| Package | com.developmentarc.framework.controllers.interfaces |
| Interface | public interface ITaskGroup extends ITask, flash.events.IEventDispatcher |
| Implementors | TaskGroup |
See also
| Property | Defined by | ||
|---|---|---|---|
| hasTask : Boolean [read-only]
Defines if the current group has any tasks in the queue.
| ITaskGroup | ||
 | isBlocker : Boolean
Defines if the Task is a blocking task.
| ITask | |
| phase : String
Returns the current phase of of the Task.
| ITask | |
| priority : uint
Returns the priority value of the Task.
| ITask | |
| ready : Boolean
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
Returns an array of Task types that this task will override when added
to the TaskController or a TaskGroup.
| ITask | |
| tasks : Array
Returns an Array of ITasks that are in the group.
| ITaskGroup | ||
| type : String
Returns the type value of the Task.
| ITask | |
| uid : Object
A unique identification value assigned to the task.
| ITask | |
| Method | Defined by | ||
|---|---|---|---|
|
Used to add a task to the task group implementation.
| ITaskGroup | ||
|
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 | |
|
Looks up and returns the next ITask in the group.
| ITaskGroup | ||
|
pause():void
Used to pause a started task.
| ITask | |
|
removeAllTasks():void
Used to remove all the ITasks from the group.
| ITaskGroup | ||
|
removeTask(task:ITask):void
Removes the requested task from the group if the task exists.
| ITaskGroup | ||
|
start():void
Used to start the task when it becomes active.
| ITask | |
| hasTask | property |
Hide Inherited Public Properties
Show Inherited Public PropertieshasTask:Boolean [read-only]Defines if the current group has any tasks in the queue.
Implementation public function get hasTask():Boolean
| tasks | property |
tasks:Array [read-write]Returns an Array of ITasks that are in the group.
Implementation public function get tasks():Array
public function set tasks(value:Array):void
| addTask | () | method |
public function addTask(task:ITask):voidUsed to add a task to the task group implementation.
Parameterstask:ITask — The task to add to the group.
|
| next | () | method |
public function next():ITaskLooks up and returns the next ITask in the group.
ReturnsITask —
The next ITask in the group.
|
| removeAllTasks | () | method |
public function removeAllTasks():voidUsed to remove all the ITasks from the group.
| removeTask | () | method |
public function removeTask(task:ITask):voidRemoves the requested task from the group if the task exists.
Parameterstask:ITask — The task to remove.
|