public interface GutterColumnListener<E>
extends java.util.EventListener
GutterColumnListener
interface should be
implemented by clients interested in receiving notification events
associated with GutterMark
instances within a
GutterColumn
. It is also used for fetching the
tooltip that should be displayed for a GutterMark
when the user hovers the mouse over the marks' icon.
For example, a markMoved()
notification is generated
when the user adds or removes text from a prior line B before line
A that a GutterMark
such that line A shifts upwards or
downwards as a result. A markRemoved()
notification
is generated when the user removes the line that a
GutterMark
is tracking. Tracking
GutterMarks
are defined as tracking the beginning of a
line. A markClicked()
notification is generated when
the user clicks on a GutterMark
.
Gutter
,
GutterColumn
,
GutterMark
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getMarkToolTip(GutterMark<E> mark,
java.awt.event.MouseEvent event)
Fetch the tooltip associated with the given
GutterMark . |
void |
markClicked(GutterMark<E> gutterMark,
int clickedLine,
java.awt.event.MouseEvent event)
Notification that the user clicked on the mark.
|
void |
markMoved(GutterMark<E> gutterMark,
int oldLine,
int newLine)
Notification that the user modified the document in such a way as
to cause the line to move.
|
void |
markRemoved(GutterMark<E> gutterMark,
int deletedLine)
Notification that the user modified the document in such a way
that a line for which a GutterMark was set was removed.
|
void markMoved(GutterMark<E> gutterMark, int oldLine, int newLine)
gutterMark
- the line mark that is tracking the given lineoldLine
- the old line number of the line that was movednewLine
- the new line number of the line that was movedvoid markRemoved(GutterMark<E> gutterMark, int deletedLine)
gutterMark
- the line mark that is tracking the given linedeletedLine
- the line number of the line mark that was removedvoid markClicked(GutterMark<E> gutterMark, int clickedLine, java.awt.event.MouseEvent event)
gutterMark
- the mark that was clicked onclickedLine
- the line that was clicked onevent
- the MouseEvent
associated with the clickjava.lang.String getMarkToolTip(GutterMark<E> mark, java.awt.event.MouseEvent event)
GutterMark
.mark
- the mark to get information forevent
- the mouse event that generated the tooltip