オブジェクト組み込みオブジェクト

オブジェクトXmlElement

XmlElementオブジェクトは、XMLドキュメントの要素を表します

継承

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>XmlNode|nodeType;nodeName;nodeValue;ownerDocument;parentNode;childNodes;firstChild;lastChild;previousSibling;nextSibling|hasChildNodes();normalize();cloneNode();lookupPrefix();lookupNamespaceURI();insertBefore();insertAfter();appendChild();replaceChild();removeChild()] [<this>XmlElement|namespaceURI;prefix;localName;tagName;id;textContent;innerHTML;className;attributes|getAttribute();getAttributeNS();setAttribute();setAttributeNS();removeAttribute();removeAttributeNS();hasAttribute();hasAttributeNS();getElementsByTagName();getElementsByTagNameNS();getElementById();getElementsByClassName()] [object] <:- [XmlNode] [XmlNode] <:- [XmlElement] XmlNode nodeType nodeName nodeValue ownerDocument parentNode childNodes firstChild lastChild previousSibling nextSibling hasChildNodes() normalize() cloneNode() lookupPrefix() lookupNamespaceURI() insertBefore() insertAfter() appendChild() replaceChild() removeChild() XmlElement namespaceURI prefix localName tagName id textContent innerHTML className attributes getAttribute() getAttributeNS() setAttribute() setAttributeNS() removeAttribute() removeAttributeNS() hasAttribute() hasAttributeNS() getElementsByTagName() getElementsByTagNameNS() getElementById() getElementsByClassName() object toString() toJSON()

メンバー属性

namespaceURI

文字列、クエリ要素の名前空間のURI。選択したノードに名前空間がない場合、この属性はNULLを返します

1
readonly String XmlElement.namespaceURI;

prefix

要素の名前空間プレフィックスを文字列、クエリ、および設定します。選択したノードに名前空間がない場合、この属性はNULLを返します

1
String XmlElement.prefix;

localName

文字列、クエリ要素のローカル名。選択したノードに名前空間がない場合、この属性はnodeNameと同等です。

1
readonly String XmlElement.localName;

tagName

文字列、要素のタグ名を返します

1
readonly String XmlElement.tagName;

id

要素のid属性を文字列、クエリ、および設定します

1
String XmlElement.id;

textContent

選択した要素のテキストを文字列、クエリ、および設定します。クエリを実行するときは、要素ノード内のすべてのテキストノードの値を返します。設定するときは、すべての子ノードを削除して、単一のテキストノードに置き換えます。

1
String XmlElement.textContent;

innerHTML

選択した要素のHTMLテキストを文字列、クエリ、および設定します。これはhtmlモードでのみ有効です。クエリを実行するときは、要素ノード内のすべての子ノードのHTMLコードを返します。設定するときは、すべての子ノードを削除し、デコード後に指定されたHTMLに置き換えます。

1
String XmlElement.innerHTML;

className

要素のクラス属性を文字列、クエリ、および設定します。htmlモードでのみ有効です。

1
String XmlElement.className;

attributes

XmlNamedNodeMap、選択したノードの属性を含むNamedNodeMapを返します。選択したノードが要素でない場合、この属性はNULLを返します。

1
readonly XmlNamedNodeMap XmlElement.attributes;

nodeType

整数、ノードのノードタイプを返します

1
readonly Integer XmlElement.nodeType;

異なるオブジェクトのnodeTypeは、異なる値を返します。


nodeName

文字列、タイプに応じてノードの名前を返します

1
readonly String XmlElement.nodeName;

異なるオブジェクトのnodeNameは、異なる値を返します。


nodeValue

文字列、タイプに応じてノードの名前を返します

1
String XmlElement.nodeValue;

異なるオブジェクトのnodeNameは、異なる値を返します。


ownerDocument

XmlDocument、ノードのルート要素を返します(XmlDocument 物体)

1
readonly XmlDocument XmlElement.ownerDocument;

parentNode

XmlNode、ノードの親ノードを返すことができます

1
readonly XmlNode XmlElement.parentNode;

childNodes

XmlNodeList、指定されたノードの子ノードのノードリストを返します

1
readonly XmlNodeList XmlElement.childNodes;

firstChild

XmlNode、ノードの最初の子ノードを返します

