org.dishevelled.iconbundle
Interface IconBundle

All Known Implementing Classes:

CachingIconBundle, PNGIconBundle, ShapeIconBundle, SVGIconBundle

public interface IconBundle

A bundle of variants of a particular icon image, for different text directions, sizes, and states. IconBundles are expected to dynamically create variants for which a source image does not exist, by rescaling or transforming existing images.

Version:

$Revision: 404 $ $Date: 2008-01-02 13:19:59 -0600 (Wed, 02 Jan 2008) $

Author:

Michael Heuer

Method Summary

java.awt.Image

getImage(java.awt.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.

Method Detail

getImage

java.awt.Image getImage(java.awt.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.

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