|
||||||||
PREV CLASS NEXT CLASS | ||||||||
SUMMARY: INNER | 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.
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 | |
java.lang.String |
getAttribute(java.lang.String name)
Retrieves an attribute value by name. |
Attr |
getAttributeNode(java.lang.String name)
Retrieves an attribute node by name. |
Attr |
getAttributeNodeNS(java.lang.String namespaceURI,
java.lang.String localName) Retrieves an Attr node by local name and namespace URI. |
java.lang.String |
getAttributeNS(java.lang.String namespaceURI,
java.lang.String localName) Retrieves an attribute value by local name and namespace URI. |
NodeList |
getElementsByTagName(java.lang.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(java.lang.String namespaceURI,
java.lang.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. |
java.lang.String |
getTagName()
The name of the element. |
boolean |
hasAttribute(java.lang.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(java.lang.String namespaceURI,
java.lang.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(java.lang.String name)
Removes an attribute by name. |
Attr |
removeAttributeNode(Attr oldAttr) Removes the specified attribute node. |
void |
removeAttributeNS(java.lang.String namespaceURI,
java.lang.String localName) Removes an attribute by local name and namespace URI. |
void |
setAttribute(java.lang.String name,
java.lang.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(java.lang.String namespaceURI,
java.lang.String qualifiedName, java.lang.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 java.lang.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 java.lang.String getAttribute(java.lang.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(java.lang.String name, java.lang.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.public void removeAttribute(java.lang.String name) throws DOMException
removeAttributeNS
method.name
- The name of the attribute to remove.public Attr getAttributeNode(java.lang.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.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.oldAttr
is not an attribute of the
element.public NodeList getElementsByTagName(java.lang.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 java.lang.String getAttributeNS(java.lang.String namespaceURI, java.lang.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(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.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.qualifiedName
is malformed, 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
is
"xmlns" and the namespaceURI
is different from "
http://www.w3.org/2000/xmlns/".public void removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName) throws DOMException
namespaceURI
- The namespace URI of the attribute to
remove.localName
- The local name of the attribute to remove.public Attr getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)
Attr
node by local name and namespace URI.
HTML-only DOM implementations do not need to implement this method.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.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 NodeList getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.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(java.lang.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(java.lang.String namespaceURI, java.lang.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. HTML-only DOM implementations do not need to
implement this method.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.
|
||||||||
PREV CLASS NEXT CLASS | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2000 W3C® (MIT, INRIA, Keio), All Rights Reserved. W3C liability, trademark, document useand software licensing rules apply. Your interactions with this site are in accordance with our public and Member privacy statements.