Packagelunas.display.button
Classpublic class AquaButtonBuilder
InheritanceAquaButtonBuilder Inheritance AbstractButtonBuilder Inheritance AbstractBuilder Inheritance CoreEventDispatcher Inheritance CoreObject

The IBuilder class of the AquaButton component.



Public Properties
 PropertyDefined by
  background : CoreShape
The background reference of the component.
AquaButtonBuilder
  backgroundColor : LightColor
The light color reference of the builder.
AquaButtonBuilder
  backgroundPen : RoundedComplexRectanglePen
The IPen of the background.
AquaButtonBuilder
  backgroundTween : Tween
The tween of the builder.
AquaButtonBuilder
 Inheritedchannel : String
Indicates the channel of this dispatcher if this instance is global.
CoreEventDispatcher
  effect : CoreShape
The effect reference of the component.
AquaButtonBuilder
  effectPen : RoundedComplexRectanglePen
The effect IPen object of the component.
AquaButtonBuilder
  field : CoreTextField
The field reference of the component.
AquaButtonBuilder
 InheritedisGlobal : Boolean
(read-only) Returns the value of the isGlobal flag of this model.
CoreEventDispatcher
 Inheritedtarget : DisplayObject
(read-write) Indicates the target reference of the component.
AbstractBuilder
Public Methods
 MethodDefined by
  
AquaButtonBuilder(target:DisplayObject, bGlobal:Boolean = false, sChannel:String = null)
Creates a new AquaButtonBuilder instance.
AquaButtonBuilder
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0.0, useWeakReference:Boolean = false):void
Allows the registration of event listeners on the event target.
CoreEventDispatcher
  
clear():void
Clear the view of the component.
AquaButtonBuilder
 Inherited
containsType(type:String):Boolean
Returns true if the specified type is register in the object.
AbstractButtonBuilder
  
Invoked when the button is down.
AquaButtonBuilder
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
CoreEventDispatcher
  
down(e:ButtonEvent):void
Invoked when the button is down.
AquaButtonBuilder
 Inherited
Returns the internal EventDispatcher reference.
CoreEventDispatcher
 Inherited
getIsGlobal():Boolean
Returns the value of the isGlobal flag of this model.
CoreEventDispatcher
 Inherited
Returns the internal ILogger reference of this ILogable object.
CoreObject
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
CoreEventDispatcher
 Inherited
hashCode():uint
Returns a hashcode value for the object.
CoreObject
 Inherited
Creates and returns the internal EventDispatcher reference (this method is invoked in the constructor).
CoreEventDispatcher
  
initType():void
Initialize all register type of this builder.
AquaButtonBuilder
 Inherited
isLocked():Boolean
Returns true if the object is locked.
CoreEventDispatcher
 Inherited
lock():void
Locks the object.
CoreEventDispatcher
  
over(e:ButtonEvent):void
Invoked when the button is over.
AquaButtonBuilder
 Inherited
registerEventListener(type:String, listener:Boolean, useCapture:int = false, priority:Boolean = 0, useWeakReference:* = false):void
Allows the registration of event listeners on the event target (Function or EventListener).
CoreEventDispatcher
 Inherited
registerType(type:String, callback:Function = null):void
Registers the ButtonEvent type passed in argument.
AbstractButtonBuilder
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
CoreEventDispatcher
  
run(... arguments):void
Run the build of the component.
AquaButtonBuilder
 Inherited
Sets the internal EventDispatcher reference.
CoreEventDispatcher
 Inherited
setGlobal(flag:Boolean = false, channel:String = null):void
Sets if the instance use a global EventDispatcher to dispatch this events, if the flag value is false the instance use a local EventDispatcher.
CoreEventDispatcher
 Inherited
setLogger(log:ILogger = null):void
Sets the internal ILogger reference of this ILogable object.
CoreObject
 Inherited
toSource(indent:int = 0):String
Returns the string representation the source code of the object.
CoreEventDispatcher
 Inherited
toString():String
Returns the string representation of this instance.
CoreObject
 Inherited
unlock():void
Unlocks the display.
CoreEventDispatcher
 Inherited
unregisterEventListener(type:String, listener:Boolean, useCapture:* = false):void
Removes a listener (Function or EventListener object) from the EventDispatcher object.
CoreEventDispatcher
 Inherited
unregisterType(type:String):void
Unregisters the ButtonEvent type passed in argument.
AbstractButtonBuilder
  
up(e:ButtonEvent):void
Invoked when the button is up.
AquaButtonBuilder
  
update():void
Update the view of the component.
AquaButtonBuilder
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
CoreEventDispatcher
Protected Methods
 MethodDefined by
 Inherited
refreshState(e:Event):void
Invoked when a ButtonEvent register in this builder is dispatched.
AbstractButtonBuilder
Property detail
backgroundproperty
public var background:CoreShape

The background reference of the component.

backgroundColorproperty 
public var backgroundColor:LightColor

The light color reference of the builder.

backgroundPenproperty 
public var backgroundPen:RoundedComplexRectanglePen

The IPen of the background.

backgroundTweenproperty 
public var backgroundTween:Tween

The tween of the builder.

effectproperty 
public var effect:CoreShape

The effect reference of the component.

effectPenproperty 
public var effectPen:RoundedComplexRectanglePen

The effect IPen object of the component.

fieldproperty 
public var field:CoreTextField

The field reference of the component.

Constructor detail
AquaButtonBuilder()constructor
public function AquaButtonBuilder(target:DisplayObject, bGlobal:Boolean = false, sChannel:String = null)

Creates a new AquaButtonBuilder instance.

Parameters
target:DisplayObject — the target of the component reference to build.
 
bGlobal:Boolean (default = false) — the flag to use a global event flow or a local event flow.
 
sChannel:String (default = null) — the name of the global event flow if the bGlobal argument is true.
Method detail
clear()method
public override function clear():void

Clear the view of the component.

disabled()method 
public function disabled(e:ButtonEvent):void

Invoked when the button is down.

Parameters
e:ButtonEvent
down()method 
public function down(e:ButtonEvent):void

Invoked when the button is down.

Parameters
e:ButtonEvent
initType()method 
public override function initType():void

Initialize all register type of this builder.

over()method 
public function over(e:ButtonEvent):void

Invoked when the button is over.

Parameters
e:ButtonEvent
run()method 
public override function run(... arguments):void

Run the build of the component.

Parameters
... arguments
up()method 
public function up(e:ButtonEvent):void

Invoked when the button is up.

Parameters
e:ButtonEvent
update()method 
public override function update():void

Update the view of the component.