|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2000, 2005 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 module dwtx.jface.text.source.IAnnotationHoverExtension;
|
|
|
14
|
|
131
|
15 import dwtx.jface.text.source.ISharedTextColors; // packageimport
|
|
|
16 import dwtx.jface.text.source.ILineRange; // packageimport
|
|
|
17 import dwtx.jface.text.source.IAnnotationPresentation; // packageimport
|
|
|
18 import dwtx.jface.text.source.IVerticalRulerInfoExtension; // packageimport
|
|
|
19 import dwtx.jface.text.source.ICharacterPairMatcher; // packageimport
|
|
|
20 import dwtx.jface.text.source.TextInvocationContext; // packageimport
|
|
|
21 import dwtx.jface.text.source.LineChangeHover; // packageimport
|
|
|
22 import dwtx.jface.text.source.IChangeRulerColumn; // packageimport
|
|
|
23 import dwtx.jface.text.source.IAnnotationMap; // packageimport
|
|
|
24 import dwtx.jface.text.source.IAnnotationModelListenerExtension; // packageimport
|
|
|
25 import dwtx.jface.text.source.ISourceViewerExtension2; // packageimport
|
|
|
26 import dwtx.jface.text.source.IAnnotationHover; // packageimport
|
|
|
27 import dwtx.jface.text.source.ContentAssistantFacade; // packageimport
|
|
|
28 import dwtx.jface.text.source.IAnnotationAccess; // packageimport
|
|
|
29 import dwtx.jface.text.source.IVerticalRulerExtension; // packageimport
|
|
|
30 import dwtx.jface.text.source.IVerticalRulerColumn; // packageimport
|
|
|
31 import dwtx.jface.text.source.LineNumberRulerColumn; // packageimport
|
|
|
32 import dwtx.jface.text.source.MatchingCharacterPainter; // packageimport
|
|
|
33 import dwtx.jface.text.source.IAnnotationModelExtension; // packageimport
|
|
|
34 import dwtx.jface.text.source.ILineDifferExtension; // packageimport
|
|
|
35 import dwtx.jface.text.source.DefaultCharacterPairMatcher; // packageimport
|
|
|
36 import dwtx.jface.text.source.LineNumberChangeRulerColumn; // packageimport
|
|
|
37 import dwtx.jface.text.source.IAnnotationAccessExtension; // packageimport
|
|
|
38 import dwtx.jface.text.source.ISourceViewer; // packageimport
|
|
|
39 import dwtx.jface.text.source.AnnotationModel; // packageimport
|
|
|
40 import dwtx.jface.text.source.ILineDifferExtension2; // packageimport
|
|
|
41 import dwtx.jface.text.source.IAnnotationModelListener; // packageimport
|
|
|
42 import dwtx.jface.text.source.IVerticalRuler; // packageimport
|
|
|
43 import dwtx.jface.text.source.DefaultAnnotationHover; // packageimport
|
|
|
44 import dwtx.jface.text.source.SourceViewer; // packageimport
|
|
|
45 import dwtx.jface.text.source.SourceViewerConfiguration; // packageimport
|
|
|
46 import dwtx.jface.text.source.AnnotationBarHoverManager; // packageimport
|
|
|
47 import dwtx.jface.text.source.CompositeRuler; // packageimport
|
|
|
48 import dwtx.jface.text.source.ImageUtilities; // packageimport
|
|
|
49 import dwtx.jface.text.source.VisualAnnotationModel; // packageimport
|
|
|
50 import dwtx.jface.text.source.IAnnotationModel; // packageimport
|
|
|
51 import dwtx.jface.text.source.ISourceViewerExtension3; // packageimport
|
|
|
52 import dwtx.jface.text.source.ILineDiffInfo; // packageimport
|
|
|
53 import dwtx.jface.text.source.VerticalRulerEvent; // packageimport
|
|
|
54 import dwtx.jface.text.source.ChangeRulerColumn; // packageimport
|
|
|
55 import dwtx.jface.text.source.ILineDiffer; // packageimport
|
|
|
56 import dwtx.jface.text.source.AnnotationModelEvent; // packageimport
|
|
|
57 import dwtx.jface.text.source.AnnotationColumn; // packageimport
|
|
|
58 import dwtx.jface.text.source.AnnotationRulerColumn; // packageimport
|
|
|
59 import dwtx.jface.text.source.AbstractRulerColumn; // packageimport
|
|
|
60 import dwtx.jface.text.source.ISourceViewerExtension; // packageimport
|
|
|
61 import dwtx.jface.text.source.AnnotationMap; // packageimport
|
|
|
62 import dwtx.jface.text.source.IVerticalRulerInfo; // packageimport
|
|
|
63 import dwtx.jface.text.source.IAnnotationModelExtension2; // packageimport
|
|
|
64 import dwtx.jface.text.source.LineRange; // packageimport
|
|
|
65 import dwtx.jface.text.source.IAnnotationAccessExtension2; // packageimport
|
|
|
66 import dwtx.jface.text.source.VerticalRuler; // packageimport
|
|
|
67 import dwtx.jface.text.source.JFaceTextMessages; // packageimport
|
|
|
68 import dwtx.jface.text.source.IOverviewRuler; // packageimport
|
|
|
69 import dwtx.jface.text.source.Annotation; // packageimport
|
|
|
70 import dwtx.jface.text.source.IVerticalRulerListener; // packageimport
|
|
|
71 import dwtx.jface.text.source.ISourceViewerExtension4; // packageimport
|
|
|
72 import dwtx.jface.text.source.AnnotationPainter; // packageimport
|
|
|
73 import dwtx.jface.text.source.IAnnotationHoverExtension2; // packageimport
|
|
|
74 import dwtx.jface.text.source.OverviewRuler; // packageimport
|
|
|
75 import dwtx.jface.text.source.OverviewRulerHoverManager; // packageimport
|
|
|
76
|
|
|
77
|
|
129
|
78 import dwt.dwthelper.utils;
|
|
|
79
|
|
|
80 import dwtx.jface.text.IInformationControlCreator;
|
|
|
81
|
|
|
82 /**
|
|
|
83 * Extension interface for {@link dwtx.jface.text.source.IAnnotationHover} for
|
|
|
84 * <ul>
|
|
|
85 * <li>providing its own information control creator</li>
|
|
|
86 * <li>providing the range of lines for which the hover for a given line is valid</li>
|
|
|
87 * <li>providing whether the information control can interact with the mouse cursor</li>
|
|
|
88 * </ul>
|
|
|
89 *
|
|
|
90 * @see dwtx.jface.text.IInformationControlCreator
|
|
|
91 * @see dwtx.jface.text.source.IAnnotationHover
|
|
|
92 * @since 3.0
|
|
|
93 */
|
|
|
94 public interface IAnnotationHoverExtension {
|
|
|
95
|
|
|
96 /**
|
|
|
97 * Returns the hover control creator of this annotation hover.
|
|
|
98 *
|
|
|
99 * @return the hover control creator
|
|
|
100 */
|
|
|
101 IInformationControlCreator getHoverControlCreator();
|
|
|
102
|
|
|
103 /**
|
|
|
104 * Returns whether the provided information control can interact with the mouse cursor. I.e. the
|
|
|
105 * hover must implement custom information control management.
|
|
|
106 *
|
|
|
107 * @return <code>true</code> if the mouse cursor can be handled
|
|
|
108 */
|
|
|
109 bool canHandleMouseCursor();
|
|
|
110
|
|
|
111 /**
|
|
|
112 * Returns the object which should be presented in the a
|
|
|
113 * hover popup window. The information is requested based on
|
|
|
114 * the specified line range.
|
|
|
115 *
|
|
|
116 * @param sourceViewer the source viewer this hover is registered with
|
|
|
117 * @param lineRange the line range for which information is requested
|
|
|
118 * @param visibleNumberOfLines the number of visible lines
|
|
|
119 * @return the requested information or <code>null</code> if no such information exists
|
|
|
120 */
|
|
|
121 Object getHoverInfo(ISourceViewer sourceViewer, ILineRange lineRange, int visibleNumberOfLines);
|
|
|
122
|
|
|
123 /**
|
|
|
124 * Returns the range of lines that include the given line number for which
|
|
|
125 * the same hover information is valid.
|
|
|
126 *
|
|
|
127 * @param viewer the viewer which the hover is queried for
|
|
|
128 * @param lineNumber the line number of the line for which a hover is displayed for
|
|
|
129 * @return the computed line range or <code>null</code> for no range
|
|
|
130 */
|
|
|
131 ILineRange getHoverLineRange(ISourceViewer viewer, int lineNumber);
|
|
|
132 }
|
