1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Editor Pages</title>
<style type="text/css">@import url("../../book.css");</style>
<style type="text/css">@import url("../../schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Editor Pages</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.wst.server.ui.editorPages<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>1.0
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension point provides a way to add an additional page to a server or server configuration editor.<p>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd"><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.page">page</a>+)></p>
<p class="code SchemaDtd"><!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point CDATA #REQUIRED<p class="code SchemaDtdAttlist">id CDATA #IMPLIED<p class="code SchemaDtdAttlist">name CDATA #IMPLIED></p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>point</b> - a fully qualified identifier of the target extension point</li>
<li><b>id</b> - an optional identifier of the extension instance</li>
<li><b>name</b> - an optional name of the extension instance</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.page">page</a> (<a href="#e.enablement">enablement</a>?)></p>
<p class="code SchemaDtd"><!ATTLIST page</p>
<p class="code SchemaDtdAttlist">id CDATA #REQUIRED<p class="code SchemaDtdAttlist">class CDATA #REQUIRED<p class="code SchemaDtdAttlist">name CDATA #REQUIRED<p class="code SchemaDtdAttlist">typeIds CDATA #REQUIRED<p class="code SchemaDtdAttlist">order CDATA #IMPLIED<p class="code SchemaDtdAttlist">insertionIds CDATA #IMPLIED></p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - specifies a unique identifier for this page</li>
<li><b>class</b> - specifies the fully qualified name of the Java class that implements <samp>org.eclipse.ui.IEditorPart</samp></li>
<li><b>name</b> - a translatable name used to identify this page</li>
<li><b>typeIds</b> - a comma separated list of server type ids. May include wildcards (*) at the end of an id</li>
<li><b>order</b> - an integer that specifies an absolute ordering of the page relative to other pages</li>
<li><b>insertionIds</b> - a comma separated list of insertion ids that allow sections to be plugged in</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.enablement">enablement</a> (<a href="#e.not">not</a> , <a href="#e.and">and</a> , <a href="#e.or">or</a> , <a href="#e.instanceof">instanceof</a> , <a href="#e.test">test</a> , <a href="#e.systemTest">systemTest</a> , <a href="#e.equals">equals</a> , <a href="#e.count">count</a> , <a href="#e.with">with</a> , <a href="#e.resolve">resolve</a> , <a href="#e.adapt">adapt</a> , <a href="#e.iterate">iterate</a> , <a href="#e.reference">reference</a>)*></p>
<p></p>
<p class="ConfigMarkupElementDesc">
A generic root element. The element can be used inside an extension point to define its enablement expression.
The children of an enablement expression are combined using the and operator.</p>
<br><br>
<p class="code SchemaDtd"><!ELEMENT <a name="e.not">not</a> (<a href="#e.not">not</a> | <a href="#e.and">and</a> | <a href="#e.or">or</a> | <a href="#e.instanceof">instanceof</a> | <a href="#e.test">test</a> | <a href="#e.systemTest">systemTest</a> | <a href="#e.equals">equals</a> | <a href="#e.count">count</a> | <a href="#e.with">with</a> | <a href="#e.resolve">resolve</a> | <a href="#e.adapt">adapt</a> | <a href="#e.iterate">iterate</a> | <a href="#e.reference">reference</a>)></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element represent a NOT operation on the result of evaluating it's sub-element expression.</p>
<br><br>
<p class="code SchemaDtd"><!ELEMENT <a name="e.and">and</a> (<a href="#e.not">not</a> , <a href="#e.and">and</a> , <a href="#e.or">or</a> , <a href="#e.instanceof">instanceof</a> , <a href="#e.test">test</a> , <a href="#e.systemTest">systemTest</a> , <a href="#e.equals">equals</a> , <a href="#e.count">count</a> , <a href="#e.with">with</a> , <a href="#e.resolve">resolve</a> , <a href="#e.adapt">adapt</a> , <a href="#e.iterate">iterate</a> , <a href="#e.reference">reference</a>)*></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element represent an AND operation on the result of evaluating all it's sub-elements expressions.</p>
<br><br>
<p class="code SchemaDtd"><!ELEMENT <a name="e.or">or</a> (<a href="#e.not">not</a> , <a href="#e.and">and</a> , <a href="#e.or">or</a> , <a href="#e.instanceof">instanceof</a> , <a href="#e.test">test</a> , <a href="#e.systemTest">systemTest</a> , <a href="#e.equals">equals</a> , <a href="#e.count">count</a> , <a href="#e.with">with</a> , <a href="#e.resolve">resolve</a> , <a href="#e.adapt">adapt</a> , <a href="#e.iterate">iterate</a> , <a href="#e.reference">reference</a>)*></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element represent an OR operation on the result of evaluating all it's sub-element expressions.</p>
<br><br>
<p class="code SchemaDtd"><!ELEMENT <a name="e.instanceof">instanceof</a> EMPTY></p>
<p class="code SchemaDtd"><!ATTLIST instanceof</p>
<p class="code SchemaDtdAttlist">value CDATA #REQUIRED></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element is used to perform an instanceof check of the object in focus. The expression returns
EvaluationResult.TRUE if the object's type is a sub type of the type specified by the attribute value.
Otherwise EvaluationResult.FALSE is returned.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>value</b> - a fully qualified name of a class or interface.</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.test">test</a> EMPTY></p>
<p class="code SchemaDtd"><!ATTLIST test</p>
<p class="code SchemaDtdAttlist">property CDATA #REQUIRED<p class="code SchemaDtdAttlist">args CDATA #IMPLIED<p class="code SchemaDtdAttlist">value CDATA #IMPLIED<p class="code SchemaDtdAttlist">forcePluginActivation (true | false) ></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element is used to evaluate the property state of the object in focus. The set of
testable properties can be extended using the propery tester extension point. The test
expression returns EvaluationResult.NOT_LOADED if the property tester doing the actual
testing isn't loaded yet and the attribute forcePluginActivation is set to false.
If forcePluginActivation is set to true and the evaluation context used to evaluate
this expression support plug-in activation then evaluating the property will result in
activating the plug-in defining the tester.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>property</b> - the name of an object's property to test.</li>
<li><b>args</b> - additional arguments passed to the property tester. Multiple arguments are seperated
by commas. Each individual argument is converted into a Java base type using the same
rules as defined for the value attribute of the test expression.</li>
<li><b>value</b> - the expected value of the property. Can be omitted if the property
is a boolean property. The test expression is supposed to return
EvaluationResult.TRUE if the property matches the value and EvaluationResult.FALSE
otherwise. The value attribute is converted into a Java base type using the following
rules:
<ul>
<li>the string "true" is converted into Boolean.TRUE</li>
<li>the string "false" is converted into Boolean.FALSE</li>
<li>if the string contains a dot then the interpreter tries to convert
the value into a Float object. If this fails the string is treated as a
java.lang.String</li>
<li>if the string only consists of numbers then the interpreter
converts the value in an Integer object.</li>
<li>in all other cases the string is treated as a java.lang.String</li>
<li>the conversion of the string into a Boolean, Float, or Integer can
be suppressed by surrounding the string with single quotes. For
example, the attribute value="'true'" is converted into the
string "true"</li>
</ul></li>
<li><b>forcePluginActivation</b> - a flag indicating whether the plug-in contributing the property tester
should be loaded if necessary. As such, this flag should be used judiciously,
in order to avoid unnecessary plug-in activations. Most clients should avoid
setting this flag to true. This flag is only honored if the evaluation context
used to evaluate this expression allows plug-in activation. Otherwise the flag
is ignored and no plug-in loading takes place.</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.systemTest">systemTest</a> EMPTY></p>
<p class="code SchemaDtd"><!ATTLIST systemTest</p>
<p class="code SchemaDtdAttlist">property CDATA #REQUIRED<p class="code SchemaDtdAttlist">value CDATA #REQUIRED></p>
<p></p>
<p class="ConfigMarkupElementDesc">
Tests a system property by calling the System.getProperty method and compares the result
with the value specified through the value attribute.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>property</b> - the name of an system property to test.</li>
<li><b>value</b> - the expected value of the property. The value is interpreted as a string value.</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.equals">equals</a> EMPTY></p>
<p class="code SchemaDtd"><!ATTLIST equals</p>
<p class="code SchemaDtdAttlist">value CDATA #REQUIRED></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element is used to perform an equals check of the object in focus. The expression returns
EvaluationResult.TRUE if the object is equal to the value provided by the attribute value. Otherwise
EvaluationResult.FALSE is returned.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>value</b> - the expected value. The value provided as a string is converted into
a Java base type using the same rules as for the value attribute of the test expression.</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.count">count</a> EMPTY></p>
<p class="code SchemaDtd"><!ATTLIST count</p>
<p class="code SchemaDtdAttlist">value CDATA #REQUIRED></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element is used to test the number of elements in a collection.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>value</b> - an expression to specify the number of elements in a list. Following wildcard
characters can be used:
<dl>
<dt>*</dt> <dd>any number of elements</dd>
<dt>?</dt> <dd>no elements or one element</dd>
<dt>+</dt> <dd>one or more elements</dd>
<dt>!</dt> <dd>no elements</dd>
<dt>integer value</dt> <dd>the list must contain the exact number of elements</dd>
</dl></li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.with">with</a> (<a href="#e.not">not</a> , <a href="#e.and">and</a> , <a href="#e.or">or</a> , <a href="#e.instanceof">instanceof</a> , <a href="#e.test">test</a> , <a href="#e.systemTest">systemTest</a> , <a href="#e.equals">equals</a> , <a href="#e.count">count</a> , <a href="#e.with">with</a> , <a href="#e.resolve">resolve</a> , <a href="#e.adapt">adapt</a> , <a href="#e.iterate">iterate</a> , <a href="#e.reference">reference</a>)*></p>
<p class="code SchemaDtd"><!ATTLIST with</p>
<p class="code SchemaDtdAttlist">variable CDATA #REQUIRED></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element changes the object to be inspected for all its child element to the object
referenced by the given variable. If the variable can not be resolved then the expression
will throw a ExpressionException when evaluating it. The children of a with expression
are combined using the and operator.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>variable</b> - the name of the variable to be used for further inspection. It is up to the evaluator
of an extension point to provide the variable in the variable pool.</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.resolve">resolve</a> (<a href="#e.not">not</a> , <a href="#e.and">and</a> , <a href="#e.or">or</a> , <a href="#e.instanceof">instanceof</a> , <a href="#e.test">test</a> , <a href="#e.systemTest">systemTest</a> , <a href="#e.equals">equals</a> , <a href="#e.count">count</a> , <a href="#e.with">with</a> , <a href="#e.resolve">resolve</a> , <a href="#e.adapt">adapt</a> , <a href="#e.iterate">iterate</a> , <a href="#e.reference">reference</a>)*></p>
<p class="code SchemaDtd"><!ATTLIST resolve</p>
<p class="code SchemaDtdAttlist">variable CDATA #REQUIRED<p class="code SchemaDtdAttlist">args CDATA #IMPLIED></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element changes the object to be inspected for all its child element to the object
referenced by the given variable. If the variable can not be resolved then the expression
will throw a ExpressionException when evaluating it. The children of a with expression
are combined using the and operator.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>variable</b> - the name of the variable to be resolved. This variable is then used as the object in focus
for child element evaluation. It is up to the evaluator of an extension point to provide a
corresponding variable resolver (see IVariableResolver) through the evaluation context passed
to the root expression element when evaluating the expression.</li>
<li><b>args</b> - additional arguments passed to the variable resolver. Multiple arguments are seperated
by commas. Each individual argument is converted into a Java base type using the same
rules as defined for the value attribute of the test expression.</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.adapt">adapt</a> (<a href="#e.not">not</a> , <a href="#e.and">and</a> , <a href="#e.or">or</a> , <a href="#e.instanceof">instanceof</a> , <a href="#e.test">test</a> , <a href="#e.systemTest">systemTest</a> , <a href="#e.equals">equals</a> , <a href="#e.count">count</a> , <a href="#e.with">with</a> , <a href="#e.resolve">resolve</a> , <a href="#e.adapt">adapt</a> , <a href="#e.iterate">iterate</a> , <a href="#e.reference">reference</a>)*></p>
<p class="code SchemaDtd"><!ATTLIST adapt</p>
<p class="code SchemaDtdAttlist">type CDATA #REQUIRED></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element is used to adapt the object in focus to the type specified by the attribute
type. The expression returns not loaded if either the adapter or the type referenced isn't
loaded yet. It throws a ExpressionException during evaluation if the type name doesn't exist
at all. The children of an adapt expression are combined using the and operator.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>type</b> - the type to which the object in focus is to be adapted.</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.iterate">iterate</a> (<a href="#e.not">not</a> , <a href="#e.and">and</a> , <a href="#e.or">or</a> , <a href="#e.instanceof">instanceof</a> , <a href="#e.test">test</a> , <a href="#e.systemTest">systemTest</a> , <a href="#e.equals">equals</a> , <a href="#e.count">count</a> , <a href="#e.with">with</a> , <a href="#e.resolve">resolve</a> , <a href="#e.adapt">adapt</a> , <a href="#e.iterate">iterate</a> , <a href="#e.reference">reference</a>)*></p>
<p class="code SchemaDtd"><!ATTLIST iterate</p>
<p class="code SchemaDtdAttlist">operator (or|and) <p class="code SchemaDtdAttlist">ifEmpty (true | false) ></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element is used to iterate over a variable that is of type java.util.Collection. If
the object in focus is not of type java.util.Collection then an ExpressionException will
be thrown while evaluating the expression.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>operator</b> - either "and" or "or". The operator defines how the child
elements will be combined. If not specified, "and" will be used.</li>
<li><b>ifEmpty</b> - the value return from the iterate expression if the collection is empty. If
not specified then true is returned when the operator equals "and"
and false is return if the operator equals "or".</li>
</ul>
<br><p class="code SchemaDtd"><!ELEMENT <a name="e.reference">reference</a> EMPTY></p>
<p class="code SchemaDtd"><!ATTLIST reference</p>
<p class="code SchemaDtdAttlist">definitionId IDREF #REQUIRED></p>
<p></p>
<p class="ConfigMarkupElementDesc">
This element is used to reference an expression from the <b>org.eclipse.core.expressions.definitions</b> extension point. The expression definition will be evaluated within the current expression element using the current evaluation context.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>definitionId</b> - The unique id of an expression from <b>org.eclipse.core.expressions.definitions</b>.</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of an editor page extension point:
<pre class="Example"><span class="code SchemaTag">
<extension
point=</span><span class="code SchemaCstring">"org.eclipse.wst.server.ui.editorPages"</span><span class="code SchemaTag">>
<page
id=</span><span class="code SchemaCstring">"com.example"</span><span class="code SchemaTag">
order=</span><span class="code SchemaCstring">"20"</span><span class="code SchemaTag">
name=</span><span class="code SchemaCstring">"%editorPage"</span><span class="code SchemaTag">
typeIds=</span><span class="code SchemaCstring">"com.example.*"</span><span class="code SchemaTag">
class=</span><span class="code SchemaCstring">"com.example.ExampleEditorFactory"</span><span class="code SchemaTag">/>
</extension>
</span></pre>
<p></p>
<br>
<p class="note SchemaCopyright">
Copyright (c) 2000, 2005 IBM Corporation and others.<br>
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License 2.0 which accompanies
this distribution, and is available at
<a href="https://www.eclipse.org/legal/epl-2.0/">https://www.eclipse.org/legal/epl-2.0/</a>
</p>
</BODY>
</HTML>
|
