Package com.intellij.ide.util.treeView

Class AbstractTreeStructure

java.lang.Object

com.intellij.ide.util.treeView.AbstractTreeStructure

Direct Known Subclasses:

AbstractTreeStructureBase, CoverageViewTreeStructure, ErrorViewStructure, FileTreeStructure, FilteringTreeStructure, HierarchyTreeStructure, SimpleTreeStructure, SmartTreeStructure, TreeContentProvider, ViewerTreeStructure

public abstract class AbstractTreeStructure
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractTreeStructure()

Method Summary

Modifier and Type	Method and Description
ActionCallback	asyncCommit()
static ActionCallback	asyncCommitDocuments(Project project)
abstract void	commit()
abstract NodeDescriptor	createDescriptor(java.lang.Object element, NodeDescriptor parentDescriptor)
abstract java.lang.Object []	getChildElements(java.lang.Object element)
LeafState	getLeafState(java.lang.Object element)
abstract java.lang.Object	getParentElement(java.lang.Object element)
abstract java.lang.Object	getRootElement()
abstract boolean	hasSomethingToCommit()
boolean	isAlwaysLeaf(java.lang.Object element)
boolean	isToBuildChildrenInBackground(java.lang.Object element)
boolean	isValid(java.lang.Object element)
<any>	revalidateElement(java.lang.Object element)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTreeStructure

public AbstractTreeStructure()

Method Detail

getRootElement

public abstract java.lang.Object getRootElement()

getChildElements

public abstract java.lang.Object [] getChildElements(java.lang.Object element)

getParentElement

public abstract java.lang.Object getParentElement(java.lang.Object element)

createDescriptor

public abstract NodeDescriptor createDescriptor(java.lang.Object element,
                                                NodeDescriptor parentDescriptor)

commit

public abstract void commit()

hasSomethingToCommit

public abstract boolean hasSomethingToCommit()

asyncCommitDocuments

public static ActionCallback asyncCommitDocuments(Project project)

asyncCommit

public ActionCallback asyncCommit()

Returns:

callback which is set to ActionCallback.setDone() when the tree structure is committed. By default it just calls commit() synchronously but it is desirable to override it to provide asynchronous commit to the tree structure to make it more responsible. E.g. when you should commit all documents during the commit(), you can use asyncCommitDocuments(Project) to do it asynchronously.

isToBuildChildrenInBackground

public boolean isToBuildChildrenInBackground(java.lang.Object element)

isValid

public boolean isValid(java.lang.Object element)

getLeafState

public LeafState getLeafState(java.lang.Object element)

Parameters:

element - an object that represents a node in this tree structure

Returns:

a leaf state for the given element

See Also:

LeafState.Supplier#getLeafState()

isAlwaysLeaf

public boolean isAlwaysLeaf(java.lang.Object element)

revalidateElement

public <any> revalidateElement(java.lang.Object element)