de.javagl.common.ui

Class JTrees

java.lang.Object

de.javagl.common.ui.JTrees

public class JTrees
extends Object

Utility methods related to trees

Method Summary

Modifier and Type	Method and Description
static void	applyButtonTreeCellRenderer(JTree tree, Function<Object,JButton> buttonFactory, Function<Object,String> textFactory) Apply a cell renderer to the given tree that will create cells that consist of a button and a label, based on a GenericTreeCellRenderer.
static void	collapseAll(JTree tree, boolean omitRoot) Collapse all rows of the given tree
static List<TreePath>	computeExpandedPaths(JTree tree) Compute the list of all tree paths in the given tree that are currently expanded
static int	computeIndexInParent(Object nodeObject) Computes the index that the given node has in its parent node.
static int	countNodes(TreeModel treeModel) Count the number of nodes in the given tree model
static TreePath	createTreePathToRoot(TreeModel treeModel, Object node) Returns the tree path from the given node to the root in the given tree model
static void	expandAll(JTree tree) Expand all rows of the given tree.
static void	expandAllFixedHeight(JTree tree) Expand all rows of the given tree, assuming a fixed height for the rows.
static DefaultMutableTreeNode	findNode(TreeModel treeModel, Object userObject) Returns the first node with the given user object in the tree with the given model.
static List<Object>	getAllDescendants(TreeModel treeModel, Object node) Return all descendants of the given node in the given tree model (not including the given node!)
static List<Object>	getAllNodes(TreeModel treeModel) Return all nodes of the given tree model
static List<Object>	getChildren(TreeModel treeModel, Object node) Returns the children of the given node in the given tree model
static List<Object>	getLeafNodes(TreeModel treeModel) Returns a list containing all leaf nodes from the given tree model.
static List<Object>	getLeafNodes(TreeModel treeModel, Object node) Returns a list containing all leaf nodes from the given tree model that are descendants of the given node.
static Object	getParent(TreeModel treeModel, Object node) Returns the parent of the given node in the given tree model.
static Object	getUserObjectFromTreeNode(Object nodeObject) Returns the user object from the given tree node.
static Object	getUserObjectFromTreePath(TreePath treePath) Returns the user object from the last path component of the given tree path.
static TreePath	translatePath(TreeModel newTreeModel, TreePath oldPath) Translates one TreePath to a new TreeModel.
static TreePath	translatePath(TreeModel newTreeModel, TreePath oldPath, BiPredicate<Object,Object> equality) Translates one TreePath to a new TreeModel.

Methods inherited from class java.lang.Object

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

Method Detail

expandAll

public static void expandAll(JTree tree)

Expand all rows of the given tree.

Note that for large trees, expandAllFixedHeight(JTree) may be significantly faster.

Parameters:

tree - The tree

expandAllFixedHeight

public static void expandAllFixedHeight(JTree tree)

Expand all rows of the given tree, assuming a fixed height for the rows.

Parameters:

tree - The tree

collapseAll

public static void collapseAll(JTree tree,
                               boolean omitRoot)

Collapse all rows of the given tree

Parameters:

tree - The tree

omitRoot - Whether the root node should not be collapsed

countNodes

public static int countNodes(TreeModel treeModel)

Count the number of nodes in the given tree model

Parameters:

treeModel - The tree model

Returns:

The number of nodes

findNode

public static DefaultMutableTreeNode findNode(TreeModel treeModel,
                                              Object userObject)

Returns the first node with the given user object in the tree with the given model. This assumes that the user object is stored in a DefaultMutableTreeNode. Returns null if no matching node is found.

Parameters:

treeModel - The tree model

userObject - The user object

Returns:

The node with the given user object, or null

getChildren

public static List<Object> getChildren(TreeModel treeModel,
                                       Object node)

Returns the children of the given node in the given tree model

Parameters:

treeModel - The tree model

node - The node

Returns:

The children

getParent

public static Object getParent(TreeModel treeModel,
                               Object node)

