Package com.intellij.codeInsight.editorActions

Class TypedHandler

java.lang.Object

com.intellij.codeInsight.template.impl.editorActions.TypedActionHandlerBase

com.intellij.codeInsight.editorActions.TypedHandler

All Implemented Interfaces:

TypedActionHandler, TypedActionHandlerEx

public class TypedHandler
extends TypedActionHandlerBase

Field Summary

Fields inherited from class com.intellij.codeInsight.template.impl.editorActions.TypedActionHandlerBase

myOriginalHandler

Constructor Summary

Constructors

Constructor and Description
TypedHandler(TypedActionHandler originalHandler)

Method Summary

Modifier and Type	Method and Description
static void	autoPopupCompletion(Editor editor, char charTyped, Project project, PsiFile file)
void	beforeExecute(Editor editor, char c, DataContext context, ActionPlan plan) The method is invoked before acquiring a write lock and actually executing an action.
static void	commitDocumentIfCurrentCaretIsNotTheFirstOne(Editor editor, Project project)
void	execute(Editor originalEditor, char charTyped, DataContext dataContext) Processes a key typed in the editor.
static QuoteHandler	getLanguageQuoteHandler(Language baseLanguage)
static QuoteHandler	getQuoteHandler(PsiFile file, Editor editor)
static QuoteHandler	getQuoteHandlerForType(FileType fileType)
static boolean	handleRParen(Editor editor, FileType fileType, char charTyped)
static void	indentOpenedBrace(Project project, Editor editor)
static Editor	injectedEditorIfCharTypedIsSignificant(char charTyped, Editor editor, PsiFile oldFile)
static Editor	injectedEditorIfCharTypedIsSignificant(int charTyped, Editor editor, PsiFile oldFile)
static void	registerBaseLanguageQuoteHandler(java.lang.Class<? extends Language> languageClass, QuoteHandler quoteHandler)
static void	registerQuoteHandler(FileType fileType, QuoteHandler quoteHandler) Deprecated. use QuoteHandlerEP

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedHandler

public TypedHandler(TypedActionHandler originalHandler)

Method Detail

getQuoteHandler

public static QuoteHandler getQuoteHandler(PsiFile file,
                                           Editor editor)

getLanguageQuoteHandler

public static QuoteHandler getLanguageQuoteHandler(Language baseLanguage)

registerBaseLanguageQuoteHandler

public static void registerBaseLanguageQuoteHandler(java.lang.Class<? extends Language> languageClass,
                                                    QuoteHandler quoteHandler)

getQuoteHandlerForType

public static QuoteHandler getQuoteHandlerForType(FileType fileType)

registerQuoteHandler

@Deprecated
public static void registerQuoteHandler(FileType fileType,
                                        QuoteHandler quoteHandler)

Deprecated. use QuoteHandlerEP

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

Overrides:

beforeExecute in class TypedActionHandlerBase

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

Parameters:

originalEditor - the editor in which the key was typed.

charTyped - the typed character.

dataContext - the current data context.

autoPopupCompletion

public static void autoPopupCompletion(Editor editor,
                                       char charTyped,
                                       Project project,
                                       PsiFile file)

commitDocumentIfCurrentCaretIsNotTheFirstOne

public static void commitDocumentIfCurrentCaretIsNotTheFirstOne(Editor editor,
                                                                Project project)

injectedEditorIfCharTypedIsSignificant

public static Editor injectedEditorIfCharTypedIsSignificant(char charTyped,
                                                            Editor editor,
                                                            PsiFile oldFile)

injectedEditorIfCharTypedIsSignificant

public static Editor injectedEditorIfCharTypedIsSignificant(int charTyped,
                                                            Editor editor,
                                                            PsiFile oldFile)

handleRParen

public static boolean handleRParen(Editor editor,
                                   FileType fileType,
                                   char charTyped)

indentOpenedBrace

public static void indentOpenedBrace(Project project,
                                     Editor editor)