Package org.htmlunit.html

Class DomNodeIterator

java.lang.Object

org.htmlunit.html.DomNodeIterator

All Implemented Interfaces:

org.w3c.dom.traversal.NodeIterator

public class DomNodeIterator
extends java.lang.Object
implements org.w3c.dom.traversal.NodeIterator

An implementation of NodeIterator.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	expandEntityReferences_
private org.w3c.dom.traversal.NodeFilter	filter_
private boolean	pointerBeforeReferenceNode_
private DomNode	referenceNode_
private DomNode	root_
private int	whatToShow_

Constructor Summary

Constructors

Constructor	Description
DomNodeIterator(DomNode root, int whatToShow, org.w3c.dom.traversal.NodeFilter filter, boolean expandEntityReferences)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	detach()
private static DomNode	getChild(DomNode node, boolean lookLeft)
boolean	getExpandEntityReferences()
org.w3c.dom.traversal.NodeFilter	getFilter()
private DomNode	getFirstUncleNode(DomNode node)	Helper method to get the first uncle node in document order (preorder traversal) from the given node.
DomNode	getRoot()
private static DomNode	getSibling(DomNode node, boolean lookLeft)
int	getWhatToShow()
private boolean	isAccepted(org.w3c.dom.Node node)
private boolean	isNodeVisible(org.w3c.dom.Node node)
boolean	isPointerBeforeReferenceNode()	Returns whether the NodeIterator is anchored before, or after the node.
DomNode	nextNode()
DomNode	previousNode()
private DomNode	traverse(boolean next)

Methods inherited from class java.lang.Object

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

Field Detail

root_

private final DomNode root_

whatToShow_

private final int whatToShow_

filter_

private final org.w3c.dom.traversal.NodeFilter filter_

referenceNode_

private DomNode referenceNode_

expandEntityReferences_

private final boolean expandEntityReferences_

pointerBeforeReferenceNode_

private boolean pointerBeforeReferenceNode_

Constructor Detail

DomNodeIterator

public DomNodeIterator(DomNode root,
                       int whatToShow,
                       org.w3c.dom.traversal.NodeFilter filter,
                       boolean expandEntityReferences)

Creates a new instance.

Parameters:

root - The root node at which to begin the NodeIterator's traversal

whatToShow - an optional int representing a bitmask created by combining the constant properties of NodeFilter

expandEntityReferences - If false, the contents of EntityReference nodes are not present in the logical view.

filter - an object implementing the NodeFilter interface

Method Detail

getRoot

public DomNode getRoot()

Specified by:

getRoot in interface org.w3c.dom.traversal.NodeIterator

getWhatToShow

public int getWhatToShow()

Specified by:

getWhatToShow in interface org.w3c.dom.traversal.NodeIterator

getExpandEntityReferences

public boolean getExpandEntityReferences()

Specified by:

getExpandEntityReferences in interface org.w3c.dom.traversal.NodeIterator

getFilter

public org.w3c.dom.traversal.NodeFilter getFilter()

Specified by:

getFilter in interface org.w3c.dom.traversal.NodeIterator

isPointerBeforeReferenceNode

public boolean isPointerBeforeReferenceNode()

Returns whether the NodeIterator is anchored before, or after the node.

Returns:

whether it is anchored before or after the node

detach

public void detach()

Specified by:

detach in interface org.w3c.dom.traversal.NodeIterator

nextNode

public DomNode nextNode()

Specified by:

nextNode in interface org.w3c.dom.traversal.NodeIterator

previousNode

public DomNode previousNode()

Specified by:

previousNode in interface org.w3c.dom.traversal.NodeIterator

traverse

private DomNode traverse(boolean next)

isNodeVisible

private boolean isNodeVisible(org.w3c.dom.Node node)

isAccepted

private boolean isAccepted(org.w3c.dom.Node node)

getFirstUncleNode

private DomNode getFirstUncleNode(DomNode node)

Helper method to get the first uncle node in document order (preorder traversal) from the given node.

getChild

private static DomNode getChild(DomNode node,
                                boolean lookLeft)

getSibling

private static DomNode getSibling(DomNode node,
                                  boolean lookLeft)