Package com.intellij.usages.impl

Class UsageViewImpl

java.lang.Object

com.intellij.usages.impl.UsageViewImpl

All Implemented Interfaces:

Disposable, UsageViewEx, UsageView

public class UsageViewImpl
extends java.lang.Object
implements UsageViewEx

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.usages.UsageView

UsageView.ExcludeListener

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

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HELP_ID
static UsageNode	NULL_NODE
static java.lang.String	SHOW_RECENT_FIND_USAGES_ACTION_ID
static java.util.Comparator<Usage>	USAGE_COMPARATOR

Fields inherited from interface com.intellij.usages.UsageView

USAGE_INFO_KEY, USAGE_INFO_LIST_KEY, USAGE_SCOPE, USAGE_TARGETS_KEY, USAGE_VIEW_KEY, USAGES_KEY

Constructor Summary

Constructors

Constructor and Description
UsageViewImpl(Project project, UsageViewPresentation presentation, UsageTarget [] targets, Factory<UsageSearcher> usageSearcherFactory)

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)
void	addExcludeListener(Disposable disposable, UsageView.ExcludeListener listener)
void	addFilteringActions(DefaultActionGroup group)
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)
java.util.concurrent.CompletableFuture<?>	appendUsagesInBulk(java.util.Collection<? extends Usage> usages)
void	associateProgress(ProgressIndicator indicator)
void	cancelCurrentSearch()
boolean	canPerformReRun()
void	close()
protected AnAction []	createActions()
void	dispose() Usually not invoked directly, see class javadoc.
UsageNode	doAppendUsage(Usage usage)
protected UsageView	doReRun()
void	excludeUsages(Usage [] usages)
void	expandAll()
void	expandRoot()
javax.swing.JComponent	getComponent()
java.util.Set<Usage>	getExcludedUsages()
Usage	getNextToSelect(java.util.Collection<? extends Usage> toDelete)
Usage	getNextToSelect(Usage toDelete)
java.lang.String	getNodeText(javax.swing.tree.TreeNode node)
javax.swing.JComponent	getPreferredFocusableComponent()
UsageViewPresentation	getPresentation()
Project	getProject()
GroupNode	getRoot()
java.util.Set<Usage>	getSelectedUsages()
static KeyboardShortcut	getShowUsagesWithSettingsShortcut()
java.util.List<Usage>	getSortedUsages()
UsageTarget []	getTargets()
java.util.Set<Usage>	getUsages()
int	getUsagesCount()
void	includeUsages(Usage [] usages)
boolean	isDisposed()
boolean	isOriginUsage(Usage usage) true if the points to the element the "find usages" action was invoked on
protected boolean	isPreviewUsageActionEnabled()
boolean	isPreviewUsages()
boolean	isSearchInProgress()
boolean	isVisible(Usage usage)
void	refreshUsages()
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	searchFinished()
boolean	searchHasBeenCancelled()
void	select()
void	selectUsages(Usage [] usages)
void	setAdditionalComponent(javax.swing.JComponent comp)
void	setOriginUsage(Usage usage) The element the "find usages" action was invoked on.
void	setPreviewUsages(boolean state)
void	setRerunAction(javax.swing.Action rerunAction)
void	setSearchInProgress(boolean searchInProgress)
void	waitForUpdateRequestsCompletion()

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.UsageView

setReRunActivity

Field Detail

SHOW_RECENT_FIND_USAGES_ACTION_ID

public static final java.lang.String SHOW_RECENT_FIND_USAGES_ACTION_ID

See Also:

Constant Field Values

NULL_NODE

public static final UsageNode NULL_NODE

USAGE_COMPARATOR

public static final java.util.Comparator<Usage> USAGE_COMPARATOR

HELP_ID

public static final java.lang.String HELP_ID

See Also:

Constant Field Values

Constructor Detail

UsageViewImpl

public UsageViewImpl(Project project,
                     UsageViewPresentation presentation,
                     UsageTarget [] targets,
                     Factory<UsageSearcher> usageSearcherFactory)

Method Detail

searchFinished

public void searchFinished()

Specified by:

searchFinished in interface UsageViewEx

searchHasBeenCancelled

public boolean searchHasBeenCancelled()

Specified by:

searchHasBeenCancelled in interface UsageViewEx

cancelCurrentSearch

public void cancelCurrentSearch()

Specified by:

cancelCurrentSearch in interface UsageViewEx

isPreviewUsages

public boolean isPreviewUsages()

setPreviewUsages

public void setPreviewUsages(boolean state)

isPreviewUsageActionEnabled

protected boolean isPreviewUsageActionEnabled()

addFilteringActions

public void addFilteringActions(DefaultActionGroup group)

createActions

protected AnAction [] createActions()

expandAll

public void expandAll()

expandRoot

public void expandRoot()

select

public void select()

getProject

public Project getProject()

getShowUsagesWithSettingsShortcut

public static KeyboardShortcut getShowUsagesWithSettingsShortcut()

associateProgress

public void associateProgress(ProgressIndicator indicator)

Specified by:

associateProgress in interface UsageViewEx

refreshUsages

public void refreshUsages()

doReRun

protected UsageView doReRun()

Returns:

usage view which will be shown after re-run (either this if it knows how to re-run itself, or the new created one otherwise)

appendUsage

public void appendUsage(Usage usage)

Specified by:

appendUsage in interface UsageView

waitForUpdateRequestsCompletion

public void waitForUpdateRequestsCompletion()

Specified by:

waitForUpdateRequestsCompletion in interface UsageViewEx

appendUsagesInBulk

public java.util.concurrent.CompletableFuture<?> appendUsagesInBulk(java.util.Collection<? extends Usage> usages)

Specified by:

appendUsagesInBulk in interface UsageViewEx

doAppendUsage

public UsageNode doAppendUsage(Usage usage)

removeUsage

public void removeUsage(Usage usage)

Specified by:

removeUsage in interface UsageView

removeUsagesBulk

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

Description copied from interface: UsageView

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".

Specified by:

removeUsagesBulk in interface UsageView

includeUsages

public void includeUsages(Usage [] usages)

Specified by:

includeUsages in interface UsageView

excludeUsages

public void excludeUsages(Usage [] usages)

Specified by:

excludeUsages in interface UsageView

selectUsages

public void selectUsages(Usage [] usages)

Specified by:

selectUsages in interface UsageView

getPreferredFocusableComponent

public javax.swing.JComponent getPreferredFocusableComponent()

Specified by:

getPreferredFocusableComponent in interface UsageView

getComponent

public javax.swing.JComponent getComponent()

Specified by:

getComponent in interface UsageView

getUsagesCount

public int getUsagesCount()

Specified by:

getUsagesCount in interface UsageView

addExcludeListener

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

Specified by:

addExcludeListener in interface UsageView

close

public void close()

Specified by:

close in interface UsageView

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

isSearchInProgress

public boolean isSearchInProgress()

Specified by:

isSearchInProgress in interface UsageView

setSearchInProgress

public void setSearchInProgress(boolean searchInProgress)

Specified by:

setSearchInProgress in interface UsageViewEx

isDisposed

public boolean isDisposed()

setRerunAction

public void setRerunAction(javax.swing.Action rerunAction)

Specified by:

setRerunAction in interface UsageView

Parameters:

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

addButtonToLowerPane

public void addButtonToLowerPane(javax.swing.Action action)

Specified by:

addButtonToLowerPane in interface UsageView

addButtonToLowerPane

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

Specified by:

addButtonToLowerPane in interface UsageView

setAdditionalComponent

public void setAdditionalComponent(javax.swing.JComponent comp)

Specified by:

setAdditionalComponent in interface UsageView

addButtonToLowerPane

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

Specified by:

addButtonToLowerPane in interface UsageView

addPerformOperationAction

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

Specified by:

addPerformOperationAction in interface UsageView

addPerformOperationAction

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

Specified by:

addPerformOperationAction in interface UsageView

checkReadOnlyStatus - if false, check is performed inside processRunnable

getPresentation

public UsageViewPresentation getPresentation()

Specified by:

getPresentation in interface UsageView

canPerformReRun

public boolean canPerformReRun()

getExcludedUsages

public java.util.Set<Usage> getExcludedUsages()

Specified by:

getExcludedUsages in interface UsageView

getSelectedUsages

public java.util.Set<Usage> getSelectedUsages()

Specified by:

getSelectedUsages in interface UsageView

getUsages

public java.util.Set<Usage> getUsages()

Specified by:

getUsages in interface UsageView

getSortedUsages

public java.util.List<Usage> getSortedUsages()

Specified by:

getSortedUsages in interface UsageView

getRoot

public GroupNode getRoot()

getNodeText

public java.lang.String getNodeText(javax.swing.tree.TreeNode node)

isVisible

public boolean isVisible(Usage usage)

getTargets

public UsageTarget [] getTargets()

setOriginUsage

public void setOriginUsage(Usage usage)

The element the "find usages" action was invoked on. E.g. if the "find usages" was invoked on the reference "getName(2)" pointing to the method "getName()" then the origin usage is this reference.

isOriginUsage

public boolean isOriginUsage(Usage usage)

true if the points to the element the "find usages" action was invoked on

getNextToSelect

public Usage getNextToSelect(Usage toDelete)

getNextToSelect

public Usage getNextToSelect(java.util.Collection<? extends Usage> toDelete)