Packagecom.asfusion.mate.actionLists
Classpublic class Injectors
InheritanceInjectors Inheritance AbstractHandlers Inheritance flash.events.EventDispatcher

An Injectors defined in the EventMap will run whenever an instance of the class specified in the Injectors's "target" argument is created.



Public Properties
 PropertyDefined by
 Inheritedactions : Array
An array of Actions (IAction) contained in this IActionList.
AbstractHandlers
 Inheriteddebug : Boolean
Whether to show debugging information for this IActionList.
AbstractHandlers
 InheriteddispatcherType : String
String that defines whether the dispatcher used by this tag is global or inherit.
AbstractHandlers
  includeDerivatives : Boolean
If this property is true, the injector will inject not only the Class in the target property, but also all the classes that extend from that class.
Injectors
 Inheritedscope : IScope
Returns the current scope for this IActionList
AbstractHandlers
  target : Class
The class that, when an object is created, should trigger the InjectorHandlers to run.
Injectors
  targets : Array
An array of classes that, when an object is created, should trigger the InjectorHandlers to run.
Injectors
Protected Properties
 PropertyDefined by
 InheritedcurrentDispatcher : IEventDispatcher
AbstractHandlers
 InheriteddispatcherTypeChanged : Boolean
Flag indicating whether the dispatcherType has been changed and needs invalidation.
AbstractHandlers
 Inheriteddocument : Object
Internal storage for the document object.
AbstractHandlers
  includeDerivativesChanged : Boolean
Flag indicating if the includeDerivatives property has been changed.
Injectors
 InheritedinheritedScope : IScope
Parent scope that is passed to the IActionList when it is a sub-ActionList.
AbstractHandlers
 Inheritedmanager : IMateManager
Internal instance of IMateManager.
AbstractHandlers
 Inheritedmap : IEventMap
Internal instance of IEventMap.
AbstractHandlers
  targetRegistered : Boolean
Flag indicating if this InjectorHandlers is registered to listen to a target or not.
Injectors
  targetsRegistered : Boolean
Flag indicating if this InjectorHandlers is registered to listen to a target list or not.
Injectors
Public Methods
 MethodDefined by
  
Constructor
Injectors
 Inherited
Unregister as a listener and prepare to be garbage collected
AbstractHandlers
  
errorString():String
Retuns an error String to be used by the debugger.
Injectors
 Inherited
getDocument():Object
A reference to the document object associated with this IActionList.
AbstractHandlers
 Inherited
getGroupId():int
Method to get the group id.
AbstractHandlers
 Inherited
initialized(document:Object, id:String):void
Called automatically by the MXML compiler if the IActionList is set up using a tag.
AbstractHandlers
 Inherited
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.
Injectors
 Inherited
setGroupId(id:int):void
Method to set the group id.
AbstractHandlers
 Inherited
setInheritedScope(inheritedScope:IScope):void
You can pass the parent scope to this IActionList to copy the inherited values.
AbstractHandlers
 Inherited
validateNow():void
Validate and update the properties of this object, if necessary.
AbstractHandlers
Protected Methods
 MethodDefined by
  
Processes the properties set on the component.
Injectors
 Inherited
A handler for the mate dispatcher changed.
AbstractHandlers
  
Called by the dispacher when the event gets triggered.
Injectors
  
This function is a handler for the injection event, if the target it is a derivative class the injection gets triggered
Injectors
  
isDerivative(injectorTarget:Object, targetClass:*):Boolean
Check if the current object is a derivative class and return a boolean value true / false.
Injectors
 Inherited
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
 Inherited
setScope(scope:IScope):void
Set the scope on this IActionList.
AbstractHandlers
  
unregister():void
Unregisters a target or targets.
Injectors
Events
 EventSummaryDefined by
 Inherited
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
 Inherited This event is dispatched right before the list of IActions are called, when the IActionList starts execution.AbstractHandlers
Property detail
includeDerivativesproperty
includeDerivatives:Boolean  [read-write]

If this property is true, the injector will inject not only the Class in the target property, but also all the classes that extend from that class. If the target is an interface, it will inject all the objects that implement the interface.

The default value is false.

Implementation
    public function get includeDerivatives():Boolean
    public function set includeDerivatives(value:Boolean):void
includeDerivativesChangedproperty 
protected var includeDerivativesChanged:Boolean

Flag indicating if the includeDerivatives property has been changed.

targetproperty 
target:Class  [read-write]

The class that, when an object is created, should trigger the InjectorHandlers to run.

The default value is null.

Implementation
    public function get target():Class
    public function set target(value:Class):void
targetRegisteredproperty 
protected var targetRegistered:Boolean

Flag indicating if this InjectorHandlers is registered to listen to a target or not.

targetsproperty 
targets:Array  [read-write]

An array of classes that, when an object is created, should trigger the InjectorHandlers to run.

The default value is true.

Implementation
    public function get targets():Array
    public function set targets(value:Array):void
targetsRegisteredproperty 
protected var targetsRegistered:Boolean

Flag indicating if this InjectorHandlers is registered to listen to a target list or not.

Constructor detail
Injectors()constructor
public function Injectors()

Constructor

Method detail
commitProperties()method
protected override function commitProperties():void

Processes the properties set on the component.

errorString()method 
public override function errorString():String

Retuns an error String to be used by the debugger.

Returns
String
fireEvent()method 
protected function fireEvent(event:InjectorEvent):void

Called by the dispacher when the event gets triggered. This method creates a scope and then runs the sequence.

Parameters
event:InjectorEvent
injectDerivativesHandler()method 
protected function injectDerivativesHandler(event:InjectorEvent):void

This function is a handler for the injection event, if the target it is a derivative class the injection gets triggered

Parameters
event:InjectorEvent
isDerivative()method 
protected function isDerivative(injectorTarget:Object, targetClass:*):Boolean

Check if the current object is a derivative class and return a boolean value true / false.

Parameters
injectorTarget:Object
 
targetClass:*

Returns
Boolean
setDispatcher()method 
public override 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)
unregister()method 
protected function unregister():void

Unregisters a target or targets. Used internally whenever a new target/s is set or dispatcher changes.