Package org.jpedal.examples.html

Class PDFtoHTML5Converter

java.lang.Object

org.jpedal.examples.html.PDFtoHTML5Converter

public class PDFtoHTML5Converter
extends Object

Clean API for converting PDF files to HTML5

Examples

The following set of examples demonstrates some of the most common uses of PDFtoHTML5Converter

Conversion with IDRViewer (BuildVu Only)

This example includes a fully-featured HTML5 document viewer the converted PDF file is displayed within. This mode is recommended for users who would like a configurable viewer solution with minimal setup.

 
     HTMLConversionOptions conversionOptions = new HTMLConversionOptions();//Set conversion options here
     conversionOptions.setDisableComments(true);

     IDRViewerOptions viewerOptions = new IDRViewerOptions();//Set viewer options here

     File pdfFile = new File("C:/MyDocument.pdf");
     File outputDir = new File("C:/MyOutputDirectory/");

     //Alternative constructor exists for converting from byte array
     PDFtoHTML5Converter converter = new PDFtoHTML5Converter(pdfFile, outputDir, conversionOptions, viewerOptions);

     try {
         converter.convert();
     } catch (PdfException e) {
         e.printStackTrace();
     }
 
 

Conversion With No Viewer (BuildVu Only)

This example converts PDF files in a simple way that allows the output to be built upon, for example for to build a custom viewer solution around the content or to use within a CMS/ERP system. Also included in the output is a properties.json file that includes information that could help build your viewing solution such as the page count, page bounds, title/author (if set), as well as any bookmarks the PDF file contains.

 
     HTMLConversionOptions conversionOptions = new HTMLConversionOptions();//Set conversion options here
     conversionOptions.setDisableComments(true);

     ContentOptions contentOptions = new ContentOptions();//Set content options here

     File pdfFile = new File("C:/MyDocument.pdf");
     File outputDir = new File("C:/MyOutputDirectory/");

     //Alternative constructor exists for converting from byte array
     PDFtoHTML5Converter converter = new PDFtoHTML5Converter(pdfFile, outputDir, conversionOptions, contentOptions);

     try {
         converter.convert();
     } catch (PdfException e) {
         e.printStackTrace();
     }
 
 

Conversion With Forms Viewer (FormVu Only)

This example converts PDF Forms using our fully featured forms viewer

 
     HTMLConversionOptions conversionOptions = new HTMLConversionOptions();//Set conversion options here

     FormViewerOptions formViewerOptions = new FormViewerOptions();//Set content options here

     File pdfFile = new File("C:/MyDocument.pdf");
     File outputDir = new File("C:/MyOutputDirectory/");

     //Alternative constructor exists for converting from byte array
     PDFtoHTML5Converter converter = new PDFtoHTML5Converter(pdfFile, outputDir, conversionOptions, formViewerOptions);

     try {
         converter.convert();
     } catch (PdfException e) {
         e.printStackTrace();
     }
 
 

Constructor Summary

Constructors

Constructor	Description
PDFtoHTML5Converter(byte[] pdfFileAsBytes, File outputDirectory, HTMLConversionOptions htmlConversionOptions, OutputModeOptions outputModeOptions)	Constructs a new PDFtoHTML5Converter.
PDFtoHTML5Converter(File pdfFile, File outputDirectory, HTMLConversionOptions htmlConversionOptions, OutputModeOptions outputModeOptions)	Constructs a new PDFtoHTML5Converter.

Method Summary

Modifier and Type	Method	Description
void	convert()	Start converting the PDF file.
void	setCustomErrorTracker(ErrorTracker customErrorTracker)	Sets a custom ErrorTracker to use during conversion allowing you to track errors and provide a timeout.
void	setCustomIO(CustomIO customIO)	Sets a CustomIO to use during conversion, allowing you to control the output.
void	setEncryptTempFiles()	Enables encryption of all temporary files that may be created during the conversion process.
void	setPassword(String password)	Handle PDF if encrypted (may need password which must be passed in)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PDFtoHTML5Converter

public PDFtoHTML5Converter(byte[] pdfFileAsBytes,
                           File outputDirectory,
                           HTMLConversionOptions htmlConversionOptions,
                           OutputModeOptions outputModeOptions)

Constructs a new PDFtoHTML5Converter. Call convert() to convert the PDF.

Parameters:

pdfFileAsBytes - The PDF file you wish to convert in a byte[] array.

outputDirectory - The directory you would like the converted PDF output to.

htmlConversionOptions - The HTMLConversionOptions object containing the settings to use in the conversion.

outputModeOptions - The OutputModeOptions object containing the output mode settings to use in the conversion.

PDFtoHTML5Converter

public PDFtoHTML5Converter(File pdfFile,
                           File outputDirectory,
                           HTMLConversionOptions htmlConversionOptions,
                           OutputModeOptions outputModeOptions)

Constructs a new PDFtoHTML5Converter. Call convert() to convert the PDF.

Parameters:

pdfFile - The PDF file you wish to convert.

outputDirectory - The directory you would like the converted PDF output to.

htmlConversionOptions - The HTMLConversionOptions object containing the settings to use in the conversion.

outputModeOptions - The OutputModeOptions object containing the output mode settings to use in the conversion.

Method Detail

convert

public void convert()
             throws PdfException

Start converting the PDF file.

Throws:

PdfException - When the PDF is corrupt, the password is incorrect, or a JVM option used an unknown value.

setCustomErrorTracker

public void setCustomErrorTracker(ErrorTracker customErrorTracker)

Sets a custom ErrorTracker to use during conversion allowing you to track errors and provide a timeout.

ExampleOutputErrorTracker.java is provided as an example implementation.

Parameters:

customErrorTracker - The ErrorTracker to use during conversion.

setCustomIO

public void setCustomIO(CustomIO customIO)

Sets a CustomIO to use during conversion, allowing you to control the output.

DefaultIO.java is provided as an example implementation.

Parameters:

customIO - The CustomIO to use during conversion.

setPassword

public void setPassword(String password)

Handle PDF if encrypted (may need password which must be passed in)

Bouncy Castle provides a default password if the password is not set Otherwise the password is used from the users flag Password is set in PDF creation.

Parameters:

password - The password of the PDF file if it has one.

setEncryptTempFiles

public void setEncryptTempFiles()

Enables encryption of all temporary files that may be created during the conversion process.

Can also be enabled by using the JVM flag -Dorg.jpedal.pdf2html.encryptTempFiles=true