org.w3c.dom
インタフェース Element

すべてのスーパーインタフェース:

Node

既知の実装クラスの一覧:

IIOMetadataNode

public interface Element
extends Node

Element インタフェースは、HTML 文書または XML 文書内の要素を表します。これらの要素は、自身に関連付けられた属性を持つことができます。Element インタフェースは Node を継承するので、汎用の Node インタフェース属性である attributes を使用して、ある要素の属性全部を取得できます。Element インタフェース上には、名前を指定して Attr オブジェクトを取得するメソッドや、名前を指定して属性値を取得するメソッドがあります。XML では、属性値に実体参照を含めることができます。したがって、Attr オブジェクトを取得することにより、属性値を示すサブツリー (かなり複雑なものを含む) を検査する必要があります。一方、HTML では、属性はいずれも単純な文字列値を持つことになります。したがって、属性値に直接アクセスするメソッドを安全かつ便利に使用できます。

注: DOM レベル 2 では、メソッド normalize は、その移動先 Node インタフェースから継承されます。

「Document Object Model (DOM) Level 3 Core Specification」も参照してください。

フィールドの概要

インタフェース org.w3c.dom.Node から継承されたフィールド

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

メソッドの概要

String	getAttribute(String name) 名前を指定して属性を取得します。
Attr	getAttributeNode(String name) 名前を指定して属性ノードを取得します。
Attr	getAttributeNodeNS(String namespaceURI, String localName) ローカル名と名前空間 URI を指定して Attr ノードを取得します。
String	getAttributeNS(String namespaceURI, String localName) ローカル名と名前空間 URI を指定して属性値を取得します。
NodeList	getElementsByTagName(String name) 所定のタグ名とともに、すべての子孫 Elements の NodeList を文書順に返します。
NodeList	getElementsByTagNameNS(String namespaceURI, String localName) 所定のローカル名と名前空間 URI とともに、すべての子孫 Elements の NodeList を文書順に返します。
TypeInfo	getSchemaTypeInfo() この要素に関連する型情報です。
String	getTagName() 要素の名前です。
boolean	hasAttribute(String name) この要素上に所定の名前の属性が指定された場合、または属性にデフォルト値がある場合は true、そうでない場合は false
boolean	hasAttributeNS(String namespaceURI, String localName) 所定のローカル名と名前空間 URI を持つ属性がこの要素で指定されているか、デフォルト値を持つ場合は true を返し、そうでない場合は false を返します。
void	removeAttribute(String name) 名前を指定して属性を削除します。
Attr	removeAttributeNode(Attr oldAttr) 指定された属性ノードを削除します。
void	removeAttributeNS(String namespaceURI, String localName) ローカル名と名前空間 URI を指定して属性を削除します。
void	setAttribute(String name, String value) 新しい属性を追加します。
Attr	setAttributeNode(Attr newAttr) 新しい属性を追加します。
Attr	setAttributeNodeNS(Attr newAttr) 新しい属性を追加します。
void	setAttributeNS(String namespaceURI, String qualifiedName, String value) 新しい属性を追加します。
void	setIdAttribute(String name, boolean isId) isId パラメータが true の場合、このメソッドは指定された属性が ユーザ決定 ID 属性であることを宣言します。
void	setIdAttributeNode(Attr idAttr, boolean isId) isId パラメータが true の場合、このメソッドは指定された属性がユーザ決定 ID 属性であることを宣言します。
void	setIdAttributeNS(String namespaceURI, String localName, boolean isId) isId パラメータが true の場合、このメソッドは指定された属性がユーザ決定 ID 属性であることを宣言します。

インタフェース org.w3c.dom.Node から継承されたメソッド

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

メソッドの詳細

getTagName

String getTagName()

要素の名前です。Node.localName が null ではない場合、この属性は修飾名です。次に例を示します。

 <elementExample id="demo">
 ... 
</elementExample> , 

