com.fourjs.report.runtime

Class HTMLRenderer

java.lang.Object

com.fourjs.report.runtime.FormatProducer

com.fourjs.report.runtime.HTMLRenderer

All Implemented Interfaces:

LayoutedPagesConsumer, java.io.Serializable

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

Class for configuring HTML output.

Font embedding

Fonts are not embedded in the output. Instead the font name is specified and a dynamic layout is used that can adapt in the case that the font is unavailable and a fall back font has to be used.

Layout method

A table layout is used for each page to reproduce the original layout as faithful as possible while catering for changing fonts at the same time.

Faithfulness of output

The focus for the HTML output is on the communication of content, size of the document and configurability via CSS. The grid layout doesn't cater for items that span several cells such as borders and background colors. For faithful reproduction consider using the PDFRenderer, SVGRenderer, PostscriptRenderer, Printer or ImageRenderer.

Handling of overlapping items

Since the tabular layout does no allow for items to overlap, any items that overlap are replaced by an image containing a painting of the overlapping items. In such a case a warning is issued. An exception of this rule are background images which can be removed from document by using the method setRemoveBackgroundImages(Boolean).

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	setEmbedImages(java.lang.Boolean embedImages) Activates image embedding if true, external image file referencing if false.
void	setFromPage(java.lang.Integer fromPage) Sets the first page to be included in the document.
void	setIgnoreColumnAlignment(java.lang.Boolean ignoreColumnAlignment) Sets whether the column alignment of items can be ignored allowing a more compact representation.
void	setIgnoreRowAlignment(java.lang.Boolean ignoreRowAlignment) Sets whether the row alignment of items can be ignored allowing a more compact representation.
void	setImageGenerationDirectory(java.lang.String imageGenerationDirectory) Sets the directory where images files are to be created when image embedding has been unselected.
void	setImageURLPrefix(java.lang.String imageURLPrefix) Sets the prefix for generated URLs that reference external images when image embedding has been unselected.
void	setRemoveBackgroundImages(java.lang.Boolean removeBackgroundImages) Activates background image removal if true, partially obscured images are preserved if false.
void	setRemoveWhitespace(java.lang.Boolean removeWhitespace) Activates whitespace removal if true, columns or rows containing whitespace only are preserved if false.
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

HTMLRenderer

protected HTMLRenderer()

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

Since:

2.50

HTMLRenderer

public HTMLRenderer(FormatHandler handler)

Creates a HTMLRenderer 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

setEmbedImages

public void setEmbedImages(java.lang.Boolean embedImages)

Activates image embedding if true, external image file referencing if false. The default value is true.

Parameters:

embedImages - whether images are embedded in the document or external files are used

Since:

2.50

setImageGenerationDirectory

public void setImageGenerationDirectory(java.lang.String imageGenerationDirectory)

Sets the directory where images files are to be created when image embedding has been unselected.

The directory needs to exist.

By default the images are generated in the same directory as the HTML document.

The specified directory has no impact on the URL generated to reference the image.

Parameters:

imageGenerationDirectory - the directory in which the image files will be placed.

Since:

2.50

See Also:

setEmbedImages(java.lang.Boolean), setImageURLPrefix(java.lang.String)

setImageURLPrefix

public void setImageURLPrefix(java.lang.String imageURLPrefix)

Sets the prefix for generated URLs that reference external images when image embedding has been unselected.

The default value is the empty string

Generated URLs are constructed by concatenation of of the prefix with the image file name. If for example the image file name is "1234.jpg" then the default url will be "1234.jpg" and a prefix of "images/" will result in "images/1234.jpg"

Parameters:

imageURLPrefix - a URL prefix

Since:

2.50

See Also:

setEmbedImages(java.lang.Boolean), setImageGenerationDirectory(java.lang.String)

setRemoveWhitespace

public void setRemoveWhitespace(java.lang.Boolean removeWhitespace)

Activates whitespace removal if true, columns or rows containing whitespace only are preserved if false. The default value is false.

Parameters:

removeWhitespace - whether columns or rows containing whitespace only are removed.

Since:

2.50

setIgnoreRowAlignment

public void setIgnoreRowAlignment(java.lang.Boolean ignoreRowAlignment)

Sets whether the row alignment of items can be ignored allowing a more compact representation. The default value is false.

When set, only those objects that are entirely above or entirely below each other will go in separate rows. The option reduces the amount of rows thereby loosing the horizontal alignment. The topology is not changed so that visually stacked items remain stacked.

Parameters:

ignoreRowAlignment - whether row alignment can be ignored.

Since:

2.50

setIgnoreColumnAlignment

public void setIgnoreColumnAlignment(java.lang.Boolean ignoreColumnAlignment)

Sets whether the column alignment of items can be ignored allowing a more compact representation. The default value is false.

When set, only those objects that are entirely to the left or entirely to the right each other will go in separate columns. The option reduces the amount of columns thereby loosing the vertical alignment. The topology is not changed so that visually adjacent items remain adjacent.

Parameters:

ignoreColumnAlignment - whether column alignment can be ignored.

Since:

2.50

setRemoveBackgroundImages

public void setRemoveBackgroundImages(java.lang.Boolean removeBackgroundImages)

Activates background image removal if true, partially obscured images are preserved if false. The default value is false.

Parameters:

removeBackgroundImages - whether partially obscured images are removed.

Since:

2.50