Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
View | Details | Raw Unified | Return to bug 181515 | Differences between
and this patch

Collapse All | Expand All

(-)schema/perspectiveExtensions.exsd (-22 / +39 lines)
Lines 1-10 Link Here
1
<?xml version='1.0' encoding='UTF-8'?>
1
<?xml version='1.0' encoding='UTF-8'?>
2
<!-- Schema file written by PDE -->
2
<!-- Schema file written by PDE -->
3
<schema targetNamespace="org.eclipse.ui">
3
<schema targetNamespace="org.eclipse.ui" xmlns="http://www.w3.org/2001/XMLSchema">
4
<annotation>
4
<annotation>
5
      <appInfo>
5
      <appinfo>
6
         <meta.schema plugin="org.eclipse.ui" id="perspectiveExtensions" name="Perspective Extensions"/>
6
         <meta.schema plugin="org.eclipse.ui" id="perspectiveExtensions" name="Perspective Extensions"/>
7
      </appInfo>
7
      </appinfo>
8
      <documentation>
8
      <documentation>
9
         This extension point is used to extend perspectives 
9
         This extension point is used to extend perspectives 
10
registered by other plug-ins. A perspective defines 
10
registered by other plug-ins. A perspective defines 
Lines 42-50 Link Here
42
               <documentation>
42
               <documentation>
43
                  an optional name of the extension instance
43
                  an optional name of the extension instance
44
               </documentation>
44
               </documentation>
45
               <appInfo>
45
               <appinfo>
46
                  <meta.attribute translatable="true"/>
46
                  <meta.attribute translatable="true"/>
47
               </appInfo>
47
               </appinfo>
48
            </annotation>
48
            </annotation>
49
         </attribute>
49
         </attribute>
50
      </complexType>
50
      </complexType>
Lines 52-60 Link Here
52
52
53
   <element name="perspectiveExtension">
53
   <element name="perspectiveExtension">
54
      <annotation>
54
      <annotation>
55
         <appInfo>
55
         <appinfo>
56
            <meta.element labelAttribute="targetID"/>
56
            <meta.element labelAttribute="targetID"/>
57
         </appInfo>
57
         </appinfo>
58
      </annotation>
58
      </annotation>
59
      <complexType>
59
      <complexType>
60
         <choice minOccurs="0" maxOccurs="unbounded">
60
         <choice minOccurs="0" maxOccurs="unbounded">
Lines 69-76 Link Here
69
            <annotation>
69
            <annotation>
70
               <documentation>
70
               <documentation>
71
                  the unique identifier of the perspective (as specified in the registry) into which the contribution is made. If the value is set to &quot;*&quot; the extension is applied to all perspectives.
71
                  the unique identifier of the perspective (as specified in the registry) into which the contribution is made. If the value is set to &quot;*&quot; the extension is applied to all perspectives.
72
73
               </documentation>
72
               </documentation>
73
               <appinfo>
74
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.perspectives/perspective/@id"/>
75
               </appinfo>
74
            </annotation>
76
            </annotation>
75
         </attribute>
77
         </attribute>
76
      </complexType>
78
      </complexType>
Lines 83-88 Link Here
83
               <documentation>
85
               <documentation>
84
                  the unique identifier of the action set which will be added to the perspective.
86
                  the unique identifier of the action set which will be added to the perspective.
85
               </documentation>
87
               </documentation>
88
               <appinfo>
89
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.actionSets/actionSet/@id"/>
90
               </appinfo>
86
            </annotation>
91
            </annotation>
87
         </attribute>
92
         </attribute>
88
      </complexType>
93
      </complexType>
Lines 95-100 Link Here
95
               <documentation>
100
               <documentation>
96
                  the unique identifier of the view which will be added to the perspective&apos;s &quot;Show View&quot; submenu of the &quot;Window&quot; menu.
101
                  the unique identifier of the view which will be added to the perspective&apos;s &quot;Show View&quot; submenu of the &quot;Window&quot; menu.
97
               </documentation>
102
               </documentation>
103
               <appinfo>
104
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.views/view/@id"/>
105
               </appinfo>
98
            </annotation>
106
            </annotation>
99
         </attribute>
107
         </attribute>
100
      </complexType>
108
      </complexType>
Lines 107-112 Link Here
107
               <documentation>
115
               <documentation>
108
                  the unique identifier of the perspective which will be added to the perspective&apos;s &quot;Open Perspective&quot; submenu of the &quot;Window&quot; menu.
116
                  the unique identifier of the perspective which will be added to the perspective&apos;s &quot;Open Perspective&quot; submenu of the &quot;Window&quot; menu.
109
               </documentation>
117
               </documentation>
118
               <appinfo>
119
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.perspectives/perspective/@id"/>
120
               </appinfo>
110
            </annotation>
121
            </annotation>
111
         </attribute>
122
         </attribute>
112
      </complexType>
123
      </complexType>
Lines 119-124 Link Here
119
               <documentation>
130
               <documentation>
120
                  the unique identifier of the new wizard which will be added to the perspective&apos;s &quot;New&quot; submenu of the &quot;File&quot; menu.
131
                  the unique identifier of the new wizard which will be added to the perspective&apos;s &quot;New&quot; submenu of the &quot;File&quot; menu.
121
               </documentation>
132
               </documentation>
133
               <appinfo>
134
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.newWizards/wizard/@id"/>
135
               </appinfo>
122
            </annotation>
136
            </annotation>
123
         </attribute>
137
         </attribute>
124
      </complexType>
138
      </complexType>
Lines 131-136 Link Here
131
               <documentation>
145
               <documentation>
132
                  the unique identifier of the view which will be added to the perspective&apos;s &quot;Show In...&quot; prompter in the Navigate menu.
146
                  the unique identifier of the view which will be added to the perspective&apos;s &quot;Show In...&quot; prompter in the Navigate menu.
133
               </documentation>
147
               </documentation>
148
               <appinfo>
149
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.views/view/@id"/>
150
               </appinfo>
134
            </annotation>
151
            </annotation>
135
         </attribute>
152
         </attribute>
136
      </complexType>
153
      </complexType>
Lines 143-148 Link Here
143
               <documentation>
160
               <documentation>
144
                  the unique identifier of the view which will be added to the perspective layout.
161
                  the unique identifier of the view which will be added to the perspective layout.
145
               </documentation>
162
               </documentation>
163
               <appinfo>
164
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.views/view/@id"/>
165
               </appinfo>
146
            </annotation>
166
            </annotation>
147
         </attribute>
167
         </attribute>
148
         <attribute name="relative" type="string">
168
         <attribute name="relative" type="string">
Lines 150-155 Link Here
150
               <documentation>
170
               <documentation>
151
                  the unique identifier of a view which already exists in the perspective.  This will be used as a reference point for placement of the view.  The relationship between these two views is defined by &lt;samp&gt;relationship&lt;/samp&gt;.  Ignored if relationship is &quot;fast&quot;.
171
                  the unique identifier of a view which already exists in the perspective.  This will be used as a reference point for placement of the view.  The relationship between these two views is defined by &lt;samp&gt;relationship&lt;/samp&gt;.  Ignored if relationship is &quot;fast&quot;.
152
               </documentation>
172
               </documentation>
173
               <appinfo>
174
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.views/view/@id"/>
175
               </appinfo>
153
            </annotation>
176
            </annotation>
154
         </attribute>
177
         </attribute>
155
         <attribute name="relationship" use="required">
178
         <attribute name="relationship" use="required">
Lines 239-247 Link Here
239
   </element>
262
   </element>
240
263
241
   <annotation>
264
   <annotation>
242
      <appInfo>
265
      <appinfo>
243
         <meta.section type="examples"/>
266
         <meta.section type="examples"/>
244
      </appInfo>
267
      </appinfo>
245
      <documentation>
268
      <documentation>
246
         The following is an example of a perspective extension (note the subelements and the way attributes are used):
269
         The following is an example of a perspective extension (note the subelements and the way attributes are used):
247
&lt;p&gt;
270
&lt;p&gt;
Lines 277-303 Link Here
277
   </annotation>
300
   </annotation>
278
301
279
   <annotation>
302
   <annotation>
280
      <appInfo>
303
      <appinfo>
281
         <meta.section type="apiInfo"/>
304
         <meta.section type="apiInfo"/>
282
      </appInfo>
305
      </appinfo>
283
      <documentation>
306
      <documentation>
284
         The items defined within the perspective extension are contributed to the initial contents of the target perspective.  Following this, the user may remove any contribution or add others to a perspective from within the workbench user interface.
307
         The items defined within the perspective extension are contributed to the initial contents of the target perspective.  Following this, the user may remove any contribution or add others to a perspective from within the workbench user interface.
285
      </documentation>
308
      </documentation>
286
   </annotation>
309
   </annotation>
287
310
288
   <annotation>
311
289
      <appInfo>
312
290
         <meta.section type="implementation"/>
291
      </appInfo>
292
      <documentation>
293
         
294
      </documentation>
295
   </annotation>
296
313
297
   <annotation>
314
   <annotation>
298
      <appInfo>
315
      <appinfo>
299
         <meta.section type="copyright"/>
316
         <meta.section type="copyright"/>
300
      </appInfo>
317
      </appinfo>
301
      <documentation>
318
      <documentation>
302
         Copyright (c) 2002, 2007 IBM Corporation and others.&lt;br&gt;
319
         Copyright (c) 2002, 2007 IBM Corporation and others.&lt;br&gt;
303
All rights reserved. This program and the accompanying materials are made
320
All rights reserved. This program and the accompanying materials are made
(-)schema/bindings.exsd (-23 / +33 lines)
Lines 1-10 Link Here
1
<?xml version='1.0' encoding='UTF-8'?>
1
<?xml version='1.0' encoding='UTF-8'?>
2
<!-- Schema file written by PDE -->
2
<!-- Schema file written by PDE -->
3
<schema targetNamespace="org.eclipse.ui">
3
<schema targetNamespace="org.eclipse.ui" xmlns="http://www.w3.org/2001/XMLSchema">
4
<annotation>
4
<annotation>
5
      <appInfo>
5
      <appinfo>
6
         <meta.schema plugin="org.eclipse.ui" id="bindings" name="Bindings"/>
6
         <meta.schema plugin="org.eclipse.ui" id="bindings" name="Bindings"/>
7
      </appInfo>
7
      </appinfo>
8
      <documentation>
8
      <documentation>
9
         &lt;p&gt;
9
         &lt;p&gt;
10
The &lt;code&gt;org.eclipse.ui.bindings&lt;/code&gt; extension point is used to declare bindings and schemes.  Schemes are sets of one or more bindings.  A binding is a mapping between a certain group of conditions, some user input and a triggered command.
10
The &lt;code&gt;org.eclipse.ui.bindings&lt;/code&gt; extension point is used to declare bindings and schemes.  Schemes are sets of one or more bindings.  A binding is a mapping between a certain group of conditions, some user input and a triggered command.
Lines 49-57 Link Here
49
               <documentation>
49
               <documentation>
50
                  
50
                  
51
               </documentation>
51
               </documentation>
52
               <appInfo>
52
               <appinfo>
53
                  <meta.attribute translatable="true"/>
