モジュール java.xml

パッケージ org.w3c.dom

インタフェースElement

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

Node

既知のすべてのサブインタフェース:

HTMLAnchorElement, HTMLAppletElement, HTMLAreaElement, HTMLBaseElement, HTMLBaseFontElement, HTMLBodyElement, HTMLBRElement, HTMLButtonElement, HTMLDirectoryElement, HTMLDivElement, HTMLDListElement, HTMLElement, HTMLFieldSetElement, HTMLFontElement, HTMLFormElement, HTMLFrameElement, HTMLFrameSetElement, HTMLHeadElement, HTMLHeadingElement, HTMLHRElement, HTMLHtmlElement, HTMLIFrameElement, HTMLImageElement, HTMLInputElement, HTMLIsIndexElement, HTMLLabelElement, HTMLLegendElement, HTMLLIElement, HTMLLinkElement, HTMLMapElement, HTMLMenuElement, HTMLMetaElement, HTMLModElement, HTMLObjectElement, HTMLOListElement, HTMLOptGroupElement, HTMLOptionElement, HTMLParagraphElement, HTMLParamElement, HTMLPreElement, HTMLQuoteElement, HTMLScriptElement, HTMLSelectElement, HTMLStyleElement, HTMLTableCaptionElement, HTMLTableCellElement, HTMLTableColElement, HTMLTableElement, HTMLTableRowElement, HTMLTableSectionElement, HTMLTextAreaElement, HTMLTitleElement, HTMLUListElement

既知のすべての実装クラス:

IIOMetadataNode

public interface Element extends Node

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

ノート: DOM Level 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」など)をサポートしていない場合に発生する可能性があります。

導入されたバージョン:

1.4、DOMレベル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の形式が「Namespaces in 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」など)をサポートしていない場合に発生する可能性があります。

導入されたバージョン:

1.4、DOMレベル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」など)をサポートしていない場合に発生する可能性があります。

導入されたバージョン:

1.4、DOMレベル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」など)をサポートしていない場合に発生する可能性があります。

導入されたバージョン:

1.4、DOMレベル2

setAttributeNodeNS

Attr setAttributeNodeNS(Attr newAttr) throws DOMException

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

パラメータ:

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

戻り値:

newAttr属性によって、同じローカル名と名前空間URIを持つ既存の属性が置き換えられる場合は、置き換えられた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」など)をサポートしていない場合に発生する可能性があります。

導入されたバージョン:

1.4、DOMレベル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」など)をサポートしていない場合に発生する可能性があります。

導入されたバージョン:

1.4、DOMレベル2

hasAttribute

boolean hasAttribute(String name)

この要素上に所定の名前の属性が指定された場合、または属性にデフォルト値がある場合はtrue、それ以外の場合はfalseを返します。

パラメータ:

name - 検索する属性の名前。

戻り値:

指定された名前を持つ属性がこの要素上で指定されているか、デフォルト値を持っている場合はtrue。それ以外の場合はfalse。

導入されたバージョン:

1.4、DOMレベル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」など)をサポートしていない場合に発生する可能性があります。

導入されたバージョン:

1.4、DOMレベル2

getSchemaTypeInfo

TypeInfo getSchemaTypeInfo()

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

導入されたバージョン:

1.5、DOMレベル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: 指定されたノードがこの要素の属性でない場合に発生します。

導入されたバージョン:

1.5、DOMレベル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: 指定されたノードがこの要素の属性でない場合に発生します。

導入されたバージョン:

1.5、DOMレベル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: 指定されたノードがこの要素の属性でない場合に発生します。

導入されたバージョン:

1.5、DOMレベル3