class VSlider
package feathers.controls
extends BaseSlider › FeathersControl › MeasureSprite › ValidatingSprite
@:directlyUsed@:build(feathers.macros.StyleContextMacro.build())@:autoBuild(feathers.macros.StyleContextMacro.build())@:build(feathers.macros.StyleMacro.build())@:autoBuild(feathers.macros.StyleMacro.build())@:styleContextA vertical slider where you may select a value within a range by dragging a thumb along the y-axis of a track.
The following example sets the slider's range and listens for when the value changes:
var slider = new VSlider();
slider.minimum = 0.0;
slider.maximum = 100.0;
slider.step = 1.0;
slider.value = 12.0;
slider.addEventListener(Event.CHANGE, slider_changeHandler);
this.addChild(slider);1.0.0
.See also:
Constructor
Inherited Variables
Defined by BaseSlider
@:value(true)@:inspectableliveDragging:Bool = true
Determines if the slider dispatches the Event.CHANGE event every time
that the thumb moves while dragging, or only after the user stops
dragging.
In the following example, live dragging is disabled:
slider.liveDragging = false;1.0.0
.@:inspectable(defaultValue = "1.0")maximum:Float
The slider's value cannot be larger than the maximum.
In the following example, the maximum is set to 100.0:
slider.minimum = 0.0;
slider.maximum = 100.0;
slider.step = 1.0;
slider.value = 12.0;1.0.0
.See also:
@:style@:flash.propertymaximumPadding:Float
The space, measured in pixels, between the maximum position of the thumb and the the maximum edge of the track. May be negative to optionally extend the draggable range of the thumb beyond the track's bounds.
In the following example, maximum padding is set to 20 pixels:
slider.maximumPadding = 20.0;1.0.0
.See also:
@:inspectable(defaultValue = "0.0")minimum:Float
The slider's value cannot be smaller than the minimum.
In the following example, the minimum is set to -100.0:
slider.minimum = -100.0;
slider.maximum = 100.0;
slider.step = 1.0;
slider.value = 50.0;1.0.0
.See also:
@:style@:flash.propertyminimumPadding:Float
The space, measured in pixels, between the minimum position of the thumb and the the minimum edge of the track. May be negative to optionally extend the draggable range of the thumb beyond the track's bounds.
In the following example, minimum padding is set to 20 pixels:
slider.minimumPadding = 20.0;1.0.0
.See also:
@:style@:flash.propertysecondaryTrackSkin:InteractiveObject
The skin to use for the slider's optional secondary track. If a slider has one track, it will fill the entire length of the slider. If a slider has a track and a secondary track, the primary track will stretch between the minimum edge of the slider and the location of the slider's thumb, while the secondary track will stretch from the location of the slider's thumb to the maximum edge of the slider.
In the following example, a track skin and a secondary track skin are passed to the slider:
var skin = new RectangleSkin();
skin.fill = SolidColor(0xaaaaaa);
slider.trackSkin = skin;
var skin = new RectangleSkin();
skin.fill = SolidColor(0xcccccc);
slider.secondaryTrackSkin = skin;1.0.0
.See also:
@:inspectable(defaultValue = "0.0")snapInterval:Float
When the slider's value changes, it may be "snapped" to the nearest
multiple of snapInterval. If snapInterval is 0.0, the value is
not snapped.
In the following example, the snap inverval is changed to 1.0:
slider.minimum = 0.0;
slider.maximum = 100.0;
slider.step = 1.0;
slider.snapInterval = 1.0;
slider.value = 10.0;1.0.0
.See also:
step:Float
Indicates the amount that value is changed when the slider has focus
and one of the arrow keys is pressed.
The value should always be greater than 0.0 to ensure that the slider
reacts to keyboard events when focused.
In the following example, the step is changed to 1.0:
slider.minimum = 0.0;
slider.maximum = 100.0;
slider.step = 1.0;
slider.value = 10.0;1.0.0
.See also:
@:style@:flash.propertythumbSkin:InteractiveObject
The skin to use for the slider's thumb.
In the following example, a thumb skin is passed to the slider:
var skin = new RectangleSkin();
skin.fill = SolidColor(0xcccccc);
slider.thumbSkin = skin;1.0.0
.See also:
@:style@:flash.propertytrackSkin:InteractiveObject
The skin to use for the slider's track.
In the following example, a track skin is passed to the slider:
var skin = new RectangleSkin();
skin.fill = SolidColor(0xcccccc);
slider.trackSkin = skin;1.0.0
.See also:
@:bindable("change")@:inspectable(defaultValue = "0.0")value:Float
The value of the slider, which must be between the minimum and the
maximum.
When the value property changes, the slider will dispatch an event of
type Event.CHANGE.
In the following example, the value is changed to 12.0:
slider.minimum = 0.0;
slider.maximum = 100.0;
slider.step = 1.0;
slider.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 BaseSlider
applyValueRestrictions():Void
Applies the minimum, maximum, and snapInterval restrictions to the
current value.
Because it's possible to set value to a numeric value that is outside
the allowed range, or to a value that has not been snapped to the
interval, this method may be called to apply the restrictions manually.
1.0.0
.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
.