system.process.TaskGroup

	Property	Defined By
		changeIt : Signaler This signal emit when the notifyChanged method is invoked.	CoreAction
		clearIt : Signaler This signal emit when the notifyCleared method is invoked.	CoreAction
		finishIt : Signaler This signal emit when the notifyFinished method is invoked.	Task
		fixed : Boolean Indicates whether the group length is fixed (true) or can be changed (false).	TaskGroup
		infoIt : Signaler This signal emit when the notifyInfo method is invoked.	CoreAction
		length : uint Indicates the numbers of actions register in the task-group.	TaskGroup
		logger : Logger Determinates the internal Logger reference of this Loggable object.	Task
		looping : Boolean The flag to determinate if the Action object is looped.	CoreAction
		loopIt : Signaler This signal emit when the notifyLooped method is invoked.	CoreAction
		mode : String Determinates the mode of the group.	TaskGroup
		pauseIt : Signaler This signal emit when the notifyPause method is invoked.	CoreAction
		phase : String [read-only] The current phase of the action.	Task
		progressIt : Signaler This signal emit when the notifyProgress method is invoked.	CoreAction
		resumeIt : Signaler This signal emit when the notifyResumed method is invoked.	CoreAction
		running : Boolean [read-only] Indicates true if the process is in progress.	Task
		startIt : Signaler This signal emit when the notifyStarted method is invoked.	Task
		stopIt : Signaler This signal emit when the notifyStopped method is invoked.	CoreAction
		stopped : Boolean [read-only] Indicates if the group is stopped.	TaskGroup
		timeoutIt : Signaler This signal emit when the notifyTimeOut method is invoked.	CoreAction
		verbose : Boolean Defines the verbose mode of the task group (use it in the toString() method)	TaskGroup

	Method	Defined By
		TaskGroup(length:uint = 0, fixed:Boolean = false, mode:String = normal, actions:* = null) Creates a new TaskGroup instance.	TaskGroup
		addAction(action:Action, priority:int = 0, autoRemove:Boolean = false):Boolean Adds an Action in the task-group.	TaskGroup
		clone():* [override] Returns a shallow copy of this object.	TaskGroup
		dispose():void Dispose the task-group and disconnect all actions but don't remove them.	TaskGroup
		getActionAt(index:uint):Action Returns the action register in the task group at the specified index value or null.	TaskGroup
		hasAction(action:Action):Boolean Returns true if the specified Action is register in the task-group.	TaskGroup
		isEmpty():Boolean Returns true if the task-group is empty.	TaskGroup
		isLocked():Boolean Returns true if the object is locked.	Task
		lock():void Locks the object.	Task
		notifyChanged():void Notify when the process is changed.	CoreAction
		notifyCleared():void Notify when the process is cleared.	CoreAction
		notifyFinished():void Notify an ActionEvent when the process is finished.	Task
		notifyInfo(info:*):void Notify a specific information when the process is changed.	CoreAction
		notifyLooped():void Notify when the process is looped.	CoreAction
		notifyPaused():void Notify when the process is paused.	CoreAction
		notifyProgress():void Notify when the process is in progress.	CoreAction
		notifyResumed():void Notify when the process is resumed.	CoreAction
		notifyStarted():void Notify an ActionEvent when the process is started.	Task
		notifyStopped():void Notify when the process is stopped.	CoreAction
		notifyTimeOut():void Notify when the process is out of time.	CoreAction
		removeAction(action:Action = null):Boolean Remove a specific action register in the task group and if the passed-in argument is null all actions register in the chain are removed.	TaskGroup
		resume():void Resume the task group.	TaskGroup
		run(... arguments):void Run the process.	Task
		setup(length:uint = 0, fixed:Boolean = false):void Sets the internal Vector of the group.	TaskGroup
		start():void Starts the chain.	TaskGroup
		stop():void Stops the task group.	TaskGroup
		toArray():Array Returns the Array representation of the object.	TaskGroup
		toString():String Returns the String representation of the object.	TaskGroup
		toVector(fixed:Boolean = false):Vector.<Action> Returns the Vector (of Action) representation of the chain.	TaskGroup
		unlock():void Unlocks the display.	Task

	Method	Defined By
		next(action:Action = null):void Invoked when a task is finished.	TaskGroup
		setRunning(b:Boolean):void Changes the running property value.	Task

	Constant	Defined By
		EVERLASTING : String = everlasting [static] Determinates the "everlasting" mode of the task-group.	TaskGroup
		NORMAL : String = normal [static] Determinates the "normal" mode of the task-group.	TaskGroup
		TRANSIENT : String = transient [static] Determinates the "transient" mode of the task-group.	TaskGroup

Property Detail

fixed

property

fixed:Boolean

Indicates whether the group length is fixed (true) or can be changed (false). This value can also be set using the fixed property.

Implementation
public function get fixed():Boolean
public function set fixed(value:Boolean):void

length

property

length:uint

Indicates the numbers of actions register in the task-group.

