|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2000, 2007 IBM Corporation and others.
|
|
|
3 * All rights reserved. This program and the accompanying materials
|
|
|
4 * are made available under the terms of the Eclipse Public License v1.0
|
|
|
5 * which accompanies this distribution, and is available at
|
|
|
6 * http://www.eclipse.org/legal/epl-v10.html
|
|
|
7 *
|
|
|
8 * Contributors:
|
|
|
9 * IBM Corporation - initial API and implementation
|
|
|
10 * Port to the D programming language:
|
|
|
11 * Frank Benoit <benoit@tionex.de>
|
|
|
12 *******************************************************************************/
|
|
|
13
|
|
131
|
14
|
|
151
|
15 module dwtx.jface.text.source.IVerticalRulerInfo;
|
|
|
16
|
|
131
|
17 import dwtx.jface.text.source.ISharedTextColors; // packageimport
|
|
|
18 import dwtx.jface.text.source.ILineRange; // packageimport
|
|
|
19 import dwtx.jface.text.source.IAnnotationPresentation; // packageimport
|
|
|
20 import dwtx.jface.text.source.IVerticalRulerInfoExtension; // packageimport
|
|
|
21 import dwtx.jface.text.source.ICharacterPairMatcher; // packageimport
|
|
|
22 import dwtx.jface.text.source.TextInvocationContext; // packageimport
|
|
|
23 import dwtx.jface.text.source.LineChangeHover; // packageimport
|
|
|
24 import dwtx.jface.text.source.IChangeRulerColumn; // packageimport
|
|
|
25 import dwtx.jface.text.source.IAnnotationMap; // packageimport
|
|
|
26 import dwtx.jface.text.source.IAnnotationModelListenerExtension; // packageimport
|
|
|
27 import dwtx.jface.text.source.ISourceViewerExtension2; // packageimport
|
|
|
28 import dwtx.jface.text.source.IAnnotationHover; // packageimport
|
|
|
29 import dwtx.jface.text.source.ContentAssistantFacade; // packageimport
|
|
|
30 import dwtx.jface.text.source.IAnnotationAccess; // packageimport
|
|
|
31 import dwtx.jface.text.source.IVerticalRulerExtension; // packageimport
|
|
|
32 import dwtx.jface.text.source.IVerticalRulerColumn; // packageimport
|
|
|
33 import dwtx.jface.text.source.LineNumberRulerColumn; // packageimport
|
|
|
34 import dwtx.jface.text.source.MatchingCharacterPainter; // packageimport
|
|
|
35 import dwtx.jface.text.source.IAnnotationModelExtension; // packageimport
|
|
|
36 import dwtx.jface.text.source.ILineDifferExtension; // packageimport
|
|
|
37 import dwtx.jface.text.source.DefaultCharacterPairMatcher; // packageimport
|
|
|
38 import dwtx.jface.text.source.LineNumberChangeRulerColumn; // packageimport
|
|
|
39 import dwtx.jface.text.source.IAnnotationAccessExtension; // packageimport
|
|
|
40 import dwtx.jface.text.source.ISourceViewer; // packageimport
|
|
|
41 import dwtx.jface.text.source.AnnotationModel; // packageimport
|
|
|
42 import dwtx.jface.text.source.ILineDifferExtension2; // packageimport
|
|
|
43 import dwtx.jface.text.source.IAnnotationModelListener; // packageimport
|
|
|
44 import dwtx.jface.text.source.IVerticalRuler; // packageimport
|
|
|
45 import dwtx.jface.text.source.DefaultAnnotationHover; // packageimport
|
|
|
46 import dwtx.jface.text.source.SourceViewer; // packageimport
|
|
|
47 import dwtx.jface.text.source.SourceViewerConfiguration; // packageimport
|
|
|
48 import dwtx.jface.text.source.AnnotationBarHoverManager; // packageimport
|
|
|
49 import dwtx.jface.text.source.CompositeRuler; // packageimport
|
|
|
50 import dwtx.jface.text.source.ImageUtilities; // packageimport
|
|
|
51 import dwtx.jface.text.source.VisualAnnotationModel; // packageimport
|
|
|
52 import dwtx.jface.text.source.IAnnotationModel; // packageimport
|
|
|
53 import dwtx.jface.text.source.ISourceViewerExtension3; // packageimport
|
|
|
54 import dwtx.jface.text.source.ILineDiffInfo; // packageimport
|
|
|
55 import dwtx.jface.text.source.VerticalRulerEvent; // packageimport
|
|
|
56 import dwtx.jface.text.source.ChangeRulerColumn; // packageimport
|
|
|
57 import dwtx.jface.text.source.ILineDiffer; // packageimport
|
|
|
58 import dwtx.jface.text.source.AnnotationModelEvent; // packageimport
|
|
|
59 import dwtx.jface.text.source.AnnotationColumn; // packageimport
|
|
|
60 import dwtx.jface.text.source.AnnotationRulerColumn; // packageimport
|
|
|
61 import dwtx.jface.text.source.IAnnotationHoverExtension; // packageimport
|
|
|
62 import dwtx.jface.text.source.AbstractRulerColumn; // packageimport
|
|
|
63 import dwtx.jface.text.source.ISourceViewerExtension; // packageimport
|
|
|
64 import dwtx.jface.text.source.AnnotationMap; // packageimport
|
|
|
65 import dwtx.jface.text.source.IAnnotationModelExtension2; // packageimport
|
|
|
66 import dwtx.jface.text.source.LineRange; // packageimport
|
|
|
67 import dwtx.jface.text.source.IAnnotationAccessExtension2; // packageimport
|
|
|
68 import dwtx.jface.text.source.VerticalRuler; // packageimport
|
|
|
69 import dwtx.jface.text.source.JFaceTextMessages; // packageimport
|
|
|
70 import dwtx.jface.text.source.IOverviewRuler; // packageimport
|
|
|
71 import dwtx.jface.text.source.Annotation; // packageimport
|
|
|
72 import dwtx.jface.text.source.IVerticalRulerListener; // packageimport
|
|
|
73 import dwtx.jface.text.source.ISourceViewerExtension4; // packageimport
|
|
|
74 import dwtx.jface.text.source.AnnotationPainter; // packageimport
|
|
|
75 import dwtx.jface.text.source.IAnnotationHoverExtension2; // packageimport
|
|
|
76 import dwtx.jface.text.source.OverviewRuler; // packageimport
|
|
|
77 import dwtx.jface.text.source.OverviewRulerHoverManager; // packageimport
|
|
|
78
|
|
129
|
79 import dwt.dwthelper.utils;
|
|
|
80
|
|
|
81
|
|
|
82 import dwt.widgets.Control;
|
|
|
83
|
|
|
84
|
|
|
85 /**
|
|
|
86 * A vertical ruler is a visual component which may serve text viewers as an
|
|
|
87 * annotation presentation area. The vertical ruler info provides interested
|
|
|
88 * clients with the mapping and interaction aspect of the vertical ruler. This
|
|
|
89 * covers the mapping between coordinates of the ruler's control and line
|
|
|
90 * numbers based on the connected text viewer's document.
|
|
|
91 *
|
|
|
92 * In order to provide backward compatibility for clients of
|
|
|
93 * <code>IVerticalRulerInfo</code>, extension interfaces are used as a means
|
|
|
94 * of evolution. The following extension interfaces exist:
|
|
|
95 * <ul>
|
|
|
96 * <li>{@link dwtx.jface.text.source.IVerticalRulerInfoExtension} since
|
|
|
97 * version 3.0 allowing custom annotation hovers and specific annotation models.
|
|
|
98 * </li>
|
|
|
99 * </ul>
|
|
|
100 *
|
|
|
101 * @see dwtx.jface.text.source.IVerticalRulerInfoExtension
|
|
|
102 * @since 2.0
|
|
|
103 */
|
|
|
104 public interface IVerticalRulerInfo {
|
|
|
105
|
|
|
106 /**
|
|
|
107 * Returns the ruler's DWT control.
|
|
|
108 *
|
|
|
109 * @return the ruler's DWT control
|
|
|
110 */
|
|
|
111 Control getControl();
|
|
|
112
|
|
|
113 /**
|
|
|
114 * Returns the line number of the last mouse button activity.
|
|
|
115 * Based on the input document of the connected text viewer.
|
|
|
116 *
|
|
|
117 * @return the line number of the last mouse button activity or <code>-1</code> if
|
|
|
118 * the last mouse activity does not correspond to a valid document line
|
|
|
119 */
|
|
|
120 int getLineOfLastMouseButtonActivity();
|
|
|
121
|
|
|
122 /**
|
|
|
123 * Translates a y-coordinate of the ruler's DWT control into
|
|
|
124 * the according line number of the document of the connected text viewer.
|
|
|
125 *
|
|
|
126 * @param y_coordinate a y-coordinate of the ruler's DWT control
|
|
|
127 * @return the line number of that coordinate or <code>-1</code> if that
|
|
|
128 * coordinate does not correspond to a valid document line
|
|
|
129 */
|
|
|
130 int toDocumentLineNumber(int y_coordinate);
|
|
|
131
|
|
|
132 /**
|
|
|
133 * Returns the width of this ruler's control.
|
|
|
134 *
|
|
|
135 * @return the width of this ruler's control
|
|
|
136 */
|
|
|
137 int getWidth();
|
|
|
138 }
|
