com.qoppa.pdfWeb

Class PDFWeb

java.lang.Object

com.qoppa.pdfWeb.PDFWeb

public class PDFWeb
extends Object

The PDFWeb class provides methods to load PDF documents and export web content. The object can export pages as SVG. Documents can be loaded from the file system, from a URL or from a Java InputStream.

The class can export the SVG files using the file system or an output stream.

Author:

Qoppa Software

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDFWeb.KeyInfoWeb This is the Main-Class for the jPDFWeb.jar that can generate server key requests, validate a key, and display server information.

Field Summary

Fields

Modifier and Type	Field and Description
static int	IMGFMT_JPEG
static int	IMGFMT_PNG

Constructor Summary

Constructors

Constructor and Description
PDFWeb(InputStream inStream, IPassword password) Loads a PDF document from an InputStream.
PDFWeb(com.qoppa.pdf.source.PDFSource source, IPassword password) Loads a PDF document from a PDFSource object.
PDFWeb(String filePath, IPassword password) Loads a PDF document from a file.
PDFWeb(URL url, IPassword password) Loads a PDF document from a URL.

Method Summary

Modifier and Type	Method and Description
void	close() Close / release all resources held by this document.
DocumentInfo	getDocumentInfo() Returns a DocumentInfo object containing the information section of a PDF document (author, title, etc.)
int	getPageCount() Returns the number of pages in this document.
AllPDFPermissions	getPDFPermissions() Returns the AllPDFPermissions object which encompasses this document's PasswordPermissions, DocMDPPermissions, and UsageRightsPermissions.
static String	getVersion() Returns version string for jPDFWeb.
static void	loadLicense(InputStream licenseStream) Method to load a license file from an inputstream.
static void	loadLicense(String licenseFile) Method to load a license file.
void	saveDocumentAsSVG(String filePath) Save the entire document as SVG with default SVG options
void	saveDocumentAsSVG(String filePath, SVGOptions options) Save the entire document as SVG to the given file.
void	saveDocumentAsSVG(Writer outWriter) Save the entire document as SVG with default SVG options
void	saveDocumentAsSVG(Writer outWriter, SVGOptions options) Save the entire document as SVG to a Writer.
void	saveDocumentAsSVG(Writer outWriter, SVGOptions options, List<Integer> pageNumbers) Save the specified pages of the document as SVG to a Writer.
void	savePageAsSVG(int pageIndex, String filePath) Save the page to the specified file in SVG format using default SVG options
void	savePageAsSVG(int pageIndex, SVGOptions options, String filePath) Save the page to the specified file in SVG format using specified SVG options.
void	savePageAsSVG(int pageIndex, SVGOptions options, Writer outWriter) Save the page to the given Writer in SVG format using specified SVG options.
void	savePageAsSVG(int pageIndex, Writer outWriter) Save page to the given Writer in SVG format using default SVG options
void	savePageBundleSVG(SVGBundleWriter writer, SVGOptions options) This method saves all the pages in a PDF as SVG files in a "bundle".
void	savePageImage(int pageIndex, int resDPI, int imageFormat, OutputStream outStream) Save page image to file @ specified DPI This can be used to generate a page thumbnail image.
void	savePageImage(int pageIndex, int resDPI, int imageFormat, String filePath) Save page image to file @ specified DPI This can be used to generate a page thumbnail image.
static boolean	setKey(String key) Method to unlock the production version of the library.

Methods inherited from class java.lang.Object

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

Field Detail

IMGFMT_PNG

public static final int IMGFMT_PNG

See Also:

Constant Field Values

IMGFMT_JPEG

public static final int IMGFMT_JPEG

See Also:

Constant Field Values

Constructor Detail

PDFWeb

public PDFWeb(String filePath,
              IPassword password)
       throws PDFException

Loads a PDF document from a file.

Parameters:

filePath - Name of the PDF file.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

PDFWeb

public PDFWeb(InputStream inStream,
              IPassword password)
       throws PDFException

Loads a PDF document from an InputStream.

Parameters:

inStream - InputStream to read the PDF document.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

PDFWeb

public PDFWeb(URL url,
              IPassword password)
       throws PDFException

Loads a PDF document from a URL.

Parameters:

url - Location of the PDF document.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

PDFWeb

public PDFWeb(com.qoppa.pdf.source.PDFSource source,
              IPassword password)
       throws PDFException

Loads a PDF document from a PDFSource object. Implementations of PDFSource can be found in the com.qoppa.pdf.source package or can be implemented by the host application for custom PDF sources.

Parameters:

source - Source for PDF document

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

Method Detail

close

public void close()

Close / release all resources held by this document. After this method is called, this object becomes invalid and should not be used anymore.

setKey

public static boolean setKey(String key)

Method to unlock the production version of the library.

Parameters:

key - Production key.

Returns:

Flag indicating (TODO)

loadLicense

public static void loadLicense(InputStream licenseStream)
                        throws com.qoppa.pdf.LicenseException

Method to load a license file from an inputstream. This is useful when the license file is placed in the classpath of the host application and an input stream can be opened to it as a resource.

Parameters:

licenseStream - The input stream for the license file contents.

Throws:

com.qoppa.pdf.LicenseException - If there are any problems with the license file

loadLicense

public static void loadLicense(String licenseFile)
                        throws com.qoppa.pdf.LicenseException,
                               IOException

Method to load a license file.

Parameters:

licenseFile - The full path to the license file.

Throws:

com.qoppa.pdf.LicenseException - If there are any problems with the license file

IOException

getVersion

public static String getVersion()

Returns version string for jPDFWeb. If this is the demo version, the return string will contain 'Demo Version' at the end.

getDocumentInfo

public DocumentInfo getDocumentInfo()

Returns a DocumentInfo object containing the information section of a PDF document (author, title, etc.)

Returns:

DocumentInfo Object containing header information for the document.

getPageCount

public int getPageCount()

Returns the number of pages in this document.

Returns:

Number of pages in PDF document

getPDFPermissions

public AllPDFPermissions getPDFPermissions()

Returns the AllPDFPermissions object which encompasses this document's PasswordPermissions, DocMDPPermissions, and UsageRightsPermissions.

savePageImage

public void savePageImage(int pageIndex,
                          int resDPI,
                          int imageFormat,
                          String filePath)
                   throws IOException,
                          PDFException,
                          IllegalArgumentException

Save page image to file @ specified DPI This can be used to generate a page thumbnail image.

Parameters:

pageIndex - The 0-based page index.

resDPI - Dots per inch at which to render the image. 72 is the PDF native DPI and 100% scale

imageFormat - Format for output image (IMGFMT_PNG or IMGFMT_JPEG)

filePath - Path for page image file

Throws:

IOException

PDFException

IllegalArgumentException

savePageImage

public void savePageImage(int pageIndex,
                          int resDPI,
                          int imageFormat,
                          OutputStream outStream)
                   throws IOException,
                          PDFException,
                          IllegalArgumentException

Save page image to file @ specified DPI This can be used to generate a page thumbnail image.

Parameters:

pageIndex - The 0-based page index.

resDPI - Dots per inch at which to render the image. 72 is the PDF native DPI and 100% scale

imageFormat - Format for output image (IMGFMT_PNG or IMGFMT_JPEG)

outStream - Output stream for image

Throws:

IOException

PDFException

IllegalArgumentException

savePageAsSVG

public void savePageAsSVG(int pageIndex,
                          String filePath)
                   throws IOException,
                          PDFException,
                          IllegalArgumentException

Save the page to the specified file in SVG format using default SVG options

Parameters:

pageIndex - The 0-based page index.

filePath - The name of the SVG file.

Throws:

IOException

PDFException

IllegalArgumentException

savePageAsSVG

public void savePageAsSVG(int pageIndex,
                          Writer outWriter)
                   throws IOException,
                          PDFException,
                          IllegalArgumentException

