/*
* org.openmicroscopy.shoola.util.ui.IconFactory
*
*------------------------------------------------------------------------------
* Copyright (C) 2006 University of Dundee. All rights reserved.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*------------------------------------------------------------------------------
*/
package org.openmicroscopy.shoola.util.ui;
//Java imports
import java.net.URL;
import javax.swing.Icon;
import javax.swing.ImageIcon;
//Third-party libraries
//Application-internal dependencies
/**
* We may not distribute the UI package with Shoola, so we have an internal
* factory for Icon.
*
* @author Jean-Marie Burel
* <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @author Donald MacDonald
* <a href="mailto:donald@lifesci.dundee.ac.uk">donald@lifesci.dundee.ac.uk</a>
* @version 3.0
* <small>
* (<b>Internal version:</b> $Revision: $ $Date: $)
* </small>
* @since OME2.2
*/
class IconFactory
{
/**
* Points to the directory specified by the <i>location</i> tag.
* The path is relative to the application classpath.
*/
private String location = "/org/openmicroscopy/shoola/util/ui/graphx/";
/**
* Returns the pathname of the specified file.
* The returned pathname is relative to the application classpath.
*
* @param iconFileName The file name.
* @return See above.
*/
String getResourcePathname(String iconFileName)
{
return location+iconFileName;
}
/**
* Creates an {@link Icon} from the specified file.
*
* @param name The file name. Must be a valid name within the location
* specified in the configuration file.
* @return An {@link Icon} object created from the image file.
* The return value will be <code>null</code> if the file
* couldn't be found or an image icon couldn't be created from
* that file.
*/
Icon getIcon(String name)
{
ImageIcon icon = null;
try {
String path = getResourcePathname(name);
URL url = IconFactory.class.getResource(path);
icon = new ImageIcon(url);
} catch (Exception e) {}
return icon;
}
/**
* Creates an {@link ImageIcon} from the specified file.
*
* @param name The file name. Must be a valid name within the location
* specified in the configuration file.
* @return An {@link ImageIcon} object created from the image file. The
* return value will be <code>null</code> if the file couldn't be
* found or an image icon couldn't be created from that file.
*/
ImageIcon getImageIcon(String name)
{
ImageIcon icon = null;
try {
String path = getResourcePathname(name);
URL url = IconFactory.class.getResource(path);
icon = new ImageIcon(url);
} catch (Exception e) {}
return icon;
}
}