JavaTM 2
Platform
Std. Ed. v1.4.0

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 2 Core Specification』を参照してください。


フィールドの概要
 
インタフェース org.w3c.dom.Node から継承したフィールド
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, 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)
          所定のタグ名とともに、すべての子孫 ElementsNodeList を返します。
 NodeList getElementsByTagNameNS(String namespaceURI, String localName)
          所定のローカル名およびネームスペース URI とともに、すべての ElementsNodeList を返します。
 String getTagName()
          要素の名前です。
 boolean hasAttribute(String name)
          この要素上に所定の名前の属性が指定された場合、または属性にデフォルト値がある場合は true、それ以外の場合は false
 boolean hasAttributeNS(String namespaceURI, String localName)
          この要素上に所定のローカル名とネームスペース URI を持つ属性が指定された場合、またはその属性にデフォルト値がある場合は true、それ以外の場合は false
"XML" 機能をサポートしない文書では、要素や属性を作成または設定する DOM レベル 1 呼び出しのみが許可されます。
 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)
          新しい属性を追加します。
 
インタフェース org.w3c.dom.Node から継承したメソッド
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 

メソッドの詳細

getTagName

public String getTagName()
要素の名前です。以下の例を参照してください。
 <elementExample 
 id="demo"> ... </elementExample> , 
tagName の値は "elementExample" です。XML では、DOM の操作と同様にアルファベットの大文字と小文字の区別が保存されます。HTML DOM は、ソースとなる HTML 文書で大文字と小文字のどちらが使用されていても、HTML 要素の tagName を標準の大文字で返します。


getAttribute

public String getAttribute(String name)
名前を指定して属性を取得します。

パラメータ:
name - 取得する属性の名前
戻り値:
文字列で表現された Attr の値。その属性が指定された値またはデフォルト値を持たない場合は空文字列

setAttribute

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

パラメータ:
name - 作成または変更する属性の名前
value - 設定する値を表す文字列
例外:
DOMException - INVALID_CHARACTER_ERR: 指定された名前に不正な文字が含まれている場合
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合

removeAttribute

public void removeAttribute(String name)
                     throws DOMException
名前を指定して属性を削除します。削除される属性がデフォルト値を持つ属性である場合、対応するネームスペース URI、ローカル名、前置修飾子 (適切な場合) とデフォルト値を持つ属性が即座に作成されます。
ローカル名とネームスペース URI を指定して属性を削除するには、removeAttributeNS メソッドを使用します。

パラメータ:
name - 削除する属性の名前
例外:
DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合

getAttributeNode

public Attr getAttributeNode(String name)
名前を指定して属性ノードを取得します。
修飾名とネームスペース URI を指定して属性ノードを取得するには、getAttributeNS メソッドを使用します。

パラメータ:
name - 取得する属性の名前 (nodeName)
戻り値:
指定された名前 ( nodeName) の Attr ノード。該当する属性が存在しない場合は null

setAttributeNode

public 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

public Attr removeAttributeNode(Attr oldAttr)
                         throws DOMException
指定された属性ノードを削除します。削除対象の Attr にデフォルト値がある場合、ただちに別の属性で置き換えられます。置き換え後の属性も、元のものと同じネームスペース URI、ローカル名、前置修飾子 (適切な場合) を備えています。

パラメータ:
oldAttr - 属性リストから削除する Attr ノード
戻り値:
削除された Attr ノード
例外:
DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合
NOT_FOUND_ERR: oldAttr がこの要素の属性でない場合

getElementsByTagName

public NodeList getElementsByTagName(String name)
所定のタグ名とともに、すべての子孫 ElementsNodeList を返します。返される順番は、この Element ツリーの先行順 (preorder traversal) で検出された順番になります。

パラメータ:
name - 一致するタグの名前。特殊な値 "*" はすべてのタグに一致する
戻り値:
一致する Element ノードのリスト

getAttributeNS

public String getAttributeNS(String namespaceURI,
                             String localName)
ローカル名とネームスペース URI を指定して属性値を取得します。
"XML" 機能をサポートしない文書では、要素や属性を作成または設定する DOM レベル 1 呼び出しのみが許可されます。したがって、null 以外のネームスペース URI を指定すると、一致するノードは検出されません。

パラメータ:
namespaceURI - 取得する属性のネームスペース URI
localName - 取得する属性のローカル名
戻り値:
文字列で表現された Attr の値。その属性が指定された値またはデフォルト値を持たない場合は空文字列
導入されたバージョン:
DOM Level 2

setAttributeNS

public void setAttributeNS(String namespaceURI,
                           String qualifiedName,
                           String value)
                    throws DOMException
新しい属性を追加します。指定されたローカル名およびネームスペース URI を持つ属性が要素内にすでに存在する場合、その前置修飾子が qualifiedName の前置部分に変更されます。また、その値は、値パラメータの値に変更されます。この値は単純な文字列であり、設定時に解析は行われません。その結果、あらゆるマークアップ (エンティティ参照として認識される構文を含む) が文字テキストと見なされます。実装は、書き出しを行う際、これを適切な方法でエスケープする必要があります。エンティティ参照を含む属性値を割り当てるには、Attr ノードのほかに Text ノードと EntityReference ノードを作成する必要があります。次に、適切なサブツリーを構築し、setAttributeNodeNSsetAttributeNode を使って、これを属性値として割り当てます。

