Package com.intellij.codeInsight.editorActions

Class JavaQuoteHandler

java.lang.Object

com.intellij.codeInsight.editorActions.SimpleTokenSetQuoteHandler

com.intellij.codeInsight.editorActions.JavaQuoteHandler

All Implemented Interfaces:

JavaLikeQuoteHandler, MultiCharQuoteHandler, QuoteHandler

public class JavaQuoteHandler
extends SimpleTokenSetQuoteHandler
implements JavaLikeQuoteHandler, MultiCharQuoteHandler

Field Summary

Fields inherited from class com.intellij.codeInsight.editorActions.SimpleTokenSetQuoteHandler

myLiteralTokenSet

Constructor Summary

Constructors

Constructor and Description
JavaQuoteHandler()

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	getClosingQuote(HighlighterIterator iterator, int offset) Returns a closing quote for an opening quote placed immediately before offset, or null when there is no matching quote.
TokenSet	getConcatenatableStringTokenTypes()
java.lang.String	getStringConcatenationOperatorRepresentation()
TokenSet	getStringTokenTypes()
boolean	hasNonClosedLiteral(Editor editor, HighlighterIterator iterator, int offset) Called after the quote has been inserted in the editor to check that it belongs to an empty string literal that has only the opening quote and therefore, can be completed by inserting the respective closing one.
void	insertClosingQuote(Editor editor, int offset, PsiFile file, java.lang.CharSequence closingQuote) Should insert the closingQuote returned from MultiCharQuoteHandler.getClosingQuote(HighlighterIterator, int) into the document.
boolean	isAppropriateElementTypeForLiteral(IElementType tokenType)
boolean	isClosingQuote(HighlighterIterator iterator, int offset) Checks whether there is the closing quote or the last one of the set of closing quotes of a string literal at the given offset.
boolean	isOpeningQuote(HighlighterIterator iterator, int offset) Checks whether there is the opening quote or the last one of the set of opening quotes of a string literal at the given offset.
boolean	needParenthesesAroundConcatenation(PsiElement element)

Methods inherited from class com.intellij.codeInsight.editorActions.SimpleTokenSetQuoteHandler

isInsideLiteral, isNonClosedLiteral

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.codeInsight.editorActions.JavaLikeQuoteHandler

canBeConcatenated

Methods inherited from interface com.intellij.codeInsight.editorActions.MultiCharQuoteHandler

insertClosingQuote

Methods inherited from interface com.intellij.codeInsight.editorActions.QuoteHandler

isInsideLiteral

Constructor Detail

JavaQuoteHandler

public JavaQuoteHandler()

Method Detail

isOpeningQuote

public boolean isOpeningQuote(HighlighterIterator iterator,
                              int offset)

Description copied from interface: QuoteHandler

Checks whether there is the opening quote or the last one of the set of opening quotes of a string literal at the given offset.

Specified by:

isOpeningQuote in interface QuoteHandler

Overrides:

isOpeningQuote in class SimpleTokenSetQuoteHandler

Parameters:

iterator - highlighting iterator at the state corresponding to the offset

offset - the offset at which the quote was inserted

isClosingQuote

public boolean isClosingQuote(HighlighterIterator iterator,
                              int offset)

Description copied from interface: QuoteHandler

Checks whether there is the closing quote or the last one of the set of closing quotes of a string literal at the given offset.

Upon insertion, this method is called before the quote is actually inserted in the editor in order to check whether it's going to be typed over an existing one closing a string literal and, thus, should be omitted (only the caret position will be adjusted in this case).

Specified by:

isClosingQuote in interface QuoteHandler

Overrides:

isClosingQuote in class SimpleTokenSetQuoteHandler

Parameters:

iterator - highlighting iterator at the state corresponding to the offset

offset - the offset at which the quote is going to be inserted/deleted

getConcatenatableStringTokenTypes

public TokenSet getConcatenatableStringTokenTypes()

Specified by:

getConcatenatableStringTokenTypes in interface JavaLikeQuoteHandler

getStringConcatenationOperatorRepresentation

public java.lang.String getStringConcatenationOperatorRepresentation()

Specified by:

getStringConcatenationOperatorRepresentation in interface JavaLikeQuoteHandler

getStringTokenTypes

public TokenSet getStringTokenTypes()

Specified by:

getStringTokenTypes in interface JavaLikeQuoteHandler

isAppropriateElementTypeForLiteral

public boolean isAppropriateElementTypeForLiteral(IElementType tokenType)

Specified by:

isAppropriateElementTypeForLiteral in interface JavaLikeQuoteHandler

needParenthesesAroundConcatenation

public boolean needParenthesesAroundConcatenation(PsiElement element)

Specified by:

needParenthesesAroundConcatenation in interface JavaLikeQuoteHandler

getClosingQuote

public java.lang.CharSequence getClosingQuote(HighlighterIterator iterator,
                                              int offset)

Description copied from interface: MultiCharQuoteHandler

Returns a closing quote for an opening quote placed immediately before offset, or null when there is no matching quote.

Specified by:

getClosingQuote in interface MultiCharQuoteHandler

hasNonClosedLiteral

public boolean hasNonClosedLiteral(Editor editor,
                                   HighlighterIterator iterator,
                                   int offset)

Description copied from interface: QuoteHandler

Called after the quote has been inserted in the editor to check that it belongs to an empty string literal that has only the opening quote and therefore, can be completed by inserting the respective closing one.

If both this method and QuoteHandler.isOpeningQuote(HighlighterIterator, int) return true, the respective closing quote will be inserted automatically.

Specified by:

hasNonClosedLiteral in interface QuoteHandler

Overrides:

hasNonClosedLiteral in class SimpleTokenSetQuoteHandler

Parameters:

editor - an editor instance where the quote was inserted

iterator - highlighting iterator at the state corresponding to the offset

offset - the offset at which the quote was inserted

See Also:

QuoteHandler.isOpeningQuote(HighlighterIterator, int)

insertClosingQuote

public void insertClosingQuote(Editor editor,
                               int offset,
                               PsiFile file,
                               java.lang.CharSequence closingQuote)

Description copied from interface: MultiCharQuoteHandler

Should insert the closingQuote returned from MultiCharQuoteHandler.getClosingQuote(HighlighterIterator, int) into the document. Override this method for languages with multi-root PSI.

Specified by:

insertClosingQuote in interface MultiCharQuoteHandler