Packagecom.afcomponents.umap.gui.button
Classpublic class GuiButton
InheritanceGuiButton Inheritance flash.display.Sprite
SubclassesDropdownButton, SwitchButton

Button



Public Properties
 PropertyDefined by
  autoSize : Boolean
Gets or sets the autoSize property.
GuiButton
  currentState : DisplayObject
[read-only]
GuiButton
  downState : DisplayObject
Gets or sets the down state display object.
GuiButton
  enabled : Boolean
Get or sets button's enable property.
GuiButton
  grouped : Boolean
GuiButton
  hitTestState : DisplayObject
Gets or sets the up state display object.
GuiButton
  label : String
Gets or sets button's label.
GuiButton
  overState : DisplayObject
Gets or sets the over state display object.
GuiButton
  padding : Point
GuiButton
  type : String
GuiButton
  upState : DisplayObject
Gets or sets the up state display object.
GuiButton
Public Methods
 MethodDefined by
  
GuiButton(label:String, type:String, skin:ButtonSkin, padding:Point = null, grouped:Boolean = false)
GuiButton
  
GuiButton
  
dispose():void
GuiButton
  
enable(flag:Boolean):void
GuiButton
  
enableAutoRepeat(repeatStartDelay:uint, repeatDelay:uint):void
GuiButton
  
getSkinRect():Rectangle
GuiButton
  
setSize(new_width:uint, new_height:uint):void
Resize button.
GuiButton
Property detail
autoSizeproperty
autoSize:Boolean  [read-write]

Gets or sets the autoSize property.

The default value is true.

Implementation
    public function get autoSize():Boolean
    public function set autoSize(value:Boolean):void
currentStateproperty 
currentState:DisplayObject  [read-only]Implementation
    public function get currentState():DisplayObject
downStateproperty 
downState:DisplayObject  [read-write]

Gets or sets the down state display object.

Implementation
    public function get downState():DisplayObject
    public function set downState(value:DisplayObject):void
enabledproperty 
enabled:Boolean  [read-write]

Get or sets button's enable property. Disabled button won't generate ACTION events.

Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
groupedproperty 
grouped:Boolean  [read-write]

Implementation
    public function get grouped():Boolean
    public function set grouped(value:Boolean):void
hitTestStateproperty 
hitTestState:DisplayObject  [read-write]

Gets or sets the up state display object.

Implementation
    public function get hitTestState():DisplayObject
    public function set hitTestState(value:DisplayObject):void
labelproperty 
label:String  [read-write]

Gets or sets button's label.

Implementation
    public function get label():String
    public function set label(value:String):void
overStateproperty 
overState:DisplayObject  [read-write]

Gets or sets the over state display object.

Implementation
    public function get overState():DisplayObject
    public function set overState(value:DisplayObject):void
paddingproperty 
padding:Point  [read-write]

Implementation
    public function get padding():Point
    public function set padding(value:Point):void
typeproperty 
type:String  [read-write]

Implementation
    public function get type():String
    public function set type(value:String):void
upStateproperty 
upState:DisplayObject  [read-write]

Gets or sets the up state display object.

Implementation
    public function get upState():DisplayObject
    public function set upState(value:DisplayObject):void
Constructor detail
GuiButton()constructor
public function GuiButton(label:String, type:String, skin:ButtonSkin, padding:Point = null, grouped:Boolean = false)

Parameters
label:String
 
type:String
 
skin:ButtonSkin
 
padding:Point (default = null)
 
grouped:Boolean (default = false)
Method detail
disableAutoRepeat()method
public function disableAutoRepeat():void

dispose()method 
public function dispose():void

enable()method 
public function enable(flag:Boolean):voidParameters
flag:Boolean
enableAutoRepeat()method 
public function enableAutoRepeat(repeatStartDelay:uint, repeatDelay:uint):void

Parameters
repeatStartDelay:uint
 
repeatDelay:uint
getSkinRect()method 
public function getSkinRect():Rectangle

Returns
Rectangle
setSize()method 
public function setSize(new_width:uint, new_height:uint):void

Resize button.

Parameters
new_width:uint
 
new_height:uint