JobTrayControl Class Reference

Provides access to JobTrayControl information. More...

Public Member Functions
void	dispose () throws TFormerException
	Releases the resources allocated by this instance. More...
void	dump (PrintStream s) throws IOException, TFormerException
	Dumps the current instance into a text stream. More...
String	getComment () throws TFormerException
	Gets the comment for the JobTrayControl. More...
String	getDescription () throws TFormerException
	Gets the description of the JobTrayControl. More...
long	getMaxNumberOfTrays () throws TFormerException
	Returns the maximum number of logical trays. More...
String	getName () throws TFormerException
	Gets the name of the JobTrayControl. More...
JobTrayControl	getNext () throws TFormerException
	Gets the next JobTrayControl object. More...
String	getTray (long nLogicalTray) throws TFormerException, IllegalArgumentException
	Gets the physical tray that is assigned to the logical tray. More...
boolean	isDefault () throws TFormerException
	Gets a value indicating whether this object is the default JobTrayControl of the Repository. More...
void	setComment (String sComment) throws TFormerException
	Sets the comment for the JobTrayControl. More...
void	setDescription (String sDescription) throws TFormerException
	Sets the description of the JobTrayControl. More...
void	setName (String sName) throws TFormerException
	Sets the name of the JobTrayControl. More...
void	setTray (int nLogicalTray, String sPhysicalTray) throws TFormerException
	Assigns a physical tray to a logical tray. More...
String	toString ()
	Returns a string representation of the instance. More...

Detailed Description

Provides access to JobTrayControl information.

Overview

For every single page of the output, TFORMer can dynamically select a tray on the target printer. This is useful for printing the first page of an invoice on a letterhead, or for adding an envelope to the printout. The tray selection works completely device-independent: TFORMer uses logical tray numbers (tray 1 to tray 10) which are mapped to physical (device-specific) trays or to paper format names (e.g. A4 or Letter) via a JobTrayControl-object.

A JobTrayControl is usually configured using TFORMer Designer, it can then be selected when printing a Job.

The default JobTrayControl object is named _Default_ and performs no mappings. When printing a FormLayout with this default JobTrayControl all pages of the output are sent to the printer without selecting special printer trays. In this case it is completely up to the device driver or the printer itself which trays are being selected.

Using Tray Control

Whenever output trays should be controlled by the FormLayout you must adjust the _Default_ JobTrayControl or create and assign a new JobTrayControl.

A typical JobTrayControl looks like follows:

LogicalTrayNumber	Physical Tray or Name of Paper Format	Description
1	A4	The logical tray number 1 is assigned to paper format A4. Whenever a band is printed which is assigned to logical tray 1 TFORMer instructs the printer driver to select the tray which holds the paper format A4.
2	A5	The logical tray number 2 is assigned to paper format A5. Whenever a band is printed which is assigned to logical tray 2 TFORMer instructs the printer driver to select the tray which holds the paper format A5.
3	Manual Feed in Tray 1	The logical tray number 3 is assigned to the physical printer tray named Manual Feed in Tray 1. Whenever a band is printed which is assigned to logical tray 3 TFORMer instructs the printer driver to select the physical printer tray with this name.
4	(auto)	The logical tray number 4 is not assigned to a specific tray or paper format. Whenever a band is printed which is assigned to logical tray 4 TFORMer does nothing special. The currently selected printer tray or paper format will not change.
5	(auto)	See tray 4
6	(auto)	See tray 4
7	(auto)	See tray 4
8	(auto)	See tray 4
9	(auto)	See tray 4
10	(auto)	See tray 4

A tray is always selected by its logical number. Such a logical tray number (1..10) or the value 0-Default is assigned to each band of a FormLayout. Whenever a band is printed and a new page is started, TFORMer performs a lookup for the physical tray assignment using the active JobTrayControl. If the value 0-Default is assigned this behavior changes: this value instructs TFORMer to use the currently active tray (or paper format name) of the output device.

Note

TFORMer uses a configuration file named TFORMer.xml for adjusting output options and paper format names. Since paper format names are also used in JobTrayControl please check out TFORMer.XML Configuration File too.

Attention

The JobTrayControl is only valid as long as it is available in the Repository. If it is removed from the Repository all instances of the JobTrayControl immediately become invalid.

Note

Thread-safety: A single instance of this class must not be used by different threads.

Member Function Documentation

void dispose

(

)

throws TFormerException

Releases the resources allocated by this instance.

Call this method in every case (even in case of exceptions) is this instance is not required anymore.

void dump

(

PrintStream

s

)

throws IOException, TFormerException

Dumps the current instance into a text stream.

Parameters

s	Instance of the stream

String getComment

(

)

throws TFormerException

Gets the comment for the JobTrayControl.

Returns

The comment for the JobTrayControl

String getDescription

(

)

throws TFormerException

Gets the description of the JobTrayControl.

Returns

The description of the JobTrayControl

long getMaxNumberOfTrays

(

)

throws TFormerException

Returns the maximum number of logical trays.

Returns

The maximum number of logical trays.

String getName

(

)

throws TFormerException

Gets the name of the JobTrayControl.

Returns

The name of the JobTrayControl

JobTrayControl getNext

(

)

throws TFormerException

Gets the next JobTrayControl object.

Returns

The next JobTrayControl object in the list or null.

String getTray

(

long

nLogicalTray

)

throws TFormerException, IllegalArgumentException

Gets the physical tray that is assigned to the logical tray.

Parameters

nLogicalTray

The index of the logical tray. The range for this index is: [1 ... MaxNumberOfTrays]

Returns

The name of the physical tray

Exceptions

IllegalArgumentException

If the index of the logical tray is invalid

boolean isDefault

(

)

throws TFormerException

Gets a value indicating whether this object is the default JobTrayControl of the Repository.

Every Repository has a default JobTrayControl-object. To modify the default JobTrayControl fetch the object with Repository.getDefaultJobTrayControl and modify its properties.

Returns

true if this JobTrayControl is the default.

void setComment

(

String

sComment

)

throws TFormerException

Sets the comment for the JobTrayControl.

Parameters

sComment

The comment for the JobTrayControl

void setDescription

(

String

sDescription

)

throws TFormerException

Sets the description of the JobTrayControl.

Parameters

sDescription

The description of the JobTrayControl

void setName

(

String

sName

)

throws TFormerException

Sets the name of the JobTrayControl.

You should not rename the default JobTrayControl which is named _Default_.

Parameters

sName

The name of the JobTrayControl

void setTray	(	int	nLogicalTray,
		String	sPhysicalTray
	)		throws TFormerException

Assigns a physical tray to a logical tray.

Parameters

nLogicalTray	The index of the logical tray. The range for this index is: [1 ... MaxNumberOfTrays]
sPhysicalTray	The name of the physical tray

String toString

(

)

Returns a string representation of the instance.

Returns

A string representation of the instance