| Package | system.process |
| Class | public class Chain |
| Inheritance | Chain TaskGroup CoreAction Task Object |
Example :
package examples
{
import system.events.ActionEvent;
import system.process.Action;
import system.process.Chain;
import system.process.Pause;
import flash.display.Sprite;
[SWF(width="740", height="480", frameRate="24", backgroundColor="#666666")]
public class ChainBasicExample extends Sprite
{
public function ChainBasicExample()
{
var chain:Chain = new Chain() ;
chain.addEventListener( ActionEvent.FINISH , debug ) ;
chain.addEventListener( ActionEvent.PROGRESS , debug ) ;
chain.addEventListener( ActionEvent.START , debug ) ;
chain.finishIt.connect( finish ) ;
chain.progressIt.connect( progress ) ;
chain.startIt.connect( start ) ;
chain.addAction( new Pause(1) ) ;
chain.addAction( new Pause(1) ) ;
chain.addAction( new Pause(1) ) ;
chain.run() ;
}
public function debug( e:ActionEvent ):void
{
trace( "debug " + e.type ) ;
}
public function finish( action:Action ):void
{
trace( "finish" ) ;
}
public function progress( action:Action ):void
{
trace( "progress : " + (action as Chain).current ) ;
}
public function start( action:Action ):void
{
trace( "start" ) ;
}
}
}
| Property | Defined By | ||
|---|---|---|---|
![]() | changeIt : Signaler
This signal emit when the notifyChanged method is invoked. | CoreAction | |
![]() | clearIt : Signaler
This signal emit when the notifyCleared method is invoked. | CoreAction | |
| current : Action [read-only]
Indicates the current Action reference when the chain process is running. | Chain | ||
| currentLoop : uint [read-only]
Indicates the current countdown loop value. | Chain | ||
![]() | finishIt : Signaler
This signal emit when the notifyFinished method is invoked. | Task | |
![]() | fixed : Boolean
Indicates whether the group length is fixed (true) or can be changed (false). | TaskGroup | |
![]() | infoIt : Signaler
This signal emit when the notifyInfo method is invoked. | CoreAction | |
![]() | length : uint
Indicates the numbers of actions register in the task-group. | TaskGroup | |
![]() | logger : Logger
Determinates the internal Logger reference of this Loggable object. | Task | |
![]() | looping : Boolean
The flag to determinate if the Action object is looped. | CoreAction | |
![]() | loopIt : Signaler
This signal emit when the notifyLooped method is invoked. | CoreAction | |
![]() | mode : String
Determinates the mode of the group. | TaskGroup | |
| numLoop : uint
Specifies the number of the times the chain should loop during playback. | Chain | ||
![]() | pauseIt : Signaler
This signal emit when the notifyPause method is invoked. | CoreAction | |
![]() | phase : String [read-only]
The current phase of the action. | Task | |
| position : uint [read-only]
Indicates the current numeric position of the chain. | Chain | ||
![]() | progressIt : Signaler
This signal emit when the notifyProgress method is invoked. | CoreAction | |
![]() | resumeIt : Signaler
This signal emit when the notifyResumed method is invoked. | CoreAction | |
![]() | running : Boolean [read-only]
Indicates true if the process is in progress. | Task | |
![]() | startIt : Signaler
This signal emit when the notifyStarted method is invoked. | Task | |
![]() | stopIt : Signaler
This signal emit when the notifyStopped method is invoked. | CoreAction | |
![]() | stopped : Boolean [read-only]
Indicates if the group is stopped. | TaskGroup | |
![]() | timeoutIt : Signaler
This signal emit when the notifyTimeOut method is invoked. | CoreAction | |
![]() | verbose : Boolean
Defines the verbose mode of the task group (use it in the toString() method)
| TaskGroup | |
| Method | Defined By | ||
|---|---|---|---|
Chain(length:uint = 0, fixed:Boolean = false, looping:Boolean = false, numLoop:uint = 0, mode:String = normal, actions:* = null)
Creates a new Chain instance. | Chain | ||
![]() |
Adds an Action in the task-group. | TaskGroup | |
clone():* [override]
Returns a shallow copy of this object. | Chain | ||
![]() | dispose():void
Dispose the task-group and disconnect all actions but don't remove them. | TaskGroup | |
element():*
Retrieves the next action reference in the chain with the current position. | Chain | ||
![]() | getActionAt(index:uint):Action
Returns the action register in the task group at the specified index value or null. | TaskGroup | |
![]() |
Returns true if the specified Action is register in the task-group. | TaskGroup | |
hasNext():Boolean
Indicates if the chain contains a next action (based with the current position value). | Chain | ||
![]() | isEmpty():Boolean
Returns true if the task-group is empty. | TaskGroup | |
![]() | isLocked():Boolean
Returns true if the object is locked. | Task | |
![]() | lock():void
Locks the object. | Task | |
![]() | notifyChanged():void
Notify when the process is changed. | CoreAction | |
![]() | notifyCleared():void
Notify when the process is cleared. | CoreAction | |
![]() | notifyFinished():void
Notify an ActionEvent when the process is finished. | Task | |
![]() | notifyInfo(info:*):void
Notify a specific information when the process is changed. | CoreAction | |
![]() | notifyLooped():void
Notify when the process is looped. | CoreAction | |
![]() | notifyPaused():void
Notify when the process is paused. | CoreAction | |
![]() | notifyProgress():void
Notify when the process is in progress. | CoreAction | |
![]() | notifyResumed():void
Notify when the process is resumed. | CoreAction | |
![]() | notifyStarted():void
Notify an ActionEvent when the process is started. | Task | |
![]() | notifyStopped():void
Notify when the process is stopped. | CoreAction | |
![]() | notifyTimeOut():void
Notify when the process is out of time. | CoreAction | |
![]() | removeAction(action:Action = null):Boolean
Remove a specific action register in the task group and if the passed-in argument is null all actions register in the chain are removed. | TaskGroup | |
resume():void [override]
Resume the chain. | Chain | ||
run(... arguments):void [override]
Launchs the chain process. | Chain | ||
![]() | setup(length:uint = 0, fixed:Boolean = false):void
Sets the internal Vector of the group. | TaskGroup | |
![]() | start():void
Starts the chain. | TaskGroup | |
stop():void [override]
Stops the chain. | Chain | ||
![]() | toArray():Array
Returns the Array representation of the object. | TaskGroup | |
![]() | toString():String
Returns the String representation of the object. | TaskGroup | |
![]() |
Returns the Vector (of Action) representation of the chain. | TaskGroup | |
![]() | unlock():void
Unlocks the display. | Task | |
| Method | Defined By | ||
|---|---|---|---|
[override]
Run the next action in the chain. | Chain | ||
![]() | setRunning(b:Boolean):void
Changes the running property value. | Task | |
| Constant | Defined By | ||
|---|---|---|---|
| EVERLASTING : String = everlasting [static]
Determinates the "everlasting" mode of the chain. | Chain | ||
| NORMAL : String = normal [static]
Determinates the "normal" mode of the chain. | Chain | ||
| TRANSIENT : String = transient [static]
Determinates the "transient" mode of the chain. | Chain | ||
| current | property |
current:Action [read-only] Indicates the current Action reference when the chain process is running.
public function get current():Action| currentLoop | property |
currentLoop:uint [read-only] Indicates the current countdown loop value.
public function get currentLoop():uint| numLoop | property |
public var numLoop:uintSpecifies the number of the times the chain should loop during playback.
| position | property |
position:uint [read-only] Indicates the current numeric position of the chain.
public function get position():uint| Chain | () | Constructor |
public function Chain(length:uint = 0, fixed:Boolean = false, looping:Boolean = false, numLoop:uint = 0, mode:String = normal, actions:* = null)Creates a new Chain instance.
Parameterslength:uint (default = 0) — The initial length (number of elements) of the Vector. If this parameter is greater than zero, the specified number of Vector elements are created and populated with the default value appropriate to the base type (null for reference types).
| |
fixed:Boolean (default = false) — Whether the chain length is fixed (true) or can be changed (false). This value can also be set using the fixed property.
| |
looping:Boolean (default = false) — Specifies whether playback of the clip should continue, or loop (default false).
| |
numLoop:uint (default = 0) — Specifies the number of the times the presentation should loop during playback.
| |
mode:String (default = normal) — Specifies the mode of the chain. The mode can be "normal" (default), "transient" or "everlasting".
| |
actions:* (default = null) — A dynamic object who contains Action references to initialize the chain.
|
| clone | () | method |
override public function clone():*Returns a shallow copy of this object.
Returns* — a shallow copy of this object.
|
| element | () | method |
public function element():*Retrieves the next action reference in the chain with the current position.
Returns* |
| hasNext | () | method |
public function hasNext():BooleanIndicates if the chain contains a next action (based with the current position value).
ReturnsBoolean |
| next | () | method |
override protected function next(action:Action = null):voidRun the next action in the chain.
Parameters
action:Action (default = null) |
| resume | () | method |
override public function resume():voidResume the chain.
| run | () | method |
override public function run(... arguments):voidLaunchs the chain process.
Parameters
... arguments |
| stop | () | method |
override public function stop():voidStops the chain. Stop only the current action if is running.
| EVERLASTING | Constant |
public static const EVERLASTING:String = everlastingDeterminates the "everlasting" mode of the chain. In this mode the action register in the chain can't be auto-remove.
| NORMAL | Constant |
public static const NORMAL:String = normalDeterminates the "normal" mode of the chain. In this mode the chain has a normal life cycle.
| TRANSIENT | Constant |
public static const TRANSIENT:String = transientDeterminates the "transient" mode of the chain. In this mode all actions are strictly auto-remove in the chain when are invoked.