Packagecom.bourre.plugin
Classpublic final class NullPlugin
ImplementsPlugin

Player version: Flash Player 9.0
Language version: ActionScript 3.0

The NullPlugin class defines a default plugin to use if none is defined current application.

Can be used to allow Front controller, locators and event channel concept on non IoC application.


Public Methods
 MethodDefined by
  
fireExternalEvent(e:Event, channel:EventChannel):void
Fires events using dedicated event channel.
NullPlugin
  
firePrivateEvent(e:Event):void
Fires events using private ( internal ) event channel.
NullPlugin
  
firePublicEvent(e:Event):void
Fires events using public event channel.
NullPlugin
  
getChannel():EventChannel
Returns plugin's event channel.
NullPlugin
  
getInstance():NullPlugin
[static] Returns singleton instance of NullPlugin class.
NullPlugin
  
getLogger():PluginDebug
NullPlugin
  
getModel(key:String):AbstractModel
Returns an AbstractModel instance if it is registered in model locator with passed-in key identifier.
NullPlugin
  
getView(key:String):AbstractView
Returns an AbstractView instance if it is registered in view locator with passed-in key identifier.
NullPlugin
  
isModelRegistered(key:String):Boolean
NullPlugin
  
isViewRegistered(key:String):Boolean
Returns true if a view is registered in view locator with passed-in name.
NullPlugin
  
onApplicationInit():void
Triggered when all IoC processing is finished.
NullPlugin
  
toString():String
Returns the string representation of this instance.
NullPlugin
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
getInstance()method 
public static function getInstance():NullPlugin

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns singleton instance of NullPlugin class.

Returns
NullPlugin — The singleton instance of NullPlugin class.
getLogger()method 
public function getLogger():PluginDebug

Player version: Flash Player 9.0
Language version: ActionScript 3.0

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(key:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Parameters
key:String

Returns
Boolean
isViewRegistered()method 
public function isViewRegistered(key: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
key:String — View identifier to search

Returns
Boolean — true 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.

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



Submit Feedback
LowRA API documentation 2008- 2009
Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1
mer. févr. 25 2009, 9:22 AM GMT+01:00