Package | feathers.controls |
Class | public class ToggleButton |
Inheritance | ToggleButton ![]() ![]() ![]() |
Implements | IToggle |
Subclasses | BaseDefaultItemRenderer, Check, FullScreenToggleButton, MuteToggleButton, PlayPauseToggleButton, Radio |
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
Property | Defined By | ||
---|---|---|---|
![]() | defaultIcon : DisplayObject
The icon used when no other icon is defined for the current state. | Button | |
![]() | defaultLabelProperties : 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 | |
defaultSelectedIcon : DisplayObject
The icon used when no other icon is defined for the current state
when the button is selected. | ToggleButton | ||
defaultSelectedLabelProperties : 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 button's isSelected property is
true), and the properties will be passed down to the
label text renderer when the button validates. | ToggleButton | ||
defaultSelectedSkin : DisplayObject
The skin used when no other skin is defined for the current state
when the button is selected. | ToggleButton | ||
![]() | defaultSkin : DisplayObject
The skin used when no other skin is defined for the current state. | Button | |
![]() | defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
![]() | defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
![]() | disabledIcon : DisplayObject
The icon used for the button's disabled state. | Button | |
![]() | disabledLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DISABLED state,
and the properties will be passed down to the label text renderer
when the button validates. | Button | |
![]() | disabledSkin : DisplayObject
The skin used for the button's disabled state. | Button | |
![]() | downIcon : DisplayObject
The icon used for the button's down state. | Button | |
![]() | downLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DOWN state, and
the properties will be passed down to the label text renderer when
the button validates. | Button | |
![]() | downSkin : DisplayObject
The skin used for the button's down state. | Button | |
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the
top edge of the focus indicator skin. | FeathersControl | |
![]() | gap : Number
The space, in pixels, between the icon and the label. | Button | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all ToggleButton
components. | ToggleButton | ||
![]() | hasLabelTextRenderer : Boolean
Determines if the button's label text renderer is created or not. | Button | |
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | horizontalAlign : String
The location where the button's content is aligned horizontally (on
the x-axis). | Button | |
![]() | hoverIcon : DisplayObject
The icon used for the button's hover state. | Button | |
![]() | hoverLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_HOVER state, and
the properties will be passed down to the label text renderer when
the button validates. | Button | |
![]() | hoverSkin : DisplayObject
The skin used for the button's hover state. | Button | |
![]() | iconOffsetX : Number
Offsets the x position of the icon by a certain number of pixels. | Button | |
![]() | iconOffsetY : Number
Offsets the y position of the icon by a certain number of pixels. | Button | |
![]() | iconPosition : String
The location of the icon, relative to the label. | Button | |
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean | FeathersControl | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isLongPressEnabled : Boolean
Determines if FeathersEventType.LONG_PRESS will be
dispatched. | Button | |
![]() | isQuickHitAreaEnabled : 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 | ||
![]() | keepDownStateOnRollOut : Boolean = false
Determines if a pressed button should remain in the down state if a
touch moves outside of the button's bounds. | Button | |
![]() | label : String
The text displayed on the button. | Button | |
![]() | labelFactory : Function
A function used to instantiate the button's label text renderer
sub-component. | Button | |
![]() | labelOffsetX : Number
Offsets the x position of the label by a certain number of pixels. | Button | |
![]() | labelOffsetY : Number
Offsets the y position of the label by a certain number of pixels. | Button | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
![]() | longPressDuration : Number
The duration, in seconds, of a long press. | Button | |
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | 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 | |
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | padding : Number
Quickly sets all padding properties to the same value. | Button | |
![]() | paddingBottom : Number
The minimum space, in pixels, between the button's bottom edge and
the button's content. | Button | |
![]() | paddingLeft : Number
The minimum space, in pixels, between the button's left edge and the
button's content. | Button | |
![]() | paddingRight : Number
The minimum space, in pixels, between the button's right edge and the
button's content. | Button | |
![]() | paddingTop : Number
The minimum space, in pixels, between the button's top edge and the
button's content. | Button | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | scaleWhenDown : Number
The button renders at this scale in the down state. | Button | |
![]() | scaleWhenHovering : Number
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 | ||
selectedDisabledLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DISABLED state
(and the button's isSelected property is
true), and the properties will be passed down to the
label text renderer when the button validates. | 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 | ||
selectedDownLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DOWN state (and
the button's isSelected property is true),
and the properties will be passed down to the label text renderer
when the button validates. | ToggleButton | ||
selectedDownSkin : DisplayObject
The skin used for the button's down state when the button is
selected. | ToggleButton | ||
selectedHoverIcon : DisplayObject
The icon used for the button's hover state when the button is
selected. | ToggleButton | ||
selectedHoverLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_HOVER state (and
the button's isSelected property is true),
and the properties will be passed down to the label text renderer
when the button validates. | 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 | ||
selectedUpLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_UP state (and
the button's isSelected property is true),
and the properties will be passed down to the label text renderer
when the button validates. | ToggleButton | ||
selectedUpSkin : DisplayObject
The skin used for the button's up state when the button is selected. | ToggleButton | ||
![]() | stateToIconFunction : Function
Returns an icon for the current state. | Button | |
![]() | stateToLabelPropertiesFunction : Function
Returns a text format for the current state. | Button | |
![]() | stateToSkinFunction : Function
Returns a skin for the current state. | Button | |
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
![]() | upIcon : DisplayObject
The icon used for the button's up state. | Button | |
![]() | upLabelProperties : Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_UP state, and the
properties will be passed down to the label text renderer when the
button validates. | Button | |
![]() | upSkin : DisplayObject
The skin used for the button's up state. | Button | |
![]() | verticalAlign : String
The location where the button's content is aligned vertically (on
the y-axis). | Button | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
Constructor. | ToggleButton | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | FeathersControl | |
![]() | invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the button is selected or deselected either programmatically or as a result of user interaction. | ToggleButton | |||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
![]() | Dispatched when the button is pressed for a long time. | Button | ||
![]() | Dispatched when the width or height of the control changes. | FeathersControl | ||
![]() | Dispatched when the the user taps or clicks the button. | Button |
defaultSelectedIcon | property |
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
.
public function get defaultSelectedIcon():DisplayObject
public function set defaultSelectedIcon(value:DisplayObject):void
See also
defaultSelectedLabelProperties | property |
defaultSelectedLabelProperties: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 button's isSelected
property is
true
), and the properties will be passed down to the
label text renderer when the button validates. The available
properties depend on which ITextRenderer
implementation
is returned by labelFactory
. Refer to
feathers.core.ITextRenderer
for a list of available text renderer implementations.
The following example gives the button default label properties to use for all selected states when no specific label properties are available:
button.defaultSelectedLabelProperties.textFormat = new BitmapFontTextFormat( bitmapFont ); button.defaultSelectedLabelProperties.wordWrap = true;
The default value is null
.
public function get defaultSelectedLabelProperties():Object
public function set defaultSelectedLabelProperties(value:Object):void
See also
defaultSelectedSkin | property |
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
.
public function get defaultSelectedSkin():DisplayObject
public function set defaultSelectedSkin(value:DisplayObject):void
See also
globalStyleProvider | property |
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
isSelected | property |
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
.
public function get isSelected():Boolean
public function set isSelected(value:Boolean):void
See also
isToggle | property |
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
.
public function get isToggle():Boolean
public function set isToggle(value:Boolean):void
See also
selectedDisabledIcon | property |
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 );
The default value is null
.
public function get selectedDisabledIcon():DisplayObject
public function set selectedDisabledIcon(value:DisplayObject):void
See also
selectedDisabledLabelProperties | property |
selectedDisabledLabelProperties:Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DISABLED
state
(and the button's isSelected
property is
true
), and the properties will be passed down to the
label text renderer when the button validates. The available
properties depend on which ITextRenderer
implementation
is returned by labelFactory
. Refer to
feathers.core.ITextRenderer
for a list of available text renderer implementations.
The following example gives the button label properties for the selected disabled state:
button.selectedDisabledLabelProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
The default value is null
.
public function get selectedDisabledLabelProperties():Object
public function set selectedDisabledLabelProperties(value:Object):void
See also
selectedDisabledSkin | property |
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 );
The default value is null
.
public function get selectedDisabledSkin():DisplayObject
public function set selectedDisabledSkin(value:DisplayObject):void
See also
selectedDownIcon | property |
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 );
The default value is null
.
public function get selectedDownIcon():DisplayObject
public function set selectedDownIcon(value:DisplayObject):void
See also
selectedDownLabelProperties | property |
selectedDownLabelProperties:Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_DOWN
state (and
the button's isSelected
property is true
),
and the properties will be passed down to the label text renderer
when the button validates. The available properties depend on which
ITextRenderer
implementation is returned by
labelFactory
. Refer to
feathers.core.ITextRenderer
for a list of available text renderer implementations.
The following example gives the button label properties for the selected down state:
button.selectedDownLabelProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
The default value is null
.
public function get selectedDownLabelProperties():Object
public function set selectedDownLabelProperties(value:Object):void
See also
selectedDownSkin | property |
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 );
The default value is null
.
public function get selectedDownSkin():DisplayObject
public function set selectedDownSkin(value:DisplayObject):void
See also
selectedHoverIcon | property |
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 );
The default value is null
.
public function get selectedHoverIcon():DisplayObject
public function set selectedHoverIcon(value:DisplayObject):void
See also
selectedHoverLabelProperties | property |
selectedHoverLabelProperties:Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_HOVER
state (and
the button's isSelected
property is true
),
and the properties will be passed down to the label text renderer
when the button validates. The available properties depend on which
ITextRenderer
implementation is returned by
labelFactory
. Refer to
feathers.core.ITextRenderer
for a list of available text renderer implementations.
The following example gives the button label properties for the selected hover state:
button.selectedHoverLabelProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
The default value is null
.
public function get selectedHoverLabelProperties():Object
public function set selectedHoverLabelProperties(value:Object):void
See also
selectedHoverSkin | property |
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 );
The default value is null
.
public function get selectedHoverSkin():DisplayObject
public function set selectedHoverSkin(value:DisplayObject):void
See also
selectedUpIcon | property |
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 );
The default value is null
.
public function get selectedUpIcon():DisplayObject
public function set selectedUpIcon(value:DisplayObject):void
See also
selectedUpLabelProperties | property |
selectedUpLabelProperties:Object
An object that stores properties for the button's label text renderer
when the button is in the Button.STATE_UP
state (and
the button's isSelected
property is true
),
and the properties will be passed down to the label text renderer
when the button validates. The available properties depend on which
ITextRenderer
implementation is returned by
labelFactory
. Refer to
feathers.core.ITextRenderer
for a list of available text renderer implementations.
The following example gives the button label properties for the selected up state:
button.selectedUpLabelProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
The default value is null
.
public function get selectedUpLabelProperties():Object
public function set selectedUpLabelProperties(value:Object):void
See also
selectedUpSkin | property |
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 );
The default value is null
.
public function get selectedUpSkin():DisplayObject
public function set selectedUpSkin(value:DisplayObject):void
See also
ToggleButton | () | Constructor |
public function ToggleButton()
Constructor.
change | Event |
starling.events.Event
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:
Property | Value |
---|---|
bubbles | false |
currentTarget | The 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 . |
data | null |
target | The 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