Top Description Fields Constructors Methods

org.apache.pdfbox.rendering

public final Class PageDrawerParameters

Class Inheritance

extends Object

java.lang.Object
org.apache.pdfbox.rendering.PageDrawerParameters

Imports

java.awt.RenderingHints, org.apache.pdfbox.pdmodel.PDPage

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.

Author: John Hewson

Field Summary

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

Constructor Summary

Access	Constructor and Description
pack-priv	PageDrawerParameters(PDFRenderer renderer, PDPage page, boolean subsamplingAllowed, RenderDestination destination, RenderingHints renderingHints, float imageDownscalingOptimizationThreshold) Package-private constructor.

Method Summary

Modifier and Type	Method and Description
public RenderDestination	Returns: the destination getDestination()
public float	Returns: the imageDownscalingOptimizationThreshold getImageDownscalingOptimizationThreshold()
public PDPage	Returns: the page getPage() Returns the page.
pack-priv PDFRenderer	Returns: the renderer getRenderer() Returns the renderer.
public RenderingHints	Returns: the rendering hints. getRenderingHints()
public boolean	Returns: true if subsampling of images os allowed isSubsamplingAllowed() Returns whether to allow subsampling of images.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

destination	back to summary
private final RenderDestination destination

imageDownscalingOptimizationThreshold	back to summary
private final float imageDownscalingOptimizationThreshold

page	back to summary
private final PDPage page

renderer	back to summary
private final PDFRenderer renderer

renderingHints	back to summary
private final RenderingHints renderingHints

subsamplingAllowed	back to summary
private final boolean subsamplingAllowed

Constructor Detail

PageDrawerParameters	back to summary
pack-priv PageDrawerParameters(PDFRenderer renderer, PDPage page, boolean subsamplingAllowed, RenderDestination destination, RenderingHints renderingHints, float imageDownscalingOptimizationThreshold) Package-private constructor.

Method Detail

getDestination	back to summary
public RenderDestination getDestination() Returns:RenderDestination the destination

getImageDownscalingOptimizationThreshold	back to summary
public float getImageDownscalingOptimizationThreshold() Returns:float the imageDownscalingOptimizationThreshold

getPage

back to summary

public PDPage getPage()

Returns the page.

Returns:PDPage: the page

getRenderer

back to summary

pack-priv PDFRenderer getRenderer()

Returns the renderer.

Returns:PDFRenderer: the renderer

getRenderingHints	back to summary
public RenderingHints getRenderingHints() Returns:RenderingHints the rendering hints.

isSubsamplingAllowed

back to summary

public boolean isSubsamplingAllowed()

Returns whether to allow subsampling of images.

Returns:boolean: true if subsampling of images os allowed