org.openpnp.gui

Class AlphaImageIcon

java.lang.Object

javax.swing.ImageIcon

org.openpnp.gui.AlphaImageIcon

All Implemented Interfaces:

java.io.Serializable, javax.accessibility.Accessible, javax.swing.Icon

public class AlphaImageIcon
extends javax.swing.ImageIcon

An Icon wrapper that paints the contained icon with a specified transparency.

This class is suitable for wrapping an ImageIcon that holds an animated image. To show a non-animated Icon with transparency, the companion class AlphaIcon is a lighter alternative.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.ImageIcon

javax.swing.ImageIcon.AccessibleImageIcon

Field Summary

Fields inherited from class javax.swing.ImageIcon

component, tracker

Constructor Summary

Constructors

Constructor and Description
AlphaImageIcon(javax.swing.Icon icon, float alpha) Creates an AlphaImageIcon with the specified icon and opacity.

Method Summary

Modifier and Type	Method and Description
float	getAlpha() Gets this AlphaIcon's opacity
javax.swing.Icon	getIcon() Gets the icon wrapped by this AlphaIcon
int	getIconHeight() Gets the height of the bounding rectangle of this AlphaImageIcon.
int	getIconWidth() Gets the width of the bounding rectangle of this AlphaImageIcon.
java.awt.Image	getImage() Overridden to return the image of a wrapped ImageIcon, or null if the wrapped icon is not an ImageIcon.
int	getImageLoadStatus() Overridden to return the status of the image loading operation of a wrapped ImageIcon, or 0 if the contained icon is not an ImageIcon.
java.awt.image.ImageObserver	getImageObserver() Overridden to return the ImageObserver of the image of a wrapped ImageIcon, or null if the contained icon is not an ImageIcon.
void	paintIcon(java.awt.Component c, java.awt.Graphics g, int x, int y) Paints the wrapped icon with this AlphaImageIcon's transparency.
void	setImage(java.awt.Image image) Overridden to forward to a wrapped ImageIcon.
void	setImageObserver(java.awt.image.ImageObserver observer) Overridden to forward to a wrapped ImageIcon.

Methods inherited from class javax.swing.ImageIcon

getAccessibleContext, getDescription, loadImage, setDescription, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AlphaImageIcon

public AlphaImageIcon(javax.swing.Icon icon,
                      float alpha)

Creates an AlphaImageIcon with the specified icon and opacity. The opacity alpha should be in the range 0.0F (fully transparent) to 1.0F (fully opaque).

Parameters:

icon - the Icon to wrap

alpha - the opacity

Method Detail

getImage

public java.awt.Image getImage()

Overridden to return the image of a wrapped ImageIcon, or null if the wrapped icon is not an ImageIcon.

Overrides:

getImage in class javax.swing.ImageIcon

Returns:

the Image object for a wrapped ImageIcon, or null

setImage

public void setImage(java.awt.Image image)

Overridden to forward to a wrapped ImageIcon. Does nothing if the wrapped icon is not an ImageIcon.

In common with ImageIcom, the newly set image will only be shown when the concerned component(s) are repainted.

Overrides:

setImage in class javax.swing.ImageIcon

Parameters:

image - Sets the image displayed by a wrapped ImageIcon

getImageLoadStatus

public int getImageLoadStatus()

Overridden to return the status of the image loading operation of a wrapped ImageIcon, or 0 if the contained icon is not an ImageIcon.

Overrides:

getImageLoadStatus in class javax.swing.ImageIcon

Returns:

the loading status as defined by java.awt.MediaTracker

getImageObserver

public java.awt.image.ImageObserver getImageObserver()

Overridden to return the ImageObserver of the image of a wrapped ImageIcon, or null if the contained icon is not an ImageIcon.

Overrides:

getImageObserver in class javax.swing.ImageIcon

Returns:

the loading status as defined by java.awt.MediaTracker

setImageObserver

public void setImageObserver(java.awt.image.ImageObserver observer)

Overridden to forward to a wrapped ImageIcon. Does nothing if the wrapped icon is not an ImageIcon.

Overrides:

setImageObserver in class javax.swing.ImageIcon

Parameters:

observer - the image observer

getAlpha

public float getAlpha()

Gets this AlphaIcon's opacity

Returns:

the opacity, in the range 0.0 to 1.0

getIcon

public javax.swing.Icon getIcon()

Gets the icon wrapped by this AlphaIcon

Returns:

the wrapped icon

paintIcon

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

Paints the wrapped icon with this AlphaImageIcon's transparency.

Specified by:

paintIcon in interface javax.swing.Icon

Overrides:

paintIcon in class javax.swing.ImageIcon

Parameters:

c - The component to which the icon is painted

g - the graphics context

x - the X coordinate of the icon's top-left corner

y - the Y coordinate of the icon's top-left corner

getIconWidth

public int getIconWidth()

Gets the width of the bounding rectangle of this AlphaImageIcon. Overridden to return the width of the wrapped icom.

Specified by:

getIconWidth in interface javax.swing.Icon

Overrides:

getIconWidth in class javax.swing.ImageIcon

Returns:

the width in pixels

getIconHeight

public int getIconHeight()

Gets the height of the bounding rectangle of this AlphaImageIcon. Overridden to return the height of the wrapped icon.

Specified by:

getIconHeight in interface javax.swing.Icon

Overrides:

getIconHeight in class javax.swing.ImageIcon

Returns:

the height in pixels