Packagecom.asfusion.mate.actionLists
Classpublic class AbstractHandlers
InheritanceAbstractHandlers Inheritance flash.events.EventDispatcher
ImplementsIActionList, mx.core.IMXMLObject
SubclassesEventHandlers, Injectors, MessageHandlers

AbstractHandlers is a base class for all the IActionList implementations.

Default MXML Propertyactions



Public Properties
 PropertyDefined by
  actions : Array
An array of Actions (IAction) contained in this IActionList.
AbstractHandlers
  debug : Boolean
Whether to show debugging information for this IActionList.
AbstractHandlers
  dispatcherType : String
String that defines whether the dispatcher used by this tag is global or inherit.
AbstractHandlers
  scope : IScope
[read-only] Returns the current scope for this IActionList
AbstractHandlers
Protected Properties
 PropertyDefined by
  currentDispatcher : IEventDispatcher
AbstractHandlers
  dispatcherTypeChanged : Boolean
Flag indicating whether the dispatcherType has been changed and needs invalidation.
AbstractHandlers
  document : Object
Internal storage for the document object.
AbstractHandlers
  inheritedScope : IScope
Parent scope that is passed to the IActionList when it is a sub-ActionList.
AbstractHandlers
  manager : IMateManager
Internal instance of IMateManager.
AbstractHandlers
  map : IEventMap
Internal instance of IEventMap.
AbstractHandlers
Public Methods
 MethodDefined by
  
Constructor
AbstractHandlers
  
Unregister as a listener and prepare to be garbage collected
AbstractHandlers
  
errorString():String
Retuns an error String to be used by the debugger.
AbstractHandlers
  
getDocument():Object
A reference to the document object associated with this IActionList.
AbstractHandlers
  
getGroupId():int
Method to get the group id.
AbstractHandlers
  
initialized(document:Object, id:String):void
Called automatically by the MXML compiler if the IActionList is set up using a tag.
AbstractHandlers
  
Marks a component so that its commitProperties method gets called during a later screen update.
AbstractHandlers
  
setDispatcher(value:IEventDispatcher, local:Boolean = true):void
A method that allows setting the dispatcher that this IActionList will use to register to events.
AbstractHandlers
  
setGroupId(id:int):void
Method to set the group id.
AbstractHandlers
  
setInheritedScope(inheritedScope:IScope):void
You can pass the parent scope to this IActionList to copy the inherited values.
AbstractHandlers
  
validateNow():void
Validate and update the properties of this object, if necessary.
AbstractHandlers
Protected Methods
 MethodDefined by
  
Processes the properties set on the component.
AbstractHandlers
  
A handler for the mate dispatcher changed.
AbstractHandlers
  
runSequence(scope:IScope, actionList:Array):void
Goes over all the listeners (IActions) and calls the method trigger on them, passing the scope as an argument.
AbstractHandlers
  
setScope(scope:IScope):void
Set the scope on this IActionList.
AbstractHandlers
Events
 EventSummaryDefined by
  
end
This event is dispatched right after all the IActions have been called, when the IActionList ends execution (although this event might be dispatched before asynchronous calls have returned).AbstractHandlers
   This event is dispatched right before the list of IActions are called, when the IActionList starts execution.AbstractHandlers
Property detail
actionsproperty
actions:Array  [read-write]

An array of Actions (IAction) contained in this IActionList. The Actions are processed in the order in which they were added.

Implementation
    public function get actions():Array
    public function set actions(value:Array):void
currentDispatcherproperty 
protected var currentDispatcher:IEventDispatcher
debugproperty 
debug:Boolean  [read-write]

Whether to show debugging information for this IActionList. If true, Console output will show debugging information as this IActionList runs.

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

The IActionList registers itself as an event listener of the dispatcher specified in this property. By the default, this dispatcher is the Application. dispatcher property only available when using mate namespace

The default value is Application.application.

Implementation
    mate function get dispatcher():IEventDispatcher
    mate function set dispatcher(value:IEventDispatcher):void
dispatcherTypeproperty 
dispatcherType:String  [read-write]

String that defines whether the dispatcher used by this tag is global or inherit. If it is inherit, the dispatcher used is the dispatcher provided by the EventMap where this tag lives.

Implementation
    public function get dispatcherType():String
    public function set dispatcherType(value:String):void
dispatcherTypeChangedproperty 
protected var dispatcherTypeChanged:Boolean

Flag indicating whether the dispatcherType has been changed and needs invalidation.

documentproperty 
protected var document:Object

Internal storage for the document object.

inheritedScopeproperty 
protected var inheritedScope:IScope

Parent scope that is passed to the IActionList when it is a sub-ActionList.

managerproperty 
protected var manager:IMateManager

Internal instance of IMateManager.

mapproperty 
protected var map:IEventMap

Internal instance of IEventMap.

scopeproperty 
scope:IScope  [read-only]

Returns the current scope for this IActionList

This property can be used as the source for data binding.

Implementation
    public function get scope():IScope
Constructor detail
AbstractHandlers()constructor
public function AbstractHandlers()

Constructor

Method detail
clearReferences()method
public function clearReferences():void

Unregister as a listener and prepare to be garbage collected

commitProperties()method 
protected function commitProperties():void

Processes the properties set on the component.

dispatcherChangeHandler()method 
protected function dispatcherChangeHandler(event:DispatcherEvent):void

A handler for the mate dispatcher changed. This method is called by IMateManager when the dispatcher changes.

Parameters
event:DispatcherEvent
errorString()method 
public function errorString():String

Retuns an error String to be used by the debugger.

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

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

Returns
Object
getGroupId()method 
public function getGroupId():int

Method to get the group id.

Returns
int
initialized()method 
public function initialized(document:Object, id:String):void

Called automatically by the MXML compiler if the IActionList is set up using a tag.

Parameters
document:Object
 
id:String
invalidateProperties()method 
public function invalidateProperties():void

Marks a component so that its commitProperties method gets called during a later screen update.

Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update.

runSequence()method 
protected function runSequence(scope:IScope, actionList:Array):void

Goes over all the listeners (IActions) and calls the method trigger on them, passing the scope as an argument. It also dispatches the start and end sequence events.

Parameters
scope:IScope
 
actionList:Array
setDispatcher()method 
public function setDispatcher(value:IEventDispatcher, local:Boolean = true):void

A method that allows setting the dispatcher that this IActionList will use to register to events.

Parameters
value:IEventDispatcher
 
local:Boolean (default = true)
setGroupId()method 
public function setGroupId(id:int):void

Method to set the group id. This property associates a group of handlers under the same id

Parameters
id:int
setInheritedScope()method 
public function setInheritedScope(inheritedScope:IScope):void

You can pass the parent scope to this IActionList to copy the inherited values.

Parameters
inheritedScope:IScope
setScope()method 
protected function setScope(scope:IScope):void

Set the scope on this IActionList.

Parameters
scope:IScope
validateNow()method 
public function validateNow():void

Validate and update the properties of this object, if necessary. Processing properties that require substantial computation are normally not processed until the script finishes executing. Delaying the processing prevents it from being repeated multiple times if the script sets the value of the property more than once. This method lets you manually override this behavior.

Event detail
endevent 
Event object type: com.asfusion.mate.events.ActionListEvent

This event is dispatched right after all the IActions have been called, when the IActionList ends execution (although this event might be dispatched before asynchronous calls have returned).

startevent  
Event object type: com.asfusion.mate.events.ActionListEvent

This event is dispatched right before the list of IActions are called, when the IActionList starts execution.