Package com.intellij.usages

Class PsiElementUsageGroupBase<T extends PsiElement & NavigationItem>

java.lang.Object

com.intellij.usages.PsiElementUsageGroupBase<T>

All Implemented Interfaces:

Navigatable, NamedPresentably, UsageGroup, java.lang.Comparable<UsageGroup>

Direct Known Subclasses:

PsiNamedElementUsageGroupBase

public class PsiElementUsageGroupBase<T extends PsiElement & NavigationItem>
extends java.lang.Object
implements UsageGroup, NamedPresentably

Constructor Summary

Constructors

Constructor and Description
PsiElementUsageGroupBase(T element)
PsiElementUsageGroupBase(T element, javax.swing.Icon icon)

Method Summary

Modifier and Type	Method and Description
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).
int	compareTo(UsageGroup o)
boolean	equals(java.lang.Object obj)
T	getElement()
FileStatus	getFileStatus()
javax.swing.Icon	getIcon(boolean isOpen)
java.lang.String	getPresentableName()
java.lang.String	getText(UsageView view)
int	hashCode()
boolean	isValid()
void	navigate(boolean focus) Open editor and select/navigate to the object there if possible.
void	update()

Methods inherited from class java.lang.Object

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

Constructor Detail

PsiElementUsageGroupBase

public PsiElementUsageGroupBase(T element,
                                javax.swing.Icon icon)

PsiElementUsageGroupBase

public PsiElementUsageGroupBase(T element)

Method Detail

getIcon

public javax.swing.Icon getIcon(boolean isOpen)

Specified by:

getIcon in interface UsageGroup

getElement

public T getElement()

getText

public java.lang.String getText(UsageView view)

Specified by:

getText in interface UsageGroup

getFileStatus

public FileStatus getFileStatus()

Specified by:

getFileStatus in interface UsageGroup

isValid

public boolean isValid()

Specified by:

isValid in interface UsageGroup

navigate

public void navigate(boolean focus)
              throws java.lang.UnsupportedOperationException

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:

focus - true if focus requesting is necessary

Throws:

java.lang.UnsupportedOperationException

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.

update

public void update()

Specified by:

update in interface UsageGroup

compareTo

public int compareTo(UsageGroup o)

Specified by:

compareTo in interface java.lang.Comparable<UsageGroup>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getPresentableName

public java.lang.String getPresentableName()

Specified by:

getPresentableName in interface NamedPresentably