com.xmlmind.guiutil

Class IconResource

java.lang.Object

com.xmlmind.guiutil.IconResource

All Implemented Interfaces:

Icon

public class IconResource
extends Object
implements Icon

A replacement for ImageIcon which takes into account the display scaling.

Unlike ImageIcon, this icon knows how to paint itself in "disabled" (grayed) state.

This class leverages ImageResource to manage (e.g. cache) the images used as icons.

See Also:

AWTUtil.getDisplayScaling()

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected Image	disabledImage
int	height
Image	image
boolean	isDoubleSizeImage
int	width

Constructor Summary

Constructors

Constructor and Description
IconResource(Class<?> cls, String name) Constructs an icon using specified image resource.
IconResource(Class<?> cls, String name, Color foreground, Color background) Constructs an icon using specified image resource.
IconResource(Image image) Constructs an icon using specified image.
IconResource(URL url) Constructs an icon using specified image URL.
IconResource(URL url, Color foreground, Color background) Constructs an icon using specified image URL.

Method Summary

Modifier and Type	Method and Description
static Icon	createDisabledIcon(Icon icon, JComponent comp) Create a "disabled" (grayed) icon corresponding to specified icon.
String	getDescription() Returns the description of this icon.
int	getIconHeight()
int	getIconWidth()
void	paintIcon(Component c, Graphics g, int x, int y)
void	setDescription(String description) Sets the description of this icon.
static void	setDisabledIcon(AbstractButton button, Icon icon) Configures specified button in order to use specified icon as its disabled icon.
static void	setDisabledIcon(JLabel label, Icon icon) Same as setDisabledIcon(javax.swing.AbstractButton, javax.swing.Icon) but for a JLabel.
static void	setDisabledSelectedIcon(AbstractButton button, Icon icon) Configures specified button in order to use specified icon as its disabled selected icon.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

image

public final Image image

isDoubleSizeImage

public final boolean isDoubleSizeImage

width

public final int width

height

public final int height

description

protected String description

disabledImage

protected Image disabledImage

Constructor Detail

IconResource

public IconResource(Class<?> cls,
                    String name)

Constructs an icon using specified image resource.

Parameters:

cls - the image resource belong to this class

name - filename of the image resource. Example: "myicon.png".

IconResource

public IconResource(URL url)

Constructs an icon using specified image URL.

Parameters:

url - location of the image

IconResource

public IconResource(Image image)

Constructs an icon using specified image.

IconResource

public IconResource(Class<?> cls,
                    String name,
                    Color foreground,
                    Color background)

Constructs an icon using specified image resource.

A bitonal image may be colorized using specified colors.

Parameters:

cls - the image resource belong to this class

name - filename of the image resource. Example: "myicon.png".

foreground - a new foreground color for the image. null means keep original foreground.

background - a new background color for the image. null means keep original background.

IconResource

public IconResource(URL url,
                    Color foreground,
                    Color background)

Constructs an icon using specified image URL.

A bitonal image may be colorized using specified colors.

Parameters:

url - location of the image

foreground - a new foreground color for the image. null means keep original foreground.

background - a new background color for the image. null means keep original background.

Method Detail

getIconWidth

public int getIconWidth()

Specified by:

getIconWidth in interface Icon

getIconHeight

public int getIconHeight()

Specified by:

getIconHeight in interface Icon

paintIcon

public void paintIcon(Component c,
                      Graphics g,
                      int x,
                      int y)

Specified by:

paintIcon in interface Icon

setDescription

public void setDescription(String description)

Sets the description of this icon.

Note that this is not automatically done when this icon is created out of an URL (IconResource(URL)).

getDescription

public String getDescription()

Returns the description of this icon. Returns null unless a description has been specified using setDescription(java.lang.String).

setDisabledIcon

public static void setDisabledIcon(AbstractButton button,
                                   Icon icon)

Configures specified button in order to use specified icon as its disabled icon.

This is needed when the icon is an IconResource and when the button is configured using an Action because otherwise, in this case, the disabled icon is set to null.

setDisabledIcon

public static void setDisabledIcon(JLabel label,
                                   Icon icon)

Same as setDisabledIcon(javax.swing.AbstractButton, javax.swing.Icon) but for a JLabel.

setDisabledSelectedIcon

public static void setDisabledSelectedIcon(AbstractButton button,
                                           Icon icon)

Configures specified button in order to use specified icon as its disabled selected icon.

This is needed when the icon is an IconResource and when the button is configured using an Action because otherwise, in this case, the disabled icon is set to null.

createDisabledIcon

public static Icon createDisabledIcon(Icon icon,
                                      JComponent comp)

Create a "disabled" (grayed) icon corresponding to specified icon.

Parameters:

icon - an icon

comp - the component which is to use the icon.

May be null.

Returns:

"disabled" icon when sucessfully created; original icon otherwise