53
                  <meta.attribute translatable="true"/>
54
               </appInfo>
54
               </appinfo>
55
            </annotation>
55
            </annotation>
56
         </attribute>
56
         </attribute>
57
      </complexType>
57
      </complexType>
Lines 59-67 Link Here
59
59
60
   <element name="scheme">
60
   <element name="scheme">
61
      <annotation>
61
      <annotation>
62
         <appInfo>
62
         <appinfo>
63
            <meta.element labelAttribute="name"/>
63
            <meta.element labelAttribute="name"/>
64
         </appInfo>
64
         </appinfo>
65
         <documentation>
65
         <documentation>
66
            &lt;p&gt;
66
            &lt;p&gt;
67
A scheme is a grouping of bindings that an end user can chose to use.
67
A scheme is a grouping of bindings that an end user can chose to use.
Lines 84-92 Link Here
84
               <documentation>
84
               <documentation>
85
                  The name for this scheme, as it should be displayed to an end-user.  This value should be translated.
85
                  The name for this scheme, as it should be displayed to an end-user.  This value should be translated.
86
               </documentation>
86
               </documentation>
87
               <appInfo>
87
               <appinfo>
88
                  <meta.attribute translatable="true"/>
88
                  <meta.attribute translatable="true"/>
89
               </appInfo>
89
               </appinfo>
90
            </annotation>
90
            </annotation>
91
         </attribute>
91
         </attribute>
92
         <attribute name="description" type="string">
92
         <attribute name="description" type="string">
Lines 94-102 Link Here
94
               <documentation>
94
               <documentation>
95
                  The description for this scheme, as it would be displayed to an end user.  This value should be translated.
95
                  The description for this scheme, as it would be displayed to an end user.  This value should be translated.
96
               </documentation>
96
               </documentation>
97
               <appInfo>
97
               <appinfo>
98
                  <meta.attribute translatable="true"/>
98
                  <meta.attribute translatable="true"/>
99
               </appInfo>
99
               </appinfo>
100
            </annotation>
100
            </annotation>
101
         </attribute>
101
         </attribute>
102
         <attribute name="parentId" type="string">
102
         <attribute name="parentId" type="string">
Lines 111-119 Link Here
111
111
112
   <element name="key">
112
   <element name="key">
113
      <annotation>
113
      <annotation>
114
         <appInfo>
114
         <appinfo>
115
            <meta.element labelAttribute="commandId"/>
115
            <meta.element labelAttribute="commandId"/>
116
         </appInfo>
116
         </appinfo>
117
         <documentation>
117
         <documentation>
118
            &lt;p&gt;A binding between some keyboard input and the triggering of a command.&lt;/p&gt;
118
            &lt;p&gt;A binding between some keyboard input and the triggering of a command.&lt;/p&gt;
119
         </documentation>
119
         </documentation>
Lines 149-154 Link Here
149
               <documentation>
149
               <documentation>
150
                  The identifier of the scheme in which this key binding is active.
150
                  The identifier of the scheme in which this key binding is active.
151
               </documentation>
151
               </documentation>
152
               <appinfo>
153
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.bindings/scheme/@id"/>
154
               </appinfo>
152
            </annotation>
155
            </annotation>
153
         </attribute>
156
         </attribute>
154
         <attribute name="contextId" type="string" use="default" value="org.eclipse.ui.contexts.window">
157
         <attribute name="contextId" type="string" use="default" value="org.eclipse.ui.contexts.window">
Lines 156-161 Link Here
156
               <documentation>
159
               <documentation>
157
                  The identifier of the context in which this key binding is active.  Please see the &lt;code&gt;org.eclipse.ui.contexts&lt;/code&gt; extension point.  If this is not specified, then it defaults to &lt;code&gt;org.eclipse.ui.contexts.window&lt;/code&gt;.
160
                  The identifier of the context in which this key binding is active.  Please see the &lt;code&gt;org.eclipse.ui.contexts&lt;/code&gt; extension point.  If this is not specified, then it defaults to &lt;code&gt;org.eclipse.ui.contexts.window&lt;/code&gt;.
158
               </documentation>
161
               </documentation>
162
               <appinfo>
163
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.contexts/context/@id"/>
164
               </appinfo>
159
            </annotation>
165
            </annotation>
160
         </attribute>
166
         </attribute>
161
         <attribute name="commandId" type="string">
167
         <attribute name="commandId" type="string">
Lines 168-173 Link Here
168
If no command identifier is specified, this is a deletion marker.  This means that any binding in the same context with the same sequence, platform and locale will become inactive when this binding becomes active.  If the platform or locale on a deletion is not specified, then it matches any platform or locale.
174
If no command identifier is specified, this is a deletion marker.  This means that any binding in the same context with the same sequence, platform and locale will become inactive when this binding becomes active.  If the platform or locale on a deletion is not specified, then it matches any platform or locale.
169
&lt;/p&gt;
175
&lt;/p&gt;
170
               </documentation>
176
               </documentation>
177
               <appinfo>
178
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.commands/command/@id"/>
179
               </appinfo>
171
            </annotation>
180
            </annotation>
172
         </attribute>
181
         </attribute>
173
         <attribute name="platform" type="string">
182
         <attribute name="platform" type="string">
Lines 189-197 Link Here
189
198
190
   <element name="parameter">
199
   <element name="parameter">
191
      <annotation>
200
      <annotation>
192
         <appInfo>
201
         <appinfo>
193
            <meta.element labelAttribute="id"/>
202
            <meta.element labelAttribute="id"/>
194
         </appInfo>
203
         </appinfo>
195
         <documentation>
204
         <documentation>
196
            A parameter name and value that should be passed to the command when it is executed.  This allows for the command to be qualified in some way.  For example, a &quot;Show View&quot; command might accept the view id as a parameter.
205
            A parameter name and value that should be passed to the command when it is executed.  This allows for the command to be qualified in some way.  For example, a &quot;Show View&quot; command might accept the view id as a parameter.
197
         </documentation>
206
         </documentation>
Lines 215-232 Link Here
215
   </element>
224
   </element>
216
225
217
   <annotation>
226
   <annotation>
218
      <appInfo>
227
      <appinfo>
219
         <meta.section type="since"/>
228
         <meta.section type="since"/>
220
      </appInfo>
229
      </appinfo>
221
      <documentation>
230
      <documentation>
222
         3.1
231
         3.1
223
      </documentation>
232
      </documentation>
224
   </annotation>
233
   </annotation>
225
234
226
   <annotation>
235
   <annotation>
227
      <appInfo>
236
      <appinfo>
228
         <meta.section type="examples"/>
237
         <meta.section type="examples"/>
229
      </appInfo>
238
      </appinfo>
230
      <documentation>
239
      <documentation>
231
         &lt;pre&gt;
240
         &lt;pre&gt;
232
&lt;extension
241
&lt;extension
Lines 251-259 Link Here
251
   </annotation>
260
   </annotation>
252
261
253
   <annotation>
262
   <annotation>
254
      <appInfo>
263
      <appinfo>
255
         <meta.section type="apiInfo"/>
264
         <meta.section type="apiInfo"/>
256
      </appInfo>
265
      </appinfo>
257
      <documentation>
266
      <documentation>
258
         &lt;p&gt;
267
         &lt;p&gt;
259
There is no public API for defining bindings.  To try to achieve stability for the user, bindings are only defined through the extension points.  If you are an RCP application, you should be able to override this behaviour in the &lt;code&gt;WorkbenchAdvisor&lt;/code&gt;.
268
There is no public API for defining bindings.  To try to achieve stability for the user, bindings are only defined through the extension points.  If you are an RCP application, you should be able to override this behaviour in the &lt;code&gt;WorkbenchAdvisor&lt;/code&gt;.
Lines 265-274 Link Here
265
   </annotation>
274
   </annotation>
266
275
267
276
277
268
   <annotation>
278
   <annotation>
269
      <appInfo>
279
      <appinfo>
270
         <meta.section type="copyright"/>
280
         <meta.section type="copyright"/>
271
      </appInfo>
281
      </appinfo>
272
      <documentation>
282
      <documentation>
273
         Copyright (c) 2005,2007 IBM Corporation and others.&lt;br&gt;
283
         Copyright (c) 2005,2007 IBM Corporation and others.&lt;br&gt;
274
All rights reserved. This program and the accompanying materials are made
284
All rights reserved. This program and the accompanying materials are made
(-)schema/commands.exsd (-123 / +122 lines)
Lines 1-10 Link Here
1
<?xml version='1.0' encoding='UTF-8'?>
1
<?xml version='1.0' encoding='UTF-8'?>
2
<!-- Schema file written by PDE -->
2
<!-- Schema file written by PDE -->
3
<schema targetNamespace="org.eclipse.ui">
3
<schema targetNamespace="org.eclipse.ui" xmlns="http://www.w3.org/2001/XMLSchema">
4
<annotation>
4
<annotation>
5
      <appInfo>
5
      <appinfo>
6
         <meta.schema plugin="org.eclipse.ui" id="commands" name="Commands"/>
6
         <meta.schema plugin="org.eclipse.ui" id="commands" name="Commands"/>
7
      </appInfo>
7
      </appinfo>
8
      <documentation>
8
      <documentation>
9
         &lt;p&gt;
9
         &lt;p&gt;
10
The &lt;code&gt;org.eclipse.ui.commands&lt;/code&gt; extension point is used to declare commands and command categories, using the &lt;code&gt;command&lt;/code&gt; and &lt;code&gt;category&lt;/code&gt; elements. A command is an abstract representation of some semantic behaviour, but not it&apos;s actual implementation.  This allows different developers to contribute specific behaviour for their individual parts.  For example, there might be a &quot;paste&quot; command with one implementation in an editor and a different implementation in an explorer widget.  These implementations are called handlers.  Commands can also be viewed as declarative function pointers, or signal handlers.
10
The &lt;code&gt;org.eclipse.ui.commands&lt;/code&gt; extension point is used to declare commands and command categories, using the &lt;code&gt;command&lt;/code&gt; and &lt;code&gt;category&lt;/code&gt; elements. A command is an abstract representation of some semantic behaviour, but not it&apos;s actual implementation.  This allows different developers to contribute specific behaviour for their individual parts.  For example, there might be a &quot;paste&quot; command with one implementation in an editor and a different implementation in an explorer widget.  These implementations are called handlers.  Commands can also be viewed as declarative function pointers, or signal handlers.
Lines 36-44 Link Here
36
               <documentation>
36
               <documentation>
37
                  An optional name of the extension instance.
37
                  An optional name of the extension instance.
38
               </documentation>
38
               </documentation>
39
               <appInfo>
39
               <appinfo>
40
                  <meta.attribute translatable="true"/>
40
                  <meta.attribute translatable="true"/>
41
               </appInfo>
41
               </appinfo>
42
            </annotation>
42
            </annotation>
43
         </attribute>
43
         </attribute>
44
         <attribute name="point" type="string" use="required">
44
         <attribute name="point" type="string" use="required">
Lines 70-78 Link Here
70
               <documentation>
70
               <documentation>
71
                  Please use &lt;code&gt;categoryId&lt;/code&gt; instead.
