Packageorg.springextensions.actionscript.puremvc.patterns.facade
SVN browsingIocFacade.as
FisheyeIocFacade.as
Classpublic class IocFacade
InheritanceIocFacade Inheritance org.puremvc.as3.patterns.facade.Facade
Implementsflash.events.IEventDispatcher, IIocFacade

IoC capable PureMVC facade which integrates functionalities of Prana and PureMVC frameworks.

Author: Damir Murat
Version: $Revision: 17 $, $Date: 2008-11-01 20:07:07 +0100 (za, 01 nov 2008) $, $Author: dmurat $
Since: 0.4



Public Properties
 PropertyDefined by
  container : IConfigurableApplicationContext
[read-only]
IocFacade
Protected Properties
 PropertyDefined by
  m_applicationContext : XMLApplicationContext
IocFacade
  m_dispatcher : EventDispatcher
IocFacade
  m_iocContainerInitialized : Boolean = false
IocFacade
  m_mediatorNamesMap : Dictionary
IocFacade
  m_proxyNamesMap : Dictionary
IocFacade
Public Methods
 MethodDefined by
  
IocFacade(p_configSource:* = null)
Constructor.
IocFacade
  
addConfigSource(p_configSource:*):void
Adds configuration source to this IocFacade instance.
IocFacade
  
addEventListener(p_type:String, p_listener:Function, p_useCapture:Boolean = false, p_priority:int = 0, p_useWeakReference:Boolean = false):void
IocFacade
  
dispatchEvent(p_event:Event):Boolean
IocFacade
  
hasEventListener(p_type:String):Boolean
IocFacade
  
initializeIocContainer(p_configSource:* = null):void
One time initialization of internal IoC container.
IocFacade
  
registerCommandByConfigName(p_noteName:String, p_configName:String):void
IocFacade
  
registerMediatorByConfigName(p_mediatorName:String, p_viewComponent:Object = null):void
IocFacade
  
registerProxyByConfigName(p_proxyName:String):void
IocFacade
  
removeEventListener(p_type:String, p_listener:Function, p_useCapture:Boolean = false):void
IocFacade
  
removeMediator(p_mediatorName:String):IMediator
IocFacade
  
removeProxy(p_proxyName:String):IProxy
IocFacade
  
willTrigger(p_type:String):Boolean
IocFacade
Protected Methods
 MethodDefined by
  
Enables adding object postprocessors in internal prana container.
IocFacade
  
IocFacade
  
This prevents super constructor from trying to initialize facade to early.
IocFacade
  
IocFacade
  
onObjectFactoryListenerComplete(p_event:Event):void
IocFacade
Events
 EventSummaryDefined by
   Dispatched as a result of a call to the initializeIocContainer() method when all available configuration sources have been parsed.IocFacade
Property detail
containerproperty
container:IConfigurableApplicationContext  [read-only]Implementation
    public function get container():IConfigurableApplicationContext
m_applicationContextproperty 
protected var m_applicationContext:XMLApplicationContext
m_dispatcherproperty 
protected var m_dispatcher:EventDispatcher
m_iocContainerInitializedproperty 
protected var m_iocContainerInitialized:Boolean = false
m_mediatorNamesMapproperty 
protected var m_mediatorNamesMap:Dictionary
m_proxyNamesMapproperty 
protected var m_proxyNamesMap:Dictionary
Constructor detail
IocFacade()constructor
public function IocFacade(p_configSource:* = null)

Constructor. Construction of IocFacade instance creates PureMVC compatible facade. After construction this facade is not yet IoC enabled, but it can be used as an ordinary PureMVC facade. To enable IoC features, one must invoke initializeIocContainer() method. Otherwise, all IoC specific methods will throw errors.

Between construction and invocation of initializeIocContainer() method, one can use addConfigSource() to define additional configuration sources.

