| java.lang.Object
 org.apache.xerces.dom.NodeImpl
All known Subclasses: org.apache.xerces.dom.AttrImpl, org.apache.xerces.dom.NotationImpl, org.apache.xerces.dom.ChildNode,
| NodeImpl | | abstract public class NodeImpl implements Node,NodeList,EventTarget,Cloneable,Serializable(Code) | | NodeImpl provides the basic structure of a DOM tree. It is never used
directly, but instead is subclassed to add type and data
information, and additional methods, appropriate to each node of
the tree. Only its subclasses should be instantiated -- and those,
with the exception of Document itself, only through a specific
Document's factory methods.
The Node interface provides shared behaviors such as siblings and
children, both for consistancy and so that the most common tree
operations may be performed without constantly having to downcast
to specific node types. When there is no obvious mapping for one of
these queries, it will respond with null.
Note that the default behavior is that children are forbidden. To
permit them, the subclass ParentNode overrides several methods.
NodeImpl also implements NodeList, so it can return itself in
response to the getChildNodes() query. This eliminiates the need
for a separate ChildNodeList object. Note that this is an
IMPLEMENTATION DETAIL; applications should _never_ assume that
this identity exists.
All nodes in a single document must originate
in that document. (Note that this is much tighter than "must be
same implementation") Nodes are all aware of their ownerDocument,
and attempts to mismatch will throw WRONG_DOCUMENT_ERR.
However, to save memory not all nodes always have a direct reference
to their ownerDocument. When a node is owned by another node it relies
on its owner to store its ownerDocument. Parent nodes always store it
though, so there is never more than one level of indirection.
And when a node doesn't have an owner, ownerNode refers to its
ownerDocument.
This class doesn't directly support mutation events, however, it still
implements the EventTarget interface and forward all related calls to the
document so that the document class do so.
author:
Arnaud Le Hors, IBM
author:
Joe Kesselman, IBM
version:
$Id: NodeImpl.java 449328 2006-09-23 22:58:23Z mrglavas $
since:
PR-DOM-Level-1-19980818. |
| Constructor Summary | |
| protected | NodeImpl(CoreDocumentImpl ownerDocument)
No public constructor; only subclasses of Node should be
instantiated, and those normally via a Document's factory methods
Every Node knows what Document it belongs to. | | public | NodeImpl()
Constructor for serialization. |
| Method Summary | |
| public void | addEventListener(String type, EventListener listener, boolean useCapture)
| | public Node | appendChild(Node newChild)
Adds a child node to the end of the list of children for this node. | | protected void | changed()
Denotes that this node has changed. | | protected int | changes()
Returns the number of changes to this node. | | public Node | cloneNode(boolean deep)
Returns a duplicate of a given node. | | public short | compareDocumentPosition(Node other)
Compares a node with this node with regard to their position in the
document. | | public short | compareTreePosition(Node other)
Compares a node with this node with regard to their position in the
tree and according to the document order. | | public boolean | dispatchEvent(Event event)
| | public NamedNodeMap | getAttributes()
Return the collection of attributes associated with this node,
or null if none. | | public String | getBaseURI()
The absolute base URI of this node or null if undefined. | | public NodeList | getChildNodes()
Obtain a NodeList enumerating all children of this node. | | protected Node | getContainer()
For non-child nodes, the node which "points" to this node. | | Node | getElementAncestor(Node currentNode)
| | public Object | getFeature(String feature, String version)
| | public Node | getFirstChild()
The first child of this Node, or null if none. | | public Node | getLastChild()
The first child of this Node, or null if none. | | public int | getLength()
NodeList method: Count the immediate children of this node
By default we do not have any children, ParentNode overrides this. | | public String | getLocalName()
Introduced in DOM Level 2. | | public String | getNamespaceURI()
Introduced in DOM Level 2. | | public Node | getNextSibling()
| | abstract public String | getNodeName()
the name of this node. | | protected int | getNodeNumber()
| | abstract public short | getNodeType()
A short integer indicating what type of node this is. | | public String | getNodeValue()
Returns the node value. | | public Document | getOwnerDocument()
Find the Document that this Node belongs to (the document in
whose context the Node was created). | | public Node | getParentNode()
Obtain the DOM-tree parent of this node, or null if it is not
currently active in the DOM tree (perhaps because it has just been
created or removed). | | public String | getPrefix()
Introduced in DOM Level 2. | | public Node | getPreviousSibling()
| | public boolean | getReadOnly()
NON-DOM: Returns true if this node is read-only. | | public String | getTextContent()
This attribute returns the text content of this node and its
descendants. | | void | getTextContent(StringBuffer buf)
| | public Object | getUserData(String key)
Retrieves the object associated to a key on a this node. | | public Object | getUserData()
NON-DOM:
Returns the user data associated to this node. | | protected Hashtable | getUserDataRecord()
| | public boolean | hasAttributes()
Returns whether this node (if it is an element) has any attributes. | | public boolean | hasChildNodes()
Test whether this node has any children. | | final boolean | hasStringValue()
| | final void | hasStringValue(boolean value)
| | public Node | insertBefore(Node newChild, Node refChild)
Move one or more node(s) to our list of children. | | final boolean | internalIsIgnorableWhitespace()
| | public boolean | isDefaultNamespace(String namespaceURI)
DOM Level 3: Experimental
This method checks if the specified namespaceURI is the
default namespace or not. | | public boolean | isEqualNode(Node arg)
Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e.,
whether the two nodes are references to the same object) which can be
tested with Node.isSameNode. | | final boolean | isFirstChild()
| | final void | isFirstChild(boolean value)
| | final boolean | isIdAttribute()
| | final void | isIdAttribute(boolean value)
| | final void | isIgnorableWhitespace(boolean value)
| | final boolean | isNormalized()
| | final void | isNormalized(boolean value)
| | final boolean | isOwned()
| | final void | isOwned(boolean value)
| | final boolean | isReadOnly()
| | final void | isReadOnly(boolean value)
| | public boolean | isSameNode(Node other)
Returns whether this node is the same node as the given one.
This method provides a way to determine whether two
Node references returned by the implementation reference
the same object. | | final boolean | isSpecified()
| | final void | isSpecified(boolean value)
| | public boolean | isSupported(String feature, String version)
Introduced in DOM Level 2. | | public Node | item(int index)
NodeList method: Return the Nth immediate child of this node, or
null if the index is out of bounds. | | String | lookupNamespacePrefix(String namespaceURI, ElementImpl el)
| | public String | lookupNamespaceURI(String specifiedPrefix)
DOM Level 3 - Experimental:
Look up the namespace URI associated to the given prefix, starting from this node. | | public String | lookupPrefix(String namespaceURI)
DOM Level 3 - Experimental:
Look up the prefix associated to the given namespace URI, starting from this node. | | final boolean | needsSyncChildren()
| | final public void | needsSyncChildren(boolean value)
| | final boolean | needsSyncData()
| | final void | needsSyncData(boolean value)
| | public void | normalize()
Puts all Text nodes in the full depth of the sub-tree
underneath this Node, including attribute nodes, into a
"normal" form where only markup (e.g., tags, comments, processing
instructions, CDATA sections, and entity references) separates
Text nodes, i.e., there are no adjacent Text
nodes. | | CoreDocumentImpl | ownerDocument()
| | NodeImpl | parentNode()
| | ChildNode | previousSibling()
| | public Node | removeChild(Node oldChild)
Remove a child from this Node. | | public void | removeEventListener(String type, EventListener listener, boolean useCapture)
| | public Node | replaceChild(Node newChild, Node oldChild)
Make newChild occupy the location that oldChild used to
have. | | public void | setNodeValue(String x)
Sets the node value. | | protected void | setOwnerDocument(CoreDocumentImpl doc)
| | public void | setPrefix(String prefix)
Introduced in DOM Level 2. | | public void | setReadOnly(boolean readOnly, boolean deep)
NON-DOM: PR-DOM-Level-1-19980818 mentions readonly nodes in conjunction
with Entities, but provides no API to support this.
Most DOM users should not touch this method. | | public void | setTextContent(String textContent)
This attribute returns the text content of this node and its
descendants. | | public Object | setUserData(String key, Object data, UserDataHandler handler)
Associate an object to a key on this node. | | public void | setUserData(Object data)
NON-DOM: As an alternative to subclassing the DOM, this implementation
has been extended with the ability to attach an object to each node.
(If you need multiple objects, you can attach a collection such as a
vector or hashtable, then attach your application information to that.)
Important Note: You are responsible for removing references
to your data on nodes that are no longer used. | | protected void | synchronizeData()
Override this method in subclass to hook in efficient
internal data structure. | | public String | toString()
NON-DOM method for debugging convenience. |
| DOCUMENT_POSITION_CONTAINS | | final public static short DOCUMENT_POSITION_CONTAINS(Code) | | |
| DOCUMENT_POSITION_DISCONNECTED | | final public static short DOCUMENT_POSITION_DISCONNECTED(Code) | | |
| DOCUMENT_POSITION_FOLLOWING | | final public static short DOCUMENT_POSITION_FOLLOWING(Code) | | |
| DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC | | final public static short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC(Code) | | |
| DOCUMENT_POSITION_IS_CONTAINED | | final public static short DOCUMENT_POSITION_IS_CONTAINED(Code) | | |
| DOCUMENT_POSITION_PRECEDING | | final public static short DOCUMENT_POSITION_PRECEDING(Code) | | |
| ELEMENT_DEFINITION_NODE | | final public static short ELEMENT_DEFINITION_NODE(Code) | | Element definition node type.
|
| FIRSTCHILD | | final protected static short FIRSTCHILD(Code) | | |
| HASSTRING | | final protected static short HASSTRING(Code) | | |
| ID | | final protected static short ID(Code) | | |
| IGNORABLEWS | | final protected static short IGNORABLEWS(Code) | | |
| NORMALIZED | | final protected static short NORMALIZED(Code) | | |
| OWNED | | final protected static short OWNED(Code) | | |
| READONLY | | final protected static short READONLY(Code) | | |
| SPECIFIED | | final protected static short SPECIFIED(Code) | | |
| SYNCCHILDREN | | final protected static short SYNCCHILDREN(Code) | | |
| SYNCDATA | | final protected static short SYNCDATA(Code) | | |
| TREE_POSITION_ANCESTOR | | final public static short TREE_POSITION_ANCESTOR(Code) | | The node is an ancestor of the reference node.
|
| TREE_POSITION_DESCENDANT | | final public static short TREE_POSITION_DESCENDANT(Code) | | The node is a descendant of the reference node.
|
| TREE_POSITION_DISCONNECTED | | final public static short TREE_POSITION_DISCONNECTED(Code) | | The two nodes are disconnected, they do not have any common ancestor.
This is the case of two nodes that are not in the same document.
|
| TREE_POSITION_EQUIVALENT | | final public static short TREE_POSITION_EQUIVALENT(Code) | | The two nodes have an equivalent position. This is the case of two
attributes that have the same ownerElement, and two
nodes that are the same.
|
| TREE_POSITION_FOLLOWING | | final public static short TREE_POSITION_FOLLOWING(Code) | | The node follows the reference node.
|
| TREE_POSITION_PRECEDING | | final public static short TREE_POSITION_PRECEDING(Code) | | The node precedes the reference node.
|
| TREE_POSITION_SAME_NODE | | final public static short TREE_POSITION_SAME_NODE(Code) | | The two nodes are the same. Two nodes that are the same have an
equivalent position, though the reverse may not be true.
|
| flags | | protected short flags(Code) | | |
| serialVersionUID | | final static long serialVersionUID(Code) | | Serialization version.
|
| NodeImpl | | protected NodeImpl(CoreDocumentImpl ownerDocument)(Code) | | No public constructor; only subclasses of Node should be
instantiated, and those normally via a Document's factory methods
Every Node knows what Document it belongs to.
|
| NodeImpl | | public NodeImpl()(Code) | | Constructor for serialization.
|
| appendChild | | public Node appendChild(Node newChild) throws DOMException(Code) | | Adds a child node to the end of the list of children for this node.
Convenience shorthand for insertBefore(newChild,null).
See Also: NodeImpl.insertBefore(Node,Node)
See Also:
See Also: By default we do not accept any children, ParentNode overrides this.
See Also: ParentNode newChild, in its new state (relocated, or emptied in the case ofDocumentNode.)
throws:
DOMException - (HIERARCHY_REQUEST_ERR) if newChild is of atype that shouldn't be a child of this node.
throws:
DOMException - (WRONG_DOCUMENT_ERR) if newChild has adifferent owner document than we do.
throws:
DOMException - (NO_MODIFICATION_ALLOWED_ERR) if this node isread-only.
|
| changed | | protected void changed()(Code) | | Denotes that this node has changed.
|
| changes | | protected int changes()(Code) | | Returns the number of changes to this node.
|
| cloneNode | | public Node cloneNode(boolean deep)(Code) | | Returns a duplicate of a given node. You can consider this a
generic "copy constructor" for nodes. The newly returned object should
be completely independent of the source object's subtree, so changes
in one after the clone has been made will not affect the other.
Note: since we never have any children deep is meaningless here,
ParentNode overrides this behavior.
See Also: ParentNode
See Also:
See Also: Example: Cloning a Text node will copy both the node and the text it
See Also: contains.
See Also:
See Also: Example: Cloning something that has children -- Element or Attr, for
See Also: example -- will _not_ clone those children unless a "deep clone"
See Also: has been requested. A shallow clone of an Attr node will yield an
See Also: empty Attr of the same name.
See Also:
See Also: NOTE: Clones will always be read/write, even if the node being cloned
See Also: is read-only, to permit applications using only the DOM API to obtain
See Also: editable copies of locked portions of the tree.
|
| compareDocumentPosition | | public short compareDocumentPosition(Node other) throws DOMException(Code) | | Compares a node with this node with regard to their position in the
document.
Parameters:
other - The node to compare against this node. Returns how the given node is positioned relatively to this node.
since:
DOM Level 3 |
| compareTreePosition | | public short compareTreePosition(Node other)(Code) | | Compares a node with this node with regard to their position in the
tree and according to the document order. This order can be extended
by module that define additional types of nodes.
Parameters:
other - The node to compare against this node. Returns how the given node is positioned relatively to this node.
since:
DOM Level 3 |
| dispatchEvent | | public boolean dispatchEvent(Event event)(Code) | | |
| getAttributes | | public NamedNodeMap getAttributes()(Code) | | Return the collection of attributes associated with this node,
or null if none. At this writing, Element is the only type of node
which will ever have attributes.
See Also: ElementImpl |
| getBaseURI | | public String getBaseURI()(Code) | | The absolute base URI of this node or null if undefined.
This value is computed according to . However, when the
Document supports the feature "HTML" , the base URI is
computed using first the value of the href attribute of the HTML BASE
element if any, and the value of the documentURI
attribute from the Document interface otherwise.
When the node is an Element, a Document
or a a ProcessingInstruction, this attribute represents
the properties [base URI] defined in . When the node is a
Notation, an Entity, or an
EntityReference, this attribute represents the
properties [declaration base URI] in the . How will this be affected
by resolution of relative namespace URIs issue?It's not.Should this
only be on Document, Element, ProcessingInstruction, Entity, and
Notation nodes, according to the infoset? If not, what is it equal to
on other nodes? Null? An empty string? I think it should be the
parent's.No.Should this be read-only and computed or and actual
read-write attribute?Read-only and computed (F2F 19 Jun 2000 and
teleconference 30 May 2001).If the base HTML element is not yet
attached to a document, does the insert change the Document.baseURI?
Yes. (F2F 26 Sep 2001)
since:
DOM Level 3 |
| getChildNodes | | public NodeList getChildNodes()(Code) | | Obtain a NodeList enumerating all children of this node. If there
are none, an (initially) empty NodeList is returned.
NodeLists are "live"; as children are added/removed the NodeList
will immediately reflect those changes. Also, the NodeList refers
to the actual nodes, so changes to those nodes made via the DOM tree
will be reflected in the NodeList and vice versa.
In this implementation, Nodes implement the NodeList interface and
provide their own getChildNodes() support. Other DOMs may solve this
differently.
|
| getContainer | | protected Node getContainer()(Code) | | For non-child nodes, the node which "points" to this node.
For example, the owning element for an attribute
|
| getFirstChild | | public Node getFirstChild()(Code) | | The first child of this Node, or null if none.
By default we do not have any children, ParentNode overrides this.
See Also: ParentNode |
| getLastChild | | public Node getLastChild()(Code) | | The first child of this Node, or null if none.
By default we do not have any children, ParentNode overrides this.
See Also: ParentNode |
| getLength | | public int getLength()(Code) | | NodeList method: Count the immediate children of this node
By default we do not have any children, ParentNode overrides this.
See Also: ParentNode int |
| getLocalName | | public String getLocalName()(Code) | | Introduced in DOM Level 2.
Returns the local part of the qualified name of this node.
For nodes created with a DOM Level 1 method, such as createElement
from the Document interface, and for nodes of any type other than
ELEMENT_NODE and ATTRIBUTE_NODE this is the same as the nodeName
attribute.
since:
WD-DOM-Level-2-19990923
See Also: AttrNSImpl
See Also: ElementNSImpl |
| getNamespaceURI | | public String getNamespaceURI()(Code) | | Introduced in DOM Level 2.
The namespace URI of this node, or null if it is unspecified. When this
node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE, this is
always null and setting it has no effect.
This is not a computed value that is the result of a namespace lookup
based on an examination of the namespace declarations in scope. It is
merely the namespace URI given at creation time.
For nodes created with a DOM Level 1 method, such as createElement
from the Document interface, this is null.
since:
WD-DOM-Level-2-19990923
See Also: AttrNSImpl
See Also: ElementNSImpl |
| getNextSibling | | public Node getNextSibling()(Code) | | The next child of this node's parent, or null if none
|
| getNodeName | | abstract public String getNodeName()(Code) | | the name of this node.
|
| getNodeNumber | | protected int getNodeNumber()(Code) | | Returns the node number
|
| getNodeType | | abstract public short getNodeType()(Code) | | 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.
|
| getOwnerDocument | | public Document getOwnerDocument()(Code) | | Find the Document that this Node belongs to (the document in
whose context the Node was created). The Node may or may not
currently be part of that Document's actual contents.
|
| getParentNode | | public Node getParentNode()(Code) | | Obtain the DOM-tree parent of this node, or null if it is not
currently active in the DOM tree (perhaps because it has just been
created or removed). Note that Document, DocumentFragment, and
Attribute will never have parents.
|
| getPrefix | | public String getPrefix()(Code) | | Introduced in DOM Level 2.
The namespace prefix of this node, or null if it is unspecified. When
this node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE this
is always null and setting it has no effect.
For nodes created with a DOM Level 1 method, such as createElement
from the Document interface, this is null.
since:
WD-DOM-Level-2-19990923
See Also: AttrNSImpl
See Also: ElementNSImpl |
| getPreviousSibling | | public Node getPreviousSibling()(Code) | | The previous child of this node's parent, or null if none
|
| getReadOnly | | public boolean getReadOnly()(Code) | | NON-DOM: Returns true if this node is read-only. This is a
shallow check.
|
| getTextContent | | public String getTextContent() throws DOMException(Code) | | This attribute returns the text content of this node and its
descendants. When it is defined to be null, setting it has no effect.
When set, any possible children this node may have are removed and
replaced by a single Text node containing the string
this attribute is set to. On getting, no serialization is performed,
the returned string does not contain any markup. No whitespace
normalization is performed, the returned string does not contain the
element content whitespaces . Similarly, on setting, no parsing is
performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node
depending on its type, as defined below:
| Node type |
Content |
/**
This attribute returns the text content of this node and its
descendants. When it is defined to be null, setting it has no effect.
When set, any possible children this node may have are removed and
replaced by a single Text node containing the string
this attribute is set to. On getting, no serialization is performed,
the returned string does not contain any markup. No whitespace
normalization is performed, the returned string does not contain the
element content whitespaces . Similarly, on setting, no parsing is
performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node
depending on its type, as defined below:
| Node type |
Content |
|
ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE,
DOCUMENT_FRAGMENT_NODE |
concatenation of the textContent
attribute value of every child node, excluding COMMENT_NODE and
PROCESSING_INSTRUCTION_NODE nodes |
| ATTRIBUTE_NODE, TEXT_NODE,
CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE |
nodeValue |
| DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE |
null |
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
exception:
DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
since:
DOM Level 3
| getUserData | | public Object getUserData(String key)(Code) | | Retrieves the object associated to a key on a this node. The object
must first have been set to this node by calling
setUserData with the same key.
Parameters:
key - The key the object is associated to. Returns the DOMObject associated to the given key on this node, or null if there was none.
since:
DOM Level 3 |
| getUserData | | public Object getUserData()(Code) | | NON-DOM:
Returns the user data associated to this node.
|
| hasAttributes | | public boolean hasAttributes()(Code) | | Returns whether this node (if it is an element) has any attributes.
true if this node has any attributes, false otherwise.
since:
DOM Level 2
See Also: ElementImpl |
| hasChildNodes | | public boolean hasChildNodes()(Code) | | Test whether this node has any children. Convenience shorthand
for (Node.getFirstChild()!=null)
By default we do not have any children, ParentNode overrides this.
See Also: ParentNode |
| hasStringValue | | final boolean hasStringValue()(Code) | | |
| hasStringValue | | final void hasStringValue(boolean value)(Code) | | |
| insertBefore | | public Node insertBefore(Node newChild, Node refChild) throws DOMException(Code) | | Move one or more node(s) to our list of children. Note that this
implicitly removes them from their previous parent.
By default we do not accept any children, ParentNode overrides this.
See Also: ParentNode
Parameters:
newChild - The Node to be moved to our subtree. As aconvenience feature, inserting a DocumentNode will instead insertall its children.
Parameters:
refChild - Current child which newChild should be placedimmediately before. If refChild is null, the insertion occursafter all existing Nodes, like appendChild(). newChild, in its new state (relocated, or emptied in the case ofDocumentNode.)
throws:
DOMException - (HIERARCHY_REQUEST_ERR) if newChild is of atype that shouldn't be a child of this node, or if newChild is anancestor of this node.
throws:
DOMException - (WRONG_DOCUMENT_ERR) if newChild has adifferent owner document than we do.
throws:
DOMException - (NOT_FOUND_ERR) if refChild is not a child ofthis node.
throws:
DOMException - (NO_MODIFICATION_ALLOWED_ERR) if this node isread-only. |
| internalIsIgnorableWhitespace | | final boolean internalIsIgnorableWhitespace()(Code) | | |
| isDefaultNamespace | | public boolean isDefaultNamespace(String namespaceURI)(Code) | | DOM Level 3: Experimental
This method checks if the specified namespaceURI is the
default namespace or not.
Parameters:
namespaceURI - The namespace URI to look for. true if the specified namespaceURI is the default namespace, false otherwise.
since:
DOM Level 3 |
| isEqualNode | | public boolean isEqualNode(Node arg)(Code) | | Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e.,
whether the two nodes are references to the same object) which can be
tested with Node.isSameNode. All nodes that are the same
will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are
satisfied: The two nodes are of the same type.The following string
attributes are equal: nodeName, localName,
namespaceURI, prefix, nodeValue
, baseURI. This is: they are both null, or
they have the same length and are character for character identical.
The attributes NamedNodeMaps are equal.
This is: they are both null, or they have the same
length and for each node that exists in one map there is a node that
exists in the other map and is equal, although not necessarily at the
same index.The childNodes NodeLists are
equal. This is: they are both null, or they have the
same length and contain equal nodes at the same index. This is true
for Attr nodes as for any other type of node. Note that
normalization can affect equality; to avoid this, nodes should be
normalized before being compared.
For two DocumentType nodes to be equal, the following
conditions must also be satisfied: The following string attributes
are equal: publicId, systemId,
internalSubset.The entities
NamedNodeMaps are equal.The notations
NamedNodeMaps are equal.
On the other hand, the following do not affect equality: the
ownerDocument attribute, the specified
attribute for Attr nodes, the
isWhitespaceInElementContent attribute for
Text nodes, as well as any user data or event listeners
registered on the nodes.
Parameters:
arg - The node to compare equality with. If the nodes, and possibly subtrees are equal, true otherwise false.
since:
DOM Level 3 |
| isFirstChild | | final boolean isFirstChild()(Code) | | |
| isFirstChild | | final void isFirstChild(boolean value)(Code) | | |
| isIdAttribute | | final boolean isIdAttribute()(Code) | | |
| isIdAttribute | | final void isIdAttribute(boolean value)(Code) | | |
| isIgnorableWhitespace | | final void isIgnorableWhitespace(boolean value)(Code) | | |
| isNormalized | | final boolean isNormalized()(Code) | | |
| isNormalized | | final void isNormalized(boolean value)(Code) | | |
| isOwned | | final boolean isOwned()(Code) | | |
| isOwned | | final void isOwned(boolean value)(Code) | | |
| isReadOnly | | final boolean isReadOnly()(Code) | | |
| isReadOnly | | final void isReadOnly(boolean value)(Code) | | |
| isSameNode | | public boolean isSameNode(Node other)(Code) | | Returns whether this node is the same node as the given one.
This method provides a way to determine whether two
Node references returned by the implementation reference
the same object. When two Node references are references
to the same object, even if through a proxy, the references may be
used completely interchangably, such that all attributes have the
same values and calling the same DOM method on either reference
always has exactly the same effect.
Parameters:
other - The node to test against. Returns true if the nodes are the same, false otherwise.
since:
DOM Level 3 |
| isSpecified | | final boolean isSpecified()(Code) | | |
| isSpecified | | final void isSpecified(boolean value)(Code) | | |
| isSupported | | public boolean isSupported(String feature, String version)(Code) | | Introduced in DOM Level 2.
Tests whether the DOM implementation implements a specific feature and
that feature is supported by this node.
Parameters:
feature - The package name of the feature to test. This is the samename as what can be passed to the method hasFeature onDOMImplementation.
Parameters:
version - This is the version number of the package name totest. In Level 2, version 1, this is the string "2.0". If the version isnot specified, supporting any version of the feature will cause themethod to return true. boolean Returns true if this node defines a subtree within whichthe specified feature is supported, false otherwise.
since:
WD-DOM-Level-2-19990923 |
| item | | public Node item(int index)(Code) | | NodeList method: Return the Nth immediate child of this node, or
null if the index is out of bounds.
By default we do not have any children, ParentNode overrides this.
See Also: ParentNode org.w3c.dom.Node
Parameters:
index - int |
| lookupNamespaceURI | | public String lookupNamespaceURI(String specifiedPrefix)(Code) | | DOM Level 3 - Experimental:
Look up the namespace URI associated to the given prefix, starting from this node.
Use lookupNamespaceURI(null) to lookup the default namespace
Parameters:
specifiedPrefix - the URI for the namespace
since:
DOM Level 3 |
| lookupPrefix | | public String lookupPrefix(String namespaceURI)(Code) | | DOM Level 3 - Experimental:
Look up the prefix associated to the given namespace URI, starting from this node.
Parameters:
namespaceURI - the prefix for the namespace |
| needsSyncChildren | | final boolean needsSyncChildren()(Code) | | |
| needsSyncChildren | | final public void needsSyncChildren(boolean value)(Code) | | |
| needsSyncData | | final boolean needsSyncData()(Code) | | |
| needsSyncData | | final void needsSyncData(boolean value)(Code) | | |
| normalize | | public void normalize()(Code) | | Puts all Text nodes in the full depth of the sub-tree
underneath this Node, including attribute nodes, into a
"normal" form where only markup (e.g., tags, comments, processing
instructions, CDATA sections, and entity references) separates
Text nodes, i.e., there are no adjacent Text
nodes. This can be used to ensure that the DOM view of a document is
the same as if it were saved and re-loaded, and is useful when
operations (such as XPointer lookups) that depend on a particular
document tree structure are to be used.In cases where the document
contains CDATASections, the normalize operation alone may
not be sufficient, since XPointers do not differentiate between
Text nodes and CDATASection nodes.
Note that this implementation simply calls normalize() on this Node's
children. It is up to implementors or Node to override normalize()
to take action.
|
| ownerDocument | | CoreDocumentImpl ownerDocument()(Code) | | same as above but returns internal type and this one is not overridden
by CoreDocumentImpl to return null
|
| removeChild | | public Node removeChild(Node oldChild) throws DOMException(Code) | | Remove a child from this Node. The removed child's subtree
remains intact so it may be re-inserted elsewhere.
By default we do not have any children, ParentNode overrides this.
See Also: ParentNode oldChild, in its new state (removed).
throws:
DOMException - (NOT_FOUND_ERR) if oldChild is not a child ofthis node.
throws:
DOMException - (NO_MODIFICATION_ALLOWED_ERR) if this node isread-only. |
| replaceChild | | public Node replaceChild(Node newChild, Node oldChild) throws DOMException(Code) | | Make newChild occupy the location that oldChild used to
have. Note that newChild will first be removed from its previous
parent, if any. Equivalent to inserting newChild before oldChild,
then removing oldChild.
By default we do not have any children, ParentNode overrides this.
See Also: ParentNode oldChild, in its new state (removed).
throws:
DOMException - (HIERARCHY_REQUEST_ERR) if newChild is of atype that shouldn't be a child of this node, or if newChild isone of our ancestors.
throws:
DOMException - (WRONG_DOCUMENT_ERR) if newChild has adifferent owner document than we do.
throws:
DOMException - (NOT_FOUND_ERR) if oldChild is not a child ofthis node.
throws:
DOMException - (NO_MODIFICATION_ALLOWED_ERR) if this node isread-only. |
| setOwnerDocument | | protected void setOwnerDocument(CoreDocumentImpl doc)(Code) | | NON-DOM
set the ownerDocument of this node
|
| setPrefix | | public void setPrefix(String prefix) throws DOMException(Code) | | Introduced in DOM Level 2.
The namespace prefix of this node, or null if it is unspecified. When
this node is of any type other than ELEMENT_NODE and ATTRIBUTE_NODE
this is always null and setting it has no effect.
For nodes created with a DOM Level 1 method, such as createElement from
the Document interface, this is null.
Note that setting this attribute changes the nodeName attribute, which
holds the qualified name, as well as the tagName and name attributes of
the Element and Attr interfaces, when applicable.
throws:
INVALID_CHARACTER_ERR - Raised if the specifiedprefix contains an invalid character.
since:
WD-DOM-Level-2-19990923
See Also: AttrNSImpl
See Also: ElementNSImpl |
| setReadOnly | | public void setReadOnly(boolean readOnly, boolean deep)(Code) | | NON-DOM: PR-DOM-Level-1-19980818 mentions readonly nodes in conjunction
with Entities, but provides no API to support this.
Most DOM users should not touch this method. Its anticpated use
is during construction of EntityRefernces, where it will be used to
lock the contents replicated from Entity so they can't be casually
altered. It _could_ be published as a DOM extension, if desired.
Note: since we never have any children deep is meaningless here,
ParentNode overrides this behavior.
See Also: ParentNode
Parameters:
readOnly - True or false as desired.
Parameters:
deep - If true, children are also toggled. Note that this willnot change the state of an EntityReference or its children,which are always read-only. |
| setTextContent | | public void setTextContent(String textContent) throws DOMException(Code) | | This attribute returns the text content of this node and its
descendants. When it is defined to be null, setting it has no effect.
When set, any possible children this node may have are removed and
replaced by a single Text node containing the string
this attribute is set to. On getting, no serialization is performed,
the returned string does not contain any markup. No whitespace
normalization is performed, the returned string does not contain the
element content whitespaces . Similarly, on setting, no parsing is
performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node
depending on its type, as defined below:
| Node type |
Content |
|
ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE,
DOCUMENT_FRAGMENT_NODE |
concatenation of the textContent
attribute value of every child node, excluding COMMENT_NODE and
PROCESSING_INSTRUCTION_NODE nodes |
| ATTRIBUTE_NODE, TEXT_NODE,
CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE |
nodeValue |
| DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE |
null |
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
exception:
DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
since:
DOM Level 3 |
| setUserData | | public Object setUserData(String key, Object data, UserDataHandler handler)(Code) | | Associate an object to a key on this node. The object can later be
retrieved from this node by calling getUserData with the
same key.
Parameters:
key - The key to associate the object to.
Parameters:
data - The object to associate to the given key, or null to remove any existing association to that key.
Parameters:
handler - The handler to associate to that key, or null. Returns the DOMObject previously associated to the given key on this node, or null if there was none.
since:
DOM Level 3 |
| setUserData | | public void setUserData(Object data)(Code) | | NON-DOM: As an alternative to subclassing the DOM, this implementation
has been extended with the ability to attach an object to each node.
(If you need multiple objects, you can attach a collection such as a
vector or hashtable, then attach your application information to that.)
Important Note: You are responsible for removing references
to your data on nodes that are no longer used. Failure to do so will
prevent the nodes, your data is attached to, to be garbage collected
until the whole document is.
Parameters:
data - the object to store or null to remove any existing reference |
| synchronizeData | | protected void synchronizeData()(Code) | | Override this method in subclass to hook in efficient
internal data structure.
|
| toString | | public String toString()(Code) | | NON-DOM method for debugging convenience.
|
|
|
|