com.biomatters.geneious.publicapi.plugin

Class Icons

java.lang.Object

com.biomatters.geneious.publicapi.plugin.Icons

Direct Known Subclasses:

OverlayIcons

public class Icons
extends Object

Stores a set of different sized versions of the same icon.

This is best used by construction from a single 32 x 32 icon. To get an icon from an image file you can use: "new ImageIcon(Toolkit.getDefaultToolkit().createImage(String imageFile))"

Constructor Summary

Constructors

Constructor and Description
Icons(Icon icon) Creates Icons from a single sized Icon.
Icons(Icon iconSmall, Icon iconLarge) Creates Icons from two sized Icons.

Method Summary

Methods

Modifier and Type	Method and Description
Icon	getIcon(int size) Get an icon of size * size dimensions.
Icon	getIcon16() Get a 16 * 16 pixel icon
Icon	getIcon24() Get a 24 * 24 pixel icon
Icon	getIcon32() Get a 32 * 32 pixel icon
Icon	getOriginalIcon() Get the icon used to construct this Icons object if the single parameter constructor was used, or the larger icon if the two parameter constructor was used.

Methods inherited from class java.lang.Object

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

Constructor Detail

Icons

public Icons(Icon icon)

Creates Icons from a single sized Icon. The Icon will be scaled to sizes 16 * 16 and 32 * 32 It is best to supply an Icon of 32 * 32 for image quality. It is not recommended to create Icons from a 16 * 16 Icon if 32 * 32 is to be used.

Parameters:

icon - of any size. Must not be null.

Icons

public Icons(Icon iconSmall,
     Icon iconLarge)

Creates Icons from two sized Icons. The second is assumed to be the higher resolution. Both may be resized to make them 16 * 16 and 32 * 32. If one Icon is null it will be made by resizing the other. This constructor should be used for toolbar buttons.

Parameters:

iconSmall - preferably 16 * 16 pixels. May be null only if iconLarge is not null.

iconLarge - preferably 24 * 24 pixels for actions and 32 * 32 for documents. May be null only if iconSmall is not null.

Method Detail

getIcon16

public Icon getIcon16()

Get a 16 * 16 pixel icon

Returns:

16 * 16 icon

getIcon24

public Icon getIcon24()

Get a 24 * 24 pixel icon

Returns:

24 * 24 icon

getIcon32

public Icon getIcon32()

Get a 32 * 32 pixel icon

Returns:

32 * 32 icon

getOriginalIcon

public Icon getOriginalIcon()

Get the icon used to construct this Icons object if the single parameter constructor was used, or the larger icon if the two parameter constructor was used.

Returns:

the original icon

getIcon

public Icon getIcon(int size)

Get an icon of size * size dimensions.

Parameters:

size - size in pixels of the icon to get

Returns:

an icon of size * size dimensions