Module org.icepdf.ri.viewer

Package org.icepdf.ri.common.print

Class PrintHelperImpl

java.lang.Object

org.icepdf.ri.common.print.PrintHelper

org.icepdf.ri.common.print.PrintHelperImpl

All Implemented Interfaces:

Printable

public class PrintHelperImpl
extends PrintHelper

The PrintHelper class is utility class to aid developers in printing PDF document content. The PrintHelper takes advantage of the Pageable and Printable interfaces availabe in Java 2.

Since:

2.0

Field Summary

Fields inherited from class org.icepdf.ri.common.print.PrintHelper

CLIPPING_FIX_ENABLED, EMPTY_PRINTSERVICE_ARRAY, PRINTER_NAME_ATTRIBUTE

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor	Description
PrintHelperImpl(Container container, PageTree pageTree, float userRotation, DocAttributeSet docAttributeSet, PrintRequestAttributeSet printRequestAttributeSet)	Creates a new PrintHelper instance using the specified doc and print attribute sets.
PrintHelperImpl(Container container, PageTree pageTree, float rotation, MediaSizeName paperSizeName, PrintQuality printQuality)	Creates a new PrintHelper instance using the specified media sized and print quality.

Method Summary

Modifier and Type	Method	Description
CancelablePrintJob	cancelablePrint()
protected PrintService	getSetupDialog()	Utility for creating a print setup dialog.
float	getUserRotation()	Users rotation specified for the print job.
void	print()	Print a range of pages from the document as specified by #setupPrintService.
int	print(Graphics printGraphics, PageFormat pageFormat, int pageIndex)	Prints the page at the specified index into the specified java.awt.Graphics context in the specified format.
void	print(PrintJobWatcher printJobWatcher)
void	showPrintSetupDialog()	Utility for showing print dialog for the current printService.

Methods inherited from class org.icepdf.ri.common.print.PrintHelper

createDocAttributeSet, createPrintRequestAttributeSet, getCurrentPage, getDocAttributeSet, getNumberOfPages, getPrintRequestAttributeSet, getPrintService, getPrintServiceOrDefault, getServices, guessMediaSizeName, hasPrinter, isPaintAnnotation, isPaintSearchHighlight, isPrintFitToMargin, lookForPrintServices, preloadServices, reloadServices, setCurrentPage, setDocAttributeSet, setNumberOfPages, setPaintAnnotation, setPaintSearchHighlight, setPrinter, setPrintFitToMargin, setPrintRequestAttributeSet, setPrintService, setupPrintService, setupPrintService, setupPrintService

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintHelperImpl

public PrintHelperImpl(Container container,
                       PageTree pageTree,
                       float rotation,
                       MediaSizeName paperSizeName,
                       PrintQuality printQuality)

Creates a new PrintHelper instance using the specified media sized and print quality.

Parameters:

container - parent container uses to center print dialog.

pageTree - document page tree.

rotation - rotation at witch to paint document.

paperSizeName - MediaSizeName constant of paper size to print to.

printQuality - quality of the print job, draft, quality etc.

PrintHelperImpl

public PrintHelperImpl(Container container,
                       PageTree pageTree,
                       float userRotation,
                       DocAttributeSet docAttributeSet,
                       PrintRequestAttributeSet printRequestAttributeSet)

Creates a new PrintHelper instance using the specified doc and print attribute sets. This constructor offers the most flexibility as it allows the attributes sets to be pre configured. This method should only be used by advanced users.

Parameters:

container - parent container uses to center print dialog.

pageTree - document page tree.

userRotation - rotation of view

docAttributeSet - MediaSizeName constant of paper size to print to.

printRequestAttributeSet - quality of the print job, draft, quality etc.

Method Detail

showPrintSetupDialog

public void showPrintSetupDialog()

Description copied from class: PrintHelper

Utility for showing print dialog for the current printService. If no print service is assigned the first print service is used to create the print dialog.

Specified by:

showPrintSetupDialog in class PrintHelper

getUserRotation

public float getUserRotation()

Users rotation specified for the print job.

Returns:

float value representing rotation, 0 is 0 degrees.

print

public int print(Graphics printGraphics,
                 PageFormat pageFormat,
                 int pageIndex)

Prints the page at the specified index into the specified java.awt.Graphics context in the specified format.

Specified by:

print in interface Printable

Specified by:

print in class PrintHelper

Parameters:

printGraphics - paper graphics context.

pageFormat - print attributes translated from PrintService

pageIndex - page to print, zero based.

Returns:

A status code of Printable.NO_SUCH_PAGE or Printable.PAGE_EXISTS

print

public void print()
           throws PrintException

Description copied from class: PrintHelper

Print a range of pages from the document as specified by #setupPrintService.

Specified by:

print in class PrintHelper

Throws:

PrintException - if a default printer could not be found or some other printing related error.

cancelablePrint

public CancelablePrintJob cancelablePrint()
                                   throws PrintException

Specified by:

cancelablePrint in class PrintHelper

Throws:

PrintException

print

public void print(PrintJobWatcher printJobWatcher)
           throws PrintException

Specified by:

print in class PrintHelper

Throws:

PrintException

getSetupDialog

protected PrintService getSetupDialog()

Description copied from class: PrintHelper

Utility for creating a print setup dialog.

Specified by:

getSetupDialog in class PrintHelper

Returns:

print service selected by the user, or null if the user cancelled the dialog.