Package com.intellij.openapi.editor.actionSystem

Class EditorAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.openapi.editor.actionSystem.EditorAction

All Implemented Interfaces:

LightEditCompatible, UpdateInBackground, DumbAware, PossiblyDumbAware

Direct Known Subclasses:

BackwardParagraphAction, BackwardParagraphWithSelectionAction, BaseExpandToLevelAction, BraceOrQuoteOutAction, ChooseItemAction, CloneCaretAbove, CloneCaretBelow, CodeBlockEndAction, CodeBlockEndWithSelectionAction, CodeBlockStartAction, CodeBlockStartWithSelectionAction, CollapseAllRegionsAction, CollapseRegionAction, CollapseRegionRecursivelyAction, ConvertIndentsActionBase, DeleteAction, DeleteToLineEndAction, DeleteToLineStartAction, DuplicateAction, DuplicateLinesAction, EnterAction, EscapeAction, ExpandAllRegionsAction, ExpandLiveTemplateByTabAction, ExpandLiveTemplateCustomAction, ExpandRegionAction, ExpandRegionRecursivelyAction, FindAction, FindWordAtCaretAction, FixDocCommentAction, FocusGutterAction, ForwardParagraphAction, ForwardParagraphWithSelectionAction, GoToEditPointAction, InactiveEditorAction, IncrementalFindAction, IndentSelectionAction, JavaMethodOverloadSwitchDownAction, JavaMethodOverloadSwitchUpAction, LookupActionHandler.DownAction, LookupActionHandler.UpAction, MatchBraceAction, MoveCaretDownAction, MoveCaretDownWithSelectionAction, MoveCaretLeftAction, MoveCaretLeftWithSelectionAction, MoveCaretRightAction, MoveCaretRightWithSelectionAction, MoveCaretUpAction, MoveCaretUpWithSelectionAction, MoveDownAndScrollAction, MoveDownWithSelectionAndScrollAction, MoveElementLeftAction, MoveElementRightAction, MoveLineDownAction, MoveLineUpAction, MoveStatementDownAction, MoveStatementUpAction, MoveUpAndScrollAction, MoveUpWithSelectionAndScrollAction, NextBookmarkAction, NextParameterAction, NextVariableAction, PageBottomAction, PageBottomWithSelectionAction, PageDownAction, PageDownWithSelectionAction, PageTopAction, PageTopWithSelectionAction, PageUpAction, PageUpWithSelectionAction, PasteFromX11Action, PreviousBookmarkAction, PreviousVariableAction, PrevParameterAction, ReplaceAction, ResetFontSizeAction, ReverseLinesAction, SearchAgainAction, SearchBackAction, SelectAllOccurrencesAction, SelectNextOccurrenceAction, ShowFontsUsedByEditorAction, ShowGutterIconTooltipAction, SimplePasteAction, SmartEnterAction, SortLinesAction, SplitLineAction, StartNewLineAction, StartNewLineBeforeAction, SwapSelectionBoundariesAction, TabAction, TextComponentEditorAction, ToggleInsertStateAction, ToggleRenderedDocPresentationAction, ToggleStickySelectionModeAction, UnindentSelectionAction, UnselectPreviousOccurrenceAction, UnselectWordAtCaretAction

public abstract class EditorAction
extends AnAction
implements DumbAware, UpdateInBackground, LightEditCompatible

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	EditorAction(EditorActionHandler defaultHandler)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(AnActionEvent e) Implement this method to provide your action handler.
void	actionPerformed(Editor editor, DataContext dataContext)
void	beforeActionPerformedUpdate(AnActionEvent e) Same as AnAction.update(AnActionEvent) but is calls immediately before actionPerformed() as final check guard.
protected void	doSetupHandler(EditorActionHandler newHandler)
protected Editor	getEditor(DataContext dataContext)
EditorActionHandler	getHandler()
void	setInjectedContext(boolean worksInInjected) Enables automatic detection of injected fragments in editor.
EditorActionHandler	setupHandler(EditorActionHandler newHandler)
void	update(AnActionEvent e) Updates the state of the action.
void	update(Editor editor, Presentation presentation, DataContext dataContext)
void	updateForKeyboardAccess(Editor editor, Presentation presentation, DataContext dataContext)

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, 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

EditorAction

protected EditorAction(EditorActionHandler defaultHandler)

Method Detail

setupHandler

public final EditorActionHandler setupHandler(EditorActionHandler newHandler)

doSetupHandler

protected void doSetupHandler(EditorActionHandler newHandler)

getHandler

public EditorActionHandler getHandler()

setInjectedContext

public void setInjectedContext(boolean worksInInjected)

Description copied from class: AnAction

Enables automatic detection of injected fragments in editor. Values in DataContext, passed to the action, like EDITOR, PSI_FILE will refer to an injected fragment, if caret is currently positioned on it.

Overrides:

setInjectedContext in class AnAction

actionPerformed

public final 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)

actionPerformed

public final void actionPerformed(Editor editor,
                                  DataContext dataContext)

update

public void update(Editor editor,
                   Presentation presentation,
                   DataContext dataContext)

updateForKeyboardAccess

public void updateForKeyboardAccess(Editor editor,
                                    Presentation presentation,
                                    DataContext dataContext)

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