| Package | org.puremvc.as3.multicore.patterns.observer |
| Class | public class Notifier |
| Implements | INotifier |
| Subclasses | MacroCommand, Mediator, Proxy, SimpleCommand |
INotifier implementation.
MacroCommand, Command, Mediator and Proxy
all have a need to send Notifications.
The INotifier interface provides a common method called
sendNotification that relieves implementation code of
the necessity to actually construct Notifications.
The Notifier class, which all of the above mentioned classes
extend, provides an initialized reference to the Facade
Multiton, which is required for the convienience method
for sending Notifications, but also eases implementation as these
classes have frequent Facade interactions and usually require
access to the facade anyway.
NOTE: In the MultiCore version of the framework, there is one caveat to notifiers, they cannot send notifications or reach the facade until they have a valid multitonKey. The multitonKey is set: on a Command when it is executed by the Controller on a Mediator is registered with the View on a Proxy is registered with the Model.
See also
| Property | Defined by | ||
|---|---|---|---|
| facade : IFacade
[read-only]
| Notifier | ||
| multitonKey : String | Notifier | ||
| Method | Defined by | ||
|---|---|---|---|
|
initializeNotifier(key:String):void
Initialize this INotifier instance.
| Notifier | ||
|
sendNotification(notificationName:String, body:Object = null, type:String = null):void
Create and send an
INotification. | Notifier | ||
| Constant | Defined by | ||
|---|---|---|---|
| MULTITON_MSG : String = "multitonKey for this Notifier not yet initialized!" | Notifier | ||
| facade | property |
| multitonKey | property |
protected var multitonKey:String
| initializeNotifier | () | method |
public function initializeNotifier(key:String):voidInitialize this INotifier instance.
This is how a Notifier gets its multitonKey. Calls to sendNotification or to access the facade will fail until after this method has been called.
Mediators, Commands or Proxies may override this method in order to send notifications or access the Multiton Facade instance as soon as possible. They CANNOT access the facade in their constructors, since this method will not yet have been called.
Parameterskey:String — the multitonKey for this INotifier to use
|
| sendNotification | () | method |
public function sendNotification(notificationName:String, body:Object = null, type:String = null):void
Create and send an INotification.
Keeps us from having to construct new INotification instances in our implementation code.
ParametersnotificationName:String — the name of the notiification to send
|
|
body:Object (default = null) |
|
type:String (default = null) |
| MULTITON_MSG | constant |
protected const MULTITON_MSG:String = "multitonKey for this Notifier not yet initialized!"