Four Js Genero Report Writer
FourJs.Report.Runtime.PDFRenderer Class Reference

Class for configuring PDF output. More...

Inheritance diagram for FourJs.Report.Runtime.PDFRenderer:
FourJs.Report.Runtime.FormatProducer FourJs.Report.Runtime.LayoutedPagesConsumer

Public Member Functions

 PDFRenderer (FormatHandler handler)
 Creates a PDFRenderer object that outputs to the given handler object. More...
 
- Public Member Functions inherited from FourJs.Report.Runtime.FormatProducer
 FormatProducer (FormatHandler handler)
 Creates a FormatProducer object that outputs to the given handler object. More...
 

Static Public Attributes

static String legalCopyright = Version.CLASS_COPYRIGHT
 
- Static Public Attributes inherited from FourJs.Report.Runtime.FormatProducer
static String legalCopyright = Version.CLASS_COPYRIGHT
 

Properties

String fontDirectory [get, set]
 Sets an additional search directory for font files. fontDirectory is an absolute path to a directory containing font files. More...
 
int fromPage [get, set]
 Sets the first page to be included in the document. fromPage an integer greater than zero and less than or equal to toPage More...
 
int toPage [get, set]
 Sets the last page (inclusive) to be included in the document. toPage an integer greater than zero and greater than or equal to fromPage More...
 
bool encodeImagesAsJPEG [get, set]
 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. More...
 
double JPEGquality [get, set]
 Sets the compression quality to a value between 0 and 1 in case JPEG image inclusion has been selected. More...
 
int maximumImageResolution [get, set]
 Sets the maximum DPI of images included in the document. Images with higher values are resampled with the maximum value. More...
 
- Properties inherited from FourJs.Report.Runtime.FormatProducer
FormatHandler handler [get]
 Sets the specified handler as the handler for the output produced by this processor. More...
 

Detailed Description

Class for configuring PDF output.

Font embedding

Fonts are embedded. For a list of embeddable fonts use the utility com.fourjs.report.main.FontInfoPdf 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.

Constructor & Destructor Documentation

FourJs.Report.Runtime.PDFRenderer.PDFRenderer ( FormatHandler  handler)

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

Parameters
handlerA FormatHandler

Property Documentation

bool FourJs.Report.Runtime.PDFRenderer.encodeImagesAsJPEG
getset

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.

String FourJs.Report.Runtime.PDFRenderer.fontDirectory
getset

Sets an additional search directory for font files. fontDirectory is an absolute path to a directory containing font files.

int FourJs.Report.Runtime.PDFRenderer.fromPage
getset

Sets the first page to be included in the document. fromPage an integer greater than zero and less than or equal to toPage

Exceptions
ArgumentOutOfRangeExceptionif the above condition is violated.
double FourJs.Report.Runtime.PDFRenderer.JPEGquality
getset

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."

Exceptions
ArgumentOutOfRangeExceptionif quality is not between 0 and 1 , inclusive

encodeImagesAsJPEG

int FourJs.Report.Runtime.PDFRenderer.maximumImageResolution
getset

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

Exceptions
ArgumentOutOfRangeExceptionif maximumImageResolutionInDPI is not greater than 0.
int FourJs.Report.Runtime.PDFRenderer.toPage
getset

Sets the last page (inclusive) to be included in the document. toPage an integer greater than zero and greater than or equal to fromPage

exception cref="ArgumentOutOfRangeException">if the above condition is violated.