|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2000, 2006 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.IAnnotationAccess;
|
|
|
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.IVerticalRulerExtension; // packageimport
|
|
|
29 import dwtx.jface.text.source.IVerticalRulerColumn; // packageimport
|
|
|
30 import dwtx.jface.text.source.LineNumberRulerColumn; // packageimport
|
|
|
31 import dwtx.jface.text.source.MatchingCharacterPainter; // packageimport
|
|
|
32 import dwtx.jface.text.source.IAnnotationModelExtension; // packageimport
|
|
|
33 import dwtx.jface.text.source.ILineDifferExtension; // packageimport
|
|
|
34 import dwtx.jface.text.source.DefaultCharacterPairMatcher; // packageimport
|
|
|
35 import dwtx.jface.text.source.LineNumberChangeRulerColumn; // packageimport
|
|
|
36 import dwtx.jface.text.source.IAnnotationAccessExtension; // packageimport
|
|
|
37 import dwtx.jface.text.source.ISourceViewer; // packageimport
|
|
|
38 import dwtx.jface.text.source.AnnotationModel; // packageimport
|
|
|
39 import dwtx.jface.text.source.ILineDifferExtension2; // packageimport
|
|
|
40 import dwtx.jface.text.source.IAnnotationModelListener; // packageimport
|
|
|
41 import dwtx.jface.text.source.IVerticalRuler; // packageimport
|
|
|
42 import dwtx.jface.text.source.DefaultAnnotationHover; // packageimport
|
|
|
43 import dwtx.jface.text.source.SourceViewer; // packageimport
|
|
|
44 import dwtx.jface.text.source.SourceViewerConfiguration; // packageimport
|
|
|
45 import dwtx.jface.text.source.AnnotationBarHoverManager; // packageimport
|
|
|
46 import dwtx.jface.text.source.CompositeRuler; // packageimport
|
|
|
47 import dwtx.jface.text.source.ImageUtilities; // packageimport
|
|
|
48 import dwtx.jface.text.source.VisualAnnotationModel; // packageimport
|
|
|
49 import dwtx.jface.text.source.IAnnotationModel; // packageimport
|
|
|
50 import dwtx.jface.text.source.ISourceViewerExtension3; // packageimport
|
|
|
51 import dwtx.jface.text.source.ILineDiffInfo; // packageimport
|
|
|
52 import dwtx.jface.text.source.VerticalRulerEvent; // packageimport
|
|
|
53 import dwtx.jface.text.source.ChangeRulerColumn; // packageimport
|
|
|
54 import dwtx.jface.text.source.ILineDiffer; // packageimport
|
|
|
55 import dwtx.jface.text.source.AnnotationModelEvent; // packageimport
|
|
|
56 import dwtx.jface.text.source.AnnotationColumn; // packageimport
|
|
|
57 import dwtx.jface.text.source.AnnotationRulerColumn; // packageimport
|
|
|
58 import dwtx.jface.text.source.IAnnotationHoverExtension; // 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 /**
|
|
|
81 * An annotation access provides access to information that is not available via
|
|
|
82 * the API of {@link dwtx.jface.text.source.Annotation}. With version
|
|
|
83 * 3.0 all this information is now available from the annotation itself.
|
|
|
84 * <p>
|
|
|
85 *
|
|
|
86 * In order to provide backward compatibility for clients of
|
|
|
87 * <code>IAnnotationAccess</code>, extension interfaces are used as a means
|
|
|
88 * of evolution. The following extension interfaces exist:
|
|
|
89 * <ul>
|
|
|
90 * <li>{@link dwtx.jface.text.source.IAnnotationAccessExtension} since
|
|
|
91 * version 3.0 replacing all methods in that interface</li>
|
|
|
92 * <li>{@link IAnnotationAccessExtension2} since
|
|
|
93 * version 3.2 allowing to set a quick assist assistant to an annotation access.</li>
|
|
|
94 * </ul></p>
|
|
|
95 * <p>
|
|
|
96 * Clients usually implement this interface and its extension interfaces.</p>
|
|
|
97 *
|
|
|
98 * @see dwtx.jface.text.source.IAnnotationAccessExtension
|
|
|
99 * @see dwtx.jface.text.source.Annotation
|
|
|
100 * @since 2.1
|
|
|
101 */
|
|
|
102 public interface IAnnotationAccess {
|
|
|
103
|
|
|
104 /**
|
|
|
105 * Returns the type of the given annotation.
|
|
|
106 *
|
|
|
107 * @param annotation the annotation
|
|
|
108 * @return the type of the given annotation or <code>null</code> if it has none.
|
|
|
109 * @deprecated use <code>Annotation.getType()</code>
|
|
|
110 */
|
|
|
111 Object getType(Annotation annotation);
|
|
|
112
|
|
|
113 /**
|
|
|
114 * Returns whether the given annotation spans multiple lines.
|
|
|
115 *
|
|
|
116 * @param annotation the annotation
|
|
|
117 * @return <code>true</code> if the annotation spans multiple lines,
|
|
|
118 * <code>false</code> otherwise
|
|
|
119 *
|
|
|
120 * @deprecated assumed to always return <code>true</code>
|
|
|
121 */
|
|
|
122 bool isMultiLine(Annotation annotation);
|
|
|
123
|
|
|
124 /**
|
|
|
125 * Returns whether the given annotation is temporary rather than persistent.
|
|
|
126 *
|
|
|
127 * @param annotation the annotation
|
|
|
128 * @return <code>true</code> if the annotation is temporary,
|
|
|
129 * <code>false</code> otherwise
|
|
|
130 * @deprecated use <code>Annotation.isPersistent()</code>
|
|
|
131 */
|
|
|
132 bool isTemporary(Annotation annotation);
|
|
|
133 }
|
