| Package | org.mvcexpress.base |
| Class | public class MediatorMap |
| Inheritance | MediatorMap  Object |
| Implements | IMediatorMap |
| Subclasses | FlexMediatorMap |
| Property | Defined By | ||
|---|---|---|---|
| classRegistry : Dictionary | MediatorMap | ||
| mediatorRegistry : Dictionary | MediatorMap | ||
| messenger : Messenger | MediatorMap | ||
| proxyMap : ProxyMap | MediatorMap | ||
| Method | Defined By | ||
|---|---|---|---|
CONSTRUCTOR | MediatorMap | ||
isMapped(viewClass:Class, mediatorClass:Class):Boolean
Checks if mediator class is mapped to view class. | MediatorMap | ||
isMediated(viewObject:Object):Boolean
Checks if view object is mediated. | MediatorMap | ||
listMappings():String
Returns String of all view classes that are mapped to mediator classes. | MediatorMap | ||
map(viewClass:Class, mediatorClass:Class):void
Maps mediator class to view class. | MediatorMap | ||
mediate(viewObject:Object):void
Mediates provided viewObject with mapped mediator. | MediatorMap | ||
unmap(viewClass:Class):void
Unmaps any mediator class to given view class. | MediatorMap | ||
unmediate(viewObject:Object):void
If any mediator is mediating viewObject: it calls onRemove on that object, automatically removes all handler functions listening for messages from that mediator and deletes it. | MediatorMap | ||
| classRegistry | property |
protected var classRegistry:Dictionary| mediatorRegistry | property |
protected var mediatorRegistry:Dictionary| messenger | property |
protected var messenger:Messenger| proxyMap | property |
protected var proxyMap:ProxyMap| MediatorMap | () | Constructor |
public function MediatorMap(messenger:Messenger, proxyMap:ProxyMap)CONSTRUCTOR
Parametersmessenger:Messenger | |
proxyMap:ProxyMap |
| isMapped | () | method |
public function isMapped(viewClass:Class, mediatorClass:Class):BooleanChecks if mediator class is mapped to view class.
Parameters
viewClass:Class — view class that has to be mediated by mediator class then mediate(viewObject) is called.
| |
mediatorClass:Class — Mediator class that will be instantiated then viewClass object is passed to mediate function.
|
Boolean — true if view class is already mapped to mediator class.
|
| isMediated | () | method |
public function isMediated(viewObject:Object):BooleanChecks if view object is mediated.
Parameters
viewObject:Object — View object to check if it is mediated.
|
Boolean |
| listMappings | () | method |
public function listMappings():StringReturns String of all view classes that are mapped to mediator classes.
ReturnsString — Text with all mapped mediators.
|
| map | () | method |
public function map(viewClass:Class, mediatorClass:Class):voidMaps mediator class to view class. Only one mediator class can mediate single instance of view class.
Parameters
viewClass:Class — view class that has to be mediated by mediator class then mediate() is called.
| |
mediatorClass:Class — mediator class that will be instantiated then viewClass object is passed to mediate() function.
|
| mediate | () | method |
public function mediate(viewObject:Object):voidMediates provided viewObject with mapped mediator. Automatically instantiates mediator class(if mapped), handles all injections(including viewObject), and calls onRegister function. Throws error if mediator class is not mapped to viewObject class.
Parameters
viewObject:Object — view object to mediate.
|
| unmap | () | method |
public function unmap(viewClass:Class):voidUnmaps any mediator class to given view class.
Parameters
viewClass:Class — view class to remove mapped mediator class from.
|
| unmediate | () | method |
public function unmediate(viewObject:Object):voidIf any mediator is mediating viewObject: it calls onRemove on that object, automatically removes all handler functions listening for messages from that mediator and deletes it.
Parameters
viewObject:Object — view object witch mediator will be destroyed.
|