]> git.uio.no Git - ifi-stolz-refaktor.git/blame - case-study/jdt-after/ui/org/eclipse/jdt/ui/ISharedImages.java
Case Study: adding data and statistics
[ifi-stolz-refaktor.git] / case-study / jdt-after / ui / org / eclipse / jdt / ui / ISharedImages.java
CommitLineData
1b2798f6
EK
1/*******************************************************************************
2 * Copyright (c) 2000, 2008 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
7 *
8 * Contributors:
9 * IBM Corporation - initial API and implementation
10 *******************************************************************************/
11package org.eclipse.jdt.ui;
12
13
14import org.eclipse.swt.graphics.Image;
15
16import org.eclipse.jface.resource.ImageDescriptor;
17
18import org.eclipse.jdt.internal.ui.JavaPluginImages;
19
20/**
21 * Standard images provided by the Java UI plug-in. This class offers access to the
22 * standard images in two forms:
23 * <ul>
24 * <li>Use <code>ISharedImages.getImage(IMG_OBJS_<i>FOO</i>)</code>
25 * to access the shared standard <code>Image</code> object (caller must not
26 * dispose of image).</li>
27 * <li>Use <code>ISharedImages.getImageDescriptor(IMG_OBJS_<i>FOO</i>)</code>
28 * to access the standard <code>ImageDescriptor</code> object (caller is
29 * responsible for disposing of any <code>Image</code> objects it creates using
30 * this descriptor).</li>
31 * </ul>
32 * <p>
33 * This interface is not intended to be implemented by clients.
34 * </p>
35 *
36 * @noimplement This interface is not intended to be implemented by clients.
37 * @noextend This interface is not intended to be extended by clients.
38 */
39public interface ISharedImages {
40
41 /**
42 * Key to access the shared image or image descriptor for a Java compilation unit.
43 */
44 public static final String IMG_OBJS_CUNIT= JavaPluginImages.IMG_OBJS_CUNIT;
45
46 /**
47 * Key to access the shared image or image descriptor for a Java class file.
48 */
49 public static final String IMG_OBJS_CFILE= JavaPluginImages.IMG_OBJS_CFILE;
50
51 /**
52 * Key to access the shared image or image descriptor for a JAR archive.
53 */
54 public static final String IMG_OBJS_JAR= JavaPluginImages.IMG_OBJS_JAR;
55
56 /**
57 * Key to access the shared image or image descriptor for a JAR with source.
58 * @since 3.0
59 */
60 public static final String IMG_OBJS_JAR_WITH_SOURCE= JavaPluginImages.IMG_OBJS_JAR_WSRC;
61
62 /**
63 * Key to access the shared image or image descriptor for external archives.
64 * @since 2.1
65 */
66 public static final String IMG_OBJS_EXTERNAL_ARCHIVE= JavaPluginImages.IMG_OBJS_EXTJAR;
67
68 /**
69 * Key to access the shared image or image descriptor for external archives with source.
70 * @since 2.1
71 */
72 public static final String IMG_OBJS_EXTERNAL_ARCHIVE_WITH_SOURCE= JavaPluginImages.IMG_OBJS_EXTJAR_WSRC;
73
74 /**
75 * Key to access the shared image or image descriptor for a classpath variable entry.
76 * @since 3.2
77 */
78 public static final String IMG_OBJS_CLASSPATH_VAR_ENTRY= JavaPluginImages.IMG_OBJS_ENV_VAR;
79
80 /**
81 * Key to access the shared image or image descriptor for a library (class path container).
82 * @since 3.0
83 */
84 public static final String IMG_OBJS_LIBRARY= JavaPluginImages.IMG_OBJS_LIBRARY;
85
86 /**
87 * Key to access the shared image or image descriptor for a package fragment root.
88 * @since 3.0
89 */
90 public static final String IMG_OBJS_PACKFRAG_ROOT= JavaPluginImages.IMG_OBJS_PACKFRAG_ROOT;
91
92 /**
93 * Key to access the shared image or image descriptor for a package.
94 */
95 public static final String IMG_OBJS_PACKAGE= JavaPluginImages.IMG_OBJS_PACKAGE;
96
97 /**
98 * Key to access the shared image or image descriptor for an empty package.
99 * @since 3.0
100 */
101 public static final String IMG_OBJS_EMPTY_PACKAGE= JavaPluginImages.IMG_OBJS_EMPTY_PACKAGE;
102
103 /**
104 * Key to access the shared image or image descriptor for a logical package.
105 * @since 3.0
106 */
107 public static final String IMG_OBJS_LOGICAL_PACKAGE= JavaPluginImages.IMG_OBJS_LOGICAL_PACKAGE;
108
109 /**
110 * Key to access the shared image or image descriptor for an empty logical package.
111 * @since 3.0
112 */
113 public static final String IMG_OBJS_EMPTY_LOGICAL_PACKAGE= JavaPluginImages.IMG_OBJS_EMPTY_LOGICAL_PACKAGE;
114
115 /**
116 * Key to access the shared image or image descriptor for a class.
117 */
118 public static final String IMG_OBJS_CLASS= JavaPluginImages.IMG_OBJS_CLASS;
119
120 /**
121 * Key to access the shared image or image descriptor for a class with default visibility.
122 * @since 3.0
123 */
124 public static final String IMG_OBJS_CLASS_DEFAULT= JavaPluginImages.IMG_OBJS_CLASS_DEFAULT;
125
126 /**
127 * Key to access the shared image or image descriptor for a public inner class.
128 * @since 3.0
129 */
130 public static final String IMG_OBJS_INNER_CLASS_PUBLIC= JavaPluginImages.IMG_OBJS_INNER_CLASS_PUBLIC;
131
132 /**
133 * Key to access the shared image or image descriptor for a inner class with default visibility.
134 * @since 3.0
135 */
136 public static final String IMG_OBJS_INNER_CLASS_DEFAULT= JavaPluginImages.IMG_OBJS_INNER_CLASS_DEFAULT;
137
138 /**
139 * Key to access the shared image or image descriptor for a protected inner class.
140 * @since 3.0
141 */
142 public static final String IMG_OBJS_INNER_CLASS_PROTECTED= JavaPluginImages.IMG_OBJS_INNER_CLASS_PROTECTED;
143
144 /**
145 * Key to access the shared image or image descriptor for a private inner class.
146 * @since 3.0
147 */
148 public static final String IMG_OBJS_INNER_CLASS_PRIVATE= JavaPluginImages.IMG_OBJS_INNER_CLASS_PRIVATE;
149
150 /**
151 * Key to access the shared image or image descriptor for an interface.
152 */
153 public static final String IMG_OBJS_INTERFACE= JavaPluginImages.IMG_OBJS_INTERFACE;
154
155 /**
156 * Key to access the shared image or image descriptor for an interface with default visibility.
157 * @since 3.0
158 */
159 public static final String IMG_OBJS_INTERFACE_DEFAULT= JavaPluginImages.IMG_OBJS_INTERFACE_DEFAULT;
160
161 /**
162 * Key to access the shared image or image descriptor for a public inner interface.
163 * @since 3.0
164 */
165 public static final String IMG_OBJS_INNER_INTERFACE_PUBLIC= JavaPluginImages.IMG_OBJS_INNER_INTERFACE_PUBLIC;
166
167 /**
168 * Key to access the shared image or image descriptor for an inner interface with default visibility.
169 * @since 3.0
170 */
171 public static final String IMG_OBJS_INNER_INTERFACE_DEFAULT= JavaPluginImages.IMG_OBJS_INNER_INTERFACE_DEFAULT;
172
173 /**
174 * Key to access the shared image or image descriptor for a protected inner interface.
175 * @since 3.0
176 */
177 public static final String IMG_OBJS_INNER_INTERFACE_PROTECTED= JavaPluginImages.IMG_OBJS_INNER_INTERFACE_PROTECTED;
178
179 /**
180 * Key to access the shared image or image descriptor for a private inner interface.
181 * @since 3.0
182 */
183 public static final String IMG_OBJS_INNER_INTERFACE_PRIVATE= JavaPluginImages.IMG_OBJS_INNER_INTERFACE_PRIVATE;
184
185 /** Key to access the shared image or image descriptor for a package declaration. */
186 public static final String IMG_OBJS_PACKDECL= JavaPluginImages.IMG_OBJS_PACKDECL;
187
188 /** Key to access the shared image or image descriptor for an import container. */
189 public static final String IMG_OBJS_IMPCONT= JavaPluginImages.IMG_OBJS_IMPCONT;
190
191 /** Key to access the shared image or image descriptor for an import statement. */
192 public static final String IMG_OBJS_IMPDECL= JavaPluginImages.IMG_OBJS_IMPDECL;
193
194 /** Key to access the shared image or image descriptor for a public member. */
195 public static final String IMG_OBJS_PUBLIC= JavaPluginImages.IMG_MISC_PUBLIC;
196
197 /** Key to access the shared image or image descriptor for a protected member. */
198 public static final String IMG_OBJS_PROTECTED= JavaPluginImages.IMG_MISC_PROTECTED;
199
200 /** Key to access the shared image or image descriptor for a private member. */
201 public static final String IMG_OBJS_PRIVATE= JavaPluginImages.IMG_MISC_PRIVATE;
202
203 /** Key to access the shared image or image descriptor for class members with default visibility. */
204 public static final String IMG_OBJS_DEFAULT= JavaPluginImages.IMG_MISC_DEFAULT;
205
206 /**
207 * Key to access the shared image or image descriptor for a public field.
208 * @since 3.0
209 */
210 public static final String IMG_FIELD_PUBLIC= JavaPluginImages.IMG_FIELD_PUBLIC;
211
212 /**
213 * Key to access the shared image or image descriptor for a protected field.
214 * @since 3.0
215 */
216 public static final String IMG_FIELD_PROTECTED= JavaPluginImages.IMG_FIELD_PROTECTED;
217
218 /**
219 * Key to access the shared image or image descriptor for a private field.
220 * @since 3.0
221 */
222 public static final String IMG_FIELD_PRIVATE= JavaPluginImages.IMG_FIELD_PRIVATE;
223
224 /**
225 * Key to access the shared image or image descriptor for a field with default visibility.
226 * @since 3.0
227 */
228 public static final String IMG_FIELD_DEFAULT= JavaPluginImages.IMG_FIELD_DEFAULT;
229
230 /**
231 * Key to access the shared image or image descriptor for a local variable.
232 * @since 3.0
233 */
234 public static final String IMG_OBJS_LOCAL_VARIABLE= JavaPluginImages.IMG_OBJS_LOCAL_VARIABLE;
235
236 /**
237 * Key to access the shared image or image descriptor for a enum type.
238 * @since 3.1
239 */
240 public static final String IMG_OBJS_ENUM= JavaPluginImages.IMG_OBJS_ENUM;
241
242 /**
243 * Key to access the shared image or image descriptor for a enum type
244 * with default visibility.
245 * @since 3.1
246 */
247 public static final String IMG_OBJS_ENUM_DEFAULT= JavaPluginImages.IMG_OBJS_ENUM_DEFAULT;
248
249 /**
250 * Key to access the shared image or image descriptor for a enum type
251 * with protected visibility.
252 * @since 3.1
253 */
254 public static final String IMG_OBJS_ENUM_PROTECTED= JavaPluginImages.IMG_OBJS_ENUM_PROTECTED;
255
256 /**
257 * Key to access the shared image or image descriptor for a enum type
258 * with private visibility.
259 * @since 3.1
260 */
261 public static final String IMG_OBJS_ENUM_PRIVATE= JavaPluginImages.IMG_OBJS_ENUM_PRIVATE;
262
263 /**
264 * Key to access the shared image or image descriptor for a annotation type.
265 * @since 3.1
266 */
267 public static final String IMG_OBJS_ANNOTATION= JavaPluginImages.IMG_OBJS_ANNOTATION;
268
269 /**
270 * Key to access the shared image or image descriptor for a annotation type
271 * with default visibility.
272 * @since 3.1
273 */
274 public static final String IMG_OBJS_ANNOTATION_DEFAULT= JavaPluginImages.IMG_OBJS_ANNOTATION_DEFAULT;
275
276 /**
277 * Key to access the shared image or image descriptor for a annotation type
278 * with protected visibility.
279 * @since 3.1
280 */
281 public static final String IMG_OBJS_ANNOTATION_PROTECTED= JavaPluginImages.IMG_OBJS_ANNOTATION_PROTECTED;
282
283 /**
284 * Key to access the shared image or image descriptor for a annotation type
285 * with private visibility.
286 * @since 3.1
287 */
288 public static final String IMG_OBJS_ANNOTATION_PRIVATE= JavaPluginImages.IMG_OBJS_ANNOTATION_PRIVATE;
289
290 /**
291 * Key to access the shared image or image descriptor for javadoc tags.
292 * @since 3.2
293 */
294 public static final String IMG_OBJS_JAVADOCTAG= JavaPluginImages.IMG_OBJS_JAVADOCTAG;
295
296 /**
297 * Returns the shared image managed under the given key.
298 * <p>
299 * Note that clients <b>must not</b> dispose the image returned by this method.
300 * </p>
301 *
302 * @param key the image key; one of the <code>IMG_OBJS_* </code> constants
303 * @return the shared image managed under the given key, or <code>null</code>
304 * if none
305 */
306 public Image getImage(String key);
307
308 /**
309 * Returns the image descriptor managed under the given key.
310 *
311 * @param key the image key; one of the <code>IMG_OBJS_* </code> constants
312 * @return the image descriptor managed under the given key, or <code>null</code>
313 * if none
314 */
315 public ImageDescriptor getImageDescriptor(String key);
316}