com.fourjs.report.runtime

Class PDFRenderer

java.lang.Object

com.fourjs.report.runtime.FormatProducer

com.fourjs.report.runtime.PDFRenderer

All Implemented Interfaces:

LayoutedPagesConsumer, java.io.Serializable

public class PDFRenderer
extends FormatProducer
implements LayoutedPagesConsumer, java.io.Serializable

Class for configuring PDF output.

Font embedding

Fonts are embedded. For a list of embeddable fonts use the utility FontInfoPdf.

Processing large documents

The delay between input and output is one page however, since PDF documents are read from the end it is not possible to take advantage of that to speed up viewing. Documents not containing "Page N of M" paginations exhibit nearly constant memory consumption while documents containing them have a linear consumption of about 25 KB per page. The paginations do not interfere with the streaming since a PDF specific referencing mechanism is used to set the paginations at the end of a block when the total number of pages is known.

Since:

2.50

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	legalCopyright

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PDFRenderer() Creates a PDFRenderer object.
	PDFRenderer(FormatHandler handler) Creates a PDFRenderer object that outputs to the given handler object.

Method Summary

Modifier and Type	Method and Description
void	setEncodeImagesAsJPEG(java.lang.Boolean encodeImagesAsJPEG) Sets whether images included in the document are encoded in JPEG format or in a more space consuming lossless format.
void	setFontDirectory(java.lang.String fontDirectory) Sets an additional search directory for font files.
void	setFromPage(java.lang.Integer fromPage) Sets the first page to be included in the document.
void	setJPEGQuality(java.lang.Double quality) Sets the compression quality to a value between 0 and 1 in case JPEG image inclusion has been selected.
void	setMaximumImageResolution(java.lang.Integer maximumImageResolutionInDPI) Sets the maximum DPI of images included in the document.
void	setToPage(java.lang.Integer toPage) Sets the last page (inclusive) to be included in the document.

Methods inherited from class com.fourjs.report.runtime.FormatProducer

setHandler

Methods inherited from class java.lang.Object

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

Field Detail

legalCopyright

public static final java.lang.String legalCopyright

See Also:

Constant Field Values

Constructor Detail

PDFRenderer

protected PDFRenderer()

Creates a PDFRenderer object. Constructor for the purpose of serialization of classes extending this class.

Since:

2.50

PDFRenderer

public PDFRenderer(FormatHandler handler)

Creates a PDFRenderer object that outputs to the given handler object.

Parameters:

handler - A FormatHandler

Since:

2.50

Method Detail

setFontDirectory

public void setFontDirectory(java.lang.String fontDirectory)

Sets an additional search directory for font files.

Parameters:

fontDirectory - An absolute path to a directory containing font files.

Since:

2.50

setFromPage

public void setFromPage(java.lang.Integer fromPage)

Sets the first page to be included in the document.

Parameters:

fromPage - an integer greater than zero and less than or equal to toPage.

Throws:

java.lang.IllegalArgumentException - if the above condition is violated.

Since:

2.50

setToPage

public void setToPage(java.lang.Integer toPage)

Sets the last page (inclusive) to be included in the document.

Parameters:

toPage - an integer greater than zero and greater than or equal to fromPage.

Throws:

java.lang.IllegalArgumentException - if the above condition is violated.

Since:

2.50

setEncodeImagesAsJPEG

public void setEncodeImagesAsJPEG(java.lang.Boolean encodeImagesAsJPEG)

Sets whether images included in the document are encoded in JPEG format or in a more space consuming lossless format. The default value is false.

Parameters:

encodeImagesAsJPEG - whether images are encoded in JPEG or in a lossless format

Since:

2.50

setJPEGQuality

public void setJPEGQuality(java.lang.Double quality)

Sets the compression quality to a value between 0 and 1 in case JPEG image inclusion has been selected.

A compression quality setting of 0.0 is interpreted as "high compression is important," while a setting of 1.0 is interpreted as "high image quality is important."

Parameters:

quality - a float between 0and 1 indicating the desired quality level.

Throws:

java.lang.IllegalArgumentException - if quality is not between 0and 1, inclusive.

Since:

2.50

See Also:

setEncodeImagesAsJPEG(java.lang.Boolean)

setMaximumImageResolution

public void setMaximumImageResolution(java.lang.Integer maximumImageResolutionInDPI)

Sets the maximum DPI of images included in the document. Images with higher values are resampled with the maximum value.

Parameters:

maximumImageResolutionInDPI - the maximum resolution of images included in the document

Throws:

java.lang.IllegalArgumentException - if maximumImageResolutionInDPI is not greater than 0.

Since:

2.50