GODPAPER | All Packages | All Classes | Index | Frames No Frames |
Slider

Package | feathers.controls
Class | public class Slider
Inheritance | Slider FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object
Implements | IScrollBar, IFocusDisplayObject

Select a value between a minimum and a maximum by dragging a thumb over the bounds of a track. The slider's track is divided into two parts split by the thumb.

See also

http://wiki.starling-framework.org/feathers/slider

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alpha : Number The opacity of the object. | DisplayObject
|  | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject
|  | blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject
|  | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject
|  | clipRect : Rectangle [override] | FeathersControl
|  | customMaximumTrackName : String A name to add to the slider's maximum track sub-component. | Slider
|  | customMinimumTrackName : String A name to add to the slider's minimum track sub-component. | Slider
|  | customThumbName : String A name to add to the slider's thumb sub-component. | Slider
|  | 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
|  | direction : String Determines if the slider's thumb can be dragged horizontally or vertically. | Slider
|  | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject
|  | focusManager : IFocusManager The current focus manager for this component. | FeathersControl
|  | hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject
|  | 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
|  | isEnabled : Boolean Indicates whether the control is interactive or not. | FeathersControl
|  | isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite
|  | isFocusEnabled : Boolean 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
|  | layoutData : ILayoutData Extra parameters associated with this display object that will be used by the layout algorithm. | FeathersControl
|  | liveDragging : Boolean = true Determines if the slider dispatches the Event.CHANGE event every time the thumb moves, or only once it stops moving. | Slider
|  | 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 slider's value will not go higher than the maximum. | Slider
|  | maximumPadding : Number The space, in pixels, between the maximum position of the thumb and the maximum edge of the track. | Slider
|  | maximumTrackFactory : Function A function used to generate the slider's maximum track sub-component. | Slider
|  | maximumTrackProperties : Object A set of key/value pairs to be passed down to the slider's maximum track sub-component. | Slider
|  | 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 slider's value will not go lower than the minimum. | Slider
|  | minimumPadding : Number The space, in pixels, between the minimum position of the thumb and the minimum edge of the track. | Slider
|  | minimumTrackFactory : Function A function used to generate the slider's minimum track sub-component. | Slider
|  | minimumTrackProperties : Object A set of key/value pairs to be passed down to the slider's minimum track sub-component. | Slider
|  | 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
|  | name : String [override] The concatenated nameList, with each name separated by spaces. | FeathersControl
|  | nameList : TokenList [read-only] Contains a list of all "names" assigned to this control. | FeathersControl
|  | nextTabFocus : IFocusDisplayObject The next object that will receive focus when the tab key is pressed. | FeathersControl
|  | numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer
|  | page : Number If the slider's track is touched, and the thumb is shown, the slider value will be incremented or decremented by the page value. | Slider
|  | parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject
|  | pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject
|  | pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject
|  | repeatDelay : Number The time, in seconds, before actions are repeated. | Slider
|  | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject
|  | rotation : Number The rotation of the object in radians. | DisplayObject
|  | scaleX : Number The horizontal scale factor. | DisplayObject
|  | scaleY : Number The vertical scale factor. | DisplayObject
|  | showThumb : Boolean Determines if the thumb should be displayed. | Slider
|  | skewX : Number The horizontal skew angle in radians. | DisplayObject
|  | skewY : Number The vertical skew angle in radians. | DisplayObject
|  | stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected to the stage. | DisplayObject
|  | step : Number As the slider's thumb is dragged, the value is snapped to a multiple of the step. | Slider
|  | thumbFactory : Function A function used to generate the slider's thumb sub-component. | Slider
|  | thumbProperties : Object A set of key/value pairs to be passed down to the slider's thumb sub-component. | Slider
|  | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject
|  | trackLayoutMode : String Determines how the minimum and maximum track skins are positioned and sized. | Slider
|  | trackScaleMode : String Determines how the minimum and maximum track skins are positioned and sized. | Slider
|  | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject
|  | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject
|  | value : Number The value of the slider, between the minimum and maximum. | Slider
|  | visible : Boolean The visibility of the object. | DisplayObject
|  | width : Number [override] The width of the component, in pixels. | FeathersControl
|  | x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject
|  | y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | actualHeight : Number = 0 The final height value that should be used for layout. | FeathersControl
|  | actualWidth : Number = 0 The final width value that should be used for layout. | FeathersControl
|  | explicitHeight : Number = NaN The height value explicitly set by calling the height setter or setSize(). | FeathersControl
|  | explicitWidth : Number = NaN The width value explicitly set by calling the width setter or setSize(). | FeathersControl
|  | maximumTrack : Button The maximum track sub-component. | Slider
|  | maximumTrackName : String = feathers-slider-maximum-track The value added to the nameList of the maximum track. | Slider
|  | minimumTrack : Button The minimum track sub-component. | Slider
|  | minimumTrackName : String = feathers-slider-minimum-track The value added to the nameList of the minimum track. | Slider
|  | thumb : Button The thumb sub-component. | Slider
|  | thumbName : String = feathers-slider-thumb The value added to the nameList of the thumb. | Slider

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Slider() Constructor. | Slider
|  | addChild(child:DisplayObject):DisplayObject Adds a child to the container. | DisplayObjectContainer
|  | addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child to the container at a certain index. | DisplayObjectContainer
|  | addEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system of the object. | DisplayObject
|  | broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer
|  | broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer
|  | contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer
|  | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher
|  | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered listeners for the given type. | EventDispatcher
|  | dispose():void [override] Disposes the resources of all children. | Sprite
|  | flatten():void Optimizes the sprite for optimal rendering performance. | Sprite
|  | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another coordinate system. | Sprite
|  | getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer
|  | getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer
|  | getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer
|  | getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or null if the sprite doens't have a clipRect. | Sprite
|  | getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system to another. | DisplayObject
|  | globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject
|  | hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher
|  | hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails. | Sprite
|  | 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
|  | localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject
|  | removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject Removes a child from the container. | DisplayObjectContainer
|  | removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer
|  | removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer
|  | removeEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | removeEventListeners(type:String = null):void [override] | DisplayObject
|  | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject
|  | render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite
|  | setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer
|  | setSize(width:Number, height:Number):void Sets both the width and the height of the control. | FeathersControl
|  | sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function of the Vector class). | DisplayObjectContainer
|  | swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the indexes of two children. | DisplayObjectContainer
|  | swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer
|  | unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite
|  | validate():void Immediately validates the control, which triggers a redraw, if one is pending. | FeathersControl

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | draw():void Override to customize layout and to adjust properties of children. | 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
|  | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean Sets the width and height of the control, with the option of invalidating or not. | FeathersControl

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | added | Dispatched when an object is added to a parent. | DisplayObject
|  | addedToStage | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject
|  | beginInteraction | Dispatched when the user starts dragging the slider's thumb or track. | Slider
|  | change | Dispatched when the slider's value changes. | Slider
|  | endInteraction | Dispatched when the user stops dragging the slider's thumb or track. | Slider
|  | enterFrame | Dispatched once every frame on every object that is connected to the stage. | DisplayObject
|  | flatten | Dispatched on all children when the object is flattened. | Sprite
|  | initialize | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl
|  | keyDown | Dispatched when a key on the keyboard is pressed. | DisplayObject
|  | keyUp | Dispatched when a key on the keyboard is released. | DisplayObject
|  | removed | Dispatched when an object is removed from its parent. | DisplayObject
|  | removedFromStage | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject
|  | resize | Dispatched when the width or height of the control changes. | FeathersControl
|  | touch | Dispatched when an object is touched. | DisplayObject

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | DEFAULT_CHILD_NAME_MAXIMUM_TRACK : String = feathers-slider-maximum-track [static] The default value added to the nameList of the maximum track. | Slider
|  | DEFAULT_CHILD_NAME_MINIMUM_TRACK : String = feathers-slider-minimum-track [static] The default value added to the nameList of the minimum track. | Slider
|  | DEFAULT_CHILD_NAME_THUMB : String = feathers-slider-thumb [static] The default value added to the nameList of the thumb. | Slider
|  | DIRECTION_HORIZONTAL : String = horizontal [static] The slider's thumb may be dragged horizontally (on the x-axis). | Slider
|  | DIRECTION_VERTICAL : String = vertical [static] The slider's thumb may be dragged vertically (on the y-axis). | Slider
|  | 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_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
|  | TRACK_LAYOUT_MODE_MIN_MAX : String = minMax [static] The slider has two tracks, stretching to fill each side of the slider with the thumb in the middle. | Slider
|  | TRACK_LAYOUT_MODE_SINGLE : String = single [static] The slider has only one track, that fills the full length of the slider. | Slider
|  | TRACK_SCALE_MODE_DIRECTIONAL : String = directional [static] If the slider's direction is horizontal, the width of the track will fill the full width of the slider, and if the slider's direction is vertical, the height of the track will fill the full height of the slider. | Slider
|  | TRACK_SCALE_MODE_EXACT_FIT : String = exactFit [static] The slider's track dimensions fill the full width and height of the slider. | Slider

Property Detail

customMaximumTrackName | property

`customMaximumTrackName:String`

A name to add to the slider's maximum track sub-component. Typically used by a theme to provide different skins to different sliders.

Implementation
`public function get customMaximumTrackName():String`
`public function set customMaximumTrackName(value:String):void`

See also

feathers.core.FeathersControl.nameList
maximumTrackFactory
maximumTrackProperties

customMinimumTrackName | property |

`customMinimumTrackName:String`

A name to add to the slider's minimum track sub-component. Typically used by a theme to provide different skins to different sliders.

Implementation
`public function get customMinimumTrackName():String`
`public function set customMinimumTrackName(value:String):void`

See also

feathers.core.FeathersControl.nameList
minimumTrackFactory
minimumTrackProperties

customThumbName | property |

`customThumbName:String`

A name to add to the slider's thumb sub-component. Typically used by a theme to provide different skins to different sliders.

Implementation
`public function get customThumbName():String`
`public function set customThumbName(value:String):void`

See also

feathers.core.FeathersControl.nameList
thumbFactory
thumbProperties

direction | property |

`direction:String`

Determines if the slider's thumb can be dragged horizontally or vertically. When this value changes, the slider's width and height values do not change automatically.

The default value is `DIRECTION_HORIZONTAL`.