Save page to the given Writer in SVG format using default SVG options

Parameters:

pageIndex - The 0-based page index.

outWriter - Writer for page output

Throws:

IOException

PDFException

IllegalArgumentException

savePageAsSVG

public void savePageAsSVG(int pageIndex,
                          SVGOptions options,
                          String filePath)
                   throws IOException,
                          PDFException,
                          IllegalArgumentException

Save the page to the specified file in SVG format using specified SVG options.

Parameters:

pageIndex - The 0-based page index.

options - Options to use when writing the SVG file.

filePath - The name of the SVG file.

Throws:

IOException

PDFException

IllegalArgumentException

savePageAsSVG

public void savePageAsSVG(int pageIndex,
                          SVGOptions options,
                          Writer outWriter)
                   throws IOException,
                          PDFException,
                          IllegalArgumentException

Save the page to the given Writer in SVG format using specified SVG options.

Parameters:

pageIndex - The 0-based page index.

options - Options to use when writing the SVG file.

outWriter - Writer for page output

Throws:

IOException

PDFException

IllegalArgumentException

saveDocumentAsSVG

public void saveDocumentAsSVG(String filePath)
                       throws PDFException,
                              IOException,
                              IllegalArgumentException

Save the entire document as SVG with default SVG options

Parameters:

filePath - Complete path for SVG output file

Throws:

PDFException

IOException

IllegalArgumentException

saveDocumentAsSVG

public void saveDocumentAsSVG(Writer outWriter)
                       throws PDFException,
                              IOException,
                              IllegalArgumentException

Save the entire document as SVG with default SVG options

Parameters:

outWriter - Writer for SVG output

Throws:

PDFException

IOException

IllegalArgumentException

saveDocumentAsSVG

public void saveDocumentAsSVG(String filePath,
                              SVGOptions options)
                       throws PDFException,
                              IOException,
                              IllegalArgumentException

Save the entire document as SVG to the given file. This method takes a SVGOptions object as an argument to describe various SVG options when saving the file.

Parameters:

filePath - The name of the file to write the SVG image to.

options - Options to use when saving the SVG file.

Throws:

PDFException

IOException

IllegalArgumentException

saveDocumentAsSVG

public void saveDocumentAsSVG(Writer outWriter,
                              SVGOptions options)
                       throws PDFException,
                              IOException

Save the entire document as SVG to a Writer. This method takes a SVGOptions object as an argument to describe various SVG options when saving the file.

Parameters:

outWriter - Writer for SVG output

options - Options to use when saving the SVG file.

Throws:

PDFException

IOException

saveDocumentAsSVG

public void saveDocumentAsSVG(Writer outWriter,
                              SVGOptions options,
                              List<Integer> pageNumbers)
                       throws PDFException,
                              IOException

Save the specified pages of the document as SVG to a Writer. This method takes a SVGOptions object as an argument to describe various SVG options when saving the file.

Parameters:

outWriter - Writer for SVG output

options - Options to use when saving the SVG file.

pageNumbers - Subset of page numbers to save to the SVG file.

Throws:

PDFException

IOException

savePageBundleSVG

public void savePageBundleSVG(SVGBundleWriter writer,
                              SVGOptions options)
                       throws PDFException,
                              IOException

This method saves all the pages in a PDF as SVG files in a "bundle". The bundle consists of a file called fonts.css to hold all the fonts used in the document and then one .svg file for each page. Each page's svg file imports the fonts.css file to access the fonts in the document.
The intent is to be able to serve pages separately to a browser in a way that is efficient to page across pages. This is especially the case because browsers tend to cache fonts if they are defined uniquely across pages.

Parameters:

writer - An interface to a class that will handle the actual writing of the files. By having this as an interface, the bundle can be written directly to a zip file, a database or to a folder.

options - Options to use when writing the SVG file.

Throws:

PDFException - Thrown when there is any errors reading the PDF document.

IOException - Thrown when there are I/O errors