パラメータ:
namespaceURI - 作成または変更する属性のネームスペース URI
qualifiedName - 作成または変更する属性の修飾名
value - 設定する値を表す文字列
例外:
DOMException - INVALID_CHARACTER_ERR: 指定された修飾名に XML 1.0 仕様に定められている不正な文字が含まれている場合
NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合
NAMESPACE_ERR: qualifiedName が XML 仕様のネームスペースの定義に沿ったものでない場合。qualifiedName が前置修飾子を持ち、namespaceURInull の場合。qualifiedName が前置修飾子 "xml" を持ち、namespaceURI が http://www.w3.org/XML/1998/namespace 以外である場合。qualifiedName またはその前置修飾子が "xmlns" であり、namespaceURI が "http://www.w3.org/2000/xmlns/" 以外である場合
NOT_SUPPORTED_ERR: 現在の文書が "XML" をサポートしない場合 (ネームスペースは XML によって定義されている)
導入されたバージョン:
DOM Level 2

removeAttributeNS

public void removeAttributeNS(String namespaceURI,
                              String localName)
                       throws DOMException
ローカル名とネームスペース URI を指定して属性を削除します。削除対象の属性にデフォルト値がある場合、ただちに別の属性で置き換えられます。置き換え後の属性も、元のものと同じネームスペース URI、ローカル名、前置修飾子を備えています。
"XML" 機能をサポートしない文書では、要素や属性を作成または設定する DOM レベル 1 呼び出しのみが許可されます。したがって、null 以外のネームスペース URI を指定すると、一致するノードは検出されません。

パラメータ:
namespaceURI - 削除する属性のネームスペース URI
localName - 削除する属性のローカル名
例外:
DOMException - NO_MODIFICATION_ALLOWED_ERR: このノードが読み取り専用の場合
導入されたバージョン:
DOM Level 2

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI,
                               String localName)
ローカル名とネームスペース URI を指定して Attr ノードを取得します。
"XML" 機能をサポートしない文書では、要素や属性を作成または設定する DOM レベル 1 呼び出しのみが許可されます。したがって、null 以外のネームスペース URI を指定すると、一致するノードは検出されません。

パラメータ:
namespaceURI - 取得する属性のネームスペース URI
localName - 取得する属性のローカル名
戻り値:
指定された属性ローカル名とネームスペース URI を持つ Attr ノード。該当する属性が存在しない場合は null
導入されたバージョン:
DOM Level 2

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)
                        throws DOMException
新しい属性を追加します。指定したローカル名およびネームスペース URI の属性がすでに要素内に存在する場合、新しい属性で置き換えられます。

パラメータ:
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 によって定義されている)
導入されたバージョン:
DOM Level 2

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)
所定のローカル名およびネームスペース URI とともに、すべての ElementsNodeList を返します。返される順番は、この Element ツリーの先行順 (preorder traversal) で検出された順番になります。
"XML" 機能をサポートしない文書では、要素や属性を作成または設定する DOM レベル 1 呼び出しのみが許可されます。したがって、null 以外のネームスペース URI を指定すると、一致するノードは検出されません。

パラメータ:
namespaceURI - 一致する要素のネームスペース URI。特殊な値 "*" はすべてのネームスペースに一致する
localName - 一致する要素のローカル名。特殊な値 "*" はすべてのローカル名に一致する
戻り値:
一致するすべての Elements を含む新しい NodeList オブジェクト
導入されたバージョン:
DOM Level 2

hasAttribute

public boolean hasAttribute(String name)
この要素上に所定の名前の属性が指定された場合、または属性にデフォルト値がある場合は true、それ以外の場合は false

パラメータ:
name - 検索する属性の名前
戻り値:
この要素上に所定の名前の属性が指定された場合、または属性にデフォルト値がある場合は true、それ以外の場合は false
導入されたバージョン:
DOM Level 2

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
                              String localName)
この要素上に所定のローカル名とネームスペース URI を持つ属性が指定された場合、またはその属性にデフォルト値がある場合は true、それ以外の場合は false
"XML" 機能をサポートしない文書では、要素や属性を作成または設定する DOM レベル 1 呼び出しのみが許可されます。したがって、null 以外のネームスペース URI を指定すると、一致するノードは検出されません。

パラメータ:
namespaceURI - 検索する属性のネームスペース URI
localName - 検索する属性のローカル名
戻り値:
この要素上に所定のローカル名とネームスペース URI を持つ属性が指定された場合、または属性にデフォルト値がある場合は true、それ以外の場合は false
導入されたバージョン:
DOM Level 2

JavaTM 2
Platform
Std. Ed. v1.4.0

バグの報告と機能のリクエスト
これ以外の API リファレンスおよび開発者用ドキュメントについては、 Java 2 SDK SE 開発者用ドキュメントを参照してください。 開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、 およびコード実例が含まれています。

Java、Java 2D、および JDBC は米国ならびにその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.