Package com.intellij.ide.hierarchy

Class HierarchyTreeStructure

java.lang.Object

com.intellij.ide.util.treeView.AbstractTreeStructure

com.intellij.ide.hierarchy.HierarchyTreeStructure

Direct Known Subclasses:

CalleeMethodsTreeStructure, CallerMethodsTreeStructure, MethodHierarchyTreeStructure, PyCallHierarchyTreeStructureBase, PySubTypesHierarchyTreeStructure, PySuperTypesHierarchyTreeStructure, SubtypesHierarchyTreeStructure, SupertypesHierarchyTreeStructure

public abstract class HierarchyTreeStructure
extends AbstractTreeStructure

Field Summary

Fields

Modifier and Type	Field and Description
protected HierarchyNodeDescriptor	myBaseDescriptor
protected Project	myProject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HierarchyTreeStructure(Project project, HierarchyNodeDescriptor baseDescriptor)

Method Summary

Modifier and Type	Method and Description
ActionCallback	asyncCommit()
protected abstract java.lang.Object []	buildChildren(HierarchyNodeDescriptor descriptor)
void	commit()
NodeDescriptor	createDescriptor(java.lang.Object element, NodeDescriptor parentDescriptor)
protected java.lang.String	formatBaseElementText()
HierarchyNodeDescriptor	getBaseDescriptor()
java.lang.Object []	getChildElements(java.lang.Object element)
LeafState	getLeafState(java.lang.Object element)
java.lang.Object	getParentElement(java.lang.Object element)
java.lang.Object	getRootElement()
protected SearchScope	getSearchScope(java.lang.String scopeType, PsiElement thisClass)
boolean	hasSomethingToCommit()
boolean	isAlwaysShowPlus()
protected boolean	isInScope(PsiElement baseClass, PsiElement srcElement, java.lang.String scopeType)
boolean	isToBuildChildrenInBackground(java.lang.Object element)
protected void	setBaseElement(HierarchyNodeDescriptor baseElement)

Methods inherited from class com.intellij.ide.util.treeView.AbstractTreeStructure

asyncCommitDocuments, isAlwaysLeaf, isValid, revalidateElement

Methods inherited from class java.lang.Object

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

Field Detail

myBaseDescriptor

protected HierarchyNodeDescriptor myBaseDescriptor

myProject

protected final Project myProject

Constructor Detail

HierarchyTreeStructure

protected HierarchyTreeStructure(Project project,
                                 HierarchyNodeDescriptor baseDescriptor)

Method Detail

getBaseDescriptor

public final HierarchyNodeDescriptor getBaseDescriptor()

setBaseElement

protected final void setBaseElement(HierarchyNodeDescriptor baseElement)

createDescriptor

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

Specified by:

createDescriptor in class AbstractTreeStructure

isToBuildChildrenInBackground

public final boolean isToBuildChildrenInBackground(java.lang.Object element)

Overrides:

isToBuildChildrenInBackground in class AbstractTreeStructure

getChildElements

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

Specified by:

getChildElements in class AbstractTreeStructure

getParentElement

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

Specified by:

getParentElement in class AbstractTreeStructure

commit

public final void commit()

Specified by:

commit in class AbstractTreeStructure

hasSomethingToCommit

public final boolean hasSomethingToCommit()

Specified by:

hasSomethingToCommit in class AbstractTreeStructure

asyncCommit

public ActionCallback asyncCommit()

Overrides:

asyncCommit in class AbstractTreeStructure

Returns:

callback which is set to ActionCallback.setDone() when the tree structure is committed. By default it just calls AbstractTreeStructure.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 AbstractTreeStructure.commit(), you can use AbstractTreeStructure.asyncCommitDocuments(Project) to do it asynchronously.

buildChildren

protected abstract java.lang.Object [] buildChildren(HierarchyNodeDescriptor descriptor)

getRootElement

public final java.lang.Object getRootElement()

Specified by:

getRootElement in class AbstractTreeStructure

getSearchScope

protected SearchScope getSearchScope(java.lang.String scopeType,
                                     PsiElement thisClass)

isInScope

protected boolean isInScope(PsiElement baseClass,
                            PsiElement srcElement,
                            java.lang.String scopeType)

getLeafState

public LeafState getLeafState(java.lang.Object element)

Overrides:

getLeafState in class AbstractTreeStructure

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()

isAlwaysShowPlus

public boolean isAlwaysShowPlus()

formatBaseElementText

protected java.lang.String formatBaseElementText()