Project

General

Profile

Download (16.9 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
    public static final String DEFAULT_DERIVATIVE = "default_derivate";
164

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

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

    
169

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

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

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

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

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

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

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

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

    
229
		}
230

    
231
		return image;
232
	}
233

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

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

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

    
395
		registerImage(registry, WEB,
396
		        "web.gif");
397

    
398
	}
399

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