Packagejp.progression.executors
Classpublic class ExecutorObject
InheritanceExecutorObject Inheritance flash.events.EventDispatcher
Implementsjp.progression.core.impls.IDisposable
SubclassesCommandExecutor, ResumeExecutor

ExecutorObject クラスは、非同期処理を実装するための汎用的な実行クラスです。


Example


Public Properties
 PropertyDefined by
  className : String
[read-only] インスタンスのクラス名を取得します。 Indicates the instance className of the SceneObject.
ExecutorObject
  depth : int
[read-only] ExecutorObject インスタンスツリー構造上での自身の深度を取得します。
ExecutorObject
  dispatching : Boolean
[read-only] イベントが送出状態であるかどうかを取得します。
ExecutorObject
  eventType : String
[read-only] 現在のイベントタイプを取得します。
ExecutorObject
  executors : Array
[read-only] 子 ExecutorObject オブジェクトが保存されている配列です。 この配列を操作することで元の配列を変更することはできません。
ExecutorObject
  extra : Object
ExecutorObject インスタンスの実行処理、または中断処理の開始時に指定されているリレーオブジェクトを取得または設定します。 この ExecutorObject インスタンスが親の ExecutorObject インスタンスによって実行されている場合には、親のリレーオブジェクトを順々に引き継ぎます。
ExecutorObject
  numExecutors : int
[read-only] 登録されている ExecutorObject インスタンス数を取得します。 Returns the number of children of this ExecutorObject.
ExecutorObject
  parent : ExecutorObject
[read-only] この ExecutorObject オブジェクトを含む ExecutorObject オブジェクトを示します。 Indicates the ExecutorObject object that contains this ExecutorObject object.
ExecutorObject
  root : ExecutorObject
[read-only] ExecutorObject ツリー構造の一番上に位置する ExecutorObject インスタンスを取得します。
ExecutorObject
  state : int
[read-only] 現在の処理状態を取得します。
ExecutorObject
  target : IEventDispatcher
[read-only] IEventDispatcher インターフェイスを実装したインスタンスを取得します。
ExecutorObject
Public Methods
 MethodDefined by
  
ExecutorObject(target:IEventDispatcher, executeFunction:Function = null, interruptFunction:Function = null)
新しい ExecutorObject インスタンスを作成します。 Creates a new ExecutorObject object.
ExecutorObject
  
addExecutor(executor:ExecutorObject):ExecutorObject
この ExecutorObject インスタンスに子 ExecutorObject インスタンスを追加します。 Adds a child ExecutorObject instance to this ExecutorObject instance.
ExecutorObject
  
contains(executor:ExecutorObject):Boolean
指定された ExecutorObject インスタンスが ExecutorObject インスタンスの子であるか、オブジェクト自体であるかを指定します。 Determines whether the specified ExecutorObject is a executor of the ExecutorObject instance or the instance itself.
ExecutorObject
  
dispose():void
保持しているデータを解放します。
ExecutorObject
  
execute(event:Event, extra:Object = null, preRegistration:Boolean = true):void
処理を実行します。
ExecutorObject
  
interrupt():void
処理を中断します。 このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
ExecutorObject
  
removeAllExecutors():void
ExecutorObject に追加されている全ての子 ExecutorObject インスタンスを削除します。
ExecutorObject
  
removeExecutor(executor:ExecutorObject):ExecutorObject
ExecutorObject インスタンスの子リストから指定の ExecutorObject インスタンスを削除します。 Removes the specified child ExecutorObject instance from the executor list of the ExecutorObject instance.
ExecutorObject
  
toString():String
指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
ExecutorObject
Protected Methods
 MethodDefined by
  
executeComplete():void
実行中の処理が完了したことを通知します。 このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
ExecutorObject
Events
 EventSummaryDefined by
  
executeComplete
処理が完了した場合に送出されます。 ExecutorObject
  
executeError
処理の途中でエラーが発生した場合に送出されます。 ExecutorObject
  
executeInterrupt
処理が中断された場合に送出されます。 ExecutorObject
  
executeStart
処理が開始された場合に送出されます。 ExecutorObject
Property detail
classNameproperty
className:String  [read-only]

インスタンスのクラス名を取得します。 Indicates the instance className of the SceneObject.

Implementation
    public function get className():String
depthproperty 
depth:int  [read-only]

ExecutorObject インスタンスツリー構造上での自身の深度を取得します。

Implementation
    public function get depth():int
dispatchingproperty 
dispatching:Boolean  [read-only]

イベントが送出状態であるかどうかを取得します。

Implementation
    public function get dispatching():Boolean
eventTypeproperty 
eventType:String  [read-only]

現在のイベントタイプを取得します。

Implementation
    public function get eventType():String
executorsproperty 
executors:Array  [read-only]

子 ExecutorObject オブジェクトが保存されている配列です。 この配列を操作することで元の配列を変更することはできません。

Implementation
    public function get executors():Array
extraproperty 
extra:Object  [read-write]

ExecutorObject インスタンスの実行処理、または中断処理の開始時に指定されているリレーオブジェクトを取得または設定します。 この ExecutorObject インスタンスが親の ExecutorObject インスタンスによって実行されている場合には、親のリレーオブジェクトを順々に引き継ぎます。

Implementation
    public function get extra():Object
    public function set extra(value:Object):void

See also

execute()
interrupt()
numExecutorsproperty 
numExecutors:int  [read-only]

登録されている ExecutorObject インスタンス数を取得します。 Returns the number of children of this ExecutorObject.

Implementation
    public function get numExecutors():int
parentproperty 
parent:ExecutorObject  [read-only]

この ExecutorObject オブジェクトを含む ExecutorObject オブジェクトを示します。 Indicates the ExecutorObject object that contains this ExecutorObject object.

Implementation
    public function get parent():ExecutorObject

See also

root
next
previous
rootproperty 
root:ExecutorObject  [read-only]

ExecutorObject ツリー構造の一番上に位置する ExecutorObject インスタンスを取得します。

Implementation
    public function get root():ExecutorObject

See also

parent
next
previous
stateproperty 
state:int  [read-only]

現在の処理状態を取得します。

Implementation
    public function get state():int

See also

execute()
interrupt()
jp.progression.executors.ExecutorObjectState
targetproperty 
target:IEventDispatcher  [read-only]

IEventDispatcher インターフェイスを実装したインスタンスを取得します。

Implementation
    public function get target():IEventDispatcher
Constructor detail
ExecutorObject()constructor
public function ExecutorObject(target:IEventDispatcher, executeFunction:Function = null, interruptFunction:Function = null)

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

Parameters
target:IEventDispatcher — 関連付けたい IEventDispatcher インスタンスです。
 
executeFunction:Function (default = null) — 実行関数です。
 
interruptFunction:Function (default = null) — 中断関数です。
Method detail
addExecutor()method
public function addExecutor(executor:ExecutorObject):ExecutorObject

この ExecutorObject インスタンスに子 ExecutorObject インスタンスを追加します。 Adds a child ExecutorObject instance to this ExecutorObject instance.

Parameters
executor:ExecutorObject — 対象の ExecutorObject インスタンスの子として追加する ExecutorObject インスタンスです。 The ExecutorObject instance to add as a executor of this ExecutorObject instance.

Returns
ExecutorObject — executor パラメータで渡す ExecutorObject インスタンスです。 The ExecutorObject instance that you pass in the executor parameter.
contains()method 
public function contains(executor:ExecutorObject):Boolean

指定された ExecutorObject インスタンスが ExecutorObject インスタンスの子であるか、オブジェクト自体であるかを指定します。 Determines whether the specified ExecutorObject is a executor of the ExecutorObject instance or the instance itself.

Parameters
executor:ExecutorObject — テストする子 ExecutorObject インスタンスです。 The executor object to test.

Returns
Boolean — executor インスタンスが ExecutorObject の子であるか、コンテナ自体である場合は true となります。そうでない場合は false となります。 true if the executor object is a executor of the ExecutorObject or the container itself; otherwise false.
dispose()method 
public function dispose():void

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

execute()method 
public function execute(event:Event, extra:Object = null, preRegistration:Boolean = true):void

処理を実行します。

Parameters
event:Event — ExecutorObject に登録された対象に対して送出するトリガーイベントです。
 
extra:Object (default = null) — 実行時に設定されるリレーオブジェクトです。
 
preRegistration:Boolean (default = true) — 実行対象の ExecutorObject を処理を行う前に登録するようにするかどうかです。

See also

state
extra
executeComplete()
interrupt()
executeComplete()method 
protected function executeComplete():void

実行中の処理が完了したことを通知します。 このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。

interrupt()method 
public function interrupt():void

処理を中断します。 このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。

See also

state
execute()
removeAllExecutors()method 
public function removeAllExecutors():void

ExecutorObject に追加されている全ての子 ExecutorObject インスタンスを削除します。

removeExecutor()method 
public function removeExecutor(executor:ExecutorObject):ExecutorObject

ExecutorObject インスタンスの子リストから指定の ExecutorObject インスタンスを削除します。 Removes the specified child ExecutorObject instance from the executor list of the ExecutorObject instance.

Parameters
executor:ExecutorObject — 対象の ExecutorObject インスタンスの子から削除する ExecutorObject インスタンスです。 The ExecutorObject instance to remove.

Returns
ExecutorObject — executor パラメータで渡す ExecutorObject インスタンスです。 The ExecutorObject instance that you pass in the executor parameter.
toString()method 
public override function toString():String

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

Returns
String — オブジェクトのストリング表現です。 A string representation of the object.
Event detail
executeCompleteevent 
Event object type: jp.progression.events.ExecuteEvent

処理が完了した場合に送出されます。

executeErrorevent  
Event object type: jp.progression.events.ExecuteErrorEvent

処理の途中でエラーが発生した場合に送出されます。

executeInterruptevent  
Event object type: jp.progression.events.ExecuteEvent

処理が中断された場合に送出されます。

executeStartevent  
Event object type: jp.progression.events.ExecuteEvent

処理が開始された場合に送出されます。




Copyright (C) 2007-2010 taka:nium.jp. All Rights Reserved.