Class View

A Singleton View implementation.

In PureMVC, the View class assumes these responsibilities:

  • Maintain a cache of Mediator instances.
  • Provide methods for registering, retrieving, and removing Mediators.
  • Notifying Mediators when they are registered or removed.
  • Managing the observer lists for each Notification in the application.
  • Providing a method for attaching Observers to a Notification's observer list.
  • Providing a method for broadcasting a Notification.
  • Notifying the Observers of a given Notification when it broadcast.

See

View

Implements

Constructors

constructor

Properties

mediatorMap observerMap instance SINGLETON_MSG

Methods

hasMediator notifyObservers registerMediator registerObserver removeMediator removeObserver retrieveMediator getInstance

Constructors

constructor

  • new View(): View

  • Constructor.

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

    Returns View

    Throws

    Error if instance for this Singleton key has already been constructed

Properties

ProtectedmediatorMap

mediatorMap: {
    [key: string]: IMediator;
}

Mapping of Mediator names to Mediator instances

ProtectedobserverMap

observerMap: {
    [key: string]: IObserver[];
}

Mapping of Notification names to Observer lists

Protected Staticinstance

instance: IView

Singleton instance

Protected StaticSINGLETON_MSG

SINGLETON_MSG: string = "View Singleton already constructed!"

Message Constants

Methods

hasMediator

  • hasMediator(mediatorName): boolean

  • Check if a Mediator is registered or not

    Parameters

    • mediatorName: string

      The name of the mediator to check.

    Returns boolean

    true if a mediator with the specified name is registered; otherwise, false.

notifyObservers

  • notifyObservers(notification): void

  • Notify the Observers for a particular Notification.

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

    Parameters

    • notification: INotification

      The notification containing the data or command details to be sent to observers.

    Returns void

registerMediator

  • registerMediator(mediator): void

  • Register a Mediator instance with the View.

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

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

    Parameters

    • mediator: IMediator

      The mediator instance to be registered.

    Returns void

registerObserver

  • registerObserver(notificationName, observer): void

  • Register an Observer to be notified of Notifications with a given name.

    Parameters

    • notificationName: string

      The name of the notification to which the observer should be registered.

    • observer: IObserver

      The observer instance to be registered.

    Returns void

removeMediator

  • removeMediator(mediatorName): null | IMediator

  • Remove a Mediator from the View.

    Parameters

    • mediatorName: string

      The name of the mediator to be removed.

    Returns null | IMediator

    The removed mediator instance, or null if no mediator with the given name was found.

removeObserver

  • removeObserver(notificationName, notifyContext): void

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

    Parameters

    • notificationName: string

      The name of the notification for which the observer should be removed.

    • notifyContext: object

      The context of the observer to be removed.

    Returns void

retrieveMediator

  • retrieveMediator(mediatorName): null | IMediator

  • Retrieve a Mediator from the View.

    Parameters

    • mediatorName: string

      The name of the mediator to retrieve.

    Returns null | IMediator

    The mediator instance associated with the given name, or null if no such mediator exists.

StaticgetInstance

  • getInstance(factory): IView

  • View Singleton factory method.

    Parameters

    • factory: (() => IView)

      A factory function that creates a new instance of the view if one does not already exist.

    Returns IView

    The view instance.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods