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

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

Inheritance diagram for FourJs.Report.Runtime.MultiPageMapper:
FourJs.Report.Runtime.PageMapper FourJs.Report.Runtime.PXMLProducer FourJs.Report.Runtime.PXMLConsumer

Public Member Functions

 MultiPageMapper (PXMLConsumer consumer)
 Creates a MultiPageMapper object that outputs to the given consumer object. More...
 
- Public Member Functions inherited from FourJs.Report.Runtime.PageMapper
 PageMapper (PXMLConsumer consumer)
 Creates a PageMapper object that outputs to the given consumer object. More...
 
- Public Member Functions inherited from FourJs.Report.Runtime.PXMLProducer
 PXMLProducer (PXMLConsumer consumer)
 Creates a PXMLProducer object that outputs to the given consumer object. More...
 

Static Public Attributes

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

Properties

int pageExponent [get, set]
 Specifies the number of logical pages that will be placed on a paper sheet as a index of 2. More...
 
int isoNumber [get, set]
 Specifies the ISO value (e.g. 4 for A4). More...
 
bool portrait [get, set]
 Specifies the orientation of the report (logical pages). More...
 
- Properties inherited from FourJs.Report.Runtime.PageMapper
String paperTopMargin [get, set]
 Specifies the top margin of the physical paper as a PXML numeric expression (e.g. "1.5cm") More...
 
String paperBottomMargin [get, set]
 Specifies the right margin the physical paper label as a PXML numeric expression (e.g. "1.5cm") More...
 
String paperLeftMargin [get, set]
 Specifies the left margin the physical paper label as a PXML numeric expression (e.g. "1.5cm") More...
 
String paperRightMargin [get, set]
 Specifies the right margin the physical paper label as a PXML numeric expression (e.g. "1.5cm") More...
 
- Properties inherited from FourJs.Report.Runtime.PXMLProducer
PXMLConsumer consumer [get]
 Sets the output consumer. More...
 

Detailed Description

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.

Constructor & Destructor Documentation

FourJs.Report.Runtime.MultiPageMapper.MultiPageMapper ( PXMLConsumer  consumer)

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

Parameters
consumerA PXMLConsumer

Property Documentation

int FourJs.Report.Runtime.MultiPageMapper.isoNumber
getset

Specifies the ISO value (e.g. 4 for A4).

The default value is taken from the current report template file if any.

Exceptions
ArgumentOutOfRangeExceptionif the value isn't positive
int FourJs.Report.Runtime.MultiPageMapper.pageExponent
getset

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.

Exceptions
ArgumentOutOfRangeExceptionif the value isn't positive
bool FourJs.Report.Runtime.MultiPageMapper.portrait
getset

Specifies the orientation of the report (logical pages).

The default value is taken from the current report template file if any.