Packagefeathers.controls
Classpublic class Button
InheritanceButton Inheritance FeathersControl Inheritance Sprite Inheritance DisplayObjectContainer Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IToggle
Subclasses Key

A push (or optionally, toggle) button control.

See also

http://wiki.starling-framework.org/feathers/button


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The opacity of the object.
DisplayObject
  autoFlatten : Boolean
Determines if the button should automatically call flatten() after it finishes drawing.
Button
 Inheritedbase : DisplayObject
[read-only] The topmost object in the display tree the object is part of.
DisplayObject
 InheritedblendMode : String
The blend mode determines how the object is blended with the objects underneath.
DisplayObject
 Inheritedbounds : Rectangle
[read-only] The bounds of the object relative to the local coordinates of the parent.
DisplayObject
  defaultIcon : DisplayObject
The icon used when no other icon is defined for the current state.
Button
  defaultLabelProperties : Object
The default label properties are a set of key/value pairs to be passed down ot the button's label instance, and it is used when no other properties are defined for the button's current state.
Button
  defaultSelectedIcon : DisplayObject
The icon used when no other icon is defined for the current state when the button is selected.
Button
  defaultSelectedLabelProperties : Object
The default selected label properties are a set of key/value pairs to be passed down ot the button's label instance, and it is used when the button is selected and no other properties are defined for the button's current state.
Button
  defaultSelectedSkin : DisplayObject
The skin used when no other skin is defined for the current state when the button is selected.
Button
  defaultSkin : DisplayObject
The skin used when no other skin is defined for the current state.
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
  disabledIcon : DisplayObject
The icon used for the button's disabled state.
Button
  disabledLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label instance when the button is in the disabled state.
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
A set of key/value pairs to be passed down ot the button's label instance when the button is in the down state.
Button
  downSkin : DisplayObject
The skin used for the button's down state.
Button
 Inheritedfilter : FragmentFilter
The filter or filter group that is attached to the display object.
DisplayObject
  gap : Number
The space, in pixels, between the icon and the label.
Button
 InheritedhasVisibleArea : Boolean
[read-only] Indicates if an object occupies any visible area.
DisplayObject
 Inheritedheight : 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
A set of key/value pairs to be passed down ot the button's label instance when the button is in the hover state.
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
  isEnabled : Boolean
[override]
Button
 InheritedisFlattened : Boolean
[read-only] Indicates if the sprite was flattened.
Sprite
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
  isSelected : Boolean
Indicates if the button is selected or not.
Button
  isToggle : Boolean
Determines if the button may be selected or unselected when clicked.
Button
  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 subcomponent.
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
 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
 Inheritedname : String
[override] The concatenated nameList, with each name separated by spaces.
FeathersControl
 InheritednameList : TokenList
[read-only] Contains a list of all "names" assigned to this control.
FeathersControl
 InheritednumChildren : int
[read-only] The number of children of this container.
DisplayObjectContainer
  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
 Inheritedparent : DisplayObjectContainer
[read-only] The display object container that contains this display object.
DisplayObject
 InheritedpivotX : Number
The x coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
 InheritedpivotY : Number
The y coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
 Inheritedroot : DisplayObject
[read-only] The root object the display object is connected to (i.e.
DisplayObject
 Inheritedrotation : Number
The rotation of the object in radians.
DisplayObject
 InheritedscaleX : Number
The horizontal scale factor.
DisplayObject
 InheritedscaleY : Number
The vertical scale factor.
DisplayObject
  selectedDisabledIcon : DisplayObject
The icon used for the button's disabled state when the button is selected.
Button
  selectedDisabledLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label instance when the button is in the disabled state and is selected.
Button
  selectedDisabledSkin : DisplayObject
The skin used for the button's disabled state when the button is selected.
Button
  selectedDownIcon : DisplayObject
The icon used for the button's down state when the button is selected.
Button
  selectedDownLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label instance when the button is in the down state and is selected.
Button
  selectedDownSkin : DisplayObject
The skin used for the button's down state when the button is selected.
Button
  selectedHoverIcon : DisplayObject
The icon used for the button's hover state when the button is selected.
Button
  selectedHoverLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label instance when the button is in the hover state and is selected.
Button
  selectedHoverSkin : DisplayObject
The skin used for the button's hover state when the button is selected.
Button
  selectedUpIcon : DisplayObject
The icon used for the button's up state when the button is selected.
Button
  selectedUpLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label instance when the button is in the up state and is selected.
Button
  selectedUpSkin : DisplayObject
The skin used for the button's up state when the button is selected.
Button
 InheritedskewX : Number
The horizontal skew angle in radians.
DisplayObject
 InheritedskewY : Number
The vertical skew angle in radians.
DisplayObject
 Inheritedstage : Stage
[read-only] The stage the display object is connected to, or null if it is not connected to the stage.
DisplayObject
  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
 Inheritedtouchable : Boolean
Indicates if this object (and its children) will receive touch events.
DisplayObject
 InheritedtransformationMatrix : Matrix
The transformation matrix of the object relative to its parent.
DisplayObject
  upIcon : DisplayObject
The icon used for the button's up state.
Button
  upLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label instance when the button is in the up state.
Button
  upSkin : DisplayObject
The skin used for the button's up state.
Button
 InheriteduseHandCursor : Boolean
Indicates if the mouse cursor should transform into a hand while it's over the sprite.
DisplayObject
  verticalAlign : String
The location where the button's content is aligned vertically (on the y-axis).
Button
 Inheritedvisible : Boolean
The visibility of the object.
DisplayObject
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
 Inheritedx : Number
The x coordinate of the object relative to the local coordinates of the parent.
DisplayObject
 Inheritedy : Number
The y coordinate of the object relative to the local coordinates of the parent.
DisplayObject
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheritedexplicitHeight : Number = NaN
The height value explicitly set by calling the height setter or setSize().
FeathersControl
 InheritedexplicitWidth : Number = NaN
The width value explicitly set by calling the width setter or setSize().
FeathersControl
  labelName : String = feathers-button-label
The value added to the nameList of the label.
Button
  labelTextRenderer : ITextRenderer
The text renderer for the button's label.
Button
  stateNames : Vector.<String>
[read-only] A list of all valid state names.
Button
Public Methods
 MethodDefined By
  
Constructor.
Button
 Inherited
Adds a child to the container.
DisplayObjectContainer
 Inherited
Adds a child to the container at a certain index.
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function):void
Registers an event listener at a certain object.
EventDispatcher
 Inherited
broadcastEvent(event:Event):void
Dispatches an event on all children (recursively).
DisplayObjectContainer
 Inherited
broadcastEventWith(type:String, data:Object = null):void
Dispatches an event with the given parameters on all children (recursively).
DisplayObjectContainer
 Inherited
contains(child:DisplayObject):Boolean
Determines if a certain object is a child of the container (recursively).
DisplayObjectContainer
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all objects that have registered listeners for its type.
EventDispatcher
 Inherited
dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void
Dispatches an event with the given parameters to all objects that have registered listeners for the given type.
EventDispatcher
 Inherited
dispose():void
[override] Disposes the resources of all children.
Sprite
 Inherited
flatten():void
Optimizes the sprite for optimal rendering performance.
Sprite
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Returns a rectangle that completely encloses the object as it appears in another coordinate system.
DisplayObjectContainer
 Inherited
Returns a child object at a certain index.
DisplayObjectContainer
 Inherited
Returns a child object with a certain name (non-recursively).
DisplayObjectContainer
 Inherited
Returns the index of a child within the container, or "-1" if it is not found.
DisplayObjectContainer
 Inherited
getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix
Creates a matrix that represents the transformation from the local coordinate system to another.
DisplayObject
 Inherited
globalToLocal(globalPoint:Point, resultPoint:Point = null):Point
Transforms a point from global (stage) coordinates to the local coordinate system.
DisplayObject
 Inherited
hasEventListener(type:String):Boolean
Returns if there are listeners registered for a certain event type.
EventDispatcher
 Inherited
hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject
[override] Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails.
DisplayObjectContainer
 Inherited
invalidate(flag:String):void
When called, the UI control will redraw within one frame.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is invalid or not.
FeathersControl
 Inherited
localToGlobal(localPoint:Point, resultPoint:Point = null):Point
Transforms a point from the local coordinate system to global (stage) coordinates.
DisplayObject
 Inherited
removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject
Removes a child from the container.
DisplayObjectContainer
 Inherited
removeChildAt(index:int, dispose:Boolean = false):DisplayObject
Removes a child at a certain index.
DisplayObjectContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void
Removes a range of children from the container (endIndex included).
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function):void
Removes an event listener from the object.
EventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all event listeners with a certain type, or all of them if type is null.
EventDispatcher
 Inherited
