| Package | com.adobe.cairngorm.task |
| Class | public class TaskGroup |
| Inheritance | TaskGroup  Task flash.events.EventDispatcher |
| Implements | ITaskGroup |
| Subclasses | ParallelTask, SequenceTask |
children and
size properties.
Default MXML Propertychildren
| Property | Defined By | ||
|---|---|---|---|
| children : Array | TaskGroup | ||
 | currentState : String [read-only] | Task | |
| enabled : Boolean | Task | |
| label : String | Task | |
| processed : uint [read-only] | TaskGroup | ||
| size : uint [read-only] | TaskGroup | ||
| Method | Defined By | ||
|---|---|---|---|
| TaskGroup | |||
| TaskGroup | |||
removeChild(child:ITask):void | TaskGroup | ||
| start():void | Task | |
| Method | Defined By | ||
|---|---|---|---|
| complete():void
This should be called by a concrete sub-class to indicate that the
task has been completed. | Task | |
| fault(message:String = null):void
This should be called by a concrete sub-class to indicate that the task
has been halted due to a fault. | Task | |
onChildTaskComplete(event:TaskEvent):void
This event handler is called whenever a child task completes. | TaskGroup | ||
onChildTaskFault(event:TaskEvent):void
This event handler is called whenever a child task fails. | TaskGroup | ||
onChildTaskStart(event:TaskEvent):void
This event handler is called whenever a child task is started. | TaskGroup | ||
| performTask():void
This abstract template method must be implemented by a concrete
sub-class to perform the task associated with the task. | Task | |
processChild(child:ITask):Boolean
Processes the specified child by starting it if it is enabled or
skipping it if it is disabled. | TaskGroup | ||
| children | property |
Hide Inherited Public Properties
Show Inherited Public Propertieschildren:Array public function get children():Array public function set children(value:Array):void| processed | property |
processed:uint [read-only] This property can be used as the source for data binding.
public function get processed():uint| size | property |
size:uint [read-only] This property can be used as the source for data binding.
public function get size():uint| TaskGroup | () | Constructor |
public function TaskGroup()| addChild | () | method |
| onChildTaskComplete | () | method |
protected function onChildTaskComplete(event:TaskEvent):void
This event handler is called whenever a child task completes. It
can be overridden, but the super.onChildTaskComplete()
method should be called.
Parameters
event:TaskEvent |
| onChildTaskFault | () | method |
protected function onChildTaskFault(event:TaskEvent):void
This event handler is called whenever a child task fails. It
can be overridden, but the super.onChildTaskFault() method
should be called.
Parameters
event:TaskEvent |
| onChildTaskStart | () | method |
protected function onChildTaskStart(event:TaskEvent):void
This event handler is called whenever a child task is started. It
can be overridden, but the super.onChildTaskStart() method
should be called.
Parameters
event:TaskEvent |
| processChild | () | method |
protected function processChild(child:ITask):BooleanProcesses the specified child by starting it if it is enabled or skipping it if it is disabled.
Parameters
child:ITask — the child task to start processing
|
Boolean —
true if the child task is started or false if it is skipped
|
| removeChild | () | method |
| childComplete | Event |
| childFault | Event |
| childStart | Event |
| taskProgress | Event |