Apache POI - Common 5.3.0 · org.apache.poi.hpsf.Thumbnail

Field Summary

Modifier and Type	Field and Description
private byte[]	_thumbnailData A `byte[]` to hold a thumbnail image in (`VT_CF`) format.
public static final int	CF_BITMAP Clipboard Format - Bitmap
public static final int	CF_DIB Clipboard Format - Device Independent Bitmap
public static final int	CF_ENHMETAFILE Clipboard Format - Enhanced Windows metafile format
public static final int	CF_METAFILEPICT Clipboard Format - Windows metafile format.
public static final int	CFTAG_FMTID Clipboard Format Tag - Format ID A GUID containing a format identifier (FMTID).
public static final int	CFTAG_MACINTOSH Clipboard Format Tag - Macintosh clipboard format A `DWORD` indicating a Macintosh clipboard format value
public static final int	CFTAG_NODATA Clipboard Format Tag - No Data A `DWORD` indicating No data.
public static final int	CFTAG_WINDOWS Clipboard Format Tag - Windows clipboard format A `DWORD` indicating a built-in Windows clipboard format value
private static final int	DEFAULT_MAX_RECORD_LENGTH
private static int	MAX_RECORD_LENGTH
public static final int	OFFSET_CF Offset in bytes where the Clipboard Format starts in the `byte[]` returned by `SummaryInformation#getThumbnail()` This is only valid if the Clipboard Format Tag is `CFTAG_WINDOWS`
public static final int	OFFSET_CFTAG Offset in bytes where the Clipboard Format Tag starts in the `byte[]` returned by `SummaryInformation#getThumbnail()`
public static final int	OFFSET_WMFDATA Offset in bytes where the Windows Metafile (WMF) image data starts in the `byte[]` returned by `SummaryInformation#getThumbnail()` There is only WMF data at this point in the `byte[]` if the Clipboard Format Tag is `CFTAG_WINDOWS` and the Clipboard Format is `CF_METAFILEPICT`.

Constructor Summary

Access	Constructor and Description
public	Thumbnail() Default Constructor.
public	Thumbnail(final byte[] The thumbnail data thumbnailData) Creates a `Thumbnail` instance and initializes with the specified image bytes.

Method Summary

Modifier and Type	Method and Description
public long	Returns: a flag indicating the Clipboard Format getClipboardFormat() Returns an `int` representing the Clipboard Format Will throw an exception if the Thumbnail's Clipboard Format Tag is not `CFTAG_WINDOWS`.
public long	Returns: A flag indicating the Clipboard Format Tag getClipboardFormatTag() Returns an `int` representing the Clipboard Format Tag Possible return values are: `CFTAG_WINDOWS` `CFTAG_MACINTOSH` `CFTAG_FMTID` `CFTAG_NODATA`
public static int	Returns: the max record length allowed for SubRecord getMaxRecordLength()
public byte[]	Returns: The thumbnail value getThumbnail() Returns the thumbnail as a `byte[]` in `VT_CF` format.
public byte[]	Returns: A WMF image of the Thumbnail getThumbnailAsWMF() Returns the Thumbnail as a `byte[]` of WMF data if the Thumbnail's Clipboard Format Tag is `CFTAG_WINDOWS` and its Clipboard Format is `CF_METAFILEPICT` This `byte[]` is in the traditional WMF file, not the clipboard-specific version with special headers.
public static void	setMaxRecordLength(int the max record length allowed for SubRecord length)
public void	setThumbnail(final byte[] The new thumbnail value thumbnail) Sets the Thumbnail's underlying `byte[]` in `VT_CF` format.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_thumbnailData	back to summary
private byte[] _thumbnailData A `byte[]` to hold a thumbnail image in (`VT_CF`) format.

CF_BITMAP	back to summary
public static final int CF_BITMAP Clipboard Format - Bitmap

CF_DIB	back to summary
public static final int CF_DIB Clipboard Format - Device Independent Bitmap

CF_ENHMETAFILE	back to summary
public static final int CF_ENHMETAFILE Clipboard Format - Enhanced Windows metafile format

