Package com.intellij.openapi.editor.actionSystem

Interface ActionPlan

public interface ActionPlan

Combined text/caret model that is used to record oncoming changes before acquiring a write lock and making actual changes to Document or CaretModel.

The draft is used to perform preemptive rendering in editor before acquiring a write lock.

The interface is simplistic and can be extended later to support multiple carets, selection, etc.

See Also:

TypedAction.beforeActionPerformed(Editor, char, DataContext, ActionPlan)

Method Summary

Modifier and Type	Method and Description
int	getCaretOffset() Returns the offset of the caret in the text.
ImmutableCharSequence	getText() Retrieves the current text content.
void	replace(int begin, int end, java.lang.String s) Replaces the specified range of text with the specified string.
void	setCaretOffset(int offset) Moves the caret to the specified offset in the text.

Method Detail

getText

ImmutableCharSequence getText()

Retrieves the current text content.

Returns:

text content.

replace

void replace(int begin,
             int end,
             java.lang.String s)

Replaces the specified range of text with the specified string.

Parameters:

begin - the start offset of the range to replace.

end - the end offset of the range to replace.

s - the text to replace with.

getCaretOffset

int getCaretOffset()

Returns the offset of the caret in the text.

Returns:

the caret offset.

setCaretOffset

void setCaretOffset(int offset)

Moves the caret to the specified offset in the text.

Parameters:

offset - the offset to move to.