Package | feathers.controls |
Class | public class ProgressBar |
Inheritance | ProgressBar FeathersControl starling.display.Sprite |
Product Version : | Feathers 1.0.0 |
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 | ||
---|---|---|---|
addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | 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 | ||
depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | ||
effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | ||
explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | ||
explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | ||
explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | ||
explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | ||
explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | ||
explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | ||
focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | ||
focusManager : IFocusManager
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The current focus manager for this component. | FeathersControl | ||
focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | ||
focusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Used for associating focusable display objects that are not direct
children with an "owner" focusable display object, such as pop-ups. | FeathersControl | ||
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all ProgressBar
components. | ProgressBar | ||
height : Number [override]
The height of the component, in pixels. | FeathersControl | ||
hideEffect : Function
An optional effect that is activated when the component is hidden. | 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
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
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 | ||
isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | ||
layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | ||
maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | 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 | ||
moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | ||
nextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | ||
nextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | ||
nextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | ||
nextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when the tab key is pressed
when a focus manager is enabled. | FeathersControl | ||
nextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | ||
previousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The previous object that will receive focus when the tab key is
pressed while holding shift when a focus manager is enabled. | FeathersControl | ||
resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | ||
showEffect : Function
An optional effect that is activated when the component is shown. | 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 | ||
toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | 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 | ||
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override]
Feathers components use an optimized getBounds()
implementation that may sometimes behave differently than regular
Starling display objects. | FeathersControl | ||
hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | ||
initializeNow():void
If the component has not yet initialized, initializes immediately. | 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 | ||
removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | ||
resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | ||
resumeEffects():void
Indicates that effects should be re-activated after being suspended. | 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
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | ||
suspendEffects():void
Indicates that effects should not be activated temporarily. | 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 | ||
ignoreNextStyleRestriction():void
The next style that is set will not be restricted. | 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 | ||
processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to
determine if the setter has been called directly on the component or
from a style provider. | FeathersControl | ||
refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | ||
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the
component. | 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 |
Style | Defined By | ||
---|---|---|---|
backgroundDisabledSkin : DisplayObject A background to display when the progress bar is disabled. | ProgressBar | ||
backgroundSkin : DisplayObject The primary background to display in the progress bar. | ProgressBar | ||
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 in the progress bar. | ProgressBar | ||
focusIndicatorSkin : DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called. | 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 | ||
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 |
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
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 saveMeasurements()
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 |
paddingLeft | style |
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
.
See also
paddingBottom | style |
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
.
See also
paddingRight | style |
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
.
See also
paddingTop | style |
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
.
See also
padding | style |
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
.
See also
fillDisabledSkin | style |
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
.
See also
fillSkin | style |
fillSkin:DisplayObject
The primary fill to display in the progress bar. The fill skin is displayed over the background skin, with padding around the edges of the fill skin to reveal the background skin behind.
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 an Image
with a
scale9Grid
as the skin, it may require a minimum width
before the image parts begin to overlap. In that case, the
Image
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
.
See also
direction | style |
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 = Direction.VERTICAL;
Note: The Direction.NONE
constant is not supported.
The default value is feathers.layout.Direction.HORIZONTAL
.
See also
backgroundDisabledSkin | style |
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
.
See also
backgroundSkin | style |
backgroundSkin:DisplayObject
The primary background to display in the progress bar. The background skin is displayed below the fill skin, and the fill skin is affected by the padding, and the background skin may be seen around the edges.
The original width or height of the background skin will be one
of the values used to calculate the width or height of the progress
bar, if the width
and height
properties are
not set explicitly. The fill skin and padding values will also be
used.
If the background skin is a Feathers component, the
minWidth
or minHeight
properties will be
one of the values used to calculate the width or height of the
progress bar. If the background skin is a regular Starling display
object, the original width and height of the display object will be
used to calculate the minimum dimensions instead.
In the following example, the progress bar is given a background skin:
progress.backgroundSkin = new Image( texture );
The default value is null
.
See also