com.qoppa.pdf

Class PrintSettings

java.lang.Object

com.qoppa.pdf.PrintSettings

public class PrintSettings
extends Object

This object controls the behavior of the library when sending a PDF document to the printer. The object has six flags that can be set:

m_AutoRotate - Will rotate the printout to match the width and length with the paper. When this flag is on, the library will ignore the portrait / landscape setting set by the user.

m_ShrinkToMargins - Will shrink pages so that they fit in the paper. This flag has no effect if the pages in a document are smaller than the paper they are being printed on.

m_ExpandToMargins - Will expand pages to fill the paper they are being printed on. This flag has no effect if the pages in a document are larger than the paper they are being printed on.

m_CenterInPage - Will center the page in the paper. This flag has no effect if the pages in a document are larger than the paper they are being printed on.

m_PrintAnnotations - Will print annotations when sending PDF content to the printer.

m_QoppaDialog - Will show a custom print dialog, otherwise will show the native print dialog. mScaleImagesToOutput - Controls whether images are resized to their output size by the library or by the printer / printer driver.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
boolean	m_AutoRotate Flag used to auto-rotate the document when printing.
boolean	m_CenterInPage Flag used to center the output on the printed page.
boolean	m_ExpandToMargins Flag used to expand the output to the printer margins.
boolean	m_PrintAnnotations This flag tells the library whether to print annotations when sending the PDF content to a printer.
boolean	m_PrintFormFields This flag tells the library whether to print form fields when sending the PDF content to a printer.
boolean	m_PrintFormsOnly Deprecated.
boolean	m_PrintPageContents This flag tells the library whether to print page contents when sending the PDF content to a printer.
boolean	m_QoppaDialog Sets the value of the Qoppa print dialog flag.
boolean	m_ScaleImagesToOutput This flag is using when printing images.
boolean	m_ShrinkToMargins Flag used to shrink the output to fit the printer margins.

Constructor Summary

Constructors

Constructor and Description
PrintSettings() Constructs a default PrintSettings object.
PrintSettings(boolean autoRotate, boolean shrinkToMargins, boolean expandToMargins, boolean centerInPage) Constructs a new PrintSettings object and initializes each of its variables to the parameters.
PrintSettings(PrintSettings init) Constructs a new PrintSettings object and initializes to init.

Method Summary

Modifier and Type	Method and Description
Rectangle2D	getPrintableRectangle(int pageIndex) Returns the area to print.
boolean	isPrintAnnotations() Returns the value of the print annotations flag.
boolean	isPrintFormFields() Returns the value of the print form fields flag.
boolean	isPrintFormsOnly() Deprecated. Use m_PrintFormFields = true and m_PrintPageContents = false instead.
boolean	isPrintPageContents() Returns the value of the page contents flag.
boolean	isQoppaPrintDialog() Returns the value of the Qoppa print dialog flag.
boolean	isScaleImagesToOutput() Returns the value of the flag that controls whether images are resized to their output size by the library or by the printer / printer driver.
void	setPrintableRectangle(int pageIndex, Rectangle2D rect) Sets the area to print.
void	setPrintAnnotations(boolean printAnnotations) Sets the value of the print annotations flag.
void	setPrintFormFields(boolean print) Sets the value of the print form fields flag.
void	setPrintFormsOnly(boolean print) Deprecated. Use m_PrintFormFields = true and m_PrintPageContents = false instead.
void	setPrintPageContents(boolean print) Sets the value of the print page contents flag.
void	setQoppaPrintDialog(boolean qoppaDialog) Sets the value of the Qoppa print dialog flag.
void	setScaleImagesToOutput(boolean scaleImagesToOutput) this method sets the value of the flag that controls whether the library resizes images to the output size and DPI when printing, or if images are sent to the printer in their original size, an the printer or printer driver resizes them. In most cases, having the library rescale the image will produce better quality, but will take more processing power to print.

Methods inherited from class java.lang.Object

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

Field Detail

m_AutoRotate

public boolean m_AutoRotate

Flag used to auto-rotate the document when printing. When this flag is set to true, the library will compare the PDF page to the printer page and find a best fit, to match landscape to landscape and portrait to portrait. The default value is true.

m_ShrinkToMargins

public boolean m_ShrinkToMargins

Flag used to shrink the output to fit the printer margins. When this flag is set to true, and the PDF content is larger than the printable margins on the printer, the output will be scaled down to fit within the printer margins. The default value is true.

m_ExpandToMargins

public boolean m_ExpandToMargins

Flag used to expand the output to the printer margins. When this flag is set to true, and the PDF content is smaller than the printable area on the printer, the output will be scaled up to fill the printable area on the printer page. The default value is false.

m_CenterInPage

public boolean m_CenterInPage

Flag used to center the output on the printed page. When this flag is set to true, and the PDF content is smaller than the printable area, the output will be centered on the printed page. This flag has no effect if the PDF content is larger than the printable area or if the expand to margins flag is set to true. The default value is true.

m_PrintAnnotations

public boolean m_PrintAnnotations

This flag tells the library whether to print annotations when sending the PDF content to a printer. The default value is true. The print form fields only flag takes precedence over this flag.

m_PrintPageContents

public boolean m_PrintPageContents

This flag tells the library whether to print page contents when sending the PDF content to a printer. The default value is true.

m_PrintFormFields

public boolean m_PrintFormFields

This flag tells the library whether to print form fields when sending the PDF content to a printer. The default value is true.

m_PrintFormsOnly

@Deprecated
public boolean m_PrintFormsOnly

Deprecated.

If this flag is set to true, then only the form fields in the document will be printed. The page contents and the annotations will not be printed. This flag takes precedence over the print annotations flag. The default value is false.

m_QoppaDialog

public boolean m_QoppaDialog

