Package com.intellij.ide.hierarchy.call

Class CallHierarchyNodeDescriptor

java.lang.Object

com.intellij.ide.util.treeView.NodeDescriptor

com.intellij.ide.util.treeView.SmartElementDescriptor

com.intellij.ide.hierarchy.HierarchyNodeDescriptor

com.intellij.ide.hierarchy.call.CallHierarchyNodeDescriptor

All Implemented Interfaces:

Navigatable

public final class CallHierarchyNodeDescriptor
extends HierarchyNodeDescriptor
implements Navigatable

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.ide.util.treeView.NodeDescriptor

NodeDescriptor.NodeComparator<T extends NodeDescriptor<?>>

Field Summary

Fields inherited from class com.intellij.ide.hierarchy.HierarchyNodeDescriptor

myHighlightedText, myIsBase

Fields inherited from class com.intellij.ide.util.treeView.NodeDescriptor

DEFAULT_WEIGHT, EMPTY_ARRAY, myClosedIcon, myColor, myName, myOpenIcon, myProject

Constructor Summary

Constructors

Constructor and Description
CallHierarchyNodeDescriptor(Project project, HierarchyNodeDescriptor parentDescriptor, PsiElement element, boolean isBase, boolean navigateToReference)

Method Summary

Modifier and Type	Method and Description
void	addReference(PsiReference reference)
boolean	canNavigate() Indicates whether this instance supports navigation of any kind.
boolean	canNavigateToSource() Indicates whether this instance supports navigation to source (that means some kind of editor).
PsiMember	getEnclosingElement()
static PsiMember	getEnclosingElement(PsiElement element)
PsiElement	getTargetElement() Element for OpenFileDescriptor
boolean	hasReference(PsiReference reference)
void	incrementUsageCount()
boolean	isValid()
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
boolean	update() Make sure the descriptor is up to date with its content

Methods inherited from class com.intellij.ide.hierarchy.HierarchyNodeDescriptor

expandOnDoubleClick, getBaseMarkerIcon, getCachedChildren, getContainingFile, getElement, getHighlightedText, getInvalidPrefixAttributes, getPackageNameAttributes, getUsageCountPrefixAttributes, installIcon, installIcon, installIcon, invalidElement, isMarkModified, isMarkReadOnly, setCachedChildren

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

getIcon, getPsiElement

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

applyFrom, getChildrenSortingStamp, getClosedIcon, getColor, getIcon, getIndex, getOpenIcon, getParentDescriptor, getProject, getUpdateCount, getWeight, isWasDeclaredAlwaysLeaf, setChildrenSortingStamp, setIcon, setIndex, setUpdateCount, setWasDeclaredAlwaysLeaf, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CallHierarchyNodeDescriptor

public CallHierarchyNodeDescriptor(Project project,
                                   HierarchyNodeDescriptor parentDescriptor,
                                   PsiElement element,
                                   boolean isBase,
                                   boolean navigateToReference)

Method Detail

getEnclosingElement

public final PsiMember getEnclosingElement()

Returns:

PsiMethod or PsiClass or JspFile

getEnclosingElement

public static PsiMember getEnclosingElement(PsiElement element)

incrementUsageCount

public final void incrementUsageCount()

getTargetElement

public final PsiElement getTargetElement()

Element for OpenFileDescriptor

isValid

public final boolean isValid()

Overrides:

isValid in class HierarchyNodeDescriptor

update

public final boolean update()

Description copied from class: NodeDescriptor

Make sure the descriptor is up to date with its content

Overrides:

update in class SmartElementDescriptor

Returns:

true if any descriptor's properties changed during the update

addReference

public void addReference(PsiReference reference)

hasReference

public boolean hasReference(PsiReference reference)

navigate

public void navigate(boolean requestFocus)

Description copied from interface: Navigatable

Open editor and select/navigate to the object there if possible. Just do nothing if navigation is not possible like in case of a package

Specified by:

navigate in interface Navigatable

Parameters:

requestFocus - true if focus requesting is necessary

canNavigate

public boolean canNavigate()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation of any kind. Usually this method is called to ensure that navigation is possible. Note that it is not called if navigation to source is supported, i.e. Navigatable.canNavigateToSource() returns true. We assume that this method should return true in such case, so implement this method respectively.

Specified by:

canNavigate in interface Navigatable

Returns:

false if navigation is not possible for any reason.

canNavigateToSource

public boolean canNavigateToSource()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation to source (that means some kind of editor). Note that navigation can be supported even if this method returns false. In such cases it is not recommended to do batch navigation for all navigatables available via CommonDataKeys.NAVIGATABLE_ARRAY, because it may lead to opening several modal dialogs. Use OpenSourceUtil.navigate(com.intellij.pom.Navigatable...) to process such arrays correctly.

Specified by:

canNavigateToSource in interface Navigatable

Returns:

false if navigation to source is not possible for any reason.