Package com.intellij.util.ui.tree

Class TreeUtil

java.lang.Object

com.intellij.util.ui.tree.TreeUtil

public final class TreeUtil
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TreeUtil.Traverse Deprecated. use TreeUtil#treePathTraverser()

Field Summary

Fields

Modifier and Type	Field and Description
static javax.swing.tree.TreePath[]	EMPTY_TREE_PATH

Method Summary

Modifier and Type	Method and Description
static void	addChildrenTo(javax.swing.tree.MutableTreeNode node, java.util.List<? extends javax.swing.tree.TreeNode> children)
static void	collapseAll(javax.swing.JTree tree, boolean strict, int keepSelectionLevel)
static void	collapseAll(javax.swing.JTree tree, int keepSelectionLevel)
static <T> java.util.List<T>	collectExpandedObjects(javax.swing.JTree tree, java.util.function.Function<? super javax.swing.tree.TreePath,? extends T> mapper)
static <T> java.util.List<T>	collectExpandedObjects(javax.swing.JTree tree, javax.swing.tree.TreePath root, java.util.function.Function<? super javax.swing.tree.TreePath,? extends T> mapper)
static java.util.List<javax.swing.tree.TreePath>	collectExpandedPaths(javax.swing.JTree tree)
static java.util.List<javax.swing.tree.TreePath>	collectExpandedPaths(javax.swing.JTree tree, javax.swing.tree.TreePath root)
static java.util.List<java.lang.Object>	collectExpandedUserObjects(javax.swing.JTree tree)
static java.util.List<java.lang.Object>	collectExpandedUserObjects(javax.swing.JTree tree, javax.swing.tree.TreePath root)
static <T> java.util.List<T>	collectSelectedObjects(javax.swing.JTree tree, java.util.function.Function<? super javax.swing.tree.TreePath,? extends T> mapper)
static <T> java.util.List<T>	collectSelectedObjects(javax.swing.JTree tree, javax.swing.tree.TreePath root, java.util.function.Function<? super javax.swing.tree.TreePath,? extends T> mapper)
static <T> java.util.List<T>	collectSelectedObjectsOfType(javax.swing.JTree tree, java.lang.Class<? extends T> type)
static java.util.List<javax.swing.tree.TreePath>	collectSelectedPaths(javax.swing.JTree tree)
static java.util.List<javax.swing.tree.TreePath>	collectSelectedPaths(javax.swing.JTree tree, javax.swing.tree.TreePath root)
static java.util.List<java.lang.Object>	collectSelectedUserObjects(javax.swing.JTree tree)
static java.util.List<java.lang.Object>	collectSelectedUserObjects(javax.swing.JTree tree, javax.swing.tree.TreePath root)
static void	dropSelectionButUnderPoint(javax.swing.JTree tree, java.awt.Point treePoint)
static void	ensureSelection(javax.swing.JTree tree)
static void	expand(javax.swing.JTree tree, int levels) Expands n levels of the tree counting from the root
static void	expand(javax.swing.JTree tree, int depth, java.lang.Runnable onDone) Expands some nodes in the specified tree and runs the specified task on done.
static void	expand(javax.swing.JTree tree, TreeVisitor visitor, java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer) Expands a node in the specified tree.
static void	expandAll(javax.swing.JTree tree)
static void	expandAll(javax.swing.JTree tree, java.lang.Runnable onDone) Expands all nodes in the specified tree and runs the specified task on done.
static void	expandRootChildIfOnlyOne(javax.swing.JTree tree)
static javax.swing.tree.TreePath	findCommonPath(javax.swing.tree.TreePath [] treePaths) Deprecated. use TreePathUtil#findCommonAncestor(TreePath...) instead
static javax.swing.tree.DefaultMutableTreeNode	findNode(javax.swing.tree.DefaultMutableTreeNode aRoot, Condition<? super javax.swing.tree.DefaultMutableTreeNode> condition)
static javax.swing.tree.DefaultMutableTreeNode	findNodeWithObject(javax.swing.tree.DefaultMutableTreeNode aRoot, java.lang.Object aObject)
static javax.swing.tree.TreeNode	findNodeWithObject(java.lang.Object object, javax.swing.tree.TreeModel model, java.lang.Object parent)
static <T> T	findObjectInPath(javax.swing.tree.TreePath path, java.lang.Class<T> clazz)
static int	getDepthOffset(javax.swing.JTree aTree)
static java.util.Comparator<javax.swing.tree.TreePath>	getDisplayOrderComparator(javax.swing.JTree tree)
static Range<java.lang.Integer>	getExpandControlRange(javax.swing.JTree aTree, javax.swing.tree.TreePath path)
static javax.swing.tree.TreePath	getFirstLeafNodePath(javax.swing.JTree tree) Deprecated. use promiseSelectFirstLeaf(javax.swing.JTree)
static javax.swing.tree.TreePath	getFirstNodePath(javax.swing.JTree tree)
static <T> T	getLastUserObject(java.lang.Class<T> type, javax.swing.tree.TreePath path)
static java.lang.Object	getLastUserObject(javax.swing.tree.TreePath path)
static int	getNodeDepth(javax.swing.JTree tree, javax.swing.tree.TreePath path)
static int	getNodeRowX(javax.swing.JTree tree, int row)
static javax.swing.tree.TreePath	getPath(javax.swing.tree.TreeNode aRootNode, javax.swing.tree.TreeNode aNode)
static javax.swing.tree.TreePath	getPathFromRoot(javax.swing.tree.TreeNode node)
static RelativePoint	getPointForBounds(javax.swing.JComponent aComponent, java.awt.Rectangle aBounds)
static RelativePoint	getPointForPath(javax.swing.JTree aTree, javax.swing.tree.TreePath path)
static RelativePoint	getPointForRow(javax.swing.JTree aTree, int aRow)
static RelativePoint	getPointForSelection(javax.swing.JTree aTree)
static javax.swing.tree.TreePath	getSelectedPathIfOne(javax.swing.JTree tree)
static <T> T	getUserObject(java.lang.Class<T> type, java.lang.Object node)
static java.lang.Object	getUserObject(java.lang.Object node)
static int	getVisibleRowCount(javax.swing.JTree tree) Returns a number of tree rows currently visible.
static <T extends javax.swing.tree.TreeNode> int	indexedBinarySearch(T parent, T key, java.util.Comparator<? super T> comparator)
static <T extends javax.swing.tree.MutableTreeNode> void	insertNode(T child, T parent, javax.swing.tree.DefaultTreeModel model, boolean allowDuplication, java.util.Comparator<? super T> comparator)
static <T extends javax.swing.tree.MutableTreeNode> void	insertNode(T child, T parent, javax.swing.tree.DefaultTreeModel model, java.util.Comparator<? super T> comparator)
static void	installActions(javax.swing.JTree tree)
static void	invalidateCacheAndRepaint(javax.swing.plaf.TreeUI ui)
static boolean	isAncestor(javax.swing.tree.TreeNode ancestor, javax.swing.tree.TreeNode node)
static boolean	isLocationInExpandControl(javax.swing.JTree tree, int x, int y)
static boolean	isLocationInExpandControl(javax.swing.JTree tree, javax.swing.tree.TreePath path, int x, int y)
static boolean	isOverSelection(javax.swing.JTree tree, java.awt.Point point)
static java.util.List<javax.swing.tree.TreeNode>	listChildren(javax.swing.tree.TreeNode node)
static void	makeVisible(javax.swing.JTree tree, TreeVisitor visitor, java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer) Makes visible a node in the specified tree.
static ActionCallback	moveDown(javax.swing.JTree tree)
static ActionCallback	movePageDown(javax.swing.JTree tree)
static ActionCallback	movePageUp(javax.swing.JTree tree)
static void	moveSelectedRow(javax.swing.JTree tree, int direction)
static ActionCallback	moveUp(javax.swing.JTree tree)
static JBIterable<java.lang.Object>	nodeChildren(java.lang.Object node, javax.swing.tree.TreeModel model)
static JBIterable<javax.swing.tree.TreeNode>	nodeChildren(javax.swing.tree.TreeNode treeNode)
static Promise<?>	promiseExpand(javax.swing.JTree tree, int depth) Promises to expand some nodes in the specified tree.
static Promise<java.util.List<javax.swing.tree.TreePath>>	promiseExpand(javax.swing.JTree tree, java.util.stream.Stream<? extends TreeVisitor> visitors) Promises to expand several nodes in the specified tree.
static Promise<javax.swing.tree.TreePath>	promiseExpand(javax.swing.JTree tree, TreeVisitor visitor) Promises to expand a node in the specified tree.
static Promise<?>	promiseExpandAll(javax.swing.JTree tree) Promises to expand all nodes in the specified tree.
static Promise<java.util.List<javax.swing.tree.TreePath>>	promiseMakeVisible(javax.swing.JTree tree, java.util.stream.Stream<? extends TreeVisitor> visitors) Promises to make visible several nodes in the specified tree.
static Promise<javax.swing.tree.TreePath>	promiseMakeVisible(javax.swing.JTree tree, TreeVisitor visitor) Promises to make visible a node in the specified tree.
static Promise<java.util.List<javax.swing.tree.TreePath>>	promiseSelect(javax.swing.JTree tree, java.util.stream.Stream<? extends TreeVisitor> visitors) Promises to select several nodes in the specified tree.
static Promise<javax.swing.tree.TreePath>	promiseSelect(javax.swing.JTree tree, TreeVisitor visitor) Promises to select a node in the specified tree.
static Promise<javax.swing.tree.TreePath>	promiseSelectFirst(javax.swing.JTree tree) Promises to select the first node in the specified tree.
static Promise<javax.swing.tree.TreePath>	promiseSelectFirstLeaf(javax.swing.JTree tree) Promises to select the first leaf node in the specified tree.
static Promise<javax.swing.tree.TreePath>	promiseVisit(javax.swing.JTree tree, TreeVisitor visitor) Promises to process nodes in the specified tree.
static void	removeLastPathComponent(javax.swing.JTree tree, javax.swing.tree.TreePath pathToBeRemoved)
static void	removeSelected(javax.swing.JTree tree) Removes last component in the current selection path.
static void	restoreExpandedPaths(javax.swing.JTree tree, java.util.List<? extends javax.swing.tree.TreePath> paths) Expands specified paths.
static boolean	scrollToVisible(javax.swing.JTree tree, javax.swing.tree.TreePath path, boolean centered)
static void	select(javax.swing.JTree tree, TreeVisitor visitor, java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer) Deprecated. use promiseSelect(tree, visitor).onSuccess(consumer) instead
static ActionCallback	selectFirstNode(javax.swing.JTree tree) Tries to select the first node in the specified tree as soon as possible.
static ActionCallback	selectInTree(javax.swing.tree.DefaultMutableTreeNode node, boolean requestFocus, javax.swing.JTree tree)
static ActionCallback	selectInTree(javax.swing.tree.DefaultMutableTreeNode node, boolean requestFocus, javax.swing.JTree tree, boolean center)
static ActionCallback	selectInTree(Project project, javax.swing.tree.DefaultMutableTreeNode node, boolean requestFocus, javax.swing.JTree tree, boolean center)
static javax.swing.tree.TreePath []	selectMaximals(javax.swing.tree.TreePath [] paths) Deprecated. use TreeCollector.TreePathRoots#collect(TreePath...) instead
static void	selectNode(javax.swing.JTree tree, javax.swing.tree.TreeNode node)
static ActionCallback	selectPath(javax.swing.JTree tree, javax.swing.tree.TreePath path)
static ActionCallback	selectPath(javax.swing.JTree tree, javax.swing.tree.TreePath path, boolean center)
static void	selectPaths(javax.swing.JTree tree, java.util.Collection<? extends javax.swing.tree.TreePath> paths) Makes visible specified tree paths and select them.
static void	selectPaths(javax.swing.JTree tree, javax.swing.tree.TreePath... paths) Deprecated. use {selectPaths(JTree, Collection)} instead
static void	selectRow(javax.swing.JTree tree, int index) Makes visible the specified tree row and selects it.
static ActionCallback	showAndSelect(javax.swing.JTree tree, int top, int bottom, int row, int previous)
static ActionCallback	showAndSelect(javax.swing.JTree tree, int top, int bottom, int row, int previous, boolean addToSelection)
static ActionCallback	showAndSelect(javax.swing.JTree tree, int top, int bottom, int row, int previous, boolean addToSelection, boolean scroll)
static ActionCallback	showAndSelect(javax.swing.JTree tree, int top, int bottom, int row, int previous, boolean addToSelection, boolean scroll, boolean resetSelection)
static ActionCallback	showRowCentered(javax.swing.JTree tree, int row, boolean centerHorizontally)
static ActionCallback	showRowCentered(javax.swing.JTree tree, int row, boolean centerHorizontally, boolean scroll)
static void	sort(javax.swing.tree.DefaultMutableTreeNode node, java.util.Comparator comparator)
static void	sort(javax.swing.tree.DefaultTreeModel model, java.util.Comparator comparator)
static <T extends javax.swing.tree.MutableTreeNode> void	sortChildren(T node, java.util.Comparator<? super T> comparator)
static <T extends javax.swing.tree.MutableTreeNode> void	sortRecursively(T node, java.util.Comparator<? super T> comparator)
static boolean	traverse(javax.swing.tree.TreeNode node, TreeUtil.Traverse traverse) Deprecated. use TreeUtil#treeTraverser() or TreeUtil#treeNodeTraverser() directly
static boolean	traverseDepth(javax.swing.tree.TreeNode node, TreeUtil.Traverse traverse) Deprecated. use TreeUtil#treeTraverser() or TreeUtil#treeNodeTraverser() directly
static JBTreeTraverser<javax.swing.tree.TreeNode>	treeNodeTraverser(javax.swing.tree.TreeNode treeNode)
static JBTreeTraverser<javax.swing.tree.TreePath>	treePathTraverser(javax.swing.JTree tree)
static JBTreeTraverser<java.lang.Object>	treeTraverser(javax.swing.JTree tree)
static void	unselectPath(javax.swing.JTree tree, javax.swing.tree.TreePath path)
static void	visit(javax.swing.JTree tree, TreeVisitor visitor, java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer) Processes nodes in the specified tree.
static <T> void	visitVisibleRows(javax.swing.JTree tree, java.util.function.Function<? super javax.swing.tree.TreePath,? extends T> mapper, java.util.function.Consumer<? super T> consumer) Processes visible nodes in the specified tree.
static javax.swing.tree.TreePath	visitVisibleRows(javax.swing.JTree tree, TreeVisitor visitor) Processes visible nodes in the specified tree.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_TREE_PATH

public static final javax.swing.tree.TreePath[] EMPTY_TREE_PATH

Method Detail

treeTraverser

public static JBTreeTraverser<java.lang.Object> treeTraverser(javax.swing.JTree tree)

treePathTraverser

public static JBTreeTraverser<javax.swing.tree.TreePath> treePathTraverser(javax.swing.JTree tree)

nodeChildren

public static JBIterable<java.lang.Object> nodeChildren(java.lang.Object node,
                                                        javax.swing.tree.TreeModel model)

treeNodeTraverser

public static JBTreeTraverser<javax.swing.tree.TreeNode> treeNodeTraverser(javax.swing.tree.TreeNode treeNode)

nodeChildren

public static JBIterable<javax.swing.tree.TreeNode> nodeChildren(javax.swing.tree.TreeNode treeNode)

collectExpandedPaths

public static java.util.List<javax.swing.tree.TreePath> collectExpandedPaths(javax.swing.JTree tree)

Parameters:

tree - a tree, which viewable paths are processed

Returns:

a list of expanded paths

collectExpandedUserObjects

public static java.util.List<java.lang.Object> collectExpandedUserObjects(javax.swing.JTree tree)

Parameters:

tree - a tree, which viewable paths are processed

Returns:

a list of user objects which correspond to expanded paths under the specified root node

collectExpandedObjects

public static <T> java.util.List<T> collectExpandedObjects(javax.swing.JTree tree,
                                                           java.util.function.Function<? super javax.swing.tree.TreePath,? extends T> mapper)

Parameters:

tree - a tree, which viewable paths are processed

mapper - a function to convert a expanded tree path to a corresponding object

Returns:

a list of objects which correspond to expanded paths under the specified root node

findObjectInPath

public static <T> T findObjectInPath(javax.swing.tree.TreePath path,
                                     java.lang.Class<T> clazz)

collectSelectedObjectsOfType

public static <T> java.util.List<T> collectSelectedObjectsOfType(javax.swing.JTree tree,
                                                                 java.lang.Class<? extends T> type)

Parameters:

tree - a tree, which selection is processed

type - a Class object to filter selected user objects

Returns:

a list of user objects of the specified type retrieved from all selected paths

collectExpandedPaths

public static java.util.List<javax.swing.tree.TreePath> collectExpandedPaths(javax.swing.JTree tree,
                                                                             javax.swing.tree.TreePath root)

Parameters:

tree - a tree, which viewable paths are processed

root - an ascendant tree path to filter expanded tree paths

Returns:

a list of expanded paths under the specified root node

collectExpandedUserObjects

public static java.util.List<java.lang.Object> collectExpandedUserObjects(javax.swing.JTree tree,
                                                                          javax.swing.tree.TreePath root)