71
                  Please use &lt;code&gt;categoryId&lt;/code&gt; instead.
72
               </documentation>
72
               </documentation>
73
               <appInfo>
73
               <appinfo>
74
                  <meta.attribute deprecated="true"/>
74
                  <meta.attribute deprecated="true"/>
75
               </appInfo>
75
               </appinfo>
76
            </annotation>
76
            </annotation>
77
         </attribute>
77
         </attribute>
78
         <attribute name="description" type="string">
78
         <attribute name="description" type="string">
Lines 80-88 Link Here
80
               <documentation>
80
               <documentation>
81
                  A translatable short description of this command for display in the UI.
81
                  A translatable short description of this command for display in the UI.
82
               </documentation>
82
               </documentation>
83
               <appInfo>
83
               <appinfo>
84
                  <meta.attribute translatable="true"/>
84
                  <meta.attribute translatable="true"/>
85
               </appInfo>
85
               </appinfo>
86
            </annotation>
86
            </annotation>
87
         </attribute>
87
         </attribute>
88
         <attribute name="id" type="string" use="required">
88
         <attribute name="id" type="string" use="required">
Lines 97-105 Link Here
97
               <documentation>
97
               <documentation>
98
                  The translatable name of this command for display in the UI. Commands are typically named in the form of an imperative verb.
98
                  The translatable name of this command for display in the UI. Commands are typically named in the form of an imperative verb.
99
               </documentation>
99
               </documentation>
100
               <appInfo>
100
               <appinfo>
101
                  <meta.attribute translatable="true"/>
101
                  <meta.attribute translatable="true"/>
102
               </appInfo>
102
               </appinfo>
103
            </annotation>
103
            </annotation>
104
         </attribute>
104
         </attribute>
105
         <attribute name="categoryId" type="string">
105
         <attribute name="categoryId" type="string">
Lines 110-115 Link Here
110
&lt;/p&gt;
110
&lt;/p&gt;
111
&lt;p&gt;&lt;em&gt;Since: 3.0&lt;/em&gt;&lt;/p&gt;
111
&lt;p&gt;&lt;em&gt;Since: 3.0&lt;/em&gt;&lt;/p&gt;
112
               </documentation>
112
               </documentation>
113
               <appinfo>
114
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.commands/category/@id"/>
115
               </appinfo>
113
            </annotation>
116
            </annotation>
114
         </attribute>
117
         </attribute>
115
         <attribute name="defaultHandler" type="string">
118
         <attribute name="defaultHandler" type="string">
Lines 120-128 Link Here
120
&lt;/p&gt;
123
&lt;/p&gt;
121
&lt;p&gt;&lt;em&gt;Since: 3.1&lt;/em&gt;&lt;/p&gt;
124
&lt;p&gt;&lt;em&gt;Since: 3.1&lt;/em&gt;&lt;/p&gt;
122
               </documentation>
125
               </documentation>
123
               <appInfo>
126
               <appinfo>
124
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IHandler"/>
127
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IHandler"/>
125
               </appInfo>
128
               </appinfo>
126
            </annotation>
129
            </annotation>
127
         </attribute>
130
         </attribute>
128
         <attribute name="returnTypeId" type="string">
131
         <attribute name="returnTypeId" type="string">
Lines 162-170 Link Here
162
               <documentation>
165
               <documentation>
163
                  A translatable short description of this category for display in the UI.
166
                  A translatable short description of this category for display in the UI.
164
               </documentation>
167
               </documentation>
165
               <appInfo>
168
               <appinfo>
166
                  <meta.attribute translatable="true"/>
169
                  <meta.attribute translatable="true"/>
167
               </appInfo>
170
               </appinfo>
168
            </annotation>
171
            </annotation>
169
         </attribute>
172
         </attribute>
170
         <attribute name="id" type="string" use="required">
173
         <attribute name="id" type="string" use="required">
Lines 179-187 Link Here
179
               <documentation>
182
               <documentation>
180
                  The translatable name of this category for display in the UI.
183
                  The translatable name of this category for display in the UI.
181
               </documentation>
184
               </documentation>
182
               <appInfo>
185
               <appinfo>
183
                  <meta.attribute translatable="true"/>
186
                  <meta.attribute translatable="true"/>
184
               </appInfo>
187
               </appinfo>
185
            </annotation>
188
            </annotation>
186
         </attribute>
189
         </attribute>
187
      </complexType>
190
      </complexType>
Lines 189-197 Link Here
189
192
190
   <element name="commandParameter">
193
   <element name="commandParameter">
191
      <annotation>
194
      <annotation>
192
         <appInfo>
195
         <appinfo>
193
            <meta.element labelAttribute="id"/>
196
            <meta.element labelAttribute="id"/>
194
         </appInfo>
197
         </appinfo>
195
         <documentation>
198
         <documentation>
196
            &lt;p&gt;
199
            &lt;p&gt;
197
Defines a parameter that a command should understand.  A parameter is a way to provide more information to a handler at execution time.  For example, a &quot;show view&quot; command might take a view as a parameter.  Handlers should be able to understand these parameters, so they should be treated like API.
200
Defines a parameter that a command should understand.  A parameter is a way to provide more information to a handler at execution time.  For example, a &quot;show view&quot; command might take a view as a parameter.  Handlers should be able to understand these parameters, so they should be treated like API.
Lines 215-223 Link Here
215
               <documentation>
218
               <documentation>
216
                  The name for the parameter.  This is the name as it will be displayed to an end-user.  As such, it should be translatable.  The name should be short -- preferrably one word.
219
                  The name for the parameter.  This is the name as it will be displayed to an end-user.  As such, it should be translatable.  The name should be short -- preferrably one word.
217
               </documentation>
220
               </documentation>
218
               <appInfo>
221
               <appinfo>
219
                  <meta.attribute translatable="true"/>
222
                  <meta.attribute translatable="true"/>
220
               </appInfo>
223
               </appinfo>
221
            </annotation>
224
            </annotation>
222
         </attribute>
225
         </attribute>
223
         <attribute name="values" type="string">
226
         <attribute name="values" type="string">
Lines 225-233 Link Here
225
               <documentation>
228
               <documentation>
226
                  The class providing a list of parameter values for the user to select.  This class should implement &lt;code&gt;org.eclipse.core.commands.IParameterValues&lt;/code&gt;.  If this class is not specified, you must specify the more verbose &lt;code&gt;values&lt;/code&gt; element.  Please see &lt;code&gt;org.eclipse.core.runtime.IExecutableExtension&lt;/code&gt;.
229
                  The class providing a list of parameter values for the user to select.  This class should implement &lt;code&gt;org.eclipse.core.commands.IParameterValues&lt;/code&gt;.  If this class is not specified, you must specify the more verbose &lt;code&gt;values&lt;/code&gt; element.  Please see &lt;code&gt;org.eclipse.core.runtime.IExecutableExtension&lt;/code&gt;.
227
               </documentation>
230
               </documentation>
228
               <appInfo>
231
               <appinfo>
229
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IParameterValues"/>
232
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IParameterValues"/>
230
               </appInfo>
233
               </appinfo>
231
            </annotation>
234
            </annotation>
232
         </attribute>
235
         </attribute>
233
         <attribute name="typeId" type="string">
236
         <attribute name="typeId" type="string">
Lines 235-240 Link Here
235
               <documentation>
238
               <documentation>
236
                  The id of a commandParameterType for this commandParameter.  Specifying a typeId allows handlers of a command to convert string parameter values to objects in a consistent way and it allows potential callers of a command to look for commands that take objects of various types for their parameters.
239
                  The id of a commandParameterType for this commandParameter.  Specifying a typeId allows handlers of a command to convert string parameter values to objects in a consistent way and it allows potential callers of a command to look for commands that take objects of various types for their parameters.
237
               </documentation>
240
               </documentation>
241
               <appinfo>
242
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.commands/commandParameterType/@id"/>
243
               </appinfo>
238
            </annotation>
244
            </annotation>
239
         </attribute>
245
         </attribute>
240
         <attribute name="optional" type="boolean" use="default" value="true">
246
         <attribute name="optional" type="boolean" use="default" value="true">
Lines 269-277 Link Here
269
               <documentation>
275
               <documentation>
270
                  The fully qualified name of a Java class or interface to use as the type of this command parameter.  This attribute is optional, however if omitted, &lt;code&gt;java.lang.Object&lt;/code&gt; will be used as the parameter type.
276
                  The fully qualified name of a Java class or interface to use as the type of this command parameter.  This attribute is optional, however if omitted, &lt;code&gt;java.lang.Object&lt;/code&gt; will be used as the parameter type.
271
               </documentation>
277
               </documentation>
272
               <appInfo>
278
               <appinfo>
273
                  <meta.attribute kind="java"/>
279
                  <meta.attribute kind="java"/>
274
               </appInfo>
280
               </appinfo>
275
            </annotation>
281
            </annotation>
276
         </attribute>
282
         </attribute>
277
         <attribute name="converter" type="string">
283
         <attribute name="converter" type="string">
Lines 279-287 Link Here
279
               <documentation>
285
               <documentation>
280
                  The class for converting between objects and string representations of objects for command parameter values.  This class should extend &lt;code&gt;org.eclipse.core.commands.AbstractParameterValueConverter&lt;/code&gt;. The converter should produce and consume objects of the type indicated in the &lt;code&gt;type&lt;/code&gt; attribute. If this class is not specified, this facility to convert between string and object values for this parameter type will not be available (the &lt;code&gt;getValueConverter()&lt;/code&gt; on class &lt;code&gt;ParameterType&lt;/code&gt; will return &lt;code&gt;null&lt;/code&gt;).
286
                  The class for converting between objects and string representations of objects for command parameter values.  This class should extend &lt;code&gt;org.eclipse.core.commands.AbstractParameterValueConverter&lt;/code&gt;. The converter should produce and consume objects of the type indicated in the &lt;code&gt;type&lt;/code&gt; attribute. If this class is not specified, this facility to convert between string and object values for this parameter type will not be available (the &lt;code&gt;getValueConverter()&lt;/code&gt; on class &lt;code&gt;ParameterType&lt;/code&gt; will return &lt;code&gt;null&lt;/code&gt;).
281
               </documentation>
287
               </documentation>
282
               <appInfo>
288
               <appinfo>
283
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.AbstractParameterValueConverter"/>
289
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.AbstractParameterValueConverter"/>
284
               </appInfo>
290
               </appinfo>
285
            </annotation>
291
            </annotation>
286
         </attribute>
292
         </attribute>
287
      </complexType>
293
      </complexType>
Lines 289-297 Link Here
289
295
290
   <element name="values">
296
   <element name="values">
291
      <annotation>
297
      <annotation>
292
         <appInfo>
298
         <appinfo>
293
            <meta.element labelAttribute="class"/>
299
            <meta.element labelAttribute="class"/>
294
         </appInfo>
300
         </appinfo>
295
         <documentation>
301
         <documentation>
296
            &lt;p&gt;
302
            &lt;p&gt;
