org.kde.koala
public class TreeWalker extends Object implements QtSupport
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.UNKNOWN: 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
.
Constructor Summary | |
---|---|
protected | TreeWalker(Class dummy) |
TreeWalker() | |
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. |
UNKNOWN: The node at which the TreeWalker is currently positioned.
UNKNOWN: The value of this flag determines whether the children of entity reference nodes are visible to the TreeWalker.
UNKNOWN: The filter used to screen nodes.
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.Returns: The new node, or null
if the current
node has no children.
UNKNOWN: Moves the TreeWalker
to the first child of the current node, and returns the new node.
UNKNOWN:
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.Returns: The new node, or null
if the current
node has no children.
UNKNOWN: Moves the TreeWalker
to the last child of the current node, and returns the new node.
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.Returns: The new node, or null
if the current
node has no next node.
UNKNOWN: Moves the TreeWalker
to the next node in document order relative to the current node, and returns the new node.
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.Returns: The new node, or null
if the current
node has no next sibling.
UNKNOWN: Moves the TreeWalker
to the next sibling of the current node, and returns the new node.
Returns: The new parent node, or null if the current node has no parent in the TreeWalker's logical view.
UNKNOWN: Moves to and returns the parent node of the current node.
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.Returns: The new node, or null
if the current
node has no previous node.
UNKNOWN: Moves the TreeWalker
to the previous node in document order relative to the current node, and returns the new node.
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.Returns: The new node, or null
if the current
node has no previous sibling.
UNKNOWN: Moves the TreeWalker
to the previous sibling of the current node, and returns the new node.
UNKNOWN: The root node of the TreeWalker, as specified when it was created.
UNKNOWN: see currentNode
UNKNOWN: This attribute determines which node types are presented via the TreeWalker.