eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/model/ImageResources.java

   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.StoreUtil;
  25 import eu.etaxonomy.taxeditor.store.internal.TaxeditorStorePlugin;
  26
  27 /**
  28  * <p>ImageResources class.</p>
  29  *
  30  * @author n.hoffmann
  31  * @created 24.03.2009
  32  * @version 1.0
  33  */
  34 public class ImageResources {
  35
  36         private static ImageResources instance;
  37
  38         /**
  39          * <p>Getter for the field <code>instance</code>.</p>
  40          *
  41          * @return a {@link eu.etaxonomy.taxeditor.model.ImageResources} object.
  42          */
  43         public static ImageResources getInstance(){
  44                 if(instance == null){
  45                         instance = new ImageResources();
  46                 }
  47                 return instance;
  48         }
  49
  50
  51         /* ***************************************************************************************
  52         ICONS
  53         ************************************************************************************** */
  54         /** Constant <code>ADD_ICON="add_icon"</code> */
  55         public static final String ADD_ICON = "add_icon";
  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         /** Constant <code>LOCK_OPEN_ICON="lock_open"</code> */
 123         public static final String LOCK_OPEN_ICON = "lock_open";
 124
 125         /** Constant <code>THREE_PRONGED_EQUAL="3_pronged_equal"</code> */
 126         public static final String THREE_PRONGED_EQUAL = "3_pronged_equal";
 127         /** Constant <code>TWO_PRONGED_EQUAL="2_pronged_equal"</code> */
 128         public static final String TWO_PRONGED_EQUAL = "2_pronged_equal";
 129         /** Constant <code>MISAPPLIED_NAME="misapplied_name"</code> */
 130         public static final String MISAPPLIED_NAME = "misapplied_name";
 131         /** Constant <code>ORPHANED_TAXON="orphaned_taxon"</code> */
 132         public static final String ORPHANED_TAXON = "orphaned_taxon";
 133         /** Constant <code>EXPAND_ALL="expand_all"</code> */
 134         public static final String EXPAND_ALL = "expand_all";
 135         /** Constant <code>COLLAPSE_ALL="collapse_all"</code> */
 136         public static final String COLLAPSE_ALL = "collapse_all";
 137
 138
 139
 140         /***************************************************************************
 141          * IMAGE REGISTRY
 142          **************************************************************************/
 143         private ImageRegistry imageRegistry;
 144
 145         /**
 146          * <p>getImageDescriptor</p>
 147          *
 148          * @param key a {@link java.lang.String} object.
 149          * @return a {@link org.eclipse.jface.resource.ImageDescriptor} object.
 150          */
 151         public static ImageDescriptor getImageDescriptor(String key) {
 152                 return getInstance().getImageRegistry().getDescriptor(key);
 153         }
 154
 155         /**
 156          * <p>getImage</p>
 157          *
 158          * @param key a {@link java.lang.String} object.
 159          * @return a {@link org.eclipse.swt.graphics.Image} object.
 160          */
 161         public static Image getImage(String key) {
 162                 return getInstance().getImageRegistry().get(key);
 163         }
 164
 165         /**
 166          * Gets an image for the given URL. Adds the image to the registry as needed.
 167          *
 168          * @param uri a {@link java.net.URI} object.
 169          * @return a {@link org.eclipse.swt.graphics.Image} object.
 170          */
 171         public static Image getImage(URI uri) {
 172
 173                 String key = uri.toString();
 174                 ImageRegistry registry = getInstance().getImageRegistry();
 175
 176                 Image image = registry.get(key);
 177
 178                 if (image == null) {
 179                         ImageDescriptor desc;
 180                         try {
 181                                 desc = ImageDescriptor.createFromURL(new URL(key));
 182                                 registry.put(key, desc);
 183                                 image = registry.get(key);
 184                         } catch (DeviceResourceException e) {
 185                                 return getImageNotFound();
 186                         } catch (MalformedURLException e) {
 187                                 // should never happen
 188                         } catch (Exception e) {
 189                                 StoreUtil.error(ImageResources.class, e);
 190                         }
 191
 192 //                      logger.warn(ImageDescriptor.getMissingImageDescriptor().getClass());
 193 //                      logger.warn(desc.getClass());
 194 //
 195 //                      if (ImageDescriptor.getMissingImageDescriptor().equals(desc)) {
 196 //                              logger.warn("img not found");
 197 //                      }
 198
 199                 }
 200
 201                 return image;
 202         }
 203
 204         /**
 205          * <p>getImageNotFound</p>
 206          *
 207          * @return a {@link org.eclipse.swt.graphics.Image} object.
 208          */
 209         public static Image getImageNotFound() {
 210                 return getImage(ImageResources.IMG_NOT_FOUND);
 211         }
 212
 213         /**
 214          * <p>Getter for the field <code>imageRegistry</code>.</p>
 215          *
 216          * @return a {@link org.eclipse.jface.resource.ImageRegistry} object.
 217          */
 218         public ImageRegistry getImageRegistry() {
 219         if (imageRegistry == null) {
 220             imageRegistry = TaxeditorStorePlugin.getDefault().createImageRegistry();
 221             initializeImageRegistry(imageRegistry);
 222         }
 223         return imageRegistry;
 224     }
 225
 226         /**
 227          * <p>initializeImageRegistry</p>
 228          *
 229          * @param registry a {@link org.eclipse.jface.resource.ImageRegistry} object.
 230          */
 231         protected void initializeImageRegistry(ImageRegistry registry) {
 232                 registerImage(registry, ADD_ICON,
 233                                 "add_no_bg.gif");
 234                 registerImage(registry, TRASH_ICON,
 235                                 "trash.gif");
 236                 registerImage(registry, EDIT_ICON,
 237                                 "text.gif");
 238                 registerImage(registry, EDIT_LOGO_ICON,
 239                                 "edit_16x16.ico");
 240                 registerImage(registry, WARNING_ICON,
 241                                 "warn_tsk.gif");
 242                 registerImage(registry, BLACK_SQUARE_ICON,
 243                                 "accepted_small.gif");
 244                 registerImage(registry, HOMOTYPIC_SYN_ICON,
 245                                 "homosyn_no_bg.gif");
 246                 registerImage(registry, HOMOTYPIC_SYN_ORIGINAL_ICON,
 247                                 "homosyn_original_no_bg.gif");
 248                 registerImage(registry, HETEROTYPIC_SYN_ICON,
 249                                 "heterosyn_no_bg.gif");
 250                 registerImage(registry, NOM_INVAL_NUD_SYN_ICON,
 251                                 "nominval_nud_no_bg.gif");
 252                 registerImage(registry, HETEROTYPIC_SYN_ORIGINAL_ICON,
 253                                 "heterosyn_original_no_bg.gif");
 254                 registerImage(registry, HOMOTYPIC_SYNONYM_IN_HETEROTYPIC_GROUP_ICON,
 255                                 "homotypic_syn_hetero_group.gif");
 256                 registerImage(registry, MISAPPLIED_NAME_ICON,
 257                                 "misapplied_no_bg.gif");
 258                 registerImage(registry, CONCEPT_ICON,
 259                                 "concept_no_bg.gif");
 260                 registerImage(registry, AUTONYM_ICON,
 261                                 "autonym_no_bg.gif");
 262                 registerImage(registry, BASIONYM_ICON,
 263                                 "basionym_no_bg.gif");
 264                 registerImage(registry, ORTHOGRAPHIC_VARIANT_ICON,
 265                                 "orthovariant_no_bg.gif");
 266                 registerImage(registry, DB_ICON,
 267                                 "db.gif");
 268                 registerImage(registry, MOVE_ICON,
 269                                 "correction_change.gif");
 270                 registerImage(registry, ACTIVE_DELETE_ICON,
 271                                 "delete_edit.gif");
 272                 registerImage(registry, SYNONYM_TO_TAXON_ICON,
 273                                 "change.gif");
 274                 registerImage(registry, OPEN_TAXON_ICON,
 275                                 "open.gif");
 276                 registerImage(registry, ADD_CHILD_TAXON_ICON,
 277                                 "new_child.gif");
 278                 registerImage(registry,
 279                                 SWAP_SYNONYM_AND_TAXON_ICON, "swap2.gif");
 280                 registerImage(registry, QUICK_ADD_ICON,
 281                                 "quick_add.gif");
 282                 registerImage(registry, TAXON_TO_SYNONYM_ICON,
 283                                 "tax_to_syn.gif");
 284                 registerImage(registry, ERROR_ANNOTATION_ICON,
 285                                 "error_co.gif");
 286                 registerImage(registry, EDIT_BITMAP_ICON,
 287                                 "256color_16x16.bmp");
 288                 registerImage(registry, IMG_DATASOURCE_CONNECTED,
 289                                 "prj_obj.gif");
 290                 registerImage(registry, IMG_DATASOURCE_DISCONNECTED,
 291                                 "cprj_obj.gif");
 292                 registerImage(registry, IMG_NOT_FOUND,
 293                                 "pic_not_found.PNG");
 294                 registerImage(registry, WARNING_ANNOTATION_ICON,
 295                                 "warning_co.gif");
 296                 registerImage(registry, THREE_PRONGED_EQUAL,
 297                                 "3_pronged_equal_small.GIF");
 298                 registerImage(registry, TWO_PRONGED_EQUAL,
 299                                 "2_pronged_equal_small.GIF");
 300                 registerImage(registry, MISAPPLIED_NAME,
 301                                 "ma_12x12.gif");
 302                 registerImage(registry, ORPHANED_TAXON,
 303                                 "orphaned.gif");
 304                 registerImage(registry, EXPAND_ALL,
 305                                 "expandAll.jpg");
 306                 registerImage(registry, COLLAPSE_ALL,
 307                                 "collapseall.gif");
 308                 registerImage(registry, BROWSE_ICON,
 309                                 "prj_obj.gif");
 310                 registerImage(registry, LOCK_ICON,
 311                         "lock.png");
 312                 registerImage(registry, LOCK_OPEN_ICON,
 313                         "lock_open.png");
 314         }
 315
 316         private void registerImage(ImageRegistry registry, String key,
 317                         String fileName) {
 318                 try {
 319                         IPath path = new Path("icons/" + fileName); //$NON-NLS-1$
 320                         URL url = FileLocator.find(TaxeditorStorePlugin.getDefault().getBundle(), path, null);
 321                         if (url != null) {
 322                                 ImageDescriptor desc = ImageDescriptor.createFromURL(url);
 323                                 registry.put(key, desc);
 324                         }
 325                 } catch (Exception e) {
 326                 }
 327         }
 328 }