1
readonly XmlNode XmlElement.firstChild;

lastChild

XmlNode、ノードの最後の子ノードを返します

1
readonly XmlNode XmlElement.lastChild;

previousSibling

XmlNode、特定のノードの直前(同じツリーレベル)のノードを返します。そのようなノードがない場合、属性はnullを返します。

1
readonly XmlNode XmlElement.previousSibling;

nextSibling

XmlNode、(同じツリーレベルの)要素の直後のノードを返します。そのようなノードがない場合、プロパティはnullを返します。

1
readonly XmlNode XmlElement.nextSibling;

メンバー関数

getAttribute

名前で属性の値を照会する

1
String XmlElement.getAttribute(String name);

呼び出しパラメーター:

  • name:文字列、クエリのプロパティ名を指定します

戻り結果:

  • String、属性の値を返します

getAttributeNS

名前空間URIと名前で属性値を取得する

1 2
String XmlElement.getAttributeNS(String namespaceURI, String localName);

呼び出しパラメーター:

  • namespaceURI:文字列、クエリの名前空間URIを指定します
  • localName:文字列、クエリのプロパティ名を指定します

戻り結果:

  • String、属性の値を返します

setAttribute

新しいプロパティを作成または変更する

1 2
XmlElement.setAttribute(String name, String value);

呼び出しパラメーター:

  • name:文字列、設定するプロパティの名前を指定します
  • value:文字列、設定する属性値を指定します

このメソッドは、指定された属性を指定された値に設定します。指定された名前の属性がない場合、メソッドは新しい属性を作成します


setAttributeNS

名前空間を使用して属性を作成または変更する

1 2 3
XmlElement.setAttributeNS(String namespaceURI, String qualifiedName, String value);

呼び出しパラメーター:

  • namespaceURI:文字列、設定する名前空間URIを指定します
  • qualifiedName:文字列、設定するプロパティの名前を指定します
  • value:文字列、設定する属性値を指定します

このメソッドはsetAttributeメソッドに似ていますが、作成または設定される属性が名前空間URIと修飾名(名前空間のプレフィックス、コロン、および名前空間内のローカル名で構成される)によって指定される点が異なります。このメソッドを使用すると、属性の値を変更するだけでなく、属性の名前空間プレフィックスを変更することもできます。


removeAttribute

指定した属性を名前で削除します

1
XmlElement.removeAttribute(String name);

呼び出しパラメーター:

  • name:文字列、削除された属性の名前を指定します

removeAttributeNS

名前空間と名前で指定された属性を削除します

1 2
XmlElement.removeAttributeNS(String namespaceURI, String localName);

呼び出しパラメーター:

  • namespaceURI:文字列、削除する名前空間URIを指定します
  • localName:文字列、削除された属性の名前を指定します

hasAttribute

現在のノードに指定された名前の属性があるかどうかを照会します

1
Boolean XmlElement.hasAttribute(String name);

呼び出しパラメーター:

  • name:文字列、クエリの属性名を指定します

戻り結果:

  • Boolean、現在の要素ノードに指定された属性がある場合はtrueを返し、そうでない場合はfalseを返します。

hasAttributeNS

現在のノードに指定された名前空間と名前の属性があるかどうかを照会します

1 2
Boolean XmlElement.hasAttributeNS(String namespaceURI, String localName);

呼び出しパラメーター:

  • namespaceURI:文字列、クエリする名前空間URIを指定します
  • localName:文字列、クエリの属性名を指定します

戻り結果:

  • Boolean、現在の要素ノードに指定された属性がある場合はtrueを返し、そうでない場合はfalseを返します。

getElementsByTagName

指定された名前のすべての要素を返します XmlNodeList

1
XmlNodeList XmlElement.getElementsByTagName(String tagName);

呼び出しパラメーター:

  • tagName:文字列、取得するタグ名。値「*」はすべてのタグに一致します

戻り結果:

  • XmlNodeList、ノードツリーで指定されたマークを持つXmlElementノードの XmlNodeList集める。返される要素ノードの順序は、ソースドキュメントに表示される順序です。

このメソッドは、指定された要素の子孫をトラバースし、XmlElementノードを返します XmlNodeListオブジェクト。指定されたタグ名を持つすべてのドキュメント要素を意味します。返される配列内の要素の順序は、ドキュメントのソースコードに表示される順序です。

XmlDocument インターフェイスはgetElementsByTagNameメソッドも定義します。これはこのメソッドに似ていますが、要素の子孫をトラバースするのではなく、ドキュメント全体をトラバースします。


getElementsByTagNameNS

指定された名前空間と名前を持つすべての要素を返します XmlNodeList

1 2
XmlNodeList XmlElement.getElementsByTagNameNS(String namespaceURI, String localName);

呼び出しパラメーター:

  • namespaceURI:文字列、クエリする名前空間URIを指定します
  • localName:文字列、取得するタグ名。値「*」はすべてのタグに一致します

戻り結果:

  • XmlNodeList、ノードツリーで指定されたマークを持つXmlElementノードの XmlNodeList集める。返される要素ノードの順序は、ソースドキュメントに表示される順序です。

このメソッドはgetElementsByTagNameメソッドに似ていますが、取得する要素のタグ名が名前空間URIと名前空間で定義されたローカル名の組み合わせとして指定される点が異なります。


getElementById

指定されたid属性を持つ要素を返します

1
XmlElement XmlElement.getElementById(String id);

呼び出しパラメーター:

  • id:文字列、取得するID

戻り結果:

  • XmlElement、ノードツリーで指定されたid属性を持つXmlElementノード

このメソッドは、指定された要素の子孫ノードをトラバースし、指定されたid属性を持つ最初のドキュメント要素を表すXmlElementノードオブジェクトを返します。

XmlDocument インターフェイスはgetElementsByTagNameメソッドも定義します。これはこのメソッドに似ていますが、要素の子孫をトラバースするのではなく、ドキュメント全体をトラバースします。


getElementsByClassName

指定されたクラス名を持つすべての要素のノードリストを返します

1
XmlNodeList XmlElement.getElementsByClassName(String className);

呼び出しパラメーター:

  • className:文字列、取得するクラスの名前

戻り結果:

  • XmlNodeList、ドキュメントツリーで指定されたクラス名を持つXmlElementノード XmlNodeList集める。返される要素ノードの順序は、ソースドキュメントに表示される順序です。

このメソッドは XmlNodeList オブジェクト(読み取り専用配列として扱うことができます)。このオブジェクトは、指定されたクラス名を持つすべてのXmlElementノードをドキュメントに格納します。格納される順序は、ソースドキュメントに表示される順序です。 XmlNodeList オブジェクトは「ライブ」です。つまり、指定されたタグ名の要素がドキュメントで追加または削除された場合、そのコンテンツは必要に応じて自動的に更新されます。


hasChildNodes

子ノードがあるかどうかを照会します

1
Boolean XmlElement.hasChildNodes();

戻り結果:

  • Boolean、子ノードがある場合はtrueを返し、そうでない場合はfalseを返します

normalize

隣接するテキストノードをマージし、空のテキストノードを削除します

1
XmlElement.normalize();

このメソッドは、現在のノードのすべての子孫ノードをトラバースし、空のテキストノードを削除し、隣接するすべてのテキストノードをマージすることによってドキュメントを正規化します。この方法は、ノードを挿入または削除した後のドキュメントツリーの構造を単純化するのに役立ちます。


cloneNode

指定されたノードの正確なコピーを作成します

1
XmlNode XmlElement.cloneNode(Boolean deep = true);

呼び出しパラメーター:

  • deep:ブール値、ディープコピーするかどうか、trueの場合、複製されたノードは元のノードのすべての子ノードを複製します

戻り結果:

  • XmlNode、コピーしたノードを返します

このメソッドは、それを呼び出したノードのコピーをコピーして返します。渡されたパラメーターがtrueの場合、現在のノードのすべての子孫も再帰的にコピーします。それ以外の場合は、現在のノードのみをコピーします。返されたノードはドキュメントツリーに属しておらず、そのparentNodeプロパティはnullです。Elementノードがコピーされると、そのすべての属性がコピーされます。


lookupPrefix

現在のノードで指定された名前空間URIに一致するプレフィックスを返します

1
String XmlElement.lookupPrefix(String namespaceURI);

呼び出しパラメーター:

  • namespaceURI:文字列、一致する名前空間URIを指定します

戻り結果:

  • String、一致したプレフィックスを返し、一致しない場合はnullを返します

lookupNamespaceURI

現在のノードで指定されたプレフィックスに一致する名前空間URIを返します

1
String XmlElement.lookupNamespaceURI(String prefix);

呼び出しパラメーター:

  • prefix:文字列、一致するプレフィックスを指定します

戻り結果:

  • String、一致する名前空間URIを返し、一致しない場合はnullを返します

insertBefore

既存の子ノードの前に新しい子ノードを挿入します

1 2
XmlNode XmlElement.insertBefore(XmlNode newChild, XmlNode refChild);

呼び出しパラメーター:

  • newChildXmlNode、新しいノードを挿入します
  • refChildXmlNode、このノードの前に新しいノードを挿入します

戻り結果:

  • XmlNode、新しい子ノードを返します

newChildがドキュメントツリーにすでに存在する場合は、ドキュメントツリーから削除されてから、新しい位置に再挿入されます。あるドキュメントのノード(または1つのドキュメントによって作成されたノード)を別のドキュメントに挿入することはできません。つまり、newChildのownerDocumentプロパティは、現在のノードのownerDocumentプロパティと同じである必要があります。


insertAfter

既存の子ノードの後に​​新しい子ノードを挿入します

1 2
XmlNode XmlElement.insertAfter(XmlNode newChild, XmlNode refChild);

呼び出しパラメーター:

  • newChildXmlNode、新しいノードを挿入します
  • refChildXmlNode、このノードの後に​​新しいノードを挿入します

戻り結果:

  • XmlNode、新しい子ノードを返します

newChildがドキュメントツリーにすでに存在する場合は、ドキュメントツリーから削除されてから、新しい位置に再挿入されます。あるドキュメントのノード(または1つのドキュメントによって作成されたノード)を別のドキュメントに挿入することはできません。つまり、newChildのownerDocumentプロパティは、現在のノードのownerDocumentプロパティと同じである必要があります。


appendChild

ノードの子ノードリストの最後に新しい子ノードを追加します

1
XmlNode XmlElement.appendChild(XmlNode newChild);

呼び出しパラメーター:

  • newChildXmlNode、追加したノードを指定します

戻り結果:

  • XmlNode、この新しい子ノードを返します

newChildがドキュメントツリーにすでに存在する場合は、ドキュメントツリーから削除されてから、新しい位置に再挿入されます。あるドキュメントのノード(または1つのドキュメントによって作成されたノード)を別のドキュメントに挿入することはできません。つまり、newChildのownerDocumentプロパティは、現在のノードのownerDocumentプロパティと同じである必要があります。


replaceChild

1つの子ノードを別の子ノードに置き換えます

1 2
XmlNode XmlElement.replaceChild(XmlNode newChild, XmlNode oldChild);

呼び出しパラメーター:

  • newChildXmlNode、新しいノードを指定します
  • oldChildXmlNode、置き換えるノードを指定します

戻り結果:

  • XmlNode、置換が成功した場合、このメソッドは置換されたノードを返すことができ、置換が失敗した場合、nullを返します

newChildがドキュメントツリーにすでに存在する場合は、ドキュメントツリーから削除されてから、新しい位置に再挿入されます。あるドキュメントのノード(または1つのドキュメントによって作成されたノード)を別のドキュメントに挿入することはできません。つまり、newChildのownerDocumentプロパティは、現在のノードのownerDocumentプロパティと同じである必要があります。


removeChild

子ノードのリストからノードを削除します

1
XmlNode XmlElement.removeChild(XmlNode oldChild);

呼び出しパラメーター:

  • oldChildXmlNode、削除するノードを指定します

戻り結果:

  • XmlNode、削除が成功した場合、このメソッドは削除されたノードを返すことができます。失敗した場合、nullを返します。

toString

オブジェクトの文字列表現を返します。通常は「[NativeObject]」を返します。オブジェクトは、独自の特性に従って再実装できます。

1
String XmlElement.toString();

戻り結果:

  • String、オブジェクトの文字列表現を返します

toJSON

オブジェクトのJSON形式の表現を返します。通常、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。

1
Value XmlElement.toJSON(String key = "");

呼び出しパラメーター:

  • key:文字列、未使用

戻り結果:

  • Value、シリアル化可能なJSONを含む値を返します