org.apache.poi.sl.usermodel

Interface PictureData

All Known Implementing Classes:

Bitmap, DIB, EMF, HSLFPictureData, JPEG, Metafile, PICT, PNG, WMF, XSLFPictureData

public interface PictureData

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PictureData.PictureType

Method Summary

Modifier and Type	Method and Description
byte[]	getChecksum() Gets the checksum - the checksum can be of various length - mostly it's 8 (XSLF) or 16 (HSLF) bytes long.
java.lang.String	getContentType() Returns content type (mime type) of this picture.
byte[]	getData() Returns the binary data of this Picture
java.awt.Dimension	getImageDimension() Return the original image dimensions in points (for formats supported by BufferedImage).
java.awt.Dimension	getImageDimensionInPixels() Return the original image dimensions in pixels
PictureData.PictureType	getType()
void	setData(byte[] data) Sets the binary picture data

Method Detail

getContentType

java.lang.String getContentType()

Returns content type (mime type) of this picture.

Returns:

content type of this picture.

getType

PictureData.PictureType getType()

Returns:

the picture type

getData

byte[] getData()

Returns the binary data of this Picture

Returns:

picture data

setData

void setData(byte[] data)
      throws java.io.IOException

Sets the binary picture data

The format of the data must match the format of getType(). Failure to match the picture data may result in data loss.

Parameters:

data - picture data

Throws:

java.io.IOException

getChecksum

byte[] getChecksum()

Gets the checksum - the checksum can be of various length - mostly it's 8 (XSLF) or 16 (HSLF) bytes long.

Returns:

the checksum

getImageDimension

java.awt.Dimension getImageDimension()

Return the original image dimensions in points (for formats supported by BufferedImage). Will return a Dimension with a default width of 200x200 if the format unsupported.

getImageDimensionInPixels

java.awt.Dimension getImageDimensionInPixels()

Return the original image dimensions in pixels

See Also:

getImageDimension()