Package com.intellij.codeInsight.editorActions.enter

Class EnterHandlerDelegateAdapter

java.lang.Object

com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegateAdapter

All Implemented Interfaces:

EnterHandlerDelegate

Direct Known Subclasses:

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

public class EnterHandlerDelegateAdapter
extends java.lang.Object
implements EnterHandlerDelegate

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegate

EnterHandlerDelegate.Result

Field Summary

Fields inherited from interface com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegate

EP_NAME

Constructor Summary

Constructors

Constructor and Description
EnterHandlerDelegateAdapter()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnterHandlerDelegateAdapter

public EnterHandlerDelegateAdapter()

Method Detail

preprocessEnter

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

Description copied from interface: EnterHandlerDelegate

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);
 

Specified by:

preprocessEnter in interface EnterHandlerDelegate

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

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

Description copied from interface: EnterHandlerDelegate

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);
 

Specified by:

postProcessEnter in interface EnterHandlerDelegate

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