Package com.intellij.codeInsight.actions

Class MultiCaretCodeInsightAction

java.lang.Object

com.intellij.openapi.actionSystem.AnAction

com.intellij.codeInsight.actions.MultiCaretCodeInsightAction

All Implemented Interfaces:

PossiblyDumbAware

Direct Known Subclasses:

CommentByBlockCommentAction, CommentByLineCommentAction

public abstract class MultiCaretCodeInsightAction
extends AnAction

Base class for PSI-aware editor actions that need to support multiple carets. Recognizes multi-root PSI and injected fragments, so different carets might be processed in context of different Editor and PsiFile instances.

Implementations should implement getHandler() method, and might override isValidFor(Project, Editor, Caret, PsiFile) method.

See Also:

MultiCaretCodeInsightActionHandler

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

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 hostEditor)
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 abstract MultiCaretCodeInsightActionHandler	getHandler()
protected boolean	isValidFor(Project project, Editor editor, Caret caret, PsiFile file) During action status update this method is invoked for each caret in editor.
void	update(AnActionEvent e) Updates the state of the action.

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

MultiCaretCodeInsightAction

public MultiCaretCodeInsightAction()

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

actionPerformedImpl

public void actionPerformedImpl(Project project,
                                Editor hostEditor)

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

isValidFor

protected boolean isValidFor(Project project,
                             Editor editor,
                             Caret caret,
                             PsiFile file)

During action status update this method is invoked for each caret in editor. If at least for a single caret it returns true, action is considered enabled.

getHandler

protected abstract MultiCaretCodeInsightActionHandler getHandler()

getCommandName

protected java.lang.String getCommandName()