org.apache.poi.hslf.blip

Class Bitmap

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFPictureData

org.apache.poi.hslf.blip.Bitmap

All Implemented Interfaces:

GenericRecord, PictureData

Direct Known Subclasses:

DIB, JPEG, PNG

public abstract class Bitmap
extends HSLFPictureData

Represents a bitmap picture data: JPEG or PNG. The data is not compressed and the exact file content is written in the stream.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.PictureData

PictureData.PictureType

Field Summary

Fields inherited from class org.apache.poi.hslf.usermodel.HSLFPictureData

CHECKSUM_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
	Bitmap() Deprecated. Use HSLFSlideShow.addPicture(byte[], org.apache.poi.sl.usermodel.PictureData.PictureType) or one of its overloads to create new Bitmap. This API led to detached Bitmap instances (See Bugzilla 46122) and prevented adding additional functionality.
protected	Bitmap(EscherContainerRecord recordContainer, EscherBSERecord bse) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected byte[]	formatImageForSlideshow(byte[] data) Formats the picture data for storage in the slideshow.
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).

Methods inherited from class org.apache.poi.hslf.usermodel.HSLFPictureData

create, getChecksum, getChecksum, getContentType, getGenericProperties, getHeader, getImageDimensionInPixels, getIndex, getOffset, getRawData, getSignature, getUID, getUIDInstanceCount, setData, setIndex, setOffset, setRawData, setSignature, setUIDInstanceCount, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.sl.usermodel.PictureData

getType

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren, getGenericRecordType

Constructor Detail

Bitmap

@Deprecated
 @Removal(version="5.3")
public Bitmap()

Deprecated. Use HSLFSlideShow.addPicture(byte[], org.apache.poi.sl.usermodel.PictureData.PictureType) or one of its overloads to create new Bitmap. This API led to detached Bitmap instances (See Bugzilla 46122) and prevented adding additional functionality.

Bitmap

@Internal
protected Bitmap(EscherContainerRecord recordContainer,
                           EscherBSERecord bse)

Creates a new instance.

Parameters:

recordContainer - Record tracking all pictures. Should be attached to the slideshow that this picture is linked to.

bse - Record referencing this picture. Should be attached to the slideshow that this picture is linked to.

Method Detail

getData

public byte[] getData()

Description copied from interface: PictureData

Returns the binary data of this Picture

Returns:

picture data

formatImageForSlideshow

protected byte[] formatImageForSlideshow(byte[] data)

Description copied from class: HSLFPictureData

Formats the picture data for storage in the slideshow.

Images stored in HSLFSlideShows are represented differently than when they are standalone files. The exact formatting differs for each image type.

Specified by:

formatImageForSlideshow in class HSLFPictureData

Parameters:

data - Original image data. If these bytes were written to a disk, a common image viewer would be able to render the image.

Returns:

Formatted image representation.

getImageDimension

public java.awt.Dimension getImageDimension()

Description copied from interface: PictureData

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.