|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IOverviewRuler
This interface defines a visual component which may serve text viewers as an overview annotation presentation area. This means, presentation of annotations is independent from the actual view port of the text viewer. The annotations of the viewer's whole document are visible in the overview ruler.
This interfaces embodies three contracts:
IVerticalRulerInfo
).
Clients may implement this interface or use the default implementation provided
by OverviewlRuler
.
ITextViewer
Method Summary | |
---|---|
void |
addAnnotationType(java.lang.Object annotationType)
Adds the given annotation type to this overview ruler. |
void |
addHeaderAnnotationType(java.lang.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(java.lang.Object annotationType)
Removes the given annotation type from this overview ruler. |
void |
removeHeaderAnnotationType(java.lang.Object annotationType)
Removes the given annotation type from the header of this ruler. |
void |
setAnnotationTypeColor(java.lang.Object annotationType,
Color color)
Sets the color for the given annotation type in this overview ruler. |
void |
setAnnotationTypeLayer(java.lang.Object annotationType,
int layer)
Sets the drawing layer for the given annotation type in this overview ruler. |
Methods inherited from interface org.eclipse.jface.text.source.IVerticalRuler |
---|
createControl, getModel, setModel, update |
Methods inherited from interface org.eclipse.jface.text.source.IVerticalRulerInfo |
---|
getControl, getLineOfLastMouseButtonActivity, getWidth, toDocumentLineNumber |
Method Detail |
---|
boolean hasAnnotation(int y)
y
- the y-coordinate
true
if there is an annotation, false
otherwiseint getAnnotationHeight()
void setAnnotationTypeColor(java.lang.Object annotationType, Color color)
annotationType
- the annotation typecolor
- the colorvoid setAnnotationTypeLayer(java.lang.Object annotationType, int layer)
annotationType
- the annotation typelayer
- the drawing layervoid addAnnotationType(java.lang.Object annotationType)
annotationType
- the annotation typevoid removeAnnotationType(java.lang.Object annotationType)
annotationType
- the annotation typevoid addHeaderAnnotationType(java.lang.Object annotationType)
annotationType
- the annotation type to be trackedvoid removeHeaderAnnotationType(java.lang.Object annotationType)
annotationType
- the annotation type to be removedControl getHeaderControl()
|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.