Packagejp.progression.scenes
Classpublic class SceneObject
InheritanceSceneObject Inheritance EventIntegrator Inheritance flash.events.EventDispatcher
Implements ICommandExecutable
Subclasses EasyCastingScene, ResumingScene

SceneObject クラスは、シーンコンテナとして機能する全てのオブジェクトの基本クラスです。

View the examples


Public Properties
 PropertyDefined By
  className : String
[read-only] インスタンスのクラス名を取得します。 Indicates the instance className of the SceneObject.
SceneObject
  eventHandlerEnabled : Boolean
オブジェクトのイベントハンドラメソッドを有効化するかどうかを指定します。
SceneObject
  executor : CommandExecutor
[read-only] コマンドを実行する CommandExecutor インスタンスを取得します。
SceneObject
  group : String
インスタンスのグループ名を取得または設定します。 Indicates the instance group of the SceneObject.
SceneObject
  id : String
インスタンスの識別子を取得または設定します。 Indicates the instance id of the SceneObject.
SceneObject
  isChild : Boolean
[read-only] カレントシーンの子シーンであるかどうかを取得します。
SceneObject
  isCurrent : Boolean
[read-only] カレントシーンであるかどうかを取得します。
SceneObject
  isParent : Boolean
[read-only] カレントシーンの親シーンであるかどうかを取得します。
SceneObject
  isVisited : Boolean
[read-only] 既読であるかどうかを取得します。
SceneObject
  name : String
インスタンスの名前を取得または設定します。 Indicates the instance name of the SceneObject.
SceneObject
  next : SceneObject
[read-only] このシーンオブジェクトの次に位置するシーンオブジェクトを取得します。
SceneObject
  numScenes : int
[read-only] 子シーンオブジェクトの数を取得します。
SceneObject
  onAscend : Function
シーンオブジェクトが SceneEvent.ASCEND イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。
SceneObject
  onDescend : Function
シーンオブジェクトが SceneEvent.DESCEND イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。
SceneObject
  onGoto : Function
シーンオブジェクトが SceneEvent.GOTO イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。
SceneObject
  onInit : Function
シーンオブジェクトが SceneEvent.INIT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。
SceneObject
  onLoad : Function
シーンオブジェクトが SceneEvent.LOAD イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。
SceneObject
  onSceneAdded : Function
シーンオブジェクトが SceneEvent.SCENE_ADDED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
SceneObject
  onSceneAddedToRoot : Function
シーンオブジェクトが SceneEvent.SCENE_ADDED_TO_ROOT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
SceneObject
  onSceneRemoved : Function
シーンオブジェクトが SceneEvent.SCENE_REMOVED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
SceneObject
  onSceneRemovedFromRoot : Function
シーンオブジェクトが SceneEvent.SCENE_REMOVED_FROM_ROOT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
SceneObject
  onSceneStateChange : Function
シーンオブジェクトが SceneEvent.SCENE_STATUS_CHANGE イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
SceneObject
  onSceneTitle : Function
シーンオブジェクトが SceneEvent.SCENE_TITLE イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
SceneObject
  onUnload : Function
シーンオブジェクトが SceneEvent.UNLOAD イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。
SceneObject
  parallelMode : Boolean
CommandExecutor の実行方法を並列処理にするかどうかを取得または設定します。
SceneObject
  parent : SceneObject
[read-only] このシーンオブジェクトを子に含んでいる親シーンオブジェクトを取得します。
SceneObject
  previous : SceneObject
[read-only] このシーンオブジェクトの前に位置するシーンオブジェクトを取得します。
SceneObject
  progression : Progression
[read-only] 関連付けられている Progression インスタンスを取得します。
SceneObject
  root : SceneObject
[read-only] シーンオブジェクトのツリー構造部分の一番上にある SceneObject インスタンスを取得します。
SceneObject
  sceneId : SceneId
[read-only] シーン識別子を取得します。
SceneObject
  sceneInfo : SceneInfo
[read-only] このオブジェクトが属するシーン情報を含む SceneInfo オブジェクトを取得します。
SceneObject
  scenes : Array
[read-only] 子シーンオブジェクトが保存されている配列です。 この配列を操作することで元の配列を変更することはできません。
SceneObject
  title : String
自身がカレントシーンの場合に、ブラウザのタイトルとして使用される文字列を取得または設定します。 ただし、設定を有効化するためには、ブラウザ同期機能が有効化されている必要があります。
SceneObject
Public Methods
 MethodDefined By
  
SceneObject(name:String = null, initObject:Object = null)
新しい SceneObject インスタンスを作成します。 Creates a new SceneObject object.
SceneObject
  
addCommand(... commands):void
特定のイベントが送出された際に、自動実行させたい Command インスタンスをリストの最後尾に追加します。 追加された Command インスタンスは、イベントが送出される直前に自動的に削除されます。
SceneObject
 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
  
addScene(scene:SceneObject):SceneObject
この SceneObject インスタンスに子 SceneObject インスタンスを追加します。 Adds a scene SceneObject instance to this SceneObject instance.
SceneObject
  
addSceneAt(scene:SceneObject, index:int):SceneObject
この SceneObject インスタンスの指定されたインデックス位置に子 SceneObject インスタンスを追加します。 Adds a scene SceneObject instance to this SceneObject instance.
SceneObject
  
addSceneAtAbove(scene:SceneObject, index:int):SceneObject
この SceneObject インスタンスの指定されたインデックス位置に子 SceneObject インスタンスを追加します。 Adds a scene SceneObject instance to this SceneObject instance.
SceneObject
  
addSceneFromXML(xml:XML):void
この SceneObject インスタンスの子を PRML 形式の XML データから追加します。
SceneObject
  
clearCommand(completely:Boolean = false):void
登録されている Command インスタンスを消去します。
SceneObject
 Inherited
completelyRemoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができません。 Remove the listener from EventIntegrator instance.
EventIntegrator
  
contains(scene:SceneObject):Boolean
指定されたシーンオブジェクトが SceneObject インスタンスの子であるか、オブジェクト自体であるかを指定します。 Determines whether the specified SceneObject is a scene of the SceneObject instance or the instance itself.
SceneObject
 Inherited
dispatchEvent(event:Event):Boolean
[override] イベントをイベントフローに送出します。 Dispatches an event into the event flow.
EventIntegrator
  
getSceneAt(index:int):SceneObject
指定のインデックス位置にある子シーンオブジェクトオブジェクトを返します。 Returns the scene SceneObject instance that exists at the specified index.
SceneObject
  
getSceneById(id:String):SceneObject
指定された id と同じ値が設定されている SceneObject インスタンスを返します。
SceneObject
  
getSceneByName(name:String):SceneObject
指定された名前に一致する子シーンオブジェクトを返します。 Returns the scene SceneObject that exists with the specified name.
SceneObject
  
getSceneBySceneId(sceneId:SceneId):SceneObject
指定された sceneId と同じ値が設定されている SceneObject インスタンスを返します。
SceneObject
  
getSceneIndex(scene:SceneObject):int
子 SceneObject インスタンスのインデックス位置を返します。 Returns the index position of a scene SceneObject instance.
SceneObject
  
getScenesByGroup(group:String, sort:Boolean = false):Array
指定された group と同じ値を持つ SceneObject インスタンスを含む配列を返します。
SceneObject
  
getScenesByRegExp(fieldName:String, pattern:RegExp, sort:Boolean = false):Array
指定された fieldName が条件と一致する SceneObject インスタンスを含む配列を返します。
SceneObject
 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 インスタンスは、イベントが送出される直前に自動的に削除されます。
SceneObject
 Inherited
removeAllListeners(completely:Boolean = false):void
addEventListener() メソッド経由で登録された全てのイベントリスナー登録を削除します。 完全に登録を削除しなかった場合には、削除されたイベントリスナーを restoreRemovedListeners() メソッドで復帰させることができます。 Remove the whole event listener registered via addEventListener() method.
EventIntegrator
  
removeAllScenes():void
SceneObject に追加されている全ての子 SceneObject インスタンスを削除します。
SceneObject
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventIntegrator instance.
EventIntegrator
  
removeScene(scene:SceneObject):SceneObject
SceneObject インスタンスの子リストから指定の SceneObject インスタンスを削除します。 Removes the specified scene SceneObject instance from the scene list of the SceneObject instance.
SceneObject
  
removeSceneAt(index:int):SceneObject
SceneObject の子リストの指定されたインデックス位置から子 SceneObject インスタンスを削除します。 Removes a child SceneObject from the specified index position in the child list of the SceneObject.
SceneObject
 Inherited
restoreRemovedListeners():void
removeEventListener() メソッド、または removeAllListeners() メソッド経由で削除された全てイベントリスナーを再登録します。 Re-register the whole event listener removed via removeEventListener() or removeAllListeners() method.
EventIntegrator
  
setProperties(props:Object):SceneObject
インスタンスに対して、複数のプロパティを一括設定します。
SceneObject
  
setSceneIndex(scene:SceneObject, index:int):void
シーンオブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing scene in the SceneObject container.
SceneObject
  
setSceneIndexAbove(scene:SceneObject, index:int):void
シーンオブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing scene in the SceneObject container.
SceneObject
  
swapScenes(scene1:SceneObject, scene2:SceneObject):void
指定された 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the two specified scene objects.
SceneObject
  
swapScenesAt(index1:int, index2:int):void
子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the scene objects at the two specified index positions in the scene list.
SceneObject
  
toString():String
[override] 指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
SceneObject
  
toXMLString():String
指定されたオブジェクトの XML ストリング表現を返します。
SceneObject
 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
  
_onAscend():void
サブクラスで onAscend イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onAscend プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
  
_onDescend():void
サブクラスで onDescend イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onDescend プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
  
_onGoto():void
サブクラスで onGoto イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onGoto プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
  
_onInit():void
サブクラスで onInit イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onInit プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
  
_onLoad():void
サブクラスで onLoad イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onLoad プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
  
_onSceneAdded():void
サブクラスで onSceneAdded イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onSceneAdded プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
  
_onSceneAddedToRoot():void
サブクラスで onSceneAddedToRoot イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onSceneAddedToRoot プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
  
_onSceneRemoved():void
サブクラスで onSceneRemoved イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onSceneRemoved プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
  
_onSceneRemovedFromRoot():void
サブクラスで onSceneRemovedFromRoot イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onSceneRemovedFromRoot プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
  
_onSceneStateChange():void
サブクラスで onSceneStateChange イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onSceneStateChange プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
  
_onSceneTitle():void
サブクラスで onSceneTitle イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onSceneTitle プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
  
_onUnload():void
サブクラスで onUnload イベントハンドラメソッドの処理を override で実装したい場合に上書きします。 onUnload プロパティに、別のメソッドを設定された場合は無効化されます。
SceneObject
Events
 Event Summary Defined By
  
ascend
シーン移動時に目的地がシーンオブジェクトの親階層であり、かつ出発地ではない場合に、移動を中継した瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。SceneObject
  
descend
シーン移動時に目的地がシーンオブジェクトの子階層であり、かつ出発地ではない場合に、移動を中継した瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。SceneObject
  
goto
シーンオブジェクトが出発地だった場合に、移動を開始した瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。SceneObject
  
init
シーンオブジェクトが目的地だった場合に、到達した瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。SceneObject
  
load
シーン移動時に目的地がシーンオブジェクト自身もしくは子階層だった場合に、階層が変更された瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。SceneObject
  
sceneAdded
シーンオブジェクトがシーンリストに追加された場合に送出されます。SceneObject
  
sceneAddedToRoot
シーンオブジェクトが直接、またはシーンオブジェクトを含むサブツリーの追加により、ルートシーン上のシーンリストに追加されたときに送出されます。SceneObject
  
sceneRemoved
シーンオブジェクトがシーンリストから削除された場合に送出されます。SceneObject
  
sceneRemovedFromRoot
シーンオブジェクトが直接、またはシーンオブジェクトを含むサブツリーの削除により、ルートシーン上のシーンリストから削除されようとしているときに送出されます。SceneObject
  
