Package org.apache.batik.dom.traversal

Class DOMTreeWalker

java.lang.Object
org.apache.batik.dom.traversal.DOMTreeWalker
All Implemented Interfaces:
org.w3c.dom.traversal.TreeWalker
public class DOMTreeWalker extends Object implements org.w3c.dom.traversal.TreeWalker
This class implements the NodeIterator interface.

  • Field Details

    • root

      protected Node root
      The root node.

    • whatToShow

      protected int whatToShow
      Which node types are presented via the iterator.

    • filter

      protected org.w3c.dom.traversal.NodeFilter filter
      The NodeFilter used to screen nodes.

    • expandEntityReferences

      protected boolean expandEntityReferences
      Whether the children of entity reference nodes are visible to the iterator.

    • currentNode

      protected Node currentNode
      The current node.

  • Constructor Details

    • DOMTreeWalker

      public DOMTreeWalker(Node n, int what, org.w3c.dom.traversal.NodeFilter nf, boolean exp)
      Creates a new TreeWalker object.
      Parameters:
      n - The root node.
      what - Which node types are presented via the iterator.
      nf - The NodeFilter used to screen nodes.
      exp - Whether the children of entity reference nodes are visible to the tree walker.

  • Method Details

    • getRoot

      public Node getRoot()
      DOM: Implements TreeWalker.getRoot().
      Specified by:
      getRoot in interface org.w3c.dom.traversal.TreeWalker

    • getWhatToShow

      public int getWhatToShow()
      DOM: Implements TreeWalker.getWhatToShow().
      Specified by:
      getWhatToShow in interface org.w3c.dom.traversal.TreeWalker

    • getFilter

      public org.w3c.dom.traversal.NodeFilter getFilter()
      DOM: Implements TreeWalker.getFilter().
      Specified by:
      getFilter in interface org.w3c.dom.traversal.TreeWalker

    • getExpandEntityReferences

      public boolean getExpandEntityReferences()
      DOM: Implements TreeWalker.getExpandEntityReferences().
      Specified by:
      getExpandEntityReferences in interface org.w3c.dom.traversal.TreeWalker

    • getCurrentNode

      public Node getCurrentNode()
      DOM: Implements TreeWalker.getCurrentNode().
      Specified by:
      getCurrentNode in interface org.w3c.dom.traversal.TreeWalker

    • setCurrentNode

      public void setCurrentNode(Node n)
      DOM: Implements TreeWalker.setCurrentNode(Node).
      Specified by:
      setCurrentNode in interface org.w3c.dom.traversal.TreeWalker

    • parentNode

      public Node parentNode()
      DOM: Implements TreeWalker.parentNode().
      Specified by:
      parentNode in interface org.w3c.dom.traversal.TreeWalker

    • firstChild

      public Node firstChild()
      DOM: Implements TreeWalker.firstChild().
      Specified by:
      firstChild in interface org.w3c.dom.traversal.TreeWalker

    • lastChild

      public Node lastChild()
      DOM: Implements TreeWalker.lastChild().
      Specified by:
      lastChild in interface org.w3c.dom.traversal.TreeWalker

    • previousSibling

      public Node previousSibling()
      DOM: Implements TreeWalker.previousSibling().
      Specified by:
      previousSibling in interface org.w3c.dom.traversal.TreeWalker

    • nextSibling

      public Node nextSibling()
      DOM: Implements TreeWalker.nextSibling().
      Specified by:
      nextSibling in interface org.w3c.dom.traversal.TreeWalker

    • previousNode

      public Node previousNode()
      DOM: Implements TreeWalker.previousNode().
      Specified by:
      previousNode in interface org.w3c.dom.traversal.TreeWalker

    • nextNode

      public Node nextNode()
      DOM: Implements TreeWalker.nextNode().
      Specified by:
      nextNode in interface org.w3c.dom.traversal.TreeWalker

    • parentNode

      protected Node parentNode(Node n)
      Returns the parent node of the given node.

    • firstChild

      protected Node firstChild(Node n)
      Returns the first child of the given node.

    • lastChild

      protected Node lastChild(Node n)
      Returns the last child of the given node.

    • previousSibling

      protected Node previousSibling(Node n, Node root)
      Returns the previous sibling of the given node.

    • nextSibling

      protected Node nextSibling(Node n, Node root)
      Returns the next sibling of the given node.

    • acceptNode

      protected short acceptNode(Node n)
      Whether or not the given node is accepted by this tree walker.