Top Description Fields Constructors Methods
org.apache.poi.hssf.usermodel

public Class HSSFPictureData

extends Object
implements PictureData
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.usermodel.PictureData
Imports
org.apache.poi.ddf.EscherBlipRecord, .EscherRecordTypes, org.apache.poi.sl.image.ImageHeaderPNG, org.apache.poi.ss.usermodel.PictureData, .Workbook
Represents binary data stored in the file. Eg. A GIF, JPEG etc...

Field Summary

Modifier and TypeField and Description
private final EscherBlipRecord
blip

Underlying escher blip record containing the bitmap data.

public static final short
FORMAT_MASK

public static final short
MSOBI_DIB

public static final short
MSOBI_EMF

public static final short
MSOBI_JPEG

public static final short
MSOBI_PICT

public static final short
MSOBI_PNG

public static final short
MSOBI_WMF

Constructor Summary

AccessConstructor and Description
public
HSSFPictureData(EscherBlipRecord
the underlying blip record containing the bitmap data.
blip)

Constructs a picture object.

Method Summary

Modifier and TypeMethod and Description
public byte[]
getData()

Implements org.apache.poi.ss.usermodel.PictureData.getData.

Gets the picture data.

public int

Returns:

format of the picture.
getFormat()

public String
getMimeType()

Implements org.apache.poi.ss.usermodel.PictureData.getMimeType.

Returns the mime type for the image

public int

Returns:

the POI internal image type, 0 if unknown image type (was -1 prior to 5.0.0 but that was inconsistent with other PictureData implementations)
getPictureType()

Implements org.apache.poi.ss.usermodel.PictureData.getPictureType.

public String

Returns:

'wmf', 'jpeg' etc depending on the format. never null
suggestFileExtension()

Implements org.apache.poi.ss.usermodel.PictureData.suggestFileExtension.

Suggests a file extension for this image.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

blipback to summary
private final EscherBlipRecord blip

Underlying escher blip record containing the bitmap data.

FORMAT_MASKback to summary
public static final short FORMAT_MASK
MSOBI_DIBback to summary
public static final short MSOBI_DIB
MSOBI_EMFback to summary
public static final short MSOBI_EMF
MSOBI_JPEGback to summary
public static final short MSOBI_JPEG
MSOBI_PICTback to summary
public static final short MSOBI_PICT
MSOBI_PNGback to summary
public static final short MSOBI_PNG
MSOBI_WMFback to summary
public static final short MSOBI_WMF

Constructor Detail

HSSFPictureDataback to summary
public HSSFPictureData(EscherBlipRecord blip)

Constructs a picture object.

Parameters
blip:EscherBlipRecord

the underlying blip record containing the bitmap data.

Method Detail

getDataback to summary
public byte[] getData()

Implements org.apache.poi.ss.usermodel.PictureData.getData.

Doc from org.apache.poi.ss.usermodel.PictureData.getData.

Gets the picture data.

Returns:byte[]

the picture data.

Annotations
@Override
getFormatback to summary
public int getFormat()
Returns:int

format of the picture.

See Also
HSSFWorkbook#PICTURE_TYPE_DIB, HSSFWorkbook#PICTURE_TYPE_WMF, HSSFWorkbook#PICTURE_TYPE_EMF, HSSFWorkbook#PICTURE_TYPE_PNG, HSSFWorkbook#PICTURE_TYPE_JPEG, HSSFWorkbook#PICTURE_TYPE_PICT
getMimeTypeback to summary
public String getMimeType()

Implements org.apache.poi.ss.usermodel.PictureData.getMimeType.

Doc from org.apache.poi.ss.usermodel.PictureData.getMimeType.

Returns the mime type for the image

Annotations
@Override
getPictureTypeback to summary
public int getPictureType()

Implements org.apache.poi.ss.usermodel.PictureData.getPictureType.

Returns:int

the POI internal image type, 0 if unknown image type (was -1 prior to 5.0.0 but that was inconsistent with other PictureData implementations)

Annotations
@Override
suggestFileExtensionback to summary
public String suggestFileExtension()

Implements org.apache.poi.ss.usermodel.PictureData.suggestFileExtension.

Doc from org.apache.poi.ss.usermodel.PictureData.suggestFileExtension.

Suggests a file extension for this image.

Returns:String

'wmf', 'jpeg' etc depending on the format. never null

Annotations
@Override
See Also
getFormat