sceneStateChange
シーンオブジェクトの状態が変更された場合に送出されます。SceneObject
  
sceneTitle
シーンオブジェクトのタイトルが変更された場合に送出されます。SceneObject
  
unload
シーン移動時に目的地がシーンオブジェクト自身もしくは親階層だった場合に、階層が変更された瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。SceneObject
Property Detail
__ownerproperty
__owner:Progression


Implementation
    progression_internal static function get __owner():Progression
    progression_internal static function set __owner(value:Progression):void
classNameproperty 
className:String  [read-only]

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


Implementation
    public function get className():String
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
groupproperty 
group:String

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


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

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


Implementation
    public function get id():String
    public function set id(value:String):void
isChildproperty 
isChild:Boolean  [read-only]

カレントシーンの子シーンであるかどうかを取得します。


Implementation
    public function get isChild():Boolean
isCurrentproperty 
isCurrent:Boolean  [read-only]

カレントシーンであるかどうかを取得します。


Implementation
    public function get isCurrent():Boolean
isParentproperty 
isParent:Boolean  [read-only]

カレントシーンの親シーンであるかどうかを取得します。


Implementation
    public function get isParent():Boolean
isVisitedproperty 
isVisited:Boolean  [read-only]

既読であるかどうかを取得します。


Implementation
    public function get isVisited():Boolean
nameproperty 
name:String

インスタンスの名前を取得または設定します。 Indicates the instance name of the SceneObject.


Implementation
    public function get name():String
    public function set name(value:String):void
nextproperty 
next:SceneObject  [read-only]

このシーンオブジェクトの次に位置するシーンオブジェクトを取得します。


Implementation
    public function get next():SceneObject
numScenesproperty 
numScenes:int  [read-only]

子シーンオブジェクトの数を取得します。


Implementation
    public function get numScenes():int
onAscendproperty 
onAscend:Function

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


Implementation
    public function get onAscend():Function
    public function set onAscend(value:Function):void
onDescendproperty 
onDescend:Function

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


Implementation
    public function get onDescend():Function
    public function set onDescend(value:Function):void
onGotoproperty 
onGoto:Function

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


Implementation
    public function get onGoto():Function
    public function set onGoto(value:Function):void
onInitproperty 
onInit:Function

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


Implementation
    public function get onInit():Function
    public function set onInit(value:Function):void
onLoadproperty 
onLoad:Function

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


Implementation
    public function get onLoad():Function
    public function set onLoad(value:Function):void
onSceneAddedproperty 
onSceneAdded:Function

シーンオブジェクトが SceneEvent.SCENE_ADDED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。


Implementation
    public function get onSceneAdded():Function
    public function set onSceneAdded(value:Function):void
onSceneAddedToRootproperty 
onSceneAddedToRoot:Function

シーンオブジェクトが SceneEvent.SCENE_ADDED_TO_ROOT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。


Implementation
    public function get onSceneAddedToRoot():Function
    public function set onSceneAddedToRoot(value:Function):void
onSceneRemovedproperty 
onSceneRemoved:Function

シーンオブジェクトが SceneEvent.SCENE_REMOVED イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。


Implementation
    public function get onSceneRemoved():Function
    public function set onSceneRemoved(value:Function):void
onSceneRemovedFromRootproperty 
onSceneRemovedFromRoot:Function

シーンオブジェクトが SceneEvent.SCENE_REMOVED_FROM_ROOT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。


Implementation
    public function get onSceneRemovedFromRoot():Function
    public function set onSceneRemovedFromRoot(value:Function):void
onSceneStateChangeproperty 
onSceneStateChange:Function

シーンオブジェクトが SceneEvent.SCENE_STATUS_CHANGE イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。


Implementation
    public function get onSceneStateChange():Function
    public function set onSceneStateChange(value:Function):void
onSceneTitleproperty 
onSceneTitle:Function

シーンオブジェクトが SceneEvent.SCENE_TITLE イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。


Implementation
    public function get onSceneTitle():Function
    public function set onSceneTitle(value:Function):void
onUnloadproperty 
onUnload:Function

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


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

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


Implementation
    public function get parallelMode():Boolean
    public function set parallelMode(value:Boolean):void
parentproperty 
parent:SceneObject  [read-only]

このシーンオブジェクトを子に含んでいる親シーンオブジェクトを取得します。


Implementation
    public function get parent():SceneObject
previousproperty 
previous:SceneObject  [read-only]

このシーンオブジェクトの前に位置するシーンオブジェクトを取得します。


Implementation
    public function get previous():SceneObject
progressionproperty 
progression:Progression  [read-only]

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


Implementation
    public function get progression():Progression
rootproperty 
root:SceneObject  [read-only]

シーンオブジェクトのツリー構造部分の一番上にある SceneObject インスタンスを取得します。


Implementation
    public function get root():SceneObject
sceneIdproperty 
sceneId:SceneId  [read-only]

シーン識別子を取得します。


Implementation
    public function get sceneId():SceneId
sceneInfoproperty 
sceneInfo:SceneInfo  [read-only]

このオブジェクトが属するシーン情報を含む SceneInfo オブジェクトを取得します。


Implementation
    public function get sceneInfo():SceneInfo
scenesproperty 
scenes:Array  [read-only]

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


Implementation
    public function get scenes():Array
titleproperty 
title:String

自身がカレントシーンの場合に、ブラウザのタイトルとして使用される文字列を取得または設定します。 ただし、設定を有効化するためには、ブラウザ同期機能が有効化されている必要があります。


Implementation
    public function get title():String
    public function set title(value:String):void
Constructor Detail
SceneObject()Constructor
public function SceneObject(name:String = null, initObject:Object = null)

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

Parameters
name:String (default = null) — シーンの名前です。
 
initObject:Object (default = null) — 設定したいプロパティを含んだオブジェクトです。
Method Detail
_onAscend()method
protected function _onAscend():void

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

_onDescend()method 
protected function _onDescend():void

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

_onGoto()method 
protected function _onGoto():void

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

_onInit()method 
protected function _onInit():void

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

_onLoad()method 
protected function _onLoad():void

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

_onSceneAdded()method 
protected function _onSceneAdded():void

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

_onSceneAddedToRoot()method 
protected function _onSceneAddedToRoot():void

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

_onSceneRemoved()method 
protected function _onSceneRemoved():void

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

_onSceneRemovedFromRoot()method 
protected function _onSceneRemovedFromRoot():void

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

_onSceneStateChange()method 
protected function _onSceneStateChange():void

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

_onSceneTitle()method 
protected function _onSceneTitle():void

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

_onUnload()method 
protected function _onUnload():void

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

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

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

Parameters

... commands — 追加したいコマンドを含む配列です。

addScene()method 
public function addScene(scene:SceneObject):SceneObject

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

Parameters

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

Returns
SceneObject — scene パラメータで渡す SceneObject インスタンスです。 The SceneObject instance that you pass in the scene parameter.
addSceneAt()method 
public function addSceneAt(scene:SceneObject, index:int):SceneObject

この SceneObject インスタンスの指定されたインデックス位置に子 SceneObject インスタンスを追加します。 Adds a scene SceneObject instance to this SceneObject instance.

Parameters

scene:SceneObject — 対象の SceneObject インスタンスの子として追加する SceneObject インスタンスです。 The SceneObject instance to add as a scene of this SceneObject instance.
 
index:int — 子を追加するインデックス位置です。 The index position to which the scene is added. If you specify a currently occupied index position, the scene object that exists at that position and all higher positions are moved up one position in the scene list.

Returns
SceneObject — child パラメータで渡す SceneObject インスタンスです。 The SceneObject instance that you pass in the scene parameter.
addSceneAtAbove()method 
public function addSceneAtAbove(scene:SceneObject, index:int):SceneObject

この SceneObject インスタンスの指定されたインデックス位置に子 SceneObject インスタンスを追加します。 Adds a scene SceneObject instance to this SceneObject instance.

Parameters

scene:SceneObject — 対象の SceneObject インスタンスの子として追加する SceneObject インスタンスです。 The SceneObject instance to add as a scene of this SceneObject instance.
 
index:int — 子を追加するインデックス位置です。 The index position to which the scene is added. If you specify a currently occupied index position, the scene object that exists at that position and all higher positions are moved up one position in the scene list.

Returns
SceneObject — child パラメータで渡す SceneObject インスタンスです。 The SceneObject instance that you pass in the scene parameter.
addSceneFromXML()method 
public function addSceneFromXML(xml:XML):void

この SceneObject インスタンスの子を PRML 形式の XML データから追加します。

Parameters

xml:XML — PRML 形式の XML データです。

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

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

Parameters

completely:Boolean (default = false) — 登録されている全てのコマンドを消去する場合には true を、現在処理しているコマンド以降を消去する場合には false となります。

contains()method 
public function contains(scene:SceneObject):Boolean

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

Parameters

scene:SceneObject — テストする子 SceneObject インスタンスです。 The scene object to test.

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

指定のインデックス位置にある子シーンオブジェクトオブジェクトを返します。 Returns the scene SceneObject instance that exists at the specified index.

Parameters

index:int — 子 SceneObject インスタンスのインデックス位置です。 The index position of the scene object.

Returns
SceneObject — 指定されたインデックス位置にある子 SceneObject インスタンスです。 The scene SceneObject at the specified index position.
getSceneById()method 
public function getSceneById(id:String):SceneObject

指定された id と同じ値が設定されている SceneObject インスタンスを返します。

Parameters

id:String — 条件となるストリングです。

Returns
SceneObject — 条件と一致するインスタンスです。
getSceneByName()method 
public function getSceneByName(name:String):SceneObject

指定された名前に一致する子シーンオブジェクトを返します。 Returns the scene SceneObject that exists with the specified name.

Parameters

name:String — 返される子 SceneObject インスタンスの名前です。 The name of the scene to return.

Returns
SceneObject — 指定された名前を持つ子 SceneObject インスタンスです。 The scene SceneObject with the specified name.
getSceneBySceneId()method 
public function getSceneBySceneId(sceneId:SceneId):SceneObject

指定された sceneId と同じ値が設定されている SceneObject インスタンスを返します。

Parameters

sceneId:SceneId — 条件となる SceneId インスタンスです。

Returns
SceneObject — 条件と一致するインスタンスです。
getSceneIndex()method 
public function getSceneIndex(scene:SceneObject):int

子 SceneObject インスタンスのインデックス位置を返します。 Returns the index position of a scene SceneObject instance.

Parameters

scene:SceneObject — 特定する子 SceneObject インスタンスです。 The SceneObject instance to identify.

Returns
int — 特定する子 SceneObject インスタンスのインデックス位置です。 The index position of the scene SceneObject to identify.
getScenesByGroup()method 
public function getScenesByGroup(group:String, sort:Boolean = false):Array

指定された group と同じ値を持つ SceneObject インスタンスを含む配列を返します。

Parameters

group:String — 条件となるストリングです。
 
sort:Boolean (default = false) — 配列をソートするかどうかを指定します。

Returns
Array — 条件と一致するインスタンスです。
getScenesByRegExp()method 
public function getScenesByRegExp(fieldName:String, pattern:RegExp, sort:Boolean = false):Array

指定された fieldName が条件と一致する SceneObject インスタンスを含む配列を返します。

Parameters

fieldName:String — 調査するフィールド名です。
 
pattern:RegExp — 条件となる正規表現です。
 
sort:Boolean (default = false) — 配列をソートするかどうかを指定します。

Returns
Array — 条件と一致するインスタンスです。
insertCommand()method 
public function insertCommand(... commands):void

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

Parameters

... commands — 追加したいコマンドを含む配列です。

removeAllScenes()method 
public function removeAllScenes():void

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

removeScene()method 
public function removeScene(scene:SceneObject):SceneObject

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

Parameters

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

Returns
SceneObject — scene パラメータで渡す SceneObject インスタンスです。 The SceneObject instance that you pass in the scene parameter.
removeSceneAt()method 
public function removeSceneAt(index:int):SceneObject

