Packagejp.progression.casts
Classpublic dynamic class CastObject
InheritanceCastObject Inheritance flash.utils.Proxy
Implementsjp.progression.core.impls.ICastObject, jp.progression.core.impls.IManageable

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


Example 
  // Sprite インスタンスを作成する
  var sp:Sprite = new Sprite();
  
  // Sprite インスタンスの委譲先となる CastObject インスタンスを作成する
  var cast:CastObject = new CastObject( sp );
  
  // 画面設置時のイベントを設定する
  cast.onCastAdded = function():void {
   trace( "表示されました" );
  };
  cast.onCastRemoved = function():void {
   trace( "消去されました" );
  };
  
  // SerialList コマンドを実行する
  new SerialList( null,
   // 画面に表示する
   new AddChild( this, cast ),
   
   // 画面から消去する
   new RemoveChild( this, cast )
  ).execute();

See also

jp.progression.casts.getInstanceById()
jp.progression.casts.getInstancesByGroup()

Public Properties
 PropertyDefined by
  className : String
[read-only] インスタンスのクラス名を取得します。 Indicates the instance className of the IExDisplayObject.
CastObject
  executor : ExecutorObject
[read-only] 関連付けられている ExecutorObject インスタンスを取得します。
CastObject
  group : String
インスタンスのグループ名を取得または設定します。 Indicates the instance group of the IExDisplayObject.
CastObject
  id : String
インスタンスの識別子を取得または設定します。 Indicates the instance id of the IExDisplayObject.
CastObject
  manager : Progression
[read-only] 関連付けられている Progression インスタンスを取得します。
CastObject
  onCastAdded : Function
キャストオブジェクトが CastEvent.CAST_ADDED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。
CastObject
  onCastRemoved : Function
キャストオブジェクトが CastEvent.CAST_REMOVED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。
CastObject
  self : CastObject
[read-only] 自身の参照を取得します。
CastObject
  target : DisplayObject
[read-only] 委譲元となる DisplayObject インスタンスを取得します。
CastObject
Public Methods
 MethodDefined by
  
CastObject(target:DisplayObject, initObject:Object = null)
新しい CastObject インスタンスを作成します。 Creates a new CastObject object.
CastObject
  
addCommand(... commands):void
特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
CastObject
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。 このメソッドを使用して登録されたリスナーを removeEventListener() メソッドで削除した場合には、restoreRemovedListeners() メソッドで再登録させることができます。 Register the event listener object into the EventIntegrator instance to get the event notification.
CastObject
  
clearCommand(completely:Boolean = false):void
登録されている Command インスタンスを削除します。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
CastObject
  
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。 Dispatches an event into the event flow.
CastObject
  
dispose():void
保持しているデータを解放します。
CastObject
  
hasEventListener(type:String):Boolean
EventIntegrator インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
CastObject
  
insertCommand(... commands):void
特定のイベントが送出された際に、自動実行させたい Command インスタンスをすでにリストに登録され、実行中の Command インスタンスの次の位置に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
CastObject
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventIntegrator instance.
CastObject
  
setProperties(parameters:Object):CastObject
インスタンスに対して、複数のプロパティを一括設定します。 Setup the several instance properties.
CastObject
  
toString():String
指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
CastObject
  
updateManager():Boolean
マネージャーオブジェクトとの関連付けを更新します。
CastObject
  
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventIntegrator インスタンスまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
CastObject
Protected Methods
 MethodDefined by
  
atCastAdded():void
キャストオブジェクトが CastEvent.CAST_ADDED イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。
CastObject
  
atCastRemoved():void
キャストオブジェクトが CastEvent.CAST_REMOVED イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。
CastObject
Events
 EventSummaryDefined by
  
castAdded
IExecutable オブジェクトが AddChild コマンド、または AddChildAt コマンド経由で表示リストに追加された場合に送出されます。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。 CastObject
  
castAddedComplete
CastEvent.CAST_ADDED イベント中に実行された非同期処理が完了した場合に送出されます。 CastObject
  
castRemoved
IExecutable オブジェクトが RemoveChild コマンド、または RemoveAllChild コマンド経由で表示リストから削除された場合に送出されます。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。 CastObject
  
castRemovedComplete
CastEvent.CAST_REMOVED イベント中に実行された非同期処理が完了した場合に送出されます。 CastObject
  
executeError
非同期処理中にエラーが発生した場合に送出されます。 CastObject
  
managerActivate
Progression インスタンスとの関連付けがアクティブになったときに送出されます。 CastObject
  
managerDeactivate
Progression インスタンスとの関連付けが非アクティブになったときに送出されます。 CastObject
Property detail
classNameproperty
className:String  [read-only]

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

Implementation
    public function get className():String
executorproperty 
executor:ExecutorObject  [read-only]

