Java > Open Source Codes > org > eclipse > ui > internal > browser > ImageResource


1 /*******************************************************************************
2  * Copyright (c) 2003, 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.internal.browser;
12
13 import java.net.URL ;
14 import java.util.Map ;
15 import java.util.HashMap ;
16 import org.eclipse.swt.graphics.Image;
17 import org.eclipse.core.runtime.FileLocator;
18 import org.eclipse.core.runtime.Path;
19 import org.eclipse.jface.resource.ImageDescriptor;
20 import org.eclipse.jface.resource.ImageRegistry;
21 /**
22  * Utility class to handle image resources.
23  */
24 public class ImageResource {
25     // the image registry
26 private static ImageRegistry imageRegistry;
27
28     // map of image descriptors since these
29 // will be lost by the image registry
30 private static Map imageDescriptors;
31
32     private static Image[] busyImages;
33
34     private static final String URL_PREFIX = "$nl$/icons/"; //$NON-NLS-1$
35 private static final String URL_CLCL = URL_PREFIX + "clcl16/"; //$NON-NLS-1$
36 private static final String URL_ELCL = URL_PREFIX + "elcl16/"; //$NON-NLS-1$
37 private static final String URL_DLCL = URL_PREFIX + "dlcl16/"; //$NON-NLS-1$
38 private static final String URL_OBJ = URL_PREFIX + "obj16/"; //$NON-NLS-1$
39
40     // --- constants for images ---
41 // toolbar images
42 public static final String IMG_CLCL_NAV_BACKWARD = "IMG_CLCL_NAV_BACKWARD"; //$NON-NLS-1$
43 public static final String IMG_CLCL_NAV_FORWARD = "IMG_CLCL_NAV_FORWARD"; //$NON-NLS-1$
44 public static final String IMG_CLCL_NAV_STOP = "IMG_CLCL_NAV_STOP"; //$NON-NLS-1$
45 public static final String IMG_CLCL_NAV_REFRESH = "IMG_CLCL_NAV_REFRESH"; //$NON-NLS-1$
46 public static final String IMG_CLCL_NAV_GO = "IMG_CLCL_NAV_GO"; //$NON-NLS-1$
47 public static final String IMG_CLCL_NAV_HOME = "IMG_CLCL_NAV_HOME"; //$NON-NLS-1$
48 public static final String IMG_CLCL_NAV_PRINT = "IMG_CLCL_NAV_PRINT"; //$NON-NLS-1$
49
50     public static final String IMG_ELCL_NAV_BACKWARD = "IMG_ELCL_NAV_BACKWARD"; //$NON-NLS-1$
51 public static final String IMG_ELCL_NAV_FORWARD = "IMG_ELCL_NAV_FORWARD"; //$NON-NLS-1$
52 public static final String IMG_ELCL_NAV_STOP = "IMG_ELCL_NAV_STOP"; //$NON-NLS-1$
53 public static final String IMG_ELCL_NAV_REFRESH = "IMG_ELCL_NAV_REFRESH"; //$NON-NLS-1$
54 public static final String IMG_ELCL_NAV_GO = "IMG_ELCL_NAV_GO"; //$NON-NLS-1$
55 public static final String IMG_ELCL_NAV_HOME = "IMG_ELCL_NAV_HOME"; //$NON-NLS-1$
56 public static final String IMG_ELCL_NAV_PRINT = "IMG_ELCL_NAV_PRINT"; //$NON-NLS-1$
57
58     public static final String IMG_DLCL_NAV_BACKWARD = "IMG_DLCL_NAV_BACKWARD"; //$NON-NLS-1$
59 public static final String IMG_DLCL_NAV_FORWARD = "IMG_DLCL_NAV_FORWARD"; //$NON-NLS-1$
60 public static final String IMG_DLCL_NAV_STOP = "IMG_DLCL_NAV_STOP"; //$NON-NLS-1$
61 public static final String IMG_DLCL_NAV_REFRESH = "IMG_DLCL_NAV_REFRESH"; //$NON-NLS-1$
62 public static final String IMG_DLCL_NAV_GO = "IMG_DLCL_NAV_GO"; //$NON-NLS-1$
63 public static final String IMG_DLCL_NAV_HOME = "IMG_DLCL_NAV_HOME"; //$NON-NLS-1$
64 public static final String IMG_DLCL_NAV_PRINT = "IMG_DLCL_NAV_PRINT"; //$NON-NLS-1$
65
66     // general object images
67 public static final String IMG_INTERNAL_BROWSER = "internalBrowser"; //$NON-NLS-1$
68 public static final String IMG_EXTERNAL_BROWSER = "externalBrowser"; //$NON-NLS-1$
69 public static final String IMG_SYSTEM_BROWSER = "systemBrowser"; //$NON-NLS-1$
70
71     /**
72      * Cannot construct an ImageResource. Use static methods only.
73      */
74     private ImageResource() {
75         // do nothing
76 }
77
78     /**
79      * Returns the busy images for the Web browser.
80      *
81      * @return org.eclipse.swt.graphics.Image[]
82      */
83     public static Image[] getBusyImages() {
84         return busyImages;
85     }
86
87     /**
88      * Return the image with the given key.
89      *
90      * @param key java.lang.String
91      * @return org.eclipse.swt.graphics.Image
92      */
93     public static Image getImage(String key) {
94         if (imageRegistry == null)
95             initializeImageRegistry();
96         return imageRegistry.get(key);
97     }
98
99     /**
100      * Return the image descriptor with the given key.
101      *
102      * @param key java.lang.String
103      * @return org.eclipse.jface.resource.ImageDescriptor
104      */
105     public static ImageDescriptor getImageDescriptor(String key) {
106         if (imageRegistry == null)
107             initializeImageRegistry();
108         return (ImageDescriptor) imageDescriptors.get(key);
109     }
110
111     /**
112      * Initialize the image resources.
113      */
114     protected static void initializeImageRegistry() {
115         imageRegistry = new ImageRegistry();
116         imageDescriptors = new HashMap ();
117     
118         // load Web browser images
119 registerImage(IMG_ELCL_NAV_BACKWARD, URL_ELCL + "nav_backward.gif"); //$NON-NLS-1$
120 registerImage(IMG_ELCL_NAV_FORWARD, URL_ELCL + "nav_forward.gif"); //$NON-NLS-1$
121 registerImage(IMG_ELCL_NAV_STOP, URL_ELCL + "nav_stop.gif"); //$NON-NLS-1$
122 registerImage(IMG_ELCL_NAV_REFRESH, URL_ELCL + "nav_refresh.gif"); //$NON-NLS-1$
123 registerImage(IMG_ELCL_NAV_GO, URL_ELCL + "nav_go.gif"); //$NON-NLS-1$
124 registerImage(IMG_ELCL_NAV_HOME, URL_ELCL + "nav_home.gif"); //$NON-NLS-1$
125 registerImage(IMG_ELCL_NAV_PRINT, URL_ELCL + "nav_print.gif"); //$NON-NLS-1$
126
127         registerImage(IMG_CLCL_NAV_BACKWARD, URL_CLCL + "nav_backward.gif"); //$NON-NLS-1$
128 registerImage(IMG_CLCL_NAV_FORWARD, URL_CLCL + "nav_forward.gif"); //$NON-NLS-1$
129 registerImage(IMG_CLCL_NAV_STOP, URL_CLCL + "nav_stop.gif"); //$NON-NLS-1$
130 registerImage(IMG_CLCL_NAV_REFRESH, URL_CLCL + "nav_refresh.gif"); //$NON-NLS-1$
131 registerImage(IMG_CLCL_NAV_GO, URL_CLCL + "nav_go.gif"); //$NON-NLS-1$
132 registerImage(IMG_CLCL_NAV_HOME, URL_CLCL + "nav_home.gif"); //$NON-NLS-1$
133 registerImage(IMG_CLCL_NAV_PRINT, URL_CLCL + "nav_print.gif"); //$NON-NLS-1$
134
135         registerImage(IMG_DLCL_NAV_BACKWARD, URL_DLCL + "nav_backward.gif"); //$NON-NLS-1$
136 registerImage(IMG_DLCL_NAV_FORWARD, URL_DLCL + "nav_forward.gif"); //$NON-NLS-1$
137 registerImage(IMG_DLCL_NAV_STOP, URL_DLCL + "nav_stop.gif"); //$NON-NLS-1$
138 registerImage(IMG_DLCL_NAV_REFRESH, URL_DLCL + "nav_refresh.gif"); //$NON-NLS-1$
139 registerImage(IMG_DLCL_NAV_GO, URL_DLCL + "nav_go.gif"); //$NON-NLS-1$
140 registerImage(IMG_DLCL_NAV_HOME, URL_DLCL + "nav_home.gif"); //$NON-NLS-1$
141 registerImage(IMG_DLCL_NAV_PRINT, URL_DLCL + "nav_print.gif"); //$NON-NLS-1$
142
143         registerImage(IMG_INTERNAL_BROWSER, URL_OBJ + "internal_browser.gif"); //$NON-NLS-1$
144 registerImage(IMG_EXTERNAL_BROWSER, URL_OBJ + "external_browser.gif"); //$NON-NLS-1$
145
146         // busy images
147 busyImages = new Image[13];
148         for (int i = 0; i < 13; i++) {
149             registerImage("busy" + i, URL_OBJ + "busy/" + (i+1) + ".gif"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
150 busyImages[i] = getImage("busy" + i); //$NON-NLS-1$
151 }
152     }
153
154     /**
155      * Register an image with the registry.
156      *
157      * @param key java.lang.String
158      * @param partialURL java.lang.String
159      */
160     private static void registerImage(String key, String partialURL) {
161         try {
162             URL url = FileLocator.find(WebBrowserUIPlugin.getInstance().getBundle(), new Path(partialURL), null);
163             ImageDescriptor id = ImageDescriptor.createFromURL(url);
164             imageRegistry.put(key, id);
165             imageDescriptors.put(key, id);
166         } catch (Exception e) {
167             Trace.trace(Trace.WARNING, "Error registering image " + key + " from " + partialURL, e); //$NON-NLS-1$ //$NON-NLS-2$
168 }
169     }
170 }
171

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags