Packagejp.progression.casts
Classpublic class CastObject
InheritanceCastObject Inheritance EventIntegrator Inheritance flash.events.EventDispatcher
Implements ICastObject

CastObject クラスは、イベントフローとの連携機能を実装した jp.progression パッケージで使用される基本的な表示オブジェクトに必要な機能を実装した委譲クラスです。

View the examples



Public Properties
 PropertyDefined By
  eventHandlerEnabled : Boolean
オブジェクトのイベントハンドラメソッドを有効化するかどうかを指定します。
CastObject
  executor : CommandExecutor
[read-only] コマンドを実行する CommandExecutor インスタンスを取得します。
CastObject
  onCastAdded : Function
キャストオブジェクトが CastEvent.CAST_ADDED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。
CastObject
  onCastRemoved : Function
キャストオブジェクトが CastEvent.CAST_REMOVED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。
CastObject
  parallelMode : Boolean
CommandExecutor の実行方法を並列処理にするかどうかを取得または設定します。
CastObject
  target : DisplayObject
[read-only] 委譲元となる DisplayObject インスタンスを取得します。
CastObject
Public Methods
 MethodDefined By
  
CastObject(target:DisplayObject)
新しい CastObject インスタンスを作成します。 Creates a new CastObject object.
CastObject
  
addCommand(... commands):void
特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に削除されます。
CastObject
 Inherited
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
 Inherited
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
  
clearCommand(completely:Boolean = false):void
登録されている Command インスタンスを削除します。
CastObject
 Inherited
completelyRemoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができません。 Remove the listener from EventIntegrator instance.
EventIntegrator
 Inherited
dispatchEvent(event:Event):Boolean
[override] イベントをイベントフローに送出します。 Dispatches an event into the event flow.
EventIntegrator
 Inherited
hasEventListener(type:String):Boolean
[override] EventIntegrator インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventIntegrator
  
insertCommand(... commands):void
特定のイベントが送出された際に、自動実行させたい Command インスタンスをすでにリストに登録され、実行中の Command インスタンスの次の位置に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に削除されます。
CastObject
 Inherited
removeAllListeners(completely:Boolean = false):void
addEventListener() メソッド経由で登録された全てのイベントリスナー登録を削除します。 完全に登録を削除しなかった場合には、削除されたイベントリスナーを restoreRemovedListeners() メソッドで復帰させることができます。 Remove the whole event listener registered via addEventListener() method.
EventIntegrator
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventIntegrator instance.
EventIntegrator
 Inherited
removeEventListener() メソッド、または removeAllListeners() メソッド経由で削除された全てイベントリスナーを再登録します。 Re-register the whole event listener removed via removeEventListener() or removeAllListeners() method.
EventIntegrator
  
toString():String
[override] 指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
CastObject
 Inherited
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
Protected Methods
 MethodDefined By
  
サブクラスで onCastAdded イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onCastAdded プロパティに、別のメソッドを設定された場合は無効化されます。
CastObject
  
サブクラスで onCastRemoved イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onCastRemoved プロパティに、別のメソッドを設定された場合は無効化されます。
CastObject
Events
 Event Summary Defined By
  ICastObject オブジェクトが AddChild コマンド、または AddChildAt コマンド経由でディスプレイリストに追加された場合に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。CastObject
  ICastObject オブジェクトが RemoveChild コマンド、または RemoveAllChild コマンド経由でディスプレイリストから削除された場合に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。CastObject
Property Detail
eventHandlerEnabledproperty
eventHandlerEnabled:Boolean

オブジェクトのイベントハンドラメソッドを有効化するかどうかを指定します。


Implementation
    public function get eventHandlerEnabled():Boolean
    public function set eventHandlerEnabled(value:Boolean):void
executorproperty 
executor:CommandExecutor  [read-only]

コマンドを実行する CommandExecutor インスタンスを取得します。


Implementation
    public function get executor():CommandExecutor
onCastAddedproperty 
onCastAdded:Function

キャストオブジェクトが CastEvent.CAST_ADDED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。


Implementation
    public function get onCastAdded():Function
    public function set onCastAdded(value:Function):void
onCastRemovedproperty 
onCastRemoved:Function

キャストオブジェクトが CastEvent.CAST_REMOVED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。


Implementation
    public function get onCastRemoved():Function
    public function set onCastRemoved(value:Function):void
parallelModeproperty 
parallelMode:Boolean

CommandExecutor の実行方法を並列処理にするかどうかを取得または設定します。


Implementation
    public function get parallelMode():Boolean
    public function set parallelMode(value:Boolean):void
targetproperty 
target:DisplayObject  [read-only]

委譲元となる DisplayObject インスタンスを取得します。


Implementation
    public function get target():DisplayObject
Constructor Detail
CastObject()Constructor
public function CastObject(target:DisplayObject)

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

Parameters
target:DisplayObject委譲元となる DisplayObject インスタンスです。
Method Detail
_onCastAdded()method
protected function _onCastAdded():void

サブクラスで onCastAdded イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onCastAdded プロパティに、別のメソッドを設定された場合は無効化されます。

_onCastRemoved()method 
protected function _onCastRemoved():void

サブクラスで onCastRemoved イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onCastRemoved プロパティに、別のメソッドを設定された場合は無効化されます。

addCommand()method 
public function addCommand(... commands):void

特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に削除されます。

Parameters

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

clearCommand()method 
public function clearCommand(completely:Boolean = false):void

登録されている Command インスタンスを削除します。

Parameters

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

insertCommand()method 
public function insertCommand(... commands):void

特定のイベントが送出された際に、自動実行させたい Command インスタンスをすでにリストに登録され、実行中の Command インスタンスの次の位置に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に削除されます。

Parameters

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

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

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

Returns
Stringオブジェクトのストリング表現です。 A string representation of the object.
Event Detail
castAdded Event
Event Object Type: jp.progression.events.CastEvent
CastEvent.type property = jp.progression.events.CastEvent.CAST_ADDED

ICastObject オブジェクトが AddChild コマンド、または AddChildAt コマンド経由でディスプレイリストに追加された場合に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。

castAdded イベントオブジェクトの type プロパティ値を定義します。 The CastEvent.CAST_ADDED constant defines the value of the type property of an castAdded event object.
castRemoved Event  
Event Object Type: jp.progression.events.CastEvent
CastEvent.type property = jp.progression.events.CastEvent.CAST_REMOVED

ICastObject オブジェクトが RemoveChild コマンド、または RemoveAllChild コマンド経由でディスプレイリストから削除された場合に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。

castRemoved イベントオブジェクトの type プロパティ値を定義します。 The CastEvent.CAST_REMOVED constant defines the value of the type property of an castRemoved event object.
Examples