PureMVC Framework for Haxe: API Documentation
Back | Index
interface org.puremvc.haxe.interfaces.IMediator

The interface definition for a PureMVC Mediator.

In PureMVC, `IMediator` implementors assume these responsibilities:

- Implement a common method which returns a list of all `INotification`s the `IMediator` has interest in.
- Implement a common notification (callback) method.

Additionally, `IMediator`s typically:

- Act as an intermediary between one or more view components such as text boxes or list controls, maintaining references and coordinating their behavior.
- In Flash-based apps, this is often the place where event listeners are added to view components, and their handlers implemented.
- Respond to and generate `INotifications`, interacting with of the rest of the PureMVC app.

When an `IMediator` is registered with the `IView`, the `IView` will call the `IMediator`'s `listNotificationInterests` method. The `IMediator` will return an `Array` of `INotification` names which it wishes to be notified about.

The `IView` will then create an `Observer` object encapsulating that `IMediator`'s (`handleNotification`) method and register it as an Observer for each `INotification` name returned by `listNotificationInterests`.

function getMediatorName() : String
  Get the `IMediator` instance name
function getViewComponent() : Dynamic
  Get the `IMediator`'s view component.
function handleNotification(notification : INotification) : Void
  Handle an `INotification`.
function listNotificationInterests() : Array<String>
  List `INotification` interests.
function onRegister() : Void
  Called by the `View` when the `Mediator` is registered
function onRemove() : Void
  Called by the `View` when the `Mediator` is removed
function setViewComponent(viewComponent : Dynamic) : Void
  Set the `IMediator`'s view component.

Back | Index