|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.kde.koala.TreeWalker
public class TreeWalker
TreeWalker
objects are used to navigate a document
tree or subtree using the view of the document defined by its
whatToShow
flags and any filters that are defined
for the TreeWalker
. Any function which performs
navigation using a TreeWalker
will automatically
support any view defined by a TreeWalker
.
Omitting nodes from the logical view of a subtree can result in a
structure that is substantially different from the same subtree in
the complete, unfiltered document. Nodes that are siblings in the
TreeWalker view may be children of different, widely separated
nodes in the original view. For instance, consider a Filter that
skips all nodes except for Text nodes and the root node of a
document. In the logical view that results, all text nodes will be
siblings and appear as direct children of the root node, no matter
how deeply nested the structure of the original document.
Constructor Summary | |
---|---|
|
TreeWalker()
|
protected |
TreeWalker(java.lang.Class dummy)
|
|
TreeWalker(TreeWalker other)
|
Method Summary | |
---|---|
Node |
currentNode()
The node at which the TreeWalker is currently positioned. |
boolean |
expandEntityReferences()
The value of this flag determines whether the children of entity reference nodes are visible to the TreeWalker. |
NodeFilter |
filter()
The filter used to screen nodes. |
Node |
firstChild()
Moves the TreeWalker to the first child of the
current node, and returns the new node. |
boolean |
isNull()
not part of the DOM |
Node |
lastChild()
Moves the TreeWalker to the last child of the
current node, and returns the new node. |
Node |
nextNode()
Moves the TreeWalker to the next node in
document order relative to the current node, and returns the
new node. |
Node |
nextSibling()
Moves the TreeWalker to the next sibling of the
current node, and returns the new node. |
Node |
parentNode()
Moves to and returns the parent node of the current node. |
Node |
previousNode()
Moves the TreeWalker to the previous node in
document order relative to the current node, and returns the
new node. |
Node |
previousSibling()
Moves the TreeWalker to the previous sibling of
the current node, and returns the new node. |
Node |
root()
The root node of the TreeWalker, as specified when it was created. |
void |
setCurrentNode(Node _currentNode)
see currentNode |
long |
whatToShow()
This attribute determines which node types are presented via the TreeWalker. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected TreeWalker(java.lang.Class dummy)
public TreeWalker()
public TreeWalker(TreeWalker other)
Method Detail |
---|
public Node root()
public long whatToShow()
public NodeFilter filter()
public boolean expandEntityReferences()
public Node currentNode()
public void setCurrentNode(Node _currentNode)
public Node parentNode()
public Node firstChild()
TreeWalker
to the first child of the
current node, and returns the new node. If the current node has
no children, returns null
, and retains the
current node.
null
if the current
node has no children.public Node lastChild()
TreeWalker
to the last child of the
current node, and returns the new node. If the current node has
no children, returns null
, and retains the
current node.
null
if the current
node has no children.public Node previousSibling()
TreeWalker
to the previous sibling of
the current node, and returns the new node. If the current node
has no previous sibling, returns null
, and
retains the current node.
null
if the current
node has no previous sibling.public Node nextSibling()
TreeWalker
to the next sibling of the
current node, and returns the new node. If the current node has
no next sibling, returns null
, and retains the
current node.
null
if the current
node has no next sibling.public Node previousNode()
TreeWalker
to the previous node in
document order relative to the current node, and returns the
new node. If the current node has no previous node, returns
null
, and retains the current node.
null
if the current
node has no previous node.public Node nextNode()
TreeWalker
to the next node in
document order relative to the current node, and returns the
new node. If the current node has no next node, returns
null
, and retains the current node.
null
if the current
node has no next node.public boolean isNull()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |