Package com.intellij.codeInsight.actions

Class BaseCodeInsightAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.codeInsight.actions.CodeInsightAction

com.intellij.codeInsight.actions.BaseCodeInsightAction

All Implemented Interfaces:

UpdateInBackground, PossiblyDumbAware

Direct Known Subclasses:

AutoIndentLinesAction, CollapseBlockAction, CollapseDocCommentsAction, CollapseSelectionAction, DelegateMethodsAction, EmacsStyleIndentAction, EmmetPreviewAction, EmmetUpdateTagAction, EscapeEntitiesAction, ExpandDocCommentsAction, FillParagraphAction, GenerateDTDAction, GenerateSuperMethodCallAction, GotoDeclarationAction, GotoImplementationAction, GotoNextElementUnderCaretUsageAction, GotoNextErrorAction, GotoPrevElementUnderCaretUsageAction, GotoPreviousErrorAction, GotoTestOrCodeAction, GotoTypeDeclarationAction, HippieBackwardCompletionAction, HippieCompletionAction, ListTemplatesAction, MethodDownAction, MethodUpAction, PresentableActionHandlerBasedAction, ShowContainerInfoAction, ShowControlFlowAction, ShowErrorDescriptionAction, ShowExpressionTypeAction, ShowIntentionActionsAction, ShowParameterInfoAction, ShowQuickDocInfoAction, SurroundWithAction, SurroundWithEmmetAction, SurroundWithTemplateAction, UnwrapAction

public abstract class BaseCodeInsightAction
extends CodeInsightAction

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

Modifier	Constructor and Description
protected	BaseCodeInsightAction()
protected	BaseCodeInsightAction(boolean lookForInjectedEditor)

Method Summary

Modifier and Type	Method and Description
protected Editor	getBaseEditor(DataContext dataContext, Project project)
protected Editor	getEditor(DataContext dataContext, Project project, boolean forUpdate)
static Editor	getInjectedEditor(Project project, Editor editor)
static Editor	getInjectedEditor(Project project, Editor editor, boolean commit)
protected boolean	isValidForLookup()
void	update(AnActionEvent event) Updates the state of the action.

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

actionPerformed, actionPerformedImpl, beforeActionPerformedUpdate, getCommandName, getHandler, 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.openapi.project.PossiblyDumbAware

isDumbAware

Constructor Detail

BaseCodeInsightAction

protected BaseCodeInsightAction()

BaseCodeInsightAction

protected BaseCodeInsightAction(boolean lookForInjectedEditor)

Method Detail

getEditor

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

Overrides:

getEditor in class CodeInsightAction

getInjectedEditor

public static Editor getInjectedEditor(Project project,
                                       Editor editor)

getInjectedEditor

public static Editor getInjectedEditor(Project project,
                                       Editor editor,
                                       boolean commit)

getBaseEditor

protected Editor getBaseEditor(DataContext dataContext,
                               Project project)

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 CodeInsightAction

Parameters:

event - Carries information on the invocation place and data available

isValidForLookup

protected boolean isValidForLookup()