Packagecom.asfusion.mate.actionLists
Classpublic class Scope
ImplementsIScope
SubclassesMessageScope, ServiceScope

Scope is an object created by the IActionList.

It represents the running scope of a IActionList. The IActionList and its actions share this object to transfer data between them.


Public Properties
 PropertyDefined 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
  owner : IActionList
The IActionList that created this scope.
Scope
  running : Boolean = true
Flag that indicates whether IActionList is running or not.
Scope
Public Methods
 MethodDefined by
  
Scope(event:Event, active:Boolean, map:IEventMap, inheritScope:IScope = null)
Constructor
Scope
  
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
  
getLogger():IMateLogger
Returns an IMateLogger used to log errors.
Scope
  
getManager():IMateManager
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
Property detail
currentEventproperty
public var currentEvent:Event

Current Event, different from the original event when a sub-action-list is running.

currentTargetproperty 
currentTarget:Object  [read-write]

The current target that is using this scope. This target is usually set by the IActionList before calling trigger on its actions.

Implementation
    public function get currentTarget():Object
    public function set currentTarget(value:Object):void
dataproperty 
data:Object  [read-write]

Data Object (holder for custom data)

Implementation
    public function get data():Object
    public function set data(value:Object):void
dispatcherproperty 
dispatcher:IEventDispatcher  [read-write]

Instance of the IEventDispatcher that will be used to dispatch events or to register to events.

Implementation
    public function get dispatcher():IEventDispatcher
    public function set dispatcher(value:IEventDispatcher):void
eventproperty 
event:Event  [read-write]

Original Event that triggered the IActionList.

Implementation
    public function get event():Event
    public function set event(value:Event):void
eventMapproperty 
eventMap:IEventMap  [read-write]

Instance of the EventMap where this scope lives.

Implementation
    public function get eventMap():IEventMap
    public function set eventMap(value:IEventMap):void
lastReturnproperty 
lastReturn:*  [read-write]

return from the last IAction run

Implementation
    public function get lastReturn():*
    public function set lastReturn(value:*):void
loggerproperty 
mate var logger:IMateLogger

An IMateLogger used to log errors. Similar to Flex ILogger

managerproperty 
mate var manager:IMateManager

Instance of IMateManager used to get the logger and dispatcher.

ownerproperty 
owner:IActionList  [read-write]

The IActionList that created this scope.

Implementation
    public function get owner():IActionList
    public function set owner(value:IActionList):void
runningproperty 
public var running:Boolean = true

Flag that indicates whether IActionList is running or not.

Constructor detail
Scope()constructor
public function Scope(event:Event, active:Boolean, map:IEventMap, inheritScope:IScope = null)

Constructor

Parameters
event:Event
 
active:Boolean
 
map:IEventMap
 
inheritScope:IScope (default = null)
Method detail
errorString()method
public function errorString():String

Retuns the default error string to be used by the debugger.

Returns
String
getCurrentTarget()method 
public function getCurrentTarget():Object

Returns the current target that is using this scope. This target is usually set by the IActionList before calling trigger on its actions.

Returns
Object
getDocument()method 
public function getDocument():Object

A reference to the document object associated with this ILoggerProvider. A document object is an Object at the top of the hierarchy of a Flex application, MXML component, or AS component.

Returns
Object
getLogger()method 
public function getLogger():IMateLogger

Returns an IMateLogger used to log errors. Similar to Flex ILogger

Returns
IMateLogger
getManager()method 
public function getManager():IMateManager

Returns an instance of IMateManager used to get the logger and dispatcher.

Returns
IMateManager
isRunning()method 
public function isRunning():Boolean

Returns a boolean indicating if the IActionList is running or not.

Returns
Boolean
stopRunning()method 
public function stopRunning():void

Stops the IActionList flow. The next IAction will be not be called.