Packageardisia.components.progressDisplay
Classpublic class ProgressDisplayDeterminate
InheritanceProgressDisplayDeterminate Inheritance ProgressDisplayBase Inheritance Pane Inheritance spark.components.Panel

Determinate version of the ProgressDisplay. Change the visual look in the skin.

Call updateProgress() to update.

Default MXML PropertymxmlContentFactory



Public Properties
 PropertyDefined By
 InheritedboundingMode : String
Set to bound the entire pane to the screen or no bounding at all.
Pane
 InheritedcanBeDocked : Boolean = true
True to allow the pane to docked to a PaneNavigator when dragged over.
Pane
 InheritedcanBeFloated : Boolean = true
Whether the pane can be floated.
Pane
 InheritedcanBeResized : Boolean
True to allow the pane to be resized via mouse interaction while floated.
Pane
 InheriteddelayAfterCloseFloat : Number = 0
Delay after close() is called before the tracker is closed.
ProgressDisplayBase
 InheriteddelayBeforeFloat : Number = 0
Delay after show() is called before the indicator is popped up.
ProgressDisplayBase
 InheriteddisplayCloseButton : Boolean
True to allow the pane to be closed via mouse interaction while floated.
Pane
 InheriteddisplayMaximizedButton : Boolean
True to allow the pane to be maximized via mouse interaction while floated.
Pane
 InheriteddisplayMinimizedButton : Boolean
True to allow the pane to be minimized via mouse interaction while floated.
Pane
 Inheriteddraggable : Boolean
True to allow the pane to be dragged while floated.
Pane
 Inheritedicon : Object
The pane icon.
Pane
 InheritedincludeInControlBar : Boolean = true
False to signal that a floatPaneControlBar should not manage this pane.
Pane
 InheritedisDragging : Boolean
[read-only] True if the pane is currently being dragged.
Pane
 InheritedisFloating : Boolean
[read-only] Whether the pane is currently floated.
Pane
 Inheritedlabel : String
The string to pass to the displayLabelPart.
ProgressDisplayBase
 Inheritedmaximized : Boolean
Any visual changes must be handled by the skin or an external class.
Pane
 Inheritedminimized : Boolean
Any visual changes must be handled by the skin or an external class.
Pane
 InheritedminimumFloatTime : Number = 0
The minimum time the indicator will be displayed.
ProgressDisplayBase
 InheritedresizeThreshold : Number = 7
The threshold within the outer boundaries of the transformRegionPart that will trigger a pane resize, rather than a drag.
Pane
 InheritedrestoreRectangle : Rectangle
The rectangle that describes the measurements and layout for a pane before it is maximized or minimized in the coordinate space of the pane's systemManager.
Pane
 InheritedtimeoutDuration : Number = 0
The delay after being displayed that the tracker will be closed regardless of any other behaviour.
ProgressDisplayBase
 Inheritedtitle : String
[override] The pane title.
Pane
Protected Properties
 PropertyDefined By
 InheritedmoveEffect : Move3D
Used for float/closeFloat animations.
Pane
 InheritedqueueCenter : Boolean
Pane
 InheritedqueueClose : Boolean
Pane
 InheritedqueueCloseProperties : Object
Pane
 InheritedqueueOpen : Boolean
Pane
 InheritedqueueOpenProperties : Object
Pane
Public Methods
 MethodDefined By
 Inherited
center():void
Call to center the pane.
Pane
 Inherited
close(closeImmediately:Boolean = false):void
Un-float and remove the tracker.
ProgressDisplayBase
 Inherited
closeFloatedPane(skipTransition:Boolean = false):void
If the pane is floated, will be closed and unfloated.
Pane
 Inherited
dispose():void
Call dispose() to remove the pane from the display list and remove all of the attached listeners.
Pane
 Inherited
End a drag.
Pane
 Inherited
floatPane(parentElement:DisplayObject, modal:Boolean = false, center:Boolean = false, animateIn:Boolean = true, childList:String = null, moduleFactory:IFlexModuleFactory = null):void
Float the pane.
Pane
 Inherited
show(parentElement:DisplayObject, modal:Boolean = true, moduleFactory:IFlexModuleFactory = null):void
Popup and display the tracker.
ProgressDisplayBase
 Inherited
Start a drag.
Pane
 Inherited
updateBounds(proposedRect:Rectangle = null):void
Constrain the pane based on the "boundingMode" property.
Pane
  
updateProgress(percent:Number):void
Update the progress display.
ProgressDisplayDeterminate
Protected Methods
 MethodDefined By
 Inherited
checkDock(event:MouseEvent):void
Check if hovering over any PaneNavigatorBase controls.
Pane
 Inherited
closeButtonPartHandler(event:Event):void
Handles events for the close button.
Pane
 Inherited
Close the tracker.
ProgressDisplayBase
 Inherited
effectHandler(event:Event):void
Handles events for effects.
Pane
 Inherited
eventHandler(event:Event):void
[override] Handles events on the component.
ProgressDisplayBase
 Inherited
Get the string description of where the mouse cursor is in relation to the edges of the dragRegionPart and the "resizeThreshold".
Pane
 Inherited
maximizeButtonPartHandler(event:Event):void
Handles events for the maximize button.
Pane
 Inherited
minimizeButtonPartHandler(event:Event):void
Handles dragging events for the minimize button.
Pane
 Inherited
modalHandler(event:Event):void
Handles events for modal checks.
Pane
 Inherited
open():void
Float the tracker.
ProgressDisplayBase
 Inherited
Change the skin state and dispatch a "minimizeChange" event after the state changes.
Pane
 Inherited
Change the skin state and dispatch a "minimizeChange" event after the state changes.
Pane
 Inherited
Setup the animation for floating and closing.
Pane
 Inherited
skinHandler(event:Event):void
Handles events on the skin.
Pane
 Inherited
timerHandler(event:TimerEvent):void
Handles events on the timer.
ProgressDisplayBase
 Inherited
transformRegionPartHandler(event:Event):void
Handles events for resizing.
Pane
 Inherited
Update the close button part.
Pane
 Inherited
Update the display label skin part.
ProgressDisplayBase
 Inherited
Update the icon part.
Pane
 Inherited
Update the maximize button part.
Pane
 Inherited
Update the minimize part.
Pane
 Inherited
Update the title part.
Pane
 Inherited
Update the transformRegion part.
Pane
Events
 Event Summary Defined By
 InheritedDispatched when a floated pane is closed.Pane
 InheritedDispatched when the "displayCloseButton" property changes.Pane
 InheritedDispatched when the pane is docked to a pane navigator.Pane
 InheritedDispatched repeatedly when a pane is being dragged.Pane
 InheritedDispatched when a pane drag ends.Pane
 InheritedDispatched before a pane drag begins.Pane
 InheritedDispatched when the pane is floated.Pane
 InheritedDispatched when a floating pane is focused and activated by the flex window manager.Pane
 InheritedDispatched when a previously focused and active floating pane loses focus and is deactivated by the window manager.Pane
 InheritedDispatched when the pane icon changes.Pane
 InheritedDispatched when the maximize property value changes.Pane
 InheritedDispatched when the minimize property value changes.Pane
 InheritedDispatched right before an animate in animation runs.Pane
 InheritedDispatched when the pane title changes.Pane
Styles
 Style Description Defined By
 InheritedType: Number CSS Inheritance: no
The alpha to set the pane to when hovering over a PaneNavigator and the pane can be docked.
Pane
 InheritedType: Number CSS Inheritance: no
ONLY APPLICABLE WHEN THE PANE IS FLOATED.
Pane
 InheritedType: uint CSS Inheritance: no
ONLY APPLICABLE WHEN THE PANE IS FLOATED.
Pane
 InheritedType: Number CSS Inheritance: no
ONLY APPLICABLE WHEN THE PANE IS FLOATED.
Pane
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
 Inherited
closeButtonPart:spark.components.supportClasses.ButtonBase
Required: false Part Type: Static
Optional button used to close the pane. Typically displayed when floating. If the "displayCloseButton" property is false, and this skin part is displayed, it will be disabled, hidden, and removed from layout.
Pane
 Inherited
displayLabelPart:spark.components.Label
Required: false Part Type: Static
Label used to display loading information.
ProgressDisplayBase
 Inherited
iconPart:spark.primitives.BitmapImage
Required: false Part Type: Static
Bitmap image used to display the pane icon. Displayed when floating.
Pane
 InheritedRequired: false Part Type: Static
Optional button used to maximize a floating pane to fill the viewable screen real estate. If the "displayMaximizedButton" property is false, it will be disabled, hidden, and removed from layout.
Pane
 Inherited
minimizeButtonPart:spark.components.supportClasses.ButtonBase
Required: false Part Type: Static
Optional button used to change the floating pane. If the "displayMinimizedButton" property is false, it will be disabled, hidden, and removed from layout.
Pane
 Inherited
titleLabelPart:spark.components.supportClasses.TextBase
Required: false Part Type: Static
The label that displays the pane title. Typically displayed when floating.
Pane
 Inherited
transformRegionPart:spark.components.Group
Required: false Part Type: Static
Region of the pane that is resizable via mouse interaction when floated if the "canBeResized" property is true and the mouse is within the "resizeThreshold". Is also the region of the pane that is draggable via mouse interaction when: floated , the "draggable" property is true, the mouse is down, and the cursor is not within the "resizeThreshold".
Pane
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


 Skin State Description Defined By
 InheritedPane
 InheritedPane
 InheritedPane
 InheritedPane
 InheritedPane
 InheritedPane
 InheritedPane
 InheritedPane
 InheritedPane
 InheritedPane
 InheritedPane
 InheritedPane
Method Detail
updateProgress()method
public function updateProgress(percent:Number):void

Update the progress display.

Parameters

percent:Number — the percent of the process completed