public abstract class ParentNode extends ChildNode
ParentNode, just like 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. On the other hand, subclasses may need to override this, in case of conflicting names. This is the case for the classes HTMLSelectElementImpl and HTMLFormElementImpl of the HTML DOM.
While we have a direct reference to the first child, the last child is stored as the previous sibling of the first child. First child nodes are marked as being so, and getNextSibling hides this fact.
Note: Not all parent nodes actually need to also be a child. At some point we used to have ParentNode inheriting from NodeImpl and another class called ChildAndParentNode that inherited from ChildNode. But due to the lack of multiple inheritance a lot of code had to be duplicated which led to a maintenance nightmare. At the same time only a few nodes (Document, DocumentFragment, Entity, and Attribute) cannot be a child so the gain in memory wasn't really worth it. The only type for which this would be the case is Attribute, but we deal with there in another special way, so this is not applicable.
This class doesn't directly support mutation events, however, it notifies the document when mutations are performed so that the document class do so.
WARNING: Some of the code here is partially duplicated in AttrImpl, be careful to keep these two classes in sync!
Modifier and Type | Field and Description |
---|---|
protected ChildNode |
firstChild
First child.
|
protected org.apache.xerces.dom.NodeListCache |
fNodeListCache
NodeList cache
|
protected CoreDocumentImpl |
ownerDocument
Owner document.
|
nextSibling, previousSibling
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
Modifier | Constructor and Description |
---|---|
|
ParentNode()
Constructor for serialization.
|
protected |
ParentNode(CoreDocumentImpl ownerDocument)
No public constructor; only subclasses of ParentNode should be
instantiated, and those normally via a Document's factory methods
|
Modifier and Type | Method and Description |
---|---|
Node |
cloneNode(boolean deep)
Returns a duplicate of a given node.
|
NodeList |
getChildNodes()
Obtain a NodeList enumerating all children of this node.
|
protected NodeList |
getChildNodesUnoptimized()
Create a NodeList to access children that is use by subclass elements
that have methods named getLength() or item(int).
|
Node |
getFirstChild()
The first child of this Node, or null if none.
|
Node |
getLastChild()
The last child of this Node, or null if none.
|
int |
getLength()
NodeList method: Count the immediate children of this node
|
Document |
getOwnerDocument()
Find the Document that this Node belongs to (the document in
whose context the Node was created).
|
String |
getTextContent()
This attribute returns the text content of this node and its
descendants.
|
boolean |
hasChildNodes()
Test whether this node has any children.
|
Node |
insertBefore(Node newChild,
Node refChild)
Move one or more node(s) to our list of children.
|
boolean |
isEqualNode(Node arg)
DOM Level 3 WD- Experimental.
|
Node |
item(int index)
NodeList method: Return the Nth immediate child of this node, or
null if the index is out of bounds.
|
void |
normalize()
Override default behavior to call normalize() on this Node's
children.
|
Node |
removeChild(Node oldChild)
Remove a child from this Node.
|
Node |
replaceChild(Node newChild,
Node oldChild)
Make newChild occupy the location that oldChild used to
have.
|
protected void |
setOwnerDocument(CoreDocumentImpl doc)
NON-DOM
set the ownerDocument of this node and its children
|
void |
setReadOnly(boolean readOnly,
boolean deep)
Override default behavior so that if deep is true, children are also
toggled.
|
void |
setTextContent(String textContent)
This attribute returns the text content of this node and its
descendants.
|
protected void |
synchronizeChildren()
Override this method in subclass to hook in efficient
internal data structure.
|
getNextSibling, getParentNode, getPreviousSibling
addEventListener, appendChild, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getAttributes, getBaseURI, getContainer, getFeature, getLocalName, getNamespaceURI, getNodeName, getNodeNumber, getNodeType, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, getUserDataRecord, hasAttributes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setPrefix, setUserData, setUserData, synchronizeData, toString
protected CoreDocumentImpl ownerDocument
protected ChildNode firstChild
protected transient org.apache.xerces.dom.NodeListCache fNodeListCache
protected ParentNode(CoreDocumentImpl ownerDocument)
public ParentNode()
public Node cloneNode(boolean deep)
Example: Cloning a Text node will copy both the node and the text it contains.
Example: Cloning something that has children -- Element or Attr, for example -- will _not_ clone those children unless a "deep clone" has been requested. A shallow clone of an Attr node will yield an empty Attr of the same name.
NOTE: Clones will always be read/write, even if the node being cloned is read-only, to permit applications using only the DOM API to obtain editable copies of locked portions of the tree.
cloneNode
in interface Node
cloneNode
in class ChildNode
Example: Cloning a Text node will copy both the node and the text it
contains.
Example: Cloning something that has children -- Element or Attr, for
example -- will _not_ clone those children unless a "deep clone"
has been requested. A shallow clone of an Attr node will yield an
empty Attr of the same name.
NOTE: Clones will always be read/write, even if the node being cloned
is read-only, to permit applications using only the DOM API to obtain
editable copies of locked portions of the tree.
public Document getOwnerDocument()
getOwnerDocument
in interface Node
getOwnerDocument
in class NodeImpl
protected void setOwnerDocument(CoreDocumentImpl doc)
setOwnerDocument
in class NodeImpl
public boolean hasChildNodes()
hasChildNodes
in interface Node
hasChildNodes
in class NodeImpl
ParentNode
public NodeList getChildNodes()
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.
getChildNodes
in interface Node
getChildNodes
in class NodeImpl
public Node getFirstChild()
getFirstChild
in interface Node
getFirstChild
in class NodeImpl
ParentNode
public Node getLastChild()
getLastChild
in interface Node
getLastChild
in class NodeImpl
ParentNode
public Node insertBefore(Node newChild, Node refChild) throws DOMException
insertBefore
in interface Node
insertBefore
in class NodeImpl
newChild
- The Node to be moved to our subtree. As a
convenience feature, inserting a DocumentNode will instead insert
all its children.refChild
- Current child which newChild should be placed
immediately before. If refChild is null, the insertion occurs
after all existing Nodes, like appendChild().DOMException(HIERARCHY_REQUEST_ERR)
- if newChild is of a
type that shouldn't be a child of this node, or if newChild is an
ancestor of this node.DOMException(WRONG_DOCUMENT_ERR)
- if newChild has a
different owner document than we do.DOMException(NOT_FOUND_ERR)
- if refChild is not a child of
this node.DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if this node is
read-only.DOMException
ParentNode
public Node removeChild(Node oldChild) throws DOMException
removeChild
in interface Node
removeChild
in class NodeImpl
DOMException(NOT_FOUND_ERR)
- if oldChild is not a child of
this node.DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if this node is
read-only.DOMException
ParentNode
public Node replaceChild(Node newChild, Node oldChild) throws DOMException
replaceChild
in interface Node
replaceChild
in class NodeImpl
DOMException(HIERARCHY_REQUEST_ERR)
- if newChild is of a
type that shouldn't be a child of this node, or if newChild is
one of our ancestors.DOMException(WRONG_DOCUMENT_ERR)
- if newChild has a
different owner document than we do.DOMException(NOT_FOUND_ERR)
- if oldChild is not a child of
this node.DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if this node is
read-only.DOMException
ParentNode
public String getTextContent() throws DOMException
NodeImpl
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.
Node type | Content |
---|
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 |
getTextContent
in interface Node
getTextContent
in class NodeImpl
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.public void setTextContent(String textContent) throws DOMException
NodeImpl
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.
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 |
setTextContent
in interface Node
setTextContent
in class NodeImpl
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.public int getLength()
getLength
in interface NodeList
getLength
in class NodeImpl
ParentNode
public Node item(int index)
item
in interface NodeList
item
in class NodeImpl
index
- intParentNode
protected final NodeList getChildNodesUnoptimized()
To use this method, the subclass should implement getChildNodes() and have it call this method. The resulting NodeList instance maybe shared and cached in a transient field, but the cached value must be cleared if the node is cloned.
public void normalize()
public boolean isEqualNode(Node arg)
isEqualNode
in interface Node
isEqualNode
in class NodeImpl
arg
- The node to compare equality with.true
otherwise false
.public void setReadOnly(boolean readOnly, boolean deep)
setReadOnly
in class NodeImpl
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.
Note: this will not change the state of an EntityReference or its
children, which are always read-only.
protected void synchronizeChildren()
Copyright © 2017 JBoss by Red Hat. All rights reserved.