XMLList

パッケージ	トップレベル
クラス	public final dynamic class XMLList
継承	XMLList Object

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9, Flash Lite 4

XMLList クラスには、XML エレメントを操作するためのメソッドが含まれています。XMLList オブジェクトは複数の XML オブジェクトまたはエレメント（複数のノードまたは属性を含む）を表すこともできるので、コレクション内のエレメント全体に対してメソッドを呼び出すことも、コレクション内のエレメントごとにメソッドを呼び出すことも可能です。

XMLList オブジェクトに XML エレメントが 1 つしかない場合は、XMLList オブジェクトに対して XML クラスのメソッドを直接使用できます。次の例で、example.two は長さ 1 の XMLList オブジェクトです。そのため、このオブジェクトにはどのような XML メソッドをも呼び出すことができます。

 var example2 = <example><two>2</two></example>;

複数の XML オブジェクトを含んだ XMLList オブジェクトと共に XML クラスのメソッドを使用しようとすると、例外がスローされます。例外がスローされないようにするには、for each..in ステートメントなどを使用して XMLList コレクションに対して反復処理を行い、コレクション内の各 XML オブジェクトにメソッドを適用します。

例を表示

関連する API エレメント

XML
for each..in
Namespace
QName

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		XMLList(value:Object) 新しい XMLList オブジェクトを作成します。	XMLList
		attribute(attributeName:*):XMLList 各 XML オブジェクトの attribute() メソッドを呼び出し、その結果の XMLList オブジェクトを返します。	XMLList
		attributes():XMLList 各 XML オブジェクトの attributes() メソッドを呼び出し、各 XML オブジェクトの属性の XMLList オブジェクトを返します。	XMLList
		child(propertyName:Object):XMLList 各 XML オブジェクトの child() メソッドを呼び出し、その結果を順に含む XMLList オブジェクトを返します。	XMLList
		children():XMLList 各 XML オブジェクトの children() メソッドを呼び出し、その結果を含む XMLList オブジェクトを返します。	XMLList
		comments():XMLList 各 XML オブジェクトの comments() メソッドを呼び出し、コメントの XMLList を返します。	XMLList
		contains(value:XML):Boolean 指定された value パラメーターに等しい XML オブジェクトが XMLList オブジェクトに含まれるかどうかを確認します。	XMLList
		copy():XMLList 指定された XMLList オブジェクトのコピーを返します。	XMLList
		descendants(name:Object = *):XMLList 指定された name パラメーターを持つ XML オブジェクトのすべての子孫（子、孫、ひ孫など）を返します。	XMLList
		elements(name:Object = *):XMLList 各 XML オブジェクトの elements() メソッドを呼び出します。	XMLList
		hasComplexContent():Boolean XMLList オブジェクトに複合内容が含まれるかどうかを確認します。	XMLList
		hasOwnProperty(p:String):Boolean p により指定されたプロパティをチェックします。	XMLList
		hasSimpleContent():Boolean XMLList オブジェクトに単純内容が含まれるかどうかを確認します。	XMLList
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		length():int XMLList オブジェクト内のプロパティ数を返します。	XMLList
		normalize():XMLList 隣接するテキストノードを結合し、XMLList 内のすべてのテキストノード、XMLList に含まれるすべての XML オブジェクト、および XMLList 内のすべての XML オブジェクトの子孫について、それぞれ空のテキストノードを削除します。	XMLList
		parent():Object XMLList オブジェクト内のすべてのアイテムが同じ親を持つ場合、XMLList オブジェクトの親を返します。	XMLList
		processingInstructions(name:String = "*"):XMLList name パラメーターを指定した場合は、その名前を持つ処理命令を含む XMLList オブジェクトのすべての子を一覧表示します。	XMLList
		propertyIsEnumerable(p:String):Boolean XML オブジェクトに適用される for..in ステートメント内で反復処理されるプロパティセット内に、プロパティ p があるかどうかを確認します。	XMLList
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		text():XMLList 各 XML オブジェクトの text() メソッドを呼び出し、その結果を含む XMLList オブジェクトを返します。	XMLList
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String XMLList オブジェクト内のすべての XML オブジェクトのストリング表現を返します。	XMLList
		toXMLString():String XMLList オブジェクト内のすべての XML オブジェクトのストリング表現を返します。	XMLList
		valueOf():XMLList XMLList オブジェクトを返します。	XMLList

コンストラクターの詳細

()

コンストラクター

public function XMLList(value:Object)

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

新しい XMLList オブジェクトを作成します。

パラメーター

value:Object — トップレベル関数 XMLList() によって XMLList オブジェクトに変換可能なオブジェクトです。

関連する API エレメント

top-level XMLList() 関数

メソッドの詳細

attribute

()

メソッド

AS3 function attribute(attributeName:*):XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

各 XML オブジェクトの attribute() メソッドを呼び出し、その結果の XMLList オブジェクトを返します。この結果は、指定された attributeName パラメーターに一致します。一致する XML オブジェクトがなかった場合、attribute() メソッドは空の XMLList オブジェクトを返します。

パラメーター

attributeName:* — XMLList オブジェクト内に含める属性の名前です。

戻り値

XMLList — XML オブジェクトが一致する XMLList オブジェクト、または空の XMLList オブジェクトです。

関連する API エレメント

XML.attribute()
XML.attributes()

attributes

()

メソッド

AS3 function attributes():XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

各 XML オブジェクトの attributes() メソッドを呼び出し、各 XML オブジェクトの属性の XMLList オブジェクトを返します。

戻り値

XMLList — 各 XML オブジェクトの属性の XMLList オブジェクトです。

関連する API エレメント

XML.attribute()
XML.attributes()

child

()

メソッド

AS3 function child(propertyName:Object):XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

各 XML オブジェクトの child() メソッドを呼び出し、その結果を順に含む XMLList オブジェクトを返します。

パラメーター

propertyName:Object — XML の子のエレメント名または整数です。

戻り値

XMLList — 入力パラメーターに一致する子ノードの XMLList オブジェクトです。

関連する API エレメント

XML.child()

children

()

メソッド

AS3 function children():XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

各 XML オブジェクトの children() メソッドを呼び出し、その結果を含む XMLList オブジェクトを返します。

戻り値

XMLList — XML オブジェクト内の子（複数）の XMLList オブジェクトです。

関連する API エレメント

XML.children()

comments

()

メソッド

AS3 function comments():XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

各 XML オブジェクトの comments() メソッドを呼び出し、コメントの XMLList を返します。

戻り値

XMLList — XML オブジェクト内のコメントの XMLList です。

関連する API エレメント

XML.comments()

contains

()

メソッド

AS3 function contains(value:XML):Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

指定された value パラメーターに等しい XML オブジェクトが XMLList オブジェクトに含まれるかどうかを確認します。

パラメーター

value:XML — 現在の XMLList オブジェクトと比較する XML オブジェクトです。

戻り値

Boolean — value パラメーターで宣言された XML オブジェクトが XMLList オブジェクトに含まれる場合は true、それ以外の場合は false を返します。

copy

()

メソッド

AS3 function copy():XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

指定された XMLList オブジェクトのコピーを返します。コピーとはノードのツリー全体の複製です。コピーされた XML オブジェクトに親はないので、null が返されます（parent() メソッドを呼び出した場合）。

戻り値

XMLList — XMLList オブジェクトのコピーです。

descendants

()

メソッド

AS3 function descendants(name:Object = *):XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

指定された name パラメーターを持つ XML オブジェクトのすべての子孫（子、孫、ひ孫など）を返します。name パラメーターには、QName オブジェクト、String データ型、または他の任意のデータ型（後で String データ型に変換されます）を指定できます。

すべての子孫を返すには、アスタリスク（*）パラメーターを使用します。パラメーターを指定しない場合はストリング "*" が渡され、XML オブジェクトのすべての子孫が返されます。

パラメーター

name:Object (default = *) — 照合するエレメントの名前です。

戻り値

XMLList — 元のリスト内の一致する XML オブジェクトの子孫（子、孫など）の XMLList オブジェクトです。子孫がない場合は、空の XMLList オブジェクトを返します。

関連する API エレメント

XML.descendants()

elements

()

メソッド

AS3 function elements(name:Object = *):XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

各 XML オブジェクトの elements() メソッドを呼び出します。name パラメーターが descendants() メソッドに渡されます。パラメーターが渡されなかった場合、ストリング "*" が descendants() メソッドに渡されます。

パラメーター

name:Object (default = *) — 照合するエレメントの名前です。

戻り値

XMLList — 一致する XML オブジェクトの子エレメントの XMLList オブジェクトです。

関連する API エレメント

XML.elements()

hasComplexContent

()

メソッド

AS3 function hasComplexContent():Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

XMLList オブジェクトに複合内容が含まれるかどうかを確認します。XMLList オブジェクトが空でなく、次のいずれかの条件が true の場合に、XMLList オブジェクトは複合内容を持つと見なされます。

XMLList オブジェクトに、複合内容を持つ 1 つの XML アイテムが含まれている。
XMLList オブジェクトに複数のエレメントが含まれている。

戻り値

Boolean — XMLList オブジェクトに複合内容が含まれる場合は true、それ以外の場合は false を返します。

hasOwnProperty

()

メソッド

AS3 function hasOwnProperty(p:String):Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

p により指定されたプロパティをチェックします。

パラメーター

p:String — 照合するプロパティです。

戻り値

Boolean — パラメーターが存在する場合は true、それ以外の場合は false を返します。

hasSimpleContent

()

メソッド

AS3 function hasSimpleContent():Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

XMLList オブジェクトに単純内容が含まれるかどうかを確認します。次のいずれかの条件が true の場合に、XMLList オブジェクトは単純内容を持つと見なされます。

XMLList オブジェクトが空である。
XMLList オブジェクトに、単純内容を持つ 1 つの XML アイテムが含まれている。
XMLList オブジェクトにエレメントが含まれていない。

戻り値

Boolean — XMLList に単純内容が含まれる場合は true、それ以外の場合は false を返します。

length

()

メソッド

AS3 function length():int

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

XMLList オブジェクト内のプロパティ数を返します。

戻り値

int — XMLList オブジェクト内のプロパティ数です。

normalize

()

メソッド

AS3 function normalize():XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

隣接するテキストノードを結合し、XMLList 内のすべてのテキストノード、XMLList に含まれるすべての XML オブジェクト、および XMLList 内のすべての XML オブジェクトの子孫について、それぞれ空のテキストノードを削除します。

戻り値

XMLList — 正規化した XMLList オブジェクトです。

parent

()

メソッド

AS3 function parent():Object

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

XMLList オブジェクト内のすべてのアイテムが同じ親を持つ場合、XMLList オブジェクトの親を返します。XMLList オブジェクトが親を持たないか、異なる親を持つ場合、メソッドは undefined を返します。

戻り値

Object — 親 XML オブジェクトを返します。

processingInstructions

()

メソッド

AS3 function processingInstructions(name:String = "*"):XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

name パラメーターを指定した場合、その名前を持つ処理命令を含む XMLList オブジェクトのすべての子を一覧表示します。パラメーターを指定しなかった場合、メソッドは任意の処理命令を含む XMLList オブジェクトのすべての子を一覧表示します。

パラメーター

name:String (default = "*") — 照合する処理命令の名前です。

戻り値

XMLList — 各 XML オブジェクトの処理命令を含む XMLList オブジェクトです。

関連する API エレメント

XML.processingInstructions()

propertyIsEnumerable

()

メソッド

AS3 function propertyIsEnumerable(p:String):Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

プロパティ p が、XMLList オブジェクトに適用される for..in ステートメント内で反復処理されるプロパティセット内にあるかどうかを確認します。true が返るのは、toNumber(p) が 0 より大きいか等しく、かつ XMLList オブジェクトの長さより小さい場合のみです。

パラメーター

p:String — 確認するプロパティのインデックスです。

戻り値

Boolean — for..in ステートメント内でプロパティを反復処理できる場合は true、それ以外の場合は false を返します。

text

()

メソッド

AS3 function text():XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

各 XML オブジェクトの text() メソッドを呼び出し、その結果を含む XMLList オブジェクトを返します。

戻り値

XMLList — XML テキストノードを表す XMLList オブジェクトのすべての XML プロパティの XMLList オブジェクトです。

関連する API エレメント

XML.text()

toString

()

メソッド

AS3 function toString():String

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

XMLList オブジェクト内のすべての XML オブジェクトのストリング表現を返します。この変換の規則は、XML オブジェクトに単純内容が含まれるか、複合内容が含まれるかによって決まります。

XML オブジェクトに単純内容が含まれる場合、toString() は XML オブジェクトのストリング内容を返し、開始タグ、属性、名前空間宣言、および終了タグを削除します。

XML オブジェクトに複合内容が含まれる場合、toString() は、開始タグ、属性、名前空間宣言および終了タグを含む XML オブジェクト全体を表す、XML エンコードされたストリングを返します。

XML オブジェクト全体を毎回返すには、toXMLString() メソッドを使用します。

戻り値

String — XML オブジェクトのストリング表現です。

例 ( この例の使用方法 )

次の例は、XML オブジェクトに単純内容が含まれる場合に toString() メソッドによって何が返されるかを示しています。

var test:XML = <type name="Joe">example</type>;
trace(test.toString()); //example

次の例は、XML オブジェクトに複合内容が含まれる場合に toString() メソッドによって何が返されるかを示しています。

var test:XML = 
<type name="Joe">
    <base name="Bob"></base>
    example
</type>;
trace(test.toString());
  // <type name="Joe">
  // <base name="Bob"/>
  // example
  // </type>

toXMLString

()

メソッド

AS3 function toXMLString():String

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

XMLList オブジェクト内のすべての XML オブジェクトのストリング表現を返します。toString() メソッドとは異なり、toXMLString() メソッドは、XML オブジェクトに単純内容が含まれるか、複合内容が含まれるかに関係なく、常に XML オブジェクトの開始タグ、属性、および終了タグを返します。toString() メソッドは、単純内容を持つ XML オブジェクトの開始タグ、属性、および終了タグを削除します。

戻り値

String — XML オブジェクトのストリング表現です。

関連する API エレメント

toString()

valueOf

()

メソッド

AS3 function valueOf():XMLList

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 1.0, Flash Player 9

XMLList オブジェクトを返します。

戻り値

XMLList — 現在の XMLList オブジェクトを返します。

例この例の使用方法

XMLListExample.as

次の例は books という名前の XML プロパティを作成し、book publisher タグや name タグを持ついくつかのアイテムを books というノードに追加しています。次に showBooksByPublisher() メソッドを呼び出します。このメソッドは XMLList を受け取り、発行者 "Addison-Wesley" に一致する各アイテムを返します。

package {
    import flash.display.Sprite;

    public class XMLListExample extends Sprite {
        private var books:XML;

        public function XMLListExample() {
            books =    <books>
                        <book publisher="Addison-Wesley" name="Design Patterns" />
                        <book publisher="Addison-Wesley" name="The Pragmatic Programmer" />
                        <book publisher="Addison-Wesley" name="Test Driven Development" />
                        <book publisher="Addison-Wesley" name="Refactoring to Patterns" />
                        <book publisher="O'Reilly Media" name="The Cathedral & the Bazaar" />
                        <book publisher="O'Reilly Media" name="Unit Test Frameworks" />
                    </books>;

            showBooksByPublisher("Addison-Wesley");
        }

        private function showBooksByPublisher(name:String):void {
            var results:XMLList = books.book.(@publisher == name);
            showList(results);
        }

        private function showList(list:XMLList):void {
            var item:XML;
            for each(item in list) {
                trace("item: " + item.toXMLString());
            }
        }
    }
}

法律上の注意 | プライバシーポリシー

XMLList - AS3

パッケージx

言語エレメント

付録

クラス x

XMLList

attribute

attributes

child

children

comments

contains

copy

descendants

elements

hasComplexContent

hasOwnProperty

hasSimpleContent

length

normalize

parent

processingInstructions

propertyIsEnumerable

text

toString

toXMLString

valueOf