Package org.apache.batik.dom.traversal
Class DOMNodeIterator
java.lang.Object
org.apache.batik.dom.traversal.DOMNodeIterator
- All Implemented Interfaces:
NodeIterator
This class implements the
NodeIterator
interface.- Version:
- $Id: DOMNodeIterator.java 1733416 2016-03-03 07:07:13Z gadams $
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final short
The backward state.protected AbstractDocument
The document which created the iterator.protected boolean
Whether the children of entity reference nodes are visible to the iterator.protected NodeFilter
The NodeFilter used to screen nodes.protected static final short
The forward state.protected static final short
The initial state.protected static final short
The invalid state.protected Node
The reference node.protected Node
The root node.protected short
The iterator state.protected int
Which node types are presented via the iterator. -
Constructor Summary
ConstructorsConstructorDescriptionDOMNodeIterator
(AbstractDocument doc, Node n, int what, NodeFilter nf, boolean exp) Creates a new NodeIterator object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
detach()
DOM: ImplementsNodeIterator.detach()
.boolean
DOM: ImplementsNodeIterator.getExpandEntityReferences()
.DOM: ImplementsNodeIterator.getFilter()
.getRoot()
DOM: ImplementsNodeIterator.getRoot()
.int
DOM: ImplementsNodeIterator.getWhatToShow()
.nextNode()
DOM: ImplementsNodeIterator.nextNode()
.void
nodeToBeRemoved
(Node removedNode) Called by the DOM when a node will be removed from the current document.DOM: ImplementsNodeIterator.previousNode()
.protected void
Sets the reference node to the next node, unfiltered.protected void
Sets the reference node to the previous node, unfiltered.
-
Field Details
-
INITIAL
protected static final short INITIALThe initial state.- See Also:
-
INVALID
protected static final short INVALIDThe invalid state.- See Also:
-
FORWARD
protected static final short FORWARDThe forward state.- See Also:
-
BACKWARD
protected static final short BACKWARDThe backward state.- See Also:
-
document
The document which created the iterator. -
root
The root node. -
whatToShow
protected int whatToShowWhich node types are presented via the iterator. -
filter
The NodeFilter used to screen nodes. -
expandEntityReferences
protected boolean expandEntityReferencesWhether the children of entity reference nodes are visible to the iterator. -
state
protected short stateThe iterator state. -
referenceNode
The reference node.
-
-
Constructor Details
-
DOMNodeIterator
Creates a new NodeIterator object.- Parameters:
doc
- The document which created the tree walker.n
- The root node.what
- Which node types are presented via the iterator.nf
- The NodeFilter used to screen nodes.exp
- Whether the children of entity reference nodes are visible to the iterator.
-
-
Method Details
-
getRoot
DOM: ImplementsNodeIterator.getRoot()
.- Specified by:
getRoot
in interfaceNodeIterator
-
getWhatToShow
public int getWhatToShow()DOM: ImplementsNodeIterator.getWhatToShow()
.- Specified by:
getWhatToShow
in interfaceNodeIterator
-
getFilter
DOM: ImplementsNodeIterator.getFilter()
.- Specified by:
getFilter
in interfaceNodeIterator
-
getExpandEntityReferences
public boolean getExpandEntityReferences()DOM: ImplementsNodeIterator.getExpandEntityReferences()
.- Specified by:
getExpandEntityReferences
in interfaceNodeIterator
-
nextNode
DOM: ImplementsNodeIterator.nextNode()
.- Specified by:
nextNode
in interfaceNodeIterator
-
previousNode
DOM: ImplementsNodeIterator.previousNode()
.- Specified by:
previousNode
in interfaceNodeIterator
-
detach
public void detach()DOM: ImplementsNodeIterator.detach()
.- Specified by:
detach
in interfaceNodeIterator
-
nodeToBeRemoved
Called by the DOM when a node will be removed from the current document. -
unfilteredNextNode
protected void unfilteredNextNode()Sets the reference node to the next node, unfiltered. -
unfilteredPreviousNode
protected void unfilteredPreviousNode()Sets the reference node to the previous node, unfiltered.
-