org.apache.pdfbox.printing

Class PDFPrinter

java.lang.Object

org.apache.pdfbox.printing.PDFPrinter

public class PDFPrinter
extends Object

Prints a PDF document using AWT. This class may be overridden in order to perform custom printing.

Author:

John Hewson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PDFPrinter.PDFPageable
protected class	PDFPrinter.PDFPrintable

Field Summary

Fields

Modifier and Type	Field and Description
protected PDDocument	document
protected float	dpi
protected Orientation	orientation
protected Paper	paper
protected PrinterJob	printerJob
protected PDFRenderer	renderer
protected Scaling	scaling
protected boolean	showPageBorder

Constructor Summary

Constructors

Constructor and Description
PDFPrinter(PDDocument document) Creates a new PDFPrinter using the system's default printer.
PDFPrinter(PDDocument document, PrinterJob printerJob) Creates a new PDFPrinter using the given printer.
PDFPrinter(PDDocument document, PrinterJob printerJob, Scaling scaling, Orientation orientation, Paper paper, boolean showPageBorder, float dpi) Creates a new PDFPrinter using the given printer, the given page scaling and orientation, and with optional page borders shown.
PDFPrinter(PDDocument document, Scaling scaling, Orientation orientation) Creates a new PDFPrinter using the system's default printer, with the given page scaling and orientation.
PDFPrinter(PDDocument document, Scaling scaling, Orientation orientation, Paper paper) Creates a new PDFPrinter using the system's default printer, with the given page scaling and orientation.
PDFPrinter(PDDocument document, Scaling scaling, Orientation orientation, Paper paper, float dpi) Creates a new PDFPrinter using the system's default printer, with the given page scaling and orientation.

Method Summary

Modifier and Type	Method and Description
Pageable	getPageable() Returns the Pageable instance used in this class.
boolean	print() Prints the given document using the default printer without prompting the user.
boolean	print(PrinterJob printerJob) Prints the given document using the default printer without prompting the user.
boolean	print(PrinterJob printerJob, PrintRequestAttributeSet attributes) Prints the given document using the default printer without prompting the user.
boolean	print(PrintRequestAttributeSet attributes) Prints the given document using the default printer without prompting the user.
void	silentPrint() Prints the given document using the default printer without prompting the user.
void	silentPrint(PrinterJob printerJob) Prints the given document using the default printer without prompting the user.
boolean	silentPrint(PrintRequestAttributeSet attributes) Prints the given document using the default printer without prompting the user.

Methods inherited from class java.lang.Object

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

Field Detail

document

protected final PDDocument document

renderer

protected final PDFRenderer renderer

printerJob

protected final PrinterJob printerJob

scaling

protected final Scaling scaling

orientation

protected final Orientation orientation

showPageBorder

protected final boolean showPageBorder

paper

protected final Paper paper

dpi

protected final float dpi

Constructor Detail

PDFPrinter

public PDFPrinter(PDDocument document)
           throws PrinterException

Creates a new PDFPrinter using the system's default printer.

Parameters:

document - the document to print

Throws:

PrinterException - if the document permissions don't allow printing

PDFPrinter

public PDFPrinter(PDDocument document,
                  PrinterJob printerJob)
           throws PrinterException

Creates a new PDFPrinter using the given printer.

Parameters:

document - the document to print

printerJob - the printer job to use

Throws:

PrinterException - if the document permissions don't allow printing

PDFPrinter

public PDFPrinter(PDDocument document,
                  Scaling scaling,
                  Orientation orientation)
           throws PrinterException

Creates a new PDFPrinter using the system's default printer, with the given page scaling and orientation.

Parameters:

document - the document to print

scaling - page scaling policy

orientation - page orientation policy

Throws:

PrinterException - if the document permissions don't allow printing

PDFPrinter

public PDFPrinter(PDDocument document,
                  Scaling scaling,
                  Orientation orientation,
                  Paper paper)
           throws PrinterException

Creates a new PDFPrinter using the system's default printer, with the given page scaling and orientation.

Parameters:

document - the document to print

scaling - page scaling policy

orientation - page orientation policy

paper - the physical characteristics of a piece of paper

Throws:

PrinterException - if the document permissions don't allow printing

PDFPrinter

public PDFPrinter(PDDocument document,
                  Scaling scaling,
                  Orientation orientation,
                  Paper paper,
                  float dpi)
           throws PrinterException

Creates a new PDFPrinter using the system's default printer, with the given page scaling and orientation.

Parameters:

document - the document to print

scaling - page scaling policy

orientation - page orientation policy

paper - the physical characteristics of a piece of paper

dpi - if non-zero then the image will be rasterized at the given DPI

Throws:

PrinterException - if the document permissions don't allow printing

PDFPrinter

public PDFPrinter(PDDocument document,
                  PrinterJob printerJob,
                  Scaling scaling,
                  Orientation orientation,
                  Paper paper,
                  boolean showPageBorder,
                  float dpi)
           throws PrinterException

Creates a new PDFPrinter using the given printer, the given page scaling and orientation, and with optional page borders shown.

Parameters:

document - the document to print

printerJob - the printer job to use

scaling - page scaling policy

orientation - page orientation policy

paper - the physical characteristics of a piece of paper

showPageBorder - true if page borders are to be printed

dpi - if non-zero then the image will be rasterized at the given DPI

Throws:

PrinterException - if the document permissions don't allow printing

Method Detail

silentPrint

public void silentPrint()
                 throws PrinterException

Prints the given document using the default printer without prompting the user.

Throws:

PrinterException - if the document cannot be printed

silentPrint

public boolean silentPrint(PrintRequestAttributeSet attributes)
                    throws PrinterException

Prints the given document using the default printer without prompting the user.

Parameters:

attributes - application supplied attributes

Returns:

true if the user does not cancel the dialog

Throws:

PrinterException - if the document cannot be printed

silentPrint

public void silentPrint(PrinterJob printerJob)
                 throws PrinterException

Prints the given document using the default printer without prompting the user.

Parameters:

printerJob - a printer job definition

Throws:

PrinterException - if the document cannot be printed

print

public boolean print()
              throws PrinterException

Prints the given document using the default printer without prompting the user. The image is generated using PageDrawer. This is a convenience method to create the java.awt.print.PrinterJob. Advanced printing tasks can be performed using getPageable() instead.

Returns:

true if the user does not cancel the dialog

Throws:

PrinterException - if the document cannot be printed

print

public boolean print(PrintRequestAttributeSet attributes)
              throws PrinterException

Prints the given document using the default printer without prompting the user. The image is generated using PageDrawer. This is a convenience method to create the java.awt.print.PrinterJob. Advanced printing tasks can be performed using getPageable() instead.

Parameters:

attributes - application supplied attributes

Returns:

true if the user does not cancel the dialog

Throws:

PrinterException - if the document cannot be printed

print

public boolean print(PrinterJob printerJob)
              throws PrinterException

Prints the given document using the default printer without prompting the user.

Parameters:

printerJob - the printer job.

Returns:

true if the user does not cancel the dialog

Throws:

PrinterException - if the document cannot be printed

print

public boolean print(PrinterJob printerJob,
                     PrintRequestAttributeSet attributes)
              throws PrinterException

Prints the given document using the default printer without prompting the user.

Parameters:

printerJob - the printer job.

attributes - application supplied attributes

Returns:

true if the user does not cancel the dialog

Throws:

PrinterException - if the document cannot be printed

getPageable

public Pageable getPageable()

Returns the Pageable instance used in this class. Can be overridden by subclasses.