| Package | com.developmentarc.framework.controllers.interfaces |
| Interface | public interface ITask extends flash.events.IEventDispatcher |
| Subinterfaces | ITaskGroup |
| Implementors | AbstractTask, TaskGroup |
| Property | Defined by | ||
|---|---|---|---|
| isBlocker : Boolean [read-only]
Defines if the Task is a blocking task.
| ITask | ||
| phase : String [read-only]
Returns the current phase of of the Task.
| ITask | ||
| priority : uint [read-only]
Returns the priority value of the Task.
| ITask | ||
| ready : Boolean [read-only]
Used to define the ready state of the Task.
| ITask | ||
| selfOverride : Boolean
Defines of if the Task overrides the same type of task that already have
been added to a queue.
| ITask | ||
| taskOverrides : Array [read-only]
Returns an array of Task types that this task will override when added
to the TaskController or a TaskGroup.
| ITask | ||
| type : String [read-only]
Returns the type value of the Task.
| ITask | ||
| uid : Object [read-only]
A unique identification value assigned to the task.
| ITask | ||
| Method | Defined by | ||
|---|---|---|---|
|
cancel():void
Used to cancel a task.
| ITask | ||
|
ignore():void
Used to put the task in ignore mode.
| ITask | ||
|
inQueue():void
Used to set the task state to queued.
| ITask | ||
|
inWaitingForReady():void
Used to put the Task in waiting for ready mode.
| ITask | ||
|
pause():void
Used to pause a started task.
| ITask | ||
|
start():void
Used to start the task when it becomes active.
| ITask | ||
| isBlocker | property |
isBlocker:Boolean [read-only]Defines if the Task is a blocking task. A Blocking task prevents any other tasks in the queue from executing until this task is completed.
Implementation public function get isBlocker():Boolean
| phase | property |
phase:String [read-only]Returns the current phase of of the Task.
Implementation public function get phase():String
| priority | property |
priority:uint [read-only]Returns the priority value of the Task. Zero being the highest priority and uint.MAX_VALUE being the lowest.
Implementation public function get priority():uint
| ready | property |
ready:Boolean [read-only]Used to define the ready state of the Task. If true the task is ready to be started, if false the task is not ready to be started.
Implementation public function get ready():Boolean
| selfOverride | property |
selfOverride:Boolean [read-write]Defines of if the Task overrides the same type of task that already have been added to a queue. When a task is self-overriding and is added to the Task Controller or Task Group, the controller/group reviews the existing task queue and then removes any exisiting task that have the same type and uid as the new task that is being added.
Implementation public function get selfOverride():Boolean
public function set selfOverride(value:Boolean):void
| taskOverrides | property |
taskOverrides:Array [read-only]Returns an array of Task types that this task will override when added to the TaskController or a TaskGroup.
Implementation public function get taskOverrides():Array
| type | property |
type:String [read-only]Returns the type value of the Task. This defines what type of task the object represents. This is similar to the Event.type property.
Implementation public function get type():String
| uid | property |
uid:Object [read-only]A unique identification value assigned to the task. This value allows for self overriding task to know if they are both the same type and identification.
Implementation public function get uid():Object
| cancel | () | method |
public function cancel():voidUsed to cancel a task.
| ignore | () | method |
public function ignore():voidUsed to put the task in ignore mode.
| inQueue | () | method |
public function inQueue():voidUsed to set the task state to queued.
| inWaitingForReady | () | method |
public function inWaitingForReady():voidUsed to put the Task in waiting for ready mode.
| pause | () | method |
public function pause():voidUsed to pause a started task.
| start | () | method |
public function start():voidUsed to start the task when it becomes active.