com.intellij.usages.impl.rules
Class FileGroupingRule.FileUsageGroup

java.lang.Object
  com.intellij.usages.impl.rules.FileGroupingRule.FileUsageGroup

All Implemented Interfaces:

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

Enclosing class:

FileGroupingRule

protected static class FileGroupingRule.FileUsageGroup
extends java.lang.Object
implements UsageGroup, DataProvider

Constructor Summary

FileGroupingRule.FileUsageGroup(Project project, VirtualFile file)

Method Summary

boolean	canNavigate()
boolean	canNavigateToSource()
int	compareTo(UsageGroup usageGroup)
boolean	equals(java.lang.Object o)
java.lang.Object	getData(java.lang.String dataId) Returns the object corresponding to the specified data identifier.
FileStatus	getFileStatus()
javax.swing.Icon	getIcon(boolean isOpen)
PsiFile	getPsiFile()
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

FileGroupingRule.FileUsageGroup

public FileGroupingRule.FileUsageGroup(Project project,
                                       VirtualFile file)

Method Detail

update

public void update()

Specified by:

update in interface UsageGroup

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getIcon

public javax.swing.Icon getIcon(boolean isOpen)

Specified by:

getIcon in interface UsageGroup

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

Throws:

java.lang.UnsupportedOperationException

canNavigate

public boolean canNavigate()

Specified by:

canNavigate in interface Navigatable

Returns:

false if navigation is not possible for any reason.

canNavigateToSource

public boolean canNavigateToSource()

Specified by:

canNavigateToSource in interface Navigatable

Returns:

false if navigation to source is not possible for any reason. Source means some kind of editor

compareTo

public int compareTo(UsageGroup usageGroup)

Specified by:

compareTo in interface java.lang.Comparable<UsageGroup>

getData

public java.lang.Object getData(java.lang.String dataId)

Description copied from interface: DataProvider

Returns the object corresponding to the specified data identifier. Some of the supported data identifiers are defined in the DataConstants class.

Specified by:

getData in interface DataProvider

Parameters:

dataId - the data identifier for which the value is requested.

Returns:

the value, or null if no value is available in the current context for this identifier.

getPsiFile

public PsiFile getPsiFile()