org.spicefactory.lib.task.util.CommandTask

Package	org.spicefactory.lib.task.util
Class	public class CommandTask
Inheritance	CommandTask Task flash.events.EventDispatcher

Task implementation that wraps a synchronous Command. Useful if you need to add some kind of synchronous operation to a TaskGroup.

Public Properties

	Property		Defined by
		cancelable : Boolean Indicates whether this Task can be cancelled.	Task
		context : * An arbitrary value associated with this Task.	Task
		parent : TaskGroup The parent of this Task.	Task
		restartable : Boolean Indicates whether this Task can be restarted.	Task
		skippable : Boolean Indicates whether this Task can be forced to skip to its final state.	Task
		state : TaskState The current state of this Task.	Task
		suspendable : Boolean Indicates whether this Task can be suspended.	Task
		timeout : uint The timeout for this Task in milliseconds.	Task

Public Methods

	Method		Defined by
		CommandTask(command:Command, name:String = "[CommandTask]") Creates a new Task that wraps the specified synchronous Command.	CommandTask
		cancel():Boolean Cancels this Task.	Task
		resume():Boolean Resumes this Task if it is suspended.	Task
		skip():Boolean Forces this Task to move to its final state.	Task
		start():Boolean Starts this Task.	Task
		suspend():Boolean Suspends this Task.	Task

Protected Methods

	Method		Defined by
		complete():Boolean Signals that this Task has completed.	Task
		doCancel():void Called before the `CANCEL` event gets fired.	Task
		doError(message:String):void Called before the `ERROR` event gets fired.	Task
		doResume():void Called before the `RESUME` event gets fired.	Task
		doSkip():void Called after `skip` has been called but before the `COMPLETE` event gets fired.	Task
		doStart():void Called before the `START` event gets fired.	Task
		doSuspend():void Called before the `SUSPEND` event gets fired.	Task
		doTimeout():void Called before the `ERROR` event gets fired after a timeout occurred.	Task
		error(message:String):Boolean Signals an error condition and cancels the Task.	Task
		setCancelable(value:Boolean):void Specifies whether this Task can be cancelled.	Task
		setName(name:String):void Sets the name of this Task.	Task
		setRestartable(value:Boolean):void Specifies whether this Task can be restarted.	Task
		setSkippable(value:Boolean):void Specifies whether this Task can be forced to skip to its final state.	Task
		setSuspendable(value:Boolean):void Specifies whether this Task can be suspended.	Task
		setTimeout(value:uint):void Sets the timeout for this Task in milliseconds.	Task

Events

	Summary	Defined by
cancel	Dispatched when a Task is cancelled.	Task
complete	Dispatched when a Task has completed its execution.	Task
error	Dispatched when a Task has aborted due to an error condition.	Task
resume	Dispatched when a suspended Task is resumed.	Task
start	Dispatched when a Task is started.	Task
suspend	Dispatched when a Task is suspended.	Task

Constructor detail

CommandTask

()

constructor

public function CommandTask(command:Command, name:String = "[CommandTask]")

Creates a new Task that wraps the specified synchronous Command.

Parameters

	`command:Command` — the Command to execute when the Task is started

	`name:String` (default = "`[CommandTask]`") — an optional name for this CommandTask for log output

Spicelib AS3 API	All Packages \| All Classes \| Index \| Frames No Frames
Class CommandTask	Properties \| Methods \| Events