Packagefeathers.controls
Classpublic class ToggleSwitch
InheritanceToggleSwitch Inheritance FeathersControl Inheritance starling.display.Sprite
Implements IToggle, IFocusDisplayObject

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

The following example programmatically selects a toggle switch and listens for when the selection changes:

     var toggle:ToggleSwitch = new ToggleSwitch();
     toggle.isSelected = true;
     toggle.addEventListener( Event.CHANGE, toggle_changeHandler );
     this.addChild( toggle );

See also

How to use the Feathers ToggleSwitch component
feathers.controls.Check


Public Properties
 PropertyDefined By
  customOffTrackName : String
DEPRECATED: Replaced by customOffTrackStyleName.
ToggleSwitch
  customOffTrackStyleName : String
A style name to add to the toggle switch's off track sub-component.
ToggleSwitch
  customOnTrackName : String
DEPRECATED: Replaced by customOnTrackStyleName.
ToggleSwitch
  customOnTrackStyleName : String
A style name to add to the toggle switch's on track sub-component.
ToggleSwitch
  customThumbName : String
DEPRECATED: Replaced by customThumbStyleName.
ToggleSwitch
  customThumbStyleName : String
A style name to add to the toggle switch's thumb sub-component.
ToggleSwitch
  defaultLabelProperties : Object
An object that stores properties for the toggle switch's label text renderers when the toggle switch is enabled, and the properties will be passed down to the text renderers when the toggle switch validates.
ToggleSwitch
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
  disabledLabelProperties : Object
An object that stores properties for the toggle switch's label text renderers when the toggle switch is disabled, and the properties will be passed down to the text renderers when the toggle switch validates.
ToggleSwitch
 InheritedfocusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 InheritedfocusManager : IFocusManager
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
FeathersControl
 InheritedfocusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 InheritedfocusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all ToggleSwitch components.
ToggleSwitch
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : 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 text renderer sub-components, if specific factories for those label text renderers are not provided.
ToggleSwitch
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritednextTabFocus : IFocusDisplayObject
FeathersControl
  offLabelFactory : Function
A function used to instantiate the toggle switch's off label text renderer sub-component.
ToggleSwitch
  offLabelProperties : Object
An object that stores properties for the toggle switch's "off" label text renderer, and the properties will be passed down to the text renderer when the toggle switch validates.
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
An object that stores properties for the toggle switch's "off" track, and the properties will be passed down to the "off" track when the toggle switch validates.
ToggleSwitch
  onLabelFactory : Function
A function used to instantiate the toggle switch's on label text renderer sub-component.
ToggleSwitch
  onLabelProperties : Object
An object that stores properties for the toggle switch's "on" label text renderer, and the properties will be passed down to the text renderer when the toggle switch validates.
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
An object that stores properties for the toggle switch's "on" track, and the properties will be passed down to the "on" track when the toggle switch validates.
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
 InheritedpreviousTabFocus : IFocusDisplayObject
FeathersControl
  showLabels : Boolean
Determines if the labels should be drawn.
ToggleSwitch
  showThumb : Boolean
Determines if the thumb should be displayed.
ToggleSwitch
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
  thumbFactory : Function
A function used to generate the toggle switch's thumb sub-component.
ToggleSwitch
  thumbProperties : Object
An object that stores properties for the toggle switch's thumb sub-component, and the properties will be passed down to the thumb when the toggle switch validates.
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
  toggleThumbSelection : Boolean
Determines if the isSelected property of the thumb is updated to match the isSelected property of the toggle switch, if the class used to create the thumb implements the IToggle interface.
ToggleSwitch
  trackLayoutMode : String
Determines how the on and off track skins are positioned and sized.
ToggleSwitch
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the globalStyleProvider property is set to this value.
FeathersControl
 InheritedexplicitHeight : Number = NaN
The height value explicitly set by calling the height setter or setSize().
FeathersControl
 InheritedexplicitWidth : Number = NaN
