org.jeditor.gui

Class CodeEditorHighlighter

java.lang.Object

org.jeditor.gui.CodeEditorHighlighter

public class CodeEditorHighlighter
extends java.lang.Object

Manage the highlighting of text. Highlighting of line number can be performed using the relative line numbers (the default), or the absolute line number in the text.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodeEditorHighlighter.Highlight Represents a highlight on a line which encompass the entire line.
static class	CodeEditorHighlighter.HighlightZone Represents a highlight on a zone in a line.
static class	CodeEditorHighlighter.ZoneHighlight Represents a highlight on a line which can encompass several zones on the line.

Constructor Summary

Constructors

Constructor and Description
CodeEditorHighlighter() Constructor.
CodeEditorHighlighter(boolean absolute) Constructor.

Method Summary

Modifier and Type	Method and Description
void	append(int line, java.awt.Color color) Add a highlight for a specified line number.
void	append(int line, java.awt.Color color, int startOffset, int endOffset) Add a highlight for a specified line number and offset.
void	clear() Clear all highlights.
int	count() Return the number of highlights.
java.awt.Color	getColor(int line) Return the highlight color for a specified line number.
CodeEditorHighlighter.Highlight	getHighlight(int line) Return the highlight for a specified line number.
java.util.Map<java.lang.Integer,CodeEditorHighlighter.Highlight>	getHighlights() Return the highlights.
boolean	hasHighlight(int line) Return if there is a highlight on a line.
boolean	isAbsolute() Return true if the highlighter uses absolute line numbers to paint lines.
boolean	removeHighlight(int line) Remove a highlight.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeEditorHighlighter

public CodeEditorHighlighter()

Constructor.

CodeEditorHighlighter

public CodeEditorHighlighter(boolean absolute)

Constructor.

Parameters:

absolute - true if the highlighter uses absolute line numbers to paint lines

Method Detail

isAbsolute

public boolean isAbsolute()

Return true if the highlighter uses absolute line numbers to paint lines.

Returns:

true if the highlighter uses absolute line numbers to paint lines

append

public void append(int line,
                   java.awt.Color color)

Add a highlight for a specified line number.

Parameters:

line - the line number

color - the highlight color

append

public void append(int line,
                   java.awt.Color color,
                   int startOffset,
                   int endOffset)

Add a highlight for a specified line number and offset.

Parameters:

line - the line number

color - the highlight color

startOffset - the start offset

endOffset - the end offset

removeHighlight

public boolean removeHighlight(int line)

Remove a highlight.

Parameters:

line - the line number

Returns:

true if there was a highlight for this line number

clear

public void clear()

Clear all highlights.

getHighlights

public java.util.Map<java.lang.Integer,CodeEditorHighlighter.Highlight> getHighlights()

Return the highlights.

Returns:

the highlights

hasHighlight

public boolean hasHighlight(int line)

Return if there is a highlight on a line.

Parameters:

line - the line number

Returns:

true if there is a highlight on the line

getColor

public java.awt.Color getColor(int line)

Return the highlight color for a specified line number.

Parameters:

line - the line number

Returns:

the highlight color for the line number

getHighlight

public CodeEditorHighlighter.Highlight getHighlight(int line)

Return the highlight for a specified line number.

Parameters:

line - the line number

Returns:

the highlight for the line number

count

public int count()

Return the number of highlights.

Returns:

the number of highlights