Implementation
`public function get direction():String`
`public function set direction(value:String):void`

See also

DIRECTION_HORIZONTAL
DIRECTION_VERTICAL

liveDragging | property |

`public var liveDragging:Boolean = true`

Determines if the slider dispatches the `Event.CHANGE` event every time the thumb moves, or only once it stops moving.

maximum | property |

`maximum:Number`

The slider's value will not go higher than the maximum.

Implementation
`public function get maximum():Number`
`public function set maximum(value:Number):void`

maximumPadding | property |

`maximumPadding:Number`

The space, in pixels, between the maximum position of the thumb and the maximum edge of the track. May be negative to extend the range of the thumb.

Implementation
`public function get maximumPadding():Number`
`public function set maximumPadding(value:Number):void`

maximumTrack | property |

`protected var maximumTrack:Button`

The maximum track sub-component.

maximumTrackFactory | property |

`maximumTrackFactory:Function`

A function used to generate the slider's maximum track sub-component. This can be used to change properties on the maximum track when it is first created. For instance, if you are skinning Feathers components without a theme, you might use `maximumTrackFactory` to set skins and other styles on the maximum track.

The function should have the following signature:

    function():Button

Implementation
`public function get maximumTrackFactory():Function`
`public function set maximumTrackFactory(value:Function):void`

See also

maximumTrackProperties

maximumTrackName | property |

`protected var maximumTrackName:String = feathers-slider-maximum-track`

The value added to the `nameList` of the maximum track.

maximumTrackProperties | property |

`maximumTrackProperties:Object`

A set of key/value pairs to be passed down to the slider's maximum track sub-component. The maximum track is a `feathers.controls.Button` instance.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute `@` notation. For example, to set the skin on the thumb of a `SimpleScrollBar` which is in a `Scroller` which is in a `List`, you can use the following syntax:

    list.scrollerProperties.@verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Implementation
`public function get maximumTrackProperties():Object`
`public function set maximumTrackProperties(value:Object):void`

See also

feathers.controls.Button

minimum | property |

`minimum:Number`

The slider's value will not go lower than the minimum.

Implementation
`public function get minimum():Number`
`public function set minimum(value:Number):void`

minimumPadding | property |

