oracle.javatools.editor.gutter
Interface GutterMark

public interface GutterMark

The GutterMark is used by the Gutter interface and implementations to mark a specific column and line in the Gutter with an Icon. If the mark was created with tracking requested, the getLine() method may be called to determine the current line of the mark.

It is possible the underlying buffer may be reloaded from disk (or persistent storage), such as on an application switch, if the buffer was modified externally. In such cases, rather than removing all gutter marks (which in the case of a debugger, would mean removing all breakpoints), we will leave all gutter marks as they are (i.e., not moved) except in the case that the buffer gets shorter, in which case we will remove tracking breakpoints beyond the length of the buffer.

See Also:

Gutter, GutterTrackingListener

Method Summary

java.lang.String	getColumnName() Fetches the name of gutter column that this mark was created in.
Gutter	getGutter() Fetches the Gutter that this mark has been created in.
HighlightStyle	getHighlightStyle() Fetches the HighlightStyle associated with this GutterMark when it was created.
javax.swing.Icon	getIcon() Fetches the Icon that was associated with this GutterMark when it was created.
int	getLine() Fetches the line that this GutterMark is currently located on.
boolean	isTracking() Fetches whether this mark performs line tracking.

Method Detail

getColumnName

public java.lang.String getColumnName()

Fetches the name of gutter column that this mark was created in.

Returns:

the GutterColumn containing this mark

getGutter

public Gutter getGutter()

Fetches the Gutter that this mark has been created in.

Returns:

the Gutter containing this mark.

getIcon

public javax.swing.Icon getIcon()

Fetches the Icon that was associated with this GutterMark when it was created. This is the icon that is displayed in the Gutter to represent this mark.

Returns:

this icon for this mark

getHighlightStyle

public HighlightStyle getHighlightStyle()

Fetches the HighlightStyle associated with this GutterMark when it was created. This is the style used for highlighting the line for this mark.

Returns:

the highlight style for this mark

getLine

public int getLine()

Fetches the line that this GutterMark is currently located on. If this mark is not tracking, then the line is the one the mark was created on.

Returns:

the line for this mark

isTracking

public boolean isTracking()

Fetches whether this mark performs line tracking.

Returns:

true if this mark tracks the line