com.fourjs.report.runtime

Class LabelMapper

java.lang.Object

com.fourjs.report.runtime.PXMLProducer

com.fourjs.report.runtime.PageMapper

com.fourjs.report.runtime.LabelMapper

All Implemented Interfaces:

PXMLConsumer, java.io.Serializable

public class LabelMapper
extends PageMapper
implements java.io.Serializable

Class for configuring label output.

Logical to physical page mapping

The processor performs a PXML to PXML transformation allowing a label report to define the layout of a single label which is then stamped multiple time onto a larger page. The labels are arranged in a grid with a specifiable amount of rows and columns.

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

Method Summary

Modifier and Type	Method and Description
void	setHeight(java.lang.String heightExpression) Specifies the height of an idividual label as a PXML numeric expression (e.g.
void	setLabelsPerColumn(java.lang.Integer labelsPerColumn) Specifies the number of labels per column.
void	setLabelsPerRow(java.lang.Integer labelsPerRow) Specifies the number of labels per row.
void	setPaperHeight(java.lang.String paperHeightExpression) Specifies the physical paper height as a PXML numeric expression (e.g.
void	setPaperWidth(java.lang.String paperWidthExpression) Specifies the physial paper width as a PXML numeric expression (e.g.
void	setWidth(java.lang.String widthExpression) Specifies the width of an idividual label as a PXML numeric expression (e.g.

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

LabelMapper

protected LabelMapper()

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

Since:

2.50

LabelMapper

public LabelMapper(PXMLConsumer consumer)

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

Parameters:

consumer - A PXMLConsumer

Since:

2.50

Method Detail

setPaperWidth

public void setPaperWidth(java.lang.String paperWidthExpression)

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

Parameters:

paperWidthExpression - A PXML numeric expression.

Throws:

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

Since:

2.50

setPaperHeight

public void setPaperHeight(java.lang.String paperHeightExpression)

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

Parameters:

paperHeightExpression - A PXML numeric expression.

Throws:

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

Since:

2.50

setWidth

public void setWidth(java.lang.String widthExpression)

Specifies the width of an idividual label as a PXML numeric expression (e.g. "5cm").

Parameters:

widthExpression - A PXML numeric expression.

Throws:

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

Since:

2.50

setHeight

public void setHeight(java.lang.String heightExpression)

Specifies the height of an idividual label as a PXML numeric expression (e.g. "3.5cm").

Parameters:

heightExpression - A PXML numeric expression.

Throws:

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

Since:

2.50

setLabelsPerRow

public void setLabelsPerRow(java.lang.Integer labelsPerRow)

Specifies the number of labels per row.

Parameters:

labelsPerRow - The number of labels per row.

Throws:

java.lang.IllegalArgumentException - if the argument isn't strictly positive

Since:

2.50

setLabelsPerColumn

public void setLabelsPerColumn(java.lang.Integer labelsPerColumn)

Specifies the number of labels per column.

Parameters:

labelsPerColumn - The number of labels per column.

Throws:

java.lang.IllegalArgumentException - if the argument isn't strictly positive

Since:

2.50