@componyx/ui 0.0.0-stage → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (169) hide show
  1. package/AppSkin/AppSkin.css +1268 -0
  2. package/AppSkin/AppSkin.js +2748 -0
  3. package/AppSkin/Themes/Default.css +241 -0
  4. package/Base/Base.js +3407 -0
  5. package/Base/ComponentIcons.css +66 -0
  6. package/Base/Font/ComponentIcons.woff +0 -0
  7. package/Base/Font/UI.woff +0 -0
  8. package/Base/Library.js +8432 -0
  9. package/Base/NavigationManager.js +462 -0
  10. package/Base/ResponsiveTemplates.js +371 -0
  11. package/Base/Sanitizer.js +288 -0
  12. package/Base/Themes/Default.css +255 -0
  13. package/Base/UI.css +618 -0
  14. package/Base/UIResourcePath.js +6 -0
  15. package/Bindary/Bindary.js +2011 -0
  16. package/Bindary/Modules/Connection.js +216 -0
  17. package/Bindary/Modules/Core.js +854 -0
  18. package/Bindary/Modules/DataUpdater.js +351 -0
  19. package/Bindary/Modules/ExpressionEngine.js +347 -0
  20. package/Bindary/Modules/ProxyManager.js +482 -0
  21. package/Bindary/Modules/Renderer.js +605 -0
  22. package/Bindary/Modules/Router.js +291 -0
  23. package/Bindary/Modules/Scroller.js +89 -0
  24. package/Bindary/Modules/Template.js +1273 -0
  25. package/BookmarkSpy/BookmarkSpy.js +430 -0
  26. package/Box/Box.css +36 -0
  27. package/Box/Box.js +1685 -0
  28. package/Button/Button.css +470 -0
  29. package/Button/Button.js +1398 -0
  30. package/Button/Themes/Default.css +200 -0
  31. package/Carousel/Carousel.css +273 -0
  32. package/Carousel/Carousel.js +607 -0
  33. package/ColorButton/ColorButton.css +39 -0
  34. package/ColorButton/ColorButton.js +336 -0
  35. package/ColorPicker/ColorPicker.css +359 -0
  36. package/ColorPicker/ColorPicker.js +972 -0
  37. package/ComboBox/ComboBox.css +357 -0
  38. package/ComboBox/ComboBox.js +2342 -0
  39. package/ComboBox/Themes/Default.css +23 -0
  40. package/DataPager/DataPager.css +72 -0
  41. package/DataPager/DataPager.js +674 -0
  42. package/DatePicker/DatePicker.css +227 -0
  43. package/DatePicker/DatePicker.js +1531 -0
  44. package/DatePicker/Themes/Default.css +26 -0
  45. package/Dialog/Dialog.css +106 -0
  46. package/Dialog/Dialog.js +572 -0
  47. package/Dialog/Themes/Default.css +10 -0
  48. package/Editor/Data/Emoji.json +8285 -0
  49. package/Editor/Data/Special.json +1042 -0
  50. package/Editor/Editor.css +1562 -0
  51. package/Editor/Editor.js +4058 -0
  52. package/Editor/Font/Editor.woff +0 -0
  53. package/Editor/Modules/ComponentFactory.js +565 -0
  54. package/Editor/Modules/ContentManager.js +748 -0
  55. package/Editor/Modules/DialogManager.js +1234 -0
  56. package/Editor/Modules/EventManager.js +458 -0
  57. package/Editor/Modules/Format.js +950 -0
  58. package/Editor/Modules/History.js +191 -0
  59. package/Editor/Modules/LayoutState.js +379 -0
  60. package/Editor/Modules/ListManager.js +296 -0
  61. package/Editor/Modules/MenuManager.js +388 -0
  62. package/Editor/Modules/NodeManager.js +681 -0
  63. package/Editor/Modules/ParagraphButtons.js +122 -0
  64. package/Editor/Modules/Resizer.js +176 -0
  65. package/Editor/Modules/SelectionRange.js +564 -0
  66. package/Editor/Modules/SourceViewBuilder.js +212 -0
  67. package/Editor/Modules/SymbolPicker.js +208 -0
  68. package/Editor/Modules/Table.js +2327 -0
  69. package/Editor/Modules/TableDialog.js +757 -0
  70. package/Editor/Modules/Toolbar.js +375 -0
  71. package/Editor/Modules/TooltipMenu.js +125 -0
  72. package/Editor/Modules/Utility.js +131 -0
  73. package/Editor/Themes/Default.css +204 -0
  74. package/FileUpload/FileUpload.css +156 -0
  75. package/FileUpload/FileUpload.js +898 -0
  76. package/FileUpload/Themes/Default.css +17 -0
  77. package/Form/Form.css +1934 -0
  78. package/Form/Form.js +4943 -0
  79. package/Form/Modules/ActionManager.js +368 -0
  80. package/Form/Modules/BuildPanelManager.js +319 -0
  81. package/Form/Modules/ComponentFactory.js +468 -0
  82. package/Form/Modules/ComponentPanel.js +265 -0
  83. package/Form/Modules/ConfigPanelManager.js +685 -0
  84. package/Form/Modules/DataBinder.js +602 -0
  85. package/Form/Modules/DataObserver.js +717 -0
  86. package/Form/Modules/Draggable.js +756 -0
  87. package/Form/Modules/OptionsPanel.js +342 -0
  88. package/Form/Modules/Renderer.js +1889 -0
  89. package/Form/Modules/RuleEngine.js +585 -0
  90. package/Form/Modules/RulesPanel.js +1158 -0
  91. package/Form/Modules/Types.js +1709 -0
  92. package/Form/Modules/ValidationManager.js +194 -0
  93. package/Form/Themes/Default.css +216 -0
  94. package/FormField/FormField.css +468 -0
  95. package/FormField/FormField.js +576 -0
  96. package/FormField/Themes/Default.css +99 -0
  97. package/Grid/Grid.css +544 -0
  98. package/Grid/Grid.js +3761 -0
  99. package/Grid/Themes/Default.css +43 -0
  100. package/LICENSE +126 -0
  101. package/MaskedTextBox/MaskedTextBox.css +28 -0
  102. package/MaskedTextBox/MaskedTextBox.js +642 -0
  103. package/MaskedTextBox/Themes/Default.css +6 -0
  104. package/Menu/Menu.css +328 -0
  105. package/Menu/Menu.js +2386 -0
  106. package/Menu/Themes/Default.css +24 -0
  107. package/NumericBox/NumericBox.css +120 -0
  108. package/NumericBox/NumericBox.js +984 -0
  109. package/PanelBar/PanelBar.css +123 -0
  110. package/PanelBar/PanelBar.js +505 -0
  111. package/PanelBar/Themes/Default.css +51 -0
  112. package/PieChart/PieChart.css +95 -0
  113. package/PieChart/PieChart.js +820 -0
  114. package/PieChart/Themes/Default.css +9 -0
  115. package/README.md +178 -3
  116. package/Slider/Slider.css +348 -0
  117. package/Slider/Slider.js +1306 -0
  118. package/Slider/Themes/Default.css +44 -0
  119. package/TabStrip/TabStrip.css +52 -0
  120. package/TabStrip/TabStrip.js +362 -0
  121. package/TabStrip/Themes/Default.css +35 -0
  122. package/TimePicker/Themes/Default.css +30 -0
  123. package/TimePicker/TimePicker.css +253 -0
  124. package/TimePicker/TimePicker.js +1485 -0
  125. package/TooltipManager/Themes/Default.css +21 -0
  126. package/TooltipManager/TooltipManager.css +227 -0
  127. package/TooltipManager/TooltipManager.js +791 -0
  128. package/Validator/Validator.css +54 -0
  129. package/Validator/Validator.js +2508 -0
  130. package/componyx.html-data.json +619 -0
  131. package/index.js +27 -0
  132. package/package.json +43 -4
  133. package/types/AppSkin.d.ts +842 -0
  134. package/types/Base.d.ts +1034 -0
  135. package/types/Bindary.d.ts +1196 -0
  136. package/types/BookmarkSpy.d.ts +112 -0
  137. package/types/Box.d.ts +374 -0
  138. package/types/Button.d.ts +455 -0
  139. package/types/Carousel.d.ts +136 -0
  140. package/types/ColorButton.d.ts +120 -0
  141. package/types/ColorPicker.d.ts +225 -0
  142. package/types/ComboBox.d.ts +507 -0
  143. package/types/DataPager.d.ts +152 -0
  144. package/types/DatePicker.d.ts +354 -0
  145. package/types/Dialog.d.ts +160 -0
  146. package/types/Editor.d.ts +1289 -0
  147. package/types/FileUpload.d.ts +206 -0
  148. package/types/Form.d.ts +3078 -0
  149. package/types/FormField.d.ts +204 -0
  150. package/types/Grid.d.ts +911 -0
  151. package/types/Library.d.ts +1899 -0
  152. package/types/MaskedTextBox.d.ts +91 -0
  153. package/types/Menu.d.ts +577 -0
  154. package/types/NumericBox.d.ts +310 -0
  155. package/types/PanelBar.d.ts +223 -0
  156. package/types/PieChart.d.ts +224 -0
  157. package/types/ResponsiveTemplates.d.ts +108 -0
  158. package/types/Slider.d.ts +227 -0
  159. package/types/TabStrip.d.ts +185 -0
  160. package/types/TimePicker.d.ts +265 -0
  161. package/types/TooltipManager.d.ts +178 -0
  162. package/types/UI.d.ts +29 -0
  163. package/types/Validator.d.ts +653 -0
  164. package/types/index.d.ts +59 -0
  165. package/ui.css +11783 -0
  166. package/ui.js +79477 -0
  167. package/ui.min.css +138 -0
  168. package/ui.min.js +264 -0
  169. package/ui.min.js.map +1 -0
