| org.w3c.dom.Element
All known Subclasses: org.w3c.tidy.DOMElementImpl,
| Element | | public interface Element extends Node(Code) | | 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.
|
| Method Summary | |
| public String | getAttribute(String name)
Retrieves an attribute value by name.
Parameters:
nameThe - name of the attribute to retrieve. | | public String | getAttributeNS(String namespaceURI, String localName)
Retrieves an attribute value by local name and namespace URI. | | public Attr | getAttributeNode(String name)
Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and namespace URI,
use the getAttributeNodeNS method.
Parameters:
nameThe - name (nodeName) of the attribute to retrieve. | | public Attr | getAttributeNodeNS(String namespaceURI, String localName)
Retrieves an Attr node by local name and namespace URI. | | public 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.
Parameters:
nameThe - name of the tag to match on. | | public 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.
HTML-only DOM implementations do not need to implement this method.
Parameters:
namespaceURIThe - namespace URI of the elements to match on. | | public String | getTagName()
The name of the element. | | public 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.
Parameters:
nameThe - name of the attribute to look for. | | public 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. | | public void | removeAttribute(String name)
Removes an attribute by name. | | public void | removeAttributeNS(String namespaceURI, String localName)
Removes an attribute by local name and namespace URI. | | public Attr | removeAttributeNode(Attr oldAttr)
Removes the specified attribute node. | | public void | setAttribute(String name, String value)
Adds a new attribute. | | public void | setAttributeNS(String namespaceURI, String qualifiedName, String value)
Adds a new attribute. | | public Attr | setAttributeNode(Attr newAttr)
Adds a new attribute node. | | public Attr | setAttributeNodeNS(Attr newAttr)
Adds a new attribute. |
| getAttribute | | public String getAttribute(String name)(Code) | | Retrieves an attribute value by name.
Parameters:
nameThe - name of the attribute to retrieve. The Attr value as a string, or the empty string if that attribute does not have a specified or default value. |
| getAttributeNS | | public String getAttributeNS(String namespaceURI, String localName)(Code) | | Retrieves an attribute value by local name and namespace URI. HTML-only
DOM implementations do not need to implement this method.
Parameters:
namespaceURIThe - namespace URI of the attribute to retrieve.
Parameters:
localNameThe - local name of the attribute to retrieve. The Attr value as a string, or the empty string if that attribute does not have a specified or default value.
since:
DOM Level 2 |
| getAttributeNode | | public Attr getAttributeNode(String name)(Code) | | Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and namespace URI,
use the getAttributeNodeNS method.
Parameters:
nameThe - name (nodeName) of the attribute to retrieve. The Attr node with the specified name (nodeName) or null if there is no such attribute. |
| getAttributeNodeNS | | public Attr getAttributeNodeNS(String namespaceURI, String localName)(Code) | | Retrieves an Attr node by local name and namespace URI.
HTML-only DOM implementations do not need to implement this method.
Parameters:
namespaceURIThe - namespace URI of the attribute to retrieve.
Parameters:
localNameThe - local name of the attribute to retrieve. The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.
since:
DOM Level 2 |
| getElementsByTagName | | public NodeList getElementsByTagName(String name)(Code) | | 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.
Parameters:
nameThe - name of the tag to match on. The special value "*" matches all tags. A list of matching Element nodes. |
| getElementsByTagNameNS | | public NodeList getElementsByTagNameNS(String namespaceURI, String localName)(Code) | | 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.
HTML-only DOM implementations do not need to implement this method.
Parameters:
namespaceURIThe - namespace URI of the elements to match on. The special value "*" matches all namespaces.
Parameters:
localNameThe - local name of the elements to match on. The special value "*" matches all local names. A new NodeList object containing all the matched Elements.
since:
DOM Level 2 |
| getTagName | | public String getTagName()(Code) | | The name of the element. For example, in:
<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.
|
| hasAttribute | | public boolean hasAttribute(String name)(Code) | | Returns true when an attribute with a given name is
specified on this element or has a default value, false
otherwise.
Parameters:
nameThe - 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, falseotherwise.
since:
DOM Level 2 |
| hasAttributeNS | | public boolean hasAttributeNS(String namespaceURI, String localName)(Code) | | 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. HTML-only DOM implementations do not
need to implement this method.
Parameters:
namespaceURIThe - namespace URI of the attribute to look for.
Parameters:
localNameThe - 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.
since:
DOM Level 2 |
| removeAttribute | | public void removeAttribute(String name) throws DOMException(Code) | | Removes an attribute by name. If the removed attribute is known to have
a default value, an attribute immediately appears containing the
default value as well as the corresponding namespace URI, local name,
and prefix when applicable.
To remove an attribute by local name and namespace URI, use the
removeAttributeNS method.
Parameters:
nameThe - name of the attribute to remove.
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
| removeAttributeNS | | public void removeAttributeNS(String namespaceURI, String localName) throws DOMException(Code) | | Removes an attribute by local name and namespace URI. If the removed
attribute 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.
HTML-only DOM implementations do not need to implement this method.
Parameters:
namespaceURIThe - namespace URI of the attribute to remove.
Parameters:
localNameThe - local name of the attribute to remove.
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
since:
DOM Level 2 |
| removeAttributeNode | | public Attr removeAttributeNode(Attr oldAttr) throws DOMException(Code) | | Removes the specified attribute node. If the removed 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.
Parameters:
oldAttrThe - Attr node to remove from the attribute list. The Attr node that was removed.
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element. |
| setAttribute | | public void setAttribute(String name, String value) throws DOMException(Code) | | Adds a new attribute. If an attribute with that name is already present
in the element, its value is changed to be that of 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 setAttributeNode to assign
it as the value of an attribute.
To set an attribute with a qualified name and namespace URI, use
the setAttributeNS method.
Parameters:
nameThe - name of the attribute to create or alter.
Parameters:
valueValue - to set in string form.
exception:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
| setAttributeNS | | public void setAttributeNS(String namespaceURI, String qualifiedName, String value) throws DOMException(Code) | | Adds a new attribute. If an attribute with the same local name and
namespace URI is already present on the element, its prefix is
changed to be the prefix part of the 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.
HTML-only DOM implementations do not need to implement this method.
Parameters:
namespaceURIThe - namespace URI of the attribute to create or alter.
Parameters:
qualifiedNameThe - qualified name of the attribute to create or alter.
Parameters:
valueThe - value to set in string form.
exception:
DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the 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/".
since:
DOM Level 2 |
| setAttributeNode | | public Attr setAttributeNode(Attr newAttr) throws DOMException(Code) | | Adds a new attribute node. If an attribute with that name (
nodeName) is already present in the element, it is
replaced by the new one.
To add a new attribute node with a qualified name and namespace
URI, use the setAttributeNodeNS method.
Parameters:
newAttrThe - Attr node to add to the attribute list. If the newAttr attribute replaces an existing attribute, the replaced Attr node is returned, otherwise null is returned.
exception:
DOMException - WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements. |
| setAttributeNodeNS | | public Attr setAttributeNodeNS(Attr newAttr) throws DOMException(Code) | | Adds a new attribute. If an attribute with that local name and that
namespace URI is already present in the element, it is replaced by
the new one.
HTML-only DOM implementations do not need to implement this method.
Parameters:
newAttrThe - Attr node to add to the attribute list. If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the replaced Attr node is returned, otherwise null is returned.
exception:
DOMException - WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.
since:
DOM Level 2 |
|
|