akasha

Class TreeWalker

java.lang.Object

akasha.core.JsObject

akasha.TreeWalker

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="TreeWalker")
public class TreeWalker
extends JsObject

The TreeWalker object represents the nodes of a document subtree and a position within them.

See Also:

TreeWalker - MDN, (DOM) # interface-treewalker

Field Summary

Fields

Modifier and Type	Field and Description
Node	currentNode The TreeWalker.currentNode property represents the Node on which the TreeWalker is currently pointing at.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TreeWalker()

Method Summary

Modifier and Type	Method and Description
NodeFilter	filter() The TreeWalker.filter read-only property returns a NodeFilter that is the filtering object associated with the TreeWalker.
Node	firstChild() The TreeWalker.firstChild() method moves the current Node to the first visible child of the current node, and returns the found child.
Node	lastChild() The TreeWalker.lastChild() method moves the current Node to the last visible child of the current node, and returns the found child.
Node	nextNode() The TreeWalker.nextNode() method moves the current Node to the next visible node in the document order, and returns the found node.
Node	nextSibling() The TreeWalker.nextSibling() method moves the current Node to its next sibling, if any, and returns the found sibling.
Node	parentNode() The TreeWalker.parentNode() method moves the current Node to the first visible ancestor node in the document order, and returns the found node.
Node	previousNode() The TreeWalker.previousNode() method moves the current Node to the previous visible node in the document order, and returns the found node.
Node	previousSibling() The TreeWalker.previousSibling() method moves the current Node to its previous sibling, if any, and returns the found sibling.
Node	root() The TreeWalker.root read-only property returns the node that is the root of what the TreeWalker traverses.
int	whatToShow() The TreeWalker.whatToShow read-only property returns an unsigned long being a bitmask made of constants describing the types of Node that must to be presented.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

currentNode

@Nonnull
public Node currentNode

The TreeWalker.currentNode property represents the Node on which the TreeWalker is currently pointing at.

See Also:

TreeWalker.currentNode - MDN

Constructor Detail

TreeWalker

protected TreeWalker()

Method Detail

filter

@JsProperty(name="filter")
 @Nullable
public NodeFilter filter()

The TreeWalker.filter read-only property returns a NodeFilter that is the filtering object associated with the TreeWalker.

See Also:

TreeWalker.filter - MDN

root

@JsProperty(name="root")
 @Nonnull
public Node root()

The TreeWalker.root read-only property returns the node that is the root of what the TreeWalker traverses.

See Also:

TreeWalker.root - MDN

whatToShow

@JsProperty(name="whatToShow")
public int whatToShow()

The TreeWalker.whatToShow read-only property returns an unsigned long being a bitmask made of constants describing the types of Node that must to be presented. Non-matching nodes are skipped, but their children may be included, if relevant. The possible values are:

See Also:

TreeWalker.whatToShow - MDN

firstChild

@Nullable
public Node firstChild()

The TreeWalker.firstChild() method moves the current Node to the first visible child of the current node, and returns the found child. It also moves the current node to this child. If no such child exists, returns null and the current node is not changed.

See Also:

TreeWalker.firstChild - MDN

lastChild

@Nullable
public Node lastChild()

The TreeWalker.lastChild() method moves the current Node to the last visible child of the current node, and returns the found child. It also moves the current node to this child. If no such child exists, returns null and the current node is not changed.

See Also:

TreeWalker.lastChild - MDN

nextNode

@Nullable
public Node nextNode()

The TreeWalker.nextNode() method moves the current Node to the next visible node in the document order, and returns the found node. It also moves the current node to this one. If no such node exists, returns null and the current node is not changed.

See Also:

TreeWalker.nextNode - MDN

nextSibling

@Nullable
public Node nextSibling()

The TreeWalker.nextSibling() method moves the current Node to its next sibling, if any, and returns the found sibling. If there is no such node, return null and the current node is not changed.

See Also:

TreeWalker.nextSibling - MDN

parentNode

@Nullable
public Node parentNode()

The TreeWalker.parentNode() method moves the current Node to the first visible ancestor node in the document order, and returns the found node. If no such node exists, or if it is above the TreeWalker's root node, returns null and the current node is not changed.

See Also:

TreeWalker.parentNode - MDN

previousNode

@Nullable
public Node previousNode()

The TreeWalker.previousNode() method moves the current Node to the previous visible node in the document order, and returns the found node. It also moves the current node to this one. If no such node exists,or if it is before that the root node defined at the object construction, returns null and the current node is not changed.

See Also:

TreeWalker.previousNode - MDN

previousSibling

@Nullable
public Node previousSibling()

The TreeWalker.previousSibling() method moves the current Node to its previous sibling, if any, and returns the found sibling. If there is no such node, return null and the current node is not changed.

See Also:

TreeWalker.previousSibling - MDN