297
The more verbose version of the &lt;code&gt;values&lt;/code&gt; attribute on the &lt;code&gt;commandParameter&lt;/code&gt;.
303
The more verbose version of the &lt;code&gt;values&lt;/code&gt; attribute on the &lt;code&gt;commandParameter&lt;/code&gt;.
Lines 308-316 Link Here
308
               <documentation>
314
               <documentation>
309
                  The class providing a list of parameter values for the user to select.  This class should implement &lt;code&gt;org.eclipse.core.commands.IParameterValues&lt;/code&gt;.  If this class is not specified, you must specify the more verbose &lt;code&gt;values&lt;/code&gt; element.  Please see &lt;code&gt;org.eclipse.core.runtime.IExecutableExtension&lt;/code&gt;.
315
                  The class providing a list of parameter values for the user to select.  This class should implement &lt;code&gt;org.eclipse.core.commands.IParameterValues&lt;/code&gt;.  If this class is not specified, you must specify the more verbose &lt;code&gt;values&lt;/code&gt; element.  Please see &lt;code&gt;org.eclipse.core.runtime.IExecutableExtension&lt;/code&gt;.
310
               </documentation>
316
               </documentation>
311
               <appInfo>
317
               <appinfo>
312
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IParameterValues"/>
318
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IParameterValues"/>
313
               </appInfo>
319
               </appinfo>
314
            </annotation>
320
            </annotation>
315
         </attribute>
321
         </attribute>
316
      </complexType>
322
      </complexType>
Lines 318-326 Link Here
318
324
319
   <element name="parameter">
325
   <element name="parameter">
320
      <annotation>
326
      <annotation>
321
         <appInfo>
327
         <appinfo>
322
            <meta.element labelAttribute="name"/>
328
            <meta.element labelAttribute="name"/>
323
         </appInfo>
329
         </appinfo>
324
         <documentation>
330
         <documentation>
325
            &lt;p&gt;
331
            &lt;p&gt;
326
A possible value for a parameter.
332
A possible value for a parameter.
Lines 348-356 Link Here
348
354
349
   <element name="defaultHandler">
355
   <element name="defaultHandler">
350
      <annotation>
356
      <annotation>
351
         <appInfo>
357
         <appinfo>
352
            <meta.element labelAttribute="class"/>
358
            <meta.element labelAttribute="class"/>
353
         </appInfo>
359
         </appinfo>
354
         <documentation>
360
         <documentation>
355
            &lt;p&gt;
361
            &lt;p&gt;
356
The default handler for this command.  If no other handler is active, this handler will be active.  This handler will conflict with other handler definitions that specify no &lt;code&gt;activeWhen&lt;/code&gt; conditions.  If you are not creating an &lt;code&gt;IExecutableExtension&lt;/code&gt;, you can use the &lt;code&gt;defaultHandler&lt;/code&gt; attribute instead.
362
The default handler for this command.  If no other handler is active, this handler will be active.  This handler will conflict with other handler definitions that specify no &lt;code&gt;activeWhen&lt;/code&gt; conditions.  If you are not creating an &lt;code&gt;IExecutableExtension&lt;/code&gt;, you can use the &lt;code&gt;defaultHandler&lt;/code&gt; attribute instead.
Lines 367-375 Link Here
367
               <documentation>
373
               <documentation>
368
                  The class which implements &lt;code&gt;org.eclipse.core.commands.IHandler&lt;/code&gt;.
374
                  The class which implements &lt;code&gt;org.eclipse.core.commands.IHandler&lt;/code&gt;.
369
               </documentation>
375
               </documentation>
370
               <appInfo>
376
               <appinfo>
371
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IHandler"/>
377
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IHandler"/>
372
               </appInfo>
378
               </appinfo>
373
            </annotation>
379
            </annotation>
374
         </attribute>
380
         </attribute>
375
      </complexType>
381
      </complexType>
Lines 377-385 Link Here
377
383
378
   <element name="state">
384
   <element name="state">
379
      <annotation>
385
      <annotation>
380
         <appInfo>
386
         <appinfo>
381
            <meta.element labelAttribute="class"/>
387
            <meta.element labelAttribute="class"/>
382
         </appInfo>
388
         </appinfo>
383
         <documentation>
389
         <documentation>
384
            &lt;p&gt;
390
            &lt;p&gt;
385
State information shared between all handlers, and potentially persisted between sessions.The state is simply a class that is loaded to look after the state.  See the API Information for more details.  This is not used for UI attributes like a menu contribution check box state or label.
391
State information shared between all handlers, and potentially persisted between sessions.The state is simply a class that is loaded to look after the state.  See the API Information for more details.  This is not used for UI attributes like a menu contribution check box state or label.
Lines 396-404 Link Here
396
               <documentation>
402
               <documentation>
397
                  The class that can be loaded to store the state of this command.  State is shared amongst handlers, and can be persisted between sessions.  This class must implement &lt;code&gt;org.eclipse.core.commands.State&lt;/code&gt;.  Please see API Information.
403
                  The class that can be loaded to store the state of this command.  State is shared amongst handlers, and can be persisted between sessions.  This class must implement &lt;code&gt;org.eclipse.core.commands.State&lt;/code&gt;.  Please see API Information.
398
               </documentation>
404
               </documentation>
399
               <appInfo>
405
               <appinfo>
400
                  <meta.attribute kind="java"/>
406
                  <meta.attribute kind="java"/>
401
               </appInfo>
407
               </appinfo>
402
            </annotation>
408
            </annotation>
403
         </attribute>
409
         </attribute>
404
         <attribute name="id" type="string" use="required">
410
         <attribute name="id" type="string" use="required">
Lines 415-423 Link Here
415
421
416
   <element name="class">
422
   <element name="class">
417
      <annotation>
423
      <annotation>
418
         <appInfo>
424
         <appinfo>
419
            <meta.element labelAttribute="class"/>
425
            <meta.element labelAttribute="class"/>
420
         </appInfo>
426
         </appinfo>
421
         <documentation>
427
         <documentation>
422
            &lt;p&gt;
428
            &lt;p&gt;
423
The class that can be loaded to store the state of this command.  This element is used if you wish to pass multiple parameters to an &lt;code&gt;org.eclipse.core.runtime.IExecutableExtension&lt;/code&gt;.
429
The class that can be loaded to store the state of this command.  This element is used if you wish to pass multiple parameters to an &lt;code&gt;org.eclipse.core.runtime.IExecutableExtension&lt;/code&gt;.
Lines 434-442 Link Here
434
               <documentation>
440
               <documentation>
435
                  The class that can be loaded to store the state of this command.  State is shared amongst handlers, and can be persisted between sessions.  This class must implement &lt;code&gt;org.eclipse.core.commands.State&lt;/code&gt;.  Please see API Information.
441
                  The class that can be loaded to store the state of this command.  State is shared amongst handlers, and can be persisted between sessions.  This class must implement &lt;code&gt;org.eclipse.core.commands.State&lt;/code&gt;.  Please see API Information.
436
               </documentation>
442
               </documentation>
437
               <appInfo>
443
               <appinfo>
438
                  <meta.attribute kind="java"/>
444
                  <meta.attribute kind="java"/>
439
               </appInfo>
445
               </appinfo>
440
            </annotation>
446
            </annotation>
441
         </attribute>
447
         </attribute>
442
      </complexType>
448
      </complexType>
Lines 444-452 Link Here
444
450
445
   <element name="keyConfiguration">
451
   <element name="keyConfiguration">
446
      <annotation>
452
      <annotation>
447
         <appInfo>
453
         <appinfo>
448
            <meta.element deprecated="true"/>
454
            <meta.element deprecated="true"/>
449
         </appInfo>
455
         </appinfo>
450
         <documentation>
456
         <documentation>
451
            This element is used to define key configurations. If more than one of these elements exist with the same &lt;code&gt;id&lt;/code&gt; attribute, only the last declared element (in order of reading the plugin registry) is considered valid.  Please use the &quot;org.eclipse.ui.bindings&quot; extension point instead.
457
            This element is used to define key configurations. If more than one of these elements exist with the same &lt;code&gt;id&lt;/code&gt; attribute, only the last declared element (in order of reading the plugin registry) is considered valid.  Please use the &quot;org.eclipse.ui.bindings&quot; extension point instead.
452
         </documentation>
458
         </documentation>
Lines 457-465 Link Here
457
               <documentation>
463
               <documentation>
458
                  A translatable short description of this key configuration for display in the UI.
464
                  A translatable short description of this key configuration for display in the UI.
459
               </documentation>
465
               </documentation>
460
               <appInfo>
466
               <appinfo>
461
                  <meta.attribute translatable="true" deprecated="true"/>
467
                  <meta.attribute translatable="true" deprecated="true"/>
462
               </appInfo>
468
               </appinfo>
463
            </annotation>
469
            </annotation>
464
         </attribute>
470
         </attribute>
465
         <attribute name="id" type="string" use="required">
471
         <attribute name="id" type="string" use="required">
Lines 467-475 Link Here
467
               <documentation>
473
               <documentation>
468
                  The unique identifier of this key configuration.
474
                  The unique identifier of this key configuration.
469
               </documentation>
475
               </documentation>
470
               <appInfo>
476
               <appinfo>
471
                  <meta.attribute deprecated="true"/>
477
                  <meta.attribute deprecated="true"/>
472
               </appInfo>
478
               </appinfo>
473
            </annotation>
479
            </annotation>
474
         </attribute>
480
         </attribute>
475
         <attribute name="name" type="string" use="required">
481
         <attribute name="name" type="string" use="required">
Lines 477-485 Link Here
477
               <documentation>
483
               <documentation>
478
                  The translatable name of this key configuration for display in the UI. If this key configuration has a parent, it is not necessary to add &quot;(extends ...)&quot; to the name. This will be automatically added by the UI where necessary.
484
                  The translatable name of this key configuration for display in the UI. If this key configuration has a parent, it is not necessary to add &quot;(extends ...)&quot; to the name. This will be automatically added by the UI where necessary.
479
               </documentation>
485
               </documentation>
480
               <appInfo>
486
               <appinfo>
481
                  <meta.attribute translatable="true" deprecated="true"/>
487
                  <meta.attribute translatable="true" deprecated="true"/>
482
               </appInfo>
488
               </appinfo>
483
            </annotation>
489
            </annotation>
484
         </attribute>
490
         </attribute>
485
         <attribute name="parent" type="string">
491
         <attribute name="parent" type="string">
Lines 488-496 Link Here
488
                  The unique id of the parent key configuration. If this key configuration has a parent, it will borrow all key bindings from its parent, in addition to the key bindings defined in its own key configuration.
494
                  The unique id of the parent key configuration. If this key configuration has a parent, it will borrow all key bindings from its parent, in addition to the key bindings defined in its own key configuration.
489
@deprecated Please use parentId instead.
495
@deprecated Please use parentId instead.
490
               </documentation>
496
               </documentation>
491
               <appInfo>
497
               <appinfo>
492
                  <meta.attribute deprecated="true"/>
498
                  <meta.attribute deprecated="true"/>
493
               </appInfo>
499
               </appinfo>
494
            </annotation>
500
            </annotation>
495
         </attribute>
501
         </attribute>
496
         <attribute name="parentId" type="string">
502
         <attribute name="parentId" type="string">
