Packagefeathers.controls
Classpublic class ToggleButton
InheritanceToggleButton Inheritance Button Inheritance BasicButton Inheritance FeathersControl Inheritance starling.display.Sprite
Implements IGroupedToggle
Subclasses BaseDefaultItemRenderer, Check, FullScreenToggleButton, MuteToggleButton, PlayPauseToggleButton, Radio

A button that may be selected and deselected when triggered.

The following example creates a toggle button, and listens for when its selection changes:

var button:ToggleButton = new ToggleButton();
button.label = "Click Me";
button.addEventListener( Event.CHANGE, button_changeHandler );
this.addChild( button );

See also

How to use the Feathers ToggleButton component


Public Properties
 PropertyDefined By
 Inheritedbaseline : Number
[read-only] Returns the text baseline measurement, in pixels.
Button
 InheritedcurrentState : String
[read-only] The current state of the button.
BasicButton
 InheriteddefaultLabelProperties : Object
An object that stores properties for the button's label text renderer when no specific properties are defined for the button's current state, and the properties will be passed down to the label text renderer when the button validates.
Button
 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
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
 InheritedfocusManager : IFocusManager
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all ToggleButton components.
ToggleButton
 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
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisLongPressEnabled : Boolean
Determines if FeathersEventType.LONG_PRESS will be dispatched.
Button
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
  isSelected : Boolean
Indicates if the button is selected or not.
ToggleButton
  isToggle : Boolean
Determines if the button may be selected or deselected as a result of user interaction.
ToggleButton
 Inheritedlabel : String
The text displayed on the button.
Button
 InheritedlabelFactory : Function
A function used to instantiate the button's label text renderer sub-component.
Button
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedlongPressDuration : Number
The duration, in seconds, of a long press.
Button
 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
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.
FeathersControl
 InheritedpreviousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.
FeathersControl
 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
  toggleGroup : ToggleGroup
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.
ToggleButton
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
 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
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheritedcurrentIcon : DisplayObject
The currently visible icon.
Button
 InheritedcurrentSkin : DisplayObject
The currently visible skin.
BasicButton
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the globalStyleProvider property is set to this value.
FeathersControl
 InheritedlabelStyleName : String = "feathers-button-label"
The value added to the styleNameList of the label text renderer.
Button
 InheritedlabelTextRenderer : ITextRenderer
The text renderer for the button's label.
Button
 InheritedtouchPointID : int = -1
The saved ID of the currently active touch.
BasicButton
Public Methods
 MethodDefined By
  
Constructor.
ToggleButton
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.
FeathersControl
 Inherited
getFontStylesForState(state:String):TextFormat
Gets the font styles to be used to display the button's text when the button's currentState property matches the specified state value.
Button
 Inherited
getIconForState(state:String):DisplayObject
Gets the icon to be used by the button when the button's currentState property matches the specified state value.
Button
 Inherited
getSkinForState(state:String):DisplayObject
Gets the skin to be used by the button when its currentState property matches the specified state value.
BasicButton
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
If the component has not yet initialized, initializes immediately.
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
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
 Inherited
setFontStylesForState(state:String, format:TextFormat):void
Sets the font styles to be used to display the button's text when the button's currentState property matches the specified state value.
Button
 Inherited
setIconForState(state:String, icon:DisplayObject):void
Sets the icon to be used by the button when the button's currentState property matches the specified state value.
Button
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
setSkinForState(state:String, skin:DisplayObject):void
Sets the skin to be used by the button when its currentState property matches the specified state value.
BasicButton
 Inherited
showFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
BasicButton
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
Creates the label text renderer sub-component and removes the old instance, if one exists.
Button
 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
Positions and sizes the button's content.
Button
 Inherited
processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.
FeathersControl
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
Sets the currentIcon property.
Button
 Inherited
Sets the currentSkin property.
BasicButton
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
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
  Dispatched when the button is selected or deselected either programmatically or as a result of user interaction.ToggleButton
 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 button is pressed for a long time.Button
 InheritedDispatched when the width or height of the control changes.FeathersControl
 InheritedDispatched when the display object's state changes.BasicButton
 InheritedDispatched when the the user taps or clicks the button.BasicButton
Styles
 StyleDefined By
 Inherited
A style name to add to the button's label text renderer sub-component.
Button
 Inherited
defaultIcon : DisplayObject
The icon used when no other icon is defined for the current state.
Button
  
defaultSelectedIcon : DisplayObject
The icon used when no other icon is defined for the current state when the button is selected.
ToggleButton
  
defaultSelectedSkin : DisplayObject
The skin used when no other skin is defined for the current state when the button is selected.
ToggleButton
 Inherited
defaultSkin : DisplayObject
The skin used when no other skin is defined for the current state.
BasicButton
 Inherited
disabledFontStyles : TextFormat
The font styles used to display the button's text when the button is disabled.
Button
 Inherited
disabledIcon : DisplayObject
The icon used for the button's disabled state.
Button
 Inherited
disabledSkin : DisplayObject
The skin used for the button's disabled state.
BasicButton
 Inherited
downIcon : DisplayObject
The icon used for the button's down state.
Button
 Inherited
downSkin : DisplayObject
The skin used for the button's down state.
BasicButton
 Inherited
focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 Inherited
focusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
 Inherited
fontStyles : TextFormat
The font styles used to display the button's text.
Button
 Inherited
gap : Number
The space, in pixels, between the icon and the label.
Button
 Inherited
Determines if the button's label text renderer is created or not.
Button
 Inherited
The location where the button's content is aligned horizontally (on the x-axis).
Button
 Inherited
hoverIcon : DisplayObject
The icon used for the button's hover state.
Button
 Inherited
