net.sourceforge.phpeclipse.externaltools/src/net/sourceforge/phpdt/externaltools/internal/model/ExternalToolsImages.java

   1 package net.sourceforge.phpdt.externaltools.internal.model;
   2
   3 /**********************************************************************
   4 Copyright (c) 2002 IBM Corp. and others. All rights reserved.
   5 This file is made available under the terms of the Common Public License v1.0
   6 which accompanies this distribution, and is available at
   7 http://www.eclipse.org/legal/cpl-v10.html
   8 �
   9 Contributors:
  10 **********************************************************************/
  11
  12 import java.net.MalformedURLException;
  13 import java.net.URL;
  14 import java.util.HashMap;
  15
  16 import net.sourceforge.phpdt.externaltools.internal.ui.IExternalToolsUIConstants;
  17 import net.sourceforge.phpdt.externaltools.model.IExternalToolConstants;
  18
  19 import org.eclipse.jface.resource.ImageDescriptor;
  20 import org.eclipse.jface.resource.ImageRegistry;
  21 import org.eclipse.swt.graphics.Image;
  22 import org.eclipse.ui.externaltools.internal.model.ExternalToolsPlugin;
  23
  24 /**
  25  * The images provided by the external tools plugin.
  26  */
  27 public class ExternalToolsImages {
  28
  29         /**
  30          * The image registry containing <code>Image</code>s.
  31          */
  32         private static ImageRegistry imageRegistry;
  33
  34         /**
  35          * A table of all the <code>ImageDescriptor</code>s.
  36          */
  37         private static HashMap imageDescriptors;
  38
  39         private static final String ATTR_LAUNCH_CONFIG_TYPE_ICON = "icon"; //$NON-NLS-1$
  40         private static final String ATTR_LAUNCH_CONFIG_TYPE_ID = "configTypeID"; //$NON-NLS-1$
  41
  42         /* Declare Common paths */
  43         private static URL ICON_BASE_URL= null;
  44
  45 //      static {
  46 //              String pathSuffix = "icons/externaltools/full/"; //$NON-NLS-1$
  47 //
  48 //              try {
  49 //                      ICON_BASE_URL= new URL(PHPeclipsePlugin.getDefault().getDescriptor().getInstallURL(), pathSuffix);
  50 //              } catch (MalformedURLException e) {
  51 //                      // do nothing
  52 //              }
  53 //      }
  54         static {
  55                 String pathSuffix = "icons/full/"; //$NON-NLS-1$
  56                 ICON_BASE_URL= ExternalToolsPlugin.getDefault().getBundle().getEntry(pathSuffix);
  57         }
  58
  59         // Use IPath and toOSString to build the names to ensure they have the slashes correct
  60         private final static String CTOOL= "ctool16/"; //basic colors - size 16x16 //$NON-NLS-1$
  61         private final static String LOCALTOOL= "clcl16/"; //basic colors - size 16x16 //$NON-NLS-1$
  62         private final static String DLCL= "dlcl16/"; //disabled - size 16x16 //$NON-NLS-1$
  63         private final static String ELCL= "elcl16/"; //enabled - size 16x16 //$NON-NLS-1$
  64         private final static String OBJECT= "obj16/"; //basic colors - size 16x16 //$NON-NLS-1$
  65         private final static String WIZBAN= "wizban/"; //basic colors - size 16x16 //$NON-NLS-1$
  66         private final static String OVR= "ovr16/"; //basic colors - size 7x8 //$NON-NLS-1$
  67         private final static String VIEW= "cview16/"; // views //$NON-NLS-1$
  68
  69         /**
  70          * Declare all images
  71          */
  72         private static void declareImages() {
  73                 // Ant View Actions
  74                 declareRegistryImage(IExternalToolsUIConstants.IMG_REMOVE, LOCALTOOL + "remove_co.gif"); //$NON-NLS-1$
  75                 declareRegistryImage(IExternalToolsUIConstants.IMG_REMOVE_ALL, LOCALTOOL + "removeAll_co.gif"); //$NON-NLS-1$
  76                 declareRegistryImage(IExternalToolsUIConstants.IMG_ADD, LOCALTOOL + "add_co.gif"); //$NON-NLS-1$
  77                 declareRegistryImage(IExternalToolsUIConstants.IMG_RUN, LOCALTOOL + "run_tool.gif"); //$NON-NLS-1$
  78                 declareRegistryImage(IExternalToolsUIConstants.IMG_SEARCH, LOCALTOOL + "search.gif"); //$NON-NLS-1$
  79                 declareRegistryImage(IExternalToolsUIConstants.IMG_MOVE_UP, LOCALTOOL + "moveUp.gif"); //$NON-NLS-1$
  80                 declareRegistryImage(IExternalToolsUIConstants.IMG_MOVE_DOWN, LOCALTOOL + "moveDown.gif"); //$NON-NLS-1$
  81                 declareRegistryImage(IExternalToolsUIConstants.IMG_ACTIVATE, LOCALTOOL + "activate.gif"); //$NON-NLS-1$
  82                 declareRegistryImage(IExternalToolsUIConstants.IMG_DEACTIVATE, LOCALTOOL + "deactivate.gif"); //$NON-NLS-1$
  83                 declareRegistryImage(IExternalToolsUIConstants.IMG_GO_TO_FILE, LOCALTOOL + "gotoobj_tsk.gif"); //$NON-NLS-1$
  84                 // Ant View Labels
  85 //              declareRegistryImage(IExternalToolsUIConstants.IMG_ANT_PROJECT, OBJECT + "file_obj.gif"); //$NON-NLS-1$
  86 //              declareRegistryImage(IExternalToolsUIConstants.IMG_ANT_PROJECT_ERROR, LOCALTOOL + "ant_project_err.gif"); //$NON-NLS-1$
  87 //              declareRegistryImage(IExternalToolsUIConstants.IMG_ANT_TARGET, LOCALTOOL + "ant_target.gif"); //$NON-NLS-1$
  88 //              declareRegistryImage(IExternalToolsUIConstants.IMG_ANT_TARGET_ERROR, LOCALTOOL + "error.gif"); //$NON-NLS-1$
  89 //              declareRegistryImage(IExternalToolsUIConstants.IMG_ANT_TARGET_ELEMENTS, LOCALTOOL + "elements.gif"); //$NON-NLS-1$
  90 //              declareRegistryImage(IExternalToolsUIConstants.IMG_ANT_TARGET_ELEMENT, LOCALTOOL + "element.gif"); //$NON-NLS-1$
  91                 // Wizards
  92                 declareRegistryImage(IExternalToolConstants.IMG_WIZBAN_EXTERNAL_TOOLS, WIZBAN + "ext_tools_wiz.gif"); //$NON-NLS-1$
  93
  94                 // Actions
  95                 declareRegistryImage(IExternalToolConstants.IMG_ACTION_REFRESH, LOCALTOOL + "refresh.gif"); //$NON-NLS-1$
  96
  97                 // Objects
  98                 declareRegistryImage(IExternalToolConstants.IMG_TAB_MAIN, OBJECT + "main_tab.gif"); //$NON-NLS-1$
  99                 declareRegistryImage(IExternalToolConstants.IMG_TAB_OPTIONS, OBJECT + "options_tab.gif"); //$NON-NLS-1$
 100
 101                 //ANT object
 102                 declareRegistryImage(IExternalToolConstants.IMG_TAB_ANT_TARGETS, LOCALTOOL + "ant_tsk_check.gif"); //$NON-NLS-1$
 103         }
 104
 105         /**
 106          * Declare an Image in the registry table.
 107          * @param key   The key to use when registering the image
 108          * @param path  The path where the image can be found. This path is relative to where
 109          *                              this plugin class is found (i.e. typically the packages directory)
 110          */
 111         private final static void declareRegistryImage(String key, String path) {
 112                 ImageDescriptor desc= ImageDescriptor.getMissingImageDescriptor();
 113                 try {
 114                         desc= ImageDescriptor.createFromURL(makeIconFileURL(path));
 115                 } catch (MalformedURLException me) {
 116                         //ExternalToolsPlugin.log(me);
 117                 }
 118                 imageRegistry.put(key, desc);
 119                 imageDescriptors.put(key, desc);
 120         }
 121
 122         /**
 123          * Returns the ImageRegistry.
 124          */
 125         public static ImageRegistry getImageRegistry() {
 126                 if (imageRegistry == null) {
 127                         initializeImageRegistry();
 128                 }
 129                 return imageRegistry;
 130         }
 131
 132         /**
 133          *      Initialize the image registry by declaring all of the required
 134          *      graphics. This involves creating JFace image descriptors describing
 135          *      how to create/find the image should it be needed.
 136          *      The image is not actually allocated until requested.
 137          *
 138          *      Prefix conventions
 139          *              Wizard Banners                  WIZBAN_
 140          *              Preference Banners              PREF_BAN_
 141          *              Property Page Banners   PROPBAN_
 142          *              Color toolbar                   CTOOL_
 143          *              Enable toolbar                  ETOOL_
 144          *              Disable toolbar                 DTOOL_
 145          *              Local enabled toolbar   ELCL_
 146          *              Local Disable toolbar   DLCL_
 147          *              Object large                    OBJL_
 148          *              Object small                    OBJS_
 149          *              View                                    VIEW_
 150          *              Product images                  PROD_
 151          *              Misc images                             MISC_
 152          *
 153          *      Where are the images?
 154          *              The images (typically gifs) are found in the same location as this plugin class.
 155          *              This may mean the same package directory as the package holding this class.
 156          *              The images are declared using this.getClass() to ensure they are looked up via
 157          *              this plugin class.
 158          *      @see JFace's ImageRegistry
 159          */
 160         public static ImageRegistry initializeImageRegistry() {
 161                 imageRegistry= new ImageRegistry(ExternalToolsPlugin.getStandardDisplay());
 162                 imageDescriptors = new HashMap(30);
 163                 declareImages();
 164                 return imageRegistry;
 165         }
 166
 167         /**
 168          * Returns the <code>Image<code> identified by the given key,
 169          * or <code>null</code> if it does not exist.
 170          */
 171         public static Image getImage(String key) {
 172                 return getImageRegistry().get(key);
 173         }
 174
 175         /**
 176          * Returns the <code>ImageDescriptor<code> identified by the given key,
 177          * or <code>null</code> if it does not exist.
 178          */
 179         public static ImageDescriptor getImageDescriptor(String key) {
 180                 if (imageDescriptors == null) {
 181                         initializeImageRegistry();
 182                 }
 183                 return (ImageDescriptor)imageDescriptors.get(key);
 184         }
 185
 186         private static URL makeIconFileURL(String iconPath) throws MalformedURLException {
 187                 if (ICON_BASE_URL == null) {
 188                         throw new MalformedURLException();
 189                 }
 190
 191                 return new URL(ICON_BASE_URL, iconPath);
 192         }
 193 }
 194
 195