net.sf.image4j.codec.ico
Class ICOImage

java.lang.Object
  net.sf.image4j.codec.bmp.BMPImage
      net.sf.image4j.codec.ico.ICOImage

public class ICOImage
extends BMPImage

Contains a decoded ICO image, as well as information about the source encoded ICO image.

Since:

0.7

Author:

Ian McDonagh

Field Summary

protected IconEntry	iconEntry
protected int	iconIndex
protected boolean	pngCompressed

Fields inherited from class net.sf.image4j.codec.bmp.BMPImage

image, infoHeader

Constructor Summary

ICOImage(java.awt.image.BufferedImage image, InfoHeader infoHeader, IconEntry iconEntry)
Creates a new instance of ICOImage

Method Summary

int	getColourCount() The number of possible colours for the ICO image.
int	getColourDepth() The colour depth of the ICO image (bits per pixel).
int	getHeight() The height of the ICO image in pixels.
IconEntry	getIconEntry() The IconEntry associated with this ICOImage, which provides information about the image format and encoding.
int	getIconIndex() The zero-based index for this ICOImage in the source ICO file or resource.
InfoHeader	getInfoHeader() The InfoHeader structure representing the encoded ICO image.
int	getWidth() The width of the ICO image in pixels.
boolean	isIndexed() Specifies whether this ICO image is indexed, that is, the encoded bitmap uses a colour table.
boolean	isPngCompressed() Specifies whether the encoded image is PNG compressed.
void	setIconEntry(IconEntry iconEntry) Sets the IconEntry associated with this ICOImage.
void	setIconIndex(int iconIndex) Sets the icon index, which is zero-based.
void	setPngCompressed(boolean pngCompressed) Sets whether the encoded image is PNG compressed.

Methods inherited from class net.sf.image4j.codec.bmp.BMPImage

getImage, setImage, setInfoHeader

Methods inherited from class java.lang.Object

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

Field Detail

iconEntry

protected IconEntry iconEntry

pngCompressed

protected boolean pngCompressed

iconIndex

protected int iconIndex

Constructor Detail

ICOImage

public ICOImage(java.awt.image.BufferedImage image,
                InfoHeader infoHeader,
                IconEntry iconEntry)

Creates a new instance of ICOImage

Parameters:

image - the BufferedImage decoded from the source ICO image

infoHeader - the BMP InfoHeader structure for the BMP encoded ICO image

iconEntry - the IconEntry structure describing the ICO image

Method Detail

getIconEntry

public IconEntry getIconEntry()

The IconEntry associated with this ICOImage, which provides information about the image format and encoding.

Returns:

the IconEntry structure

setIconEntry

public void setIconEntry(IconEntry iconEntry)

Sets the IconEntry associated with this ICOImage.

Parameters:

iconEntry - the new IconEntry structure to set

isPngCompressed

public boolean isPngCompressed()

Specifies whether the encoded image is PNG compressed.

Returns:

true if the encoded image is PNG compressed, false if it is plain BMP encoded

setPngCompressed

public void setPngCompressed(boolean pngCompressed)

Sets whether the encoded image is PNG compressed.

Parameters:

pngCompressed - true if the encoded image is PNG compressed, false if it is plain BMP encoded

getInfoHeader

public InfoHeader getInfoHeader()

The InfoHeader structure representing the encoded ICO image.

Overrides:

getInfoHeader in class BMPImage

Returns:

the InfoHeader structure, or null if there is no InfoHeader structure, which is possible for PNG compressed icons.

getIconIndex

public int getIconIndex()

The zero-based index for this ICOImage in the source ICO file or resource.

Returns:

the index in the source, or -1 if it is unknown.

setIconIndex

public void setIconIndex(int iconIndex)

Sets the icon index, which is zero-based.

Parameters:

iconIndex - the zero-based icon index, or -1 if unknown.

getWidth

public int getWidth()

The width of the ICO image in pixels.

Overrides:

getWidth in class BMPImage

Returns:

the width of the ICO image, or -1 if unknown

Since:

0.7alpha2

getHeight

public int getHeight()

The height of the ICO image in pixels.

Overrides:

getHeight in class BMPImage

Returns:

the height of the ICO image, or -1 if unknown.

Since:

0.7alpha2

getColourDepth

public int getColourDepth()

The colour depth of the ICO image (bits per pixel).

Overrides:

getColourDepth in class BMPImage

Returns:

the colour depth, or -1 if unknown.

Since:

0.7alpha2

getColourCount

public int getColourCount()

The number of possible colours for the ICO image.

Overrides:

getColourCount in class BMPImage

Returns:

the number of colours, or -1 if unknown.

Since:

0.7alpha2

isIndexed

public boolean isIndexed()

Specifies whether this ICO image is indexed, that is, the encoded bitmap uses a colour table. If getColourDepth() returns -1, the return value has no meaning.

Overrides:

isIndexed in class BMPImage

Returns:

true if indexed, false if not.

Since:

0.7alpha2