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

Modifier and Type	Field and Description
private final boolean	center
private final float	dpi
private static final Log	LOG
private final PDPageTree	pageTree
public static final float	RASTERIZE_DPI_AUTO
public static final float	RASTERIZE_OFF
private final PDFRenderer	renderer
private RenderingHints	renderingHints
private final Scaling	scaling
private final boolean	showPageBorder
private boolean	subsamplingAllowed

Constructor Summary

Access	Constructor and Description
public	PDFPrintable(PDDocument the document to print document) Creates a new PDFPrintable.
public	PDFPrintable(PDDocument the document to print document, Scaling page scaling policy scaling) Creates a new PDFPrintable with the given page scaling.
public	PDFPrintable(PDDocument the document to print document, Scaling page scaling policy scaling, boolean true if page borders are to be printed showPageBorder) Creates a new PDFPrintable with the given page scaling and with optional page borders shown.
public	PDFPrintable(PDDocument the document to print document, Scaling page scaling policy scaling, boolean true if page borders are to be printed showPageBorder, float if positive non-zero then the image will be rasterized at the given DPI. If set to the special value RASTERIZE_DPI_AUTO, the dpi of the printer will be used. dpi) Creates a new PDFPrintable with the given page scaling and with optional page borders shown.
public	PDFPrintable(PDDocument the document to print document, Scaling page scaling policy scaling, boolean true if page borders are to be printed showPageBorder, float if positive non-zero then the image will be rasterized at the given DPI. If set to the special value RASTERIZE_DPI_AUTO, the dpi of the printer will be used. dpi, boolean true if the content is to be centered on the page (otherwise top-left). center) Creates a new PDFPrintable with the given page scaling and with optional page borders shown.
public	PDFPrintable(PDDocument the document to print document, Scaling page scaling policy scaling, boolean true if page borders are to be printed showPageBorder, float if positive non-zero then the image will be rasterized at the given DPI. If set to the special value RASTERIZE_DPI_AUTO, the dpi of the printer will be used. dpi, boolean true if the content is to be centered on the page (otherwise top-left). center, PDFRenderer the document renderer. Useful if `PDFRenderer` has been subclassed. renderer) Creates a new PDFPrintable with the given page scaling and with optional page borders shown.

Method Summary

Modifier and Type	Method and Description
public RenderingHints	Returns: the rendering hints or null if none are set. getRenderingHints() Get the rendering hints.
pack-priv static PDRectangle	Returns: The CropBox at this level in the hierarchy. getRotatedCropBox(PDPage page) This will find the CropBox with rotation applied, for this page by looking up the hierarchy until it finds them.
pack-priv static PDRectangle	Returns: The MediaBox at this level in the hierarchy. getRotatedMediaBox(PDPage page) This will find the MediaBox with rotation applied, for this page by looking up the hierarchy until it finds them.
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 int	print(Graphics the context into which the page is drawn graphics, PageFormat the size and orientation of the page being drawn pageFormat, int the zero based index of the page to be drawn pageIndex) Implements java.awt.print.Printable.print. Prints the page at the specified index into the specified `Graphics` context in the specified format.
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.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

center	back to summary
private final boolean center

dpi	back to summary
private final float dpi

LOG	back to summary
private static final Log LOG

pageTree	back to summary
private final PDPageTree pageTree

RASTERIZE_DPI_AUTO	back to summary
public static final float RASTERIZE_DPI_AUTO

RASTERIZE_OFF	back to summary
public static final float RASTERIZE_OFF

renderer	back to summary
private final PDFRenderer renderer

renderingHints	back to summary
private RenderingHints renderingHints

scaling	back to summary
private final Scaling scaling

showPageBorder	back to summary
private final boolean showPageBorder

subsamplingAllowed	back to summary
private boolean subsamplingAllowed

Constructor Detail

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

PDFPrintable

back to summary

public PDFPrintable(PDDocument document)

Creates a new PDFPrintable.

Parameters

document:PDDocument: the document to print

PDFPrintable	back to summary
public PDFPrintable(PDDocument document, Scaling scaling) Creates a new PDFPrintable with the given page scaling. Parameters document:PDDocument the document to print scaling:Scaling page scaling policy

PDFPrintable

back to summary

public PDFPrintable(PDDocument document, Scaling scaling)

Creates a new PDFPrintable with the given page scaling.

Parameters

document:PDDocument: the document to print
scaling:Scaling: page scaling policy

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

PDFPrintable

back to summary

public PDFPrintable(PDDocument document, Scaling scaling, boolean showPageBorder)

Creates a new PDFPrintable with the given page scaling and with optional page borders shown.

Parameters

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

PDFPrintable	back to summary
public PDFPrintable(PDDocument document, Scaling scaling, boolean showPageBorder, float dpi) Creates a new PDFPrintable with the given page scaling and with optional page borders shown. The image will be rasterized at the given DPI before being sent to the printer. Parameters document:PDDocument the document to print scaling:Scaling page scaling policy showPageBorder:boolean true if page borders are to be printed dpi:float if positive non-zero then the image will be rasterized at the given DPI. If set to the special value RASTERIZE_DPI_AUTO, the dpi of the printer will be used.

PDFPrintable

back to summary

public PDFPrintable(PDDocument document, Scaling scaling, boolean showPageBorder, float dpi)

Creates a new PDFPrintable with the given page scaling and with optional page borders shown. The image will be rasterized at the given DPI before being sent to the printer.

Parameters

document:PDDocument: the document to print
scaling:Scaling: page scaling policy
showPageBorder:boolean: true if page borders are to be printed
dpi:float: if positive non-zero then the image will be rasterized at the given DPI. If set to the special value RASTERIZE_DPI_AUTO, the dpi of the printer will be used.

PDFPrintable	back to summary
public PDFPrintable(PDDocument document, Scaling scaling, boolean showPageBorder, float dpi, boolean center) Creates a new PDFPrintable with the given page scaling and with optional page borders shown. The image will be rasterized at the given DPI before being sent to the printer. Parameters document:PDDocument the document to print scaling:Scaling page scaling policy showPageBorder:boolean true if page borders are to be printed dpi:float if positive non-zero then the image will be rasterized at the given DPI. If set to the special value RASTERIZE_DPI_AUTO, the dpi of the printer will be used. center:boolean true if the content is to be centered on the page (otherwise top-left).

PDFPrintable

back to summary

public PDFPrintable(PDDocument document, Scaling scaling, boolean showPageBorder, float dpi, boolean center)

Creates a new PDFPrintable with the given page scaling and with optional page borders shown. The image will be rasterized at the given DPI before being sent to the printer.

Parameters

document:PDDocument: the document to print
scaling:Scaling: page scaling policy
showPageBorder:boolean: true if page borders are to be printed
dpi:float: if positive non-zero then the image will be rasterized at the given DPI. If set to the special value RASTERIZE_DPI_AUTO, the dpi of the printer will be used.
center:boolean: true if the content is to be centered on the page (otherwise top-left).

PDFPrintable back to summary

PDFPrintable	back to summary
public PDFPrintable(PDDocument document, Scaling scaling, boolean showPageBorder, float dpi, boolean center, PDFRenderer renderer) Creates a new PDFPrintable with the given page scaling and with optional page borders shown. The image will be rasterized at the given DPI before being sent to the printer. Parameters document:PDDocument the document to print scaling:Scaling page scaling policy showPageBorder:boolean true if page borders are to be printed dpi:float if positive non-zero then the image will be rasterized at the given DPI. If set to the special value RASTERIZE_DPI_AUTO, the dpi of the printer will be used. center:boolean true if the content is to be centered on the page (otherwise top-left). renderer:PDFRenderer the document renderer. Useful if `PDFRenderer` has been subclassed.

public PDFPrintable(PDDocument document, Scaling scaling, boolean showPageBorder, float dpi, boolean center, PDFRenderer renderer)

