java.lang.Object | ||||
↳ | org.apache.xerces.dom.NodeImpl | |||
↳ | org.apache.xerces.dom.ChildNode | |||
↳ | org.apache.xerces.dom.ParentNode | |||
↳ | org.apache.xerces.dom.ElementImpl |
Known Direct Subclasses |
Elements represent most of the "markup" and structure of the document. They contain both the data for the element itself (element name and attributes), and any contained nodes, including document text (as children).
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.@xerces.internal
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.xerces.dom.NodeImpl
| |||||||||||
From interface
org.w3c.dom.Node
| |||||||||||
From interface
org.w3c.dom.TypeInfo
|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
attributes | Attributes. | ||||||||||
name | Element name. |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.xerces.dom.ParentNode
| |||||||||||
From class
org.apache.xerces.dom.ChildNode
| |||||||||||
From class
org.apache.xerces.dom.NodeImpl
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Factory constructor.
|
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return a duplicate copy of this Element.
| |||||||||||
Look up a single Attribute by name.
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
Look up a single Attribute by name.
| |||||||||||
Retrieves an Attr node by local name and namespace URI.
| |||||||||||
Retrieve all the Attributes as a set.
| |||||||||||
DOM Level 3 WD - Experimental.
| |||||||||||
Returns a NodeList of all descendent nodes (children,
grandchildren, and so on) which are Elements and which have the
specified tag name.
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
Returns the element name
| |||||||||||
A short integer indicating what type of node this is.
| |||||||||||
Method getSchemaTypeInfo.
| |||||||||||
Returns the name of the Element.
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
Introduced in DOM Level 3.
| |||||||||||
DOM Level 3 WD- Experimental.
| |||||||||||
In "normal form" (as read from a source file), there will never be two
Text children in succession.
| |||||||||||
Remove the named attribute from this Element.
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
Remove the specified attribute/value pair.
| |||||||||||
Add a new name/value pair, or replace the value of the existing
attribute having that name.
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
Add a new attribute/value pair, or replace the value of the
existing attribute with that name.
| |||||||||||
Introduced in DOM Level 2.
| |||||||||||
DOM Level 3: register the given attribute node as an ID attribute
| |||||||||||
DOM Level 3: register the given attribute node as an ID attribute
| |||||||||||
DOM Level 3: register the given attribute node as an ID attribute
| |||||||||||
NON-DOM: Subclassed to flip the attributes' readonly switch as well.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Get the default attributes.
| |||||||||||
NON-DOM: get inded of an attribute
| |||||||||||
Reconcile default attributes.
| |||||||||||
NON-DOM
set the ownerDocument of this node, its children, and its attributes
| |||||||||||
NON-DOM: sets attribute node for this element
| |||||||||||
Setup the default attributes.
| |||||||||||
Synchronizes the data (name and value) for fast nodes.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.xerces.dom.ParentNode
| |||||||||||
From class
org.apache.xerces.dom.ChildNode
| |||||||||||
From class
org.apache.xerces.dom.NodeImpl
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
org.w3c.dom.Element
| |||||||||||
From interface
org.w3c.dom.Node
| |||||||||||
From interface
org.w3c.dom.NodeList
| |||||||||||
From interface
org.w3c.dom.TypeInfo
| |||||||||||
From interface
org.w3c.dom.events.EventTarget
|
Return a duplicate copy of this Element. Note that its children will not be copied unless the "deep" flag is true, but Attributes are always replicated.
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().
Introduced in DOM Level 2.
Retrieves an attribute value by local name and namespace URI.
namespaceURI | The namespace URI of the attribute to retrieve. |
---|---|
localName | The local name of the attribute to retrieve. |
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.
Retrieves an 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. |
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.
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.
tagname | The type of element to gather. To obtain a list of all elements no matter what their names, use the wild-card tag name "*". |
---|
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.
namespaceURI | 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. |
---|---|
localName | The local name of the elements to match on. The special value "*" matches all local names. |
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.
Method getSchemaTypeInfo.
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.
Introduced in DOM Level 2.
true
if this node has any attributes,
false
otherwise.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
typeNamespaceArg | The namspace of the ancestor type declaration |
---|---|
typeNameArg | The name of the ancestor type declaration |
derivationMethod | The derivation method |
DOM Level 3 WD- Experimental. Override inherited behavior from NodeImpl and ParentNode to check on attributes
arg | The node to compare equality with. |
---|
true
otherwise false
.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.
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.
if the node is readonly. |
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.
namespaceURI | The namespace URI of the attribute to remove. |
---|---|
localName | The local name of the attribute to remove. |
Raised if this node is readonly. |
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().
if oldattr is not an attribute of this Element. | |
if the node is readonly. | |
DOMException |
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.
if the name is not acceptable. (Attribute factory will do that test for us.) | |
if the node is readonly. |
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.
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. |
Raised if the specified name contains an invalid character. | |
Raised if this node is readonly. | |
Raised if the qualifiedName has a prefix that is "xml" and the namespaceURI is neither null nor an empty string nor "http://www.w3.org/XML/1998/namespace", or if the qualifiedName has a prefix that is "xmlns" but the namespaceURI is neither null nor an empty string, or if if the qualifiedName has a prefix different from "xml" and "xmlns" and the namespaceURI is null or an empty string. |
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.
if the Attribute object has already been assigned to another Element. | |
DOMException |
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.
newAttr | The Attr node to add to the attribute list. When the Node has no namespaceURI, this method behaves like setAttributeNode. |
---|
Raised if newAttr was created from a different document than the one that created the element. | |
Raised if this node is readonly. | |
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. | |
DOMException |
DOM Level 3: register the given attribute node as an ID attribute
DOM Level 3: register the given attribute node as an ID attribute
DOM Level 3: register the given attribute node as an ID attribute
NON-DOM: Subclassed to flip the attributes' readonly switch as well.
readOnly | True or false as desired. |
---|---|
deep | 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. |
NON-DOM: get inded of an attribute
Reconcile default attributes.
NON-DOM set the ownerDocument of this node, its children, and its attributes
NON-DOM: sets attribute node for this element
Setup the default attributes.
Synchronizes the data (name and value) for fast nodes.