Package com.intellij.codeInsight.navigation.actions

Class GotoDeclarationAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.codeInsight.actions.CodeInsightAction

com.intellij.codeInsight.actions.BaseCodeInsightAction

com.intellij.codeInsight.navigation.actions.GotoDeclarationAction

All Implemented Interfaces:

CodeInsightActionHandler, FileModifier, UpdateInBackground, WriteActionAware, DumbAware, PossiblyDumbAware

public class GotoDeclarationAction
extends BaseCodeInsightAction
implements CodeInsightActionHandler, DumbAware

Nested Class Summary

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

AnAction.TransparentUpdate

Field Summary

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

ACTIONS_KEY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
GotoDeclarationAction()

Method Summary

Modifier and Type	Method and Description
static boolean	chooseAmbiguousTarget(Editor editor, int offset, PsiElementProcessor<? super PsiElement> processor, java.lang.String titlePattern, PsiElement [] elements) Deprecated. use chooseAmbiguousTarget(Project, Editor, int, PsiElementProcessor, String, PsiElement[])
static boolean	chooseAmbiguousTarget(Project project, Editor editor, int offset, PsiElementProcessor<? super PsiElement> processor, java.lang.String titlePattern, PsiElement [] elements)
static PsiElement []	findAllTargetElements(Project project, Editor editor, int offset)
static PsiElement	findElementToShowUsagesOf(Editor editor, int offset)
static PsiElement	findTargetElement(Project project, Editor editor, int offset)
static PsiElement []	findTargetElementsNoVS(Project project, Editor editor, int offset, boolean lookupAccepted)
protected CodeInsightActionHandler	getHandler()
void	invoke(Project project, Editor editor, PsiFile file)
protected boolean	isValidForLookup()
static void	startFindUsages(Editor editor, Project project, PsiElement element)
static void	startFindUsages(Editor editor, Project project, PsiElement element, RelativePoint point)
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.
void	update(AnActionEvent event) Updates the state of the action.

Methods inherited from class com.intellij.codeInsight.actions.BaseCodeInsightAction

getBaseEditor, getEditor, getInjectedEditor, getInjectedEditor

Methods inherited from class com.intellij.codeInsight.actions.CodeInsightAction

actionPerformed, actionPerformedImpl, beforeActionPerformedUpdate, getCommandName, isValidForFile, update, update

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

addTextOverride, applyTextOverride, 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.codeInsight.intention.FileModifier

getElementToMakeWritable

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

isDumbAware

Constructor Detail

GotoDeclarationAction

public GotoDeclarationAction()

Method Detail

getHandler

protected CodeInsightActionHandler getHandler()

Specified by:

getHandler in class CodeInsightAction

isValidForLookup

protected boolean isValidForLookup()

Overrides:

isValidForLookup in class BaseCodeInsightAction

invoke

public void invoke(Project project,
                   Editor editor,
                   PsiFile file)

Specified by:

invoke in interface CodeInsightActionHandler

startFindUsages

public static void startFindUsages(Editor editor,
                                   Project project,
                                   PsiElement element)

startFindUsages

public static void startFindUsages(Editor editor,
                                   Project project,
                                   PsiElement element,
                                   RelativePoint point)

findElementToShowUsagesOf

public static PsiElement findElementToShowUsagesOf(Editor editor,
                                                   int offset)

chooseAmbiguousTarget

@Deprecated
public static boolean chooseAmbiguousTarget(Editor editor,
                                            int offset,
                                            PsiElementProcessor<? super PsiElement> processor,
                                            java.lang.String titlePattern,
                                            PsiElement [] elements)

Deprecated. use chooseAmbiguousTarget(Project, Editor, int, PsiElementProcessor, String, PsiElement[])

chooseAmbiguousTarget

public static boolean chooseAmbiguousTarget(Project project,
                                            Editor editor,
                                            int offset,
                                            PsiElementProcessor<? super PsiElement> processor,
                                            java.lang.String titlePattern,
                                            PsiElement [] elements)

startInWriteAction

public boolean startInWriteAction()

Description copied from interface: WriteActionAware

Indicate whether this action should be invoked inside write action.

Should return false if e.g. modal dialog is shown inside the action. If false is returned the action itself is responsible for starting write action when needed, by calling Application.runWriteAction(Runnable).

Specified by:

startInWriteAction in interface WriteActionAware

Returns:

true if the action requires a write action (default), false otherwise.

findTargetElement

public static PsiElement findTargetElement(Project project,
                                           Editor editor,
                                           int offset)

findAllTargetElements

public static PsiElement [] findAllTargetElements(Project project,
                                                  Editor editor,
                                                  int offset)

findTargetElementsNoVS

public static PsiElement [] findTargetElementsNoVS(Project project,
                                                   Editor editor,
                                                   int offset,
                                                   boolean lookupAccepted)

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 BaseCodeInsightAction

Parameters:

event - Carries information on the invocation place and data available