| Package | com.adobe.cairngorm.task |
| Interface | public interface ITask extends flash.events.IEventDispatcher |
| Implementors | Task |
start() method is
called. If the task completes successfully, the taskComplete
event is dispatched, if a fault occurs then the taskFault
event is dispatched. During progressing taskProgress events
are dispatched. The granularity of these depends on the concrete
implementation.
| Property | Defined By | ||
|---|---|---|---|
| currentState : String [read-only]
Gets the current state of the task. | ITask | ||
| enabled : Boolean
Enables or disables the taskgroup task. | ITask | ||
| label : String
A label associated with the task. | ITask | ||
| Method | Defined By | ||
|---|---|---|---|
start():void
Starts processing the task-item. | ITask | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the currentState property has changed value. | ITask | |||
| Dispatched when the task has been completed. | ITask | |||
| Dispatched when a fault has occurred while performing the task. | ITask | |||
| Dispatched when the task has started after the start() method of the task has been invoked. | ITask | |||
| currentState | property |
currentState:String [read-only]
Gets the current state of the task. The values are defined as
constants on the TaskState class.
public function get currentState():String| enabled | property |
enabled:BooleanEnables or disables the taskgroup task. Only enabled task group tasks will be processed.
public function get enabled():Boolean public function set enabled(value:Boolean):void| label | property |
label:StringA label associated with the task.
public function get label():String public function set label(value:String):void| start | () | method |
public function start():voidStarts processing the task-item.
| currentStateChange | Event |
mx.events.StateChangeEvent
Dispatched when the currentState property has changed value.
| taskComplete | Event |
| taskFault | Event |
com.adobe.cairngorm.task.TaskEventDispatched when a fault has occurred while performing the task.
| taskStart | Event |
com.adobe.cairngorm.task.TaskEvent
Dispatched when the task has started after the start() method
of the task has been invoked.