akasha

Class NodeIterator

java.lang.Object

akasha.NodeIterator

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="NodeIterator")
public class NodeIterator
extends java.lang.Object

The NodeIterator interface represents an iterator over the members of a list of the nodes in a subtree of the DOM. The nodes will be returned in document order.

See Also:

NodeIterator - MDN, NodeIterator - DOM, NodeIterator - Document Object Model (DOM) Level 2 Traversal and Range Specification

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodeIterator()

Method Summary

Modifier and Type	Method and Description
void	detach() The NodeIterator.detach() method is a no-op, kept for backward compatibility only.
NodeFilter	filter() The NodeIterator.filter read-only method returns a NodeFilter object, that is an object implement an acceptNode(node) method, used to screen nodes.
Node	nextNode() The NodeIterator.nextNode() method returns the next node in the set represented by the NodeIterator and advances the position of the iterator within the set.
boolean	pointerBeforeReferenceNode() The NodeIterator.pointerBeforeReferenceNode read-only property returns a Boolean flag that indicates whether the NodeFilter is anchored before (if this value is true) or after (if this value is false) the anchor node indicated by the NodeIterator.referenceNode property.
Node	previousNode() The NodeIterator.previousNode() method returns the previous node in the set represented by the NodeIterator and moves the position of the iterator backwards within the set.
Node	referenceNode() The NodeIterator.referenceNode read-only returns the Node to which the iterator is anchored; as new nodes are inserted, the iterator remains anchored to the reference node as specified by this property.
Node	root() The NodeIterator.root read-only property represents the Node that is the root of what the NodeIterator traverses.
int	whatToShow() The NodeIterator.whatToShow read-only property represents an unsigned integer representing a bitmask signifying what types of nodes should be returned by the NodeIterator.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeIterator

protected NodeIterator()

Method Detail

filter

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

The NodeIterator.filter read-only method returns a NodeFilter object, that is an object implement an acceptNode(node) method, used to screen nodes.

See Also:

NodeIterator.filter - MDN, NodeIterator.filter - DOM, NodeIterator.filter - Document Object Model (DOM) Level 2 Traversal and Range Specification

pointerBeforeReferenceNode

@JsProperty(name="pointerBeforeReferenceNode")
public boolean pointerBeforeReferenceNode()

The NodeIterator.pointerBeforeReferenceNode read-only property returns a Boolean flag that indicates whether the NodeFilter is anchored before (if this value is true) or after (if this value is false) the anchor node indicated by the NodeIterator.referenceNode property.

See Also:

NodeIterator.pointerBeforeReferenceNode - MDN

referenceNode

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

The NodeIterator.referenceNode read-only returns the Node to which the iterator is anchored; as new nodes are inserted, the iterator remains anchored to the reference node as specified by this property.

See Also:

NodeIterator.referenceNode - MDN

root

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

The NodeIterator.root read-only property represents the Node that is the root of what the NodeIterator traverses.

See Also:

NodeIterator.root - MDN

whatToShow

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

The NodeIterator.whatToShow read-only property represents an unsigned integer representing a bitmask signifying what types of nodes should be returned by the NodeIterator.

See Also:

NodeIterator.whatToShow - MDN

detach

public void detach()

The NodeIterator.detach() method is a no-op, kept for backward compatibility only.

See Also:

NodeIterator.detach - MDN

nextNode

@Nullable
public Node nextNode()

The NodeIterator.nextNode() method returns the next node in the set represented by the NodeIterator and advances the position of the iterator within the set. The first call to nextNode() returns the first node in the set.

See Also:

NodeIterator.nextNode - MDN

previousNode

@Nullable
public Node previousNode()

The NodeIterator.previousNode() method returns the previous node in the set represented by the NodeIterator and moves the position of the iterator backwards within the set.

See Also:

NodeIterator.previousNode - MDN