Class GVTTreeWalker

java.lang.Object
org.apache.batik.gvt.GVTTreeWalker

public class GVTTreeWalker extends Object
GVTTreeWalker objects are used to navigate a GVT tree or subtree.
  • Field Details

    • gvtRoot

      protected GraphicsNode gvtRoot
      The GVT root into which text is searched.
    • treeRoot

      protected GraphicsNode treeRoot
      The root of the subtree of the GVT which is traversed.
    • currentNode

      protected GraphicsNode currentNode
      The current GraphicsNode.
  • Constructor Details

    • GVTTreeWalker

      public GVTTreeWalker(GraphicsNode treeRoot)
      Constructs a new GVTTreeWalker.
      Parameters:
      treeRoot - the top of the graphics node tree to search
  • Method Details

    • getRoot

      public GraphicsNode getRoot()
      Returns the root graphics node.
    • getGVTRoot

      public GraphicsNode getGVTRoot()
      Returns the GVT root graphics node.
    • setCurrentGraphicsNode

      public void setCurrentGraphicsNode(GraphicsNode node)
      Sets the current GraphicsNode to the specified node.
      Parameters:
      node - the new current graphics node
      Throws:
      IllegalArgumentException - if the node is not part of the GVT Tree this walker is dedicated to
    • getCurrentGraphicsNode

      public GraphicsNode getCurrentGraphicsNode()
      Returns the current GraphicsNode.
    • previousGraphicsNode

      public GraphicsNode previousGraphicsNode()
      Returns the previous GraphicsNode. If the current graphics node does not have a previous node, returns null and retains the current node.
    • nextGraphicsNode

      public GraphicsNode nextGraphicsNode()
      Returns the next GraphicsNode. If the current graphics node does not have a next node, returns null and retains the current node.
    • parentGraphicsNode

      public GraphicsNode parentGraphicsNode()
      Returns the parent of the current GraphicsNode. If the current graphics node has no parent, returns null and retains the current node.
    • getNextSibling

      public GraphicsNode getNextSibling()
      Returns the next sibling of the current GraphicsNode. If the current graphics node does not have a next sibling, returns null and retains the current node.
    • getPreviousSibling

      public GraphicsNode getPreviousSibling()
      Returns the next previous of the current GraphicsNode. If the current graphics node does not have a previous sibling, returns null and retains the current node.
    • firstChild

      public GraphicsNode firstChild()
      Returns the first child of the current GraphicsNode. If the current graphics node does not have a first child, returns null and retains the current node.
    • lastChild

      public GraphicsNode lastChild()
      Returns the last child of the current GraphicsNode. If the current graphics node does not have a last child, returns null and retains the current node.
    • getNextGraphicsNode

      protected GraphicsNode getNextGraphicsNode(GraphicsNode node)
    • getPreviousGraphicsNode

      protected GraphicsNode getPreviousGraphicsNode(GraphicsNode node)
    • getLastChild

      protected static GraphicsNode getLastChild(GraphicsNode node)
    • getPreviousSibling

      protected static GraphicsNode getPreviousSibling(GraphicsNode node)
    • getFirstChild

      protected static GraphicsNode getFirstChild(GraphicsNode node)
    • getNextSibling

      protected static GraphicsNode getNextSibling(GraphicsNode node)