Apache PDFBox 3.0.4 · org.apache.pdfbox.printing.PDFPageable

Modifier and Type	Field and Description
private final boolean	center
private final PDDocument	document
private final float	dpi
private final int	numberOfPages
private final Orientation	orientation
private RenderingHints	renderingHints
private final boolean	showPageBorder
private boolean	subsamplingAllowed

Constructor Summary

Access	Constructor and Description
public	PDFPageable(PDDocument the document to print document) Creates a new PDFPageable.
public	PDFPageable(PDDocument the document to print document, Orientation page orientation policy orientation) Creates a new PDFPageable with the given page orientation.
public	PDFPageable(PDDocument the document to print document, Orientation page orientation policy orientation, boolean true if page borders are to be printed showPageBorder) Creates a new PDFPageable with the given page orientation and with optional page borders shown.
public	PDFPageable(PDDocument the document to print document, Orientation page orientation policy orientation, boolean true if page borders are to be printed showPageBorder, float if non-zero then the image will be rasterized at the given DPI dpi) Creates a new PDFPageable with the given page orientation and with optional page borders shown.
public	PDFPageable(PDDocument the document to print document, Orientation page orientation policy orientation, boolean true if page borders are to be printed showPageBorder, float if non-zero then the image will be rasterized at the given DPI dpi, boolean true if the content is to be centered on the page (otherwise top-left). center) Creates a new PDFPageable with the given page orientation and with optional page borders shown.

Method Summary

Modifier and Type	Method and Description
public int	getNumberOfPages() Overrides java.awt.print.Book.getNumberOfPages. Implements java.awt.print.Pageable.getNumberOfPages. Returns the number of pages in this `Book`.
public PageFormat	getPageFormat(int the zero based index of the page whose `PageFormat` is being requested pageIndex) Overrides java.awt.print.Book.getPageFormat. Implements java.awt.print.Pageable.getPageFormat. Returns the `PageFormat` of the page specified by `pageIndex`.
public Printable	getPrintable(int the zero based index of the page whose `Printable` is being requested i) Overrides java.awt.print.Book.getPrintable. Implements java.awt.print.Pageable.getPrintable. Returns the `Printable` instance responsible for rendering the page specified by `pageIndex`.
public RenderingHints	Returns: the rendering hints or null if none are set. getRenderingHints() Get the rendering hints.
public boolean	Returns: true if subsampling of images is allowed, false otherwise. isSubsamplingAllowed() Value indicating if the renderer is allowed to subsample images before drawing, according to image dimensions and requested scale.
public void	setRenderingHints(RenderingHints rendering hints to be used to influence rendering quality and speed renderingHints) Set the rendering hints.
public void	setSubsamplingAllowed(boolean The new value indicating if subsampling is allowed. subsamplingAllowed) Sets a value instructing the renderer whether it is allowed to subsample images before drawing.

Inherited from java.awt.print.Book:: append append setPage

Field Detail

center	back to summary
private final boolean center

document	back to summary
private final PDDocument document

dpi	back to summary
private final float dpi

numberOfPages	back to summary
private final int numberOfPages

orientation	back to summary
private final Orientation orientation

renderingHints	back to summary
private RenderingHints renderingHints

showPageBorder	back to summary
private final boolean showPageBorder

subsamplingAllowed	back to summary
private boolean subsamplingAllowed

Constructor Detail

PDFPageable	back to summary
public PDFPageable(PDDocument document) Creates a new PDFPageable. Parameters document:PDDocument the document to print

PDFPageable

back to summary

public PDFPageable(PDDocument document)

Creates a new PDFPageable.

Parameters

document:PDDocument: the document to print

PDFPageable	back to summary
public PDFPageable(PDDocument document, Orientation orientation) Creates a new PDFPageable with the given page orientation. Parameters document:PDDocument the document to print orientation:Orientation page orientation policy

PDFPageable

back to summary

public PDFPageable(PDDocument document, Orientation orientation)

Creates a new PDFPageable with the given page orientation.

Parameters

document:PDDocument: the document to print
orientation:Orientation: page orientation policy

PDFPageable	back to summary
public PDFPageable(PDDocument document, Orientation orientation, boolean showPageBorder) Creates a new PDFPageable with the given page orientation and with optional page borders shown. Parameters document:PDDocument the document to print orientation:Orientation page orientation policy showPageBorder:boolean true if page borders are to be printed

PDFPageable

back to summary

public PDFPageable(PDDocument document, Orientation orientation, boolean showPageBorder)

Creates a new PDFPageable with the given page orientation and with optional page borders shown.

Parameters

document:PDDocument: the document to print
orientation:Orientation: page orientation policy
showPageBorder:boolean: true if page borders are to be printed

PDFPageable	back to summary
public PDFPageable(PDDocument document, Orientation orientation, boolean showPageBorder, float dpi) 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 if non-zero. Parameters document:PDDocument the document to print orientation:Orientation page orientation policy showPageBorder:boolean true if page borders are to be printed dpi:float if non-zero then the image will be rasterized at the given DPI

PDFPageable

back to summary

public PDFPageable(PDDocument document, Orientation orientation, boolean showPageBorder, float dpi)

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 if non-zero.

Parameters

document:PDDocument: the document to print
orientation:Orientation: page orientation policy
showPageBorder:boolean: true if page borders are to be printed
dpi:float: if non-zero then the image will be rasterized at the given DPI

PDFPageable	back to summary
public PDFPageable(PDDocument document, Orientation orientation, boolean showPageBorder, float dpi, boolean center) 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 if non-zero, and optionally be centered. Parameters document:PDDocument the document to print orientation:Orientation page orientation policy showPageBorder:boolean true if page borders are to be printed dpi:float if non-zero then the image will be rasterized at the given DPI center:boolean true if the content is to be centered on the page (otherwise top-left).

PDFPageable

back to summary

public PDFPageable(PDDocument document, Orientation orientation, boolean showPageBorder, float dpi, boolean center)

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 if non-zero, and optionally be centered.

Parameters

document:PDDocument: the document to print
orientation:Orientation: page orientation policy
showPageBorder:boolean: true if page borders are to be printed
dpi:float: if non-zero then the image will be rasterized at the given DPI
center:boolean: true if the content is to be centered on the page (otherwise top-left).

Method Detail

getNumberOfPages back to summary

getNumberOfPages	back to summary
public int getNumberOfPages() Overrides java.awt.print.Book.getNumberOfPages. Implements java.awt.print.Pageable.getNumberOfPages. Doc from java.awt.print.Book.getNumberOfPages. Returns the number of pages in this `Book`. Returns:int the number of pages this `Book` contains. Annotations @Override

public int getNumberOfPages()

Overrides java.awt.print.Book.getNumberOfPages.

Implements java.awt.print.Pageable.getNumberOfPages.

Doc from java.awt.print.Book.getNumberOfPages.

Returns the number of pages in this Book.

Returns:int

the number of pages this Book contains.

Annotations

@Override

getPageFormat back to summary

getPageFormat	back to summary
public PageFormat getPageFormat(int pageIndex) Overrides java.awt.print.Book.getPageFormat. Implements java.awt.print.Pageable.getPageFormat. Doc from java.awt.print.Book.getPageFormat. Returns the `PageFormat` of the page specified by `pageIndex`. Returns the actual physical size of the pages in the PDF file. May not fit the local printer. Parameters pageIndex:int the zero based index of the page whose `PageFormat` is being requested Returns:PageFormat the `PageFormat` describing the size and orientation of the page. Annotations @Override

public PageFormat getPageFormat(int pageIndex)

Overrides java.awt.print.Book.getPageFormat.

Implements java.awt.print.Pageable.getPageFormat.

Doc from java.awt.print.Book.getPageFormat.

Returns the PageFormat of the page specified by pageIndex. Returns the actual physical size of the pages in the PDF file. May not fit the local printer.

Parameters

pageIndex:int: the zero based index of the page whose PageFormat is being requested

Returns:PageFormat

the PageFormat describing the size and orientation of the page.

Annotations

@Override

getPrintable back to summary

getPrintable	back to summary
public Printable getPrintable(int i) Overrides java.awt.print.Book.getPrintable. Implements java.awt.print.Pageable.getPrintable. Doc from java.awt.print.Book.getPrintable. Returns the `Printable` instance responsible for rendering the page specified by `pageIndex`. Parameters i:int the zero based index of the page whose `Printable` is being requested Returns:Printable the `Printable` that renders the page. Annotations @Override

public Printable getPrintable(int i)

Overrides java.awt.print.Book.getPrintable.

Implements java.awt.print.Pageable.getPrintable.

Doc from java.awt.print.Book.getPrintable.

Returns the Printable instance responsible for rendering the page specified by pageIndex.

Parameters

i:int: the zero based index of the page whose Printable is being requested

Returns:Printable

the Printable that renders the page.

Annotations

@Override

getRenderingHints	back to summary
public RenderingHints getRenderingHints() Get the rendering hints. Returns:RenderingHints the rendering hints or null if none are set.

getRenderingHints

back to summary

public RenderingHints getRenderingHints()

Get the rendering hints.

Returns:RenderingHints: the rendering hints or null if none are set.

isSubsamplingAllowed	back to summary
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:boolean true if subsampling of images is allowed, false otherwise.

isSubsamplingAllowed

back to summary

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:boolean: true if subsampling of images is allowed, false otherwise.

setRenderingHints	back to summary
public void setRenderingHints(RenderingHints renderingHints) 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:RenderingHints rendering hints to be used to influence rendering quality and speed

setRenderingHints

back to summary

public void setRenderingHints(RenderingHints renderingHints)

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:RenderingHints: rendering hints to be used to influence rendering quality and speed

setSubsamplingAllowed	back to summary
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:boolean The new value indicating if subsampling is allowed.

setSubsamplingAllowed

back to summary

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:boolean: The new value indicating if subsampling is allowed.

public final Class PDFPageable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail