The FormFieldCE
annotation defines the behavior of an entity field within automatically generated forms, lists, and related structures. It provides support for relations, UI rendering, sorting, filtering, and event handling.
related: Boolean
Specifies if the field represents a relationship to another entity.relatedEntityClass: KClass<*>
Defines the related entity class for this field.extName: String
The name of the extension field in the generated class for related fields.entityColumn: String
*(Default: "id"
)
The column in the related entity table that this field references.render: Boolean
(Default: true
)
Whether this field should be rendered in the UI.
label: String
The label displayed for this field in the form.
placeHolder: String
Placeholder text for input fields.
type: String
(Default: FieldTypeHelper.TEXT
)
Defines the field type using FieldTypeHelper
constants:
FieldTypeHelper.TEXT
โ Standard text fieldFieldTypeHelper.NUMBER
โ Whole number inputFieldTypeHelper.DECIMAL
โ Decimal number inputFieldTypeHelper.DATE
โ Date pickerFieldTypeHelper.DATE_TIME
โ Date & time pickerFieldTypeHelper.BOOLEAN
โ Toggle switchFieldTypeHelper.SELECT
โ Dropdown selectionFieldTypeHelper.EMAIL
โ Email input fieldFieldTypeHelper.PASSWORD
โ Password input fieldFieldTypeHelper.NUMBER_PASSWORD
โ Numeric password fieldFieldTypeHelper.COMPOSABLE
โ Custom Composable UI elementFieldTypeHelper.FILTER
โ Used for filtering in reportscustomComposable: String
Allows specifying a custom Composable for rendering this field.
renderInAddEdit: Boolean
(Default: true
)
Show the field in Add/Edit forms.renderInView: Boolean
(Default: true
)
Show the field in View mode.renderInList: Boolean
(Default: true
)
Show the field in List view.positionOnForm: Int
(Default: 100000
)
Controls the fieldโs position on the form.