org.apache.poi.hslf.blip

Class WMF

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFPictureData

org.apache.poi.hslf.blip.Metafile

org.apache.poi.hslf.blip.WMF

All Implemented Interfaces:

GenericRecord, PictureData

public final class WMF
extends Metafile

Represents a WMF (Windows Metafile) picture data.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.hslf.blip.Metafile

Metafile.Header

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
WMF() Deprecated. Use HSLFSlideShow.addPicture(byte[], org.apache.poi.sl.usermodel.PictureData.PictureType) or one of its overloads to create new WMF. This API led to detached WMF instances (See Bugzilla 46122) and prevented adding additional functionality.
WMF(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
int	getSignature() WMF signature is either 0x2160 or 0x2170
PictureData.PictureType	getType()
void	setSignature(int signature) Sets the WMF signature - either 0x2160 or 0x2170

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

compress, 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

WMF

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

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

WMF

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

getType

public PictureData.PictureType getType()

Returns:

the picture type

getSignature

public int getSignature()

WMF signature is either 0x2160 or 0x2170

Specified by:

getSignature in class HSLFPictureData

setSignature

public void setSignature(int signature)

Sets the WMF signature - either 0x2160 or 0x2170

Specified by:

setSignature in class HSLFPictureData