oracle.ide.db.util

Class TreeNodeMaker

java.lang.Object

oracle.ide.db.util.TreeNodeMaker

public class TreeNodeMaker
extends java.lang.Object

UI utility for creating TreeNodes for DBObjects and SQLFragments.

Constructor Summary

Constructors

Constructor and Description
TreeNodeMaker()
TreeNodeMaker(boolean showChildren) Creates a new TreeNodeMaker that specifically does or doesn't create child nodes as well.
TreeNodeMaker(boolean showChildren, java.lang.String[] childTypes) Creates a new TreeNodeMaker that specifically does or doesn't create child nodes of the given types as well.
TreeNodeMaker(javax.swing.JTree tree) Creates a TreeNodeMaker that performs the expanding of nodes off the event thread (provided the parameter is not null and the tree model is an instance of DefaultTreeModel).

Method Summary

Modifier and Type	Method and Description
javax.swing.tree.DefaultMutableTreeNode	createTreeNode(DBObject obj) Creates a TreeNode using the defaults set on this TreeNodeMaker for child nodes for the given DBObject.
javax.swing.tree.DefaultMutableTreeNode	createTreeNode(SQLFragment obj) Creates a TreeNode using the defaults set on this TreeNodeMaker for child nodes for the given SQLFragment.
javax.swing.tree.DefaultMutableTreeNode	createTreeNode(SQLFragment obj, boolean showAvailKids) Creates a TreeNode using the defaults set on this TreeNodeMaker but gives an extra customisation - the ability to show available children - e.g.
static void	expandAll(javax.swing.JTree tree) Expands every row in a tree so that all leaves are showing.
static javax.swing.tree.DefaultMutableTreeNode	findNode(java.lang.Object userObject, javax.swing.tree.DefaultMutableTreeNode root) Looks for a node in the tree that has the given object as its user object.
boolean	getShowChildren() Gets whether child nodes are also created for a given object.
static int	indexOfNode(javax.swing.tree.DefaultMutableTreeNode node, javax.swing.tree.DefaultMutableTreeNode parent) Gets the index of the given node underneath its parent in a list of its direct children.
void	setChildTypes(java.lang.String[] childTypes) If child nodes are being created, the types of children for which nodes are created can be filtered by types.
void	setDeepFKs(boolean boo) Sets wether FKConstraint nodes should recurse to their referenced relations.
void	setShowChildren(boolean boo) Sets whether child nodes are also created for a given object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TreeNodeMaker

public TreeNodeMaker()

TreeNodeMaker

public TreeNodeMaker(javax.swing.JTree tree)

Creates a TreeNodeMaker that performs the expanding of nodes off the event thread (provided the parameter is not null and the tree model is an instance of DefaultTreeModel). When a node is expanded, a "Loading..." node is displayed and the query performed in the background. When the query returns, the child nodes are added to the expanded node.

Parameters:

tree - the parent tree control. If this is null or getModel() does not return an instanceof DefaultTreeModel, this parameter has no effect.

TreeNodeMaker

public TreeNodeMaker(boolean showChildren)

Creates a new TreeNodeMaker that specifically does or doesn't create child nodes as well.

TreeNodeMaker

public TreeNodeMaker(boolean showChildren,
                     java.lang.String[] childTypes)

Creates a new TreeNodeMaker that specifically does or doesn't create child nodes of the given types as well.

Method Detail

setShowChildren

public void setShowChildren(boolean boo)

Sets whether child nodes are also created for a given object.

getShowChildren

public boolean getShowChildren()

Gets whether child nodes are also created for a given object.

setChildTypes

public void setChildTypes(java.lang.String[] childTypes)

If child nodes are being created, the types of children for which nodes are created can be filtered by types. This supports the use of the sub-types for Constraints.

setDeepFKs

public void setDeepFKs(boolean boo)

Sets wether FKConstraint nodes should recurse to their referenced relations.

createTreeNode

public javax.swing.tree.DefaultMutableTreeNode createTreeNode(DBObject obj)

Creates a TreeNode using the defaults set on this TreeNodeMaker for child nodes for the given DBObject.

createTreeNode

public javax.swing.tree.DefaultMutableTreeNode createTreeNode(SQLFragment obj)

Creates a TreeNode using the defaults set on this TreeNodeMaker for child nodes for the given SQLFragment.

createTreeNode

public javax.swing.tree.DefaultMutableTreeNode createTreeNode(SQLFragment obj,
                                                              boolean showAvailKids)

Creates a TreeNode using the defaults set on this TreeNodeMaker but gives an extra customisation - the ability to show available children - e.g. Columns on a FromObject that has a RelationUsage etc. Useful for expression pallettes.

indexOfNode

public static int indexOfNode(javax.swing.tree.DefaultMutableTreeNode node,
                              javax.swing.tree.DefaultMutableTreeNode parent)

Gets the index of the given node underneath its parent in a list of its direct children.

findNode

public static javax.swing.tree.DefaultMutableTreeNode findNode(java.lang.Object userObject,
                                                               javax.swing.tree.DefaultMutableTreeNode root)

Looks for a node in the tree that has the given object as its user object. Will test the object using == not .equals.

Parameters:

userObject - the object to look for

root - the node to root the search from

Returns:

the node containing the userObject or null

expandAll

public static void expandAll(javax.swing.JTree tree)

Expands every row in a tree so that all leaves are showing.