TFORMer Class Reference

Provides methods to query status information and to license TFORMer SDK. More...

Public Member Functions
void	finalize () throws Throwable
	Releases unmanaged resources and performs other cleanup operations.

Static Public Member Functions
static File	getExampleFile (String subdir, String fileName)
	Return the default example directory. More...
static boolean	isDesignerAvailable () throws TFormerException
	Indicates whether TFORMer Designer is available or not. More...
static void	license (String sLicensee, ELicenseKind kind, int nNumberOfLicenses, String sKey) throws TFormerException
	Applies a license to this instance of the TFORMer SDK. More...

Detailed Description

Provides methods to query status information and to license TFORMer SDK.

Member Function Documentation

static File getExampleFile ( String  subdir, String  fileName  )

static

Return the default example directory.

It's possible to override the standard location by setting the environment variable TFORMERSAMPLES.

Examples are usually installed in

• Windows Vista or later: C:/Program Data/TEC-IT/TFORMer/7.0/Examples
• Older versions of Microsoft Windows: C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/7.0/Examples
• Unix platforms: /usr/local/share/TFORMer/Examples

Parameters

subdir	Optional subdirectory, null to ignore it
fileName	Filename in the example directory/subdirectory

Returns

File object

static boolean isDesignerAvailable ( ) throws TFormerException

static

Indicates whether TFORMer Designer is available or not.

This property determines whether TFORMer Designer (TFORMer.exe) is installed on the local machine. If TFORMer Designer is installed, FormLayouts can be edited with TFORMer Designer.

The method FormLayout.design starts TFORMer Designer and loads the current FormLayout.

Returns

true if TFORMer Designer is available.

static void license ( String  sLicensee, ELicenseKind  kind, int  nNumberOfLicenses, String  sKey  ) throws TFormerException

static

Applies a license to this instance of the TFORMer SDK.

The licensing method needs to be called prior to any call generating output (e.g. print). It is recommended to call this method once immediately after loading the TFORMer SDK. You will receive the license information from TEC-IT Datenverarbeitung GmbH after ordering (http://www.tec-it.com/order). All license values must be specified exactly as received from TEC-IT. The license kind, the number of licenses and the licensee string are checked against the license key.

See also

Licensing TFORMer

Parameters

sLicensee	The licensee
kind	The kind of the license
nNumberOfLicenses	The number of licenses
sKey	The license key