Lines 498-506 Link Here
498
               <documentation>
504
               <documentation>
499
                  The unique id of the parent key configuration. If this key configuration has a parent, it will borrow all key bindings from its parent, in addition to the key bindings defined in its own key configuration.
505
                  The unique id of the parent key configuration. If this key configuration has a parent, it will borrow all key bindings from its parent, in addition to the key bindings defined in its own key configuration.
500
               </documentation>
506
               </documentation>
501
               <appInfo>
507
               <appinfo>
502
                  <meta.attribute deprecated="true"/>
508
                  <meta.attribute deprecated="true"/>
503
               </appInfo>
509
               </appinfo>
504
            </annotation>
510
            </annotation>
505
         </attribute>
511
         </attribute>
506
      </complexType>
512
      </complexType>
Lines 508-516 Link Here
508
514
509
   <element name="context">
515
   <element name="context">
510
      <annotation>
516
      <annotation>
511
         <appInfo>
517
         <appinfo>
512
            <meta.element deprecated="true"/>
518
            <meta.element deprecated="true"/>
513
         </appInfo>
519
         </appinfo>
514
         <documentation>
520
         <documentation>
515
            This element is used to define contexts. If more than one of these elements exist with the same &lt;code&gt;id&lt;/code&gt; attribute, only the last declared element (in order of reading the plugin registry) is considered valid.  Please use the &lt;a href=&quot;org_eclipse_ui_contexts.html&quot;&gt;org.eclipse.ui.contexts&lt;/a&gt; extension point instead.
521
            This element is used to define contexts. If more than one of these elements exist with the same &lt;code&gt;id&lt;/code&gt; attribute, only the last declared element (in order of reading the plugin registry) is considered valid.  Please use the &lt;a href=&quot;org_eclipse_ui_contexts.html&quot;&gt;org.eclipse.ui.contexts&lt;/a&gt; extension point instead.
516
         </documentation>
522
         </documentation>
Lines 521-529 Link Here
521
               <documentation>
527
               <documentation>
522
                  A translatable short description of this context for display in the UI.
528
                  A translatable short description of this context for display in the UI.
523
               </documentation>
529
               </documentation>
524
               <appInfo>
530
               <appinfo>
525
                  <meta.attribute translatable="true" deprecated="true"/>
531
                  <meta.attribute translatable="true" deprecated="true"/>
526
               </appInfo>
532
               </appinfo>
527
            </annotation>
533
            </annotation>
528
         </attribute>
534
         </attribute>
529
         <attribute name="id" type="string" use="required">
535
         <attribute name="id" type="string" use="required">
Lines 531-539 Link Here
531
               <documentation>
537
               <documentation>
532
                  The unique identifier of this context.
538
                  The unique identifier of this context.
533
               </documentation>
539
               </documentation>
534
               <appInfo>
540
               <appinfo>
535
                  <meta.attribute deprecated="true"/>
541
                  <meta.attribute deprecated="true"/>
536
               </appInfo>
542
               </appinfo>
537
            </annotation>
543
            </annotation>
538
         </attribute>
544
         </attribute>
539
         <attribute name="name" type="string" use="required">
545
         <attribute name="name" type="string" use="required">
Lines 541-549 Link Here
541
               <documentation>
547
               <documentation>
542
                  The translatable name of this context for display in the UI. If this context has a parent, it is not necessary to add &quot;(extends parent)&quot; to the name. This will be automatically added by the UI where necessary.
548
                  The translatable name of this context for display in the UI. If this context has a parent, it is not necessary to add &quot;(extends parent)&quot; to the name. This will be automatically added by the UI where necessary.
543
               </documentation>
549
               </documentation>
544
               <appInfo>
550
               <appinfo>
545
                  <meta.attribute translatable="true" deprecated="true"/>
551
                  <meta.attribute translatable="true" deprecated="true"/>
546
               </appInfo>
552
               </appinfo>
547
            </annotation>
553
            </annotation>
548
         </attribute>
554
         </attribute>
549
         <attribute name="parent" type="string">
555
         <attribute name="parent" type="string">
Lines 552-560 Link Here
552
                  The unique id of the parent context. If this context has a parent, it will borrow all key bindings from its parent, in addition to the key bindings defined in its own context.
558
                  The unique id of the parent context. If this context has a parent, it will borrow all key bindings from its parent, in addition to the key bindings defined in its own context.
553
@deprecated Please use &quot;parentId&quot; instead.
559
@deprecated Please use &quot;parentId&quot; instead.
554
               </documentation>
560
               </documentation>
555
               <appInfo>
561
               <appinfo>
556
                  <meta.attribute deprecated="true"/>
562
                  <meta.attribute deprecated="true"/>
557
               </appInfo>
563
               </appinfo>
558
            </annotation>
564
            </annotation>
559
         </attribute>
565
         </attribute>
560
         <attribute name="parentId" type="string">
566
         <attribute name="parentId" type="string">
Lines 562-570 Link Here
562
               <documentation>
568
               <documentation>
563
                  The unique id of the parent context. If this context has a parent, it will borrow all key bindings from its parent, in addition to the key bindings defined in its own context.
569
                  The unique id of the parent context. If this context has a parent, it will borrow all key bindings from its parent, in addition to the key bindings defined in its own context.
564
               </documentation>
570
               </documentation>
565
               <appInfo>
571
               <appinfo>
566
                  <meta.attribute deprecated="true"/>
572
                  <meta.attribute deprecated="true"/>
567
               </appInfo>
573
               </appinfo>
568
            </annotation>
574
            </annotation>
569
         </attribute>
575
         </attribute>
570
      </complexType>
576
      </complexType>
Lines 572-580 Link Here
572
578
573
   <element name="scope">
579
   <element name="scope">
574
      <annotation>
580
      <annotation>
575
         <appInfo>
581
         <appinfo>
576
            <meta.element labelAttribute="id" deprecated="true"/>
582
            <meta.element labelAttribute="id" deprecated="true"/>
577
         </appInfo>
583
         </appinfo>
578
         <documentation>
584
         <documentation>
579
            This element is used to define scopes. If more than one of these elements exist with the same &lt;code&gt;id&lt;/code&gt; attribute, only the last declared element (in order of reading the plugin registry) is considered valid.
585
            This element is used to define scopes. If more than one of these elements exist with the same &lt;code&gt;id&lt;/code&gt; attribute, only the last declared element (in order of reading the plugin registry) is considered valid.
580
@deprecated Please use the &quot;org.eclipse.ui.contexts&quot; extension point instead.
586
@deprecated Please use the &quot;org.eclipse.ui.contexts&quot; extension point instead.
Lines 588-596 Link Here
588
594
589
@deprecated Please use the &quot;org.eclipse.ui.contexts&quot; extension point instead.
595
@deprecated Please use the &quot;org.eclipse.ui.contexts&quot; extension point instead.
590
               </documentation>
596
               </documentation>
591
               <appInfo>
597
               <appinfo>
592
                  <meta.attribute translatable="true" deprecated="true"/>
598
                  <meta.attribute translatable="true" deprecated="true"/>
593
               </appInfo>
599
               </appinfo>
594
            </annotation>
600
            </annotation>
595
         </attribute>
601
         </attribute>
596
         <attribute name="id" type="string" use="required">
602
         <attribute name="id" type="string" use="required">
Lines 600-608 Link Here
600
606
601
@deprecated Please use the &quot;org.eclipse.ui.contexts&quot; extension point instead.
607
@deprecated Please use the &quot;org.eclipse.ui.contexts&quot; extension point instead.
602
               </documentation>
608
               </documentation>
603
               <appInfo>
609
               <appinfo>
604
                  <meta.attribute deprecated="true"/>
610
                  <meta.attribute deprecated="true"/>
605
               </appInfo>
611
               </appinfo>
606
            </annotation>
612
            </annotation>
607
         </attribute>
613
         </attribute>
608
         <attribute name="name" type="string" use="required">
614
         <attribute name="name" type="string" use="required">
Lines 612-620 Link Here
612
618
613
@deprecated Please use the &quot;org.eclipse.ui.contexts&quot; extension point instead.
619
@deprecated Please use the &quot;org.eclipse.ui.contexts&quot; extension point instead.
614
               </documentation>
620
               </documentation>
615
               <appInfo>
621
               <appinfo>
616
                  <meta.attribute translatable="true" deprecated="true"/>
622
                  <meta.attribute translatable="true" deprecated="true"/>
617
               </appInfo>
623
               </appinfo>
618
            </annotation>
624
            </annotation>
619
         </attribute>
625
         </attribute>
620
         <attribute name="parent" type="string">
626
         <attribute name="parent" type="string">
Lines 624-632 Link Here
624
630
625
@deprecated Please use the &quot;org.eclipse.ui.contexts&quot; extension point instead.
631
@deprecated Please use the &quot;org.eclipse.ui.contexts&quot; extension point instead.
626
               </documentation>
632
               </documentation>
627
               <appInfo>
633
               <appinfo>
628
                  <meta.attribute deprecated="true"/>
634
                  <meta.attribute deprecated="true"/>
629
               </appInfo>
635
               </appinfo>
630
            </annotation>
636
            </annotation>
631
         </attribute>
637
         </attribute>
632
      </complexType>
638
      </complexType>
Lines 634-642 Link Here
634
640
635
   <element name="activeKeyConfiguration">
641
   <element name="activeKeyConfiguration">
636
      <annotation>
642
      <annotation>
637
         <appInfo>
643
         <appinfo>
638
            <meta.element deprecated="true"/>
644
            <meta.element deprecated="true"/>
639
         </appInfo>
645
         </appinfo>
640
         <documentation>
646
         <documentation>
641
            &lt;p&gt;
647
            &lt;p&gt;
642
This element is used to define the initial active key configuration for Eclipse. If more than one of these elements exist, only the last declared element (in order of reading the plugin registry) is considered valid.
648
This element is used to define the initial active key configuration for Eclipse. If more than one of these elements exist, only the last declared element (in order of reading the plugin registry) is considered valid.
Lines 652-660 Link Here
652
               <documentation>
658
               <documentation>
653
                  The unique id (&lt;code&gt;id&lt;/code&gt; attribute) of the keyConfiguration element one wishes to be initially active.
659
                  The unique id (&lt;code&gt;id&lt;/code&gt; attribute) of the keyConfiguration element one wishes to be initially active.
654
               </documentation>
660
               </documentation>
655
               <appInfo>
661
               <appinfo>
656
                  <meta.attribute deprecated="true"/>
662
                  <meta.attribute deprecated="true"/>
657
               </appInfo>
663
               </appinfo>
658
            </annotation>
664
            </annotation>
659
         </attribute>
665
         </attribute>
660
         <attribute name="keyConfigurationId" type="string">
666
         <attribute name="keyConfigurationId" type="string">
Lines 662-670 Link Here
662
               <documentation>
668
               <documentation>
663
                  The unique id (&lt;code&gt;id&lt;/code&gt; attribute) of the keyConfiguration element one wishes to be initially active.
669
                  The unique id (&lt;code&gt;id&lt;/code&gt; attribute) of the keyConfiguration element one wishes to be initially active.
664
               </documentation>
670
               </documentation>
