jp.progression.core.commands.CommandList

Public Properties

	Property		Defined By
		className : String [read-only] インスタンスのクラス名を取得します。 Indicates the instance className of the Command.	Command
		commands : Array [read-only] 登録されているコマンド配列を取得します。この配列を操作することで元の配列を変更することはできません。	CommandList
		defaultTimeOut : int [static]	Command
		delay : int コマンド実行までの遅延時間（ミリ秒）を取得または設定します。	Command
		enabled : Boolean コマンドが実行可能かどうかを取得または設定します。この値を false に設定した状態で execute() メソッドを実行すると、何も処理を行わずに CommandEvent.COMMAND_COMPLETE イベントを送出します。	Command
		enforcedInterrupting : Boolean [read-only] コマンドが強制中断処理中かどうかを取得します。	Command
		extra : Object [read-only] execute() メソッド実行時に引数として指定されたオブジェクトを取得します。このコマンドが親の CommandList インスタンスによって実行されている場合には、親の extra オブジェクトの内容をコマンド実行順にリレーする形で引き継ぎます。	Command
		group : String インスタンスのグループ名を取得または設定します。 Indicates the instance group of the Command.	Command
		id : String インスタンスの識別子を取得または設定します。 Indicates the instance id of the Command.	Command
		interrupting : Boolean [read-only] コマンドが中断処理中かどうかを取得します。	Command
		latestData : * CommandList 上で、自身より前に実行された外部データ読み込み系のコマンドが持っている外部データを取得します。	Command
		length : int [read-only] コマンドの深度を取得します。	Command
		name : String インスタンスの名前を取得または設定します。 Indicates the instance name of the Command.	Command
		next : Command [read-only] このコマンドが CommandList インスタンスに関連付けられている場合に、次に位置するコマンドを取得します。	Command
		numCommands : int [read-only] 登録されているコマンド数を取得します。	CommandList
		parent : CommandList [read-only] このコマンドを子に含んでいる親の CommandList インスタンスを取得します。	Command
		position : int [read-only] 現在処理しているコマンド位置を取得します。	CommandList
		previous : Command [read-only] このコマンドが CommandList インスタンスに関連付けられている場合に、前に位置するコマンドを取得します。	Command
		root : Command [read-only] コマンドツリー構造の一番上に位置するコマンドを取得します。	Command
		running : Boolean [read-only] コマンドが実行中かどうかを取得します。	Command
		scope : Object コマンド実行処理、および中断処理のタイムアウト時間（ミリ秒）を取得または設定します。指定された時間中に executeComplete() メソッド、もしくは interruptComplete() が実行されなかった場合にエラーが送出されます。この値が 0 に設定されている場合、タイムアウトは発生しません。	Command
		thresholdLength : int [static]	Command
		timeOut : int コマンド実行処理、および中断処理のタイムアウト時間（ミリ秒）を取得または設定します。指定された時間中に executeComplete() メソッド、もしくは interruptComplete() が実行されなかった場合にエラーが送出されます。この値が 0 に設定されている場合、タイムアウトは発生しません。	Command

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		CommandList(executeFunction:Function = null, interruptFunction:Function = null, initObject:Object = null, ... commands) 新しい CommandList インスタンスを作成します。 Creates a new CommandList object.	CommandList
		addCommand(... commands):CommandList 登録されているコマンドの最後尾に新しくコマンドを追加します。	CommandList
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override] イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。このメソッドを使用して登録されたリスナーを removeEventListener() メソッドで削除した場合には、restoreRemovedListeners() メソッドで再登録させることができます。 Register the event listener object into the EventIntegrator instance to get the event notification.	EventIntegrator
		addExclusivelyEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。このメソッドを使用して登録されたリスナーは、IEventIntegrator インスタンスの管理外となるため、removeEventListener() メソッドで削除した場合にも、restoreRemovedListeners() メソッドで再登録させることができません。 Register the event listener object into the EventIntegrator instance to get the event notification.	EventIntegrator
		after(afterFunction:Function, ... afterArgs):Command コマンドの実行完了直後に処理させたい関数を設定します。関数実行時の this 参照は実行しているコマンドインスタンスになります。	Command
		apply(applyFunction:Function, ... applyArgs):Command コマンドに対してすぐに関数を実行します。関数実行時の this 参照は実行しているコマンドインスタンスになります。	Command
		before(beforeFunction:Function, ... beforeArgs):Command コマンドの実行直前に処理させたい関数を設定します。関数実行時の this 参照は実行しているコマンドインスタンスになります。	Command
		clearCommand(completely:Boolean = false):CommandList コマンド登録を解除します。	CommandList
		clone():Command [override] CommandList インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an CommandList subclass.	CommandList
		completelyRemoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventIntegrator インスタンスからリスナーを削除します。このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができません。 Remove the listener from EventIntegrator instance.	EventIntegrator
		dispatchEvent(event:Event):Boolean [override] イベントをイベントフローに送出します。 Dispatches an event into the event flow.	EventIntegrator
		error(errorFunction:Function):Command コマンド実行中に例外エラーが発生した場合に呼び出される関数を設定します。関数実行時の this 参照はエラーが発生したコマンドインスタンスになります。	Command
		execute(extra:Object = null):void コマンドを実行します。	Command
		executeComplete():void 実行中のコマンド処理が完了したことを通知します。このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。	Command
		getCommandById(id:String):Command 指定された id と同じ値が設定されている Command インスタンスを返します。	Command
		getCommandsByGroup(group:String, sort:Boolean = false):Array 指定された group と同じ値を持つ Command インスタンスを含む配列を返します。	Command
		getCommandsByRegExp(fieldName:String, pattern:RegExp, sort:Boolean = false):Array 指定された fieldName が条件と一致する Command インスタンスを含む配列を返します。	Command
		hasEventListener(type:String):Boolean [override] EventIntegrator インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventIntegrator
		hasNextCommand():Boolean 次のコマンドが存在するかどうかを返します。	CommandList
		insertCommand(... commands):CommandList 現在実行中のコマンドの次の位置に新しくコマンドを追加します。	CommandList
		interrupt(enforced:Boolean = false, extra:Object = null):void コマンド処理を中断します。このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。	Command
		interruptComplete():void 実行中のコマンド中断処理が完了したことを通知します。このメソッドを実行するためには、事前に interrupt() メソッドが実行されている必要があります。	Command
		listen(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0):Command コマンド実行中にイベントが発生した場合に呼び出されるリスナー関数を設定します。	Command
		nextCommand():Command 次のコマンドを取得して、処理位置を次に進めます。	CommandList
		removeAllListeners(completely:Boolean = false):void addEventListener() メソッド経由で登録された全てのイベントリスナー登録を削除します。完全に登録を削除しなかった場合には、削除されたイベントリスナーを restoreRemovedListeners() メソッドで復帰させることができます。 Remove the whole event listener registered via addEventListener() method.	EventIntegrator
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override] EventIntegrator インスタンスからリスナーを削除します。このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventIntegrator instance.	EventIntegrator
		reset():void コマンドの処理位置を最初に戻します。	CommandList
		restoreRemovedListeners():void removeEventListener() メソッド、または removeAllListeners() メソッド経由で削除された全てイベントリスナーを再登録します。 Re-register the whole event listener removed via removeEventListener() or removeAllListeners() method.	EventIntegrator
		setProperties(props:Object):Command コマンドに対して、複数のプロパティを一括設定します。	Command
		toString():String [override] 指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.	Command
		willTrigger(type:String):Boolean [override] 指定されたイベントタイプについて、この EventIntegrator インスタンスまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventIntegrator

	Method	Defined By
		_catchError(target:Command, error:Error):void コマンド処理でエラーが発生した場合の処理を行います。エラー処理が発生すると、コマンド処理が停止します。問題を解決し、通常フローに戻す場合には executeComplete() メソッドを、問題が解決されない為に中断処理を行いたい場合には interrupt() メソッドを実行してください。関数内で問題が解決、または中断処理に移行しなかった場合には CommandEvent.COMMAND_ERROR イベントが送出されます。関数実行時の this 参照は実行しているコマンドインスタンスになります。	Command

