Package puremvc :: Module core :: Class View
[hide private]
[frames] | no frames]

type View

source code

          object --+
                   |
interfaces.IView --+
                   |
                  View

A Singleton IView implementation.

In PureMVC, the View class assumes these responsibilities:

Maintain a cache of IMediator instances.

Provide methods for registering, retrieving, and removing IMediators.

Notifiying IMediators when they are registered or removed.

Managing the observer lists for each INotification in the application.

Providing a method for attaching IObservers to an INotification's observer list.

Providing a method for broadcasting an INotification.

Notifying the IObservers of a given INotification when it broadcast.


See Also:
Mediator, Observer, Notification
Instance Methods [hide private]
 
initializeView(self)
Initialize the Singleton View instance.
source code
 
registerObserver(self, notificationName, observer)
Register an IObserver to be notified of INotifications with a given name.
source code
 
notifyObservers(self, notification)
Notify the IObservers for a particular INotification.
source code
 
removeObserver(self, notificationName, notifyContext)
Remove the observer for a given notifyContext from an observer list for a given Notification name.
source code
 
registerMediator(self, mediator)
Register an IMediator instance with the View.
source code
 
retrieveMediator(self, mediatorName)
Retrieve an IMediator from the View.
source code
 
removeMediator(self, mediatorName)
Remove an IMediator from the View.
source code
 
hasMediator(self, mediatorName)
Check if a Mediator is registered or not
source code
Static Methods [hide private]
 
__new__(cls, *args, **kwargs)
This iView implementation is a Singleton, so you should not call the constructor directly, but instead call the static Singleton method View.getInstance()
source code
 
getInstance()
View Singleton Static method.
source code
Class Variables [hide private]
  instance = None
  observerMap = None
  mediatorMap = None
Method Details [hide private]

__new__(cls, *args, **kwargs)
Static Method

source code 

This iView implementation is a Singleton, so you should not call the constructor directly, but instead call the static Singleton method View.getInstance()

Overrides: object.__new__

getInstance()
Static Method

source code 

View Singleton Static method.

Returns:
the Singleton instance of View

initializeView(self)

source code 

Initialize the Singleton View instance.

Called automatically by the constructor.

registerObserver(self, notificationName, observer)

source code 

Register an IObserver to be notified of INotifications with a given name.

Parameters:
  • notificationName - the name of the INotifications to notify this IObserver of
  • observer - the IObserver to register
Overrides: interfaces.IView.registerObserver

notifyObservers(self, notification)

source code 

Notify the IObservers for a particular INotification.

All previously attached IObservers for this INotification's list are notified and are passed a reference to the INotification in the order in which they were registered.

Parameters:
  • notification - the INotification to notify IObservers of.
Overrides: interfaces.IView.notifyObservers

removeObserver(self, notificationName, notifyContext)

source code 

Remove the observer for a given notifyContext from an observer list for a given Notification name.

Parameters:
  • notificationName - which observer list to remove from
  • notifyContext - remove the observer with this object as its notifyContext

registerMediator(self, mediator)

source code 

Register an IMediator instance with the View.

Registers the IMediator so that it can be retrieved by name, and further interrogates the IMediator for its INotification interests.

If the IMediator returns any INotification names to be notified about, an Observer is created encapsulating the IMediator instance's handleNotification method and registering it as an Observer for all INotifications the IMediator is interested in.

Parameters:
  • mediator - a reference to the IMediator instance
Overrides: interfaces.IView.registerMediator

retrieveMediator(self, mediatorName)

source code 

Retrieve an IMediator from the View.

Parameters:
  • mediatorName - the name of the IMediator instance to retrieve.
Returns:
the IMediator instance previously registered with the given mediatorName.
Overrides: interfaces.IView.retrieveMediator

removeMediator(self, mediatorName)

source code 

Remove an IMediator from the View.

Parameters:
  • mediatorName - name of the IMediator instance to be removed.
Returns:
the IMediator that was removed from the View
Overrides: interfaces.IView.removeMediator

hasMediator(self, mediatorName)

source code 

Check if a Mediator is registered or not

Parameters:
  • mediatorName - the name of the IMediator
Returns:
whether a Mediator is registered with the given mediatorName.
Overrides: interfaces.IView.hasMediator