Packageorg.mvcexpress.mvc
Classpublic class Proxy
InheritanceProxy Inheritance Object

Proxy holds and manages application data, provide API to work with it. Can send messages. (Usually sends one with each data update)


Protected Properties
 PropertyDefined By
  isReady : Boolean
[read-only] Indicates if proxy is ready for usage.
Proxy
  proxyMap : IProxyMap
Interface to work with proxies.
Proxy
Public Methods
 MethodDefined By
  
Proxy()
CONSTRUCTOR
Proxy
Protected Methods
 MethodDefined By
  
onRegister():void
Then proxy is mapped with proxyMap this function is called.
Proxy
  
onRemove():void
Then proxy is unmapped with proxyMap this function is called.
Proxy
  
sendMessage(type:String, params:Object = null):void
Sends a message with optional params object inside of current module.
Proxy
  
sendScopeMessage(scopeName:String, type:String, params:Object = null):void
Sends scoped module to module message, all modules that are listening to specified scopeName and message type will get it.
Proxy
Property Detail
isReadyproperty
isReady:Boolean  [read-only]

Indicates if proxy is ready for usage. (all dependencies are injected.)


Implementation
    protected function get isReady():Boolean
proxyMapproperty 
protected var proxyMap:IProxyMap

Interface to work with proxies.

Constructor Detail
Proxy()Constructor
public function Proxy()

CONSTRUCTOR

Method Detail
onRegister()method
protected function onRegister():void

Then proxy is mapped with proxyMap this function is called.

onRemove()method 
protected function onRemove():void

Then proxy is unmapped with proxyMap this function is called.

sendMessage()method 
protected function sendMessage(type:String, params:Object = null):void

Sends a message with optional params object inside of current module.

Parameters

type:String — type of the message for Commands or Mediator's handle function to react to.
 
params:Object (default = null) — Object that will be passed to Command execute() function or to handle functions.

sendScopeMessage()method 
protected function sendScopeMessage(scopeName:String, type:String, params:Object = null):void

Sends scoped module to module message, all modules that are listening to specified scopeName and message type will get it.

Parameters

scopeName:String — both sending and receiving modules must use same scope to make module to module communication.
 
type:String — type of the message for Commands or Mediator's handle function to react to.
 
params:Object (default = null) — Object that will be passed to Command execute() function and to handle functions.





Sun Feb 3 2013, 10:47 AM +01:00