| Package | ardisia.components.progressDisplay.baseClasses |
| Class | public class ProgressDisplayBase |
| Inheritance | ProgressDisplayBase  Pane spark.components.Panel |
| Subclasses | ProgressDisplayDeterminate, ProgressDisplayIndeterminate |
Only use show() and close() to open and close the display. Do not use the PopupManager directly or inherited Pane methods.
View the technical documentation on the Ardisia Labs website for more information.
Default MXML PropertymxmlContentFactory
| Property | Defined By | ||
|---|---|---|---|
 | boundingMode : String
Set to bound the entire pane to the screen or no bounding at all. | Pane | |
| canBeDocked : Boolean = true
True to allow the pane to docked to a PaneNavigator when dragged over. | Pane | |
| canBeFloated : Boolean = true
Whether the pane can be floated. | Pane | |
| canBeResized : Boolean
True to allow the pane to be resized via mouse interaction while floated. | Pane | |
| delayAfterCloseFloat : Number = 0
Delay after close() is called before the tracker is closed. | ProgressDisplayBase | ||
| delayBeforeFloat : Number = 0
Delay after show() is called before the indicator is popped up. | ProgressDisplayBase | ||
| displayCloseButton : Boolean
True to allow the pane to be closed via mouse interaction while floated. | Pane | |
| displayMaximizedButton : Boolean
True to allow the pane to be maximized via mouse interaction while
floated. | Pane | |
| displayMinimizedButton : Boolean
True to allow the pane to be minimized via mouse interaction while
floated. | Pane | |
| draggable : Boolean
True to allow the pane to be dragged while floated. | Pane | |
| icon : Object
The pane icon. | Pane | |
| includeInControlBar : Boolean = true
False to signal that a floatPaneControlBar should not manage this pane. | Pane | |
| isDragging : Boolean [read-only]
True if the pane is currently being dragged. | Pane | |
| isFloating : Boolean [read-only]
Whether the pane is currently floated. | Pane | |
| label : String
The string to pass to the displayLabelPart. | ProgressDisplayBase | ||
| maximized : Boolean
Any visual changes must be handled by the skin or an external class. | Pane | |
| minimized : Boolean
Any visual changes must be handled by the skin or an external class. | Pane | |
| minimumFloatTime : Number = 0
The minimum time the indicator will be displayed. | ProgressDisplayBase | ||
| resizeThreshold : Number = 7
The threshold within the outer boundaries of the transformRegionPart
that will trigger a pane resize, rather than a drag. | Pane | |
| restoreRectangle : 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 | |
| timeoutDuration : Number = 0
The delay after being displayed that the tracker will be closed
regardless of any other behaviour. | ProgressDisplayBase | ||
| title : String [override]
The pane title. | Pane | |
| Method | Defined By | ||
|---|---|---|---|
| ProgressDisplayBase | |||
| center():void
Call to center the pane. | Pane | |
close(closeImmediately:Boolean = false):void
Un-float and remove the tracker. | ProgressDisplayBase | ||
| closeFloatedPane(skipTransition:Boolean = false):void
If the pane is floated, will be closed and unfloated. | Pane | |
| dispose():void
Call dispose() to remove the pane from the display list and remove all
of the attached listeners. | Pane | |
| endPaneDrag():void
End a drag. | Pane | |
| floatPane(parentElement:DisplayObject, modal:Boolean = false, center:Boolean = false, animateIn:Boolean = true, childList:String = null, moduleFactory:IFlexModuleFactory = null):void
Float the pane. | Pane | |
show(parentElement:DisplayObject, modal:Boolean = true, moduleFactory:IFlexModuleFactory = null):void
Popup and display the tracker. | ProgressDisplayBase | ||
| startPaneDrag():void
Start a drag. | Pane | |
| updateBounds(proposedRect:Rectangle = null):void
Constrain the pane based on the "boundingMode" property. | Pane | |
| Method | Defined By | ||
|---|---|---|---|
| checkDock(event:MouseEvent):void
Check if hovering over any PaneNavigatorBase controls. | Pane | |
| closeButtonPartHandler(event:Event):void
Handles events for the close button. | Pane | |
closeDisplay():void
Close the tracker. | ProgressDisplayBase | ||
| effectHandler(event:Event):void
Handles events for effects. | Pane | |
eventHandler(event:Event):void [override]
Handles events on the component. | ProgressDisplayBase | ||
| getResizeMouseLocation():String
Get the string description of where the mouse cursor is in relation to
the edges of the dragRegionPart and the "resizeThreshold". | Pane | |
| maximizeButtonPartHandler(event:Event):void
Handles events for the maximize button. | Pane | |
| minimizeButtonPartHandler(event:Event):void
Handles dragging events for the minimize button. | Pane | |
| modalHandler(event:Event):void
Handles events for modal checks. | Pane | |
open():void
Float the tracker. | ProgressDisplayBase | ||
| setMaximized():void
Change the skin state and dispatch a "minimizeChange" event after the
state changes. | Pane | |
| setMinimized():void
Change the skin state and dispatch a "minimizeChange" event after the
state changes. | Pane | |
| setupAnimation():void
Setup the animation for floating and closing. | Pane | |
| skinHandler(event:Event):void
Handles events on the skin. | Pane | |
timerHandler(event:TimerEvent):void
Handles events on the timer. | ProgressDisplayBase | ||
| transformRegionPartHandler(event:Event):void
Handles events for resizing. | Pane | |
| updateCloseButtonPart():void
Update the close button part. | Pane | |
updateDisplayLabelPart():void
Update the display label skin part. | ProgressDisplayBase | ||
| updateIconPart():void
Update the icon part. | Pane | |
| updateMaximizeButtonPart():void
Update the maximize button part. | Pane | |
| updateMinimizeButtonPart():void
Update the minimize part. | Pane | |
| updateTitleLabelPart():void
Update the title part. | Pane | |
| updateTransformRegionPart():void
Update the transformRegion part. | Pane | |
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 | ||
|---|---|---|---|---|
| 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 | |
displayLabelPart:spark.components.Label | Required: false Part Type: Static Label used to display loading information. | ProgressDisplayBase | ||
| iconPart:spark.primitives.BitmapImage | Required: false Part Type: Static Bitmap image used to display the pane icon. Displayed when floating. | Pane | |
| Required: 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 | ||
| 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 | |
| titleLabelPart:spark.components.supportClasses.TextBase | Required: false Part Type: Static The label that displays the pane title. Typically displayed when floating. | Pane | |
| 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 | |
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.
| delayAfterCloseFloat | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var delayAfterCloseFloat:Number = 0Delay after close() is called before the tracker is closed.
The default value is 0.
| delayBeforeFloat | property |
public var delayBeforeFloat:Number = 0Delay after show() is called before the indicator is popped up.
Useful to prevent display if the duration of the process being tracked is too short. If close() is called before this delay is satisfied, the tracker will not be displayed.
The default value is 0.
| label | property |
label:StringThe string to pass to the displayLabelPart.
The default value is null.
public function get label():String public function set label(value:String):void| minimumFloatTime | property |
public var minimumFloatTime:Number = 0The minimum time the indicator will be displayed.
The default value is 0.
| timeoutDuration | property |
public var timeoutDuration:Number = 0The delay after being displayed that the tracker will be closed regardless of any other behaviour.
Useful for when the tracker is a modal popup to make sure the user will get control back over the app if the process being tracked never completes.
Only relevant if the tracker is popped up via show() and the value is greater than 0.
The default value is 0 (ignored).
| ProgressDisplayBase | () | Constructor |
public function ProgressDisplayBase()| close | () | method |
public function close(closeImmediately:Boolean = false):voidUn-float and remove the tracker.
Parameters
closeImmediately:Boolean (default = false) |
| closeDisplay | () | method |
protected function closeDisplay():voidClose the tracker. Sub-classes should override.
| eventHandler | () | method |
override protected function eventHandler(event:Event):voidHandles events on the component.
Parameters
event:Event — the Event that triggered the handler
|
| open | () | method |
protected function open():voidFloat the tracker. Sub-classes should override.
| show | () | method |
public function show(parentElement:DisplayObject, modal:Boolean = true, moduleFactory:IFlexModuleFactory = null):voidPopup and display the tracker.
Parameters
parentElement:DisplayObject | |
modal:Boolean (default = true) | |
moduleFactory:IFlexModuleFactory (default = null) |
| timerHandler | () | method |
protected function timerHandler(event:TimerEvent):voidHandles events on the timer.
Parameters
event:TimerEvent — the TimerEvent that triggered the handler
|
| updateDisplayLabelPart | () | method |
protected function updateDisplayLabelPart():voidUpdate the display label skin part.