Packagecom.bourre.ioc.assembler.displayobject
Classpublic class DefaultDisplayObjectBuilder
ImplementsDisplayObjectBuilder
SubclassesRTDisplayObjectBuilder

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Default display object builder implementation.



Public Methods
 MethodDefined by
  
DefaultDisplayObjectBuilder(rootTarget:DisplayObjectContainer = null)
Creates instance.
DefaultDisplayObjectBuilder
  
addEventListener(type:String, listener:Object, ... rest):Boolean
Adds an event listener for the specified event type.
DefaultDisplayObjectBuilder
  
Adds the passed-in listener as listener for all events dispatched by this builder.
DefaultDisplayObjectBuilder
  
Builds display list.
DefaultDisplayObjectBuilder
  
buildDisplayLoader(valueObject:ValueObject):void
Builds a display loader using passed-in ValueObject configuration object.
DefaultDisplayObjectBuilder
  
buildDisplayObject(valueObject:ValueObject):void
Builds a Display object using passed-in ValueObject configuration object.
DefaultDisplayObjectBuilder
  
buildDLL(valueObject:ValueObject):void
Builds a DLL object using passed-in ValueObject configuration object.
DefaultDisplayObjectBuilder
  
buildResource(valueObject:ValueObject):void
Builds a Resource object using passed-in ValueObject configuration object.
DefaultDisplayObjectBuilder
  
execute(e:Event = null):void
Starts processing.
DefaultDisplayObjectBuilder
  
getRootID():String
Returns the root registration ID.
DefaultDisplayObjectBuilder
  
getRootTarget():DisplayObjectContainer
Returns root target.
DefaultDisplayObjectBuilder
  
getURLRequest(request:URLRequest, prefix:String = null):URLRequest
Retreives and returns correct url using request base url and the possible prefix to insert.
DefaultDisplayObjectBuilder
  
isAntiCache():Boolean
Returns true if Anti cache system is activated for loading process.
DefaultDisplayObjectBuilder
  
Loads Display objects queue.( if any ).
DefaultDisplayObjectBuilder
  
loadDLLQueue():void
Loads DLL queue.( if any ).
DefaultDisplayObjectBuilder
  
loadRSCQueue():void
Loads Resources queue.( if any ).
DefaultDisplayObjectBuilder
  
Triggered when display loader is loaded.
DefaultDisplayObjectBuilder
  
Triggered when Display objects queue loading is finished.
DefaultDisplayObjectBuilder
  
Triggered when Display objects queue starts loading.
DefaultDisplayObjectBuilder
  
Triggered when DLL queue loading is finished.
DefaultDisplayObjectBuilder
  
Triggered when DLL queue starts loading.
DefaultDisplayObjectBuilder
  
Triggered when Resources queue loading is finished.
DefaultDisplayObjectBuilder
  
Triggered when Resources queue starts loading.
DefaultDisplayObjectBuilder
  
Triggered when an error occurs during element, contained in queues, fail.
DefaultDisplayObjectBuilder
  
Triggered when an element contains in queues stops loading.
DefaultDisplayObjectBuilder
  
Triggered during element, contained in queues, loading progession.
DefaultDisplayObjectBuilder
  
Triggered when an element contains in queues starts loading.
DefaultDisplayObjectBuilder
  
Triggered when a timout occurs during element, contained in queues, loading.
DefaultDisplayObjectBuilder
  
Triggered when an element ( resources only ) contains in queues stops loading.
DefaultDisplayObjectBuilder
  
removeEventListener(type:String, listener:Object):Boolean
Removes the passed-in listener for listening the specified event.
DefaultDisplayObjectBuilder
  
Removes the passed-in listener object from this event broadcaster.
DefaultDisplayObjectBuilder
  
setAntiCache(b:Boolean):void
Sets the Anti cache system to true or false
DefaultDisplayObjectBuilder
  
setRootTarget(target:DisplayObjectContainer):void
Sets the root target for display list creation.
DefaultDisplayObjectBuilder
  
size():uint
Returns all elements queue size.
DefaultDisplayObjectBuilder
  
toString():String
Returns the string representation of this instance.
DefaultDisplayObjectBuilder
Protected Methods
 MethodDefined by
  
Builds the display list as it is defined in xml context tree.
DefaultDisplayObjectBuilder
  
Creates empty display object.
DefaultDisplayObjectBuilder
  
fireEvent(type:String, loader:Loader = null, errorMessage:String = null):void
Broadcasts event.
DefaultDisplayObjectBuilder
  
generateRootID():String
Generates an unique registration ID for root object.
DefaultDisplayObjectBuilder
Events
 EventSummaryDefined by
   Dispatched when display list build is finished.DefaultDisplayObjectBuilder
   Dispatched when display list build is processing.DefaultDisplayObjectBuilder
   Dispatched when display list treatment is finished.DefaultDisplayObjectBuilder
   Dispatched when engine starts display list treatment.DefaultDisplayObjectBuilder
   Dispatched when DLL list treatment is finished.DefaultDisplayObjectBuilder
   Dispatched when engine starts DLL list treatment.DefaultDisplayObjectBuilder
   Dispatched when an error occurs during context element loading.DefaultDisplayObjectBuilder
   Dispatched when a context element loading is finished.DefaultDisplayObjectBuilder
   Dispatched during context element loading progression.DefaultDisplayObjectBuilder
   Dispatched when a context element starts loading.DefaultDisplayObjectBuilder
   Dispatched when a timemout occurs during context element loading.DefaultDisplayObjectBuilder
   Dispatched when resources list treatment is finished.DefaultDisplayObjectBuilder
   Dispatched when engine starts resources list treatment.DefaultDisplayObjectBuilder
Public Constants
 ConstantDefined by
  MOVIECLIP : String
[static]
DefaultDisplayObjectBuilder
  SPRITE : String
[static]
DefaultDisplayObjectBuilder
  TEXTFIELD : String
[static]
DefaultDisplayObjectBuilder
Constructor detail
DefaultDisplayObjectBuilder()constructor
public function DefaultDisplayObjectBuilder(rootTarget:DisplayObjectContainer = null)

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Creates instance.

Parameters
rootTarget:DisplayObjectContainer (default = null)
Method detail
_buildDisplayObject()method
protected function _buildDisplayObject(info:DisplayObjectInfo):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Builds the display list as it is defined in xml context tree.

Parameters
info:DisplayObjectInfo

Returns
Boolean
_buildEmptyDisplayObject()method 
protected function _buildEmptyDisplayObject(info:DisplayObjectInfo):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Creates empty display object. ( container ).

Parameters
info:DisplayObjectInfo

Returns
Boolean
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
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
buildDisplayList()method 
public function buildDisplayList():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Builds display list.

buildDisplayLoader()method 
public function buildDisplayLoader(valueObject:ValueObject):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

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

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

Player version: Flash Player 9.0
Language version: ActionScript 3.0

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

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

Player version: Flash Player 9.0
Language version: ActionScript 3.0

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

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

Player version: Flash Player 9.0
Language version: ActionScript 3.0

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

Parameters
valueObject:ValueObjectValueObject containing building parameters
execute()method 
public function execute(e:Event = null):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Starts processing.

Parameters
e:Event (default = null)
fireEvent()method 
protected function fireEvent(type:String, loader:Loader = null, errorMessage:String = null):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Broadcasts event.

Parameters
type:String
 
loader:Loader (default = null)
 
errorMessage:String (default = null)
generateRootID()method 
protected function generateRootID():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Generates an unique registration ID for root object.

Returns
String
getRootID()method 
public function getRootID():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the root registration ID.

Returns
String
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
loadDisplayObjectQueue()method 
public function loadDisplayObjectQueue():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Loads Display objects queue.( if any ).

If queue is empty, pass to buildDisplayList() method.

See also

loadDLLQueue()method 
public function loadDLLQueue():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Loads DLL queue.( if any ).

If queue is empty, pass to loadRSCQueue() method.

See also

loadRSCQueue()method 
public function loadRSCQueue():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Loads Resources queue.( if any ).

If queue is empty, pass to loadDisplayObjectQueue() method.

See also

onDisplayLoaderInit()method 
public function onDisplayLoaderInit(e:GraphicLoaderEvent, displayLoaderInfo:DisplayLoaderInfo):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when display loader is loaded.

Parameters
e:GraphicLoaderEvent
 
