Top Inners Methods
org.apache.poi.sl.usermodel

public Interface PictureData

Imports
java.awt.Dimension, java.io.IOException

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Method Summary

Modifier and TypeMethod and Description
public byte[]

Returns:

the checksum
getChecksum
()

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

public String

Returns:

content type of this picture.
getContentType
()

Returns content type (mime type) of this picture.

public byte[]

Returns:

picture data
getData
()

Returns the binary data of this Picture

public Dimension
getImageDimension()

Return the original image dimensions in points (for formats supported by BufferedImage).

public Dimension
getImageDimensionInPixels()

Return the original image dimensions in pixels

public PictureData.PictureType

Returns:

the picture type
getType
()

public void
setData(byte[]
picture data
data
)

Sets the binary picture data

The format of the data must match the format of getType().

Method Detail

getChecksumback to summary
public byte[] getChecksum()

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

Returns:byte[]

the checksum

getContentTypeback to summary
public String getContentType()

Returns content type (mime type) of this picture.

Returns:String

content type of this picture.

getDataback to summary
public byte[] getData()

Returns the binary data of this Picture

Returns:byte[]

picture data

getImageDimensionback to summary
public 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.

getImageDimensionInPixelsback to summary
public Dimension getImageDimensionInPixels()

Return the original image dimensions in pixels

See Also
PictureData#getImageDimension()
getTypeback to summary
public PictureData.PictureType getType()
Returns:PictureData.PictureType

the picture type

setDataback to summary
public void setData(byte[] data) throws 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:byte[]

picture data

org.apache.poi.sl.usermodel back to summary

public final Enum PictureData.PictureType

extends Enum<PictureData.PictureType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final PictureData.PictureType
BMP

Windows Bitmap (.bmp)

public static final PictureData.PictureType
CLIENT

client defined blip type - native-id 32 to 255

public static final PictureData.PictureType
CMYKJPEG

JPEG in the YCCK or CMYK color space.

public final String
public static final PictureData.PictureType
DIB

Device independent bitmap

public static final PictureData.PictureType
EMF

Extended windows meta file

public static final PictureData.PictureType
EPS

Encapsulated Postscript (.eps)

public static final PictureData.PictureType
ERROR

Picture type error - specific to escher bse record

public final String
public static final PictureData.PictureType
GIF

GIF image format

public static final PictureData.PictureType
JPEG

JPEG format

public final int
public final int
public static final PictureData.PictureType
PICT

Mac PICT format

public static final PictureData.PictureType
PNG

PNG format

public static final PictureData.PictureType
SVG

Scalable vector graphics (.svg) - supported by Office 2016 and higher

public static final PictureData.PictureType
TIFF

Tag Image File (.tiff)

public static final PictureData.PictureType
UNKNOWN

Unknown picture type - specific to escher bse record

public static final PictureData.PictureType
WDP

Microsoft Windows Media Photo image (.wdp)

public static final PictureData.PictureType
WMF

Windows Meta File

public static final PictureData.PictureType
WPG

WordPerfect graphics (.wpg)

Constructor Summary

AccessConstructor and Description
private
PictureType(int nativeId, int ooxmlId, String contentType, String extension)

Method Summary

Modifier and TypeMethod and Description
public static PictureData.PictureType
forNativeID(int nativeId)

public static PictureData.PictureType
forOoxmlID(int ooxmlId)

public static PictureData.PictureType
public static PictureData.PictureType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

BMPback to summary
public static final PictureData.PictureType BMP

Windows Bitmap (.bmp)

CLIENTback to summary
public static final PictureData.PictureType CLIENT

client defined blip type - native-id 32 to 255

CMYKJPEGback to summary
public static final PictureData.PictureType CMYKJPEG

JPEG in the YCCK or CMYK color space.

contentTypeback to summary
public final String contentType
DIBback to summary
public static final PictureData.PictureType DIB

Device independent bitmap

EMFback to summary
public static final PictureData.PictureType EMF

Extended windows meta file

EPSback to summary
public static final PictureData.PictureType EPS

Encapsulated Postscript (.eps)

ERRORback to summary
public static final PictureData.PictureType ERROR

Picture type error - specific to escher bse record

extensionback to summary
public final String extension
GIFback to summary
public static final PictureData.PictureType GIF

GIF image format

JPEGback to summary
public static final PictureData.PictureType JPEG

JPEG format

nativeIdback to summary
public final int nativeId
ooxmlIdback to summary
public final int ooxmlId
PICTback to summary
public static final PictureData.PictureType PICT

Mac PICT format

PNGback to summary
public static final PictureData.PictureType PNG

PNG format

SVGback to summary
public static final PictureData.PictureType SVG

Scalable vector graphics (.svg) - supported by Office 2016 and higher

TIFFback to summary
public static final PictureData.PictureType TIFF

Tag Image File (.tiff)

UNKNOWNback to summary
public static final PictureData.PictureType UNKNOWN

Unknown picture type - specific to escher bse record

WDPback to summary
public static final PictureData.PictureType WDP

Microsoft Windows Media Photo image (.wdp)

WMFback to summary
public static final PictureData.PictureType WMF

Windows Meta File

WPGback to summary
public static final PictureData.PictureType WPG

WordPerfect graphics (.wpg)

Constructor Detail

PictureTypeback to summary
private PictureType(int nativeId, int ooxmlId, String contentType, String extension)

Method Detail

forNativeIDback to summary
public static PictureData.PictureType forNativeID(int nativeId)
forOoxmlIDback to summary
public static PictureData.PictureType forOoxmlID(int ooxmlId)
valueOfback to summary
public static PictureData.PictureType valueOf(String name)
valuesback to summary
public static PictureData.PictureType[] values()