Apache Flex (FlexJS) 0.7.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
UIButtonBase

Package | org.apache.flex.core
Class | public class UIButtonBase
Inheritance | UIButtonBase flash.display.SimpleButton
Implements | IStrandWithModel, IEventDispatcher, IUIBase, IStyleableObject, ILayoutChild, org.apache.flex.core.IFlexJSElement
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

| Property | Defined 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
|  | beads : Array The array property that is used to add additional beads to an MXML tag. | UIButtonBase
|  | className : String The classname. | UIButtonBase
|  | element : IFlexJSElement [read-only] Each IUIBase has an element that is actually added to the platform's display list DOM. | UIButtonBase
|  | explicitHeight : Number The explicitly set width (as opposed to measured width or percentage width). | UIButtonBase
|  | explicitWidth : Number The explicitly set width (as opposed to measured width or percentage width). | 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 : Object An IBeadModel that serves as the data model for the component. | UIButtonBase
|  | percentHeight : Number The requested percentage height this component should have in the parent container. | UIButtonBase
|  | percentWidth : Number The requested percentage width this component should have in the parent container. | UIButtonBase
|  | style : Object The object that contains "styles" and other associated name-value pairs. | UIButtonBase
|  | styleString : String [write-only] The styles for this object formatted as an HTML style attribute. | UIButtonBase
|  | topMostEventDispatcher : IEventDispatcher [read-only] The top most event dispatcher. | UIButtonBase
|  | typeNames : String A list of type names. | UIButtonBase
|  | view : IBeadView An IBeadView that serves as the view for the component. | UIButtonBase
|  | width : Number [override] The width of the component. | UIButtonBase

Protected Properties

| Property | Defined By
--- | --- | ---
|  | $y : Number [read-only] Retrieve the low-level bounding box y. | UIButtonBase

Public Methods

| Method | Defined 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
|  | addedToParent():void | UIButtonBase
|  | getBeadByType(classOrInterface:Class):IBead Find a bead on the strand. | UIButtonBase
|  | isHeightSizedToContent():Boolean | UIButtonBase
|  | isWidthSizedToContent():Boolean | UIButtonBase
|  | removeBead(value:IBead):IBead Remove a bead from the strand. | UIButtonBase
|  | setHeight(value:Number, noEvent:Boolean = false):void | UIButtonBase
|  | setWidth(value:Number, noEvent:Boolean = false):void | UIButtonBase
|  | setWidthAndHeight(newWidth:Number, newHeight:Number, noEvent:Boolean = false):void | UIButtonBase
|  | setX(value:Number):void | UIButtonBase
|  | setY(value:Number):void | UIButtonBase

Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | click | Set a different class for click events so that there aren't dependencies on the flash classes on the JS side. | UIButtonBase

Property Detail

$height | property

`$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. Not implemented in JS.

Implementation
`public function get $height():Number`

$width | property |

`$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. Not implemented in JS.

Implementation
`public function get $width():Number`

$y | property |

`$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`

beads | property |

`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.

className | property |

`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`

element | property |

`element:IFlexJSElement` [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():IFlexJSElement`

explicitHeight | property |

`explicitHeight:Number`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The explicitly set width (as opposed to measured width or percentage width).

Implementation
`public function get explicitHeight():Number`
`public function set explicitHeight(value:Number):void`

explicitWidth | property |

`explicitWidth:Number`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The explicitly set width (as opposed to measured width or percentage width).

Implementation
`public function get explicitWidth():Number`
`public function set explicitWidth(value:Number):void`

height | property |

`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.

This property can be used as the source for data binding.

Implementation
`public function get height():Number`
`public function set height(value:Number):void`

id | property |

`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`

measurementBead | property |

`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`

model | property |

`model:Object`

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():Object`
`public function set model(value:Object):void`

percentHeight | property |

`percentHeight:Number`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The requested percentage height this component should have in the parent container. Note that the actual percentage may be different if the total is more than 100% or if there are other components with explicitly set heights.

Implementation
`public function get percentHeight():Number`
`public function set percentHeight(value:Number):void`

percentWidth | property |

`percentWidth:Number`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The requested percentage width this component should have in the parent container. Note that the actual percentage may be different if the total is more than 100% or if there are other components with explicitly set widths.

Implementation
`public function get percentWidth():Number`
`public function set percentWidth(value:Number):void`

style | property |

`style:Object`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The object that contains "styles" and other associated name-value pairs. You can also specify a string in HTML style attribute format.

Implementation
`public function get style():Object`
`public function set style(value:Object):void`

styleString | property |

`styleString:String` [write-only]

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The styles for this object formatted as an HTML style attribute. While this may be a convenient and less verbose way of specifying styles than using the style object, you run the risk of having a typo.

Implementation
`public function set styleString(value:String):void`

topMostEventDispatcher | property |

`topMostEventDispatcher:IEventDispatcher` [read-only]

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The top most event dispatcher. Good for trying to capture all input events.

Implementation
`public function get topMostEventDispatcher():IEventDispatcher`

typeNames | property |

`public var typeNames:String`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

A list of type names. Often used for CSS type selector lookups.

view | property |

`view:IBeadView`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

An IBeadView that serves as the view for the component.

Implementation
`public function get view():IBeadView`
`public function set view(value:IBeadView):void`

width | property |

`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.

This property can be used as the source for data binding.

Implementation
`public function get width():Number`
`public function set width(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.

isHeightSizedToContent | () | method |

`public function isHeightSizedToContent():Boolean`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Returns

| `Boolean`

isWidthSizedToContent | () | method |

`public function isWidthSizedToContent():Boolean`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Returns

| `Boolean`

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`

setHeight | () | method |

`public function setHeight(value:Number, noEvent:Boolean = false):void`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Parameters

| `value:Number`
| `noEvent:Boolean` (default = `false`)``

setWidth | () | method |

`public function setWidth(value:Number, noEvent:Boolean = false):void`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Parameters

| `value:Number`
| `noEvent:Boolean` (default = `false`)``

setWidthAndHeight | () | method |

`public function setWidthAndHeight(newWidth:Number, newHeight:Number, noEvent:Boolean = false):void`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Parameters

| `newWidth:Number`
| `newHeight:Number`
| `noEvent:Boolean` (default = `false`)``

setX | () | method |

`public function setX(value:Number):void`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Parameters

| `value:Number`

setY | () | method |

`public function setY(value:Number):void`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Parameters

| `value:Number`

Event Detail

click | Event

Event Object Type: `org.apache.flex.events.MouseEvent`

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.

Mon Sep 5 2016, 07:19 AM -07:00