FormLayout Class Reference

Provides access to a FormLayout which is referenced by a Repository or available as stand-alone FormLayout. More...

List of all members.

Public Member Functions
void	design (String designer, boolean showSplashScreen, boolean maximizeWindow, boolean useExistingInstance, String extraParameters) throws TFormerException
	Opens the FormLayout with TFORMer Designer.
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 FormLayout.
DataFieldUsage	getDataFieldUsage (String dataFieldName) throws TFormerException
	Retrieves the usage of a specific DataField in a FormLayout.
String	getDescription () throws TFormerException
	Gets the description of the FormLayout.
String	getFileName () throws TFormerException
	Gets the filename of the FormLayout.
String	getName () throws TFormerException
	Gets the name of the FormLayout.
FormLayout	getNext () throws TFormerException
	Gets the next FormLayout available.
void	setComment (String sComment) throws TFormerException
	Sets the comment of the FormLayout.
void	setDescription (String sDescription) throws TFormerException
	Sets the description of the FormLayout.
void	setFileName (String sFilename) throws TFormerException
	Sets the filename of the FormLayout.
void	setName (String sName) throws TFormerException
	Sets the name of the FormLayout.
String	toString ()
	Returns a string representation of the instance.

---

Detailed Description

Provides access to a FormLayout which is referenced by a Repository or available as stand-alone FormLayout.

A FormLayout is a document which was created with TFORMer Designer. A typical FormLayout contains static content (like a logo),
dynamic content (like a DataField) and a number of properties which are used to describe the FormLayout and its behavior during print-time.


This class is used to retrieve or set information belonging to a FormLayout. It is not possible to change the appearance of the FormLayout (like adding new elements or bands) with this class. Design tasks are supported by TFORMer Designer only.


TFORMer Designer supports the creation of Repository-based form layouts as well as of stand-alone form layouts.
The layout and output features of both variants are identical.


Repository describes the differences between a Repository and a stand-alone FormLayout in more detail.


In order to access the data-fields in a FormLayout you may either use the method Project.GetDataField or you may iterate through all available data-fields using Project.FirstDataField and DataField.Next (please check out the respective examples).
If you want to know, whether the returned DataField is actually used you can use the method GetDataFieldUsage.

Important:

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

Thread-safety:

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

---

Member Function Documentation

void design	(	String	designer,
		boolean	showSplashScreen,
		boolean	maximizeWindow,
		boolean	useExistingInstance,
		String	extraParameters
	)			throws TFormerException

Opens the FormLayout with TFORMer Designer.

TFORMer Runtime on its own cannot be used for editing a FormLayout. Use this method to invoke TFORMer Designer.
Note: Make sure that your purchased license model fits your requirements. If you are creating applications which are distributed to 3rd party you may need to redistribute TFORMer Designer as well.

Parameters:

	designer	The path and name of the TFORMer Designer executable. If null then the method tries to find the executable automatically.
	showSplashScreen	If set to true the splash screen is shown.
	maximizeWindow	If set to true the TFORMer Designer windows is maximized.
	useExistingInstance	If set to true the form-layout will be opened in an already running TFORMer Designer instance.
	extraParameters	Additional parameters that will be passed to TFORMer Designer.

Exceptions:

TFormerException

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 FormLayout.

Returns:

The comment of the FormLayout.

DataFieldUsage getDataFieldUsage

(

String

dataFieldName

)

throws TFormerException

Retrieves the usage of a specific DataField in a FormLayout.

Parameters:

dataFieldName

Name of the DataField to be queried.

Returns:

null if the requested object doesn't exist, otherwise a valid instance

String getDescription

(

)

throws TFormerException

Gets the description of the FormLayout.

Returns:

The description of the FormLayout.

Exceptions:

TFormerException

String getFileName

(

)

throws TFormerException

Gets the filename of the FormLayout.

Returns:

The filename of the FormLayout.

Exceptions:

TFormerException

String getName

(

)

throws TFormerException

Gets the name of the FormLayout.

Returns:

The name of the FormLayout.

Exceptions:

TFormerException

FormLayout getNext

(

)

throws TFormerException

Gets the next FormLayout available.

To retrieve the first FormLayout within a Project (or the Repository.GlobalProject) refer to Project.getFirstFormLayout().

When using a stand-alone FormLayout this property always returns null. In this case only one FormLayout is available - it can be retrieved via Repository.getGlobalProject().

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

Returns:

The next FormLayout object available or null.

Exceptions:

TFormerException

void setComment

(

String

sComment

)

throws TFormerException

Sets the comment of the FormLayout.

Parameters:

sComment

The comment of the FormLayout.

Exceptions:

TFormerException

void setDescription

(

String

sDescription

)

throws TFormerException

Sets the description of the FormLayout.

Parameters:

sDescription

The description of the FormLayout.

Exceptions:

TFormerException

void setFileName

(

String

sFilename

)

throws TFormerException

Sets the filename of the FormLayout.

Parameters:

sFilename

The filename of the FormLayout.

Exceptions:

TFormerException

void setName

(

String

sName

)

throws TFormerException

Sets the name of the FormLayout.

Parameters:

sName

The name of the FormLayout.

Exceptions:

TFormerException

String toString

(

)

Returns a string representation of the instance.

Returns:

a string representation of the instance