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

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

Similar to a light switch with on and off states. Generally considered an alternative to a check box.

See also

http://wiki.starling-framework.org/feathers/toggle-switch
Check

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
|  | customOffTrackName : String A name to add to the toggle switch's off track sub-component. | ToggleSwitch
|  | customOnTrackName : String A name to add to the toggle switch's on track sub-component. | ToggleSwitch
|  | customThumbName : String A name to add to the toggle switch's thumb sub-component. | ToggleSwitch
|  | defaultLabelProperties : Object The key/value pairs to pass to the labels, if no higher priority format is available. | ToggleSwitch
|  | 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
|  | disabledLabelProperties : Object The key/value pairs to pass to the labels, if the toggle switch is disabled. | ToggleSwitch
|  | 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
|  | isSelected : Boolean Indicates if the toggle switch is selected (ON) or not (OFF). | ToggleSwitch
|  | labelAlign : String The vertical alignment of the label. | ToggleSwitch
|  | labelFactory : Function A function used to instantiate the toggle switch's label subcomponents. | ToggleSwitch
|  | layoutData : ILayoutData Extra parameters associated with this display object that will be used by the layout algorithm. | FeathersControl
|  | maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. | FeathersControl
|  | 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
|  | 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
|  | offLabelProperties : Object The key/value pairs passed to the OFF label. | ToggleSwitch
|  | offText : String The text to display in the OFF label. | ToggleSwitch
|  | offTrackFactory : Function A function used to generate the toggle switch's off track sub-component. | ToggleSwitch
|  | offTrackProperties : Object A set of key/value pairs to be passed down to the toggle switch's off track sub-component. | ToggleSwitch
|  | onLabelProperties : Object The key/value pairs passed to the ON label. | ToggleSwitch
|  | onText : String The text to display in the ON label. | ToggleSwitch
|  | onTrackFactory : Function A function used to generate the toggle switch's on track sub-component. | ToggleSwitch
|  | onTrackProperties : Object A set of key/value pairs to be passed down to the toggle switch's on track sub-component. | ToggleSwitch
|  | paddingLeft : Number The minimum space, in pixels, between the switch's left edge and the switch's content. | ToggleSwitch
|  | paddingRight : Number The minimum space, in pixels, between the switch's right edge and the switch's content. | ToggleSwitch
|  | 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
|  | 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
|  | showLabels : Boolean Determines if the labels should be drawn. | ToggleSwitch
|  | showThumb : Boolean Determines if the thumb should be displayed. | ToggleSwitch
|  | 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
|  | thumbFactory : Function A function used to generate the toggle switch's thumb sub-component. | ToggleSwitch
|  | thumbProperties : Object A set of key/value pairs to be passed down to the toggle switch's thumb sub-component. | ToggleSwitch
|  | toggleDuration : Number The duration, in seconds, of the animation when the toggle switch is toggled and animates the position of the thumb. | ToggleSwitch
|  | toggleEase : Object The easing function used for toggle animations. | ToggleSwitch
|  | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject
|  | trackLayoutMode : String Determines how the on and off track skins are positioned and sized. | ToggleSwitch
|  | 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
|  | 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
|  | offLabelName : String = feathers-toggle-switch-off-label The value added to the nameList of the on label. | ToggleSwitch
|  | offTextRenderer : ITextRenderer The "off" text renderer sub-component. | ToggleSwitch
|  | offTrack : Button The "off" track sub-component. | ToggleSwitch
|  | offTrackName : String = feathers-toggle-switch-off-track The value added to the nameList of the off track. | ToggleSwitch
|  | onLabelName : String = feathers-toggle-switch-on-label The value added to the nameList of the off label. | ToggleSwitch
|  | onTextRenderer : ITextRenderer The "on" text renderer sub-component. | ToggleSwitch
|  | onTrack : Button The "on" track sub-component. | ToggleSwitch
|  | onTrackName : String = feathers-toggle-switch-on-track The value added to the nameList of the on track. | ToggleSwitch
|  | thumb : Button The thumb sub-component. | ToggleSwitch
|  | thumbName : String = feathers-toggle-switch-thumb The value added to the nameList of the thumb. | ToggleSwitch

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ToggleSwitch() Constructor. | ToggleSwitch
|  | 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
|  | change |  | ToggleSwitch
|  | 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_OFF_LABEL : String = feathers-toggle-switch-off-label [static] The default value added to the nameList of the off label. | ToggleSwitch
|  | DEFAULT_CHILD_NAME_OFF_TRACK : String = feathers-toggle-switch-off-track [static] The default value added to the nameList of the off track. | ToggleSwitch
|  | DEFAULT_CHILD_NAME_ON_LABEL : String = feathers-toggle-switch-on-label [static] The default value added to the nameList of the on label. | ToggleSwitch
|  | DEFAULT_CHILD_NAME_ON_TRACK : String = feathers-toggle-switch-on-track [static] The default value added to the nameList of the on track. | ToggleSwitch
|  | DEFAULT_CHILD_NAME_THUMB : String = feathers-toggle-switch-thumb [static] The default value added to the nameList of the thumb. | ToggleSwitch
|  | 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
|  | LABEL_ALIGN_BASELINE : String = baseline [static] The ON and OFF labels will be aligned to the middle vertically, based on only the baseline value of the font. | ToggleSwitch
|  | LABEL_ALIGN_MIDDLE : String = middle [static] The ON and OFF labels will be aligned to the middle vertically, based on the full character height of the font. | ToggleSwitch
|  | TRACK_LAYOUT_MODE_ON_OFF : String = onOff [static] The toggle switch has two tracks, stretching to fill each side of the scroll bar with the thumb in the middle. | ToggleSwitch
|  | TRACK_LAYOUT_MODE_SINGLE : String = single [static] The toggle switch has only one track skin, stretching to fill the full length of switch. | ToggleSwitch

Property Detail

customOffTrackName | property

`customOffTrackName:String`

A name to add to the toggle switch's off track sub-component. Typically used by a theme to provide different skins to different toggle switches.

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

See also

feathers.core.FeathersControl.nameList
offTrackFactory
offTrackProperties

customOnTrackName | property |

`customOnTrackName:String`

A name to add to the toggle switch's on track sub-component. Typically used by a theme to provide different skins to different toggle switches.

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

See also

feathers.core.FeathersControl.nameList
onTrackFactory
onTrackProperties

customThumbName | property |

`customThumbName:String`

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

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

See also

feathers.core.FeathersControl.nameList
thumbFactory
thumbProperties

defaultLabelProperties | property |

`defaultLabelProperties:Object`

The key/value pairs to pass to the labels, if no higher priority format is available. For the ON label, `onLabelProperties` takes priority. For the OFF label, `offLabelProperties` takes priority.

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

See also

feathers.core.ITextRenderer
onLabelProperties
offLabelProperties
disabledLabelProperties

disabledLabelProperties | property |

`disabledLabelProperties:Object`

The key/value pairs to pass to the labels, if the toggle switch is disabled.

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

See also

feathers.core.ITextRenderer

isSelected | property |

`isSelected:Boolean`

Indicates if the toggle switch is selected (ON) or not (OFF).

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

labelAlign | property |

`labelAlign:String`

The vertical alignment of the label.

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

labelFactory | property |

`labelFactory:Function`

A function used to instantiate the toggle switch's label subcomponents.

The factory should have the following function signature:

    function():ITextRenderer

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

See also

feathers.core.ITextRenderer
feathers.core.FeathersControl.defaultTextRendererFactory

offLabelName | property |

`protected var offLabelName:String = feathers-toggle-switch-off-label`

The value added to the `nameList` of the on label.

offLabelProperties | property |

`offLabelProperties:Object`

The key/value pairs passed to the OFF label. If `null`, then `defaultLabelProperties` will be used instead.

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

See also

feathers.core.ITextRenderer

offText | property |

`offText:String`

The text to display in the OFF label.

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

offTextRenderer | property |

`protected var offTextRenderer:ITextRenderer`

The "off" text renderer sub-component.

offTrack | property |

`protected var offTrack:Button`

The "off" track sub-component.

offTrackFactory | property |

`offTrackFactory:Function`

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

The function should have the following signature:

    function():Button

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

See also

offTrackProperties

offTrackName | property |

`protected var offTrackName:String = feathers-toggle-switch-off-track`

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

offTrackProperties | property |

`offTrackProperties:Object`

A set of key/value pairs to be passed down to the toggle switch's off track sub-component. The off 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 offTrackProperties():Object`
`public function set offTrackProperties(value:Object):void`

See also

feathers.controls.Button

onLabelName | property |

`protected var onLabelName:String = feathers-toggle-switch-on-label`

The value added to the `nameList` of the off label.

onLabelProperties | property |

`onLabelProperties:Object`

The key/value pairs passed to the ON label. If `null`, then `defaultLabelProperties` will be used instead.

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

See also

feathers.core.ITextRenderer

onText | property |

`onText:String`

The text to display in the ON label.

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

onTextRenderer | property |

`protected var onTextRenderer:ITextRenderer`

The "on" text renderer sub-component.

onTrack | property |

`protected var onTrack:Button`

The "on" track sub-component.

onTrackFactory | property |

`onTrackFactory:Function`

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

The function should have the following signature:

    function():Button

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

See also

onTrackProperties

onTrackName | property |

`protected var onTrackName:String = feathers-toggle-switch-on-track`

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

onTrackProperties | property |

`onTrackProperties:Object`

A set of key/value pairs to be passed down to the toggle switch's on track sub-component. The on 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 onTrackProperties():Object`
`public function set onTrackProperties(value:Object):void`

See also

feathers.controls.Button

paddingLeft | property |

`paddingLeft:Number`

The minimum space, in pixels, between the switch's left edge and the switch's content.

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

paddingRight | property |

`paddingRight:Number`

The minimum space, in pixels, between the switch's right edge and the switch's content.

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

showLabels | property |

`showLabels:Boolean`

Determines if the labels should be drawn. The onTrackSkin and offTrackSkin backgrounds may include the text instead.

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

showThumb | property |

`showThumb:Boolean`

Determines if the thumb should be displayed. This stops interaction while still displaying the background.

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

thumb | property |

`protected var thumb:Button`

The thumb sub-component.

thumbFactory | property |

`thumbFactory:Function`

A function used to generate the toggle switch'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-toggle-switch-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 toggle switch'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

toggleDuration | property |

`toggleDuration:Number`

The duration, in seconds, of the animation when the toggle switch is toggled and animates the position of the thumb.

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

toggleEase | property |

`toggleEase:Object`

The easing function used for toggle animations.

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

trackLayoutMode | property |

`trackLayoutMode:String`

Determines how the on and off 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_ON_OFF
Constructor Detail

ToggleSwitch | () | Constructor

`public function ToggleSwitch()`

Constructor.

Event Detail

change | Event

Event Object Type: `starling.events.Event`

Constant Detail

DEFAULT_CHILD_NAME_OFF_LABEL | Constant

`public static const DEFAULT_CHILD_NAME_OFF_LABEL:String = feathers-toggle-switch-off-label`

The default value added to the `nameList` of the off label.

DEFAULT_CHILD_NAME_OFF_TRACK | Constant |

`public static const DEFAULT_CHILD_NAME_OFF_TRACK:String = feathers-toggle-switch-off-track`

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

DEFAULT_CHILD_NAME_ON_LABEL | Constant |

`public static const DEFAULT_CHILD_NAME_ON_LABEL:String = feathers-toggle-switch-on-label`

The default value added to the `nameList` of the on label.

DEFAULT_CHILD_NAME_ON_TRACK | Constant |

`public static const DEFAULT_CHILD_NAME_ON_TRACK:String = feathers-toggle-switch-on-track`

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

DEFAULT_CHILD_NAME_THUMB | Constant |

`public static const DEFAULT_CHILD_NAME_THUMB:String = feathers-toggle-switch-thumb`

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

LABEL_ALIGN_BASELINE | Constant |

`public static const LABEL_ALIGN_BASELINE:String = baseline`

The ON and OFF labels will be aligned to the middle vertically, based on only the baseline value of the font.

LABEL_ALIGN_MIDDLE | Constant |

`public static const LABEL_ALIGN_MIDDLE:String = middle`

The ON and OFF labels will be aligned to the middle vertically, based on the full character height of the font.

TRACK_LAYOUT_MODE_ON_OFF | Constant |

`public static const TRACK_LAYOUT_MODE_ON_OFF:String = onOff`

The toggle switch has two tracks, stretching to fill each side of the scroll bar with the thumb in the middle. The tracks will be resized as the thumb moves. This layout mode is designed for toggle switches where the two sides of the track may be colored differently to better differentiate between the on state and the off state.

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 toggle switch has only one track skin, stretching to fill the full length of switch. In this layout mode, the on track is displayed and fills the entire length of the toggle switch. The off track will not exist.

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