com.qoppa.pdfPrint

Class PDFPrint

java.lang.Object

com.qoppa.pdfPrint.PDFPrint

All Implemented Interfaces:

Printable

public class PDFPrint
extends Object
implements Printable

The PDFPrint class provides methods to print a pdf document.

Author:

Qoppa Software

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
PDFPrint(InputStream inStream, IPassword password) Loads a PDF document from an InputStream.
PDFPrint(String fileName, IPassword password) Loads a PDF document from a file.
PDFPrint(URL url, IPassword password) Loads a PDF document from a URL.

Method Summary

Modifier and Type	Method and Description
void	addPrintListener(PrintListener printListener) Adds a PrintListener to the PDFDocument
void	close() Close / release all resources held by this document.
SimpleDoc	createSimpleDoc(DocAttributeSet attributes) Creates and returns a SimpleDoc, with the specified doc attribute set, which can be used in many common printing requests.
Pageable	getPageable(PrinterJob pJob) Returns an object that implements Pageable for this PDF document.
int	getPageCount() Returns the number of pages in this document.
PageFormat	getPageFormat(int pageIndex) Returns a PageFormat object for the given page.
PrintSettings	getPrintSettings() Returns the PrintSettings that will be used when printing the document.
static String	getVersion() Returns version string for jPDFPrint.
IWatermark	getWatermark() Returns the watermark for the PDFPrint document.
boolean	isPrintAllowed() Returns whether this document has permissions to print.
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.
int	print(Graphics graphics, PageFormat pageFormat, int pageIndex) Prints the page.
void	print(PrintSettings printSettings) Prints this PDF document.
void	print(String printerName, PrintSettings printSettings) Prints this PDF document to the specified printer, by name.
static void	print(String fileName, PrintSettings printSettings, IPassword password) Convenience method to print a PDF document from a file.
void	print(String printerName, PrintSettings printSettings, PrintRequestAttributeSet printAttrSet) Prints this PDF document to the specified printer, by name and passes the attribute set to the printer job.
static void	print(String fileName, String printerName, PrintSettings printSettings, IPassword password) Convenience method to print a PDF document from a file to a named printer.
void	printAsImage(String printerName, PrintSettings printSettings, PrintRequestAttributeSet printAttrSet) Prints this document by first converting each page to an image and then sending the image to the printer.
void	printToDefaultPrinter(PrintSettings printSettings) Prints the PDF document to the default printer.
void	removePrintListener(PrintListener printListener) Removes a PrintListener from the PDFDocument
static boolean	setAppletKey(String key, Applet applet) Method to unlock the production version of the library.
static boolean	setKey(String key) Method to unlock the production version of the library.
void	setPrintSettings(PrintSettings printSettings) Set the PrintSettings used when printing this document while using the class as a Printable (rather than calling one of the print methods).
void	setWatermark(IWatermark watermark) Sets the watermark on the PDFPrint document.
boolean	usePermissionsPassword(String ownerPassword) Tells the PDFPrint object that the permissions password is known, so all permissions are granted.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFPrint

public PDFPrint(String fileName,
                IPassword password)
         throws PDFException

Loads a PDF document from a file.

Parameters:

fileName - 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

PDFPrint

public PDFPrint(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

PDFPrint

public PDFPrint(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

Method Detail

print

public static void print(String fileName,
                         PrintSettings printSettings,
                         IPassword password)
                  throws PrinterException,
                         PDFException

Convenience method to print a PDF document from a file. This method will prompt the user with the printer dialog and then print the document. This method is equivalent to:

PDFPrint pdfPrint = new PDFPrint (fileName, pwdHandler);
pdfPrint.print (printSettings);

Parameters:

fileName - Name of the PDF file.

printSettings - Print job settings. Use this object to tell the library how to print the document. The library uses default settings when null is used.

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:

PrinterException

PDFException

print

public static void print(String fileName,
                         String printerName,
                         PrintSettings printSettings,
                         IPassword password)
                  throws PrinterException,
                         PDFException

Convenience method to print a PDF document from a file to a named printer. This method is equivalent to:

PDFPrint pdfPrint = new PDFPrint (fileName, pwdHandler);
pdfPrint.print (printerName, printSettings);

Parameters:

fileName - Name of the PDF file.

printerName - Name of the printer to print to. If null, prints to the default printer.

printSettings - Print job settings. Use this object to tell the library how to print the document. The library uses default settings when null is used.

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:

PrinterException

PDFException

print

public void print(PrintSettings printSettings)
           throws PDFPermissionException,
                  PrinterException

Prints this PDF document. This method will prompt the user with the printer dialog and then print the document.

If finer control of printing is necessary, the PDFPrint object implements both Printable and Pageable (through the getPageable method). The host application can then create its own PrinterJob and set any settings necessary, then call either setPageable or setPrintable and then start the print job.

Parameters:

printSettings - Print job settings. Use this object to tell the library how to print the document. If null, the library will print using default settings.

Throws:

PDFPermissionException

PrinterException

print

public void print(String printerName,
                  PrintSettings printSettings)
           throws PDFPermissionException,
                  PrinterException

Prints this PDF document to the specified printer, by name. This method will print the PDF document silently (without showing the printer dialog) to the named printer. If the printerName parameter is null, this method will print to the default printer.

This method can only be called if using Java 1.4.2 or higher as it needs PrintServices, which were only implemented starting on 1.4.

If finer control of printing is necessary, the PDFPrint object implements both Printable and Pageable (through its getPageable method). The host application can then create its own PrinterJob and set any settings necessary, then call either setPageable or setPrintable and then start the print job.

Parameters:

printSettings - Print job settings. Use this object to tell the library how to print the document. If null, the library will print using default settings.

printerName - The name of the printer to print to. If this parameter is set to null, the method will print to the default printer.

Throws:

PrinterException - This exception is thrown if the printer is not found or if there is an error while printing.

PDFPermissionException

print

public void print(String printerName,
                  PrintSettings printSettings,
                  PrintRequestAttributeSet printAttrSet)
           throws PDFPermissionException,
                  PrinterException

Prints this PDF document to the specified printer, by name and passes the attribute set to the printer job. This method will print the PDF document silently (without showing the printer dialog) to the named printer. If the printerName parameter is null, this method will print to the default printer. If the printAttrSet parameter is null, the printer job will use its default settings.

This method can only be called if using Java 1.4.2 or higher as it needs PrintServices, which were only implemented starting on 1.4.

If finer control of printing is necessary, the PDFPrint object implements both Printable and Pageable (through its getPageable method). The host application can then create its own PrinterJob and set any settings necessary, then call either setPageable or setPrintable and then start the print job.

Parameters:

printSettings - Print job settings. Use this object to tell the library how to print the document. If null, the library will print using default settings.

printerName - The name of the printer to print to. If this parameter is set to null, the method will print to the default printer.

printAttrSet - The attribute set to pass to the printer. This parameter simply gets passed through to the printer job to set options such as the media tray, chromaticity and others. If null is passed, the print job will use default attributes.

Throws:

PrinterException - This exception is thrown if the printer is not found or if there is an error while printing.

PDFPermissionException

printToDefaultPrinter

public void printToDefaultPrinter(PrintSettings printSettings)
                           throws PDFPermissionException,
                                  PrinterException

Prints the PDF document to the default printer. This method will print the PDF document silently (without showing the printer dialog) to the default printer.

Parameters:

printSettings - Print job settings. Use this object to tell the library how to print the document. If null, the library will print using default settings.

Throws:

PrinterException - This exception is thrown if the printer is not found or if there is an error while printing.

PDFPermissionException

createSimpleDoc

public SimpleDoc createSimpleDoc(DocAttributeSet attributes)

Creates and returns a SimpleDoc, with the specified doc attribute set, which can be used in many common printing requests.

Example:

   PrintService printService = PrintServiceLookup.lookupDefaultPrintService();
   DocPrintJob printJob = printService.createPrintJob();
   
   DocumentName docName = new DocumentName("Doc Name", Locale.getDefault());
   HashDocAttributeSet attributes = new HashDocAttributeSet(docName);
   
   try {
     PDFPrint pdfPrint = new PDFPrint("sampleFile.pdf", null);
     printJob.print(pdfPrint.createSimpleDoc(attributes), null);
   }
   catch (PDFException e) {
     e.printStackTrace();
   }
   catch (PrintException e) {
     e.printStackTrace();
   }
 

Parameters:

attributes - a DocAttributeSet, which can be null

Returns:

a SimpleDoc object

setKey

public static boolean setKey(String key)

Method to unlock the production version of the library.

Parameters:

key - Production key.

loadLicense

public static void loadLicense(InputStream licenseStream)
                        throws 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:

LicenseException - If there are any problems with the license file

loadLicense

public static void loadLicense(String licenseFile)
                        throws LicenseException,
                               IOException

Method to load a license file.

Parameters:

licenseFile - The full path to the license file.

Throws:

LicenseException - If there are any problems with the license file

IOException

setAppletKey

public static boolean setAppletKey(String key,
                                   Applet applet)

Method to unlock the production version of the library.

Parameters:

key - Production key.

getVersion

public static String getVersion()

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

print

public int print(Graphics graphics,
                 PageFormat pageFormat,
                 int pageIndex)
          throws PrinterException

Prints the page. This method fulfills the Printable interface and usually gets called by PrinterJob when printing the document.

Specified by:

print in interface Printable

Throws:

PrinterException

getPrintSettings

public PrintSettings getPrintSettings()

Returns the PrintSettings that will be used when printing the document.

Returns:

PrintSettings Print settings used when printing.

getPageable

public Pageable getPageable(PrinterJob pJob)

Returns an object that implements Pageable for this PDF document. The method takes a PrinterJob object as a parameter because information about the printer is needed in order to fulfill the Pageable interface properly.

Parameters:

pJob - PrinterJob object where the Pageable will be used.

Returns:

Object that implements the Pageable interface.

setPrintSettings

public void setPrintSettings(PrintSettings printSettings)

Set the PrintSettings used when printing this document while using the class as a Printable (rather than calling one of the print methods).

Parameters:

printSettings - PrintSettings to use when printing.

getPageFormat

public PageFormat getPageFormat(int pageIndex)
                         throws IndexOutOfBoundsException

Returns a PageFormat object for the given page. Page indices are 0 based (1st page is pageIndex 0).

Returns:

PageFormat A PageFormat object describing the page dimensions.

Throws:

IndexOutOfBoundsException

getPageCount

public int getPageCount()

Returns the number of pages in this document.

isPrintAllowed

public boolean isPrintAllowed()

Returns whether this document has permissions to print.

Returns:

Boolean flag indicating if this document has permissions to print.

close

public void close()

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

usePermissionsPassword

public boolean usePermissionsPassword(String ownerPassword)
                               throws PDFException

Tells the PDFPrint object that the permissions password is known, so all permissions are granted.

Parameters:

ownerPassword - The permissions password

Returns:

true if the password was validated

Throws:

PDFException

setWatermark

public void setWatermark(IWatermark watermark)

Sets the watermark on the PDFPrint document. The PDFPrint document will make callbacks to this watermark with type IWatermark.TYPE_PRINT when printing the document.

Parameters:

watermark - the IWatermark object to use when printing the PDFPrint document

getWatermark

public IWatermark getWatermark()

Returns the watermark for the PDFPrint document.

Returns:

the IWatermark object

See Also:

setWatermark(com.qoppa.pdf.IWatermark)

addPrintListener

public void addPrintListener(PrintListener printListener)

Adds a PrintListener to the PDFDocument

Parameters:

printListener - - the PrintListener to be added

removePrintListener

public void removePrintListener(PrintListener printListener)

Removes a PrintListener from the PDFDocument

Parameters:

printListener - - the PrintListener to be removed

printAsImage

public void printAsImage(String printerName,
                         PrintSettings printSettings,
                         PrintRequestAttributeSet printAttrSet)
                  throws PDFPermissionException,
                         PrinterException

Prints this document by first converting each page to an image and then sending the image to the printer. This method is here as a workaround to Java JDK issues where in some rare cases, the full page is not printed correctly.
When converting to an image, the method looks at the printer's DPI and creates an image of the page using that DPI. By doing this, there should be no loss in quality. However, this might cause performance issues because a full page image at high DPI values can get quite large, so this method should only be used when standard printing has issues.

Parameters:

printerName - The name of the printer to print to. If this parameter is set to null, the method will print to the default printer.

printSettings - Print job settings. Use this object to tell the library how to print the document. If null, the library will print using default settings.

printAttrSet - The attribute set to pass to the printer. This parameter simply gets passed through to the printer job to set options such as the media tray, chromaticity and others. If null is passed, the print job will use default attributes.

Throws:

PDFPermissionException - This exception is thrown if the PDF does not allow for printing.

PrinterException - This exception is thrown if the printer is not found or if there is an error while printing.

PrinterException