Package com.intellij.ui.tree

Class AsyncTreeModel

java.lang.Object

com.intellij.util.ui.tree.AbstractTreeModel

com.intellij.ui.tree.AsyncTreeModel

All Implemented Interfaces:

Disposable, Identifiable, Navigatable, Searchable, TreeVisitor.Acceptor, javax.swing.tree.TreeModel

public final class AsyncTreeModel
extends AbstractTreeModel
implements Identifiable, Searchable, Navigatable, TreeVisitor.Acceptor

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
AsyncTreeModel(javax.swing.tree.TreeModel model) Deprecated. use AsyncTreeModel(TreeModel, Disposable) instead
AsyncTreeModel(javax.swing.tree.TreeModel model, boolean showLoadingNode) Deprecated. use AsyncTreeModel(TreeModel, boolean, Disposable) instead
AsyncTreeModel(javax.swing.tree.TreeModel model, boolean showLoadingNode, Disposable parent)
AsyncTreeModel(javax.swing.tree.TreeModel model, Disposable parent)

Method Summary

Modifier and Type	Method and Description
Promise<javax.swing.tree.TreePath>	accept(TreeVisitor visitor) Starts visiting the tree structure with loading all needed children.
Promise<javax.swing.tree.TreePath>	accept(TreeVisitor visitor, boolean allowLoading) Starts visiting the tree structure.
void	dispose() Usually not invoked directly, see class javadoc.
java.lang.Object	getChild(java.lang.Object object, int index)
int	getChildCount(java.lang.Object object)
int	getIndexOfChild(java.lang.Object object, java.lang.Object child)
java.lang.Object	getRoot()
Promise<javax.swing.tree.TreePath>	getTreePath(java.lang.Object object) Starts searching by the specified object.
java.lang.Object	getUniqueID(javax.swing.tree.TreePath path) Returns an unique identifier for the specified path if applicable.
boolean	isLeaf(java.lang.Object object)
boolean	isProcessing()
Promise<javax.swing.tree.TreePath>	nextTreePath(javax.swing.tree.TreePath path, java.lang.Object object)
void	onValidThread(java.lang.Runnable runnable)
Promise<javax.swing.tree.TreePath>	prevTreePath(javax.swing.tree.TreePath path, java.lang.Object object)
Promise<javax.swing.tree.TreePath>	resolve(javax.swing.tree.TreePath path)
void	setRootImmediately(java.lang.Object object) Deprecated. do not use
protected void	treeNodesChanged(javax.swing.tree.TreePath path, int[] indices, java.lang.Object[] children) Notifies all added listeners that some nodes were changed.
protected void	treeNodesInserted(javax.swing.tree.TreePath path, int[] indices, java.lang.Object[] children) Notifies all added listeners that some nodes were inserted.
protected void	treeNodesRemoved(javax.swing.tree.TreePath path, int[] indices, java.lang.Object[] children) /** Notifies all added listeners that some nodes were removed.
protected void	treeStructureChanged(javax.swing.tree.TreePath path, int[] indices, java.lang.Object[] children) Notifies all added listeners that a tree hierarchy was changed.
void	valueForPathChanged(javax.swing.tree.TreePath path, java.lang.Object value)

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

addTreeModelListener, removeTreeModelListener

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncTreeModel

@Deprecated
public AsyncTreeModel(javax.swing.tree.TreeModel model)

Deprecated. use AsyncTreeModel(TreeModel, Disposable) instead

AsyncTreeModel

@Deprecated
public AsyncTreeModel(javax.swing.tree.TreeModel model,
                      boolean showLoadingNode)

Deprecated. use AsyncTreeModel(TreeModel, boolean, Disposable) instead

AsyncTreeModel

public AsyncTreeModel(javax.swing.tree.TreeModel model,
                      Disposable parent)

AsyncTreeModel

public AsyncTreeModel(javax.swing.tree.TreeModel model,
                      boolean showLoadingNode,
                      Disposable parent)

Method Detail

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

getUniqueID

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

Description copied from interface: Identifiable

Returns an unique identifier for the specified path if applicable. This method is usually used to store a tree state on disposing, so we cannot use invoker to calculate it later on a valid thread, and an implementor must be ready to support any thread.

Specified by:

getUniqueID in interface Identifiable

Parameters:

path - a tree path in the current tree model

Returns:

an unique identifier for the specified path, or null if not applicable

See Also:

Searchable.getTreePath(java.lang.Object)

getTreePath

public Promise<javax.swing.tree.TreePath> getTreePath(java.lang.Object object)

Description copied from interface: Searchable

Starts searching by the specified object.

Specified by:

getTreePath in interface Searchable

Parameters:

object - an object to identify a tree path

Returns:

a Promise containing a search result

See Also:

Identifiable.getUniqueID(javax.swing.tree.TreePath)

nextTreePath

public Promise<javax.swing.tree.TreePath> nextTreePath(javax.swing.tree.TreePath path,
                                                       java.lang.Object object)

Specified by:

nextTreePath in interface Navigatable

prevTreePath

public Promise<javax.swing.tree.TreePath> prevTreePath(javax.swing.tree.TreePath path,
                                                       java.lang.Object object)

Specified by:

prevTreePath in interface Navigatable

resolve

public Promise<javax.swing.tree.TreePath> resolve(javax.swing.tree.TreePath path)

getRoot

public java.lang.Object getRoot()

Specified by:

getRoot in interface javax.swing.tree.TreeModel

getChild

public java.lang.Object getChild(java.lang.Object object,
                                 int index)

Specified by:

getChild in interface javax.swing.tree.TreeModel

getChildCount

public int getChildCount(java.lang.Object object)

Specified by:

getChildCount in interface javax.swing.tree.TreeModel

isLeaf

public boolean isLeaf(java.lang.Object object)

Specified by:

isLeaf in interface javax.swing.tree.TreeModel

valueForPathChanged

public void valueForPathChanged(javax.swing.tree.TreePath path,
                                java.lang.Object value)

Specified by:

valueForPathChanged in interface javax.swing.tree.TreeModel

Overrides:

valueForPathChanged in class AbstractTreeModel

Parameters:

path - the path to the node that the user has altered

value - the new value from the tree cell editor

See Also:

DefaultTreeModel.valueForPathChanged(javax.swing.tree.TreePath, java.lang.Object)

getIndexOfChild

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

Specified by:

getIndexOfChild in interface javax.swing.tree.TreeModel

accept

public Promise<javax.swing.tree.TreePath> accept(TreeVisitor visitor)

Starts visiting the tree structure with loading all needed children.

Specified by:

accept in interface TreeVisitor.Acceptor

Parameters:

visitor - an object that controls visiting a tree structure

Returns:

a promise that will be resolved when visiting is finished

accept

public Promise<javax.swing.tree.TreePath> accept(TreeVisitor visitor,
                                                 boolean allowLoading)

Starts visiting the tree structure.

Parameters:

visitor - an object that controls visiting a tree structure

allowLoading - load all needed children if true

Returns:

a promise that will be resolved when visiting is finished

isProcessing

public boolean isProcessing()

Returns:

true if this model is updating its structure

onValidThread

public void onValidThread(java.lang.Runnable runnable)

treeStructureChanged

protected void treeStructureChanged(javax.swing.tree.TreePath path,
                                    int[] indices,
                                    java.lang.Object[] children)

Description copied from class: AbstractTreeModel

Notifies all added listeners that a tree hierarchy was changed.

Overrides:

treeStructureChanged in class AbstractTreeModel

Parameters:

path - the path to the parent of the modified items

indices - index values of the modified items

children - an array containing the inserted, removed, or changed objects

See Also:

TreeModelListener.treeStructureChanged(TreeModelEvent)

treeNodesChanged

protected void treeNodesChanged(javax.swing.tree.TreePath path,
                                int[] indices,
                                java.lang.Object[] children)

Description copied from class: AbstractTreeModel

Notifies all added listeners that some nodes were changed.

Overrides:

treeNodesChanged in class AbstractTreeModel

Parameters:

path - the path to the parent of the modified items

indices - index values of the modified items

children - an array containing the inserted, removed, or changed objects

See Also:

TreeModelListener.treeNodesChanged(TreeModelEvent)

treeNodesInserted

protected void treeNodesInserted(javax.swing.tree.TreePath path,
                                 int[] indices,
                                 java.lang.Object[] children)

Description copied from class: AbstractTreeModel

Notifies all added listeners that some nodes were inserted.

Overrides:

treeNodesInserted in class AbstractTreeModel

Parameters:

path - the path to the parent of the modified items

indices - index values of the modified items

children - an array containing the inserted, removed, or changed objects

See Also:

TreeModelListener.treeNodesInserted(TreeModelEvent)

treeNodesRemoved

protected void treeNodesRemoved(javax.swing.tree.TreePath path,
                                int[] indices,
                                java.lang.Object[] children)

Description copied from class: AbstractTreeModel

/** Notifies all added listeners that some nodes were removed.

Overrides:

treeNodesRemoved in class AbstractTreeModel

Parameters:

path - the path to the parent of the modified items

indices - index values of the modified items

children - an array containing the inserted, removed, or changed objects

See Also:

TreeModelListener.treeNodesRemoved(TreeModelEvent)

setRootImmediately

@Deprecated
public void setRootImmediately(java.lang.Object object)

Deprecated. do not use