jp.progression.commands.Break

Package	jp.progression.commands
Class	public class Break
Inheritance	Break Command flash.events.EventDispatcher

Break クラスは、実行中の処理を強制的に中断するコマンドクラスです。

Example

  // SerialList インスタンスを作成する
  var com:SerialList = new SerialList();
  
  // コマンドを登録する
  com.addCommand(
   new Trace( "親の SerialList を実行" ),
   new SerialList( null,
    new Trace( "子の SerialList を実行" ),
    new SerialList( null,
     new Trace( "孫の SerialList を実行" ),
     // ここで処理を中断する
     new Break(),
     new Trace( "このコマンドは実行されない" )
    ),
    new Trace( "子の SerialList を終了" )
   ),
   new Trace( "親の SerialList を終了" )
  );
  
  // コマンドを実行する
  com.execute();

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		catchError : Function コマンドの実行中に例外が発生した際に実行するエラー処理関数を取得または設定します。	Command
		className : String インスタンスのクラス名を取得します。 Indicates the instance className of the Command.	Command
		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
		onComplete : Function コマンドオブジェクトが ExecuteEvent.EXECUTE_COMPLETE イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。	Command
		onError : Function コマンドオブジェクトが ExecuteErrorEvent.EXECUTE_ERROR イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。	Command
		onInterrupt : Function コマンドオブジェクトが ExecuteEvent.EXECUTE_INTERRUPT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。	Command
		onStart : Function コマンドオブジェクトが ExecuteEvent.EXECUTE_START イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。	Command
		parent : CommandList この Command オブジェクトを含む CommandList オブジェクトを示します。 Indicates the CommandList object that contains this Command object.	Command
		previous : Command このコマンドが関連付けられている親の CommandList インスタンス内で、一つ前に位置する Command インスタンスを取得します。	Command
		root : Command コマンドツリー構造の一番上に位置する Command インスタンスを取得します。	Command
		scope : Object コマンドの実行処理、または中断処理に指定されている関数内でのスコープ対象を取得または設定します。	Command
		state : int コマンドの実行状態を取得します。	Command
		thresholdLength : int [static] 同一プロセス上で実行可能な最大コマンド数を取得または設定します。設定された閾値を超えて実行された場合には、強制的に 1 ミリ秒の遅延を発生させます。この値が大きすぎる場合、スタックオーバーフローが発生する可能性があります。	Command
		timeout : Number コマンドの実行中のタイムアウト時間を取得または設定します。指定された時間中に executeComplete() メソッド、または interrupt() メソッドが実行されなかった場合にはエラーが送出されます。この値が 0 に設定されている場合、タイムアウト処理は発生しません。	Command

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		Break(initObject:Object = null) 新しい Break インスタンスを作成します。 Creates a new Break object.	Break
		clone():Command Break インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an Break subclass.	Break
		dispose():void 保持しているデータを解放します。	Command
		execute(extra:Object = null):void コマンド処理を実行します。	Command
		executeComplete():void 実行中のコマンド処理が完了したことを通知します。このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。	Command
		interrupt(enforced:Boolean = false):void コマンド処理を中断します。このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。	Command
		setProperties(parameters:Object):Command インスタンスに対して、複数のプロパティを一括設定します。	Command
		toString():String 指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.	Command

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		throwError(target:Command, error:Error):void コマンド処理中に例外が発生したことを通知します。エラー処理が発生すると、コマンド処理が停止します。問題を解決し、通常フローに戻す場合には executeComplete() メソッドを、問題が解決されず中断処理を行いたい場合には interrupt() メソッドを実行してください。関数内で問題が解決、または中断処理に移行しなかった場合には ExecuteErrorEvent.EXECUTE_ERROR イベントが送出されます。	Command

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined by
executeComplete	処理が完了した場合に送出されます。	Command
executeError	処理の途中でエラーが発生した場合に送出されます。	Command
executeInterrupt	処理が中断された場合に送出されます。	Command
executeStart	処理が開始された場合に送出されます。	Command

Constructor detail

Break

()

constructor

public function Break(initObject:Object = null)

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

Parameters

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

Method detail

clone

()

method

public override function clone():Command

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

Returns

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

Progression 4.0 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class Break	Properties \| Methods \| Events