Summary	Defined By
commandAdded	コマンドがコマンドリストに追加された場合に送出されます。	Command
commandComplete	コマンドの処理が完了した場合に送出されます。	Command
commandError	コマンド処理中にエラーが発生した場合に送出されます。	Command
commandInterrupt	コマンドの処理を停止した場合に送出されます。	Command
commandRemoved	コマンドがコマンドリストから削除された場合に送出されます。	Command
commandStart	コマンドの処理が開始された場合に送出されます。	Command

Property Detail

__length

property

__length:int[override]

Implementation
progression_internal function get __length():int
progression_internal function set __length(value:int):void

__next

property

__next:Command[override]

Implementation
progression_internal function get __next():Command
progression_internal function set __next(value:Command):void

__parent

property

__parent:CommandList[override]

Implementation
progression_internal function get __parent():CommandList
progression_internal function set __parent(value:CommandList):void

__previous

property

__previous:Command[override]

Implementation
progression_internal function get __previous():Command
progression_internal function set __previous(value:Command):void

__root

property

__root:Command[override]

Implementation
progression_internal function get __root():Command
progression_internal function set __root(value:Command):void

commands

property

commands:Array [read-only]

登録されているコマンド配列を取得します。この配列を操作することで元の配列を変更することはできません。

Implementation
public function get commands():Array

numCommands

property

numCommands:int [read-only]

登録されているコマンド数を取得します。

Implementation
public function get numCommands():int

position

property

position:int [read-only]

現在処理しているコマンド位置を取得します。

Implementation
public function get position():int

Constructor Detail

CommandList

()

Constructor

public function CommandList(executeFunction:Function = null, interruptFunction:Function = null, initObject:Object = null, ... commands)

新しい CommandList インスタンスを作成します。 Creates a new CommandList object.

Parameters

	`executeFunction:Function` (default = `null`) — コマンドの実行関数です。

	`interruptFunction:Function` (default = `null`) — コマンドの中断関数です。

	`initObject:Object` (default = `null`) — 設定したいプロパティを含んだオブジェクトです。

	`... commands` — 登録したいコマンドを含む配列です。

Method Detail

addCommand

()

method

public function addCommand(... commands):CommandList

登録されているコマンドの最後尾に新しくコマンドを追加します。

Parameters

... commands — 登録したいコマンドを含む配列です。

Returns

CommandList — 自身の参照です。

clearCommand

()

method

public function clearCommand(completely:Boolean = false):CommandList

コマンド登録を解除します。

Parameters

completely:Boolean (default = false) — true が設定されている場合は登録されている全てのコマンド登録を解除し、false の場合には現在処理中のコマンド以降の登録を解除します。

Returns

CommandList — 自身の参照です。

clone

()

method

override public function clone():Command

CommandList インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an CommandList subclass.

Returns

Command — 元のオブジェクトと同じプロパティ値を含む新しい CommandList インスタンスです。 A new CommandList object that is identical to the original.

hasNextCommand

()

method

public function hasNextCommand():Boolean

次のコマンドが存在するかどうかを返します。

Returns

Boolean — 次のコマンドが存在すれば true を、それ以外の場合には false です。

insertCommand

()

method

public function insertCommand(... commands):CommandList

現在実行中のコマンドの次の位置に新しくコマンドを追加します。

Parameters

... commands — 登録したいコマンドを含む配列です。

Returns

CommandList — 自身の参照です。

nextCommand

()

method

public function nextCommand():Command

次のコマンドを取得して、処理位置を次に進めます。

Returns

Command — 次に位置するコマンドです。

reset

()

method

public function reset():void

コマンドの処理位置を最初に戻します。

Examples

Progression 3.1 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
CommandList	Properties \| Methods \| Events \| Examples

Package	jp.progression.core.commands
Class	public class CommandList
Inheritance	CommandList Command EventIntegrator flash.events.EventDispatcher
Subclasses	ParallelList, SerialList