Returns the text baseline measurement, in pixels.

The current state of the toggle switch.

See also

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.

See also

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.

See also

The default IStyleProvider for all ToggleSwitch components.

The default value is null.

See also

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.

See also

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.

See also

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.

See also

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.

See also

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.

To customize the "off" label text renderer style name without subclassing, see customOffLabelStyleName.

See also

The "off" text renderer sub-component.

For internal use in subclasses.

See also

The "off" track sub-component.

For internal use in subclasses.

See also

A function used to generate the toggle switch's "off" track sub-component. The "off" track must be an instance of BasicButton (or a subclass). 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():BasicButton

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

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

The default value is null.

See also

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

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.

See also

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

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.

See also

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.

See also

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.

To customize the "on" label text renderer style name without subclassing, see customOnLabelStyleName.

See also

The "on" text renderer sub-component.

See also

The "on" track sub-component.

For internal use in subclasses.

See also

A function used to generate the toggle switch's "on" track sub-component. The "on" track must be an instance of BasicButton (or a subclass). 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():BasicButton

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

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

The default value is null.

See also

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

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.

See also

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

The thumb sub-component.

For internal use in subclasses.

See also

A function used to generate the toggle switch's thumb sub-component. The thumb must be an instance of BasicButton (or a subclass). This factory 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 other styles on the thumb.

The function should have the following signature:

function():BasicButton

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

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

The default value is null.

See also

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

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.

See also

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

Constructor.

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 saveMeasurements() 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.

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

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

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

Gets the font styles to be used to display the toggle switch's off label text when the toggle switch's currentState property matches the specified state value.

If font styles are not defined for a specific state, returns null.

Parameters

See also

Gets the font styles to be used to display the toggle switch's on label text when the toggle switch's currentState property matches the specified state value.

If font styles are not defined for a specific state, returns null.

Parameters

See also

Sets the font styles to be used to display the toggle switch's off label text when the toggle switch's currentState property matches the specified state value.

If font styles are not defined for a specific state, the value of the offLabelFontStyles property will be used instead.

Note: if the text renderer has been customized with advanced font formatting, it may override the values specified with setOffLabelFontStylesForState() and properties like offLabelFontStyles and offLabelDisabledFontStyles.

Parameters

See also

Sets the font styles to be used to display the toggle switch's on label text when the toggle switch's currentState property matches the specified state value.

If font styles are not defined for a specific state, the value of the onLabelFontStyles property will be used instead.

Note: if the text renderer has been customized with advanced font formatting, it may override the values specified with setOnLabelFontStylesForState() and properties like onLabelFontStyles and onLabelDisabledFontStyles.

Parameters

See also

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

Parameters

See also

Dispatched when the selection changes.

The properties of the event object have the following values:

See also

Dispatched when the display object's state changes.

The properties of the event object have the following values:

See also

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

In the following example, the toggle switch's track scale is customized:

toggle.trackScaleMode = TrackScaleMode.EXACT_FIT;

The default value is feathers.controls.TrackScaleMode.DIRECTIONAL.

See also

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 = TrackLayoutMode.SPLIT;

The default value is feathers.controls.TrackLayoutMode.SINGLE.

See also

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.

See also

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.

See also

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.

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.

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.

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.

See also

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.

See also

The text to display in the "off" label text renderer.

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

toggle.offText = "off";

The default value is "OFF".

See also

The font styles used to display the off label's text when the toggle switch is selected.

In the following example, the off label's selected font styles are customized:

toggle.offLabelSelectedFontStyles = new TextFormat( "Helvetica", 20, 0xff0000 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the offLabelFactory to set more advanced styles on the text renderer.

The default value is null.

See also

The font styles used to display the off label's text.

In the following example, the off label's font styles are customized:

toggle.offLabelFontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the offLabelFactory to set more advanced styles.

The default value is null.

See also

The font styles used to display the off label's text when the toggle switch is disabled.

In the following example, the off labels' disabled font styles are customized:

toggle.offLabelDisabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the offLabelFactory to set more advanced styles on the text renderer.

The default value is null.

See also

The text to display in the "on" label text renderer.

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

toggle.onText = "on";

The default value is "ON".

See also

The font styles used to display the on label's text when the toggle switch is selected.

In the following example, the on label's selected font styles are customized:

toggle.onLabelSelectedFontStyles = new TextFormat( "Helvetica", 20, 0xff0000 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the onLabelFactory to set more advanced styles on the text renderer.

The default value is null.

See also

The font styles used to display the on label's text.

In the following example, the on label's font styles are customized:

toggle.onLabelFontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the onLabelFactory to set more advanced styles.

The default value is null.

See also

The font styles used to display the on label's text when the toggle switch is disabled.

In the following example, the on labels' disabled font styles are customized:

toggle.onLabelDisabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the onLabelFactory to set more advanced styles on the text renderer.

The default value is null.

See also

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.

See also

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.

See also

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

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

toggle.customOffLabelStyleName = "my-custom-toggle-off-label";

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

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-toggle-off-label", setCustomToggleSwitchOffLabelStyles );

The default value is null.

See also

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.

See also

A style name to add to the toggle switch's on label text renderer sub-component. Typically used by a theme to provide different styles to different buttons.

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

toggle.customOnLabelStyleName = "my-custom-toggle-on-label";

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

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-toggle-on-label", setCustomToggleSwitchOnLabelStyles );

The default value is null.

See also

The default value added to the styleNameList of the "off label" text renderer.

Note: the "off label" text renderer is not a feathers.controls.Label. It is an instance of one of the ITextRenderer implementations.

See also

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

See also

The default value added to the styleNameList of the "on label" text renderer.

Note: the "on label" text renderer is not a feathers.controls.Label. It is an instance of one of the ITextRenderer implementations.

See also

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

See also

The default value added to the styleNameList of the thumb.

See also