Project

General

Profile

Download (17.1 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
	public static final String ADD_EDIT = "add_edit";
56
	/** Constant <code>TRASH_ICON="trash_icon"</code> */
57
	public static final String TRASH_ICON = "trash_icon";
58
	/** Constant <code>BROWSE_ICON="browse_icon"</code> */
59
	public static final String BROWSE_ICON = "browse_icon";
60
	/** Constant <code>EDIT_ICON="edit_icon"</code> */
61
	public static final String EDIT_ICON = "edit_icon";
62
	/** Constant <code>EDIT_LOGO_ICON="edit_logo_icon"</code> */
63
	public static final String EDIT_LOGO_ICON = "edit_logo_icon";
64
	/** Constant <code>WARNING_ICON="warning_icon"</code> */
65
	public static final String WARNING_ICON = "warning_icon";
66
	/** Constant <code>BLACK_SQUARE_ICON="black_square_icon"</code> */
67
	public static final String BLACK_SQUARE_ICON = "black_square_icon";
68
	/** Constant <code>HOMOTYPIC_SYN_ICON="homotypic_syn_icon"</code> */
69
	public static final String HOMOTYPIC_SYN_ICON = "homotypic_syn_icon";
70
	/** Constant <code>HOMOTYPIC_SYN_ORIGINAL_ICON="homotypic_syn_original_icon"</code> */
71
	public static final String HOMOTYPIC_SYN_ORIGINAL_ICON = "homotypic_syn_original_icon";
72
	/** Constant <code>HETEROTYPIC_SYN_ICON="heterotypic_syn_icon"</code> */
73
	public static final String HETEROTYPIC_SYN_ICON = "heterotypic_syn_icon";
74
	public static final String NOM_INVAL_NUD_SYN_ICON = "nom_inval_nud_syn_icon";
75
	public static final String HOMOTYPIC_SYNONYM_IN_HETEROTYPIC_GROUP_ICON = "homotypic_synonym_in_heterotypic_group_icon";
76
	/** Constant <code>HETEROTYPIC_SYN_ORIGINAL_ICON="heterotypic_syn_original_icon"</code> */
77
	public static final String HETEROTYPIC_SYN_ORIGINAL_ICON = "heterotypic_syn_original_icon";
78
	/** Constant <code>MISAPPLIED_NAME_ICON="misapplied_icon"</code> */
79
	public static final String MISAPPLIED_NAME_ICON = "misapplied_icon";
80
	/** Constant <code>CONCEPT_ICON="concept_icon"</code> */
81
	public static final String CONCEPT_ICON = "concept_icon";
82
	/** Constant <code>AUTONYM_ICON="autonym_icon"</code> */
83
	public static final String AUTONYM_ICON = "autonym_icon";
84
	/** Constant <code>BASIONYM_ICON="basionym_icon"</code> */
85
	public static final String BASIONYM_ICON = "basionym_icon";
86
	/** Constant <code>ORTHOGRAPHIC_VARIANT_ICON="orthographic_variants_icon"</code> */
87
	public static final String ORTHOGRAPHIC_VARIANT_ICON = "orthographic_variants_icon";
88
	/** Constant <code>DB_ICON="db_icon"</code> */
89
	public static final String DB_ICON = "db_icon";
90
	/** Constant <code>MOVE_ICON="move_icon"</code> */
91
	public static final String MOVE_ICON = "move_icon";
92
	/** Constant <code>ACTIVE_DELETE_ICON="active_delete_icon"</code> */
93
	public static final String ACTIVE_DELETE_ICON = "active_delete_icon";
94
	/** Constant <code>SYNONYM_TO_TAXON_ICON="synoynm_to_taxon_icon"</code> */
95
	public static final String SYNONYM_TO_TAXON_ICON = "synoynm_to_taxon_icon";
96
	/** Constant <code>OPEN_TAXON_ICON="open_taxon_icon"</code> */
97
	public static final String OPEN_TAXON_ICON = "open_taxon_icon";
98
	/** Constant <code>ADD_CHILD_TAXON_ICON="add_taxon_icon"</code> */
99
	public static final String ADD_CHILD_TAXON_ICON = "add_taxon_icon";
100
	/** Constant <code>SWAP_SYNONYM_AND_TAXON_ICON="swap_syn_and_tax_icon"</code> */
101
	public static final String SWAP_SYNONYM_AND_TAXON_ICON = "swap_syn_and_tax_icon";
102
	/** Constant <code>QUICK_ADD_ICON="quick_add_icon"</code> */
103
	public static final String QUICK_ADD_ICON = "quick_add_icon";
104
	/** Constant <code>TAXON_TO_SYNONYM_ICON="tax_to_syn_icon"</code> */
105
	public static final String TAXON_TO_SYNONYM_ICON = "tax_to_syn_icon";
106
	/** Constant <code>ERROR_ANNOTATION_ICON="error_annotation_icon"</code> */
107
	public static final String ERROR_ANNOTATION_ICON = "error_annotation_icon";
108
	/** Constant <code>EDIT_BITMAP_ICON="edit_bitmap_icon"</code> */
109
	public static final String EDIT_BITMAP_ICON = "edit_bitmap_icon";
110
	/** Constant <code>IMG_DATASOURCE_CONNECTED="IMG_DATASOURCE_CONNECTED"</code> */
111
	public static final String IMG_DATASOURCE_CONNECTED = "IMG_DATASOURCE_CONNECTED";
112
	/** Constant <code>IMG_DATASOURCE_DISCONNECTED="IMG_DATASOURCE_DISCONNECTED"</code> */
113
	public static final String IMG_DATASOURCE_DISCONNECTED = "IMG_DATASOURCE_DISCONNECTED";
114
	/** Constant <code>IMG_NOT_FOUND="IMG_NOT_FOUND"</code> */
115
	public static final String IMG_NOT_FOUND = "IMG_NOT_FOUND";
116
	/** Constant <code>WARNING_ANNOTATION_ICON="warning"</code> */
117
	public static final String WARNING_ANNOTATION_ICON = "warning";
118

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

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

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

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

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

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

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

    
168
    public static final String WEB = "web";
169
    public static final String DATE = "dates";
170

    
171

    
172
	/***************************************************************************
173
	 * IMAGE REGISTRY
174
	 **************************************************************************/
175
	private ImageRegistry imageRegistry;
176

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

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

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

    
205
		String key = uri.toString();
206
		ImageRegistry registry = getInstance().getImageRegistry();
207

    
208
		Image image = registry.get(key);
209

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

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

    
231
		}
232

    
233
		return image;
234
	}
235

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

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

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

    
399
		registerImage(registry, WEB,
400
		        "web.gif");
401
		registerImage(registry, DATE,
402
		        "dates.gif");
403

    
404
	}
405

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