org.dishevelled.iconbundle.impl
Class PNGIconBundle

java.lang.Object
  org.dishevelled.iconbundle.impl.PNGIconBundle

All Implemented Interfaces:

IconBundle

public final class PNGIconBundle
extends Object
implements IconBundle

Icon bundle derived from a single base image in PNG format.

Version:

$Revision: 974 $ $Date: 2011-01-04 21:40:23 -0600 (Tue, 04 Jan 2011) $

Author:

Michael Heuer

Constructor Summary

PNGIconBundle(File file)
Create a new PNG icon bundle from a base image that will be read from the specified file.

PNGIconBundle(ImageInputStream imageInputStream)
Create a new PNG icon bundle from a base image that will be read from the specified image input stream.

PNGIconBundle(InputStream inputStream)
Create a new PNG icon bundle from a base image that will be read from the specified input stream.

PNGIconBundle(String baseImageName)
Create a new PNG icon bundle from a base image name.

PNGIconBundle(URL url)
Create a new PNG icon bundle from a base image that will be read from the specified URL.

Method Summary

Image

getImage(Component component, IconTextDirection direction, IconState state, IconSize size) Return an icon image in the specified icon text direction, size, and state suitable for the specified component.

Methods inherited from class java.lang.Object

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

Constructor Detail

PNGIconBundle

public PNGIconBundle(File file)

Create a new PNG icon bundle from a base image that will be read from the specified file.

Parameters:

file - file, must not be null

PNGIconBundle

public PNGIconBundle(InputStream inputStream)

Create a new PNG icon bundle from a base image that will be read from the specified input stream.

Parameters:

inputStream - input stream, must not be null

PNGIconBundle

public PNGIconBundle(ImageInputStream imageInputStream)

Create a new PNG icon bundle from a base image that will be read from the specified image input stream.

Parameters:

imageInputStream - image input stream, must not be null

PNGIconBundle

public PNGIconBundle(URL url)

Create a new PNG icon bundle from a base image that will be read from the specified URL.

Parameters:

url - URL, must not be null

PNGIconBundle

public PNGIconBundle(String baseImageName)

Create a new PNG icon bundle from a base image name. The name will be used to construct an URL to a classpath resource baseImageName + iconSize.toString() + ".png".

Parameters:

baseImageName - base image name, must not be null

Method Detail

getImage

public Image getImage(Component component,
                      IconTextDirection direction,
                      IconState state,
                      IconSize size)

Return an icon image in the specified icon text direction, size, and state suitable for the specified component. The specified AWT or Swing component may be null.

Specified by:

getImage in interface IconBundle

Parameters:

component - AWT or Swing component hint, if any

direction - icon text direction, must not be null

state - icon state, must not be null

size - icon size, must not be null

Returns:

an icon image suitable for the specified component