org.fife.ui.rsyntaxtextarea
Class RSyntaxTextAreaHighlighter

java.lang.Object
  javax.swing.text.LayeredHighlighter
      javax.swing.text.DefaultHighlighter
          javax.swing.plaf.basic.BasicTextUI.BasicHighlighter
              org.fife.ui.rsyntaxtextarea.RSyntaxTextAreaHighlighter

All Implemented Interfaces:

javax.swing.plaf.UIResource, javax.swing.text.Highlighter

public class RSyntaxTextAreaHighlighter
extends javax.swing.plaf.basic.BasicTextUI.BasicHighlighter

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

Author:

Robert Futrell

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.text.DefaultHighlighter

javax.swing.text.DefaultHighlighter.DefaultHighlightPainter

Nested classes/interfaces inherited from class javax.swing.text.LayeredHighlighter

javax.swing.text.LayeredHighlighter.LayerPainter

Nested classes/interfaces inherited from interface javax.swing.text.Highlighter

javax.swing.text.Highlighter.Highlight, javax.swing.text.Highlighter.HighlightPainter

Field Summary

Fields inherited from class javax.swing.text.DefaultHighlighter

DefaultPainter

Constructor Summary

RSyntaxTextAreaHighlighter()
Constructor.

Method Summary

void	clearParserHighlights(Parser parser) Removes all of the highlights for a specific parser.
void	deinstall(javax.swing.text.JTextComponent c)
java.util.List	getMarkedOccurrences() Returns a list of "marked occurrences" in the text area.
void	install(javax.swing.text.JTextComponent c)
void	paint(java.awt.Graphics g) Renders the highlights.
void	paintLayeredHighlights(java.awt.Graphics g, int p0, int p1, java.awt.Shape viewBounds, javax.swing.text.JTextComponent editor, javax.swing.text.View view) When leaf Views (such as LabelView) are rendering they should call into this method.

Methods inherited from class javax.swing.text.DefaultHighlighter

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RSyntaxTextAreaHighlighter

public RSyntaxTextAreaHighlighter()

Constructor.

Method Detail

clearParserHighlights

public void clearParserHighlights(Parser parser)

Removes all of the highlights for a specific parser.

Parameters:

parser - The parser.

deinstall

public void deinstall(javax.swing.text.JTextComponent c)

Specified by:

deinstall in interface javax.swing.text.Highlighter

Overrides:

deinstall in class javax.swing.text.DefaultHighlighter

getMarkedOccurrences

public java.util.List 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.

install

public void install(javax.swing.text.JTextComponent c)

Specified by:

install in interface javax.swing.text.Highlighter

Overrides:

install in class javax.swing.text.DefaultHighlighter

paint

public void paint(java.awt.Graphics g)

Renders the highlights.

Specified by:

paint in interface javax.swing.text.Highlighter

Overrides:

paint in class javax.swing.text.DefaultHighlighter

Parameters:

g - the graphics context

paintLayeredHighlights

public void paintLayeredHighlights(java.awt.Graphics g,
                                   int p0,
                                   int p1,
                                   java.awt.Shape viewBounds,
                                   javax.swing.text.JTextComponent editor,
                                   javax.swing.text.View view)

When leaf Views (such as LabelView) are rendering they should call into this method. If a highlight is in the given region it will be drawn immediately.

Overrides:

paintLayeredHighlights in class javax.swing.text.DefaultHighlighter

Parameters:

g - Graphics used to draw

p0 - starting offset of view

p1 - ending offset of view

viewBounds - Bounds of View

editor - JTextComponent

view - View instance being rendered