`minimumPadding:Number`

The space, in pixels, between the minimum position of the thumb and the minimum edge of the track. May be negative to extend the range of the thumb.

Implementation
`public function get minimumPadding():Number`
`public function set minimumPadding(value:Number):void`

minimumTrack | property |

`protected var minimumTrack:Button`

The minimum track sub-component.

minimumTrackFactory | property |

`minimumTrackFactory:Function`

A function used to generate the slider's minimum track sub-component. This can be used to change properties on the minimum track when it is first created. For instance, if you are skinning Feathers components without a theme, you might use `minimumTrackFactory` to set skins and other styles on the minimum track.

The function should have the following signature:

    function():Button

Implementation
`public function get minimumTrackFactory():Function`
`public function set minimumTrackFactory(value:Function):void`

See also

minimumTrackProperties

minimumTrackName | property |

`protected var minimumTrackName:String = feathers-slider-minimum-track`

The value added to the `nameList` of the minimum track.

minimumTrackProperties | property |

`minimumTrackProperties:Object`

A set of key/value pairs to be passed down to the slider's minimum track sub-component. The minimum track is a `feathers.controls.Button` instance.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute `@` notation. For example, to set the skin on the thumb of a `SimpleScrollBar` which is in a `Scroller` which is in a `List`, you can use the following syntax:

    list.scrollerProperties.@verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Implementation
`public function get minimumTrackProperties():Object`
`public function set minimumTrackProperties(value:Object):void`

See also

feathers.controls.Button

page | property |

`page:Number`

If the slider's track is touched, and the thumb is shown, the slider value will be incremented or decremented by the page value. If the thumb is hidden, this value is ignored, and the track may be dragged instead.

If this value is `NaN`, the `step` value will be used instead. If the `step` value is zero, paging with the track is not possible.

Implementation
`public function get page():Number`
`public function set page(value:Number):void`

repeatDelay | property |

`repeatDelay:Number`

The time, in seconds, before actions are repeated. The first repeat happens after a delay that is five times longer than the following repeats.

Implementation
`public function get repeatDelay():Number`
`public function set repeatDelay(value:Number):void`

showThumb | property |

`showThumb:Boolean`

Determines if the thumb should be displayed.

Implementation
`public function get showThumb():Boolean`
`public function set showThumb(value:Boolean):void`

step | property |

`step:Number`

As the slider's thumb is dragged, the value is snapped to a multiple of the step. Paging using the slider's track will use the `step` value if the `page` value is `NaN`. If the `step` is zero, paging with the track will not be possible.

Implementation
`public function get step():Number`
`public function set step(value:Number):void`

thumb | property |

`protected var thumb:Button`

The thumb sub-component.

thumbFactory | property |

`thumbFactory:Function`

A function used to generate the slider's thumb sub-component. This can be used to change properties on the thumb when it is first created. For instance, if you are skinning Feathers components without a theme, you might use `thumbFactory` to set skins and text styles on the thumb.

The function should have the following signature:

    function():Button

Implementation
`public function get thumbFactory():Function`
`public function set thumbFactory(value:Function):void`

See also

thumbProperties

thumbName | property |

`protected var thumbName:String = feathers-slider-thumb`

The value added to the `nameList` of the thumb.

thumbProperties | property |

`thumbProperties:Object`

A set of key/value pairs to be passed down to the slider's thumb sub-component. The thumb is a `feathers.controls.Button` instance.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute `@` notation. For example, to set the skin on the thumb of a `SimpleScrollBar` which is in a `Scroller` which is in a `List`, you can use the following syntax:

    list.scrollerProperties.@verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Implementation
`public function get thumbProperties():Object`
`public function set thumbProperties(value:Object):void`

See also

feathers.controls.Button

trackLayoutMode | property |

`trackLayoutMode:String`

Determines how the minimum and maximum track skins are positioned and sized.

The default value is `TRACK_LAYOUT_MODE_SINGLE`.

Implementation
`public function get trackLayoutMode():String`
`public function set trackLayoutMode(value:String):void`

See also

TRACK_LAYOUT_MODE_SINGLE
TRACK_LAYOUT_MODE_MIN_MAX

trackScaleMode | property |

`trackScaleMode:String`