tagName の値は「elementExample」です。XML では、DOM の操作と同様にアルファベットの大文字と小文字の区別が保存されます。HTML DOM は、ソースとなる HTML 文書で大文字と小文字のどちらが使用されていても、HTML 要素の tagName を標準の大文字で返します。

getAttribute

String getAttribute(String name)

名前を指定して属性を取得します。

パラメータ:

name - 取得する属性の名前

戻り値:

文字列で表現された Attr の値。その属性が指定された値またはデフォルト値を持たない場合は空文字列

setAttribute

void setAttribute(String name,
                  String value)
                  throws DOMException

新しい属性を追加します。要素内にその名前の属性がすでに存在する場合、その値は value パラメータの値に変更されます。この値は単純な文字列であり、設定時に解析は行われません。その結果、あらゆるマークアップ (実体参照として認識される構文を含む) が文字テキストと見なされます。実装は、書き出しを行う際、これを適切な方法でエスケープする必要があります。実体参照を含む属性値を割り当てるには、Attr ノードのほかに Text ノードと EntityReference ノードを作成する必要があります。次に、適切なサブツリーを構築し、setAttributeNode を使用して、これを属性値として割り当てます。
修飾名と名前空間 URI を持つ属性を設定するには、setAttributeNS メソッドを使用します。

パラメータ:

name - 作成または変更する属性の名前

value - 設定する値を表す文字列

例外:

DOMException - INVALID_CHARACTER_ERR: 指定された名前が、使用中の XML バージョン (Document.xmlVersion 属性に指定されている) に定められている XML 名ではない場合
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用である場合

removeAttribute

void removeAttribute(String name)
                     throws DOMException

名前を指定して属性を削除します。削除される属性のデフォルト値が DTD で定義されていると、デフォルト値ばかりでなく、該当する場合は対応する名前空間 URI、ローカル名、接頭辞とともに新しい属性がすぐに表示されます。実装では、ほかのスキーマのデフォルト値を同様に処理できますが、アプリケーションでは Document.normalizeDocument() を使用して、情報が最新の情報であることを保証する必要があります。
この名前を持つ属性が見つからない場合には、このメソッドは効果がありません。
ローカル名と名前空間 URI で属性を削除するには、removeAttributeNS メソッドを使用します。

パラメータ:

name - 削除する属性の名前

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合

getAttributeNode

Attr getAttributeNode(String name)

名前を指定して属性ノードを取得します。
修飾名と名前空間 URI を指定して属性ノードを取得するには、getAttributeNodeNS メソッドを使用します。

パラメータ:

name - 取得する属性の名前 (nodeName)

戻り値:

指定された名前 ( nodeName) の Attr ノード。該当する属性が存在しない場合は null

setAttributeNode

Attr setAttributeNode(Attr newAttr)
                      throws DOMException

新しい属性を追加します。指定した名前 (nodeName) を持つ属性がすでに要素内に存在する場合は、新しい属性に置き換えられます。属性ノードをその属性ノード自体に置き換えても影響はまったくありません。
修飾名と名前空間 URI を持つ属性ノードを新しく追加するには、setAttributeNodeNS メソッドを使用します。

パラメータ:

newAttr - 属性リストに追加する Attr ノード

戻り値:

既存の属性が newAttr 属性で置き換えられる場合は置き換えの対象となる Attr ノード。それ以外の場合は null

例外:

DOMException - WRONG_DOCUMENT_ERR: 要素を作成した文書とは異なる文書から newAttr が作成された場合
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用である場合
INUSE_ATTRIBUTE_ERR: newAttr が別の Element オブジェクトの属性である場合。Attr ノードをほかの要素で再利用するには、このノードを DOM ユーザの手で明示的に複製する必要がある

removeAttributeNode

Attr removeAttributeNode(Attr oldAttr)
                         throws DOMException

指定された属性ノードを削除します。削除される Attr ノードのデフォルト値が DTD で定義されていると、デフォルト値ばかりでなく、該当する場合は対応する名前空間 URI、ローカル名、接頭辞とともに新しいノードがすぐに表示されます。実装では、同様にほかのスキーマからのデフォルト値を処理できますが、アプリケーションでは Document.normalizeDocument() を使用して、情報が最新の情報であることを保証する必要があります。

