Package org.apache.pdfbox.rendering

Class PageDrawerParameters

java.lang.Object

org.apache.pdfbox.rendering.PageDrawerParameters

public final class PageDrawerParameters
extends java.lang.Object

Parameters for a PageDrawer. This class ensures allows PDFRenderer and PageDrawer to share private implementation data in a future-proof manner, while still allowing end-users to create their own subclasses of PageDrawer.

Field Summary

Fields

Modifier and Type	Field	Description
private RenderDestination	destination
private float	imageDownscalingOptimizationThreshold
private PDPage	page
private PDFRenderer	renderer
private java.awt.RenderingHints	renderingHints
private boolean	subsamplingAllowed

Constructor Summary

Constructors

Constructor	Description
PageDrawerParameters(PDFRenderer renderer, PDPage page, boolean subsamplingAllowed, RenderDestination destination, java.awt.RenderingHints renderingHints, float imageDownscalingOptimizationThreshold)	Package-private constructor.

Method Summary

Modifier and Type	Method	Description
RenderDestination	getDestination()
float	getImageDownscalingOptimizationThreshold()
PDPage	getPage()	Returns the page.
(package private) PDFRenderer	getRenderer()	Returns the renderer.
java.awt.RenderingHints	getRenderingHints()
boolean	isSubsamplingAllowed()	Returns whether to allow subsampling of images.

Methods inherited from class java.lang.Object

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

Field Detail

renderer

private final PDFRenderer renderer

page

private final PDPage page

subsamplingAllowed

private final boolean subsamplingAllowed

destination

private final RenderDestination destination

renderingHints

private final java.awt.RenderingHints renderingHints

imageDownscalingOptimizationThreshold

private final float imageDownscalingOptimizationThreshold

Constructor Detail

PageDrawerParameters

PageDrawerParameters(PDFRenderer renderer,
                     PDPage page,
                     boolean subsamplingAllowed,
                     RenderDestination destination,
                     java.awt.RenderingHints renderingHints,
                     float imageDownscalingOptimizationThreshold)

Package-private constructor.

Method Detail

getPage

public PDPage getPage()

Returns the page.

Returns:

the page

getRenderer

PDFRenderer getRenderer()

Returns the renderer.

Returns:

the renderer

isSubsamplingAllowed

public boolean isSubsamplingAllowed()

Returns whether to allow subsampling of images.

Returns:

true if subsampling of images os allowed

getDestination

public RenderDestination getDestination()

Returns:

the destination

getRenderingHints

public java.awt.RenderingHints getRenderingHints()

Returns:

the rendering hints.

getImageDownscalingOptimizationThreshold

public float getImageDownscalingOptimizationThreshold()

Returns:

the imageDownscalingOptimizationThreshold