oracle.javatools.ui.overview

Interface OverviewMark<T extends java.lang.Number>

Type Parameters:

T - The type of units the Overview is using as its scale. e.g. a text editor may use Integers to represent each line in the editor. This type should match the type T in the corresponding Overview

All Superinterfaces:

java.lang.Comparable<OverviewMark>

All Known Implementing Classes:

BasicEditorOverviewLabelMark, BasicEditorOverviewMark, DefaultOverviewMark

public interface OverviewMark<T extends java.lang.Number>
extends java.lang.Comparable<OverviewMark>

Marks indicate the position of a location in an Overview by the appearance of a colored strip stretching between start and end location.

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getColor()
T	getEnd()
float	getPriority()
T	getStart()

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getStart

T getStart()

Returns:

the start location in Overview units, where the mark should be rendered.

getEnd

T getEnd()

Returns:

the end location in Overview units, where the mark should be rendered.

getColor

java.awt.Color getColor()

Returns:

the color to render the mark in the overview.

getPriority

float getPriority()

Returns:

the priority of the mark. Higher priority marks appear on top of lower priority marks when they overlap.