| Package | efnx.gui |
| Class | public class Button |
| Inheritance | Button  flash.display.Sprite |
| Property | Defined by | ||
|---|---|---|---|
| down : BitmapData
The
BitmapData object to represent the button in the down position. | Button | ||
| downFunction : Function
Reference to the function to be performed on mouse down.
| Button | ||
| guide : BitmapData
A
BitmapData object specifying the bounds of the button. | Button | ||
| height : Number | Button | ||
| initialized : Boolean [read-only]
Returns whether or not the Button is initialized and
contains references to bitmapData.
| Button | ||
| outFunction : Function
Reference to the function to be performed on roll out.
| Button | ||
| over : BitmapData
The
BitmapData object to represent the button in the over position. | Button | ||
| overFunction : Function
Reference to the function to be performed on roll over.
| Button | ||
| testing : Boolean = false [static]
Toggles verbose output.
| Button | ||
| up : BitmapData
The
BitmapData object to represent the button in the normal or "up" position. | Button | ||
| upFunction : Function
Reference to the function to be performed on mouse up.
| Button | ||
| width : Number | Button | ||
| Method | Defined by | ||
|---|---|---|---|
|
Button()
| Button | ||
|
Returns a clone of the given Button instance.
| Button | ||
|
destroy():void
Destroys all internal references.
| Button | ||
|
inheritSkin(parent:Button, inheritFunctions:Boolean = false):void
Inherits the skin [or bitmapdata and guide] as well as optionally the
action functions of the
parent Button. | Button | ||
| down | property |
down:BitmapData [read-write]
The BitmapData object to represent the button in the down position.
public function get down():BitmapData
public function set down(value:BitmapData):void
| downFunction | property |
public var downFunction:FunctionReference to the function to be performed on mouse down.
| guide | property |
public var guide:BitmapData
A BitmapData object specifying the bounds of the button.
Two BitmapData given for each up/over/down state could be different
sizes, so the guide will be the deciding bound.
| height | property |
height:Number [read-write]Implementation
public function get height():Number
public function set height(value:Number):void
| initialized | property |
initialized:Boolean [read-only]Returns whether or not the Button is initialized and contains references to bitmapData.
Implementation public function get initialized():Boolean
| outFunction | property |
public var outFunction:FunctionReference to the function to be performed on roll out.
| over | property |
over:BitmapData [read-write]
The BitmapData object to represent the button in the over position.
public function get over():BitmapData
public function set over(value:BitmapData):void
| overFunction | property |
public var overFunction:FunctionReference to the function to be performed on roll over.
| testing | property |
public static var testing:Boolean = falseToggles verbose output.
| up | property |
up:BitmapData [read-write]
The BitmapData object to represent the button in the normal or "up" position.
public function get up():BitmapData
public function set up(value:BitmapData):void
| upFunction | property |
public var upFunction:FunctionReference to the function to be performed on mouse up.
| width | property |
width:Number [read-write]Implementation
public function get width():Number
public function set width(value:Number):void
| Button | () | constructor |
public function Button()
| clone | () | method |
public function clone():ButtonReturns a clone of the given Button instance.
ReturnsButton —
Button instance.
|
| destroy | () | method |
public function destroy():voidDestroys all internal references.
| inheritSkin | () | method |
public function inheritSkin(parent:Button, inheritFunctions:Boolean = false):void
Inherits the skin [or bitmapdata and guide] as well as optionally the
action functions of the parent Button. This is much like
the clone function, but instead of creating a new Button
instance and returning it, it populates the calling Button instance
with the bitmapdata and guide of the Button passed in the parameters.
parent:Button — The parent Button to inherit from.
|
|
inheritFunctions:Boolean (default = false) |