com.gargoylesoftware.htmlunit.javascript.host.dom

Class NodeIterator

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.dom.NodeIterator

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable, net.sourceforge.htmlunit.corejs.javascript.SymbolScriptable

public class NodeIterator
extends SimpleScriptable

A JavaScript object for NodeIterator.

Author:

Ahmed Ashour, Ronald Brill

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
NodeIterator() Creates an instance.
NodeIterator(SgmlPage page, Node root, int whatToShow, org.w3c.dom.traversal.NodeFilter filter) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	detach() This operation is a no-op.
Object	getFilter() Returns the filter.
Node	getRoot() Returns the root node.
long	getWhatToShow() Returns the types of nodes being presented.
Node	nextNode() Returns the next Node in the document, or null if there are none.
Node	previousNode() Returns the previous Node in the document, or null if there are none.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

clone, equivalentValues, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

defineFunctionProperties, defineProperty, getClassName, put, setClassName, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeIterator

public NodeIterator()

Creates an instance.

NodeIterator

public NodeIterator(SgmlPage page,
                    Node root,
                    int whatToShow,
                    org.w3c.dom.traversal.NodeFilter filter)

Creates a new instance.

Parameters:

page - the page

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

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

filter - an object implementing the NodeFilter interface

Method Detail

getRoot

public Node getRoot()

Returns the root node.

Returns:

the root node

getWhatToShow

public long getWhatToShow()

Returns the types of nodes being presented.

Returns:

combined bitmask of NodeFilter

getFilter

public Object getFilter()

Returns the filter.

Returns:

the filter

detach

public void detach()

This operation is a no-op.

nextNode

public Node nextNode()

Returns the next Node in the document, or null if there are none.

Returns:

the next node

previousNode

public Node previousNode()

Returns the previous Node in the document, or null if there are none.

Returns:

the previous node