WikiPage Busy Indicator modified by SourceForge Editorial Staff

SourceForge Editorial Staff — Thu, 06 Dec 2012 19:15:20 -0000

--- v2
+++ v3
@@ -1,4 +1,3 @@
-
 
 
   
@@ -8,11 +7,6 @@
 
 
 
-[[ style  ]]  
-h3   
-.wiki-content h2   
-.indent blockquote   
-[[ /style ]]
 
 # Functional and Design Specification

WikiPage Busy Indicator modified by SourceForge Editorial Staff

SourceForge Editorial Staff — Thu, 06 Dec 2012 19:13:48 -0000

--- v1
+++ v2
@@ -1,11 +1,10 @@
 
-
-
+
 
   
 
 
-
+
 
 
 
@@ -207,5 +206,4 @@
 
 
 
-  
-[[ include ref='site:open_commentlogin' ]]
+

WikiPage Busy Indicator modified by SourceForge Editorial Staff

SourceForge Editorial Staff — Thu, 15 Mar 2012 18:12:55 -0000

[[ style ]] h3 .wiki-content h2 .indent blockquote [[ /style ]] # Functional and Design Specification ---- ## Glossary ## Summary and Background The Busy Indicator component gives the user a visual indication that the application is in the middle of an operation, e.g. a long-running calculation or a network operation. ### Goals ---- * A simple component that the developer can place as needed. ### Non-Goals ---- * A skinnable busy indicator is not within the scope of this work * Determinate progress (e.g. "65% of 100% done) is not included in the scope of this work * Specialized components (e.g. a dialog box with a busy indicator and text) are not included in the scope of this work * This component will not have a modal mode, i.e. it will not provide functionality to block user interaction * This component will not implement a full-screen overlay mode; that additional functionality can be implemented relatively easily by the end developer ## Usage Scenarios When starting a long-running operation, such as a network operation, add the BusyIndicator to the display list. After the operation has completed, remove the BusyIndicator from the display list. An alternative to adding and removing the BusyIndictor to/from the display list is to leave the BusyIndicator on a controlBar and change the BusyIndicator's visibility to show and hide it. The BusyIndicator will be implemented not to use any processor time when it is not visible. ## API Description **BusyIndicator** package spark.components { //-------------------------------------- // Styles //-------------------------------------- /** * The interval to delay, in milliseconds, between rotations of this * component. Controls the speed at which this component spins. * * @default 50 * * @langversion 3.0 * @playerversion Flash 10.1 * @playerversion AIR 2.5 * @productversion Flex 4.5 * */ Style(name="rotationInterval", type="Number", format="Time", inherit="no") /** * Color of any symbol of a component. * This is used by the BusyIndicator to color the spokes of the spinner. * * @default 0x000000 * * @langversion 3.0 * @playerversion Flash 10.1 * @playerversion AIR 2.5 * @productversion Flex 4.5 */ Style(name="symbolColor", type="uint", format="Color", inherit="yes", theme="spark,mobile") /** * The BusyIndicator defines a component to display when a long-running * operation is in progress. This component is a spinner with twelve spokes. * The color of the spokes is controled by the value of the symbolColor style. * The transparency of this component can be modified using the alpha property * but the alpha value of each spoke cannot be modified. * *

* The speed at which this component spins is controled by the rotationInterval * style. The rotationInterval style is the delay in milliseconds between * rotates. Decrease the rotationInterval to increase the speed of the spin * and increase the rotationInterval to slow the spin. *

* *

The BusyIndicator has the following default characteristics:

* * * * * *

Characteristic	Description
Default size	160 DPI: 26x26 pixels * 240 DPI: 40x40 pixels * 320 DPI: 52x52 pixels
Minimum size	20x20 pixels
Maximum size	No limit

* * The diameter of the BusyIndicator's spinner is the minimum of the width and * height of the component. The diameter must be an even number so will be * reduced by one if it is odd. * * @mxml * *

The <s:BusyCursor> tag inherits the symbolColor style * and adds the rotationInterval style.

* *

     *  <s:BusyIndicator
     *     
     *    Styles
     *    rotationInterval=50
     * 
     *    Spark Styles
     *    symbolColor="0x000000"
     *  
     *  >
     *

* * * @langversion 3.0 * @playerversion Flash 10.1 * @playerversion AIR 2.5 * @productversion Flex 4.5 */ public class BusyIndicator extends UIComponent { //-------------------------------------------------------------------------- // // Constructor // //-------------------------------------------------------------------------- /** * Constructor. * * @langversion 3.0 * @playerversion Flash 10.1 * @playerversion AIR 2.5 * @productversion Flex 4.5 */ public function BusyIndicator(); ## Examples and Usage The BusyIndicator can be placed in a control bar and set to visible when needed. When not visible or not on the display list the BusyIndicator will not consume any processor cycles. ## Compiler Work N/A. ## Performance If the BusyIndicator is not on the display list or is not visible it will not rotate and consume processor cycles.

[[ include ref='flexsdk_rightnav' ]]

[[ include ref='site:open_commentlogin' ]]

Recent changes to Busy Indicator

WikiPage Busy Indicator modified by SourceForge Editorial Staff

WikiPage Busy Indicator modified by SourceForge Editorial Staff

WikiPage Busy Indicator modified by SourceForge Editorial Staff