org.apache.poi.hslf.blip

Class DIB

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFPictureData

org.apache.poi.hslf.blip.Bitmap

org.apache.poi.hslf.blip.DIB

All Implemented Interfaces:

GenericRecord, PictureData

public final class DIB
extends Bitmap

Represents a DIB picture data in a PPT file

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

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

Method Summary

Modifier and Type	Method and Description
static byte[]	addBMPHeader(byte[] data)
protected byte[]	formatImageForSlideshow(byte[] data) Formats the picture data for storage in the slideshow.
byte[]	getData() Returns the binary data of this Picture
int	getSignature() DIB signature is 0x7A80 or 0x7A90
PictureData.PictureType	getType()
void	setSignature(int signature) Sets the DIB signature - either 0x7A80 or 0x7A90

Methods inherited from class org.apache.poi.hslf.blip.Bitmap

getImageDimension

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

create, getChecksum, getChecksum, getContentType, getGenericProperties, getHeader, getImageDimensionInPixels, getIndex, getOffset, getRawData, getUID, getUIDInstanceCount, setData, setIndex, setOffset, setRawData, 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.common.usermodel.GenericRecord

getGenericChildren, getGenericRecordType

Constructor Detail

DIB

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

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

DIB

@Internal
public DIB(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

getType

public PictureData.PictureType getType()

Returns:

the picture type

getSignature

public int getSignature()

DIB signature is 0x7A80 or 0x7A90

Specified by:

getSignature in class HSLFPictureData

Returns:

DIB signature (0x7A80 or 0x7A90)

setSignature

public void setSignature(int signature)

Sets the DIB signature - either 0x7A80 or 0x7A90

Specified by:

setSignature in class HSLFPictureData

getData

public byte[] getData()

Description copied from interface: PictureData

Returns the binary data of this Picture

Specified by:

getData in interface PictureData

Overrides:

getData in class Bitmap

Returns:

picture data

addBMPHeader

public static byte[] addBMPHeader(byte[] 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.

Overrides:

formatImageForSlideshow in class Bitmap

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.