Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 2c5c40bcb993bfadf9836c1821e87f1cb3010ffe (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
335
336
337
<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.ui.intro.quicklinks" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
      <appinfo>
         <meta.schema plugin="org.eclipse.ui.intro.quicklinks" id="org.eclipse.ui.intro.quicklinks" name="Quicklinks Configuration"/>
      </appinfo>
      <documentation>
         This extension point is used to configure the Quicklinks Welcome/Intro viewer component.  Quicklinks are useful actions to be shown to a user in the Intro/Welcome.  The Quicklinks use the Eclipse Core Commands framework (see the &lt;tt&gt;org.eclipse.ui.commands&lt;/tt&gt; extension point), but supports overriding the icon and text to be used for an item.

The Quicklinks is experimental component and is not yet considered API.
      </documentation>
   </annotation>

   <element name="extension">
      <annotation>
         <appinfo>
            <meta.element />
         </appinfo>
      </annotation>
      <complexType>
         <choice minOccurs="1" maxOccurs="unbounded">
            <element ref="command"/>
            <element ref="override"/>
            <element ref="url"/>
         </choice>
         <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>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="command">
      <annotation>
         <documentation>
            Defines a Quicklink component.  One of &quot;command&quot; or &quot;url&quot; must be specified.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="id" type="string" use="required">
            <annotation>
               <documentation>
                  The command identifier to be invoked.  The command can also be a serialized command to encode command parameters (see ParameterizedCommand#serialize() for details).
               </documentation>
               <appinfo>
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.commands/command/@id"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="label" type="string">
            <annotation>
               <documentation>
                  The label to be displayed. If unspecified, the command name is used instead.
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="description" type="string">
            <annotation>
               <documentation>
                  A description for the quicklink. If unspecified, use the command&apos;s description.
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="icon" type="string">
            <annotation>
               <documentation>
                  The icon to be used for the quicklink.  If unspecified, the command&apos;s associated image is used instead.
               </documentation>
               <appinfo>
                  <meta.attribute kind="resource"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="importance">
            <annotation>
               <documentation>
                  Define the level of importance of this item.  If unspecified, defaults to &quot;low&quot;.
               </documentation>
            </annotation>
            <simpleType>
               <restriction base="string">
                  <enumeration value="high">
                  </enumeration>
                  <enumeration value="medium">
                  </enumeration>
                  <enumeration value="low">
                  </enumeration>
               </restriction>
            </simpleType>
         </attribute>
         <attribute name="resolution">
            <annotation>
               <documentation>
                  What should happen to the Welcome view after executing the command.
If &quot;full&quot; or unspecified, the Welcome/Intro part will be put into full visual mode.
If &quot;standby&quot;  (the default), the Welcome/Intro part will be put into standby mode.
If &quot;launchbar&quot;, the Welcome/Intro will be put into &apos;launchbar&apos; mode in the status area.
If &quot;close&quot; then the Welcome/Intro will be closed.
               </documentation>
            </annotation>
            <simpleType>
               <restriction base="string">
                  <enumeration value="standby">
                  </enumeration>
                  <enumeration value="launchbar">
                  </enumeration>
                  <enumeration value="close">
                  </enumeration>
                  <enumeration value="full">
                  </enumeration>
               </restriction>
            </simpleType>
         </attribute>
      </complexType>
   </element>

   <element name="url">
      <annotation>
         <documentation>
            Defines a URL Quicklink component.  URL Quicklinks must provide a label and it is recommended to provide an icon and description
         </documentation>
      </annotation>
      <complexType>
         <attribute name="location" type="string" use="required">
            <annotation>
               <documentation>
                  The URL to be invoked.  The URL can either be an Intro URL or an external URL.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="label" type="string" use="required">
            <annotation>
               <documentation>
                  The label to be displayed. If unspecified, the command name is used instead.
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="description" type="string" use="required">
            <annotation>
               <documentation>
                  A description for the quicklink. If unspecified, use the command&apos;s description.
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="icon" type="string">
            <annotation>
               <documentation>
                  The icon to be used for the quicklink.  If unspecified, the command&apos;s associated image is used instead.
               </documentation>
               <appinfo>
                  <meta.attribute kind="resource"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="importance">
            <annotation>
               <documentation>
                  Define the level of importance of this item.  If unspecified, defaults to &quot;low&quot;.
               </documentation>
            </annotation>
            <simpleType>
               <restriction base="string">
                  <enumeration value="high">
                  </enumeration>
                  <enumeration value="medium">
                  </enumeration>
                  <enumeration value="low">
                  </enumeration>
               </restriction>
            </simpleType>
         </attribute>
      </complexType>
   </element>

   <element name="override">
      <annotation>
         <documentation>
            Provide a mechanism for a theme to override the icons used to represent a command in a quicklink.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="command" type="string" use="required">
            <annotation>
               <documentation>
                  The command identifier as referenced in a &amp;lt;quicklink&amp;gt; element.  The command can also be a serialized command to encode command parameters (see ParameterizedCommand#serialize() for details).  The command may include simple &apos;*&apos; wildcards to match any substring.  For example, &lt;code&gt;org.eclipse.ui.newWizard*&lt;/code&gt; will match any &quot;New&quot; wizard definitions.
               </documentation>
               <appinfo>
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.commands/command/@id"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="theme" type="string" use="required">
            <annotation>
               <documentation>
                  The theme identifier. May be a comma-separated set of values.
               </documentation>
               <appinfo>
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.intro.configExtension/theme/@id"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="icon" type="string" use="required">
            <annotation>
               <documentation>
                  The icon to be used for representing this command.
               </documentation>
               <appinfo>
                  <meta.attribute kind="resource"/>
               </appinfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appinfo>
         <meta.section type="since"/>
      </appinfo>
      <documentation>
         Quicklinks first appeared in the Eclipse Platform 4.6, part of the Neon release train.
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="examples"/>
      </appinfo>
      <documentation>
         Here is an example of configuring a Quicklink:
&lt;pre&gt;
   &lt;extension
         point=&quot;org.eclipse.ui.intro.quicklinks&quot;&gt;
      &lt;!-- Reuses command definition label and icons --&gt;
      &lt;quicklink
            command=&quot;org.eclipse.epp.mpc.ui.command.showMarketplaceWizard&quot;
            icon=&quot;icons/mpcdrag.png&quot;&gt;
      &lt;/quicklink&gt;
      
      &lt;!-- Invoke a particular new wizard; place the Welcome/Intro in Standby mode on success --&gt;
      &lt;quicklink
            command=&quot;org.eclipse.ui.newWizard(newWizardId=org.eclipse.jdt.ui.wizards.JavaProjectWizard)&quot;
            description=&quot;Create a new Java Eclipse project&quot;
            label=&quot;Create a new Java project&quot;
            standby=&quot;true&quot;&gt;
      &lt;/quicklink&gt;
      
      &lt;!-- Allow overriding theme and icons for all newWizard-related commands --&gt;
      &lt;override
            command=&quot;org.eclipse.ui.newWizard*&quot;
            icon=&quot;icons/solstice/new-project.png&quot;
            theme=&quot;org.eclipse.ui.intro.universal.solstice&quot;&gt;
      &lt;/override&gt;
   &lt;/extension&gt;
&lt;/pre&gt;
&lt;p&gt;
Quicklinks are shown using the Quicklinks Viewer Component in a &lt;tt&gt;introContent.xml&lt;/tt&gt; definition.
&lt;/p&gt;
&lt;pre&gt;
 &lt;extensionContent id=&quot;quicklinks&quot; name=&quot;Quick Actions&quot; path=&quot;root/extra-group2/anchor&quot;&gt;
        &lt;contentProvider 
         pluginId=&quot;org.eclipse.ui.intro.quicklinks&quot;
         class=&quot;org.eclipse.ui.intro.quicklinks.QuicklinksViewer&quot;
         id=&quot;quick-links&quot;&gt;
        &lt;/contentProvider&gt;
    &lt;/extensionContent&gt;
&lt;/pre&gt;
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="apiinfo"/>
      </appinfo>
      <documentation>
         Quicklinks are still experimental and not yet considered API.
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="implementation"/>
      </appinfo>
      <documentation>
         Quicklinks are still experimental and not yet considered API.
      </documentation>
   </annotation>

   <annotation>
      <appinfo>
         <meta.section type="copyright"/>
      </appinfo>
      <documentation>
         Copyright (c) 2016 Manumitting Technologies Inc 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:
     Manumitting Technologies Inc - initial API and implementation
      </documentation>
   </annotation>

</schema>

Back to the top