Parameters:

tree - a tree, which viewable paths are processed

root - an ascendant tree path to filter expanded tree paths

Returns:

a list of user objects which correspond to expanded paths under the specified root node

collectExpandedObjects

public static <T> java.util.List<T> collectExpandedObjects(javax.swing.JTree tree,
                                                           javax.swing.tree.TreePath root,
                                                           java.util.function.Function<? super javax.swing.tree.TreePath,? extends T> mapper)

Parameters:

tree - a tree, which viewable paths are processed

root - an ascendant tree path to filter expanded tree paths

mapper - a function to convert a expanded tree path to a corresponding object

Returns:

a list of objects which correspond to expanded paths under the specified root node

restoreExpandedPaths

public static void restoreExpandedPaths(javax.swing.JTree tree,
                                        java.util.List<? extends javax.swing.tree.TreePath> paths)

Expands specified paths.

Parameters:

tree - JTree to apply expansion status to

paths - to expand. See collectExpandedPaths(JTree, TreePath)

getPath

public static javax.swing.tree.TreePath getPath(javax.swing.tree.TreeNode aRootNode,
                                                javax.swing.tree.TreeNode aNode)

isAncestor

public static boolean isAncestor(javax.swing.tree.TreeNode ancestor,
                                 javax.swing.tree.TreeNode node)

getPathFromRoot

public static javax.swing.tree.TreePath getPathFromRoot(javax.swing.tree.TreeNode node)

findNodeWithObject

public static javax.swing.tree.TreeNode findNodeWithObject(java.lang.Object object,
                                                           javax.swing.tree.TreeModel model,
                                                           java.lang.Object parent)

removeSelected

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

Removes last component in the current selection path.

Parameters:

tree - to remove selected node from.

removeLastPathComponent

public static void removeLastPathComponent(javax.swing.JTree tree,
                                           javax.swing.tree.TreePath pathToBeRemoved)

findNodeWithObject

public static javax.swing.tree.DefaultMutableTreeNode findNodeWithObject(javax.swing.tree.DefaultMutableTreeNode aRoot,
                                                                         java.lang.Object aObject)

findNode

public static javax.swing.tree.DefaultMutableTreeNode findNode(javax.swing.tree.DefaultMutableTreeNode aRoot,
                                                               Condition<? super javax.swing.tree.DefaultMutableTreeNode> condition)

findCommonPath

@Deprecated
public static javax.swing.tree.TreePath findCommonPath(javax.swing.tree.TreePath [] treePaths)

