| パッケージ | トップレベル |
| public final dynamic class XMLList | |
| 継承 | XMLList Object |
1 つの XML エレメントを持つ XMLList オブジェクトは、1 つの XML オブジェクトと同様に扱われます。XML エレメントが 1 つの場合、XML オブジェクトに使用できるすべてのメソッドをその XMLList オブジェクトにも使用できます。
次の例で、example.two は長さ 1 の XMLList オブジェクトです。そのため、このオブジェクトにはどのような XML メソッドをも呼び出すことができます。
var example2 = <example><two>2</two></example>;
次の表は、XMLList クラスには含まれないが、XMLList オブジェクトの XML エレメントが 1 つのみの場合に使用できる XML メソッドを示しています。XML エレメントを 1 つでなく、0 または複数持つ XMLList オブジェクトに対してこれらのメソッドを使用しようとすると、例外がスローされます。
| XML メソッド |
|---|
addNamespace() |
appendChild() |
childIndex() |
inScopeNamespace() |
insertChildAFter() |
insertChildBefore() |
name() |
namespace() |
localName() |
namespaceDeclarations() |
nodeKind() |
prependChild() |
removeNamespace() |
replace() |
setChildren() |
setLocalName() |
setName() |
setNamespace() |
XML、Namespace、QName などのクラスと同様、XMLList クラスには ECMAScript for XML (E4X) 仕様 (ECMA-357 Edition 2) で定義されている強力な XML 処理規格が実装されています。
関連項目
| メソッド | 定義 | ||
|---|---|---|---|
| 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
XMLList オブジェクトに適用される
for..in ステートメント内で反復処理されるプロパティセット内に、プロパティ p があるかどうかを確認します。 | XMLList | ||
![]() | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
| Object | |
| text():XMLList
各 XML オブジェクトの
text() メソッドを呼び出し、その結果を含む XMLList オブジェクトを返します。 | XMLList | ||
| toString():String
XMLList オブジェクト内のすべての XML オブジェクトのストリング表現を返します。
| XMLList | ||
| toXMLString():String
XMLList オブジェクト内のすべての XML オブジェクトのストリング表現を返します。
| XMLList | ||
| valueOf():XMLList
XMLList オブジェクトを返します。
| XMLList | ||
| XMLList | () | コンストラクタ |
public 関数 XMLList(value:Object)新しい XMLList オブジェクトを作成します。
パラメータvalue:Object — トップレベル関数 XMLList() によって XMLList オブジェクトに変換可能なオブジェクトです。
|
関連項目
| attribute | () | メソッド |
AS3 function attribute(attributeName:*):XMLList
各 XML オブジェクトの attribute() メソッドを呼び出し、その結果の XMLList オブジェクトを返します。この結果は、指定された attributeName パラメータに一致します。一致する XML オブジェクトがなかった場合、attribute() メソッドは空の XMLList オブジェクトを返します。
attributeName:* — XMLList オブジェクト内に含める属性の名前です。
|
XMLList —
XML オブジェクトが一致する XMLList オブジェクト、または空の XMLList オブジェクトです。
|
関連項目
| attributes | () | メソッド |
AS3 function attributes():XMLList
各 XML オブジェクトの attributes() メソッドを呼び出し、各 XML オブジェクトの属性の XMLList オブジェクトを返します。
XMLList —
各 XML オブジェクトの属性の XMLList オブジェクトです。
|
関連項目
| child | () | メソッド |
AS3 function child(propertyName:Object):XMLList
各 XML オブジェクトの child() メソッドを呼び出し、その結果を順に含む XMLList オブジェクトを返します。
propertyName:Object — XML の子のエレメント名または整数です。
|
XMLList —
入力パラメータに一致する子ノードの XMLList オブジェクトです。
|
関連項目
| children | () | メソッド |
AS3 function children():XMLList
各 XML オブジェクトの children() メソッドを呼び出し、その結果を含む XMLList オブジェクトを返します。
XMLList —
XML オブジェクト内の子 (複数)の XMLList オブジェクトです。
|
関連項目
| comments | () | メソッド |
AS3 function comments():XMLList
各 XML オブジェクトの comments() メソッドを呼び出し、コメントの XMLList を返します。
XMLList —
XML オブジェクト内のコメントの XMLList です。
|
関連項目
| contains | () | メソッド |
AS3 function contains(value:XML):Boolean
指定された value パラメータに等しい XML オブジェクトが XMLList オブジェクトに含まれるかどうかを確認します。
value:XML — 現在の XMLList オブジェクトと比較する XML オブジェクトです。
|
Boolean —
value パラメータで宣言された XML オブジェクトが XMLList オブジェクトに含まれる場合は true、それ以外の場合は false を返します。
|
関連項目
| copy | () | メソッド |
AS3 function copy():XMLList
指定された XMLList オブジェクトのコピーを返します。コピーとはノードのツリー全体の複製です。コピーされた XML オブジェクトには親はなく、parent() メソッドを呼び出そうとすると null が返されます。
XMLList —
XMLList オブジェクトのコピーです。
|
関連項目
| descendants | () | メソッド |
AS3 function descendants(name:Object = *):XMLList
指定された name パラメータを持つ XML オブジェクトのすべての子孫 (子、孫、ひ孫など) を返します。name パラメータには、QName オブジェクト、String データ型、または他の任意のデータ型 (後で String データ型に変換されます) を指定できます。
すべての子孫を返すには、アスタリスク (*) パラメータを使用します。パラメータを指定しない場合はストリング "*" が渡され、XML オブジェクトのすべての子孫が返されます。
パラメータname:Object (default = *) — 照合するエレメントの名前です。
|
XMLList —
元のリスト内の一致する XML オブジェクトの子孫 (子、孫など) の XMLList オブジェクトです。子孫がない場合は、空の XMLList オブジェクトを返します。
|
関連項目
| elements | () | メソッド |
AS3 function elements(name:Object = *):XMLList
各 XML オブジェクトの elements() メソッドを呼び出します。name パラメータが descendants() メソッドに渡されます。パラメータが渡されなかった場合、ストリング "*" が descendants() メソッドに渡されます。
name:Object (default = *) — 照合するエレメントの名前です。
|
XMLList —
一致する XML オブジェクトの子エレメントの XMLList オブジェクトです。
|
関連項目
| hasComplexContent | () | メソッド |
AS3 function hasComplexContent():BooleanXMLList オブジェクトに複合内容が含まれるかどうかを確認します。XMLList オブジェクトが空でなく、次のいずれかの条件が true の場合に、XMLList オブジェクトは複合内容を持つと見なされます。
Boolean —
XMLList オブジェクトに複合内容が含まれる場合は true、それ以外の場合は false を返します。
|
関連項目
| hasOwnProperty | () | メソッド |
AS3 function hasOwnProperty(p:String):Boolean
p により指定されたプロパティをチェックします。
p:String — 照合するプロパティです。
|
Boolean —
パラメータが存在する場合は true、それ以外の場合は false を返します。
|
関連項目
| hasSimpleContent | () | メソッド |
AS3 function hasSimpleContent():BooleanXMLList オブジェクトに単純内容が含まれるかどうかを確認します。次のいずれかの条件が true の場合に、XMLList オブジェクトは単純内容を持つと見なされます。
Boolean —
XMLList に単純内容が含まれる場合は true、それ以外の場合は false を返します。
|
関連項目
| length | () | メソッド |
| normalize | () | メソッド |
AS3 function normalize():XMLList隣接するテキストノードを結合し、XMLList 内のすべてのテキストノード、XMLList に含まれるすべての XML オブジェクト、および XMLList 内のすべての XML オブジェクトの子孫について、それぞれ空のテキストノードを削除します。
戻り値XMLList —
正規化した XMLList オブジェクトです。
|
関連項目
| parent | () | メソッド |
AS3 function parent():Object
XMLList オブジェクト内のすべてのアイテムが同じ親を持つ場合、XMLList オブジェクトの親を返します。XMLList オブジェクトが親を持たないか、異なる親を持つ場合、メソッドは undefined 返します。
Object —
親 XML オブジェクトを返します。
|
関連項目
| processingInstructions | () | メソッド |
AS3 function processingInstructions(name:String = "*"):XMLList
name パラメータを指定した場合、その名前を持つ処理命令を含む XMLList オブジェクトのすべての子を一覧表示します。パラメータを指定しなかった場合、メソッドは任意の処理命令を含む XMLList オブジェクトのすべての子を一覧表示します。
name:String (default = "*") — 照合する処理命令の名前です。
|
XMLList —
各 XML オブジェクトの処理命令を含む XMLList オブジェクトです。
|
関連項目
| propertyIsEnumerable | () | メソッド |
AS3 function propertyIsEnumerable(p:String):Boolean
XMLList オブジェクトに適用される for..in ステートメント内で反復処理されるプロパティセット内に、プロパティ p があるかどうかを確認します。これは、toNumber(p) が 0 より大きいか等しく、かつ XMLList オブジェクトの長さより小さい場合に限り true を返します。
p:String — 確認するプロパティのインデックスです。
|
Boolean —
for..in ステートメント内でプロパティを反復処理できる場合は true、それ以外の場合は false を返します。
|
関連項目
| text | () | メソッド |
AS3 function text():XMLList
各 XML オブジェクトの text() メソッドを呼び出し、その結果を含む XMLList オブジェクトを返します。
XMLList —
XML テキストノードを表す XMLList オブジェクトのすべての XML プロパティの XMLList オブジェクトです。
|
関連項目
| toString | () | メソッド |
AS3 function toString():StringXMLList オブジェクト内のすべての XML オブジェクトのストリング表現を返します。この変換の規則は、XML オブジェクトに単純内容が含まれるか、複合内容が含まれるかによって決まります。
toString() は、XML オブジェクトのストリング内容から開始タグ、属性、名前空間宣言、および終了タグを削除します。toString() は、開始タグ、属性、名前空間宣言、および終了タグを含む XML オブジェクト全体を表す、XML エンコードされたストリングを返します。XML オブジェクト全体を毎回返すには、toXMLString() メソッドを使用します。
String —
XML オブジェクトのストリング表現です。
|
関連項目
toString() メソッドが何を返すかを示しています。
var test:XML = <type name="Joe">example</type>; trace(test.toString()); //example
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
XMLList オブジェクト内のすべての XML オブジェクトのストリング表現を返します。toString() メソッドとは異なり、toXMLString() メソッドは、XML オブジェクトに単純内容が含まれるか、複合内容が含まれるかに関係なく、常に XML オブジェクトの開始タグ、属性、および終了タグを返します。toString() メソッドは、単純内容を持つ XML オブジェクトの開始タグ、属性、および終了タグを削除します。
String —
XML オブジェクトのストリング表現です。
|
関連項目
| valueOf | () | メソッド |
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());
}
}
}
}