processing.mode.java.debug

Class LineHighlight

java.lang.Object

processing.mode.java.debug.LineHighlight

public class LineHighlight
extends Object

Model/Controller for a highlighted source code line. Implements a custom background color and a text based marker placed in the left-hand gutter area.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Set<LineHighlight>	allHighlights
protected JavaEditor	editor
protected LineID	lineID
protected String	marker
protected int	priority

Constructor Summary

Constructors

Constructor and Description
LineHighlight(int lineIdx, JavaEditor editor) Create a LineHighlight on the current tab.
LineHighlight(LineID lineID, JavaEditor editor) Create a LineHighlight.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear this line highlight.
void	dispose() Notify this line highlight that it is no longer used.
LineID	getLineID() Retrieve the line id of this LineHighlight.
protected static boolean	isHighestPriority(LineHighlight hl)
boolean	isOnLine(LineID testLine) Test if this highlight is on a certain line.
void	lineChanged(LineID line, int oldLineIdx, int newLineIdx) Event handler for line number changes (due to editing).
void	paint() (Re-)paint this line highlight.
int	priority()
void	setMarker(String marker) Set a text based marker displayed in the left hand gutter area of this highlighted line.
void	setPriority(int p)

Methods inherited from class java.lang.Object

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

Field Detail

editor

protected final JavaEditor editor

lineID

protected final LineID lineID

marker

protected String marker

priority

protected int priority

allHighlights

protected static final Set<LineHighlight> allHighlights

Constructor Detail

LineHighlight

public LineHighlight(LineID lineID,
                     JavaEditor editor)

Create a LineHighlight.

LineHighlight

public LineHighlight(int lineIdx,
                     JavaEditor editor)

Create a LineHighlight on the current tab.

Parameters:

lineIdx - the line index on the current tab to highlight

editor - the JavaEditor

Method Detail

isHighestPriority

protected static boolean isHighestPriority(LineHighlight hl)

setPriority

public void setPriority(int p)

priority

public int priority()

setMarker

public void setMarker(String marker)

Set a text based marker displayed in the left hand gutter area of this highlighted line.

Parameters:

marker - the marker text

getLineID

public LineID getLineID()

Retrieve the line id of this LineHighlight.

Returns:

the line id

isOnLine

public boolean isOnLine(LineID testLine)

Test if this highlight is on a certain line.

Parameters:

testLine - the line to test

Returns:

true if this highlight is on the given line

lineChanged

public void lineChanged(LineID line,
                        int oldLineIdx,
                        int newLineIdx)

Event handler for line number changes (due to editing). Will remove the highlight from the old line number and repaint it at the new location.

Parameters:

line - the line that has changed

oldLineIdx - the old line index (0-based)

newLineIdx - the new line index (0-based)

dispose

public void dispose()

Notify this line highlight that it is no longer used. Call this for cleanup before the LineHighlight is discarded.

paint

public void paint()

(Re-)paint this line highlight.

clear

public void clear()

Clear this line highlight.