The default IStyleProvider for all ToggleButton components. If null, falls back to using Button.globalStyleProvider instead.

The default value is null.

See also

Indicates if the button is selected or not. The button may be selected programmatically, even if isToggle is false, but generally, isToggle should be set to true to allow the user to select and deselect it by triggering the button with a click or tap. If focus management is enabled, a button may also be triggered with the spacebar when the button has focus.

The following example enables the button to toggle and selects it automatically:

button.isToggle = true;
button.isSelected = true;

Warning: Do not listen to Event.TRIGGERED to be notified when the isSelected property changes. You must listen to Event.CHANGE.

The default value is false.

See also

Determines if the button may be selected or deselected as a result of user interaction. If true, the value of the isSelected property will be toggled when the button is triggered.

The following example disables the ability to toggle:

button.isToggle = false;

The default value is true.

See also

When the toggle is added to a ToggleGroup, the group will manage the entire group's selection when one of the toggles in the group changes.

In the following example, a Radio is added to a ToggleGroup:

var group:ToggleGroup = new ToggleGroup();
group.addEventListener( Event.CHANGE, group_changeHandler );
var radio:Radio = new Radio();
radio.toggleGroup = group;
this.addChild( radio );

Constructor.

Dispatched when the button is selected or deselected either programmatically or as a result of user interaction. The value of the isSelected property indicates whether the button is selected or not. Use interaction may only change selection when the isToggle property is set to true.

The properties of the event object have the following values:

See also

The skin used for the button's up state when the button is selected. If null, then defaultSelectedSkin is used instead. If defaultSelectedSkin is also null, then defaultSkin is used.

This property will be ignored if a function is passed to the stateToSkinFunction property.

The following example gives the button a skin for the selected up state:

button.selectedUpSkin = new Image( texture );

Alternatively, you may use setSkinForState() with ButtonState.UP_AND_SELECTED to set the same skin:

var skin:Image = new Image( texture );
button.setSkinForState( ButtonState.UP_AND_SELECTED, skin );

The default value is null.

See also

The icon used for the button's up state when the button is selected. If null, then defaultSelectedIcon is used instead. If defaultSelectedIcon is also null, then defaultIcon is used.

This property will be ignored if a function is passed to the stateToIconFunction property.

The following example gives the button an icon for the selected up state:

button.selectedUpIcon = new Image( texture );

Alternatively, you may use setIconForState() with ButtonState.UP_AND_SELECTED to set the same icon:

var icon:Image = new Image( texture );
button.setIconForState( ButtonState.UP_AND_SELECTED, icon );

The default value is null.

See also

The skin used for the button's down state when the button is selected. If null, then defaultSelectedSkin is used instead. If defaultSelectedSkin is also null, then defaultSkin is used.

This property will be ignored if a function is passed to the stateToSkinFunction property.

The following example gives the button a skin for the selected down state:

button.selectedDownSkin = new Image( texture );

Alternatively, you may use setSkinForState() with ButtonState.DOWN_AND_SELECTED to set the same skin:

var skin:Image = new Image( texture );
button.setSkinForState( ButtonState.DOWN_AND_SELECTED, skin );

The default value is null.

See also

The icon used for the button's down state when the button is selected. If null, then defaultSelectedIcon is used instead. If defaultSelectedIcon is also null, then defaultIcon is used.

This property will be ignored if a function is passed to the stateToIconFunction property.

The following example gives the button an icon for the selected down state:

button.selectedDownIcon = new Image( texture );

Alternatively, you may use setIconForState() with ButtonState.DOWN_AND_SELECTED to set the same icon:

var icon:Image = new Image( texture );
button.setIconForState( ButtonState.DOWN_AND_SELECTED, icon );

The default value is null.

See also

The skin used for the button's hover state when the button is selected. If null, then defaultSelectedSkin is used instead. If defaultSelectedSkin is also null, then defaultSkin is used.

This property will be ignored if a function is passed to the stateToSkinFunction property.

The following example gives the button a skin for the selected hover state:

button.selectedHoverSkin = new Image( texture );

Alternatively, you may use setSkinForState() with ButtonState.HOVER_AND_SELECTED to set the same skin:

var skin:Image = new Image( texture );
button.setSkinForState( ButtonState.HOVER_AND_SELECTED, skin );

The default value is null.

See also

The icon used for the button's hover state when the button is selected. If null, then defaultSelectedIcon is used instead. If defaultSelectedIcon is also null, then defaultIcon is used.

This property will be ignored if a function is passed to the stateToIconFunction property.

The following example gives the button an icon for the selected hover state:

button.selectedHoverIcon = new Image( texture );

Alternatively, you may use setIconForState() with ButtonState.HOVER_AND_SELECTED to set the same icon:

var icon:Image = new Image( texture );
button.setIconForState( ButtonState.HOVER_AND_SELECTED, icon );

The default value is null.

See also

The font styles used to display the button's text when the button is selected.

In the following example, the selected font styles are customized:

button.selectedFontStyles = 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 labelFactory to set more advanced styles on the text renderer.

The default value is null.

See also

The skin used for the button's disabled state when the button is selected. If null, then defaultSelectedSkin is used instead. If defaultSelectedSkin is also null, then defaultSkin is used.

This property will be ignored if a function is passed to the stateToSkinFunction property.

The following example gives the button a skin for the selected disabled state:

button.selectedDisabledSkin = new Image( texture );

Alternatively, you may use setSkinForState() with ButtonState.DISABLED_AND_SELECTED to set the same skin:

var skin:Image = new Image( texture );
button.setSkinForState( ButtonState.DISABLED_AND_SELECTED, skin );

The default value is null.

See also

The icon used for the button's disabled state when the button is selected. If null, then defaultSelectedIcon is used instead. If defaultSelectedIcon is also null, then defaultIcon is used.

This property will be ignored if a function is passed to the stateToIconFunction property.

The following example gives the button an icon for the selected disabled state:

button.selectedDisabledIcon = new Image( texture );

Alternatively, you may use setIconForState() with ButtonState.DISABLED_AND_SELECTED to set the same icon:

var icon:Image = new Image( texture );
button.setIconForState( ButtonState.DISABLED_AND_SELECTED, icon );

The default value is null.

See also

If not NaN, the button renders at this scale when selected. Otherwise, defaults to 1.

The following example scales the button when selected:

button.scaleWhenSelected = 0.9;

The default value is 1.

See also

The skin used when no other skin is defined for the current state when the button is selected. Has a higher priority than defaultSkin, but a lower priority than other selected skins.

This property will be ignored if a function is passed to the stateToSkinFunction property.

The following example gives the button a default skin to use for all selected states when no specific skin is available:

button.defaultSelectedSkin = new Image( texture );

The default value is null.

See also

The icon used when no other icon is defined for the current state when the button is selected. Has a higher priority than defaultIcon, but a lower priority than other selected icons.

This property will be ignored if a function is passed to the stateToIconFunction property.

The following example gives the button a default icon to use for all selected states when no specific icon is available:

button.defaultSelectedIcon = new Image( texture );

The default value is null.

See also