com.fourjs.report.runtime

Class PXMLLayouter

java.lang.Object

com.fourjs.report.runtime.LayoutedPagesProducer

com.fourjs.report.runtime.PXMLLayouter

All Implemented Interfaces:

PXMLConsumer, java.io.Serializable

public class PXMLLayouter
extends LayoutedPagesProducer
implements PXMLConsumer, java.io.Serializable

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.

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

Method Summary

Modifier and Type	Method and Description
void	setAuthor(java.lang.String author) Sets the report's author metadata attribute.
void	setBottomMargin(java.lang.String bottomMarginExpression) Specifies the bottom margin as a PXML numeric expression (e.g.
void	setCreator(java.lang.String creator) Sets the report creator.
void	setKeywords(java.lang.String keywords) Sets the report's keywords meta data attribute.
void	setLeftMargin(java.lang.String leftMarginExpression) Specifies the left margin as a PXML numeric expression (e.g.
void	setMarkOverfullBoxesInDocument(java.lang.Boolean markOverfullBoxesInDocument) Activates visual marking of overfull boxes if true.
void	setPageLength(java.lang.String pageLengthExpression) Specifies the page height as a PXML numeric expression (e.g.
void	setPageWidth(java.lang.String pageWidthExpression) Specifies the page width as a PXML numeric expression (e.g.
void	setRightMargin(java.lang.String rightMarginExpression) Specifies the right margin as a PXML numeric expression (e.g.
void	setSubject(java.lang.String subject) Sets the report subject.
void	setTitle(java.lang.String title) Sets the report title.
void	setTopMargin(java.lang.String topMarginExpression) Specifies the top margin as a PXML numeric expression (e.g.

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

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

PXMLLayouter

protected PXMLLayouter()

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

Since:

2.50

PXMLLayouter

public PXMLLayouter(LayoutedPagesConsumer consumer)

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

Parameters:

consumer - A LayoutedPageConsumer

Since:

2.50

Method Detail

setPageWidth

public void setPageWidth(java.lang.String pageWidthExpression)

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

Parameters:

pageWidthExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setPageLength

public void setPageLength(java.lang.String pageLengthExpression)

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

Parameters:

pageLengthExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setLeftMargin

public void setLeftMargin(java.lang.String leftMarginExpression)

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

Parameters:

leftMarginExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setTopMargin

public void setTopMargin(java.lang.String topMarginExpression)

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

Parameters:

topMarginExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setRightMargin

public void setRightMargin(java.lang.String rightMarginExpression)

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

Parameters:

rightMarginExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setBottomMargin

public void setBottomMargin(java.lang.String bottomMarginExpression)

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

Parameters:

bottomMarginExpression - A PXML numeric expression.

Throws:

java.lang.IllegalArgumentException - if the expression isn't a valid PXML numeric expression

Since:

2.50

setTitle

public void setTitle(java.lang.String title)

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 FourRpProcessor.

Parameters:

title - The report title.

Since:

2.50

setAuthor

public void setAuthor(java.lang.String author)

Sets the report's author metadata attribute. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report author property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the FourRpProcessor.

Parameters:

author - The report's author metadata attribute.

Since:

2.50

setCreator

public void setCreator(java.lang.String creator)

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

Parameters:

creator - The report creator.

Since:

2.50

setSubject

public void setSubject(java.lang.String subject)

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

Parameters:

subject - The report subject.

Since:

2.50

setKeywords

public void setKeywords(java.lang.String keywords)

Sets the report's keywords meta data attribute. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report keyword property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the FourRpProcessor.

Parameters:

keywords - The report's keywords.

Since:

2.50

setMarkOverfullBoxesInDocument

public void setMarkOverfullBoxesInDocument(java.lang.Boolean markOverfullBoxesInDocument)

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.

Parameters:

markOverfullBoxesInDocument - whether overfull boxes are visually marked.

Since:

2.50