jp.progression.Progression

	Property	Defined by
		autoLock : Boolean シーンの移動シーケンスが開始された場合に、自動的に lock プロパティを true にするかどうかを取得または設定します。移動シーケンスが完了後には、lock プロパティは自動的に false に設定されます。	Progression
		config : Configuration [static][read-only] 初期化時に指定された Configuration を取得します。	Progression
		current : SceneObject [read-only] 現在位置となる SceneObject インスタンスを取得します。	Progression
		currentSceneId : SceneId [read-only] 現在位置を示すシーン識別子を取得します。	Progression
		departedSceneId : SceneId [read-only] 出発位置を示すシーン識別子を取得します。	Progression
		destinedSceneId : SceneId [read-only] 目的位置を示すシーン識別子を取得します。	Progression
		eventType : String [read-only] 現在のイベントタイプを取得します。	Progression
		extra : Object [read-only] 実行時のリレーオブジェクトを取得します。	Progression
		group : String インスタンスのグループ名を取得または設定します。 Indicates the instance group of the Progression.	Progression
		history : IHistoryManager [read-only] この Progression インスタンスに関する履歴を管理している IHistoryManager インスタンスを取得します。	Progression
		id : String インスタンスの識別子を取得します。 Indicates the instance id of the Progression.	Progression
		lock : Boolean シーン移動処理の実行中に、新しい移動シーケンスの開始を無効化するかどうかを取得または設定します。このプロパティを設定すると autoLock プロパティが強制的に false に設定されます。	Progression
		root : SceneObject [read-only] シーンツリーの最上位に位置する SceneObject インスタンスを取得します。	Progression
		stage : Stage [read-only] 関連付けられている Stage インスタンスを取得します。	Progression
		state : int [read-only] 現在の処理状態を取得します。	Progression
		sync : Boolean この Progression インスタンスを同期対象として設定するかどうかを取得または設定します。同期対象として有効化するためには、Progression を初期化する際にシンクロ機能に対応している Configuration を設定しておく必要があります。	Progression
		syncedManager : Progression [static][read-only] 現在同期中の Progression インスタンスを取得します。	Progression
		syncedSceneId : SceneId [read-only] 同期機能が有効化された状態でのシーン識別子を取得します。	Progression

	Method	Defined by
		Progression(id:String, container:DisplayObjectContainer, rootClass:Class = null, initObject:Object = null) 新しい Progression インスタンスを作成します。 Creates a new Progression object.	Progression
		createFromXML(container:DisplayObjectContainer, prml:XML):Progression [static] XML データから Progression インスタンスを生成します。	Progression
		goto(sceneId:SceneId, extra:Object = null):Boolean シーンを移動します。	Progression
		initialize(config:Configuration):Boolean [static] Progression を初期化します。この処理は Progression インスタンスを作成する前の状態で 1 回のみ行うことができます。	Progression
		jumpto(sceneId:SceneId, extra:Object = null):Boolean シーン移動に関係した処理を全て無視して、すぐに移動します。	Progression
		setProperties(parameters:Object):Progression インスタンスに対して、複数のプロパティを一括設定します。	Progression
		stop():void シーン移動処理を中断します。	Progression
		toString():String 指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.	Progression

Summary	Defined by
managerLockChange	オブジェクトの lock プロパティの値が変更されたときに送出されます。	Progression
managerReady	シーン移動処理が実行可能になった瞬間に送出されます。このイベントが送出される以前に実行された移動命令は、実行可能になるまでスタックされます。	Progression
processChange	管理下にあるシーンの移動処理中に移動先が変更された場合に送出されます。	Progression
processComplete	管理下にあるシーンの移動処理が完了した場合に送出されます。	Progression
processError	シーン移動中にエラーが発生した場合に送出されます。	Progression
processEvent	管理下にあるシーンの移動処理中に対象シーンでイベントが発生した場合に送出されます。	Progression
processScene	管理下にあるシーンの移動処理中に対象シーンが変更された場合に送出されます。	Progression
processStart	管理下にあるシーンの移動処理が開始された場合に送出されます。	Progression
processStop	管理下にあるシーンの移動処理が停止された場合に送出されます。	Progression

	Constant	Defined by
		AUTHOR : String = "Copyright (C) 2007-2010 taka:nium.jp, All Rights Reserved." [static] パッケージの制作者を取得します。	Progression
		NAME : String = "Progression" [static] パッケージの名前を取得します。 Package name	Progression
		URL : String = "http://progression.jp/" [static] パッケージの URL を取得します。	Progression
		VERSION : String = "4.0.31" [static] パッケージのバージョン情報を取得します。	Progression

Property detail

autoLock

property

autoLock:Boolean [read-write]

シーンの移動シーケンスが開始された場合に、自動的に lock プロパティを true にするかどうかを取得または設定します。移動シーケンスが完了後には、lock プロパティは自動的に false に設定されます。

Implementation
public function get autoLock():Boolean
public function set autoLock(value:Boolean):void

See also

lock
goto()
jumpto()

config

property

config:Configuration [read-only]

初期化時に指定された Configuration を取得します。

Implementation
public static function get config():Configuration

See also

initialize()

current

property

current:SceneObject [read-only]

現在位置となる SceneObject インスタンスを取得します。

Implementation
public function get current():SceneObject

currentSceneId

property

currentSceneId:SceneId [read-only]

現在位置を示すシーン識別子を取得します。

Implementation
public function get currentSceneId():SceneId

departedSceneId

property

departedSceneId:SceneId [read-only]

出発位置を示すシーン識別子を取得します。

Implementation
public function get departedSceneId():SceneId

destinedSceneId

property

destinedSceneId:SceneId [read-only]

目的位置を示すシーン識別子を取得します。

Implementation
public function get destinedSceneId():SceneId

eventType

property

eventType:String [read-only]

現在のイベントタイプを取得します。

Implementation
public function get eventType():String

See also

goto()
jp.progression.events.SceneEvent

extra

property

extra:Object [read-only]

実行時のリレーオブジェクトを取得します。

Implementation
public function get extra():Object

group

property

group:String [read-write]

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

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

See also

jp.progression.getManagersByGroup()

history

property

history:IHistoryManager [read-only]

この Progression インスタンスに関する履歴を管理している IHistoryManager インスタンスを取得します。

Implementation
public function get history():IHistoryManager

See also

goto()
jumpto()

property

id:String [read-write]

インスタンスの識別子を取得します。 Indicates the instance id of the Progression.

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

See also

jp.progression.getManagerById()

lock

property

lock:Boolean [read-write]

シーン移動処理の実行中に、新しい移動シーケンスの開始を無効化するかどうかを取得または設定します。このプロパティを設定すると autoLock プロパティが強制的に false に設定されます。

Implementation
public function get lock():Boolean
public function set lock(value:Boolean):void

See also

autoLock
goto()
jumpto()

root

property

root:SceneObject [read-only]

シーンツリーの最上位に位置する SceneObject インスタンスを取得します。

Implementation
public function get root():SceneObject

stage

property

stage:Stage [read-only]

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

Implementation
public function get stage():Stage

state

property

state:int [read-only]

現在の処理状態を取得します。

Implementation
public function get state():int

sync

property

sync:Boolean [read-write]

この Progression インスタンスを同期対象として設定するかどうかを取得または設定します。同期対象として有効化するためには、Progression を初期化する際にシンクロ機能に対応している Configuration を設定しておく必要があります。

Implementation
public function get sync():Boolean
public function set sync(value:Boolean):void

See also

jp.progression.config

syncedManager

property

syncedManager:Progression [read-only]

現在同期中の Progression インスタンスを取得します。

Implementation
public static function get syncedManager():Progression

See also

sync

syncedSceneId

property

syncedSceneId:SceneId [read-only]

同期機能が有効化された状態でのシーン識別子を取得します。

Implementation
public function get syncedSceneId():SceneId

Constructor detail

Progression

()

constructor

public function Progression(id:String, container:DisplayObjectContainer, rootClass:Class = null, initObject:Object = null)

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

Parameters

	`id:String` — インスタンスの識別子です。

	`container:DisplayObjectContainer` — 関連付けたい DisplayObjectContainer インスタンスです。

	`rootClass:Class` (default = `null`) — ルートシーンに関連付けたいクラスの参照です。

	`initObject:Object` (default = `null`) — 設定したいプロパティを含んだオブジェクトです。

Method detail

createFromXML

()

method

public static function createFromXML(container:DisplayObjectContainer, prml:XML):Progression

XML データから Progression インスタンスを生成します。

Parameters

	`container:DisplayObjectContainer` — 関連付けたい Stage インスタンスです。

	`prml:XML` — 生成時に使用する設定情報を含んだ XML オブジェクトです。

Returns

Progression — 生成された Progression インスタンスです。

Example

   // 環境設定を指定する
   Progression.initialize( new BasicAppConfig() );
   
   // XML データを作成する
   var prml:XML =
   <prml version="2.0.0" type="text/prml.plain">
    <scene name="index">
     <scene name="about">
     </scene>
     <scene name="gallery">
     </scene>
     <scene name="contact">
     </scene>
    </scene>
   </prml>;
   
   // XML データから Progression インスタンスを作成する
   var manager:Progression = Progression.createFromXML( stage, prml );

goto

()

method

public function goto(sceneId:SceneId, extra:Object = null):Boolean

シーンを移動します。

Parameters

	`sceneId:SceneId` — 移動先を示すシーン識別子です。

	`extra:Object` (default = `null`) — 実行時にコマンドフローをリレーするオブジェクトです。

Returns

Boolean — 移動処理が正常に実行された場合は true を、それ以外は false を返します。

See also

jumpto()
stop()

initialize

()

method

public static function initialize(config:Configuration):Boolean

Progression を初期化します。この処理は Progression インスタンスを作成する前の状態で 1 回のみ行うことができます。

Parameters

config:Configuration — 初期化情報として使用したい Configuration インスタンスです。

Returns

Boolean — 初期化に成功した場合には true を、失敗した場合には false を返します。

See also

config
jp.progression.config

Example

   // 環境設定を指定する
   Progression.initialize( new BasicAppConfig() );
   
   // Progression インスタンスを作成する
   var manager:Progression = new Progression( "index", stage );

jumpto

()

method

public function jumpto(sceneId:SceneId, extra:Object = null):Boolean

シーン移動に関係した処理を全て無視して、すぐに移動します。

Parameters

	`sceneId:SceneId` — 移動先を示すシーン識別子です。

	`extra:Object` (default = `null`) — 実行時にコマンドフローをリレーするオブジェクトです。

Returns

Boolean — 移動処理が正常に実行された場合は true を、それ以外は false を返します。

See also

goto()
stop()

setProperties

()

method

public function setProperties(parameters:Object):Progression

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

Parameters

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

Returns

Progression — 自身の参照です。

stop

()

method

public function stop():void

シーン移動処理を中断します。

See also

goto()
jumpto()

toString

()

method

public override function toString():String

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

Returns

String — オブジェクトのストリング表現です。 A string representation of the object.

Event detail

managerLockChange

event

Event object type: jp.progression.events.ManagerEvent

オブジェクトの lock プロパティの値が変更されたときに送出されます。

managerReady

event

Event object type: jp.progression.events.ManagerEvent

シーン移動処理が実行可能になった瞬間に送出されます。このイベントが送出される以前に実行された移動命令は、実行可能になるまでスタックされます。

processChange

event

Event object type: jp.progression.events.ProcessEvent

管理下にあるシーンの移動処理中に移動先が変更された場合に送出されます。

processComplete

event

Event object type: jp.progression.events.ProcessEvent

管理下にあるシーンの移動処理が完了した場合に送出されます。

processError

event

Event object type: jp.progression.events.ProcessEvent

シーン移動中にエラーが発生した場合に送出されます。

processEvent

event

Event object type: jp.progression.events.ProcessEvent

管理下にあるシーンの移動処理中に対象シーンでイベントが発生した場合に送出されます。

processScene

event

Event object type: jp.progression.events.ProcessEvent

管理下にあるシーンの移動処理中に対象シーンが変更された場合に送出されます。

processStart

event

Event object type: jp.progression.events.ProcessEvent

管理下にあるシーンの移動処理が開始された場合に送出されます。

processStop

event

Event object type: jp.progression.events.ProcessEvent

管理下にあるシーンの移動処理が停止された場合に送出されます。

Constant detail

AUTHOR

constant

パッケージの制作者を取得します。

NAME

constant

public static const NAME:String = "Progression"

パッケージの名前を取得します。 Package name

URL

constant

public static const URL:String = "http://progression.jp/"

パッケージの URL を取得します。

VERSION

constant

public static const VERSION:String = "4.0.31"

パッケージのバージョン情報を取得します。

Progression 4.0 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class Progression	Properties \| Methods \| Events \| Constants

Package	jp.progression
Class	public class Progression
Inheritance	Progression flash.events.EventDispatcher
Implements	IIdGroup