Parameters
p_configSource:* (default = null) — Optional parameter with configuration source which supports several configuration source types. In one case, configuration source can be XML instance containing Prana's configuration (i.e. this can be useful for embedded configurations). Otherwise, configuration source should contain a path (or paths) to the configuration files. For a single path, String type should be used. For one or more paths, Array instance with String elements should be used.

Throws
— Error Thrown if singleton instance has already been constructed.

See also

Method detail
addConfigSource()method
public function addConfigSource(p_configSource:*):void

Adds configuration source to this IocFacade instance. To have an effect, it should be invoked between construction of facade and invocation of initializeIocContainer() method.

It supports configuration sources expressed as XML instance which should contain Prana's configuration, or as paths to the configuration files encoded like String or Array with String elements.

Parameters
p_configSource:* — Optional parameter with configuration source.

Throws
— Thrown when a supplied array contains non String elements or when supplied parameter is not of XML, String or Array type.

See also

addEventListener()method 
public function addEventListener(p_type:String, p_listener:Function, p_useCapture:Boolean = false, p_priority:int = 0, p_useWeakReference:Boolean = false):voidParameters
p_type:String
 
p_listener:Function
 
p_useCapture:Boolean (default = false)
 
p_priority:int (default = 0)
 
p_useWeakReference:Boolean (default = false)
dispatchEvent()method 
public function dispatchEvent(p_event:Event):BooleanParameters
p_event:Event

Returns
Boolean
getObjectPostProcessors()method 
protected function getObjectPostProcessors():Array

Enables adding object postprocessors in internal prana container. This implementation adds just IocConfigNameAwarePostProcessor. If this is not desired, one override this method in a subclass.

Returns
Array — Array containing all configured object postprocessors for internal prana container.

See also

hasEventListener()method 
public function hasEventListener(p_type:String):BooleanParameters
p_type:String

Returns
Boolean
initializeController()method 
protected override function initializeController():void
initializeFacade()method 
protected override function initializeFacade():void

This prevents super constructor from trying to initialize facade to early.

initializeIocContainer()method 
public function initializeIocContainer(p_configSource:* = null):void

One time initialization of internal IoC container. This method can be used only once. Otherwise, it will throw an error. To enable IoC features of IocFacade this method must be invoked after IocFacade construction.

Dispatces flash.events.Event.COMPLETE instance when finishes initialization.

Parameters
p_configSource:* (default = null) — Optional parameter specifying configuration source. It can be XML, String and Array with String elements.

Throws
— Thrown if IoC conatiner is already initialized.

See also

initializeIocFacade()method 
protected function initializeIocFacade():void
onObjectFactoryListenerComplete()method 
protected function onObjectFactoryListenerComplete(p_event:Event):voidParameters
p_event:Event
registerCommandByConfigName()method 
public function registerCommandByConfigName(p_noteName:String, p_configName:String):voidParameters
p_noteName:String
 
p_configName:String
registerMediatorByConfigName()method 
public function registerMediatorByConfigName(p_mediatorName:String, p_viewComponent:Object = null):voidParameters
p_mediatorName:String
 
p_viewComponent:Object (default = null)
registerProxyByConfigName()method 
public function registerProxyByConfigName(p_proxyName:String):voidParameters
p_proxyName:String
removeEventListener()method 
public function removeEventListener(p_type:String, p_listener:Function, p_useCapture:Boolean = false):voidParameters
p_type:String
 
p_listener:Function
 
p_useCapture:Boolean (default = false)
removeMediator()method 
public override function removeMediator(p_mediatorName:String):IMediatorParameters
p_mediatorName:String

Returns
IMediator
removeProxy()method 
public override function removeProxy(p_proxyName:String):IProxyParameters
p_proxyName:String

Returns
IProxy
willTrigger()method 
public function willTrigger(p_type:String):BooleanParameters
p_type:String

Returns
Boolean
Event detail
completeevent 
Event object type: flash.events.Event

Dispatched as a result of a call to the initializeIocContainer() method when all available configuration sources have been parsed.

See also