org.fife.ui.rtextarea
Class RTextAreaHighlighter

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

All Implemented Interfaces:

UIResource, Highlighter

Direct Known Subclasses:

RSyntaxTextAreaHighlighter

public class RTextAreaHighlighter
extends BasicTextUI.BasicHighlighter

The highlighter implementation used by RTextAreas. It knows to always paint "mark all" highlights below selection 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

static interface	RTextAreaHighlighter.HighlightInfo Information about a highlight being painted by this highlighter.
protected static class	RTextAreaHighlighter.HighlightInfoImpl A straightforward implementation of HighlightInfo.
static interface	RTextAreaHighlighter.LayeredHighlightInfo Information about a layered highlight being painted by this highlighter.
protected static class	RTextAreaHighlighter.LayeredHighlightInfoImpl A straightforward implementation of HighlightInfo for painting layered highlights.

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

DefaultHighlighter.DefaultHighlightPainter

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

LayeredHighlighter.LayerPainter

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

Highlighter.Highlight, Highlighter.HighlightPainter

Field Summary

protected RTextArea

textArea The text component we are the highlighter for.

Fields inherited from class javax.swing.text.DefaultHighlighter

DefaultPainter

Constructor Summary

RTextAreaHighlighter()
Constructor.

Method Summary

void	deinstall(JTextComponent c)
int	getMarkAllHighlightCount() Returns the number of "mark all" highlights currently shown in the editor.
List<DocumentRange>	getMarkAllHighlightRanges() Returns a list of "mark all" highlights in the text area.
void	install(JTextComponent c)
void	paintLayeredHighlights(Graphics g, int lineStart, int lineEnd, Shape viewBounds, JTextComponent editor, View view) When leaf Views (such as LabelView) are rendering they should call into this method.
protected void	paintList(Graphics g, List<? extends RTextAreaHighlighter.HighlightInfo> highlights) Paints a list of highlights.
protected void	paintListLayered(Graphics g, int lineStart, int lineEnd, Shape viewBounds, JTextComponent editor, View view, List<? extends RTextAreaHighlighter.HighlightInfo> highlights)
protected void	repaintListHighlight(RTextAreaHighlighter.HighlightInfo info)

Methods inherited from class javax.swing.text.DefaultHighlighter

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

Methods inherited from class java.lang.Object

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

Field Detail

textArea

protected RTextArea textArea

The text component we are the highlighter for.

Constructor Detail

RTextAreaHighlighter

public RTextAreaHighlighter()

Constructor.

Method Detail

deinstall

public void deinstall(JTextComponent c)

Specified by:

deinstall in interface Highlighter

Overrides:

deinstall in class DefaultHighlighter

getMarkAllHighlightCount

public int getMarkAllHighlightCount()

Returns the number of "mark all" highlights currently shown in the editor.

Returns:

The "mark all" highlight count.

getMarkAllHighlightRanges

public List<DocumentRange> getMarkAllHighlightRanges()

Returns a list of "mark all" highlights in the text area. If there are no such highlights, this will be an empty list.

Returns:

The list of "mark all" highlight ranges.

install

public void install(JTextComponent c)

Specified by:

install in interface Highlighter

Overrides:

install in class DefaultHighlighter

paintList

protected void paintList(Graphics g,
                         List<? extends RTextAreaHighlighter.HighlightInfo> highlights)

Paints a list of highlights.

Parameters:

g - The graphics context.

highlights - The list of highlights to paint.

paintLayeredHighlights

public void paintLayeredHighlights(Graphics g,
                                   int lineStart,
                                   int lineEnd,
                                   Shape viewBounds,
                                   JTextComponent editor,
                                   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 DefaultHighlighter

Parameters:

g - Graphics used to draw

lineStart - starting offset of view

lineEnd - ending offset of view

viewBounds - Bounds of View

editor - JTextComponent

view - View instance being rendered

paintListLayered

protected void paintListLayered(Graphics g,
                                int lineStart,
                                int lineEnd,
                                Shape viewBounds,
                                JTextComponent editor,
                                View view,
                                List<? extends RTextAreaHighlighter.HighlightInfo> highlights)

repaintListHighlight

protected void repaintListHighlight(RTextAreaHighlighter.HighlightInfo info)