Packageorg.apache.flex.core
Classpublic class UIButtonBase
InheritanceUIButtonBase Inheritance flash.display.SimpleButton
Implements IStrand, IEventDispatcher, IUIBase
Subclasses Button, CheckBox, RadioButton

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The UIButtonBase class is the base class for most Buttons in a FlexJS application. In Flash, these buttons extend SimpleButton and therefore do not support all of the Sprite APIs.



Public Properties
 PropertyDefined By
  beads : Array
The array property that is used to add additional beads to an MXML tag.
UIButtonBase
  className : String
The classname.
UIButtonBase
  element : Object
[read-only] Each IUIBase has an element that is actually added to the platform's display list DOM.
UIButtonBase
  height : Number
[override] The width of the component.
UIButtonBase
  id : String
An id property for MXML documents.
UIButtonBase
  measurementBead : IMeasurementBead
[read-only] A measurement bead, if one exists.
UIButtonBase
  model : IBeadModel
An IBeadModel that serves as the data model for the component.
UIButtonBase
  width : Number
[override] The width of the component.
UIButtonBase
  x : Number
[override]
UIButtonBase
  y : Number
[override]
UIButtonBase
Protected Properties
 PropertyDefined By
  $height : Number
[read-only] Retrieve the low-level bounding box height.
UIButtonBase
  $width : Number
[read-only] Retrieve the low-level bounding box width.
UIButtonBase
  $x : Number
[read-only] Retrieve the low-level bounding box x.
UIButtonBase
  $y : Number
[read-only] Retrieve the low-level bounding box y.
UIButtonBase
Public Methods
 MethodDefined By
  
UIButtonBase(upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)
Constructor.
UIButtonBase
  
addBead(bead:IBead):void
Add a bead to the strand.
UIButtonBase
  
UIButtonBase
  
getBeadByType(classOrInterface:Class):IBead
Find a bead on the strand.
UIButtonBase
  
Remove a bead from the strand.
UIButtonBase
Events
 Event Summary Defined By
  Set a different class for click events so that there aren't dependencies on the flash classes on the JS side.UIButtonBase
Property Detail
$heightproperty
$height:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Retrieve the low-level bounding box height.


Implementation
    protected function get $height():Number
$widthproperty 
$width:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Retrieve the low-level bounding box width.


Implementation
    protected function get $width():Number
$xproperty 
$x:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Retrieve the low-level bounding box x.


Implementation
    protected function get $x():Number
$yproperty 
$y:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Retrieve the low-level bounding box y.


Implementation
    protected function get $y():Number
beadsproperty 
public var beads:Array

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The array property that is used to add additional beads to an MXML tag. From ActionScript, just call addBead directly.

classNameproperty 
className:String

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The classname. Often used for CSS class selector lookups.


Implementation
    public function get className():String
    public function set className(value:String):void
elementproperty 
element:Object  [read-only]

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Each IUIBase has an element that is actually added to the platform's display list DOM. It may not be the actual component itself.


Implementation
    public function get element():Object
heightproperty 
height:Number[override]

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The width of the component. If no width has been previously set the default width may be specified in the IValuesImpl or determined as the bounding box around all child components and graphics.


Implementation
    public function get height():Number
    public function set height(value:Number):void
idproperty 
id:String

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

An id property for MXML documents.


Implementation
    public function get id():String
    public function set id(value:String):void
measurementBeadproperty 
measurementBead:IMeasurementBead  [read-only]

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

A measurement bead, if one exists.


Implementation
    public function get measurementBead():IMeasurementBead
modelproperty 
model:IBeadModel

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

An IBeadModel that serves as the data model for the component.


Implementation
    public function get model():IBeadModel
    public function set model(value:IBeadModel):void
widthproperty 
width:Number[override]

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The width of the component. If no width has been previously set the default width may be specified in the IValuesImpl or determined as the bounding box around all child components and graphics.


Implementation
    public function get width():Number
    public function set width(value:Number):void
xproperty 
x:Number[override]

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6


Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number[override]

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6


Implementation
    public function get y():Number
    public function set y(value:Number):void
Constructor Detail
UIButtonBase()Constructor
public function UIButtonBase(upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Constructor.

Parameters
upState:DisplayObject (default = null)
 
overState:DisplayObject (default = null)
 
downState:DisplayObject (default = null)
 
hitTestState:DisplayObject (default = null)
Method Detail
addBead()method
public function addBead(bead:IBead):void

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Add a bead to the strand.

Parameters

bead:IBead — The bead to be added.

addedToParent()method 
public function addedToParent():void

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

getBeadByType()method 
public function getBeadByType(classOrInterface:Class):IBead

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Find a bead on the strand.

Parameters

classOrInterface:Class — The class or interface to use to search for the bead

Returns
IBead — The bead.
removeBead()method 
public function removeBead(value:IBead):IBead

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Remove a bead from the strand.

Parameters

value:IBead — bead The bead to be removed.

Returns
IBead
Event Detail
click Event
Event Object Type: org.apache.flex.events.Event

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Set a different class for click events so that there aren't dependencies on the flash classes on the JS side.