FourJs.Report.Runtime.LabelMapper Class Reference

Class for configuring label output. More...

Inheritance diagram for FourJs.Report.Runtime.LabelMapper:

Public Member Functions
	LabelMapper (PXMLConsumer consumer)
	Creates a LabelMapper 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
String	paperWidth [get, set]
	Specifies the physial paper width as a PXML numeric expression (e.g. "21cm" or "a4width"). More...
String	paperHeight [get, set]
	Specifies the physical paper height as a PXML numeric expression (e.g. "8.5in" or "letterlength"). More...
String	width [get, set]
	Specifies the width of an idividual label as a PXML numeric expression (e.g. "5cm"). More...
String	height [get, set]
	Specifies the height of an idividual label as a PXML numeric expression (e.g. "3.5cm"). More...
int	labelsPerRow [get, set]
	Specifies the number of labels per row. More...
int	labelsPerColumn [get, set]
	Specifies the number of labels per column. 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 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.

Constructor & Destructor Documentation

FourJs.Report.Runtime.LabelMapper.LabelMapper

(

PXMLConsumer

consumer

)

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

Parameters

consumer

A PXMLConsumer

Property Documentation

String FourJs.Report.Runtime.LabelMapper.height

getset

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

int FourJs.Report.Runtime.LabelMapper.labelsPerColumn

getset

Specifies the number of labels per column.

Exceptions

ArgumentOutOfRangeException

if the argument isn't strictly positive

int FourJs.Report.Runtime.LabelMapper.labelsPerRow

getset

Specifies the number of labels per row.

Exceptions

ArgumentOutOfRangeException

if the argument isn't strictly positive

String FourJs.Report.Runtime.LabelMapper.paperHeight

getset

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

String FourJs.Report.Runtime.LabelMapper.paperWidth

getset

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

String FourJs.Report.Runtime.LabelMapper.width

getset

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