| Package | lunas.components.buttons |
| Class | public class BackgroundButtonBuilder |
| Inheritance | BackgroundButtonBuilder  CoreButtonBuilder CoreBuilder CoreEventDispatcher Object |
| Subclasses | LabelButtonBuilder, PictureButtonBuilder, SwitchLabelButtonBuilder |
| Property | Defined By | ||
|---|---|---|---|
| background : Background
The background reference of the component. | BackgroundButtonBuilder | ||
 | channel : String [read-only]
Indicates the channel of this dispatcher if this instance is global. | CoreEventDispatcher | |
| target : DisplayObject
Indicates the target reference of the component. | CoreBuilder | |
| Method | Defined By | ||
|---|---|---|---|
BackgroundButtonBuilder(target:DisplayObject)
Creates a new BackgroundButtonBuilder instance. | BackgroundButtonBuilder | ||
| 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 [override]
Clear the view of the component. | BackgroundButtonBuilder | ||
| containsType(type:String):Boolean
Returns true if the specified type is register in the object. | CoreButtonBuilder | |
disabled(e:ButtonEvent = null):void
Invoked when the button is down. | BackgroundButtonBuilder | ||
| dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. | CoreEventDispatcher | |
down(e:ButtonEvent = null):void
Invoked when the button is down. | BackgroundButtonBuilder | ||
|
Returns the internal system.events.EventDispatcher reference. | CoreEventDispatcher | |
| hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | CoreEventDispatcher | |
initType():void [override]
Initialize all register type of this builder. | BackgroundButtonBuilder | ||
| isGlobal():Boolean
Indicates if the dispatcher use a global event flow. | CoreEventDispatcher | |
| isLocked():Boolean
Returns true if the object is locked. | CoreEventDispatcher | |
| lock():void
Locks the object. | CoreEventDispatcher | |
over(e:ButtonEvent = null):void
Invoked when the button is over. | BackgroundButtonBuilder | ||
| registerEventListener(type:String, listener:*, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Allows the registration of event listeners on the event target (Function or EventListener). | CoreEventDispatcher | |
registerLight(target:DisplayObject):void
Register the scope of the light effect of the component. | BackgroundButtonBuilder | ||
| registerType(type:String, callback:Function = null):void
Registers the ButtonEvent type passed in argument. | CoreButtonBuilder | |
| removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object. | CoreEventDispatcher | |
run(... arguments):void [override]
Runs the build of the component. | BackgroundButtonBuilder | ||
| setEventDispatcher(dispatcher:EventDispatcher):void
Sets the internal EventDispatcher reference. | CoreEventDispatcher | |
| setGlobal(flag:Boolean = false, channel:String = null):void
Sets if the instance use a global system.events.EventDispatcher to dispatch this events, if the flag value is false the instance use a local EventDispatcher. | CoreEventDispatcher | |
| unlock():void
Unlocks the display. | CoreEventDispatcher | |
| unregisterEventListener(type:String, listener:*, useCapture:Boolean = false):void
Removes a listener (Function or EventListener object) from the EventDispatcher object. | CoreEventDispatcher | |
| unregisterType(type:String):void
Unregisters the ButtonEvent type passed in argument. | CoreButtonBuilder | |
up(e:ButtonEvent = null):void
Invoked when the button is up. | BackgroundButtonBuilder | ||
update():void [override]
Update the view of the component. | BackgroundButtonBuilder | ||
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
|
Creates and returns the internal EventDispatcher reference (this method is invoked in the constructor). | CoreEventDispatcher | |
Refresh the internal background. | BackgroundButtonBuilder | ||
| refreshState(e:Event):void
Invoked when a ButtonEvent register in this builder is dispatched. | CoreButtonBuilder | |
| background | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var background:BackgroundThe background reference of the component.
| BackgroundButtonBuilder | () | Constructor |
public function BackgroundButtonBuilder(target:DisplayObject)Creates a new BackgroundButtonBuilder instance.
Parameterstarget:DisplayObject — the target of the component reference to build.
|
| clear | () | method |
override public function clear():voidClear the view of the component.
| disabled | () | method |
public function disabled(e:ButtonEvent = null):voidInvoked when the button is down.
Parameters
e:ButtonEvent (default = null) |
| down | () | method |
public function down(e:ButtonEvent = null):voidInvoked when the button is down.
Parameters
e:ButtonEvent (default = null) |
| initType | () | method |
override public function initType():voidInitialize all register type of this builder.
| over | () | method |
public function over(e:ButtonEvent = null):voidInvoked when the button is over.
Parameters
e:ButtonEvent (default = null) |
| refreshBackground | () | method |
protected function refreshBackground(theme:IFillStyle = null, themeBorder:ILineStyle = null):voidRefresh the internal background.
Parameters
theme:IFillStyle (default = null) | |
themeBorder:ILineStyle (default = null) |
| registerLight | () | method |
public function registerLight(target:DisplayObject):voidRegister the scope of the light effect of the component.
Parameters
target:DisplayObject |
| run | () | method |
override public function run(... arguments):voidRuns the build of the component.
Parameters
... arguments |
| up | () | method |
public function up(e:ButtonEvent = null):voidInvoked when the button is up.
Parameters
e:ButtonEvent (default = null) |
| update | () | method |
override public function update():voidUpdate the view of the component.