Package com.intellij.codeInsight.editorActions.enter

Class EnterBetweenBracesFinalHandler

java.lang.Object

com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegateAdapter

com.intellij.codeInsight.editorActions.enter.EnterBetweenBracesFinalHandler

All Implemented Interfaces:

EnterHandlerDelegate

Direct Known Subclasses:

EnterBetweenBracesHandler

public class EnterBetweenBracesFinalHandler
extends EnterHandlerDelegateAdapter

Please, don't extend the class. Use the EnterBetweenBracesDelegate language-specific implementation instead.

Nested Class Summary

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

EnterHandlerDelegate.Result

Field Summary

Fields

Modifier and Type	Field and Description
protected static EnterBetweenBracesDelegate	ourDefaultBetweenDelegate

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

EP_NAME

Constructor Summary

Constructors

Constructor and Description
EnterBetweenBracesFinalHandler()

Method Summary

Modifier and Type	Method and Description
protected EnterBetweenBracesDelegate	getLanguageImplementation(Language language)
protected boolean	isApplicable(PsiFile file, Editor editor, java.lang.CharSequence documentText, int caretOffset, EnterBetweenBracesDelegate helper)
protected static boolean	isValidOffset(int offset, java.lang.CharSequence text)
EnterHandlerDelegate.Result	preprocessEnter(PsiFile file, Editor editor, Ref<java.lang.Integer> caretOffsetRef, Ref<java.lang.Integer> caretAdvance, DataContext dataContext, EditorActionHandler originalHandler) Called before the actual Enter processing is done.

Methods inherited from class com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegateAdapter

postProcessEnter

Methods inherited from class java.lang.Object

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

Field Detail

ourDefaultBetweenDelegate

protected static EnterBetweenBracesDelegate ourDefaultBetweenDelegate

Constructor Detail

EnterBetweenBracesFinalHandler

public EnterBetweenBracesFinalHandler()

Method Detail

preprocessEnter

public EnterHandlerDelegate.Result preprocessEnter(PsiFile file,
                                                   Editor editor,
                                                   Ref<java.lang.Integer> caretOffsetRef,
                                                   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

Overrides:

preprocessEnter in class EnterHandlerDelegateAdapter

Parameters:

file - The PSI file associated with the document.

editor - The editor.

caretOffsetRef - 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.

isApplicable

protected boolean isApplicable(PsiFile file,
                               Editor editor,
                               java.lang.CharSequence documentText,
                               int caretOffset,
                               EnterBetweenBracesDelegate helper)

getLanguageImplementation

protected EnterBetweenBracesDelegate getLanguageImplementation(Language language)

isValidOffset

protected static boolean isValidOffset(int offset,
                                       java.lang.CharSequence text)