| Package | mx.controls |
| Class | public class ProgressBar |
| Inheritance | ProgressBar  UIComponent FlexSprite flash.display.Sprite |
| Implements | IFontContextComponent |
A determinate ProgressBar control is a linear representation of the progress of a task over time. You use a determinate ProgressBar when the scope of the task is known. It displays when the user has to wait for an extended amount of time.
An indeterminate ProgressBar control represents time-based processes for which the scope is not yet known. As soon as you can determine the scope, you should use a determinate ProgressBar control.
The ProgressBar control has the following default characteristics:
| Characteristic | Description |
|---|---|
| default size | 150 pixels wide by 4 pixels high |
| Minimum size | 0 pixels |
| Maximum size | Undefined |
Hide MXML Syntax
The <mx:ProgressBar> tag inherits all of the tag attributes
of its superclass, and adds the following tag attributes:
Show MXML Syntax
<mx:ProgressBar
Properties
conversion="1"
direction="right|left"
indeterminate="false|true"
label="No default"
labelPlacement="bottom|top|left|right|center"
maximum="0"
minimum="0"
mode="event|polled|manual"
source="No default"
Styles
barColor="undefined"
barSkin="ProgressBarSkin"
borderColor="0xAAB3B3"
color="0x0B333C"
disabledColor="0xAAB3B3"
fontAntiAliasType="advanced"
fontFamily="Verdana"
fontGridFitType="pixel"
fontSharpness="0"
fontSize="10"
fontThickness="0"
fontStyle="normal|italic"
fontWeight="normal|bold"
horizontalGap="8"
indeterminateMoveInterval="26"
indeterminateSkin="ProgressIndeterminateSkin"
labelWidth="Computed"
leading="0"
maskSkin="ProgressMaskSkin"
paddingLeft="0"
paddingRight="0"
textAlign="left|right|center"
textDecoration="none|underline"
textIndent="0"
themeColor="haloGreen|haloBlue|haloOrange"
trackColors="[0xE6EEEE,0xE6EEEE]"
trackHeight="Calculated"
trackSkin="ProgressTrackSkin"
verticalGap="6"
Events
complete="No default"
hide="No default"
progress="No default"
show="No default"
Effects
completeEffect="No default"
/>
See also
| Property | Defined by | ||
|---|---|---|---|
 | activeEffects : Array
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | |
| automationName : String
Name that can be used as an identifier for this object.
| UIComponent | |
| automationTabularData : Object
An implementation of the
IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | |
| baselinePosition : Number
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | |
| cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
| className : String
The name of this instance's class, such as
"Button". | UIComponent | |
| contentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | |
| contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | |
| conversion : Number
Number used to convert incoming current bytes loaded value and
the total bytes loaded values.
| ProgressBar | ||
| currentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
| UIComponent | |
| currentState : String
The current view state of the component.
| UIComponent | |
| cursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| direction : String
Direction in which the fill of the ProgressBar expands toward completion.
| ProgressBar | ||
| document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | |
| doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives
doubleClick events. | UIComponent | |
| enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | |
| errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | |
| focusPane : Sprite
The focus pane associated with this object.
| UIComponent | |
| globalX : Number | UIComponent | |
| globalY : Number | UIComponent | |
| height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| id : String
ID of the component.
| UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | |
| indeterminate : Boolean
Whether the ProgressBar control has a determinate or
indeterminate appearance.
| ProgressBar | ||
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | |
| instanceIndex : int
The index of a repeated component.
| UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | |
| isDocument : Boolean
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | |
| isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| label : String
Text that accompanies the progress bar.
| ProgressBar | ||
| labelPlacement : String
Placement of the label.
| ProgressBar | ||
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| maximum : Number
Largest progress value for the ProgressBar.
| ProgressBar | ||
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| minimum : Number
Smallest progress value for the ProgressBar.
| ProgressBar | ||
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| miscHolder : Object
A utility holder for any various properties
| UIComponent | |
| mode : String
Specifies the method used to update the bar.
| ProgressBar | ||
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
| move_enableProtection : Boolean = false | UIComponent | |
| nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | |
| numAutomationChildren : int
The number of automation children this container has.
| UIComponent | |
| owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | |
| parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | |
| parentApplication : Object
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
| parentDocument : Object
A reference to the parent document object for this UIComponent.
| UIComponent | |
| percentComplete : Number [read-only]
Percentage of process that is completed.The range is 0 to 100.
| ProgressBar | ||
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
| processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| repeater : IRepeater
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
| repeaterIndex : int
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | |
| scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
| scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | |
| screen : Rectangle
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | |
| setActualSize_enableProtection : Boolean = false | UIComponent | |
| setVisible_enableProtection : Boolean = true | UIComponent | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | |
| source : Object
Refers to the control that the ProgressBar is measuring the progress of.
| ProgressBar | ||
| states : Array
The view states that are defined for this component.
| UIComponent | |
| styleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the
styleName property) override inline styles. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | |
| styleName : Object
The class style used by this component.
| UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | |
| toolTip : String
Text to display in the ToolTip.
| UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | |
| uid : String
A unique identifier for the object.
| UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | |
| validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | |
| value : Number [read-only]
Read-only property that contains the amount of progress
that has been made - between the minimum and maximum values.
| ProgressBar | ||
| visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | |
| visible_unprotected : Boolean
If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
| UIComponent | |
| width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | |
| xmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
| UIComponent | |
| y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| ProgressBar | ||
|
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
| UIComponent | |
|
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
| UIComponent | |
|
contentToGlobal(point:Point):Point
Converts a
Point object from content coordinates to global coordinates. | UIComponent | |
|
contentToLocal(point:Point):Point
Converts a
Point object from content to local coordinates. | UIComponent | |
|
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container.
| UIComponent | |
|
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | |
|
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
| UIComponent | |
|
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
| UIComponent | |
|
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | |
|
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component.
| UIComponent | |
|
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
| UIComponent | |
|
endEffectsStarted():void
Ends all currently playing effects on the component.
| UIComponent | |
|
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
| UIComponent | |
|
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
| UIComponent | |
|
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| UIComponent | |
|
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance.
| UIComponent | |
|
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | |
|
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
| UIComponent | |
|
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
| UIComponent | |
|
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
getFocus():InteractiveObject
Gets the object that currently has focus.
| UIComponent | |
|
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the
dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | |
|
getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
| UIComponent | |
|
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | UIComponent | |
|
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
initialize():void
Initializes the internal structure of this component.
| UIComponent | |
|
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | |
|
invalidateDisplayList():void
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
invalidateProperties():void
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | |
|
invalidateSize():void
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | |
|
localToContent(point:Point):Point
Converts a
Point object from local to content coordinates. | UIComponent | |
|
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such
as
<font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
|
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
| UIComponent | |
|
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
| UIComponent | |
|
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
| UIComponent | |
|
owns(child:DisplayObject):Boolean
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | |
|
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing.
| UIComponent | |
|
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the
recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | |
|
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
| UIComponent | |
|
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
| UIComponent | |
|
resumeBackgroundProcessing():void
[static]
Resumes the background processing of methods
queued by
callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
setActualSize(w:Number, h:Number):void
Sizes the object.
| UIComponent | |
|
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
| UIComponent | |
|
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | |
|
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
| UIComponent | |
|
setFocus():void
Sets the focus to this component.
| UIComponent | |
|
setProgress(value:Number, total:Number):void
Sets the state of the bar to reflect the amount of progress made
when using manual mode.
| ProgressBar | ||
|
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
| UIComponent | |
|
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the
visible property changes. | UIComponent | |
|
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
| UIComponent | |
|
styleChanged(styleProp:String):void
Detects changes to style properties.
| UIComponent | |
|
stylesInitialized():void
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
|
suspendBackgroundProcessing():void
[static]
Blocks the background processing of methods
queued by
callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
toString():String
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
|
validateDisplayList():void
Validates the position and size of children and draws other
visuals.
| UIComponent | |
|
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | |
|
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the
commitProperties() method. | UIComponent | |
|
validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the
LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
validationResultHandler(event:ValidationResultEvent):void
Handles both the
valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to
drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
|
Dispatched when the component is added to a container as a content child
by using the addChild() or addChildAt() method. | UIComponent | ||
| Dispatched when the load completes. | ProgressBar | |||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
|
Dispatched after the currentState property changes,
but before the view state changes. | UIComponent | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after the component has returned to the root view state. | UIComponent | ||
| Dispatched before the component exits from the root view state. | UIComponent | ||
| Dispatched when an object's state changes from visible to invisible. | ProgressBar | |||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched as content loads in event or polled mode. | ProgressBar | |||
| Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring. | UIComponent | ||
| Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring. | UIComponent | ||
| Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring. | UIComponent | ||
| Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring. | UIComponent | ||
|
Dispatched when the component is removed from a container as a content child
by using the removeChild() or removeChildAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when the component becomes visible. | ProgressBar | |||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
|
Dispatched by a component whose toolTip property is set,
as soon as the user moves the mouse over it. | UIComponent | ||
|
Dispatched when an object has had its commitProperties(),
measure(), and
updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined by | ||
|---|---|---|---|---|
|
barColor
| Type: uint Format: Color CSS Inheritance: yes Determines the color of a ProgressBar. A ProgressBar is filled with a vertical gradient between this color and a brighter color computed from it. This style has no effect on other components, but can be set on a container to control the appearance of all progress bars found within. The default value is undefined, which means it is not set.
In this case, the themeColor style property is used.
| ProgressBar | ||
|
barSkin
| Type: Class CSS Inheritance: no Skin style for a determinate progress bar. The default value is mx.skins.halo.ProgressBarSkin. | ProgressBar | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
|
borderColor
| Type: uint Format: Color CSS Inheritance: no Black section of a three-dimensional border, or the color section of a two-dimensional border. The default value is 0xB7BABC. | ProgressBar | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | ||
| Type: Number CSS Inheritance: no The color brightness of the component. | UIComponent | ||
|
color
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value is 0x0B333C. | ProgressBar | ||
| Type: Number CSS Inheritance: no The color contrast of the component. | UIComponent | ||
|
disabledColor
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. The default value is 0xAAB3B3. | ProgressBar | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
|
fontAntiAliasType
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. The possible values are
"normal" (flash.text.AntiAliasType.NORMAL)
and "advanced" (flash.text.AntiAliasType.ADVANCED).
The default value is This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you cannot apply it to some characters and not others. The default value is"advanced". | ProgressBar | ||
|
fontFamily
| Type: String CSS Inheritance: yes Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana". | ProgressBar | ||
|
fontGridFitType
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls.
The possible values are "none" (flash.text.GridFitType.NONE),
"pixel" (flash.text.GridFitType.PIXEL),
and "subpixel" (flash.text.GridFitType.SUBPIXEL).
This property only applies when you are using an embedded font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is"pixel". | ProgressBar | ||
|
fontSharpness
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls.
This property specifies the sharpness of the glyph edges. The possible values are Numbers
from -400 through 400.
This property only applies when you are using an embedded font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is0. | ProgressBar | ||
|
fontSize
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11. | ProgressBar | ||
|
fontStyle
| Type: String CSS Inheritance: yes Determines whether the text is italic font. Recognized values are "normal" and "italic".
The default value is "normal". | ProgressBar | ||
|
fontThickness
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls.
This property specifies the thickness of the glyph edges.
The possible values are Numbers from -200 to 200.
This property only applies when you are using an embedded font
and the This style has no effect on system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is0. | ProgressBar | ||
|
fontWeight
| Type: String CSS Inheritance: yes Determines whether the text is boldface. Recognized values are normal and bold.
The default value for Button controls is bold.
The default value for all other controls is normal.
| ProgressBar | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
|
horizontalGap
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction. The default value depends on the component class; if not overriden for the class, the default value is 8. | ProgressBar | ||
| Type: Number CSS Inheritance: no The color hue of the component. | UIComponent | ||
|
indeterminateMoveInterval
| Type: Number CSS Inheritance: no The number of pixels to move the indeterminate progress bar for each indeterminate loop. Once the progress bar has moved the specified number of pixels, it gets respositioned back to its starting point. A value of 0 means that the bar is not moved. The default value is 26. | ProgressBar | ||
|
indeterminateSkin
| Type: Class CSS Inheritance: no Skin style for an indeterminate progress bar. The default value is mx.skins.halo.ProgressIndeterminateSkin. | ProgressBar | ||
|
kerning
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false).
Kerning adjusts the gap between certain character pairs
to improve readability, and should be used only when necessary,
such as with headings in large fonts.
Kerning is supported for embedded fonts only.
Certain fonts, such as Verdana, and monospaced fonts,
such as Courier New, do not support kerning.
The default value is false. | ProgressBar | ||
|
labelWidth
| Type: Number Format: Length CSS Inheritance: yes The width of the label in pixels. If the value is NaN, the ProgressBar control sets it to the width of the control. The default value is NaN. | ProgressBar | ||
|
leading
| Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. The default value is 2. The default value for the ComboBox control is 0. | ProgressBar | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | ||
|
letterSpacing
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0. | ProgressBar | ||
|
maskSkin
| Type: Class CSS Inheritance: no Skin style for the mask of the determinate and indeterminate bars. The default value is mx.skins.halo.ProgressMaskSkin. | ProgressBar | ||
| Type: Number CSS Inheritance: no The opacity of the component. | UIComponent | ||
|
paddingLeft
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. The default value is 0. The default value for a Button control is 10. The default value for the ComboBox control is 5. The default value for the Form container is 16. The default value for the Tree control is 2. | ProgressBar | ||
|
paddingRight
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. The default value is 0. The default value for a Button control is 10. The default value for the ComboBox control is 5. The default value for the Form container is 16. | ProgressBar | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | ||
| Type: Number CSS Inheritance: no The color saturation of the component. | UIComponent | ||
|
textAlign
| Type: String CSS Inheritance: yes Alignment of text within a container. Possible values are "left", "right",
or "center".
The default value for most components is | ProgressBar | ||
|
textDecoration
| Type: String CSS Inheritance: yes Determines whether the text is underlined. Possible values are "none" and "underline".
The default value is "none". | ProgressBar | ||
|
textIndent
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. The default value is 0. | ProgressBar | ||
|
themeColor
| Type: uint Format: Color CSS Inheritance: yes Theme color of the ProgressBar control. Possible values are haloGreen, haloBlue, and haloOrange. Adobe recommends setting the themeColor style
in the <mx:Application> tag, instead of in
individual controls.
The default value is "haloBlue". | ProgressBar | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | ||
|
trackColors
| Type: Array Format: Color CSS Inheritance: no The colors of the track, as an array of two colors. You can use the same color twice for a solid track color. The default value is [ 0xE6EEEE, 0xE6EEEE ]. | ProgressBar | ||
|
trackHeight
| Type: Number Format: Length CSS Inheritance: no The height of the track in pixels. If the value is NaN, then use the height of the skin specified by the trackSkin property.
The default value is NaN. | ProgressBar | ||
|
trackSkin
| Type: Class CSS Inheritance: no Skin style for the progress indicator track. The default value is mx.skins.halo.ProgressTrackSkin. | ProgressBar | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
|
verticalGap
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction. The default value depends on the component class; if not overriden for the class, the default value is 6. | ProgressBar | ||
| Effect | Description | Defined by | ||
|---|---|---|---|---|
| Triggering event: added Played when the component is added as a child to a Container. | UIComponent | ||
|
completeEffect
| Triggering event: complete
Effect called when Flex dispatches the complete event,
which occurs when the load completes.
| ProgressBar | ||
| Triggering event: creationComplete
Played when the component is created. | UIComponent | ||
| Triggering event: focusIn Played when the component gains keyboard focus. | UIComponent | ||
| Triggering event: focusOut Played when the component loses keyboard focus. | UIComponent | ||
| Triggering event: hide
Played when the component becomes invisible. | UIComponent | ||
| Triggering event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent | ||
| Triggering event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent | ||
| Triggering event: move
Played when the component is moved. | UIComponent | ||
| Triggering event: removed Played when the component is removed from a Container. | UIComponent | ||
| Triggering event: resize
Played when the component is resized. | UIComponent | ||
| Triggering event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent | ||
| Triggering event: rollOver Played when the user rolls the mouse over the component. | UIComponent | ||
| Triggering event: show
Played when the component becomes visible. | UIComponent | ||
| conversion | property |
conversion:Number [read-write]Number used to convert incoming current bytes loaded value and the total bytes loaded values. Flex divides the current and total values by this property and uses the closest integer that is less than or equal to each value in the label string. A value of 1 does no conversion.
The default value is 1.
This property can be used as the source for data binding.
Implementation public function get conversion():Number
public function set conversion(value:Number):void
| direction | property |
direction:String [read-write]
Direction in which the fill of the ProgressBar expands toward completion.
Valid values in MXML are
"right" and "left".
In ActionScript, you use use the following constants
to set this property:
ProgressBarDirection.RIGHT and
ProgressBarDirection.LEFT.
The default value is ProgressBarDirection.RIGHT.
This property can be used as the source for data binding.
Implementation public function get direction():String
public function set direction(value:String):void
See also
| indeterminate | property |
indeterminate:Boolean [read-write]
Whether the ProgressBar control has a determinate or
indeterminate appearance.
Use an indeterminate appearance when the progress status cannot be determined.
If true, the appearance is indeterminate.
The default value is false.
This property can be used as the source for data binding.
Implementation public function get indeterminate():Boolean
public function set indeterminate(value:Boolean):void
| label | property |
label:String [read-write]Text that accompanies the progress bar. You can include the following special characters in the text string:
If a field is unknown, it is replaced by "??". If undefined, the label is not displayed.
If you are in manual mode, you can set the values of these special characters
by using the setProgress() method.
The default value is "LOADING %3%%".
This property can be used as the source for data binding.
Implementation public function get label():String
public function set label(value:String):void
| labelPlacement | property |
labelPlacement:String [read-write]
Placement of the label.
Valid values in MXML are "right", "left",
"bottom", "center", and "top".
In ActionScript, you can use use the following constants to set this property:
ProgressBarLabelPlacement.RIGHT, ProgressBarLabelPlacement.LEFT,
ProgressBarLabelPlacement.BOTTOM, ProgressBarLabelPlacement.CENTER,
and ProgressBarLabelPlacement.TOP.
The default value is ProgressBarLabelPlacement.BOTTOM.
This property can be used as the source for data binding.
Implementation public function get labelPlacement():String
public function set labelPlacement(value:String):void
See also
| maximum | property |
maximum:Number [read-write]Largest progress value for the ProgressBar. You can only use this property in manual mode.
The default value is 0.
This property can be used as the source for data binding.
Implementation public function get maximum():Number
public function set maximum(value:Number):void
| minimum | property |
minimum:Number [read-write]Smallest progress value for the ProgressBar. This property is set by the developer only in manual mode.
The default value is 0.
This property can be used as the source for data binding.
Implementation public function get minimum():Number
public function set minimum(value:Number):void
| mode | property |
mode:String [read-write]Specifies the method used to update the bar. Use one of the following values in MXML:
event The control specified by the source
property must dispatch progress and completed events.
The ProgressBar control uses these events to update its status.
The ProgressBar control only updates if the value of
the source property extends the EventDispatcher class.polled The source property must specify
an object that exposes bytesLoaded and
bytesTotal properties. The ProgressBar control
calls these methods to update its status.manual You manually update the ProgressBar status.
In this mode you specify the maximum and minimum
properties and use the setProgress() property method to
specify the status. This mode is often used when the indeterminate
property is true.In ActionScript, you can use use the following constants to set this property:
ProgressBarMode.EVENT, ProgressBarMode.POLLED,
and ProgressBarMode.MANUAL.
The default value is ProgressBarMode.EVENT.
This property can be used as the source for data binding.
Implementation public function get mode():String
public function set mode(value:String):void
See also
| percentComplete | property |
percentComplete:Number [read-only]
Percentage of process that is completed.The range is 0 to 100.
Use the setProgress() method to change the percentage.
This property can be used as the source for data binding.
Implementation public function get percentComplete():Number
| source | property |
source:Object [read-write]Refers to the control that the ProgressBar is measuring the progress of. Use this property only in event and polled mode. A typical usage is to set this property to a Loader control.
This property can be used as the source for data binding.
Implementation public function get source():Object
public function set source(value:Object):void
| value | property |
value:Number [read-only]Read-only property that contains the amount of progress that has been made - between the minimum and maximum values.
This property can be used as the source for data binding.
Implementation public function get value():Number
| ProgressBar | () | constructor |
public function ProgressBar()Constructor.
| setProgress | () | method |
public function setProgress(value:Number, total:Number):void
Sets the state of the bar to reflect the amount of progress made
when using manual mode.
The value argument is assigned to the value
property and the maximum argument is assigned to the
maximum property.
The minimum property is not altered.
value:Number — Current value.
|
|
total:Number — Total or target value.
|
| complete | event |
| hide | event |
mx.events.FlexEvent
mx.events.FlexEvent.HIDE
Dispatched when an object's state changes from visible to invisible.
The FlexEvent.HIDE constant defines the value of the
type property of the event object for a hide event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
| progress | event |
| show | event |
mx.events.FlexEvent
mx.events.FlexEvent.SHOW
Dispatched when the component becomes visible.
The FlexEvent.SHOW constant defines the value of the
type property of the event object for a show event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |