001: /*
002: * uDig - User Friendly Desktop Internet GIS client
003: * http://udig.refractions.net
004: * (C) 2004, Refractions Research Inc.
005: *
006: * This library is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation;
009: * version 2.1 of the License.
010: *
011: * This library is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: *
016: */
017: package net.refractions.udig.project.ui.internal;
018:
019: import static net.refractions.udig.core.internal.Icons.DLOCALTOOL;
020: import static net.refractions.udig.core.internal.Icons.ELOCALTOOL;
021: import static net.refractions.udig.core.internal.Icons.ETOOL;
022: import static net.refractions.udig.core.internal.Icons.OBJECT;
023:
024: import org.eclipse.jface.resource.ImageDescriptor;
025:
026: /**
027: * A registry for common images which may be useful to other plug-ins.
028: * <p>
029: * This lists the <code>ImageDescriptor</code>s that are available via
030: * RegistryPlugin.getImageResource(). The fact that a constant is mentioned here, by convention,
031: * makes the associated Image part of the Plug-In API.
032: * </p>
033: * To use one of these images:
034: *
035: * <pre><code>
036: * ImageRegistry images = RegistryPlugin.getDefault().getImageRegistry();
037: * ImageDescriptor image = images.getDescriptor(ISharedImages.IMG_DATASTORE_OBJ);
038: * </code></pre>
039: *
040: * <p>
041: * This interface is not intended to be implemented by clients.
042: * </p>
043: */
044: public interface ISharedImages {
045: /**
046: * Represent a Map object.
047: */
048: public final static String MAP_OBJ = OBJECT + "map_obj.gif"; //$NON-NLS-1$
049:
050: /**
051: * Represent a Page object.
052: */
053: public final static String PAGE_OBJ = OBJECT + "page_obj.gif"; //$NON-NLS-1$
054: /**
055: * Represents a Layer object
056: */
057: public static final String LAYER_OBJ = OBJECT + "layer_obj.gif"; //$NON-NLS-1$;
058:
059: /**
060: * Represents a Map folder object
061: */
062: public static final String MAP_FOLDER_OBJ = OBJECT
063: + "mapfolder_obj.gif"; //$NON-NLS-1$;
064:
065: /**
066: * Represent a Project.
067: */
068: public final static String PROJECT_OBJ = OBJECT + "project_obj.gif"; //$NON-NLS-1$
069:
070: /** Represents the "Collapse all branches of tree" action */
071: public static final String COLLAPSE_ALL = ELOCALTOOL
072: + "collapseall_co.gif"; //$NON-NLS-1$;
073:
074: /** Represents the "Link editor focus to Project Explorer" action */
075: public static final String LINK = ELOCALTOOL + "link_co.gif"; //$NON-NLS-1$;;
076:
077: /** Represents the "Link editor focus to Project Explorer" action */
078: public static final String ACTIVE_LINK = ELOCALTOOL
079: + "link_on_co.gif"; //$NON-NLS-1$;;
080:
081: /** Represents the "Link editor focus to Project Explorer" action */
082: public static final String ADD_CO = ELOCALTOOL + "add_co.gif"; //$NON-NLS-1$;;
083:
084: /** Represents the "Collapse all branches of tree" action */
085: public static final String D_COLLAPSE_ALL = DLOCALTOOL
086: + "collapseall_co.gif"; //$NON-NLS-1$;
087:
088: /** Represents the "Collapse all branches of tree" action */
089: public static final String D_ADD_CO = DLOCALTOOL + "add_co.gif"; //$NON-NLS-1$;
090:
091: /** Represents the "Link editor focus to Project Explorer" action */
092: public static final String D_LINK = DLOCALTOOL + "link_co.gif"; //$NON-NLS-1$;;
093:
094: /** Represents the "Start new Project wizard" action */
095: public static final String NEW_PROJECT = ETOOL + "newprj_wiz.gif"; //$NON-NLS-1$
096:
097: /**
098: * Returns the image descriptor for the given image ID. Returns null if there is no such image.
099: *
100: * @param id Constant from ISharedImages
101: * @return ImageDescriptor locating resource associated with id
102: */
103: public ImageDescriptor getImageDescriptor(String id);
104:
105: }
|