Package com.intellij.codeInsight.editorActions.enter

Class BaseIndentEnterHandler

java.lang.Object

com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegateAdapter

com.intellij.codeInsight.editorActions.enter.BaseIndentEnterHandler

All Implemented Interfaces:

EnterHandlerDelegate

public class BaseIndentEnterHandler
extends EnterHandlerDelegateAdapter

Created by IntelliJ IDEA.

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
BaseIndentEnterHandler(Language language, TokenSet indentTokens, IElementType lineCommentType, java.lang.String lineCommentPrefix, TokenSet whitespaceTokens)
BaseIndentEnterHandler(Language language, TokenSet indentTokens, IElementType lineCommentType, java.lang.String lineCommentPrefix, TokenSet whitespaceTokens, boolean worksWithFormatter)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getNewIndent(PsiFile file, Document document, java.lang.CharSequence oldIndent)
protected IElementType	getNonWhitespaceElementType(HighlighterIterator iterator, int currentLineStartOffset, int prevLineStartOffset)
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.
protected EnterHandlerDelegate.Result	shouldSkipWithResult(PsiFile file, Editor editor, DataContext dataContext)

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

Constructor Detail

BaseIndentEnterHandler

public BaseIndentEnterHandler(Language language,
                              TokenSet indentTokens,
                              IElementType lineCommentType,
                              java.lang.String lineCommentPrefix,
                              TokenSet whitespaceTokens)

BaseIndentEnterHandler

public BaseIndentEnterHandler(Language language,
                              TokenSet indentTokens,
                              IElementType lineCommentType,
                              java.lang.String lineCommentPrefix,
                              TokenSet whitespaceTokens,
                              boolean worksWithFormatter)

Method Detail

shouldSkipWithResult

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

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

Overrides:

preprocessEnter in class EnterHandlerDelegateAdapter

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.

getNewIndent

protected java.lang.String getNewIndent(PsiFile file,
                                        Document document,
                                        java.lang.CharSequence oldIndent)

getNonWhitespaceElementType

protected IElementType getNonWhitespaceElementType(HighlighterIterator iterator,
                                                   int currentLineStartOffset,
                                                   int prevLineStartOffset)