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

Class TreeVisitor

java.lang.Object

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

public abstract class TreeVisitor
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	traverseDeeper

Constructor Summary

Constructors

Constructor and Description
TreeVisitor()

Method Summary

Modifier and Type	Method and Description
static javax.swing.tree.TreePath	depthFirstSearch(javax.swing.tree.TreeNode root, TreeVisitor visitor) Performs a depth first search starting at the root node provided.
abstract boolean	visit(javax.swing.tree.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 Detail

traverseDeeper

protected boolean traverseDeeper

Constructor Detail

TreeVisitor

public TreeVisitor()

Method Detail

visit

public abstract boolean visit(javax.swing.tree.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.

Parameters:

node -

Returns:

If true, the search will stop and this node's TreePath will be considered as the match. If false, the search will continue.

depthFirstSearch

public static javax.swing.tree.TreePath depthFirstSearch(javax.swing.tree.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.