2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
10 package eu
.etaxonomy
.taxeditor
.model
;
12 import java
.net
.MalformedURLException
;
16 import org
.eclipse
.core
.runtime
.FileLocator
;
17 import org
.eclipse
.core
.runtime
.IPath
;
18 import org
.eclipse
.core
.runtime
.Path
;
19 import org
.eclipse
.jface
.resource
.DeviceResourceException
;
20 import org
.eclipse
.jface
.resource
.ImageDescriptor
;
21 import org
.eclipse
.jface
.resource
.ImageRegistry
;
22 import org
.eclipse
.swt
.graphics
.Image
;
24 import eu
.etaxonomy
.taxeditor
.store
.internal
.TaxeditorStorePlugin
;
27 * <p>ImageResources class.</p>
33 public class ImageResources
{
35 private static ImageResources instance
;
38 * <p>Getter for the field <code>instance</code>.</p>
40 * @return a {@link eu.etaxonomy.taxeditor.model.ImageResources} object.
42 public static ImageResources
getInstance(){
44 instance
= new ImageResources();
50 /* ***************************************************************************************
52 ************************************************************************************** */
53 /** Constant <code>ADD_ICON="add_icon"</code> */
54 public static final String ADD_ICON
= "add_icon";
55 /** Constant <code>TRASH_ICON="trash_icon"</code> */
56 public static final String TRASH_ICON
= "trash_icon";
57 /** Constant <code>BROWSE_ICON="browse_icon"</code> */
58 public static final String BROWSE_ICON
= "browse_icon";
59 /** Constant <code>EDIT_ICON="edit_icon"</code> */
60 public static final String EDIT_ICON
= "edit_icon";
61 /** Constant <code>EDIT_LOGO_ICON="edit_logo_icon"</code> */
62 public static final String EDIT_LOGO_ICON
= "edit_logo_icon";
63 /** Constant <code>WARNING_ICON="warning_icon"</code> */
64 public static final String WARNING_ICON
= "warning_icon";
65 /** Constant <code>BLACK_SQUARE_ICON="black_square_icon"</code> */
66 public static final String BLACK_SQUARE_ICON
= "black_square_icon";
67 /** Constant <code>HOMOTYPIC_SYN_ICON="homotypic_syn_icon"</code> */
68 public static final String HOMOTYPIC_SYN_ICON
= "homotypic_syn_icon";
69 /** Constant <code>HOMOTYPIC_SYN_ORIGINAL_ICON="homotypic_syn_original_icon"</code> */
70 public static final String HOMOTYPIC_SYN_ORIGINAL_ICON
= "homotypic_syn_original_icon";
71 /** Constant <code>HETEROTYPIC_SYN_ICON="heterotypic_syn_icon"</code> */
72 public static final String HETEROTYPIC_SYN_ICON
= "heterotypic_syn_icon";
73 public static final String NOM_INVAL_NUD_SYN_ICON
= "nom_inval_nud_syn_icon";
74 public static final String HOMOTYPIC_SYNONYM_IN_HETEROTYPIC_GROUP_ICON
= "homotypic_synonym_in_heterotypic_group_icon";
75 /** Constant <code>HETEROTYPIC_SYN_ORIGINAL_ICON="heterotypic_syn_original_icon"</code> */
76 public static final String HETEROTYPIC_SYN_ORIGINAL_ICON
= "heterotypic_syn_original_icon";
77 /** Constant <code>MISAPPLIED_NAME_ICON="misapplied_icon"</code> */
78 public static final String MISAPPLIED_NAME_ICON
= "misapplied_icon";
79 /** Constant <code>CONCEPT_ICON="concept_icon"</code> */
80 public static final String CONCEPT_ICON
= "concept_icon";
81 /** Constant <code>AUTONYM_ICON="autonym_icon"</code> */
82 public static final String AUTONYM_ICON
= "autonym_icon";
83 /** Constant <code>BASIONYM_ICON="basionym_icon"</code> */
84 public static final String BASIONYM_ICON
= "basionym_icon";
85 /** Constant <code>ORTHOGRAPHIC_VARIANT_ICON="orthographic_variants_icon"</code> */
86 public static final String ORTHOGRAPHIC_VARIANT_ICON
= "orthographic_variants_icon";
87 /** Constant <code>DB_ICON="db_icon"</code> */
88 public static final String DB_ICON
= "db_icon";
89 /** Constant <code>MOVE_ICON="move_icon"</code> */
90 public static final String MOVE_ICON
= "move_icon";
91 /** Constant <code>ACTIVE_DELETE_ICON="active_delete_icon"</code> */
92 public static final String ACTIVE_DELETE_ICON
= "active_delete_icon";
93 /** Constant <code>SYNONYM_TO_TAXON_ICON="synoynm_to_taxon_icon"</code> */
94 public static final String SYNONYM_TO_TAXON_ICON
= "synoynm_to_taxon_icon";
95 /** Constant <code>OPEN_TAXON_ICON="open_taxon_icon"</code> */
96 public static final String OPEN_TAXON_ICON
= "open_taxon_icon";
97 /** Constant <code>ADD_CHILD_TAXON_ICON="add_taxon_icon"</code> */
98 public static final String ADD_CHILD_TAXON_ICON
= "add_taxon_icon";
99 /** Constant <code>SWAP_SYNONYM_AND_TAXON_ICON="swap_syn_and_tax_icon"</code> */
100 public static final String SWAP_SYNONYM_AND_TAXON_ICON
= "swap_syn_and_tax_icon";
101 /** Constant <code>QUICK_ADD_ICON="quick_add_icon"</code> */
102 public static final String QUICK_ADD_ICON
= "quick_add_icon";
103 /** Constant <code>TAXON_TO_SYNONYM_ICON="tax_to_syn_icon"</code> */
104 public static final String TAXON_TO_SYNONYM_ICON
= "tax_to_syn_icon";
105 /** Constant <code>ERROR_ANNOTATION_ICON="error_annotation_icon"</code> */
106 public static final String ERROR_ANNOTATION_ICON
= "error_annotation_icon";
107 /** Constant <code>EDIT_BITMAP_ICON="edit_bitmap_icon"</code> */
108 public static final String EDIT_BITMAP_ICON
= "edit_bitmap_icon";
109 /** Constant <code>IMG_DATASOURCE_CONNECTED="IMG_DATASOURCE_CONNECTED"</code> */
110 public static final String IMG_DATASOURCE_CONNECTED
= "IMG_DATASOURCE_CONNECTED";
111 /** Constant <code>IMG_DATASOURCE_DISCONNECTED="IMG_DATASOURCE_DISCONNECTED"</code> */
112 public static final String IMG_DATASOURCE_DISCONNECTED
= "IMG_DATASOURCE_DISCONNECTED";
113 /** Constant <code>IMG_NOT_FOUND="IMG_NOT_FOUND"</code> */
114 public static final String IMG_NOT_FOUND
= "IMG_NOT_FOUND";
115 /** Constant <code>WARNING_ANNOTATION_ICON="warning"</code> */
116 public static final String WARNING_ANNOTATION_ICON
= "warning";
118 /** Constant <code>LOCK_ICON="locked"</code> */
119 public static final String LOCK_ICON
= "lock";
121 /** Constant <code>LOCK_OPEN_ICON="lock_open"</code> */
122 public static final String LOCK_OPEN_ICON
= "lock_open";
124 /** Constant <code>THREE_PRONGED_EQUAL="3_pronged_equal"</code> */
125 public static final String THREE_PRONGED_EQUAL
= "3_pronged_equal";
126 /** Constant <code>TWO_PRONGED_EQUAL="2_pronged_equal"</code> */
127 public static final String TWO_PRONGED_EQUAL
= "2_pronged_equal";
128 /** Constant <code>MISAPPLIED_NAME="misapplied_name"</code> */
129 public static final String MISAPPLIED_NAME
= "misapplied_name";
130 /** Constant <code>ORPHANED_TAXON="orphaned_taxon"</code> */
131 public static final String ORPHANED_TAXON
= "orphaned_taxon";
132 /** Constant <code>EXPAND_ALL="expand_all"</code> */
133 public static final String EXPAND_ALL
= "expand_all";
134 /** Constant <code>COLLAPSE_ALL="collapse_all"</code> */
135 public static final String COLLAPSE_ALL
= "collapse_all";
137 public static final String TISSUE_SAMPLE_DERIVATE
= "tissue_sample_derivate";
138 public static final String TISSUE_SAMPLE_DERIVATE_CHARACTER_DATA
= "tissue_sample_derivate_character_data";
139 public static final String DNA_SAMPLE_DERIVATE
= "dna_sample_derivate";
140 public static final String DNA_SAMPLE_DERIVATE_CHARACTER_DATA
= "dna_sample_derivate_character_data";
141 public static final String FIELD_UNIT
= "field_unit";
142 public static final String FIELD_UNIT_CHARACTER_DATA
= "field_unit_character_data";
143 public static final String SPECIMEN_DERIVATE
= "specimen_derivate";
144 public static final String SPECIMEN_DERIVATE_CHARACTER_DATA
= "specimen_derivate_character_data";
145 public static final String ARTWORK_DERIVATE
= "artwork_derivate";
146 public static final String ARTWORK_DERIVATE_CHARACTER_DATA
= "artwork_derivate_character_data";
147 public static final String SPECIMEN_SCAN_DERIVATE
= "specimen_scan_derivate";
148 public static final String SPECIMEN_SCAN_DERIVATE_CHARACTER_DATA
= "specimen_scan_derivate_character_data";
149 public static final String LIVING_PLANT_PHOTO_DERIVATE
= "living_plant_photo_derivate";
150 public static final String LIVING_PLANT_PHOTO_DERIVATE_CHARACTER_DATA
= "living_plant_photo_derivate_character_data";
151 public static final String DETAIL_IMAGE_DERIVATE
= "detail_image_derivate";
152 public static final String DETAIL_IMAGE_DERIVATE_CHARACTER_DATA
= "detail_image_derivate_character_data";
153 public static final String SEQUENCE_DERIVATE
= "sequence_derivate";
154 public static final String AMPLIFICATION_DERIVATE
= "amplification_derivate";
155 public static final String SINGLE_READ_DERIVATE
= "single_read_derivate";
156 public static final String SINGLE_READ_DERIVATE_MULTILINK
= "single_read_derivate_multilink";
158 public static final String CHARACTER_DATA_DERIVATE
= "character_data_derivate";
162 /***************************************************************************
164 **************************************************************************/
165 private ImageRegistry imageRegistry
;
168 * <p>getImageDescriptor</p>
170 * @param key a {@link java.lang.String} object.
171 * @return a {@link org.eclipse.jface.resource.ImageDescriptor} object.
173 public static ImageDescriptor
getImageDescriptor(String key
) {
174 return getInstance().getImageRegistry().getDescriptor(key
);
180 * @param key a {@link java.lang.String} object.
181 * @return a {@link org.eclipse.swt.graphics.Image} object.
183 public static Image
getImage(String key
) {
184 return getInstance().getImageRegistry().get(key
);
188 * Gets an image for the given URL. Adds the image to the registry as needed.
190 * @param uri a {@link java.net.URI} object.
191 * @return a {@link org.eclipse.swt.graphics.Image} object.
193 public static Image
getImage(URI uri
) {
195 String key
= uri
.toString();
196 ImageRegistry registry
= getInstance().getImageRegistry();
198 Image image
= registry
.get(key
);
201 ImageDescriptor desc
;
203 desc
= ImageDescriptor
.createFromURL(new URL(key
));
204 registry
.put(key
, desc
);
205 image
= registry
.get(key
);
206 } catch (DeviceResourceException e
) {
207 return getImageNotFound();
208 } catch (MalformedURLException e
) {
209 // should never happen
210 } catch (Exception e
) {
211 MessagingUtils
.error(ImageResources
.class, e
);
214 // logger.warn(ImageDescriptor.getMissingImageDescriptor().getClass());
215 // logger.warn(desc.getClass());
217 // if (ImageDescriptor.getMissingImageDescriptor().equals(desc)) {
218 // logger.warn("img not found");
227 * <p>getImageNotFound</p>
229 * @return a {@link org.eclipse.swt.graphics.Image} object.
231 public static Image
getImageNotFound() {
232 return getImage(ImageResources
.IMG_NOT_FOUND
);
236 * <p>Getter for the field <code>imageRegistry</code>.</p>
238 * @return a {@link org.eclipse.jface.resource.ImageRegistry} object.
240 public ImageRegistry
getImageRegistry() {
241 if (imageRegistry
== null) {
242 imageRegistry
= TaxeditorStorePlugin
.getDefault().createImageRegistry();
243 initializeImageRegistry(imageRegistry
);
245 return imageRegistry
;
249 * <p>initializeImageRegistry</p>
251 * @param registry a {@link org.eclipse.jface.resource.ImageRegistry} object.
253 protected void initializeImageRegistry(ImageRegistry registry
) {
254 registerImage(registry
, ADD_ICON
,
256 registerImage(registry
, TRASH_ICON
,
258 registerImage(registry
, EDIT_ICON
,
260 registerImage(registry
, EDIT_LOGO_ICON
,
262 registerImage(registry
, WARNING_ICON
,
264 registerImage(registry
, BLACK_SQUARE_ICON
,
265 "accepted_small.gif");
266 registerImage(registry
, HOMOTYPIC_SYN_ICON
,
267 "homosyn_no_bg.gif");
268 registerImage(registry
, HOMOTYPIC_SYN_ORIGINAL_ICON
,
269 "homosyn_original_no_bg.gif");
270 registerImage(registry
, HETEROTYPIC_SYN_ICON
,
271 "heterosyn_no_bg.gif");
272 registerImage(registry
, NOM_INVAL_NUD_SYN_ICON
,
273 "nominval_nud_no_bg.gif");
274 registerImage(registry
, HETEROTYPIC_SYN_ORIGINAL_ICON
,
275 "heterosyn_original_no_bg.gif");
276 registerImage(registry
, HOMOTYPIC_SYNONYM_IN_HETEROTYPIC_GROUP_ICON
,
277 "homotypic_syn_hetero_group.gif");
278 registerImage(registry
, MISAPPLIED_NAME_ICON
,
279 "misapplied_no_bg.gif");
280 registerImage(registry
, CONCEPT_ICON
,
281 "concept_no_bg.gif");
282 registerImage(registry
, AUTONYM_ICON
,
283 "autonym_no_bg.gif");
284 registerImage(registry
, BASIONYM_ICON
,
285 "basionym_no_bg.gif");
286 registerImage(registry
, ORTHOGRAPHIC_VARIANT_ICON
,
287 "orthovariant_no_bg.gif");
288 registerImage(registry
, DB_ICON
,
290 registerImage(registry
, MOVE_ICON
,
291 "correction_change.gif");
292 registerImage(registry
, ACTIVE_DELETE_ICON
,
294 registerImage(registry
, SYNONYM_TO_TAXON_ICON
,
296 registerImage(registry
, OPEN_TAXON_ICON
,
298 registerImage(registry
, ADD_CHILD_TAXON_ICON
,
300 registerImage(registry
,
301 SWAP_SYNONYM_AND_TAXON_ICON
, "swap2.gif");
302 registerImage(registry
, QUICK_ADD_ICON
,
304 registerImage(registry
, TAXON_TO_SYNONYM_ICON
,
306 registerImage(registry
, ERROR_ANNOTATION_ICON
,
308 registerImage(registry
, EDIT_BITMAP_ICON
,
309 "256color_16x16.bmp");
310 registerImage(registry
, IMG_DATASOURCE_CONNECTED
,
312 registerImage(registry
, IMG_DATASOURCE_DISCONNECTED
,
314 registerImage(registry
, IMG_NOT_FOUND
,
315 "pic_not_found.PNG");
316 registerImage(registry
, WARNING_ANNOTATION_ICON
,
318 registerImage(registry
, THREE_PRONGED_EQUAL
,
319 "3_pronged_equal_small.GIF");
320 registerImage(registry
, TWO_PRONGED_EQUAL
,
321 "2_pronged_equal_small.GIF");
322 registerImage(registry
, MISAPPLIED_NAME
,
324 registerImage(registry
, ORPHANED_TAXON
,
326 registerImage(registry
, EXPAND_ALL
,
328 registerImage(registry
, COLLAPSE_ALL
,
330 registerImage(registry
, BROWSE_ICON
,
332 registerImage(registry
, LOCK_ICON
,
334 registerImage(registry
, LOCK_OPEN_ICON
,
336 registerImage(registry
, DNA_SAMPLE_DERIVATE
,
337 "dna_derivate-16x16-32.png");
338 registerImage(registry
, DNA_SAMPLE_DERIVATE_CHARACTER_DATA
,
339 "dna_derivate_data-16x16-32.png");
340 registerImage(registry
, FIELD_UNIT
,
341 "fieldunit-16x16-32.png");
342 registerImage(registry
, FIELD_UNIT_CHARACTER_DATA
,
343 "fieldunit_data-16x16-32.png");
344 registerImage(registry
, SPECIMEN_DERIVATE
,
345 "specimen_derivate-16x16-32.png");
346 registerImage(registry
, SPECIMEN_DERIVATE_CHARACTER_DATA
,
347 "specimen_derivate_data-16x16-32.png");
348 registerImage(registry
, ARTWORK_DERIVATE
,
349 "artwork_derivate-16x16-32.png");
350 registerImage(registry
, ARTWORK_DERIVATE_CHARACTER_DATA
,
351 "artwork_derivate_data-16x16-32.png");
352 registerImage(registry
, SPECIMEN_SCAN_DERIVATE
,
353 "specimen_scan_derivate-16x16-32.png");
354 registerImage(registry
, SPECIMEN_SCAN_DERIVATE_CHARACTER_DATA
,
355 "specimen_scan_derivate_data-16x16-32.png");
356 registerImage(registry
, LIVING_PLANT_PHOTO_DERIVATE
,
357 "living_plant_photo_derivate-16x16-32.png");
358 registerImage(registry
, LIVING_PLANT_PHOTO_DERIVATE_CHARACTER_DATA
,
359 "living_plant_photo_derivate_data-16x16-32.png");
360 registerImage(registry
, DETAIL_IMAGE_DERIVATE
,
361 "detail_image_derivate-16x16-32.png");
362 registerImage(registry
, DETAIL_IMAGE_DERIVATE_CHARACTER_DATA
,
363 "detail_image_derivate_data-16x16-32.png");
364 registerImage(registry
, TISSUE_SAMPLE_DERIVATE
,
365 "tissue_sample-16x16-32.png");
366 registerImage(registry
, TISSUE_SAMPLE_DERIVATE_CHARACTER_DATA
,
367 "tissue_sample_data-16x16-32.png");
368 registerImage(registry
, SEQUENCE_DERIVATE
,
369 "sequence_derivate-16x16-32.png");
370 registerImage(registry
, AMPLIFICATION_DERIVATE
,
371 "amplification_derivate-16x16-32.png");
372 registerImage(registry
, SINGLE_READ_DERIVATE
,
373 "single_read_derivate-16x16-32.png");
374 registerImage(registry
, SINGLE_READ_DERIVATE_MULTILINK
,
375 "single_read_derivate_multilink-16x16-32.png");
376 registerImage(registry
, CHARACTER_DATA_DERIVATE
,
377 "character_data_derivate-16x16-32.png");
381 private void registerImage(ImageRegistry registry
, String key
,
384 IPath path
= new Path("icons/" + fileName
); //$NON-NLS-1$
385 URL url
= FileLocator
.find(TaxeditorStorePlugin
.getDefault().getBundle(), path
, null);
387 ImageDescriptor desc
= ImageDescriptor
.createFromURL(url
);
388 registry
.put(key
, desc
);
390 } catch (Exception e
) {