CF_METAFILEPICT	back to summary
public static final int CF_METAFILEPICT Clipboard Format - Windows metafile format. This is the recommended way to store thumbnails in Property Streams. Note This is not the same format used in regular WMF images. The clipboard version of this format has an extra clipboard-specific header.

CFTAG_FMTID	back to summary
public static final int CFTAG_FMTID Clipboard Format Tag - Format ID A GUID containing a format identifier (FMTID). This is rarely used.

CFTAG_FMTID

back to summary

public static final int CFTAG_FMTID

Clipboard Format Tag - Format ID

A GUID containing a format identifier (FMTID). This is rarely used.

CFTAG_MACINTOSH back to summary

CFTAG_MACINTOSH	back to summary
public static final int CFTAG_MACINTOSH Clipboard Format Tag - Macintosh clipboard format A `DWORD` indicating a Macintosh clipboard format value

public static final int CFTAG_MACINTOSH

Clipboard Format Tag - Macintosh clipboard format

A DWORD indicating a Macintosh clipboard format value

CFTAG_NODATA back to summary

CFTAG_NODATA	back to summary
public static final int CFTAG_NODATA Clipboard Format Tag - No Data A `DWORD` indicating No data. This is rarely used.

public static final int CFTAG_NODATA

Clipboard Format Tag - No Data

A DWORD indicating No data. This is rarely used.

CFTAG_WINDOWS back to summary

CFTAG_WINDOWS	back to summary
public static final int CFTAG_WINDOWS Clipboard Format Tag - Windows clipboard format A `DWORD` indicating a built-in Windows clipboard format value

public static final int CFTAG_WINDOWS

Clipboard Format Tag - Windows clipboard format

A DWORD indicating a built-in Windows clipboard format value

DEFAULT_MAX_RECORD_LENGTH	back to summary
private static final int DEFAULT_MAX_RECORD_LENGTH

MAX_RECORD_LENGTH	back to summary
private static int MAX_RECORD_LENGTH

OFFSET_CF back to summary

OFFSET_CF	back to summary
public static final int OFFSET_CF Offset in bytes where the Clipboard Format starts in the `byte[]` returned by `SummaryInformation#getThumbnail()` This is only valid if the Clipboard Format Tag is `CFTAG_WINDOWS`

public static final int OFFSET_CF

Offset in bytes where the Clipboard Format starts in the byte[] returned by SummaryInformation#getThumbnail()

This is only valid if the Clipboard Format Tag is CFTAG_WINDOWS

OFFSET_CFTAG	back to summary
public static final int OFFSET_CFTAG Offset in bytes where the Clipboard Format Tag starts in the `byte[]` returned by `SummaryInformation#getThumbnail()`

OFFSET_WMFDATA back to summary

OFFSET_WMFDATA	back to summary
public static final int OFFSET_WMFDATA Offset in bytes where the Windows Metafile (WMF) image data starts in the `byte[]` returned by `SummaryInformation#getThumbnail()` There is only WMF data at this point in the `byte[]` if the Clipboard Format Tag is `CFTAG_WINDOWS` and the Clipboard Format is `CF_METAFILEPICT`. Note The `byte[]` that starts at `OFFSET_WMFDATA` and ends at `getThumbnail().length - 1` forms a complete WMF image. It can be saved to disk with a `.wmf` file type and read using a WMF-capable image viewer.

public static final int OFFSET_WMFDATA

Offset in bytes where the Windows Metafile (WMF) image data starts in the byte[] returned by SummaryInformation#getThumbnail()

There is only WMF data at this point in the byte[] if the Clipboard Format Tag is CFTAG_WINDOWS and the Clipboard Format is CF_METAFILEPICT.

Note

The byte[] that starts at OFFSET_WMFDATA and ends at getThumbnail().length - 1 forms a complete WMF image. It can be saved to disk with a .wmf file type and read using a WMF-capable image viewer.

Constructor Detail

Thumbnail	back to summary
public Thumbnail() Default Constructor. If you use it then one you'll have to add the thumbnail `byte[]` from `SummaryInformation#getThumbnail()` to do any useful manipulations, otherwise you'll get a `NullPointerException`.

Thumbnail back to summary

Thumbnail	back to summary
public Thumbnail(final byte[] thumbnailData) Creates a `Thumbnail` instance and initializes with the specified image bytes. Parameters thumbnailData:byte[] The thumbnail data

