Package com.intellij.codeInsight.editorActions.enter

Interface EnterHandlerDelegate

All Known Implementing Classes:

BaseIndentEnterHandler, EnterAfterJavadocTagHandler, EnterAfterUnmatchedBraceHandler, EnterBetweenBracesFinalHandler, EnterBetweenBracesHandler, EnterBetweenXmlTagsHandler, EnterHandlerDelegateAdapter, EnterInBlockCommentHandler, EnterInJavadocParamDescriptionHandler, EnterInLineCommentHandler, EnterInPropertiesFileHandler, EnterInStringLiteralHandler, GroovyEnterHandler, JavaEnterAfterUnmatchedBraceHandler, JavaEnterInTextBlockHandler, JsonEnterHandler, MarkdownEnterHandler, PyEnterAtIndentHandler, PythonEnterHandler, YAMLEnterAtIndentHandler

public interface EnterHandlerDelegate

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EnterHandlerDelegate.Result

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
EnterHandlerDelegate.Result	postProcessEnter(PsiFile file, Editor editor, DataContext dataContext) Called at the end of Enter handling after line feed insertion and indentation adjustment.
EnterHandlerDelegate.Result	preprocessEnter(PsiFile file, Editor editor, Ref<java.lang.Integer> caretOffset, Ref<java.lang.Integer> caretAdvance, DataContext dataContext, EditorActionHandler originalHandler) Called before the actual Enter processing is done.

Field Detail

EP_NAME

static final ExtensionPointName<EnterHandlerDelegate> EP_NAME

Method Detail

preprocessEnter

EnterHandlerDelegate.Result preprocessEnter(PsiFile file,
                                            Editor editor,
                                            Ref<java.lang.Integer> caretOffset,
                                            Ref<java.lang.Integer> caretAdvance,
                                            DataContext dataContext,
                                            EditorActionHandler originalHandler)

Called before the actual Enter processing is done. Important Note: A document associated with the editor may have modifications which are not reflected yet in the PSI file. If any operations with PSI are needed including a search for PSI elements, the document must be committed first to update the PSI. For example:

   PsiDocumentManager.getInstance(file.getProject()).commitDocument(editor.getDocument);
 

Parameters:

file - The PSI file associated with the document.

editor - The editor.

caretOffset - Indicates a place where line break is to be inserted (it's a caret position initially). Method implementation can change this value to adjust target line break position.

caretAdvance - A reference to the number of columns by which the caret must be moved forward.

dataContext - The data context passed to the enter handler.

originalHandler - The original handler.

Returns:

One of EnterHandlerDelegate.Result values.

postProcessEnter

EnterHandlerDelegate.Result postProcessEnter(PsiFile file,
                                             Editor editor,
                                             DataContext dataContext)

Called at the end of Enter handling after line feed insertion and indentation adjustment.

Important Note: A document associated with the editor has modifications which are not reflected yet in the PSI file. If any operations with PSI are needed including a search for PSI elements, the document must be committed first to update the PSI. For example:

   PsiDocumentManager.getInstance(file.getProject()).commitDocument(editor.getDocument);
 

Parameters:

file - The PSI file associated with the document.

editor - The editor.

dataContext - The data context passed to the Enter handler.

Returns:

One of EnterHandlerDelegate.Result values.

See Also:

DataContext, PsiDocumentManager