@@ -0,0 +1,3078 @@
1
+ declare namespace componyx
2
+ {
3
+ namespace UI
4
+ {
5
+ /**
6
+ * <p>Namespace for form modules.</p>
7
+ */
8
+ namespace form_modules
9
+ {
10
+ /**
11
+ * <p>Promise that resolves when all form modules are loaded asynchronously.</p>
12
+ */
13
+ var loaded: Promise<void>;
14
+ }
15
+
16
+ namespace Form
17
+ {
18
+ /**
19
+ * @property newItemPrefix - <p>= New - Gets or sets the prefix used when a new type is created without a custom label.</p>
20
+ * @property addItemPrefix - <p>= Add - Gets or sets the prefix used for adding an item. The type description of the item is used as suffix.</p>
21
+ * @property removeItemPrefix - <p>= Remove - Gets or sets the prefix used for removing an item. The type description of the item is used as suffix.</p>
22
+ * @property applyToPrefix - <p>= Apply to - Gets or sets the prefix used for apply to. The type description of the item is used as suffix.</p>
23
+ * @property labelPlaceholder - <p>= Enter a label - Gets or sets the placeholder to display when a label is empty.</p>
24
+ * @property headerTitle - <p>= Form Header - Gets or sets the header title.</p>
25
+ * @property sectionSwitch - <p>= Enable Sections - Gets or sets the label for the Sections switch.</p>
26
+ * @property lineBreak - <p>= Line break - Gets or sets the label for the lineBreak setting in the FieldSet/Field/FieldOption configuration panel.</p>
27
+ * @property visible - <p>= Visible - Gets or sets the label for the visible setting field in the FieldSet/Field configuration panel.</p>
28
+ * @property disabled - <p>= Disabled - Gets or sets the label for the disabled setting in the FieldSet/Field/FieldOption configuration panel.</p>
29
+ * @property readOnly - <p>= Readonly - Gets or sets the label for the readOnly setting in the Field configuration panel.</p>
30
+ * @property selected - <p>= Selected - Gets or sets the label for the selected setting in the FieldOption configuration panel.</p>
31
+ * @property tooltip - <p>= Tooltip - Gets or sets the label for the tooltip setting in the FieldSet/Field configuration panel.</p>
32
+ * @property tooltipHint - <p>= Text shown via info icon - Gets or sets the label for the tooltip setting hint in the FieldSet/Field configuration panel.</p>
33
+ * @property value - <p>= Default Value - Gets or sets the label for the value setting in the Field- and Component- configuration panels.</p>
34
+ * @property minValue - <p>= Minimum Value - Gets or sets the label for the minValue setting in the DatePicker/NumericBox/Slider/TimePicker configuration panel.</p>
35
+ * @property maxValue - <p>= Maximum Value - Gets or sets the label for the maxValue setting in the DatePicker/NumericBox/Slider/TimePicker configuration panel.</p>
36
+ * @property comboBoxDefaultHint - <p>= - Select - - Gets or sets the label for the ComboBox placeholder.</p>
37
+ * @property section - <p>= Section - Gets or sets the label used to describe a section.</p>
38
+ * @property fieldSet - <p>= Field Set - Gets or sets the label used to describe a field set.</p>
39
+ * @property fieldSets - <p>= Field Sets - Gets or sets the label used to describe field sets.</p>
40
+ * @property fieldPaneEmptyHint - <p>= Drag a field here... - Gets or sets the message to display when a field pane of a field set is empty.</p>
41
+ * @property fieldSetId - <p>= ID - Gets or sets the label for the id read-only setting field in the FieldSet configuration panel.</p>
42
+ * @property fieldSetLayout - <p>= Layout - Gets or sets the label for the layout setting field in the FieldSet configuration panel.</p>
43
+ * @property fieldSetLayoutNone - <p>= None - Gets or sets the label for the 'None' option of the Layout dropdown in the FieldSet configuration panel.</p>
44
+ * @property fieldSetLayoutDefault - <p>= Default - Gets or sets the label for the 'Default' option of the Layout dropdown in the FieldSet configuration panel.</p>
45
+ * @property fieldSetLayoutBannered - <p>= Bannered - Gets or sets the label for the 'Bannered' option of the Layout dropdown in the FieldSet configuration panel.</p>
46
+ * @property fieldSetLabelDisplay - <p>= Label Display (this group) - Gets or sets the label for the label display setting in the FieldSet configuration panel.</p>
47
+ * @property fieldSetRepeatable - <p>= Repeatable - Gets or sets the label for the repeatable setting field in the FieldSet configuration panel.</p>
48
+ * @property fieldSetMaxRepeats - <p>= Max Repeats - Gets or sets the label for the maximum repeats setting field in the FieldSet configuration panel.</p>
49
+ * @property fieldSetRepeatLabel - <p>= Repeat Label - Gets or sets the label for the repeat label setting field in the FieldSet configuration panel.</p>
50
+ * @property fieldSetRepeatButton - <p>= Add Another - Gets or sets the label for the button to add a repeated field set if the field set does not have a label, otherwise addItemPrefix + label are used.</p>
51
+ * @property field - <p>= Field - Gets or sets the label used to describe a field.</p>
52
+ * @property fields - <p>= Fields - Gets or sets the label used to describe fields.</p>
53
+ * @property fieldName - <p>= Field Name - Gets or sets the label for the name setting in the Field configuration panel.</p>
54
+ * @property fieldPlaceholder - <p>= Placeholder - Gets or sets the label for the placeholder setting in the Field configuration panel.</p>
55
+ * @property fieldPlaceholderHint - <p>= Text shown when empty - Gets or sets the label for the placeholder setting hint in the Field configuration panel.</p>
56
+ * @property fieldWidth - <p>= Width - Gets or sets the label for the width setting in the Field configuration panel.</p>
57
+ * @property fieldWidthHint - <p>= - Select option or type a value - - Gets or sets the label for the width setting hint in the Field configuration panel.</p>
58
+ * @property fieldWidthTooltip - <p>Gets or sets the label for the width setting tooltip in the Field configuration panel.</p>
59
+ * @property fieldWidthAuto - <p>= Auto (360px) - Gets or sets the label for the 'Auto' option of the fieldWidth dropdown in the Field configuration panel.</p>
60
+ * @property fieldWidth1PerRow - <p>= 100% (1 field per row) - Gets or sets the label for the '100%' option of the fieldWidth dropdown in the Field configuration panel.</p>
61
+ * @property fieldWidth2PerRow - <p>= 50% (2 fields per row) - Gets or sets the label for the '50%' option of the fieldWidth dropdown in the Field configuration panel.</p>
62
+ * @property fieldWidth3PerRow - <p>= 33% (3 fields per row) - Gets or sets the label for the '33%' option of the fieldWidth dropdown in the Field configuration panel.</p>
63
+ * @property fieldWidth4PerRow - <p>= 25% (4 fields per row) - Gets or sets the label for the '25%' option of the fieldWidth dropdown in the Field configuration panel.</p>
64
+ * @property fieldRole - <p>= Role - Gets or sets the label for the role setting in the Field configuration panel.</p>
65
+ * @property fieldRoleTooltip - <p>Gets or sets the label for the role setting tooltip in the Field configuration panel.</p>
66
+ * @property fieldLabelDisplay - <p>= Label Display - Gets or sets the label for the label display setting in the Field configuration panel.</p>
67
+ * @property fieldLabelDisplayAbove - <p>= Above - Gets or sets the label for the 'Above' label display option.</p>
68
+ * @property fieldLabelDisplayBefore - <p>= Before - Gets or sets the label for the 'Before' label display option.</p>
69
+ * @property fieldLabelDisplayFloating - <p>= Floating - Gets or sets the label for the 'Floating' label display option.</p>
70
+ * @property fieldLabelDisplayInside - <p>= Inside - Gets or sets the label for the 'Inside' label display option.</p>
71
+ * @property fieldMoreSettings - <p>= More Settings... - Gets or sets the label for the more settings button in the Field configuration panel.</p>
72
+ * @property fieldInlineOptions - <p>= Inline Options - Gets or sets the label for the inline options setting in the Field Options configuration panel.</p>
73
+ * @property fieldOptionWidth - <p>= Option Width - Gets or sets the label for the option width setting in the Field Options configuration panel.</p>
74
+ * @property fieldOptionWidthAuto - <p>= Auto - Gets or sets the label for the 'Auto' option of the optionWidth dropdown in the Field Options configuration panel.</p>
75
+ * @property fieldOptionWidth2PerRow - <p>= 50% (2 items per row) - Gets or sets the label for the '50%' option of the optionWidth dropdown in the Field Options configuration panel.</p>
76
+ * @property fieldOptionWidth3PerRow - <p>= 33% (3 items per row) - Gets or sets the label for the '33%' option of the optionWidth dropdown in the Field Options configuration panel.</p>
77
+ * @property fieldOptionWidth4PerRow - <p>= 25% (4 items per row) - Gets or sets the label for the '25%' option of the optionWidth dropdown in the Field Options configuration panel.</p>
78
+ * @property fieldOption - <p>= Option - Gets or sets the label used to describe a field option.</p>
79
+ * @property fieldOptions - <p>= Options - Gets or sets the label used to describe field options.</p>
80
+ * @property fieldOptionValue - <p>= Option Value - Gets or sets the label used to describe a field option value.</p>
81
+ * @property fieldOptionsType - <p>= Options Type - Gets or sets the label for the options type setting in the Field Option configuration panel.</p>
82
+ * @property fieldOptionsTypeStatic - <p>= Static - Gets or sets the label for the 'Static' options of the option type radio button in the Field Options configuration panel.</p>
83
+ * @property fieldOptionsTypeDataSource - <p>= Data Source - Gets or sets the label for the 'DataSource' options of the option type radio button in the Field Options configuration panel.</p>
84
+ * @property fieldOptionLabelHeader - <p>= Label - Gets or sets the label for the label header of a field-option.</p>
85
+ * @property fieldOptionValueHeader - <p>= Value - Gets or sets the label for the value header of a field-option.</p>
86
+ * @property fieldOptionSelectedHeader - <p>= Selected - Gets or sets the label for the selected header of a field-option.</p>
87
+ * @property fieldOptionDisabledHeader - <p>= Disabled - Gets or sets the label for the disabled header of a field-option.</p>
88
+ * @property dataSourceId - <p>= Data Source ID - Gets or sets the label for the data source id setting in the Field Options configuration panel.</p>
89
+ * @property dataSourcePreview - <p>= Data Source Preview - Gets or sets the label for the data source preview setting in the Field Options configuration panel.</p>
90
+ * @property validationRequired - <p>= Required - Gets or sets the label for the required setting in the Validation configuration panel.</p>
91
+ * @property validationDataType - <p>= Data Type - Gets or sets the label for the dataType setting in the Validation configuration panel.</p>
92
+ * @property validationDataTypeInteger - <p>= Integer - Gets or sets the label for the 'Integer' option of the dataType dropdown in the Validation configuration panel.</p>
93
+ * @property validationDataTypeFloat - <p>= Float - Gets or sets the label for the 'Float' option of the dataType dropdown in the Validation configuration panel.</p>
94
+ * @property validationDataTypeDateTime - <p>= DateTime - Gets or sets the label for the 'DateTime' option of the dataType dropdown in the Validation configuration panel.</p>
95
+ * @property validationDataTypeEmail - <p>= Email - Gets or sets the label for the 'Email' option of the dataType dropdown in the Validation configuration panel.</p>
96
+ * @property validationDataTypeURL - <p>= URL - Gets or sets the label for the 'URL' option of the dataType dropdown in the Validation configuration panel.</p>
97
+ * @property validationDataTypeSource - <p>= Source - Gets or sets the label for the 'Source' option of the DataType dropdown in the Validation configuration panel.</p>
98
+ * @property validationPattern - <p>= Pattern - Gets or sets the label for the pattern setting in the Validation configuration panel.</p>
99
+ * @property validationPatternHint - <p>= Regular expression (e.g. ^[0-9]+$) - Gets or sets the label for the pattern setting hint in the Validation configuration panel.</p>
100
+ * @property validationLength - <p>= Length - Gets or sets the label for the length setting in the Validation configuration panel.</p>
101
+ * @property validationMinLengthHint - <p>= Min Length - Gets or sets the label for the min length setting hint in the Validation configuration panel.</p>
102
+ * @property validationMaxLengthHint - <p>= Max Length - Gets or sets the label for the max length setting hint in the Validation configuration panel.</p>
103
+ * @property validationRange - <p>= Range - Gets or sets the label for the range setting in the Validation configuration panel.</p>
104
+ * @property validationMinRangeHint - <p>= Min Range - Gets or sets the label for the min range setting hint in the Validation configuration panel.</p>
105
+ * @property validationMaxRangeHint - <p>= Max Range - Gets or sets the label for the max range setting hint in the Validation configuration panel.</p>
106
+ * @property validationCompare - <p>= Compare To - Gets or sets the label for the compare setting in the Validation configuration panel.</p>
107
+ * @property validatorMessage_required - <p>= {field} is required. - Gets or sets the label for required field validation error messages.</p>
108
+ * @property validatorMessage_range - <p>= {field} must be between {min} and {max}. - Gets or sets the label for numeric range validation error messages.</p>
109
+ * @property validatorMessage_length - <p>= {field} must be between {min} and {max} characters long. - Gets or sets the label for minimum/maximum length validation error messages.</p>
110
+ * @property validatorMessage_integer - <p>= {field} must be a valid number. - Gets or sets the label for integer data type validation error messages.</p>
111
+ * @property validatorMessage_float - <p>= {field} must be a valid decimal number. - Gets or sets the label for float data type validation error messages.</p>
112
+ * @property validatorMessage_datetime - <p>= {field} must be a valid date. - Gets or sets the label for datetime data type validation error messages.</p>
113
+ * @property validatorMessage_email - <p>= {field} must be a valid email address. - Gets or sets the label for email data type validation error messages.</p>
114
+ * @property validatorMessage_url - <p>= {field} must be a valid URL. - Gets or sets the label for URL data type validation error messages.</p>
115
+ * @property validatorMessage_source - <p>= {field} must be a valid source. - Gets or sets the label for source data type validation error messages.</p>
116
+ * @property validatorMessage_compare - <p>= {field} must be {operator} {compareField}. - Gets or sets the label for comparison validation error messages.</p>
117
+ * @property validatorMessage_pattern - <p>= {field} has an invalid format. - Gets or sets the label for regex/pattern validation error messages.</p>
118
+ * @property ruleCase - <p>= Rule Case - Gets or sets the label used to describe a rule case.</p>
119
+ * @property ruleGroup - <p>= Rule Group - Gets or sets the label used to describe a rule group.</p>
120
+ * @property ruleCaseHeader - <p>= Rule Case - Gets or sets the label for the rule case header in the Rules configuration panel.</p>
121
+ * @property ruleCaseTrigger - <p>= Case Trigger - Gets or sets the label for the rule case trigger setting in the Rules configuration panel.</p>
122
+ * @property ruleCaseRunVisibility - <p>= Run When - Gets or sets the label for the rule case run visibility setting in the Rules configuration panel.</p>
123
+ * @property ruleGroupConnector - <p>= Group Connector - Gets or sets the label for the rule group connector setting in the Rules configuration panel.</p>
124
+ * @property ruleGroupsEmptyHint - <p>= Actions will fire unconditionally - Gets or sets the message to display when the rule groups container element is empty.</p>
125
+ * @property actionsHeader - <p>= Actions - Gets or sets the label for the actions header in the Rules configuration panel.</p>
126
+ * @property ruleFieldHint - <p>= - Field - - Gets or sets the label for the rule field setting hint in the Rules configuration panel.</p>
127
+ * @property ruleComparisonOperatorHint - <p>= - Condition - - Gets or sets the label for the rule comparison operator hint in the Rules configuration panel.</p>
128
+ * @property operator_and - <p>= AND - Gets or sets the label for the AND logical operator.</p>
129
+ * @property operator_or - <p>= OR - Gets or sets the label for the OR logical operator.</p>
130
+ * @property operator_equal - <p>= Equal - Gets or sets the label for the equal operator.</p>
131
+ * @property operator_not_equal - <p>= Not Equal - Gets or sets the label for the not equal operator.</p>
132
+ * @property operator_less_than - <p>= Less Than - Gets or sets the label for the less than operator.</p>
133
+ * @property operator_less_than_or_equal - <p>= Less Than Or Equal - Gets or sets the label for the less than or equal operator.</p>
134
+ * @property operator_greater_than_or_equal - <p>= Greater Than Or Equal - Gets or sets the label for the greater than or equal operator.</p>
135
+ * @property operator_greater_than - <p>= Greater Than - Gets or sets the label for the greater than operator.</p>
136
+ * @property operator_contains - <p>= Contains - Gets or sets the label for the contains operator.</p>
137
+ * @property operator_not_contains - <p>= Does Not Contain - Gets or sets the label for the not contains operator.</p>
138
+ * @property operator_starts_with - <p>= Starts With - Gets or sets the label for the starts with operator.</p>
139
+ * @property operator_ends_with - <p>= Ends With - Gets or sets the label for the ends with operator.</p>
140
+ * @property operator_empty - <p>= Empty - Gets or sets the label for the empty operator.</p>
141
+ * @property operator_not_empty - <p>= Not Empty - Gets or sets the label for the not empty operator.</p>
142
+ * @property operator_visible - <p>= Visible - Gets or sets the label for the visible operator.</p>
143
+ * @property operator_hidden - <p>= Hidden - Gets or sets the label for the hidden (not visible) operator.</p>
144
+ * @property operator_enabled - <p>= Enabled - Gets or sets the label for the enabled operator.</p>
145
+ * @property operator_disabled - <p>= Disabled - Gets or sets the label for the disabled operator.</p>
146
+ * @property operator_required - <p>= Required - Gets or sets the label for the required operator.</p>
147
+ * @property operator_optional - <p>= Optional - Gets or sets the label for the optional operator.</p>
148
+ * @property trigger_always - <p>= Always - Gets or sets the label for the always rule case trigger.</p>
149
+ * @property trigger_change - <p>= On Field Change - Gets or sets the label for the change rule case trigger.</p>
150
+ * @property trigger_init - <p>= On Form Load - Gets or sets the label for the init rule case trigger.</p>
151
+ * @property trigger_show_section - <p>= On Show Section - Gets or sets the label for the show section rule case trigger.</p>
152
+ * @property trigger_before_submit - <p>= Before Form Submit - Gets or sets the label for the before submit rule case trigger.</p>
153
+ * @property trigger_submit_succeeded - <p>= After Successful Submit - Gets or sets the label for the succeeded submit rule case trigger.</p>
154
+ * @property trigger_submit_failed - <p>= After Failed Submit - Gets or sets the label for the failed submit rule case trigger.</p>
155
+ * @property run_visibility_visible - <p>= Field is Visible - Gets or sets the label for the rule case run visibility 'visible' option.</p>
156
+ * @property run_visibility_hidden - <p>= Field is Visible or Hidden - Gets or sets the label for the rule case run visibility 'hidden' option.</p>
157
+ * @property run_visibility_section_hidden - <p>= Section is Hidden - Gets or sets the label for the rule case run visibility 'section_hidden' option.</p>
158
+ * @property action_value - <p>= Set Value - Gets or sets the label for the set field value action.</p>
159
+ * @property action_expression - <p>= Set Value Expression - Gets or sets the label for the set field value expression action.</p>
160
+ * @property action_feedback - <p>= Feedback Message - Gets or sets the label for the set field feedback value action.</p>
161
+ * @property action_alert - <p>= Alert Dialog - Gets or sets the label for the set field alert value action.</p>
162
+ * @property action_confirm - <p>= Confirmation Dialog - Gets or sets the label for the set field confirm value action.</p>
163
+ * @property action_required - <p>= Set Required - Gets or sets the label for the set field required action.</p>
164
+ * @property action_optional - <p>= Set Optional - Gets or sets the label for the set field optional action.</p>
165
+ * @property action_hide - <p>= Hide - Gets or sets the label for the hide field action.</p>
166
+ * @property action_show - <p>= Show - Gets or sets the label for the show field action.</p>
167
+ * @property action_disable - <p>= Enable - Gets or sets the label for the disable field action.</p>
168
+ * @property action_enable - <p>= Disable - Gets or sets the label for the enable field action.</p>
169
+ * @property action_read - <p>= Read only - Gets or sets the label for the readonly field action.</p>
170
+ * @property action_editable - <p>= Editable - Gets or sets the label for the editable field action.</p>
171
+ * @property action_disable_next - <p>= Disable Next/Submit - Gets or sets the label for the disable next/submit button action.</p>
172
+ * @property action_enable_next - <p>= Enable Next/Submit - Gets or sets the label for the disable next/submit button action.</p>
173
+ * @property action_cancel - <p>= Cancel Submit - Gets or sets the label for the cancel submit action.</p>
174
+ * @property action_show_section - <p>= Show Section - Gets or sets the label for the show section action.</p>
175
+ * @property action_end - <p>= End Form - Gets or sets the label for the end form action.</p>
176
+ * @property actionValueHint - <p>= Enter a Value - Gets or sets the label for the 'Set Value' action hint in the Rules configuration panel.</p>
177
+ * @property actionExpressionHint - <p>= Enter an Expression - Gets or sets the label for the 'Set Expression' action in the Rules configuration panel.</p>
178
+ * @property componentPanelHeader - <p>= {0} Configuration - Gets or sets the label for the component configuration panel header. The {0} tag gets replaced with the name of the component.</p>
179
+ * @property comboBox - <p>= ComboBox - Gets or sets the label for the component's friendly name of the when the field input type is a ComboBox component.</p>
180
+ * @property datePicker - <p>= DatePicker - Gets or sets the label for the component's friendly name of the when the field input type is a DatePicker component.</p>
181
+ * @property editor - <p>= Editor - Gets or sets the label for the component's friendly name of the when the field input type is a Editor component.</p>
182
+ * @property fileUpload - <p>= FileUpload - Gets or sets the label for the component's friendly name of the when the field input type is a FileUpload component.</p>
183
+ * @property maskedTextBox - <p>= MaskedTextBox - Gets or sets the label for the component's friendly name of the when the field input type is a MaskedTextBox component.</p>
184
+ * @property numericBox - <p>= NumericBox - Gets or sets the label for the component's friendly name of the when the field input type is a NumericBox component.</p>
185
+ * @property slider - <p>= Slider - Gets or sets the label for the component's friendly name of the when the field input type is a Slider component.</p>
186
+ * @property timePicker - <p>= TimePicker - Gets or sets the label for the component's friendly name of the when the field input type is a TimePicker component.</p>
187
+ * @property multiSelect - <p>= Enable Multi-Selection - Gets or sets the label for the multiSelect setting in the ComboBox configuration panel.</p>
188
+ * @property multiSelectTagging - <p>= Selections as Tags - Gets or sets the label for the multiSelectTagging setting in the ComboBox configuration panel.</p>
189
+ * @property allowInput - <p>= Allow Typing - Gets or sets the label for the allowInput setting in the ComboBox configuration panel.</p>
190
+ * @property today - <p>= Default to Today - Gets or sets the label for the today setting in the DatePicker configuration panel.</p>
191
+ * @property allowedDates - <p>= Allow Listed Dates - Gets or sets the label for the allowedDates setting in the DatePicker configuration panel.</p>
192
+ * @property disallowDates - <p>= Disallow Listed Dates - Gets or sets the label for the disallowDates setting in the DatePicker configuration panel.</p>
193
+ * @property precision - <p>= Decimal Precision - Gets or sets the label for the precision setting in the NumericBox configuration panel.</p>
194
+ * @property mask - <p>= Mask - Gets or sets the label for the mask setting in the MaskedTextBox configuration panel.</p>
195
+ * @property maskTooltip - <p>Gets or sets the label for the tooltip for the mask setting in the MaskedTextBox configuration panel.</p>
196
+ * @property allowedCharacters - <p>= Allowed Characters - Gets or sets the label for the allowedCharacters setting in the MaskedTextBox configuration panel.</p>
197
+ * @property allowedCharactersAlphanumeric - <p>= Alphanumeric - Gets or sets the label for the 'Alphanumeric' option of the allowedCharacters dropdown in the MaskedTextBox configuration panel.</p>
198
+ * @property allowedCharactersDigits - <p>= Digits - Gets or sets the label for the 'Digits' option of the allowedCharacters dropdown in the MaskedTextBox configuration panel.</p>
199
+ * @property allowedCharactersLetters - <p>= Letters - Gets or sets the label for the 'Letters' option of the allowedCharacters dropdown in the MaskedTextBox configuration panel.</p>
200
+ * @property range - <p>= Enable Range Selection - Gets or sets the label for the range setting in the Slider configuration panel.</p>
201
+ * @property trackSize - <p>= Track Size - Gets or sets the label for the trackSize setting in the Slider configuration panel.</p>
202
+ * @property trackSizeHint - <p>= 200px, 100%, 20ch - use CSS units - Gets or sets the label for the trackSize setting hint in the Field configuration panel.</p>
203
+ * @property startValue - <p>= Start Value - Gets or sets the label for the startValue setting in the Slider configuration panel.</p>
204
+ * @property tickMarks - <p>= Tick Marks - Gets or sets the label for the tickMarks setting in the Slider configuration panel.</p>
205
+ * @property incrementalValue - <p>= Step Interval (minutes) - Gets or sets the label for the incrementalValue setting in the TimePicker configuration panel.</p>
206
+ * @property allowedTimes - <p>= Allowed Times - Gets or sets the label for the allowedTimes setting in the TimePicker configuration panel.</p>
207
+ * @property disallowTimes - <p>= Disallow Listed Times - Gets or sets the label for the disallowTimes setting in the TimePicker configuration panel.</p>
208
+ * @property accept - <p>= Accept - Gets or sets the label for the accept setting in the FileUpload configuration panel.</p>
209
+ * @property acceptHint - <p>= .png, .jpg, .jpeg - Gets or sets the label for the placeholder setting hint for the accept setting in the FileUpload configuration panel.</p>
210
+ * @property maxFileSize - <p>= Max. File Size (KB) - Gets or sets the label for the maxFileSize setting in the FileUpload configuration panel.</p>
211
+ * @property maxFiles - <p>= Max. Files - Gets or sets the label for the maxFiles setting in the FileUpload configuration panel.</p>
212
+ * @property all - <p>= All Options - Gets or sets the label for the all setting in the Editor configuration panel.</p>
213
+ * @property block - <p>= Block styles - Gets or sets the label for the block setting in the Editor configuration panel.</p>
214
+ * @property link - <p>= Links - Gets or sets the label for the link setting in the Editor configuration panel.</p>
215
+ * @property list - <p>= Lists - Gets or sets the label for the list setting in the Editor configuration panel.</p>
216
+ * @property special - <p>= Special Chars - Gets or sets the label for the special setting in the Editor configuration panel.</p>
217
+ * @property margin - <p>= Margin - Gets or sets the label for the margin setting in the Content configuration panel.</p>
218
+ * @property marginHint - <p>= 5px, 100% - use CSS units - Gets or sets the label for the margin setting hint in the Content configuration panel.</p>
219
+ * @property padding - <p>= Padding - Gets or sets the label for the padding setting in the Content configuration panel.</p>
220
+ * @property paddingHint - <p>= 5px, 100% - use CSS units - Gets or sets the label for the padding setting hint in the Content configuration panel.</p>
221
+ * @property backgroundColor - <p>= Background color - Gets or sets the label for the backgroundColor setting in the Content configuration panel.</p>
222
+ * @property borderWidth - <p>= Border width - Gets or sets the label for the borderWidth setting in the Content configuration panel.</p>
223
+ * @property borderColor - <p>= Border color - Gets or sets the label for the borderColor setting in the Content configuration panel.</p>
224
+ * @property borderRadius - <p>= Border radius - Gets or sets the label for the borderRadius setting in the Content configuration panel.</p>
225
+ * @property borderRadiusHint - <p>= 5px, 100% - use CSS units - Gets or sets the label for the borderRadius setting hint in the Content configuration panel.</p>
226
+ * @property showDivider - <p>= Show Divider - Gets or sets the label for the showDivider setting in the Spacer configuration panel.</p>
227
+ * @property height - <p>= Height - Gets or sets the label for the height setting in the Spacer configuration panel.</p>
228
+ * @property heightHint - <p>= 10px, 2em - use CSS units - Gets or sets the label for the height setting hint in the Spacer configuration panel.</p>
229
+ * @property saveInProgress - <p>= Saving... - Gets or sets the label for the save-status when the save is in progress.</p>
230
+ * @property saveSuccess - <p>= Saved... - Gets or sets the label for the save-status when the save is successful.</p>
231
+ * @property saveFailed - <p>= Save failed - Gets or sets the label for the save-status when the save failed.</p>
232
+ * @property alertDialogHeader - <p>= Alert - Gets or sets the header label for the alert dialog.</p>
233
+ * @property confirmDialogHeader - <p>= Confirmation - Gets or sets the header label for the confirmation dialog.</p>
234
+ * @property previous - <p>= Previous - Gets or sets the label for the previous section button.</p>
235
+ * @property next - <p>= Next - Gets or sets the label for the next section button.</p>
236
+ * @property submit - <p>= Submit - Gets or sets the label for the submit button.</p>
237
+ */
238
+ type LabelSettings = {
239
+ [key: string]: string;
240
+ };
241
+
242
+ /**
243
+ * <p>Internal CSS class name constants of the Form component.</p>
244
+ */
245
+ type ClassOption = Readonly<{
246
+ BUILD_MODE: 'build-mode';
247
+ PREVIEW_MODE: 'preview-mode';
248
+ EDIT_MODE: 'edit-mode';
249
+ VIEW_MODE: 'view-mode';
250
+ FIXED_LAYOUT: 'fixed-layout';
251
+ PANES: 'panes';
252
+ BUILD_PANE: 'build-pane';
253
+ CONFIG_PANE: 'config-pane';
254
+ FORM_PANE: 'form-pane';
255
+ FIELD_PANE: 'field-pane';
256
+ PANE_HIDDEN: 'pane-hidden';
257
+ EDGE_TOP: 'edge-top';
258
+ EDGE_BOTTOM: 'edge-bottom';
259
+ LINE_BREAK: 'line-break';
260
+ VIEW_FIELD: 'view-field';
261
+ EDIT_FIELD: 'edit-field';
262
+ BUILD_FIELD: 'build-field';
263
+ BUILD_MENU: 'build-menu';
264
+ LABEL: 'label';
265
+ REMOVE: 'remove';
266
+ CLONE: 'clone';
267
+ ADD: 'add';
268
+ DISABLED: 'disabled';
269
+ INVISIBLE: 'invisible';
270
+ READONLY: 'readonly';
271
+ FILLER: 'filler';
272
+ BUILD_BLOCK: 'build-block';
273
+ BUILD_BLOCK_INSERT: 'insert';
274
+ FIELD_INDICATORS: 'field-indicators';
275
+ ICON: 'icon';
276
+ TOOLTIP_ICON: 'ico-question-mark';
277
+ RULES_ICON: 'ico-chip';
278
+ VALIDATOR_ICON: 'ico-validator';
279
+ DRAG_GHOST: 'drag-ghost';
280
+ DRAG_HANDLE: 'drag-handle';
281
+ DRAGGING: 'dragging';
282
+ DROPPABLE: 'droppable';
283
+ DROP_LEFT: 'drop-left';
284
+ DROP_RIGHT: 'drop-right';
285
+ DROP_ABOVE: 'drop-above';
286
+ DROP_BELOW: 'drop-below';
287
+ DROP_INSIDE: 'drop-inside';
288
+ DROP_DENIED: 'drop-denied';
289
+ FIELD_SET: 'field-set';
290
+ BANNERED: 'bannered';
291
+ LAYOUTLESS: 'layoutless';
292
+ SELECTED: 'selected';
293
+ TITLE: 'title';
294
+ SECTION_SWITCH: 'section-switch';
295
+ COMMANDS: 'commands';
296
+ SECTIONS: 'sections';
297
+ SECTION_ADD: 'section-add';
298
+ SECTION_REMOVE: 'section-remove icon ico-bin';
299
+ SECTION_PREVIOUS: 'section-prev';
300
+ SECTION_NEXT: 'section-next';
301
+ STEP_INDICATOR: 'step-indicator';
302
+ STEP: 'step';
303
+ STEP_ACTIVE: 'step-active';
304
+ SUBMIT: 'submit';
305
+ CONFIG_CHOICE_GROUP: 'config-choice-group';
306
+ MORE_SETTINGS: 'more-settings';
307
+ FIELD_OPTIONS_TYPE: 'options-type';
308
+ FIELD_OPTIONS: 'field-options';
309
+ FIELD_OPTIONS_INLINE: 'options-inline';
310
+ FIELD_OPTIONS_ROW: 'options-row';
311
+ FIELD_OPTIONS_HEADER: 'option-header';
312
+ FIELD_OPTIONS_ITEM: 'option-item';
313
+ FIELD_OPTIONS_ITEM_NEW: 'option-new';
314
+ FIELD_OPTIONS_ITEM_GHOST: 'option-item-ghost';
315
+ ALLOWED_LIST: 'allowed-list';
316
+ REPEATABLE: 'repeatable';
317
+ REPEAT_ADD: 'repeat-add';
318
+ REPEAT_REMOVE: 'repeat-remove';
319
+ EMPTY: 'empty';
320
+ FIELD_TOOLTIP: 'tooltip field-tooltip';
321
+ SPACER: 'spacer';
322
+ CONTENT: 'content';
323
+ DIVIDER: 'divider';
324
+ COMBOBOX_VAL_COMPARE_OPERATOR: 'val-compare-operator';
325
+ COMBOBOX_VAL_COMPARE_FIELD: 'val-compare-field';
326
+ COMBOBOX_LOGICAL_OPERATOR: 'logical-operator';
327
+ COMBOBOX_RULE_FIELD: 'rule-field';
328
+ COMBOBOX_RULE_COMPARISON_OPERATOR: 'rule-comparison-operator';
329
+ COMBOBOX_ACTION: 'action';
330
+ RULE_CASE: 'rule-case';
331
+ RULE_CASE_TRIGGER: 'rule-case-trigger';
332
+ RULE_CASE_RUN_VISIBILITY: 'rule-case-run-visibility';
333
+ ACTIONS: 'actions';
334
+ RULE_GROUPS: 'rule-groups';
335
+ RULE_GROUP: 'rule-group';
336
+ RULES: 'rules';
337
+ RULE: 'rule';
338
+ RULE_VALUE: 'rule-value';
339
+ ACTION: 'action';
340
+ ACTION_FOLLOW_UP: 'follow-up';
341
+ ACTION_VALUE: 'action-value';
342
+ EXPRESSION: 'expression';
343
+ EXPRESSION_CONTROLS: 'expr-controls';
344
+ FEEDBACK: 'feedback';
345
+ VALIDATION_FEEDBACK: 'val-feedback';
346
+ RULE_FEEDBACK: 'rule-feedback';
347
+ SAVE_STATUS: 'save-status';
348
+ SAVE_STATUS_BUSY: 'busy';
349
+ SAVE_STATUS_SUCCESS: 'success';
350
+ SAVE_STATUS_FAILED: 'failed';
351
+ SPINNER: 'spinner';
352
+ }>;
353
+
354
+ /**
355
+ * <p>Form CSS Variables.</p>
356
+ * @property ["--fieldset-border-width"] - <p>Border width of fieldsets.</p>
357
+ * @property ["--fieldset-drop-above-margin"] - <p>34px&quot; - Margin above a drop target fieldset.</p>
358
+ * @property ["--fieldset-bannered-drop-above-margin"] - <p>52px&quot; - Margin above a bannered drop target.</p>
359
+ * @property ["--fieldset-nested-margin"] - <p>Margin for nested fieldsets.</p>
360
+ * @property ["--droppable-margin"] - <p>Margin between droppable zones when dropping a field(set).</p>
361
+ * @property ["--droppable-line-size"] - <p>Height of the droppable line.</p>
362
+ * @property ["--build-pane-width"] - <p>15vw, 260px)&quot; - Width of the build pane.</p>
363
+ * @property ["--config-pane-width"] - <p>25vw, 500px)&quot; - Width of the config pane.</p>
364
+ * @property ["--header-height"] - <p>Height of the header.</p>
365
+ * @property ["--fixed-layout-offset-top"] - <p>Top offset for fixed layout.</p>
366
+ * @property ["--fixed-layout-offset-bottom"] - <p>Bottom offset for fixed layout.</p>
367
+ * @property ["--fixed-layout-offset-left"] - <p>Left offset for fixed layout.</p>
368
+ * @property ["--fixed-layout-offset-right"] - <p>Right offset for fixed layout.</p>
369
+ * @property ["--fixed-layout-z-index"] - <p>Z-index for fixed layout elements.</p>
370
+ */
371
+ type CSSVariables = {
372
+ "--fieldset-border-width"?: string;
373
+ "--fieldset-drop-above-margin"?: string;
374
+ "--fieldset-bannered-drop-above-margin"?: string;
375
+ "--fieldset-nested-margin"?: string;
376
+ "--droppable-margin"?: string;
377
+ "--droppable-line-size"?: string;
378
+ "--build-pane-width"?: string;
379
+ "--config-pane-width"?: string;
380
+ "--header-height"?: string;
381
+ "--fixed-layout-offset-top"?: string;
382
+ "--fixed-layout-offset-bottom"?: string;
383
+ "--fixed-layout-offset-left"?: string;
384
+ "--fixed-layout-offset-right"?: string;
385
+ "--fixed-layout-z-index"?: string;
386
+ };
387
+
388
+ /**
389
+ * @property dateFormat - <p>Gets or sets the input format for dates. Default: MM/dd/yyyy.</p>
390
+ * @property decimalSeparator - <p>Gets or sets the decimal separator for numbers. Default: '.'.</p>
391
+ * @property groupSeparator - <p>Gets or sets the group (thousands) separator for numbers. Default: ','.</p>
392
+ */
393
+ type FormatConfig = {
394
+ dateFormat: string;
395
+ decimalSeparator: string;
396
+ groupSeparator: string;
397
+ };
398
+
399
+ /**
400
+ * @property fieldSet - <p>The fieldset instance. Use <code>fieldSet.element</code> to access the fieldset's root element.</p>
401
+ */
402
+ type FieldSetEventArgs = {
403
+ fieldSet: componyx.UI.Form.Field;
404
+ };
405
+ /**
406
+ * @property field - <p>The field instance. Use <code>field.element</code> to access the field's root element.</p>
407
+ * @property [option] - <p>The optional field option, only available for <code>onRenderEditFieldOption</code>.</p>
408
+ */
409
+ type FieldEventArgs = {
410
+ field: componyx.UI.Form.Field;
411
+ option?: componyx.UI.Form.FieldOption;
412
+ };
413
+ /**
414
+ * @property item - <p>The dropped field or fieldSet.</p>
415
+ */
416
+ type DropFieldEventArgs = {
417
+ item: componyx.UI.Form.Field | componyx.UI.Form.FieldSet;
418
+ };
419
+ /**
420
+ * @property fieldSet - <p>The selected fieldSet.</p>
421
+ */
422
+ type SelectFieldSetEventArgs = {
423
+ fieldSet: componyx.UI.Form.FieldSet;
424
+ };
425
+ /**
426
+ * @property field - <p>The selected field.</p>
427
+ */
428
+ type SelectFieldEventArgs = {
429
+ field: componyx.UI.Form.Field;
430
+ };
431
+ /**
432
+ * @property sanitizer - <p>The created sanitizer class instance.</p>
433
+ */
434
+ type CreateSanitizerEventArgs = {
435
+ sanitizer: componyx.base_modules.Sanitizer;
436
+ };
437
+ /**
438
+ * <p>// empty additional fields besides form instance</p>
439
+ */
440
+ type BaseEventArgs = any;
441
+ /**
442
+ * @property values - <p>The submitted form values.</p>
443
+ * @property result - <p>The submit result.
444
+ * Custom onSubmit handler(s) must set <code>result.error</code> and <code>result.success</code> ONLY if the onSubmitEndpoint is not configured.
445
+ * If the default endpoint is used, these flags are set automatically and handlers can safely ignore them.</p>
446
+ * @property [result.error] - <p>A value indicating if an exception was thrown.</p>
447
+ * @property [result.success] - <p>A value indicating if the completed action returned true (success) or false.</p>
448
+ */
449
+ type SubmitEventArgs = {
450
+ values: any;
451
+ result: {
452
+ error?: boolean;
453
+ success?: boolean;
454
+ };
455
+ };
456
+ /**
457
+ * @property result - <p>The save result.
458
+ * Custom onSave handler(s) must set <code>result.error</code> and <code>result.success</code> ONLY if the onSaveEndpoint is not configured.
459
+ * If the default endpoint is used, these flags are set automatically and handlers can safely ignore them.</p>
460
+ * @property [result.error] - <p>A value indicating if an exception was thrown.</p>
461
+ * @property [result.success] - <p>A value indicating if the completed action returned true (success) or false.</p>
462
+ */
463
+ type SaveEventArgs = {
464
+ result: {
465
+ error?: boolean;
466
+ success?: boolean;
467
+ };
468
+ };
469
+ /**
470
+ * <p>Callback for fieldset events.</p>
471
+ * @param form - <p>The form instance firing the event.</p>
472
+ * @param eventArgs - <p>The event details.</p>
473
+ */
474
+ type FieldSetEventHandler = (form: componyx.UI.Form, eventArgs: componyx.UI.Form.FieldSetEventArgs) => void;
475
+ /**
476
+ * <p>Callback for field events.</p>
477
+ * @param form - <p>The form instance firing the event.</p>
478
+ * @param eventArgs - <p>The event details.</p>
479
+ */
480
+ type FieldEventHandler = (form: componyx.UI.Form, eventArgs: componyx.UI.Form.FieldEventArgs) => void;
481
+ /**
482
+ * <p>Callback for drop field events.</p>
483
+ * @param form - <p>The form instance firing the event.</p>
484
+ * @param eventArgs - <p>The event details.</p>
485
+ */
486
+ type DropFieldEventHandler = (form: componyx.UI.Form, eventArgs: componyx.UI.Form.DropFieldEventArgs) => void;
487
+ /**
488
+ * <p>Callback for select fieldset events.</p>
489
+ * @param form - <p>The form instance firing the event.</p>
490
+ * @param eventArgs - <p>The event details.</p>
491
+ */
492
+ type SelectFieldSetEventHandler = (form: componyx.UI.Form, eventArgs: componyx.UI.Form.SelectFieldSetEventArgs) => void;
493
+ /**
494
+ * <p>Callback for select field events.</p>
495
+ * @param form - <p>The form instance firing the event.</p>
496
+ * @param eventArgs - <p>The event details.</p>
497
+ */
498
+ type SelectFieldEventHandler = (form: componyx.UI.Form, eventArgs: componyx.UI.Form.SelectFieldEventArgs) => void;
499
+ /**
500
+ * <p>Callback for sanitizer creation events.</p>
501
+ * @param form - <p>The form instance firing the event.</p>
502
+ * @param eventArgs - <p>The event details.</p>
503
+ */
504
+ type CreateSanitizerEventHandler = (form: componyx.UI.Form, eventArgs: componyx.UI.Form.CreateSanitizerEventArgs) => void;
505
+ /**
506
+ * <p>Callback for base form events.</p>
507
+ * @param form - <p>The form instance firing the event.</p>
508
+ * @param [eventArgs] - <p>The event details (optional).</p>
509
+ */
510
+ type BaseEventHandler = (form: componyx.UI.Form, eventArgs?: componyx.UI.Form.BaseEventArgs) => void;
511
+ /**
512
+ * <p>Callback for form submit events.</p>
513
+ * @param form - <p>The form instance firing the event.</p>
514
+ * @param eventArgs - <p>The event details.</p>
515
+ */
516
+ type SubmitEventHandler = (form: componyx.UI.Form, eventArgs: componyx.UI.Form.SubmitEventArgs) => void;
517
+ /**
518
+ * <p>Callback for form save events.</p>
519
+ * @param form - <p>The form instance firing the event.</p>
520
+ * @param eventArgs - <p>The event details.</p>
521
+ */
522
+ type SaveEventHandler = (form: componyx.UI.Form, eventArgs: componyx.UI.Form.SaveEventArgs) => void;
523
+ /**
524
+ * @property onRenderFieldSet - <p>Fires when a fieldset is rendered.</p>
525
+ * @property onRenderField - <p>Fires when a field is rendered.</p>
526
+ * @property onRenderViewTemplate - <p>Fires when the view template is rendered.</p>
527
+ * @property onRenderEditTemplate - <p>Fires when the edit template is rendered.</p>
528
+ * @property onRenderEditFieldOption - <p>Fires when a field option is rendered. </p>
529
+ * @property onUpdateFieldSet - <p>Fires when a fieldset is updated, minor changes that do not require full re-render.</p>
530
+ * @property onUpdateField - <p>Fires when a field is updated, minor changes that do not require full re-render.</p>
531
+ * @property onDropField - <p>Fires when a field or fieldSet is dropped from build pane onto the form.</p>
532
+ * @property onSelectFieldSet - <p>Fires when a fieldSet is selected.</p>
533
+ * @property onSelectField - <p>Fires when a field is selected.</p>
534
+ * @property onCreateSanitizer - <p>Fires when the default HTML sanitizer is created, allowing optional configuration.</p>
535
+ * @property onSave - <p>Fires when the form definition is saved in build mode.</p>
536
+ * @property onSubmit - <p>Fires when the form values are submitted.</p>
537
+ * @property onSubmitCanceled - <p>Fires when the form submit is canceled because of the rule case cancel submit action.</p>
538
+ * @property onEndForm - <p>Fires when the form end action is executed.</p>
539
+ */
540
+ class FormEvents extends componyx.UI.base.Events<componyx.UI.Form>
541
+ {
542
+ constructor();
543
+ /**
544
+ * <p>Fires when a fieldset is rendered.</p>
545
+ */
546
+ onRenderFieldSet: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.FieldSetEventArgs>;
547
+ /**
548
+ * <p>Fires when a field is rendered.</p>
549
+ */
550
+ onRenderField: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.FieldEventArgs>;
551
+ /**
552
+ * <p>Fires when the view template is rendered.</p>
553
+ */
554
+ onRenderViewTemplate: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.FieldEventArgs>;
555
+ /**
556
+ * <p>Fires when the edit template is rendered.</p>
557
+ */
558
+ onRenderEditTemplate: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.FieldEventArgs>;
559
+ /**
560
+ * <p>Fires when a field option is rendered. </p>
561
+ */
562
+ onRenderEditFieldOption: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.FieldEventArgs>;
563
+ /**
564
+ * <p>Fires when a fieldset is updated, minor changes that do not require full re-render.</p>
565
+ */
566
+ onUpdateFieldSet: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.FieldSetEventArgs>;
567
+ /**
568
+ * <p>Fires when a field is updated, minor changes that do not require full re-render.</p>
569
+ */
570
+ onUpdateField: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.FieldEventArgs>;
571
+ /**
572
+ * <p>Fires when a field or fieldSet is dropped from build pane onto the form.</p>
573
+ */
574
+ onDropField: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.DropFieldEventArgs>;
575
+ /**
576
+ * <p>Fires when a fieldSet is selected.</p>
577
+ */
578
+ onSelectFieldSet: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.SelectFieldSetEventArgs>;
579
+ /**
580
+ * <p>Fires when a field is selected.</p>
581
+ */
582
+ onSelectField: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.SelectFieldEventArgs>;
583
+ /**
584
+ * <p>Fires when the default HTML sanitizer is created, allowing optional configuration.</p>
585
+ */
586
+ onCreateSanitizer: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.CreateSanitizerEventArgs>;
587
+ /**
588
+ * <p>Fires when the form definition is saved in build mode.</p>
589
+ */
590
+ onSave: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.SaveEventArgs>;
591
+ /**
592
+ * <p>Fires when the form values are submitted.</p>
593
+ */
594
+ onSubmit: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.SubmitEventArgs>;
595
+ /**
596
+ * <p>Fires when the form submit is canceled because of the rule case cancel submit action.</p>
597
+ */
598
+ onSubmitCanceled: componyx.UI.base.Event<componyx.UI.Form, componyx.UI.Form.SubmitEventArgs>;
599
+ /**
600
+ * <p>Fires when the form end action is executed.</p>
601
+ */
602
+ onEndForm: componyx.UI.base.Event<componyx.UI.Form>;
603
+ }
604
+
605
+ /**
606
+ * <p>Gets the value from the field.</p>
607
+ * @param field - <p>The field instance.</p>
608
+ */
609
+ type CustomFieldGetter = (field: any) => any;
610
+ /**
611
+ * <p>Sets the value on the field.</p>
612
+ * @param field - <p>The field instance.</p>
613
+ * @param value - <p>The value to set.</p>
614
+ */
615
+ type CustomFieldSetter = (field: any, value: any) => void;
616
+ /**
617
+ * <p>Renders the field HTML and must call the callback when rendering is complete.</p>
618
+ * @param form - <p>The form instance.</p>
619
+ * @param field - <p>The field instance.</p>
620
+ * @param element - <p>The container element to render into.</p>
621
+ * @param isView - <p>A value indicating if the field is rendered in the view template instead of the edit template.</p>
622
+ * @param callback - <p>Callback to invoke when rendering is done.</p>
623
+ */
624
+ type CustomFieldRenderer = (form: componyx.UI.Form, field: componyx.UI.Form.Field, element: HTMLElement, isView: boolean, callback: (...params: any[]) => any) => void;
625
+ /**
626
+ * <p>Updates &quot;minor&quot; properties without full re-render. Called when a property in <code>minorProps</code> changes.</p>
627
+ * @param form - <p>The form instance.</p>
628
+ * @param field - <p>The field instance.</p>
629
+ */
630
+ type CustomFieldUpdater = (form: componyx.UI.Form, field: componyx.UI.Form.Field) => void;
631
+ /**
632
+ * <p>Creates the configurable input value used in rules and set-value actions.</p>
633
+ * @param form - <p>The form instance.</p>
634
+ * @param field - <p>The field instance.</p>
635
+ * @param target - <p>The target, either a rule or an action.</p>
636
+ * @param container - <p>The container element in which to render the output.</p>
637
+ */
638
+ type CustomFieldRenderValueInput = (form: componyx.UI.Form, field: componyx.UI.Form.Field, target: componyx.UI.Form.Rule | componyx.UI.Form.Action, container: HTMLElement) => void;
639
+ type CustomFieldConfig = {
640
+ getter: componyx.UI.Form.CustomFieldGetter;
641
+ setter?: componyx.UI.Form.CustomFieldSetter;
642
+ renderer?: componyx.UI.Form.CustomFieldRenderer;
643
+ updater?: componyx.UI.Form.CustomFieldUpdater;
644
+ renderValueInput?: componyx.UI.Form.CustomFieldRenderValueInput;
645
+ minorProps?: Set<string>;
646
+ omitProps?: Set<string>;
647
+ };
648
+ /**
649
+ * <p>A function that executes an action.</p>
650
+ * @param supportsFieldSet - <p>A value indicating if the action can be applied to a FieldSet.</p>
651
+ * @param mustAwait- - <p>A value indicating if the action must be awaited (blocks other actions until this action is completed).</p>
652
+ * @param setValue - <p>A value indicating if the action sets the value of the related target field.</p>
653
+ * @param setExpression - <p>A value indicating if the action sets the expression value of the related target field.</p>
654
+ * @param label - <p>The text label of the action.</p>
655
+ * @param execute - <p>The function to execute the action.</p>
656
+ * @param [description] - <p>The optional desciption of the action, displayed in a tooltip.</p>
657
+ */
658
+ type ActionConfig = any;
659
+ /**
660
+ * <p>A function that executes an action.</p>
661
+ * @param value - <p>The value associated with the action.</p>
662
+ * @param target - <p>The field or fieldset on which the action is executed.</p>
663
+ */
664
+ type ActionExecutor = (value: any, target: componyx.UI.Form.Field | componyx.UI.Form.FieldSet) => void;
665
+ /**
666
+ * @property fieldSet - <p>The field set containing the target field.</p>
667
+ * @property fieldSetIndex - <p>The index of the field set in the field set list.</p>
668
+ * @property fieldIndex - <p>The index of the field.</p>
669
+ * @property nextField - <p>The rendered field after the target field, or null if it's the last field.</p>
670
+ * @property nextFieldSet - <p>The rendered field-set after the target field-set, or null if it's the last field-set.</p>
671
+ * @property isLastField - <p>A value indicating if the target field is the last field in the field set.</p>
672
+ * @property isLastFieldSet - <p>A value indicating if the target field-set is the last.</p>
673
+ */
674
+ type FieldContext = {
675
+ fieldSet: componyx.UI.Form.FieldSet;
676
+ fieldSetIndex: number;
677
+ fieldIndex: number;
678
+ nextField: componyx.UI.Form.Field;
679
+ nextFieldSet: componyx.UI.Form.FieldSet;
680
+ isLastField: boolean;
681
+ isLastFieldSet: boolean;
682
+ };
683
+
684
+ /**
685
+ * <p>The Form ComponentSettings class.</p>
686
+ */
687
+ class ComponentSettings extends BaseType
688
+ {
689
+ }
690
+ type ExtraComponentSettings = {
691
+ [key: string]: any;
692
+ };
693
+
694
+ /**
695
+ * @property [multiSelect] - <p>Gets or sets a value indicating whether multiple items can be selected through checkboxes.</p>
696
+ * @property [multiSelectTagging] - <p>Gets or sets a value indicating whether selected items are displayed as tags.</p>
697
+ * @property [allowInput] - <p>Gets or sets a value indicating whether textual input is allowed.</p>
698
+ */
699
+ type ComboBoxSettings = ComponentSettings & ExtraComponentSettings & {
700
+ multiSelect?: boolean;
701
+ multiSelectTagging?: boolean;
702
+ allowInput?: boolean;
703
+ };
704
+ /**
705
+ * @property [today] - <p>Gets or sets a value indicating whether today should be used as initial selected date.</p>
706
+ * @property [minValue] - <p>Gets or sets the minimum allowed date value.</p>
707
+ * @property [maxValue] - <p>Gets or sets the maximum allowed date value.</p>
708
+ * @property [allowedDates] - <p>Gets or sets a list of allowed calendar dates. Separate two date strings with a space to specify allowed range. When allowed dates are set, date input fields are rendered in readonly mode.</p>
709
+ * @property [disallowDates] - <p>Gets or sets a value indicating if the dates specified in the dates property are disallowed instead of the default allowed.</p>
710
+ */
711
+ type DatePickerSettings = ComponentSettings & ExtraComponentSettings & {
712
+ today?: boolean;
713
+ minValue?: string | Date;
714
+ maxValue?: string | Date;
715
+ allowedDates?: String[] | Date[];
716
+ disallowDates?: boolean;
717
+ };
718
+ /**
719
+ * @property [mask] - <p>Gets or sets the text box mask pattern.</p>
720
+ * @property [allowedCharacters] - <p>Gets or sets a value indicating which characters are allowed.</p>
721
+ */
722
+ type MaskedTextBoxSettings = ComponentSettings & ExtraComponentSettings & {
723
+ mask?: string;
724
+ allowedCharacters?: MaskedTextBox.AllowedCharactersOption;
725
+ };
726
+ /**
727
+ * @property [minValue] - <p>Gets or sets the minimium allowed value.</p>
728
+ * @property [maxValue] - <p>Gets or sets the maximum allowed value.</p>
729
+ * @property [precision] - <p>Gets or sets the amount of decimal places.</p>
730
+ */
731
+ type NumericBoxSettings = ComponentSettings & ExtraComponentSettings & {
732
+ minValue?: number;
733
+ maxValue?: number;
734
+ precision?: number;
735
+ };
736
+ /**
737
+ * @property [range] - <p>Gets or sets a value indicating if the slider has a start- and end-handle to set a range.</p>
738
+ * @property [startValue] - <p>Gets or sets the start value of the range slider.</p>
739
+ * @property [minValue] - <p>Gets or sets the minimum value.</p>
740
+ * @property [maxValue] - <p>Gets or sets the maximum value.</p>
741
+ * @property [tickMarks] - <p>Gets or sets the amount of rendered tickmarks.</p>
742
+ * @property [trackSize] - <p>Gets or sets the size of the slider track.</p>
743
+ */
744
+ type SliderSettings = ComponentSettings & ExtraComponentSettings & {
745
+ range?: boolean;
746
+ startValue?: number;
747
+ minValue?: number;
748
+ maxValue?: number;
749
+ tickMarks?: number;
750
+ trackSize?: number;
751
+ };
752
+ /**
753
+ * @property [minValue] - <p>Gets or sets the minimum allowed time in format 'HH:MM'. Minutes must be divisible by 5.</p>
754
+ * @property [maxValue] - <p>Gets or sets the maximum allowed time in format 'HH:MM'. Minutes must be divisible by 5.</p>
755
+ * @property [incrementalValue] - <p>Gets or sets the incremental value in minutes. Minutes must be divisible by 5.</p>
756
+ * @property [allowedTimes] - <p>Gets or sets a list of allowed clock times (format 'HH:MM'). Separate two date strings with a space to specify allowed range. When allowed times are set, date input fields are rendered in readonly mode.Gets or sets a list of allowed calendar dates.</p>
757
+ * @property [disallowTimes] - <p>Gets or sets a value indicating if the times specified in the times property are disallowed instead of the default allowed.</p>
758
+ */
759
+ type TimePickerSettings = ComponentSettings & ExtraComponentSettings & {
760
+ minValue?: string;
761
+ maxValue?: string;
762
+ incrementalValue?: string;
763
+ allowedTimes?: String[];
764
+ disallowTimes?: boolean;
765
+ };
766
+ /**
767
+ * @property [accept] - <p>Gets or sets the comma-separated list of allowed file extensions (.png, .jpg, .jpeg) or MIME types (image/png or image/*).</p>
768
+ * @property [maxFileSize] - <p>Gets or sets the max allowed file size in KB.</p>
769
+ * @property [maxFiles] - <p>Gets or sets the max allowed file count.</p>
770
+ */
771
+ type FileUploadSettings = ComponentSettings & ExtraComponentSettings & {
772
+ accept?: string;
773
+ maxFileSize?: number;
774
+ maxFiles?: number;
775
+ };
776
+ /**
777
+ * @property [all] - <p>Gets or sets a value indicating whether all editor settings are enabled.</p>
778
+ * @property [block] - <p>Gets or sets a value indicating whether changing block styles is enabled.</p>
779
+ * @property [link] - <p>Gets or sets a value indicating whether editing links is enabled.</p>
780
+ * @property [list] - <p>Gets or sets a value indicating whether editing UL/OL lists is enabled.</p>
781
+ * @property [image] - <p>Gets or sets a value indicating whether editing images is enabled.</p>
782
+ * @property [media] - <p>Gets or sets a value indicating whether editing media (video/audio) is enabled.</p>
783
+ */
784
+ type EditorSettings = ComponentSettings & ExtraComponentSettings & {
785
+ all?: boolean;
786
+ block?: boolean;
787
+ link?: boolean;
788
+ list?: boolean;
789
+ image?: boolean;
790
+ media?: boolean;
791
+ };
792
+ /**
793
+ * <p>Command Location options</p>
794
+ */
795
+ enum CommandLocationOption
796
+ {
797
+ /**
798
+ * <p>Commands shown in the top header bar.</p>
799
+ */
800
+ HEADER = 0,
801
+ /**
802
+ * <p>Commands shown in the top-left corner of the form.</p>
803
+ */
804
+ BUILD_PANE_TOP = 1,
805
+ /**
806
+ * <p>Commands shown in the bottom-left corner of the form.</p>
807
+ */
808
+ BUILD_PANE_BOTTOM = 2,
809
+ /**
810
+ * <p>Commands shown in the top-right corner of the form.</p>
811
+ */
812
+ CONFIG_PANE_TOP = 3,
813
+ /**
814
+ * <p>Commands shown in the bottom-right corner of the form.</p>
815
+ */
816
+ CONFIG_PANE_BOTTOM = 4
817
+ }
818
+ /**
819
+ * <p>Block Type options</p>
820
+ */
821
+ enum BlockTypeOption
822
+ {
823
+ /**
824
+ * <p>A container for grouping related fields.</p>
825
+ */
826
+ FIELD_SET = 0,
827
+ /**
828
+ * <p>A standard input field.</p>
829
+ */
830
+ FIELD = 1,
831
+ /**
832
+ * <p>A content block for displaying rich text.</p>
833
+ */
834
+ CONTENT_FIELD = 2,
835
+ /**
836
+ * <p>A spacer field.</p>
837
+ */
838
+ SPACER_FIELD = 3
839
+ }
840
+ namespace BlockTypeOption
841
+ {
842
+ /**
843
+ * <p>Gets the PascalCase name of the block type (e.g. ContentField).</p>
844
+ * @param value - <p>The enum value.</p>
845
+ */
846
+ function getName(value: componyx.UI.Form.BlockTypeOption): string;
847
+ }
848
+ /**
849
+ * <p>Input Type options</p>
850
+ */
851
+ enum InputTypeOption
852
+ {
853
+ /**
854
+ * <p>Simple single-line text input.</p>
855
+ */
856
+ TEXTBOX = 0,
857
+ /**
858
+ * <p>Multi-line text input.</p>
859
+ */
860
+ TEXTAREA = 1,
861
+ /**
862
+ * <p>Checkbox input, for binary options.</p>
863
+ */
864
+ CHECKBOX = 2,
865
+ /**
866
+ * <p>Radio button input, for selecting one option from a group.</p>
867
+ */
868
+ RADIO = 3,
869
+ /**
870
+ * <p>Checkbox as switch input, for selecting one option from a group.</p>
871
+ */
872
+ SWITCH = 4,
873
+ /**
874
+ * <p>Textbox input with masking (componyx.UI.MaskedTextBox).</p>
875
+ */
876
+ MASKEDTEXTBOX = 5,
877
+ /**
878
+ * <p>Input for numeric values (componyx.UI.NumericBox).</p>
879
+ */
880
+ NUMERICBOX = 6,
881
+ /**
882
+ * <p>Dropdown input (componyx.UI.ComboBox).</p>
883
+ */
884
+ COMBOBOX = 7,
885
+ /**
886
+ * <p>Date selector (componyx.UI.DatePicker).</p>
887
+ */
888
+ DATEPICKER = 8,
889
+ /**
890
+ * <p>Time selector (componyx.UI.TimePicker).</p>
891
+ */
892
+ TIMEPICKER = 9,
893
+ /**
894
+ * <p>Range slider (componyx.UI.Slider).</p>
895
+ */
896
+ SLIDER = 10,
897
+ /**
898
+ * <p>File upload control (componyx.UI.FileUpload).</p>
899
+ */
900
+ FILEUPLOAD = 11,
901
+ /**
902
+ * <p>Rich text editor (componyx.UI.Editor).</p>
903
+ */
904
+ EDITOR = 12
905
+ }
906
+ namespace InputTypeOption
907
+ {
908
+ /**
909
+ * <p>Gets the PascalCase name of the input type. Component input types return the component name (e.g. MaskedTextBox, DatePicker).</p>
910
+ * @param value - <p>The enum value.</p>
911
+ */
912
+ function getName(value: componyx.UI.Form.InputTypeOption): string;
913
+ }
914
+ /**
915
+ * <p>Display Type options</p>
916
+ */
917
+ enum DisplayModeOption
918
+ {
919
+ /**
920
+ * <p>Editable mode for user input.</p>
921
+ */
922
+ EDIT = 0,
923
+ /**
924
+ * <p>View-only mode, for displaying data.</p>
925
+ */
926
+ VIEW = 1,
927
+ /**
928
+ * <p>Build mode, for constructing and designing the form.</p>
929
+ */
930
+ BUILD = 2,
931
+ /**
932
+ * <p>Preview mode. Similar to editable mode but with header.</p>
933
+ */
934
+ PREVIEW = 3
935
+ }
936
+ /**
937
+ * <p>FieldSet Layout options</p>
938
+ */
939
+ enum FieldSetLayoutOption
940
+ {
941
+ /**
942
+ * <p>No visible layout applied. Fields appear directly in the form.</p>
943
+ */
944
+ NONE = 0,
945
+ /**
946
+ * <p>Default fieldset appearance with a thin border and a legend at the top.</p>
947
+ */
948
+ DEFAULT = 1,
949
+ /**
950
+ * <p>Section with a full-width banner header above the fields, giving it a modern look.</p>
951
+ */
952
+ BANNERED = 2
953
+ }
954
+ /**
955
+ * <p>Rule Case triggers.</p>
956
+ */
957
+ enum RuleCaseTriggerOption
958
+ {
959
+ /**
960
+ * <p>The RuleCase runs both on form initialization and when dependent fields change.</p>
961
+ */
962
+ ALWAYS = "always",
963
+ /**
964
+ * <p>The RuleCase runs once when the form initializes.</p>
965
+ */
966
+ INIT = "init",
967
+ /**
968
+ * <p>The RuleCase runs whenever dependent fields change.</p>
969
+ */
970
+ CHANGE = "change",
971
+ /**
972
+ * <p>The RuleCase runs when the corresponding section becomes visible.</p>
973
+ */
974
+ SHOW_SECTION = "show_section",
975
+ /**
976
+ * <p>The RuleCase runs when before the form is being submitted.</p>
977
+ */
978
+ BEFORE_SUBMIT = "before_submit",
979
+ /**
980
+ * <p>The RuleCase runs when the form submit was successful.</p>
981
+ */
982
+ SUBMIT_SUCCEEDED = "submit_succeeded",
983
+ /**
984
+ * <p>The RuleCase runs when the form submit was unsuccessful</p>
985
+ */
986
+ SUBMIT_FAILED = "submit_failed"
987
+ }
988
+ /**
989
+ * <p>Rule Case run options.</p>
990
+ */
991
+ enum RuleCaseRunVisibilityOption
992
+ {
993
+ /**
994
+ * <p>The RuleCase runs only when field is visible.</p>
995
+ */
996
+ VISIBLE = "visible",
997
+ /**
998
+ * <p>The RuleCase runs when field is hidden.</p>
999
+ */
1000
+ HIDDEN = "hidden",
1001
+ /**
1002
+ * <p>The RuleCase runs when even when the field's section is hidden.</p>
1003
+ */
1004
+ SECTION_HIDDEN = "section_hidden"
1005
+ }
1006
+ /**
1007
+ * <p>Comparison operators options</p>
1008
+ */
1009
+ enum RuleComparisonOperatorOption
1010
+ {
1011
+ EQUAL = "equal",
1012
+ NOT_EQUAL = "not_equal",
1013
+ GREATER_THAN = "greater_than",
1014
+ GREATER_THAN_OR_EQUAL = "greater_than_or_equal",
1015
+ LESS_THAN = "less_than",
1016
+ LESS_THAN_OR_EQUAL = "less_than_or_equal",
1017
+ CONTAINS = "contains",
1018
+ NOT_CONTAINS = "not_contains",
1019
+ STARTS_WITH = "starts_with",
1020
+ ENDS_WITH = "ends_with",
1021
+ EMPTY = "empty",
1022
+ NOT_EMPTY = "not_empty",
1023
+ VISIBLE = "visible",
1024
+ HIDDEN = "hidden",
1025
+ ENABLED = "enabled",
1026
+ DISABLED = "disabled",
1027
+ REQUIRED = "required",
1028
+ OPTIONAL = "optional"
1029
+ }
1030
+ /**
1031
+ * @property [headerTemplate] - <p>Gets or sets the header template.</p>
1032
+ * @property [footerTemplate] - <p>Gets or sets the footer template.</p>
1033
+ * @property [fieldSets] - <p>Gets or sets an array of field sets (nested field groupings).</p>
1034
+ */
1035
+ type BaseSetProperties = {
1036
+ headerTemplate?: HTMLElement | HTMLElement[] | DocumentFragment | string | null;
1037
+ footerTemplate?: HTMLElement | HTMLElement[] | DocumentFragment | string | null;
1038
+ fieldSets?: componyx.UI.Form.BaseSet[];
1039
+ };
1040
+ /**
1041
+ * @property [allowAsRoot] - <p>Gets or sets a value indicating if this field set can be used as a root element in the form.</p>
1042
+ * @property [layout] - <p>Gets or sets the layout of the field set.</p>
1043
+ * @property [repeatable] - <p>Gets or sets a value indicating if this field set is repeatable.</p>
1044
+ * @property [maxRepeats] - <p>Gets or sets a value indicating how many repeats are allowed for this field set. No value or zero means unlimited.</p>
1045
+ * @property [repeatLabel] - <p>Gets or sets the field set repeat label.</p>
1046
+ * @property [fields] - <p>Gets or sets the form fields that belong to the field set.</p>
1047
+ */
1048
+ type FieldSetProperties = {
1049
+ allowAsRoot?: boolean;
1050
+ layout?: componyx.UI.Form.FieldSetLayoutOption;
1051
+ repeatable?: boolean;
1052
+ maxRepeats?: number | null;
1053
+ repeatLabel?: string;
1054
+ fields?: componyx.UI.Form.BaseField[];
1055
+ };
1056
+ /**
1057
+ * @property [panelTemplates] - <p>Gets or sets the templates to render in each property panel. Maps property panel ids to template ids.</p>
1058
+ * @property [parent] - <p>The parent field if this set is part of another set.</p>
1059
+ * @property [id] - <p>Gets or sets the id of the field. The id is generated if it's not set.</p>
1060
+ * @property [name] - <p>Gets or sets the name of the field.</p>
1061
+ * @property [width] - <p>Gets or sets the width of the field.</p>
1062
+ * @property [cssClass] - <p>Gets or sets the CSS class of the field.</p>
1063
+ * @property [cssClassIcon] - <p>Gets or sets the CSS class of the field icon.</p>
1064
+ * @property [style] - <p>Gets or sets the CSS style of the field.</p>
1065
+ * @property [tooltip] - <p>Gets or sets the tooltip of the field.</p>
1066
+ * @property [visible] - <p>Gets a value indicating if the field is visible.</p>
1067
+ * @property [disabled] - <p>Gets a value indicating if the field is disabled.</p>
1068
+ * @property [label] - <p>Gets or sets the label of the field.</p>
1069
+ * @property [value] - <p>Gets or sets the value of the option.</p>
1070
+ * @property [lineBreak] - <p>Gets or sets a value indicating if the field moves to a new line.</p>
1071
+ * @property [viewTemplate] - <p>Gets or sets a custom template to display the field in view mode.</p>
1072
+ * @property [editTemplate] - <p>Gets or sets a custom template to display the field in edit mode.</p>
1073
+ * @property [element] - <p>Gets the rendered root element of the class.</p>
1074
+ * @property [componentSettings] - <p>Gets or sets the specific settings configured for the input type component.</p>
1075
+ */
1076
+ type BaseFieldProperties = {
1077
+ panelTemplates?: {
1078
+ [key: string]: string;
1079
+ } | null;
1080
+ parent?: componyx.UI.Form.BaseField | null;
1081
+ id?: string;
1082
+ name?: string;
1083
+ width?: string;
1084
+ cssClass?: string;
1085
+ cssClassIcon?: string;
1086
+ style?: string;
1087
+ tooltip?: string;
1088
+ visible?: boolean;
1089
+ disabled?: boolean;
1090
+ label?: string;
1091
+ value?: string;
1092
+ lineBreak?: boolean;
1093
+ viewTemplate?: HTMLElement | HTMLElement[] | DocumentFragment | string | null;
1094
+ editTemplate?: HTMLElement | HTMLElement[] | DocumentFragment | string | null;
1095
+ element?: HTMLElement | null;
1096
+ componentSettings?: componyx.UI.Form.ComponentSettings | null;
1097
+ };
1098
+ /**
1099
+ * @property [placeholder] - <p>Gets or sets the placeholder of the field for when it has no value.</p>
1100
+ * @property [labelDisplay = 3] - <p>Gets or sets the label display option of the field (above, before, floating, inside).</p>
1101
+ * @property [bindingKey] - <p>Gets or sets the data binding key of the field. Defaults to the field name if not set. Supports dot notation (e.g. &quot;user.address.street&quot;). Only applies when form.bindToCustomModel is true.</p>
1102
+ * @property [autoDataBind] - <p>Gets or sets a value indicating if the data binding (via Bindary) is automatically activated on this form field.</p>
1103
+ * @property [hideLabel] - <p>Gets or sets a value indicating if the label should be hidden. Ignored in build mode.</p>
1104
+ * @property [viewAsLabel] - <p>Gets or sets a value indicating if the field value is displayed as a label when in view mode.</p>
1105
+ * @property [inlineOptions = true] - <p>Gets or sets a value indicating whether options are displayed horizontally or stacked vertically.</p>
1106
+ * @property [optionWidth = auto] - <p>Gets or sets the width of a field option (auto, 50%, 33%, 25%, 20%). Only applies when inlineOptions is true.</p>
1107
+ * @property [options] - <p>Gets or sets the field options for input types CHECKBOX or RADIO.</p>
1108
+ * @property [inputType] - <p>Gets or sets the input type to render the editable field.</p>
1109
+ * @property [customType] - <p>Gets or sets the custom type of the form field.</p>
1110
+ * @property [dataSourceId] - <p>Gets or sets the id of the data source used for the field.</p>
1111
+ * @property [dataSourcePreview] - <p>Gets or sets a value indicating if the data source can be previewed in Form Build mode.</p>
1112
+ * @property [readOnly] - <p>Gets or sets a value indicating if the field is readonly.</p>
1113
+ * @property [required] - <p>Gets or sets a value indicating if the field is required.</p>
1114
+ * @property [validationSettings] - <p>Gets or sets the validation settings of the field.</p>
1115
+ * @property [ruleCases] - <p>Gets or sets a list of rule cases.</p>
1116
+ * @property [inputId] - <p>Gets or sets the id of the edit HTML Element or UI component from which attributes/settings are cloned.</p>
1117
+ * @property [viewElementId] - <p>Gets or sets the id of the view HTML Element from which attributes are cloned.</p>
1118
+ * @property [formFieldId] - <p>Gets or sets the id of the FormField component from which settings are cloned.</p>
1119
+ * @property [lineBreakElement] - <p>Gets the rendered line break element.</p>
1120
+ * @property [viewElement] - <p>Gets the rendered view element.</p>
1121
+ * @property [editElement] - <p>Gets the rendered edit element.</p>
1122
+ */
1123
+ type FieldProperties = {
1124
+ placeholder?: string;
1125
+ labelDisplay?: componyx.UI.FormField.LabelDisplayOption;
1126
+ bindingKey?: string;
1127
+ autoDataBind?: boolean;
1128
+ hideLabel?: boolean;
1129
+ viewAsLabel?: boolean;
1130
+ inlineOptions?: boolean;
1131
+ optionWidth?: string;
1132
+ options?: componyx.UI.Form.FieldOption;
1133
+ inputType?: componyx.UI.Form.InputTypeOption;
1134
+ customType?: string;
1135
+ dataSourceId?: string;
1136
+ dataSourcePreview?: boolean;
1137
+ readOnly?: boolean;
1138
+ required?: boolean;
1139
+ validationSettings?: ValidationSettings;
1140
+ ruleCases?: RuleCase[];
1141
+ inputId?: string;
1142
+ viewElementId?: string;
1143
+ formFieldId?: string;
1144
+ lineBreakElement?: HTMLElement;
1145
+ viewElement?: HTMLElement;
1146
+ editElement?: HTMLElement;
1147
+ };
1148
+ /**
1149
+ * @property [value] - <p>Gets or sets the value of the option.</p>
1150
+ * @property [selected] - <p>Gets or sets a value indicating if the option is selected/checked.</p>
1151
+ * @property [inputId] - <p>Gets or sets the id of the HTML Element from which attributes are cloned.</p>
1152
+ * @property [formFieldId] - <p>Gets or sets the id of the FormField component from which settings are cloned.</p>
1153
+ */
1154
+ type FieldOptionProperties = {
1155
+ value?: string;
1156
+ selected?: boolean;
1157
+ inputId?: string;
1158
+ formFieldId?: string;
1159
+ };
1160
+ /**
1161
+ * @property [trustHTML] - <p>Gets or sets a value indicating whether the HTML content of this field is trusted.</p>
1162
+ * @property [margin] - <p>Gets or sets the margin of the content field.</p>
1163
+ * @property [padding] - <p>Gets or sets the padding of the content field.</p>
1164
+ * @property [borderWidth] - <p>Gets or sets the border width of the content field.</p>
1165
+ * @property [borderRadius] - <p>Gets or sets the border radius of the content field.</p>
1166
+ * @property [borderColor] - <p>Gets or sets the border color of the content field.</p>
1167
+ * @property [backgroundColor] - <p>Gets or sets the background color of the content field.</p>
1168
+ */
1169
+ type ContentFieldProperties = {
1170
+ trustHTML?: string;
1171
+ margin?: string;
1172
+ padding?: string;
1173
+ borderWidth?: number | null;
1174
+ borderRadius?: string;
1175
+ borderColor?: string;
1176
+ backgroundColor?: string;
1177
+ };
1178
+ /**
1179
+ * @property [showDivider] - <p>Gets or sets a value indicating whether the divider line is rendered in the middle of the spacer.</p>
1180
+ * @property [height] - <p>Gets or sets the height of the spacer field.</p>
1181
+ */
1182
+ type SpacerFieldProperties = {
1183
+ showDivider?: string;
1184
+ height?: string;
1185
+ };
1186
+ /**
1187
+ * @property [panelId] - <p>Gets or sets the identifier of the panel in which the build block is placed. Item is placed in first Panel if not set.</p>
1188
+ * @property [blockType = 0] - <p>Gets or sets the type of the build block or null if it's a custom field. Defaults to an input field type.</p>
1189
+ * @property [inputType] - <p>Gets or sets the input type of the form field or null if it's a custom field.</p>
1190
+ * @property [customType] - <p>Gets or sets the custom type of the form field.</p>
1191
+ * @property [inputId] - <p>Gets or sets the id of the edit HTML Element or UI component from which attributes/settings are cloned.</p>
1192
+ * @property [fieldSet] - <p>Gets or sets the field set of the build block when type is set to FIELDSET.</p>
1193
+ */
1194
+ type BuildBlockProperties = {
1195
+ panelId?: string;
1196
+ blockType?: componyx.UI.Form.BlockTypeOption | null;
1197
+ inputType?: componyx.UI.Form.InputTypeOption | null;
1198
+ customType?: string;
1199
+ inputId?: string;
1200
+ fieldSet?: componyx.UI.Form.FieldSet;
1201
+ };
1202
+ /**
1203
+ * <p>Represents a field role.</p>
1204
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1205
+ * @param [properties.id] - <p>Gets or sets the id of the role.</p>
1206
+ * @param [properties.label] - <p>Gets or sets the label of the role.</p>
1207
+ * @param [properties.defaultValue] - <p>Gets or sets the default value of the role if desired.</p>
1208
+ * @param [properties.inputType] - <p>Gets or sets the field input type(s) for which this field role will be selectable.</p>
1209
+ */
1210
+ class FieldRole
1211
+ {
1212
+ constructor(properties?: {
1213
+ id?: string;
1214
+ label?: string;
1215
+ defaultValue?: string;
1216
+ inputType?: componyx.UI.Form.InputTypeOption | componyx.UI.Form.InputTypeOption[] | null;
1217
+ });
1218
+ /**
1219
+ * <p>Gets or sets the id of the role.</p>
1220
+ */
1221
+ id: string;
1222
+ /**
1223
+ * <p>Gets or sets the label of the role.</p>
1224
+ */
1225
+ label: string;
1226
+ /**
1227
+ * <p>Gets or sets the default value of the role if desired.</p>
1228
+ */
1229
+ defaultValue: any;
1230
+ /**
1231
+ * <p>Gets or sets the field input type(s) for which this field role will be selectable.</p>
1232
+ */
1233
+ inputType: componyx.UI.Form.InputTypeOption | componyx.UI.Form.InputTypeOption[] | null;
1234
+ }
1235
+ /**
1236
+ * <p>The Form ServerEndpoint class.</p>
1237
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1238
+ * @param properties.id - <p>Gets or sets the identifier of the item.</p>
1239
+ * @param properties.label - <p>Gets or sets the label of the item.</p>
1240
+ * @param properties.absoluteURL - <p>Gets or sets a value indicating whether the URL is absolute or relative.</p>
1241
+ * @param properties.url - <p>Gets or sets the API endpoint for file uploads or data requests.</p>
1242
+ * @param properties.method - <p>Gets or sets the HTTP method used for requests (e.g., &quot;POST&quot;, &quot;GET&quot;).</p>
1243
+ * @param properties.headers - <p>Gets or sets the request headers for the API call.</p>
1244
+ * @param properties.params - <p>Gets or sets additional parameters sent with the request.</p>
1245
+ * @param properties.timeout - <p>Gets or sets the timeout in milliseconds for the request.</p>
1246
+ * @param properties.credentials - <p>Gets or sets the credentials mode for the fetch request.</p>
1247
+ * @param properties.responseType - <p>Gets or sets the expected response type ('json', 'text', 'blob').</p>
1248
+ * @param properties.preFetch - <p>Gets or sets the hook executed before the fetch request.</p>
1249
+ * @param properties.postFetch - <p>Gets or sets the hook executed after the fetch request completes.</p>
1250
+ */
1251
+ class ServerEndpoint
1252
+ {
1253
+ constructor(properties?: {
1254
+ id: string;
1255
+ label: string;
1256
+ absoluteURL: boolean;
1257
+ url: string;
1258
+ method: string;
1259
+ headers: any;
1260
+ params: any;
1261
+ timeout: number | null;
1262
+ credentials: string;
1263
+ responseType: string;
1264
+ preFetch: ((...params: any[]) => any) | null;
1265
+ postFetch: ((...params: any[]) => any) | null;
1266
+ });
1267
+ /**
1268
+ * <p>Gets or sets the id of the item.</p>
1269
+ */
1270
+ id: string;
1271
+ /**
1272
+ * <p>Gets or sets the label of the item.</p>
1273
+ */
1274
+ label: string;
1275
+ /**
1276
+ * <p>Gets or sets a value indicating whether the URL is absolute or relative.</p>
1277
+ */
1278
+ absoluteURL: boolean;
1279
+ /**
1280
+ * <p>Gets or sets the API endpoint for file uploads or data requests.</p>
1281
+ */
1282
+ url: string;
1283
+ /**
1284
+ * <p>Gets or sets the HTTP method used for requests (e.g., &quot;POST&quot;, &quot;GET&quot;).</p>
1285
+ */
1286
+ method: string;
1287
+ /**
1288
+ * <p>Gets or sets the request headers for the API call.</p>
1289
+ */
1290
+ headers: any;
1291
+ /**
1292
+ * <p>Gets or sets additional parameters sent with the request.</p>
1293
+ */
1294
+ params: any;
1295
+ /**
1296
+ * <p>Gets or sets the timeout in milliseconds for the request. If null, no timeout is applied.</p>
1297
+ */
1298
+ timeout: number | null;
1299
+ /**
1300
+ * <p>Gets or sets the credentials mode for the fetch request. E.g., 'same-origin', 'include', or 'omit'.</p>
1301
+ */
1302
+ credentials: string;
1303
+ /**
1304
+ * <p>Gets or sets the expected response type. Determines how the fetch response is parsed.
1305
+ * Supported values: 'json', 'text', 'blob'.</p>
1306
+ */
1307
+ responseType: string;
1308
+ /**
1309
+ * <p>Gets or sets the optional hook executed before the fetch request. Can be used to modify the request parameters or context.</p>
1310
+ */
1311
+ preFetch: ((...params: any[]) => any) | null;
1312
+ /**
1313
+ * <p>Gets or sets the optional hook executed after the fetch request completes. Can be used to handle the result or update the context.</p>
1314
+ */
1315
+ postFetch: (...params: any[]) => any;
1316
+ }
1317
+ /**
1318
+ * <p>The Form DataSource class.</p>
1319
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1320
+ * @param properties.inputType - <p>Gets or sets the supported input type(s) of the data source; matched by strict equality or inclusion if array.</p>
1321
+ */
1322
+ class DataSource extends ServerEndpoint
1323
+ {
1324
+ constructor(properties?: {
1325
+ inputType: componyx.UI.Form.InputTypeOption | componyx.UI.Form.InputTypeOption[];
1326
+ });
1327
+ /**
1328
+ * <p>Gets or sets the supported input type(s) of the data source; matched by strict equality or inclusion if array.</p>
1329
+ */
1330
+ inputType: componyx.UI.Form.InputTypeOption | componyx.UI.Form.InputTypeOption[] | null;
1331
+ }
1332
+ /**
1333
+ * <p>The base class that holds the type property so the type can be converted back to class instance after JSON serialization.</p>
1334
+ */
1335
+ class BaseType
1336
+ {
1337
+ /**
1338
+ * <p>Gets the parent fieldSet or Section.</p>
1339
+ */
1340
+ parent?: BaseType | null;
1341
+ /**
1342
+ * <p>Gets the name of the class, required for identifying the object type when stored as JSON data.</p>
1343
+ */
1344
+ readonly type: string;
1345
+ }
1346
+ /**
1347
+ * <p>The base class for all form field and fieldSet types.</p>
1348
+ */
1349
+ class BaseField extends BaseType
1350
+ {
1351
+ /**
1352
+ * <p>Gets or sets the templates to render in each property panel. Maps property panel ids to template ids.</p>
1353
+ */
1354
+ panelTemplates: {
1355
+ [key: string]: string;
1356
+ } | null;
1357
+ /**
1358
+ * <p>Gets or sets the id of the field. The id is generated if it's not set.</p>
1359
+ */
1360
+ id: string;
1361
+ /**
1362
+ * <p>Gets or sets the name of the field.</p>
1363
+ */
1364
+ name: string;
1365
+ /**
1366
+ * <p>Gets or sets the width of the field.</p>
1367
+ */
1368
+ width: string;
1369
+ /**
1370
+ * <p>Gets or sets the id of the custom template to display the field in view mode.</p>
1371
+ */
1372
+ viewTemplateId: string | null;
1373
+ /**
1374
+ * <p>Gets or sets the id of the custom template to display the field in edit mode.</p>
1375
+ */
1376
+ editTemplateId: string | null;
1377
+ /**
1378
+ * <p>Gets or sets the CSS class of the field.</p>
1379
+ */
1380
+ cssClass: string;
1381
+ /**
1382
+ * <p>Gets or sets the CSS class of the field icon.</p>
1383
+ */
1384
+ cssClassIcon: string;
1385
+ /**
1386
+ * <p>Gets or sets the CSS style of the field.</p>
1387
+ */
1388
+ style: string;
1389
+ /**
1390
+ * <p>Gets or sets the tooltip of the field.</p>
1391
+ */
1392
+ tooltip: string;
1393
+ /**
1394
+ * <p>Gets a value indicating if the field is visible.</p>
1395
+ */
1396
+ visible: boolean;
1397
+ /**
1398
+ * <p>Gets a value indicating if the field is disabled.</p>
1399
+ */
1400
+ disabled: boolean;
1401
+ /**
1402
+ * <p>Gets or sets the label of the field.</p>
1403
+ */
1404
+ label: string;
1405
+ /**
1406
+ * <p>Gets or sets the value of the option.</p>
1407
+ */
1408
+ value: string;
1409
+ /**
1410
+ * <p>Gets or sets a value indicating if the field moves to a new line.</p>
1411
+ */
1412
+ lineBreak: boolean;
1413
+ /**
1414
+ * <p>Gets or sets a custom template to display the field in view mode.</p>
1415
+ */
1416
+ viewTemplate: HTMLElement | HTMLElement[] | DocumentFragment | string | null;
1417
+ /**
1418
+ * <p>Gets or sets a custom template to display the field in edit mode.</p>
1419
+ */
1420
+ editTemplate: HTMLElement | HTMLElement[] | DocumentFragment | string | null;
1421
+ /**
1422
+ * <p>Gets or sets the specific settings configured for the input type component.</p>
1423
+ */
1424
+ componentSettings: ComponentSettings | null;
1425
+ /**
1426
+ * <p>Gets the rendered root element.</p>
1427
+ */
1428
+ element: HTMLElement | null;
1429
+ /**
1430
+ * <p>Gets the rendered line break element.</p>
1431
+ */
1432
+ lineBreakElement: HTMLElement | null;
1433
+ }
1434
+ /**
1435
+ * <p>The base class for form field sets (Section, FieldSet).</p>
1436
+ */
1437
+ class BaseSet extends BaseField
1438
+ {
1439
+ /**
1440
+ * <p>Gets or sets the header template.</p>
1441
+ */
1442
+ headerTemplate: HTMLElement | HTMLElement[] | DocumentFragment | string | null;
1443
+ /**
1444
+ * <p>Gets or sets the footer template.</p>
1445
+ */
1446
+ footerTemplate: HTMLElement | HTMLElement[] | DocumentFragment | string | null;
1447
+ /**
1448
+ * <p>Gets or sets an array of field sets (nested field groupings).</p>
1449
+ */
1450
+ fieldSets: componyx.UI.Form.BaseSet[];
1451
+ }
1452
+ /**
1453
+ * <p>The Form BuildItem class.</p>
1454
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1455
+ */
1456
+ class BuildBlock extends BaseField
1457
+ {
1458
+ constructor(properties?: BaseFieldProperties & BuildBlockProperties);
1459
+ /**
1460
+ * <p>Gets or sets the type of the build block or null if it's a custom field. Defaults to input field type.</p>
1461
+ */
1462
+ blockType: componyx.UI.Form.BlockTypeOption | null;
1463
+ /**
1464
+ * <p>Gets or sets the input type of the form field or null if it's a custom field.</p>
1465
+ */
1466
+ inputType: componyx.UI.Form.InputTypeOption | null;
1467
+ /**
1468
+ * <p>Gets or sets the custom type of the form field.</p>
1469
+ */
1470
+ customType: string | null;
1471
+ /**
1472
+ * <p>Gets or sets the identifier of the panel in which the build block is placed.</p>
1473
+ */
1474
+ panelId: string;
1475
+ /**
1476
+ * <p>Gets or sets the id of the edit HTML Element or UI component from which the attributes/settings are cloned.</p>
1477
+ */
1478
+ inputId: string | null;
1479
+ /**
1480
+ * <p>Gets or sets the field set of the build block when type is set to FIELDSET.</p>
1481
+ */
1482
+ fieldSet: componyx.UI.Form.FieldSet | null;
1483
+ }
1484
+ /**
1485
+ * <p>The Form Section class.</p>
1486
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1487
+ */
1488
+ class Section extends BaseSet
1489
+ {
1490
+ constructor(properties?: BaseFieldProperties & BaseSetProperties);
1491
+ }
1492
+ /**
1493
+ * <p>The Form FieldSet class.</p>
1494
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1495
+ */
1496
+ class FieldSet extends BaseSet
1497
+ {
1498
+ constructor(properties?: BaseFieldProperties & BaseSetProperties & FieldSetProperties);
1499
+ /**
1500
+ * <p>Gets or sets a value indicating if this field set can be used as a root element in the form.</p>
1501
+ */
1502
+ allowAsRoot: boolean;
1503
+ /**
1504
+ * <p>Gets or sets the layout of the field set.</p>
1505
+ */
1506
+ layout: Form.FieldSetLayoutOption;
1507
+ /**
1508
+ * <p>Gets or sets a value indicating if this field set is repeatable.</p>
1509
+ */
1510
+ repeatable: boolean;
1511
+ /**
1512
+ * <p>Gets the field set repeat label.</p>
1513
+ */
1514
+ repeatLabel: string;
1515
+ /**
1516
+ * <p>Gets or sets how many repeats are allowed for this field set. No value or zero means unlimited repeats.</p>
1517
+ */
1518
+ maxRepeats: number | null;
1519
+ /**
1520
+ * <p>Gets or sets the form fields that belong to the field set.</p>
1521
+ */
1522
+ fields: componyx.UI.Form.BaseField[];
1523
+ }
1524
+ /**
1525
+ * <p>The Form Field class.</p>
1526
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1527
+ */
1528
+ class Field extends BaseField
1529
+ {
1530
+ constructor(properties?: BaseFieldProperties & FieldProperties);
1531
+ /**
1532
+ * <p>Gets or sets the role identifier for the field, defining its purpose or behavior.</p>
1533
+ */
1534
+ role: string;
1535
+ /**
1536
+ * <p>Gets or sets the placeholder of the field for when it has no value.</p>
1537
+ */
1538
+ placeholder: string;
1539
+ /**
1540
+ * <p>Gets or sets the label display option of the field (above, before, floating, inside).</p>
1541
+ */
1542
+ labelDisplay: componyx.UI.FormField.LabelDisplayOption;
1543
+ /**
1544
+ * <p>Gets or sets the data binding key of the field. If not provided, the field name is used as the key.</p>
1545
+ */
1546
+ bindingKey: string;
1547
+ /**
1548
+ * <p>Gets or sets a value indicating if the data binding (via Bindary) is automatically activated on this form field.</p>
1549
+ */
1550
+ autoDataBind: boolean | null;
1551
+ /**
1552
+ * <p>Gets or sets a value indicating if the label should be hidden. Setting is ignored in build mode.</p>
1553
+ */
1554
+ hideLabel: boolean | null;
1555
+ /**
1556
+ * <p>Gets or sets a value indicating if the field value is displayed as a label when in view mode.</p>
1557
+ */
1558
+ viewAsLabel: boolean;
1559
+ /**
1560
+ * <p>Gets or sets a value indicating whether options are displayed horizontally or stacked vertically.</p>
1561
+ */
1562
+ inlineOptions: boolean;
1563
+ /**
1564
+ * <p>Gets or sets the width of a field option (auto - sized by content; 50% - 2 per row; 33% - 3 per row; 25% - 4 per row; 20% - 5 per row).</p>
1565
+ */
1566
+ optionWidth: string;
1567
+ /**
1568
+ * <p>Gets or sets the field options for when the input type is set to CHECKBOX or RADIO.</p>
1569
+ */
1570
+ options: componyx.UI.Form.FieldOption[];
1571
+ /**
1572
+ * <p>Gets or sets the input type to render the editable field.</p>
1573
+ */
1574
+ inputType: componyx.UI.Form.InputTypeOption | null;
1575
+ /**
1576
+ * <p>Gets or sets the custom type of the form field.</p>
1577
+ */
1578
+ customType: string | null;
1579
+ /**
1580
+ * <p>Gets or sets the id of the data source used for the field.</p>
1581
+ */
1582
+ dataSourceId: string | null;
1583
+ /**
1584
+ * <p>Gets or sets a value indicating if the data source can be previewed in the Form Build mode.</p>
1585
+ */
1586
+ dataSourcePreview: boolean;
1587
+ /**
1588
+ * <p>Gets a value indicating if the field is readonly.</p>
1589
+ */
1590
+ readOnly: boolean;
1591
+ /**
1592
+ * <p>Gets or sets a value indicating if the field is required.</p>
1593
+ */
1594
+ required: boolean;
1595
+ /**
1596
+ * <p>Gets or sets the validation settings of the field.</p>
1597
+ */
1598
+ validationSettings: ValidationSettings;
1599
+ /**
1600
+ * <p>Gets or sets a list of rule cases.</p>
1601
+ */
1602
+ ruleCases: RuleCase[];
1603
+ /**
1604
+ * <p>Gets or sets the id of the edit HTML Element (TextBox, TextArea) or UI component from which the attributes/settings are cloned.</p>
1605
+ */
1606
+ inputId: string | null;
1607
+ /**
1608
+ * <p>Gets or sets the id of the view HTML Element from which the attributes are cloned.</p>
1609
+ */
1610
+ viewElementId: string | null;
1611
+ /**
1612
+ * <p>Gets or sets the id of the FormField component from which the settings are cloned.</p>
1613
+ */
1614
+ formFieldId: string | null;
1615
+ /**
1616
+ * <p>Gets the rendered view element.</p>
1617
+ */
1618
+ viewElement: HTMLElement | null;
1619
+ /**
1620
+ * <p>Gets the rendered edit element.</p>
1621
+ */
1622
+ editElement: HTMLElement | null;
1623
+ /**
1624
+ * <p>Gets the rendered edit component.</p>
1625
+ */
1626
+ renderedEditComponent: componyx.UI.base.Component | componyx.UI.base.WebComponent | HTMLElement;
1627
+ }
1628
+ /**
1629
+ * <p>The Form FieldOption class.</p>
1630
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1631
+ */
1632
+ class FieldOption extends BaseField
1633
+ {
1634
+ constructor(properties?: BaseFieldProperties & FieldOptionProperties);
1635
+ /**
1636
+ * <p>Gets or sets a value indicating if the option is selected/checked.</p>
1637
+ */
1638
+ selected: boolean;
1639
+ /**
1640
+ * <p>Gets or sets the id of the HTML Element from which the attributes are cloned.</p>
1641
+ */
1642
+ inputId: string | null;
1643
+ /**
1644
+ * <p>Gets or sets the id of the FormField component from which the settings are cloned.</p>
1645
+ */
1646
+ formFieldId: string | null;
1647
+ }
1648
+ /**
1649
+ * <p>The Form ContentField class.</p>
1650
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1651
+ */
1652
+ class ContentField extends BaseField
1653
+ {
1654
+ constructor(properties?: BaseFieldProperties & ContentFieldProperties);
1655
+ /**
1656
+ * <p>Gets or sets a value indicating whether the HTML content of this field is trusted.</p>
1657
+ */
1658
+ trustHTML: boolean;
1659
+ /**
1660
+ * <p>Gets or sets the margin of the content field.</p>
1661
+ */
1662
+ margin: string | null;
1663
+ /**
1664
+ * <p>Gets or sets the padding of the content field.</p>
1665
+ */
1666
+ padding: string | null;
1667
+ /**
1668
+ * <p>Gets or sets the border width of the content field.</p>
1669
+ */
1670
+ borderWidth: number | null;
1671
+ /**
1672
+ * <p>Gets or sets the border radius of the content field.</p>
1673
+ */
1674
+ borderRadius: string | null;
1675
+ /**
1676
+ * <p>Gets or sets the border color of the content field.</p>
1677
+ */
1678
+ borderColor: string | null;
1679
+ /**
1680
+ * <p>Gets or sets the background color of the content field.</p>
1681
+ */
1682
+ backgroundColor: string | null;
1683
+ }
1684
+ /**
1685
+ * <p>The Form SpacerField class.</p>
1686
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1687
+ */
1688
+ class SpacerField extends BaseField
1689
+ {
1690
+ constructor(properties?: BaseFieldProperties & SpacerFieldProperties);
1691
+ /**
1692
+ * <p>Gets or sets a value indicating whether the divider line is rendered in the middle of the spacer.</p>
1693
+ */
1694
+ showDivider: boolean;
1695
+ /**
1696
+ * <p>Gets or sets the height of the spacer field.</p>
1697
+ */
1698
+ height: string | null;
1699
+ }
1700
+ /**
1701
+ * <p>The Form ValidationSettings class.</p>
1702
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1703
+ * @param [properties.dataType] - <p>Gets or sets the expected data type of the field. INTEGER: 0, FLOAT: 1, DATETIME: 2, EMAIL: 3, URL: 4, SOURCE: 5</p>
1704
+ * @param [properties.compareFieldId] - <p>Gets or sets the comparison field identifier for the field.</p>
1705
+ * @param [properties.compareOperator] - <p>Gets or sets the comparison operator for the field.</p>
1706
+ * @param [properties.minLength] - <p>Gets or sets the minimum length allowed for the field value.</p>
1707
+ * @param [properties.maxLength] - <p>Gets or sets the maximum length allowed for the field value.</p>
1708
+ * @param [properties.minRange] - <p>Gets or sets the minimum range allowed for the field value.</p>
1709
+ * @param [properties.maxRange] - <p>Gets or sets the maximum range allowed for the field value.</p>
1710
+ * @param [properties.pattern] - <p>Gets or sets the regex pattern that the field value must match.</p>
1711
+ */
1712
+ class ValidationSettings extends BaseType
1713
+ {
1714
+ constructor(properties?: {
1715
+ dataType?: number;
1716
+ compareFieldId?: string;
1717
+ compareOperator?: string;
1718
+ minLength?: number;
1719
+ maxLength?: number;
1720
+ minRange?: number;
1721
+ maxRange?: number;
1722
+ pattern?: string;
1723
+ });
1724
+ /**
1725
+ * <p>Gets or sets the expected data type of the field. INTEGER: 0, FLOAT: 1, DATETIME: 2, EMAIL: 3, URL: 4, SOURCE: 5</p></p>
1726
+ */
1727
+ dataType?: number | null;
1728
+ /**
1729
+ * <p>Gets or sets the comparison field identifier for the field.</p>
1730
+ */
1731
+ compareFieldId?: string | any | null;
1732
+ /**
1733
+ * <p>Gets or sets the comparison operator for the field.</p>
1734
+ */
1735
+ compareOperator?: string | null;
1736
+ /**
1737
+ * <p>Gets or sets the minimum length allowed for the field value.</p>
1738
+ */
1739
+ minLength?: number | null;
1740
+ /**
1741
+ * <p>Gets or sets the maximum length allowed for the field value.</p>
1742
+ */
1743
+ maxLength?: number | null;
1744
+ /**
1745
+ * <p>Gets or sets the minimum range allowed for the field value.</p>
1746
+ */
1747
+ minRange?: number | null;
1748
+ /**
1749
+ * <p>Gets or sets the maximum range allowed for the field value.</p>
1750
+ */
1751
+ maxRange?: number | null;
1752
+ /**
1753
+ * <p>Gets or sets the regex pattern that the field value must match.</p>
1754
+ */
1755
+ pattern?: string | null;
1756
+ }
1757
+ /**
1758
+ * <p>The Form Command class.</p>
1759
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1760
+ * @param [properties.id] - <p>Gets or sets the id of the command. The id is generated if it's not set.</p>
1761
+ * @param [properties.command] - <p>Gets or sets the command that the button triggers (e.g. 'undo', 'redo').</p>
1762
+ * @param [properties.isVisible] - <p>Gets or sets a predicate function that returns <code>true</code> when this button should be shown. No value set means always visible.</p>
1763
+ * @param [properties.isEnabled] - <p>Gets or sets a predicate function that returns <code>true</code> when this button should be enabled; return <code>false</code> to disable it. No value set means always enabled.</p>
1764
+ * @param [properties.shortcutKey] - <p>Gets or sets the keyboard shortcut key in combination with the CTRL key for this button (e.g. 'z' for undo).</p>
1765
+ * @param [properties.cssClass = ''] - <p>Gets or sets the CSS class name for the button.</p>
1766
+ * @param [properties.cssClassIcon = 'ico-undo'] - <p>Gets or sets the CSS class name for the icon to display.</p>
1767
+ * @param [properties.events = null] - <p>Gets or sets the events of the button component.</p>
1768
+ * @param [properties.buttonId = null] - <p>Gets or sets the id of the button component from which the settings are cloned.</p>
1769
+ */
1770
+ class Command
1771
+ {
1772
+ constructor(properties?: {
1773
+ id?: string;
1774
+ command?: string | ((...params: any[]) => any);
1775
+ isVisible?: (...params: any[]) => any;
1776
+ isEnabled?: (...params: any[]) => any;
1777
+ shortcutKey?: string;
1778
+ cssClass?: string;
1779
+ cssClassIcon?: string;
1780
+ events?: any;
1781
+ buttonId?: string | null;
1782
+ });
1783
+ /**
1784
+ * <p>Gets or sets the id of the command. The id is generated if it's not set.</p>
1785
+ */
1786
+ id: string | null;
1787
+ /**
1788
+ * <p>Gets or sets the command to execute.</p>
1789
+ */
1790
+ command: ((...params: any[]) => any) | null;
1791
+ /**
1792
+ * <p>Gets or sets a predicate function that returns <code>true</code> when this button should be shown.</p>
1793
+ */
1794
+ isVisible: ((...params: any[]) => any) | null;
1795
+ /**
1796
+ * <p>Gets or sets a predicate function that returns <code>true</code> when this button should be enabled; return <code>false</code> to disable it.</p>
1797
+ */
1798
+ isEnabled: ((...params: any[]) => any) | null;
1799
+ /**
1800
+ * <p>Gets or sets the keyboard shortcut key in combination with the CTRL key for this button (e.g. 'z' for undo).</p>
1801
+ */
1802
+ shortcutKey: string;
1803
+ /**
1804
+ * <p>Gets or sets the CSS class name for the button.</p>
1805
+ */
1806
+ cssClass: string;
1807
+ /**
1808
+ * <p>Gets or sets the CSS class name for the icon to display.</p>
1809
+ */
1810
+ cssClassIcon: string;
1811
+ /**
1812
+ * <p>Gets or sets the location of the command button.</p>
1813
+ */
1814
+ location: Form.CommandLocationOption;
1815
+ /**
1816
+ * <p>Gets or sets the events of the button component.</p>
1817
+ */
1818
+ events: any | null;
1819
+ /**
1820
+ * <p>Gets or sets the id of the button component from which the settings are cloned.</p>
1821
+ */
1822
+ buttonId: string | null;
1823
+ }
1824
+ /**
1825
+ * <p>The RuleCase class represents a case of rules that result in actions.</p>
1826
+ */
1827
+ class RuleCase extends BaseType
1828
+ {
1829
+ /**
1830
+ * <p>Gets or sets the id. The id is generated if it's not set.</p>
1831
+ */
1832
+ id: string;
1833
+ /**
1834
+ * <p>Gets or sets the trigger of the RuleCase. Determines when this case executes.</p>
1835
+ */
1836
+ trigger: RuleCaseTriggerOption;
1837
+ /**
1838
+ * <p>Gets or sets a value indicating if this rule case is run when the field is visible (default), hidden or when even it's section is hidden.</p>
1839
+ */
1840
+ runVisibility: RuleCaseRunVisibilityOption;
1841
+ /**
1842
+ * <p>Gets or sets the array of RuleGroup objects in this case.</p>
1843
+ */
1844
+ ruleGroups: RuleGroup[];
1845
+ /**
1846
+ * <p>Gets or sets a list of actions to execute when the rule condition is met. Each action is an object with a type and optional value.</p>
1847
+ */
1848
+ actions: Action[];
1849
+ }
1850
+ /**
1851
+ * <p>The RuleGroup class represents a group of rules combined with a logical operator.</p>
1852
+ */
1853
+ class RuleGroup extends BaseType
1854
+ {
1855
+ /**
1856
+ * <p>Gets or sets the id. The id is generated if it's not set.</p>
1857
+ */
1858
+ id: string;
1859
+ /**
1860
+ * <p>Gets or sets the array of Rule objects in this group.</p>
1861
+ */
1862
+ rules: Rule[];
1863
+ /**
1864
+ * <p>Gets or sets the logical operator to combine the rules: 'AND' or 'OR'.</p>
1865
+ */
1866
+ logicalOperator: string;
1867
+ }
1868
+ /**
1869
+ * <p>The Rule class represents a single conditional rule for a field.</p>
1870
+ */
1871
+ class Rule extends BaseType
1872
+ {
1873
+ /**
1874
+ * <p>Gets or sets the id. The id is generated if it's not set.</p>
1875
+ */
1876
+ id: string;
1877
+ /**
1878
+ * <p>Gets or sets the id of the field/fieldset that this rule applies to.</p>
1879
+ */
1880
+ sourceId: string | null;
1881
+ /**
1882
+ * <p>Gets or sets the logical operator to combine the rules: 'AND' or 'OR'.</p>
1883
+ */
1884
+ logicalOperator: string | null;
1885
+ /**
1886
+ * <p>Gets or sets the comparison operator for evaluation (e.g., equals, greater than).</p>
1887
+ */
1888
+ comparisonOperator: RuleComparisonOperatorOption;
1889
+ /**
1890
+ * <p>Gets or sets the value to compare against.</p>
1891
+ */
1892
+ value: any;
1893
+ /**
1894
+ * <p>Gets or sets a value indicating if the set value is the end value of a range.</p>
1895
+ */
1896
+ isRangeEnd: boolean;
1897
+ }
1898
+ /**
1899
+ * <p>Represents an action to execute when a rule case condition is met.</p>
1900
+ * @param [properties] - <p>The properties used to initialize the object.</p>
1901
+ * @param [properties.id] - <p>Gets or sets the id of the action.</p>
1902
+ * @param [properties.runtimeActionId] - <p>Gets or sets the unique id of the registered runtime action to execute.</p>
1903
+ * @param [properties.targetFieldSetId] - <p>Gets or sets the id of the target field set.</p>
1904
+ * @param [properties.value] - <p>Gets or sets the value associated with the action.</p>
1905
+ */
1906
+ class Action extends BaseType
1907
+ {
1908
+ constructor(properties?: {
1909
+ id?: string;
1910
+ runtimeActionId?: string;
1911
+ targetFieldSetId?: any;
1912
+ value?: any;
1913
+ });
1914
+ /**
1915
+ * <p>Gets or sets the id of the action.</p>
1916
+ */
1917
+ id: string;
1918
+ /**
1919
+ * <p>Gets or sets the unique id of the registered runtime action to execute.</p>
1920
+ */
1921
+ runtimeActionId: string;
1922
+ /**
1923
+ * <p>Gets or sets the id of the target field set.</p>
1924
+ */
1925
+ targetFieldSetId: string;
1926
+ /**
1927
+ * <p>Gets or sets the value associated with the action.</p>
1928
+ */
1929
+ value: any;
1930
+ }
1931
+ }
1932
+
1933
+ interface Form extends Omit<componyx.UI.base.methods, 'render' | 'postRender' | 'destroy' | 'cloneProperties'> { }
1934
+ /**
1935
+ * <p>Form class.</p>
1936
+ */
1937
+ class Form extends componyx.UI.base.WebComponent
1938
+ {
1939
+ /**
1940
+ * Creates a new Form instance.
1941
+ * @param id - <p>The id of the component.</p>
1942
+ * @param properties - <p>The properties used to initialize the component or the container element.</p>
1943
+ */
1944
+ constructor(id?: string, properties?: Partial<Form> | HTMLElement);
1945
+ /**
1946
+ * <p>Internal CSS class name constants.
1947
+ * You can override any of these classes on the Component instance by defining a property named
1948
+ * <code>cssClass&lt;Key&gt;</code> where &lt;Key&gt; is the PascalCase key from this object.
1949
+ * Example:
1950
+ * 'BUILD_PANE' -&gt; 'cssClassBuildPane'
1951
+ * Be cautious: overriding these classes without including the default names may break styling and functionality.</p>
1952
+ */
1953
+ readonly classOption: componyx.UI.Form.ClassOption;
1954
+ /**
1955
+ * <p>Gets or sets the tab index of the form element. A value is required so the form can receive focus programmatically, enabling its keyboard shortcuts.</p>
1956
+ */
1957
+ tabIndex: number;
1958
+ /**
1959
+ * <p>Gets or sets the format configuration for dates and numbers.</p>
1960
+ */
1961
+ format: componyx.UI.Form.FormatConfig;
1962
+ /**
1963
+ * <p>Gets or sets a value indicating whether the display is in build, edit or view mode.</p>
1964
+ */
1965
+ displayMode: componyx.UI.Form.DisplayModeOption;
1966
+ /**
1967
+ * <p>Gets or sets a value indicating whether the label is displayed automatically, inside, above, before or after the form input field.</p>
1968
+ */
1969
+ labelDisplay: componyx.UI.FormField.LabelDisplayOption;
1970
+ /**
1971
+ * <p>Gets or sets a value indicating if the form uses a fixed layout with always-visible side panes and header. Useful when embedding the form in full-page layouts.</p>
1972
+ */
1973
+ fixedLayout: boolean;
1974
+ /**
1975
+ * <p>Gets or sets a value indicating whether the form navigation buttons (previous/next/submit) are rendered.</p>
1976
+ */
1977
+ renderNavigationButtons: boolean;
1978
+ /**
1979
+ * <p>Gets or sets a value indicating if the data binding (via Bindary) is automatically activated on the form fields.</p>
1980
+ */
1981
+ autoDataBindFields: boolean;
1982
+ /**
1983
+ * <p>Gets or sets a value indicating whether the form binds field values to a custom external model instead of the internal model (form.values).</p>
1984
+ */
1985
+ bindToCustomModel: boolean;
1986
+ /**
1987
+ * <p>Gets or sets a method to retrieve the custom external model. When using form rules in combination with bindToCustomModel this property is required.</p>
1988
+ */
1989
+ customModelGetter: (...params: any[]) => any;
1990
+ /**
1991
+ * <p>Gets or sets a value indicating whether the form element is configured with a root data binding context (set via the Bindary context attribute). When true, this element serves as the root of the view update, potentially improving performance.</p>
1992
+ */
1993
+ hasDataBindRootContext: boolean;
1994
+ /**
1995
+ * <p>Gets or sets the array of nested field sets. Sections group FieldSets (cannot contain fields) while FieldSets directly contain fields, ensuring every field is always within a FieldSet.</p>
1996
+ */
1997
+ fieldSets: (componyx.UI.Form.Section | componyx.UI.Form.FieldSet)[];
1998
+ /**
1999
+ * <p>Gets or sets the current form field values stored by bindingKey or name.</p>
2000
+ */
2001
+ values: {
2002
+ [key: string]: any;
2003
+ };
2004
+ /**
2005
+ * <p>Gets or sets the field roles that determine how this field’s data is processed by the backend. Each role can specify a default value and be restricted to certain input types.</p>
2006
+ */
2007
+ fieldRoles: componyx.UI.Form.FieldRole[];
2008
+ /**
2009
+ * <p>Gets or sets the panels of the build panel-bar. If using Panel instances, the PanelBar script must be available at design time. If using plain objects, they are converted at runtime, and the PanelBar script is imported in the preRender phase.</p>
2010
+ */
2011
+ buildPanels: componyx.UI.PanelBar.Panel[] | object[];
2012
+ /**
2013
+ * <p>Gets or sets the panel id in the build panels for the Navigator. If set to null or if no panel with the specified id exists, the Navigator will not be rendered.</p>
2014
+ */
2015
+ navigatorPanelId: string | null;
2016
+ /**
2017
+ * <p>Gets or sets the delay in milliseconds before applying the navigator search after the user stops typing.</p>
2018
+ */
2019
+ navigatorSearchDelay: number;
2020
+ /**
2021
+ * <p>Gets or sets the id of the component from which the settings are cloned for the navigator menu used by the form component.</p>
2022
+ */
2023
+ navigatorMenuId: string | null;
2024
+ /**
2025
+ * <p>Gets or sets the panels of the config panel-bar. If using Panel instances, the PanelBar script must be available at design time. If using plain objects, they are converted at runtime, and the PanelBar script is imported in the preRender phase.</p>
2026
+ */
2027
+ configPanels: componyx.UI.PanelBar.Panel[] | object[];
2028
+ /**
2029
+ * <p>Gets or sets the build blocks that are displayed in the form's build pane when the displayMode is set to BUILD.</p>
2030
+ */
2031
+ buildBlocks: componyx.UI.Form.BuildBlock[];
2032
+ /**
2033
+ * <p>Gets or sets the command buttons displayed in the form’s specific placeholder locations.</p>
2034
+ */
2035
+ commands: componyx.UI.Form.Command[];
2036
+ /**
2037
+ * <p>Gets or sets the text labels used by the form.</p>
2038
+ */
2039
+ labels: componyx.UI.Form.LabelSettings;
2040
+ /**
2041
+ * <p>Gets or sets the data sources available for form fields (server endpoints filtered by input type). Configurable in build mode; used at runtime to populate field options (ComboBox, Checkbox, Radio, Switch) or to upload files.</p>
2042
+ */
2043
+ dataSources: componyx.UI.Form.DataSource[];
2044
+ /**
2045
+ * <p>Gets or sets the server endpoints used by rule case actions at runtime. Endpoints should return a JSON object with <code>success: true</code> to continue the current rule case actions or <code>success: false</code> to stop the action flow.</p>
2046
+ */
2047
+ actionEndpoints: componyx.UI.Form.ServerEndpoint[];
2048
+ /**
2049
+ * <p>Gets or sets the endpoint used to save the form definition.</p>
2050
+ */
2051
+ saveEndpoint: componyx.UI.Form.ServerEndpoint;
2052
+ /**
2053
+ * <p>Gets or sets the endpoint used to submit the form values at runtime.</p>
2054
+ */
2055
+ submitEndpoint: componyx.UI.Form.ServerEndpoint;
2056
+ /**
2057
+ * <p>Gets or sets the CRSF Token to send with each server endpoint request.</p>
2058
+ */
2059
+ crsfToken: string;
2060
+ /**
2061
+ * <p>Gets or sets a value indicating if disabled form fields are included in the form submit.</p>
2062
+ */
2063
+ includeDisabledFields: string;
2064
+ /**
2065
+ * <p>Gets or sets the maximum items allowed in the history stack. Null means no limit.</p>
2066
+ */
2067
+ maxHistoryLength: number | null;
2068
+ /**
2069
+ * <p>Gets or sets the delay in milliseconds before applying config panel setting changes to the form pane when in form build mode.</p>
2070
+ */
2071
+ settingUpdateDelay: number;
2072
+ /**
2073
+ * <p>* Gets or sets the delay in milliseconds before saving the form via the configured saveEndpoint (or custom onSave implementation) when in form build mode.</p>
2074
+ */
2075
+ autoSaveDelay: number;
2076
+ /**
2077
+ * <p>Gets or sets a custom function to sanitize HTML data. If provided, it overrides the default built-in sanitizer. For high-security environments, it's strongly recommended to use a library like DOMPurify or similar.</p>
2078
+ */
2079
+ sanitizer: ((...params: any[]) => any) | null;
2080
+ /**
2081
+ * <p>Gets or sets the drag settings for all draggable items.</p>
2082
+ */
2083
+ dragSettings: componyx.library.DraggableSettings;
2084
+ /**
2085
+ * <p>Gets or sets the id of the component from which the settings are cloned for the remove Field button (inside the Field action-menu).</p>
2086
+ */
2087
+ removeFieldButtonId: string;
2088
+ /**
2089
+ * <p>Gets or sets the id of the component from which the settings are cloned for the clone Field button (inside the Field action-menu).</p>
2090
+ */
2091
+ cloneFieldButtonId: string;
2092
+ /**
2093
+ * <p>Gets or sets the id of the component from which the settings are cloned for the add Field button (inside the Field action-menu).</p>
2094
+ */
2095
+ addFieldButtonId: string;
2096
+ /**
2097
+ * <p>Gets or sets the id of the component from which the settings are cloned for the remove Field Option button (inside the Field Options configuration panel).</p>
2098
+ */
2099
+ removeFieldOptionButtonId: string;
2100
+ /**
2101
+ * <p>Gets or sets the id of the component from which the settings are cloned for the add Field option button (inside the Field Options configuration panel).</p>
2102
+ */
2103
+ addFieldOptionButtonId: string;
2104
+ /**
2105
+ * <p>Gets or sets the id of the component from which the settings are cloned for the remove allowed time/date button (inside the Component configuration panel).</p>
2106
+ */
2107
+ removeAllowedItemButtonId: string;
2108
+ /**
2109
+ * <p>Gets or sets the id of the component from which the settings are cloned for the add allowed time/date button (inside the Component configuration panel).</p>
2110
+ */
2111
+ addAllowedItemOptionButtonId: string;
2112
+ /**
2113
+ * <p>Gets or sets the id of the component from which the settings are cloned for the build panel-bar.</p>
2114
+ */
2115
+ buildPanelBarId: string;
2116
+ /**
2117
+ * <p>Gets or sets the id of the component from which the settings are cloned for the configuration panel-bar.</p>
2118
+ */
2119
+ configPanelBarId: string;
2120
+ /**
2121
+ * <p>Gets or sets the id of the component from which the settings are cloned for the build-block insert button (inside the build panel).</p>
2122
+ */
2123
+ insertBuildBlockButtonId: string;
2124
+ /**
2125
+ * <p>Gets or sets the id of the component from which the settings are cloned for the layout combo-box (inside the FieldSet configuration panel).</p>
2126
+ */
2127
+ layoutComboBoxId: string;
2128
+ /**
2129
+ * <p>Gets or sets the id of the component from which the settings are cloned for the label display combo-box (inside the Field and FieldSet configuration panels).</p>
2130
+ */
2131
+ labelDisplayComboBoxId: string;
2132
+ /**
2133
+ * <p>Gets or sets the id of the component from which the settings are cloned for the field width combo-box (inside the Field configuration panel).</p>
2134
+ */
2135
+ fieldWidthComboBoxId: string;
2136
+ /**
2137
+ * <p>Gets or sets the id of the component from which the settings are cloned for the option width combo-box (inside the Field Options configuration panel).</p>
2138
+ */
2139
+ fieldOptionWidthComboBoxId: string;
2140
+ /**
2141
+ * <p>Gets or sets the id of the component from which the settings are cloned for more settings button (inside the Field configuration panel).</p>
2142
+ */
2143
+ moreSettingsButtonId: string;
2144
+ /**
2145
+ * <p>Gets or sets the id of the component from which the settings are cloned for the data type combo-box (inside the Validation configuration panel).</p>
2146
+ */
2147
+ dataTypeComboBoxId: string;
2148
+ /**
2149
+ * <p>Gets or sets the id of the component from which the settings are cloned for the compare operator combo-box (inside the Validation configuration panel).</p>
2150
+ */
2151
+ compareOperatorComboBoxId: string;
2152
+ /**
2153
+ * <p>Gets or sets the id of the component from which the settings are cloned for the compare field combo-box (inside the Validation configuration panel).</p>
2154
+ */
2155
+ compareFieldComboBoxId: string;
2156
+ /**
2157
+ * <p>Gets or sets the id of the component from which the settings are cloned for the data source combo-box (inside the Field Options configuration panel).</p>
2158
+ */
2159
+ dataSourceComboBoxId: string;
2160
+ /**
2161
+ * <p>Gets or sets the id of the component from which the settings are cloned for the data source preview combo-box (inside the Field Options configuration panel).</p>
2162
+ */
2163
+ dataSourcePreviewComboBoxId: string;
2164
+ /**
2165
+ * <p>Gets or sets the id of the component from which the settings are cloned for the max repeats numeric-box (inside the FieldSet configuration panel).</p>
2166
+ */
2167
+ maxRepeatsNumericBoxId: string;
2168
+ /**
2169
+ * <p>Gets or sets the id of the component from which the settings are cloned for the min length numeric-box (inside the Validation configuration panel).</p>
2170
+ */
2171
+ minLengthNumericBoxId: string;
2172
+ /**
2173
+ * <p>Gets or sets the id of the component from which the settings are cloned for the max length numeric-box (inside the Validation configuration panel).</p>
2174
+ */
2175
+ maxLengthNumericBoxId: string;
2176
+ /**
2177
+ * <p>Gets or sets the id of the component from which the settings are cloned for the min range numeric-box (inside the Validation configuration panel).</p>
2178
+ */
2179
+ minRangeNumericBoxId: string;
2180
+ /**
2181
+ * <p>Gets or sets the id of the component from which the settings are cloned for the max range numeric-box (inside the Validation configuration panel).</p>
2182
+ */
2183
+ maxRangeNumericBoxId: string;
2184
+ /**
2185
+ * <p>Gets or sets the id of the component from which the settings are cloned for the remove option button (inside the Field Options configuration panel).</p>
2186
+ */
2187
+ removeOptionButtonId: string;
2188
+ /**
2189
+ * <p>Gets or sets the id of the component from which the settings are cloned for the add rule case button (inside the Rules configuration panel).</p>
2190
+ */
2191
+ addRuleCaseButtonId: string;
2192
+ /**
2193
+ * <p>Gets or sets the id of the component from which the settings are cloned for the remove rule case button (inside the Rules configuration panel).</p>
2194
+ */
2195
+ removeRuleCaseButtonId: string;
2196
+ /**
2197
+ * <p>Gets or sets the id of the component from which the settings are cloned for the add rule group button (inside the Rules configuration panel).</p>
2198
+ */
2199
+ addRuleGroupButtonId: string;
2200
+ /**
2201
+ * <p>Gets or sets the id of the component from which the settings are cloned for the add action button (inside the Rules configuration panel).</p>
2202
+ */
2203
+ addActionButtonId: string;
2204
+ /**
2205
+ * <p>Gets or sets the id of the component from which the settings are cloned for the remove action button (inside the Rules configuration panel).</p>
2206
+ */
2207
+ removeActionButtonId: string;
2208
+ /**
2209
+ * <p>Gets or sets the id of the component from which the settings are cloned for the trigger combo-box (inside the Rules configuration panel).</p>
2210
+ */
2211
+ triggerComboBoxId: string;
2212
+ /**
2213
+ * <p>Gets or sets the id of the component from which the settings are cloned for the run visibility combo-box (inside the Rules configuration panel).</p>
2214
+ */
2215
+ runVisibilityComboBoxId: string;
2216
+ /**
2217
+ * <p>Gets or sets the id of the component from which the settings are cloned for the action combo-box (inside the Rules configuration panel).</p>
2218
+ */
2219
+ actionComboBoxId: string;
2220
+ /**
2221
+ * <p>Gets or sets the id of the component from which the settings are cloned for the action target combo-box (inside the Rules configuration panel).</p>
2222
+ */
2223
+ actionTargetComboBoxId: string;
2224
+ /**
2225
+ * <p>Gets or sets the id of the component from which the settings are cloned for the source field operator combo-box (inside the Rules configuration panel).</p>
2226
+ */
2227
+ sourceFieldComboBoxId: string;
2228
+ /**
2229
+ * <p>Gets or sets the id of the component from which the settings are cloned for the comparison operator combo-box (inside the Rules configuration panel).</p>
2230
+ */
2231
+ comparisonComboBoxId: string;
2232
+ /**
2233
+ * <p>Gets or sets the id of the component from which the settings are cloned for the logical operator combo-box (inside the Rules configuration panel).</p>
2234
+ */
2235
+ logicalOperatorComboBoxId: string;
2236
+ /**
2237
+ * <p>Gets or sets the id of the component from which the settings are cloned for the options value combo-box (inside the Rules configuration panel).</p>
2238
+ */
2239
+ optionsValueComboBoxId: string;
2240
+ /**
2241
+ * <p>Gets or sets the id of the component from which the settings are cloned for the sections value combo-box displayed for the show_section action (inside the Rules configuration panel).</p>
2242
+ */
2243
+ sectionsValueComboBoxId: string;
2244
+ /**
2245
+ * <p>Gets or sets the id of the component from which the settings are cloned for the value date-picker (inside the Component configuration panel).</p>
2246
+ */
2247
+ valueDatePickerId: string;
2248
+ /**
2249
+ * <p>Gets or sets the id of the component from which the settings are cloned for the min value date-picker (inside the Component configuration panel).</p>
2250
+ */
2251
+ minValueDatePickerId: string;
2252
+ /**
2253
+ * <p>Gets or sets the id of the component from which the settings are cloned for the max value date-picker (inside the Component configuration panel).</p>
2254
+ */
2255
+ maxValueDatePickerId: string;
2256
+ /**
2257
+ * <p>Gets or sets the id of the component from which the settings are cloned for the value time-picker (inside the Component configuration panel).</p>
2258
+ */
2259
+ valueTimePickerId: string;
2260
+ /**
2261
+ * <p>Gets or sets the id of the component from which the settings are cloned for the min value time-picker (inside the Component configuration panel).</p>
2262
+ */
2263
+ minValueTimePickerId: string;
2264
+ /**
2265
+ * <p>Gets or sets the id of the component from which the settings are cloned for the max value time-picker (inside the Component configuration panel).</p>
2266
+ */
2267
+ maxValueTimePickerId: string;
2268
+ /**
2269
+ * <p>Gets or sets the id of the component from which the settings are cloned for the default value numeric-box (inside the Component configuration panel).</p>
2270
+ */
2271
+ valueNumericBoxId: string;
2272
+ /**
2273
+ * <p>Gets or sets the id of the component from which the settings are cloned for the min value numeric-box (inside the Component configuration panel).</p>
2274
+ */
2275
+ minValueNumericBoxId: string;
2276
+ /**
2277
+ * <p>Gets or sets the id of the component from which the settings are cloned for the max value numeric-box (inside the Component configuration panel).</p>
2278
+ */
2279
+ maxValueNumericBoxId: string;
2280
+ /**
2281
+ * <p>Gets or sets the id of the component from which the settings are cloned for the start value numeric-box (inside the Component configuration panel).</p>
2282
+ */
2283
+ startValueNumericBoxId: string;
2284
+ /**
2285
+ * <p>Gets or sets the id of the component from which the settings are cloned for the precision numeric-box (inside the Component configuration panel).</p>
2286
+ */
2287
+ precisionNumericBoxId: string;
2288
+ /**
2289
+ * <p>Gets or sets the id of the component from which the settings are cloned for the tick marks numeric-box (inside the Component configuration panel).</p>
2290
+ */
2291
+ tickMarksNumericBoxId: string;
2292
+ /**
2293
+ * <p>Gets or sets the id of the component from which the settings are cloned for the incremental value numeric-box (inside the Component configuration panel).</p>
2294
+ */
2295
+ incrementalValueNumericBoxId: string;
2296
+ /**
2297
+ * <p>Gets or sets the id of the component from which the settings are cloned for the date-picker used to add allowed dates (inside the Component configuration panel).</p>
2298
+ */
2299
+ addAllowedDatePickerId: string;
2300
+ /**
2301
+ * <p>Gets or sets the id of the component from which the settings are cloned for the time-picker used to add allowed times (inside the Component configuration panel).</p>
2302
+ */
2303
+ addAllowedTimePickerId: string;
2304
+ /**
2305
+ * <p>Gets or sets the id of the component from which the settings are cloned for the max file size numeric-box (inside the Component configuration panel).</p>
2306
+ */
2307
+ maxFileSizeNumericBoxId: string;
2308
+ /**
2309
+ * <p>Gets or sets the id of the component from which the settings are cloned for the max files numeric-box (inside the Component configuration panel).</p>
2310
+ */
2311
+ maxFilesNumericBoxId: string;
2312
+ /**
2313
+ * <p>Gets or sets the id of the component from which the settings are cloned for the border width numeric-box (inside the Content configuration panel).</p>
2314
+ */
2315
+ borderWidthNumericBoxId: string;
2316
+ /**
2317
+ * <p>Gets or sets the id of the component from which the settings are cloned for the border color-button (inside the Content configuration panel).</p>
2318
+ */
2319
+ borderColorButtonId: string;
2320
+ /**
2321
+ * <p>Gets or sets the id of the component from which the settings are cloned for the background color-button (inside the Content configuration panel).</p>
2322
+ */
2323
+ backgroundColorButtonId: string;
2324
+ /**
2325
+ * <p>Gets or sets the id of the component from which the settings are cloned for the content field editor (Content Fields in Build Mode).</p>
2326
+ */
2327
+ contentFieldEditorId: string;
2328
+ /**
2329
+ * <p>Gets or sets the id of the component from which the settings are cloned for the color picker used by the form component.</p>
2330
+ */
2331
+ colorPickerId: string;
2332
+ /**
2333
+ * <p>Gets or sets the id of the component from which the settings are cloned for the section switch form-field rendered in the form header.</p>
2334
+ */
2335
+ sectionSwitchFormFieldId: string;
2336
+ /**
2337
+ * <p>Gets or sets the id of the component from which the settings are cloned for the alert dialog action.</p>
2338
+ */
2339
+ alertDialogId: string;
2340
+ /**
2341
+ * <p>Gets or sets the id of the component from which the settings are cloned for the confirmation dialog action.</p>
2342
+ */
2343
+ confirmDialogId: string;
2344
+ /**
2345
+ * <p>Gets or sets the id of the component from which the settings are cloned for the previous section button.</p>
2346
+ */
2347
+ previousSectionButtonId: string;
2348
+ /**
2349
+ * <p>Gets or sets the id of the component from which the settings are cloned for the next section button.</p>
2350
+ */
2351
+ nextSectionButtonId: string;
2352
+ /**
2353
+ * <p>Gets or sets the id of the component from which the settings are cloned for the submit button.</p>
2354
+ */
2355
+ submitButtonId: string;
2356
+ /**
2357
+ * <p>Gets or sets the id of the component from which the settings are cloned for the tooltip manager used by the form component.</p>
2358
+ */
2359
+ tooltipManagerId: string;
2360
+ /**
2361
+ * <p>Gets or sets the id of the component from which the settings are cloned for the validator used by the form component.</p>
2362
+ */
2363
+ validatorId: string;
2364
+ events: componyx.UI.Form.FormEvents;
2365
+ /**
2366
+ * <p>Gets the previous button.</p>
2367
+ */
2368
+ readonly prevButton: componyx.UI.Button;
2369
+ /**
2370
+ * <p>Gets the next button.</p>
2371
+ */
2372
+ readonly nextButton: componyx.UI.Button;
2373
+ /**
2374
+ * <p>Gets the submit button.</p>
2375
+ */
2376
+ readonly submitButton: componyx.UI.Button;
2377
+ /**
2378
+ * <p>Gets the field attribute name</p>
2379
+ */
2380
+ readonly fieldAttribute: string;
2381
+ /**
2382
+ * <p>Gets the selected field set identifier.</p>
2383
+ */
2384
+ readonly selectedFieldSetId: string;
2385
+ /**
2386
+ * <p>Gets the selected field identifier.</p>
2387
+ */
2388
+ readonly selectedFieldId: string;
2389
+ /**
2390
+ * <p>Gets the registered runtime actions.</p>
2391
+ */
2392
+ readonly runtimeActions: {
2393
+ [key: string]: componyx.UI.Form.ActionConfig;
2394
+ };
2395
+ /**
2396
+ * <p>Registers a custom field type.</p>
2397
+ * @param typeName - <p>The name of the custom field type.</p>
2398
+ * @param config - <p>Configuration for the custom field type.</p>
2399
+ */
2400
+ static registerCustomType(typeName: string, config: componyx.UI.Form.CustomFieldConfig): void;
2401
+ /**
2402
+ * <p>Retrieves the configuration for a registered custom field type.</p>
2403
+ * @param typeName - <p>The name of the custom field type.</p>
2404
+ * @returns <p>The configuration object for the custom type, or undefined if not registered.</p>
2405
+ */
2406
+ static getCustomType(typeName: string): any | undefined;
2407
+ /**
2408
+ * <p>Gets a unique identifer.</p>
2409
+ * @returns <p>A unique identifier.</p>
2410
+ */
2411
+ guid(): string;
2412
+ /**
2413
+ * <p>Registers a runtime action.</p>
2414
+ * @param id - <p>The unique identifier of the action.</p>
2415
+ * @param config - <p>The object to configure the action.</p>
2416
+ */
2417
+ registerAction(id: string, config: componyx.UI.Form.ActionConfig): void;
2418
+ /**
2419
+ * <p>Executes a serialized action on a field.</p>
2420
+ * @param action - <p>The action instance.</p>
2421
+ * @param target - <p>The target field or fieldset on which the action is executed.</p>
2422
+ */
2423
+ executeAction(action: componyx.UI.Form.Action, target: componyx.UI.Form.Field | componyx.UI.Form.FieldSet): void;
2424
+ /**
2425
+ * <p>Retrieves the Section of the current field (if sections are enabled).</p>
2426
+ * @param field - <p>The field instance.</p>
2427
+ * @returns <p>The parent section.</p>
2428
+ */
2429
+ getParentSection(field: componyx.UI.Form.Field): componyx.UI.Form.Section;
2430
+ /**
2431
+ * <p>Gets the values of enabled form fields (excludes disabled fields).</p>
2432
+ * @returns <p>The form values of all enabled fields.</p>
2433
+ */
2434
+ getEnabledFieldValues(): any;
2435
+ /**
2436
+ * <p>Check if the given type belongs to a group container (e.g., FieldSet, Section).</p>
2437
+ * @param type - <p>The type to check.</p>
2438
+ * @returns <p>True if the type is a group.</p>
2439
+ */
2440
+ isGroup(type: string): boolean;
2441
+ /**
2442
+ * <p>Check if the given type is an input field (user-enterable).</p>
2443
+ * @param type - <p>The type to check.</p>
2444
+ * @returns <p>True if the type is an input field.</p>
2445
+ */
2446
+ isInputField(type: string): boolean;
2447
+ /**
2448
+ * <p>Check if the given type is a content-only field.</p>
2449
+ * @param type - <p>The type to check.</p>
2450
+ * @returns <p>True if the type is a content field.</p>
2451
+ */
2452
+ isContentField(type: string): boolean;
2453
+ /**
2454
+ * <p>Check if the given type is a content or input field.</p>
2455
+ * @param type - <p>The type to check.</p>
2456
+ * @returns <p>True if the type is a content field.</p>
2457
+ */
2458
+ isField(type: string): boolean;
2459
+ /**
2460
+ * <p>Sets the header template. The template supports the below listed interpolations.</p>
2461
+ * <ul>
2462
+ * <li>{title} This value will be replaced with the form title.</li>
2463
+ * <li>{commands} This value will be replaced with the form commands.</li>
2464
+ * </ul>
2465
+ * @param content - <p>The HTML template.</p>
2466
+ */
2467
+ setHeaderTemplate(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2468
+ /**
2469
+ * <p>Sets the FieldSetPanel template. The template supports the below listed interpolations.</p>
2470
+ * <ul>
2471
+ * <li>{layout}</li>
2472
+ * <li>{labelDisplay}</li>
2473
+ * <li>{repeatable}</li>
2474
+ * <li>{maxRepeats}</li>
2475
+ * <li>{repeatLabel}</li>
2476
+ * <li>{tooltip}</li>
2477
+ * <li>{lineBreak}</li>
2478
+ * <li>{visible}</li>
2479
+ * <li>{disabled}</li>
2480
+ * </ul>
2481
+ * @param content - <p>The HTML template.</p>
2482
+ */
2483
+ setFieldSetPanel(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2484
+ /**
2485
+ * <p>Sets the FieldPanel template. The template supports the below listed interpolations.</p>
2486
+ * <ul>
2487
+ * <li>{name}</li>
2488
+ * <li>{labelDisplay}</li>
2489
+ * <li>{placeholder}</li>
2490
+ * <li>{tooltip}</li>
2491
+ * <li>{value}</li>
2492
+ * <li>{width}</li>
2493
+ * <li>{required}</li>
2494
+ * <li>{lineBreak}</li>
2495
+ * <li>{visible}</li>
2496
+ * <li>{disabled}</li>
2497
+ * </ul>
2498
+ * @param content - <p>The HTML template.</p>
2499
+ */
2500
+ setFieldPanel(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2501
+ /**
2502
+ * <p>Sets the ContentFieldPanel template. The template supports the below listed interpolations.</p>
2503
+ * <ul>
2504
+ * <li>{width}</li>
2505
+ * <li>{margin}</li>
2506
+ * <li>{padding}</li>
2507
+ * <li>{borderWidth}</li>
2508
+ * <li>{borderRadius}</li>
2509
+ * <li>{borderColor}</li>
2510
+ * <li>{backgroundColor}</li>
2511
+ * <li>{lineBreak}</li>
2512
+ * <li>{visible}</li>
2513
+ * </ul>
2514
+ * @param content - <p>The HTML template.</p>
2515
+ */
2516
+ setContentFieldPanel(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2517
+ /**
2518
+ * <p>Sets the SpacerFieldPanel template. The template supports the below listed interpolations.</p>
2519
+ * <ul>
2520
+ * <li>{showDivider}</li>
2521
+ * <li>{height}</li>
2522
+ * </ul>
2523
+ * @param content - <p>The HTML template.</p>
2524
+ */
2525
+ setSpacerFieldPanel(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2526
+ /**
2527
+ * <p>Sets the FieldOptionsPanel template. The template supports the below listed interpolations.</p>
2528
+ * <ul>
2529
+ * <li>{optionsType}</li>
2530
+ * <li>{dataSourceId}</li>
2531
+ * <li>{dataSourcePreview}</li>
2532
+ * <li>{inlineOptions}</li>
2533
+ * <li>{optionWidth}</li>
2534
+ * <li>{options}</li>
2535
+ * </ul>
2536
+ * @param content - <p>The HTML template.</p>
2537
+ */
2538
+ setFieldOptionsPanel(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2539
+ /**
2540
+ * <p>Sets the ComponentPanel_MaskedTextBox template. The template supports the below listed interpolations.</p>
2541
+ * <ul>
2542
+ * <li>{mask}</li>
2543
+ * <li>{value}</li>
2544
+ * <li>{allowedCharacters}</li>
2545
+ * </ul>
2546
+ * @param content - <p>The HTML template.</p>
2547
+ */
2548
+ setComponentPanel_MaskedTextBox(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2549
+ /**
2550
+ * <p>Sets the ComponentPanel_NumericBox template. The template supports the below listed interpolations.</p>
2551
+ * <ul>
2552
+ * <li>{precision}</li>
2553
+ * <li>{value}</li>
2554
+ * <li>{minValue}</li>
2555
+ * <li>{maxValue}</li>
2556
+ * </ul>
2557
+ * @param content - <p>The HTML template.</p>
2558
+ */
2559
+ setComponentPanel_NumericBox(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2560
+ /**
2561
+ * <p>Sets the ComponentPanel_ComboBox template. The template supports the below listed interpolations.</p>
2562
+ * <ul>
2563
+ * <li>{multiSelect}</li>
2564
+ * <li>{multiSelectTagging}</li>
2565
+ * <li>{allowInput}</li>
2566
+ * </ul>
2567
+ * @param content - <p>The HTML template.</p>
2568
+ */
2569
+ setComponentPanel_ComboBox(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2570
+ /**
2571
+ * <p>Sets the ComponentPanel_DatePicker template. The template supports the below listed interpolations.</p>
2572
+ * <ul>
2573
+ * <li>{today}</li>
2574
+ * <li>{value}</li>
2575
+ * <li>{minValue}</li>
2576
+ * <li>{maxValue}</li>
2577
+ * <li>{allowedDates}</li>
2578
+ * <li>{disallowDates}</li>
2579
+ * </ul>
2580
+ * @param content - <p>The HTML template.</p>
2581
+ */
2582
+ setComponentPanel_DatePicker(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2583
+ /**
2584
+ * <p>Sets the ComponentPanel_TimePicker template. The template supports the below listed interpolations.</p>
2585
+ * <ul>
2586
+ * <li>{value}</li>
2587
+ * <li>{minValue}</li>
2588
+ * <li>{maxValue}</li>
2589
+ * <li>{incrementalValue}</li>
2590
+ * <li>{allowedTimes}</li>
2591
+ * <li>{disallowTimes}</li>
2592
+ * </ul>
2593
+ * @param content - <p>The HTML template.</p>
2594
+ */
2595
+ setComponentPanel_TimePicker(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2596
+ /**
2597
+ * <p>Sets the ComponentPanel_Slider template. The template supports the below listed interpolations.</p>
2598
+ * <ul>
2599
+ * <li>{range}</li>
2600
+ * <li>{trackSize}</li>
2601
+ * <li>{startValue}</li>
2602
+ * <li>{value}</li>
2603
+ * <li>{minValue}</li>
2604
+ * <li>{maxValue}</li>
2605
+ * <li>{tickMarks}</li>
2606
+ * </ul>
2607
+ * @param content - <p>The HTML template.</p>
2608
+ */
2609
+ setComponentPanel_Slider(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2610
+ /**
2611
+ * <p>Sets the ComponentPanel_FileUpload template. The template supports the below listed interpolations.</p>
2612
+ * <ul>
2613
+ * <li>{accept}</li>
2614
+ * <li>{maxFileSize}</li>
2615
+ * <li>{maxFiles}</li>
2616
+ * <li>{dataSourceId}</li>
2617
+ * </ul>
2618
+ * @param content - <p>The HTML template.</p>
2619
+ */
2620
+ setComponentPanel_FileUpload(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2621
+ /**
2622
+ * <p>Sets the ComponentPanel_Editor template. The template supports the below listed interpolations.</p>
2623
+ * <ul>
2624
+ * <li>{blockStyles}</li>
2625
+ * <li>{links}</li>
2626
+ * <li>{lists}</li>
2627
+ * <li>{images}</li>
2628
+ * <li>{media}</li>
2629
+ * <li>{all}</li>
2630
+ * </ul>
2631
+ * @param content - <p>The HTML template.</p>
2632
+ */
2633
+ setComponentPanel_Editor(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2634
+ /**
2635
+ * <p>Sets the ValidationPanel template. The template supports the below listed interpolations.</p>
2636
+ * <ul>
2637
+ * <li>{required}</li>
2638
+ * <li>{dataType}</li>
2639
+ * <li>{pattern}</li>
2640
+ * <li>{length}</li>
2641
+ * <li>{compare}</li>
2642
+ * </ul>
2643
+ * @param content - <p>The HTML template.</p>
2644
+ */
2645
+ setValidationPanel(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2646
+ /**
2647
+ * <p>Sets the Option template. The template supports the below listed interpolations.</p>
2648
+ * <ul>
2649
+ * <li>{name}</li>
2650
+ * <li>{value}</li>
2651
+ * <li>{remove}</li>
2652
+ * </ul>
2653
+ * @param content - <p>The HTML template.</p>
2654
+ */
2655
+ setOption(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2656
+ /**
2657
+ * <p>Sets the Rule template. The template supports the below listed interpolations.</p>
2658
+ * <ul>
2659
+ * <li>{source}</li>
2660
+ * <li>{operator}</li>
2661
+ * <li>{value}</li>
2662
+ * <li>{connector}</li>
2663
+ * <li>{remove}</li>
2664
+ * </ul>
2665
+ * @param content - <p>The HTML template.</p>
2666
+ */
2667
+ setRule(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2668
+ /**
2669
+ * <p>Sets the Action template. The template supports the below listed interpolations.</p>
2670
+ * <ul>
2671
+ * <li>{actionSelector}</li>
2672
+ * <li>{remove}</li>
2673
+ * </ul>
2674
+ * @param content - <p>The HTML template.</p>
2675
+ */
2676
+ setAction(content: HTMLElement | HTMLElement[] | DocumentFragment | string): void;
2677
+ /**
2678
+ * <p>Gets a value indicating whether the form is in build mode.</p>
2679
+ * @returns <p>A value indicating whether the form is in build mode.</p>
2680
+ */
2681
+ isBuildMode(): boolean;
2682
+ /**
2683
+ * <p>Gets a value indicating whether the form is in preview mode.</p>
2684
+ * @returns <p>A value indicating whether the form is in preview mode.</p>
2685
+ */
2686
+ isPreviewMode(): boolean;
2687
+ /**
2688
+ * <p>Sets the display mode and re-renders the component.</p>
2689
+ * @param displayMode - <p>The display mode in which the form will be rendered.</p>
2690
+ */
2691
+ setDisplayMode(displayMode: componyx.UI.Form.DisplayModeOption): void;
2692
+ /**
2693
+ * <p>Toggles the visibility of a specified side pane (build or config).
2694
+ * Adds or removes a CSS class that controls visibility.</p>
2695
+ * @param pane - <p>The pane to toggle ('build' for the left panel, 'config' for the right panel).</p>
2696
+ */
2697
+ togglePane(pane?: 'build' | 'config'): void;
2698
+ /**
2699
+ * <p>Checks whether an undo or redo operation is possible based on the current history state.</p>
2700
+ * @param type - <p>Either 'undo' or 'redo'.</p>
2701
+ * @returns <p>True if the operation is possible; otherwise, false.</p>
2702
+ */
2703
+ canPerformHistoryAction(type: string): boolean;
2704
+ /**
2705
+ * <p>Updates the visibility and enabled state of UI command buttons based on their associated conditions.
2706
+ * Commands are shown/hidden and enabled/disabled according to their <code>isVisible</code> and <code>isEnabled</code> callbacks.</p>
2707
+ */
2708
+ updateCommandStates(): void;
2709
+ /**
2710
+ * <p>Reverts the form data to the previous state in the undo stack.</p>
2711
+ */
2712
+ undo(): void;
2713
+ /**
2714
+ * <p>Restores the form data to the next state in the redo stack.</p>
2715
+ */
2716
+ redo(): void;
2717
+ /**
2718
+ * <p>Sets the active element for the data observer.</p>
2719
+ */
2720
+ setActiveElement(): void;
2721
+ /**
2722
+ * <p>Executes a block of code without tracking any changes in the undo/redo history stack.
2723
+ * Any modifications to form data within the callback will not be recorded in the form's history. This is useful for internal or silent updates that should not be undoable.
2724
+ * Optionally, you can disable processing/rendering of the changes by passing <code>false</code> as the second argument.</p>
2725
+ * @param callback - <p>The function containing non-history-tracked changes.</p>
2726
+ * @param processChanges - <p>A value indicating whether to process and render the changes made during the callback.</p>
2727
+ */
2728
+ withoutTracking(callback: (...params: any[]) => any, processChanges?: boolean): void;
2729
+ /**
2730
+ * <p>Processes any pending data changes and updates the form UI accordingly.
2731
+ * Call this method after making direct changes to the form data to ensure those changes are rendered and reflected in the UI.</p>
2732
+ */
2733
+ processChanges(): void;
2734
+ /**
2735
+ * <p>Checks if the form has any sections (root-level fieldSets of type &quot;Section&quot;).</p>
2736
+ * @returns <p>True if at least one section exists.</p>
2737
+ */
2738
+ hasSections(): boolean;
2739
+ /**
2740
+ * <p>Retrieves a section by its identifier. Sections are represented as root-level field sets.</p>
2741
+ * @param id - <p>The identifier of the section to find.</p>
2742
+ * @returns <p>The section with the specified id, or null if not found.</p>
2743
+ */
2744
+ getSection(id: string): componyx.UI.Form.FieldSet | null;
2745
+ /**
2746
+ * <p>Retrieves a field set by its identifier, searching recursively through all nested field sets.</p>
2747
+ * @param id - <p>The identifier of the field set to find.</p>
2748
+ * @param [fieldSets = this.fieldSets] - <p>Optional root list of field sets to start from.</p>
2749
+ * @returns <p>The field set with the specified id, or null if not found.</p>
2750
+ */
2751
+ getFieldSet(id: string, fieldSets?: componyx.UI.Form.FieldSet[]): componyx.UI.Form.FieldSet | null;
2752
+ /**
2753
+ * <p>Get field by its identifier.</p>
2754
+ * @param id - <p>The identifier of the field to retrieve.</p>
2755
+ * @param [fieldSet = null] - <p>The root field set to start from.</p>
2756
+ * @param [fields = null] - <p>The flattened field collection to speed up the lookup for batched find actions.</p>
2757
+ * @returns <p>The field with the specified id, or null if not found.</p>
2758
+ */
2759
+ getField(id: string, fieldSet?: componyx.UI.Form.FieldSet, fields?: componyx.UI.Form.Field[]): componyx.UI.Form.Field | null;
2760
+ /**
2761
+ * <p>Retrieves all fields from the given field set or the entire form if none is provided.
2762
+ * Searches recursively to include fields from nested field sets.</p>
2763
+ * @param [fieldSet = null] - <p>The root field set to start from.</p>
2764
+ * @returns <p>A flat array of all fields.</p>
2765
+ */
2766
+ getFields(fieldSet?: componyx.UI.Form.FieldSet): componyx.UI.Form.Field[];
2767
+ /**
2768
+ * <p>Retrieves all field sets from the given root or the entire form if none is provided.
2769
+ * Searches recursively to include field sets from nested field sets.</p>
2770
+ * @param [fieldSet = null] - <p>The root field set to start from.</p>
2771
+ * @returns <p>A flat array of all field sets.</p>
2772
+ */
2773
+ getFieldSets(fieldSet?: any): object[];
2774
+ /**
2775
+ * <p>Retrieves the field by the field option.</p>
2776
+ * @param fieldOption - <p>The field option.</p>
2777
+ * @returns <p>The field to which the field option belongs.</p>
2778
+ */
2779
+ getFieldByFieldOption(fieldOption: componyx.UI.Form.FieldOption): componyx.UI.Form.Field;
2780
+ /**
2781
+ * <p>Retrieves the field name from the specified text label.</p>
2782
+ * @param label - <p>The text label.</p>
2783
+ * @returns <p>A valid field name.</p>
2784
+ */
2785
+ getValidFieldNameFromLabel(label: string): string;
2786
+ /**
2787
+ * <p>Gets the field context by its identifier in the field sets.</p>
2788
+ * @param field - <p>The field to find context for.</p>
2789
+ * @returns <p>The context of the field.</p>
2790
+ */
2791
+ getFieldContext(field: componyx.UI.Form.Field): componyx.UI.Form.FieldContext | null;
2792
+ /**
2793
+ * <p>Recursively finds a FieldSet by its associated DOM element.</p>
2794
+ * @param fieldSets - <p>The list of FieldSets to search through.</p>
2795
+ * @param element - <p>The element to find the corresponding FieldSet for.</p>
2796
+ * @returns <p>The matching FieldSet, or null if not found.</p>
2797
+ */
2798
+ findFieldSetByElement(fieldSets: any[], element: HTMLElement): any | null;
2799
+ /**
2800
+ * <p>Inserts a build block into the form's active field-set.</p>
2801
+ * @param buildBlock - <p>The build block to insert.</p>
2802
+ */
2803
+ insertBuildBlock(buildBlock: componyx.UI.Form.BuildBlock): void;
2804
+ /**
2805
+ * <p>Gets the active field set.</p>
2806
+ * @returns <p>The active field set.</p>
2807
+ */
2808
+ getActiveFieldSet(): componyx.UI.Form.FieldSet;
2809
+ /**
2810
+ * <p>Toggles sections mode.</p>
2811
+ */
2812
+ toggleSectionMode(): void;
2813
+ /**
2814
+ * <p>Disables sections mode: flattens all section fieldSets into root.</p>
2815
+ */
2816
+ disableSectionMode(): void;
2817
+ /**
2818
+ * <p>Enables sections mode: wraps all existing root fieldSets into a single Section.</p>
2819
+ */
2820
+ enableSectionMode(): void;
2821
+ /**
2822
+ * <p>Shows the previous visible Section, if any.
2823
+ * Navigates backward within the fieldSets sequence.</p>
2824
+ */
2825
+ previousSection(): void;
2826
+ /**
2827
+ * <p>Shows the next visible Section, if any.
2828
+ * Navigates forward within the fieldSets sequence.</p>
2829
+ */
2830
+ nextSection(): void;
2831
+ /**
2832
+ * <p>Checks if the currently visible Section is the first one.</p>
2833
+ * @returns <p>True if the current Section is the first; otherwise false.</p>
2834
+ */
2835
+ isFirstSection(): boolean;
2836
+ /**
2837
+ * <p>Checks if the currently visible Section is the last one.</p>
2838
+ * @returns <p>True if the current Section is the last; otherwise false.</p>
2839
+ */
2840
+ isLastSection(): boolean;
2841
+ /**
2842
+ * <p>Displays the specified Section and updates button and rule states accordingly.
2843
+ * Hides the currently visible Section if different.</p>
2844
+ * @param section - <p>The Section to display.</p>
2845
+ */
2846
+ showSection(section: componyx.UI.Form.Section): void;
2847
+ /**
2848
+ * <p>Initializes conditional and validation rules. Also updates form navigation button states and moves focus to first form field.
2849
+ * Is called automatically after the form is loaded or when a section is shown.</p>
2850
+ * @param fieldSets - <p>The fieldSets for which the rules will be initialized.</p>
2851
+ */
2852
+ initRules(fieldSets: componyx.UI.Form.FieldSet[]): void;
2853
+ /**
2854
+ * <p>Adds a new Section as root item into the fieldSets data.
2855
+ * Optionally, existing fieldSets can be wrapped inside this new section.</p>
2856
+ * @param [fieldSets] - <p>Optional array of fieldSets to include in the new Section.</p>
2857
+ * @returns <p>The newly added Section.</p>
2858
+ */
2859
+ addSection(fieldSets?: componyx.UI.Form.FieldSet[], focusTabInput?: boolean): componyx.UI.Form.Section;
2860
+ /**
2861
+ * <p>Removes the specified section from the fieldSets data.
2862
+ * Picks a neighbor section (previous if possible, otherwise next) to keep the form visible.</p>
2863
+ */
2864
+ removeSection(section: componyx.UI.Form.Section): void;
2865
+ /**
2866
+ * <p>Adds a repeated instance of the given field set, assigning it a new label and tracking it as part of a repeat group.</p>
2867
+ * @param fieldSet - <p>The original field set to repeat.</p>
2868
+ */
2869
+ addRepeatedFieldSet(fieldSet: componyx.UI.Form.FieldSet): void;
2870
+ /**
2871
+ * <p>Removes a repeated field set instance and updates related UI elements and data.</p>
2872
+ * <ul>
2873
+ * <li>Adjusts line breaks if necessary.</li>
2874
+ * <li>Removes the associated &quot;remove repeat&quot; button.</li>
2875
+ * <li>Re-enables the &quot;add repeat&quot; button if applicable.</li>
2876
+ * </ul>
2877
+ * @param fieldSet - <p>The repeated field set to remove.</p>
2878
+ */
2879
+ removeRepeatedFieldSet(fieldSet: componyx.UI.Form.FieldSet): void;
2880
+ /**
2881
+ * <p>Adds a new field set after the specified field into the fieldSets data.</p>
2882
+ * @param fieldSet - <p>The field set after which the new field will be added.</p>
2883
+ * @param clone - <p>A value indicating if the field set should be cloned.</p>
2884
+ * @returns <p>The added field set.</p>
2885
+ */
2886
+ addFieldSet(fieldSet: componyx.UI.Form.FieldSet, clone: boolean): componyx.UI.Form.FieldSet;
2887
+ /**
2888
+ * <p>Removes the specified field set from the fieldSets data and adjusts the line break if necessary.</p>
2889
+ * @param fieldSet - <p>The field set to be removed.</p>
2890
+ * @param resetConfigPanelBar - <p>A value indicating if the config panel bar must be reset (disabled and collapsed).</p>
2891
+ */
2892
+ removeFieldSet(fieldSet: componyx.UI.Form.FieldSet, resetConfigPanelBar: boolean): void;
2893
+ /**
2894
+ * <p>Adds a new field after the specified field into the fieldSets data.</p>
2895
+ * @param field - <p>The field after which the new field will be added.</p>
2896
+ * @param clone - <p>A value indicating if the field should be cloned.</p>
2897
+ * @returns <p>The added field.</p>
2898
+ */
2899
+ addField(field: componyx.UI.Form.Field, clone: boolean): componyx.UI.Form.Field;
2900
+ /**
2901
+ * <p>Removes the specified field from the fieldSets data and adjusts the line break if necessary.</p>
2902
+ * @param field - <p>The field to be removed.</p>
2903
+ * @param resetConfigPanelBar - <p>A value indicating if the config panel bar must be reset (disabled and collapsed).</p>
2904
+ */
2905
+ removeField(field: componyx.UI.Form.Field, resetConfigPanelBar: boolean): void;
2906
+ /**
2907
+ * <p>Resets the config panel bar to default disabled and collapsed state.</p>
2908
+ */
2909
+ resetConfigPanelBar(): void;
2910
+ /**
2911
+ * <p>Sets the label display for all fields in the field set.</p>
2912
+ * @param fieldSet - <p>The field set containing the fields for which to set the label display.</p>
2913
+ * @param labelDisplay - <p>The label display.</p>
2914
+ */
2915
+ setLabelDisplay(fieldSet: componyx.UI.Form.FieldSet, labelDisplay: componyx.UI.FormField.LabelDisplayOption): void;
2916
+ /**
2917
+ * <p>Destroys the section</p>
2918
+ * @param section - <p>The section to destroy.</p>
2919
+ */
2920
+ destroySection(section: componyx.UI.Form.Section): void;
2921
+ /**
2922
+ * <p>Renders the section.</p>
2923
+ * @param section - <p>The section to render.</p>
2924
+ */
2925
+ renderSection(section: componyx.UI.Form.Section): void;
2926
+ /**
2927
+ * <p>Updates simple settings that don't required a re-render.</p>
2928
+ * @param section - <p>The section to update.</p>
2929
+ */
2930
+ updateSection(section: componyx.UI.Form.Section): void;
2931
+ /**
2932
+ * <p>Destroys the field-set.</p>
2933
+ * @param fieldSet - <p>The field-set to destroy.</p>
2934
+ */
2935
+ destroyFieldSet(fieldSet: componyx.UI.Form.FieldSet): void;
2936
+ /**
2937
+ * <p>Renders the field-set.</p>
2938
+ * @param fieldSet - <p>The field-set to render.</p>
2939
+ */
2940
+ renderFieldSet(fieldSet: componyx.UI.Form.FieldSet): void;
2941
+ /**
2942
+ * <p>Updates simple field set settings that don't required a re-render.</p>
2943
+ * @param fieldSet - <p>The field-set to update.</p>
2944
+ */
2945
+ updateFieldSet(fieldSet: componyx.UI.Form.FieldSet): void;
2946
+ /**
2947
+ * <p>Renders the field.</p>
2948
+ * @param field - <p>The field to render.</p>
2949
+ */
2950
+ renderField(field: componyx.UI.Form.Field): void;
2951
+ /**
2952
+ * <p>Updates simple field settings that don't required a re-render.</p>
2953
+ * @param field - <p>The field to update.</p>
2954
+ */
2955
+ updateField(field: componyx.UI.Form.FieldSet): void;
2956
+ /**
2957
+ * <p>Updates the field with new options for build mode view.</p>
2958
+ * @param field - <p>The field to update.</p>
2959
+ */
2960
+ updateFieldOptions(field: componyx.UI.Form.FieldSet): void;
2961
+ /**
2962
+ * <p>Destroys the field.</p>
2963
+ * @param field - <p>The field to destroy.</p>
2964
+ */
2965
+ destroyField(field: componyx.UI.Form.Field): void;
2966
+ /**
2967
+ * <p>Recursively assign parent references to each field set and its nested field sets.</p>
2968
+ * @param fieldSets - <p>Array of field sets or sections.</p>
2969
+ * @param [parent = null] - <p>Parent field set (null if at root level).</p>
2970
+ */
2971
+ setParentReferences(fieldSets: componyx.UI.Form.FieldSet[], parent?: componyx.UI.Form.FieldSet | null): void;
2972
+ /**
2973
+ * <p>Adds a line break to the field.</p>
2974
+ * @param field - <p>The field or field set.</p>
2975
+ */
2976
+ addLineBreak(field: componyx.UI.Form.Field | componyx.UI.Form.FieldSet): void;
2977
+ /**
2978
+ * <p>Removes a line break from the field.</p>
2979
+ * @param field - <p>The field or field set.</p>
2980
+ * @param updateProperty - <p>A value indicating if the lineBreak property is also updated.</p>
2981
+ */
2982
+ removeLineBreak(field: componyx.UI.Form.Field | componyx.UI.Form.FieldSet, updateProperty?: boolean): void;
2983
+ /**
2984
+ * <p>Gets the css class if it exists and otherwise the default css class.</p>
2985
+ * @param cssClassValue - <p>The default css class value (one of the classOption values).</p>
2986
+ * @returns <p>The css class.</p>
2987
+ */
2988
+ getCssClass(cssClassValue: string): string;
2989
+ /**
2990
+ * <p>Enables or disables remove buttons for root fieldSets, at least one fieldSet is required.</p>
2991
+ */
2992
+ updateRemoveButtonState(): void;
2993
+ /**
2994
+ * <p>Ensures that the object has a valid identifier if it is not set.</p>
2995
+ * @param isClone - <p>A value indicating if this field is cloned.</p>
2996
+ * @returns <p>The passed object.</p>
2997
+ */
2998
+ ensureItemId(item: componyx.UI.Form.Field | componyx.UI.Form.FieldSet | componyx.UI.Form.Section, isClone: boolean): componyx.UI.Form.Field | componyx.UI.Form.FieldSet | componyx.UI.Form.Section;
2999
+ /**
3000
+ * <p>Deselects the currently selected section.</p>
3001
+ */
3002
+ deselectSection(): void;
3003
+ /**
3004
+ * <p>Selects the given section, making it visible and deselecting the previous one.</p>
3005
+ * @param section - <p>The section to select.</p>
3006
+ * @param selectFirst - <p>A value indicating if the first field or fieldSet is selected.</p>
3007
+ */
3008
+ selectSection(section: componyx.UI.Form.Section, selectFirst: boolean): void;
3009
+ /**
3010
+ * <p>Deselects the currently selected field set.</p>
3011
+ */
3012
+ deselectFieldSet(): void;
3013
+ /**
3014
+ * <p>Selects the given field set and applies selected styling.</p>
3015
+ * @param fieldSet - <p>The field set to select.</p>
3016
+ */
3017
+ selectFieldSet(fieldSet: any): void;
3018
+ /**
3019
+ * <p>Deselects the currently selected field.</p>
3020
+ */
3021
+ deselectField(): void;
3022
+ /**
3023
+ * <p>Selects the given field and applies selected styling.</p>
3024
+ * @param field - <p>The field to select.</p>
3025
+ */
3026
+ selectField(field: any): void;
3027
+ /**
3028
+ * <p>Selects the first field or field set.</p>
3029
+ * @param [section] - <p>The section to search in. Defaults to the first root item.</p>
3030
+ */
3031
+ selectFirst(section?: componyx.UI.Form.Section | componyx.UI.Form.FieldSet): void;
3032
+ /**
3033
+ * <p>Gets a value indicating whether the form is in edit mode.</p>
3034
+ */
3035
+ isEditMode(): boolean;
3036
+ /**
3037
+ * <p>Gets a value indicating whether the form is in view mode.</p>
3038
+ */
3039
+ isViewMode(): boolean;
3040
+ /**
3041
+ * <p>Schedules an auto-save after a delay. Resets the timer if called repeatedly.</p>
3042
+ */
3043
+ scheduleSave(): void;
3044
+ /**
3045
+ * <p>Saves the current form definition by calling the configured save endpoint.
3046
+ * Triggers onSave events and updates the UI save status indicator.</p>
3047
+ * @returns <p>Resolves with the save result object.</p>
3048
+ */
3049
+ save(): Promise<object>;
3050
+ /**
3051
+ * <p>Submits the form values by calling the configured submit endpoint.
3052
+ * Executes rule-engine submit triggers and fires submit events.</p>
3053
+ * @returns <p>Resolves when submission and related rules have completed.</p>
3054
+ */
3055
+ submit(): Promise<void>;
3056
+ /**
3057
+ * <p>Rebinds legend inputs for all child field sets.
3058
+ * If no fieldSet provided, processes all field sets recursively.</p>
3059
+ * @param [fieldSet = null] - <p>The parent field set containing child sets.</p>
3060
+ */
3061
+ rebindFieldSetLabels(fieldSet?: any): void;
3062
+ /**
3063
+ * <p>Rebinds label inputs and possible content field values for all fields in the given field set or all fields in the form if none given.</p>
3064
+ * @param [fieldSet = null] - <p>The field set containing fields to rebind.</p>
3065
+ */
3066
+ rebindFieldElements(fieldSet?: any): void;
3067
+ /**
3068
+ * <p>Converts serialized objects back to their corresponding class instances.</p>
3069
+ * @param fieldSets - <p>An array of field set objects (FieldSet or Section) to rehydrate.</p>
3070
+ */
3071
+ rehydrate(fieldSets: componyx.UI.Form.FieldSet[] | componyx.UI.Form.Section[]): void;
3072
+ /**
3073
+ * <p>Renders the component.</p>
3074
+ */
3075
+ render(): void;
3076
+ }
3077
+ }
3078
+ }