Package com.intellij.openapi.editor.ex.util

Class LexerEditorHighlighter

java.lang.Object

com.intellij.openapi.editor.ex.util.LexerEditorHighlighter

All Implemented Interfaces:

DocumentListener, PrioritizedDocumentListener, EditorHighlighter, java.util.EventListener

Direct Known Subclasses:

LayeredLexerEditorHighlighter, PythonEditorHighlighter

public class LexerEditorHighlighter
extends java.lang.Object
implements EditorHighlighter, PrioritizedDocumentListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LexerEditorHighlighter.HighlighterIteratorImpl
static class	LexerEditorHighlighter.InvalidStateException
protected static interface	LexerEditorHighlighter.TokenProcessor

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.CharSequence	myText

Fields inherited from interface com.intellij.openapi.editor.ex.PrioritizedDocumentListener

COMPARATOR

Fields inherited from interface com.intellij.openapi.editor.event.DocumentListener

ARRAY_FACTORY, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
LexerEditorHighlighter(SyntaxHighlighter highlighter, EditorColorsScheme scheme)

Method Summary

Modifier and Type	Method and Description
boolean	checkContentIsEqualTo(java.lang.CharSequence sequence)
HighlighterIterator	createIterator(int startOffset)
protected SegmentArrayWithData	createSegments()
protected DataStorage	createStorage() Defines how to pack/unpack and store highlighting states.
protected LexerEditorHighlighter.TokenProcessor	createTokenProcessor(int startIndex, SegmentArrayWithData segments, java.lang.CharSequence myText)
void	documentChanged(DocumentEvent e) Called after the text of the document has been changed.
java.util.List<TextAttributes>	getAttributesForPreviousAndTypedChars(Document document, int offset, char c)
HighlighterClient	getClient()
protected Document	getDocument()
protected Lexer	getLexer()
int	getPriority()
EditorColorsScheme	getScheme()
SegmentArrayWithData	getSegments()
SyntaxHighlighter	getSyntaxHighlighter()
protected boolean	hasAdditionalData(int segmentIndex)
boolean	isPlain()
boolean	isValid()
void	setColorScheme(EditorColorsScheme scheme)
void	setEditor(HighlighterClient editor)
void	setText(java.lang.CharSequence text)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.editor.event.DocumentListener

beforeDocumentChange, bulkUpdateFinished, bulkUpdateStarting

Field Detail

myText

protected java.lang.CharSequence myText

Constructor Detail

LexerEditorHighlighter

public LexerEditorHighlighter(SyntaxHighlighter highlighter,
                              EditorColorsScheme scheme)

Method Detail

createSegments

protected SegmentArrayWithData createSegments()

createStorage

protected DataStorage createStorage()

Defines how to pack/unpack and store highlighting states.

By default a editor highlighter uses ShortBasedStorage implementation which serializes information about element type to be highlighted with elements' indices (IElementType.getIndex()) and deserializes ids back to IElementType using element types registry IElementType.find(short).

If you need to store more information during syntax highlighting or if your element types cannot be restored from IElementType.getIndex(), you can implement you own storage and override this method.

As an example, see TextMateHighlightingLexer, that lexes files with unregistered (without index) element types and its data storage (TextMateLexerDataStorage serializes/deserializes them to/from strings. The storage is created in TextMateEditorHighlighterProvider.TextMateLexerEditorHighlighter

Returns:

data storage for highlighter states

isPlain

public boolean isPlain()

getDocument

protected final Document getDocument()

checkContentIsEqualTo

public final boolean checkContentIsEqualTo(java.lang.CharSequence sequence)

getScheme

public EditorColorsScheme getScheme()

getLexer

protected Lexer getLexer()

setEditor

public void setEditor(HighlighterClient editor)

Specified by:

setEditor in interface EditorHighlighter

setColorScheme

public void setColorScheme(EditorColorsScheme scheme)

Specified by:

setColorScheme in interface EditorHighlighter

createIterator

public HighlighterIterator createIterator(int startOffset)

Specified by:

createIterator in interface EditorHighlighter

isValid

public boolean isValid()

documentChanged

public void documentChanged(DocumentEvent e)

Description copied from interface: DocumentListener

Called after the text of the document has been changed.

Specified by:

documentChanged in interface DocumentListener

Parameters:

e - the event containing the information about the change.

hasAdditionalData

protected boolean hasAdditionalData(int segmentIndex)

getPriority

public int getPriority()

Specified by:

getPriority in interface PrioritizedDocumentListener

getClient

public HighlighterClient getClient()

setText

public void setText(java.lang.CharSequence text)

Specified by:

setText in interface EditorHighlighter

createTokenProcessor

protected LexerEditorHighlighter.TokenProcessor createTokenProcessor(int startIndex,
                                                                     SegmentArrayWithData segments,
                                                                     java.lang.CharSequence myText)

getSyntaxHighlighter

public SyntaxHighlighter getSyntaxHighlighter()

getAttributesForPreviousAndTypedChars

public java.util.List<TextAttributes> getAttributesForPreviousAndTypedChars(Document document,
                                                                            int offset,
                                                                            char c)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSegments

public SegmentArrayWithData getSegments()