Package | feathers.controls |
Class | public class ProgressBar |
Inheritance | ProgressBar ![]() ![]() |
The following example creates a progress bar:
var progress:ProgressBar = new ProgressBar(); progress.minimum = 0; progress.maximum = 100; progress.value = 20; this.addChild( progress );
See also
Property | Defined By | ||
---|---|---|---|
backgroundDisabledSkin : DisplayObject
A background to display when the progress bar is disabled. | ProgressBar | ||
backgroundSkin : DisplayObject
The primary background to display. | ProgressBar | ||
![]() | 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 | |
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | 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 | ||
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the
top edge of the focus indicator skin. | FeathersControl | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all ProgressBar
components. | ProgressBar | ||
![]() | 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 | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean | 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 | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
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 | ||
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
value : Number
The value of the progress bar, between the minimum and maximum. | ProgressBar | ||
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
Constructor. | ProgressBar | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | FeathersControl | |
![]() | 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 | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | ProgressBar | ||
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
![]() | draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | |
![]() | focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN
that may be overridden in subclasses to perform additional actions
when the component receives focus. | FeathersControl | |
![]() | focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT
that may be overridden in subclasses to perform additional actions
when the component loses focus. | FeathersControl | |
![]() | initialize():void
Called the first time that the UI control is added to the stage, and
you should override this function to customize the initialization
process. | FeathersControl | |
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
![]() | setInvalidationFlag(flag:String):void
Sets an invalidation flag. | FeathersControl | |
![]() | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of
invalidating or not. | 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_FOCUS : String = focus [static]
Invalidation flag to indicate that the focus of 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 |
backgroundDisabledSkin:DisplayObject
A background to display when the progress bar is disabled.
In the following example, the progress bar is given a disabled background skin:
progress.backgroundDisabledSkin = new Image( texture );
The default value is null
.
public function get backgroundDisabledSkin():DisplayObject
public function set backgroundDisabledSkin(value:DisplayObject):void
backgroundSkin | property |
backgroundSkin:DisplayObject
The primary background to display.
In the following example, the progress bar is given a background skin:
progress.backgroundSkin = new Image( texture );
The default value is null
.
public function get backgroundSkin():DisplayObject
public function set backgroundSkin(value:DisplayObject):void
direction | property |
direction:String
Determines the direction that the progress bar fills. When this value changes, the progress bar's width and height values do not change automatically.
In the following example, the direction is set to vertical:
progress.direction = ProgressBar.DIRECTION_VERTICAL;
The default value is ProgressBar.DIRECTION_HORIZONTAL
.
public function get direction():String
public function set direction(value:String):void
See also
fillDisabledSkin | property |
fillDisabledSkin:DisplayObject
A fill to display when the progress bar is disabled.
In the following example, the progress bar is given a disabled fill skin:
progress.fillDisabledSkin = new Image( texture );
The default value is null
.
public function get fillDisabledSkin():DisplayObject
public function set fillDisabledSkin(value:DisplayObject):void
fillSkin | property |
fillSkin:DisplayObject
The 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.
In the following example, the progress bar is given a fill skin:
progress.fillSkin = new Image( texture );
The default value is null
.
public function get fillSkin():DisplayObject
public function set fillSkin(value:DisplayObject):void
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all ProgressBar
components.
The default value is null
.
See also
maximum | property |
maximum:Number
The progress bar's value will not go higher than the maximum.
In the following example, the maximum is set to 100:
progress.minimum = 0; progress.maximum = 100; progress.value = 12;
The default value is 1
.
public function get maximum():Number
public function set maximum(value:Number):void
See also
minimum | property |
minimum:Number
The progress bar's value will not go lower than the minimum.
In the following example, the minimum is set to 0:
progress.minimum = 0; progress.maximum = 100; progress.value = 12;
The default value is 0
.
public function get minimum():Number
public function set minimum(value:Number):void
See also
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.
In the following example, the padding is set to 20 pixels:
progress.padding = 20;
The default value is 0
.
public function get padding():Number
public function set padding(value:Number):void
See also
paddingBottom | property |
paddingBottom:Number
The minimum space, in pixels, between the progress bar's bottom edge and the progress bar's content.
In the following example, the bottom padding is set to 20 pixels:
progress.paddingBottom = 20;
The default value is 0
.
public function get paddingBottom():Number
public function set paddingBottom(value:Number):void
paddingLeft | property |
paddingLeft:Number
The minimum space, in pixels, between the progress bar's left edge and the progress bar's content.
In the following example, the left padding is set to 20 pixels:
progress.paddingLeft = 20;
The default value is 0
.
public function get paddingLeft():Number
public function set paddingLeft(value:Number):void
paddingRight | property |
paddingRight:Number
The minimum space, in pixels, between the progress bar's right edge and the progress bar's content.
In the following example, the right padding is set to 20 pixels:
progress.paddingRight = 20;
The default value is 0
.
public function get paddingRight():Number
public function set paddingRight(value:Number):void
paddingTop | property |
paddingTop:Number
The minimum space, in pixels, between the progress bar's top edge and the progress bar's content.
In the following example, the top padding is set to 20 pixels:
progress.paddingTop = 20;
The default value is 0
.
public function get paddingTop():Number
public function set paddingTop(value:Number):void
value | property |
value:Number
The value of the progress bar, between the minimum and maximum.
In the following example, the value is set to 12:
progress.minimum = 0; progress.maximum = 100; progress.value = 12;
The default value is 0
.
public function get value():Number
public function set value(value:Number):void
See also
ProgressBar | () | Constructor |
public function ProgressBar()
Constructor.
autoSizeIfNeeded | () | method |
protected function autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. If the
explicitWidth
or explicitHeight
member
variables are set, those value will be used without additional
measurement. If one is set, but not the other, the dimension with the
explicit value will not be measured, but the other non-explicit
dimension will still need measurement.
Calls setSizeInternal()
to set up the
actualWidth
and actualHeight
member
variables used for layout.
Meant for internal use, and subclasses may override this function with a custom implementation.
ReturnsBoolean |
DIRECTION_HORIZONTAL | Constant |
public static const DIRECTION_HORIZONTAL:String = horizontal
The progress bar fills horizontally (on the x-axis).
See also
DIRECTION_VERTICAL | Constant |
public static const DIRECTION_VERTICAL:String = vertical
The progress bar fills vertically (on the y-axis).
See also