TFORMer SDK - JAVA  7.0
Public Member Functions
Printer Class Reference

Provides access to Printer information. More...

List of all members.

Public Member Functions

void dispose () throws TFormerException
 Releases the resources allocated by this instance.
void dump (PrintStream s) throws IOException, TFormerException
 Dumps the current instance into a text stream.
String getComment () throws TFormerException
 Gets the comment for the Printer.
String getDeviceName () throws TFormerException
 Gets the device name of the Printer.
String getName () throws TFormerException
 Gets the name of the Printer.
Printer getNext () throws TFormerException
 Gets the next Printer defined in the Repository.
int getPrinterDeviceType () throws TFormerException
 Gets the device type of the Printer.
boolean isDefault () throws TFormerException
 Gets a value indicating whether this Printer is the default Printer.
void setComment (String sComment) throws TFormerException
 Sets the comment of the Printer.
void setDeviceName (String sDeviceName) throws TFormerException
 Sets the device name of the Printer.
void setName (String sName) throws TFormerException
 Sets the name of the Printer.
void setPrinterDeviceType (int nPrinterDeviceType) throws TFormerException
 Sets the device type of the Printer.
String toString ()
 Returns a string representation of the instance.

Detailed Description

Provides access to Printer information.

This class provides access to Printer-information stored in a Repository.

Overview

The term Printer refers to an output device defined in a Repository. A Printer is used by TFORMer Server only.

Note:
A stand-alone FormLayout does not support Printer-objects!
Thread-safety: A single instance of this class must not be used by different threads.
Attention:
Internal use only

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:
sInstance of the stream
String getComment ( ) throws TFormerException

Gets the comment for the Printer.

Returns:
The comment for the Printer
String getDeviceName ( ) throws TFormerException

Gets the device name of the Printer.

Returns:
The device name of the Printer
String getName ( ) throws TFormerException

Gets the name of the Printer.

Returns:
The name of the Printer

Gets the next Printer defined in the Repository.

To retrieve the first Printer within a Repository refer to Repository.getFirstPrinter.

Attention:
Internal use only
Returns:
The next Printer-object in the list or null.

Gets the device type of the Printer.

Returns:
The device type of the Printer
boolean isDefault ( ) throws TFormerException

Gets a value indicating whether this Printer is the default Printer.

Returns:
true if this Printer is the default Printer.
void setComment ( String  sComment) throws TFormerException

Sets the comment of the Printer.

Parameters:
sCommentThe comment of the Printer
void setDeviceName ( String  sDeviceName) throws TFormerException

Sets the device name of the Printer.

Parameters:
sDeviceNameThe device name of the Printer
void setName ( String  sName) throws TFormerException

Sets the name of the Printer.

Parameters:
sNameThe name of the Printer
void setPrinterDeviceType ( int  nPrinterDeviceType) throws TFormerException

Sets the device type of the Printer.

Parameters:
nPrinterDeviceTypeThe device type of the Printer
Todo:
Enumeration of devicetype
String toString ( )

Returns a string representation of the instance.

Returns:
A string representation of the instance

© 2006-2012 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Tue Oct 23 2012 16:33:20 for TFORMer SDK - JAVA with doxygen 1.8.0