665
               <appInfo>
671
               <appinfo>
666
                  <meta.attribute deprecated="true"/>
672
                  <meta.attribute deprecated="true"/>
667
               </appInfo>
673
               </appinfo>
668
            </annotation>
674
            </annotation>
669
         </attribute>
675
         </attribute>
670
      </complexType>
676
      </complexType>
Lines 672-680 Link Here
672
678
673
   <element name="keyBinding">
679
   <element name="keyBinding">
674
      <annotation>
680
      <annotation>
675
         <appInfo>
681
         <appinfo>
676
            <meta.element deprecated="true"/>
682
            <meta.element deprecated="true"/>
677
         </appInfo>
683
         </appinfo>
678
         <documentation>
684
         <documentation>
679
            This element allows one to assign key sequences to commands.  Please use the &lt;code&gt;key&lt;/code&gt; element in the &quot;org.eclipse.ui.bindings&quot; extension point instead.
685
            This element allows one to assign key sequences to commands.  Please use the &lt;code&gt;key&lt;/code&gt; element in the &quot;org.eclipse.ui.bindings&quot; extension point instead.
680
         </documentation>
686
         </documentation>
Lines 686-694 Link Here
686
                  The unique id of the key configuration of this key binding.
692
                  The unique id of the key configuration of this key binding.
687
@deprecated Please use keyConfigurationId instead.
693
@deprecated Please use keyConfigurationId instead.
688
               </documentation>
694
               </documentation>
689
               <appInfo>
695
               <appinfo>
690
                  <meta.attribute deprecated="true"/>
696
                  <meta.attribute deprecated="true"/>
691
               </appInfo>
697
               </appinfo>
692
            </annotation>
698
            </annotation>
693
         </attribute>
699
         </attribute>
694
         <attribute name="command" type="string">
700
         <attribute name="command" type="string">
Lines 697-705 Link Here
697
                  The unique identifier of the command to which the key sequence specified by this key binding is assigned. If the value of this attribute is an empty string, the key sequence is assigned to an internal &apos;no operation&apos; command. This is useful for &apos;undefining&apos; key bindings in specific key configurations and contexts which may have been borrowed from their parents.
703
                  The unique identifier of the command to which the key sequence specified by this key binding is assigned. If the value of this attribute is an empty string, the key sequence is assigned to an internal &apos;no operation&apos; command. This is useful for &apos;undefining&apos; key bindings in specific key configurations and contexts which may have been borrowed from their parents.
698
@deprecated Please use &quot;commandId&quot; instead.
704
@deprecated Please use &quot;commandId&quot; instead.
699
               </documentation>
705
               </documentation>
700
               <appInfo>
706
               <appinfo>
701
                  <meta.attribute deprecated="true"/>
707
                  <meta.attribute deprecated="true"/>
702
               </appInfo>
708
               </appinfo>
703
            </annotation>
709
            </annotation>
704
         </attribute>
710
         </attribute>
705
         <attribute name="locale" type="string">
711
         <attribute name="locale" type="string">
Lines 707-715 Link Here
707
               <documentation>
713
               <documentation>
708
                  An optional attribute indicating that this key binding is only defined for the specified locale. Locales are specified according to the format declared in &lt;code&gt;java.util.Locale&lt;/code&gt;.
714
                  An optional attribute indicating that this key binding is only defined for the specified locale. Locales are specified according to the format declared in &lt;code&gt;java.util.Locale&lt;/code&gt;.
709
               </documentation>
715
               </documentation>
710
               <appInfo>
716
               <appinfo>
711
                  <meta.attribute deprecated="true"/>
717
                  <meta.attribute deprecated="true"/>
712
               </appInfo>
718
               </appinfo>
713
            </annotation>
719
            </annotation>
714
         </attribute>
720
         </attribute>
715
         <attribute name="platform" type="string">
721
         <attribute name="platform" type="string">
Lines 717-725 Link Here
717
               <documentation>
723
               <documentation>
718
                  An optional attribute indicating that this key binding is only defined for the specified platform. The possible values of the &lt;code&gt;platform&lt;/code&gt; attribute are the set of the possible values returned by &lt;code&gt;org.eclipse.swt.SWT.getPlatform()&lt;/code&gt;.
724
                  An optional attribute indicating that this key binding is only defined for the specified platform. The possible values of the &lt;code&gt;platform&lt;/code&gt; attribute are the set of the possible values returned by &lt;code&gt;org.eclipse.swt.SWT.getPlatform()&lt;/code&gt;.
719
               </documentation>
725
               </documentation>
720
               <appInfo>
726
               <appinfo>
721
                  <meta.attribute deprecated="true"/>
727
                  <meta.attribute deprecated="true"/>
722
               </appInfo>
728
               </appinfo>
723
            </annotation>
729
            </annotation>
724
         </attribute>
730
         </attribute>
725
         <attribute name="contextId" type="string">
731
         <attribute name="contextId" type="string">
Lines 727-735 Link Here
727
               <documentation>
733
               <documentation>
728
                  The unique id of the context of this key binding.
734
                  The unique id of the context of this key binding.
729
               </documentation>
735
               </documentation>
730
               <appInfo>
736
               <appinfo>
731
                  <meta.attribute deprecated="true"/>
737
                  <meta.attribute deprecated="true"/>
732
               </appInfo>
738
               </appinfo>
733
            </annotation>
739
            </annotation>
734
         </attribute>
740
         </attribute>
735
         <attribute name="string" type="string">
741
         <attribute name="string" type="string">
Lines 738-746 Link Here
738
                  The key sequence to assign to the command. Key sequences consist of one or more key strokes, where a key stroke consists of a key on the keyboard, optionally pressed in combination with one or more of the following modifiers: Ctrl, Alt, Shift, and Command. Key strokes are separated by spaces, and modifiers are separated by &apos;+&apos; characters.
744
                  The key sequence to assign to the command. Key sequences consist of one or more key strokes, where a key stroke consists of a key on the keyboard, optionally pressed in combination with one or more of the following modifiers: Ctrl, Alt, Shift, and Command. Key strokes are separated by spaces, and modifiers are separated by &apos;+&apos; characters.
739
@deprecated Please use &quot;keySequence&quot; instead.
745
@deprecated Please use &quot;keySequence&quot; instead.
740
               </documentation>
746
               </documentation>
741
               <appInfo>
747
               <appinfo>
742
                  <meta.attribute deprecated="true"/>
748
                  <meta.attribute deprecated="true"/>
743
               </appInfo>
749
               </appinfo>
744
            </annotation>
750
            </annotation>
745
         </attribute>
751
         </attribute>
746
         <attribute name="scope" type="string">
752
         <attribute name="scope" type="string">
Lines 749-757 Link Here
749
                  The unique id of the context of this key binding.
755
                  The unique id of the context of this key binding.
750
@deprecated Please use &quot;contextId&quot; instead.  The old default scope, &quot;org.eclipse.ui.globalScope&quot;, has been changed to &quot;org.eclipse.ui.contexts.window&quot;.  The old name is still supported, but it is deprecated.
756
@deprecated Please use &quot;contextId&quot; instead.  The old default scope, &quot;org.eclipse.ui.globalScope&quot;, has been changed to &quot;org.eclipse.ui.contexts.window&quot;.  The old name is still supported, but it is deprecated.
751
               </documentation>
757
               </documentation>
752
               <appInfo>
758
               <appinfo>
753
                  <meta.attribute deprecated="true"/>
759
                  <meta.attribute deprecated="true"/>
754
               </appInfo>
760
               </appinfo>
755
            </annotation>
761
            </annotation>
756
         </attribute>
762
         </attribute>
757
         <attribute name="keyConfigurationId" type="string">
763
         <attribute name="keyConfigurationId" type="string">
Lines 760-768 Link Here
760
                  The unique id of the key configuration of this key binding.
766
                  The unique id of the key configuration of this key binding.
761
@deprecated Please use the &lt;code&gt;schemeId&lt;/code&gt; attribute on the &lt;code&gt;key&lt;/code&gt; element in the new &quot;org.eclipse.ui.bindings&quot; extension point.
767
@deprecated Please use the &lt;code&gt;schemeId&lt;/code&gt; attribute on the &lt;code&gt;key&lt;/code&gt; element in the new &quot;org.eclipse.ui.bindings&quot; extension point.
762
               </documentation>
768
               </documentation>
763
               <appInfo>
769
               <appinfo>
764
                  <meta.attribute deprecated="true"/>
770
                  <meta.attribute deprecated="true"/>
765
               </appInfo>
771
               </appinfo>
766
            </annotation>
772
            </annotation>
767
         </attribute>
773
         </attribute>
768
         <attribute name="commandId" type="string">
774
         <attribute name="commandId" type="string">
Lines 770-778 Link Here
770
               <documentation>
776
               <documentation>
771
                  The unique identifier of the command to which the key sequence specified by this key binding is assigned. If the value of this attribute is an empty string, the key sequence is assigned to an internal &apos;no operation&apos; command. This is useful for &apos;undefining&apos; key bindings in specific key configurations and contexts which may have been borrowed from their parents.
777
                  The unique identifier of the command to which the key sequence specified by this key binding is assigned. If the value of this attribute is an empty string, the key sequence is assigned to an internal &apos;no operation&apos; command. This is useful for &apos;undefining&apos; key bindings in specific key configurations and contexts which may have been borrowed from their parents.
772
               </documentation>
778
               </documentation>
773
               <appInfo>
779
               <appinfo>
774
                  <meta.attribute deprecated="true"/>
780
                  <meta.attribute deprecated="true"/>
775
               </appInfo>
781
               </appinfo>
776
            </annotation>
782
            </annotation>
777
         </attribute>
783
         </attribute>
778
         <attribute name="keySequence" type="string">
784
         <attribute name="keySequence" type="string">
