| Package | jp.progression.commands.lists |
| Class | public class LoopList |
| Inheritance | LoopList  SerialList CommandList Command flash.events.EventDispatcher |
| Implements | IRepeatable |
// LoopList インスタンスを作成する var list:LoopList = new LoopList(); // コマンドを登録する list.addCommand( new Trace( "実行します" ), new Wait( 1 ), // このループの 5 周のこの位置で停止させる new Stop( 5 ) ); // コマンドを実行する list.execute();
| Property | Defined by | ||
|---|---|---|---|
 | catchError : Function
コマンドの実行中に例外が発生した際に実行するエラー処理関数を取得または設定します。
| Command | |
| className : String
インスタンスのクラス名を取得します。
Indicates the instance className of the Command.
| Command | |
| commands : Array
子コマンドインスタンスが保存されている配列です。
この配列を操作することで元の配列を変更することはできません。
| CommandList | |
| count : int [read-only]
現在のループ処理回数を取得します。
| LoopList | ||
| defaultInterruptType : int [static]
interruptType プロパティの初期値を取得または設定します。
すでに生成済みのコマンドに対しては適用されません。
| Command | |
| defaultTimeout : Number [static]
timeout プロパティの初期値を取得または設定します。
すでに生成済みのコマンドに対しては適用されません。
| Command | |
| delay : Number
コマンドが実際に実行されるまでの遅延時間を取得または設定します。
コマンド実行中に値を変更しても、処理に対して反映されません。
| Command | |
| depth : int
コマンドツリー構造上での自身の深度を取得します。
| Command | |
| extra : Object
コマンドの実行処理、または中断処理の開始時に指定されているリレーオブジェクトを取得または設定します。
このコマンドが親の CommandList インスタンスによって実行されている場合には、親のリレーオブジェクトを順々に引き継ぎます。
| Command | |
| group : String
インスタンスのグループ名を取得または設定します。
Indicates the instance group of the Command.
| Command | |
| id : String
インスタンスを表すユニークな識別子を取得または設定します。
| Command | |
| interruptType : int
中断処理時の処理方法を取得または設定します。
コマンド実行中に値を変更しても、処理に対して反映されません。
| Command | |
| latestData : *
自身から見て最後に関連付けられた読み込みデータを取得または設定します。
このコマンドが CommandList インスタンス上に存在する場合には、自身より前、または自身の親のデータを取得します。
| Command | |
| name : String
インスタンスの名前を取得または設定します。
Indicates the instance name of the Command.
| Command | |
| next : Command
このコマンドが関連付けられている親の CommandList インスタンス内で、次に位置する Command インスタンスを取得します。
| Command | |
| numCommands : int
子として登録されているコマンド数を取得します。
| CommandList | |
| onComplete : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_COMPLETE イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
| Command | |
| onError : Function
コマンドオブジェクトが ExecuteErrorEvent.EXECUTE_ERROR イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
| Command | |
| onInterrupt : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_INTERRUPT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
| Command | |
| onPosition : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_POSITION イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
| SerialList | |
| onStart : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_START イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
| Command | |
| parent : CommandList
この Command オブジェクトを含む CommandList オブジェクトを示します。
Indicates the CommandList object that contains this Command object.
| Command | |
| position : int
現在処理しているコマンド位置を取得または設定します。
| CommandList | |
| previous : Command
このコマンドが関連付けられている親の CommandList インスタンス内で、一つ前に位置する Command インスタンスを取得します。
| Command | |
| repeatCount : int
実行したいループ処理数を取得または設定します。
この値が 0 に設定されている場合には、stop() メソッドで終了させるまで処理し続けます。
コマンド実行中に値を変更しても、処理に対して反映されません。
| LoopList | ||
| root : Command
コマンドツリー構造の一番上に位置する Command インスタンスを取得します。
| Command | |
| scope : Object
コマンドの実行処理、または中断処理に指定されている関数内でのスコープ対象を取得または設定します。
| Command | |
| state : int
コマンドの実行状態を取得します。
| Command | |
| thresholdLength : int [static]
同一プロセス上で実行可能な最大コマンド数を取得または設定します。
設定された閾値を超えて実行された場合には、強制的に 1 ミリ秒の遅延を発生させます。
この値が大きすぎる場合、スタックオーバーフローが発生する可能性があります。
| Command | |
| timeout : Number
コマンドの実行中のタイムアウト時間を取得または設定します。
指定された時間中に executeComplete() メソッド、または interrupt() メソッドが実行されなかった場合にはエラーが送出されます。
この値が 0 に設定されている場合、タイムアウト処理は発生しません。
| Command | |
| Method | Defined by | ||
|---|---|---|---|
|
LoopList(repeatCount:int = 0, initObject:Object = null, ... commands)
新しい LoopList インスタンスを作成します。
Creates a new LoopList object.
| LoopList | ||
|
addCommand(... commands):void
登録されているコマンドの最後尾に新しくコマンドを追加します。
関数を指定した場合には、自動的に Func コマンドに変換され、
数値を指定した場合には、自動的に Wait コマンドに変換され、
配列を指定した場合には、自動的に ParallelList コマンドに変換され、
それ以外の値は、全て自動的に Trace コマンドに変換されます。
| SerialList | |
|
clearCommand(completely:Boolean = false):void
コマンドインスタンスをリストから削除します。
| CommandList | |
|
LoopList インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。
Duplicates an instance of an LoopList subclass.
| LoopList | ||
|
dispose():void
保持しているデータを解放します。
| LoopList | ||
|
execute(extra:Object = null):void
コマンド処理を実行します。
| Command | |
|
executeComplete():void
実行中のコマンド処理が完了したことを通知します。
このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
| Command | |
|
getCommandAt(index:int):Command
指定のインデックス位置にある子 Command インスタンスオブジェクトを返します。
Returns the child Command instance that exists at the specified index.
| CommandList | |
|
getCommandIndex(command:Command):int
指定された名前に一致する子 Command インスタンスを返します。
Returns the child Command that exists with the specified name.
| CommandList | |
|
insertCommand(... commands):void
現在実行中のコマンドの次の位置に新しくコマンドを追加します。
関数を指定した場合には、自動的に Func コマンドに変換され、
数値を指定した場合には、自動的に Wait コマンドに変換され、
配列を指定した場合には、自動的に ParallelList コマンドに変換され、
それ以外の値は、全て自動的に Trace コマンドに変換されます。
| SerialList | |
|
interrupt(enforced:Boolean = false):void
コマンド処理を中断します。
このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
| SerialList | |
|
setProperties(parameters:Object):Command
インスタンスに対して、複数のプロパティを一括設定します。
| Command | |
|
stop():void
実行中のループ処理を停止させます。
| LoopList | ||
|
toString():String
指定されたオブジェクトのストリング表現を返します。
Returns the string representation of the specified object.
| LoopList | ||
| Method | Defined by | ||
|---|---|---|---|
|
hasNextCommand():Boolean
次のコマンドインスタンスが存在するかどうかを返します。
| CommandList | |
|
次のコマンドインスタンスを取得して、処理位置を次に進めます。
| CommandList | |
|
reset():void
コマンドの処理位置を最初に戻します。
| LoopList | ||
|
throwError(target:Command, error:Error):void
コマンド処理中に例外が発生したことを通知します。
エラー処理が発生すると、コマンド処理が停止します。
問題を解決し、通常フローに戻す場合には executeComplete() メソッドを、問題が解決されず中断処理を行いたい場合には interrupt() メソッドを実行してください。
関数内で問題が解決、または中断処理に移行しなかった場合には ExecuteEvent.ERROR イベントが送出されます。
| CommandList | |
| count | property |
Hide Inherited Public Properties
Show Inherited Public Propertiescount:int [read-only]現在のループ処理回数を取得します。
Implementation public function get count():int
See also
| repeatCount | property |
repeatCount:int [read-write]実行したいループ処理数を取得または設定します。 この値が 0 に設定されている場合には、stop() メソッドで終了させるまで処理し続けます。 コマンド実行中に値を変更しても、処理に対して反映されません。
Implementation public function get repeatCount():int
public function set repeatCount(value:int):void
See also
| LoopList | () | constructor |
public function LoopList(repeatCount:int = 0, initObject:Object = null, ... commands)新しい LoopList インスタンスを作成します。 Creates a new LoopList object.
ParametersrepeatCount:int (default = 0) |
|
initObject:Object (default = null) |
|
... commands — 登録したいコマンドインスタンス、関数、数値、配列などを含む配列です。
|
| clone | () | method |
public override function clone():CommandLoopList インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an LoopList subclass.
ReturnsCommand —
元のオブジェクトと同じプロパティ値を含む新しい LoopList インスタンスです。
A new LoopList object that is identical to the original.
|
| dispose | () | method |
public override function dispose():void保持しているデータを解放します。
| reset | () | method |
| stop | () | method |
| toString | () | method |
public override function toString():String指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
ReturnsString — オブジェクトのストリング表現です。
A string representation of the object.
|