The width value explicitly set by calling the width setter or setSize().
FeathersControl
  offLabelName : String
DEPRECATED: Replaced by offLabelStyleName.
ToggleSwitch
  offLabelStyleName : String = feathers-toggle-switch-off-label
The value added to the styleNameList of the off label text renderer.
ToggleSwitch
  offTextRenderer : ITextRenderer
The "off" text renderer sub-component.
ToggleSwitch
  offTrack : Button
The "off" track sub-component.
ToggleSwitch
  offTrackName : String
DEPRECATED: Replaced by offTrackStyleName.
ToggleSwitch
  offTrackStyleName : String = feathers-toggle-switch-off-track
The value added to the styleNameList of the off track.
ToggleSwitch
  onLabelName : String
DEPRECATED: Replaced by onLabelStyleName.
ToggleSwitch
  onLabelStyleName : String = feathers-toggle-switch-on-label
The value added to the styleNameList of the off label text renderer.
ToggleSwitch
  onTextRenderer : ITextRenderer
The "on" text renderer sub-component.
ToggleSwitch
  onTrack : Button
The "on" track sub-component.
ToggleSwitch
  onTrackName : String
DEPRECATED: Replaced by onTrackStyleName.
ToggleSwitch
  onTrackStyleName : String = feathers-toggle-switch-on-track
The value added to the styleNameList of the on track.
ToggleSwitch
  thumb : Button
The thumb sub-component.
ToggleSwitch
  thumbName : String
DEPRECATED: Replaced by tabStyleName.
ToggleSwitch
  thumbStyleName : String = feathers-toggle-switch-thumb
The value added to the styleNameList of the thumb.
ToggleSwitch
Public Methods
 MethodDefined By
  
Constructor.
ToggleSwitch
 Inherited
hideFocus():void
If the visual indicator of focus has been displayed by showFocus(), call this function to hide it.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
  
setSelectionWithAnimation(isSelected:Boolean):void
Changes the isSelected property, but animates the thumb to the new position, as if the user tapped the toggle switch.
ToggleSwitch
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
showFocus():void
If the object has focus, an additional visual indicator may optionally be displayed to highlight the object.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
  
If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
ToggleSwitch
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
  
Creates and adds the offTrack sub-component and removes the old instance, if one exists.
ToggleSwitch
  
Creates and adds the onTrack sub-component and removes the old instance, if one exists.
ToggleSwitch
  
Creates and adds the thumb sub-component and removes the old instance, if one exists.
ToggleSwitch
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.
FeathersControl
 Inherited
focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.
FeathersControl
 Inherited
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
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
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
 Event Summary Defined By
  ToggleSwitch
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
Public Constants
 ConstantDefined By
  DEFAULT_CHILD_NAME_OFF_LABEL : String = feathers-toggle-switch-off-label
[static] DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_OFF_LABEL.
ToggleSwitch
  DEFAULT_CHILD_NAME_OFF_TRACK : String = feathers-toggle-switch-off-track
[static] DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_OFF_TRACK.
ToggleSwitch
  DEFAULT_CHILD_NAME_ON_LABEL : String = feathers-toggle-switch-on-label
[static] DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_ON_LABEL.
ToggleSwitch
  DEFAULT_CHILD_NAME_ON_TRACK : String = feathers-toggle-switch-on-track
[static] DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_ON_TRACK.
ToggleSwitch
  DEFAULT_CHILD_NAME_THUMB : String = feathers-toggle-switch-thumb
[static] DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_THUMB.
ToggleSwitch
  DEFAULT_CHILD_STYLE_NAME_OFF_LABEL : String = feathers-toggle-switch-off-label
[static] The default value added to the styleNameList of the off label.
ToggleSwitch
  DEFAULT_CHILD_STYLE_NAME_OFF_TRACK : String = feathers-toggle-switch-off-track
[static] The default value added to the styleNameList of the off track.
ToggleSwitch
  DEFAULT_CHILD_STYLE_NAME_ON_LABEL : String = feathers-toggle-switch-on-label