Sets the value of the Qoppa print dialog flag. If true then the library will show custom print dialog, otherwise it will show the native print dialog. If the Qoppa print dialog is shown, then the settings auto rotate, shrink to margins, expand to margins, center in page, and print annotations may be modified by the user. The Qoppa print dialog has a print preview, page range options, and options to set print job attributes including Chromaticity, Copies, Destination, MediaSizeName, MediaTray, OrientationRequested, PrintQuality, SheetCollate, and Sides. The default value is true.

m_ScaleImagesToOutput

public boolean m_ScaleImagesToOutput

This flag is using when printing images. If set to true, the library will scale the image to the output DPI. If set to false, images will be printed in the resolution that they are stored in and the printer or printer driver will scale them to their output size.

In most cases, having the library rescale the image will produce better quality, but will take more processing power to print.

Constructor Detail

PrintSettings

public PrintSettings()

Constructs a default PrintSettings object. The default PrintSettings object will auto-rotate, shrink to margins, center in page, and print annotations, but will not expand the content to fit to the margins.

PrintSettings

public PrintSettings(boolean autoRotate,
                     boolean shrinkToMargins,
                     boolean expandToMargins,
                     boolean centerInPage)

Constructs a new PrintSettings object and initializes each of its variables to the parameters.

Parameters:

autoRotate - Sets the auto rotate flag.

shrinkToMargins - Sets the shrink to page flag.

expandToMargins - Sets the expand to page flag.

centerInPage - Sets the center in page flag.

PrintSettings

public PrintSettings(PrintSettings init)

Constructs a new PrintSettings object and initializes to init.

Parameters:

init - Object to use to initialize the new PrintSettings.

Method Detail

isPrintAnnotations

public boolean isPrintAnnotations()

Returns the value of the print annotations flag. This flag determines whether annotations on a PDF document will be printed. The print form fields only flag takes precedence over this flag.

Returns:

The value of the print annotations flag.

setPrintAnnotations

public void setPrintAnnotations(boolean printAnnotations)

Sets the value of the print annotations flag. This flag determines whether annotations on a PDF document will be printed. The default value is true. The print form fields only flag takes precedence over this flag.

Parameters:

printAnnotations - The new value of the print annotations flag.

isPrintFormFields

public boolean isPrintFormFields()

Returns the value of the print form fields flag. This flag determines whether form fields on a PDF document will be printed.

setPrintFormFields

public void setPrintFormFields(boolean print)

Sets the value of the print form fields flag. This flag determines whether form fields on a PDF document will be printed. The default value is true.

Parameters:

print - The new value of the print form fields flag.

isPrintPageContents

public boolean isPrintPageContents()

Returns the value of the page contents flag. This flag determines whether page contents on a PDF document will be printed.

setPrintPageContents

public void setPrintPageContents(boolean print)

Sets the value of the print page contents flag. This flag determines whether page contents on a PDF document will be printed. The default value is true.

Parameters:

print - The new value of the print page contents flag.

setPrintableRectangle

public void setPrintableRectangle(int pageIndex,
                                  Rectangle2D rect)

Sets the area to print. The rectangle must be contained within the page's crop box, otherwise it is ignored.

Parameters:

pageIndex - The index of the page. Page index starts at 0.

rect - The area to print.

getPrintableRectangle

public Rectangle2D getPrintableRectangle(int pageIndex)

Returns the area to print.

Parameters:

pageIndex - The index of the page. Page index starts at 0.

Returns:

The area to print.

setQoppaPrintDialog

public void setQoppaPrintDialog(boolean qoppaDialog)

Sets the value of the Qoppa print dialog flag. If true then the library will show custom print dialog, otherwise it will show the native print dialog. If the Qoppa print dialog is shown, then the settings auto rotate, shrink to margins, expand to margins, center in page, and print annotations may be modified by the user. The Qoppa print dialog has a print preview, page range options, and options to set print job attributes including Chromaticity, Copies, Destination, MediaSizeName, MediaTray, OrientationRequested, PrintQuality, SheetCollate, and Sides. The default value is true.

Parameters:

qoppaDialog - The value of the custom dialog flag.

isQoppaPrintDialog

public boolean isQoppaPrintDialog()

Returns the value of the Qoppa print dialog flag. If true then the library will use a custom print dialog, otherwise it will use the native print dialog.

Returns:

The value of the custom dialog flag.

setScaleImagesToOutput

public void setScaleImagesToOutput(boolean scaleImagesToOutput)

this method sets the value of the flag that controls whether the library resizes images to the output size and DPI when printing, or if images are sent to the printer in their original size, an the printer or printer driver resizes them.

In most cases, having the library rescale the image will produce better quality, but will take more processing power to print.

Parameters:

scaleImagesToOutput -

isScaleImagesToOutput

public boolean isScaleImagesToOutput()

Returns the value of the flag that controls whether images are resized to their output size by the library or by the printer / printer driver.

Returns:

The value of the rescaling flag.

isPrintFormsOnly

@Deprecated
public boolean isPrintFormsOnly()

Deprecated. Use m_PrintFormFields = true and m_PrintPageContents = false instead.

Returns the value of the print form fields only flag. If this flag is set to true, then only the form fields in the document will be printed. The page contents and the annotations will not be printed. This flag takes precedence over the print annotations flag. The default value is false.

Returns:

The value of the print form fields only flag.

setPrintFormsOnly

@Deprecated
public void setPrintFormsOnly(boolean print)

Deprecated. Use m_PrintFormFields = true and m_PrintPageContents = false instead.

Sets the value of the print form fields only flag. If this flag is set to true, then only the form fields in the document will be printed. The page contents and the annotations will not be printed. This flag takes precedence over the print annotations flag. The default value is false.

Parameters:

print - The value of the print form fields only flag.