removeFromParent(dispose:Boolean = false):void
Removes the object from its parent, if it has one.
DisplayObject
 Inherited
render(support:RenderSupport, parentAlpha:Number):void
[override] Renders the display object with the help of a support object.
Sprite
 Inherited
setChildIndex(child:DisplayObject, index:int):void
Moves a child to a certain index.
DisplayObjectContainer
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control.
FeathersControl
 Inherited
sortChildren(compareFunction:Function):void
Sorts the children according to a given function (that works just like the sort function of the Vector class).
DisplayObjectContainer
 Inherited
Swaps the indexes of two children.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the indexes of two children.
DisplayObjectContainer
 Inherited
unflatten():void
Removes the rendering optimizations that were created when flattening the sprite.
Sprite
 Inherited
validate():void
Immediately validates the control, which triggers a redraw, if one is pending.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
initialize():void
Override to initialize the UI control.
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
 InheritedDispatched when an object is added to a parent.DisplayObject
 InheritedDispatched when an object is connected to the stage (directly or indirectly).DisplayObject
  Dispatched when the button is selected or unselected.Button
 InheritedDispatched once every frame on every object that is connected to the stage.DisplayObject
 InheritedDispatched on all children when the object is flattened.Sprite
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when an object is removed from its parent.DisplayObject
 InheritedDispatched when an object is removed from the stage and won't be rendered any longer.DisplayObject
 InheritedDispatched when the width or height of the control changes.FeathersControl
 InheritedDispatched when an object is touched.DisplayObject
  Dispatched when the button is released while the touch is still within the button's bounds (a tap or click that should trigger the button).Button
Public Constants
 ConstantDefined By
  DEFAULT_CHILD_NAME_LABEL : String = feathers-button-label
[static] The default value added to the nameList of the label.
Button
  HORIZONTAL_ALIGN_CENTER : String = center
[static] The icon and label will be aligned horizontally to the center of the button.
Button
  HORIZONTAL_ALIGN_LEFT : String = left
[static] The icon and label will be aligned horizontally to the left edge of the button.
Button
  HORIZONTAL_ALIGN_RIGHT : String = right
[static] The icon and label will be aligned horizontally to the right edge of the button.
Button
  ICON_POSITION_BOTTOM : String = bottom
[static] The icon will be positioned below the label.
Button
  ICON_POSITION_LEFT : String = left
[static] The icon will be positioned to the left of the label.
Button
  ICON_POSITION_LEFT_BASELINE : String = leftBaseline
[static] The icon will be positioned to the left the label, and the bottom of the icon will be aligned to the baseline of the label text.
Button
  ICON_POSITION_MANUAL : String = manual
[static] The icon will be positioned manually with no relation to the position of the label.
Button
  ICON_POSITION_RIGHT : String = right
[static] The icon will be positioned to the right of the label.
Button
  ICON_POSITION_RIGHT_BASELINE : String = rightBaseline
[static] The icon will be positioned to the right the label, and the bottom of the icon will be aligned to the baseline of the label text.
Button
  ICON_POSITION_TOP : String = top
[static] The icon will be positioned above the label.
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_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
  VERTICAL_ALIGN_BOTTOM : String = bottom
[static] The icon and label will be aligned vertically to the bottom edge of the button.
Button
  VERTICAL_ALIGN_MIDDLE : String = middle
[static] The icon and label will be aligned vertically to the middle of the button.
Button
  VERTICAL_ALIGN_TOP : String = top
[static] The icon and label will be aligned vertically to the top edge of the button.
Button
Property Detail
autoFlattenproperty
autoFlatten:Boolean

Determines if the button should automatically call flatten() after it finishes drawing. In some cases, this will improve performance.


Implementation
    public function get autoFlatten():Boolean
    public function set autoFlatten(value:Boolean):void
defaultIconproperty 
defaultIcon:DisplayObject

The icon used when no other icon is defined for the current state. Intended for use when multiple states should use the same icon.


Implementation
    public function get defaultIcon():DisplayObject
    public function set defaultIcon(value:DisplayObject):void

See also

defaultLabelPropertiesproperty 
defaultLabelProperties:Object

The default label properties are a set of key/value pairs to be passed down ot the button's label instance, and it is used when no other properties are defined for the button's current state. Intended for use when multiple states should use the same properties.


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

See also

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


Implementation
    public function get defaultSelectedIcon():DisplayObject
    public function set defaultSelectedIcon(value:DisplayObject):void

See also

defaultSelectedLabelPropertiesproperty 
defaultSelectedLabelProperties:Object

The default selected label properties are a set of key/value pairs to be passed down ot the button's label instance, and it is used when the button is selected and no other properties are defined for the button's current state. If null, then defaultLabelProperties is used instead.


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

See also

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


Implementation
    public function get defaultSelectedSkin():DisplayObject
    public function set defaultSelectedSkin(value:DisplayObject):void

See also

defaultSkinproperty 
defaultSkin:DisplayObject

The skin used when no other skin is defined for the current state. Intended for use when multiple states should use the same skin.


Implementation
    public function get defaultSkin():DisplayObject
    public function set defaultSkin(value:DisplayObject):void

See also

disabledIconproperty 
disabledIcon:DisplayObject

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


Implementation
    public function get disabledIcon():DisplayObject
    public function set disabledIcon(value:DisplayObject):void

See also

disabledLabelPropertiesproperty 
disabledLabelProperties:Object

A set of key/value pairs to be passed down ot the button's label instance when the button is in the disabled state. If null, then defaultLabelProperties is used instead.


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

See also

disabledSkinproperty 
disabledSkin:DisplayObject

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


Implementation
    public function get disabledSkin():DisplayObject
    public function set disabledSkin(value:DisplayObject):void

See also

downIconproperty 
downIcon:DisplayObject

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


Implementation
    public function get downIcon():DisplayObject
    public function set downIcon(value:DisplayObject):void

See also

downLabelPropertiesproperty 
downLabelProperties:Object

A set of key/value pairs to be passed down ot the button's label instance when the button is in the down state. If null, then defaultLabelProperties is used instead.


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

See also

downSkinproperty 
downSkin:DisplayObject

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


Implementation
    public function get downSkin():DisplayObject
    public function set downSkin(value:DisplayObject):void

See also

gapproperty 
gap:Number

The space, in pixels, between the icon and the label. Applies to either horizontal or vertical spacing, depending on the value of iconPosition.

If gap is set to Number.POSITIVE_INFINITY, the label and icon will be positioned as far apart as possible. In other words, they will be positioned at the edges of the button, adjusted for padding.


Implementation
    public function get gap():Number
    public function set gap(value:Number):void

See also

horizontalAlignproperty 
horizontalAlign:String

The location where the button's content is aligned horizontally (on the x-axis).


Implementation
    public function get horizontalAlign():String
    public function set horizontalAlign(value:String):void
hoverIconproperty 
hoverIcon:DisplayObject

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


Implementation
    public function get hoverIcon():DisplayObject
    public function set hoverIcon(value:DisplayObject):void

See also

hoverLabelPropertiesproperty 
hoverLabelProperties:Object

A set of key/value pairs to be passed down ot the button's label instance when the button is in the hover state. If null, then defaultLabelProperties is used instead.


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

See also

hoverSkinproperty 
hoverSkin:DisplayObject

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


Implementation
    public function get hoverSkin():DisplayObject
    public function set hoverSkin(value:DisplayObject):void

See also

iconOffsetXproperty 
iconOffsetX:Number

Offsets the x position of the icon by a certain number of pixels.


Implementation
    public function get iconOffsetX():Number
    public function set iconOffsetX(value:Number):void
iconOffsetYproperty 
iconOffsetY:Number

Offsets the y position of the icon by a certain number of pixels.


Implementation
    public function get iconOffsetY():Number
    public function set iconOffsetY(value:Number):void
iconPositionproperty 
iconPosition:String

The location of the icon, relative to the label.


Implementation
    public function get iconPosition():String
    public function set iconPosition(value:String):void
isEnabledproperty 
isEnabled:Boolean[override]


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

Indicates if the button is selected or not. The button may be selected programmatically, even if isToggle 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 unselected when clicked.


Implementation
    public function get isToggle():Boolean
    public function set isToggle(value:Boolean):void
keepDownStateOnRollOutproperty 
public var keepDownStateOnRollOut:Boolean = false

Determines if a pressed button should remain in the down state if a touch moves outside of the button's bounds. Useful for controls like Slider and ToggleSwitch to keep a thumb in the down state while it is dragged around.

labelproperty 
label:String

The text displayed on the button.


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

A function used to instantiate the button's label subcomponent.

The factory should have the following function signature:

function():ITextRenderer


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

See also

labelNameproperty 
protected var labelName:String = feathers-button-label

The value added to the nameList of the label.

labelOffsetXproperty 
labelOffsetX:Number

Offsets the x position of the label by a certain number of pixels.


Implementation
    public function get labelOffsetX():Number
    public function set labelOffsetX(value:Number):void
labelOffsetYproperty 
labelOffsetY:Number

Offsets the y position of the label by a certain number of pixels.


Implementation
    public function get labelOffsetY():Number
    public function set labelOffsetY(value:Number):void
labelTextRendererproperty 
protected var labelTextRenderer:ITextRenderer

The text renderer for the button's label.

paddingBottomproperty 
paddingBottom:Number

The minimum space, in pixels, between the button's bottom edge and the button's content.


Implementation
    public function get paddingBottom():Number
    public function set paddingBottom(value:Number):void
paddingLeftproperty 
paddingLeft:Number

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


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

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


Implementation
    public function get paddingRight():Number
    public function set paddingRight(value:Number):void
paddingTopproperty 
paddingTop:Number

The minimum space, in pixels, between the button's top edge and the button's content.


Implementation
    public function get paddingTop():Number
    public function set paddingTop(value:Number):void
selectedDisabledIconproperty 
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.


Implementation
    public function get selectedDisabledIcon():DisplayObject
    public function set selectedDisabledIcon(value:DisplayObject):void

See also

selectedDisabledLabelPropertiesproperty 
selectedDisabledLabelProperties:Object

A set of key/value pairs to be passed down ot the button's label instance when the button is in the disabled state and is selected. If null, then defaultSelectedLabelProperties is used instead. If defaultSelectedLabelProperties is also null, then defaultLabelProperties is used.


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

See also

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


Implementation
    public function get selectedDisabledSkin():DisplayObject
    public function set selectedDisabledSkin(value:DisplayObject):void

See also

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


Implementation
    public function get selectedDownIcon():DisplayObject
    public function set selectedDownIcon(value:DisplayObject):void

See also

selectedDownLabelPropertiesproperty 
selectedDownLabelProperties:Object

A set of key/value pairs to be passed down ot the button's label instance when the button is in the down state and is selected. If null, then defaultSelectedLabelProperties is used instead. If defaultSelectedLabelProperties is also null, then defaultLabelProperties is used.


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

See also

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


Implementation
    public function get selectedDownSkin():DisplayObject
    public function set selectedDownSkin(value:DisplayObject):void

See also

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


Implementation
    public function get selectedHoverIcon():DisplayObject
    public function set selectedHoverIcon(value:DisplayObject):void

See also

selectedHoverLabelPropertiesproperty 
selectedHoverLabelProperties:Object

A set of key/value pairs to be passed down ot the button's label instance when the button is in the hover state and is selected. If null, then defaultSelectedLabelProperties is used instead. If defaultSelectedLabelProperties is also null, then defaultLabelProperties is used.


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

See also

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


Implementation
    public function get selectedHoverSkin():DisplayObject
    public function set selectedHoverSkin(value:DisplayObject):void

See also

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


Implementation
    public function get selectedUpIcon():DisplayObject
    public function set selectedUpIcon(value:DisplayObject):void

See also

selectedUpLabelPropertiesproperty 
selectedUpLabelProperties:Object

A set of key/value pairs to be passed down ot the button's label instance when the button is in the up state and is selected. If null, then defaultSelectedLabelProperties is used instead. If defaultSelectedLabelProperties is also null, then defaultLabelProperties is used.


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

See also

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


Implementation
    public function get selectedUpSkin():DisplayObject
    public function set selectedUpSkin(value:DisplayObject):void

See also

stateNamesproperty 
stateNames:Vector.<String>  [read-only]

A list of all valid state names.


Implementation
    protected function get stateNames():Vector.<String>
stateToIconFunctionproperty 
stateToIconFunction:Function

Returns an icon for the current state.

The following function signature is expected:

function(target:Button, state:Object, oldIcon:DisplayObject = null):DisplayObject


Implementation
    public function get stateToIconFunction():Function
    public function set stateToIconFunction(value:Function):void
