TreeVisitor

java.lang.Object

com.inductiveautomation.ignition.client.util.gui.tree.TreeVisitor

public abstract class TreeVisitor extends Object

Field Summary

Fields

Modifier and Type

Field

Description

protected boolean

traverseDeeper
Constructor Summary

Constructors

Constructor

Description

TreeVisitor()
Method Summary

Modifier and Type

Method

Description

static TreeVisitor

createBrowseTreeVisitor(TagPath path)

static TreePath

depthFirstSearch(TreeNode root, TreeVisitor visitor)

Performs a depth first search starting at the root node provided.

abstract boolean

visit(TreeNode node)

This will be called for each tree node in the tree.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- traverseDeeper
  
  protected boolean traverseDeeper
Constructor Details
- TreeVisitor
  
  public TreeVisitor()
Method Details
- visit
  
  public abstract boolean visit(TreeNode node)
  
  This will be called for each tree node in the tree. Returning true indicates a matching node. As an optional performance improvement, set the boolean field traverseDeeper to false if nothing under this node could be a match.
  
  Returns:
  
  If true, the search will stop and this node's TreePath will be considered as the match. If false, the search will continue.
- createBrowseTreeVisitor
  
  public static TreeVisitor createBrowseTreeVisitor(TagPath path)
- depthFirstSearch
  
  public static TreePath depthFirstSearch(TreeNode root, TreeVisitor visitor)
  
  Performs a depth first search starting at the root node provided. Returns the TreePath of the first node that the visitor returns true for.