Class NodeIterator

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.htmlunit.corejs.javascript.ConstProperties, org.htmlunit.corejs.javascript.debug.DebuggableObject, org.htmlunit.corejs.javascript.Scriptable, org.htmlunit.corejs.javascript.SymbolScriptable

    public class NodeIterator
    extends HtmlUnitScriptable
    A JavaScript object for NodeIterator.
    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.htmlunit.corejs.javascript.ScriptableObject

        org.htmlunit.corejs.javascript.ScriptableObject.KeyComparator
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private DomNodeIterator iterator_  
      • Fields inherited from class org.htmlunit.corejs.javascript.ScriptableObject

        CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST
      • Fields inherited from interface org.htmlunit.corejs.javascript.Scriptable

        NOT_FOUND
    • Constructor Summary

      Constructors 
      Constructor Description
      NodeIterator()
      Creates an instance.
      NodeIterator​(Node root, int whatToShow, org.w3c.dom.traversal.NodeFilter filter)
      Creates a new instance.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void detach()
      This operation is a no-op.
      java.lang.Object getFilter()
      Returns the filter.
      private static Node getNodeOrNull​(DomNode domNode)  
      Node getRoot()
      Returns the root node.
      long getWhatToShow()
      Returns the types of nodes being presented.
      void jsConstructor()
      JavaScript constructor.
      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 org.htmlunit.corejs.javascript.ScriptableObject

        applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, 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​(Node root,
                            int whatToShow,
                            org.w3c.dom.traversal.NodeFilter filter)
        Creates a new instance.
        Parameters:
        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

      • jsConstructor

        public void jsConstructor()
        JavaScript constructor.
      • getRoot

        public Node getRoot()
        Returns the root node.
        Returns:
        the root node
      • getNodeOrNull

        private static Node getNodeOrNull​(DomNode domNode)
      • getWhatToShow

        public long getWhatToShow()
        Returns the types of nodes being presented.
        Returns:
        combined bitmask of NodeFilter
      • getFilter

        public java.lang.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