Package com.intellij.openapi.editor.actionSystem

Class EditorWriteActionHandler

java.lang.Object

com.intellij.openapi.editor.actionSystem.EditorActionHandler

com.intellij.openapi.editor.actionSystem.EditorWriteActionHandler

Direct Known Subclasses:

AbstractPermuteLinesHandler, BackspaceHandler, BaseEnterHandler, BaseMoveHandler, BasePasteHandler, CutAction.Handler, CutHandler, DeleteAction.Handler, DeleteInColumnModeHandler, DeleteSelectionHandler, MoveElementLeftRightActionHandler, NamedElementDuplicateHandler, TabAction.Handler

public abstract class EditorWriteActionHandler
extends EditorActionHandler

Base class for EditorActionHandler instances, which need to modify the document. Implementations should override executeWriteAction(Editor, Caret, DataContext).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EditorWriteActionHandler()
protected	EditorWriteActionHandler(boolean runForEachCaret)

Method Summary

Modifier and Type	Method and Description
void	doExecute(Editor editor, Caret caret, DataContext dataContext) Executes the action in the context of given caret.
void	executeWriteAction(Editor editor, Caret caret, DataContext dataContext)
void	executeWriteAction(Editor editor, DataContext dataContext) Deprecated. Use/override executeWriteAction(Editor, Caret, DataContext) instead.

Methods inherited from class com.intellij.openapi.editor.actionSystem.EditorActionHandler

execute, execute, executeInCommand, getCommandGroupId, isEnabled, isEnabled, isEnabledForCaret, runForAllCarets

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EditorWriteActionHandler

protected EditorWriteActionHandler()

EditorWriteActionHandler

protected EditorWriteActionHandler(boolean runForEachCaret)

Method Detail

doExecute

public void doExecute(Editor editor,
                      Caret caret,
                      DataContext dataContext)

Description copied from class: EditorActionHandler

Executes the action in the context of given caret. Subclasses should override this method.

Overrides:

doExecute in class EditorActionHandler

Parameters:

editor - the editor in which the action is invoked.

caret - the caret for which the action is performed at the moment, or null if it's a 'one-off' action executed without current context

dataContext - the data context for the action.

executeWriteAction

@Deprecated
public void executeWriteAction(Editor editor,
                               DataContext dataContext)

Deprecated. Use/override executeWriteAction(Editor, Caret, DataContext) instead.

executeWriteAction

public void executeWriteAction(Editor editor,
                               Caret caret,
                               DataContext dataContext)