[static] The default value added to the styleNameList of the on label.
ToggleSwitch
  DEFAULT_CHILD_STYLE_NAME_ON_TRACK : String = feathers-toggle-switch-on-track
[static] The default value added to the styleNameList of the on track.
ToggleSwitch
  DEFAULT_CHILD_STYLE_NAME_THUMB : String = feathers-toggle-switch-thumb
[static] The default value added to the styleNameList of the thumb.
ToggleSwitch
 InheritedINVALIDATION_FLAG_ALL : String = all
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = data
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = focus
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = layout
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = scroll
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = selected
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = size
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = skin
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = state
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_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
customOffTrackNameproperty
customOffTrackName:String

DEPRECATED: Replaced by customOffTrackStyleName.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.


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

See also

customOffTrackStyleNameproperty 
customOffTrackStyleName:String

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

In the following example, a custom off track style name is passed to the toggle switch:

         toggle.customOffTrackStyleName = "my-custom-off-track";

In your theme, you can target this sub-component style name to provide different styles than the default:

         getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-off-track", setCustomOffTrackStyles );

The default value is null.


Implementation
    public function get customOffTrackStyleName():String
    public function set customOffTrackStyleName(value:String):void

See also

customOnTrackNameproperty 
customOnTrackName:String

DEPRECATED: Replaced by customOnTrackStyleName.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.


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

See also

customOnTrackStyleNameproperty 
customOnTrackStyleName:String

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

In the following example, a custom on track style name is passed to the toggle switch:

         toggle.customOnTrackStyleName = "my-custom-on-track";

In your theme, you can target this sub-component style name to provide different styles than the default:

         getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-on-track", setCustomOnTrackStyles );

The default value is null.


Implementation
    public function get customOnTrackStyleName():String
    public function set customOnTrackStyleName(value:String):void

See also

customThumbNameproperty 
customThumbName:String

DEPRECATED: Replaced by customThumbStyleName.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.


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

See also

customThumbStyleNameproperty 
customThumbStyleName:String

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

In the following example, a custom thumb style name is passed to the toggle switch:

         toggle.customThumbStyleName = "my-custom-thumb";

In your theme, you can target this sub-component style name to provide different styles than the default:

         getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-thumb", setCustomThumbStyles );

The default value is null.


Implementation
    public function get customThumbStyleName():String
    public function set customThumbStyleName(value:String):void

See also

defaultLabelPropertiesproperty 
defaultLabelProperties:Object

An object that stores properties for the toggle switch's label text renderers when the toggle switch is enabled, and the properties will be passed down to the text renderers when the toggle switch validates. The available properties depend on which ITextRenderer implementation is returned by labelFactory (possibly onLabelFactory or offLabelFactory instead). Refer to feathers.core.ITextRenderer for a list of available text renderer implementations.

In the following example, the toggle switch's default label properties are updated (this example assumes that the label text renderers are of type TextFieldTextRenderer):

         toggle.defaultLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
         toggle.defaultLabelProperties.embedFonts = true;

The default value is null.


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

See also

disabledLabelPropertiesproperty 
disabledLabelProperties:Object

An object that stores properties for the toggle switch's label text renderers when the toggle switch is disabled, and the properties will be passed down to the text renderers when the toggle switch validates. The available properties depend on which ITextRenderer implementation is returned by labelFactory (possibly onLabelFactory or offLabelFactory instead). Refer to feathers.core.ITextRenderer for a list of available text renderer implementations.

In the following example, the toggle switch's disabled label properties are updated (this example assumes that the label text renderers are of type TextFieldTextRenderer):

         toggle.disabledLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
         toggle.disabledLabelProperties.embedFonts = true;

The default value is null.


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

See also

globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all ToggleSwitch components.

The default value is null.

See also

isSelectedproperty 
isSelected:Boolean

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

In the following example, the toggle switch is selected:

         toggle.isSelected = true;

The default value is false.


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

See also

labelAlignproperty 
labelAlign:String

The vertical alignment of the label.

In the following example, the toggle switch's label alignment is updated:

         toggle.labelAlign = ToggleSwitch.LABEL_ALIGN_MIDDLE;

The default value is ToggleSwitch.LABEL_ALIGN_BASELINE.


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

See also

labelFactoryproperty 
labelFactory:Function

A function used to instantiate the toggle switch's label text renderer sub-components, if specific factories for those label text renderers are not provided. The label text renderers must be instances of ITextRenderer. This factory can be used to change properties of the label text renderers when they are first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to style the label text renderers.

The factory should have the following function signature:

function():ITextRenderer

In the following example, the toggle switch uses a custom label factory:

         toggle.labelFactory = function():ITextRenderer
         {
             return new TextFieldTextRenderer();
         }

The default value is null.


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

See also

offLabelFactoryproperty 
offLabelFactory:Function

A function used to instantiate the toggle switch's off label text renderer sub-component. The off label text renderer must be an instance of ITextRenderer. This factory can be used to change properties of the off label text renderer when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to style the off label text renderer.

If an offLabelFactory is not provided, the default labelFactory will be used.

The factory should have the following function signature:

function():ITextRenderer

In the following example, the toggle switch uses a custom on label factory:

         toggle.offLabelFactory = function():ITextRenderer
         {
             return new TextFieldTextRenderer();
         }

The default value is null.


Implementation
    public function get offLabelFactory():Function
    public function set offLabelFactory(value:Function):void

See also

offLabelNameproperty 
offLabelName:String

DEPRECATED: Replaced by offLabelStyleName.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.


Implementation
    protected function get offLabelName():String
    protected function set offLabelName(value:String):void

See also

offLabelPropertiesproperty 
offLabelProperties:Object

An object that stores properties for the toggle switch's "off" label text renderer, and the properties will be passed down to the text renderer when the toggle switch validates. If null, then defaultLabelProperties is used instead.

The available properties depend on which ITextRenderer implementation is returned by labelFactory (possibly offLabelFactory instead). Refer to feathers.core.ITextRenderer for a list of available text renderer implementations.

In the following example, the toggle switch's off label properties are updated (this example assumes that the off label text renderer is a TextFieldTextRenderer):

         toggle.offLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
         toggle.offLabelProperties.embedFonts = true;

The default value is null.


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

See also

offLabelStyleNameproperty 
protected var offLabelStyleName:String = feathers-toggle-switch-off-label

The value added to the styleNameList of the off label text renderer. This variable is protected so that sub-classes can customize the off label text renderer style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_OFF_LABEL.

See also

offTextproperty 
offText:String

The text to display in the OFF label.

In the following example, the toggle switch's off label text is updated:

         toggle.offText = "off";

The default value is "OFF".


Implementation
    public function get offText():String
    public function set offText(value:String):void
offTextRendererproperty 
protected var offTextRenderer:ITextRenderer

The "off" text renderer sub-component.

For internal use in subclasses.

See also

offTrackproperty 
protected var offTrack:Button

The "off" track sub-component.

For internal use in subclasses.

See also

offTrackFactoryproperty 
offTrackFactory:Function

A function used to generate the toggle switch's "off" track sub-component. The "off" track must be an instance of Button. This factory 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 this factory to set skins and other styles on the "off" track.

The function should have the following signature:

function():Button

In the following example, a custom off track factory is passed to the toggle switch:

         toggle.offTrackFactory = function():Button
         {
             var offTrack:Button = new Button();
             offTrack.defaultSkin = new Image( texture );
             return offTrack;
         };

The default value is null.


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

See also

offTrackNameproperty 
offTrackName:String

DEPRECATED: Replaced by offTrackStyleName.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.


Implementation
    protected function get offTrackName():String
    protected function set offTrackName(value:String):void

See also

offTrackPropertiesproperty 
offTrackProperties:Object

An object that stores properties for the toggle switch's "off" track, and the properties will be passed down to the "off" track when the toggle switch validates. For a list of available properties, refer to feathers.controls.Button.

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 which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

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

Setting properties in a offTrackFactory function instead of using offTrackProperties will result in better performance.

In the following example, the toggle switch's off track properties are updated:

         toggle.offTrackProperties.defaultSkin = new Image( texture );

The default value is null.


Implementation
    public function get offTrackProperties():Object
    public function set offTrackProperties(value:Object):void

See also

offTrackStyleNameproperty 
protected var offTrackStyleName:String = feathers-toggle-switch-off-track

The value added to the styleNameList of the off track. This variable is protected so that sub-classes can customize the off track style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_OFF_TRACK.

To customize the off track style name without subclassing, see customOffTrackStyleName.

See also

onLabelFactoryproperty 
onLabelFactory:Function

A function used to instantiate the toggle switch's on label text renderer sub-component. The on label text renderer must be an instance of ITextRenderer. This factory can be used to change properties of the on label text renderer when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to style the on label text renderer.

If an onLabelFactory is not provided, the default labelFactory will be used.

The factory should have the following function signature:

function():ITextRenderer

In the following example, the toggle switch uses a custom on label factory:

         toggle.onLabelFactory = function():ITextRenderer
         {
             return new TextFieldTextRenderer();
         }

The default value is null.


Implementation
    public function get onLabelFactory():Function
    public function set onLabelFactory(value:Function):void

See also

onLabelNameproperty 
onLabelName:String

DEPRECATED: Replaced by onLabelStyleName.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.


Implementation
    protected function get onLabelName():String
    protected function set onLabelName(value:String):void

See also

onLabelPropertiesproperty 
onLabelProperties:Object

An object that stores properties for the toggle switch's "on" label text renderer, and the properties will be passed down to the text renderer when the toggle switch validates. If null, then defaultLabelProperties is used instead.

The available properties depend on which ITextRenderer implementation is returned by labelFactory (possibly onLabelFactory instead). Refer to feathers.core.ITextRenderer for a list of available text renderer implementations.

In the following example, the toggle switch's on label properties are updated (this example assumes that the on label text renderer is a TextFieldTextRenderer):

         toggle.onLabelProperties.textFormat = new TextFormat( "Source Sans Pro", 16, 0x333333 );
         toggle.onLabelProperties.embedFonts = true;

The default value is null.


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

See also

onLabelStyleNameproperty 
protected var onLabelStyleName:String = feathers-toggle-switch-on-label

The value added to the styleNameList of the off label text renderer. This variable is protected so that sub-classes can customize the on label text renderer style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_ON_LABEL.

See also

onTextproperty 
onText:String

The text to display in the ON label.

In the following example, the toggle switch's on label text is updated:

         toggle.onText = "on";

The default value is "ON".


Implementation
    public function get onText():String
    public function set onText(value:String):void
onTextRendererproperty 
protected var onTextRenderer:ITextRenderer

The "on" text renderer sub-component.

See also

onTrackproperty 
protected var onTrack:Button

The "on" track sub-component.

For internal use in subclasses.

See also

onTrackFactoryproperty 
onTrackFactory:Function

A function used to generate the toggle switch's "on" track sub-component. The "on" track must be an instance of Button. This factory 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 this factory to set skins and other styles on the "on" track.

The function should have the following signature:

function():Button

In the following example, a custom on track factory is passed to the toggle switch:

         toggle.onTrackFactory = function():Button
         {
             var onTrack:Button = new Button();
             onTrack.defaultSkin = new Image( texture );
             return onTrack;
         };

The default value is null.


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

See also

onTrackNameproperty 
onTrackName:String

DEPRECATED: Replaced by onTrackStyleName.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.


Implementation
    protected function get onTrackName():String
    protected function set onTrackName(value:String):void

See also

onTrackPropertiesproperty 
onTrackProperties:Object

An object that stores properties for the toggle switch's "on" track, and the properties will be passed down to the "on" track when the toggle switch validates. For a list of available properties, refer to feathers.controls.Button.

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 which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

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

Setting properties in a onTrackFactory function instead of using onTrackProperties will result in better performance.

In the following example, the toggle switch's on track properties are updated:

         toggle.onTrackProperties.defaultSkin = new Image( texture );

The default value is null.


Implementation
    public function get onTrackProperties():Object
    public function set onTrackProperties(value:Object):void

See also

onTrackStyleNameproperty 
protected var onTrackStyleName:String = feathers-toggle-switch-on-track

The value added to the styleNameList of the on track. This variable is protected so that sub-classes can customize the on track style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_ON_TRACK.

To customize the on track style name without subclassing, see customOnTrackStyleName.

See also

paddingLeftproperty 
paddingLeft:Number

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

In the following example, the toggle switch's left padding is set to 20 pixels:

         toggle.paddingLeft = 20;

The default value is 0.


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

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

In the following example, the toggle switch's right padding is set to 20 pixels:

         toggle.paddingRight = 20;

The default value is 0.


Implementation
    public function get paddingRight():Number
    public function set paddingRight(value:Number):void
showLabelsproperty 
showLabels:Boolean

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

In the following example, the toggle switch's labels are hidden:

         toggle.showLabels = false;

The default value is true.


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

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

In the following example, the toggle switch's thumb is hidden:

         toggle.showThumb = false;

The default value is true.


Implementation
    public function get showThumb():Boolean
    public function set showThumb(value:Boolean):void
thumbproperty 
protected var thumb:Button

The thumb sub-component.

For internal use in subclasses.

See also

thumbFactoryproperty 
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

In the following example, a custom thumb factory is passed to the toggle switch:

         toggle.thumbFactory = function():Button
         {
             var button:Button = new Button();
             button.defaultSkin = new Image( texture );
             return button;
         };

The default value is null.


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

See also

thumbNameproperty 
thumbName:String

DEPRECATED: Replaced by tabStyleName.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.


Implementation
    protected function get thumbName():String
    protected function set thumbName(value:String):void

See also

thumbPropertiesproperty 
thumbProperties:Object

An object that stores properties for the toggle switch's thumb sub-component, and the properties will be passed down to the thumb when the toggle switch validates. For a list of available properties, refer to feathers.controls.Button.

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 which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

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

Setting properties in a thumbFactory function instead of using thumbProperties will result in better performance.

In the following example, the toggle switch's thumb properties are updated:

         toggle.thumbProperties.defaultSkin = new Image( texture );

The default value is null.


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

See also

thumbStyleNameproperty 
protected var thumbStyleName:String = feathers-toggle-switch-thumb

The value added to the styleNameList of the thumb. This variable is protected so that sub-classes can customize the thumb style name in their constructors instead of using the default stylename defined by DEFAULT_CHILD_STYLE_NAME_THUMB.

To customize the thumb style name without subclassing, see customThumbStyleName.

See also

toggleDurationproperty 
toggleDuration:Number

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

In the following example, the duration of the toggle switch thumb animation is updated:

         toggle.toggleDuration = 0.5;

The default value is 0.15.


Implementation
    public function get toggleDuration():Number
    public function set toggleDuration(value:Number):void
toggleEaseproperty 
toggleEase:Object

The easing function used for toggle animations.

In the following example, the easing function used by the toggle switch's thumb animation is updated:

         toggle.toggleEase = Transitions.EASE_IN_OUT;

The default value is starling.animation.Transitions.EASE_OUT.


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

See also

toggleThumbSelectionproperty 
toggleThumbSelection:Boolean

Determines if the isSelected property of the thumb is updated to match the isSelected property of the toggle switch, if the class used to create the thumb implements the IToggle interface. Useful for skinning to provide a different appearance for the thumb based on whether the toggle switch is selected or not.

In the following example, the thumb selection is toggled:

         toggle.toggleThumbSelection = true;

The default value is false.


Implementation
    public function get toggleThumbSelection():Boolean
    public function set toggleThumbSelection(value:Boolean):void

