PureMVC AS3 Framework - [Standard Version] | All Packages | All Classes | Index | Frames No Frames |
Interface IView

Package | org.puremvc.as3.interfaces
Interface | public interface IView
Implementors | View

The interface definition for a PureMVC View.

In PureMVC, `IView` implementors assume these responsibilities:

In PureMVC, the `View` class assumes 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.

See also

IMediator
IObserver
INotification

Public Methods

| Method | Defined by
--- | --- | ---
|  | hasMediator(mediatorName:String):Boolean Check if a Mediator is registered or not | IView
|  | notifyObservers(note:INotification):void Notify the `IObservers` for a particular `INotification`. | IView
|  | registerMediator(mediator:IMediator):void Register an `IMediator` instance with the `View`. | IView
|  | registerObserver(noteName:String, observer:IObserver):void Register an `IObserver` to be notified of `INotifications` with a given name. | IView
|  | removeMediator(mediatorName:String):IMediator Remove an `IMediator` from the `View`. | IView
|  | retrieveMediator(mediatorName:String):IMediator Retrieve an `IMediator` from the `View`. | IView

Method detail

hasMediator | () | method

`public function hasMediator(mediatorName:String):Boolean`

Check if a Mediator is registered or not

Parameters

| `mediatorName:String`

Returns

| `Boolean` — whether a Mediator is registered with the given `mediatorName`.

notifyObservers | () | method |

`public function notifyObservers(note:INotification):void`

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

| `note:INotification` — the `INotification` to notify `IObservers` of.

registerMediator | () | method |

`public function registerMediator(mediator:IMediator):void`

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:IMediator` — the name to associate with this `IMediator` instance

registerObserver | () | method |

`public function registerObserver(noteName:String, observer:IObserver):void`

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

Parameters

| `noteName:String` — the name of the `INotifications` to notify this `IObserver` of
| `observer:IObserver` — the `IObserver` to register

removeMediator | () | method |

`public function removeMediator(mediatorName:String):IMediator`

Remove an `IMediator` from the `View`.

Parameters

| `mediatorName:String` — name of the `IMediator` instance to be removed.

Returns

| `IMediator` — the `IMediator` that was removed from the `View`

retrieveMediator | () | method |

`public function retrieveMediator(mediatorName:String):IMediator`

Retrieve an `IMediator` from the `View`.

Parameters

| `mediatorName:String` — the name of the `IMediator` instance to retrieve.

Returns

| `IMediator` — the `IMediator` instance previously registered with the given `mediatorName`.