001: /*--
002:
003: Copyright (C) 2000-2003 Anthony Eden.
004: All rights reserved.
005:
006: Redistribution and use in source and binary forms, with or without
007: modification, are permitted provided that the following conditions
008: are met:
009:
010: 1. Redistributions of source code must retain the above copyright
011: notice, this list of conditions, and the following disclaimer.
012:
013: 2. Redistributions in binary form must reproduce the above copyright
014: notice, this list of conditions, and the disclaimer that follows
015: these conditions in the documentation and/or other materials
016: provided with the distribution.
017:
018: 3. The name "EdenLib" must not be used to endorse or promote products
019: derived from this software without prior written permission. For
020: written permission, please contact me@anthonyeden.com.
021:
022: 4. Products derived from this software may not be called "EdenLib", nor
023: may "EdenLib" appear in their name, without prior written permission
024: from Anthony Eden (me@anthonyeden.com).
025:
026: In addition, I request (but do not require) that you include in the
027: end-user documentation provided with the redistribution and/or in the
028: software itself an acknowledgement equivalent to the following:
029: "This product includes software developed by
030: Anthony Eden (http://www.anthonyeden.com/)."
031:
032: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
033: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
034: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
035: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
036: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
037: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
038: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
039: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
040: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
041: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
042: POSSIBILITY OF SUCH DAMAGE.
043:
044: For more information on EdenLib, please see <http://edenlib.sf.net/>.
045:
046: */
047:
048: package com.anthonyeden.lib.util;
049:
050: import java.net.URL;
051: import java.util.Map;
052: import java.util.HashMap;
053:
054: import javax.swing.Icon;
055: import javax.swing.ImageIcon;
056:
057: import org.apache.commons.logging.Log;
058: import org.apache.commons.logging.LogFactory;
059:
060: /** The IconManager provides a central location for loading and caching
061: Icons loaded from the class loader as resources.
062:
063: @author Anthony Eden
064: */
065:
066: public class IconManager {
067:
068: private static Log log = LogFactory.getLog(IconManager.class);
069: private static String defaultBasePath = "";
070: private static HashMap icons;
071:
072: private String basePath = "";
073:
074: /** Default constructor. The base path will be set to the value returned from
075: the <code>getDefaultBasePath()</code> method.
076: */
077:
078: public IconManager() {
079: setBasePath(getDefaultBasePath());
080: }
081:
082: /** Construct an IconManager with the given base path.
083:
084: @param basePath The base path
085: */
086:
087: public IconManager(String basePath) {
088: setBasePath(basePath);
089: }
090:
091: /** Get the base path for finding icons. The base path should be a relative
092: path with the '/' character as a separator.
093:
094: @return The base path
095: */
096:
097: public String getBasePath() {
098: return basePath;
099: }
100:
101: /** Set the base path for finding icons. The base path should be a relative
102: path with the '/' character as a separator.
103:
104: @param basePath The base path
105: */
106:
107: public void setBasePath(String basePath) {
108: if (basePath == null) {
109: basePath = "";
110: }
111: this .basePath = basePath;
112: }
113:
114: /** Get the icon at the given path. The path should point to a GIF in the class
115: path. If no image is located at the given location, then this method returns
116: null.
117:
118: @return An icon or null
119: */
120:
121: public Icon getIcon(String path) {
122: path = basePath + path;
123:
124: Map icons = getIcons();
125: Icon icon = (Icon) icons.get(path);
126: if (icon == null) {
127: log.debug("Loading icon: " + path);
128: URL resourceURL = ClassUtilities.getResource(path, this );
129: if (resourceURL != null) {
130: log.debug("Icon resource URL: " + resourceURL);
131: icon = new ImageIcon(resourceURL);
132: icons.put(path, icon);
133: } else {
134: return null;
135: }
136: }
137: return icon;
138: }
139:
140: /** Get the default base path for loading icons. The value
141: of defaultBasePath will be appended to the <code>path</code>
142: argument of <code>getIcon</code> if the base path of the current
143: IconManager instance is not set. By default the value is an
144: empty String.
145:
146: @return The default base path
147: */
148:
149: public static String getDefaultBasePath() {
150: return defaultBasePath;
151: }
152:
153: /** Set the default base path for loading icons. The value
154: of defaultBasePath will be appended to the <code>path</code>
155: argument of <code>getIcon</code> if the base path of the current
156: IconManager instance is not set. By default the value is an
157: empty String.
158:
159: @param _defaultBasePath The default base path
160: */
161:
162: public static void setDefaultBasePath(String _defaultBasePath) {
163: defaultBasePath = _defaultBasePath;
164: }
165:
166: /** Get a Map of all cached icons.
167:
168: @return The cached icon Map
169: */
170:
171: protected static synchronized Map getIcons() {
172: if (icons == null) {
173: icons = new HashMap();
174: }
175: return icons;
176: }
177:
178: }
|