]>
Commit | Line | Data |
---|---|---|
1b2798f6 EK |
1 | <?xml version='1.0' encoding='UTF-8'?> |
2 | <!-- Schema file written by PDE --> | |
3 | <schema targetNamespace="org.eclipse.jdt.ui" xmlns="http://www.w3.org/2001/XMLSchema"> | |
4 | <annotation> | |
5 | <appinfo> | |
6 | <meta.schema plugin="org.eclipse.jdt.ui" id="cleanUps" name="Clean Ups"/> | |
7 | </appinfo> | |
8 | <documentation> | |
9 | This extension point allows to add clean ups that can solve problems in a compilation unit. | |
10 | </documentation> | |
11 | </annotation> | |
12 | ||
13 | <element name="extension"> | |
14 | <annotation> | |
15 | <appinfo> | |
16 | <meta.element /> | |
17 | </appinfo> | |
18 | </annotation> | |
19 | <complexType> | |
20 | <sequence> | |
21 | <element ref="cleanUp" minOccurs="0" maxOccurs="unbounded"/> | |
22 | <element ref="cleanUpConfigurationUI" minOccurs="0" maxOccurs="unbounded"/> | |
23 | <element ref="cleanUpOptionsInitializer" minOccurs="0" maxOccurs="unbounded"/> | |
24 | </sequence> | |
25 | <attribute name="point" type="string" use="required"> | |
26 | <annotation> | |
27 | <documentation> | |
28 | a fully qualified identifier of the target extension point | |
29 | </documentation> | |
30 | </annotation> | |
31 | </attribute> | |
32 | <attribute name="id" type="string"> | |
33 | <annotation> | |
34 | <documentation> | |
35 | an optional identifier of the extension instance | |
36 | </documentation> | |
37 | </annotation> | |
38 | </attribute> | |
39 | <attribute name="name" type="string"> | |
40 | <annotation> | |
41 | <documentation> | |
42 | an optional name of the extension instance | |
43 | </documentation> | |
44 | <appinfo> | |
45 | <meta.attribute translatable="true"/> | |
46 | </appinfo> | |
47 | </annotation> | |
48 | </attribute> | |
49 | </complexType> | |
50 | </element> | |
51 | ||
52 | <element name="cleanUp"> | |
53 | <complexType> | |
54 | <attribute name="class" type="string" use="required"> | |
55 | <annotation> | |
56 | <documentation> | |
57 | the fully qualified class name implementing the interface <code>org.eclipse.jdt.ui.cleanup.ICleanUp</code> | |
58 | </documentation> | |
59 | <appinfo> | |
60 | <meta.attribute kind="java" basedOn=":org.eclipse.jdt.ui.cleanup.ICleanUp"/> | |
61 | </appinfo> | |
62 | </annotation> | |
63 | </attribute> | |
64 | <attribute name="id" type="string" use="required"> | |
65 | <annotation> | |
66 | <documentation> | |
67 | a unique id that will be used to identify this clean up | |
68 | </documentation> | |
69 | </annotation> | |
70 | </attribute> | |
71 | <attribute name="runAfter" type="string"> | |
72 | <annotation> | |
73 | <documentation> | |
74 | optional clean up id specifying that this clean up should run after it | |
75 | </documentation> | |
76 | <appinfo> | |
77 | <meta.attribute kind="identifier" basedOn="org.eclipse.jdt.ui.cleanUps/cleanUp/@id"/> | |
78 | </appinfo> | |
79 | </annotation> | |
80 | </attribute> | |
81 | </complexType> | |
82 | </element> | |
83 | ||
84 | <element name="cleanUpConfigurationUI"> | |
85 | <annotation> | |
86 | <documentation> | |
87 | A clean up configuration UI for the given clean up kind. Each contributed clean up <strong>must at least provide UI that allows to disable it</strong>. | |
88 | </documentation> | |
89 | </annotation> | |
90 | <complexType> | |
91 | <attribute name="name" type="string" use="required"> | |
92 | <annotation> | |
93 | <documentation> | |
94 | a name that allows to identify this configuration in the UI | |
95 | </documentation> | |
96 | <appinfo> | |
97 | <meta.attribute translatable="true"/> | |
98 | </appinfo> | |
99 | </annotation> | |
100 | </attribute> | |
101 | <attribute name="class" type="string" use="required"> | |
102 | <annotation> | |
103 | <documentation> | |
104 | the fully qualified class name implementing the interface <code>org.eclipse.jdt.ui.cleanup.ICleanUpConfigurationUI</code> | |
105 | </documentation> | |
106 | <appinfo> | |
107 | <meta.attribute kind="java" basedOn=":org.eclipse.jdt.ui.cleanup.ICleanUpConfigurationUI"/> | |
108 | </appinfo> | |
109 | </annotation> | |
110 | </attribute> | |
111 | <attribute name="cleanUpKind" use="required"> | |
112 | <annotation> | |
113 | <documentation> | |
114 | The kind of clean up this configuration UI configures. Currently only the following are supported: | |
115 | <ul> | |
116 | <li>cleanUp: a normal clean up</li> | |
117 | <li>saveAction: a clean up executed on save in the Java editor</li> | |
118 | </ul> | |
119 | </documentation> | |
120 | </annotation> | |
121 | <simpleType> | |
122 | <restriction base="string"> | |
123 | <enumeration value="cleanUp"> | |
124 | </enumeration> | |
125 | <enumeration value="saveAction"> | |
126 | </enumeration> | |
127 | </restriction> | |
128 | </simpleType> | |
129 | </attribute> | |
130 | </complexType> | |
131 | </element> | |
132 | ||
133 | <element name="cleanUpOptionsInitializer"> | |
134 | <annotation> | |
135 | <documentation> | |
136 | An options initializer that returns default options for a clean up kind. Each clean up will consult all contributed initializers to check whether it is enabled. | |
137 | </documentation> | |
138 | </annotation> | |
139 | <complexType> | |
140 | <attribute name="cleanUpKind" use="required"> | |
141 | <annotation> | |
142 | <documentation> | |
143 | The kind of clean up this initializer initializes. Currently only the following are supported:<br> | |
144 | <ul> | |
145 | <li>cleanUp: a normal clean up</li> | |
146 | <li>saveAction: a clean up executed on save in the Java editor</li> | |
147 | </ul> | |
148 | </documentation> | |
149 | </annotation> | |
150 | <simpleType> | |
151 | <restriction base="string"> | |
152 | <enumeration value="cleanUp"> | |
153 | </enumeration> | |
154 | <enumeration value="saveAction"> | |
155 | </enumeration> | |
156 | </restriction> | |
157 | </simpleType> | |
158 | </attribute> | |
159 | <attribute name="class" type="string" use="required"> | |
160 | <annotation> | |
161 | <documentation> | |
162 | the fully qualified class name implementing the interface <code>org.eclipse.jdt.ui.cleanup.ICleanUpOptionsInitializer</code> | |
163 | </documentation> | |
164 | <appinfo> | |
165 | <meta.attribute kind="java" basedOn=":org.eclipse.jdt.ui.cleanup.ICleanUpOptionsInitializer"/> | |
166 | </appinfo> | |
167 | </annotation> | |
168 | </attribute> | |
169 | </complexType> | |
170 | </element> | |
171 | ||
172 | <annotation> | |
173 | <appinfo> | |
174 | <meta.section type="since"/> | |
175 | </appinfo> | |
176 | <documentation> | |
177 | 3.5 | |
178 | </documentation> | |
179 | </annotation> | |
180 | ||
181 | <annotation> | |
182 | <appinfo> | |
183 | <meta.section type="examples"/> | |
184 | </appinfo> | |
185 | <documentation> | |
186 | The following is an example of a clean up that updates a copyright on save: | |
187 | ||
188 | <p> | |
189 | <pre> | |
190 | <extension | |
191 | point="org.eclipse.jdt.ui.cleanUps"> | |
192 | <cleanUp | |
193 | id="org.eclipse.jdt.copyrightsaveaction.copyright_clean_up" | |
194 | class="org.eclipse.jdt.ui.internal.copyrightupdater.CopyrightUpdaterCleanUp"> | |
195 | </cleanUp> | |
196 | ||
197 | <cleanUpOptionsInitializer | |
198 | class="org.eclipse.jdt.ui.internal.copyrightupdater.CopyrightOnSaveOptionsInitializer" | |
199 | cleanUpKind="saveAction"> | |
200 | </cleanUpOptionsInitializer> | |
201 | ||
202 | <cleanUpConfigurationUI | |
203 | class="org.eclipse.jdt.ui.internal.copyrightupdater.CopyrightTabPage" | |
204 | name="%cleanUpConfigurationUI.name" | |
205 | cleanUpKind="saveAction"> | |
206 | </cleanUpConfigurationUI> | |
207 | </extension> | |
208 | </pre> | |
209 | </p> | |
210 | </documentation> | |
211 | </annotation> | |
212 | ||
213 | ||
214 | ||
215 | <annotation> | |
216 | <appinfo> | |
217 | <meta.section type="copyright"/> | |
218 | </appinfo> | |
219 | <documentation> | |
220 | Copyright (c) 2008, 2009 IBM Corporation and others.<br> | |
221 | All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a> | |
222 | </documentation> | |
223 | </annotation> | |
224 | ||
225 | </schema> |