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 | getCaption () throws TFormerException |
Gets the caption of the DataField. | |
String | getComment () throws TFormerException |
Gets the comment of the DataField. | |
boolean | getCriteria () throws TFormerException |
Gets a flag indicating whether this DataField should be used as a Criteria for a print-job. | |
int | getCriteriaColumn () throws TFormerException |
Gets the criteria column of the DataField. | |
String | getCriteriaFormat () throws TFormerException |
Gets the criteria format of the DataField. | |
String | getDefaultValue () throws TFormerException |
Gets the default value of the DataField. | |
String | getDescription () throws TFormerException |
Gets the description of the DataField. | |
String | getDisplayOrder () throws TFormerException |
Gets the display order of the DataField. | |
String | getName () throws TFormerException |
Gets the name of the DataField. | |
DataField | getNext () throws TFormerException |
Gets the next instance defined in the Project. | |
DataFieldType | getType () throws TFormerException |
Gets the type of the DataField. | |
String | getValidationMessage () throws TFormerException |
Gets the validation message of the DataField. | |
String | getValidationRule () throws TFormerException |
Gets the validation rule of the DataField. | |
void | setCaption (String sCaption) throws TFormerException |
Sets the caption of the DataField. | |
void | setComment (String sComment) throws TFormerException |
Sets the comment of the DataField. | |
void | setCriteria (boolean bCriteria) throws TFormerException |
Sets a flag indicating whether this DataField should be used as a Criteria for a print-job. | |
void | setCriteriaColumn (int nCriteriaColumn) throws TFormerException |
Sets the criteria column of the DataField. | |
void | setCriteriaFormat (String sCriteriaFormat) throws TFormerException |
Sets the criteria format of the DataField. | |
void | setDefaultValue (String sDefaultValue) throws TFormerException |
Sets the default value of the DataField. | |
void | setDescription (String sDescription) throws TFormerException |
Sets the description of the DataField. | |
void | setDisplayOrder (String sDisplayOrder) throws TFormerException |
Sets the display order of the DataField. | |
void | setName (String sName) throws TFormerException |
Sets the name of the DataField. | |
void | setType (DataFieldType dataFieldType) throws TFormerException |
Sets the type of the DataField. | |
void | setValidationMessage (String sValidationMessage) throws TFormerException |
Sets the validation message of the DataField. | |
void | setValidationRule (String sValidationRule) throws TFormerException |
Sets the validation rule of the DataField. | |
String | toString () |
Returns a string representation of the instance. |
A DataField is a place-holder for dynamic content in a FormLayout. One FormLayout can use an arbitrary number of data-fields (0..n). TFORMer Designer requires that a DataField is defined before it can be used. This definition takes place directly in the FormLayout (in the case of a stand-alone form) or in a user-defined Project (or the GlobalProject ) of a Repository.
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.getFirstDataField and DataField.getNext(please check out the respective examples). If you want to know, whether the returned DataField is actually used in the FormLayout use the method Formlayout .getDataFieldUsage().
The current value of a DataField is provided by a JobData. It is available during print-time only (see Job.print ). The value of a DataField may be printed as text, as bar-code or may even be used to provide the filename for image elements in the FormLayout. Besides this, a DataField can be used in expressions or printing-conditions to control the output behavior.
The DataField is only valid as long as it is available in the Project. If it is removed from the Project all instances of the DataField immediately become invalid.
A single instance of this class must not be used by different threads.
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.
TFormerException | error occurred into TFORMer runtime. |
void dump | ( | PrintStream | s | ) | throws IOException, TFormerException |
Dumps the current instance into a text stream.
s | instance of the stream |
IOException | error in I/O | |
TFormerException | error occurred into TFORMer runtime. |
String getCaption | ( | ) | throws TFormerException |
Gets the caption of the DataField.
TFormerException | error occurred into TFORMer runtime. |
String getComment | ( | ) | throws TFormerException |
Gets the comment of the DataField.
TFormerException | error occurred into TFORMer runtime. |
boolean getCriteria | ( | ) | throws TFormerException |
Gets a flag indicating whether this DataField should be used as a Criteria for a print-job.
TFormerException |
int getCriteriaColumn | ( | ) | throws TFormerException |
Gets the criteria column of the DataField.
TFormerException |
String getCriteriaFormat | ( | ) | throws TFormerException |
Gets the criteria format of the DataField.
TFormerException | error occurred into TFORMer runtime. |
String getDefaultValue | ( | ) | throws TFormerException |
Gets the default value of the DataField.
TFormerException | error occurred into TFORMer runtime. |
String getDescription | ( | ) | throws TFormerException |
Gets the description of the DataField.
TFormerException | error occurred into TFORMer runtime. |
String getDisplayOrder | ( | ) | throws TFormerException |
Gets the display order of the DataField.
TFormerException | error occurred into TFORMer runtime. |
String getName | ( | ) | throws TFormerException |
Gets the name of the DataField.
TFormerException | error occurred into TFORMer runtime. |
DataField getNext | ( | ) | throws TFormerException |
Gets the next instance defined in the Project.
A Project stores a list of DataField objects. You can use this method to iterate through the list. To retrieve the first DataField in the Project see Project.getFirstDataField().
null
if there aren't other instances into the project, otherwise a valid instance TFormerException | error occurred into TFORMer runtime. |
DataFieldType getType | ( | ) | throws TFormerException |
Gets the type of the DataField.
TFormerException | error occurred into TFORMer runtime. |
String getValidationMessage | ( | ) | throws TFormerException |
Gets the validation message of the DataField.
TFormerException | error occurred into TFORMer runtime. |
String getValidationRule | ( | ) | throws TFormerException |
Gets the validation rule of the DataField.
TFormerException | error occurred into TFORMer runtime. |
void setCaption | ( | String | sCaption | ) | throws TFormerException |
Sets the caption of the DataField.
sCaption | The caption of the DataField. |
TFormerException | error occurred into TFORMer runtime. |
void setComment | ( | String | sComment | ) | throws TFormerException |
Sets the comment of the DataField.
sComment | The comment of the DataField. |
TFormerException | error occurred into TFORMer runtime. |
void setCriteria | ( | boolean | bCriteria | ) | throws TFormerException |
Sets a flag indicating whether this DataField should be used as a Criteria for a print-job.
bCriteria |
TFormerException | error occurred into TFORMer runtime. |
void setCriteriaColumn | ( | int | nCriteriaColumn | ) | throws TFormerException |
Sets the criteria column of the DataField.
nCriteriaColumn | The criteria column of the DataField. |
TFormerException | error occurred into TFORMer runtime. |
void setCriteriaFormat | ( | String | sCriteriaFormat | ) | throws TFormerException |
Sets the criteria format of the DataField.
sCriteriaFormat | The criteria format of the DataField. |
TFormerException | error occurred into TFORMer runtime. |
void setDefaultValue | ( | String | sDefaultValue | ) | throws TFormerException |
Sets the default value of the DataField.
sDefaultValue | default value of the field |
TFormerException | error occurred into TFORMer runtime. |
void setDescription | ( | String | sDescription | ) | throws TFormerException |
Sets the description of the DataField.
sDescription | The description of the DataField. |
TFormerException | error occurred into TFORMer runtime. |
void setDisplayOrder | ( | String | sDisplayOrder | ) | throws TFormerException |
Sets the display order of the DataField.
sDisplayOrder | The display order of the DataField. |
TFormerException | error occurred into TFORMer runtime. |
void setName | ( | String | sName | ) | throws TFormerException |
Sets the name of the DataField.
sName | The name of the DataField. |
TFormerException | error occurred into TFORMer runtime. |
void setType | ( | DataFieldType | dataFieldType | ) | throws TFormerException |
Sets the type of the DataField.
dataFieldType | The type of the DataField. |
TFormerException | error occurred into TFORMer runtime. |
void setValidationMessage | ( | String | sValidationMessage | ) | throws TFormerException |
Sets the validation message of the DataField.
sValidationMessage | The validation message of the DataField. |
TFormerException | error occurred into TFORMer runtime. |
void setValidationRule | ( | String | sValidationRule | ) | throws TFormerException |
Sets the validation rule of the DataField.
sValidationRule | The validation rule of the DataField. |
TFormerException | error occurred into TFORMer runtime. |
String toString | ( | ) |
Returns a string representation of the instance.
© 2006-2009 All rights reserved by TEC-IT Datenverarbeitung GmbH |
![]() |
Generated on Wed Sep 2 16:01:27 2009 for TFORMer Runtime JAVA Developer Reference with doxygen 1.5.8 |