Package com.intellij.usages

Class UsageInfo2UsageAdapter

java.lang.Object

com.intellij.usages.UsageInfo2UsageAdapter

All Implemented Interfaces:

TypeSafeDataProvider, Navigatable, RenameableUsage, MergeableUsage, PsiElementUsage, UsageInFile, UsageInLibrary, UsageInModule, Usage, UsagePresentation, java.lang.Comparable<UsageInfo2UsageAdapter>

Direct Known Subclasses:

ReadWriteAccessUsageInfo2UsageAdapter, SliceUsage

public class UsageInfo2UsageAdapter
extends java.lang.Object
implements UsageInModule, UsageInLibrary, UsageInFile, PsiElementUsage, MergeableUsage, java.lang.Comparable<UsageInfo2UsageAdapter>, RenameableUsage, TypeSafeDataProvider, UsagePresentation

Field Summary

Fields

Modifier and Type	Field and Description
static NotNullFunction<UsageInfo,Usage>	CONVERTER
protected javax.swing.Icon	myIcon

Fields inherited from interface com.intellij.usages.Usage

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
UsageInfo2UsageAdapter(UsageInfo usageInfo)

Method Summary

Modifier and Type	Method and Description
void	calcData(DataKey key, DataSink sink)
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(UsageInfo2UsageAdapter o)
static UsageInfo2UsageAdapter []	convert(UsageInfo [] usageInfos)
TextChunk []	getCachedText() If the implementation caches or lazy-loades the text chunks internally, this method gives it a chance to avoid re-calculating it synchronously on EDT and return the possibly obsolete data.
Document	getDocument()
PsiElement	getElement()
VirtualFile	getFile()
javax.swing.Icon	getIcon()
OrderEntry	getLibraryEntry()
int	getLine()
FileEditorLocation	getLocation()
UsageInfo []	getMergedInfos()
Module	getModule()
Segment	getNavigationRange() Returns the text range of the usage relative to the start of the file.
java.lang.String	getPlainText()
UsagePresentation	getPresentation()
java.util.List<SyntheticLibrary>	getSyntheticLibraries()
TextChunk []	getText()
java.lang.String	getTooltipText()
UsageInfo	getUsageInfo()
UsageType	getUsageType()
void	highlightInEditor()
boolean	isNonCodeUsage()
boolean	isReadOnly()
boolean	isValid()
boolean	merge(MergeableUsage other)
void	navigate(boolean focus) Open editor and select/navigate to the object there if possible.
Editor	openTextEditor(boolean focus)
boolean	processRangeMarkers(Processor<? super Segment> processor)
void	rename(java.lang.String newName)
void	reset() Revert to original status prior any merges
void	selectInEditor()
java.lang.String	toString()
void	updateCachedText()

Methods inherited from class java.lang.Object

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

Field Detail

CONVERTER

public static final NotNullFunction<UsageInfo,Usage> CONVERTER

myIcon

protected javax.swing.Icon myIcon

Constructor Detail

UsageInfo2UsageAdapter

public UsageInfo2UsageAdapter(UsageInfo usageInfo)

Method Detail

getPresentation

public UsagePresentation getPresentation()

Specified by:

getPresentation in interface Usage

isValid

public boolean isValid()

Specified by:

isValid in interface Usage

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface Usage

getLocation

public FileEditorLocation getLocation()

Specified by:

getLocation in interface Usage

selectInEditor

public void selectInEditor()

Specified by:

selectInEditor in interface Usage

highlightInEditor

public void highlightInEditor()

Specified by:

highlightInEditor in interface Usage

processRangeMarkers

public boolean processRangeMarkers(Processor<? super Segment> processor)

getDocument

public Document getDocument()

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

openTextEditor

public Editor openTextEditor(boolean focus)

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.

getNavigationRange

public Segment getNavigationRange()

Returns the text range of the usage relative to the start of the file.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getModule

public Module getModule()

Specified by:

getModule in interface UsageInModule

getLibraryEntry

public OrderEntry getLibraryEntry()

Specified by:

getLibraryEntry in interface UsageInLibrary

getSyntheticLibraries

public java.util.List<SyntheticLibrary> getSyntheticLibraries()

Specified by:

getSyntheticLibraries in interface UsageInLibrary

getFile

public VirtualFile getFile()

Specified by:

getFile in interface UsageInFile

getLine

public int getLine()

merge

public boolean merge(MergeableUsage other)

Specified by:

merge in interface MergeableUsage

Returns:

true if merge succeeded

reset

public void reset()

Description copied from interface: MergeableUsage

Revert to original status prior any merges

Specified by:

reset in interface MergeableUsage

getElement

public final PsiElement getElement()

Specified by:

getElement in interface PsiElementUsage

isNonCodeUsage

public boolean isNonCodeUsage()

Specified by:

isNonCodeUsage in interface PsiElementUsage

getUsageInfo

public UsageInfo getUsageInfo()

compareTo

public int compareTo(UsageInfo2UsageAdapter o)

Specified by:

compareTo in interface java.lang.Comparable<UsageInfo2UsageAdapter>

rename

public void rename(java.lang.String newName)
            throws IncorrectOperationException

Specified by:

rename in interface RenameableUsage

Throws:

IncorrectOperationException

convert

public static UsageInfo2UsageAdapter [] convert(UsageInfo [] usageInfos)

calcData

public void calcData(DataKey key,
                     DataSink sink)

Specified by:

calcData in interface TypeSafeDataProvider

getMergedInfos

public UsageInfo [] getMergedInfos()

getText

public TextChunk [] getText()

Specified by:

getText in interface UsagePresentation

getCachedText

public TextChunk [] getCachedText()

Description copied from interface: UsagePresentation

If the implementation caches or lazy-loades the text chunks internally, this method gives it a chance to avoid re-calculating it synchronously on EDT and return the possibly obsolete data. The component using this presentation might call UsagePresentation.updateCachedText() in a background thread and then use UsagePresentation.getCachedText() to draw the text.

Specified by:

getCachedText in interface UsagePresentation

updateCachedText

public void updateCachedText()

Specified by:

updateCachedText in interface UsagePresentation

getPlainText

public java.lang.String getPlainText()

Specified by:

getPlainText in interface UsagePresentation

getIcon

public javax.swing.Icon getIcon()

Specified by:

getIcon in interface UsagePresentation

getTooltipText

public java.lang.String getTooltipText()

Specified by:

getTooltipText in interface UsagePresentation

getUsageType

public UsageType getUsageType()