Packagevegas.config
Classpublic class ConfigurableObject
InheritanceConfigurableObject Inheritance CoreEventDispatcher Inheritance Object
Implements IConfigurable, Identifiable
Subclasses CoreStyle

This core class extend the CoreObject class and implement the IConfigurable interface. A IConfigurable object handle a notification of the ConfigCollector class with the method setup(), you must override this method in your concrete class. The IConfigurable objects are registered in the ConfigCollector to launch the setup of all IConfigurable object one time with the ConfigCollector.run() method when the Config is loaded for example.


Public Properties
 PropertyDefined By
 Inheritedchannel : String
[read-only] Indicates the channel of this dispatcher if this instance is global.
CoreEventDispatcher
  id : *
Returns the id of this object.
ConfigurableObject
  isConfigurable : Boolean
Indicates if the object is configurable and receive the notification of the ConfigCollector in the setup() method.
ConfigurableObject
Public Methods
 MethodDefined By
  
ConfigurableObject(id:* = null, isConfigurable:Boolean = false, global:Boolean = false, channel:String = null)
Creates a new ConfigurableObject instance.
ConfigurableObject
 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
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
CoreEventDispatcher
 Inherited
getEventDispatcher():EventDispatcher
Returns the internal system.events.EventDispatcher reference.
CoreEventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
CoreEventDispatcher
 Inherited
isGlobal():Boolean
Indicates if the dispatcher use a global event flow.
CoreEventDispatcher
 Inherited
isLocked():Boolean
Returns true if the object is locked.
CoreEventDispatcher
 Inherited
lock():void
Locks the object.
CoreEventDispatcher
 Inherited
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
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
CoreEventDispatcher
 Inherited
setEventDispatcher(dispatcher:EventDispatcher):void
Sets the internal EventDispatcher reference.
CoreEventDispatcher
 Inherited
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
  
setup():void
Invoked when this object when the ConfigCollector is run.
ConfigurableObject
 Inherited
unlock():void
Unlocks the display.
CoreEventDispatcher
 Inherited
unregisterEventListener(type:String, listener:*, useCapture:Boolean = false):void
Removes a listener (Function or EventListener object) from the EventDispatcher object.
CoreEventDispatcher
  
update():void
Update the display.
ConfigurableObject
 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
  
_setID(id:*):void
Sets the id of the object with a custom method.
ConfigurableObject
 Inherited
initEventDispatcher():EventDispatcher
Creates and returns the internal EventDispatcher reference (this method is invoked in the constructor).
CoreEventDispatcher
Property Detail
idproperty
id:*

Returns the id of this object.


Implementation
    public function get id():*
    public function set id(value:any):void
isConfigurableproperty 
isConfigurable:Boolean

Indicates if the object is configurable and receive the notification of the ConfigCollector in the setup() method.


Implementation
    public function get isConfigurable():Boolean
    public function set isConfigurable(value:Boolean):void
Constructor Detail
ConfigurableObject()Constructor
public function ConfigurableObject(id:* = null, isConfigurable:Boolean = false, global:Boolean = false, channel:String = null)

Creates a new ConfigurableObject instance.

Parameters
id:* (default = null) — Indicates the id of the object.
 
isConfigurable:Boolean (default = false) — This flag indicates if the IConfigurable object is register in the ConfigCollector.
 
global:Boolean (default = false) — the flag to use a global event flow or a local event flow.
 
channel:String (default = null) — the name of the global event flow if the global argument is true.
Method Detail
_setID()method
protected function _setID(id:*):void

Sets the id of the object with a custom method.

Parameters

id:*

setup()method 
public function setup():void

Invoked when this object when the ConfigCollector is run.

update()method 
public function update():void

Update the display. You must override this method. This method is launch by the setup() method when the Config is checked.





Mardi Août 16 2011, 02:33 PM +02:00