displayLoaderInfo:DisplayLoaderInfo
onDisplayObjectLoadInit()method 
public function onDisplayObjectLoadInit(e:LoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when Display objects queue loading is finished.

Parameters
e:LoaderEvent
onDisplayObjectLoadStart()method 
public function onDisplayObjectLoadStart(e:LoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when Display objects queue starts loading.

Parameters
e:LoaderEvent
onDLLLoadInit()method 
public function onDLLLoadInit(e:LoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when DLL queue loading is finished.

Parameters
e:LoaderEvent
onDLLLoadStart()method 
public function onDLLLoadStart(e:LoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when DLL queue starts loading.

Parameters
e:LoaderEvent
onRSCLoadInit()method 
public function onRSCLoadInit(e:LoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when Resources queue loading is finished.

Parameters
e:LoaderEvent
onRSCLoadStart()method 
public function onRSCLoadStart(e:LoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when Resources queue starts loading.

Parameters
e:LoaderEvent
qlOnLoadError()method 
public function qlOnLoadError(e:LoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when an error occurs during element, contained in queues, fail.

Parameters
e:LoaderEvent
qlOnLoadInit()method 
public function qlOnLoadInit(e:LoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when an element contains in queues stops loading.

Parameters
e:LoaderEvent
qlOnLoadProgress()method 
public function qlOnLoadProgress(e:LoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered during element, contained in queues, loading progession.

Parameters
e:LoaderEvent
qlOnLoadStart()method 
public function qlOnLoadStart(e:LoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when an element contains in queues starts loading.

Parameters
e:LoaderEvent
qlOnLoadTimeOut()method 
public function qlOnLoadTimeOut(e:LoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when a timout occurs during element, contained in queues, loading.

Parameters
e:LoaderEvent
qlOnRSCLoadInit()method 
public function qlOnRSCLoadInit(e:QueueLoaderEvent):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when an element ( resources only ) contains in queues stops loading.

Parameters
e:QueueLoaderEvent
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
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
toString()method 
public function toString():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the string representation of this instance.

Returns
String — the string representation of this instance
Event detail
onDisplayObjectBuilderLoadInitevent 
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onDisplayObjectBuilderLoadInitEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when display list build is finished.

Defines the value of the type property of the event object for a onDisplayObjectBuilderLoadInit event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
onDisplayObjectBuilderLoadStartevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onDisplayObjectBuilderLoadStartEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when display list build is processing.

Defines the value of the type property of the event object for a onDisplayObjectBuilderLoadStart event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
onDisplayObjectLoadInitevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onDisplayObjectLoadInitEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when display list treatment is finished.

Defines the value of the type property of the event object for a onDisplayObjectLoadInit event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
onDisplayObjectLoadStartevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onDisplayObjectLoadStartEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when engine starts display list treatment.

Defines the value of the type property of the event object for a onDisplayObjectLoadStart event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
onDLLLoadInitevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onDLLLoadInitEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when DLL list treatment is finished.

Defines the value of the type property of the event object for a onDLLLoadInit event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
onDLLLoadStartevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onDLLLoadStartEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when engine starts DLL list treatment.

Defines the value of the type property of the event object for a onDLLLoadStart event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
onLoadErrorEVENTevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onLoadErrorEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when an error occurs during context element loading.

onLoadInitevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onLoadInitEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when a context element loading is finished.

Defines the value of the type property of the event object for a onLoadInit event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getLoader() The loader object
getName() The loader identifier
onLoadProgressevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onLoadProgressEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched during context element loading progression.

Defines the value of the type property of the event object for a onLoadProgress event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getLoader() The loader object
getName() The loader identifier
getPercent() The loading progression
onLoadStartevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onLoadStartEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when a context element starts loading.

Defines the value of the type property of the event object for a onLoadStart event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getLoader() The loader object
getName() The loader identifier
onLoadTimeOutevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onLoadTimeOutEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when a timemout occurs during context element loading.

Defines the value of the type property of the event object for a onLoadTimeOut event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getLoader() The loader object
getName() The loader identifier
onRSCLoadInitevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onRSCLoadInitEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when resources list treatment is finished.

Defines the value of the type property of the event object for a onRSCLoadInit event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
onRSCLoadStartevent  
Event object type: com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent
DisplayObjectBuilderEvent.type property = com.bourre.ioc.assembler.displayobject.DisplayObjectBuilderEvent.onRSCLoadStartEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when engine starts resources list treatment.

Defines the value of the type property of the event object for a onRSCLoadStart event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
Constant detail
MOVIECLIPconstant
public static const MOVIECLIP:String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

SPRITEconstant 
public static const SPRITE:String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

TEXTFIELDconstant 
public static const TEXTFIELD:String

Player version: Flash Player 9.0
Language version: ActionScript 3.0