ardisia.components.progressDisplay.ProgressDisplayDeterminate

Package	ardisia.components.progressDisplay
Class	public class ProgressDisplayDeterminate
Inheritance	ProgressDisplayDeterminate ProgressDisplayBase Pane spark.components.Panel

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

Call updateProgress() to update.

Default MXML PropertymxmlContentFactory

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	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

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		moveEffect : Move3D Used for float/closeFloat animations.	Pane
		queueCenter : Boolean	Pane
		queueClose : Boolean	Pane
		queueCloseProperties : Object	Pane
		queueOpen : Boolean	Pane
		queueOpenProperties : Object	Pane

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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
		updateProgress(percent:Number):void Update the progress display.	ProgressDisplayDeterminate

Protected Methods

Show Inherited Protected Methods

	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

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
closed	Dispatched when a floated pane is closed.	Pane
displayCloseButtonChanged	Dispatched when the "displayCloseButton" property changes.	Pane
docked	Dispatched when the pane is docked to a pane navigator.	Pane
dragging	Dispatched repeatedly when a pane is being dragged.	Pane
draggingEnd	Dispatched when a pane drag ends.	Pane
draggingStarting	Dispatched before a pane drag begins.	Pane
floated	Dispatched when the pane is floated.	Pane
floatedPaneActive	Dispatched when a floating pane is focused and activated by the flex window manager.	Pane
floatedPaneInactive	Dispatched when a previously focused and active floating pane loses focus and is deactivated by the window manager.	Pane
iconChange	Dispatched when the pane icon changes.	Pane
maximizeChange	Dispatched when the maximize property value changes.	Pane
minimizeChange	Dispatched when the minimize property value changes.	Pane
readyToAnimate	Dispatched right before an animate in animation runs.	Pane
titleChange	Dispatched when the pane title changes.	Pane

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
alphaOverPaneNavigator	Type: Number CSS Inheritance: no The alpha to set the pane to when hovering over a PaneNavigator and the pane can be docked.	Pane
backgroundAlpha	Type: Number CSS Inheritance: no ONLY APPLICABLE WHEN THE PANE IS FLOATED.	Pane
backgroundColor	Type: uint CSS Inheritance: no ONLY APPLICABLE WHEN THE PANE IS FLOATED.	Pane
paneChrome	Type: 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.

Hide Inherited Skin Parts

Show Inherited Skin Parts

	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
maximizeButtonPart:MaximizeButton	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

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.

Hide Inherited Skin States

Show Inherited Skin States

	Skin State		Description	Defined By
		disabled		Pane
		disabledAndFloating		Pane
		disabledAndFloatingAndInactive		Pane
		disabledAndFloatingAndInactiveWithControlBar		Pane
		disabledAndFloatingWithControlBar		Pane
		disabledWithControlBar		Pane
		floating		Pane
		floatingAndInactive		Pane
		floatingAndInactiveWithControlBar		Pane
		floatingWithControlBar		Pane
		normal		Pane
		normalWithControlBar		Pane

Method Detail

updateProgress

()

method

public function updateProgress(percent:Number):void

Update the progress display.

Parameters

percent:Number — the percent of the process completed

Mon Sep 15 2014, 01:55 AM -06:00

Ardisia Component Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
ProgressDisplayDeterminate	Properties \| Methods \| Events \| Styles \| Skin Parts \| Skin States