Elements may have Attributes associated with them; the API for this is defined in Node, but the function is implemented here. In general, XML applications should retrive Attributes as Nodes, since they may contain entity references and hence be a fairly complex sub-tree. HTML users will be dealing with simple string values, and convenience methods are provided to work in terms of Strings.
ElementImpl does not support Namespaces. ElementNSImpl, which inherits from it, does.
ElementNSImpl
| Modifier and Type | Field and Description |
|---|---|
| protected AttributeMap | attributes
Attributes. |
| protected String | name
Element name. |
| pack-priv static final long | serialVersionUID
Hides com. |
| Access | Constructor and Description |
|---|---|
| public | |
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public Node | cloneNode(boolean
If deep)true, recursively clone the subtree under
the specified node; if false, clone only the node
itself (and its attributes, if it is an Element).Overrides com. Implements org. Return a duplicate copy of this Element. |
| public String | getAttribute(String
The name of the attribute to retrieve. name)Implements org. Look up a single Attribute by name. |
| public Attr | getAttributeNode(String
The name ( name)nodeName) of the attribute to
retrieve.Implements org. Look up a single Attribute by name. |
| public Attr | Returns: Attr The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.The namespace URI of the attribute to retrieve. namespaceURI, String The local name of the attribute to retrieve. localName)Implements org. Retrieves an Attr node by local name and namespace URI. |
| public String | Returns: String The Attr value as a string, or empty string if that attribute does not have a specified or default value.The namespace URI of the attribute to retrieve. namespaceURI, String The local name of the attribute to retrieve. localName)Implements org. Introduced in DOM Level 2. |
| public NamedNodeMap | Returns: all AttributesOverrides com. Implements org. Retrieve all the Attributes as a set. |
| public String | Returns: the baseURIOverrides com. Implements org. DOM Level 3 WD - Experimental. |
| public final int | getChildElementCount()
Implements org. Returns the current number of child nodes of the element which are of
the |
| protected NamedNodeMapImpl | |
| public NodeList | getElementsByTagName(String
The type of element to gather. To obtain a list of all
elements no matter what their names, use the wild-card tag name "*". tagname)Implements org. Returns a NodeList of all descendent nodes (children, grandchildren, and so on) which are Elements and which have the specified tag name. |
| public NodeList | Returns: NodeList A new NodeList object containing all the matched Elements.The namespace URI of the elements to match on. The
special value "*" matches all namespaces. When it is null or an empty
string, this method behaves like getElementsByTagName. namespaceURI, String The local name of the elements to match on. The special
value "*" matches all local names. localName)Implements org. Introduced in DOM Level 2. |
| public final Element | getFirstElementChild()
Implements org. Returns a reference to the first child node of the element which is of
the |
| private Element | |
| public final Element | getLastElementChild()
Implements org. Returns a reference to the last child node of the element which is of
the |
| private Element | |
| public final Element | getNextElementSibling()
Implements org. Returns a reference to the sibling node of the element which most immediately
follows the element in document order, and which is of the |
| private Node | |
| public String | Returns: the node nameImplements abstract com. Implements org. Returns the node name |
| public short | getNodeType()
Implements abstract com. Implements org. A short integer indicating what type of node this is. |
| public final Element | getPreviousElementSibling()
Implements org. Returns a reference to the sibling node of the element which most immediately
precedes the element in document order, and which is of the |
| private Node | |
| public TypeInfo | Returns: TypeInfoImplements org. Method getSchemaTypeInfo. |
| public String | |
| public String | getTypeName()
Implements org. The name of a type declared for the associated element or attribute,
or |
| public String | getTypeNamespace()
Implements org. The namespace of the type declared for the associated element or
attribute or |
| protected int | |
| protected Attr | |
| public boolean | hasAttribute(String
The name of the attribute to look for. name)Implements org. Introduced in DOM Level 2. |
| public boolean | hasAttributeNS(String
The namespace URI of the attribute to look for. namespaceURI, String The local name of the attribute to look for. localName)Implements org. Introduced in DOM Level 2. |
| public boolean | hasAttributes()
Overrides com. Implements org. Introduced in DOM Level 2. |
| public boolean | Returns: boolean True if the type is derived by restriction for the reference typeThe namspace of the ancestor type declaration typeNamespaceArg, String The name of the ancestor type declaration typeNameArg, int The derivation method derivationMethod)Implements org. Introduced in DOM Level 3. |
| public boolean | isEqualNode(Node
The node to compare equality with. arg)Overrides com. Implements org. DOM Level 3 WD- Experimental. |
| pack-priv void | |
| public void | normalize()
Overrides com. Implements org. In "normal form" (as read from a source file), there will never be two Text children in succession. |
| protected void | |
| public void | removeAttribute(String
The name of the attribute to remove. name)Implements org. Remove the named attribute from this Element. |
| public Attr | Returns: the Attribute object that was removed.The oldAttr)Attr node to remove from the attribute
list.Implements org. Remove the specified attribute/value pair. |
| public void | removeAttributeNS(String
The namespace URI of the attribute to remove. namespaceURI, String The local name of the attribute to remove. localName)Implements org. Introduced in DOM Level 2. |
| pack-priv void | |
| public void | setAttribute(String
The name of the attribute to create or alter. name, String Value to set in string form. value)Implements org. Add a new name/value pair, or replace the value of the existing attribute having that name. |
| public Attr | setAttributeNode(Attr
The newAttr)Attr node to add to the attribute list.Implements org. Add a new attribute/value pair, or replace the value of the existing attribute with that name. |
| public Attr | Returns: Attr If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the * previously existing Attr node is returned, otherwise null is returned.The Attr node to add to the attribute list. When the Node
has no namespaceURI, this method behaves like setAttributeNode. newAttr)Implements org. Introduced in DOM Level 2. |
| public void | setAttributeNS(String
The namespace URI of the attribute to create or
alter. namespaceURI, String The qualified name of the attribute to create or
alter. qualifiedName, String The value to set in string form. value)Implements org. Introduced in DOM Level 2. |
| public void | setIdAttribute(String
The name of the attribute. name, boolean Whether the attribute is a of type ID. makeId)Implements org. DOM Level 3: register the given attribute node as an ID attribute |
| public void | setIdAttributeNode(Attr
The attribute node. at, boolean Whether the attribute is a of type ID. makeId)Implements org. DOM Level 3: register the given attribute node as an ID attribute |
| public void | setIdAttributeNS(String
The namespace URI of the attribute. namespaceURI, String The local name of the attribute. localName, boolean Whether the attribute is a of type ID. makeId)Implements org. DOM Level 3: register the given attribute node as an ID attribute |
| protected void | setOwnerDocument(CoreDocumentImpl doc)
Overrides com. NON-DOM set the ownerDocument of this node, its children, and its attributes |
| public void | setReadOnly(boolean
True or false as desired. readOnly, boolean If true, children are also toggled. Note that this will
not change the state of an EntityReference or its children,
which are always read-only. deep)Overrides com. NON-DOM: Subclassed to flip the attributes' readonly switch as well. |
| protected void | |
| protected int | |
| protected void | synchronizeData()
Overrides com. Synchronizes the data (name and value) for fast nodes. |
| attributes | back to summary |
|---|---|
| protected AttributeMap attributes Attributes. | |
| name | back to summary |
|---|---|
| protected String name Element name. | |
| serialVersionUID | back to summary |
|---|---|
| pack-priv static final long serialVersionUID Hides com. Serialization version. | |
| ElementImpl | back to summary |
|---|---|
| public ElementImpl(CoreDocumentImpl ownerDoc, String name) Factory constructor. | |
| ElementImpl | back to summary |
|---|---|
| protected ElementImpl() | |
| cloneNode | back to summary |
|---|---|
| public Node cloneNode(boolean deep) Overrides com. Implements org. Return a duplicate copy of this Element. Note that its children will not
be copied unless the "deep" flag is true, but Attributes are
| |
| getAttribute | back to summary |
|---|---|
| public String getAttribute(String name) Implements org. Look up a single Attribute by name. Returns the Attribute's string value, or an empty string (NOT null!) to indicate that the name did not map to a currently defined attribute. Note Attributes may contain complex node trees. This method returns the "flattened" string obtained from Attribute.getValue(). If you need the structure information, see getAttributeNode().
| |
| getAttributeNode | back to summary |
|---|---|
| public Attr getAttributeNode(String name) Implements org. Look up a single Attribute by name. Returns the Attribute Node, so its complete child tree is available. This could be important in XML, where the string rendering may not be sufficient information. If no matching attribute is available, returns null.
| |
| getAttributeNodeNS | back to summary |
|---|---|
| public Attr getAttributeNodeNS(String namespaceURI, String localName) Implements org. Retrieves an Attr node by local name and namespace URI. | |
| getAttributeNS | back to summary |
|---|---|
| public String getAttributeNS(String namespaceURI, String localName) Implements org. Introduced in DOM Level 2. Retrieves an attribute value by local name and namespace URI. | |
| getAttributes | back to summary |
|---|---|
| public NamedNodeMap getAttributes() Overrides com. Implements org. Retrieve all the Attributes as a set. Note that this API is inherited from Node rather than specified on Element; in fact only Elements will ever have Attributes, but they want to allow folks to "blindly" operate on the tree as a set of Nodes.
| |
| getBaseURI | back to summary |
|---|---|
| public String getBaseURI() Overrides com. Implements org. DOM Level 3 WD - Experimental. Retrieve baseURI | |
| getChildElementCount | back to summary |
|---|---|
| public final int getChildElementCount() Implements org. Doc from org. Returns the current number of child nodes of the element which are of
the
| |
| getDefaultAttributes | back to summary |
|---|---|
| protected NamedNodeMapImpl getDefaultAttributes() Get the default attributes. | |
| getElementsByTagName | back to summary |
|---|---|
| public NodeList getElementsByTagName(String tagname) Implements org. Returns a NodeList of all descendent nodes (children, grandchildren, and so on) which are Elements and which have the specified tag name. Note NodeList is a "live" view of the DOM. Its contents will change as the DOM changes, and alterations made to the NodeList will be reflected in the DOM.
| |
| getElementsByTagNameNS | back to summary |
|---|---|
| public NodeList getElementsByTagNameNS(String namespaceURI, String localName) Implements org. Introduced in DOM Level 2. Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the Document tree, starting from this node.
| |
| getFirstElementChild | back to summary |
|---|---|
| public final Element getFirstElementChild() Implements org. Doc from org. Returns a reference to the first child node of the element which is of
the
| |
| getFirstElementChild | back to summary |
|---|---|
| private Element getFirstElementChild(Node n) | |
| getLastElementChild | back to summary |
|---|---|
| public final Element getLastElementChild() Implements org. Doc from org. Returns a reference to the last child node of the element which is of
the
| |
| getLastElementChild | back to summary |
|---|---|
| private Element getLastElementChild(Node n) | |
| getNextElementSibling | back to summary |
|---|---|
| public final Element getNextElementSibling() Implements org. Doc from org. Returns a reference to the sibling node of the element which most immediately
follows the element in document order, and which is of the
| |
| getNextLogicalSibling | back to summary |
|---|---|
| private Node getNextLogicalSibling(Node n) | |
| getNodeName | back to summary |
|---|---|
| public String getNodeName() Implements abstract com. Implements org. Returns the node name | |
| getNodeType | back to summary |
|---|---|
| public short getNodeType() Implements abstract com. Implements org. A short integer indicating what type of node this is. The named constants for this value are defined in the org.w3c.dom.Node interface. | |
| getPreviousElementSibling | back to summary |
|---|---|
| public final Element getPreviousElementSibling() Implements org. Doc from org. Returns a reference to the sibling node of the element which most immediately
precedes the element in document order, and which is of the
| |
| getPreviousLogicalSibling | back to summary |
|---|---|
| private Node getPreviousLogicalSibling(Node n) | |
| getSchemaTypeInfo | back to summary |
|---|---|
| public TypeInfo getSchemaTypeInfo() Implements org. Method getSchemaTypeInfo.
| |
| getTagName | back to summary |
|---|---|
| public String getTagName() Implements org. Returns the name of the Element. Note that Element.nodeName() is defined to also return the tag name. This is case-preserving in XML. HTML should uppercasify it on the way in. | |
| getTypeName | back to summary |
|---|---|
| public String getTypeName() Implements org. Doc from org. The name of a type declared for the associated element or attribute,
or
| |
| getTypeNamespace | back to summary |
|---|---|
| public String getTypeNamespace() Implements org. Doc from org. The namespace of the type declared for the associated element or
attribute or | |
| getXercesAttribute | back to summary |
|---|---|
| protected int getXercesAttribute(String namespaceURI, String localName) NON-DOM: get inded of an attribute | |
| getXMLBaseAttribute | back to summary |
|---|---|
| protected Attr getXMLBaseAttribute() NON-DOM Returns the xml:base attribute.
| |
| hasAttribute | back to summary |
|---|---|
| public boolean hasAttribute(String name) Implements org. Introduced in DOM Level 2.
| |
| hasAttributeNS | back to summary |
|---|---|
| public boolean hasAttributeNS(String namespaceURI, String localName) Implements org. Introduced in DOM Level 2.
| |
| hasAttributes | back to summary |
|---|---|
| public boolean hasAttributes() Overrides com. Implements org. Introduced in DOM Level 2.
| |
| isDerivedFrom | back to summary |
|---|---|
| public boolean isDerivedFrom(String typeNamespaceArg, String typeNameArg, int derivationMethod) Implements org. Introduced in DOM Level 3. Checks if a type is derived from another by restriction. See: http://www.w3.org/TR/DOM-Level-3-Core/core.html#TypeInfo-isDerivedFrom | |
| isEqualNode | back to summary |
|---|---|
| public boolean isEqualNode(Node arg) Overrides com. Implements org. DOM Level 3 WD- Experimental. Override inherited behavior from NodeImpl and ParentNode to check on attributes
| |
| moveSpecifiedAttributes | back to summary |
|---|---|
| pack-priv void moveSpecifiedAttributes(ElementImpl el) | |
| normalize | back to summary |
|---|---|
| public void normalize() Overrides com. Implements org. In "normal form" (as read from a source file), there will never be two Text children in succession. But DOM users may create successive Text nodes in the course of manipulating the document. Normalize walks the sub-tree and merges adjacent Texts, as if the DOM had been written out and read back in again. This simplifies implementation of higher-level functions that may want to assume that the document is in standard form. To normalize a Document, normalize its top-level Element child. As of PR-DOM-Level-1-19980818, CDATA -- despite being a subclass of Text -- is considered "markup" and will _not_ be merged either with normal Text or with other CDATASections. | |
| reconcileDefaultAttributes | back to summary |
|---|---|
| protected void reconcileDefaultAttributes() Reconcile default attributes. | |
| removeAttribute | back to summary |
|---|---|
| public void removeAttribute(String name) Implements org. Remove the named attribute from this Element. If the removed Attribute has a default value, it is immediately replaced thereby. The default logic is actually implemented in NamedNodeMapImpl. PR-DOM-Level-1-19980818 doesn't fully address the DTD, so some of this behavior is likely to change in future versions. ????? Note that this call "succeeds" even if no attribute by this name existed -- unlike removeAttributeNode, which will throw a not-found exception in that case.
| |
| removeAttributeNode | back to summary |
|---|---|
| public Attr removeAttributeNode(Attr oldAttr) throws DOMException Implements org. Remove the specified attribute/value pair. If the removed Attribute has a default value, it is immediately replaced. Note Specifically removes THIS NODE -- not the node with this name, nor the node with these contents. If the specific Attribute object passed in is not stored in this Element, we throw a DOMException. If you really want to remove an attribute by name, use removeAttribute().
| |
| removeAttributeNS | back to summary |
|---|---|
| public void removeAttributeNS(String namespaceURI, String localName) Implements org. Introduced in DOM Level 2. 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.
| |
| rename | back to summary |
|---|---|
| pack-priv void rename(String name) | |
| setAttribute | back to summary |
|---|---|
| public void setAttribute(String name, String value) Implements org. Add a new name/value pair, or replace the value of the existing attribute having that name. Note this method supports only the simplest kind of Attribute, one whose value is a string contained in a single Text node. If you want to assert a more complex value (which XML permits, though HTML doesn't), see setAttributeNode(). The attribute is created with specified=true, meaning it's an explicit value rather than inherited from the DTD as a default. Again, setAttributeNode can be used to achieve other results.
| |
| setAttributeNode | back to summary |
|---|---|
| public Attr setAttributeNode(Attr newAttr) throws DOMException Implements org. Add a new attribute/value pair, or replace the value of the existing attribute with that name. This method allows you to add an Attribute that has already been constructed, and hence avoids the limitations of the simple setAttribute() call. It can handle attribute values that have arbitrarily complex tree structure -- in particular, those which had entity references mixed into their text.
| |
| setAttributeNodeNS | back to summary |
|---|---|
| public Attr setAttributeNodeNS(Attr newAttr) throws DOMException Implements org. Introduced in DOM Level 2. Adds a new attribute. If an attribute with that local name and namespace URI is already present in the element, it is replaced by the new one.
| |
| setAttributeNS | back to summary |
|---|---|
| public void setAttributeNS(String namespaceURI, String qualifiedName, String value) Implements org. Introduced in DOM Level 2. Adds a new attribute. If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the new attribute is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace" [Namespaces]. 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.
| |
| setIdAttribute | back to summary |
|---|---|
| public void setIdAttribute(String name, boolean makeId) Implements org. DOM Level 3: register the given attribute node as an ID attribute
| |
| setIdAttributeNode | back to summary |
|---|---|
| public void setIdAttributeNode(Attr at, boolean makeId) Implements org. DOM Level 3: register the given attribute node as an ID attribute
| |
| setIdAttributeNS | back to summary |
|---|---|
| public void setIdAttributeNS(String namespaceURI, String localName, boolean makeId) Implements org. DOM Level 3: register the given attribute node as an ID attribute
| |
| setOwnerDocument | back to summary |
|---|---|
| protected void setOwnerDocument(CoreDocumentImpl doc) Overrides com. NON-DOM set the ownerDocument of this node, its children, and its attributes
| |
| setReadOnly | back to summary |
|---|---|
| public void setReadOnly(boolean readOnly, boolean deep) Overrides com. NON-DOM: Subclassed to flip the attributes' readonly switch as well.
| |
| setupDefaultAttributes | back to summary |
|---|---|
| protected void setupDefaultAttributes() Setup the default attributes. | |
| setXercesAttributeNode | back to summary |
|---|---|
| protected int setXercesAttributeNode(Attr attr) NON-DOM: sets attribute node for this element | |
| synchronizeData | back to summary |
|---|---|
| protected void synchronizeData() Overrides com. Synchronizes the data (name and value) for fast nodes. | |