Packagestarling.display
Classpublic class Button
InheritanceButton Inheritance DisplayObjectContainer Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object

A simple button composed of an image and, optionally, text.

You can pass a texture for up- and downstate of the button. If you do not provide a down state, the button is simply scaled a little when it is touched. In addition, you can overlay a text on the button. To customize the text, almost the same options as those of text fields are provided. In addition, you can move the text to a certain position with the help of the textBounds property.

To react on touches on a button, there is special triggered-event type. Use this event instead of normal touch events - that way, users can cancel button activation by moving the mouse/finger away from the button before releasing.



Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The opacity of the object.
DisplayObject
  alphaWhenDisabled : Number
The alpha value of the button when it is disabled.
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
  downState : Texture
The texture that is displayed while the button is touched.
Button
  enabled : Boolean
Indicates if the button can be triggered.
Button
 Inheritedfilter : FragmentFilter
The filter that is attached to the display object.
DisplayObject
  fontBold : Boolean
Indicates if the font should be bold.
Button
  fontColor : uint
The color of the font.
Button
  fontName : String
The name of the font displayed on the button.
Button
  fontSize : Number
The size of the font.
Button
 InheritedhasVisibleArea : Boolean
[read-only] Indicates if an object occupies any visible area.
DisplayObject
 Inheritedheight : Number
The height of the object in pixels.
DisplayObject
 Inheritedname : String
The name of the display object (default: null).
DisplayObject
 InheritednumChildren : int
[read-only] The number of children of this container.
DisplayObjectContainer
 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
  scaleWhenDown : Number
The scale factor of the button on touch.
Button
 InheritedscaleX : Number
The horizontal scale factor.
DisplayObject
 InheritedscaleY : Number
The vertical scale factor.
DisplayObject
 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
  text : String
The text that is displayed on the button.
Button
  textBounds : Rectangle
The bounds of the textfield on the button.
Button
  textHAlign : String
The horizontal alignment of the text on the button.
Button
  textVAlign : String
The vertical alignment of the text on the button.
Button
 Inheritedtouchable : Boolean
Indicates if this object (and its children) will receive touch events.
DisplayObject
 InheritedtouchGroup : Boolean
If a container is a 'touchGroup', it will act as a single touchable object.
DisplayObjectContainer
 InheritedtransformationMatrix : Matrix
The transformation matrix of the object relative to its parent.
DisplayObject
  upState : Texture
The texture that is displayed when the button is not being touched.
Button
  useHandCursor : Boolean
[override] Indicates if the mouse cursor should transform into a hand while it's over the button.
Button
 Inheritedvisible : Boolean
The visibility of the object.
DisplayObject
 Inheritedwidth : Number
The width of the object in pixels.
DisplayObject
 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
Public Methods
 MethodDefined By
  
Button(upState:Texture, text:String, downState:Texture = null)
Creates a button with textures for up- and down-state or text.
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
[override]
DisplayObject
 Inherited
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
 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
[override]
DisplayObject
 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
  
dispose():void
[override] Disposes the resources of all children.
Button
 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
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
[override]
DisplayObject
 Inherited
removeEventListeners(type:String = null):void
[override]
DisplayObject
 Inherited
removeFromParent(dispose:Boolean = false):void
Removes the object from its parent, if it has one, and optionally disposes it.
DisplayObject
 Inherited
render(support:RenderSupport, parentAlpha:Number):void
[override] Renders the display object with the help of a support object.
DisplayObjectContainer
 Inherited
setChildIndex(child:DisplayObject, index:int):void
Moves a child to a certain index.
DisplayObjectContainer
 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
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
 InheritedDispatched once every frame on every object that is connected to the stage.DisplayObject
 InheritedDispatched when a key on the keyboard is pressed.DisplayObject
 InheritedDispatched when a key on the keyboard is released.DisplayObject
 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 an object is touched.DisplayObject
  Dispatched when the user triggers the button.Button
Property Detail
alphaWhenDisabledproperty
alphaWhenDisabled:Number

The alpha value of the button when it is disabled.

The default value is 0.5.


Implementation
    public function get alphaWhenDisabled():Number
    public function set alphaWhenDisabled(value:Number):void
downStateproperty 
downState:Texture

The texture that is displayed while the button is touched.


Implementation
    public function get downState():Texture
    public function set downState(value:Texture):void
enabledproperty 
enabled:Boolean

Indicates if the button can be triggered.


Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
fontBoldproperty 
fontBold:Boolean

Indicates if the font should be bold.


Implementation
    public function get fontBold():Boolean
    public function set fontBold(value:Boolean):void
fontColorproperty 
fontColor:uint

The color of the font.


Implementation
    public function get fontColor():uint
    public function set fontColor(value:uint):void
fontNameproperty 
fontName:String

The name of the font displayed on the button. May be a system font or a registered bitmap font.


Implementation
    public function get fontName():String
    public function set fontName(value:String):void
fontSizeproperty 
fontSize:Number

The size of the font.


Implementation
    public function get fontSize():Number
    public function set fontSize(value:Number):void
scaleWhenDownproperty 
scaleWhenDown:Number

The scale factor of the button on touch. Per default, a button with a down state texture won't scale.


Implementation
    public function get scaleWhenDown():Number
    public function set scaleWhenDown(value:Number):void
textproperty 
text:String

The text that is displayed on the button.


Implementation
    public function get text():String
    public function set text(value:String):void
textBoundsproperty 
textBounds:Rectangle

The bounds of the textfield on the button. Allows moving the text to a custom position.


Implementation
    public function get textBounds():Rectangle
    public function set textBounds(value:Rectangle):void
textHAlignproperty 
textHAlign:String

The horizontal alignment of the text on the button.


Implementation
    public function get textHAlign():String
    public function set textHAlign(value:String):void
textVAlignproperty 
textVAlign:String

The vertical alignment of the text on the button.


Implementation
    public function get textVAlign():String
    public function set textVAlign(value:String):void
upStateproperty 
upState:Texture

The texture that is displayed when the button is not being touched.


Implementation
    public function get upState():Texture
    public function set upState(value:Texture):void
useHandCursorproperty 
useHandCursor:Boolean[override]

Indicates if the mouse cursor should transform into a hand while it's over the button.

The default value is true.


Implementation
    public function get useHandCursor():Boolean
    public function set useHandCursor(value:Boolean):void
Constructor Detail
Button()Constructor
public function Button(upState:Texture, text:String, downState:Texture = null)

Creates a button with textures for up- and down-state or text.

Parameters
upState:Texture
 
text:String
 
downState:Texture (default = null)
Method Detail
dispose()method
override public function dispose():void

Disposes the resources of all children.

Event Detail
triggered Event
Event Object Type: starling.events.Event

Dispatched when the user triggers the button. Bubbles.