Package com.intellij.codeInsight.actions

Class CodeInsightAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.codeInsight.actions.CodeInsightAction

All Implemented Interfaces:

UpdateInBackground, PossiblyDumbAware

Direct Known Subclasses:

AddGradleDslDependencyAction, BaseCodeInsightAction, BaseGenerateAction, GenerateDomElementAction, NextPrevParameterAction, ShGenerateForLoop, ShGenerateUntilLoop, ShGenerateWhileLoop, SimpleCodeInsightAction, SliceBackwardAction, SliceForwardAction

public abstract class CodeInsightAction
extends AnAction
implements UpdateInBackground

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
CodeInsightAction()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
void	actionPerformedImpl(Project project, Editor editor)
void	beforeActionPerformedUpdate(AnActionEvent e) Same as AnAction.update(AnActionEvent) but is calls immediately before actionPerformed() as final check guard.
protected java.lang.String	getCommandName()
protected Editor	getEditor(DataContext dataContext, Project project, boolean forUpdate)
protected abstract CodeInsightActionHandler	getHandler()
protected boolean	isValidForFile(Project project, Editor editor, PsiFile file)
void	update(AnActionEvent e) Updates the state of the action.
protected void	update(Presentation presentation, Project project, Editor editor, PsiFile file)
protected void	update(Presentation presentation, Project project, Editor editor, PsiFile file, DataContext dataContext, java.lang.String actionPlace)

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.openapi.project.PossiblyDumbAware

isDumbAware

Constructor Detail

CodeInsightAction

public CodeInsightAction()

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

getEditor

protected Editor getEditor(DataContext dataContext,
                           Project project,
                           boolean forUpdate)

actionPerformedImpl

public void actionPerformedImpl(Project project,
                                Editor editor)

beforeActionPerformedUpdate

public void beforeActionPerformedUpdate(AnActionEvent e)

Description copied from class: AnAction

Same as AnAction.update(AnActionEvent) but is calls immediately before actionPerformed() as final check guard. Default implementation delegates to AnAction.update(AnActionEvent).

Overrides:

beforeActionPerformedUpdate in class AnAction

Parameters:

e - Carries information on the invocation place and data available

update

public void update(AnActionEvent e)

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:

e - Carries information on the invocation place and data available

update

protected void update(Presentation presentation,
                      Project project,
                      Editor editor,
                      PsiFile file)

update

protected void update(Presentation presentation,
                      Project project,
                      Editor editor,
                      PsiFile file,
                      DataContext dataContext,
                      java.lang.String actionPlace)

isValidForFile

protected boolean isValidForFile(Project project,
                                 Editor editor,
                                 PsiFile file)

getHandler

protected abstract CodeInsightActionHandler getHandler()

getCommandName

protected java.lang.String getCommandName()