SceneObject の子リストの指定されたインデックス位置から子 SceneObject インスタンスを削除します。 Removes a child SceneObject from the specified index position in the child list of the SceneObject.

Parameters

index:int — 削除する SceneObject の子インデックスです。 The child index of the SceneObject to remove.

Returns
SceneObject — 削除された SceneObject インスタンスです。 The SceneObject instance that was removed.
setProperties()method 
public function setProperties(props:Object):SceneObject

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

Parameters

props:Object — 設定したいプロパティを含んだオブジェクトです。

Returns
SceneObject — 設定対象の SceneObject インスタンスです。
setSceneIndex()method 
public function setSceneIndex(scene:SceneObject, index:int):void

シーンオブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing scene in the SceneObject container.

Parameters

scene:SceneObject — インデックス番号を変更する子 SceneObject インスタンスです。 The scene SceneObject instance for which you want to change the index number.
 
index:int — child インスタンスの結果のインデックス番号です。 The resulting index number for the scene SceneObject.

setSceneIndexAbove()method 
public function setSceneIndexAbove(scene:SceneObject, index:int):void

シーンオブジェクトコンテナの既存の子の位置を変更します。 Changes the position of an existing scene in the SceneObject container.

Parameters

scene:SceneObject — インデックス番号を変更する子 SceneObject インスタンスです。 The scene SceneObject instance for which you want to change the index number.
 
index:int — child インスタンスの結果のインデックス番号です。 The resulting index number for the scene SceneObject.

swapScenes()method 
public function swapScenes(scene1:SceneObject, scene2:SceneObject):void

指定された 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the two specified scene objects.

Parameters

scene1:SceneObject — 先頭の子 SceneObject インスタンスです。 The first scene object.
 
scene2:SceneObject — 2 番目の子 SceneObject インスタンスです。 The second scene object.

swapScenesAt()method 
public function swapScenesAt(index1:int, index2:int):void

子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序（重ね順）を入れ替えます。 Swaps the z-order (front-to-back order) of the scene objects at the two specified index positions in the scene list.

Parameters

index1:int — 最初の子 SceneObject インスタンスのインデックス位置です。 The index position of the first scene object.
 
index2:int — 2 番目の子 SceneObject インスタンスのインデックス位置です。 The index position of the second scene object.

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

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

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

指定されたオブジェクトの XML ストリング表現を返します。

Returns
String — オブジェクトの XML ストリング表現です。
Event Detail
ascend Event
Event Object Type: jp.progression.events.SceneEvent
SceneEvent.type property = jp.progression.events.SceneEvent.ASCEND

シーン移動時に目的地がシーンオブジェクトの親階層であり、かつ出発地ではない場合に、移動を中継した瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。

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

シーン移動時に目的地がシーンオブジェクトの子階層であり、かつ出発地ではない場合に、移動を中継した瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。

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

シーンオブジェクトが出発地だった場合に、移動を開始した瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。

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

シーンオブジェクトが目的地だった場合に、到達した瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。

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

シーン移動時に目的地がシーンオブジェクト自身もしくは子階層だった場合に、階層が変更された瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。

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

シーンオブジェクトがシーンリストに追加された場合に送出されます。

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

シーンオブジェクトが直接、またはシーンオブジェクトを含むサブツリーの追加により、ルートシーン上のシーンリストに追加されたときに送出されます。

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

シーンオブジェクトがシーンリストから削除された場合に送出されます。

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

シーンオブジェクトが直接、またはシーンオブジェクトを含むサブツリーの削除により、ルートシーン上のシーンリストから削除されようとしているときに送出されます。

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

シーンオブジェクトの状態が変更された場合に送出されます。

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

シーンオブジェクトのタイトルが変更された場合に送出されます。

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

シーン移動時に目的地がシーンオブジェクト自身もしくは親階層だった場合に、階層が変更された瞬間に送出されます。 このイベント処理の実行中には、addCommand() メソッド、及び insertCommand() メソッドによるコマンドの同期処理が行えます。

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



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