Implementation
public function get length():uint
public function set length(value:uint):void

mode

property

mode:String

Determinates the mode of the group. The mode can be "normal", "transient" or "everlasting".

Implementation
public function get mode():String
public function set mode(value:String):void

See also

TaskGroup.EVERLASTING, TaskGroup.TRANSIENT

stopped

property

stopped:Boolean [read-only]

Indicates if the group is stopped.

Implementation
public function get stopped():Boolean

verbose

property

public var verbose:Boolean

Defines the verbose mode of the task group (use it in the toString() method)

Constructor Detail

TaskGroup

()

Constructor

public function TaskGroup(length:uint = 0, fixed:Boolean = false, mode:String = normal, actions:* = null)

Creates a new TaskGroup instance.

Parameters

	`length:uint` (default = `0`) — The initial length (number of elements) of the Vector. If this parameter is greater than zero, the specified number of Vector elements are created and populated with the default value appropriate to the base type (null for reference types).

	`fixed:Boolean` (default = `false`) — Whether the chain length is fixed (true) or can be changed (false). This value can also be set using the fixed property.

	`mode:String` (default = `normal`) — Specifies the mode of the chain. The mode can be "normal" (default), "transient" or "everlasting".

	`actions:*` (default = `null`) — A dynamic object who contains Action references to initialize the chain.

Method Detail

addAction

()

method

public function addAction(action:Action, priority:int = 0, autoRemove:Boolean = false):Boolean

Adds an Action in the task-group.

Parameters

	`action:Action` — Determinates the priority level of the action in the chain. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority. All actions with priority n are processed before actions of priority n-1. If two or more actions share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`priority:int` (default = `0`) — Apply a removeAction after the first finish notification.

	`autoRemove:Boolean` (default = `false`)

Returns

Boolean — true if the insert is success.

clone

()

method

override public function clone():*

Returns a shallow copy of this object.

Returns

* — a shallow copy of this object.

dispose

()

method

public function dispose():void

Dispose the task-group and disconnect all actions but don't remove them.

getActionAt

()

method

public function getActionAt(index:uint):Action

Returns the action register in the task group at the specified index value or null.

Parameters

index:uint

Returns

Action — the action register in the task group at the specified index value or null.

hasAction

()

method

public function hasAction(action:Action):Boolean

Returns true if the specified Action is register in the task-group.

Parameters

action:Action

Returns

Boolean — true if the specified Action is register in the task-group.

isEmpty

()

method

public function isEmpty():Boolean

Returns true if the task-group is empty.

Returns

Boolean — true if the task-group is empty.

()

method

protected function next(action:Action = null):void

Invoked when a task is finished.

Parameters

action:Action (default = null)

removeAction

()

method

public function removeAction(action:Action = null):Boolean

Remove a specific action register in the task group and if the passed-in argument is null all actions register in the chain are removed. If the chain is running the stop() method is called.

Parameters

action:Action (default = null)

Returns

Boolean — true if the method success.

resume

()

method

public function resume():void

Resume the task group.

setup

()

method

public function setup(length:uint = 0, fixed:Boolean = false):void

Sets the internal Vector of the group.

Parameters

	`length:uint` (default = `0`) — The initial length (number of elements) of the Vector. If this parameter is greater than zero, the specified number of Vector elements are created and populated with the default value appropriate to the base type (null for reference types).

	`fixed:Boolean` (default = `false`) — Whether the chain length is fixed (true) or can be changed (false). This value can also be set using the fixed property.

start

()

method

public function start():void

Starts the chain.

stop

()

method

public function stop():void

Stops the task group.

toArray

()

method

public function toArray():Array

Returns the Array representation of the object.

Returns

Array — the Array representation of the object.

toString

()

method

public function toString():String

Returns the String representation of the object.

Returns

String — the String representation of the object.

toVector

()

method

public function toVector(fixed:Boolean = false):Vector.<Action>

Returns the Vector (of Action) representation of the chain.

Parameters

fixed:Boolean (default = false)

Returns

Vector.<Action> — the Vector (of Action) representation of the chain.

Constant Detail

EVERLASTING

Constant

public static const EVERLASTING:String = everlasting

Determinates the "everlasting" mode of the task-group. In this mode the action register in the task-group can't be auto-remove.

NORMAL

Constant

public static const NORMAL:String = normal

Determinates the "normal" mode of the task-group. In this mode the task-group has a normal life cycle.

TRANSIENT

Constant

public static const TRANSIENT:String = transient

Determinates the "transient" mode of the task-group. In this mode all actions are strictly auto-remove in the task-group when are invoked.

Mardi Août 16 2011, 02:33 PM +02:00

VEGAS AS3 Reference	All Packages \| All Classes \| Index \| Frames No Frames
TaskGroup	Properties \| Methods \| Constants

Package	system.process
Class	public class TaskGroup
Inheritance	TaskGroup CoreAction Task Object
Implements	Resumable, Startable, Stoppable
Subclasses	BatchTask, Chain