Package com.intellij.ide.actions

Class GotoActionBase

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.ide.actions.GotoActionBase

All Implemented Interfaces:

PossiblyDumbAware

Direct Known Subclasses:

GotoActionAction, GotoClassAction, GotoFileAction, GotoSymbolAction, GotoTaskAction, RunInspectionAction

public abstract class GotoActionBase
extends AnAction

Author: msk

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GotoActionBase.GotoActionCallback<T>

Nested classes/interfaces inherited from class com.intellij.openapi.actionSystem.AnAction

AnAction.TransparentUpdate

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Class	myInAction

Fields inherited from class com.intellij.openapi.actionSystem.AnAction

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
GotoActionBase()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
protected static Pair<java.lang.String,java.lang.Integer>	getInitialText(boolean useEditorSelection, AnActionEvent e)
static java.lang.String	getInitialTextForNavigation(AnActionEvent e)
static PsiElement	getPsiContext(AnActionEvent e)
static PsiElement	getPsiContext(Project project)
protected abstract void	gotoActionPerformed(AnActionEvent e)
protected boolean	hasContributors(DataContext dataContext)
protected boolean	requiresProject()
protected void	showInSearchEverywherePopup(java.lang.String searchProviderID, AnActionEvent event, boolean useEditorSelection, boolean sendStatistics)
protected <T> void	showNavigationPopup(AnActionEvent e, ChooseByNameModel model, GotoActionBase.GotoActionCallback<T> callback)
protected <T> void	showNavigationPopup(AnActionEvent e, ChooseByNameModel model, GotoActionBase.GotoActionCallback<T> callback, boolean allowMultipleSelection)
protected <T> void	showNavigationPopup(AnActionEvent e, ChooseByNameModel model, GotoActionBase.GotoActionCallback<T> callback, java.lang.String findUsagesTitle, boolean useSelectionFromEditor)
protected <T> void	showNavigationPopup(AnActionEvent e, ChooseByNameModel model, GotoActionBase.GotoActionCallback<T> callback, java.lang.String findUsagesTitle, boolean useSelectionFromEditor, boolean allowMultipleSelection)
protected <T> void	showNavigationPopup(AnActionEvent e, ChooseByNameModel model, GotoActionBase.GotoActionCallback<T> callback, java.lang.String findUsagesTitle, boolean useSelectionFromEditor, boolean allowMultipleSelection, ChooseByNameItemProvider itemProvider)
protected <T> void	showNavigationPopup(AnActionEvent e, ChooseByNameModel model, GotoActionBase.GotoActionCallback<T> callback, java.lang.String findUsagesTitle, boolean useSelectionFromEditor, boolean allowMultipleSelection, DefaultChooseByNameItemProvider itemProvider) Deprecated. use other overloaded methods
protected <T> void	showNavigationPopup(GotoActionBase.GotoActionCallback<T> callback, java.lang.String findUsagesTitle, ChooseByNamePopup popup)
protected <T> void	showNavigationPopup(GotoActionBase.GotoActionCallback<T> callback, java.lang.String findUsagesTitle, ChooseByNamePopup popup, boolean allowMultipleSelection)
void	update(AnActionEvent event) Updates the state of the action.

Methods inherited from class com.intellij.openapi.actionSystem.AnAction

addTextOverride, applyTextOverride, beforeActionPerformedUpdate, copyFrom, copyShortcutFrom, displayTextInToolbar, getEventProject, getShortcutSet, getTemplatePresentation, getTemplateText, isDefaultIcon, isEnabledInModalContext, isInInjectedContext, isTransparentUpdate, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, registerCustomShortcutSet, setDefaultIcon, setEnabledInModalContext, setInjectedContext, setShortcutSet, startInTransaction, toString, unregisterCustomShortcutSet, useSmallerFontForTextInToolbar

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.project.PossiblyDumbAware

isDumbAware

Field Detail

myInAction

protected static java.lang.Class myInAction

Constructor Detail

GotoActionBase

public GotoActionBase()

Method Detail

actionPerformed

public void actionPerformed(AnActionEvent e)

Description copied from class: AnAction

Implement this method to provide your action handler.

Specified by:

actionPerformed in class AnAction

Parameters:

e - Carries information on the invocation place

gotoActionPerformed

protected abstract void gotoActionPerformed(AnActionEvent e)

update

public void update(AnActionEvent event)

Description copied from class: AnAction

Updates the state of the action. Default implementation does nothing. Override this method to provide the ability to dynamically change action's state and(or) presentation depending on the context (For example when your action state depends on the selection you can check for selection and change the state accordingly).

This method can be called frequently, and on UI thread. This means that this method is supposed to work really fast, no real work should be done at this phase. For example, checking selection in a tree or a list, is considered valid, but working with a file system or PSI (especially resolve) is not. If you cannot determine the state of the action fast enough, you should do it in the AnAction.actionPerformed(AnActionEvent) method and notify the user that action cannot be executed if it's the case.

If the action is added to a toolbar, its "update" can be called twice a second, but only if there was any user activity or a focus transfer. If your action's availability is changed in absence of any of these events, please call ActivityTracker.getInstance().inc() to notify action subsystem to update all toolbar actions when your subsystem's determines that its actions' visibility might be affected.

Overrides:

update in class AnAction

Parameters:

event - Carries information on the invocation place and data available

hasContributors

protected boolean hasContributors(DataContext dataContext)

requiresProject

protected boolean requiresProject()

getPsiContext

public static PsiElement getPsiContext(AnActionEvent e)

getPsiContext

public static PsiElement getPsiContext(Project project)

getInitialText

protected static Pair<java.lang.String,java.lang.Integer> getInitialText(boolean useEditorSelection,
                                                                         AnActionEvent e)

getInitialTextForNavigation

public static java.lang.String getInitialTextForNavigation(AnActionEvent e)

showNavigationPopup

protected <T> void showNavigationPopup(AnActionEvent e,
                                       ChooseByNameModel model,
                                       GotoActionBase.GotoActionCallback<T> callback)

showNavigationPopup

protected <T> void showNavigationPopup(AnActionEvent e,
                                       ChooseByNameModel model,
                                       GotoActionBase.GotoActionCallback<T> callback,
                                       boolean allowMultipleSelection)

showNavigationPopup

protected <T> void showNavigationPopup(AnActionEvent e,
                                       ChooseByNameModel model,
                                       GotoActionBase.GotoActionCallback<T> callback,
                                       java.lang.String findUsagesTitle,
                                       boolean useSelectionFromEditor)

showNavigationPopup

protected <T> void showNavigationPopup(AnActionEvent e,
                                       ChooseByNameModel model,
                                       GotoActionBase.GotoActionCallback<T> callback,
                                       java.lang.String findUsagesTitle,
                                       boolean useSelectionFromEditor,
                                       boolean allowMultipleSelection)

showNavigationPopup

@Deprecated
protected <T> void showNavigationPopup(AnActionEvent e,
                                       ChooseByNameModel model,
                                       GotoActionBase.GotoActionCallback<T> callback,
                                       java.lang.String findUsagesTitle,
                                       boolean useSelectionFromEditor,
                                       boolean allowMultipleSelection,
                                       DefaultChooseByNameItemProvider itemProvider)

Deprecated. use other overloaded methods

showNavigationPopup

protected <T> void showNavigationPopup(AnActionEvent e,
                                       ChooseByNameModel model,
                                       GotoActionBase.GotoActionCallback<T> callback,
                                       java.lang.String findUsagesTitle,
                                       boolean useSelectionFromEditor,
                                       boolean allowMultipleSelection,
                                       ChooseByNameItemProvider itemProvider)

showNavigationPopup

protected <T> void showNavigationPopup(GotoActionBase.GotoActionCallback<T> callback,
                                       java.lang.String findUsagesTitle,
                                       ChooseByNamePopup popup)

showNavigationPopup

protected <T> void showNavigationPopup(GotoActionBase.GotoActionCallback<T> callback,
                                       java.lang.String findUsagesTitle,
                                       ChooseByNamePopup popup,
                                       boolean allowMultipleSelection)

showInSearchEverywherePopup

protected void showInSearchEverywherePopup(java.lang.String searchProviderID,
                                           AnActionEvent event,
                                           boolean useEditorSelection,
                                           boolean sendStatistics)