XML （Flex 3）

	プロパティ	定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		ignoreComments : Boolean [静的] XML オブジェクトがソースの XML データを解析する際に、XML コメントを無視するかどうかを決定します。	XML
		ignoreProcessingInstructions : Boolean [静的] XML オブジェクトがソースの XML データを解析する際に、XML 処理命令を無視するかどうかを決定します。	XML
		ignoreWhitespace : Boolean [静的] テキストノードの先頭および最後の空白文字を、解析時に無視するかどうかを決定します。	XML
		prettyIndent : int [静的] XML.prettyPrinting プロパティを true に設定した場合に、toString() メソッドと toXMLString() メソッドが適用するインデントの量を決定します。	XML
		prettyPrinting : Boolean [静的] toString() メソッドと toXMLString() メソッドが、タグ間の空白文字を正規化するかどうかを決定します。	XML
		prototype : Object [静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object

	メソッド	定義元
		XML(value:Object) 新しい XML オブジェクトを作成します。	XML
		addNamespace(ns:Object):XML XML オブジェクトのスコープ内の名前空間セットに名前空間を追加します。	XML
		appendChild(child:Object):XML 指定された子を XML オブジェクトのプロパティの最後に追加します。	XML
		attribute(attributeName:*):XMLList attributeName パラメータに一致する名前を持つ属性の XML 値を返します。	XML
		attributes():XMLList 指定された XML オブジェクトの属性値のリストを返します。	XML
		child(propertyName:Object):XMLList XML オブジェクトの子を列挙します。	XML
		childIndex():int 親のコンテキスト内でのこの XML オブジェクトの 0 から始まるインデックス位置を識別します。	XML
		children():XMLList XML オブジェクトの子を、出現する順序で列挙します。	XML
		comments():XMLList XML コメントを持つ XML オブジェクトのプロパティを列挙します。	XML
		contains(value:XML):Boolean XML オブジェクトと、指定された value パラメータを比較します。	XML
		copy():XML 指定された XML オブジェクトのコピーを返します。	XML
		defaultSettings():Object [静的] プロパティ ignoreComments、ignoreProcessingInstructions、ignoreWhitespace、prettyIndent、および prettyPrinting を取得します。	XML
		descendants(name:Object = *):XMLList 指定された name パラメータを持つ XML オブジェクトのすべての子孫（子、孫、ひ孫など）を返します。	XML
		elements(name:Object = *):XMLList XML オブジェクトのエレメントを列挙します。	XML
		hasComplexContent():Boolean XML オブジェクトに複合内容が含まれるかどうかを確認します。	XML
		hasOwnProperty(p:String):Boolean オブジェクトに p パラメータで指定されたプロパティがあるかどうかを確認します。	XML
		hasSimpleContent():Boolean XML オブジェクトに単純内容が含まれるかどうかを確認します。	XML
		inScopeNamespaces():Array オブジェクトの親に基づいて、XML オブジェクトの名前空間を列挙します。	XML
		insertChildAfter(child1:Object, child2:Object):* 指定された child2 パラメータを、この XML オブジェクトの child1 パラメータの後に挿入し、その結果のオブジェクトを返します。	XML
		insertChildBefore(child1:Object, child2:Object):* 指定された child2 パラメータを、この XML オブジェクトの child1 パラメータの前に挿入し、その結果のオブジェクトを返します。	XML
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		length():int XML オブジェクトの場合、このメソッドは常に整数 1 を返します。	XML
		localName():Object XML オブジェクトの修飾名のローカル名部分を指定します。	XML
		name():Object XML オブジェクトの修飾名を指定します。	XML
		namespace(prefix:String = null):* パラメータを指定しない場合、この XML オブジェクトの修飾名に関連付けられている名前空間を指定します。	XML
		namespaceDeclarations():Array 親のコンテキストで XML オブジェクトに関連付けられている名前空間宣言を列挙します。	XML
		nodeKind():String ノードのタイプ（テキスト、コメント、処理命令、属性、またはエレメント）を指定します。	XML
		normalize():XML XML オブジェクトとすべての子孫の XML オブジェクトについて、隣接するテキストノードを結合し、空のテキストノードを削除します。	XML
		parent():* XML オブジェクトの親を返します。	XML
		prependChild(value:Object):XML 指定された child オブジェクトのコピーを、このエレメント内の既存のすべての XML プロパティの前に挿入します。	XML
		processingInstructions(name:String = "*"):XMLList name パラメータを指定した場合、その name を持つ処理命令を含む XML オブジェクトのすべての子を列挙します。	XML
		propertyIsEnumerable(p:String):Boolean XML オブジェクトに適用される for..in ステートメント内で反復処理されるプロパティセット内に、プロパティ p があるかどうかを確認します。	XML
		removeNamespace(ns:Namespace):XML このオブジェクトとすべての子孫に指定された名前空間を削除します。	XML
		replace(propertyName:Object, value:XML):XML propertyName パラメータで指定されたプロパティを、指定された value パラメータに置き換えます。	XML
		setChildren(value:Object):XML XML オブジェクトの子プロパティを、value パラメータで指定された XML プロパティのセットに置き換えます。	XML
		setLocalName(name:String):void XML オブジェクトのローカル名を、指定された name パラメータに変更します。	XML
		setName(name:String):void XML オブジェクトの名前を、指定された修飾名または属性名に設定します。	XML
		setNamespace(ns:Namespace):void XML オブジェクトに関連付けられている名前空間を設定します。	XML
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		setSettings(... rest):void [静的] XML プロパティ ignoreComments、ignoreProcessingInstructions、ignoreWhitespace、prettyIndent、および prettyPrinting を取得します。	XML
		settings():Object [静的] プロパティ ignoreComments、ignoreProcessingInstructions、ignoreWhitespace、prettyIndent、および prettyPrinting を取得します。	XML
		text():XMLList XML テキストノードを表す XML オブジェクトのすべての XML プロパティの XMLList オブジェクトを返します。	XML
		toString():String XML オブジェクトのストリング表現を返します。	XML
		toXMLString():String XML オブジェクトのストリング表現を返します。	XML
		valueOf():XML XML オブジェクトを返します。	XML

プロパティの詳細

ignoreComments

プロパティ

ignoreComments:Boolean [読み取り-書き込み]

XML オブジェクトがソースの XML データを解析する際に、XML コメントを無視するかどうかを決定します。デフォルトでは、コメントを無視します（true）。XML コメントを含めるには、このプロパティを false に設定します。ignoreComments プロパティは、myXMLObject.child(*).toXMLString() などのメソッドの呼び出し時でなく、XML の解析時にのみ使用します。ソースの XML にコメントノードが含まれる場合、このノードは XML の解析時には保持されるか、または破棄されます。

実装
public static function get ignoreComments():Boolean
public function set ignoreComments(value:Boolean):void

関連項目

XML.child()
XML.toXMLString()

例

この例は、XML.ignoreComments を false に設定した場合と true に設定した場合の影響を示しています。

XML.ignoreComments = false;
var xml1:XML = 
        <foo>
            <!-- comment -->
        </foo>;
trace(xml1.toXMLString()); // <foo><!-- comment --></foo>

XML.ignoreComments = true;
var xml2:XML = 
        <foo>
            <!-- example -->
        </foo>;
trace(xml2.toXMLString()); // <foo/>

ignoreProcessingInstructions

プロパティ

ignoreProcessingInstructions:Boolean [読み取り-書き込み]

XML オブジェクトがソースの XML データを解析する際に、XML 処理命令を無視するかどうかを決定します。デフォルトでは、処理命令を無視します（true）。XML 処理命令を含めるには、このプロパティを false に設定します。ignoreProcessingInstructions プロパティは、myXMLObject.child(*).toXMLString() などのメソッドの呼び出し時でなく、XML の解析時にのみ使用します。ソースの XML に処理命令ノードが含まれる場合、このノードは XML の解析時には保持されるか、または破棄されます。

実装
public static function get ignoreProcessingInstructions():Boolean
public function set ignoreProcessingInstructions(value:Boolean):void

関連項目

XML.child()
XML.toXMLString()

例

この例は、XML.ignoreProcessingInstructions を false に設定した場合と true に設定した場合の影響を示しています。

XML.ignoreProcessingInstructions = false;
var xml1:XML = 
        <foo>
            <?exampleInstruction ?>
        </foo>;
trace(xml1.toXMLString()); // <foo><?exampleInstruction ?></foo>

XML.ignoreProcessingInstructions = true;
var xml2:XML = 
        <foo>
            <?exampleInstruction ?>
        </foo>;
trace(xml2.toXMLString()); // <foo/>

ignoreWhitespace

プロパティ

ignoreWhitespace:Boolean [読み取り-書き込み]

テキストノードの先頭および最後の空白文字を、解析時に無視するかどうかを決定します。デフォルトでは、空白文字を無視します（true）。テキストノードが 100% 空白文字で、ignoreWhitespace プロパティが true に設定されている場合、ノードは作成されません。テキストノード内の空白文字を表示するには、ignoreWhitespace プロパティを false に設定します。

実装
public static function get ignoreWhitespace():Boolean
public function set ignoreWhitespace(value:Boolean):void

例

この例は、XML.ignoreWhitespace を false に設定した場合と true に設定した場合の影響を示しています。

XML.ignoreWhitespace = false;
var xml1:XML = <foo>    </foo>;
trace(xml1.children().length()); // 1

XML.ignoreWhitespace = true;
var xml2:XML = <foo>    </foo>;
trace(xml2.children().length()); // 0

prettyIndent

プロパティ

prettyIndent:int [読み取り-書き込み]

toString() メソッドと toXMLString() メソッドが適用するインデントの量を決定します（XML.prettyPrinting プロパティを true に設定した場合）。インデントは、タブ文字でなく、空白文字で適用されます。デフォルト値は 2 です。

実装
public static function get prettyIndent():int
public function set prettyIndent(value:int):void

関連項目

prettyPrinting
toString()
toXMLString()

例

この例は、XML.prettyIndent 静的プロパティを設定した場合の影響を示しています。

var xml:XML = <foo><bar/></foo>;
XML.prettyIndent = 0;
trace(xml.toXMLString());

XML.prettyIndent = 1;
trace(xml.toXMLString());

XML.prettyIndent = 2;
trace(xml.toXMLString());

prettyPrinting

プロパティ

prettyPrinting:Boolean [読み取り-書き込み]

toString() メソッドと toXMLString() メソッドが、タグ間の空白文字を正規化するかどうかを決定します。デフォルト値は true です。

実装
public static function get prettyPrinting():Boolean
public function set prettyPrinting(value:Boolean):void

関連項目

prettyIndent
toString()
toXMLString()

例

この例は、XML.prettyPrinting 静的プロパティを設定した場合の影響を示しています。

var xml:XML = <foo><bar/></foo>;
XML.prettyPrinting = false;
trace(xml.toXMLString());

XML.prettyPrinting = true;
trace(xml.toXMLString());

コンストラクタの詳細

XML

()

コンストラクタ

public function XML(value:Object)

新しい XML オブジェクトを作成します。XML クラスのメソッドを呼び出す前に、コンストラクタを使用して XML オブジェクトを作成する必要があります。

toXMLString() メソッドは、XML オブジェクトに単純内容が含まれるか複合内容が含まれるかに関係なく、XML オブジェクトのストリング表現を返します。

パラメータ

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

メソッドの詳細

addNamespace

()

メソッド

AS3 function addNamespace(ns:Object):XML

XML オブジェクトのスコープ内の名前空間セットに名前空間を追加します。その名前空間が XML オブジェクトのスコープ内の名前空間セットに既に存在する（指定されたパラメータに一致する接頭辞を持つ）場合、既存の名前空間の接頭辞は undefined に設定されます。入力パラメータが Namespace オブジェクトの場合は、このオブジェクトが直接使用されます。入力パラメータが QName オブジェクトの場合は、新しい名前空間の作成に入力パラメータの URI が使用され、それ以外の場合は、入力パラメータは String に変換され、名前空間がその String から作成されます。

パラメータ

ns:Object — XML オブジェクトに追加する名前空間です。

戻り値

XML — 名前空間が追加された新しい XML オブジェクトです。

関連項目

XML objects

例

次の例では、1 つの XML オブジェクトに定義されている名前空間を使用して、これを別の XML オブジェクトに適用します。

var xml1:XML = <ns:foo xmlns:ns="www.example.com/ns" />;
var nsNamespace:Namespace = xml1.namespace();

var xml2:XML = <bar />;
xml2.addNamespace(nsNamespace);
trace(xml2.toXMLString()); // <bar xmlns:ns="www.example.com/ns"/>

appendChild

()

メソッド

AS3 function appendChild(child:Object):XML

指定された子を XML オブジェクトのプロパティの最後に追加します。appendChild() メソッドは、XML オブジェクト、XMLList オブジェクト、または他の任意のデータ型（後で String データ型に変換されます）を受け取ります。

XML ノードを削除するには、delete（XML）演算子を使用します。

パラメータ

child:Object — 追加する XML オブジェクトです。

戻り値

XML — 結果として作成される XML オブジェクトです。

例

この例では、新しいエレメントを XML オブジェクトの子リストの最後に追加します。

var xml:XML = 
        <body>
            <p>hello</p>
        </body>;
        
xml.appendChild(<p>world</p>);    
trace(xml.p[0].toXMLString()); // <p>hello</p>
trace(xml.p[1].toXMLString()); // <p>world</p>

attribute

()

メソッド

AS3 function attribute(attributeName:*):XMLList

attributeName パラメータに一致する名前を持つ属性の XML 値を返します。属性は XML エレメント内にあります。たとえば、<first gender="boy">John</first> の場合、エレメントは値 "boy" の "gender" という名前の属性を持ちます。

attributeName パラメータには任意のデータ型を指定できますが、String データ型を使用するのが最も一般的です。QName オブジェクト以外のオブジェクトを渡した場合、attributeName パラメータは toString() メソッドを使用してパラメータをストリングに変換します。

修飾名参照が必要な場合は、QName オブジェクトで渡すことができます。QName オブジェクトは名前空間とローカル名を定義するもので、属性の修飾名の定義に使用することができます。したがって、attribute(qname) の呼び出しは attribute(qname.toString()) の呼び出しと同じではありません。

パラメータ

attributeName:* — 属性の名前。

戻り値

XMLList — XMLList オブジェクトまたは空の XMLList オブジェクトです。属性値が定義されていない場合は空の XMLList を返します。

例

この例は、attribute() オブジェクトに渡される QName オブジェクトを示しています。localName プロパティは attr で、namespace プロパティは ns です。

var xml:XML = <ns:node xmlns:ns = "http://uri" ns:attr = '7' />       
var qn:QName = new QName("http://uri", "attr");
trace(xml.attribute(qn)); // 7

ActionScript の予約語と名前が一致する属性を返すには、次の例のように、属性識別（@）演算子ではなく attribute() メソッドを使用します。

var xml:XML = <example class="first" />
trace(xml.attribute("class"));

attributes

()

メソッド

AS3 function attributes():XMLList

指定された XML オブジェクトの属性値のリストを返します。name() メソッドを attributes() メソッドと共に使用して属性の名前を返します。すべての属性の名前を返すには、@* を使用します。

戻り値

XMLList — 属性値のリストです。

例

次の例では、属性の名前を返します。

var xml:XML=<example id='123' color='blue'/>
trace(xml.attributes()[1].name()); //color

この例は、すべての属性の名前を返します。

 
var xml:XML = <example id='123' color='blue'/>
var attNamesList:XMLList = xml.@*;

trace(attNamesList is XMLList); // true
trace(attNamesList.length()); // 2

for (var i:int = 0; i < attNamesList.length(); i++)
{ 
    trace(typeof (attNamesList[i])); // xml
    trace(attNamesList[i].nodeKind()); // attribute
    trace(attNamesList[i].name()); // id and color
}

child

()

メソッド

AS3 function child(propertyName:Object):XMLList

XML オブジェクトの子を列挙します。XML の 1 つの子は、1 つの XML エレメント、テキストノード、コメント、または処理命令です。

propertyName パラメータを使用して、特定の XML の子の内容を列挙します。たとえば、<first> という名前の子の内容を返すには、child.name("first") を使用します。子のインデックス番号を使用しても同じ結果が得られます。インデックス番号は、複数の XML の子のリスト内での子の位置を識別します。たとえば、name.child(0) はリスト内の先頭の子を返します。

XML ドキュメント内のすべての子を出力するにはアスタリスク（*）を使用します。たとえば、doc.child("*") となります。

子の総数を出力するには、length() メソッドを、アスタリスク（*）パラメータを指定した child() メソッドと共に使用します。たとえば、numChildren = doc.child("*").length() となります。

パラメータ

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

戻り値

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

例

次の例は、child() メソッドを使って指定された名前の子エレメントを識別する方法を示しています。

var xml:XML = 
        <foo>
            <bar>text1</bar>
            <bar>text2</bar>
        </foo>;
trace(xml.child("bar").length());  // 2
trace(xml.child("bar")[0].toXMLString()); // <bar>text1</bar>
trace(xml.child("bar")[1].toXMLString()); // <bar>text2</bar>

childIndex

()

メソッド

AS3 function childIndex():int

親のコンテキスト内でのこの XML オブジェクトの 0 から始まるインデックス位置を識別します。

戻り値

int — オブジェクトの位置です。正の整数だけでなく、-1 も返します。

関連項目

XML objects

例

この例は、childIndex() メソッドの使用法を示しています。

var xml:XML = 
            <foo>
                <bar />
                text
                <bob />
            </foo>;
trace(xml.bar.childIndex()); // 0
trace(xml.bob.childIndex()); // 2

children

()

メソッド

AS3 function children():XMLList

XML オブジェクトの子を、出現する順序で列挙します。XML の 1 つの子は、1 つの XML エレメント、テキストノード、コメント、または処理命令です。

戻り値

XMLList — XML オブジェクトの子の XMLList オブジェクトです。

関連項目

XML objects

例

この例は、children() メソッドの使用法を示しています。

XML.ignoreComments = false;
XML.ignoreProcessingInstructions = false;
var xml:XML = 
        <foo id="22">
            <bar>44</bar>
            text
            <!-- comment -->
            <?instruction ?>
        </foo>;
trace(xml.children().length()); // 4
trace(xml.children()[0].toXMLString()); // <bar>44</bar>
trace(xml.children()[1].toXMLString()); // text
trace(xml.children()[2].toXMLString()); // <!-- comment -->
trace(xml.children()[3].toXMLString()); // <?instruction ?>

comments

()

メソッド

AS3 function comments():XMLList

XML コメントを持つ XML オブジェクトのプロパティを列挙します。

戻り値

XMLList — コメントを持つプロパティの XMLList オブジェクトです。

関連項目

XML objects

例

この例は、comments() メソッドの使用法を示しています。

XML.ignoreComments = false;
var xml:XML = 
        <foo>
            <!-- example -->
            <!-- example2 -->
        </foo>;
trace(xml.comments().length()); // 2
trace(xml.comments()[1].toXMLString()); // <!-- example2 -->

contains

()

メソッド

AS3 function contains(value:XML):Boolean

XML オブジェクトと、指定された value パラメータを比較します。

パラメータ

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

戻り値

Boolean — XML オブジェクトが value パラメータに一致する場合は true、それ以外の場合は false を返します。

関連項目

XML objects

例

この例は、contains() メソッドの使用法を示しています。

var xml:XML = 
        <order>
            <item>Rice</item>
            <item>Kung Pao Shrimp</item>
        </order>;
trace(xml.item[0].contains(<item>Rice</item>)); // true
trace(xml.item[1].contains(<item>Kung Pao Shrimp</item>)); // true
trace(xml.item[1].contains(<item>MSG</item>)); // false

copy

()

メソッド

AS3 function copy():XML

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

戻り値

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

関連項目

XML objects

例

この例では、copy() メソッドは XML オブジェクトの新しいインスタンスを作成しています。コピーを修正しても、元のオブジェクトは変更されません。

var xml1:XML = <foo />;
var xml2:XML = xml1.copy();
xml2.appendChild(<bar />);
trace(xml1.bar.length()); // 0
trace(xml2.bar.length()); // 1

defaultSettings

()

メソッド

AS3 static function defaultSettings():Object

プロパティ ignoreComments、ignoreProcessingInstructions、ignoreWhitespace、prettyIndent、および prettyPrinting をデフォルト値に設定したオブジェクトを返します。. デフォルト値は次のとおりです。

ignoreComments = true
ignoreProcessingInstructions = true
ignoreWhitespace = true
prettyIndent = 2
prettyPrinting = true

メモ : このメソッドを XML クラスのインスタンスには適用しません。次のコードのように、XML に適用します。var df:Object = XML.defaultSettings() .

戻り値

Object — プロパティをデフォルト値に設定したオブジェクトです。

例

次の例は、XML オブジェクトを設定する前に、コメントおよび処理命令を配置するカスタム設定を適用する方法、別のXML オブジェクトを設定する前にデフォルト設定に戻す方法、さらに別の XML オブジェクトの設定のために再度カスタム設定を適用する方法を示しています。

XML.ignoreComments = false;
XML.ignoreProcessingInstructions = false;
var customSettings:Object = XML.settings();

var xml1:XML = 
        <foo>
            <!-- comment -->
            <?instruction ?>
        </foo>;
trace(xml1.toXMLString());
//    <foo>
//        <!-- comment -->
//         <?instruction ?>
//    </foo>

XML.setSettings(XML.defaultSettings());
var xml2:XML = 
        <foo>
            <!-- comment -->
            <?instruction ?>
        </foo>;
trace(xml2.toXMLString());

descendants

()

メソッド

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

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

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

パラメータ

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

戻り値

XMLList — 一致する子孫の XMLList オブジェクトです。子孫がない場合は、空の XMLList オブジェクトを返します。

関連項目

descendant accessor (..) 演算子

例

ActionScript の予約語に一致する名前の子孫を返すには、子孫演算子（..）ではなく、次の例のように descendants() メソッドを使用します。

var xml:XML = 
  <enrollees>
    <student id="239">
        <class name="Algebra" />
        <class name="Spanish 2"/>
    </student>
    <student id="206">
        <class name="Trigonometry" />
        <class name="Spanish 2" />
    </student>
  </enrollees>
trace(xml.descendants("class"));

次の例では、descendants() メソッドは、子、孫など、子孫オブジェクトのすべてを含む XMLList オブジェクトを返しています。

XML.ignoreComments = false;
var xml:XML = 
        <body>
            <!-- comment -->
            text1
            <a>
                <b>text2</b>
            </a>
        </body>;
trace(xml.descendants("*").length()); // 5
trace(xml.descendants("*")[0]); // // <!-- comment -->
trace(xml.descendants("*")[1].toXMLString()); // text1
trace(xml.descendants("a").toXMLString()); // <a><b>text2</b></a>
trace(xml.descendants("b").toXMLString()); // <b>text2</b>

elements

()

メソッド

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

XML オブジェクトのエレメントを列挙します。エレメントは、<first></first> のように開始タグと終了タグで構成されます。name パラメータはオプションです。name パラメータには、QName オブジェクト、String データ型、または他の任意のデータ型（後で String データ型に変換されます）を指定できます。name パラメータは、特定のエレメントの列挙に使用します。たとえば、<first>John</first> では、エレメント "first" は "John" を返します。

すべてのエレメントを列挙するには、パラメータにアスタリスク（*）を使用します。アスタリスクはデフォルトパラメータでもあります。

エレメントの総数を出力するには、length() メソッドをアスタリスクパラメータと共に使用します。たとえば、numElement = addressbook.elements("*").length() となります。

パラメータ

name:Object (default = *) — エレメントの名前です。エレメントの名前は山括弧で囲まれています。たとえば、<first></first> の name は "first" です。

戻り値

XMLList — エレメントの内容の XMLList オブジェクトです。エレメントの内容は開始タグと終了タグで囲まれます。すべてのエレメントの呼び出しでアスタリスク（*）を使用すると、エレメントのタグと内容の両方を返します。

例

次の例では、elements() メソッドは、コメント、テキストプロパティ、または処理命令を返さずに、エレメントのリストのみを返しています。

var xml:XML = 
        <foo>
            <!-- comment -->
            <?instruction ?>
            text
            <a>1</a>
            <b>2</b>
        </foo>;
trace(xml.elements("*").length()); // 2
trace(xml.elements("*")[0].toXMLString()); // <a>1</a>
trace(xml.elements("b").length()); // 1
trace(xml.elements("b")[0].toXMLString()); // <b>2</b>

ActionScript の予約語に一致する名前のエレメントを返すには、XML ドット演算子（.）ではなく、次の例のように elements() メソッドを使用します。

var xml:XML =
 <student id="206">
    <class name="Trigonometry" />
    <class name="Spanish 2" />
 </student>
trace(xml.elements("class"));

hasComplexContent

()

メソッド

AS3 function hasComplexContent():Boolean

XML オブジェクトに複合内容が含まれるかどうかを確認します。子エレメントを持つ場合、XML オブジェクトには複合内容が含まれます。属性、コメント、処理命令、およびテキストノードを表す XML オブジェクトは複合内容を持ちません。ただし、これらを含むオブジェクトでも、子エレメントを持つ場合は、複合内容を含んでいると見なされます。

戻り値

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

関連項目

XML.hasSimpleContent()
XML objects

例

次の例は、単純内容を含む a という名前の 1 つのプロパティと、複合内容を含む a という名前の 1 つのプロパティを持つ XML オブジェクトを示しています。

var xml:XML = 
        <foo>
            <a>
                text
            </a>
            <a>
                <b/>
            </a>
        </foo>;
trace(xml.a[0].hasComplexContent()); // false
trace(xml.a[1].hasComplexContent()); // true

trace(xml.a[0].hasSimpleContent()); // true
trace(xml.a[1].hasSimpleContent()); // false

hasOwnProperty

()

メソッド

AS3 function hasOwnProperty(p:String):Boolean

オブジェクトに p パラメータで指定されたプロパティがあるかどうかを確認します。

パラメータ

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

戻り値

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

関連項目

XML objects

例

次の例では、hasOwnProperty() メソッドを使用してプロパティ（b）が存在することを確認してから、このプロパティを使用する式（b == "11"）を評価します。

var xml:XML = 
        <foo>
            <a />
            <a>
                <b>10</b>
            </a>
            <a>
                <b>11</b>
            </a>
        </foo>;
trace(xml.a.(hasOwnProperty("b") && b == "11"));

この例の最後の行が次のように記述されていると、a という名前の最初のエレメントに b という名前のプロパティが存在しないため、Flash Player は例外をスローします。

trace(xml.a.(b == "11"));

次の例では、hasOwnProperty() メソッドを使用してプロパティ（item）が存在することを確認してから、このプロパティを使用する式（item.contains("toothbrush")）を評価します。

var xml:XML = 
        <orders>
            <order id='1'>
                <item>toothbrush</item>
                <item>toothpaste</item>
            </order>
            <order>
                <returnItem>shoe polish</returnItem>
            </order>
        </orders>;
trace(xml.order.(hasOwnProperty("item") && item.contains("toothbrush")));

hasSimpleContent

()

メソッド

AS3 function hasSimpleContent():Boolean

XML オブジェクトに単純内容が含まれるかどうかを確認します。XML オブジェクトが子エレメントを持たないテキストノード、属性ノード、または XML エレメントを表す場合には、このオブジェクトには単純内容が含まれます。コメントおよび処理命令を表す XML オブジェクトには単純内容は含まれません。

戻り値

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

関連項目

XML.hasComplexContent()
XML objects

例

var xml:XML = 
        <foo>
            <a>
                text
            </a>
            <a>
                <b/>
            </a>
        </foo>;
trace(xml.a[0].hasComplexContent()); // false
trace(xml.a[1].hasComplexContent()); // true

trace(xml.a[0].hasSimpleContent()); // true
trace(xml.a[1].hasSimpleContent()); // false

inScopeNamespaces

()

メソッド

AS3 function inScopeNamespaces():Array

オブジェクトの親に基づいて、XML オブジェクトの名前空間を列挙します。

戻り値

Array — Namespace オブジェクトの配列です。

関連項目

XML objects

insertChildAfter

()

メソッド

AS3 function insertChildAfter(child1:Object, child2:Object):*

指定された child2 パラメータを、この XML オブジェクトの child1 パラメータの後に挿入し、その結果のオブジェクトを返します。child1 パラメータが null の場合、このメソッドは child2 の内容を、XML オブジェクトのすべての子の前、つまり先頭に挿入します。指定した child1 が XML オブジェクトに存在しない場合、XML オブジェクトは変更されずに、undefined が返されます。

テキスト、属性、コメント、パイなどのエレメントでない XML の子に対してこのメソッドを呼び出すと、undefined を返します。

XML ノードを削除するには、delete（XML）演算子を使用します。

パラメータ

	`child1:Object` — `child2` の前に挿入するソースオブジェクト内のオブジェクトです。

	`child2:Object` — 挿入するオブジェクトです。

戻り値

* — 結果として作成される XML オブジェクトまたは undefined です。

例

次の例では、XML オブジェクトの子エレメントの最後にエレメントを追加します。

var xml:XML = 
        <menu>
            <item>burger</item>
            <item>soda</item>
        </menu>;
xml.insertChildAfter(xml.item[0], <saleItem>fries</saleItem>);
trace(xml);

trace() の出力は次のようになります。

 <menu>
 	<item>burger</item>
 	<saleItem>fries</saleItem>
 	<item>soda</item>
 </menu>

insertChildBefore

()

メソッド

AS3 function insertChildBefore(child1:Object, child2:Object):*

指定された child2 パラメータを、この XML オブジェクトの child1 パラメータの前に挿入し、その結果のオブジェクトを返します。child1 パラメータが null の場合、このメソッドは child2 の内容を、XML オブジェクトのすべての子の後、つまり最後に挿入します。指定した child1 が XML オブジェクトに存在しない場合、XML オブジェクトは変更されずに、undefined が返されます。

テキスト、属性、コメント、パイなどのエレメントでない XML の子に対してこのメソッドを呼び出すと、undefined を返します。

XML ノードを削除するには、delete（XML）演算子を使用します。

パラメータ

	`child1:Object` — `child2` の後に挿入するソースオブジェクト内のオブジェクトです。

	`child2:Object` — 挿入するオブジェクトです。

戻り値

* — 結果として作成される XML オブジェクトまたは undefined です。

例

次の例では、XML オブジェクトの子エレメントの最後にエレメントを追加します。

var xml:XML = 
        <menu>
            <item>burger</item>
            <item>soda</item>
        </menu>;
xml.insertChildBefore(xml.bar[0], <saleItem>fries</saleItem>);
trace(xml);

trace() の出力は次のようになります。

<menu>
 	<saleItem>fries</saleItem>
 	<item>burger</item>
 	<item>soda</item>
 </menu>

length

()

メソッド

AS3 function length():int

XML オブジェクトの場合、このメソッドは常に整数 1 を返します。XMLList クラスの length() メソッドは、1 つの値のみを含む XMLList オブジェクトの値 1 を返します。

戻り値

int — どのような XML オブジェクトに対しても、常に 1 を返します。

関連項目

XML objects

localName

()

メソッド

AS3 function localName():Object

XML オブジェクトの修飾名のローカル名部分を指定します。

戻り値

Object — String または null のいずれかのローカル名です。

関連項目

XML objects

例

次の例は、localName() メソッドの使用法を示しています。

var xml:XML = 
        <soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
            soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">

                        <soap:Body xmlns:wx = "http://example.com/weather">
                <wx:forecast>
                    <wx:city>Quito</wx:city>
                </wx:forecast>
            </soap:Body>
        </soap:Envelope>;
        
trace(xml.localName()); // Envelope

name

()

メソッド

AS3 function name():Object

XML オブジェクトの修飾名を指定します。

戻り値

Object — 修飾名には、QName または null のいずれかを指定します。

例

次の例は、name() メソッドを使用して XML オブジェクトの修飾名を取得する方法を示しています。

var xml:XML = 
        <soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
            soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">

                        <soap:Body xmlns:wx = "http://example.com/weather">
                <wx:forecast>
                    <wx:city>Quito</wx:city>
                </wx:forecast>
            </soap:Body>
        </soap:Envelope>;
        
trace(xml.name().localName); // Envelope
trace(xml.name().uri); // "http://www.w3.org/2001/12/soap-envelope"

次の例は、XML プロパティ、テキストエレメント、および属性に対して呼び出す name() メソッドの使用法を示しています。

var xml:XML = 
        <foo x="15" y="22">
            text
        </foo>;
        
trace(xml.name().localName); // foo
trace(xml.name().uri == ""); // true
trace(xml.children()[0]); // text
trace(xml.children()[0].name()); // null
trace(xml.attributes()[0]); // 15
trace(xml.attributes()[0].name()); // x

namespace

()

メソッド

AS3 function namespace(prefix:String = null):*

パラメータを指定しない場合、この XML オブジェクトの修飾名に関連付けられている名前空間を指定します。prefix パラメータを指定した場合、prefix パラメータに一致し、XML オブジェクトのスコープ内にある名前空間を返します。このような条件に一致する名前空間がなかった場合、メソッドは undefined を返します。

パラメータ

prefix:String (default = null) — 照合する接頭辞です。

戻り値

* — null , undefined、または名前空間を返します。

関連項目

XML objects

例

次の例では、namespace() メソッドを使用して XML オブジェクトの名前空間を取得し、それを soap という名前の Namespace オブジェクトに割り当てます。次にその Namespace オブジェクトを使用して xml オブジェクト（xml.soap::Body[0]）のプロパティを識別します。

var xml:XML = 
        <soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
            soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">

                        <soap:Body xmlns:wx = "http://example.com/weather">
                <wx:forecast>
                    <wx:city>Quito</wx:city>
                </wx:forecast>
            </soap:Body>
        </soap:Envelope>;
        
var soap:Namespace = xml.namespace();
trace(soap.prefix); // soap
trace(soap.uri); // http://www.w3.org/2001/12/soap-envelope

var body:XML = xml.soap::Body[0];
trace(body.namespace().prefix); // soap
trace(xml.namespace().uri); // http://www.w3.org/2001/12/soap-envelope
trace(body.namespace("wx").uri); // "http://example.com/weather"

次の例では、namespace() メソッドを使用し、ノードのデフォルトの名前空間と、特定の接頭辞（"dc"）の名前空間を取得します。

var xml:XML = 
        <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" 
            xmlns:dc="http://purl.org/dc/elements/1.1/" 
            xmlns="http://purl.org/rss/1.0/">
                <!-- ... -->
        </rdf:RDF>;
                    
trace(xml.namespace()); // http://www.w3.org/1999/02/22-rdf-syntax-ns#
trace(xml.namespace("dc")); // http://purl.org/dc/elements/1.1/
trace(xml.namespace("foo")); // undefined

namespaceDeclarations

()

メソッド

AS3 function namespaceDeclarations():Array

親のコンテキストで XML オブジェクトに関連付けられている名前空間宣言を列挙します。

戻り値

Array — Namespace オブジェクトの配列です。

関連項目

XML.namespace()
XML objects

例

次の例は、XML オブジェクトの名前空間宣言を出力します。

var xml:XML = 
        <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" 
            xmlns:dc="http://purl.org/dc/elements/1.1/" 
            xmlns="http://purl.org/rss/1.0/">

            <!-- ... -->
            
        </rdf:RDF>;
                    
for (var i:uint = 0; i < xml.namespaceDeclarations().length; i++) {
    var ns:Namespace = xml.namespaceDeclarations()[i]; 
    var prefix:String = ns.prefix;
    if (prefix == "") {
        prefix = "(default)";
    }
    trace(prefix + ":" , ns.uri);
}

trace() の出力は次のようになります。

rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns#
 dc: http://purl.org/dc/elements/1.1/
 (default): http://purl.org/rss/1.0/

nodeKind

()

メソッド

AS3 function nodeKind():String

ノードのタイプ（テキスト、コメント、処理命令、属性、またはエレメント）を指定します。

戻り値

String — 使用するノードタイプです。

関連項目

attribute 識別子
XML objects

例

この例では、5 つのすべてのノードタイプをトレースします。

XML.ignoreComments = false;
XML.ignoreProcessingInstructions = false;

var xml:XML = 
    <example id="10">
        <!-- this is a comment -->
        <?test this is a pi ?>
        and some text
    </example>;

trace(xml.nodeKind()); // element
trace(xml.children()[0].nodeKind()); // comment
trace(xml.children()[1].nodeKind()); // processing-instruction
trace(xml.children()[2].nodeKind()); // text
trace(xml.@id[0].nodeKind()); // attribute

normalize

()

メソッド

AS3 function normalize():XML

XML オブジェクトとすべての子孫の XML オブジェクトについて、隣接するテキストノードを結合し、空のテキストノードを削除します。

戻り値

XML — 結果として作成される、正規化された XML オブジェクトです。

関連項目

XML objects

例

次の例は、normalize() メソッドを呼び出す場合の影響を示しています。

var xml:XML = <body></body>;
xml.appendChild("hello");
xml.appendChild(" world");
trace(xml.children().length()); // 2
xml.normalize();
trace(xml.children().length()); // 1

parent

()

メソッド

AS3 function parent():*

XML オブジェクトの親を返します。XML オブジェクトに親がない場合、メソッドは、undefined を返します。

戻り値

* — 親 XML オブジェクトです。String または null のいずれかを返します。

関連項目

XML objects
Traversing XML structures

例

次の例では、parent() メソッドを使用して、XML 構造内の特定エレメントの親エレメントを識別します。

var xml:XML = 
    <body>
        <p id="p1">Hello</p>
        <p id="p2">Test:
            <ul>
                <li>1</li>
                <li>2</li>
            </ul>
        </p>
    </body>;
var node:XML = xml.p.ul.(li.contains("1"))[0]; // == <ul> ... </ul>
trace(node.parent().@id); // p2

prependChild

()

メソッド

AS3 function prependChild(value:Object):XML

指定された child オブジェクトのコピーを、このエレメント内の既存のすべての XML プロパティの前に挿入します。

XML ノードを削除するには、delete（XML）演算子を使用します。

パラメータ

value:Object — 挿入するオブジェクトです。

戻り値

XML — 結果として作成される XML オブジェクトです。

例

次の例では、prependChild() メソッドを使用して、XML オブジェクトの子リストの先頭にエレメントを追加します。

var xml:XML = 
        <body>
            <p>hello</p>
        </body>;
        
xml.prependChild(<p>world</p>);    
trace(xml.p[0].toXMLString()); // <p>world</p>
trace(xml.p[1].toXMLString()); // <p>hello</p>

processingInstructions

()

メソッド

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

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

パラメータ

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

戻り値

XMLList — 一致する子オブジェクトのリストです。

関連項目

XML objects

例

次の例では、processingInstructions() メソッドを使用して、XML オブジェクトの処理命令の配列を取得します。

XML.ignoreProcessingInstructions = false;
var xml:XML =
    <body>
            foo
            <?xml-stylesheet href="headlines.css" type="text/css" ?>
            <?instructionX ?>
            
    </body>;

trace(xml.processingInstructions().length()); // 2
trace(xml.processingInstructions()[0].name()); // xml-stylesheet

propertyIsEnumerable

()

メソッド

AS3 function propertyIsEnumerable(p:String):Boolean

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

パラメータ

p:String — チェックするプロパティです。

戻り値

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

関連項目

XML objects

例

次の例では、propertyNameIsEnumerable() メソッドは、XML オブジェクトの場合に値 true を、値 0 に対してのみ返し、XMLList オブジェクトの場合は、XMLList オブジェクトの有効な各インデックス値に対して値 true を返しています。

var xml:XML = 
        <body>
             <p>Hello</p>
               <p>World</p>
        </body>;

trace(xml.propertyIsEnumerable(0)); // true
trace(xml.propertyIsEnumerable(1)); // false

for (var propertyName:String in xml) {
    trace(xml[propertyName]);
}

var list:XMLList = xml.p;
trace(list.propertyIsEnumerable(0)); // true
trace(list.propertyIsEnumerable(1)); // true
trace(list.propertyIsEnumerable(2)); // false

for (var propertyName:String in list) { 
    trace(list[propertyName]);
}

removeNamespace

()

メソッド

AS3 function removeNamespace(ns:Namespace):XML

このオブジェクトとすべての子孫に指定された名前空間を削除します。名前空間がオブジェクトの修飾名またはオブジェクトの属性の修飾名によって参照されている場合、removeNamespace() メソッドは名前空間を削除しません。

パラメータ

ns:Namespace — 削除する名前空間です。

戻り値

XML — 結果として作成される XML オブジェクトのコピーです。

関連項目

XML objects

例

次の例は、XML オブジェクトから名前空間宣言を削除する方法を示しています。

var xml:XML = 
    <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" 
        xmlns:dc="http://purl.org/dc/elements/1.1/" 
        xmlns="http://purl.org/rss/1.0/">
    
        <!-- ... -->
        
    </rdf:RDF>;

trace(xml.namespaceDeclarations().length); // 3
trace(xml.namespaceDeclarations()[0] is String); // 
var dc:Namespace = xml.namespace("dc");
xml.removeNamespace(dc);
trace(xml.namespaceDeclarations().length); // 2

replace

()

メソッド

AS3 function replace(propertyName:Object, value:XML):XML

propertyName パラメータで指定されたプロパティを、指定された value パラメータに置き換えます。propertyName に一致するプロパティがない場合、XML オブジェクトは変更されません。

パラメータ

	`propertyName:Object` — 数値、XML エレメントセットの無修飾名、XML エレメントセットの修飾名、またはアスタリスクワイルドカード（"*"）を使用できます。無修飾名は、デフォルトの名前空間内での XML エレメントの識別に使用します。

	`value:XML` — 置換する値です。この値には、XML オブジェクト、XMLList オブジェクト、または `toString()` で変換可能な値を使用できます。

戻り値

XML — 一致するプロパティが置き換えられた、結果として作成される XML オブジェクトです。

関連項目

XML objects

例

次の例では、1 番目のパラメータに整数を指定して replace() メソッドを呼び出します。

var xml:XML = 
    <body>
        <p>Hello</p>
        <p>World</p>
        <hr/>
    </body>;

xml.replace(1, <p>Bob</p>);
trace(xml);

この結果は、次の trace() 出力のようになります。


 <body>
 	<p>Hello</p>
 	<p>Bob</p>
 	<hr/>
 </body>

次の例は、1 番目のパラメータにストリングを指定して replace() メソッドを呼び出します。

var xml:XML = 
    <body>
        <p>Hello</p>
        <p>World</p>
        <hr/>
    </body>;

xml.replace("p", <p>Hi</p>); 
trace(xml);

この結果は、次の trace() 出力のようになります。


 <body>
 	<p>Hi</p>
 	<hr/>
 </body>;

次の例では、1 番目のパラメータに QName を指定して replace() メソッドを呼び出します。

var xml:XML = 
    <ns:body xmlns:ns = "myNS">
        <ns:p>Hello</ns:p>
        <ns:p>World</ns:p>
        <hr/>
    </ns:body>;

var qname:QName = new QName("myNS", "p");
xml.replace(qname, <p>Bob</p>);
trace(xml);

この結果は、次の trace() 出力のようになります。


 <ns:body xmlns:ns = "myNS">
 	<p>Bob</p>
 	<hr/>
 </ns:body>

次の例では、replace() メソッドを呼び出します（1 番目のパラメータにストリング "*" を指定）。

var xml:XML = 
    <body>
        <p>Hello</p>
        <p>World</p>
        <hr/>
    </body>;

xml.replace("*", <img src = "hello.jpg"/>);
trace(xml);

この結果は、次の trace() 出力のようになります。


 <body>
 	<img src="hello.jpg"/>
 </body>

setChildren

()

メソッド

AS3 function setChildren(value:Object):XML

XML オブジェクトの子プロパティを、value パラメータで指定された XML プロパティのセットに置き換えます。

パラメータ

value:Object — 置き換えに使用する XML プロパティです。単一の XML オブジェクト、または XMLList オブジェクトにすることができます。

戻り値

XML — 結果として作成される XML オブジェクトです。

関連項目

XML objects

例

次の例では、まず、XML オブジェクトをパラメータに指定して setChildren() メソッドを呼び出し、次に XMLList オブジェクトをパラメータに指定して呼び出しています。

var xml:XML = 
    <body>
        <p>Hello</p>
        <p>World</p>
    </body>;

var list:XMLList = xml.p;

xml.setChildren(<p>hello</p>);
trace(xml);

//    <body>
//        <p>hello</p>
//    </body>

xml.setChildren(list);
trace(xml);

//    <body>
//        <p>Hello</p>
//        <p>World</p>
//    </body>

setLocalName

()

メソッド

AS3 function setLocalName(name:String):void

XML オブジェクトのローカル名を、指定された name パラメータに変更します。

パラメータ

name:String — ローカル名に置き換える名前です。

関連項目

XML objects

例

次の例では、setLocalName() メソッドを使用して、XML エレメントのローカル名を変更します。

var xml:XML = 
    <ns:item xmlns:ns="http://example.com">
        toothbrush
    </ns:item>;
    
xml.setLocalName("orderItem");
trace(xml.toXMLString()); // <ns:orderItem xmlns:ns="http://example.com">toothbrush</ns:orderItem>

setName

()

メソッド

AS3 function setName(name:String):void

XML オブジェクトの名前を、指定された修飾名または属性名に設定します。

パラメータ

name:String — オブジェクトの新しい名前です。

関連項目

パッケージ	トップレベル
Class	public final dynamic class XML
継承	XML Object