com.fourjs.report.runtime

Class RTFRenderer

java.lang.Object

com.fourjs.report.runtime.FormatProducer

com.fourjs.report.runtime.RTFRenderer

All Implemented Interfaces:

LayoutedPagesConsumer, java.io.Serializable

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

Class for configuring RTF output.

Font embedding

Fonts are not embedded in the output.

Faithfulness of output

The focus for the RTF output is on the alterability of content. For faithful reproduction consider using the PDFRenderer, SVGRenderer, PostscriptRenderer, Printer or ImageRenderer.

Processing large documents

For documents not containing "Page N of M" paginations the delay between input and output is one page and memory consumption is nearly constant. For documents containing "Page N of M" paginations the latency is M pages and the memory consumption is linear within a pagination block and hence can exhaust heap space if individual blocks are very large.

Since:

2.50

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RTFRenderer.ImageFormat
static class	RTFRenderer.OutputFormat

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RTFRenderer.OutputFormat	getOutputFormat()
void	setFromPage(java.lang.Integer fromPage) Sets the first page to be included in the document.
void	setImageFormat(RTFRenderer.ImageFormat imageFormat) Sets the image format of images contained in the document as determined by the imageFormat argument.
void	setMaximumImageResolution(java.lang.Integer maximumImageResolutionInDPI) Sets the maximum DPI of images included in the document.
void	setMemoryThreshold(java.lang.Integer memoryThresholdInBytes) Sets the threshold for disk swapping.
void	setOutputFormat(RTFRenderer.OutputFormat outputFormat) Sets the output format as determined by the outputFormat argument.
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

RTFRenderer

protected RTFRenderer()

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

Since:

2.50

RTFRenderer

public RTFRenderer(FormatHandler handler)

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

Parameters:

handler - A FormatHandler

Since:

2.50

Method Detail

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

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

setImageFormat

public void setImageFormat(RTFRenderer.ImageFormat imageFormat)

Sets the image format of images contained in the document as determined by the imageFormat argument.

Parameters:

imageFormat - one of the following values:

• png
• jpg

Since:

2.50

setMemoryThreshold

public void setMemoryThreshold(java.lang.Integer memoryThresholdInBytes)

Sets the threshold for disk swapping. Documents exceeding the value will be processed using a temporary file thereby reducing the amount of heap space used for processing.

Parameters:

memoryThresholdInBytes - documents exceeding his value will be processed from disk.

Throws:

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

Since:

2.50

getOutputFormat

public RTFRenderer.OutputFormat getOutputFormat()

setOutputFormat

public void setOutputFormat(RTFRenderer.OutputFormat outputFormat)

Sets the output format as determined by the outputFormat argument.

Parameters:

outputFormat - one of the following values:

• RTF (MS-Word RTF)
• OORTF (Open Office RTF)

Since:

2.50