Returns the parent of the given node in the given tree model. This parent may be null, if the given node is the root node (or not contained in the tree model at all).

Parameters:

treeModel - The tree model

node - The node

Returns:

The parent

getAllNodes

public static List<Object> getAllNodes(TreeModel treeModel)

Return all nodes of the given tree model

Parameters:

treeModel - The tree model

Returns:

The nodes

getAllDescendants

public static List<Object> getAllDescendants(TreeModel treeModel,
                                             Object node)

Return all descendants of the given node in the given tree model (not including the given node!)

Parameters:

treeModel - The tree model

node - The node

Returns:

The descendants

getLeafNodes

public static List<Object> getLeafNodes(TreeModel treeModel)

Returns a list containing all leaf nodes from the given tree model. These are the nodes that have 0 children.

Parameters:

treeModel - The tree model

Returns:

The leaf nodes

getLeafNodes

public static List<Object> getLeafNodes(TreeModel treeModel,
                                        Object node)

Returns a list containing all leaf nodes from the given tree model that are descendants of the given node. These are the nodes that have 0 children.

Parameters:

treeModel - The tree model

node - The node to start the search from

Returns:

The leaf nodes

createTreePathToRoot

public static TreePath createTreePathToRoot(TreeModel treeModel,
                                            Object node)

Returns the tree path from the given node to the root in the given tree model

Parameters:

treeModel - The tree model

node - The node

Returns:

The tree path

computeExpandedPaths

public static List<TreePath> computeExpandedPaths(JTree tree)

Compute the list of all tree paths in the given tree that are currently expanded

Parameters:

tree - The tree

Returns:

The expanded paths

translatePath

public static TreePath translatePath(TreeModel newTreeModel,
                                     TreePath oldPath)

Translates one TreePath to a new TreeModel. This methods assumes DefaultMutableTreeNodes.

Parameters:

newTreeModel - The new tree model

oldPath - The old tree path

Returns:

The new tree path, or null if there is no corresponding path in the new tree model

translatePath

public static TreePath translatePath(TreeModel newTreeModel,
                                     TreePath oldPath,
                                     BiPredicate<Object,Object> equality)

Translates one TreePath to a new TreeModel. This methods assumes DefaultMutableTreeNodes, and identifies the path based on the equality of user objects using the given equality predicate.

Parameters:

newTreeModel - The new tree model

oldPath - The old tree path

equality - The equality predicate

Returns:

The new tree path, or null if there is no corresponding path in the new tree model

getUserObjectFromTreePath

public static Object getUserObjectFromTreePath(TreePath treePath)

Returns the user object from the last path component of the given tree path. If the given path is null, then null is returned. If the last path component is not a DefaultMutableTreeNode, then null is returned.

Parameters:

treePath - The tree path

Returns:

The user object

getUserObjectFromTreeNode

public static Object getUserObjectFromTreeNode(Object nodeObject)

Returns the user object from the given tree node. If the given node object is null or not a DefaultMutableTreeNode, then null is returned.

Parameters:

nodeObject - The node object

Returns:

The user object

computeIndexInParent

public static int computeIndexInParent(Object nodeObject)

Computes the index that the given node has in its parent node. Returns -1 if the given node does not have a parent, or the node is not a DefaultMutableTreeNode.

Parameters:

nodeObject - The node

Returns:

The index of the node in its parent

applyButtonTreeCellRenderer

public static void applyButtonTreeCellRenderer(JTree tree,
                                               Function<Object,JButton> buttonFactory,
                                               Function<Object,String> textFactory)

Apply a cell renderer to the given tree that will create cells that consist of a button and a label, based on a GenericTreeCellRenderer.

An editor will be installed for the tree, making the buttons clickable.

Some details about the exact layout of the cells are intentionally not specified.

Parameters:

tree - The tree

buttonFactory - The factory that will receive the tree node, and return the JButton (to which listeners may already have been attached). If this function returns null, then no button will be inserted.

textFactory - The factory that will receive the tree node, and return the text that should be displayed as the node label.