Creates a new PDFPrintable with the given page scaling and with optional page borders shown. The image will be rasterized at the given DPI before being sent to the printer.

Parameters

document:PDDocument: the document to print
scaling:Scaling: page scaling policy
showPageBorder:boolean: true if page borders are to be printed
dpi:float: if positive non-zero then the image will be rasterized at the given DPI. If set to the special value RASTERIZE_DPI_AUTO, the dpi of the printer will be used.
center:boolean: true if the content is to be centered on the page (otherwise top-left).
renderer:PDFRenderer: the document renderer. Useful if PDFRenderer has been subclassed.

Method Detail

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.

getRotatedCropBox	back to summary
pack-priv static PDRectangle getRotatedCropBox(PDPage page) This will find the CropBox with rotation applied, for this page by looking up the hierarchy until it finds them. Returns:PDRectangle The CropBox at this level in the hierarchy.

getRotatedCropBox

back to summary

pack-priv static PDRectangle getRotatedCropBox(PDPage page)

This will find the CropBox with rotation applied, for this page by looking up the hierarchy until it finds them.

Returns:PDRectangle: The CropBox at this level in the hierarchy.

getRotatedMediaBox	back to summary
pack-priv static PDRectangle getRotatedMediaBox(PDPage page) This will find the MediaBox with rotation applied, for this page by looking up the hierarchy until it finds them. Returns:PDRectangle The MediaBox at this level in the hierarchy.

getRotatedMediaBox

back to summary

pack-priv static PDRectangle getRotatedMediaBox(PDPage page)

This will find the MediaBox with rotation applied, for this page by looking up the hierarchy until it finds them.

Returns:PDRectangle: The MediaBox at this level in the hierarchy.

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.

print back to summary

print	back to summary
public int print(Graphics graphics, PageFormat pageFormat, int pageIndex) throws PrinterException Implements java.awt.print.Printable.print. Doc from java.awt.print.Printable.print. Prints the page at the specified index into the specified `Graphics` context in the specified format. A `PrinterJob` calls the `Printable` interface to request that a page be rendered into the context specified by `graphics`. The format of the page to be drawn is specified by `pageFormat`. The zero based index of the requested page is specified by `pageIndex`. If the requested page does not exist then this method returns NO_SUCH_PAGE; otherwise PAGE_EXISTS is returned. The `Graphics` class or subclass implements the `PrinterGraphics` interface to provide additional information. If the `Printable` object aborts the print job then it throws a `PrinterException`. Parameters graphics:Graphics the context into which the page is drawn pageFormat:PageFormat the size and orientation of the page being drawn pageIndex:int the zero based index of the page to be drawn Returns:int PAGE_EXISTS if the page is rendered successfully or NO_SUCH_PAGE if `pageIndex` specifies a non-existent page. Annotations @Override Exceptions PrinterException: thrown when the print job is terminated.

public int print(Graphics graphics, PageFormat pageFormat, int pageIndex) throws PrinterException

Implements java.awt.print.Printable.print.

Doc from java.awt.print.Printable.print.

Prints the page at the specified index into the specified Graphics context in the specified format. A PrinterJob calls the Printable interface to request that a page be rendered into the context specified by graphics. The format of the page to be drawn is specified by pageFormat. The zero based index of the requested page is specified by pageIndex. If the requested page does not exist then this method returns NO_SUCH_PAGE; otherwise PAGE_EXISTS is returned. The Graphics class or subclass implements the PrinterGraphics interface to provide additional information. If the Printable object aborts the print job then it throws a PrinterException.

Parameters

graphics:Graphics: the context into which the page is drawn
pageFormat:PageFormat: the size and orientation of the page being drawn
pageIndex:int: the zero based index of the page to be drawn

Returns:int

PAGE_EXISTS if the page is rendered successfully or NO_SUCH_PAGE if pageIndex specifies a non-existent page.

Annotations

@Override

Exceptions

PrinterException:: thrown when the print job is terminated.

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 PDFPrintable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail