Packagevegas.ioc
Classpublic class ObjectFactoryLoader
InheritanceObjectFactoryLoader Inheritance Task Inheritance Object
Subclasses ApplicationLoader

This loader object load an external IoC context and this dependencies and fill the IoC container.



Public Properties
 PropertyDefined By
  context : String
The default context file uri value.
ObjectFactoryLoader
  factory : ObjectFactory
The IoC factory reference.
ObjectFactoryLoader
 InheritedfinishIt : Signaler
This signal emit when the notifyFinished method is invoked.
Task
  flashVars : FlashVars
The flashVars reference of the application.
ObjectFactoryLoader
 Inheritedlogger : Logger
Determinates the internal Logger reference of this Loggable object.
Task
  path : String
The default path of the external context file.
ObjectFactoryLoader
 Inheritedphase : String
[read-only] The current phase of the action.
Task
  resourceInfo : ObjectResourceInfo
[read-only] Returns the ObjectResourceInfo object corresponding to the current resource being loaded.
ObjectFactoryLoader
  root : DisplayObjectContainer
The root reference of the application.
ObjectFactoryLoader
 Inheritedrunning : Boolean
[read-only] Indicates true if the process is in progress.
Task
  stage : Stage
The Stage reference of the application.
ObjectFactoryLoader
 InheritedstartIt : Signaler
This signal emit when the notifyStarted method is invoked.
Task
  verbose : Boolean
Switch the verbose mode of this loader.
ObjectFactoryLoader
Protected Properties
 PropertyDefined By
  objects : Array
The array representation of the object definitions to insert in the IoC factory container.
ObjectFactoryLoader
  sequencer : Chain
The internal sequencer of the factory loader.
ObjectFactoryLoader
Public Methods
 MethodDefined By
  
ObjectFactoryLoader(context:String = null, path:String, factory:ObjectFactory = null)
Creates a new ObjectFactoryLoader instance.
ObjectFactoryLoader
  
clear():void
Clear all the resources in the loader and reset it.
ObjectFactoryLoader
 Inherited
clone():*
Returns a shallow copy of this object.
Task
  
create():void
Creates the objects.
ObjectFactoryLoader
 Inherited
isLocked():Boolean
Returns true if the object is locked.
Task
 Inherited
lock():void
Locks the object.
Task
 Inherited
Notify an ActionEvent when the process is finished.
Task
 Inherited
Notify an ActionEvent when the process is started.
Task
  
Register the current factory reference of this loader.
ObjectFactoryLoader
  
run(... arguments):void
[override] Run the process.
ObjectFactoryLoader
 Inherited
unlock():void
Unlocks the display.
Task
  
Unregister the current factory referenceof this loader.
ObjectFactoryLoader
Protected Methods
 MethodDefined By
  
addResource(resource:ObjectResource):Boolean
This method is the strategy to insert a new ObjectResource in the sequencer.
ObjectFactoryLoader
  
change(action:Action):void
Invoked when the current task in the sequencer is changed.
ObjectFactoryLoader
  
complete(action:Action = null):void
Invoked when the factory is complete.
ObjectFactoryLoader
 Inherited
setRunning(b:Boolean):void
Changes the running property value.
Task
Property Detail
contextproperty
public var context:String

The default context file uri value.

factoryproperty 
factory:ObjectFactory

The IoC factory reference.


Implementation
    public function get factory():ObjectFactory
    public function set factory(value:ObjectFactory):void
flashVarsproperty 
flashVars:FlashVars

The flashVars reference of the application. This property is optional and can be target in the IoC factory with the "ref" attribute with the value "#flashVars".


Implementation
    public function get flashVars():FlashVars
    public function set flashVars(value:FlashVars):void
objectsproperty 
protected var objects:Array

The array representation of the object definitions to insert in the IoC factory container.

pathproperty 
path:String

The default path of the external context file.


Implementation
    public function get path():String
    public function set path(value:String):void
resourceInfoproperty 
resourceInfo:ObjectResourceInfo  [read-only]

Returns the ObjectResourceInfo object corresponding to the current resource being loaded.


Implementation
    public function get resourceInfo():ObjectResourceInfo
rootproperty 
root:DisplayObjectContainer

The root reference of the application. This property is optional and can be target in the IoC factory with the "ref" attribute with the value "#root".


Implementation
    public function get root():DisplayObjectContainer
    public function set root(value:DisplayObjectContainer):void
sequencerproperty 
protected var sequencer:Chain

The internal sequencer of the factory loader. (Use it to load multiple context files).

stageproperty 
stage:Stage

The Stage reference of the application. This property is optional and can be target in the IoC factory with the "ref" attribute with the value "#stage".


Implementation
    public function get stage():Stage
    public function set stage(value:Stage):void
verboseproperty 
public var verbose:Boolean

Switch the verbose mode of this loader.

Constructor Detail
ObjectFactoryLoader()Constructor
public function ObjectFactoryLoader(context:String = null, path:String, factory:ObjectFactory = null)

Creates a new ObjectFactoryLoader instance.

Parameters
context:String (default = null) — The uri of the context external eden file (default "application.eden").
 
path:String — The optional path of the external context file (default "").
 
factory:ObjectFactory (default = null) — The ObjectFactory reference of this loader.
Method Detail
addResource()method
protected function addResource(resource:ObjectResource):Boolean

This method is the strategy to insert a new ObjectResource in the sequencer. You must defines and overrides this method in your concrete ObjectFactoryLoader class.

Parameters

resource:ObjectResource

Returns
Boolean
change()method 
protected function change(action:Action):void

Invoked when the current task in the sequencer is changed.

Parameters

action:Action

clear()method 
public function clear():void

Clear all the resources in the loader and reset it.

complete()method 
protected function complete(action:Action = null):void

Invoked when the factory is complete.

Parameters

action:Action (default = null)

create()method 
public function create():void

Creates the objects.

registerFactory()method 
public function registerFactory():void

Register the current factory reference of this loader.

run()method 
override public function run(... arguments):void

Run the process.

Parameters

... arguments

unregisterFactory()method 
public function unregisterFactory():void

Unregister the current factory referenceof this loader.