123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277 |
- /* ====================================================================
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- ==================================================================== */
-
- package org.apache.poi.hpsf;
-
- import org.apache.poi.util.LittleEndian;
- /**
- * <p>Class to manipulate data in the Clipboard Variant ({@link
- * Variant#VT_CF VT_CF}) format.</p>
- *
- * @author Drew Varner (Drew.Varner inOrAround sc.edu)
- * @see SummaryInformation#getThumbnail()
- */
- public final class Thumbnail {
-
- /**
- * <p>Offset in bytes where the Clipboard Format Tag starts in the
- * <code>byte[]</code> returned by {@link
- * SummaryInformation#getThumbnail()}</p>
- */
- public static final int OFFSET_CFTAG = 4;
-
- /**
- * <p>Offset in bytes where the Clipboard Format starts in the
- * <code>byte[]</code> returned by {@link
- * SummaryInformation#getThumbnail()}</p>
- *
- * <p>This is only valid if the Clipboard Format Tag is {@link
- * #CFTAG_WINDOWS}</p>
- */
- public static final int OFFSET_CF = 8;
-
- /**
- * <p>Offset in bytes where the Windows Metafile (WMF) image data
- * starts in the <code>byte[]</code> returned by {@link
- * SummaryInformation#getThumbnail()}</p>
- *
- * <p>There is only WMF data at this point in the
- * <code>byte[]</code> if the Clipboard Format Tag is {@link
- * #CFTAG_WINDOWS} and the Clipboard Format is {@link
- * #CF_METAFILEPICT}.</p>
- *
- * <p>Note: The <code>byte[]</code> that starts at
- * <code>OFFSET_WMFDATA</code> and ends at
- * <code>getThumbnail().length - 1</code> forms a complete WMF
- * image. It can be saved to disk with a <code>.wmf</code> file
- * type and read using a WMF-capable image viewer.</p>
- */
- public static final int OFFSET_WMFDATA = 20;
-
- /**
- * <p>Clipboard Format Tag - Windows clipboard format</p>
- *
- * <p>A <code>DWORD</code> indicating a built-in Windows clipboard
- * format value</p>
- */
- public static final int CFTAG_WINDOWS = -1;
-
- /**
- * <p>Clipboard Format Tag - Macintosh clipboard format</p>
- *
- * <p>A <code>DWORD</code> indicating a Macintosh clipboard format
- * value</p>
- */
- public static final int CFTAG_MACINTOSH = -2;
-
- /**
- * <p>Clipboard Format Tag - Format ID</p>
- *
- * <p>A GUID containing a format identifier (FMTID). This is
- * rarely used.</p>
- */
- public static final int CFTAG_FMTID = -3;
-
- /**
- * <p>Clipboard Format Tag - No Data</p>
- *
- * <p>A <code>DWORD</code> indicating No data. This is rarely
- * used.</p>
- */
- public static final int CFTAG_NODATA = 0;
-
- /**
- * <p>Clipboard Format - Windows metafile format. This is the
- * recommended way to store thumbnails in Property Streams.</p>
- *
- * <p><strong>Note:</strong> This is not the same format used in
- * regular WMF images. The clipboard version of this format has an
- * extra clipboard-specific header.</p>
- */
- public static final int CF_METAFILEPICT = 3;
-
- /**
- * <p>Clipboard Format - Device Independent Bitmap</p>
- */
- public static final int CF_DIB = 8;
-
- /**
- * <p>Clipboard Format - Enhanced Windows metafile format</p>
- */
- public static final int CF_ENHMETAFILE = 14;
-
- /**
- * <p>Clipboard Format - Bitmap</p>
- *
- * <p>Obsolete, see <a
- * href="msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp
- * target="_blank">msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp</a>.</p>
- */
- public static final int CF_BITMAP = 2;
-
- /**
- * <p>A <code>byte[]</code> to hold a thumbnail image in ({@link
- * Variant#VT_CF VT_CF}) format.</p>
- */
- private byte[] _thumbnailData = null;
-
-
-
- /**
- * <p>Default Constructor. If you use it then one you'll have to add
- * the thumbnail <code>byte[]</code> from {@link
- * SummaryInformation#getThumbnail()} to do any useful
- * manipulations, otherwise you'll get a
- * <code>NullPointerException</code>.</p>
- */
- public Thumbnail()
- {
- super();
- }
-
-
-
- /**
- * <p>Creates a <code>Thumbnail</code> instance and initializes
- * with the specified image bytes.</p>
- *
- * @param thumbnailData The thumbnail data
- */
- public Thumbnail(final byte[] thumbnailData)
- {
- this._thumbnailData = thumbnailData;
- }
-
-
-
- /**
- * <p>Returns the thumbnail as a <code>byte[]</code> in {@link
- * Variant#VT_CF VT_CF} format.</p>
- *
- * @return The thumbnail value
- * @see SummaryInformation#getThumbnail()
- */
- public byte[] getThumbnail()
- {
- return _thumbnailData;
- }
-
-
-
- /**
- * <p>Sets the Thumbnail's underlying <code>byte[]</code> in
- * {@link Variant#VT_CF VT_CF} format.</p>
- *
- * @param thumbnail The new thumbnail value
- * @see SummaryInformation#getThumbnail()
- */
- public void setThumbnail(final byte[] thumbnail)
- {
- this._thumbnailData = thumbnail;
- }
-
-
-
- /**
- * <p>Returns an <code>int</code> representing the Clipboard
- * Format Tag</p>
- *
- * <p>Possible return values are:</p>
- * <ul>
- * <li>{@link #CFTAG_WINDOWS CFTAG_WINDOWS}</li>
- * <li>{@link #CFTAG_MACINTOSH CFTAG_MACINTOSH}</li>
- * <li>{@link #CFTAG_FMTID CFTAG_FMTID}</li>
- * <li>{@link #CFTAG_NODATA CFTAG_NODATA}</li>
- * </ul>
- *
- * @return A flag indicating the Clipboard Format Tag
- */
- public long getClipboardFormatTag()
- {
- long clipboardFormatTag = LittleEndian.getInt(getThumbnail(),
- OFFSET_CFTAG);
- return clipboardFormatTag;
- }
-
-
-
- /**
- * <p>Returns an <code>int</code> representing the Clipboard
- * Format</p>
- *
- * <p>Will throw an exception if the Thumbnail's Clipboard Format
- * Tag is not {@link Thumbnail#CFTAG_WINDOWS CFTAG_WINDOWS}.</p>
- *
- * <p>Possible return values are:</p>
- *
- * <ul>
- * <li>{@link #CF_METAFILEPICT CF_METAFILEPICT}</li>
- * <li>{@link #CF_DIB CF_DIB}</li>
- * <li>{@link #CF_ENHMETAFILE CF_ENHMETAFILE}</li>
- * <li>{@link #CF_BITMAP CF_BITMAP}</li>
- * </ul>
- *
- * @return a flag indicating the Clipboard Format
- * @throws HPSFException if the Thumbnail isn't CFTAG_WINDOWS
- */
- public long getClipboardFormat() throws HPSFException
- {
- if (!(getClipboardFormatTag() == CFTAG_WINDOWS))
- throw new HPSFException("Clipboard Format Tag of Thumbnail must " +
- "be CFTAG_WINDOWS.");
-
- return LittleEndian.getInt(getThumbnail(), OFFSET_CF);
- }
-
-
-
- /**
- * <p>Returns the Thumbnail as a <code>byte[]</code> of WMF data
- * if the Thumbnail's Clipboard Format Tag is {@link
- * #CFTAG_WINDOWS CFTAG_WINDOWS} and its Clipboard Format is
- * {@link #CF_METAFILEPICT CF_METAFILEPICT}</p> <p>This
- * <code>byte[]</code> is in the traditional WMF file, not the
- * clipboard-specific version with special headers.</p>
- *
- * <p>See <a href="http://www.wvware.com/caolan/ora-wmf.html"
- * target="_blank">http://www.wvware.com/caolan/ora-wmf.html</a>
- * for more information on the WMF image format.</p>
- *
- * @return A WMF image of the Thumbnail
- * @throws HPSFException if the Thumbnail isn't CFTAG_WINDOWS and
- * CF_METAFILEPICT
- */
- public byte[] getThumbnailAsWMF() throws HPSFException
- {
- if (!(getClipboardFormatTag() == CFTAG_WINDOWS))
- throw new HPSFException("Clipboard Format Tag of Thumbnail must " +
- "be CFTAG_WINDOWS.");
- if (!(getClipboardFormat() == CF_METAFILEPICT)) {
- throw new HPSFException("Clipboard Format of Thumbnail must " +
- "be CF_METAFILEPICT.");
- }
- byte[] thumbnail = getThumbnail();
- int wmfImageLength = thumbnail.length - OFFSET_WMFDATA;
- byte[] wmfImage = new byte[wmfImageLength];
- System.arraycopy(thumbnail,
- OFFSET_WMFDATA,
- wmfImage,
- 0,
- wmfImageLength);
- return wmfImage;
- }
- }
|