Package com.intellij.openapi.editor.impl

Class DefaultRawTypedHandler

java.lang.Object

com.intellij.openapi.editor.impl.DefaultRawTypedHandler

All Implemented Interfaces:

TypedActionHandler, TypedActionHandlerEx

public class DefaultRawTypedHandler
extends java.lang.Object
implements TypedActionHandlerEx

Method Summary

Modifier and Type	Method and Description
void	beforeExecute(Editor editor, char c, DataContext context, ActionPlan plan) The method is invoked before acquiring a write lock and actually executing an action.
void	beginUndoablePostProcessing()
void	execute(Editor editor, char charTyped, DataContext dataContext) Processes a key typed in the editor.

Methods inherited from class java.lang.Object

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

Method Detail

beforeExecute

public void beforeExecute(Editor editor,
                          char c,
                          DataContext context,
                          ActionPlan plan)

Description copied from interface: TypedActionHandlerEx

The method is invoked before acquiring a write lock and actually executing an action. Expected to draft an action plan that will be used as a base for zero-latency rendering in editor.

There's no need to mirror all the oncoming changes, focus on latency-sensitive activity (like typing).

Implementation should not modify entities besides ActionPlan (e.g. Editor, Document, CaretModel, etc.). Moreover, as the handlers can be chained, implementation must rely primarily on the state that is provided by the ActionPlan (i.e. ActionPlan.getText() must be used instead of a direct Document.getText() call).

The handler is responsible for delegating to the previously registered handler if needed.

Specified by:

beforeExecute in interface TypedActionHandlerEx

Parameters:

editor - the editor in which the key was typed.

c - the typed character.

context - the current data context.

plan - the current action plan draft.

execute

public void execute(Editor editor,
                    char charTyped,
                    DataContext dataContext)

Description copied from interface: TypedActionHandler

Processes a key typed in the editor. The handler is responsible for delegating to the previously registered handler if it did not handle the typed key.

Specified by:

execute in interface TypedActionHandler

Parameters:

editor - the editor in which the key was typed.

charTyped - the typed character.

dataContext - the current data context.

beginUndoablePostProcessing

public void beginUndoablePostProcessing()