Package com.intellij.codeInsight.editorActions

Class TypedHandlerDelegate

java.lang.Object

com.intellij.codeInsight.editorActions.TypedHandlerDelegate

Direct Known Subclasses:

CompletionAutoPopupHandler, GroovyTypedHandler, GStringTypedActionHandler, JavadocTypedHandler, JavaTypedHandler, JsonTypedHandler, MarkdownTypedHandler, PyKeywordTypedHandler, PyMethodNameTypedHandler, PythonConsoleAutopopupBlockingHandler, PythonSpaceHandler, SelectionQuotingTypedHandler, ShTypedHandler, SpaceHandler, StructuralSearchTypedHandler, TextMateTypedHandler, XmlAutoPopupHandler, XmlEqTypedHandler, XmlGtTypedHandler, XmlPiTypedHandler, XmlSlashTypedHandler, XPathTypedHandler, YAMLHyphenTypedHandler

public abstract class TypedHandlerDelegate
extends java.lang.Object

Handler, extending IDE behaviour on typing in editor.

Note that PsiFile passed to handler's methods isn't guaranteed to be in sync with the document at the time of invocation (due to performance considerations). PsiDocumentManager.commitDocument(Document) should be invoked explicitly, if an up-to-date PSI is required.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypedHandlerDelegate.Result

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<TypedHandlerDelegate>	EP_NAME

Constructor Summary

Constructors

Constructor and Description
TypedHandlerDelegate()

Method Summary

Modifier and Type	Method and Description
TypedHandlerDelegate.Result	beforeCharTyped(char c, Project project, Editor editor, PsiFile file, FileType fileType) Called before the specified character typed by the user is inserted in the editor.
TypedHandlerDelegate.Result	beforeSelectionRemoved(char c, Project project, Editor editor, PsiFile file) Called before selected text is deleted.
TypedHandlerDelegate.Result	charTyped(char c, Project project, Editor editor, PsiFile file) Called after the specified character typed by the user has been inserted in the editor.
TypedHandlerDelegate.Result	checkAutoPopup(char charTyped, Project project, Editor editor, PsiFile file) If the specified character triggers auto-popup, schedules the auto-popup appearance.
boolean	isImmediatePaintingEnabled(Editor editor, char c, DataContext context)

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<TypedHandlerDelegate> EP_NAME

Constructor Detail

TypedHandlerDelegate

public TypedHandlerDelegate()

Method Detail

checkAutoPopup

public TypedHandlerDelegate.Result checkAutoPopup(char charTyped,
                                                  Project project,
                                                  Editor editor,
                                                  PsiFile file)

If the specified character triggers auto-popup, schedules the auto-popup appearance. This method is called even in overwrite mode, when the rest of typed handler delegate methods are not called. It is invoked only for the primary caret.

beforeSelectionRemoved

public TypedHandlerDelegate.Result beforeSelectionRemoved(char c,
                                                          Project project,
                                                          Editor editor,
                                                          PsiFile file)

Called before selected text is deleted. This method is supposed to be overridden by handlers having custom behaviour with respect to selection.

beforeCharTyped

public TypedHandlerDelegate.Result beforeCharTyped(char c,
                                                   Project project,
                                                   Editor editor,
                                                   PsiFile file,
                                                   FileType fileType)

Called before the specified character typed by the user is inserted in the editor.

charTyped

public TypedHandlerDelegate.Result charTyped(char c,
                                             Project project,
                                             Editor editor,
                                             PsiFile file)

Called after the specified character typed by the user has been inserted in the editor.

isImmediatePaintingEnabled

public boolean isImmediatePaintingEnabled(Editor editor,
                                          char c,
                                          DataContext context)