public Thumbnail(final byte[] thumbnailData)

Creates a Thumbnail instance and initializes with the specified image bytes.

Parameters

thumbnailData:byte[]: The thumbnail data

Method Detail

getClipboardFormat back to summary

getClipboardFormat	back to summary
public long getClipboardFormat() throws HPSFException Returns an `int` representing the Clipboard Format Will throw an exception if the Thumbnail's Clipboard Format Tag is not `CFTAG_WINDOWS`. Possible return values are: `CF_METAFILEPICT` `CF_DIB` `CF_ENHMETAFILE` `CF_BITMAP` Returns:long a flag indicating the Clipboard Format Exceptions HPSFException: if the Thumbnail isn't CFTAG_WINDOWS

public long getClipboardFormat() throws HPSFException

Returns an int representing the Clipboard Format

Will throw an exception if the Thumbnail's Clipboard Format Tag is not CFTAG_WINDOWS.

Possible return values are:

Returns:long

a flag indicating the Clipboard Format

Exceptions

HPSFException:: if the Thumbnail isn't CFTAG_WINDOWS

getClipboardFormatTag back to summary

getClipboardFormatTag	back to summary
public long getClipboardFormatTag() Returns an `int` representing the Clipboard Format Tag Possible return values are: `CFTAG_WINDOWS` `CFTAG_MACINTOSH` `CFTAG_FMTID` `CFTAG_NODATA` Returns:long A flag indicating the Clipboard Format Tag

public long getClipboardFormatTag()

Returns an int representing the Clipboard Format Tag

Possible return values are:

Returns:long: A flag indicating the Clipboard Format Tag

getMaxRecordLength	back to summary
public static int getMaxRecordLength() Returns:int the max record length allowed for SubRecord

getThumbnail back to summary

getThumbnail	back to summary
public byte[] getThumbnail() Returns the thumbnail as a `byte[]` in `VT_CF` format. Returns:byte[] The thumbnail value See Also `SummaryInformation#getThumbnail()`

public byte[] getThumbnail()

Returns the thumbnail as a byte[] in VT_CF format.

Returns:byte[]: The thumbnail value
See Also: SummaryInformation#getThumbnail()

getThumbnailAsWMF back to summary

getThumbnailAsWMF	back to summary
public byte[] getThumbnailAsWMF() throws HPSFException Returns the Thumbnail as a `byte[]` of WMF data if the Thumbnail's Clipboard Format Tag is `CFTAG_WINDOWS` and its Clipboard Format is `CF_METAFILEPICT` This `byte[]` is in the traditional WMF file, not the clipboard-specific version with special headers. See http://www.wvware.com/caolan/ora-wmf.html for more information on the WMF image format. Returns:byte[] A WMF image of the Thumbnail Exceptions HPSFException: if the Thumbnail isn't CFTAG_WINDOWS and CF_METAFILEPICT

public byte[] getThumbnailAsWMF() throws HPSFException

Returns the Thumbnail as a byte[] of WMF data if the Thumbnail's Clipboard Format Tag is CFTAG_WINDOWS and its Clipboard Format is CF_METAFILEPICT

This byte[] is in the traditional WMF file, not the clipboard-specific version with special headers.

See http://www.wvware.com/caolan/ora-wmf.html for more information on the WMF image format.

Returns:byte[]

A WMF image of the Thumbnail

Exceptions

HPSFException:: if the Thumbnail isn't CFTAG_WINDOWS and CF_METAFILEPICT

setMaxRecordLength	back to summary
public static void setMaxRecordLength(int length) Parameters length:int the max record length allowed for SubRecord

setThumbnail back to summary

setThumbnail	back to summary
public void setThumbnail(final byte[] thumbnail) Sets the Thumbnail's underlying `byte[]` in `VT_CF` format. Parameters thumbnail:byte[] The new thumbnail value See Also `SummaryInformation#getThumbnail()`

public void setThumbnail(final byte[] thumbnail)

Sets the Thumbnail's underlying byte[] in VT_CF format.

Parameters

thumbnail:byte[]: The new thumbnail value

See Also

SummaryInformation#getThumbnail()

public final Class Thumbnail

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail