Home » xml-commons-external-1.4.01-src » org.w3c » dom » [javadoc | source]
org.w3c.dom
public interface: Element [javadoc | source]

All Implemented Interfaces:
    Node

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.

Note: 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 3 Core Specification.
Method from org.w3c.dom.Element Summary:
getAttribute,   getAttributeNS,   getAttributeNode,   getAttributeNodeNS,   getElementsByTagName,   getElementsByTagNameNS,   getSchemaTypeInfo,   getTagName,   hasAttribute,   hasAttributeNS,   removeAttribute,   removeAttributeNS,   removeAttributeNode,   setAttribute,   setAttributeNS,   setAttributeNode,   setAttributeNodeNS,   setIdAttribute,   setIdAttributeNS,   setIdAttributeNode
Method from org.w3c.dom.Element Detail:
 public String getAttribute(String name)
    Retrieves an attribute value by name.
 public String getAttributeNS(String namespaceURI,
    String localName) throws DOMException
    Retrieves an attribute value by local name and namespace URI.

    Per [XML Namespaces]
, applications must use the value null as the 
namespaceURI parameter for methods if they wish to have 
no namespace.
 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.
 public Attr getAttributeNodeNS(String namespaceURI,
    String localName) throws DOMException
    Retrieves an Attr node by local name and namespace URI.

    Per [XML Namespaces]
, applications must use the value null as the 
namespaceURI parameter for methods if they wish to have 
no namespace.
 public NodeList getElementsByTagName(String name)
    Returns a NodeList of all descendant Elements 
with a given tag name, in document order.
 public NodeList getElementsByTagNameNS(String namespaceURI,
    String localName) throws DOMException
    Returns a NodeList of all the descendant 
Elements with a given local name and namespace URI in 
document order.
 public TypeInfo getSchemaTypeInfo()
    The type information associated with this element.
 public String getTagName()
    The name of the element. If Node.localName is different 
from null, this attribute is a qualified name. 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.
 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.
 public boolean hasAttributeNS(String namespaceURI,
    String localName) throws DOMException
    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.

    Per [XML Namespaces]
, applications must use the value null as the 
namespaceURI parameter for methods if they wish to have 
no namespace.
 public  void removeAttribute(String name) throws DOMException
    Removes an attribute by name. If a default value for the removed 
attribute is defined in the DTD, a new attribute immediately appears 
with the default value as well as the corresponding namespace URI, 
local name, and prefix when applicable. The implementation may handle 
default values from other schemas similarly but applications should 
use Document.normalizeDocument() to guarantee this 
information is up-to-date.

    If no attribute with this name is found, this method has no effect.

    To remove an attribute by local name and namespace URI, use the 
removeAttributeNS method.
 public  void removeAttributeNS(String namespaceURI,
    String localName) throws DOMException
    Removes an attribute by local name and namespace URI. If a default 
value for the removed attribute is defined in the DTD, a new 
attribute immediately appears with the default value as well as the 
corresponding namespace URI, local name, and prefix when applicable. 
The implementation may handle default values from other schemas 
similarly but applications should use 
Document.normalizeDocument() to guarantee this 
information is up-to-date.

    If no attribute with this local name and namespace URI is found, 
this method has no effect.

    Per [XML Namespaces]
, applications must use the value null as the 
namespaceURI parameter for methods if they wish to have 
no namespace.
 public Attr removeAttributeNode(Attr oldAttr) throws DOMException
    Removes the specified attribute node. If a default value for the 
removed Attr node is defined in the DTD, a new node 
immediately appears with the default value as well as the 
corresponding namespace URI, local name, and prefix when applicable. 
The implementation may handle default values from other schemas 
similarly but applications should use 
Document.normalizeDocument() to guarantee this 
information is up-to-date.
 public  void setAttribute(String name,
    String value) throws DOMException
    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.
 public  void setAttributeNS(String namespaceURI,
    String qualifiedName,
    String value) throws DOMException
    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.

    Per [XML Namespaces]
, applications must use the value null as the 
namespaceURI parameter for methods if they wish to have 
no namespace.
 public Attr setAttributeNode(Attr newAttr) throws DOMException
    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. Replacing an attribute node by itself has no 
effect.

    To add a new attribute node with a qualified name and namespace 
URI, use the setAttributeNodeNS method.
 public Attr setAttributeNodeNS(Attr newAttr) throws DOMException
    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. Replacing an attribute node by itself has no effect.

    Per [XML Namespaces]
, applications must use the value null as the 
namespaceURI parameter for methods if they wish to have 
no namespace.
 public  void setIdAttribute(String name,
    boolean isId) throws DOMException
    If the parameter isId is true, this method 
declares the specified attribute to be a user-determined ID attribute
. This affects the value of Attr.isId and the behavior 
of Document.getElementById, but does not change any 
schema that may be in use, in particular this does not affect the 
Attr.schemaTypeInfo of the specified Attr 
node. Use the value false for the parameter 
isId to undeclare an attribute for being a 
user-determined ID attribute. 

     To specify an attribute by local name and namespace URI, use the 
setIdAttributeNS method.
 public  void setIdAttributeNS(String namespaceURI,
    String localName,
    boolean isId) throws DOMException
    If the parameter isId is true, this method 
declares the specified attribute to be a user-determined ID attribute
. This affects the value of Attr.isId and the behavior 
of Document.getElementById, but does not change any 
schema that may be in use, in particular this does not affect the 
Attr.schemaTypeInfo of the specified Attr 
node. Use the value false for the parameter 
isId to undeclare an attribute for being a 
user-determined ID attribute.
 public  void setIdAttributeNode(Attr idAttr,
    boolean isId) throws DOMException
    If the parameter isId is true, this method 
declares the specified attribute to be a user-determined ID attribute
. This affects the value of Attr.isId and the behavior 
of Document.getElementById, but does not change any 
schema that may be in use, in particular this does not affect the 
Attr.schemaTypeInfo of the specified Attr 
node. Use the value false for the parameter 
isId to undeclare an attribute for being a 
user-determined ID attribute.