関連付けられている ExecutorObject インスタンスを取得します。

Implementation
    public function get executor():ExecutorObject

See also

onCastAdded
onCastRemoved
addCommand()
insertCommand()
clearCommand()
groupproperty 
group:String  [read-write]

インスタンスのグループ名を取得または設定します。 Indicates the instance group of the IExDisplayObject.

Implementation
    public function get group():String
    public function set group(value:String):void

See also

jp.nium.display.getInstancesByGroup()
idproperty 
id:String  [read-write]

インスタンスの識別子を取得または設定します。 Indicates the instance id of the IExDisplayObject.

Implementation
    public function get id():String
    public function set id(value:String):void

See also

jp.nium.display.getInstanceById()
managerproperty 
manager:Progression  [read-only]

関連付けられている Progression インスタンスを取得します。

Implementation
    public function get manager():Progression

See also

jp.progression.events.ManagerEvent.MANAGER_ACTIVATE
jp.progression.events.ManagerEvent.MANAGER_DEACTIVATE
onCastAddedproperty 
onCastAdded:Function  [read-write]

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

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

See also

executor
addCommand()
insertCommand()
clearCommand()
jp.progression.events.CastEvent.CAST_ADDED
jp.progression.events.CastEvent.CAST_ADDED_COMPLETE
onCastRemovedproperty 
onCastRemoved:Function  [read-write]

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

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

See also

executor
addCommand()
insertCommand()
clearCommand()
jp.progression.events.CastEvent.CAST_REMOVED
jp.progression.events.CastEvent.CAST_REMOVED_COMPLETE
selfproperty 
self:CastObject  [read-only]

自身の参照を取得します。

Implementation
    public function get self():CastObject
targetproperty 
target:DisplayObject  [read-only]

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

Implementation
    public function get target():DisplayObject
Constructor detail
CastObject()constructor
public function CastObject(target:DisplayObject, initObject:Object = null)

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

Parameters
target:DisplayObject — コントロール対象となる DisplayObject です。
 
initObject:Object (default = null) — 設定したいプロパティを含んだオブジェクトです。
Method detail
addCommand()method
public function addCommand(... commands):void

特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。

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

See also

executor
onCastAdded
onCastRemoved
insertCommand()
clearCommand()
addEventListener()method 
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。 このメソッドを使用して登録されたリスナーを removeEventListener() メソッドで削除した場合には、restoreRemovedListeners() メソッドで再登録させることができます。 Register the event listener object into the EventIntegrator instance to get the event notification. If the registered listener by this method removed by using removeEventListener() method, it can re-register using restoreRemovedListeners() method.

Parameters
type:String — イベントのタイプです。 The type of event.
 
listener:Function — イベントを処理するリスナー関数です。この関数は Event インスタンスを唯一のパラメータとして受け取り、何も返さないものである必要があります。関数は任意の名前を持つことができます。 The listener function that processes the event. This function must accept an Event object as its only parameter and must return nothing. The function can have any name.
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。useCapture を true に設定すると、リスナーはキャプチャ段階のみでイベントを処理し、ターゲット段階またはバブリング段階では処理しません。useCapture を false に設定すると、リスナーはターゲット段階またはバブリング段階のみでイベントを処理します。3 つの段階すべてでイベントを受け取るには、addEventListener を 2 回呼び出します。useCapture を true に設定して 1 度呼び出し、useCapture を false に設定してもう一度呼び出します。 Determines whether the listener works in the capture phase or the target and bubbling phases. If useCapture is set to true, the listener processes the event only during the capture phase and not in the target or bubbling phase. If useCapture is false, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call addEventListener twice, once with useCapture set to true, then again with useCapture set to false.
 
priority:int (default = 0) — イベントリスナーの優先度レベルです。優先度は、符号付き 32 ビット整数で指定します。数値が大きくなるほど優先度が高くなります。優先度が n のすべてのリスナーは、優先度が n -1 のリスナーよりも前に処理されます。複数のリスナーに対して同じ優先度が設定されている場合、それらは追加された順番に処理されます。デフォルトの優先度は 0 です。 The priority level of the event listener. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.
 
useWeakReference:Boolean (default = false) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。デフォルトである強参照の場合は、リスナーのガベージコレクションが回避されます。弱参照では回避されません。 Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not.
atCastAdded()method 
protected function atCastAdded():void

キャストオブジェクトが CastEvent.CAST_ADDED イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

See also

executor
addCommand()
insertCommand()
clearCommand()
jp.progression.events.CastEvent.CAST_ADDED
jp.progression.events.CastEvent.CAST_ADDED_COMPLETE
atCastRemoved()method 
protected function atCastRemoved():void

キャストオブジェクトが CastEvent.CAST_REMOVED イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