stateToLabelPropertiesFunctionproperty 
stateToLabelPropertiesFunction:Function

Returns a text format for the current state.

The following function signature is expected:

function(target:Button, state:Object):Object


Implementation
    public function get stateToLabelPropertiesFunction():Function
    public function set stateToLabelPropertiesFunction(value:Function):void
stateToSkinFunctionproperty 
stateToSkinFunction:Function

Returns a skin for the current state.

The following function signature is expected:

function(target:Button, state:Object, oldSkin:DisplayObject = null):DisplayObject


Implementation
    public function get stateToSkinFunction():Function
    public function set stateToSkinFunction(value:Function):void
upIconproperty 
upIcon:DisplayObject

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


Implementation
    public function get upIcon():DisplayObject
    public function set upIcon(value:DisplayObject):void

See also

upLabelPropertiesproperty 
upLabelProperties:Object

A set of key/value pairs to be passed down ot the button's label instance when the button is in the up state. If null, then defaultLabelProperties is used instead.


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

See also

upSkinproperty 
upSkin:DisplayObject

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


Implementation
    public function get upSkin():DisplayObject
    public function set upSkin(value:DisplayObject):void

See also

verticalAlignproperty 
verticalAlign:String

The location where the button's content is aligned vertically (on the y-axis).


Implementation
    public function get verticalAlign():String
    public function set verticalAlign(value:String):void
Constructor Detail
Button()Constructor
public function Button()

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 unselected. A button's selection may be changed by the user when isToggle is set to true. The selection may be changed programmatically at any time, regardless of the value of isToggle.

An event type to be utilized in custom events. Not used by Starling right now.
triggered Event  
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.TRIGGERED

Dispatched when the button is released while the touch is still within the button's bounds (a tap or click that should trigger the button).

Event type for a triggered button.
Constant Detail
DEFAULT_CHILD_NAME_LABELConstant
public static const DEFAULT_CHILD_NAME_LABEL:String = feathers-button-label

The default value added to the nameList of the label.

HORIZONTAL_ALIGN_CENTERConstant 
public static const HORIZONTAL_ALIGN_CENTER:String = center

The icon and label will be aligned horizontally to the center of the button.

HORIZONTAL_ALIGN_LEFTConstant 
public static const HORIZONTAL_ALIGN_LEFT:String = left

The icon and label will be aligned horizontally to the left edge of the button.

HORIZONTAL_ALIGN_RIGHTConstant 
public static const HORIZONTAL_ALIGN_RIGHT:String = right

The icon and label will be aligned horizontally to the right edge of the button.

ICON_POSITION_BOTTOMConstant 
public static const ICON_POSITION_BOTTOM:String = bottom

The icon will be positioned below the label.

ICON_POSITION_LEFTConstant 
public static const ICON_POSITION_LEFT:String = left

The icon will be positioned to the left of the label.

ICON_POSITION_LEFT_BASELINEConstant 
public static const ICON_POSITION_LEFT_BASELINE:String = leftBaseline

The icon will be positioned to the left the label, and the bottom of the icon will be aligned to the baseline of the label text.

ICON_POSITION_MANUALConstant 
public static const ICON_POSITION_MANUAL:String = manual

The icon will be positioned manually with no relation to the position of the label. Use iconOffsetX and iconOffsetY to set the icon's position.

See also

ICON_POSITION_RIGHTConstant 
public static const ICON_POSITION_RIGHT:String = right

The icon will be positioned to the right of the label.

ICON_POSITION_RIGHT_BASELINEConstant 
public static const ICON_POSITION_RIGHT_BASELINE:String = rightBaseline

The icon will be positioned to the right the label, and the bottom of the icon will be aligned to the baseline of the label text.

ICON_POSITION_TOPConstant 
public static const ICON_POSITION_TOP:String = top

The icon will be positioned above the label.

VERTICAL_ALIGN_BOTTOMConstant 
public static const VERTICAL_ALIGN_BOTTOM:String = bottom

The icon and label will be aligned vertically to the bottom edge of the button.

VERTICAL_ALIGN_MIDDLEConstant 
public static const VERTICAL_ALIGN_MIDDLE:String = middle

The icon and label will be aligned vertically to the middle of the button.

VERTICAL_ALIGN_TOPConstant 
public static const VERTICAL_ALIGN_TOP:String = top

The icon and label will be aligned vertically to the top edge of the button.