T
- The type of the scale used by the overview (e.g. Float, Integer).M
- The type of OverviewMark that can be added to the Overviewpublic class Overview<T extends java.lang.Number,M extends OverviewMark<T>>
extends java.lang.Object
The overview has an arbitrary start and end; and marks are placed at locations along this scale. Marks are rendered in a linear scale along the overview.
Marks have a priority, and when marks overlap: marks with lower priorities appear below marks with higher priorities.
Marks can be placed into groups which can all be removed at once.
The overview can optionally display a status indicator to display information about the overview: e.g. "Compiling", "4 Errors, 3 Warnings".
The class is not a component itself, the overview UI component can be obtained via Overview.getGUI() and added to a component hierarchy.
Modifier and Type | Class and Description |
---|---|
static class |
Overview.Orientation
The direction of the Overview.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PROPERTY_END
Property fired when the end of the overview changes.
|
static java.lang.String |
PROPERTY_START
Property fired when the start of the overview changes.
|
static java.lang.String |
PROPERTY_STATUS
Property fired when the overview status changes.
|
Constructor and Description |
---|
Overview(Overview.Orientation orientation,
T start,
T end)
Construct an Overview with the given orientation.
|
Overview(T start,
T end)
Construct an Overview with a vertical orientation.
|
Modifier and Type | Method and Description |
---|---|
void |
addMark(M mark)
Add a mark to the overview.
|
void |
addMark(M mark,
java.lang.Object group)
Add a mark to the overview.
|
void |
addOverviewListener(OverviewListener<M> listener)
Listen for changes in the overview.
|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener) |
T |
getEnd()
The overview can be of an arbitrary size.
|
javax.swing.JComponent |
getGUI() |
protected java.util.Collection<M> |
getMarks() |
T |
getStart()
The overview can start at an abitrary point.
|
OverviewStatus |
getStatus() |
void |
rebuild()
Prompt the overview to recalculate and redraw its marks.
|
void |
removeMark(M mark)
Remove a mark from the overview.
|
java.util.Collection<M> |
removeMarks(java.lang.Object group)
Remove all marks that are part of the given group.
|
void |
removeOverviewListener(OverviewListener<M> listener)
Stop listener to changes in the overview.
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener) |
void |
setEnd(T end)
Set the end point of the overview.
|
void |
setInfoTipProvider(OverviewTipProvider overviewInfoTipProvider) |
void |
setStart(T start)
Set the start of the overview.
|
void |
setStatus(OverviewStatus status)
Set the overviews overall status indicator (can be null for no overall status indicator).
|
void |
setThin(boolean thin)
Make the overview GUI thinner than usual.
|
public static final java.lang.String PROPERTY_END
public static final java.lang.String PROPERTY_START
public static final java.lang.String PROPERTY_STATUS
public Overview(T start, T end)
start
- end
- public Overview(Overview.Orientation orientation, T start, T end)
orientation
- start
- end
- public javax.swing.JComponent getGUI()
public void setThin(boolean thin)
thin
- public void rebuild()
public void addMark(M mark)
mark
- the mark to addpublic void addMark(M mark, java.lang.Object group)
All marks in a group can be removed in one go via a call to removeMarks(Object)
.
mark
- the mark to addgroup
- a unique key for the group the mark belongs to.public void removeMark(M mark)
mark
- public java.util.Collection<M> removeMarks(java.lang.Object group)
group
- public T getStart()
public void setStart(T start)
start
- public T getEnd()
public void setEnd(T end)
end
- protected final java.util.Collection<M> getMarks()
public void addOverviewListener(OverviewListener<M> listener)
listener
- public void removeOverviewListener(OverviewListener<M> listener)
listener
- public void setStatus(OverviewStatus status)
status
- public OverviewStatus getStatus()
public void setInfoTipProvider(OverviewTipProvider overviewInfoTipProvider)
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
-