Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: d3ab022332edfb64d91aa4437d61964391c7d3b9 (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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.ui.editors">
<annotation>
      <appInfo>
         <meta.schema plugin="org.eclipse.ui.editors" id="markerAnnotationSpecification" name="Marker Annotation Specification"/>
      </appInfo>
      <documentation>
         This extension point is used to define presentation properties of markers. Extensions provided for this extension point can be accessed using &lt;samp&gt;org.eclipse.ui.texteditor.MarkerAnnotationPreferences&lt;/samp&gt;. Use &lt;samp&gt;org.eclipse.ui.texteditor.AnnotationPreferenceLookup&lt;/samp&gt; to get the annotation preference for a given annotation.
&lt;p&gt;
Note that an extension will only be returned from &lt;code&gt;MarkerAnnotationPreferences.getAnnotationPreferences&lt;/code&gt; (and thus included in the preference pages) if it contains the following four attributes in addition to the required &lt;code&gt;annotationType&lt;/code&gt;:
&lt;ul&gt;
 &lt;li&gt;&lt;code&gt;colorPreferenceKey&lt;/code&gt;&lt;/li&gt;
 &lt;li&gt;&lt;code&gt;colorPreferenceValue&lt;/code&gt;&lt;/li&gt;
 &lt;li&gt;&lt;code&gt;overviewRulerPreferenceKey&lt;/code&gt;&lt;/li&gt;
 &lt;li&gt;&lt;code&gt;textPreferenceKey&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;/p&gt;
&lt;p&gt;
Annotation preference types that extend another annotation preference are allowed to overwrite attributes already defined in a parent preference specification, but these will not be accessible from the preference page.
&lt;/p&gt;
      </documentation>
   </annotation>

   <element name="extension">
      <complexType>
         <sequence>
            <element ref="specification"/>
         </sequence>
         <attribute name="point" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="id" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="name" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="specification">
      <complexType>
         <attribute name="annotationType" type="string" use="required">
            <annotation>
               <documentation>
                  The annotation type.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="colorPreferenceKey" type="string">
            <annotation>
               <documentation>
                  The color preference key must be provided, otherwise this annotation type will not be included in the List returned from MarkerAnnotationPreferences.getAnnotationPreferences() and thus not show in the preferences.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="overviewRulerPreferenceKey" type="string">
            <annotation>
               <documentation>
                  The overview ruler preference key must be provided, otherwise this annotation type will not be included in the List returned from MarkerAnnotationPreferences.getAnnotationPreferences() and thus not show in the preferences.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="verticalRulerPreferenceKey" type="string">
            <annotation>
               <documentation>
                  The preference key for the show in vertical ruler preference.
since: 3.0
               </documentation>
            </annotation>
         </attribute>
         <attribute name="textPreferenceKey" type="string">
            <annotation>
               <documentation>
                  The text preference key must be provided, otherwise this annotation type will not be included in the List returned from MarkerAnnotationPreferences.getAnnotationPreferences() and thus not show in the preferences.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="label" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="highlightPreferenceKey" type="string">
            <annotation>
               <documentation>
                  The preference key for highlighting in text.
since: 3.0
               </documentation>
            </annotation>
         </attribute>
         <attribute name="colorPreferenceValue" type="string">
            <annotation>
               <documentation>
                  The color preference value must be provided, otherwise this annotation type will not be included in the List returned from MarkerAnnotationPreferences.getAnnotationPreferences() and thus not show in the preferences.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="presentationLayer" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="overviewRulerPreferenceValue" type="boolean">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="verticalRulerPreferenceValue" type="boolean">
            <annotation>
               <documentation>
                  The default value for showing in vertical ruler.
since: 3.0
               </documentation>
            </annotation>
         </attribute>
         <attribute name="textPreferenceValue" type="boolean">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="highlightPreferenceValue" type="boolean">
            <annotation>
               <documentation>
                  The default value for highlighting in text.
since: 3.0
               </documentation>
            </annotation>
         </attribute>
         <attribute name="contributesToHeader" type="boolean">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="showInNextPrevDropdownToolbarActionKey" type="string">
            <annotation>
               <documentation>
                  The preference key for the visibility in the next/previous drop down toolbar action.
since: 3.0
               </documentation>
            </annotation>
         </attribute>
         <attribute name="showInNextPrevDropdownToolbarAction" type="boolean">
            <annotation>
               <documentation>
                  The default value for the visibility in the next/previous drop down toolbar action.
since: 3.0
               </documentation>
            </annotation>
         </attribute>
         <attribute name="isGoToNextNavigationTargetKey" type="string">
            <annotation>
               <documentation>
                  The preference key for go to next navigation enablement.
since: 3.0
               </documentation>
            </annotation>
         </attribute>
         <attribute name="isGoToNextNavigationTarget" type="boolean">
            <annotation>
               <documentation>
                  The default value for go to next navigation enablement.
since: 3.0
               </documentation>
            </annotation>
         </attribute>
         <attribute name="isGoToPreviousNavigationTargetKey" type="string">
            <annotation>
               <documentation>
                  The preference key for go to previous navigation enablement.
since: 3.0
               </documentation>
            </annotation>
         </attribute>
         <attribute name="isGoToPreviousNavigationTarget" type="boolean">
            <annotation>
               <documentation>
                  The default value for go to previous navigation enablement.
since: 3.0
               </documentation>
            </annotation>
         </attribute>
         <attribute name="icon" type="string">
            <annotation>
               <documentation>
                  The path to the icon to be drawn for annotations of this annotation type.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="symbolicIcon">
            <annotation>
               <documentation>
                  The symbolic name of the image that should be drawn to represent annotation of this annotation type. The image is only used when there is no vertical ruler icon specified for this annotation type. Possible values are: &quot;error&quot;, &quot;warning&quot;, &quot;info&quot;, &quot;task&quot;, &quot;bookmark&quot;.
               </documentation>
            </annotation>
            <simpleType>
               <restriction base="string">
                  <enumeration value="error">
                  </enumeration>
                  <enumeration value="warning">
                  </enumeration>
                  <enumeration value="info">
                  </enumeration>
                  <enumeration value="task">
                  </enumeration>
                  <enumeration value="bookmark">
                  </enumeration>
               </restriction>
            </simpleType>
         </attribute>
         <attribute name="annotationImageProvider" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
               <appInfo>
                  <meta.attribute kind="java"/>
               </appInfo>
            </annotation>
         </attribute>
         <attribute name="textStylePreferenceKey" type="string">
            <annotation>
               <documentation>
                  The preference key for the text decoration property.
since: 3.0
               </documentation>
            </annotation>
         </attribute>
         <attribute name="textStylePreferenceValue">
            <annotation>
               <documentation>
                  The default value for the &quot;show in text&quot; decoration style.
since: 3.0
               </documentation>
            </annotation>
            <simpleType>
               <restriction base="string">
                  <enumeration value="SQUIGGLIES">
                  </enumeration>
                  <enumeration value="BOX">
                  </enumeration>
                  <enumeration value="UNDERLINE">
                  </enumeration>
                  <enumeration value="IBEAM">
                  </enumeration>
                  <enumeration value="NONE">
                  </enumeration>
               </restriction>
            </simpleType>
         </attribute>
         <attribute name="includeOnPreferencePage" type="boolean" use="default" value="true">
            <annotation>
               <documentation>
                  Defines whether this annotation type should be configurable via the standard annotation preference page. Default is true.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appInfo>
         <meta.section type="since"/>
      </appInfo>
      <documentation>
         3.0 (originally named org.eclipse.ui.workbench.texteditor.markerAnnotationSpecification)
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="examples"/>
      </appInfo>
      <documentation>
         
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="apiInfo"/>
      </appInfo>
      <documentation>
         
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="implementation"/>
      </appInfo>
      <documentation>
         
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="copyright"/>
      </appInfo>
      <documentation>
         &lt;p&gt;
&lt;a href=&quot;hglegal.htm&quot;&gt;
 &lt;img SRC=&quot;ngibmcpy.gif&quot;
   ALT=&quot;Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved.&quot;
   BORDER=0 height=14 width=324&gt;&lt;/a&gt;
&lt;/p&gt;
      </documentation>
   </annotation>

</schema>

Back to the top