Deprecated. use TreePathUtil#findCommonAncestor(TreePath...) instead

selectFirstNode

public static ActionCallback selectFirstNode(javax.swing.JTree tree)

Tries to select the first node in the specified tree as soon as possible.

Parameters:

tree - a tree, which node should be selected

Returns:

a callback that will be done when first visible node is selected

See Also:

promiseSelectFirst(javax.swing.JTree)

getFirstNodePath

public static javax.swing.tree.TreePath getFirstNodePath(javax.swing.JTree tree)

getFirstLeafNodePath

@Deprecated
public static javax.swing.tree.TreePath getFirstLeafNodePath(javax.swing.JTree tree)

Deprecated. use promiseSelectFirstLeaf(javax.swing.JTree)

selectMaximals

@Deprecated
public static javax.swing.tree.TreePath [] selectMaximals(javax.swing.tree.TreePath [] paths)

Deprecated. use TreeCollector.TreePathRoots#collect(TreePath...) instead

sort

public static void sort(javax.swing.tree.DefaultTreeModel model,
                        java.util.Comparator comparator)

sort

public static void sort(javax.swing.tree.DefaultMutableTreeNode node,
                        java.util.Comparator comparator)

sortRecursively

public static <T extends javax.swing.tree.MutableTreeNode> void sortRecursively(T node,
                                                                                java.util.Comparator<? super T> comparator)

sortChildren

public static <T extends javax.swing.tree.MutableTreeNode> void sortChildren(T node,
                                                                             java.util.Comparator<? super T> comparator)

addChildrenTo

public static void addChildrenTo(javax.swing.tree.MutableTreeNode node,
                                 java.util.List<? extends javax.swing.tree.TreeNode> children)

traverse

@Deprecated
public static boolean traverse(javax.swing.tree.TreeNode node,
                               TreeUtil.Traverse traverse)

Deprecated. use TreeUtil#treeTraverser() or TreeUtil#treeNodeTraverser() directly

traverseDepth

@Deprecated
public static boolean traverseDepth(javax.swing.tree.TreeNode node,
                                    TreeUtil.Traverse traverse)

Deprecated. use TreeUtil#treeTraverser() or TreeUtil#treeNodeTraverser() directly

selectRow

public static void selectRow(javax.swing.JTree tree,
                             int index)

Makes visible the specified tree row and selects it. It does not clear selection if there is nothing to select.

Parameters:

tree - a tree to select in

index - an index of a viewable node in the given tree

See Also:

JTree.getRowCount(), JTree.clearSelection()

selectPaths

public static void selectPaths(javax.swing.JTree tree,
                               java.util.Collection<? extends javax.swing.tree.TreePath> paths)

Makes visible specified tree paths and select them. It does not clear selection if there are no paths to select.

Parameters:

tree - a tree to select in

paths - a collection of paths to select

See Also:

JTree.clearSelection()

selectPaths

@Deprecated
public static void selectPaths(javax.swing.JTree tree,
                               javax.swing.tree.TreePath... paths)

Deprecated. use {selectPaths(JTree, Collection)} instead

selectPath

public static ActionCallback selectPath(javax.swing.JTree tree,
                                        javax.swing.tree.TreePath path)

selectPath

public static ActionCallback selectPath(javax.swing.JTree tree,
                                        javax.swing.tree.TreePath path,
                                        boolean center)

moveDown

public static ActionCallback moveDown(javax.swing.JTree tree)

moveUp

public static ActionCallback moveUp(javax.swing.JTree tree)

movePageUp

public static ActionCallback movePageUp(javax.swing.JTree tree)

movePageDown

public static ActionCallback movePageDown(javax.swing.JTree tree)

showRowCentered

public static ActionCallback showRowCentered(javax.swing.JTree tree,
                                             int row,
                                             boolean centerHorizontally)

showRowCentered

public static ActionCallback showRowCentered(javax.swing.JTree tree,
                                             int row,
                                             boolean centerHorizontally,
                                             boolean scroll)

showAndSelect

public static ActionCallback showAndSelect(javax.swing.JTree tree,
                                           int top,
                                           int bottom,
                                           int row,
                                           int previous)

showAndSelect

public static ActionCallback showAndSelect(javax.swing.JTree tree,
                                           int top,
                                           int bottom,
                                           int row,
                                           int previous,
                                           boolean addToSelection)

showAndSelect

public static ActionCallback showAndSelect(javax.swing.JTree tree,
                                           int top,
                                           int bottom,
                                           int row,
                                           int previous,
                                           boolean addToSelection,
                                           boolean scroll)

showAndSelect

public static ActionCallback showAndSelect(javax.swing.JTree tree,
                                           int top,
                                           int bottom,
                                           int row,
                                           int previous,
                                           boolean addToSelection,
                                           boolean scroll,
                                           boolean resetSelection)

getVisibleRowCount

public static int getVisibleRowCount(javax.swing.JTree tree)

Returns a number of tree rows currently visible. Do not mix with JTree.getVisibleRowCount() which returns a preferred number of rows to be displayed within a scroll pane.

Parameters:

tree - tree to get the number of visible rows

Returns:

number of visible rows, including partially visible ones. Not more than total number of tree rows.

installActions

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

collapseAll

public static void collapseAll(javax.swing.JTree tree,
                               int keepSelectionLevel)

Parameters:

tree - a tree, which nodes should be collapsed

keepSelectionLevel - a minimal path count of a lead selection path or -1 to restore old selection

collapseAll

public static void collapseAll(javax.swing.JTree tree,
                               boolean strict,
                               int keepSelectionLevel)

Parameters:

tree - a tree, which nodes should be collapsed

strict - use false if a single top level node should not be collapsed

keepSelectionLevel - a minimal path count of a lead selection path or -1 to restore old selection

selectNode

public static void selectNode(javax.swing.JTree tree,
                              javax.swing.tree.TreeNode node)

moveSelectedRow

public static void moveSelectedRow(javax.swing.JTree tree,
                                   int direction)

listChildren

public static java.util.List<javax.swing.tree.TreeNode> listChildren(javax.swing.tree.TreeNode node)

expandRootChildIfOnlyOne

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

expandAll

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

expandAll

public static void expandAll(javax.swing.JTree tree,
                             java.lang.Runnable onDone)

Expands all nodes in the specified tree and runs the specified task on done.

Parameters:

tree - a tree, which nodes should be expanded

onDone - a task to run on EDT after expanding nodes

promiseExpandAll

public static Promise<?> promiseExpandAll(javax.swing.JTree tree)

Promises to expand all nodes in the specified tree. NB!: The returned promise may be resolved immediately, if this method is called on inappropriate background thread.

Parameters:

tree - a tree, which nodes should be expanded

Returns:

a promise that will be succeed when all nodes are expanded

expand

public static void expand(javax.swing.JTree tree,
                          int levels)

Expands n levels of the tree counting from the root

Parameters:

tree - to expand nodes of

levels - depths of the expantion

expand

public static void expand(javax.swing.JTree tree,
                          int depth,
                          java.lang.Runnable onDone)

Expands some nodes in the specified tree and runs the specified task on done.

Parameters:

tree - a tree, which nodes should be expanded

depth - a depth starting from the root node

onDone - a task to run on EDT after expanding nodes

promiseExpand

public static Promise<?> promiseExpand(javax.swing.JTree tree,
                                       int depth)

Promises to expand some nodes in the specified tree. NB!: The returned promise may be resolved immediately, if this method is called on inappropriate background thread.

Parameters:

tree - a tree, which nodes should be expanded

depth - a depth starting from the root node

Returns:

a promise that will be succeed when all needed nodes are expanded

selectInTree

public static ActionCallback selectInTree(javax.swing.tree.DefaultMutableTreeNode node,
                                          boolean requestFocus,
                                          javax.swing.JTree tree)

selectInTree

public static ActionCallback selectInTree(javax.swing.tree.DefaultMutableTreeNode node,
                                          boolean requestFocus,
                                          javax.swing.JTree tree,
                                          boolean center)

selectInTree

public static ActionCallback selectInTree(Project project,
                                          javax.swing.tree.DefaultMutableTreeNode node,
                                          boolean requestFocus,
                                          javax.swing.JTree tree,
                                          boolean center)

collectSelectedPaths

public static java.util.List<javax.swing.tree.TreePath> collectSelectedPaths(javax.swing.JTree tree)

Parameters:

tree - a tree, which selection is processed

Returns:

a list of all selected paths

collectSelectedUserObjects

public static java.util.List<java.lang.Object> collectSelectedUserObjects(javax.swing.JTree tree)

Parameters:

tree - a tree, which selection is processed

Returns:

a list of user objects which correspond to all selected paths

collectSelectedObjects

public static <T> java.util.List<T> collectSelectedObjects(javax.swing.JTree tree,
                                                           java.util.function.Function<? super javax.swing.tree.TreePath,? extends T> mapper)

Parameters:

tree - a tree, which selection is processed

mapper - a function to convert a selected tree path to a corresponding object

Returns:

a list of objects which correspond to all selected paths

collectSelectedPaths

public static java.util.List<javax.swing.tree.TreePath> collectSelectedPaths(javax.swing.JTree tree,
                                                                             javax.swing.tree.TreePath root)

Parameters:

tree - a tree, which selection is processed

root - an ascendant tree path to filter selected tree paths

Returns:

a list of selected paths under the specified root node

collectSelectedUserObjects

public static java.util.List<java.lang.Object> collectSelectedUserObjects(javax.swing.JTree tree,
                                                                          javax.swing.tree.TreePath root)

Parameters:

tree - a tree, which selection is processed

root - an ascendant tree path to filter selected tree paths

Returns:

a list of user objects which correspond to selected paths under the specified root node

collectSelectedObjects

public static <T> java.util.List<T> collectSelectedObjects(javax.swing.JTree tree,
                                                           javax.swing.tree.TreePath root,
                                                           java.util.function.Function<? super javax.swing.tree.TreePath,? extends T> mapper)

