|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
The Element interface represents an element in an HTML or XML
document. Elements may have attributes associated with them; since the
Element interface inherits from Node, the
generic Node interface attribute attributes may
be used to retrieve the set of all attributes for an element. There are
methods on the Element interface to retrieve either an
Attr object by name or an attribute value by name. In XML,
where an attribute value may contain entity references, an
Attr object should be retrieved to examine the possibly
fairly complex sub-tree representing the attribute value. On the other
hand, in HTML, where all attributes have simple string values, methods to
directly access an attribute value can safely be used as a convenience.In
DOM Level 2, the method normalize is inherited from the
Node interface where it was moved.
See also the Document Object Model (DOM) Level 2 Core Specification.
| Field Summary |
| Fields inherited from interface 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 |
| Method Summary | |
String |
getAttribute(String name)
Retrieves an attribute value by name. |
Attr |
getAttributeNode(String name)
Retrieves an attribute node by name. |
Attr |
getAttributeNodeNS(String namespaceURI,
String localName)
Retrieves an Attr node by local name and namespace URI. |
String |
getAttributeNS(String namespaceURI,
String localName)
Retrieves an attribute value by local name and namespace URI. |
NodeList |
getElementsByTagName(String name)
Returns a NodeList of all descendant Elements
with a given tag name, in the order in which they are encountered in
a preorder traversal of this Element tree. |
NodeList |
getElementsByTagNameNS(String namespaceURI,
String localName)
Returns a NodeList of all the descendant
Elements with a given local name and namespace URI in
the order in which they are encountered in a preorder traversal of
this Element tree. |
String |
getTagName()
The name of the element. |
boolean |
hasAttribute(String name)
Returns true when an attribute with a given name is
specified on this element or has a default value, false
otherwise. |
boolean |
hasAttributeNS(String namespaceURI,
String localName)
Returns true when an attribute with a given local name and
namespace URI is specified on this element or has a default value,
false otherwise. |
void |
removeAttribute(String name)
Removes an attribute by name. |
Attr |
removeAttributeNode(Attr oldAttr)
Removes the specified attribute node. |
void |
removeAttributeNS(String namespaceURI,
String localName)
Removes an attribute by local name and namespace URI. |
void |
setAttribute(String name,
String value)
Adds a new attribute. |
Attr |
setAttributeNode(Attr newAttr)
Adds a new attribute node. |
Attr |
setAttributeNodeNS(Attr newAttr)
Adds a new attribute. |
void |
setAttributeNS(String namespaceURI,
String qualifiedName,
String value)
Adds a new attribute. |
| Methods inherited from interface 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 |
| Method Detail |
public String getTagName()
<elementExample id="demo"> ... </elementExample> ,
tagName has
the value "elementExample". Note that this is
case-preserving in XML, as are all of the operations of the DOM. The
HTML DOM returns the tagName of an HTML element in the
canonical uppercase form, regardless of the case in the source HTML
document.
public String getAttribute(String name)
name - The name of the attribute to retrieve.
Attr value as a string, or the empty string
if that attribute does not have a specified or default value.
public void setAttribute(String name,
String value)
throws DOMException
Attr node plus any
Text and EntityReference nodes, build the
appropriate subtree, and use setAttributeNode to assign
it as the value of an attribute.
setAttributeNS method.
name - The name of the attribute to create or alter.value - Value to set in string form.
DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an
illegal character.
public void removeAttribute(String name)
throws DOMException
removeAttributeNS method.
name - The name of the attribute to remove.
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.public Attr getAttributeNode(String name)
getAttributeNodeNS method.
name - The name (nodeName) of the attribute to
retrieve.
Attr node with the specified name (
nodeName) or null if there is no such
attribute.
public Attr setAttributeNode(Attr newAttr)
throws DOMException
nodeName) is already present in the element, it is
replaced by the new one.
setAttributeNodeNS method.
newAttr - The Attr node to add to the attribute list.
newAttr attribute replaces an existing
attribute, the replaced Attr node is returned,
otherwise null is returned.
DOMException - WRONG_DOCUMENT_ERR: Raised if newAttr was created from a
different document than the one that created the element.
newAttr is already an
attribute of another Element object. The DOM user must
explicitly clone Attr nodes to re-use them in other
elements.
public Attr removeAttributeNode(Attr oldAttr)
throws DOMException
Attr
has a default value it is immediately replaced. The replacing
attribute has the same namespace URI and local name, as well as the
original prefix, when applicable.
oldAttr - The Attr node to remove from the attribute
list.
Attr node that was removed.
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
oldAttr is not an attribute
of the element.public NodeList getElementsByTagName(String name)
NodeList of all descendant Elements
with a given tag name, in the order in which they are encountered in
a preorder traversal of this Element tree.
name - The name of the tag to match on. The special value "*"
matches all tags.
Element nodes.
public String getAttributeNS(String namespaceURI,
String localName)
namespaceURI - The namespace URI of the attribute to retrieve.localName - The local name of the attribute to retrieve.
Attr value as a string, or the empty string
if that attribute does not have a specified or default value.
public void setAttributeNS(String namespaceURI,
String qualifiedName,
String value)
throws DOMException
qualifiedName, and
its value is changed to be the value parameter. This
value is a simple string; it is not parsed as it is being set. So any
markup (such as syntax to be recognized as an entity reference) is
treated as literal text, and needs to be appropriately escaped by the
implementation when it is written out. In order to assign an
attribute value that contains entity references, the user must create
an Attr node plus any Text and
EntityReference nodes, build the appropriate subtree,
and use setAttributeNodeNS or
setAttributeNode to assign it as the value of an
attribute.
namespaceURI - The namespace URI of the attribute to create or
alter.qualifiedName - The qualified name of the attribute to create or
alter.value - The value to set in string form.
DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name
contains an illegal character, per the XML 1.0 specification .
qualifiedName is
malformed per the Namespaces in XML specification, if the
qualifiedName has a prefix and the
namespaceURI is null, if the
qualifiedName has a prefix that is "xml" and the
namespaceURI is different from "
http://www.w3.org/XML/1998/namespace", or if the
qualifiedName, or its prefix, is "xmlns" and the
namespaceURI is different from "
http://www.w3.org/2000/xmlns/".
"XML" feature, since namespaces were
defined by XML.
public void removeAttributeNS(String namespaceURI,
String localName)
throws DOMException
namespaceURI - The namespace URI of the attribute to remove.localName - The local name of the attribute to remove.
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public Attr getAttributeNodeNS(String namespaceURI,
String localName)
Attr node by local name and namespace URI.
namespaceURI - The namespace URI of the attribute to retrieve.localName - The local name of the attribute to retrieve.
Attr node with the specified attribute local
name and namespace URI or null if there is no such
attribute.
public Attr setAttributeNodeNS(Attr newAttr)
throws DOMException
newAttr - The Attr node to add to the attribute list.
newAttr attribute replaces an existing
attribute with the same local name and namespace URI, the replaced
Attr node is returned, otherwise null is
returned.
DOMException - WRONG_DOCUMENT_ERR: Raised if newAttr was created from a
different document than the one that created the element.
newAttr is already an
attribute of another Element object. The DOM user must
explicitly clone Attr nodes to re-use them in other
elements.
"XML" feature, since namespaces were
defined by XML.
public NodeList getElementsByTagNameNS(String namespaceURI,
String localName)
NodeList of all the descendant
Elements with a given local name and namespace URI in
the order in which they are encountered in a preorder traversal of
this Element tree.
namespaceURI - The namespace URI of the elements to match on. The
special value "*" matches all namespaces.localName - The local name of the elements to match on. The
special value "*" matches all local names.
NodeList object containing all the matched
Elements.public boolean hasAttribute(String name)
true when an attribute with a given name is
specified on this element or has a default value, false
otherwise.
name - The name of the attribute to look for.
true if an attribute with the given name is
specified on this element or has a default value, false
otherwise.
public boolean hasAttributeNS(String namespaceURI,
String localName)
true when an attribute with a given local name and
namespace URI is specified on this element or has a default value,
false otherwise.
namespaceURI - The namespace URI of the attribute to look for.localName - The local name of the attribute to look for.
true if an attribute with the given local name
and namespace URI is specified or has a default value on this
element, false otherwise.
|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.