パラメータ:

oldAttr - 属性リストから削除する Attr ノード

戻り値:

削除された Attr ノード

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用である場合
NOT_FOUND_ERR: oldAttr が要素の属性ではない場合

getElementsByTagName

NodeList getElementsByTagName(String name)

所定のタグ名とともに、すべての子孫 Elements の NodeList を文書順に返します。

パラメータ:

name - 一致するタグの名前。特殊な値「*」はすべてのタグに一致する

戻り値:

一致する Element ノードのリスト

getAttributeNS

String getAttributeNS(String namespaceURI,
                      String localName)
                      throws DOMException

ローカル名と名前空間 URI を指定して属性値を取得します。
名前空間を保有したくない場合は、XML 名前空間に従って、アプリケーションでメソッドの namespaceURI パラメータに null 値を使用する必要があります。

パラメータ:

namespaceURI - 取得する属性の名前空間 URI

localName - 取得する属性のローカル名

戻り値:

文字列で表現された Attr の値。その属性が指定された値またはデフォルト値を持たない場合は空文字列

例外:

DOMException - NOT_SUPPORTED_ERR: 実装が XML 機能をサポートしておらず、文書を通じて公開された言語が XML 名前空間 (「HTML 4.01」など) をサポートしていない場合

導入されたバージョン:

DOM Level 2

setAttributeNS

void setAttributeNS(String namespaceURI,
                    String qualifiedName,
                    String value)
                    throws DOMException

新しい属性を追加します。同じローカル名および名前空間 URI を持つ属性が要素内にすでに存在する場合、その接頭辞が qualifiedName の前置部分に変更されます。また、その値は、value パラメータの値に変更されます。この値は単純な文字列であり、設定時に解析は行われません。その結果、あらゆるマークアップ (実体参照として認識される構文を含む) が文字テキストと見なされます。実装は、書き出しを行う際、これを適切な方法でエスケープする必要があります。実体参照を含む属性値を割り当てるには、Attr ノードのほかに Text ノードと EntityReference ノードを作成する必要があります。次に、適切なサブツリーを構築し、setAttributeNodeNS か setAttributeNode を使用して、これを属性値として割り当てます。
名前空間を保有したくない場合は、XML 名前空間に従って、アプリケーションでメソッドの namespaceURI パラメータに null 値を使用する必要があります。

パラメータ:

namespaceURI - 作成または変更する属性の名前空間 URI

qualifiedName - 作成または変更する属性の修飾名

value - 設定する値を表す文字列形式

例外:

DOMException - INVALID_CHARACTER_ERR: 指定された修飾名が、使用中の XML バージョン (Document.xmlVersion 属性で指定) で定められている XML 名ではない場合
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合
NAMESPACE_ERR: qualifiedName が XML 仕様の名前空間の定義に沿ったものでない場合。qualifiedName が接頭辞を持ち namespaceURI が null である場合。qualifiedName が接頭辞「xml」を持ち、かつnamespaceURI が「 http://www.w3.org/XML/1998/namespace」以外である場合。qualifiedName またはそのが接頭辞が「xmlns」であり、かつ namespaceURI が「http://www.w3.org/2000/xmlns/」外である場合。namespaceURI が「http://www.w3.org/2000/xmlns/」であり、qualifiedName も接頭辞も「xmlns」ではない場合
NOT_SUPPORTED_ERR: 実装が XML 機能をサポートしておらず、文書を通じて公開された言語が XML 名前空間 (「HTML 4.01」など) をサポートしていない場合

導入されたバージョン:

DOM Level 2

removeAttributeNS

void removeAttributeNS(String namespaceURI,
                       String localName)
                       throws DOMException

