Package com.intellij.usages

Interface UsageView

All Superinterfaces:

Disposable

All Known Subinterfaces:

UsageViewEx

All Known Implementing Classes:

UsageViewImpl

public interface UsageView
extends Disposable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UsageView.ExcludeListener

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static DataKey<UsageInfo>	USAGE_INFO_KEY
static DataKey<java.util.List<UsageInfo>>	USAGE_INFO_LIST_KEY
static DataKey<SearchScope>	USAGE_SCOPE
static DataKey<UsageTarget[]>	USAGE_TARGETS_KEY Returns UsageTarget to look usages for
static DataKey<UsageView>	USAGE_VIEW_KEY
static DataKey<Usage[]>	USAGES_KEY Returns Usage which are selected in usage view

Method Summary

Modifier and Type	Method and Description
void	addButtonToLowerPane(javax.swing.Action action)
void	addButtonToLowerPane(java.lang.Runnable runnable, java.lang.String text)
void	addButtonToLowerPane(java.lang.Runnable runnable, java.lang.String text, char mnemonic) Deprecated. please specify mnemonic by prefixing the mnemonic character with an ampersand (&& for Mac-specific ampersands)
default void	addExcludeListener(Disposable disposable, UsageView.ExcludeListener listener)
void	addPerformOperationAction(java.lang.Runnable processRunnable, java.lang.String commandName, java.lang.String cannotMakeString, java.lang.String shortDescription)
void	addPerformOperationAction(java.lang.Runnable processRunnable, java.lang.String commandName, java.lang.String cannotMakeString, java.lang.String shortDescription, boolean checkReadOnlyStatus)
void	appendUsage(Usage usage)
void	close()
void	excludeUsages(Usage [] usages)
javax.swing.JComponent	getComponent()
java.util.Set<Usage>	getExcludedUsages()
default javax.swing.JComponent	getPreferredFocusableComponent()
UsageViewPresentation	getPresentation()
java.util.Set<Usage>	getSelectedUsages()
java.util.List<Usage>	getSortedUsages()
java.util.Set<Usage>	getUsages()
int	getUsagesCount()
void	includeUsages(Usage [] usages)
boolean	isSearchInProgress()
void	removeUsage(Usage usage)
void	removeUsagesBulk(java.util.Collection<? extends Usage> usages) Removes all specified usages from the usage view in one heroic swoop.
void	selectUsages(Usage [] usages)
void	setAdditionalComponent(javax.swing.JComponent component)
default void	setRerunAction(javax.swing.Action rerunAction)
default void	setReRunActivity(java.lang.Runnable runnable) Deprecated. see setRerunAction(Action)

Methods inherited from interface com.intellij.openapi.Disposable

dispose

Field Detail

USAGE_TARGETS_KEY

static final DataKey<UsageTarget[]> USAGE_TARGETS_KEY

Returns UsageTarget to look usages for

USAGES_KEY

static final DataKey<Usage[]> USAGES_KEY

Returns Usage which are selected in usage view

USAGE_VIEW_KEY

static final DataKey<UsageView> USAGE_VIEW_KEY

USAGE_INFO_KEY

static final DataKey<UsageInfo> USAGE_INFO_KEY

USAGE_SCOPE

static final DataKey<SearchScope> USAGE_SCOPE

USAGE_INFO_LIST_KEY

static final DataKey<java.util.List<UsageInfo>> USAGE_INFO_LIST_KEY

Method Detail

appendUsage

void appendUsage(Usage usage)

removeUsage

void removeUsage(Usage usage)

includeUsages

void includeUsages(Usage [] usages)

excludeUsages

void excludeUsages(Usage [] usages)

selectUsages

void selectUsages(Usage [] usages)

close

void close()

isSearchInProgress

boolean isSearchInProgress()

addButtonToLowerPane

@Deprecated
void addButtonToLowerPane(java.lang.Runnable runnable,
                          java.lang.String text,
                          char mnemonic)

Deprecated. please specify mnemonic by prefixing the mnemonic character with an ampersand (&& for Mac-specific ampersands)

addButtonToLowerPane

void addButtonToLowerPane(java.lang.Runnable runnable,
                          java.lang.String text)

addButtonToLowerPane

void addButtonToLowerPane(javax.swing.Action action)

setReRunActivity

@Deprecated
default void setReRunActivity(java.lang.Runnable runnable)

Deprecated. see setRerunAction(Action)

setRerunAction

default void setRerunAction(javax.swing.Action rerunAction)

Parameters:

rerunAction - this action is used to provide non-standard search restart. Disabled action makes toolbar button disabled too.

setAdditionalComponent

void setAdditionalComponent(javax.swing.JComponent component)

addPerformOperationAction

void addPerformOperationAction(java.lang.Runnable processRunnable,
                               java.lang.String commandName,
                               java.lang.String cannotMakeString,
                               java.lang.String shortDescription)

addPerformOperationAction

void addPerformOperationAction(java.lang.Runnable processRunnable,
                               java.lang.String commandName,
                               java.lang.String cannotMakeString,
                               java.lang.String shortDescription,
                               boolean checkReadOnlyStatus)

Parameters:

checkReadOnlyStatus - if false, check is performed inside processRunnable

getPresentation

UsageViewPresentation getPresentation()

getExcludedUsages

java.util.Set<Usage> getExcludedUsages()

getSelectedUsages

java.util.Set<Usage> getSelectedUsages()

getUsages

java.util.Set<Usage> getUsages()

getSortedUsages

java.util.List<Usage> getSortedUsages()

getComponent

javax.swing.JComponent getComponent()

getPreferredFocusableComponent

default javax.swing.JComponent getPreferredFocusableComponent()

getUsagesCount

int getUsagesCount()

removeUsagesBulk

void removeUsagesBulk(java.util.Collection<? extends Usage> usages)

Removes all specified usages from the usage view in one heroic swoop. Reloads the whole tree model once instead of firing individual remove event for each node. Useful for processing huge number of usages faster, e.g. during "find in path/replace all".

addExcludeListener

default void addExcludeListener(Disposable disposable,
                                UsageView.ExcludeListener listener)