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())@:styleContext1.0.0
.See:
Constructor
Inherited Variables
Defined by BaseProgressBar
@:value(null)@:stylebackgroundSkin:DisplayObject = null
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:
@:value(null)@:styledisabledBackgroundSkin:DisplayObject = null
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:
@:value(null)@:styledisabledFillSkin:DisplayObject = null
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
.@:value(null)@:stylefillSkin:DisplayObject = null
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
.@:value(1.0)maximum:Float = 1.0
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:
@:value(0.0)minimum:Float = 0.0
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:
@:value(0.0)@:stylepaddingBottom:Float = 0.0
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:
@:value(0.0)@:stylepaddingLeft:Float = 0.0
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:
@:value(0.0)@:stylepaddingRight:Float = 0.0
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:
@:value(0.0)@:stylepaddingTop:Float = 0.0
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:
@:value(0.0)value:Float = 0.0
The value of the progress bar, which must be between the minimum
and
the maximum
.
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:
Defined by FeathersControl
@:value(false)read onlycreated:Bool = false
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);
}
See:
@:value(false)read onlyinitialized:Bool = false
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:
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
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
You can set or replace an existing style provider at any time before a component initializes without immediately affecting the component's visual appearance. After the component initializes, the style provider may still be changed, and any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.
1.0.0
.See:
@:value(null)variant:String = null
May be used to provide multiple different variations of the same UI component, each with a different appearance.
1.0.0
.Defined by MeasureSprite
@:value(null)@:isVarexplicitHeight:Null<Float> = null
@:value(null)@:isVarexplicitMaxHeight:Null<Float> = null
@:value(null)@:isVarexplicitMaxWidth:Null<Float> = null
@:value(null)@:isVarexplicitMinHeight:Null<Float> = null
@:value(null)@:isVarexplicitMinWidth:Null<Float> = null
Defined by ValidatingSprite
Inherited Methods
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, Event.INIT
is dispatched.
The following example overrides initialization:
override private function initialize():Void {
super.initialize();
}
1.0.0
.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:
DisplayObject.x
DisplayObject.y
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:
DisplayObject.width
DisplayObject.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
@:value({ flag : null })isInvalid (?flag:String):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()); // true
1.0.0
.@:value({ flag : null })setInvalid (?flag:String):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()); // true
1.0.0
.private@:dox(show)setInvalidationFlag (flag:String):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:
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
.