net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/ui/PHPUiImages.java

   1 package net.sourceforge.phpdt.internal.ui;
   2
   3 import java.net.MalformedURLException;
   4 import java.net.URL;
   5
   6 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
   7 import org.eclipse.jface.action.IAction;
   8 import org.eclipse.jface.resource.ImageDescriptor;
   9 import org.eclipse.jface.resource.ImageRegistry;
  10 import org.eclipse.swt.graphics.Image;
  11
  12 public class PHPUiImages {
  13
  14         protected static final String NAME_PREFIX = "net.sourceforge.phpdt.internal.ui.";
  15         protected static final int NAME_PREFIX_LENGTH = NAME_PREFIX.length();
  16
  17         protected static URL iconBaseURL;
  18
  19         static {
  20                 String pathSuffix = "icons/";
  21                 try {
  22                         iconBaseURL = new URL(PHPeclipsePlugin.getDefault().getDescriptor().getInstallURL(), pathSuffix);
  23                 } catch (MalformedURLException e) {
  24                         PHPeclipsePlugin.log(e);
  25                 }
  26         }
  27
  28         protected static final ImageRegistry IMAGE_REGISTRY = new ImageRegistry();
  29
  30         protected static final String OBJ_PREFIX = "obj16";
  31         protected static final String OVR_PREFIX = "ovr16";
  32         protected static final String CTOOL_PREFIX = "ctool16";
  33
  34   public static final String IMG_CLASS = NAME_PREFIX + "class_obj.gif";
  35   public static final String IMG_BUILTIN = NAME_PREFIX + "builtin_obj.gif";
  36   public static final String IMG_FUN = NAME_PREFIX + "fun_obj.gif";
  37   public static final String IMG_INC = NAME_PREFIX + "impc_obj.gif";
  38   public static final String IMG_VAR = NAME_PREFIX + "var_obj.gif";
  39         public static final String IMG_OBJS_ERROR = NAME_PREFIX + "error_obj.gif";
  40         public static final String IMG_OBJS_WARNING = NAME_PREFIX + "warning_obj.gif";
  41         public static final String IMG_OBJS_INFO = NAME_PREFIX + "info_obj.gif";
  42         public static final String IMG_CTOOLS_PHP_PAGE = NAME_PREFIX + "php_page.gif";
  43         public static final String IMG_CTOOLS_PHP = NAME_PREFIX + "php.gif";
  44
  45   public static final String IMG_OBJS_TEMPLATE= NAME_PREFIX + "template_obj.gif";
  46
  47   public static final ImageDescriptor DESC_CLASS = createManaged(OBJ_PREFIX, IMG_CLASS);
  48   public static final ImageDescriptor DESC_BUILTIN = createManaged(OBJ_PREFIX, IMG_BUILTIN);
  49   public static final ImageDescriptor DESC_FUN = createManaged(OBJ_PREFIX, IMG_FUN);
  50   public static final ImageDescriptor DESC_INC = createManaged(OBJ_PREFIX, IMG_INC);
  51         public static final ImageDescriptor DESC_VAR = createManaged(OBJ_PREFIX, IMG_VAR);
  52   public static final ImageDescriptor DESC_OBJS_ERROR = createManaged(OBJ_PREFIX, IMG_OBJS_ERROR);
  53         public static final ImageDescriptor DESC_OBJS_WARNING = createManaged(OBJ_PREFIX, IMG_OBJS_WARNING);
  54         public static final ImageDescriptor DESC_OBJS_INFO = createManaged(OBJ_PREFIX, IMG_OBJS_INFO);
  55         public static final ImageDescriptor DESC_CTOOL_PHP_PAGE = createManaged(CTOOL_PREFIX, IMG_CTOOLS_PHP_PAGE);
  56         public static final ImageDescriptor DESC_CTOOL_PHP = createManaged(CTOOL_PREFIX, IMG_CTOOLS_PHP);
  57
  58   public static final ImageDescriptor DESC_OBJS_TEMPLATE= createManaged(OBJ_PREFIX, IMG_OBJS_TEMPLATE);
  59
  60         /**
  61          * Returns the image managed under the given key in this registry.
  62          *
  63          * @param key the image's key
  64          * @return the image managed under the given key
  65          */
  66         public static Image get(String key) {
  67                 return IMAGE_REGISTRY.get(key);
  68         }
  69
  70         /**
  71          * Sets the three image descriptors for enabled, disabled, and hovered to an action. The actions
  72          * are retrieved from the *tool16 folders.
  73          */
  74         public static void setToolImageDescriptors(IAction action, String iconName) {
  75                 setImageDescriptors(action, "tool16", iconName);
  76         }
  77
  78         /**
  79          * Sets the three image descriptors for enabled, disabled, and hovered to an action. The actions
  80          * are retrieved from the *lcl16 folders.
  81          */
  82         public static void setLocalImageDescriptors(IAction action, String iconName) {
  83                 setImageDescriptors(action, "lcl16", iconName);
  84         }
  85
  86         public static ImageRegistry getImageRegistry() {
  87                 return IMAGE_REGISTRY;
  88         }
  89
  90         //---- Helper methods to access icons on the file system --------------------------------------
  91
  92         protected static void setImageDescriptors(IAction action, String type, String relPath) {
  93
  94                 try {
  95                         ImageDescriptor id = ImageDescriptor.createFromURL(makeIconFileURL("d" + type, relPath));
  96                         if (id != null)
  97                                 action.setDisabledImageDescriptor(id);
  98                 } catch (MalformedURLException e) {}
  99
 100                 try {
 101                         ImageDescriptor id = ImageDescriptor.createFromURL(makeIconFileURL("c" + type, relPath));
 102                         if (id != null)
 103                                 action.setHoverImageDescriptor(id);
 104                 } catch (MalformedURLException e) {}
 105
 106                 action.setImageDescriptor(create("e" + type, relPath));
 107         }
 108
 109         protected static ImageDescriptor createManaged(String prefix, String name) {
 110                 try {
 111                         ImageDescriptor result = ImageDescriptor.createFromURL(makeIconFileURL(prefix, name.substring(NAME_PREFIX_LENGTH)));
 112                         IMAGE_REGISTRY.put(name, result);
 113                         return result;
 114                 } catch (MalformedURLException e) {
 115                         return ImageDescriptor.getMissingImageDescriptor();
 116                 }
 117         }
 118
 119         protected static ImageDescriptor create(String prefix, String name) {
 120                 try {
 121                         return ImageDescriptor.createFromURL(makeIconFileURL(prefix, name));
 122                 } catch (MalformedURLException e) {
 123                         return ImageDescriptor.getMissingImageDescriptor();
 124                 }
 125         }
 126
 127         protected static URL makeIconFileURL(String prefix, String name) throws MalformedURLException {
 128                 if (iconBaseURL == null)
 129                         throw new MalformedURLException();
 130
 131                 StringBuffer buffer = new StringBuffer(prefix);
 132                 buffer.append('/');
 133                 buffer.append(name);
 134                 return new URL(iconBaseURL, buffer.toString());
 135         }
 136 }