See also

trackLayoutModeproperty 
trackLayoutMode:String

Determines how the on and off track skins are positioned and sized.

In the following example, the toggle switch's track layout mode is updated to use two tracks:

         toggle.trackLayoutMode = ToggleSwitch.TRACK_LAYOUT_MODE_ON_OFF;

The default value is ToggleSwitch.TRACK_LAYOUT_MODE_SINGLE.


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

See also

Constructor Detail
ToggleSwitch()Constructor
public function ToggleSwitch()

Constructor.

Method Detail
autoSizeIfNeeded()method
protected function autoSizeIfNeeded():Boolean

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. If the explicitWidth or explicitHeight member variables are set, those value will be used without additional measurement. If one is set, but not the other, the dimension with the explicit value will not be measured, but the other non-explicit dimension will still need measurement.

Calls setSizeInternal() to set up the actualWidth and actualHeight member variables used for layout.

Meant for internal use, and subclasses may override this function with a custom implementation.

Returns
Boolean
createOffTrack()method 
protected function createOffTrack():void

Creates and adds the offTrack sub-component and removes the old instance, if one exists. If the off track is not needed, it will not be created.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

createOnTrack()method 
protected function createOnTrack():void

Creates and adds the onTrack sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

createThumb()method 
protected function createThumb():void

Creates and adds the thumb sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

setSelectionWithAnimation()method 
public function setSelectionWithAnimation(isSelected:Boolean):void

Changes the isSelected property, but animates the thumb to the new position, as if the user tapped the toggle switch.

Parameters

isSelected:Boolean

See also

Event Detail
change Event
Event Object Type: starling.events.Event

Dispatched when the selection changes.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
datanull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

Constant Detail
DEFAULT_CHILD_NAME_OFF_LABELConstant
public static const DEFAULT_CHILD_NAME_OFF_LABEL:String = feathers-toggle-switch-off-label

DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_OFF_LABEL.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.

See also

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

DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_OFF_TRACK.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.

See also

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

DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_ON_LABEL.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.

See also

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

DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_ON_TRACK.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.

See also

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

DEPRECATED: Replaced by ToggleSwitch.DEFAULT_CHILD_STYLE_NAME_THUMB.

DEPRECATION WARNING: This property is deprecated starting with Feathers 2.1. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.

See also

DEFAULT_CHILD_STYLE_NAME_OFF_LABELConstant 
public static const DEFAULT_CHILD_STYLE_NAME_OFF_LABEL:String = feathers-toggle-switch-off-label

The default value added to the styleNameList of the off label.

See also

DEFAULT_CHILD_STYLE_NAME_OFF_TRACKConstant 
public static const DEFAULT_CHILD_STYLE_NAME_OFF_TRACK:String = feathers-toggle-switch-off-track

The default value added to the styleNameList of the off track.

See also

DEFAULT_CHILD_STYLE_NAME_ON_LABELConstant 
public static const DEFAULT_CHILD_STYLE_NAME_ON_LABEL:String = feathers-toggle-switch-on-label

The default value added to the styleNameList of the on label.

See also

DEFAULT_CHILD_STYLE_NAME_ON_TRACKConstant 
public static const DEFAULT_CHILD_STYLE_NAME_ON_TRACK:String = feathers-toggle-switch-on-track

The default value added to the styleNameList of the on track.

See also

DEFAULT_CHILD_STYLE_NAME_THUMBConstant 
public static const DEFAULT_CHILD_STYLE_NAME_THUMB:String = feathers-toggle-switch-thumb

The default value added to the styleNameList of the thumb.

See also

LABEL_ALIGN_BASELINEConstant 
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.

See also

LABEL_ALIGN_MIDDLEConstant 
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.

See also

TRACK_LAYOUT_MODE_ON_OFFConstant 
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 using a special display object such as a Scale9Image, Scale3Image or a TiledImage that is designed to be resized dynamically.

See also

TRACK_LAYOUT_MODE_SINGLEConstant 
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.

See also