org.fife.ui.rsyntaxtextarea
Class SquiggleUnderlineHighlightPainter

java.lang.Object
  javax.swing.text.LayeredHighlighter.LayerPainter
      javax.swing.text.DefaultHighlighter.DefaultHighlightPainter
          org.fife.ui.rsyntaxtextarea.ChangeableColorHighlightPainter
              org.fife.ui.rsyntaxtextarea.SquiggleUnderlineHighlightPainter

All Implemented Interfaces:

javax.swing.text.Highlighter.HighlightPainter

public class SquiggleUnderlineHighlightPainter

extends org.fife.ui.rsyntaxtextarea.ChangeableColorHighlightPainter

Highlight painter that paints a squiggly underline underneath text, similar to what popular IDE's such as Visual Studio and Eclipse do to indicate errors, warnings, etc.

This class must be used as a LayerPainter.

Version:

1.0

Author:

Robert Futrell

Constructor Summary

SquiggleUnderlineHighlightPainter(java.awt.Color color)
Constructor.

Method Summary

java.awt.Color	getColor() Returns the color to paint with.
java.awt.Shape	paintLayer(java.awt.Graphics g, int offs0, int offs1, java.awt.Shape bounds, javax.swing.text.JTextComponent c, javax.swing.text.View view) Paints a portion of a highlight.
protected void	paintSquiggle(java.awt.Graphics g, java.awt.Rectangle r) Paints a squiggle underneath text in the specified rectangle.
void	setColor(java.awt.Color color) Sets the color to paint the bounding boxes with.

Methods inherited from class javax.swing.text.DefaultHighlighter.DefaultHighlightPainter

paint

Methods inherited from class java.lang.Object

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

Constructor Detail

SquiggleUnderlineHighlightPainter

public SquiggleUnderlineHighlightPainter(java.awt.Color color)

Constructor.

Parameters:

color - The color of the squiggle. This cannot be null.

Method Detail

paintLayer

public java.awt.Shape paintLayer(java.awt.Graphics g,
                                 int offs0,
                                 int offs1,
                                 java.awt.Shape bounds,
                                 javax.swing.text.JTextComponent c,
                                 javax.swing.text.View view)

Paints a portion of a highlight.

Parameters:

g - the graphics context

offs0 - the starting model offset >= 0

offs1 - the ending model offset >= offs1

bounds - the bounding box of the view, which is not necessarily the region to paint.

c - the editor

view - View painting for

Returns:

region drawing occurred in

paintSquiggle

protected void paintSquiggle(java.awt.Graphics g,
                             java.awt.Rectangle r)

Paints a squiggle underneath text in the specified rectangle.

Parameters:

g - The graphics context with which to paint.

r - The rectangle containing the text.

getColor

public java.awt.Color getColor()

Returns the color to paint with.

Returns:

The color.

See Also:

ChangeableColorHighlightPainter.setColor(Color)

setColor

public void setColor(java.awt.Color color)

Sets the color to paint the bounding boxes with.

Parameters:

color - The new color. This cannot be null.

See Also:

ChangeableColorHighlightPainter.getColor()