com.fourjs.report.runtime

Class ImageRenderer

java.lang.Object

com.fourjs.report.runtime.ImageRenderer

All Implemented Interfaces:

LayoutedPagesConsumer, java.io.Serializable

public class ImageRenderer
extends java.lang.Object
implements LayoutedPagesConsumer, java.io.Serializable

Class for configuring image (bitmap) output.

General

An individual image file is created for each page in the report while several option exist for the naming of the files.

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	ImageRenderer.ImageFormat

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ImageRenderer() Creates a ImageRenderer object.

Method Summary

Modifier and Type	Method and Description
void	setAntialiasFonts(java.lang.Boolean antialiasFonts) Sets whether text is drawn using antialiasing.
void	setAntialiasShapes(java.lang.Boolean antialiasShapes) Sets whether shapes are drawn using antialiasing.
void	setFileNamePrefix(java.lang.String fileNamePrefix) Sets the file name prefix of the generated image files.
void	setFileType(ImageRenderer.ImageFormat fileType) Sets the output format as determined by the fileType argument.
void	setFileType(java.lang.String fileType) Sets the output format as determined by the fileType argument.
void	setFromPage(java.lang.Integer fromPage) Sets the first page to be included in the document.
void	setGenerationDirectoryName(java.lang.String generationDirectoryName) Sets the name of the directory in which the files are created.
void	setGrayscale(java.lang.Boolean grayscale) Sets whether the images produced are gray scale or color bitmaps.
void	setResolution(java.lang.Integer resolutionInDPI) Sets the resolution of the images produced.
void	setShrinkImageToPageContent(java.lang.Boolean shrinkImagesToPageContent) Sets whether the images produced are cropped to the page content (size of the page box) or have full page size.
void	setToPage(java.lang.Integer toPage) Sets the last page (inclusive) to be included in the document.
void	setUsePageNamesAsFileNames(java.lang.Boolean usePageNamesAsFileNames) Sets whether the page names ("name" attribute) in the document should be used as file names.

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

ImageRenderer

public ImageRenderer()

Creates a ImageRenderer object.

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

setAntialiasFonts

public void setAntialiasFonts(java.lang.Boolean antialiasFonts)

Sets whether text is drawn using antialiasing. The default value is true.

Parameters:

antialiasFonts - whether text is drawn with antialiasing

setAntialiasShapes

public void setAntialiasShapes(java.lang.Boolean antialiasShapes)

Sets whether shapes are drawn using antialiasing. The default value is true.

Parameters:

antialiasShapes - whether shapes are drawn with antialiasing

Since:

2.50

setGrayscale

public void setGrayscale(java.lang.Boolean grayscale)

Sets whether the images produced are gray scale or color bitmaps. The default value is false.

Parameters:

grayscale - whether gray scale images are produced

Since:

2.50

setFileType

public void setFileType(ImageRenderer.ImageFormat fileType)

Sets the output format as determined by the fileType argument.

Parameters:

fileType - one of the following values:

• jpg
• png
• bmp
• gif

Other file types may be available depending on the JVM used. These can be selected using the method setFileType(String).

Since:

2.50

See Also:

setFileType(String)

setFileType

public void setFileType(java.lang.String fileType)

Sets the output format as determined by the fileType argument.

Parameters:

fileType - one of the following values:

• "jpg"
• "png"
• "bmp"
• "gif"
• Any output type listed by the command line utility ImageIOInfo

Since:

2.50

See Also:

setFileType(ImageFormat)

setResolution

public void setResolution(java.lang.Integer resolutionInDPI)

Sets the resolution of the images produced.

Parameters:

resolutionInDPI - the resolution in DPI

Throws:

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

Since:

2.50

setShrinkImageToPageContent

public void setShrinkImageToPageContent(java.lang.Boolean shrinkImagesToPageContent)

Sets whether the images produced are cropped to the page content (size of the page box) or have full page size. The default value is false.

Parameters:

shrinkImagesToPageContent - whether images are cropped

Since:

2.50

setFileNamePrefix

public void setFileNamePrefix(java.lang.String fileNamePrefix)

Sets the file name prefix of the generated image files. The name of the files is constructed from a concatenation of this prefix and the page number as a four digit integer with leading zeros. A complementary method of file name generation can be activated calling setUsePageNamesAsFileNames(java.lang.Boolean). The default value is "img".

Parameters:

fileNamePrefix - the file name prefix of the generated image files.

Since:

2.50

See Also:

setUsePageNamesAsFileNames(java.lang.Boolean)

setGenerationDirectoryName

public void setGenerationDirectoryName(java.lang.String generationDirectoryName)

Sets the name of the directory in which the files are created. The default value is the current working directory.

Parameters:

generationDirectoryName - the name of the file creation directory

Since:

2.50

setUsePageNamesAsFileNames

public void setUsePageNamesAsFileNames(java.lang.Boolean usePageNamesAsFileNames)

Sets whether the page names ("name" attribute) in the document should be used as file names. In the case that a name is not unique a disambiguation number is appended. In the case that a page does not set the "name" attribute the default naming scheme explained in setFileNamePrefix(java.lang.String) is used. The default value is false.

Parameters:

usePageNamesAsFileNames - whether document page names should be used as file names

Since:

2.50