Packagecom.ghostwire.ui.controls
Classpublic class uiButton
InheritanceuiButton Inheritance uiComponent Inheritance flash.display.Sprite
SubclassesuiImageButton, uiInteractiveItem, uiLabelButton, uiLink

The uiButton class implements basic button behaviors.

If you need a button that contains an embedded image or text or both, you should use the uiLabelButton instead.

The uiButton class is useful for instantiating basic fully skinned buttons without child elements, usually not intended to be resized. As an example, you can create a barebones standalone checkbox button without an accompanying label with the following code:

 var choiceButton:uiButton = new uiButton();
 choiceButton.toggle = true;
 choiceButton.skin = "CheckBox";
 

"skin" Property
The default value is "Button" and the asset(s) used are:

 Button.png
 

~ This class is available in Aspire UI Components Lite Edition ~



Public Properties
 PropertyDefined by
 InheritedalignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
uiComponent
 InheritedalignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
uiComponent
 Inheritedbackground : Object
Indicates the style of the background for this component.
uiComponent
 Inheritedcontainer : uiComponent
Indicates the uiComponent instance that contains this instance.
uiComponent
  data : Object
Indicates the data to be associated with this button.
uiButton
 Inheriteddepth : int
Indicates how deep the component is in the containment hierarchy.
uiComponent
 InheriteddesiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
uiComponent
 InheriteddesiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
uiComponent
  displaceX : int
Indicates the amount of pixels to move any embedded child object horizontally to the right when the button is pressed down.
uiButton
  displaceY : int
Indicates the amount of pixels to move any embedded child object vertically downwards when the button is pressed down.
uiButton
 Inheritedenabled : Boolean
Indicates whether the component is enabled for user interaction.
uiComponent
 InheritedfillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated horizontal space.
uiComponent
 InheritedfillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated vertical space.
uiComponent
 InheritedfocusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus rectangle.
uiComponent
 InheritedfocusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it is in focus.
uiComponent
  group : uiButtonGroup
Indicates the uiButtonGroup this button is assigned to.
uiButton
 Inheritedheight : Number
Indicates the current height of the component.
uiComponent
 Inheritedmargin : Object
Indicates the thickness of the space surrounding the component.
uiComponent
 InheritedmaxHeight : int
Indicates the upper limit for height.
uiComponent
 InheritedmaxWidth : int
Indicates the upper limit for width.
uiComponent
 InheritedminHeight : int
Indicates the lower limit for height.
uiComponent
 InheritedminWidth : int
Indicates the lower limit for width.
uiComponent
 Inheritedpadding : Object
Indicates the thickness of the interior space from the edge of the component to the content area, which is where child components, if any, are contained.
uiComponent
  selected : Boolean
Indicates whether the button is selected; applicable only if the toggle property is set to true.
uiButton
 Inheritedskin : String
Indicates the name of the skin to use for this component instance.
uiComponent
 Inheritedstretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this component.
uiComponent
 InheritedtextStyle : String
Indicates the style to use for uiText instances contained in this component.
uiComponent
  toggle : Boolean
Indicates whether the button should toggle its selected property value between true and false when it is clicked.
uiButton
 InheritedtoolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers over this control.
uiComponent
 Inheriteduiskin : uiBitmapImage
Returns the uiBitmapImage rendered as the skin - for advanced users only.
uiComponent
 Inheritedvisible : Boolean
Indicates whether or not the component is visible within its container.
uiComponent
 Inheritedwidth : Number
Indicates the current width of the component.
uiComponent
Public Methods
 MethodDefined by
  
Constructor - creates a new uiButton instance.
uiButton
  
activate(noEvent:Boolean = false):void
Activates and gives focus to the button as if the button has been clicked on (a MouseEvent.CLICK event will be dispatched).
uiButton
 Inherited
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
uiComponent
 Inherited
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
uiComponent
 Inherited
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
uiComponent
 Inherited
setFocus(flag:Boolean = true):void
Gives this component instance the focus; the component must be on the display list and has its tabEnabled property set to true, otherwise this method will fail silently.
uiComponent
 Inherited
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified width and height.
uiComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
uiComponent
 Inherited
validateNow():void
Validates and render the component instance, and any component instances with depth higher than itself in the validation queue, immediately.
uiComponent
Events
 EventSummaryDefined by
   Dispatched when the selected property changes.uiButton
   Dispatched when the button is activated, either by user clicking on it or pressing the SPACE key while the button is in focus.uiButton
 Inherited Dispatched when the component's visible property is changed from true to false via calling the setVisible() method.uiComponent
 Inherited Dispatched when the component's position within its parent container has changed via calling the move() method.uiComponent
 Inherited Dispatched when the component's size has changed via calling the setSize() method.uiComponent
 Inherited Dispatched when the component's visible property is changed from false to true via calling the setVisible() method.uiComponent
Property detail
dataproperty
data:Object  [read-write]

Indicates the data to be associated with this button.

The default value is null.

Implementation
    public function get data():Object
    public function set data(value:Object):void
displaceXproperty 
displaceX:int  [read-write]

Indicates the amount of pixels to move any embedded child object horizontally to the right when the button is pressed down. A negative number means that the child object will be moved to the left.

This property is applicable only for subclasses that implements embedding of a child object in the button, such as the uiLabelButton or uiInteractiveItem classes.

The default value is 0.

Implementation
    public function get displaceX():int
    public function set displaceX(value:int):void
displaceYproperty 
displaceY:int  [read-write]

Indicates the amount of pixels to move any embedded child object vertically downwards when the button is pressed down. A negative number means that the child object will be moved upwards.

This property is applicable only for subclasses that implements embedding of a child object in the button, such as the uiLabelButton or uiInteractiveItem classes.

The default value is 0.

Implementation
    public function get displaceY():int
    public function set displaceY(value:int):void
groupproperty 
group:uiButtonGroup  [read-write]

Indicates the uiButtonGroup this button is assigned to.

When you create a set of buttons with their group property set to the same uiButtonGroup object, only one of those buttons can be selected at any one time. When you assign a uiButton instance to a uiButtonGroup its toggle property will be set to true automatically.

Only the currently selected button in a group will participate in the tab order. When the selected button has focus, the user may use the UP, DOWN, LEFT and RIGHT keys to select the other buttons in the group. In order for this behavior to function properly, you must place all the buttons in the same group in the same container. If none of the buttons has been selected, all the buttons will participate in the tab order normally (until one button has been selected).

The default value is null.

Implementation
    public function get group():uiButtonGroup
    public function set group(value:uiButtonGroup):void

See also

selectedproperty 
selected:Boolean  [read-write]

Indicates whether the button is selected; applicable only if the toggle property is set to true.

If the button is intended to be a member of a uiButtonGroup, you should not use this property. Instead, set the uiButtonGroup.selectedButton property to the button in the group to be selected.

Changing the selected property dispatches a change event.

Implementation
    public function get selected():Boolean
    public function set selected(value:Boolean):void
toggleproperty 
toggle:Boolean  [read-write]

Indicates whether the button should toggle its selected property value between true and false when it is clicked.

Implementation
    public function get toggle():Boolean
    public function set toggle(value:Boolean):void
Constructor detail
uiButton()constructor
public function uiButton()

Constructor - creates a new uiButton instance.

Method detail
activate()method
public function activate(noEvent:Boolean = false):void

Activates and gives focus to the button as if the button has been clicked on (a MouseEvent.CLICK event will be dispatched). The MouseEvent object dispatched by this method will have its localX, localY, stageX and stageY properties set to NaN.

Parameters
noEvent:Boolean (default = false) — A Boolean value - call the method with this parameter set to true if you do not want the MouseEvent.CLICK event to be dispatched.
Event detail
changeevent 
Event object type: flash.events.Event

Dispatched when the selected property changes.

clickevent  
Event object type: flash.events.MouseEvent

Dispatched when the button is activated, either by user clicking on it or pressing the SPACE key while the button is in focus.