Packagecom.bourre.ioc.assembler.displayobject
Interfacepublic interface DisplayObjectBuilder extends Command
ImplementorsApplicationLoader, DefaultDisplayObjectBuilder

Player version: Flash Player 9.0
Language version: ActionScript 3.0

All Display object builder must implement this interface.

See also

DefaultDisplayObjectBuilder


Public Methods
 MethodDefined by
  
addEventListener(type:String, listener:Object, ... rest):Boolean
Adds an event listener for the specified event type.
DisplayObjectBuilder
  
Adds the passed-in listener as listener for all events dispatched by this builder.
DisplayObjectBuilder
  
Builds a display loader using passed-in ValueObject configuration object.
DisplayObjectBuilder
  
Builds a Display object using passed-in ValueObject configuration object.
DisplayObjectBuilder
  
Builds a DLL object using passed-in ValueObject configuration object.
DisplayObjectBuilder
  
Builds a Resource object using passed-in ValueObject configuration object.
DisplayObjectBuilder
 Inherited
execute(e:Event = null):void
Execute the request according to the current command data.
Command
  
getRootTarget():DisplayObjectContainer
Returns root target.
DisplayObjectBuilder
  
getURLRequest(request:URLRequest, prefix:String = null):URLRequest
Retreives and returns correct url using request base url and the possible prefix to insert.
DisplayObjectBuilder
  
isAntiCache():Boolean
Returns true if Anti cache system is activated for loading process.
DisplayObjectBuilder
  
removeEventListener(type:String, listener:Object):Boolean
Removes the passed-in listener for listening the specified event.
DisplayObjectBuilder
  
Removes the passed-in listener object from this event broadcaster.
DisplayObjectBuilder
  
setAntiCache(b:Boolean):void
Sets the Anti cache system to true or false
DisplayObjectBuilder
  
setRootTarget(target:DisplayObjectContainer):void
Sets the root target for display list creation.
DisplayObjectBuilder
  
size():uint
Returns all elements queue size.
DisplayObjectBuilder
Method detail
addEventListener()method
public function addEventListener(type:String, listener:Object, ... rest):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds an event listener for the specified event type. There is two behaviors for the addEventListener function :

  1. The passed-in listener is an object : The object is added as listener only for the specified event, the object must have a function with the same name than type or at least a handleEvent function.
  2. The passed-in listener is a function : A Delegate object is created and then added as listener for the event type. There is no restriction on the name of the function. If the rest is not empty, all elements in it is used as additional arguments into the delegate object.

Parameters
type:String — name of the event for which register the listener
 
listener:Object — object or function which will receive this event
 
... rest — additional arguments for the function listener

Returns
Booleantrue if the function have been succesfully added as listener fot the passed-in event

Throws
UnsupportedOperationException — If the listener is an object which have neither a function with the same name than the event type nor a function called handleEvent
addListener()method 
public function addListener(listener:DisplayObjectBuilderListener):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds the passed-in listener as listener for all events dispatched by this builder. The function returns true if the listener have been added at the end of the call. If the listener is already registered in this event broadcaster the function returns false.

Parameters
listener:DisplayObjectBuilderListener — the listener object to add as builder listener.

Returns
Booleantrue if the listener have been added during this call

Throws
IllegalArgumentException — If the passed-in listener listener doesn't match the listener type supported by this event broadcaster
 
IllegalArgumentException — If the passed-in listener is a function
buildDisplayLoader()method 
public function buildDisplayLoader(o:ValueObject):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Builds a display loader using passed-in ValueObject configuration object.

Parameters
o:ValueObjectValueObject containing building parameters
buildDisplayObject()method 
public function buildDisplayObject(o:ValueObject):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Builds a Display object using passed-in ValueObject configuration object.

Parameters
o:ValueObjectValueObject containing building parameters
buildDLL()method 
public function buildDLL(o:ValueObject):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Builds a DLL object using passed-in ValueObject configuration object.

Parameters
o:ValueObjectValueObject containing building parameters
buildResource()method 
public function buildResource(o:ValueObject):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Builds a Resource object using passed-in ValueObject configuration object.

Parameters
o:ValueObjectValueObject containing building parameters
getRootTarget()method 
public function getRootTarget():DisplayObjectContainer

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns root target.

Returns
DisplayObjectContainer
getURLRequest()method 
public function getURLRequest(request:URLRequest, prefix:String = null):URLRequest

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Retreives and returns correct url using request base url and the possible prefix to insert.

Use IoC url manager to build correct url link.
See documentation annexes for more informations about url engine.

Parameters
request:URLRequest
 
prefix:String (default = null)

Returns
URLRequest — The correct url using request base url and the possible prefix to insert.
isAntiCache()method 
public function isAntiCache():Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns true if Anti cache system is activated for loading process.

Returns
Boolean
removeEventListener()method 
public function removeEventListener(type:String, listener:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes the passed-in listener for listening the specified event. The listener could be either an object or a function.

Parameters
type:String — name of the event for which unregister the listener
 
listener:Object — object or function to be unregistered

Returns
Booleantrue if the listener have been successfully removed as listener for the passed-in event
removeListener()method 
public function removeListener(listener:DisplayObjectBuilderListener):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes the passed-in listener object from this event broadcaster. The object is removed as listener for all events the broadcaster may dispatch.

Parameters
listener:DisplayObjectBuilderListener — the listener object to remove from this event broadcaster object

Returns
Booleantrue if the object have been successfully removed from this event broadcaster

Throws
IllegalArgumentException — If the passed-in listener is a function
setAntiCache()method 
public function setAntiCache(b:Boolean):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Sets the Anti cache system to true or false

Parameters
b:Booleantrue to enable anticache.
setRootTarget()method 
public function setRootTarget(target:DisplayObjectContainer):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Sets the root target for display list creation.

Parameters
target:DisplayObjectContainer
size()method 
public function size():uint

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns all elements queue size.

Returns
uint