Package com.intellij.usages.impl.rules

Class UsageGroupBase

java.lang.Object

com.intellij.usages.impl.rules.UsageGroupBase

All Implemented Interfaces:

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

public abstract class UsageGroupBase
extends java.lang.Object
implements UsageGroup

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UsageGroupBase(int order)

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)
FileStatus	getFileStatus()
javax.swing.Icon	getIcon(boolean isOpen)
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.intellij.usages.UsageGroup

getText

Constructor Detail

UsageGroupBase

protected UsageGroupBase(int order)

Method Detail

update

public void update()

Specified by:

update in interface UsageGroup

getFileStatus

public FileStatus getFileStatus()

Specified by:

getFileStatus in interface UsageGroup

isValid

public boolean isValid()

Specified by:

isValid in interface UsageGroup

getIcon

public javax.swing.Icon getIcon(boolean isOpen)

Specified by:

getIcon in interface UsageGroup

navigate

public void navigate(boolean focus)

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

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.

compareTo

public int compareTo(UsageGroup o)

Specified by:

compareTo in interface java.lang.Comparable<UsageGroup>