From: Laurent E. <let...@us...> - 2003-08-08 23:10:13
|
User: letiemble Date: 03/08/08 16:10:13 Modified: jbosside/org.jboss.ide.eclipse.xdoclet.ui/src/org/jboss/ide/eclipse/xdoclet/ui XDocletUIImages.java Log: Export the runtime jars and adjust classpath Revision Changes Path 1.4 +213 -213 contrib/jbosside/org.jboss.ide.eclipse.xdoclet.ui/src/org/jboss/ide/eclipse/xdoclet/ui/XDocletUIImages.java Index: XDocletUIImages.java =================================================================== RCS file: /cvsroot/jboss/contrib/jbosside/org.jboss.ide.eclipse.xdoclet.ui/src/org/jboss/ide/eclipse/xdoclet/ui/XDocletUIImages.java,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- XDocletUIImages.java 29 Jul 2003 21:12:44 -0000 1.3 +++ XDocletUIImages.java 8 Aug 2003 23:10:13 -0000 1.4 @@ -1,213 +1,213 @@ -/* - * JBoss, the OpenSource J2EE webOS - * - * Distributable under LGPL license. - * See terms of license at www.gnu.org. - */ -package org.jboss.ide.eclipse.xdoclet.ui; - -import java.net.MalformedURLException; -import java.net.URL; -import java.util.HashMap; - -import org.eclipse.jface.resource.ImageDescriptor; -import org.eclipse.jface.resource.ImageRegistry; -import org.eclipse.swt.graphics.Image; - - -/** - * Image registry that holds shared images for XDoclet plugins. - * - * @author Laurent Etiemble - * @created 24 juin 2003 - * @version $Revision: 1.3 $ - */ -public class XDocletUIImages -{ - /** Declare Common paths */ - protected static URL ICON_BASE_URL = null; - /** A table of all the <code>ImageDescriptor</code>s. */ - protected static HashMap imageDescriptors; - /** The image registry containing <code>Image</code>s. */ - protected static ImageRegistry imageRegistry; - - /** basic toolbar - size 16x16 */ - protected final static String CTOOL = "ctool16/";//$NON-NLS-1$ - /** disabled toolbar - size 16x16 */ - protected final static String DLCL = "dlcl16/";//$NON-NLS-1$ - /** disabled colors - size 16x16 */ - protected final static String DTOOL = "dtool16/";//$NON-NLS-1$ - /** basic colors - size 16x16 */ - protected final static String ELCL = "elcl16/";//$NON-NLS-1$ - /** enabled - size 16x16 */ - protected final static String LOCALTOOL = "clcl16/";//$NON-NLS-1$ - /** basic colors - size 16x16 */ - protected final static String OBJECT = "obj16/";//$NON-NLS-1$ - /** basic colors - size 7x8 */ - protected final static String OVR = "ovr16/";//$NON-NLS-1$ - /** basic colors - size 16x16 */ - protected final static String VIEW = "cview16/";//$NON-NLS-1$ - /** wizard banners */ - protected final static String WIZBAN = "wizban/";//$NON-NLS-1$ - - - /** - * Returns the <code>Image<code> identified by the given key, - * or <code>null</code> if it does not exist. - * - * @param key Description of the Parameter - * @return The image value - */ - public static Image getImage(String key) - { - return getImageRegistry().get(key); - } - - - /** - * Returns the <code>ImageDescriptor<code> identified by the given key, - * or <code>null</code> if it does not exist. - * - * @param key Description of the Parameter - * @return The imageDescriptor value - */ - public static ImageDescriptor getImageDescriptor(String key) - { - if (imageDescriptors == null) - { - initializeImageRegistry(); - } - return (ImageDescriptor) imageDescriptors.get(key); - } - - - /** - * Returns the ImageRegistry. - * - * @return The imageRegistry value - */ - public static ImageRegistry getImageRegistry() - { - if (imageRegistry == null) - { - initializeImageRegistry(); - } - return imageRegistry; - } - - - /** - * Initialize the image registry by declaring all of the required - * graphics. This involves creating JFace image descriptors describing - * how to create/find the image should it be needed. - * The image is not actually allocated until requested. - * - * Prefix conventions - * Wizard Banners WIZBAN_ - * Preference Banners PREF_BAN_ - * Property Page Banners PROPBAN_ - * Color toolbar CTOOL_ - * Enable toolbar ETOOL_ - * Disable toolbar DTOOL_ - * Local enabled toolbar ELCL_ - * Local Disable toolbar DLCL_ - * Object large OBJL_ - * Object small OBJS_ - * View VIEW_ - * Product images PROD_ - * Misc images MISC_ - * - * Where are the images? - * The images (typically gifs) are found in the same location as this plugin class. - * This may mean the same package directory as the package holding this class. - * The images are declared using this.getClass() to ensure they are looked up via - * this plugin class. - * - * @return Description of the Return Value - * @see JFace's ImageRegistry - */ - public static ImageRegistry initializeImageRegistry() - { - imageRegistry = new ImageRegistry(XDocletUIPlugin.getStandardDisplay()); - imageDescriptors = new HashMap(30); - declareImages(); - return imageRegistry; - } - - - /** Declare all images */ - protected static void declareImages() - { - // Objects - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_COMMAND, OBJECT + "command.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_CONTEXT_ELEMENT, OBJECT + "contextelement.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_CONTEXT_GROUP, OBJECT + "contextgroup.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_DISCRETE_ATTRIBUTE, OBJECT + "discrete_attribute.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_NAMESPACE, OBJECT + "namespace.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_NON_DISCRETE_ATTRIBUTE, OBJECT + "non_discrete_attribute.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_TEMPLATE, OBJECT + "template.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_TEMPLATE_TREE, OBJECT + "templatetree.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_VALUE, OBJECT + "value.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_VALUE_VARIABLE, OBJECT + "value_with_variable.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_XDOCLET_CONF, OBJECT + "xdoclet_conf.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_XDOCLET_SUBTASK, OBJECT + "xdoclet_subtask.gif");//$NON-NLS-1$ - declareRegistryImage(IXDocletUIConstants.IMG_OBJS_XDOCLET_TASK, OBJECT + "xdoclet_task.gif");//$NON-NLS-1$ - } - - - /** - * Create an URL from a path - * - * @param iconPath Path of the icon - * @return The URL - * @exception MalformedURLException If the URL cannot be build - */ - protected static URL makeIconFileURL(String iconPath) - throws MalformedURLException - { - if (ICON_BASE_URL == null) - { - throw new MalformedURLException(); - } - - return new URL(ICON_BASE_URL, iconPath); - } - - - /** - * Declare an Image in the registry table. - * - * @param key The key to use when registering the image - * @param path The path where the image can be found. This path is relative to where - * this plugin class is found (i.e. typically the packages directory) - */ - protected final static void declareRegistryImage(String key, String path) - { - ImageDescriptor desc = ImageDescriptor.getMissingImageDescriptor(); - try - { - desc = ImageDescriptor.createFromURL(makeIconFileURL(path)); - } - catch (MalformedURLException me) - { - XDocletUIPlugin.log(me); - } - imageRegistry.put(key, desc); - imageDescriptors.put(key, desc); - } - - /** Define base URL from plugin installation directory */ - static - { - String pathSuffix = "icons/full/";//$NON-NLS-1$ - - try - { - ICON_BASE_URL = new URL(XDocletUIPlugin.getDefault().getDescriptor().getInstallURL(), pathSuffix); - } - catch (MalformedURLException e) - { - // do nothing - } - } -} +/* + * JBoss, the OpenSource J2EE webOS + * + * Distributable under LGPL license. + * See terms of license at www.gnu.org. + */ +package org.jboss.ide.eclipse.xdoclet.ui; + +import java.net.MalformedURLException; +import java.net.URL; +import java.util.HashMap; + +import org.eclipse.jface.resource.ImageDescriptor; +import org.eclipse.jface.resource.ImageRegistry; +import org.eclipse.swt.graphics.Image; + + +/** + * Image registry that holds shared images for XDoclet plugins. + * + * @author Laurent Etiemble + * @created 24 juin 2003 + * @version $Revision: 1.4 $ + */ +public class XDocletUIImages +{ + /** Declare Common paths */ + protected static URL ICON_BASE_URL = null; + /** A table of all the <code>ImageDescriptor</code>s. */ + protected static HashMap imageDescriptors; + /** The image registry containing <code>Image</code>s. */ + protected static ImageRegistry imageRegistry; + + /** basic toolbar - size 16x16 */ + protected final static String CTOOL = "ctool16/";//$NON-NLS-1$ + /** disabled toolbar - size 16x16 */ + protected final static String DLCL = "dlcl16/";//$NON-NLS-1$ + /** disabled colors - size 16x16 */ + protected final static String DTOOL = "dtool16/";//$NON-NLS-1$ + /** basic colors - size 16x16 */ + protected final static String ELCL = "elcl16/";//$NON-NLS-1$ + /** enabled - size 16x16 */ + protected final static String LOCALTOOL = "clcl16/";//$NON-NLS-1$ + /** basic colors - size 16x16 */ + protected final static String OBJECT = "obj16/";//$NON-NLS-1$ + /** basic colors - size 7x8 */ + protected final static String OVR = "ovr16/";//$NON-NLS-1$ + /** basic colors - size 16x16 */ + protected final static String VIEW = "cview16/";//$NON-NLS-1$ + /** wizard banners */ + protected final static String WIZBAN = "wizban/";//$NON-NLS-1$ + + + /** + * Returns the <code>Image<code> identified by the given key, + * or <code>null</code> if it does not exist. + * + * @param key Description of the Parameter + * @return The image value + */ + public static Image getImage(String key) + { + return getImageRegistry().get(key); + } + + + /** + * Returns the <code>ImageDescriptor<code> identified by the given key, + * or <code>null</code> if it does not exist. + * + * @param key Description of the Parameter + * @return The imageDescriptor value + */ + public static ImageDescriptor getImageDescriptor(String key) + { + if (imageDescriptors == null) + { + initializeImageRegistry(); + } + return (ImageDescriptor) imageDescriptors.get(key); + } + + + /** + * Returns the ImageRegistry. + * + * @return The imageRegistry value + */ + public static ImageRegistry getImageRegistry() + { + if (imageRegistry == null) + { + initializeImageRegistry(); + } + return imageRegistry; + } + + + /** + * Initialize the image registry by declaring all of the required + * graphics. This involves creating JFace image descriptors describing + * how to create/find the image should it be needed. + * The image is not actually allocated until requested. + * + * Prefix conventions + * Wizard Banners WIZBAN_ + * Preference Banners PREF_BAN_ + * Property Page Banners PROPBAN_ + * Color toolbar CTOOL_ + * Enable toolbar ETOOL_ + * Disable toolbar DTOOL_ + * Local enabled toolbar ELCL_ + * Local Disable toolbar DLCL_ + * Object large OBJL_ + * Object small OBJS_ + * View VIEW_ + * Product images PROD_ + * Misc images MISC_ + * + * Where are the images? + * The images (typically gifs) are found in the same location as this plugin class. + * This may mean the same package directory as the package holding this class. + * The images are declared using this.getClass() to ensure they are looked up via + * this plugin class. + * + * @return Description of the Return Value + * @see JFace's ImageRegistry + */ + public static ImageRegistry initializeImageRegistry() + { + imageRegistry = new ImageRegistry(XDocletUIPlugin.getStandardDisplay()); + imageDescriptors = new HashMap(30); + declareImages(); + return imageRegistry; + } + + + /** Declare all images */ + protected static void declareImages() + { + // Objects + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_COMMAND, OBJECT + "command.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_CONTEXT_ELEMENT, OBJECT + "contextelement.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_CONTEXT_GROUP, OBJECT + "contextgroup.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_DISCRETE_ATTRIBUTE, OBJECT + "discrete_attribute.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_NAMESPACE, OBJECT + "namespace.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_NON_DISCRETE_ATTRIBUTE, OBJECT + "non_discrete_attribute.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_TEMPLATE, OBJECT + "template.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_TEMPLATE_TREE, OBJECT + "templatetree.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_VALUE, OBJECT + "value.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_VALUE_VARIABLE, OBJECT + "value_with_variable.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_XDOCLET_CONF, OBJECT + "xdoclet_conf.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_XDOCLET_SUBTASK, OBJECT + "xdoclet_subtask.gif");//$NON-NLS-1$ + declareRegistryImage(IXDocletUIConstants.IMG_OBJS_XDOCLET_TASK, OBJECT + "xdoclet_task.gif");//$NON-NLS-1$ + } + + + /** + * Create an URL from a path + * + * @param iconPath Path of the icon + * @return The URL + * @exception MalformedURLException If the URL cannot be build + */ + protected static URL makeIconFileURL(String iconPath) + throws MalformedURLException + { + if (ICON_BASE_URL == null) + { + throw new MalformedURLException(); + } + + return new URL(ICON_BASE_URL, iconPath); + } + + + /** + * Declare an Image in the registry table. + * + * @param key The key to use when registering the image + * @param path The path where the image can be found. This path is relative to where + * this plugin class is found (i.e. typically the packages directory) + */ + protected final static void declareRegistryImage(String key, String path) + { + ImageDescriptor desc = ImageDescriptor.getMissingImageDescriptor(); + try + { + desc = ImageDescriptor.createFromURL(makeIconFileURL(path)); + } + catch (MalformedURLException me) + { + XDocletUIPlugin.log(me); + } + imageRegistry.put(key, desc); + imageDescriptors.put(key, desc); + } + + /** Define base URL from plugin installation directory */ + static + { + String pathSuffix = "icons/full/";//$NON-NLS-1$ + + try + { + ICON_BASE_URL = new URL(XDocletUIPlugin.getDefault().getDescriptor().getInstallURL(), pathSuffix); + } + catch (MalformedURLException e) + { + // do nothing + } + } +} |