PureMVC.Interfaces.IView Interface Reference

The interface definition for a PureMVC View. More...

Inheritance diagram for PureMVC.Interfaces.IView:

List of all members.

Public Member Functions
void	RegisterObserver (string notificationName, IObserver observer)
void	RemoveObserver (string notificationName, object notifyContext)
	Remove a group of observers from the observer list for a given Notification name.
void	NotifyObservers (INotification note)
	Notify the IObservers for a particular INotification.
void	RegisterMediator (IMediator mediator)
IMediator	RetrieveMediator (string mediatorName)
	Retrieve an IMediator from the View.
IMediator	RemoveMediator (string mediatorName)
	Remove an IMediator from the View.
bool	HasMediator (string mediatorName)
	Check if a Mediator is registered or not.

---

Detailed Description

The interface definition for a PureMVC View.

In PureMVC, IView implementors assume these responsibilities:

• Maintain a cache of IMediator instances
• Provide methods for registering, retrieving, and removing IMediators
• 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

PureMVC.Interfaces.IMediator PureMVC.Interfaces.IObserver PureMVC.Interfaces.INotification

---

Member Function Documentation

bool PureMVC.Interfaces.IView.HasMediator

(

string

mediatorName

)

Check if a Mediator is registered or not.

Parameters:

mediatorName

The name of the IMediator instance to check for

Returns:

whether a Mediator is registered with the given mediatorName.

Implemented in PureMVC.Core.View.

void PureMVC.Interfaces.IView.NotifyObservers

(

INotification

note

)

Notify the IObservers for a particular INotification.

Parameters:

note

The INotification to notify IObservers of

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

Implemented in PureMVC.Core.View.

void PureMVC.Interfaces.IView.RegisterMediator

(

IMediator

mediator

)

Register an IMediator instance with the View

Parameters:

mediator

A a reference to the IMediator instance

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

Implemented in PureMVC.Core.View.

void PureMVC.Interfaces.IView.RegisterObserver	(	string	notificationName,
		IObserver	observer
	)

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

Implemented in PureMVC.Core.View.

IMediator PureMVC.Interfaces.IView.RemoveMediator

(

string

mediatorName

)

Remove an IMediator from the View.

Parameters:

mediatorName

The name of the IMediator instance to be removed

Implemented in PureMVC.Core.View.

void PureMVC.Interfaces.IView.RemoveObserver	(	string	notificationName,
		object	notifyContext
	)

Remove a group of observers from the observer list for a given Notification name.

Parameters:

	notificationName	which observer list to remove from
	notifyContext	removed the observers with this object as their notifyContext

Implemented in PureMVC.Core.View.

IMediator PureMVC.Interfaces.IView.RetrieveMediator

(

string

mediatorName

)

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

Implemented in PureMVC.Core.View.

---

The documentation for this interface was generated from the following file:

• PureMVC/Interfaces/IView.cs