Parameters:

tree - a tree, which selection is processed

root - an ascendant tree path to filter selected tree paths

mapper - a function to convert a selected tree path to a corresponding object

Returns:

a list of objects which correspond to selected paths under the specified root node

unselectPath

public static void unselectPath(javax.swing.JTree tree,
                                javax.swing.tree.TreePath path)

getExpandControlRange

public static Range<java.lang.Integer> getExpandControlRange(javax.swing.JTree aTree,
                                                             javax.swing.tree.TreePath path)

getDepthOffset

public static int getDepthOffset(javax.swing.JTree aTree)

getNodeDepth

public static int getNodeDepth(javax.swing.JTree tree,
                               javax.swing.tree.TreePath path)

getNodeRowX

public static int getNodeRowX(javax.swing.JTree tree,
                              int row)

isLocationInExpandControl

public static boolean isLocationInExpandControl(javax.swing.JTree tree,
                                                int x,
                                                int y)

isLocationInExpandControl

public static boolean isLocationInExpandControl(javax.swing.JTree tree,
                                                javax.swing.tree.TreePath path,
                                                int x,
                                                int y)

invalidateCacheAndRepaint

public static void invalidateCacheAndRepaint(javax.swing.plaf.TreeUI ui)

getPointForSelection

public static RelativePoint getPointForSelection(javax.swing.JTree aTree)

getPointForRow

public static RelativePoint getPointForRow(javax.swing.JTree aTree,
                                           int aRow)

getPointForPath

public static RelativePoint getPointForPath(javax.swing.JTree aTree,
                                            javax.swing.tree.TreePath path)

getPointForBounds

public static RelativePoint getPointForBounds(javax.swing.JComponent aComponent,
                                              java.awt.Rectangle aBounds)

isOverSelection

public static boolean isOverSelection(javax.swing.JTree tree,
                                      java.awt.Point point)

dropSelectionButUnderPoint

public static void dropSelectionButUnderPoint(javax.swing.JTree tree,
                                              java.awt.Point treePoint)

getUserObject

public static java.lang.Object getUserObject(java.lang.Object node)

getUserObject

public static <T> T getUserObject(java.lang.Class<T> type,
                                  java.lang.Object node)

getLastUserObject

public static java.lang.Object getLastUserObject(javax.swing.tree.TreePath path)

Returns:

an user object retrieved from the last component of the specified path

getLastUserObject

public static <T> T getLastUserObject(java.lang.Class<T> type,
                                      javax.swing.tree.TreePath path)

getSelectedPathIfOne

public static javax.swing.tree.TreePath getSelectedPathIfOne(javax.swing.JTree tree)

ensureSelection

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

insertNode

public static <T extends javax.swing.tree.MutableTreeNode> void insertNode(T child,
                                                                           T parent,
                                                                           javax.swing.tree.DefaultTreeModel model,
                                                                           java.util.Comparator<? super T> comparator)

insertNode

public static <T extends javax.swing.tree.MutableTreeNode> void insertNode(T child,
                                                                           T parent,
                                                                           javax.swing.tree.DefaultTreeModel model,
                                                                           boolean allowDuplication,
                                                                           java.util.Comparator<? super T> comparator)

indexedBinarySearch

public static <T extends javax.swing.tree.TreeNode> int indexedBinarySearch(T parent,
                                                                            T key,
                                                                            java.util.Comparator<? super T> comparator)

getDisplayOrderComparator

public static java.util.Comparator<javax.swing.tree.TreePath> getDisplayOrderComparator(javax.swing.JTree tree)

expand

public static void expand(javax.swing.JTree tree,
                          TreeVisitor visitor,
                          java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer)

Expands a node in the specified tree.

Parameters:

tree - a tree, which nodes should be expanded

visitor - a visitor that controls expanding of tree nodes

consumer - a path consumer called on EDT if path is found and expanded

promiseExpand

public static Promise<javax.swing.tree.TreePath> promiseExpand(javax.swing.JTree tree,
                                                               TreeVisitor visitor)

Promises to expand a node in the specified tree. NB!: The returned promise may be resolved immediately, if this method is called on inappropriate background thread.

Parameters:

tree - a tree, which nodes should be expanded

visitor - a visitor that controls expanding of tree nodes

Returns:

a promise that will be succeed only if path is found and expanded

promiseExpand

public static Promise<java.util.List<javax.swing.tree.TreePath>> promiseExpand(javax.swing.JTree tree,
                                                                               java.util.stream.Stream<? extends TreeVisitor> visitors)

Promises to expand several nodes in the specified tree. NB!: The returned promise may be resolved immediately, if this method is called on inappropriate background thread.

Parameters:

tree - a tree, which nodes should be expanded

visitors - visitors to control expanding of tree nodes

Returns:

a promise that will be succeed only if paths are found and expanded

makeVisible

public static void makeVisible(javax.swing.JTree tree,
                               TreeVisitor visitor,
                               java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer)

Makes visible a node in the specified tree.

Parameters:

tree - a tree, which nodes should be made visible

visitor - a visitor that controls expanding of tree nodes

consumer - a path consumer called on EDT if path is found and made visible

promiseMakeVisible

public static Promise<javax.swing.tree.TreePath> promiseMakeVisible(javax.swing.JTree tree,
                                                                    TreeVisitor visitor)

Promises to make visible a node in the specified tree. NB!: The returned promise may be resolved immediately, if this method is called on inappropriate background thread.

Parameters:

tree - a tree, which nodes should be made visible

visitor - a visitor that controls expanding of tree nodes

Returns:

a promise that will be succeed only if path is found and made visible

promiseMakeVisible

public static Promise<java.util.List<javax.swing.tree.TreePath>> promiseMakeVisible(javax.swing.JTree tree,
                                                                                    java.util.stream.Stream<? extends TreeVisitor> visitors)

Promises to make visible several nodes in the specified tree. NB!: The returned promise may be resolved immediately, if this method is called on inappropriate background thread.

Parameters:

tree - a tree, which nodes should be made visible

visitors - visitors to control expanding of tree nodes

Returns:

a promise that will be succeed only if path are found and made visible

select

@Deprecated
public static void select(javax.swing.JTree tree,
                          TreeVisitor visitor,
                          java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer)

Deprecated. use promiseSelect(tree, visitor).onSuccess(consumer) instead

Selects a node in the specified tree.

Parameters:

tree - a tree, which nodes should be selected

visitor - a visitor that controls expanding of tree nodes

consumer - a path consumer called on EDT if path is found and selected

promiseSelect

public static Promise<javax.swing.tree.TreePath> promiseSelect(javax.swing.JTree tree,
                                                               TreeVisitor visitor)

Promises to select a node in the specified tree. NB!: The returned promise may be resolved immediately, if this method is called on inappropriate background thread.

Parameters:

tree - a tree, which nodes should be selected

visitor - a visitor that controls expanding of tree nodes

Returns:

a promise that will be succeed only if path is found and selected

promiseSelect

public static Promise<java.util.List<javax.swing.tree.TreePath>> promiseSelect(javax.swing.JTree tree,
                                                                               java.util.stream.Stream<? extends TreeVisitor> visitors)

Promises to select several nodes in the specified tree. NB!: The returned promise may be resolved immediately, if this method is called on inappropriate background thread.

Parameters:

tree - a tree, which nodes should be selected

visitors - visitors to control expanding of tree nodes

Returns:

a promise that will be succeed only if paths are found and selected

scrollToVisible

public static boolean scrollToVisible(javax.swing.JTree tree,
                                      javax.swing.tree.TreePath path,
                                      boolean centered)

Parameters:

tree - a tree to scroll

path - a visible tree path to scroll

centered - true to show the specified path

Returns:

false if a path is hidden (under a collapsed parent)

promiseSelectFirst

public static Promise<javax.swing.tree.TreePath> promiseSelectFirst(javax.swing.JTree tree)

Promises to select the first node in the specified tree. NB!: The returned promise may be resolved immediately, if this method is called on inappropriate background thread.

Parameters:

tree - a tree, which node should be selected

Returns:

a promise that will be succeed when first visible node is selected

promiseSelectFirstLeaf

public static Promise<javax.swing.tree.TreePath> promiseSelectFirstLeaf(javax.swing.JTree tree)

Promises to select the first leaf node in the specified tree. NB!: The returned promise may be resolved immediately, if this method is called on inappropriate background thread.

Parameters:

tree - a tree, which node should be selected

Returns:

a promise that will be succeed when first leaf node is made visible and selected

visit

public static void visit(javax.swing.JTree tree,
                         TreeVisitor visitor,
                         java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer)

Processes nodes in the specified tree.

Parameters:

tree - a tree, which nodes should be processed

visitor - a visitor that controls processing of tree nodes

consumer - a path consumer called on done

promiseVisit

public static Promise<javax.swing.tree.TreePath> promiseVisit(javax.swing.JTree tree,
                                                              TreeVisitor visitor)

Promises to process nodes in the specified tree. NB!: The returned promise may be resolved immediately, if this method is called on inappropriate background thread.

Parameters:

tree - a tree, which nodes should be processed

visitor - a visitor that controls processing of tree nodes

Returns:

a promise that will be succeed when visiting is finished

visitVisibleRows

public static javax.swing.tree.TreePath visitVisibleRows(javax.swing.JTree tree,
                                                         TreeVisitor visitor)

Processes visible nodes in the specified tree.

Parameters:

tree - a tree, which nodes should be processed

visitor - a visitor that controls processing of tree nodes

visitVisibleRows

public static <T> void visitVisibleRows(javax.swing.JTree tree,
                                        java.util.function.Function<? super javax.swing.tree.TreePath,? extends T> mapper,
                                        java.util.function.Consumer<? super T> consumer)

Processes visible nodes in the specified tree.

Parameters:

tree - a tree, which nodes should be processed

mapper - a function to convert a visible tree path to a corresponding object

consumer - a visible path processor