Lines 782-799 Link Here
782
&lt;p&gt;The modifier keys can also be expressed in a platform-independent way.  On MacOS X, for example, &quot;Command&quot; is almost always used in place of &quot;Ctrl&quot;.  So, we provide &quot;M1&quot; which will map to either &quot;Ctrl&quot; or &quot;Command&quot;, as appropriate.  Similarly, &quot;M2&quot; is &quot;Shift&quot;; &quot;M3&quot; is &quot;Alt&quot;; and &quot;M4&quot; is &quot;Ctrl&quot; (MacOS X).  If more platforms are added, then you can count on these aliases being mapped to good platform defaults.&lt;/p&gt;
788
&lt;p&gt;The modifier keys can also be expressed in a platform-independent way.  On MacOS X, for example, &quot;Command&quot; is almost always used in place of &quot;Ctrl&quot;.  So, we provide &quot;M1&quot; which will map to either &quot;Ctrl&quot; or &quot;Command&quot;, as appropriate.  Similarly, &quot;M2&quot; is &quot;Shift&quot;; &quot;M3&quot; is &quot;Alt&quot;; and &quot;M4&quot; is &quot;Ctrl&quot; (MacOS X).  If more platforms are added, then you can count on these aliases being mapped to good platform defaults.&lt;/p&gt;
783
&lt;p&gt;The syntax for this string is defined in &lt;code&gt;org.eclipse.ui.internal.keys&lt;/code&gt;.  Briefly, the string is case insensitive -- though all capitals is preferred stylistically.  If the key is a letter, then simply append the letter.  If the key is a special key (i.e., non-ASCII), then use one of the following: ARROW_DOWN, ARROW_LEFT, ARROW_RIGHT, ARROW_UP, BREAK, CAPS_LOCK, END, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, HOME, INSERT, NUM_LOCK, NUMPAD_0, NUMPAD_1, NUMPAD_2, NUMPAD_3, NUMPAD_4, NUMPAD_5, NUMPAD_6, NUMPAD_7, NUMPAD_8, NUMPAD_9, NUMPAD_ADD, NUMPAD_DECIMAL, NUMPAD_DIVIDE, NUMPAD_ENTER, NUMPAD_EQUAL, NUMPAD_MULTIPLY, NUMPAD_SUBTRACT, PAGE_UP, PAGE_DOWN, PAUSE, PRINT_SCREEN, or SCROLL_LOCK.  If the key is a non-printable ASCII key, then use one of the following: BS, CR, DEL, ESC, FF, LF, NUL, SPACE, TAB, or VT.  Note that the main keyboard enter/return key is CR.&lt;/p&gt;
789
&lt;p&gt;The syntax for this string is defined in &lt;code&gt;org.eclipse.ui.internal.keys&lt;/code&gt;.  Briefly, the string is case insensitive -- though all capitals is preferred stylistically.  If the key is a letter, then simply append the letter.  If the key is a special key (i.e., non-ASCII), then use one of the following: ARROW_DOWN, ARROW_LEFT, ARROW_RIGHT, ARROW_UP, BREAK, CAPS_LOCK, END, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, HOME, INSERT, NUM_LOCK, NUMPAD_0, NUMPAD_1, NUMPAD_2, NUMPAD_3, NUMPAD_4, NUMPAD_5, NUMPAD_6, NUMPAD_7, NUMPAD_8, NUMPAD_9, NUMPAD_ADD, NUMPAD_DECIMAL, NUMPAD_DIVIDE, NUMPAD_ENTER, NUMPAD_EQUAL, NUMPAD_MULTIPLY, NUMPAD_SUBTRACT, PAGE_UP, PAGE_DOWN, PAUSE, PRINT_SCREEN, or SCROLL_LOCK.  If the key is a non-printable ASCII key, then use one of the following: BS, CR, DEL, ESC, FF, LF, NUL, SPACE, TAB, or VT.  Note that the main keyboard enter/return key is CR.&lt;/p&gt;
784
               </documentation>
790
               </documentation>
785
               <appInfo>
791
               <appinfo>
786
                  <meta.attribute deprecated="true"/>
792
                  <meta.attribute deprecated="true"/>
787
               </appInfo>
793
               </appinfo>
788
            </annotation>
794
            </annotation>
789
         </attribute>
795
         </attribute>
790
      </complexType>
796
      </complexType>
791
   </element>
797
   </element>
792
798
793
   <annotation>
799
   <annotation>
794
      <appInfo>
800
      <appinfo>
795
         <meta.section type="since"/>
801
         <meta.section type="since"/>
796
      </appInfo>
802
      </appinfo>
797
      <documentation>
803
      <documentation>
798
         &lt;p&gt;
804
         &lt;p&gt;
799
2.1
805
2.1
Lines 802-810 Link Here
802
   </annotation>
808
   </annotation>
803
809
804
   <annotation>
810
   <annotation>
805
      <appInfo>
811
      <appinfo>
806
         <meta.section type="examples"/>
812
         <meta.section type="examples"/>
807
      </appInfo>
813
      </appinfo>
808
      <documentation>
814
      <documentation>
809
         &lt;p&gt;
815
         &lt;p&gt;
810
The &lt;code&gt;plugin.xml&lt;/code&gt; file in the &lt;code&gt;org.eclipse.ui&lt;/code&gt; plugin makes extensive use of the &lt;code&gt;org.eclipse.ui.commands&lt;/code&gt; extension point.
816
The &lt;code&gt;plugin.xml&lt;/code&gt; file in the &lt;code&gt;org.eclipse.ui&lt;/code&gt; plugin makes extensive use of the &lt;code&gt;org.eclipse.ui.commands&lt;/code&gt; extension point.
Lines 813-821 Link Here
813
   </annotation>
819
   </annotation>
814
820
815
   <annotation>
821
   <annotation>
816
      <appInfo>
822
      <appinfo>
817
         <meta.section type="apiInfo"/>
823
         <meta.section type="apiInfo"/>
818
      </appInfo>
824
      </appinfo>
819
      <documentation>
825
      <documentation>
820
         &lt;p&gt;
826
         &lt;p&gt;
821
Handlers can be registered with commands using the &lt;code&gt;org.eclipse.ui.handlers.IHandlerService&lt;/code&gt;.  This can be retrieved from various workbench components (e.g., workbench, workbench window, part site, etc.) by calling &lt;code&gt;getService(IHandlerService.class)&lt;/code&gt;.
827
Handlers can be registered with commands using the &lt;code&gt;org.eclipse.ui.handlers.IHandlerService&lt;/code&gt;.  This can be retrieved from various workbench components (e.g., workbench, workbench window, part site, etc.) by calling &lt;code&gt;getService(IHandlerService.class)&lt;/code&gt;.
Lines 837-855 Link Here
837
      </documentation>
843
      </documentation>
838
   </annotation>
844
   </annotation>
839
845
840
   <annotation>
846
841
      <appInfo>
842
         <meta.section type="implementation"/>
843
      </appInfo>
844
      <documentation>
845
         
846
      </documentation>
847
   </annotation>
848
847
849
   <annotation>
848
   <annotation>
850
      <appInfo>
849
      <appinfo>
851
         <meta.section type="copyright"/>
850
         <meta.section type="copyright"/>
852
      </appInfo>
851
      </appinfo>
853
      <documentation>
852
      <documentation>
854
         Copyright (c) 2000, 2007 IBM Corporation and others.&lt;br&gt;
853
         Copyright (c) 2000, 2007 IBM Corporation and others.&lt;br&gt;
855
All rights reserved. This program and the accompanying materials are made
854
All rights reserved. This program and the accompanying materials are made
(-)schema/contexts.exsd (-25 / +21 lines)
Lines 1-10 Link Here
1
<?xml version='1.0' encoding='UTF-8'?>
1
<?xml version='1.0' encoding='UTF-8'?>
2
<!-- Schema file written by PDE -->
2
<!-- Schema file written by PDE -->
3
<schema targetNamespace="org.eclipse.ui">
3
<schema targetNamespace="org.eclipse.ui" xmlns="http://www.w3.org/2001/XMLSchema">
4
<annotation>
4
<annotation>
5
      <appInfo>
5
      <appinfo>
6
         <meta.schema plugin="org.eclipse.ui" id="contexts" name="Contexts"/>
6
         <meta.schema plugin="org.eclipse.ui" id="contexts" name="Contexts"/>
7
      </appInfo>
7
      </appinfo>
8
      <documentation>
8
      <documentation>
9
         &lt;p&gt;
9
         &lt;p&gt;
10
The &lt;code&gt;org.eclipse.ui.contexts&lt;/code&gt; extension point is used to declare contexts and associated elements.
10
The &lt;code&gt;org.eclipse.ui.contexts&lt;/code&gt; extension point is used to declare contexts and associated elements.
Lines 29-37 Link Here
29
               <documentation>
29
               <documentation>
30
                  An optional name of the extension instance.
30
                  An optional name of the extension instance.
31
               </documentation>
31
               </documentation>
32
               <appInfo>
32
               <appinfo>
33
                  <meta.attribute translatable="true"/>
33
                  <meta.attribute translatable="true"/>
34
               </appInfo>
34
               </appinfo>
35
            </annotation>
35
            </annotation>
36
         </attribute>
36
         </attribute>
37
         <attribute name="point" type="string" use="required">
37
         <attribute name="point" type="string" use="required">
Lines 56-64 Link Here
56
               <documentation>
56
               <documentation>
57
                  A translatable short description of this context for display in the UI.
57
                  A translatable short description of this context for display in the UI.
58
               </documentation>
58
               </documentation>
59
               <appInfo>
59
               <appinfo>
60
                  <meta.attribute translatable="true"/>
60
                  <meta.attribute translatable="true"/>
61
               </appInfo>
61
               </appinfo>
62
            </annotation>
62
            </annotation>
63
         </attribute>
63
         </attribute>
64
         <attribute name="id" type="string" use="required">
64
         <attribute name="id" type="string" use="required">
Lines 73-81 Link Here
73
               <documentation>
73
               <documentation>
74
                  The translatable name of this context for display in the UI.
74
                  The translatable name of this context for display in the UI.
75
               </documentation>
75
               </documentation>
76
               <appInfo>
76
               <appinfo>
77
                  <meta.attribute translatable="true"/>
77
                  <meta.attribute translatable="true"/>
78
               </appInfo>
78
               </appinfo>
79
            </annotation>
79
            </annotation>
80
         </attribute>
80
         </attribute>
81
         <attribute name="parentId" type="string">
81
         <attribute name="parentId" type="string">
Lines 83-97 Link Here
83
               <documentation>
83
               <documentation>
84
                  The unique identifier of the parent of this context.
84
                  The unique identifier of the parent of this context.
85
               </documentation>
85
               </documentation>
86
               <appinfo>
87
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.contexts/context/@id"/>
88
               </appinfo>
86
            </annotation>
89
            </annotation>
87
         </attribute>
90
         </attribute>
88
      </complexType>
91
      </complexType>
89
   </element>
92
   </element>
90
93
91
   <annotation>
94
   <annotation>
92
      <appInfo>
95
      <appinfo>
93
         <meta.section type="since"/>
96
         <meta.section type="since"/>
94
      </appInfo>
97
      </appinfo>
95
      <documentation>
98
      <documentation>
96
         &lt;p&gt;
99
         &lt;p&gt;
97
3.0
100
3.0
Lines 100-108 Link Here
100
   </annotation>
103
   </annotation>
101
104
102
   <annotation>
105
   <annotation>
103
      <appInfo>
106
      <appinfo>
104
         <meta.section type="examples"/>
107
         <meta.section type="examples"/>
105
      </appInfo>
108
      </appinfo>
106
      <documentation>
109
      <documentation>
107
         &lt;p&gt;
110
         &lt;p&gt;
108
The &lt;code&gt;plugin.xml&lt;/code&gt; file in the &lt;code&gt;org.eclipse.ui&lt;/code&gt; plugin makes use of the &lt;code&gt;org.eclipse.ui.contexts&lt;/code&gt; extension point.
111
The &lt;code&gt;plugin.xml&lt;/code&gt; file in the &lt;code&gt;org.eclipse.ui&lt;/code&gt; plugin makes use of the &lt;code&gt;org.eclipse.ui.contexts&lt;/code&gt; extension point.
Lines 111-119 Link Here
111
   </annotation>
114
   </annotation>
112
115
113
   <annotation>
116
   <annotation>
114
      <appInfo>
117
      <appinfo>
115
         <meta.section type="apiInfo"/>
