Packagejp.progression.commands
Classpublic class Func
InheritanceFunc Inheritance Command Inheritance flash.events.EventDispatcher

Func クラスは、指定された関数を実行するコマンドクラスです。


Example
  // 関数を作成する
  var myfunc:Function = function():void {
   trace( "関数を実行しました。" );
   trace( "実行中の関数内での this は、登録されている Func インスタンスになります。", this );
  };
  
  // Func インスタンスを作成する
  var com:Func = new Func( myfunc );
  
  // コマンドを実行する
  com.execute();
  



Public Properties
 PropertyDefined by
  args : Array
関数を実行する際に引数として使用する配列を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
Func
 InheritedcatchError : Function
コマンドの実行中に例外が発生した際に実行するエラー処理関数を取得または設定します。
Command
 InheritedclassName : String
インスタンスのクラス名を取得します。 Indicates the instance className of the Command.
Command
 InheriteddefaultInterruptType : int
[static] interruptType プロパティの初期値を取得または設定します。 すでに生成済みのコマンドに対しては適用されません。
Command
 InheriteddefaultTimeout : Number
[static] timeout プロパティの初期値を取得または設定します。 すでに生成済みのコマンドに対しては適用されません。
Command
 Inheriteddelay : Number
コマンドが実際に実行されるまでの遅延時間を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
Command
 Inheriteddepth : int
コマンドツリー構造上での自身の深度を取得します。
Command
  dispatcher : IEventDispatcher
[read-only] 処理の終了イベントを発行する IEventDispatcher インスタンスを取得します。 コマンド実行中に値を変更しても、処理に対して反映されません。
Func
  eventObject : Event
[read-only]
Func
  eventType : String
[read-only] 発行される終了イベントの種類を取得します。 コマンド実行中に値を変更しても、処理に対して反映されません。
Func
 Inheritedextra : Object
コマンドの実行処理、または中断処理の開始時に指定されているリレーオブジェクトを取得または設定します。 このコマンドが親の CommandList インスタンスによって実行されている場合には、親のリレーオブジェクトを順々に引き継ぎます。
Command
  func : Function
実行したい関数を取得します。 コマンド実行中に値を変更しても、処理に対して反映されません。
Func
 Inheritedgroup : String
インスタンスのグループ名を取得または設定します。 Indicates the instance group of the Command.
Command
 Inheritedid : String
インスタンスを表すユニークな識別子を取得または設定します。
Command
 InheritedinterruptType : int
中断処理時の処理方法を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
Command
 InheritedlatestData : *
自身から見て最後に関連付けられた読み込みデータを取得または設定します。 このコマンドが CommandList インスタンス上に存在する場合には、自身より前、または自身の親のデータを取得します。
Command
  listening : Boolean
[read-only] イベント待ちをしているかどうかを取得します。
Func
 Inheritedname : String
インスタンスの名前を取得または設定します。 Indicates the instance name of the Command.
Command
 Inheritednext : Command
このコマンドが関連付けられている親の CommandList インスタンス内で、次に位置する Command インスタンスを取得します。
Command
 InheritedonComplete : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_COMPLETE イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 InheritedonError : Function
コマンドオブジェクトが ExecuteErrorEvent.EXECUTE_ERROR イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 InheritedonInterrupt : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_INTERRUPT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 InheritedonStart : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_START イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 Inheritedparent : CommandList
この Command オブジェクトを含む CommandList オブジェクトを示します。 Indicates the CommandList object that contains this Command object.
Command
 Inheritedprevious : Command
このコマンドが関連付けられている親の CommandList インスタンス内で、一つ前に位置する Command インスタンスを取得します。
Command
 Inheritedroot : Command
コマンドツリー構造の一番上に位置する Command インスタンスを取得します。
Command
 Inheritedscope : Object
コマンドの実行処理、または中断処理に指定されている関数内でのスコープ対象を取得または設定します。
Command
 Inheritedstate : int
コマンドの実行状態を取得します。
Command
 InheritedthresholdLength : int
[static] 同一プロセス上で実行可能な最大コマンド数を取得または設定します。 設定された閾値を超えて実行された場合には、強制的に 1 ミリ秒の遅延を発生させます。 この値が大きすぎる場合、スタックオーバーフローが発生する可能性があります。
Command
 Inheritedtimeout : Number
コマンドの実行中のタイムアウト時間を取得または設定します。 指定された時間中に executeComplete() メソッド、または interrupt() メソッドが実行されなかった場合にはエラーが送出されます。 この値が 0 に設定されている場合、タイムアウト処理は発生しません。
Command
Public Methods
 MethodDefined by
  
Func(func:Function, args:Array = null, dispatcher:IEventDispatcher = null, eventType:String = null, initObject:Object = null)
新しい Func インスタンスを作成します。 Creates a new Func object.
Func
  
Func インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an Func subclass.
Func
  
dispose():void
保持しているデータを解放します。
Func
 Inherited
execute(extra:Object = null):void
コマンド処理を実行します。
Command
 Inherited
実行中のコマンド処理が完了したことを通知します。 このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
Command
  
getVar(name:String):*
設定された値を取得します。
Func
 Inherited
interrupt(enforced:Boolean = false):void
コマンド処理を中断します。 このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
Command
  
listen(dispatcher:IEventDispatcher, eventType:String):void
イベント待ちを設定します。
Func
 Inherited
setProperties(parameters:Object):Command
インスタンスに対して、複数のプロパティを一括設定します。
Command
  
setVar(name:String, value:*):void
指定された変数名に値を設定します。
Func
  
toString():String
指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
Func
  
unlisten():void
イベント待ちを解除します。
Func
Protected Methods
 MethodDefined by
 Inherited
throwError(target:Command, error:Error):void
コマンド処理中に例外が発生したことを通知します。 エラー処理が発生すると、コマンド処理が停止します。 問題を解決し、通常フローに戻す場合には executeComplete() メソッドを、問題が解決されず中断処理を行いたい場合には interrupt() メソッドを実行してください。 関数内で問題が解決、または中断処理に移行しなかった場合には ExecuteErrorEvent.EXECUTE_ERROR イベントが送出されます。
Command
Events
 EventSummaryDefined by
 Inherited 処理が完了した場合に送出されます。 Command
 Inherited 処理の途中でエラーが発生した場合に送出されます。 Command
 Inherited 処理が中断された場合に送出されます。 Command
 Inherited 処理が開始された場合に送出されます。 Command
Property detail
argsproperty
args:Array  [read-write]

関数を実行する際に引数として使用する配列を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。

Implementation
    public function get args():Array
    public function set args(value:Array):void

See also


Example
   // 関数を作成する
   var myfunc:Function = function( num1:Number, num2:Number ):void {
    trace( "result = ", num1 num2 ); // result = 2000
   };
   
   // Func インスタンスを作成する
   var com:Func = new Func( myfunc, [ 100, 20 ] );
   
   // コマンドを実行する
   com.execute();
   

dispatcherproperty 
dispatcher:IEventDispatcher  [read-only]

処理の終了イベントを発行する IEventDispatcher インスタンスを取得します。 コマンド実行中に値を変更しても、処理に対して反映されません。

Implementation
    public function get dispatcher():IEventDispatcher

See also

eventObjectproperty 
eventObject:Event  [read-only]

Implementation
    public function get eventObject():Event
eventTypeproperty 
eventType:String  [read-only]

発行される終了イベントの種類を取得します。 コマンド実行中に値を変更しても、処理に対して反映されません。

Implementation
    public function get eventType():String

See also

funcproperty 
func:Function  [read-write]

実行したい関数を取得します。 コマンド実行中に値を変更しても、処理に対して反映されません。

Implementation
    public function get func():Function
    public function set func(value:Function):void

See also

listeningproperty 
listening:Boolean  [read-only]

イベント待ちをしているかどうかを取得します。

Implementation
    public function get listening():Boolean

See also

Constructor detail
Func()constructor
public function Func(func:Function, args:Array = null, dispatcher:IEventDispatcher = null, eventType:String = null, initObject:Object = null)

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

Parameters
func:Function実行したい関数です。
 
args:Array (default = null)関数を実行する際に引数として使用する配列です。
 
dispatcher:IEventDispatcher (default = null)処理の終了イベントを発行する EventDispatcher インスタンスです。
 
eventType:String (default = null)発行される終了イベントの種類です。
 
initObject:Object (default = null)設定したいプロパティを含んだオブジェクトです。
Method detail
clone()method
public override function clone():Command

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

Returns
Command元のオブジェクトと同じプロパティ値を含む新しい Func インスタンスです。 A new Func object that is identical to the original.
dispose()method 
public override function dispose():void

保持しているデータを解放します。

getVar()method 
public function getVar(name:String):*

設定された値を取得します。

Parameters
name:String取得したい変数名です。

Returns
*取得した値です。

See also

listen()method 
public function listen(dispatcher:IEventDispatcher, eventType:String):void

イベント待ちを設定します。

Parameters
dispatcher:IEventDispatcherイベントの送出元です。
 
eventType:String送出されるのを待つイベントタイプです。

See also


Example
   // 関数を作成する
   var myfunc:Function = function():void {
    // ステージがクリックされるまで待機する
    this.listen( stage, MouseEvent.CLICK );
   };
   
   // SerialList インスタンスを作成する
   var com:SerialList = new SerialList( null,
    new Trace( "start" ),
    new Func( myfunc ),
    new Trace( "complete" )
   );
   
   // コマンドを実行する
   com.execute();
   

setVar()method 
public function setVar(name:String, value:*):void

指定された変数名に値を設定します。

Parameters
name:String設定したい変数名です。
 
value:*設定したい値です。

See also

toString()method 
public override function toString():String

指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.

Returns
Stringオブジェクトのストリング表現です。 A string representation of the object.
unlisten()method 
public function unlisten():void

イベント待ちを解除します。

See also