blob: 6b373894c8d4dc045cfddc805eb1f69683e8e541 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
/*******************************************************************************
* Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text.source;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.widgets.Control;
/**
* 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.
* <p>
* This interfaces embodies three contracts:
* <ul>
* <li> The overview ruler retrieves the annotations it presents from an annotation model.
* <li> The ruler is a visual component which must be integrated in a hierarchy of SWT controls.
* <li> The ruler provides interested clients with mapping and
* interaction information. This covers the mapping between
* coordinates of the ruler's control and line numbers based
* on the connected text viewer's document (<code>IVerticalRulerInfo</code>).
* </ul></p>
* <p>
* Clients may implement this interface or use the default implementation provided
* by <code>OverviewlRuler</code>.</p>
*
* @see org.eclipse.jface.text.ITextViewer
* @since 2.1
*/
public interface IOverviewRuler extends IVerticalRuler {
/**
* Returns whether there is an annotation an the given vertical coordinate. This
* method takes the compression factor of the overview ruler into account.
*
* @param y the y-coordinate
* @return <code>true</code> if there is an annotation, <code>false</code> otherwise
*/
boolean hasAnnotation(int y);
/**
* Returns the height of the visual presentation of an annotation in this
* overview ruler. Assumes that all annotations are represented using the
* same height.
*
* @return int the visual height of an annotation
*/
int getAnnotationHeight();
/**
* Sets the color for the given annotation type in this overview ruler.
*
* @param annotationType the annotation type
* @param color the color
*/
void setAnnotationTypeColor(Object annotationType, Color color);
/**
* Sets the drawing layer for the given annotation type in this overview ruler.
*
* @param annotationType the annotation type
* @param layer the drawing layer
*/
void setAnnotationTypeLayer(Object annotationType, int layer);
/**
* Adds the given annotation type to this overview ruler. Starting with this
* call, annotations of the given type are shown in the overview ruler.
*
* @param annotationType the annotation type
*/
void addAnnotationType(Object annotationType);
/**
* Removes the given annotation type from this overview ruler. Annotations
* of the given type are no longer shown in the overview ruler.
*
* @param annotationType the annotation type
*/
void removeAnnotationType(Object annotationType);
/**
* Adds the given annotation type to the header of this ruler. Starting with
* this call, the presence of annotations is tracked and the header is drawn
* in the configured color.
*
* @param annotationType the annotation type to be tracked
*/
void addHeaderAnnotationType(Object annotationType);
/**
* Removes the given annotation type from the header of this ruler. The
* presence of annotations of the given type is no longer tracked and the
* header is drawn in the default color, depending on the other configured
* configured annotation types.
*
* @param annotationType the annotation type to be removed
*/
void removeHeaderAnnotationType(Object annotationType);
/**
* Returns this rulers header control. This is the little area between the
* top of the text widget and the top of this overview ruler.
*
* @return the header control of this overview ruler.
*/
Control getHeaderControl();
}
|
