public class GroupField extends Field implements com.inet.report.ReferenceHolder, Validatable
GroupField
represents a group name field, which is automatically created with the creation of a Group
object.
When evaluating a GroupField
the name of the group will returned. So if you have a group
then you can print out the name with a FieldElement
containing the GroupField
.GroupField
of each group with Fields.getGroupNameField(int)
in class Fields
.BINARY, BOOLEAN, CURRENCY, CURSOR, DATABASE_FIELD, DATE, DATETIME, FORMULA_FIELD, GROUP_NAME_FIELD, NUMBER, PARAMETER_FIELD, SORT_FIELD, SPECIAL_FIELD, SQL_FIELD, STRING, SUMMARY_FIELD, TIME, UNKNOWN
Modifier and Type | Method and Description |
---|---|
Field |
getField()
Gets the field definition element (for example, database field element, prompt field element).
|
Group |
getGroup()
Returns the group this field is associated with.
|
int |
getGroupType()
Returns the type of the group, which is associated with this group name field.
|
java.lang.String |
getName()
Returns a string which represents the name of the group field.
|
int |
getValueType()
The return value type of a GroupField is always Field.String, but for formatting
the return value type of the group the field is based on is needed.
|
void |
setField(Field newField)
Sets the field definition element (for example, DatabaseField element, prompt field element).
|
void |
setName(java.lang.String name)
Setting the name of a GroupField is not allowed.
|
Validity |
validate()
Check if the object is valid and returns the state and details of possible errors.
|
checkNameExists, duplicate, extractReference, getPlaceholderName, getRefName, getType, indexOf, paramString, setGroup, setValueType, trimAwayBrackets
isDOMParser, parseDOM, parseElement, parseEndElement, parseText
public void setName(java.lang.String name) throws ReportException
GroupField.getGroup().setCustomizeGroupNameField(CUSTOMIZE_GROUP_NAME_FIELD_ENABLED)
GroupField.getGroup().setGroupNameDbField(<your field>)
GroupField.getGroup().setCustomizeGroupNameField(CUSTOMIZE_GROUP_NAME_FIELD_ENABLED_WITH_FM)
GroupField.getGroup().setGroupNameFormula(<your field>)
.setName
in class Field
name
- a name.ReportException
- will be thrown when you use this method to set the name of a GroupField.getName()
public Group getGroup()
getGroup
in class Field
Field.setGroup(Group)
public int getGroupType()
eng.getGroup(getGroupNumber()+1)
results the Group object which is associated with this field.
Otherwise a null
is returned by getGroup
.public Field getField()
public void setField(Field newField)
public int getValueType()
getValueType
in class Field
Field.NUMBER
,
Field.CURRENCY
,
Field.BOOLEAN
,
Field.DATE
,
Field.TIME
,
Field.STRING
,
Field.DATETIME
public java.lang.String getName()
Group.getCustomizeGroupNameField()
.getName
in class Field
setName(String)
,
Group.getCustomizeGroupNameField()
public Validity validate()
validate
in interface Validatable
Copyright © 1999-2020 by i-net software GmbH