Packagejp.progression.casts.mx
Classpublic class CastCanvas
InheritanceCastCanvas Inheritance mx.containers.Canvas
Implementsjp.progression.core.impls.ICastObject, jp.progression.core.impls.IManageable

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


Example
  // CastCanvas インスタンスを作成する
  var cast:CastCanvas = new CastCanvas();
  



Public Properties
 PropertyDefined by
  contextMenu : ContextMenu
CastCanvas
  executor : ExecutorObject
[read-only] 関連付けられている ExecutorObject インスタンスを取得します。
CastCanvas
  group : String
インスタンスのグループ名を取得または設定します。 Indicates the instance group of the IExDisplayObject.
CastCanvas
  id : String
インスタンスの識別子を取得または設定します。 Indicates the instance id of the IExDisplayObject.
CastCanvas
  manager : Progression
[read-only] 関連付けられている Progression インスタンスを取得します。
CastCanvas
  onCastAdded : Function
キャストオブジェクトが CastEvent.CAST_ADDED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。
CastCanvas
  onCastRemoved : Function
キャストオブジェクトが CastEvent.CAST_REMOVED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。
CastCanvas
  self : CastCanvas
[read-only] 自身の参照を取得します。
CastCanvas
Public Methods
 MethodDefined by
  
新しい CastCanvas インスタンスを作成します。 Creates a new CastCanvas object.
CastCanvas
  
addCommand(... commands):void
特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
CastCanvas
  
clearCommand(completely:Boolean = false):void
登録されている Command インスタンスを削除します。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
CastCanvas
  
dispose():void
保持しているデータを解放します。
CastCanvas
  
insertCommand(... commands):void
特定のイベントが送出された際に、自動実行させたい Command インスタンスをすでにリストに登録され、実行中の Command インスタンスの次の位置に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
CastCanvas
  
setProperties(parameters:Object):DisplayObject
インスタンスに対して、複数のプロパティを一括設定します。 Setup the several instance properties.
CastCanvas
  
toString():String
指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
CastCanvas
  
updateManager():Boolean
マネージャーオブジェクトとの関連付けを更新します。
CastCanvas
Protected Methods
 MethodDefined by
  
atCastAdded():void
キャストオブジェクトが CastEvent.CAST_ADDED イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。
CastCanvas
  
キャストオブジェクトが CastEvent.CAST_REMOVED イベントを受け取った場合に呼び出されるオーバーライド・イベントハンドラメソッドです。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。
CastCanvas
Events
 EventSummaryDefined by
   IExecutable オブジェクトが AddChild コマンド、または AddChildAt コマンド経由で表示リストに追加された場合に送出されます。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。 CastCanvas
   CastEvent.CAST_ADDED イベント中に実行された非同期処理が完了した場合に送出されます。 CastCanvas
   IExecutable オブジェクトが RemoveChild コマンド、または RemoveAllChild コマンド経由で表示リストから削除された場合に送出されます。 このイベント処理の実行中には、ExecutorObject を使用した非同期処理が行えます。 CastCanvas
   CastEvent.CAST_REMOVED イベント中に実行された非同期処理が完了した場合に送出されます。 CastCanvas
   非同期処理中にエラーが発生した場合に送出されます。 CastCanvas
Property detail
contextMenuproperty
contextMenu:ContextMenu  [read-write]Implementation
    public function get contextMenu():ContextMenu
    public function set contextMenu(value:ContextMenu):void
executorproperty 
executor:ExecutorObject  [read-only]

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

Implementation
    public function get executor():ExecutorObject

See also

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

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

managerproperty 
manager:Progression  [read-only]

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

Implementation
    public function get manager():Progression

See also

onCastAddedproperty 
onCastAdded:Function  [read-write]

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

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

See also

onCastRemovedproperty 
onCastRemoved:Function  [read-write]

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

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

See also

selfproperty 
self:CastCanvas  [read-only]

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

Implementation
    public function get self():CastCanvas
Constructor detail
CastCanvas()constructor
public function CastCanvas()

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

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

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

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

See also

atCastAdded()method 
protected function atCastAdded():void

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

See also

atCastRemoved()method 
protected function atCastRemoved():void

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

See also

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

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

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

See also

dispose()method 
public function dispose():void

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

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

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

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

See also

setProperties()method 
public function setProperties(parameters:Object):DisplayObject

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

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

Returns
DisplayObject自身の参照です。
toString()method 
public override 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

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

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