org.apache.poi.hslf.usermodel

Class HSLFPictureData

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFPictureData

All Implemented Interfaces:

GenericRecord, PictureData

Direct Known Subclasses:

Bitmap, Metafile

public abstract class HSLFPictureData
extends java.lang.Object
implements PictureData, GenericRecord

A class that represents image data contained in a slide show.

Nested Class Summary

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

PictureData.PictureType

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	CHECKSUM_SIZE Size of the image checksum calculated using MD5 algorithm.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static HSLFPictureData	create(PictureData.PictureType type) Deprecated. Use HSLFSlideShow.addPicture(byte[], org.apache.poi.sl.usermodel.PictureData.PictureType) or one of its overloads to create new HSLFPictureData. This API led to detached HSLFPictureData instances (See Bugzilla 46122) and prevented adding additional functionality.
protected abstract byte[]	formatImageForSlideshow(byte[] data) Formats the picture data for storage in the slideshow.
byte[]	getChecksum() Gets the checksum - the checksum can be of various length - mostly it's 8 (XSLF) or 16 (HSLF) bytes long.
static byte[]	getChecksum(byte[] data) Compute 16-byte checksum of this picture using MD5 algorithm.
java.lang.String	getContentType() Returns content type (mime type) of this picture.
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
byte[]	getHeader() Return 24 byte header which preceeds the actual picture data.
java.awt.Dimension	getImageDimensionInPixels() Return the original image dimensions in pixels
int	getIndex() Returns the 1-based index of this picture.
int	getOffset() File offset in the 'Pictures' stream
byte[]	getRawData() Returns the formatted, binary data of this picture excluding the preamble bytes.
protected abstract int	getSignature() Blip signature.
byte[]	getUID() Returns 16-byte checksum of this picture
protected int	getUIDInstanceCount() The instance type/signatures defines if one or two UID instances will be included
void	setData(byte[] data) Sets the binary picture data
void	setIndex(int index)
void	setOffset(int offset) Deprecated. This function was only intended for POI internal use. If you have a use case you're concerned about, please open an issue in the POI issue tracker.
void	setRawData(byte[] data) Deprecated. Set image data using setData(byte[]).
abstract void	setSignature(int signature)
protected void	setUIDInstanceCount(int uidInstanceCount) The instance type/signatures defines if one or two UID instances will be included
void	write(java.io.OutputStream out) Write this picture into OutputStream

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

getData, getImageDimension, getType

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

getGenericChildren, getGenericRecordType

Field Detail

CHECKSUM_SIZE

protected static final int CHECKSUM_SIZE

Size of the image checksum calculated using MD5 algorithm.

See Also:

Constant Field Values

Constructor Detail

HSLFPictureData

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

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

HSLFPictureData

@Internal
protected HSLFPictureData(EscherContainerRecord bStore,
                                    EscherBSERecord bse)

Creates a new instance.

Parameters:

bStore - BStore 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

getSignature

protected abstract int getSignature()

Blip signature.

setSignature

public abstract void setSignature(int signature)

getUIDInstanceCount

protected int getUIDInstanceCount()

The instance type/signatures defines if one or two UID instances will be included

setUIDInstanceCount

protected void setUIDInstanceCount(int uidInstanceCount)

The instance type/signatures defines if one or two UID instances will be included

Parameters:

uidInstanceCount - the number of uid sequences

getRawData

public byte[] getRawData()

Returns the formatted, binary data of this picture excluding the preamble bytes.

Primarily intended for internal POI use. Use PictureData.getData() to retrieve the picture represented by this object.

Returns:

Picture data formatted for the HSLF format.

See Also:

PictureData.getData(), formatImageForSlideshow(byte[])

setRawData

@Deprecated
 @Removal(version="5.3")
public void setRawData(byte[] data)

Deprecated. Set image data using setData(byte[]).

Sets the formatted data for this picture.

Primarily intended for internal POI use. Use setData(byte[]) to change the picture represented by this object.

Parameters:

data - Picture data formatted for the HSLF format. Excludes the preamble.

See Also:

setData(byte[]), formatImageForSlideshow(byte[])

getOffset

public int getOffset()

File offset in the 'Pictures' stream

Returns:

offset in the 'Pictures' stream

setOffset

@Deprecated
 @Removal(version="5.3")
public void setOffset(int offset)

Deprecated. This function was only intended for POI internal use. If you have a use case you're concerned about, please open an issue in the POI issue tracker.

Set offset of this picture in the 'Pictures' stream. We need to set it when a new picture is created.

Parameters:

offset - in the 'Pictures' stream

getUID

public byte[] getUID()

Returns 16-byte checksum of this picture

getChecksum

public byte[] getChecksum()

Description copied from interface: PictureData

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

Specified by:

getChecksum in interface PictureData

Returns:

the checksum

getChecksum

public static byte[] getChecksum(byte[] data)

Compute 16-byte checksum of this picture using MD5 algorithm.

write

public void write(java.io.OutputStream out)
           throws java.io.IOException

Write this picture into OutputStream

Throws:

java.io.IOException

create

@Deprecated
 @Removal(version="5.3")
public static HSLFPictureData create(PictureData.PictureType type)

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

Create an instance of HSLFPictureData by type.

Parameters:

type - type of picture.

Returns:

concrete instance of HSLFPictureData.

getHeader

public byte[] getHeader()

Return 24 byte header which preceeds the actual picture data.

The header consists of 2-byte signature, 2-byte type, 4-byte image size and 16-byte checksum of the image data.

Returns:

the 24 byte header which preceeds the actual picture data.

getIndex

public int getIndex()

Returns the 1-based index of this picture.

Returns:

the 1-based index of this pictures within the pictures stream

setIndex

public void setIndex(int index)

Parameters:

index - sets the 1-based index of this pictures within the pictures stream

formatImageForSlideshow

protected abstract byte[] formatImageForSlideshow(byte[] data)

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.

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.

setData

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

Description copied from interface: PictureData

Sets the binary picture data

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

Specified by:

setData in interface PictureData

Parameters:

data - picture data

Throws:

java.io.IOException

getContentType

public final java.lang.String getContentType()

Description copied from interface: PictureData

Returns content type (mime type) of this picture.

Specified by:

getContentType in interface PictureData

Returns:

content type of this picture.

getImageDimensionInPixels

public java.awt.Dimension getImageDimensionInPixels()

Description copied from interface: PictureData

Return the original image dimensions in pixels

Specified by:

getImageDimensionInPixels in interface PictureData

See Also:

PictureData.getImageDimension()

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord