public interface IOverviewRuler extends IVerticalRuler
This interfaces embodies three contracts:
IVerticalRulerInfo).
Clients may implement this interface or use the default implementation provided
by OverviewlRuler.
ITextViewer| Modifier and Type | Method and Description |
|---|---|
void |
addAnnotationType(Object annotationType)
Adds the given annotation type to this overview ruler.
|
void |
addHeaderAnnotationType(Object annotationType)
Adds the given annotation type to the header of this ruler.
|
int |
getAnnotationHeight()
Returns the height of the visual presentation of an annotation in this
overview ruler.
|
Control |
getHeaderControl()
Returns this rulers header control.
|
boolean |
hasAnnotation(int y)
Returns whether there is an annotation an the given vertical coordinate.
|
void |
removeAnnotationType(Object annotationType)
Removes the given annotation type from this overview ruler.
|
void |
removeHeaderAnnotationType(Object annotationType)
Removes the given annotation type from the header of this ruler.
|
void |
setAnnotationTypeColor(Object annotationType,
Color color)
Sets the color for the given annotation type in this overview ruler.
|
void |
setAnnotationTypeLayer(Object annotationType,
int layer)
Sets the drawing layer for the given annotation type in this overview ruler.
|
createControl, getModel, setModel, updategetControl, getLineOfLastMouseButtonActivity, getWidth, toDocumentLineNumberboolean hasAnnotation(int y)
y - the y-coordinatetrue if there is an annotation, false otherwiseint getAnnotationHeight()
void setAnnotationTypeColor(Object annotationType, Color color)
annotationType - the annotation typecolor - the colorvoid setAnnotationTypeLayer(Object annotationType, int layer)
annotationType - the annotation typelayer - the drawing layervoid addAnnotationType(Object annotationType)
annotationType - the annotation typevoid removeAnnotationType(Object annotationType)
annotationType - the annotation typevoid addHeaderAnnotationType(Object annotationType)
annotationType - the annotation type to be trackedvoid removeHeaderAnnotationType(Object annotationType)
annotationType - the annotation type to be removedControl getHeaderControl()
Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.