/*
* org.openmicroscopy.shoola.util.ui.ColourIcon
*
*------------------------------------------------------------------------------
* Copyright (C) 2006-2008 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.awt.Color;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.Graphics2D;
import javax.swing.Icon;
//Third-party libraries
//Application-internal dependencies
/**
* Used to color items as icons.
*
* @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 3.0-Beta3
*/
public class ColourIcon
implements Icon
{
/** The default width of the icon. */
public static final int DEFAULT_WIDTH = 16;
/** The default height of the icon. */
public static final int DEFAULT_HEIGHT = 16;
/** The default color of the border. */
private static final Color BORDER_COLOR = Color.BLACK;
/** Colour of the icon */
private Color colour;
/** The height of the icon. */
private int height;
/** The width of the icon. */
private int width;
/** Flag indicating to paint a line border. */
private boolean paintLineBorder;
/** The color of the line border. */
private Color borderColor;
/** Creates a default icon. */
public ColourIcon()
{
this(DEFAULT_WIDTH, DEFAULT_HEIGHT);
}
/**
* Creates a new instance.
*
* @param color The color to paint.
*/
public ColourIcon(Color color)
{
this(DEFAULT_WIDTH, DEFAULT_HEIGHT, color);
}
/**
* Creates a new instance.
*
* @param d The dimension of the icon.
*/
public ColourIcon(Dimension d)
{
this(d, null);
}
/**
* Creates a new instance.
*
* @param width The width of the icon.
* @param height The height of the icon.
*/
public ColourIcon(int width, int height)
{
this(new Dimension(width, height), null);
}
/**
* Creates a new instance.
*
* @param width The width of the icon.
* @param height The height of the icon.
* @param color The color to paint.
*/
public ColourIcon(int width, int height, Color color)
{
this(new Dimension(width, height), color);
}
/**
* Creates a new instance.
*
* @param d The dimension of the icon.
* @param color The color to paint.
*/
public ColourIcon(Dimension d, Color color)
{
borderColor = BORDER_COLOR;
paintLineBorder = false;
if (d == null) {
width = DEFAULT_WIDTH;
height = DEFAULT_HEIGHT;
} else {
width = d.width;
height = d.height;
}
if (width <= 0) width = DEFAULT_WIDTH;
if (height <= 0) height = DEFAULT_HEIGHT;
setColour(color);
}
/**
* Sets to <code>true</code> if a line border is painted,
* <code>false</code> otherwise.
*
* @param paintLineBorder Pass <code>true</code> to paint the line border.
* <code>false</code> otherwise.
*/
public void paintLineBorder(boolean paintLineBorder)
{
this.paintLineBorder = paintLineBorder;
}
/**
* Sets the colour of the icon.
*
* @param c The colour to set.
*/
public void setColour(Color c)
{
colour = c;
//if (colour != null && colour.getAlpha() == 0)
// colour = new Color(c.getRGB());
}
/**
* Overridden to return the set height of the icon.
* @see Icon#getIconHeight()
*/
public int getIconHeight() { return height; }
/**
* Overridden to return the set width of the icon.
* @see Icon#getIconWidth()
*/
public int getIconWidth() { return width; }
/**
* Overridden to paint filled colour icon.
* @see Icon#paintIcon(Component, Graphics, int, int)
*/
public void paintIcon(Component c, Graphics g, int x, int y)
{
Graphics2D g2D = (Graphics2D) g;
if (colour != null) {
g2D.setColor(colour);
g2D.fillRect(4, 4, width-2, height-2);
g2D.drawRect(4, 4, width-2, height-2);
if (paintLineBorder) {
g2D.setColor(borderColor);
g2D.drawRect(3, 3, width, height);
}
/*
g2D.fillRect(4, 4, width-3, height-3);
g2D.setColor(colour.darker());
g2D.drawRect(4, 4, width-3, height-3);
*/
}
}
}