Packagecom.bourre.plugin
Interfacepublic interface Plugin
ImplementorsAbstractPlugin, NullPlugin

Player version: Flash Player 9.0
Language version: ActionScript 3.0

The Plugin interface defines rules for IoC plugin implementation.



Public Methods
 MethodDefined by
  
fireExternalEvent(e:Event, channel:EventChannel):void
Fires events using dedicated event channel.
Plugin
  
firePrivateEvent(e:Event):void
Fires events using private ( internal ) event channel.
Plugin
  
firePublicEvent(e:Event):void
Fires events using public event channel.
Plugin
  
Returns plugin's event channel.
Plugin
  
Returns plugin's debug channel.
Plugin
  
getModel(key:String):AbstractModel
Returns an AbstractModel instance if it is registered in model locator with passed-in key identifier.
Plugin
  
getView(key:String):AbstractView
Returns an AbstractView instance if it is registered in view locator with passed-in key identifier.
Plugin
  
isModelRegistered(name:String):Boolean
Returns true if a model is registered in model locator with passed-in name.
Plugin
  
isViewRegistered(name:String):Boolean
Returns true if a view is registered in view locator with passed-in name.
Plugin
  
Triggered when all IoC processing is finished.
Plugin
Method detail
fireExternalEvent()method
public function fireExternalEvent(e:Event, channel:EventChannel):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Fires events using dedicated event channel.

Only listeners on this event channel can receive the event.

Parameters
e:Event
 
channel:EventChannel
firePrivateEvent()method 
public function firePrivateEvent(e:Event):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Fires events using private ( internal ) event channel.

These events can be only handled by this plugin itself.
Others plugins in context can't listen this event.

Parameters
e:Event
firePublicEvent()method 
public function firePublicEvent(e:Event):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Fires events using public event channel.

Each plugin who listen this type of event will be triggered.

Parameters
e:Event
getChannel()method 
public function getChannel():EventChannel

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns plugin's event channel.

Returns
EventChannel
getLogger()method 
public function getLogger():PluginDebug

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns plugin's debug channel.

Returns
PluginDebug
getModel()method 
public function getModel(key:String):AbstractModel

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns an AbstractModel instance if it is registered in model locator with passed-in key identifier.

Parameters
key:String — Model identifier to return.

Returns
AbstractModel — The model registered with passed-in key or null
getView()method 
public function getView(key:String):AbstractView

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns an AbstractView instance if it is registered in view locator with passed-in key identifier.

Parameters
key:String — View identifier to return.

Returns
AbstractView — The view registered with passed-in key or null
isModelRegistered()method 
public function isModelRegistered(name:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns true if a model is registered in model locator with passed-in name.

Parameters
name:String — Model identifier to search

Returns
Booleantrue if a model is registered in model locator with passed-in name.
isViewRegistered()method 
public function isViewRegistered(name:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns true if a view is registered in view locator with passed-in name.

Parameters
name:String — View identifier to search

Returns
Booleantrue if a view is registered in model locator with passed-in name.
onApplicationInit()method 
public function onApplicationInit():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Triggered when all IoC processing is finished.