Determines how the minimum and maximum track skins are positioned and sized.

The default value is `TRACK_SCALE_MODE_DIRECTIONAL`.

Implementation
`public function get trackScaleMode():String`
`public function set trackScaleMode(value:String):void`

See also

TRACK_SCALE_MODE_DIRECTIONAL
TRACK_SCALE_MODE_EXACT_FIT
trackLayoutMode

value | property |

`value:Number`

The value of the slider, between the minimum and maximum.

Implementation
`public function get value():Number`
`public function set value(value:Number):void`
Constructor Detail

Slider | () | Constructor

`public function Slider()`

Constructor.

Event Detail

beginInteraction | Event

Event Object Type: `starling.events.Event`
Event.type property = `feathers.events.FeathersEventType.BEGIN_INTERACTION`

Dispatched when the user starts dragging the slider's thumb or track.

The `FeathersEventType.BEGIN_INTERACTION` event type is used by many UI controls where a drag or other interaction happens over time. An example is a `Slider` control where the user touches the thumb to begin dragging.

change | Event |

Event Object Type: `starling.events.Event`
Event.type property = `starling.events.Event.CHANGE`

Dispatched when the slider's value changes.

An event type to be utilized in custom events. Not used by Starling right now.

endInteraction | Event |

Event Object Type: `starling.events.Event`
Event.type property = `feathers.events.FeathersEventType.END_INTERACTION`

Dispatched when the user stops dragging the slider's thumb or track.

The `FeathersEventType.END_INTERACTION` event type is used by many UI controls where a drag or other interaction happens over time. An example is a `Slider` control where the user stops touching the thumb after dragging.
Constant Detail

DEFAULT_CHILD_NAME_MAXIMUM_TRACK | Constant

`public static const DEFAULT_CHILD_NAME_MAXIMUM_TRACK:String = feathers-slider-maximum-track`

The default value added to the `nameList` of the maximum track.

DEFAULT_CHILD_NAME_MINIMUM_TRACK | Constant |

`public static const DEFAULT_CHILD_NAME_MINIMUM_TRACK:String = feathers-slider-minimum-track`

The default value added to the `nameList` of the minimum track.

DEFAULT_CHILD_NAME_THUMB | Constant |

`public static const DEFAULT_CHILD_NAME_THUMB:String = feathers-slider-thumb`

The default value added to the `nameList` of the thumb.

DIRECTION_HORIZONTAL | Constant |

`public static const DIRECTION_HORIZONTAL:String = horizontal`

The slider's thumb may be dragged horizontally (on the x-axis).

DIRECTION_VERTICAL | Constant |

`public static const DIRECTION_VERTICAL:String = vertical`

The slider's thumb may be dragged vertically (on the y-axis).

TRACK_LAYOUT_MODE_MIN_MAX | Constant |

`public static const TRACK_LAYOUT_MODE_MIN_MAX:String = minMax`

The slider has two tracks, stretching to fill each side of the slider with the thumb in the middle. The tracks will be resized as the thumb moves. This layout mode is designed for sliders where the two sides of the track may be colored differently to show the value "filling up" as the slider is dragged.

Since the width and height of the tracks will change, consider sing a special display object such as a `Scale9Image`, `Scale3Image` or a `TiledImage` that is designed to be resized dynamically.

See also

feathers.display.Scale9Image
feathers.display.Scale3Image
feathers.display.TiledImage

TRACK_LAYOUT_MODE_SINGLE | Constant |

`public static const TRACK_LAYOUT_MODE_SINGLE:String = single`

The slider has only one track, that fills the full length of the slider. In this layout mode, the "minimum" track is displayed and fills the entire length of the slider. The maximum track will not exist.

TRACK_SCALE_MODE_DIRECTIONAL | Constant |

`public static const TRACK_SCALE_MODE_DIRECTIONAL:String = directional`

If the slider's direction is horizontal, the width of the track will fill the full width of the slider, and if the slider's direction is vertical, the height of the track will fill the full height of the slider. The other edge will not be scaled.

TRACK_SCALE_MODE_EXACT_FIT | Constant |

`public static const TRACK_SCALE_MODE_EXACT_FIT:String = exactFit`

The slider's track dimensions fill the full width and height of the slider.

Thu Jan 16 2014, 01:11 PM +08:00