com.fourjs.report.runtime

Class MultiPageMapper

java.lang.Object

com.fourjs.report.runtime.PXMLProducer

com.fourjs.report.runtime.PageMapper

com.fourjs.report.runtime.MultiPageMapper

All Implemented Interfaces:

PXMLConsumer, java.io.Serializable

public class MultiPageMapper
extends PageMapper
implements java.io.Serializable

Class for rendering several pages of a report on a single physical page.

Logical to physical page mapping

The processor performs a PXML to PXML transformation that places a number of pages in a grid layout on a physical page. Both the logical and physical pages need to be ISO 216 formats (e.g. A4).

Processing large documents

There is no delay between input and output and memory consumption is constant.

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	MultiPageMapper() Creates a MultiPageMapper object.
	MultiPageMapper(PXMLConsumer consumer) Creates a MultiPageMapper object that outputs to the given consumer object.

Method Summary

Modifier and Type	Method and Description
void	setIsoNumber(java.lang.Integer isoNumber) Specifies the ISO value (e.g.
void	setPageExponent(java.lang.Integer pageExponent) Specifies the number of logical pages that will be placed on a paper sheet as a index of 2.
void	setPortrait(java.lang.Boolean portrait) Specifies the orientation of the report (logical pages).

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

setPaperBottomMargin, setPaperLeftMargin, setPaperRightMargin, setPaperTopMargin

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

setConsumer

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

MultiPageMapper

protected MultiPageMapper()

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

Since:

2.50

MultiPageMapper

public MultiPageMapper(PXMLConsumer consumer)

Creates a MultiPageMapper object that outputs to the given consumer object.

Parameters:

consumer - A PXMLConsumer

Since:

2.50

Method Detail

setPageExponent

public void setPageExponent(java.lang.Integer pageExponent)

Specifies the number of logical pages that will be placed on a paper sheet as a index of 2. The actual number of pages is calculated by the formula count=2^pageExponent. The default value is 0.

Parameters:

pageExponent - The number of logical pages per sheet as a index of 2.

Throws:

java.lang.IllegalArgumentException - if the value isn't positive

Since:

2.50

setIsoNumber

public void setIsoNumber(java.lang.Integer isoNumber)

Specifies the ISO value (e.g. 4 for A4). The default value is taken from the current report template file if any.

Parameters:

isoNumber - The iso value (e.g. 4 for A4).

Throws:

java.lang.IllegalArgumentException - if the value isn't positive

Since:

2.50

setPortrait

public void setPortrait(java.lang.Boolean portrait)

Specifies the orientation of the report (logical pages). The default value is taken from the current report template file if any.

Parameters:

portrait - "Portrait" if true otherwise "landscape"

Since:

2.50