ISharedImages


1   /*******************************************************************************
2    * Copyright (c) 2000, 2006 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   *******************************************************************************/
11  package org.eclipse.ui;
12  
13  import org.eclipse.jface.resource.ImageDescriptor;
14  import org.eclipse.swt.graphics.Image;
15  
16  /**
17   * A registry for common images used by the workbench which may be useful 
18   * to other plug-ins.
19   * <p>
20   * This class provides <code>Image</code> and <code>ImageDescriptor</code>s
21   * for each named image in the interface.  All <code>Image</code> objects provided 
22   * by this class are managed by this class and must never be disposed 
23   * by other clients.
24   * </p>
25   * <p>
26   * This interface is not intended to be implemented by clients.
27   * </p>
28   */
29  public interface ISharedImages {
30      /**
31       * Identifies a file image.
32       */
33      public final static String   IMG_OBJ_FILE = "IMG_OBJ_FILE"; //$NON-NLS-1$
34  
35      /**
36       * Identifies a folder image.
37       */
38      public final static String   IMG_OBJ_FOLDER = "IMG_OBJ_FOLDER"; //$NON-NLS-1$
39  
40      /**
41       * Identifies a project image.
42       * 
43       * @deprecated in 3.0. This image is IDE-specific, and is therefore found
44       * only in IDE configurations. IDE-specific tools should use 
45       * <code>org.eclipse.ui.ide.IDE.SharedImages.IMG_OBJ_PROJECT</code> instead.
46       */
47      public final static String   IMG_OBJ_PROJECT = "IMG_OBJ_PROJECT"; //$NON-NLS-1$
48  
49      /**
50       * Identifies a closed project image.
51       * 
52       * @deprecated in 3.0. This image is IDE-specific, and is therefore found
53       * only in IDE configurations. IDE-specific tools should use 
54       * <code>org.eclipse.ui.ide.IDE.SharedImages.IMG_OBJ_PROJECT_CLOSED</code> instead.
55       */
56      public final static String   IMG_OBJ_PROJECT_CLOSED = "IMG_OBJ_PROJECT_CLOSED"; //$NON-NLS-1$
57  
58      /**
59       * Identifies an element image.
60       */
61      public final static String   IMG_OBJ_ELEMENT = "IMG_OBJ_ELEMENTS"; //$NON-NLS-1$
62  
63      /**
64       * Identifies the image used for "open marker".
65       * 
66       * @deprecated in 3.0. This image is IDE-specific, and is therefore found
67       * only in IDE configurations. IDE-specific tools should use 
68       * <code>org.eclipse.ui.ide.IDE.SharedImages.IMG_OPEN_MARKER</code> instead.
69       */
70      public final static String   IMG_OPEN_MARKER = "IMG_OPEN_MARKER"; //$NON-NLS-1$
71  
72      /**
73       * Identifies the default image used for views.
74       */
75      public final static String   IMG_DEF_VIEW = "IMG_DEF_VIEW"; //$NON-NLS-1$
76  
77      /**
78       * Identifies the default image used to indicate errors.
79       */
80      public final static String   IMG_OBJS_ERROR_TSK = "IMG_OBJS_ERROR_TSK"; //$NON-NLS-1$
81  
82      /**
83       * Identifies the default image used to indicate warnings.
84       */
85      public final static String   IMG_OBJS_WARN_TSK = "IMG_OBJS_WARN_TSK"; //$NON-NLS-1$
86  
87      /**
88       * Identifies the default image used to indicate information only.
89       */
90      public final static String   IMG_OBJS_INFO_TSK = "IMG_OBJS_INFO_TSK"; //$NON-NLS-1$
91  
92      /**
93       * Identifies the default image used to indicate a task.
94       * 
95       * @deprecated in 3.0. This image is IDE-specific, and is therefore found
96       * only in IDE configurations. IDE-specific tools should use 
97       * <code>org.eclipse.ui.ide.IDE.SharedImages.IMG_OBJS_TASK_TSK</code> instead.
98       */
99      public final static String   IMG_OBJS_TASK_TSK = "IMG_OBJS_TASK_TSK"; //$NON-NLS-1$
100 
101     /**
102      * Identifies the default image used to indicate a bookmark.
103      * 
104      * @deprecated in 3.0. This image is IDE-specific, and is therefore found
105      * only in IDE configurations. IDE-specific tools should use 
106      * <code>org.eclipse.ui.ide.IDE.SharedImages.IMG_OBJS_BKMRK_TSK</code> instead.
107      */
108     public final static String   IMG_OBJS_BKMRK_TSK = "IMG_OBJS_BKMRK_TSK"; //$NON-NLS-1$
109 
110     /**
111      * Identifies the new wizard image in the enabled state.
112      */
113     public final static String   IMG_TOOL_NEW_WIZARD = "IMG_TOOL_NEW_WIZARD"; //$NON-NLS-1$
114 
115     /**
116      * Identifies the new wizard image in the hover (colored) state.
117      * 
118      * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_NEW_WIZARD</code>.
119      *   Enabled images are now in color.  The workbench itself no longer uses the hover image variants.
120      */
121     public final static String   IMG_TOOL_NEW_WIZARD_HOVER = "IMG_TOOL_NEW_WIZARD_HOVER"; //$NON-NLS-1$
122 
123     /**
124      * Identifies the new wizard image in the disabled state.
125      */
126     public final static String   IMG_TOOL_NEW_WIZARD_DISABLED = "IMG_TOOL_NEW_WIZARD_DISABLED"; //$NON-NLS-1$
127 
128     /**
129      * Identifies the undo image in the enabled state.
130      */
131     public final static String   IMG_TOOL_UNDO = "IMG_TOOL_UNDO"; //$NON-NLS-1$
132 
133     /**
134      * Identifies the undo image in the hover (colored) state.
135      * 
136      * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_UNDO</code>.
137      *   Enabled images are now in color.  The workbench itself no longer uses the hover image variants.
138      */
139     public final static String   IMG_TOOL_UNDO_HOVER = "IMG_TOOL_UNDO_HOVER"; //$NON-NLS-1$
140 
141     /**
142      * Identifies the undo image in the disabled state.
143      */
144     public final static String   IMG_TOOL_UNDO_DISABLED = "IMG_TOOL_UNDO_DISABLED"; //$NON-NLS-1$
145 
146     /**
147      * Identifies the redo image in the enabled state.
148      */
149     public final static String   IMG_TOOL_REDO = "IMG_TOOL_REDO"; //$NON-NLS-1$
150 
151     /**
152      * Identifies the redo image in the hover (colored) state.
153      * 
154      * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_REDO</code>.
155      *   Enabled images are now in color.  The workbench itself no longer uses the hover image variants.
156      */
157     public final static String   IMG_TOOL_REDO_HOVER = "IMG_TOOL_REDO_HOVER"; //$NON-NLS-1$
158 
159     /**
160      * Identifies the redo image in the disabled state.
161      */
162     public final static String   IMG_TOOL_REDO_DISABLED = "IMG_TOOL_REDO_DISABLED"; //$NON-NLS-1$
163 
164     /**
165      * Identifies the cut image in the enabled state.
166      */
167     public final static String   IMG_TOOL_CUT = "IMG_TOOL_CUT"; //$NON-NLS-1$
168 
169     /**
170      * Identifies the cut image in the hover (colored) state.
171      * 
172      * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_CUT</code>.
173      *   Enabled images are now in color.  The workbench itself no longer uses the hover image variants.
174      */
175     public final static String   IMG_TOOL_CUT_HOVER = "IMG_TOOL_CUT_HOVER"; //$NON-NLS-1$
176 
177     /**
178      * Identifies the cut image in the disabled state.
179      */
180     public final static String   IMG_TOOL_CUT_DISABLED = "IMG_TOOL_CUT_DISABLED"; //$NON-NLS-1$
181 
182     /**
183      * Identifies the copy image in the enabled state.
184      */
185     public final static String   IMG_TOOL_COPY = "IMG_TOOL_COPY"; //$NON-NLS-1$
186 
187     /**
188      * Identifies the copy image in the hover (colored) state.
189      * 
190      * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_COPY</code>.
191      *   Enabled images are now in color.  The workbench itself no longer uses the hover image variants.
192      */
193     public final static String   IMG_TOOL_COPY_HOVER = "IMG_TOOL_COPY_HOVER"; //$NON-NLS-1$
194 
195     /**
196      * Identifies the copy image in the disabled state.
197      */
198     public final static String   IMG_TOOL_COPY_DISABLED = "IMG_TOOL_COPY_DISABLED"; //$NON-NLS-1$
199 
200     /**
201      * Identifies the paste image in the enabled state.
202      */
203     public final static String   IMG_TOOL_PASTE = "IMG_TOOL_PASTE"; //$NON-NLS-1$
204 
205     /**
206      * Identifies the paste image in the hover (colored) state.
207      * 
208      * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_PASTE</code>.
209      *   Enabled images are now in color.  The workbench itself no longer uses the hover image variants.
210      */
211     public final static String   IMG_TOOL_PASTE_HOVER = "IMG_TOOL_PASTE_HOVER"; //$NON-NLS-1$
212 
213     /**
214      * Identifies the paste image in the disabled state.
215      */
216     public final static String   IMG_TOOL_PASTE_DISABLED = "IMG_TOOL_PASTE_DISABLED"; //$NON-NLS-1$
217 
218     /**
219      * Identifies the delete image in the enabled state.
220      */
221     public final static String   IMG_TOOL_DELETE = "IMG_TOOL_DELETE"; //$NON-NLS-1$
222 
223     /**
224      * Identifies the delete image in the hover (colored) state.
225      * 
226      * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_DELETE</code>.
227      *   Enabled images are now in color.  The workbench itself no longer uses the hover image variants.
228      */
229     public final static String   IMG_TOOL_DELETE_HOVER = "IMG_TOOL_DELETE_HOVER"; //$NON-NLS-1$
230 
231     /**
232      * Identifies the delete image in the disabled state.
233      */
234     public final static String   IMG_TOOL_DELETE_DISABLED = "IMG_TOOL_DELETE_DISABLED"; //$NON-NLS-1$
235 
236     /**
237      * Identifies the forward image in the enabled state.
238      */
239     public final static String   IMG_TOOL_FORWARD = "IMG_TOOL_FORWARD"; //$NON-NLS-1$
240 
241     /**
242      * Identifies the forward image in the hover (colored) state.
243      * 
244      * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_FORWARD</code>.
245      *   Enabled images are now in color.  The workbench itself no longer uses the hover image variants.
246      */
247     public final static String   IMG_TOOL_FORWARD_HOVER = "IMG_TOOL_FORWARD_HOVER"; //$NON-NLS-1$
248 
249     /**
250      * Identifies the forward image in the disabled state.
251      */
252     public final static String   IMG_TOOL_FORWARD_DISABLED = "IMG_TOOL_FORWARD_DISABLED"; //$NON-NLS-1$
253 
254     /**
255      * Identifies the back image in the enabled state.
256      */
257     public final static String   IMG_TOOL_BACK = "IMG_TOOL_BACK"; //$NON-NLS-1$
258 
259     /**
260      * Identifies the back image in the hover (colored) state.
261      * 
262      * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_BACK</code>.
263      *   Enabled images are now in color.  The workbench itself no longer uses the hover image variants.
264      */
265     public final static String   IMG_TOOL_BACK_HOVER = "IMG_TOOL_BACK_HOVER"; //$NON-NLS-1$
266 
267     /**
268      * Identifies the back image in the disabled state.
269      */
270     public final static String   IMG_TOOL_BACK_DISABLED = "IMG_TOOL_BACK_DISABLED"; //$NON-NLS-1$
271 
272     /**
273      * Identifies the up image in the enabled state.
274      */
275     public final static String   IMG_TOOL_UP = "IMG_TOOL_UP"; //$NON-NLS-1$
276 
277     /**
278      * Identifies the up image in the hover (colored) state.
279      * 
280      * @deprecated in 3.0. This image is now the same as <code>IMG_TOOL_UP</code>.
281      *   Enabled images are now in color.  The workbench itself no longer uses the hover image variants.
282      */
283     public final static String   IMG_TOOL_UP_HOVER = "IMG_TOOL_UP_HOVER"; //$NON-NLS-1$
284 
285     /**
286      * Identifies the up image in the disabled state.
287      */
288     public final static String   IMG_TOOL_UP_DISABLED = "IMG_TOOL_UP_DISABLED"; //$NON-NLS-1$
289     
290     /**
291      * Retrieves the specified image from the workbench plugin's image registry.
292      * Note: The returned <code>Image</code> is managed by the workbench; clients
293      * must <b>not</b> dispose of the returned image.
294      *
295      * @param symbolicName the symbolic name of the image; there are constants
296      * declared in this interface for build-in images that come with the workbench
297      * @return the image, or <code>null</code> if not found
298      */
299     public Image getImage(String   symbolicName);
300 
301     /**
302      * Retrieves the image descriptor for specified image from the workbench's
303      * image registry. Unlike <code>Image</code>s, image descriptors themselves do
304      * not need to be disposed.
305      *
306      * @param symbolicName the symbolic name of the image; there are constants
307      * declared in this interface for build-in images that come with the workbench
308      * @return the image descriptor, or <code>null</code> if not found
309      */
310     public ImageDescriptor getImageDescriptor(String   symbolicName);
311 }
312
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags