| Package | feathers.controls |
| Class | public class ProgressBar |
| Inheritance | ProgressBar  FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number The opacity of the object. | DisplayObject | |
| backgroundDisabledSkin : DisplayObject
A background to display when the progress bar is disabled. | ProgressBar | ||
| backgroundSkin : DisplayObject
The primary background to display. | ProgressBar | ||
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| clipRect : Rectangle [override] | FeathersControl | |
| defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
| defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
| direction : String
Determines the direction that the progress bar fills. | ProgressBar | ||
| fillDisabledSkin : DisplayObject
A fill to display when the progress bar is disabled. | ProgressBar | ||
| fillSkin : DisplayObject
The primary fill to display. | ProgressBar | ||
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusManager : IFocusManager
The current focus manager for this component. | FeathersControl | |
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| height : Number [override]
The height of the component, in pixels. | FeathersControl | |
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
| isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
| isFocusEnabled : Boolean
Determines if this component can receive focus. | FeathersControl | |
| isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| maximum : Number
The progress bar's value will not go higher than the maximum. | ProgressBar | ||
| maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minimum : Number
The progress bar's value will not go lower than the minimum. | ProgressBar | ||
| minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
| minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
| minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
| nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| padding : Number
Quickly sets all padding properties to the same value. | ProgressBar | ||
| paddingBottom : Number
The minimum space, in pixels, between the progress bar's bottom edge
and the progress bar's content. | ProgressBar | ||
| paddingLeft : Number
The minimum space, in pixels, between the progress bar's left edge
and the progress bar's content. | ProgressBar | ||
| paddingRight : Number
The minimum space, in pixels, between the progress bar's right edge
and the progress bar's content. | ProgressBar | ||
| paddingTop : Number
The minimum space, in pixels, between the progress bar's top edge and
the progress bar's content. | ProgressBar | ||
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| value : Number
The value of the progress bar, between the minimum and maximum. | ProgressBar | ||
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ProgressBar | ||
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
| dispose():void [override] Disposes the resources of all children. | Sprite | |
| flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Sprite | |
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
| getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or
null if the sprite doens't have a clipRect. | Sprite | |
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | Sprite | |
| invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
| isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | FeathersControl | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
| validate():void
Immediately validates the control, which triggers a redraw, if one
is pending. | FeathersControl | |
| Constant | Defined By | ||
|---|---|---|---|
| DIRECTION_HORIZONTAL : String = horizontal [static]
The progress bar fills horizontally (on the x-axis). | ProgressBar | ||
| DIRECTION_VERTICAL : String = vertical [static]
The progress bar fills vertically (on the y-axis). | ProgressBar | ||
| INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
| INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
| INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
| INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
| INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
| INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
| INVALIDATION_FLAG_STYLES : String = styles [static]
Invalidation flag to indicate that the styles or visual appearance of
the UI control has changed. | FeathersControl | |
| backgroundDisabledSkin | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbackgroundDisabledSkin:DisplayObjectA background to display when the progress bar is disabled.
public function get backgroundDisabledSkin():DisplayObject public function set backgroundDisabledSkin(value:DisplayObject):void| backgroundSkin | property |
backgroundSkin:DisplayObjectThe primary background to display.
public function get backgroundSkin():DisplayObject public function set backgroundSkin(value:DisplayObject):void| direction | property |
direction:StringDetermines the direction that the progress bar fills. When this value changes, the progress bar's width and height values do not change automatically.
public function get direction():String public function set direction(value:String):void| fillDisabledSkin | property |
fillDisabledSkin:DisplayObjectA fill to display when the progress bar is disabled.
public function get fillDisabledSkin():DisplayObject public function set fillDisabledSkin(value:DisplayObject):void| fillSkin | property |
fillSkin:DisplayObjectThe primary fill to display.
Note: The size of the fillSkin, at the time that it
is passed to the setter, will be used used as the size of the fill
when the progress bar is set to the minimum value. In other words,
if the fill of a horizontal progress bar with a value from 0 to 100
should be virtually invisible when the value is 0, then the
fillSkin should have a width of 0 when you pass it in.
On the other hand, if you're using a Scale9Image as the
skin, it may require a minimum width before the image parts begin to
overlap. In that case, the Scale9Image instance passed
to the fillSkin setter should have a width
value that is the same as that minimum width value where the image
parts do not overlap.
public function get fillSkin():DisplayObject public function set fillSkin(value:DisplayObject):void| maximum | property |
maximum:NumberThe progress bar's value will not go higher than the maximum.
public function get maximum():Number public function set maximum(value:Number):void| minimum | property |
minimum:NumberThe progress bar's value will not go lower than the minimum.
public function get minimum():Number public function set minimum(value:Number):void| padding | property |
padding:Number
Quickly sets all padding properties to the same value. The
padding getter always returns the value of
paddingTop, but the other padding values may be
different.
public function get padding():Number public function set padding(value:Number):void| paddingBottom | property |
paddingBottom:NumberThe minimum space, in pixels, between the progress bar's bottom edge and the progress bar's content.
public function get paddingBottom():Number public function set paddingBottom(value:Number):void| paddingLeft | property |
paddingLeft:NumberThe minimum space, in pixels, between the progress bar's left edge and the progress bar's content.
public function get paddingLeft():Number public function set paddingLeft(value:Number):void| paddingRight | property |
paddingRight:NumberThe minimum space, in pixels, between the progress bar's right edge and the progress bar's content.
public function get paddingRight():Number public function set paddingRight(value:Number):void| paddingTop | property |
paddingTop:NumberThe minimum space, in pixels, between the progress bar's top edge and the progress bar's content.
public function get paddingTop():Number public function set paddingTop(value:Number):void| value | property |
value:NumberThe value of the progress bar, between the minimum and maximum.
public function get value():Number public function set value(value:Number):void| ProgressBar | () | Constructor |
public function ProgressBar()Constructor.
| DIRECTION_HORIZONTAL | Constant |
public static const DIRECTION_HORIZONTAL:String = horizontalThe progress bar fills horizontally (on the x-axis).
| DIRECTION_VERTICAL | Constant |
public static const DIRECTION_VERTICAL:String = verticalThe progress bar fills vertically (on the y-axis).