The @CeField annotation defines the behavior of an entity’s field within automatically generated forms, lists, and related UI components. It enables support for relations, custom rendering, sorting, filtering, and event handling.

Parameters

🔗 Relation Handling

• related: Boolean

  Specifies whether the field represents a relation to another entity.

• relatedEntityClass: KClass<*>

  The class of the related entity.

• extName: String

  Name of the extension field generated for this relation.

• entityColumn: String = "id"

  The column in the related table this field references.

🖥️ UI Rendering Options

• render: Boolean = true

  Whether this field should be rendered in UI forms.

• label: String

  Text label shown next to the field in the form.

• placeHolder: String

  Placeholder text in input components.

• type: String = "TEXT"

  Defines the field type using FieldTypeHelper constants:

  • TEXT, NUMBER, DECIMAL, DATE, DATE_TIME,

    BOOLEAN, SELECT, EMAIL, PASSWORD,

    NUMBER_PASSWORD, COMPOSABLE, FILTER

• customComposable: String

  Allows defining a custom composable function to render this field.

📋 UI Visibility Control

• renderInAddEdit: Boolean = true

  Show the field in Add/Edit forms.

• renderInView: Boolean = true

  Show the field in View mode.

• renderInList: Boolean = true

  Show the field in List/Table view.