public class FieldDef extends BaseObject implements Serializable
FieldDef
inition maps a property of a Java-object to it's XML-representation and vice versa. When reading/writing a value from/to an Object, the field's binding
is used to do this via the JavaBeans API.Modifier and Type | Field and Description |
---|---|
protected String |
binding |
protected Condition |
condition |
protected BigInteger |
displayLength |
protected List<FieldDef> |
fields |
protected String |
format |
protected String |
hidden |
protected List<Icon> |
icons |
protected Label |
label |
protected Messages |
messages |
protected String |
name |
protected List<FieldPermissions> |
permissions |
protected String |
readonly |
protected Sort |
sort |
protected Label |
tooltip |
protected FieldType |
type |
protected Validation |
validation |
Constructor and Description |
---|
FieldDef() |
Modifier and Type | Method and Description |
---|---|
String |
getBinding()
This is the name of the property used with the JavaBeans API.
|
Condition |
getCondition()
Gets the value of the condition property.
|
BigInteger |
getDisplayLength()
The maximum number of characters when displaying the field's value as string.
|
List<FieldDef> |
getFields()
Gets the value of the fields property.
|
String |
getFormat()
The format used for this field, presuming the
type supports formatting. |
String |
getHidden()
If evaluating to
true , the field will not be visible to the user. |
List<Icon> |
getIcons()
Gets the value of the icons property.
|
Label |
getLabel()
Gets the value of the label property.
|
Messages |
getMessages()
Gets the value of the messages property.
|
String |
getName()
The name of the field.
|
List<FieldPermissions> |
getPermissions()
Gets the value of the permissions property.
|
String |
getReadonly()
If evaluating to
true , the field's value is readonly. |
Sort |
getSort()
Gets the value of the sort property.
|
Label |
getTooltip()
Gets the value of the tooltip property.
|
FieldType |
getType()
The
FieldType , which decides about how the field is being displayed. |
Validation |
getValidation()
Gets the value of the validation property.
|
void |
setBinding(String value)
Sets the value of the binding property.
|
void |
setCondition(Condition value)
Sets the value of the condition property.
|
void |
setDisplayLength(BigInteger value)
Sets the value of the displayLength property.
|
void |
setFormat(String value)
Sets the value of the format property.
|
void |
setHidden(String value)
Sets the value of the hidden property.
|
void |
setLabel(Label value)
Sets the value of the label property.
|
void |
setMessages(Messages value)
Sets the value of the messages property.
|
void |
setName(String value)
Sets the value of the name property.
|
void |
setReadonly(String value)
Sets the value of the readonly property.
|
void |
setSort(Sort value)
Sets the value of the sort property.
|
void |
setTooltip(Label value)
Sets the value of the tooltip property.
|
void |
setType(FieldType value)
Sets the value of the type property.
|
void |
setValidation(Validation value)
Sets the value of the validation property.
|
protected Sort sort
protected Label label
protected Label tooltip
protected Condition condition
protected List<FieldPermissions> permissions
protected Validation validation
protected Messages messages
protected String name
protected FieldType type
protected BigInteger displayLength
protected String format
protected String readonly
protected String hidden
protected String binding
public void setSort(Sort value)
value
- allowed object is
Sort
public Label getLabel()
Label
public void setLabel(Label value)
value
- allowed object is
Label
public Label getTooltip()
Label
public void setTooltip(Label value)
value
- allowed object is
Label
public List<Icon> getIcons()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set
method for the icons property.
For example, to add a new item, do as follows:
getIcons().add(newItem);
Objects of the following type(s) are allowed in the list
Icon
public Condition getCondition()
Condition
public void setCondition(Condition value)
value
- allowed object is
Condition
public List<FieldPermissions> getPermissions()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set
method for the permissions property.
For example, to add a new item, do as follows:
getPermissions().add(newItem);
Objects of the following type(s) are allowed in the list
FieldPermissions
public Validation getValidation()
Validation
public void setValidation(Validation value)
value
- allowed object is
Validation
public Messages getMessages()
Messages
public void setMessages(Messages value)
value
- allowed object is
Messages
public List<FieldDef> getFields()
This accessor method returns a reference to the live list,
not a snapshot. Therefore any modification you make to the
returned list will be present inside the JAXB object.
This is why there is not a set
method for the fields property.
For example, to add a new item, do as follows:
getFields().add(newItem);
Objects of the following type(s) are allowed in the list
FieldDef
public void setName(String value)
value
- allowed object is
String
public FieldType getType()
FieldType
, which decides about how the field is being displayed.FieldType
public void setType(FieldType value)
value
- allowed object is
FieldType
public BigInteger getDisplayLength()
BigInteger
public void setDisplayLength(BigInteger value)
value
- allowed object is
BigInteger
public String getFormat()
type
supports formatting.String
public void setFormat(String value)
value
- allowed object is
String
public String getReadonly()
true
, the field's value is readonly.String
public void setReadonly(String value)
value
- allowed object is
String
public String getHidden()
true
, the field will not be visible to the user.String
public void setHidden(String value)
value
- allowed object is
String
public String getBinding()
MetaData.getBindClass()
(if any, separated with a dot) and the field's name.String
Copyright © 2011–2023 aiticon GmbH. All rights reserved.