Package com.intellij.codeInsight.editorActions

Class HtmlQuoteHandler

java.lang.Object

com.intellij.codeInsight.editorActions.HtmlQuoteHandler

All Implemented Interfaces:

QuoteHandler

public class HtmlQuoteHandler
extends java.lang.Object
implements QuoteHandler

Constructor Summary

Constructors

Constructor and Description
HtmlQuoteHandler()

Method Summary

Modifier and Type	Method and Description
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.
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	isInsideLiteral(HighlighterIterator iterator)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlQuoteHandler

public HtmlQuoteHandler()

Method Detail

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

Parameters:

iterator - highlighting iterator at the state corresponding to the offset

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

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

Parameters:

iterator - highlighting iterator at the state corresponding to the offset

offset - the offset at which the quote was inserted

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

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)

isInsideLiteral

public boolean isInsideLiteral(HighlighterIterator iterator)

Specified by:

isInsideLiteral in interface QuoteHandler