oracle.javatools.editor
Interface FileOverviewMark

All Known Implementing Classes:

LineGutterPlugin.Column.Mark

public interface FileOverviewMark

Field Summary

static int	SEVERITY_ERROR Severity constant used to specify error level severity.
static int	SEVERITY_NONE Severity constant used to specify no severity.
static int	SEVERITY_WARNING Severity constant used to specify warning level severity.

Method Summary

int	getSelectionLength() Called when the FileOverviewMargin is preparing to navigate to this mark's location.
int	getSelectionStart() Called when the FileOverviewMargin is preparing to navigate to this mark's location.
int	getSeverity() Called when the FileOverviewMargin is preparing to update the summary block at the top.
java.lang.String	getToolTipText(java.awt.event.MouseEvent mouseEvent) Called when the FileOverviewMargin is preparing to show a tooltip for this mark.

Field Detail

SEVERITY_NONE

public static final int SEVERITY_NONE

Severity constant used to specify no severity.

See Also:

Constant Field Values

SEVERITY_WARNING

public static final int SEVERITY_WARNING

Severity constant used to specify warning level severity.

See Also:

Constant Field Values

SEVERITY_ERROR

public static final int SEVERITY_ERROR

Severity constant used to specify error level severity.

See Also:

Constant Field Values

Method Detail

getToolTipText

public java.lang.String getToolTipText(java.awt.event.MouseEvent mouseEvent)

Called when the FileOverviewMargin is preparing to show a tooltip for this mark.

Returns:

the desired tooltip

getSelectionStart

public int getSelectionStart()

Called when the FileOverviewMargin is preparing to navigate to this mark's location. If it is desirable to select text in the editor, this method should return the offset for the start of the selection. If it is not desirable to select text, this method should return -1.

Returns:

the selection start offset >= 0

getSelectionLength

public int getSelectionLength()

Called when the FileOverviewMargin is preparing to navigate to this mark's location. If it is desirable to select text in the editor, this method should return the length of the selection.

Returns:

the selection length >= 0

getSeverity

public int getSeverity()

Called when the FileOverviewMargin is preparing to update the summary block at the top. The severity can be SEVERITY_NONE, SEVERITY_WARNING, or SEVERITY_ERROR.

Returns:

the severity constant associated with this mark: SEVERITY_NONE, SEVERITY_WARNING, or SEVERITY_ERROR