hoverSkin : DisplayObject
The skin used for the button's hover state.
BasicButton
 Inherited
iconOffsetX : Number
Offsets the x position of the icon by a certain number of pixels.
Button
 Inherited
iconOffsetY : Number
Offsets the y position of the icon by a certain number of pixels.
Button
 Inherited
iconPosition : String
The location of the icon, relative to the label.
Button
 Inherited
Determines if a pressed button should remain in the down state if a touch moves outside of the button's bounds.
BasicButton
 Inherited
labelOffsetX : Number
Offsets the x position of the label by a certain number of pixels.
Button
 Inherited
labelOffsetY : Number
Offsets the y position of the label by a certain number of pixels.
Button
 Inherited
minGap : Number
If the value of the gap property is Number.POSITIVE_INFINITY, meaning that the gap will fill as much space as possible, the final calculated value will not be smaller than the value of the minGap property.
Button
 Inherited
padding : Number
Quickly sets all padding properties to the same value.
Button
 Inherited
paddingBottom : Number
The minimum space, in pixels, between the button's bottom edge and the button's content.
Button
 Inherited
paddingLeft : Number
The minimum space, in pixels, between the button's left edge and the button's content.
Button
 Inherited
paddingRight : Number
The minimum space, in pixels, between the button's right edge and the button's content.
Button
 Inherited
paddingTop : Number
The minimum space, in pixels, between the button's top edge and the button's content.
Button
 Inherited
scaleWhenDown : Number
The button renders at this scale in the down state.
Button
 Inherited
The button renders at this scale in the hover state.
Button
  
selectedDisabledIcon : DisplayObject
The icon used for the button's disabled state when the button is selected.
ToggleButton
  
selectedDisabledSkin : DisplayObject
The skin used for the button's disabled state when the button is selected.
ToggleButton
  
selectedDownIcon : DisplayObject
The icon used for the button's down state when the button is selected.
ToggleButton
  
selectedDownSkin : DisplayObject
The skin used for the button's down state when the button is selected.
ToggleButton
  
selectedFontStyles : TextFormat
The font styles used to display the button's text when the button is selected.
ToggleButton
  
selectedHoverIcon : DisplayObject
The icon used for the button's hover state when the button is selected.
ToggleButton
  
selectedHoverSkin : DisplayObject
The skin used for the button's hover state when the button is selected.
ToggleButton
  
selectedUpIcon : DisplayObject
The icon used for the button's up state when the button is selected.
ToggleButton
  
selectedUpSkin : DisplayObject
The skin used for the button's up state when the button is selected.
ToggleButton
 Inherited
upIcon : DisplayObject
The icon used for the button's up state.
Button
 Inherited
upSkin : DisplayObject
The skin used for the button's up state.
BasicButton
 Inherited
verticalAlign : String
The location where the button's content is aligned vertically (on the y-axis).
Button
Public Constants
 ConstantDefined By
 InheritedALTERNATE_STYLE_NAME_BACK_BUTTON : String = "feathers-back-button"
[static] An alternate style name to use with Button to allow a theme to give it a "back button" style, perhaps with an arrow pointing backward.
Button
 InheritedALTERNATE_STYLE_NAME_CALL_TO_ACTION_BUTTON : String = "feathers-call-to-action-button"
[static] An alternate style name to use with Button to allow a theme to give it a more prominent, "call-to-action" style.
Button
 InheritedALTERNATE_STYLE_NAME_DANGER_BUTTON : String = "feathers-danger-button"
[static] An alternate style name to use with Button to allow a theme to give it a highly prominent, "danger" style.
Button
 InheritedALTERNATE_STYLE_NAME_FORWARD_BUTTON : String = "feathers-forward-button"
[static] An alternate style name to use with Button to allow a theme to give it a "forward" button style, perhaps with an arrow pointing forward.
Button
 InheritedALTERNATE_STYLE_NAME_QUIET_BUTTON : String = "feathers-quiet-button"
[static] An alternate style name to use with Button to allow a theme to give it a less prominent, "quiet" style.
Button
 InheritedDEFAULT_CHILD_STYLE_NAME_LABEL : String = "feathers-button-label"
[static] The default value added to the styleNameList of the label text renderer.
Button
 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
Property Detail
globalStyleProviderproperty
public static var globalStyleProvider:IStyleProvider

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

The default value is null.

See also

isSelectedproperty 
isSelected:Boolean

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;

The default value is false.


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

See also

isToggleproperty 
isToggle:Boolean

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.


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

See also

toggleGroupproperty 
toggleGroup:ToggleGroup

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 );


Implementation
    public function get toggleGroup():ToggleGroup
    public function set toggleGroup(value:ToggleGroup):void
Constructor Detail
ToggleButton()Constructor
public function ToggleButton()

Constructor.

Event Detail
change Event
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.CHANGE

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:

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.

See also

Style Detail
selectedUpSkinstyle
selectedUpSkin:DisplayObject

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

selectedUpIconstyle 
selectedUpIcon:DisplayObject

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

selectedDownSkinstyle 
selectedDownSkin:DisplayObject

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

selectedDownIconstyle 
selectedDownIcon:DisplayObject

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

selectedHoverSkinstyle 
selectedHoverSkin:DisplayObject

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

selectedHoverIconstyle 
selectedHoverIcon:DisplayObject

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

selectedFontStylesstyle 
selectedFontStyles:TextFormat

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

selectedDisabledSkinstyle 
selectedDisabledSkin:DisplayObject

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

selectedDisabledIconstyle 
selectedDisabledIcon:DisplayObject

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

defaultSelectedSkinstyle 
defaultSelectedSkin:DisplayObject

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

defaultSelectedIconstyle 
defaultSelectedIcon:DisplayObject

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