ローカル名と名前空間 URI を指定して属性を削除します。削除される属性のデフォルト値が DTD で定義されていると、デフォルト値ばかりでなく、該当する場合は対応する名前空間 URI、ローカル名、接頭辞とともに新しい属性がすぐに表示されます。実装では、同様にほかのスキーマのデフォルト値を処理できますが、アプリケーションでは Document.normalizeDocument() を使用して、情報が最新の情報であることを保証する必要があります。
このローカル名と名前空間 URI を持つ属性が見つからない場合には、このメソッドは効果がありません。
名前空間を保有したくない場合は、XML 名前空間に従って、アプリケーションでメソッドの namespaceURI パラメータに null 値を使用する必要があります。

パラメータ:

namespaceURI - 削除する属性の名前空間 URI

localName - 削除する属性のローカル名

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合
NOT_SUPPORTED_ERR: 実装が XML 機能をサポートしておらず、文書を通じて公開された言語が XML 名前空間 (「HTML 4.01」など) をサポートしていない場合

導入されたバージョン:

DOM Level 2

getAttributeNodeNS

Attr getAttributeNodeNS(String namespaceURI,
                        String localName)
                        throws DOMException

ローカル名と名前空間 URI を指定して Attr ノードを取得します。
名前空間を保有したくない場合は、XML 名前空間に従って、アプリケーションでメソッドの namespaceURI パラメータに null 値を使用する必要があります。

パラメータ:

namespaceURI - 取得する属性の名前空間 URI

localName - 取得する属性のローカル名

戻り値:

指定された属性ローカル名と名前空間 URI を持つ Attr ノード。該当する属性が存在しない場合は null

例外:

DOMException - NOT_SUPPORTED_ERR: 実装が XML 機能をサポートしておらず、文書を通じて公開された言語が XML 名前空間 (「HTML 4.01」など) をサポートしていない場合

導入されたバージョン:

DOM Level 2

setAttributeNodeNS

Attr setAttributeNodeNS(Attr newAttr)
                        throws DOMException

新しい属性を追加します。指定したローカル名および名前空間 URI の属性がすでに要素内に存在する場合、新しい属性で置き換えられます。属性ノードをその属性ノード自体に置き換えても影響はまったくありません。
名前空間を保有したくない場合は、XML 名前空間に従って、アプリケーションでメソッドの namespaceURIパラメータに null 値を使用する必要があります。

パラメータ:

newAttr - 属性リストに追加する Attr ノード

戻り値:

指定と同じローカル名および名前空間 URI を持つ既存の属性が newAttr 属性で置き換えられる場合は置き換えの対象となる Attr ノード。それ以外の場合は null

例外:

DOMException - WRONG_DOCUMENT_ERR: 要素を作成した文書とは異なる文書から newAttr が作成された場合
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用である場合
INUSE_ATTRIBUTE_ERR: newAttr がすでに別の Element オブジェクトの属性として使用されている場合。Attr ノードをほかの要素で再利用するには、このノードを DOM ユーザの手で明示的に複製する必要がある
NOT_SUPPORTED_ERR: 実装が XML 機能をサポートしておらず、文書を通じて公開された言語が XML 名前空間 (「HTML 4.01」など)をサポートしていない場合

導入されたバージョン:

DOM Level 2

getElementsByTagNameNS

NodeList getElementsByTagNameNS(String namespaceURI,
                                String localName)
                                throws DOMException

所定のローカル名と名前空間 URI とともに、すべての子孫 Elements の NodeList を文書順に返します。

パラメータ:

namespaceURI - 一致する要素の名前空間 URI。特殊な値「*」はすべての名前空間に一致する

localName - 一致する要素のローカル名。特殊な値「*」はすべてのローカル名に一致する

戻り値:

一致するすべての Elements を含む新しい NodeList オブジェクト

例外:

DOMException - NOT_SUPPORTED_ERR: 実装が XML 機能をサポートしておらず、文書を通じて公開された言語が XML 名前空間 (「HTML 4.01」など) をサポートしていない場合

導入されたバージョン:

DOM Level 2

hasAttribute

boolean hasAttribute(String name)

この要素上に所定の名前の属性が指定された場合、または属性にデフォルト値がある場合は true、そうでない場合は false

パラメータ:

name - 検索する属性の名前

戻り値:

この要素上に所定の名前の属性が指定された場合、または属性にデフォルト値がある場合は true、そうでない場合は false

導入されたバージョン:

DOM Level 2

hasAttributeNS

boolean hasAttributeNS(String namespaceURI,
                       String localName)
                       throws DOMException

所定のローカル名と名前空間 URI を持つ属性がこの要素で指定されているか、デフォルト値を持つ場合は true を返し、そうでない場合は false を返します。
名前空間を保有したくない場合は、XML 名前空間に従って、アプリケーションでメソッドの namespaceURI パラメータに null 値を使用する必要があります。

パラメータ:

namespaceURI - 検索する属性の名前空間 URI

localName - 検索する属性のローカル名

戻り値:

この要素上に所定のローカル名と名前空間 URI を持つ属性が指定された場合、または属性にデフォルト値がある場合は true、そうでない場合は false

例外:

DOMException - NOT_SUPPORTED_ERR: 実装が XML 機能をサポートしておらず、文書を通じて公開された言語が XML 名前空間 (「HTML 4.01」など) をサポートしていない場合

導入されたバージョン:

DOM Level 2

getSchemaTypeInfo

TypeInfo getSchemaTypeInfo()

この要素に関連する型情報です。

導入されたバージョン:

DOM Level 3

setIdAttribute

void setIdAttribute(String name,
                    boolean isId)
                    throws DOMException

isId パラメータが true の場合、このメソッドは指定された属性が ユーザ決定 ID 属性であることを宣言します。これは、Attr.isId の値と Document.getElementById の動作に影響を及ぼしますが、使用中のスキーマは変更されません。特に、指定された Attr ノードの Attr.schemaTypeInfo には影響しません。isId パラメータの false 値を使用すると、属性がユーザ決定 ID 属性であることは宣言されません。
ローカル名と名前空間 URI で属性を指定するには、setIdAttributeNS メソッドを使用します。

パラメータ:

name - 属性の名前

isId - 属性が型 ID の属性であるかどうかを判定

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用である場合
NOT_FOUND_ERR: 指定されたノードがこの要素の属性でない場合

導入されたバージョン:

DOM Level 3

setIdAttributeNS

void setIdAttributeNS(String namespaceURI,
                      String localName,
                      boolean isId)
                      throws DOMException

isId パラメータが true の場合、このメソッドは指定された属性がユーザ決定 ID 属性であることを宣言します。これは、Attr.isId の値と Document.getElementById の動作に影響を及ぼしますが、使用中のスキーマは変更されません。特に、指定された Attr ノードの Attr.schemaTypeInfo には影響しません。isId パラメータの false 値を使用すると、属性がユーザ決定 ID 属性であることは宣言されません。

パラメータ:

namespaceURI - 属性の名前空間 URI

localName - 属性のローカル名

isId - 属性が型 ID の属性であるかどうかを判定

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用である場合
NOT_FOUND_ERR: 指定されたノードがこの要素の属性でない場合

導入されたバージョン:

DOM Level 3

setIdAttributeNode

void setIdAttributeNode(Attr idAttr,
                        boolean isId)
                        throws DOMException

isId パラメータが true の場合、このメソッドは指定された属性がユーザ決定 ID 属性であることを宣言します。これは、Attr.isId の値と Document.getElementById の動作に影響を及ぼしますが、使用中のスキーマは変更されません。特に、指定された Attr ノードの Attr.schemaTypeInfo には影響しません。isId パラメータの false 値を使用すると、属性がユーザ決定 ID 属性であることは宣言されません。

パラメータ:

idAttr - 属性ノード

isId - 属性が型 ID の属性であるかどうかを判定

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用である場合
NOT_FOUND_ERR: 指定されたノードがこの要素の属性でない場合

導入されたバージョン:

DOM Level 3