Class RSyntaxTextAreaHighlighter

java.lang.Object

javax.swing.text.LayeredHighlighter

javax.swing.text.DefaultHighlighter

javax.swing.plaf.basic.BasicTextUI.BasicHighlighter

org.fife.ui.rtextarea.RTextAreaHighlighter

org.fife.ui.rsyntaxtextarea.RSyntaxTextAreaHighlighter

All Implemented Interfaces:

UIResource, Highlighter

public class RSyntaxTextAreaHighlighter
extends RTextAreaHighlighter

The highlighter implementation used by RSyntaxTextAreas. It knows to always paint "marked occurrences" highlights below selection highlights, and squiggle underline highlights above all other highlights.

Most of this code is copied from javax.swing.text.DefaultHighlighter; unfortunately, we cannot re-use much of it since it is package private.

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RSyntaxTextAreaHighlighter.SyntaxLayeredHighlightInfoImpl	Highlight info implementation used for parser notices and marked occurrences.

Nested classes/interfaces inherited from class RTextAreaHighlighter

RTextAreaHighlighter.HighlightInfo, RTextAreaHighlighter.HighlightInfoImpl, RTextAreaHighlighter.LayeredHighlightInfo, RTextAreaHighlighter.LayeredHighlightInfoImpl

Nested classes/interfaces inherited from class DefaultHighlighter

DefaultHighlighter.DefaultHighlightPainter

Nested classes/interfaces inherited from class LayeredHighlighter

LayeredHighlighter.LayerPainter

Nested classes/interfaces inherited from interface Highlighter

Highlighter.Highlight, Highlighter.HighlightPainter

Field Summary

Fields

Modifier and Type	Field	Description
private static final Color	DEFAULT_PARSER_NOTICE_COLOR	The default color used for parser notices when none is specified.
private List<RSyntaxTextAreaHighlighter.SyntaxLayeredHighlightInfoImpl>	markedOccurrences	Marked occurrences in the document (to be painted separately from other highlights).
private List<RSyntaxTextAreaHighlighter.SyntaxLayeredHighlightInfoImpl>	parserHighlights	Highlights from document parsers.

Fields inherited from class RTextAreaHighlighter

textArea

Fields inherited from class DefaultHighlighter

DefaultPainter

Constructor Summary

Constructors

