Package org.apache.pdfbox.printing
Class PDFPageable
java.lang.Object
java.awt.print.Book
org.apache.pdfbox.printing.PDFPageable
- All Implemented Interfaces:
Pageable
Prints a PDF document using its original paper size.
- Author:
- John Hewson
-
Field Summary
Fields inherited from interface java.awt.print.Pageable
UNKNOWN_NUMBER_OF_PAGES
-
Constructor Summary
ConstructorsConstructorDescriptionPDFPageable
(PDDocument document) Creates a new PDFPageable.PDFPageable
(PDDocument document, Orientation orientation) Creates a new PDFPageable with the given page orientation.PDFPageable
(PDDocument document, Orientation orientation, boolean showPageBorder) Creates a new PDFPageable with the given page orientation and with optional page borders shown.PDFPageable
(PDDocument document, Orientation orientation, boolean showPageBorder, float dpi) Creates a new PDFPageable with the given page orientation and with optional page borders shown. -
Method Summary
Modifier and TypeMethodDescriptionint
getPageFormat
(int pageIndex) Returns the actual physical size of the pages in the PDF file.getPrintable
(int i) Get the rendering hints.boolean
Value indicating if the renderer is allowed to subsample images before drawing, according to image dimensions and requested scale.void
setRenderingHints
(RenderingHints renderingHints) Set the rendering hints.void
setSubsamplingAllowed
(boolean subsamplingAllowed) Sets a value instructing the renderer whether it is allowed to subsample images before drawing.
-
Constructor Details
-
PDFPageable
Creates a new PDFPageable.- Parameters:
document
- the document to print
-
PDFPageable
Creates a new PDFPageable with the given page orientation.- Parameters:
document
- the document to printorientation
- page orientation policy
-
PDFPageable
Creates a new PDFPageable with the given page orientation and with optional page borders shown. The image will be rasterized at the given DPI before being sent to the printer.- Parameters:
document
- the document to printorientation
- page orientation policyshowPageBorder
- true if page borders are to be printed
-
PDFPageable
Creates a new PDFPageable with the given page orientation and with optional page borders shown. The image will be rasterized at the given DPI before being sent to the printer.- Parameters:
document
- the document to printorientation
- page orientation policyshowPageBorder
- true if page borders are to be printeddpi
- if non-zero then the image will be rasterized at the given DPI
-
-
Method Details
-
getRenderingHints
Get the rendering hints.- Returns:
- the rendering hints or null if none are set.
-
setRenderingHints
Set the rendering hints. Use this to influence rendering quality and speed. If you don't set them yourself or pass null, PDFBox will decide at runtime depending on the destination.- Parameters:
renderingHints
-
-
isSubsamplingAllowed
public boolean isSubsamplingAllowed()Value indicating if the renderer is allowed to subsample images before drawing, according to image dimensions and requested scale. Subsampling may be faster and less memory-intensive in some cases, but it may also lead to loss of quality, especially in images with high spatial frequency.- Returns:
- true if subsampling of images is allowed, false otherwise.
-
setSubsamplingAllowed
public void setSubsamplingAllowed(boolean subsamplingAllowed) Sets a value instructing the renderer whether it is allowed to subsample images before drawing. The subsampling frequency is determined according to image size and requested scale. Subsampling may be faster and less memory-intensive in some cases, but it may also lead to loss of quality, especially in images with high spatial frequency.- Parameters:
subsamplingAllowed
- The new value indicating if subsampling is allowed.
-
getNumberOfPages
public int getNumberOfPages()- Specified by:
getNumberOfPages
in interfacePageable
- Overrides:
getNumberOfPages
in classBook
-
getPageFormat
Returns the actual physical size of the pages in the PDF file. May not fit the local printer.- Specified by:
getPageFormat
in interfacePageable
- Overrides:
getPageFormat
in classBook
-
getPrintable
- Specified by:
getPrintable
in interfacePageable
- Overrides:
getPrintable
in classBook
-