Printer Class Reference

Provides access to Printer information. More...

List of all members.

Public Member Functions

void dispose () throws TFormerException
 Releases the resources allocated into TFORMer runtime 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 of 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. A stand-alone FormLayout does not support Printer-objects!



Thread-safety:

A single instance of this class must not be used by different threads.



Internal use only!



Member Function Documentation

void dispose (  )  throws TFormerException

Releases the resources allocated into TFORMer runtime by this instance.

Remember to call this method always after the use of the instance, in order to release the memory allocated.

Exceptions:
TFormerException error occurred into TFORMer runtime.

void dump ( PrintStream  s  )  throws IOException, TFormerException

Dumps the current instance into a text stream.

Parameters:
s instance of the stream
Exceptions:
IOException error in I/O
TFormerException error occurred into TFORMer runtime.

String getComment (  )  throws TFormerException

Gets the comment of the Printer.

Returns:
the comment
Exceptions:
TFormerException 

String getDeviceName (  )  throws TFormerException

Gets the device name of the Printer.

Returns:
The device name of the Printer.
Exceptions:
TFormerException 

String getName (  )  throws TFormerException

Gets the name of the Printer.

Returns:
The name of the Printer.
Exceptions:
TFormerException 

Printer getNext (  )  throws TFormerException

Gets the next Printer defined in the Repository.

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

The property is null if there are no further objects available.

Internal usage only.

Returns:
The next Printer object in the list or null.
Exceptions:
TFormerException 

int getPrinterDeviceType (  )  throws TFormerException

Gets the device type of the Printer.

Returns:
The device type of the Printer.
Exceptions:
TFormerException 

boolean isDefault (  )  throws TFormerException

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

Returns:
true if this Printer is the default Printer; otherwise, false.
Exceptions:
TFormerException 

void setComment ( String  sComment  )  throws TFormerException

Sets the comment of the Printer.

Parameters:
sComment The comment of the Printer.
Exceptions:
TFormerException 

void setDeviceName ( String  sDeviceName  )  throws TFormerException

Sets the device name of the Printer.

Parameters:
sDeviceName The device name of the Printer.
Exceptions:
TFormerException 

void setName ( String  sName  )  throws TFormerException

Sets the name of the Printer.

Parameters:
sName The name of the Printer.
Exceptions:
TFormerException 

void setPrinterDeviceType ( int  nPrinterDeviceType  )  throws TFormerException

Sets the device type of the Printer.

Parameters:
nPrinterDeviceType The device type of the Printer.
Exceptions:
TFormerException 

String toString (  ) 

Returns a string representation of the instance.

Returns:
a string representation of the instance


© 2006-2009 All rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Wed Sep 2 16:01:28 2009 for TFORMer Runtime JAVA Developer Reference with doxygen 1.5.8