Skip to content

@Edit ​

Configures how a field behaves in the add/edit form, including the component type, required validation, search behavior, read-only state, and more.

Attributes ​

AttributeDescription
titleForm field label
descDescription / hint text
notNullWhether the field is required, defaults to false
showWhether to display the component, defaults to true
placeHolderPlaceholder text for input components
typeComponent type, defaults to AUTO, see the type table below
searchSearch configuration, see @Search
readonlyRead-only configuration, see @Readonly
ifRenderDynamically controls whether the component is rendered (ExprBool)
dynamicDynamically controls the component state based on another field's value, see @Dynamic
onchangeValue-change linkage (1.13.2+), see OnChange
orderBySort rule, HQL ORDER BY syntax; only applicable when the field is a related object
filterFilter condition, HQL WHERE syntax; only applicable when the field is a related object

Component Types (EditType) ​

For detailed configuration options and examples for each type, see the component type documentation.

Basic Components ​

TypeDescriptionSearchAdvanced Search
AUTODefault, automatically inferred from field type
INPUTSingle-line text input✅✅
NUMBERNumeric input✅✅
SLIDERNumeric slider✅✅
COLORColor picker❌❌
RATEStar rating✅✅
DATEDate/time picker✅✅
BOOLEANToggle switch✅❌
CHOICESingle-select (radio)✅✅
MULTI_CHOICEMulti-select (checkbox)❌❌
TAGSTag selector✅❌
AUTO_COMPLETEAuto-complete input✅❌
TEXTAREAMulti-line text area✅✅
HTML_EDITORRich text editor✅✅
CODE_EDITORCode editor✅✅
MARKDOWNMarkdown editor❌❌
ATTACHMENTFile / image upload❌❌
MAPMap picker❌❌
SIGNATUREHandwritten signature❌❌
DIVIDEDivider❌❌
TPLCustom HTML template❌❌
HIDDENHidden field❌❌
EMPTYEmpty placeholder (still occupies form space)❌❌

Relation Components ​

Requires JPA relationship annotations

TypeDescriptionSearch
COMBINEOne-to-one inline embed❌
REFERENCE_TREEMany-to-one tree reference✅
REFERENCE_TABLEMany-to-one table reference✅
CHECKBOXMany-to-many checkbox❌
TAB_TREEMany-to-many tree reference❌
TAB_TABLE_REFERMany-to-many table reference❌
TAB_TABLE_ADDOne-to-many add❌

Contributors

The avatar of contributor named as YuePeng YuePeng

Changelog

Released under the Apache-2.0 License.