| Package | com.asfusion.mate.actionLists |
| Class | public class MessageScope |
| Inheritance | MessageScope  Scope |
MessageScope is an object created by the MessageHandlers.
It represents the running scope of a IActionList.
The IActionList and its actions share this object to transfer data
between them.
| Property | Defined by | ||
|---|---|---|---|
 | currentEvent : Event
Current Event, different from the original event when
a sub-action-list is running.
| Scope | |
| currentTarget : Object
The current target that is using this scope.
| Scope | |
| data : Object
Data Object (holder for custom data)
| Scope | |
| dispatcher : IEventDispatcher
Instance of the
IEventDispatcher that will be used to dispatch events
or to register to events. | Scope | |
| event : Event
Original Event that triggered the
IActionList. | Scope | |
| eventMap : IEventMap
Instance of the
EventMap where this scope lives. | Scope | |
| lastReturn : *
return from the last
IAction run
| Scope | |
| message : IMessage
A message received by the consumer.
| MessageScope | ||
| owner : IActionList
The
IActionList that created this scope. | Scope | |
| running : Boolean = true
Flag that indicates whether
IActionList is running or not. | Scope | |
| Method | Defined by | ||
|---|---|---|---|
|
Constructor
| MessageScope | ||
|
errorString():String
Retuns the default error string to be used by the debugger.
| Scope | |
|
getCurrentTarget():Object
Returns the current target that is using this scope.
| Scope | |
|
getDocument():Object
A reference to the document object associated with this
ILoggerProvider. | Scope | |
|
Returns an
IMateLogger used to log errors. | Scope | |
|
Returns an instance of
IMateManager used to get the logger and dispatcher. | Scope | |
|
isRunning():Boolean
Returns a boolean indicating if the
IActionList is running or not. | Scope | |
|
stopRunning():void
Stops the
IActionList flow. | Scope | |
| message | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var message:IMessageA message received by the consumer.
| MessageScope | () | constructor |
public function MessageScope(event:Event, active:Boolean, map:IEventMap, inheritScope:IScope = null)Constructor
Parametersevent:Event |
|
active:Boolean |
|
map:IEventMap |
|
inheritScope:IScope (default = null) |