Java Doc for Thumbnail.java in  » Collaboration » poi-3.0.2-beta2 » org » apache » poi » hpsf » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Class to manipulate data in the Clipboard Variant ( Variant.VT_CF VT_CF ) format.

Clipboard Format Tag - Format ID

A GUID containing a format identifier (FMTID).

Clipboard Format Tag - No Data

A DWORD indicating No data.

Clipboard Format - Windows metafile format.

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 Thumbnail.CFTAG_WINDOWS and the Clipboard Format is Thumbnail.CF_METAFILEPICT .

Note: The byte[] that starts at OFFSET_WMFDATA and ends at getThumbnail().length - 1 forms a complete WMF image.

Default Constructor.

Clipboard Format Tag - Format ID

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

Clipboard Format Tag - Macintosh clipboard format

A DWORD indicating a Macintosh clipboard format value

Clipboard Format Tag - No Data

A DWORD indicating No data. This is rarely used.

Clipboard Format Tag - Windows clipboard format

A DWORD indicating a built-in Windows clipboard format value

Clipboard Format - Bitmap

Obsolete, see msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp.

Clipboard Format - Device Independent Bitmap

Clipboard Format - Enhanced Windows metafile format

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.

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 Thumbnail.CFTAG_WINDOWS

Offset in bytes where the Clipboard Format Tag starts in the byte[] returned by SummaryInformation.getThumbnail

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 Thumbnail.CFTAG_WINDOWS and the Clipboard Format is Thumbnail.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.

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.

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

Returns an int representing the Clipboard Format

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

Possible return values are:

• Thumbnail.CF_METAFILEPICT CF_METAFILEPICT
• Thumbnail.CF_DIB CF_DIB
• Thumbnail.CF_ENHMETAFILE CF_ENHMETAFILE
• Thumbnail.CF_BITMAP CF_BITMAP

Returns an int representing the Clipboard Format Tag

Possible return values are:

• Thumbnail.CFTAG_WINDOWS CFTAG_WINDOWS
• Thumbnail.CFTAG_MACINTOSH CFTAG_MACINTOSH
• Thumbnail.CFTAG_FMTID CFTAG_FMTID
• Thumbnail.CFTAG_NODATA CFTAG_NODATA

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

Returns the Thumbnail as a byte[] of WMF data if the Thumbnail's Clipboard Format Tag is Thumbnail.CFTAG_WINDOWS CFTAG_WINDOWS and its Clipboard Format is Thumbnail.CF_METAFILEPICT 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.

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