Project

General

Profile

Download (16.8 KB) Statistics
| Branch: | Tag: | Revision:
1
/**
2
* Copyright (C) 2007 EDIT
3
* European Distributed Institute of Taxonomy
4
* http://www.e-taxonomy.eu
5
*
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.
8
*/
9

    
10
package eu.etaxonomy.taxeditor.model;
11

    
12
import java.net.MalformedURLException;
13
import java.net.URI;
14
import java.net.URL;
15

    
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;
23

    
24
import eu.etaxonomy.taxeditor.store.internal.TaxeditorStorePlugin;
25

    
26
/**
27
 * <p>ImageResources class.</p>
28
 *
29
 * @author n.hoffmann
30
 * @created 24.03.2009
31
 * @version 1.0
32
 */
33
public class ImageResources {
34

    
35
	private static ImageResources instance;
36

    
37
	/**
38
	 * <p>Getter for the field <code>instance</code>.</p>
39
	 *
40
	 * @return a {@link eu.etaxonomy.taxeditor.model.ImageResources} object.
41
	 */
42
	public static ImageResources getInstance(){
43
		if(instance == null){
44
			instance = new ImageResources();
45
		}
46
		return instance;
47
	}
48

    
49

    
50
	/* ***************************************************************************************
51
	ICONS
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";
117

    
118
	/** Constant <code>LOCK_ICON="locked"</code> */
119
	public static final String LOCK_ICON = "lock";
120

    
121
	public static final String SYNCED = "synced";
122

    
123
	/** Constant <code>LOCK_OPEN_ICON="lock_open"</code> */
124
	public static final String LOCK_OPEN_ICON = "lock_open";
125

    
126
	/** Constant <code>THREE_PRONGED_EQUAL="3_pronged_equal"</code> */
127
	public static final String THREE_PRONGED_EQUAL = "3_pronged_equal";
128
	/** Constant <code>TWO_PRONGED_EQUAL="2_pronged_equal"</code> */
129
	public static final String TWO_PRONGED_EQUAL = "2_pronged_equal";
130
	/** Constant <code>MISAPPLIED_NAME="misapplied_name"</code> */
131
	public static final String MISAPPLIED_NAME = "misapplied_name";
132
	/** Constant <code>ORPHANED_TAXON="orphaned_taxon"</code> */
133
	public static final String ORPHANED_TAXON = "orphaned_taxon";
134
	/** Constant <code>EXPAND_ALL="expand_all"</code> */
135
	public static final String EXPAND_ALL = "expand_all";
136
	/** Constant <code>COLLAPSE_ALL="collapse_all"</code> */
137
	public static final String COLLAPSE_ALL = "collapse_all";
138

    
139
	public static final String SWITCH_VIEW_TYPE = "switch_view_type";
140

    
141
	//derivative icons
142
	public static final String TISSUE_SAMPLE_DERIVATE = "tissue_sample_derivate";
143
	public static final String TISSUE_SAMPLE_DERIVATE_CHARACTER_DATA = "tissue_sample_derivate_character_data";
144
	public static final String DNA_SAMPLE_DERIVATE = "dna_sample_derivate";
145
	public static final String DNA_SAMPLE_DERIVATE_CHARACTER_DATA = "dna_sample_derivate_character_data";
146
	public static final String FIELD_UNIT = "field_unit";
147
	public static final String FIELD_UNIT_CHARACTER_DATA = "field_unit_character_data";
148
	public static final String SPECIMEN_DERIVATE = "specimen_derivate";
149
	public static final String SPECIMEN_DERIVATE_TYPE = "specimen_derivate_type";
150
	public static final String SPECIMEN_DERIVATE_CHARACTER_DATA = "specimen_derivate_character_data";
151
    public static final String ARTWORK_DERIVATE = "artwork_derivate";
152
    public static final String ARTWORK_DERIVATE_CHARACTER_DATA = "artwork_derivate_character_data";
153
    public static final String SPECIMEN_SCAN_DERIVATE = "specimen_scan_derivate";
154
    public static final String SPECIMEN_SCAN_DERIVATE_CHARACTER_DATA = "specimen_scan_derivate_character_data";
155
    public static final String LIVING_PLANT_PHOTO_DERIVATE = "living_plant_photo_derivate";
156
    public static final String LIVING_PLANT_PHOTO_DERIVATE_CHARACTER_DATA = "living_plant_photo_derivate_character_data";
157
    public static final String DETAIL_IMAGE_DERIVATE = "detail_image_derivate";
158
    public static final String DETAIL_IMAGE_DERIVATE_CHARACTER_DATA = "detail_image_derivate_character_data";
159
    public static final String SEQUENCE_DERIVATE = "sequence_derivate";
160
    public static final String AMPLIFICATION_DERIVATE = "amplification_derivate";
161
    public static final String SINGLE_READ_DERIVATE = "single_read_derivate";
162
    public static final String SINGLE_READ_DERIVATE_MULTILINK = "single_read_derivate_multilink";
163

    
164
    public static final String CHARACTER_DATA_DERIVATE = "character_data_derivate";
165

    
166
    public static final String WEB = "web";
167

    
168

    
169
	/***************************************************************************
170
	 * IMAGE REGISTRY
171
	 **************************************************************************/
172
	private ImageRegistry imageRegistry;
173

    
174
	/**
175
	 * <p>getImageDescriptor</p>
176
	 *
177
	 * @param key a {@link java.lang.String} object.
178
	 * @return a {@link org.eclipse.jface.resource.ImageDescriptor} object.
179
	 */
180
	public static ImageDescriptor getImageDescriptor(String key) {
181
		return getInstance().getImageRegistry().getDescriptor(key);
182
	}
183

    
184
	/**
185
	 * <p>getImage</p>
186
	 *
187
	 * @param key a {@link java.lang.String} object.
188
	 * @return a {@link org.eclipse.swt.graphics.Image} object.
189
	 */
190
	public static Image getImage(String key) {
191
		return getInstance().getImageRegistry().get(key);
192
	}
193

    
194
	/**
195
	 * Gets an image for the given URL. Adds the image to the registry as needed.
196
	 *
197
	 * @param uri a {@link java.net.URI} object.
198
	 * @return a {@link org.eclipse.swt.graphics.Image} object.
199
	 */
200
	public static Image getImage(URI uri) {
201

    
202
		String key = uri.toString();
203
		ImageRegistry registry = getInstance().getImageRegistry();
204

    
205
		Image image = registry.get(key);
206

    
207
		if (image == null) {
208
			ImageDescriptor desc;
209
			try {
210
				desc = ImageDescriptor.createFromURL(new URL(key));
211
				registry.put(key, desc);
212
				image = registry.get(key);
213
			} catch (DeviceResourceException e) {
214
				return getImageNotFound();
215
			} catch (MalformedURLException e) {
216
				// should never happen
217
			} catch (Exception e) {
218
				MessagingUtils.error(ImageResources.class, e);
219
			}
220

    
221
//			logger.warn(ImageDescriptor.getMissingImageDescriptor().getClass());
222
//			logger.warn(desc.getClass());
223
//
224
//			if (ImageDescriptor.getMissingImageDescriptor().equals(desc)) {
225
//				logger.warn("img not found");
226
//			}
227

    
228
		}
229

    
230
		return image;
231
	}
232

    
233
	/**
234
	 * <p>getImageNotFound</p>
235
	 *
236
	 * @return a {@link org.eclipse.swt.graphics.Image} object.
237
	 */
238
	public static Image getImageNotFound() {
239
		return getImage(ImageResources.IMG_NOT_FOUND);
240
	}
241

    
242
	/**
243
	 * <p>Getter for the field <code>imageRegistry</code>.</p>
244
	 *
245
	 * @return a {@link org.eclipse.jface.resource.ImageRegistry} object.
246
	 */
247
	public ImageRegistry getImageRegistry() {
248
        if (imageRegistry == null) {
249
            imageRegistry = TaxeditorStorePlugin.getDefault().createImageRegistry();
250
            initializeImageRegistry(imageRegistry);
251
        }
252
        return imageRegistry;
253
    }
254

    
255
	/**
256
	 * <p>initializeImageRegistry</p>
257
	 *
258
	 * @param registry a {@link org.eclipse.jface.resource.ImageRegistry} object.
259
	 */
260
	protected void initializeImageRegistry(ImageRegistry registry) {
261
		registerImage(registry, ADD_ICON,
262
				"add_no_bg.gif");
263
		registerImage(registry, TRASH_ICON,
264
				"trash.gif");
265
		registerImage(registry, EDIT_ICON,
266
				"text.gif");
267
		registerImage(registry, EDIT_LOGO_ICON,
268
				"edit_16x16.ico");
269
		registerImage(registry, WARNING_ICON,
270
				"warn_tsk.gif");
271
		registerImage(registry, BLACK_SQUARE_ICON,
272
				"accepted_small.gif");
273
		registerImage(registry, HOMOTYPIC_SYN_ICON,
274
				"homosyn_no_bg.gif");
275
		registerImage(registry,	HOMOTYPIC_SYN_ORIGINAL_ICON,
276
				"homosyn_original_no_bg.gif");
277
		registerImage(registry, HETEROTYPIC_SYN_ICON,
278
				"heterosyn_no_bg.gif");
279
		registerImage(registry, NOM_INVAL_NUD_SYN_ICON,
280
				"nominval_nud_no_bg.gif");
281
		registerImage(registry,	HETEROTYPIC_SYN_ORIGINAL_ICON,
282
				"heterosyn_original_no_bg.gif");
283
		registerImage(registry, HOMOTYPIC_SYNONYM_IN_HETEROTYPIC_GROUP_ICON,
284
				"homotypic_syn_hetero_group.gif");
285
		registerImage(registry, MISAPPLIED_NAME_ICON,
286
				"misapplied_no_bg.gif");
287
		registerImage(registry, CONCEPT_ICON,
288
				"concept_no_bg.gif");
289
		registerImage(registry, AUTONYM_ICON,
290
				"autonym_no_bg.gif");
291
		registerImage(registry, BASIONYM_ICON,
292
				"basionym_no_bg.gif");
293
		registerImage(registry, ORTHOGRAPHIC_VARIANT_ICON,
294
				"orthovariant_no_bg.gif");
295
		registerImage(registry, DB_ICON,
296
				"db.gif");
297
		registerImage(registry, MOVE_ICON,
298
				"correction_change.gif");
299
		registerImage(registry, ACTIVE_DELETE_ICON,
300
				"delete_edit.gif");
301
		registerImage(registry, SYNONYM_TO_TAXON_ICON,
302
				"change.gif");
303
		registerImage(registry, OPEN_TAXON_ICON,
304
				"open.gif");
305
		registerImage(registry, ADD_CHILD_TAXON_ICON,
306
				"new_child.gif");
307
		registerImage(registry,
308
				SWAP_SYNONYM_AND_TAXON_ICON, "swap2.gif");
309
		registerImage(registry, QUICK_ADD_ICON,
310
				"quick_add.gif");
311
		registerImage(registry, TAXON_TO_SYNONYM_ICON,
312
				"tax_to_syn.gif");
313
		registerImage(registry, ERROR_ANNOTATION_ICON,
314
				"error_co.gif");
315
		registerImage(registry, EDIT_BITMAP_ICON,
316
				"256color_16x16.bmp");
317
		registerImage(registry, IMG_DATASOURCE_CONNECTED,
318
				"prj_obj.gif");
319
		registerImage(registry, IMG_DATASOURCE_DISCONNECTED,
320
				"cprj_obj.gif");
321
		registerImage(registry, IMG_NOT_FOUND,
322
				"pic_not_found.PNG");
323
		registerImage(registry, WARNING_ANNOTATION_ICON,
324
				"warning_co.gif");
325
		registerImage(registry, THREE_PRONGED_EQUAL,
326
				"3_pronged_equal_small.GIF");
327
		registerImage(registry, TWO_PRONGED_EQUAL,
328
				"2_pronged_equal_small.GIF");
329
		registerImage(registry, MISAPPLIED_NAME,
330
				"ma_12x12.gif");
331
		registerImage(registry, ORPHANED_TAXON,
332
				"orphaned.gif");
333
		registerImage(registry, EXPAND_ALL,
334
				"expandAll.jpg");
335
		registerImage(registry, COLLAPSE_ALL,
336
				"collapseall.gif");
337
		registerImage(registry, BROWSE_ICON,
338
				"prj_obj.gif");
339
		registerImage(registry, LOCK_ICON,
340
		        "lock.png");
341
		registerImage(registry, SYNCED,
342
		        "synced.gif");
343
		registerImage(registry, LOCK_OPEN_ICON,
344
		        "lock_open.png");
345
		registerImage(registry, SWITCH_VIEW_TYPE,
346
		        "switch_view_type-16x16-32.png");
347
		registerImage(registry, DNA_SAMPLE_DERIVATE,
348
		        "dna_derivate-16x16-32.png");
349
		registerImage(registry, DNA_SAMPLE_DERIVATE_CHARACTER_DATA,
350
		        "dna_derivate_data-16x16-32.png");
351
		registerImage(registry, FIELD_UNIT,
352
		        "fieldunit-16x16-32.png");
353
		registerImage(registry, FIELD_UNIT_CHARACTER_DATA,
354
		        "fieldunit_data-16x16-32.png");
355
		registerImage(registry, SPECIMEN_DERIVATE,
356
		        "specimen_derivate-16x16-32.png");
357
		registerImage(registry, SPECIMEN_DERIVATE_TYPE,
358
		        "specimen_derivate_type-16x16-32.png");
359
		registerImage(registry, SPECIMEN_DERIVATE_CHARACTER_DATA,
360
		        "specimen_derivate_data-16x16-32.png");
361
		registerImage(registry, ARTWORK_DERIVATE,
362
		        "artwork_derivate-16x16-32.png");
363
		registerImage(registry, ARTWORK_DERIVATE_CHARACTER_DATA,
364
		        "artwork_derivate_data-16x16-32.png");
365
		registerImage(registry, SPECIMEN_SCAN_DERIVATE,
366
		        "specimen_scan_derivate-16x16-32.png");
367
		registerImage(registry, SPECIMEN_SCAN_DERIVATE_CHARACTER_DATA,
368
		        "specimen_scan_derivate_data-16x16-32.png");
369
		registerImage(registry, LIVING_PLANT_PHOTO_DERIVATE,
370
		        "living_plant_photo_derivate-16x16-32.png");
371
		registerImage(registry, LIVING_PLANT_PHOTO_DERIVATE_CHARACTER_DATA,
372
		        "living_plant_photo_derivate_data-16x16-32.png");
373
		registerImage(registry, DETAIL_IMAGE_DERIVATE,
374
		        "detail_image_derivate-16x16-32.png");
375
		registerImage(registry, DETAIL_IMAGE_DERIVATE_CHARACTER_DATA,
376
		        "detail_image_derivate_data-16x16-32.png");
377
		registerImage(registry, TISSUE_SAMPLE_DERIVATE,
378
		        "tissue_sample-16x16-32.png");
379
		registerImage(registry, TISSUE_SAMPLE_DERIVATE_CHARACTER_DATA,
380
		        "tissue_sample_data-16x16-32.png");
381
		registerImage(registry, SEQUENCE_DERIVATE,
382
		        "sequence_derivate-16x16-32.png");
383
		registerImage(registry, AMPLIFICATION_DERIVATE,
384
		        "amplification_derivate-16x16-32.png");
385
		registerImage(registry, SINGLE_READ_DERIVATE,
386
		        "single_read_derivate-16x16-32.png");
387
		registerImage(registry, SINGLE_READ_DERIVATE_MULTILINK,
388
		        "single_read_derivate_multilink-16x16-32.png");
389
		registerImage(registry, CHARACTER_DATA_DERIVATE,
390
		        "character_data_derivate-16x16-32.png");
391

    
392
		registerImage(registry, WEB,
393
		        "web.gif");
394

    
395
	}
396

    
397
	private void registerImage(ImageRegistry registry, String key,
398
			String fileName) {
399
		try {
400
			IPath path = new Path("icons/" + fileName); //$NON-NLS-1$
401
			URL url = FileLocator.find(TaxeditorStorePlugin.getDefault().getBundle(), path, null);
402
			if (url != null) {
403
				ImageDescriptor desc = ImageDescriptor.createFromURL(url);
404
				registry.put(key, desc);
405
			}
406
		} catch (Exception e) {
407
		}
408
	}
409
}
(26-26/38)