Packagejp.progression.scenes
Classpublic class SceneId

SceneId クラスは、シーンオブジェクト構造上の特定のシーンを表すモデルクラスです。


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


Public Properties
 PropertyDefined by
  length : int
[read-only] シーンパスの深度を取得します。
SceneId
  path : String
[read-only] シーンパスを取得します。
SceneId
  query : Query
[read-only] シーンパスに関連付けられているクエリオブジェクトを取得します。
SceneId
Public Methods
 MethodDefined by
  
SceneId(scenePath:String, query:* = null)
新しい SceneId インスタンスを作成します。 Creates a new SceneId object.
SceneId
  
clone():SceneId
SceneId インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an SceneId subclass.
SceneId
  
contains(sceneId:SceneId):Boolean
指定されたシーン識別子が、自身の表すシーンパスの子シーンオブジェクトを指しているかどうかを返します。
SceneId
  
equals(sceneId:SceneId, matchQuery:Boolean = false):Boolean
指定されたシーン識別子が、自身の表すシーンパスと同一かどうかを返します。
SceneId
  
getNameByIndex(index:int):String
指定位置にあるシーンの名前を返します。
SceneId
  
isNaS(sceneId:SceneId):Boolean
[static] 対象のシーン識別子が NaS であるかどうかを返します。
SceneId
  
slice(startIndex:int = 0, endIndex:int = 0x7FFFFFFF):SceneId
シーン識別子の保存するシーンパスの指定された範囲のエレメントを取り出して、新しいシーン識別子を返します。 この操作で元のシーン識別子は変更されません。
SceneId
  
toShortPath():String
同期時に使用されるルートを省略したショートパスを表すストリングを返します。
SceneId
  
toString():String
指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
SceneId
  
transfer(scenePath:String, query:* = null):SceneId
指定された絶対シーンパスもしくは相対シーンパスを使用して移動後のシーン識別子を返します。 この操作で元のシーン識別子は変更されません。
SceneId
  
validateName(name:String):Boolean
[static] シーン名の書式が正しいかどうかを返します。
SceneId
  
validatePath(path:String):Boolean
[static] シーンパスの書式が正しいかどうかを返します。
SceneId
Public Constants
 ConstantDefined by
  NaS : SceneId
[static] 非 SceneId の値を表す SceneId 型の特殊なメンバーを取得します。
SceneId
Property detail
lengthproperty
length:int  [read-only]

シーンパスの深度を取得します。

Implementation
    public function get length():int
pathproperty 
path:String  [read-only]

シーンパスを取得します。

Implementation
    public function get path():String
queryproperty 
query:Query  [read-only]

シーンパスに関連付けられているクエリオブジェクトを取得します。

Implementation
    public function get query():Query
Constructor detail
SceneId()constructor
public function SceneId(scenePath:String, query:* = null)

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

Parameters
scenePath:String — シーン識別子に変換するシーンパス、または URL を表すストリングです。
 
query:* (default = null) — シーンパスに付加されるクエリです。
Method detail
clone()method
public function clone():SceneId

SceneId インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an SceneId subclass.

Returns
SceneId — 元のオブジェクトと同じプロパティ値を含む新しい SceneId インスタンスです。 A new SceneId object that is identical to the original.
contains()method 
public function contains(sceneId:SceneId):Boolean

指定されたシーン識別子が、自身の表すシーンパスの子シーンオブジェクトを指しているかどうかを返します。

Parameters
sceneId:SceneId — テストするシーン識別子です。

Returns
Boolean — 子シーンオブジェクトを指していれば true に、それ以外の場合は false になります。
equals()method 
public function equals(sceneId:SceneId, matchQuery:Boolean = false):Boolean

指定されたシーン識別子が、自身の表すシーンパスと同一かどうかを返します。

Parameters
sceneId:SceneId — テストするシーン識別子です。
 
matchQuery:Boolean (default = false) — テストにクエリの値を含めるかどうかです。

Returns
Boolean — 同一のシーンパスを指していれば true に、それ以外の場合は false になります。
getNameByIndex()method 
public function getNameByIndex(index:int):String

指定位置にあるシーンの名前を返します。

Parameters
index:int — 取得した名前のあるシーンの位置です。

Returns
String — 指定位置にあるシーンの名前です。
isNaS()method 
public static function isNaS(sceneId:SceneId):Boolean

対象のシーン識別子が NaS であるかどうかを返します。

Parameters
sceneId:SceneId — 比較対象の値です。

Returns
Boolean — 対象が NaS であれば true を、それ以外は false を返します。

See also

NaS

Example 
   trace( SceneId.isNaS( SceneId.NaS ) ); // true
   trace( SceneId.isNaS( new SceneId( "/index" ) ) ); // false

slice()method 
public function slice(startIndex:int = 0, endIndex:int = 0x7FFFFFFF):SceneId

シーン識別子の保存するシーンパスの指定された範囲のエレメントを取り出して、新しいシーン識別子を返します。 この操作で元のシーン識別子は変更されません。

Parameters
startIndex:int (default = 0) — スライスの始点のインデックスを示す数値です。
 
endIndex:int (default = 0x7FFFFFFF) — スライスの終点のインデックスを示す数値です。このパラメータを省略すると、スライスには配列の最初から最後までのすべてのエレメントが取り込まれます。endIndex が負の数値の場合、終点は配列の末尾から開始します。つまり、-1 が最後のエレメントです。

Returns
SceneId — 元のシーンパスから取り出した一連のエレメントから成るシーン識別子です。
toShortPath()method 
public function toShortPath():String

同期時に使用されるルートを省略したショートパスを表すストリングを返します。

Returns
String — ショートパスを表すストリングです。
toString()method 
public function toString():String

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

Returns
String — オブジェクトのストリング表現です。 A string representation of the object.
transfer()method 
public function transfer(scenePath:String, query:* = null):SceneId

指定された絶対シーンパスもしくは相対シーンパスを使用して移動後のシーン識別子を返します。 この操作で元のシーン識別子は変更されません。

Parameters
scenePath:String — 移動先のシーンパスです。
 
query:* (default = null) — 移動後のシーンパスに付加されるクエリです。

Returns
SceneId — 移動後のシーン識別子です。
validateName()method 
public static function validateName(name:String):Boolean

シーン名の書式が正しいかどうかを返します。

Parameters
name:String — 書式を調べるシーン名です。

Returns
Boolean — 書式が正しければ true に、それ以外の場合は false になります。

See also

validatePath()

Example

validatePath()method 
public static function validatePath(path:String):Boolean

シーンパスの書式が正しいかどうかを返します。

Parameters
path:String — 書式を調べるシーンパスです。

Returns
Boolean — 書式が正しければ true に、それ以外の場合は false になります。

See also

validateName()

Example

Constant detail
NaSconstant
public static const NaS:SceneId

非 SceneId の値を表す SceneId 型の特殊なメンバーを取得します。




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