| Package | jp.progression.casts |
| Class | public class CastDocument |
| Inheritance | CastDocument  ExDocument ExMovieClip flash.display.MovieClip |
| Implements | jp.progression.core.impls.ICastDocument, jp.progression.core.impls.ICastObject, jp.progression.core.impls.IManageable |
See also
| Property | Defined by | ||
|---|---|---|---|
| background : Sprite [read-only]
読み込まれるコンテンツよりも背面に表示したい DisplayObject を管理する Sprite インスタンスを取得します。
この値は CastPreloader 経由で読み込まれた場合のみ有効です。
| CastDocument | ||
| bottom : Number [static][read-only]
ステージ下の Y 座標を取得します。
Get the bottom Y coordinate of the stage.
| CastDocument | ||
| center : Number [static][read-only]
ステージ中央の X 座標を取得します。
Get the center X coordinate of the stage.
| CastDocument | ||
 | children : Array
子ディスプレイオブジェクトが保存されている配列です。
インデックス値が断続的に指定可能であるため、getChildAt() ではなくこのプロパティを使用して子ディスプレイオブジェクト走査を行います。
この配列を操作することで元の配列を変更することはできません。
The array that saves child display objects.
| ExMovieClip | |
| className : String
インスタンスのクラス名を取得します。
Indicates the instance className of the IExDisplayObject.
| ExMovieClip | |
| contextMenu : ContextMenu | CastDocument | ||
| executor : ExecutorObject
[read-only]
関連付けられている ExecutorObject インスタンスを取得します。
| CastDocument | ||
| foreground : Sprite [read-only]
読み込まれるコンテンツよりも前面に表示したい DisplayObject を管理する Sprite インスタンスを取得します。
この値は CastPreloader 経由で読み込まれた場合のみ有効です。
| CastDocument | ||
| group : String
インスタンスのグループ名を取得または設定します。
Indicates the instance group of the IExDisplayObject.
| ExMovieClip | |
| id : String
インスタンスの識別子を取得または設定します。
Indicates the instance id of the IExDisplayObject.
| ExMovieClip | |
| isDragging : Boolean
startDrag() メソッドを使用したドラッグ処理を行っている最中かどうかを取得します。
Returns if the drag process which uses startDrag() method is executing.
| ExMovieClip | |
| isPlaying : Boolean
ムービークリップのタイムライン内で再生ヘッドの移動処理が行われているかどうかを取得します。
Returns if the movement processing of the playback head is executing in the timeline of the MovieClip.
| ExMovieClip | |
| isPreloaded : Boolean [read-only]
CastPreloader 経由で読み込まれているかどうかを取得します。
| CastDocument | ||
| isReady : Boolean
ドキュメントの準備が完了しているかどうかを取得します。
| ExDocument | |
| left : Number [static][read-only]
ステージ左の X 座標を取得します。
Get the left X coordinate of the stage.
| CastDocument | ||
| manager : Progression
[read-only]
関連付けられている Progression インスタンスを取得します。
| CastDocument | ||
| middle : Number [static][read-only]
ステージ中央の Y 座標を取得します。
Get the center Y coordinate of the stage.
| CastDocument | ||
| numChildren : int [read-only]
このオブジェクトの子の数を返します。
このインスタンスが SceneLoader によって読み込まれている場合には、関連付けられている DisplayObjectContainer の子の数を返します。
| CastDocument | ||
| onReady : Function
SWF ファイルの読み込みが完了し、stage 及び loaderInfo にアクセス可能になった場合に呼び出されるイベントハンドラメソッドを取得または設定します。
| CastDocument | ||
| parent : DisplayObjectContainer [read-only]
この表示オブジェクトを含む DisplayObjectContainer オブジェクトを示します。
このインスタンスが SceneLoader によって読み込まれている場合には、関連付けられている DisplayObjectContainer を示します。
| CastDocument | ||
| right : Number [static][read-only]
ステージ右の X 座標を取得します。
Get the right X coordinate of the stage.
| CastDocument | ||
| root : CastDocument
[static][read-only]
ロードされた SWF ファイル内の表示オブジェクトの場合、root プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。
For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.
| CastDocument | ||
| self : CastDocument
[read-only]
自身の参照を取得します。
| CastDocument | ||
| stage : Stage [static][read-only]
表示オブジェクトのステージです。
The Stage of the display object.
| CastDocument | ||
| top : Number [static][read-only]
ステージ上の Y 座標を取得します。
Get the top Y coordinate of the stage.
| CastDocument | ||
| Method | Defined by | ||
|---|---|---|---|
|
CastDocument(managerId:String = null, rootClass:Class = null, config:Configuration = null, initObject:Object = null)
新しい CastDocument インスタンスを作成します。
Creates a new CastDocument object.
| CastDocument | ||
|
addChild(child:DisplayObject):DisplayObject
この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
| CastDocument | ||
|
addChildAt(child:DisplayObject, index:int):DisplayObject
この DisplayObjectContainer インスタンスの指定されたインデックス位置に子 DisplayObject インスタンスを追加します。
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
| CastDocument | ||
|
addChildAtAbove(child:DisplayObject, index:int):DisplayObject
この DisplayObjectContainer インスタンスの指定されたインデックス位置に子 DisplayObject インスタンスを追加します。
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
| CastDocument | ||
|
addCommand(... commands):void
特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。
追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。
このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
| CastDocument | ||
|
clearCommand(completely:Boolean = false):void
登録されている Command インスタンスを削除します。
このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
| CastDocument | ||
|
contains(child:DisplayObject):Boolean
指定された表示オブジェクトが DisplayObjectContainer インスタンスの子であるか、オブジェクト自体であるかを指定します。
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
| CastDocument | ||
|
getChildAt(index:int):DisplayObject
指定のインデックス位置にある子表示オブジェクトオブジェクトを返します。
Returns the child display object instance that exists at the specified index.
| CastDocument | ||
|
getChildByName(name:String):DisplayObject
指定された名前に一致する子表示オブジェクトを返します。
Returns the child display object that exists with the specified name.
| CastDocument | ||
|
getChildIndex(child:DisplayObject):int
子 DisplayObject インスタンスのインデックス位置を返します。
Returns the index position of a child DisplayObject instance.
| CastDocument | ||
|
gotoAndPlay(frame:Object, scenes:String = null):void
指定されたフレームで SWF ファイルの再生を開始します。
Start the playback of the SWF file with the specified frame.
| ExMovieClip | |
|
gotoAndStop(frame:Object, scenes:String = null):void
このムービークリップの指定されたフレームに再生ヘッドを送り、そこで停止させます。
Set the palyback head to the specified frame of the MovieClip and stop at that point.
| ExMovieClip | |
|
insertCommand(... commands):void
特定のイベントが送出された際に、自動実行させたい Command インスタンスをすでにリストに登録され、実行中の Command インスタンスの次の位置に追加します。
追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。
このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
| CastDocument | ||
|
nextFrame():void
次のフレームに再生ヘッドを送り、停止します。
Move the playback head to the next frame and stop at that point.
| ExMovieClip | |
|
play():void
ムービークリップのタイムライン内で再生ヘッドを移動します。
Moves the playback head in the timeline of the MovieClip.
| ExMovieClip | |
|
prevFrame():void
直前のフレームに再生ヘッドを戻し、停止します。
Move the playback head to the previous frame and stop at that point.
| ExMovieClip | |
|
removeAllChildren():void
DisplayObjectContainer に追加されている全ての子 DisplayObject インスタンスを削除します。
Remove the whole child DisplayObject instance which added to the DisplayObjectContainer.
| CastDocument | ||
|
removeChild(child:DisplayObject):DisplayObject
DisplayObjectContainer インスタンスの子リストから指定の DisplayObject インスタンスを削除します。
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
| CastDocument | ||
|
removeChildAt(index:int):DisplayObject
DisplayObjectContainer の子リストの指定されたインデックス位置から子 DisplayObject インスタンスを削除します。
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
| CastDocument | ||
|
setChildIndex(child:DisplayObject, index:int):void
表示オブジェクトコンテナの既存の子の位置を変更します。
Changes the position of an existing child in the display object container.
| CastDocument | ||
|
setChildIndexAbove(child:DisplayObject, index:int):void
表示オブジェクトコンテナの既存の子の位置を変更します。
Changes the position of an existing child in the display object container.
| CastDocument | ||
|
setProperties(parameters:Object):DisplayObject
インスタンスに対して、複数のプロパティを一括設定します。
Setup the several instance properties.
| ExMovieClip | |
|
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
指定されたスプライトをユーザーがドラッグできるようにします。
Allow the user to drag the specified sprite.
| ExMovieClip | |
|
stop():void
ムービークリップ内の再生ヘッドを停止します。
Stops the playback head in the MovieClip.
| ExMovieClip | |
|
stopDrag():void
startDrag() メソッドを終了します。
Ends the startDrag() method.
| ExMovieClip | |
|
swapChildren(child1:DisplayObject, child2:DisplayObject):void
指定された 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。
Swaps the z-order (front-to-back order) of the two specified child objects.
| CastDocument | ||
|
swapChildrenAt(index1:int, index2:int):void
子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
| CastDocument | ||
|
switchAtPlaying():void
ムービークリップの再生状態に応じて、再生もしくは停止します。
Playback or stops according to the playback state of the MovieClip.
| ExMovieClip | |
|
toString():String
指定されたオブジェクトのストリング表現を返します。
Returns the string representation of the specified object.
| ExMovieClip | |
|
updateManager():Boolean
マネージャーオブジェクトとの関連付けを更新します。
| CastDocument | ||
| Method | Defined by | ||
|---|---|---|---|
|
atReady():void
SWF ファイルの読み込みが完了し、stage 及び loaderInfo にアクセス可能になった場合に呼び出されるオーバーライド・イベントハンドラメソッドです。
| CastDocument | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| SWF ファイルの読み込みが完了し、stage 及び loaderInfo にアクセス可能になった場合に送出されます。 Dispatch when the SWF file completes to read and the stage and the loaderInfo becomes able to access. | ExDocument | ||
| Progression インスタンスとの関連付けがアクティブになったときに送出されます。 | CastDocument | |||
| Progression インスタンスとの関連付けが非アクティブになったときに送出されます。 | CastDocument | |||
| background | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesbackground:Sprite [read-only]読み込まれるコンテンツよりも背面に表示したい DisplayObject を管理する Sprite インスタンスを取得します。 この値は CastPreloader 経由で読み込まれた場合のみ有効です。
Implementation public function get background():Sprite
| bottom | property |
bottom:Number [read-only]ステージ下の Y 座標を取得します。 Get the bottom Y coordinate of the stage.
Implementation public static function get bottom():Number
See also
| center | property |
center:Number [read-only]ステージ中央の X 座標を取得します。 Get the center X coordinate of the stage.
Implementation public static function get center():Number
See also
| contextMenu | property |
contextMenu:ContextMenu [read-write]Implementation
public function get contextMenu():ContextMenu
public function set contextMenu(value:ContextMenu):void
| executor | property |
executor:ExecutorObject [read-only]関連付けられている ExecutorObject インスタンスを取得します。
Implementation public function get executor():ExecutorObject
See also
| foreground | property |
foreground:Sprite [read-only]読み込まれるコンテンツよりも前面に表示したい DisplayObject を管理する Sprite インスタンスを取得します。 この値は CastPreloader 経由で読み込まれた場合のみ有効です。
Implementation public function get foreground():Sprite
| isPreloaded | property |
isPreloaded:Boolean [read-only]CastPreloader 経由で読み込まれているかどうかを取得します。
Implementation public function get isPreloaded():Boolean
| left | property |
left:Number [read-only]ステージ左の X 座標を取得します。 Get the left X coordinate of the stage.
Implementation public static function get left():Number
See also
| manager | property |
manager:Progression [read-only]関連付けられている Progression インスタンスを取得します。
Implementation public function get manager():Progression
See also
| middle | property |
middle:Number [read-only]ステージ中央の Y 座標を取得します。 Get the center Y coordinate of the stage.
Implementation public static function get middle():Number
See also
| numChildren | property |
numChildren:int [read-only]このオブジェクトの子の数を返します。 このインスタンスが SceneLoader によって読み込まれている場合には、関連付けられている DisplayObjectContainer の子の数を返します。
Implementation public function get numChildren():int
| onReady | property |
onReady:Function [read-write]SWF ファイルの読み込みが完了し、stage 及び loaderInfo にアクセス可能になった場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Implementation public function get onReady():Function
public function set onReady(value:Function):void
See also
| parent | property |
parent:DisplayObjectContainer [read-only]この表示オブジェクトを含む DisplayObjectContainer オブジェクトを示します。 このインスタンスが SceneLoader によって読み込まれている場合には、関連付けられている DisplayObjectContainer を示します。
Implementation public function get parent():DisplayObjectContainer
| right | property |
right:Number [read-only]ステージ右の X 座標を取得します。 Get the right X coordinate of the stage.
Implementation public static function get right():Number
See also
| root | property |
root:CastDocument [read-only]ロードされた SWF ファイル内の表示オブジェクトの場合、root プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。 For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.
Implementation public static function get root():CastDocument
| self | property |
| stage | property |
stage:Stage [read-only]表示オブジェクトのステージです。 The Stage of the display object.
Implementation public static function get stage():Stage
| top | property |
top:Number [read-only]ステージ上の Y 座標を取得します。 Get the top Y coordinate of the stage.
Implementation public static function get top():Number
See also
| CastDocument | () | constructor |
public function CastDocument(managerId:String = null, rootClass:Class = null, config:Configuration = null, initObject:Object = null)新しい CastDocument インスタンスを作成します。 Creates a new CastDocument object.
ParametersmanagerId:String (default = null) |
|
rootClass:Class (default = null) |
|
config:Configuration (default = null) |
|
initObject:Object (default = null) |
| addChild | () | method |
public override function addChild(child:DisplayObject):DisplayObjectこの DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。 Adds a child DisplayObject instance to this DisplayObjectContainer instance.
Parameterschild:DisplayObject — 対象の DisplayObjectContainer インスタンスの子として追加する DisplayObject インスタンスです。
The DisplayObject instance to add as a child of this DisplayObjectContainer instance.
|
DisplayObject — child パラメータで渡す DisplayObject インスタンスです。
The DisplayObject instance that you pass in the child parameter.
|
| addChildAt | () | method |
public override function addChildAt(child:DisplayObject, index:int):DisplayObjectこの DisplayObjectContainer インスタンスの指定されたインデックス位置に子 DisplayObject インスタンスを追加します。 Adds a child DisplayObject instance to this DisplayObjectContainer instance.
Parameterschild:DisplayObject — 対象の DisplayObjectContainer インスタンスの子として追加する DisplayObject インスタンスです。
The DisplayObject instance to add as a child of this DisplayObjectContainer instance.
|
|
index:int — 子を追加するインデックス位置です。
The index position to which the child is added. If you specify a currently occupied index position, the child object that exists at that position and all higher positions are moved up one position in the child list.
|
DisplayObject — child パラメータで渡す DisplayObject インスタンスです。
The DisplayObject instance that you pass in the child parameter.
|
| addChildAtAbove | () | method |
public override function addChildAtAbove(child:DisplayObject, index:int):DisplayObjectこの DisplayObjectContainer インスタンスの指定されたインデックス位置に子 DisplayObject インスタンスを追加します。 Adds a child DisplayObject instance to this DisplayObjectContainer instance.
Parameterschild:DisplayObject — 対象の DisplayObjectContainer インスタンスの子として追加する DisplayObject インスタンスです。
The DisplayObject instance to add as a child of this DisplayObjectContainer instance.
|
|
index:int — 子を追加するインデックス位置です。
The index position to which the child is added. If you specify a currently occupied index position, the child object that exists at that position and all higher positions are moved up one position in the child list.
|
DisplayObject — child パラメータで渡す DisplayObject インスタンスです。
The DisplayObject instance that you pass in the child parameter.
|
| addCommand | () | method |
public function addCommand(... commands):void特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
Parameters... commands — 登録したいコマンドを含む配列です。
|
See also
| atReady | () | method |
protected function atReady():voidSWF ファイルの読み込みが完了し、stage 及び loaderInfo にアクセス可能になった場合に呼び出されるオーバーライド・イベントハンドラメソッドです。
| clearCommand | () | method |
public function clearCommand(completely:Boolean = false):void登録されている Command インスタンスを削除します。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
Parameterscompletely:Boolean (default = false) |
See also
| contains | () | method |
public override function contains(child:DisplayObject):Boolean指定された表示オブジェクトが DisplayObjectContainer インスタンスの子であるか、オブジェクト自体であるかを指定します。 Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
Parameterschild:DisplayObject — テストする子 DisplayObject インスタンスです。
The child object to test.
|
Boolean — child インスタンスが DisplayObjectContainer の子であるか、コンテナ自体である場合は true となります。そうでない場合は false となります。
true if the child object is a child of the DisplayObjectContainer or the _container itself; otherwise false.
|
| getChildAt | () | method |
public override function getChildAt(index:int):DisplayObject指定のインデックス位置にある子表示オブジェクトオブジェクトを返します。 Returns the child display object instance that exists at the specified index.
Parametersindex:int — 子 DisplayObject インスタンスのインデックス位置です。
The index position of the child object.
|
DisplayObject — 指定されたインデックス位置にある子 DisplayObject インスタンスです。
The child display object at the specified index position.
|
| getChildByName | () | method |
public override function getChildByName(name:String):DisplayObject指定された名前に一致する子表示オブジェクトを返します。 Returns the child display object that exists with the specified name.
Parametersname:String — 返される子 DisplayObject インスタンスの名前です。
The name of the child to return.
|
DisplayObject — 指定された名前を持つ子 DisplayObject インスタンスです。
The child display object with the specified name.
|
| getChildIndex | () | method |
public override function getChildIndex(child:DisplayObject):int子 DisplayObject インスタンスのインデックス位置を返します。 Returns the index position of a child DisplayObject instance.
Parameterschild:DisplayObject — 特定する子 DisplayObject インスタンスです。
The DisplayObject instance to identify.
|
int — 特定する子 DisplayObject インスタンスのインデックス位置です。
The index position of the child display object to identify.
|
| insertCommand | () | method |
public function insertCommand(... commands):void特定のイベントが送出された際に、自動実行させたい Command インスタンスをすでにリストに登録され、実行中の Command インスタンスの次の位置に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に初期化されます。 このメソッドを使用するためには executor プロパティに CommandExecutor が実装されている必要があります。
Parameters... commands — 登録したいコマンドを含む配列です。
|
See also
| removeAllChildren | () | method |
public override function removeAllChildren():voidDisplayObjectContainer に追加されている全ての子 DisplayObject インスタンスを削除します。 Remove the whole child DisplayObject instance which added to the DisplayObjectContainer.
| removeChild | () | method |
public override function removeChild(child:DisplayObject):DisplayObjectDisplayObjectContainer インスタンスの子リストから指定の DisplayObject インスタンスを削除します。 Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
Parameterschild:DisplayObject — 対象の DisplayObjectContainer インスタンスの子から削除する DisplayObject インスタンスです。
The DisplayObject instance to remove.
|
DisplayObject — child パラメータで渡す DisplayObject インスタンスです。
The DisplayObject instance that you pass in the child parameter.
|
| removeChildAt | () | method |
public override function removeChildAt(index:int):DisplayObjectDisplayObjectContainer の子リストの指定されたインデックス位置から子 DisplayObject インスタンスを削除します。 Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
Parametersindex:int — 削除する DisplayObject の子インデックスです。
The child index of the DisplayObject to remove.
|
DisplayObject — 削除された DisplayObject インスタンスです。
The DisplayObject instance that was removed.
|
| setChildIndex | () | method |
public override function setChildIndex(child:DisplayObject, index:int):void表示オブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing child in the display object container.
Parameterschild:DisplayObject — インデックス番号を変更する子 DisplayObject インスタンスです。
The child DisplayObject instance for which you want to change the index number.
|
|
index:int — child インスタンスの結果のインデックス番号です。
The resulting index number for the child display object.
|
| setChildIndexAbove | () | method |
public override function setChildIndexAbove(child:DisplayObject, index:int):void表示オブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing child in the display object container.
Parameterschild:DisplayObject — インデックス番号を変更する子 DisplayObject インスタンスです。
The child DisplayObject instance for which you want to change the index number.
|
|
index:int — child インスタンスの結果のインデックス番号です。
The resulting index number for the child display object.
|
| swapChildren | () | method |
public override function swapChildren(child1:DisplayObject, child2:DisplayObject):void指定された 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the two specified child objects.
Parameterschild1:DisplayObject — 先頭の子 DisplayObject インスタンスです。
The first child object.
|
|
child2:DisplayObject — 2 番目の子 DisplayObject インスタンスです。
The second child object.
|
| swapChildrenAt | () | method |
public override function swapChildrenAt(index1:int, index2:int):void子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
Parametersindex1:int — 最初の子 DisplayObject インスタンスのインデックス位置です。
The index position of the first child object.
|
|
index2:int — 2 番目の子 DisplayObject インスタンスのインデックス位置です。
The index position of the second child object.
|
| updateManager | () | method |
public function updateManager():Booleanマネージャーオブジェクトとの関連付けを更新します。
ReturnsBoolean — 関連付けが成功したら true を、それ以外は false を返します。
|
See also
| managerActivate | event |
| managerDeactivate | event |