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

Class for conversion of a PXML data stream to a layouted PXML document. The processor transforms the page markup stream into individual pages each containing only object for which position and size are known in absolute coordinates. More...

Inheritance diagram for FourJs.Report.Runtime.PXMLLayouter:
FourJs.Report.Runtime.LayoutedPagesProducer FourJs.Report.Runtime.PXMLConsumer

Public Member Functions

 PXMLLayouter (LayoutedPagesConsumer consumer)
 Creates a PDFRenderer object that outputs to the given consumer object. More...
 
- Public Member Functions inherited from FourJs.Report.Runtime.LayoutedPagesProducer
 LayoutedPagesProducer (LayoutedPagesConsumer consumer)
 Creates a LayoutedPagesProducer object that outputs to the given consumer object. More...
 

Static Public Attributes

static String legalCopyright = Version.CLASS_COPYRIGHT
 

Properties

String pageWidth [get, set]
 Specifies the page width as a PXML numeric expression (e.g. "21cm" or "a4width"). More...
 
String pageLength [get, set]
 Specifies the page height as a PXML numeric expression (e.g. "8.5in" or "letterlength"). More...
 
String leftMargin [get, set]
 Specifies the left margin as a PXML numeric expression (e.g. "1.5cm") More...
 
String topMargin [get, set]
 Specifies the top margin as a PXML numeric expression (e.g. "1.5cm") More...
 
String rightMargin [get, set]
 Specifies the right margin as a PXML numeric expression (e.g. "1.5cm") More...
 
String bottomMargin [get, set]
 Specifies the bottom margin as a PXML numeric expression (e.g. "1.5cm") More...
 
String title [get, set]
 Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>. More...
 
String author [get, set]
 Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>. More...
 
String creator [get, set]
 Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>. More...
 
String subject [get, set]
 Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>. More...
 
String keywords [get, set]
 Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>. More...
 
bool markOverfullBoxesInDocument [get, set]
 Activates visual marking of overfull boxes if true. If activated, overfull boxes will be highlighted in red for the purpose of debugging. The default value is false. More...
 
- Properties inherited from FourJs.Report.Runtime.LayoutedPagesProducer
LayoutedPagesConsumer consumer [get, set]
 Sets the specified consumer as the consumer for the output produced by this processor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from FourJs.Report.Runtime.LayoutedPagesProducer
 LayoutedPagesProducer ()
 Creates a LayoutedPagesProducer object. Constructor for the purpose of serialization of classes extending this class. More...
 

Detailed Description

Class for conversion of a PXML data stream to a layouted PXML document. The processor transforms the page markup stream into individual pages each containing only object for which position and size are known in absolute coordinates.

Processing large documents

The delay between input and output varies but is seldom more than one page and the memory consumption is nearly constant. Exceptions are some PXML elements such as pivot tables or charts may delay output because data needs to be sorted or aggregated. See the documentation of these elements for details.

Constructor & Destructor Documentation

FourJs.Report.Runtime.PXMLLayouter.PXMLLayouter ( LayoutedPagesConsumer  consumer)

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

Parameters
consumer

Property Documentation

String FourJs.Report.Runtime.PXMLLayouter.author
getset

Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>.

String FourJs.Report.Runtime.PXMLLayouter.bottomMargin
getset

Specifies the bottom margin as a PXML numeric expression (e.g. "1.5cm")

String FourJs.Report.Runtime.PXMLLayouter.creator
getset

Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>.

String FourJs.Report.Runtime.PXMLLayouter.keywords
getset

Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>.

String FourJs.Report.Runtime.PXMLLayouter.leftMargin
getset

Specifies the left margin as a PXML numeric expression (e.g. "1.5cm")

bool FourJs.Report.Runtime.PXMLLayouter.markOverfullBoxesInDocument
getset

Activates visual marking of overfull boxes if true. If activated, overfull boxes will be highlighted in red for the purpose of debugging. The default value is false.

String FourJs.Report.Runtime.PXMLLayouter.pageLength
getset

Specifies the page height as a PXML numeric expression (e.g. "8.5in" or "letterlength").

String FourJs.Report.Runtime.PXMLLayouter.pageWidth
getset

Specifies the page width as a PXML numeric expression (e.g. "21cm" or "a4width").

String FourJs.Report.Runtime.PXMLLayouter.rightMargin
getset

Specifies the right margin as a PXML numeric expression (e.g. "1.5cm")

String FourJs.Report.Runtime.PXMLLayouter.subject
getset

Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>.

String FourJs.Report.Runtime.PXMLLayouter.title
getset

Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>.

String FourJs.Report.Runtime.PXMLLayouter.topMargin
getset

Specifies the top margin as a PXML numeric expression (e.g. "1.5cm")