118
         <meta.section type="apiInfo"/>
116
      </appInfo>
119
      </appinfo>
117
      <documentation>
120
      <documentation>
118
         &lt;p&gt;
121
         &lt;p&gt;
119
In general, it is preferrably to declare all contexts statically (in &lt;code&gt;plugin.xml&lt;/code&gt;).  This is so that users can use them in key bindings.  However, it is possible to declare contexts at run-time.  To do this, retrieve the &lt;code&gt;org.eclipse.ui.commands.IContextService&lt;/code&gt; from a workbench component, call &lt;code&gt;getContext(contextId)&lt;/code&gt; and then call &lt;code&gt;Context#define(...)&lt;/code&gt;.
122
In general, it is preferrably to declare all contexts statically (in &lt;code&gt;plugin.xml&lt;/code&gt;).  This is so that users can use them in key bindings.  However, it is possible to declare contexts at run-time.  To do this, retrieve the &lt;code&gt;org.eclipse.ui.commands.IContextService&lt;/code&gt; from a workbench component, call &lt;code&gt;getContext(contextId)&lt;/code&gt; and then call &lt;code&gt;Context#define(...)&lt;/code&gt;.
Lines 122-140 Link Here
122
      </documentation>
125
      </documentation>
123
   </annotation>
126
   </annotation>
124
127
125
   <annotation>
128
126
      <appInfo>
127
         <meta.section type="implementation"/>
128
      </appInfo>
129
      <documentation>
130
         
131
      </documentation>
132
   </annotation>
133
129
134
   <annotation>
130
   <annotation>
135
      <appInfo>
131
      <appinfo>
136
         <meta.section type="copyright"/>
132
         <meta.section type="copyright"/>
137
      </appInfo>
133
      </appinfo>
138
      <documentation>
134
      <documentation>
139
         Copyright (c) 2000, 2007 IBM Corporation and others.&lt;br&gt;
135
         Copyright (c) 2000, 2007 IBM Corporation and others.&lt;br&gt;
140
All rights reserved. This program and the accompanying materials are made
136
All rights reserved. This program and the accompanying materials are made
(-)schema/handlers.exsd (-23 / +22 lines)
Lines 1-10 Link Here
1
<?xml version='1.0' encoding='UTF-8'?>
1
<?xml version='1.0' encoding='UTF-8'?>
2
<!-- Schema file written by PDE -->
2
<!-- Schema file written by PDE -->
3
<schema targetNamespace="org.eclipse.ui">
3
<schema targetNamespace="org.eclipse.ui" xmlns="http://www.w3.org/2001/XMLSchema">
4
<annotation>
4
<annotation>
5
      <appInfo>
5
      <appinfo>
6
         <meta.schema plugin="org.eclipse.ui" id="handlers" name="Handlers"/>
6
         <meta.schema plugin="org.eclipse.ui" id="handlers" name="Handlers"/>
7
      </appInfo>
7
      </appinfo>
8
      <documentation>
8
      <documentation>
9
         &lt;p&gt;
9
         &lt;p&gt;
10
The handlers extension point is an elaboration of the experimental &lt;code&gt;handlerSubmission&lt;/code&gt; element defined in Eclipse 3.0.  A handler is the behaviour of a command at a particular point in time.  A command can have zero or more handlers associated with it.  At any one point in time, however, a command will either have no active handler or one active handler.  The active handler is the one which is currently responsible for carrying out the behaviour of the command.  This is very similar to the concept of an action handler and a retargettable action.
10
The handlers extension point is an elaboration of the experimental &lt;code&gt;handlerSubmission&lt;/code&gt; element defined in Eclipse 3.0.  A handler is the behaviour of a command at a particular point in time.  A command can have zero or more handlers associated with it.  At any one point in time, however, a command will either have no active handler or one active handler.  The active handler is the one which is currently responsible for carrying out the behaviour of the command.  This is very similar to the concept of an action handler and a retargettable action.
Lines 75-80 Link Here
75
               <documentation>
75
               <documentation>
76
                  &lt;p&gt;The id of the command to associate with this handler implementation.&lt;/p&gt;
76
                  &lt;p&gt;The id of the command to associate with this handler implementation.&lt;/p&gt;
77
               </documentation>
77
               </documentation>
78
               <appinfo>
79
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.commands/command/@id"/>
80
               </appinfo>
78
            </annotation>
81
            </annotation>
79
         </attribute>
82
         </attribute>
80
         <attribute name="class" type="string">
83
         <attribute name="class" type="string">
Lines 82-90 Link Here
82
               <documentation>
85
               <documentation>
83
                  &lt;p&gt;The handler class that imlements &lt;code&gt;org.eclipse.core.commands.IHandler&lt;/code&gt; or extends &lt;code&gt;org.eclipse.core.commands.AbstractHandler&lt;/code&gt;.&lt;/p&gt;
86
                  &lt;p&gt;The handler class that imlements &lt;code&gt;org.eclipse.core.commands.IHandler&lt;/code&gt; or extends &lt;code&gt;org.eclipse.core.commands.AbstractHandler&lt;/code&gt;.&lt;/p&gt;
84
               </documentation>
87
               </documentation>
85
               <appInfo>
88
               <appinfo>
86
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IHandler"/>
89
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IHandler"/>
87
               </appInfo>
90
               </appinfo>
88
            </annotation>
91
            </annotation>
89
         </attribute>
92
         </attribute>
90
         <attribute name="helpContextId" type="string">
93
         <attribute name="helpContextId" type="string">
Lines 165-173 Link Here
165
               <documentation>
168
               <documentation>
166
                  &lt;p&gt;The handler class that imlements &lt;code&gt;org.eclipse.core.commands.IHandler&lt;/code&gt; or extends &lt;code&gt;org.eclipse.core.commands.AbstractHandler&lt;/code&gt;.&lt;/p&gt;
169
                  &lt;p&gt;The handler class that imlements &lt;code&gt;org.eclipse.core.commands.IHandler&lt;/code&gt; or extends &lt;code&gt;org.eclipse.core.commands.AbstractHandler&lt;/code&gt;.&lt;/p&gt;
167
               </documentation>
170
               </documentation>
168
               <appInfo>
171
               <appinfo>
169
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IHandler"/>
172
                  <meta.attribute kind="java" basedOn="org.eclipse.core.commands.IHandler"/>
170
               </appInfo>
173
               </appinfo>
171
            </annotation>
174
            </annotation>
172
         </attribute>
175
         </attribute>
173
      </complexType>
176
      </complexType>
Lines 185-190 Link Here
185
               <documentation>
188
               <documentation>
186
                  &lt;p&gt;The parameter name.&lt;/p&gt;
189
                  &lt;p&gt;The parameter name.&lt;/p&gt;
187
               </documentation>
190
               </documentation>
191
               <appinfo>
192
                  <meta.attribute kind="identifier" basedOn="org.eclipse.ui.commands/command/commandParameter/@id"/>
193
               </appinfo>
188
            </annotation>
194
            </annotation>
189
         </attribute>
195
         </attribute>
190
         <attribute name="value" type="string" use="required">
196
         <attribute name="value" type="string" use="required">
Lines 198-215 Link Here
198
   </element>
204
   </element>
199
205
200
   <annotation>
206
   <annotation>
201
      <appInfo>
207
      <appinfo>
202
         <meta.section type="since"/>
208
         <meta.section type="since"/>
203
      </appInfo>
209
      </appinfo>
204
      <documentation>
210
      <documentation>
205
         3.1
211
         3.1
206
      </documentation>
212
      </documentation>
207
   </annotation>
213
   </annotation>
208
214
209
   <annotation>
215
   <annotation>
210
      <appInfo>
216
      <appinfo>
211
         <meta.section type="examples"/>
217
         <meta.section type="examples"/>
212
      </appInfo>
218
      </appinfo>
213
      <documentation>
219
      <documentation>
214
         &lt;p&gt;
220
         &lt;p&gt;
215
Variables that are valid in activeWhen and enabledWhen expressions can be found in &lt;code&gt;org.eclipse.ui.ISources&lt;/code&gt;.  The types of the variables are determined by the &lt;code&gt;org.eclipse.ui.ISourceProvider&lt;/code&gt; that provides them.
221
Variables that are valid in activeWhen and enabledWhen expressions can be found in &lt;code&gt;org.eclipse.ui.ISources&lt;/code&gt;.  The types of the variables are determined by the &lt;code&gt;org.eclipse.ui.ISourceProvider&lt;/code&gt; that provides them.
Lines 263-271 Link Here
263
   </annotation>
269
   </annotation>
264
270
265
   <annotation>
271
   <annotation>
266
      <appInfo>
272
      <appinfo>
267
         <meta.section type="apiInfo"/>
273
         <meta.section type="apiInfo"/>
268
      </appInfo>
274
      </appinfo>
269
      <documentation>
275
      <documentation>
270
         &lt;p&gt;
276
         &lt;p&gt;
271
All handlers implement &lt;code&gt;org.eclipse.core.commands.IHandler&lt;/code&gt;, and can use &lt;code&gt;org.eclipse.core.commands.AbstractHandler&lt;/code&gt; as a base class.  Within the workbench, it is possible to activate and deactivate handlers using the &lt;code&gt;org.eclipse.ui.handlers.IHandlerService&lt;/code&gt; interface.  This interface can be retrieved from supporting workbench objects, such as &lt;code&gt;IWorkbench&lt;/code&gt; itself, a workbench window, or a part site.  To retrieve the service, you would make a call like &lt;code&gt;IWorkbench.getService(IHandlerService.class)&lt;/code&gt;.
277
All handlers implement &lt;code&gt;org.eclipse.core.commands.IHandler&lt;/code&gt;, and can use &lt;code&gt;org.eclipse.core.commands.AbstractHandler&lt;/code&gt; as a base class.  Within the workbench, it is possible to activate and deactivate handlers using the &lt;code&gt;org.eclipse.ui.handlers.IHandlerService&lt;/code&gt; interface.  This interface can be retrieved from supporting workbench objects, such as &lt;code&gt;IWorkbench&lt;/code&gt; itself, a workbench window, or a part site.  To retrieve the service, you would make a call like &lt;code&gt;IWorkbench.getService(IHandlerService.class)&lt;/code&gt;.
Lines 284-302 Link Here
284
      </documentation>
290
      </documentation>
285
   </annotation>
291
   </annotation>
286
292
287
   <annotation>
293
288
      <appInfo>
289
         <meta.section type="implementation"/>
290
      </appInfo>
291
      <documentation>
292
         
293
      </documentation>
294
   </annotation>
295
294
296
   <annotation>
295
   <annotation>
297
      <appInfo>
296
      <appinfo>
298
         <meta.section type="copyright"/>
297
         <meta.section type="copyright"/>
299
      </appInfo>
298
      </appinfo>
300
      <documentation>
299
      <documentation>
301
         Copyright (c) 2005, 2007 IBM Corporation and others.&lt;br&gt;
300
         Copyright (c) 2005, 2007 IBM Corporation and others.&lt;br&gt;
302
All rights reserved. This program and the accompanying materials are made
301
All rights reserved. This program and the accompanying materials are made

Return to bug 181515