processing.mode.java.debug

Class LineID

java.lang.Object

processing.mode.java.debug.LineID

All Implemented Interfaces:

EventListener, DocumentListener

public class LineID
extends Object
implements DocumentListener

Describes an ID for a code line. Comprised of a file name and a (0-based) line number. Can track changes to the line number due to text editing by attaching a Document. Registered LineListeners are notified of changes to the line number.

Field Summary

Fields

Modifier and Type	Field and Description
protected Document	doc
protected String	fileName
protected int	lineIdx
protected Set<LineHighlight>	listeners
protected Position	pos

Constructor Summary

Constructors

Constructor and Description
LineID(String fileName, int lineIdx)

Method Summary

Modifier and Type	Method and Description
void	addListener(LineHighlight l) Add listener to be notified when the line number changes.
void	changedUpdate(DocumentEvent de) DocumentListener callback.
protected void	editEvent(DocumentEvent de) Called when the Document registered using startTracking(javax.swing.text.Document) is edited.
boolean	equals(Object obj) Test whether this LineID is equal to another object.
String	fileName() Get the file name of this line.
int	hashCode()
void	insertUpdate(DocumentEvent de) DocumentListener callback.
int	lineIdx() Get the (0-based) line number of this line.
protected static int	nonWhiteSpaceOffset(String str) Calculate the offset of the first non-whitespace character in a string.
void	removeListener(LineHighlight l) Remove a listener for line number changes.
void	removeUpdate(DocumentEvent de) DocumentListener callback.
void	startTracking(Document doc) Attach a Document to enable line number tracking when editing.
void	stopTracking() Notify this LineID that it is no longer in use.
String	toString() Output a string representation in the form fileName:lineIdx+1.
protected void	updatePosition() Update the tracked position.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

fileName

protected String fileName

lineIdx

protected int lineIdx

doc

protected Document doc

pos

protected Position pos

listeners

protected Set<LineHighlight> listeners

Constructor Detail

LineID

public LineID(String fileName,
              int lineIdx)

Method Detail

fileName

public String fileName()

Get the file name of this line.

Returns:

the file name

lineIdx

public int lineIdx()

Get the (0-based) line number of this line.

Returns:

the line index (i.e. line number, starting at 0)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Test whether this LineID is equal to another object. Two LineID's are equal when both their fileName and lineNo are equal.

Overrides:

equals in class Object

Parameters:

obj - the object to test for equality

Returns:

true if equal

toString

public String toString()

Output a string representation in the form fileName:lineIdx+1. Note this uses a 1-based line number as is customary for human-readable line numbers.

Overrides:

toString in class Object

Returns:

the string representation of this line ID

startTracking

public void startTracking(Document doc)

Attach a Document to enable line number tracking when editing. The position to track is before the first non-whitespace character on the line. Edits happening before that position will cause the line number to update accordingly. Multiple startTracking(javax.swing.text.Document) calls will replace the tracked document. Whoever wants a tracked line should track it and add itself as listener if necessary. (LineHighlight, LineBreakpoint)

Parameters:

doc - the Document to use for line number tracking

stopTracking

public void stopTracking()

Notify this LineID that it is no longer in use. Will stop position tracking. Call this when this LineID is no longer needed.

updatePosition

protected void updatePosition()

Update the tracked position. Will notify listeners if line number has changed.

addListener

public void addListener(LineHighlight l)

Add listener to be notified when the line number changes.

Parameters:

l - the listener to add

removeListener

public void removeListener(LineHighlight l)

Remove a listener for line number changes.

Parameters:

l - the listener to remove

nonWhiteSpaceOffset

protected static int nonWhiteSpaceOffset(String str)

Calculate the offset of the first non-whitespace character in a string.

Parameters:

str - the string to examine

Returns:

offset of first non-whitespace character in str

editEvent

protected void editEvent(DocumentEvent de)

Called when the Document registered using startTracking(javax.swing.text.Document) is edited. This happens when text is inserted or removed.

insertUpdate

public void insertUpdate(DocumentEvent de)

DocumentListener callback. Called when text is inserted.

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent de)

DocumentListener callback. Called when text is removed.

Specified by:

removeUpdate in interface DocumentListener

changedUpdate

public void changedUpdate(DocumentEvent de)

DocumentListener callback. Called when attributes are changed. Not used.

Specified by:

changedUpdate in interface DocumentListener