Constructor	Description
RSyntaxTextAreaHighlighter()	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) Object	addMarkedOccurrenceHighlight(int start, int end, SmartHighlightPainter p)	Adds a special "marked occurrence" highlight.
(package private) RTextAreaHighlighter.HighlightInfo	addParserHighlight(ParserNotice notice, Highlighter.HighlightPainter p)	Adds a highlight from a parser.
(package private) void	clearMarkOccurrencesHighlights()	Removes all "marked occurrences" highlights from the view.
(package private) void	clearParserHighlights()	Removes all parser highlights.
void	clearParserHighlights(Parser parser)	Removes all the highlights for a specific parser.
void	deinstall(JTextComponent c)
List<DocumentRange>	getMarkedOccurrences()	Returns a list of "marked occurrences" in the text area.
void	paintLayeredHighlights(Graphics g, int lineStart, int lineEnd, Shape viewBounds, JTextComponent editor, View view)	Paints the "marked occurrences" highlights, then any other standard layered highlights (e.g.
void	paintParserHighlights(Graphics g, int lineStart, int lineEnd, Shape viewBounds, JTextComponent editor, View view)	Paints any highlights from Parsers.
(package private) void	removeParserHighlight(RTextAreaHighlighter.HighlightInfo tag)	Removes a parser highlight from this view.

Methods inherited from class RTextAreaHighlighter

getMarkAllHighlightCount, getMarkAllHighlightRanges, install, paintListLayered, repaintListHighlight

Methods inherited from class DefaultHighlighter

addHighlight, changeHighlight, getDrawsLayeredHighlights, getHighlights, paint, removeAllHighlights, removeHighlight, setDrawsLayeredHighlights

Methods inherited from class Object

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

Field Details

markedOccurrences

private List<RSyntaxTextAreaHighlighter.SyntaxLayeredHighlightInfoImpl> markedOccurrences

Marked occurrences in the document (to be painted separately from other highlights).

parserHighlights

private List<RSyntaxTextAreaHighlighter.SyntaxLayeredHighlightInfoImpl> parserHighlights

Highlights from document parsers. These should be painted "on top of" all other highlights to ensure they are always above the selection.

DEFAULT_PARSER_NOTICE_COLOR

private static final Color DEFAULT_PARSER_NOTICE_COLOR

The default color used for parser notices when none is specified.

Constructor Details

RSyntaxTextAreaHighlighter

public RSyntaxTextAreaHighlighter()

Constructor.

Method Details

addMarkedOccurrenceHighlight

Object addMarkedOccurrenceHighlight(int start,
 int end,
 SmartHighlightPainter p)
                             throws BadLocationException

Adds a special "marked occurrence" highlight.

Parameters:

start - The start offset.

end - The end offset, exclusive.

p - The painter to use.

Returns:

A tag to reference the highlight later.

Throws:

BadLocationException - If the specified range is invalid.

See Also:

• clearMarkOccurrencesHighlights()

addParserHighlight

RTextAreaHighlighter.HighlightInfo addParserHighlight(ParserNotice notice,
 Highlighter.HighlightPainter p)
                                               throws BadLocationException

Adds a highlight from a parser.

Parameters:

notice - The notice from a Parser.

Returns:

A tag with which to reference the highlight.

Throws:

BadLocationException - If the specified notice references invalid offsets.

See Also:

• clearParserHighlights()
• clearParserHighlights(Parser)

clearMarkOccurrencesHighlights

void clearMarkOccurrencesHighlights()

Removes all "marked occurrences" highlights from the view.

See Also:

• addMarkedOccurrenceHighlight(int, int, SmartHighlightPainter)

clearParserHighlights

void clearParserHighlights()

Removes all parser highlights.

See Also:

• addParserHighlight(ParserNotice, javax.swing.text.Highlighter.HighlightPainter)

clearParserHighlights

public void clearParserHighlights(Parser parser)

Removes all the highlights for a specific parser.

Parameters:

parser - The parser.

deinstall

public void deinstall(JTextComponent c)

Specified by:

deinstall in interface Highlighter

Overrides:

deinstall in class RTextAreaHighlighter

getMarkedOccurrences

public List<DocumentRange> getMarkedOccurrences()

Returns a list of "marked occurrences" in the text area. If there are no marked occurrences, this will be an empty list.

Returns:

The list of marked occurrences, or an empty list if none. The contents of this list will be of type DocumentRange.

paintLayeredHighlights

public void paintLayeredHighlights(Graphics g,
 int lineStart,
 int lineEnd,
 Shape viewBounds,
 JTextComponent editor,
 View view)

Paints the "marked occurrences" highlights, then any other standard layered highlights (e.g. the text selection).

Overrides:

paintLayeredHighlights in class RTextAreaHighlighter

Parameters:

g - The graphics context.

lineStart - The starting offset of the line.

lineEnd - The end offset of the line.

viewBounds - The bounds of the view.

editor - The parent text component.

view - The view instance being rendered.

See Also:

• paintParserHighlights(Graphics, int, int, Shape, JTextComponent, View)

paintParserHighlights

public void paintParserHighlights(Graphics g,
 int lineStart,
 int lineEnd,
 Shape viewBounds,
 JTextComponent editor,
 View view)

Paints any highlights from Parsers.

Parameters:

g - The graphics context.

lineStart - The starting offset of the line.

lineEnd - The end offset of the line.

viewBounds - The bounds of the view.

editor - The parent text component.

view - The view instance being rendered.

See Also:

• paintLayeredHighlights(Graphics, int, int, Shape, JTextComponent, View)

removeParserHighlight

void removeParserHighlight(RTextAreaHighlighter.HighlightInfo tag)

Removes a parser highlight from this view.

Parameters:

tag - The reference to the highlight.

See Also:

• addParserHighlight(ParserNotice, javax.swing.text.Highlighter.HighlightPainter)