Package com.intellij.ui.tree

Class StructureTreeModel<Structure extends AbstractTreeStructure>

java.lang.Object

com.intellij.util.ui.tree.AbstractTreeModel

com.intellij.ui.tree.StructureTreeModel<Structure>

All Implemented Interfaces:

Disposable, ChildrenProvider<javax.swing.tree.TreeNode>, InvokerSupplier, javax.swing.tree.TreeModel

public class StructureTreeModel<Structure extends AbstractTreeStructure>
extends AbstractTreeModel
implements Disposable, InvokerSupplier, ChildrenProvider<javax.swing.tree.TreeNode>

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from class com.intellij.util.ui.tree.AbstractTreeModel

disposed, listeners

Constructor Summary

Constructors

Constructor and Description
StructureTreeModel(Structure structure, java.util.Comparator<? super NodeDescriptor<?>> comparator, Disposable parent)
StructureTreeModel(Structure structure, java.util.Comparator<? super NodeDescriptor<?>> comparator, Invoker invoker, Disposable parent)
StructureTreeModel(Structure structure, Disposable parent)

Method Summary

Modifier and Type	Method and Description
void	dispose() Usually not invoked directly, see class javadoc.
void	expand(java.lang.Object element, javax.swing.JTree tree, java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer) Expands a node in the specified tree.
javax.swing.tree.TreeNode	getChild(java.lang.Object object, int index)
int	getChildCount(java.lang.Object object)
java.util.List<javax.swing.tree.TreeNode>	getChildren(java.lang.Object object)
int	getIndexOfChild(java.lang.Object object, java.lang.Object child)
Invoker	getInvoker()
javax.swing.tree.TreeNode	getRoot()
javax.swing.tree.TreeNode	getRootImmediately() Deprecated. do not use
Promise<?>	invalidate() Invalidates all nodes and notifies Swing model that a whole tree hierarchy is changed.
Promise<javax.swing.tree.TreePath>	invalidate(java.lang.Object element, boolean structure) Invalidates specified nodes and notifies Swing model that these nodes are changed.
Promise<javax.swing.tree.TreePath>	invalidate(javax.swing.tree.TreePath path, boolean structure) Invalidates specified nodes and notifies Swing model that these nodes are changed.
boolean	isLeaf(java.lang.Object object)
void	makeVisible(java.lang.Object element, javax.swing.JTree tree, java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer) Makes visible a node in the specified tree.
Promise<TreeVisitor>	promiseVisitor(java.lang.Object element) Promises to create default visitor to find the specified element.
void	select(java.lang.Object element, javax.swing.JTree tree, java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer) Selects a node in the specified tree.
void	setComparator(java.util.Comparator<? super NodeDescriptor<?>> comparator)
java.lang.String	toString()

Methods inherited from class com.intellij.util.ui.tree.AbstractTreeModel

addTreeModelListener, removeTreeModelListener, treeNodesChanged, treeNodesInserted, treeNodesRemoved, treeStructureChanged, valueForPathChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureTreeModel

public StructureTreeModel(Structure structure,
                          Disposable parent)

StructureTreeModel

public StructureTreeModel(Structure structure,
                          java.util.Comparator<? super NodeDescriptor<?>> comparator,
                          Disposable parent)

StructureTreeModel

public StructureTreeModel(Structure structure,
                          java.util.Comparator<? super NodeDescriptor<?>> comparator,
                          Invoker invoker,
                          Disposable parent)

Method Detail

setComparator

public final void setComparator(java.util.Comparator<? super NodeDescriptor<?>> comparator)

Parameters:

comparator - a comparator to sort tree nodes or null to disable sorting

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

Overrides:

dispose in class AbstractTreeModel

getInvoker

public final Invoker getInvoker()

Specified by:

getInvoker in interface InvokerSupplier

Returns:

preferable invoker to be used to access the supplier

invalidate

public final Promise<?> invalidate()

Invalidates all nodes and notifies Swing model that a whole tree hierarchy is changed.

invalidate

public final Promise<javax.swing.tree.TreePath> invalidate(javax.swing.tree.TreePath path,
                                                           boolean structure)

Invalidates specified nodes and notifies Swing model that these nodes are changed.

Parameters:

path - a path to the node to invalidate

structure - true means that all child nodes must be invalidated; false means that only the node specified by path must be updated

Returns:

a promise that will be succeed if path to invalidate is found

See Also:

invalidate(Object, boolean)

invalidate

public final Promise<javax.swing.tree.TreePath> invalidate(java.lang.Object element,
                                                           boolean structure)

Invalidates specified nodes and notifies Swing model that these nodes are changed. This method does not bother Swing model if the corresponding nodes have not yet been loaded.

Parameters:

element - an element of the internal tree structure

structure - true means that all child nodes must be invalidated; false means that only the node specified by path must be updated

Returns:

a promise that will be succeed if path to invalidate is found

See Also:

invalidate(TreePath, boolean)

expand

public final void expand(java.lang.Object element,
                         javax.swing.JTree tree,
                         java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer)

Expands a node in the specified tree.

Parameters:

element - an element of the internal tree structure

tree - a tree, which nodes should be expanded

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

makeVisible

public final void makeVisible(java.lang.Object element,
                              javax.swing.JTree tree,
                              java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer)

Makes visible a node in the specified tree.

Parameters:

element - an element of the internal tree structure

tree - a tree, which nodes should be made visible

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

select

public final void select(java.lang.Object element,
                         javax.swing.JTree tree,
                         java.util.function.Consumer<? super javax.swing.tree.TreePath> consumer)

Selects a node in the specified tree.

Parameters:

element - an element of the internal tree structure

tree - a tree, which nodes should be selected

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

promiseVisitor

public final Promise<TreeVisitor> promiseVisitor(java.lang.Object element)

Promises to create default visitor to find the specified element.

Parameters:

element - an element of the internal tree structure

Returns:

a promise that will be succeed if visitor is created

See Also:

TreeUtil.promiseExpand(JTree, TreeVisitor), TreeUtil.promiseSelect(JTree, TreeVisitor)

getRoot

public final javax.swing.tree.TreeNode getRoot()

Specified by:

getRoot in interface javax.swing.tree.TreeModel

getChildren

public final java.util.List<javax.swing.tree.TreeNode> getChildren(java.lang.Object object)

Specified by:

getChildren in interface ChildrenProvider<javax.swing.tree.TreeNode>

Parameters:

object - a tree node

Returns:

all children of the specified parent node or null if they are not ready yet

getChildCount

public final int getChildCount(java.lang.Object object)

Specified by:

getChildCount in interface javax.swing.tree.TreeModel

getChild

public final javax.swing.tree.TreeNode getChild(java.lang.Object object,
                                                int index)

Specified by:

getChild in interface javax.swing.tree.TreeModel

isLeaf

public final boolean isLeaf(java.lang.Object object)

Specified by:

isLeaf in interface javax.swing.tree.TreeModel

getIndexOfChild

public final int getIndexOfChild(java.lang.Object object,
                                 java.lang.Object child)

Specified by:

getIndexOfChild in interface javax.swing.tree.TreeModel

getRootImmediately

@Deprecated
public final javax.swing.tree.TreeNode getRootImmediately()

Deprecated. do not use

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a descriptive name for the instance to help a tree identification

See Also:

Invoker(String, Disposable, com.intellij.util.ThreeState)