RasterMaster® SDK RasterMaster® for the Java™ Platform V13.7 Programmer’s Reference Guide Note: An online version of this manual contains information on the latest updates to RasterMaster. To find the most recent version of this manual, please visit the online version at www.rastermaster.com or download the most recent version from our website at www.snowbound.com/support/manuals.html. DOC-0141-06 Copyright Information While Snowbound® Software believes the information included in this publication is correct as of the publication date, information in this document is subject to change without notice. UNLESS EXPRESSLY SET FORTH IN A WRITTEN AGREEMENT SIGNED BY AN AUTHORIZED REPRESENTATIVE OF SNOWBOUND SOFTWARE CORPORATION MAKES NO WARRANTY OR REPRESENTATION OF ANY KIND WITH RESPECT TO THE INFORMATION CONTAINED HEREIN, INCLUDING WARRANTY OF MERCHANTABILITY AND FITNESS FOR A PURPOSE. Snowbound Software Corporation assumes no responsibility or obligation of any kind for any errors contained herein or in connection with the furnishing, performance, or use of this document. Software described in Snowbound documents (a) is the property of Snowbound Software Corporation or the third party, (b) isfurnished only under license, and (c) may be copied or used only as expressly permitted under the terms of the license. All contents of this manual are copyrighted by Snowbound Software Corporation. The information contained herein is the exclusive property of Snowbound Software Corporation and shall not be copied, transferred, photocopied, translated on paper, film, electronic media, or computer-readable form, or otherwise reproduced in any way, without the express written permission of Snowbound Software Corporation. Microsoft, MS, MS-DOS, Windows, Windows NT, and SQL Server are either trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries. Adobe, the Adobe logo, Acrobat, and the Acrobat logo are trademarks of Adobe Systems Incorporated. Sun, Sun Microsystems, the Sun Logo, and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. iText, the Initial Developers of the Original Code are Bruno Lowagie and Paolo Soares. Portions created by Bruno Lowagie are Copyright (C) 1999-2009 by Bruno Lowagie. Kakadu JPEG2000©, is copyrighted by Dr. David Taubman, and is proprietary to NewSouth Innovations, Pty. Ltd, Australia. Aspose™, Aspose.Cells© (copyrighted 2003), Aspose.Words© (copyrighted 2003), and Aspose.Slides© (copyrighted 2004), are all proprietary to Aspose Software, Pty. Ltd, Australia. United States Government Restricted Rights The Software is provided with RESTRICTED RIGHTS. Use, duplication or disclosure by the United States Government is subject to restrictions as set forth under subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause of DFARS 252.227 –19 or subparagraphs (c)(i) and (2) of the Commercial Computer Software-Restricted Rights at 48 CFR 52.227 – 19 as applicable. The Manufacturer is Snowbound Software Corporation, 309 Waverley Oaks Rd., Suite 401, Waltham, MA 02452, USA. All other trademarks and registered trademarks are the property of their respective holders. Manual Title: Snowbound RasterMaster® Imaging SDK for the Java Platform Programmer’s Reference Guide Part Number: DOC-0141-06 Revision: 06 RasterMaster® for the Java™ Platform Release Number: 13.7 RasterMaster® SDK Release Number: 13.7 Printing Date: January 2014 Published by Snowbound Software Corporation. 309 Waverley Oaks Road Suite 401 Waltham, MA 02452 USA phone: 617-607-2000 fax: 617-607-2002 ©1996 - 2014 by Snowbound Software Corporation. All rights reserved. Table of Contents Chapter 1 - Quick Start 44 Quickly Getting Started with the Convert Sample 44 Viewing Demos Packaged with the Library 45 Adding RasterMaster Java’s Snowbnd Class to Your Application 46 System Overview 47 Version 13.7 Additions and Improvements 49 Chapter 2 - RasterMaster Java Samples 50 Overview of the Java Samples 50 Running a Sample 50 Running a Sample from the Command Prompt 51 Conversion between Document Formats 51 Simple Conversion: The SimpleConvert Sample 51 Optional Methods 52 Batch Conversion: The BatchConvert Sample 53 Single Conversion: The SingleConversion Sample 54 Simple Conversion with Timeouts: The HangDetector Sample 55 Saving to Searchable PDF: The saveSearchablePDF Sample 56 Printing 56 The Printing Sample 56 The SilentPrint Sample 57 Image Manipulation 57 The Thumbnails Sample 57 iii Watermarks and Redaction: The Watermarks Sample 58 The Manipulation Sample 58 The Color Detection Sample 58 The Save Page to Memory Sample 59 Viewing and Annotating Documents 59 The Viewing and Annotations Sample 59 Working with Vector PDF vs. Raster PDF: The VectorPDF Sample 63 The VectorPDFPageManipulation Sample 63 Scanning 63 The Scanning Sample 63 Chapter 3 - Convert and Save Methods 65 Converting File Formats 65 Automatically Detecting File Formats 65 Supported Pixel Depths 65 Converting Up 8 or 24-bit Pixel Depths 66 File Format Conversion Error Messages 66 Extracting Text 66 Methods Used for File Format Conversion 66 Optional Methods 67 IMG_create_thumbnail(int, int) 68 IMG_decompress_bitmap(String, int) 68 IMG_decompress_bitmap(java.awt.Image, int) 70 IMG_decompress_bitmap(java.io.DataInputStream, int) 70 IMG_decompress_bitmap_fd(String, int, int) 72 iv IMG_decompress_bitmap_stream(String, int) 72 IMG_decompress_bitmap_stream_onthefly(String, int, java.awt.Container) 72 IMG_decompress_fax(java.lang.String, int, int, int, int, int) 73 IMG_decompress_fax(java.io.DataInputStream, int, int, int, int, int) 74 IMG_decompress_multipage_bitmap_stream_onthefly(String, int, java.awt.Container) 75 IMG_save_bitmap(byte, int) 76 IMG_save_bitmap(byte, int, int, int) 77 IMG_save_bitmap(int, int, int, int) 78 IMG_save_bitmap(String, int) 79 IMG_save_document(String, byte, int) 80 IMG_save_document(byte, byte, int) 81 IMGLOW_write_tiff_stream(Dib_Head lpbi, byte, int, int, String) 81 Chapter 4 - Input Documents and Images 83 Determining the Document's Format and its Capabilities 83 getInstance() 83 getAvailibleSaveFormats(int) 83 getAvailibleSaveFormats(String) 84 getFormat(int) 84 getFormat(String) 84 getFormatCode(String) 84 getFormatExtension(int) 85 getFormatExtension(String) 85 getFormatName(String) 85 v isValidMultiFormat(int) 86 isValidMultiFormat(String) 86 isVectorFormat(int) 86 Methods Called from the Format Class 87 canSaveBitDepth(int) 87 getDisplayName() 87 getExtension() 87 getFormatCode() 87 getFormatName() 87 isMultipage() 88 isTiff() 88 isVectorFormat() 88 toString() 88 getErrorMessage(int) 88 Working with Document File Formats 89 IMGLOW_set_document_input(int dpi, int bits_pix, int format); 89 IMGLOW_set_pdf_output(int xsize,int ysize); 90 Working with Color Images 90 Reading Multiple Pages 90 Supported Multi-page Formats 90 Decompressing a Multi-page Image 91 Determining Multi-page Page Count 91 Extracting Text for Searchable PDF output 91 Methods Used for Save Searchable PDF 92 vi Working with RasterMaster Java’s Vector Display Technology 92 Information about ’s Vector Display Technology 93 Implementing ’s Vector Display Technology 93 Methods Used for Vector PDF 93 PDF Redaction Support 94 IMGLOW_redact_page(String, String, rarray, int , int) 94 IMGLOW_redact_page(DataInputStream, rarray, int, int) 95 AFP Specific Considerations 96 Format of Font Mapping Data 96 IMGLOW_set_fontmap_path(String) 97 IMGLOW_set_fontmap(byte[], int) 97 IMGLOW_set_overlay_path(String) 98 PDF Specific Considerations 99 Reading or Decompressing a PDF Document 99 Saving to a PDF Document 99 Changing Output Page Size 100 Performance 100 Office 2007 - 2010 Specific Considerations 100 IMGLOW_get_ooxml_license_path() 100 IMGLOW_set_ooxml_license() 101 IMGLOW_set_ooxml_license_input_stream(InputStream) 102 Ensuring Java Reading for Text-based Formats 102 Overview 102 Chapter 5 - Output Documents and Images 104 vii Image Compression 104 Preferred Formats 104 24-Bit Color Images 104 8-Bit Gray Scale Images 104 1-bit Bi-Level Images 104 Saving to a Raster Image Format 104 IMG_save_bitmap(byte, int) 104 IMG_save_bitmap(byte, int, int, int) 105 IMG_save_bitmap(int, int, int, int) 106 IMG_save_bitmap(String, int) 107 Saving to a Vector Format - Searchable PDF 108 IMG_save_document(String, byte, int) 108 IMG_save_document(byte, byte, int) 109 Saving to Multiple Pages 110 Multi-page Images 110 Supported Multi-page Formats 110 Decompressing a Multi-page Image 110 Determining Multi-page Page Count 110 Saving Multi-page File Formats 110 Methods Used for Multi-page Format Methods 111 RasterMaster® SDK Library 111 Changing the DPI in the RasterMaster® SDKLibrary 111 Chapter 6 - RasterMaster® SDK Image Data Format 113 Overview of Data Formats 113 viii MS_Windows DIB Header Format 113 MS_Windows DIB Palette Format 114 MS_Windows DIB Image Data Format 114 RasterMaster® SDK Library 115 Changing the DPI in the RasterMaster® SDK Library 116 Chapter 7 - Snowbound Classes 117 Snow.Snowbnd 117 alias 117 alias_quality 117 decomp_vect 118 dis_crop_xs, dis_crop_ys, dis_crop_xe, dis_crop_ye 118 dis_dib 119 dis_height, dis_width 119 dis_rotate 119 dis_runs_ptrs[] [] 120 dis_xs, dis_ys, dis_xsize, dis_ysize 120 hsb, vsb 121 PrintStack 121 threshold 121 VERSION_MAJOR 121 VERSION_MAJOR 121 Snow.SnowAnn 122 Snow.Defines 124 Snow.ANN_GRAPHIC_STRUCT 124 ix Constructing a New SnowAnn Object 125 Snow.SANN_POINT 126 Snow.SANN_RECT 126 SnbdWarningCode 127 public boolean hasWarnings() 127 public Vector