class HProgressBar
package feathers.controls
extends BaseProgressBar › FeathersControl › MeasureSprite › ValidatingSprite
@:directlyUsed@:build(feathers.macros.StyleContextMacro.build())@:autoBuild(feathers.macros.StyleContextMacro.build())@:build(feathers.macros.StyleMacro.build())@:autoBuild(feathers.macros.StyleMacro.build())@:styleContextDisplays the progress of a task in a horizontal direction, from left to right.
The following example creates a progress bar:
var progressBar = new HProgressBar();
progressBar.minimum = 0.0;
progressBar.maximum = 100.0;
progressBar.value = 50.0;
this.addChild(progressBar);1.0.0
.See also:
Constructor
@:value({ maximum : 1.0, minimum : 0.0, value : 0.0 })new(value:Float = 0.0, minimum:Float = 0.0, maximum:Float = 1.0, ?changeListener:Event ‑> Void)
Creates a new HProgressBar object.
1.0.0
.Inherited Variables
Defined by BaseProgressBar
@:style@:flash.propertybackgroundSkin: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 measurable 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
OpenFL 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:
var skin = new RectangleSkin();
skin.fill = SolidColor(0xcccccc);
progress.backgroundSkin = skin;1.0.0
.See also:
@:style@:flash.propertydisabledBackgroundSkin:DisplayObject
The background skin to display when the progress bar is disabled.
In the following example, the progress bar is given a disabled background skin:
var skin = new RectangleSkin();
skin.fill = SolidColor(0xdddddd);
progress.disabledBackgroundSkin = skin;
progress.enabled = false;1.0.0
.See also:
@:style@:flash.propertydisabledFillSkin:DisplayObject
The fill skin to display when the progress bar is disabled.
In the following example, the progress bar is given a disabled fill skin:
var skin = new RectangleSkin();
skin.fill = SolidColor(0xcccccc);
progress.disabledFillSkin = skin;
progress.enabled = false;1.0.0
.@:style@:flash.propertyfillMode:ProgressBarFillMode
Controls how the fill of the progress bar is rendered.
In the following example, the fill's mask is resized:
progress.fillMode = MASK;1.1.0
.@:style@:flash.propertyfillSkin:DisplayObject
The primary fill to display in the progress bar. The fill skin is rendered above the background skin, with padding around the edges of the the fill skin to reveal the background skin behind.
In the following example, the progress bar is given a fill skin:
var skin = new RectangleSkin();
skin.fill = SolidColor(0xaaaaaa);
progress.fillSkin = skin;1.0.0
.indeterminate:Bool
Indicates if a progress bar has a determinate or indeterminate appearance. Typically, an indeterminate progress bar will be animated, and will appear as if it has no specific value.
In the following example, the progress bar is made indeterminate:
progress.indeterminate = true;1.3.0
.@:style@:flash.propertyindeterminateDuration:Float
The duration of the indeterminate effect, measured in seconds.
1.3.0
.@:style@:flash.propertyindeterminateFillSkin:DisplayObject
The indeterminate skin to display. This skin will be animated when the progress bar is added to the display list, unless the activity indicator isn't in indeterminate mode.
If the skin implements the IIndeterminateSkin interface, its
indeterminatePosition property will be updated every frame with a
value between 0.0 and 1.0, based on the indeterminateDuration
property. If the skin does not implement IIndeterminateSkin, its
alpha property will be animated to fade in and out repeatedly.
The following example passes a bitmap for the activity indicator to use as a skin:
progressBar.indeterminateFillSkin = new Bitmap(bitmapData);1.3.0
.@:inspectable(defaultValue = "1.0")maximum:Float
The progress bar's value cannot be larger than the maximum.
In the following example, the maximum is set to 100.0:
progress.minimum = 0.0;
progress.maximum = 100.0;
progress.value = 12.0;1.0.0
.See also:
@:inspectable(defaultValue = "0.0")minimum:Float
The progress bar's value cannot be smaller than the minimum.
In the following example, the minimum is set to -100:
progress.minimum = -100;
progress.maximum = 100;
progress.value = 50;1.0.0
.See also:
@:style@:flash.propertypaddingBottom:Float
The minimum space, in pixels, between the progress bar's bottom edge and the progress bar's fill skin.
In the following example, the progress bar's bottom padding is set to 20 pixels:
progress.paddingBottom = 20.0;1.0.0
.See also:
@:style@:flash.propertypaddingLeft:Float
The minimum space, in pixels, between the progress bar's left edge and the text input's content.
In the following example, the progress bar's left padding is set to 20 pixels:
progress.paddingLeft = 20.0;1.0.0
.See also:
@:style@:flash.propertypaddingRight:Float
The minimum space, in pixels, between the progress bar's right edge and the progress bar's fill skin.
In the following example, the progress bar's right padding is set to 20 pixels:
progress.paddingRight = 20.0;1.0.0
.See also:
@:style@:flash.propertypaddingTop:Float
The minimum space, in pixels, between the progress bar's top edge and the progress bar's fill skin.
In the following example, the progress bar's top padding is set to 20 pixels:
progress.paddingTop = 20.0;1.0.0
.See also:
@:bindable("change")@:inspectable(defaultValue = "0.0")value:Float
The value of the progress bar, which must be between the minimum and
the maximum.
When the value property changes, the progress bar will dispatch an event
of type Event.CHANGE.
In the following example, the value is changed to 12.0:
progress.minimum = 0.0;
progress.maximum = 100.0;
progress.value = 12.0;1.0.0
.See also:
Defined by FeathersControl
@:stylealwaysShowFocus:Bool
Indicates if the focusRectSkin should always be displayed when the
component is focused, or only after keyboard focus changes.
1.3.0
.@:bindable("creationComplete")read onlycreated:Bool
Determines if the component has been initialized and validated for the first time.
In the following example, we check if the component is created or not, and we listen for an event if it isn't:
if(!control.created)
{
control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}1.0.0
.See also:
@styledisabledAlpha:Null<Float>
When disabledAlpha is not null, sets the alpha property to this
value when the the enabled property is set to false.
1.0.0
.@stylefocusPaddingBottom:Float
Optional padding outside the bottom edge of this UI component when the
focusRectSkin is visible.
1.0.0
.@stylefocusPaddingLeft:Float
Optional padding outside the left edge of this UI component when the
focusRectSkin is visible.
1.0.0
.@stylefocusPaddingRight:Float
Optional padding outside the right edge of this UI component when the
focusRectSkin is visible.
1.0.0
.@stylefocusPaddingTop:Float
Optional padding outside the top edge of this UI component when the
focusRectSkin is visible.
1.0.0
.@stylefocusRectSkin:DisplayObject
An optional skin to display when an IFocusObject component receives
focus.
1.0.0
.@:bindable("layoutDataChange")includeInLayout:Bool
@:bindable("initialize")read onlyinitialized:Bool
Determines if the component has been initialized yet. The initialize()
function is called one time only, when the Feathers UI control is added
to the display list for the first time.
In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:
if(!control.initialized)
{
control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}1.0.0
.See also:
@style@:bindable("layoutDataChange")layoutData:ILayoutData
read onlystyleContext:Class<IStyleObject>
The class used as the context for styling the component. If a subclass
of a component should have different styles than its superclass, it
should override the get_styleContext getter. However, if a subclass
should continue using the same styles as its superclass, it happens
automatically.
1.0.0
.styleProvider:IStyleProvider
Typically used by the theme to provide styles to each component, but a custom style provider may be provided that will take precedence over the theme's style provider.
When a component initializes, its style provider sets properties that
affect the component's visual appearance. If the style provider
dispatches StyleProviderEvent.STYLES_CHANGE after the component has
initialized, the original properties set by the style provider will be
reset to their default values and before applying the new property
values.
Setting the style provider or replacing an existing style provider
before a component initializes will queue up the style changes until after
initialization. Once a component initializes, the style provider
may be changed, but the changes will be applied immediately. Similarly
to when a style provider dispatcches StyleProviderEvent.STYLES_CHANGE,
any properties that were set by the previous style provider will be
reset to their default values before applying the new style provider.
If the themeEnabled property is false, the current theme's style
provider will be ignored. However, if a custom style provider was
provided from outside of the theme, it will still be used.
1.0.0
.See also:
@:inspectablevariant:String
May be used to provide multiple different variations of the same UI component, each with a different appearance.
1.0.0
.Defined by MeasureSprite
Defined by ValidatingSprite
read onlyvalidating:Bool
Indicates if the display object is currently validating.
1.0.0
.Inherited Methods
Defined by BaseProgressBar
setPadding(value:Float):Void
Sets all four padding properties to the same value.
1.0.0
.See also:
Defined by FeathersControl
private@:dox(show)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. Do things like create children and set up event listeners. After this function is called, `FeathersEvent.INITIALIZE is dispatched.
The following example overrides initialization:
override private function initialize():Void {
super.initialize();
}1.0.0
.See also:
move(x:Float, y:Float):Void
Sets both the x and y positions of the control in a single function
call.
1.0.0
.See also:
DisplayObject.xDisplayObject.y
setFocusPadding(value:Float):Void
Sets all four padding properties to the same value.
1.0.0
.See also:
setSize(width:Float, height:Float):Void
Sets both the width and height dimensions of the control in a single
function call.
1.0.0
.See also:
DisplayObject.widthDisplayObject.height
private@:dox(show)setStyle(styleName:String, ?state:EnumValue):Bool
Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.
1.0.0
.Defined by MeasureSprite
private@:value({ minHeight : 0.0, minWidth : 0.0 })@:dox(show)saveMeasurements(width:Float, height:Float, minWidth:Float = 0.0, minHeight:Float = 0.0, ?maxWidth:Float, ?maxHeight:Float):Bool
Saves the calculated dimensions for the component, replacing any values
that haven't been set explicitly. Returns true if the reported values
have changed and Event.RESIZE was dispatched.
1.0.0
.Defined by ValidatingSprite
isInvalid(?flag:InvalidationFlag):Bool
Indicates whether the control is pending validation or not. By default,
returns true if any invalidation flag has been set. If you pass in a
specific flag, returns true only if that flag has been set (others may
be set too, but it checks the specific flag only. If all flags have been
marked as invalid, always returns true.
The following example invalidates a component:
component.setInvalid();
trace(component.isInvalid()); // true1.0.0
.runWithInvalidationFlagsOnly(callback:() ‑> Void):Void
Calls a function that temporarily limits setInvalid() calls to
setting invalidation flags only, and the control will not be added to
the validation queue. In other words, setInvalid() calls will work
similarly to setInvalidationFlag() instead.
Typically, this method should be called only during validation. If
called outside of update(), the component's validation may be delayed
until a future call to setInvalid().
1.2.0
.runWithoutInvalidation(callback:() ‑> Void):Void
Calls a function that temporarily disables invalidation. In other words,
calls to setInvalid() will be ignored until the function returns.
1.0.0
.setInvalid(?flag:InvalidationFlag):Void
Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.
If you cannot wait until later for the validation to happen, you
can call validate() to redraw immediately. As an example,
you might want to validate immediately if you need to access the
correct width or height values of the UI
control, since these values are calculated during validation.
The following example invalidates a component:
component.setInvalid();
trace(component.isInvalid()); // true1.0.0
.private@:dox(show)setInvalidationFlag(flag:InvalidationFlag):Void
Sets an invalidation flag. This will not add the component to the
validation queue. It only sets the flag. A subclass might use
this function during draw() to manipulate the flags that
its superclass sees.
1.0.0
.See also:
private@:dox(show)update():Void
Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.
The following example overrides updating after invalidation:
override private function update():Void {
super.update();
}1.0.0
.