See also

executor
addCommand()
insertCommand()
clearCommand()
jp.progression.events.CastEvent.CAST_REMOVED
jp.progression.events.CastEvent.CAST_REMOVED_COMPLETE
clearCommand()method 
public function clearCommand(completely:Boolean = false):void

登録されている Command インスタンスを削除します。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。

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

See also

executor
onCastAdded
onCastRemoved
addCommand()
insertCommand()
dispatchEvent()method 
public function dispatchEvent(event:Event):Boolean

イベントをイベントフローに送出します。 Dispatches an event into the event flow.

Parameters
event:Event — イベントフローに送出されるイベントオブジェクトです。イベントが再度送出されると、イベントのクローンが自動的に作成されます。イベントが送出された後にそのイベントの target プロパティは変更できないため、再送出処理のためにはイベントの新しいコピーを作成する必要があります。 The Event object that is dispatched into the event flow. If the event is being redispatched, a clone of the event is created automatically. After an event is dispatched, its target property cannot be changed, so you must create a new copy of the event for redispatching to work.

Returns
Boolean — 値が true の場合、イベントは正常に送出されました。値が false の場合、イベントの送出に失敗したか、イベントで preventDefault() が呼び出されたことを示しています。 A value of true if the event was successfully dispatched. A value of false indicates failure or that preventDefault() was called on the event.
dispose()method 
public function dispose():void

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

hasEventListener()method 
public function hasEventListener(type:String):Boolean

EventIntegrator インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.

Parameters
type:String — イベントのタイプです。 The type of event.

Returns
Boolean — 指定したタイプのリスナーが登録されている場合は true に、それ以外の場合は false になります。 A value of true if a listener of the specified type is registered; false otherwise.
insertCommand()method 
public function insertCommand(... commands):void

特定のイベントが送出された際に、自動実行させたい Command インスタンスをすでにリストに登録され、実行中の Command インスタンスの次の位置に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。

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

See also

executor
onCastAdded
onCastRemoved
addCommand()
clearCommand()
removeEventListener()method 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventIntegrator instance. The listener removed by using this method can re-register by restoreRemovedListeners() method.

Parameters
type:String — イベントのタイプです。 The type of event.
 
listener:Function — 削除するリスナーオブジェクトです。 The listener object to remove.
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階に対して登録されたかどうかを示します。リスナーがキャプチャ段階だけでなくターゲット段階とバブリング段階にも登録されている場合は、removeEventListener() を 2 回呼び出して両方のリスナーを削除する必要があります。1 回は useCapture() を true に設定し、もう 1 回は useCapture() を false に設定する必要があります。 Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both, one call with useCapture() set to true, and another call with useCapture() set to false.
setProperties()method 
public function setProperties(parameters:Object):CastObject

インスタンスに対して、複数のプロパティを一括設定します。 Setup the several instance properties.

Parameters
parameters:Object — 設定したいプロパティを含んだオブジェクトです。 The object that contains the property to setup.

Returns
CastObject — 自身の参照です。
toString()method 
public function toString():String

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

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

マネージャーオブジェクトとの関連付けを更新します。

Returns
Boolean — 関連付けが成功したら true を、それ以外は false を返します。

See also

manager
jp.progression.Progression
willTrigger()method 
public function willTrigger(type:String):Boolean

指定されたイベントタイプについて、この EventIntegrator インスタンスまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.

Parameters
type:String — イベントのタイプです。 The type of event.

Returns
Boolean — 指定したタイプのリスナーがトリガされた場合は true に、それ以外の場合は false になります。 A value of true if a listener of the specified type will be triggered; false otherwise.
Event detail
castAddedevent 
Event object type: jp.progression.events.CastEvent

IExecutable オブジェクトが AddChild コマンド、または AddChildAt コマンド経由で表示リストに追加された場合に送出されます。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

castAddedCompleteevent  
Event object type: jp.progression.events.CastEvent

CastEvent.CAST_ADDED イベント中に実行された非同期処理が完了した場合に送出されます。

castRemovedevent  
Event object type: jp.progression.events.CastEvent

IExecutable オブジェクトが RemoveChild コマンド、または RemoveAllChild コマンド経由で表示リストから削除された場合に送出されます。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。

castRemovedCompleteevent  
Event object type: jp.progression.events.CastEvent

CastEvent.CAST_REMOVED イベント中に実行された非同期処理が完了した場合に送出されます。

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

非同期処理中にエラーが発生した場合に送出されます。

managerActivateevent  
Event object type: jp.progression.events.ManagerEvent

Progression インスタンスとの関連付けがアクティブになったときに送出されます。

managerDeactivateevent  
Event object type: jp.progression.events.ManagerEvent

Progression インスタンスとの関連付けが非アクティブになったときに送出されます。




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