| Package | feathers.controls |
| Class | public class Button |
| Inheritance | Button  FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
| Implements | IToggle, IFocusDisplayObject |
| Subclasses | BaseDefaultItemRenderer, Check, Radio |
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number The opacity of the object. | DisplayObject | |
| autoFlatten : Boolean
Determines if the button should automatically call flatten()
after it finishes drawing. | Button | ||
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| clipRect : Rectangle [override] | FeathersControl | |
| 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 | ||
| 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 | |
| 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 | ||
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusManager : IFocusManager
The current focus manager for this component. | FeathersControl | |
| gap : Number
The space, in pixels, between the icon and the label. | Button | ||
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| 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
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 | ||
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| isEnabled : Boolean [override]
| Button | ||
| isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
| isFocusEnabled : Boolean
Determines if this component can receive focus. | FeathersControl | |
| isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
| isQuickHitAreaEnabled : 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 | ||
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| 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 | |
| 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 | |
| name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
| nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| 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 | ||
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : 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 | ||
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| stage : 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 | ||
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : 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 | ||
| useHandCursor : 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 | ||
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| Property | Defined By | ||
|---|---|---|---|
| actualHeight : Number = 0
The final height value that should be used for layout. | FeathersControl | |
| actualWidth : Number = 0
The final width value that should be used for layout. | FeathersControl | |
| explicitHeight : Number = NaN
The height value explicitly set by calling the height setter or
setSize(). | FeathersControl | |
| explicitWidth : 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 | ||
| Method | Defined By | ||
|---|---|---|---|
Button()
Constructor. | Button | ||
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| 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 | |
| dispose():void [override] Disposes the resources of all children. | Sprite | |
| flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Sprite | |
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
| getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or
null if the sprite doens't have a clipRect. | Sprite | |
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| 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. | Sprite | |
| 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 | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | FeathersControl | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
| validate():void
Immediately validates the control, which triggers a redraw, if one
is pending. | FeathersControl | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an object is added to a parent. | DisplayObject | ||
| Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject | ||
| Dispatched when the button is selected or unselected. | Button | |||
| Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
| Dispatched on all children when the object is flattened. | Sprite | ||
| Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
| Dispatched when a key on the keyboard is pressed. | DisplayObject | ||
| Dispatched when a key on the keyboard is released. | DisplayObject | ||
| Dispatched when an object is removed from its parent. | DisplayObject | ||
| Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject | ||
| Dispatched when the width or height of the control changes. | FeathersControl | ||
| Dispatched 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 | |||
| Constant | Defined 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 | ||
| INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
| INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
| INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
| INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
| INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
| INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
| INVALIDATION_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 | ||
| autoFlatten | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesautoFlatten:Boolean
Determines if the button should automatically call flatten()
after it finishes drawing. In some cases, this will improve
performance.
public function get autoFlatten():Boolean public function set autoFlatten(value:Boolean):void| defaultIcon | property |
defaultIcon:DisplayObjectThe icon used when no other icon is defined for the current state. Intended for use when multiple states should use the same icon.
public function get defaultIcon():DisplayObject public function set defaultIcon(value:DisplayObject):voidSee also
| defaultLabelProperties | property |
defaultLabelProperties:ObjectThe 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.
public function get defaultLabelProperties():Object public function set defaultLabelProperties(value:Object):voidSee also
| 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.
public function get defaultSelectedIcon():DisplayObject public function set defaultSelectedIcon(value:DisplayObject):voidSee also
| defaultSelectedLabelProperties | property |
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.
public function get defaultSelectedLabelProperties():Object public function set defaultSelectedLabelProperties(value:Object):voidSee 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.
public function get defaultSelectedSkin():DisplayObject public function set defaultSelectedSkin(value:DisplayObject):voidSee also
| defaultSkin | property |
defaultSkin:DisplayObjectThe skin used when no other skin is defined for the current state. Intended for use when multiple states should use the same skin.
public function get defaultSkin():DisplayObject public function set defaultSkin(value:DisplayObject):voidSee also
| disabledIcon | property |
disabledIcon:DisplayObject
The icon used for the button's disabled state. If null, then
defaultIcon is used instead.
public function get disabledIcon():DisplayObject public function set disabledIcon(value:DisplayObject):voidSee also
| disabledLabelProperties | property |
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.
public function get disabledLabelProperties():Object public function set disabledLabelProperties(value:Object):voidSee also
| disabledSkin | property |
disabledSkin:DisplayObject
The skin used for the button's disabled state. If null,
then defaultSkin is used instead.
public function get disabledSkin():DisplayObject public function set disabledSkin(value:DisplayObject):voidSee also
| downIcon | property |
downIcon:DisplayObject
The icon used for the button's down state. If null, then
defaultIcon is used instead.
public function get downIcon():DisplayObject public function set downIcon(value:DisplayObject):voidSee also
| downLabelProperties | property |
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.
public function get downLabelProperties():Object public function set downLabelProperties(value:Object):voidSee also
| downSkin | property |
downSkin:DisplayObject
The skin used for the button's down state. If null, then
defaultSkin is used instead.
public function get downSkin():DisplayObject public function set downSkin(value:DisplayObject):voidSee also
| gap | property |
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.
public function get gap():Number public function set gap(value:Number):voidSee also
| horizontalAlign | property |
horizontalAlign:StringThe location where the button's content is aligned horizontally (on the x-axis).
public function get horizontalAlign():String public function set horizontalAlign(value:String):void| hoverIcon | property |
hoverIcon:DisplayObject
The icon used for the button's hover state. If null, then
defaultIcon is used instead.
public function get hoverIcon():DisplayObject public function set hoverIcon(value:DisplayObject):voidSee also
| hoverLabelProperties | property |
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.
public function get hoverLabelProperties():Object public function set hoverLabelProperties(value:Object):voidSee also
| hoverSkin | property |
hoverSkin:DisplayObject
The skin used for the button's hover state. If null, then
defaultSkin is used instead.
public function get hoverSkin():DisplayObject public function set hoverSkin(value:DisplayObject):voidSee also
| iconOffsetX | property |
iconOffsetX:NumberOffsets the x position of the icon by a certain number of pixels.
public function get iconOffsetX():Number public function set iconOffsetX(value:Number):void| iconOffsetY | property |
iconOffsetY:NumberOffsets the y position of the icon by a certain number of pixels.
public function get iconOffsetY():Number public function set iconOffsetY(value:Number):void| iconPosition | property |
iconPosition:StringThe location of the icon, relative to the label.
public function get iconPosition():String public function set iconPosition(value:String):void| isEnabled | property |
isEnabled:Boolean[override]
public function get isEnabled():Boolean public function set isEnabled(value:Boolean):void| isSelected | property |
isSelected:Boolean
Indicates if the button is selected or not. The button may be
selected programmatically, even if isToggle is false.
public function get isSelected():Boolean public function set isSelected(value:Boolean):voidSee also
| isToggle | property |
isToggle:BooleanDetermines if the button may be selected or unselected when clicked.
public function get isToggle():Boolean public function set isToggle(value:Boolean):void| keepDownStateOnRollOut | property |
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.
| label | property |
label:StringThe text displayed on the button.
public function get label():String public function set label(value:String):void| labelFactory | property |
labelFactory:FunctionA function used to instantiate the button's label subcomponent.
The factory should have the following function signature:
function():ITextRenderer
public function get labelFactory():Function public function set labelFactory(value:Function):voidSee also
| labelName | property |
protected var labelName:String = feathers-button-label
The value added to the nameList of the label.
| labelOffsetX | property |
labelOffsetX:NumberOffsets the x position of the label by a certain number of pixels.
public function get labelOffsetX():Number public function set labelOffsetX(value:Number):void| labelOffsetY | property |
labelOffsetY:NumberOffsets the y position of the label by a certain number of pixels.
public function get labelOffsetY():Number public function set labelOffsetY(value:Number):void| labelTextRenderer | property |
protected var labelTextRenderer:ITextRendererThe text renderer for the button's label.
| padding | property |
padding:Number
Quickly sets all padding properties to the same value. The
padding getter always returns the value of
paddingTop, but the other padding values may be
different.
public function get padding():Number public function set padding(value:Number):void| paddingBottom | property |
paddingBottom:NumberThe minimum space, in pixels, between the button's bottom edge and the button's content.
public function get paddingBottom():Number public function set paddingBottom(value:Number):void| paddingLeft | property |
paddingLeft:NumberThe minimum space, in pixels, between the button's left edge and the button's content.
public function get paddingLeft():Number public function set paddingLeft(value:Number):void| paddingRight | property |
paddingRight:NumberThe minimum space, in pixels, between the button's right edge and the button's content.
public function get paddingRight():Number public function set paddingRight(value:Number):void| paddingTop | property |
paddingTop:NumberThe minimum space, in pixels, between the button's top edge and the button's content.
public function get paddingTop():Number public function set paddingTop(value:Number):void| 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.
public function get selectedDisabledIcon():DisplayObject public function set selectedDisabledIcon(value:DisplayObject):voidSee also
| selectedDisabledLabelProperties | property |
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.
public function get selectedDisabledLabelProperties():Object public function set selectedDisabledLabelProperties(value:Object):voidSee 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.
public function get selectedDisabledSkin():DisplayObject public function set selectedDisabledSkin(value:DisplayObject):voidSee 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.
public function get selectedDownIcon():DisplayObject public function set selectedDownIcon(value:DisplayObject):voidSee also
| selectedDownLabelProperties | property |
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.
public function get selectedDownLabelProperties():Object public function set selectedDownLabelProperties(value:Object):voidSee 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.
public function get selectedDownSkin():DisplayObject public function set selectedDownSkin(value:DisplayObject):voidSee 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.
public function get selectedHoverIcon():DisplayObject public function set selectedHoverIcon(value:DisplayObject):voidSee also
| selectedHoverLabelProperties | property |
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.
public function get selectedHoverLabelProperties():Object public function set selectedHoverLabelProperties(value:Object):voidSee 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.
public function get selectedHoverSkin():DisplayObject public function set selectedHoverSkin(value:DisplayObject):voidSee 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.
public function get selectedUpIcon():DisplayObject public function set selectedUpIcon(value:DisplayObject):voidSee also
| selectedUpLabelProperties | property |
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.
public function get selectedUpLabelProperties():Object public function set selectedUpLabelProperties(value:Object):voidSee 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.
public function get selectedUpSkin():DisplayObject public function set selectedUpSkin(value:DisplayObject):voidSee also
| stateNames | property |
stateNames:Vector.<String> [read-only] A list of all valid state names.
protected function get stateNames():Vector.<String>| stateToIconFunction | property |
stateToIconFunction:FunctionReturns an icon for the current state.
The following function signature is expected:
function(target:Button, state:Object, oldIcon:DisplayObject = null):DisplayObject
public function get stateToIconFunction():Function public function set stateToIconFunction(value:Function):void| stateToLabelPropertiesFunction | property |
stateToLabelPropertiesFunction:FunctionReturns a text format for the current state.
The following function signature is expected:
function(target:Button, state:Object):Object
public function get stateToLabelPropertiesFunction():Function public function set stateToLabelPropertiesFunction(value:Function):void| stateToSkinFunction | property |
stateToSkinFunction:FunctionReturns a skin for the current state.
The following function signature is expected:
function(target:Button, state:Object, oldSkin:DisplayObject = null):DisplayObject
public function get stateToSkinFunction():Function public function set stateToSkinFunction(value:Function):void| upIcon | property |
upIcon:DisplayObject
The icon used for the button's up state. If null, then
defaultIcon is used instead.
public function get upIcon():DisplayObject public function set upIcon(value:DisplayObject):voidSee also
| upLabelProperties | property |
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.
public function get upLabelProperties():Object public function set upLabelProperties(value:Object):voidSee also
| upSkin | property |
upSkin:DisplayObject
The skin used for the button's up state. If null, then
defaultSkin is used instead.
public function get upSkin():DisplayObject public function set upSkin(value:DisplayObject):voidSee also
| verticalAlign | property |
verticalAlign:StringThe location where the button's content is aligned vertically (on the y-axis).
public function get verticalAlign():String public function set verticalAlign(value:String):void| Button | () | Constructor |
public function Button()Constructor.
| change | Event |
starling.events.Eventstarling.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.
| triggered | Event |
starling.events.Eventstarling.events.Event.TRIGGEREDDispatched 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.| DEFAULT_CHILD_NAME_LABEL | Constant |
public static const DEFAULT_CHILD_NAME_LABEL:String = feathers-button-label
The default value added to the nameList of the label.
| HORIZONTAL_ALIGN_CENTER | Constant |
public static const HORIZONTAL_ALIGN_CENTER:String = centerThe icon and label will be aligned horizontally to the center of the button.
| HORIZONTAL_ALIGN_LEFT | Constant |
public static const HORIZONTAL_ALIGN_LEFT:String = leftThe icon and label will be aligned horizontally to the left edge of the button.
| HORIZONTAL_ALIGN_RIGHT | Constant |
public static const HORIZONTAL_ALIGN_RIGHT:String = rightThe icon and label will be aligned horizontally to the right edge of the button.
| ICON_POSITION_BOTTOM | Constant |
public static const ICON_POSITION_BOTTOM:String = bottomThe icon will be positioned below the label.
| ICON_POSITION_LEFT | Constant |
public static const ICON_POSITION_LEFT:String = leftThe icon will be positioned to the left of the label.
| ICON_POSITION_LEFT_BASELINE | Constant |
public static const ICON_POSITION_LEFT_BASELINE:String = leftBaselineThe 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_MANUAL | Constant |
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_RIGHT | Constant |
public static const ICON_POSITION_RIGHT:String = rightThe icon will be positioned to the right of the label.
| ICON_POSITION_RIGHT_BASELINE | Constant |
public static const ICON_POSITION_RIGHT_BASELINE:String = rightBaselineThe 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_TOP | Constant |
public static const ICON_POSITION_TOP:String = topThe icon will be positioned above the label.
| VERTICAL_ALIGN_BOTTOM | Constant |
public static const VERTICAL_ALIGN_BOTTOM:String = bottomThe icon and label will be aligned vertically to the bottom edge of the button.
| VERTICAL_ALIGN_MIDDLE | Constant |
public static const VERTICAL_ALIGN_MIDDLE:String = middleThe icon and label will be aligned vertically to the middle of the button.
| VERTICAL_ALIGN_TOP | Constant |
public static const VERTICAL_ALIGN_TOP:String = topThe icon and label will be aligned vertically to the top edge of the button.