Packagefeathers.controls
Classpublic class BasicButton
InheritanceBasicButton Inheritance FeathersControl Inheritance starling.display.Sprite
Implements IStateContext
Subclasses Button

A simple button control with states, but no content, that is useful for purposes like skinning. For a more full-featured button, with a label and icon, see feathers.controls.Button instead.

See also

feathers.controls.Button


Public Properties
 PropertyDefined By
  currentState : String
[read-only] The current state of the button.
BasicButton
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
 InheritedfocusManager : IFocusManager
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all BasicButton components.
BasicButton
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritednextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.
FeathersControl
 InheritedpreviousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.
FeathersControl
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
  currentSkin : DisplayObject
The currently visible skin.
BasicButton
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the globalStyleProvider property is set to this value.
FeathersControl
  touchPointID : int = -1
The saved ID of the currently active touch.
BasicButton
Public Methods
 MethodDefined By
  
Constructor.
BasicButton
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.
FeathersControl
  
getSkinForState(state:String):DisplayObject
Gets the skin to be used by the button when its currentState property matches the specified state value.
BasicButton
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
If the component has not yet initialized, initializes immediately.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
  
setSkinForState(state:String, skin:DisplayObject):void
Sets the skin to be used by the button when its currentState property matches the specified state value.
BasicButton
 Inherited
showFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
  
If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
BasicButton
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.
FeathersControl
 Inherited
focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.
FeathersControl
 Inherited
initialize():void
Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.
FeathersControl
 Inherited
processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.
FeathersControl
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
  
Sets the currentSkin property.
BasicButton
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
Events
 Event Summary Defined By
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
  Dispatched when the display object's state changes.BasicButton
  Dispatched when the the user taps or clicks the button.BasicButton
Styles
 StyleDefined By
  
defaultSkin : DisplayObject
The skin used when no other skin is defined for the current state.
BasicButton
  
disabledSkin : DisplayObject
The skin used for the button's disabled state.
BasicButton
  
downSkin : DisplayObject
The skin used for the button's down state.
BasicButton
 Inherited
focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 Inherited
focusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
  
hoverSkin : DisplayObject
The skin used for the button's hover state.
BasicButton
  
Determines if a pressed button should remain in the down state if a touch moves outside of the button's bounds.
BasicButton
  
upSkin : DisplayObject
The skin used for the button's up state.
BasicButton
Public Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_ALL : String = "all"
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = "data"
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = "focus"
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = "layout"
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = "scroll"
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = "selected"
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = "size"
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = "skin"
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = "state"
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = "styles"
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Property Detail
currentSkinproperty
protected var currentSkin:DisplayObject

The currently visible skin. The value will be null if there is no currently visible skin.

For internal use in subclasses.

currentStateproperty 
currentState:String  [read-only]

The current state of the button.


Implementation
    public function get currentState():String

See also

globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all BasicButton components.

The default value is null.

See also

touchPointIDproperty 
protected var touchPointID:int = -1

The saved ID of the currently active touch. The value will be -1 if there is no currently active touch.

For internal use in subclasses.

Constructor Detail
BasicButton()Constructor
public function BasicButton()

Constructor.

Method Detail
autoSizeIfNeeded()method
protected function autoSizeIfNeeded():Boolean

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. If the explicitWidth or explicitHeight member variables are set, those value will be used without additional measurement. If one is set, but not the other, the dimension with the explicit value will not be measured, but the other non-explicit dimension will still need measurement.

Calls saveMeasurements() to set up the actualWidth and actualHeight member variables used for layout.

Meant for internal use, and subclasses may override this function with a custom implementation.

Returns
Boolean
getSkinForState()method 
public function getSkinForState(state:String):DisplayObject

Gets the skin to be used by the button when its currentState property matches the specified state value.

If a skin is not defined for a specific state, returns null.

Parameters

state:String

Returns
DisplayObject

See also

refreshSkin()method 
protected function refreshSkin():void

Sets the currentSkin property.

For internal use in subclasses.

setSkinForState()method 
public function setSkinForState(state:String, skin:DisplayObject):void

Sets the skin to be used by the button when its currentState property matches the specified state value.

If a skin is not defined for a specific state, the value of the defaultSkin property will be used instead.

Parameters

state:String
 
skin:DisplayObject

See also

Event Detail
stateChange Event
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.STATE_CHANGE

Dispatched when the display object's state changes.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
datanull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

The FeathersEventType.STATE_CHANGE event type is used by Feathers classes that implement the IStateContext interface.

See also

triggered Event  
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.TRIGGERED

Dispatched when the the user taps or clicks the button. The touch must remain within the bounds of the button on release to register as a tap or a click. If focus management is enabled, the button may also be triggered by pressing the spacebar while the button has focus.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
datanull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

Style Detail
upSkinstyle
upSkin:DisplayObject

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

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

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

button.upSkin = new Image( texture );

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

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

The default value is null.

See also

keepDownStateOnRollOutstyle 
keepDownStateOnRollOut:Boolean

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.

The following example ensures that the button's down state remains active when the button is pressed but the touch moves outside the button's bounds:

button.keepDownStateOnRollOut = true;

The default value is false.

hoverSkinstyle 
hoverSkin:DisplayObject

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

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

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

button.hoverSkin = new Image( texture );

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

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

The default value is null.

See also

downSkinstyle 
downSkin:DisplayObject

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

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

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

button.downSkin = new Image( texture );

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

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

The default value is null.

See also

disabledSkinstyle 
disabledSkin:DisplayObject

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

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

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

button.disabledSkin = new Image( texture );

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

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

The default value is null.

See also

defaultSkinstyle 
defaultSkin:DisplayObject

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

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

button.defaultSkin = new Image( texture );

The default value is null.

See also