com.aspose.html.dom.traversal

Interface ITreeWalker

All Superinterfaces:

com.aspose.ms.System.IDisposable, ITraversal

@DOMObjectAttribute
 @DOMNameAttribute(name="TreeWalker")
public interface ITreeWalker
extends ITraversal, com.aspose.ms.System.IDisposable

Method Summary

Modifier and Type	Method and Description
Node	firstChild() Moves the TreeWalker to the first visible child of the current node, and returns the new node.
Node	getCurrentNode() The node at which the TreeWalker is currently positioned.
Node	lastChild() Moves the TreeWalker to the last visible child of the current node, and returns the new node.
Node	nextNode() Moves the TreeWalker to the next visible 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 closest visible ancestor node of the current node.
Node	previousNode() Moves the TreeWalker to the previous visible 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.
void	setCurrentNode(Node value) The node at which the TreeWalker is currently positioned.

Methods inherited from interface com.aspose.html.dom.traversal.ITraversal

getFilter, getRoot, getWhatToShow

Methods inherited from interface com.aspose.ms.System.IDisposable

dispose

Method Detail

getCurrentNode

@DOMNameAttribute(name="currentNode")
Node getCurrentNode()

The node at which the TreeWalker is currently positioned. Alterations to the DOM tree may cause the current node to no longer be accepted by the TreeWalker's associated filter. currentNode may also be explicitly set to any node, whether or not it is within the subtree specified by the root node or would be accepted by the filter and whatToShow flags. Further traversal occurs relative to currentNode even if it is not part of the current view, by applying the filters in the requested direction; if no traversal is possible, currentNode is not changed.

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised if an attempt is made to set currentNode to null. Value: The current node.

setCurrentNode

@DOMNameAttribute(name="currentNode")
void setCurrentNode(Node value)

The node at which the TreeWalker is currently positioned. Alterations to the DOM tree may cause the current node to no longer be accepted by the TreeWalker's associated filter. currentNode may also be explicitly set to any node, whether or not it is within the subtree specified by the root node or would be accepted by the filter and whatToShow flags. Further traversal occurs relative to currentNode even if it is not part of the current view, by applying the filters in the requested direction; if no traversal is possible, currentNode is not changed.

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised if an attempt is made to set currentNode to null. Value: The current node.

parentNode

@DOMNameAttribute(name="parentNode")
Node parentNode()

Moves to and returns the closest visible ancestor node of the current node. If the search for parentNode attempts to step upward from the TreeWalker's root node, or if it fails to find a visible ancestor node, this method retains the current position and returns null.

Returns:

The new parent node, or null if the current node has no parent in the TreeWalker's logical view.

firstChild

@DOMNameAttribute(name="firstChild")
Node firstChild()

Moves the TreeWalker to the first visible child of the current node, and returns the new node. If the current node has no visible children, returns null, and retains the current node.

Returns:

The new node, or null if the current node has no visible children in the TreeWalker's logical view.

lastChild

@DOMNameAttribute(name="lastChild")
Node lastChild()

Moves the TreeWalker to the last visible child of the current node, and returns the new node. If the current node has no visible children, returns null, and retains the current node.

Returns:

The new node, or null if the current node has no children in the TreeWalker's logical view.

previousSibling

@DOMNameAttribute(name="previousSibling")
Node previousSibling()

Moves the TreeWalker to the previous sibling of the current node, and returns the new node. If the current node has no visible previous sibling, returns null, and retains the current node.

Returns:

The new node, or null if the current node has no previous sibling. in the TreeWalker's logical view.

nextSibling

@DOMNameAttribute(name="nextSibling")
Node nextSibling()

Moves the TreeWalker to the next sibling of the current node, and returns the new node. If the current node has no visible next sibling, returns null, and retains the current node.

Returns:

The new node, or null if the current node has no next sibling. in the TreeWalker's logical view.

previousNode

@DOMNameAttribute(name="previousNode")
Node previousNode()

Moves the TreeWalker to the previous visible node in document order relative to the current node, and returns the new node. If the current node has no previous node, or if the search for previousNode attempts to step upward from the TreeWalker's root node, returns null, and retains the current node.

Returns:

The new node, or null if the current node has no previous node in the TreeWalker's logical view.

nextNode

@DOMNameAttribute(name="nextNode")
Node nextNode()

Moves the TreeWalker to the next visible node in document order relative to the current node, and returns the new node. If the current node has no next node, or if the search for nextNode attempts to step upward from the TreeWalker's root node, returns null, and retains the current node.

Returns:

The new node, or null if the current node has no next node in the TreeWalker's logical view.