puremvc :: patterns :: observer :: Notification :: Class Notification
[hide private]
[frames] | no frames]

Class Notification

source code

              object --+    
                       |    
interfaces.INotification --+
                           |
                          Notification

A base INotification implementation.

PureMVC does not rely upon underlying event models such as the one provided with Flash, and ActionScript 3 does not have an inherent event model.

The Observer Pattern as implemented within PureMVC exists to support event-driven communication between the application and the actors of the MVC triad.

Notifications are not meant to be a replacement for Events in Flex/Flash/Apollo. Generally, IMediator implementors place event listeners on their view components, which they then handle in the usual way. This may lead to the broadcast of Notifications to trigger ICommands or to communicate with other IMediators. IProxy and ICommand instances communicate with each other and IMediators by broadcasting INotifications.

A key difference between Flash Events and PureMVC Notifications is that Events follow the 'Chain of Responsibility' pattern, 'bubbling' up the display hierarchy until some parent component handles the Event, while PureMVC Notifications follow a 'Publish/Subscribe' pattern. PureMVC classes need not be related to each other in a parent/child relationship in order to communicate with one another using Notifications.


See Also: Observer

Instance Methods [hide private]
 
__init__(self, name, body=None, noteType=None)
Constructor.
source code
 
__repr__(self)
Get the string representation of the Notification instance.
source code
 
getName(self)
Get the name of the Notification instance.
source code
 
setBody(self, body)
Set the body of the Notification instance.
source code
 
getBody(self)
Get the body of the Notification instance.
source code
 
setType(self, notificationType)
Set the type of the Notification instance.
source code
 
getType(self)
Get the type of the Notification instance.
source code

Inherited from interfaces.INotification: str

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Instance Variables [hide private]
  name
The body of the notification instance
  body
The type of the notification instance
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name, body=None, noteType=None)
(Constructor)

source code 

Constructor.

Parameters:
  • name - name of the Notification instance. (required)
  • body - the Notification body. (optional)
  • noteType - the type of the Notification (optional)
Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 

Get the string representation of the Notification instance.

Returns:
the string representation of the Notification instance.
Overrides: object.__repr__

getName(self)

source code 

Get the name of the Notification instance.

Returns:
the name of the Notification instance.
Overrides: interfaces.INotification.getName

setBody(self, body)

source code 

Set the body of the Notification instance.

Overrides: interfaces.INotification.setBody

getBody(self)

source code 

Get the body of the Notification instance.

Returns:
the body object.
Overrides: interfaces.INotification.getBody

setType(self, notificationType)

source code 

Set the type of the Notification instance.

Overrides: interfaces.INotification.setType

getType(self)

source code 

Get the type of the Notification instance.

Returns:
the type
Overrides: interfaces.INotification.getType