@sapui5/ts-types 1.145.1 → 1.147.0

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 (70) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +3 -6
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +4 -7
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +59 -67
  8. package/types/sap.f.d.ts +214 -528
  9. package/types/sap.fe.ariba.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +1 -1
  11. package/types/sap.fe.controls.d.ts +1 -1
  12. package/types/sap.fe.core.d.ts +1 -1
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +1725 -1041
  15. package/types/sap.fe.navigation.d.ts +1 -1
  16. package/types/sap.fe.placeholder.d.ts +1 -1
  17. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  18. package/types/sap.fe.templates.d.ts +1 -1
  19. package/types/sap.fe.test.d.ts +49 -1
  20. package/types/sap.fe.tools.d.ts +1 -1
  21. package/types/sap.feedback.ui.d.ts +1 -1
  22. package/types/sap.gantt.d.ts +229 -1
  23. package/types/sap.insights.d.ts +14 -1
  24. package/types/{mobile-1.145.0-d.ts → sap.m.d.ts} +607 -48
  25. package/types/sap.makit.d.ts +1 -1
  26. package/types/sap.me.d.ts +1 -1
  27. package/types/sap.ndc.d.ts +1 -1
  28. package/types/sap.ovp.d.ts +1 -1
  29. package/types/sap.rules.ui.d.ts +1 -1
  30. package/types/sap.sac.df.d.ts +1 -1
  31. package/types/sap.suite.ui.commons.d.ts +294 -10
  32. package/types/sap.suite.ui.generic.template.d.ts +79 -1
  33. package/types/sap.suite.ui.microchart.d.ts +1 -1
  34. package/types/sap.tnt.d.ts +9 -19
  35. package/types/sap.ui.codeeditor.d.ts +82 -46
  36. package/types/sap.ui.commons.d.ts +1 -1
  37. package/types/sap.ui.comp.d.ts +5 -15
  38. package/types/{core-1.145.0-d.ts → sap.ui.core.d.ts} +1209 -376
  39. package/types/sap.ui.dt.d.ts +1 -1
  40. package/types/sap.ui.export.d.ts +1 -1
  41. package/types/sap.ui.fl.d.ts +9 -1
  42. package/types/sap.ui.generic.app.d.ts +5 -5
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.geomap.d.ts +1 -1
  45. package/types/sap.ui.integration.d.ts +87 -289
  46. package/types/sap.ui.layout.d.ts +1 -1
  47. package/types/{mdc-1.145.0-d.ts → sap.ui.mdc.d.ts} +108 -21
  48. package/types/sap.ui.richtexteditor.d.ts +6 -6
  49. package/types/sap.ui.rta.d.ts +1 -1
  50. package/types/sap.ui.suite.d.ts +1 -1
  51. package/types/sap.ui.support.d.ts +2 -2
  52. package/types/sap.ui.table.d.ts +1 -1
  53. package/types/sap.ui.testrecorder.d.ts +1 -1
  54. package/types/sap.ui.unified.d.ts +41 -11
  55. package/types/sap.ui.ux3.d.ts +1 -1
  56. package/types/sap.ui.vbm.d.ts +8 -24
  57. package/types/sap.ui.vk.d.ts +216 -2
  58. package/types/sap.ui.vtm.d.ts +2 -2
  59. package/types/sap.uiext.inbox.d.ts +1 -1
  60. package/types/sap.ushell.d.ts +590 -196
  61. package/types/sap.ushell_abap.d.ts +1 -1
  62. package/types/sap.uxap.d.ts +146 -1
  63. package/types/sap.viz.d.ts +4 -5
  64. package/types/sap.webanalytics.core.d.ts +1 -1
  65. package/types/sap.zen.commons.d.ts +1 -1
  66. package/types/sap.zen.crosstab.d.ts +1 -1
  67. package/types/sap.zen.dsh.d.ts +1 -1
  68. package/types/sap.ui.webc.common.d.ts +0 -173
  69. package/types/sap.ui.webc.fiori.d.ts +0 -16012
  70. package/types/sap.ui.webc.main.d.ts +0 -51158
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.145.1
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -79,7 +79,7 @@ declare namespace sap {
79
79
  * Describes the settings that can be provided to the Chart constructor.
80
80
  *
81
81
  * @deprecated As of version 1.130. Use {@link sap.fe.macros.Chart} instead
82
- * @experimental
82
+ * @experimental As of version 1.124.
83
83
  */
84
84
  interface $ChartSettings extends sap.ui.core.$ControlSettings {
85
85
  /**
@@ -245,7 +245,7 @@ declare namespace sap {
245
245
  *
246
246
  *
247
247
  * @deprecated As of version 1.130. Use {@link sap.fe.macros.Chart} instead
248
- * @experimental
248
+ * @experimental As of version 1.124.
249
249
  */
250
250
  class Chart extends sap.ui.core.Control {
251
251
  /**
@@ -695,7 +695,7 @@ declare namespace sap {
695
695
  * Describes the settings that can be provided to the BuildingBlockWithTemplating constructor.
696
696
  *
697
697
  * @deprecated As of version 1.140.
698
- * @experimental
698
+ * @experimental As of version 1.136.
699
699
  */
700
700
  interface $BuildingBlockWithTemplatingSettings
701
701
  extends sap.fe.core.buildingBlocks.$BuildingBlockSettings {}
@@ -722,18 +722,133 @@ declare namespace sap {
722
722
  * On change of the main properties you will be able to recreate the content.
723
723
  *
724
724
  * @deprecated As of version 1.140.
725
- * @experimental
725
+ * @experimental As of version 1.136.
726
726
  */
727
727
  class BuildingBlockWithTemplating extends sap.fe.core.buildingBlocks
728
728
  .BuildingBlock {}
729
729
  }
730
730
 
731
731
  namespace field {
732
+ namespace mixin {
733
+ /**
734
+ * Mixin providing control access, value getter and setter, enabled state management, and message handling
735
+ * for field controls.
736
+ * This mixin combines the following functionalities:
737
+ * 1. FieldControlAccessor: access to the inner control of field-based building blocks
738
+ * 2. FieldValueAccessor: value getter and setter and enablement getter and setter
739
+ * 3. FieldMessageHandler: adding and managing validation messages
740
+ * This mixin enables building blocks to programmatically read and write values, enabled state,
741
+ * and validation messages across different control types (CheckBox, Input, and MDC Field).
742
+ */
743
+ class FieldMixin
744
+ implements
745
+ /* was: sap.fe.base.ClassSupport.IInterfaceWithMixin */ Object
746
+ {
747
+ __implements__sap_fe_base_ClassSupport_IInterfaceWithMixin: boolean;
748
+
749
+ /**
750
+ * Adds a validation message to the field.
751
+ * This method creates a new message and associates it with the field's binding path,
752
+ * making it visible in the field's value state and message popover.
753
+ *
754
+ *
755
+ * @returns The ID of the created message
756
+ */
757
+ addMessage(
758
+ /**
759
+ * The message parameters
760
+ */
761
+ parameters: {
762
+ /**
763
+ * Detailed message description
764
+ */
765
+ description?: string;
766
+ /**
767
+ * Message text to display
768
+ */
769
+ message?: string;
770
+ /**
771
+ * Whether the message persists across refreshes
772
+ */
773
+ persistent?: boolean;
774
+ /**
775
+ * Type of the message, such as Error, Warning, Success, or Information
776
+ */
777
+ type?: /* was: sap.ui.core.message.MessageType */ any;
778
+ }
779
+ ): string;
780
+ /**
781
+ * Gets the current enabled state of the field.
782
+ * This method handles various control types and wrappers, returning true for controls
783
+ * that are always enabled, such as Text, and checking the enabled property for interactive controls.
784
+ *
785
+ *
786
+ * @returns Boolean value indicating if the field is enabled, or true if control is not found (graceful
787
+ * fallback)
788
+ */
789
+ getEnabled(): boolean;
790
+ /**
791
+ * Gets the message manager instance from the UI5 core.
792
+ * The message manager is responsible for handling all messages in the application.
793
+ *
794
+ *
795
+ * @returns The Messaging instance
796
+ */
797
+ getMessageManager(): /* was: sap.ui.core.Messaging */ any;
798
+ /**
799
+ * Gets the current value of the field.
800
+ * This method handles various control types including CheckBox, Input, Text, MDC Field,
801
+ * RatingIndicator, Link, Label, ObjectStatus, ObjectIdentifier, and building blocks.
802
+ *
803
+ *
804
+ * @returns The current value of the field or undefined if control is not found
805
+ */
806
+ getValue(): boolean | number | string | undefined;
807
+ /**
808
+ * Removes a message from the field by its ID.
809
+ * This method finds the message in the message model and removes it,
810
+ * clearing it from the field's value state.
811
+ */
812
+ removeMessage(
813
+ /**
814
+ * The ID of the message to remove
815
+ */
816
+ id: string
817
+ ): void;
818
+ /**
819
+ * Sets the current enabled state of the field.
820
+ * This method handles various control types, setting the appropriate property,
821
+ * such as enabled, active, titleActive, or edit mode based on the control type.
822
+ *
823
+ *
824
+ * @returns The current field reference for chaining
825
+ */
826
+ setEnabled(
827
+ /**
828
+ * The enabled state to set
829
+ */
830
+ enabled: boolean
831
+ ): sap.ui.core.Control;
832
+ /**
833
+ * Sets the current value of the field.
834
+ * This method handles various control types including CheckBox, Input, Text, and MDC Field.
835
+ *
836
+ *
837
+ * @returns The current field reference for chaining
838
+ */
839
+ setValue(
840
+ /**
841
+ * The value to set
842
+ */
843
+ value: boolean | number | string
844
+ ): sap.ui.core.Control;
845
+ }
846
+ }
732
847
  /**
733
848
  * Describes the settings that can be provided to the Field constructor.
734
849
  *
735
850
  * @deprecated As of version 1.135. Use {@link sap.fe.macros.Field} instead
736
- * @experimental
851
+ * @experimental As of version 1.130.
737
852
  */
738
853
  interface $FieldSettings extends sap.ui.core.$ControlSettings {
739
854
  /**
@@ -830,6 +945,14 @@ declare namespace sap {
830
945
  */
831
946
  displayMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
832
947
 
948
+ /**
949
+ * Property for defining if the avatar image can be enlarged.
950
+ */
951
+ enableEnlargeImage?:
952
+ | boolean
953
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
954
+ | `{${string}}`;
955
+
833
956
  /**
834
957
  * Determines how the field should be rendered, e.g. as radio buttons.
835
958
  *
@@ -887,7 +1010,7 @@ declare namespace sap {
887
1010
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
888
1011
 
889
1012
  /**
890
- * Defines if the date part of a date time with timezone field should be shown.
1013
+ * Defines if the date part of a date time with timezone field is shown.
891
1014
  *
892
1015
  * The dateTimeOffset field must have a timezone annotation.
893
1016
  * The default value is true.
@@ -920,7 +1043,7 @@ declare namespace sap {
920
1043
  | `{${string}}`;
921
1044
 
922
1045
  /**
923
- * Defines how the full text will be displayed.
1046
+ * Defines how the full text is displayed.
924
1047
  *
925
1048
  * Allowed values are "InPlace" and "Popover"
926
1049
  */
@@ -930,6 +1053,8 @@ declare namespace sap {
930
1053
 
931
1054
  /**
932
1055
  * Maximum number of lines for multiline texts in edit mode.
1056
+ *
1057
+ * Supports int and string type.
933
1058
  */
934
1059
  textLinesEdit?:
935
1060
  | any
@@ -938,6 +1063,8 @@ declare namespace sap {
938
1063
 
939
1064
  /**
940
1065
  * Maximum number of characters from the beginning of the text field that are shown initially.
1066
+ *
1067
+ * Supports int and string type.
941
1068
  */
942
1069
  textMaxCharactersDisplay?:
943
1070
  | any
@@ -949,6 +1076,8 @@ declare namespace sap {
949
1076
  *
950
1077
  * If a multiline text exceeds the maximum number of allowed characters, the counter below the input field
951
1078
  * displays the exact number.
1079
+ *
1080
+ * Supports int and string type.
952
1081
  */
953
1082
  textMaxLength?:
954
1083
  | any
@@ -957,6 +1086,8 @@ declare namespace sap {
957
1086
 
958
1087
  /**
959
1088
  * Maximum number of lines that multiline texts in edit mode can grow to.
1089
+ *
1090
+ * Supports int and string type.
960
1091
  */
961
1092
  textMaxLines?:
962
1093
  | any
@@ -1002,34 +1133,36 @@ declare namespace sap {
1002
1133
  *
1003
1134
  *
1004
1135
  * @deprecated As of version 1.135. Use {@link sap.fe.macros.Field} instead
1005
- * @experimental
1136
+ * @experimental As of version 1.130.
1006
1137
  */
1007
1138
  class Field extends sap.ui.core.Control {
1008
1139
  /**
1009
- * Adds a message to the field.
1140
+ * Adds a validation message to the field.
1141
+ * This method creates a new message and associates it with the field's binding path,
1142
+ * making it visible in the field's value state and message popover.
1010
1143
  *
1011
1144
  *
1012
- * @returns The id of the message
1145
+ * @returns The ID of the created message
1013
1146
  */
1014
1147
  addMessage(
1015
1148
  /**
1016
- * The parameters to create message
1149
+ * The message parameters
1017
1150
  */
1018
1151
  parameters: {
1019
1152
  /**
1020
- * Message description
1153
+ * Detailed message description
1021
1154
  */
1022
1155
  description?: string;
1023
1156
  /**
1024
- * Message text
1157
+ * Message text to display
1025
1158
  */
1026
1159
  message?: string;
1027
1160
  /**
1028
- * True if the message is persistent
1161
+ * Whether the message persists across refreshes
1029
1162
  */
1030
1163
  persistent?: boolean;
1031
1164
  /**
1032
- * Type of the message
1165
+ * Type of the message, such as Error, Warning, Success, or Information
1033
1166
  */
1034
1167
  type?: /* was: sap.ui.core.message.MessageType */ any;
1035
1168
  }
@@ -1168,42 +1301,70 @@ declare namespace sap {
1168
1301
  mParameters?: {}
1169
1302
  ): this;
1170
1303
  /**
1171
- * Gets the current enablement state of the field.
1304
+ * Gets the current enabled state of the field.
1305
+ * This method handles various control types and wrappers, returning true for controls
1306
+ * that are always enabled, such as Text, and checking the enabled property for interactive controls.
1172
1307
  *
1173
1308
  *
1174
- * @returns Boolean value with the enablement state
1309
+ * @returns Boolean value indicating if the field is enabled, or true if control is not found (graceful
1310
+ * fallback)
1175
1311
  */
1176
1312
  getEnabled(): boolean;
1177
1313
  /**
1178
- * Retrieves the current value of the field.
1314
+ * Gets the message manager instance from the UI5 core.
1315
+ * The message manager is responsible for handling all messages in the application.
1179
1316
  *
1180
1317
  *
1181
- * @returns The current value of the field
1318
+ * @returns The Messaging instance
1182
1319
  */
1183
- getValue(): boolean | float | string | undefined;
1320
+ getMessageManager(): /* was: sap.ui.core.Messaging */ any;
1184
1321
  /**
1185
- * Removes a message from the field.
1322
+ * Gets the current value of the field.
1323
+ * This method handles various control types including CheckBox, Input, Text, MDC Field,
1324
+ * RatingIndicator, Link, Label, ObjectStatus, ObjectIdentifier, and building blocks.
1325
+ *
1326
+ *
1327
+ * @returns The current value of the field or undefined if control is not found
1328
+ */
1329
+ getValue(): boolean | number | string | undefined;
1330
+ /**
1331
+ * Removes a message from the field by its ID.
1332
+ * This method finds the message in the message model and removes it,
1333
+ * clearing it from the field's value state.
1186
1334
  */
1187
1335
  removeMessage(
1188
1336
  /**
1189
- * The id of the message
1337
+ * The ID of the message to remove
1190
1338
  */
1191
1339
  id: string
1192
1340
  ): void;
1193
1341
  /**
1194
- * Sets the current enablement state of the field.
1342
+ * Sets the current enabled state of the field.
1343
+ * This method handles various control types, setting the appropriate property,
1344
+ * such as enabled, active, titleActive, or edit mode based on the control type.
1195
1345
  *
1196
1346
  *
1197
- * @returns The current field reference
1347
+ * @returns The current field reference for chaining
1198
1348
  */
1199
- setEnabled(): sap.ui.core.Control;
1349
+ setEnabled(
1350
+ /**
1351
+ * The enabled state to set
1352
+ */
1353
+ enabled: boolean
1354
+ ): sap.ui.core.Control;
1200
1355
  /**
1201
1356
  * Sets the current value of the field.
1357
+ * This method handles various control types including CheckBox, Input, Text, and MDC Field.
1202
1358
  *
1203
1359
  *
1204
- * @returns The current field reference
1360
+ * @returns The current field reference for chaining
1205
1361
  */
1206
- setValue(): sap.ui.core.Control;
1362
+ setValue(
1363
+ /**
1364
+ * The value to set
1365
+ */
1366
+ value: boolean | number | string
1367
+ ): sap.ui.core.Control;
1207
1368
  }
1208
1369
  /**
1209
1370
  * Additional format options for the field.
@@ -1232,10 +1393,9 @@ declare namespace sap {
1232
1393
  /**
1233
1394
  * Describes the settings that can be provided to the FilterBar constructor.
1234
1395
  *
1235
- * @experimental
1396
+ * @deprecated As of version 1.147. Use {@link sap.fe.macros.FilterBar} instead
1236
1397
  */
1237
- interface $FilterBarSettings
1238
- extends sap.fe.macros.controls.$BuildingBlockWithTemplatingSettings {
1398
+ interface $FilterBarSettings extends sap.fe.macros.$FilterBarSettings {
1239
1399
  /**
1240
1400
  * Defines the path of the context used in the current page or block.
1241
1401
  * This setting is defined by the framework.
@@ -1259,8 +1419,9 @@ declare namespace sap {
1259
1419
  * Comma separated list of navigation properties which are considered for filtering.
1260
1420
  */
1261
1421
  navigationPropertiesForPersonalization?:
1262
- | string
1263
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1422
+ | string[]
1423
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1424
+ | `{${string}}`;
1264
1425
 
1265
1426
  /**
1266
1427
  * Handles the visibility of the 'Clear' button on the FilterBar.
@@ -1278,14 +1439,6 @@ declare namespace sap {
1278
1439
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1279
1440
  | `{${string}}`;
1280
1441
 
1281
- /**
1282
- * Parameter which sets the visibility of the FilterBar building block
1283
- */
1284
- visible?:
1285
- | boolean
1286
- | sap.ui.base.ManagedObject.PropertyBindingInfo
1287
- | `{${string}}`;
1288
-
1289
1442
  /**
1290
1443
  * Aggregate filter fields of the FilterBar building block
1291
1444
  */
@@ -1307,7 +1460,7 @@ declare namespace sap {
1307
1460
 
1308
1461
  /**
1309
1462
  * This event is fired after either a filter value or the visibility of a filter item has been changed.
1310
- * The event contains conditions that will be used as filters.
1463
+ * The event contains conditions that are used as filters.
1311
1464
  */
1312
1465
  filterChanged?: (oEvent: sap.ui.base.Event) => void;
1313
1466
 
@@ -1327,6 +1480,12 @@ declare namespace sap {
1327
1480
  */
1328
1481
  anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1329
1482
 
1483
+ /**
1484
+ * The filter field availability.
1485
+ * Allowed values are `Default`, `Adaptation`, and `Hidden`
1486
+ */
1487
+ availability?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1488
+
1330
1489
  /**
1331
1490
  * The property name of the FilterField
1332
1491
  */
@@ -1344,7 +1503,7 @@ declare namespace sap {
1344
1503
  placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1345
1504
 
1346
1505
  /**
1347
- * Defines which property will be influenced by the FilterField.
1506
+ * Defines which property are influenced by the FilterField.
1348
1507
  * This must be a valid property of the entity as this can be used for SAP Companion integration
1349
1508
  */
1350
1509
  property?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
@@ -1408,17 +1567,20 @@ declare namespace sap {
1408
1567
  /**
1409
1568
  * Parameters of the FilterBar#afterClear event.
1410
1569
  */
1411
- interface FilterBar$AfterClearEventParameters {}
1570
+ interface FilterBar$AfterClearEventParameters
1571
+ extends sap.fe.macros.FilterBar$AfterClearEventParameters {}
1412
1572
 
1413
1573
  /**
1414
1574
  * Parameters of the FilterBar#filterChanged event.
1415
1575
  */
1416
- interface FilterBar$FilterChangedEventParameters {}
1576
+ interface FilterBar$FilterChangedEventParameters
1577
+ extends sap.fe.macros.FilterBar$FilterChangedEventParameters {}
1417
1578
 
1418
1579
  /**
1419
1580
  * Parameters of the FilterBar#search event.
1420
1581
  */
1421
- interface FilterBar$SearchEventParameters {}
1582
+ interface FilterBar$SearchEventParameters
1583
+ extends sap.fe.macros.FilterBar$SearchEventParameters {}
1422
1584
 
1423
1585
  /**
1424
1586
  * Usage example:
@@ -1431,16 +1593,32 @@ declare namespace sap {
1431
1593
  * })
1432
1594
  * ```
1433
1595
  *
1434
- * This is currently an experimental API because the structure of the generated content will change to come
1435
- * closer to the FilterBar that you get out of templates.
1436
- * The public method and property will not change but the internal structure will so be careful on your
1437
- * usage.
1596
+ * This is an experimental API because the structure of the generated content has changed to be closer to
1597
+ * the FilterBar that you get from the templates.
1598
+ * The public method and property has not changed but the internal structure has changed so be careful on
1599
+ * your usage.
1438
1600
  *
1439
1601
  *
1440
- * @experimental
1602
+ * @deprecated As of version 1.147. Use {@link sap.fe.macros.FilterBar} instead
1441
1603
  */
1442
- class FilterBar extends sap.fe.macros.controls
1443
- .BuildingBlockWithTemplating {
1604
+ class FilterBar extends sap.fe.macros.FilterBar {
1605
+ /**
1606
+ * Adds a filterField to the FilterBar.
1607
+ * **Note:** When adding a custom filter field that uses a custom operator, ensure you use the correct configuration.
1608
+ * For more information, see {@link topic :5fb9f57fcf12401bbe39a635e9a32a4e Custom Filters with Custom Operators}.
1609
+ *
1610
+ *
1611
+ * @since 1.147.0
1612
+ * @experimental As of version 1.147.0.
1613
+ *
1614
+ * @returns Reference to this to allow method chaining
1615
+ */
1616
+ addFilterField(
1617
+ /**
1618
+ * The filterField to add
1619
+ */
1620
+ filterField: sap.fe.macros.filterBar.FilterField
1621
+ ): this;
1444
1622
  /**
1445
1623
  *
1446
1624
  * @returns Reference to sap.fe.macros.FilterBar
@@ -1603,8 +1781,8 @@ declare namespace sap {
1603
1781
  fireAfterClear(
1604
1782
  /**
1605
1783
  * The parameters to pass along with the event.
1606
- * See {@link .........types.EventHandler> }
1607
- * for the set of parameters that are expected by the event handlers.
1784
+ * See {@link .........types.EventHandler>} for the set
1785
+ * of parameters that are expected by the event handlers.
1608
1786
  */
1609
1787
  mParameters?: {}
1610
1788
  ): this;
@@ -1637,8 +1815,8 @@ declare namespace sap {
1637
1815
  fireSearch(
1638
1816
  /**
1639
1817
  * The parameters to pass along with the event.
1640
- * See {@link .........types.EventHandler> }
1641
- * for the set of parameters that are expected by the event handlers.
1818
+ * See {@link .........types.EventHandler>} for the set
1819
+ * of parameters that are expected by the event handlers.
1642
1820
  */
1643
1821
  mParameters?: {}
1644
1822
  ): this;
@@ -1698,6 +1876,20 @@ declare namespace sap {
1698
1876
  * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant}
1699
1877
  */
1700
1878
  getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
1879
+ /**
1880
+ * Removes a filterField from the FilterBar.
1881
+ *
1882
+ * @since 1.147.0
1883
+ * @experimental As of version 1.147.0.
1884
+ *
1885
+ * @returns The removed filterField or null
1886
+ */
1887
+ removeFilterField(
1888
+ /**
1889
+ * The filterField to remove, or its index or ID
1890
+ */
1891
+ filterField: number | sap.fe.macros.filterBar.FilterField | string
1892
+ ): null | sap.fe.macros.filterBar.FilterField;
1701
1893
  /**
1702
1894
  * Sets the new selected variant in the associated variant management.
1703
1895
  */
@@ -1791,7 +1983,7 @@ declare namespace sap {
1791
1983
  * Triggers the API search on the filter bar.
1792
1984
  *
1793
1985
  *
1794
- * @returns Returns a promise which resolves if filter go is triggered successfully; otherwise gets rejected.
1986
+ * @returns Returns a promise which resolves if the filter is triggered; otherwise it is rejected.
1795
1987
  */
1796
1988
  triggerSearch(): Promise<object | undefined>;
1797
1989
  }
@@ -1801,13 +1993,21 @@ declare namespace sap {
1801
1993
  *
1802
1994
  * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/filterBar/filterBarCustoms Overview of Building Blocks}
1803
1995
  */
1804
- class FilterField extends sap.fe.macros.controls
1805
- .BuildingBlockObjectProperty {}
1996
+ class FilterField
1997
+ extends sap.fe.macros.controls.BuildingBlockObjectProperty
1998
+ implements /* was: sap.fe.macros.filterBar.IFilterField */ Object
1999
+ {
2000
+ __implements__sap_fe_macros_filterBar_IFilterField: boolean;
2001
+ }
1806
2002
  /**
1807
2003
  * Definition of an override for the filter field to be used inside the FilterBar building block.
1808
2004
  */
1809
- class FilterFieldOverride extends sap.fe.macros.controls
1810
- .BuildingBlockObjectProperty {}
2005
+ class FilterFieldOverride
2006
+ extends sap.fe.macros.controls.BuildingBlockObjectProperty
2007
+ implements /* was: sap.fe.macros.filterBar.IFilterField */ Object
2008
+ {
2009
+ __implements__sap_fe_macros_filterBar_IFilterField: boolean;
2010
+ }
1811
2011
 
1812
2012
  /**
1813
2013
  * Event object of the FilterBar#afterClear event.
@@ -1842,7 +2042,7 @@ declare namespace sap {
1842
2042
  extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
1843
2043
  /**
1844
2044
  * If set, the usage of `labelSpanL` and `labelSpanXL` is dependent on the size of the used column.
1845
- * If the space is less than 600px, for example, two columns are used, `labelSpanM` is used instead.
2045
+ * If the space is less than 600px (e.g., 2 columns are used), `labelSpanM` is used instead.
1846
2046
  * Applicable for ResponsiveGridLayout type
1847
2047
  */
1848
2048
  adjustLabelSpan?:
@@ -2029,7 +2229,7 @@ declare namespace sap {
2029
2229
  * Describes the settings that can be provided to the MicroChart constructor.
2030
2230
  *
2031
2231
  * @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart} instead
2032
- * @experimental
2232
+ * @experimental As of version 1.124.
2033
2233
  */
2034
2234
  interface $MicroChartSettings
2035
2235
  extends sap.fe.macros.$MicroChartSettings {
@@ -2117,7 +2317,7 @@ declare namespace sap {
2117
2317
  *
2118
2318
  *
2119
2319
  * @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart} instead
2120
- * @experimental
2320
+ * @experimental As of version 1.124.
2121
2321
  */
2122
2322
  class MicroChart extends sap.fe.macros.MicroChart {
2123
2323
  /**
@@ -2308,6 +2508,8 @@ declare namespace sap {
2308
2508
 
2309
2509
  /**
2310
2510
  * The priority of the group in the custom toolbar.
2511
+ *
2512
+ * @deprecated As of version now. since 1.136 use priority instead
2311
2513
  */
2312
2514
  customToolbarPriority?:
2313
2515
  | int
@@ -2329,6 +2531,8 @@ declare namespace sap {
2329
2531
 
2330
2532
  /**
2331
2533
  * Row number in which the button should be
2534
+ *
2535
+ * @deprecated As of version now. since 1.136 this parameter no longer has any effect
2332
2536
  */
2333
2537
  row?:
2334
2538
  | int
@@ -2370,7 +2574,17 @@ declare namespace sap {
2370
2574
  * Describes the settings that can be provided to the ShareOptions constructor.
2371
2575
  */
2372
2576
  interface $ShareOptionsSettings
2373
- extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {}
2577
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
2578
+ /**
2579
+ * Controls visibility of the "Share in SAP Build Work Zone" option.
2580
+ * This option appears as either "Share in SAP Jam" or "Share in SAP Build Work Zone"
2581
+ * depending on the customer's deployment. Both labels refer to the same functionality.
2582
+ */
2583
+ showShareInWorkzone?:
2584
+ | boolean
2585
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2586
+ | `{${string}}`;
2587
+ }
2374
2588
 
2375
2589
  /**
2376
2590
  * Share Options.
@@ -2765,12 +2979,33 @@ declare namespace sap {
2765
2979
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2766
2980
  | `{${string}}`;
2767
2981
 
2982
+ /**
2983
+ * Determines the AI notice for the column.
2984
+ * The AI notice is used to display information related to AI features. This information is rendered as
2985
+ * an icon in the column header.
2986
+ */
2987
+ aiNotice?:
2988
+ | string
2989
+ | sap.fe.macros.table.ColumnAINotice
2990
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
2991
+
2768
2992
  /**
2769
2993
  * Determines the export settings for the column.
2770
2994
  */
2771
2995
  exportSettings?: sap.fe.macros.table.ColumnExportSettings;
2772
2996
  }
2773
2997
 
2998
+ /**
2999
+ * Describes the settings that can be provided to the ColumnAINotice constructor.
3000
+ */
3001
+ interface $ColumnAINoticeSettings
3002
+ extends sap.fe.macros.controls.$BuildingBlockObjectPropertySettings {
3003
+ /**
3004
+ * Determines the pop-up content of the AINotice to be displayed
3005
+ */
3006
+ content?: sap.ui.core.Control;
3007
+ }
3008
+
2774
3009
  /**
2775
3010
  * Describes the settings that can be provided to the ColumnExportSettings constructor.
2776
3011
  */
@@ -2863,7 +3098,7 @@ declare namespace sap {
2863
3098
  availability?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2864
3099
 
2865
3100
  /**
2866
- * Determines if the column should be excluded from the export.
3101
+ * Determines if the column is excluded from the export.
2867
3102
  */
2868
3103
  disableExport?:
2869
3104
  | boolean
@@ -2902,6 +3137,16 @@ declare namespace sap {
2902
3137
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2903
3138
  | `{${string}}`;
2904
3139
 
3140
+ /**
3141
+ * Determines the AI notice for the column.
3142
+ * The AI notice is used to display information related to AI features. This information is rendered as
3143
+ * an icon in the column header.
3144
+ */
3145
+ aiNotice?:
3146
+ | string
3147
+ | sap.fe.macros.table.ColumnAINotice
3148
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
3149
+
2905
3150
  /**
2906
3151
  * Determines the export settings for the column.
2907
3152
  */
@@ -3144,6 +3389,19 @@ declare namespace sap {
3144
3389
  | string
3145
3390
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
3146
3391
 
3392
+ /**
3393
+ * Indicates if the table should load data when initialized.
3394
+ * This property is used only if a filter bar is associated with the table and doesn't use the liveMode.
3395
+ * If set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or
3396
+ * the mandatory filters are filled in.
3397
+ * If set to `false`, the table waits for the filter bar to be filled in before loading data.
3398
+ * The default value is `false`.
3399
+ */
3400
+ initialLoad?:
3401
+ | boolean
3402
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
3403
+ | `{${string}}`;
3404
+
3147
3405
  /**
3148
3406
  * Defines whether to display the search action.
3149
3407
  */
@@ -3619,6 +3877,19 @@ declare namespace sap {
3619
3877
  | string
3620
3878
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
3621
3879
 
3880
+ /**
3881
+ * Indicates if the table should load data when initialized.
3882
+ * This property is used only if a filter bar is associated with the table and doesn't use the liveMode.
3883
+ * If set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or
3884
+ * the mandatory filters are filled in.
3885
+ * If set to `false`, the table waits for the filter bar to be filled in before loading data.
3886
+ * The default value is `false`.
3887
+ */
3888
+ initialLoad?:
3889
+ | boolean
3890
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
3891
+ | `{${string}}`;
3892
+
3622
3893
  /**
3623
3894
  * Defines the extension point to control whether a source node can be copied to a specific parent node.
3624
3895
  */
@@ -4121,7 +4392,7 @@ declare namespace sap {
4121
4392
  .BuildingBlockObjectProperty {}
4122
4393
  /**
4123
4394
  * Definition of a custom column to be used inside the table.
4124
- * The template for the column has to be provided as the default aggregation
4395
+ * The template for the column must be provided as the default aggregation
4125
4396
  */
4126
4397
  class Column
4127
4398
  extends sap.fe.macros.controls.BuildingBlockObjectProperty
@@ -4129,6 +4400,11 @@ declare namespace sap {
4129
4400
  {
4130
4401
  __implements__sap_fe_macros_table_ITableColumn: boolean;
4131
4402
  }
4403
+ /**
4404
+ * Definition of the AINotice applied to a column within the table.
4405
+ */
4406
+ class ColumnAINotice extends sap.fe.macros.controls
4407
+ .BuildingBlockObjectProperty {}
4132
4408
  /**
4133
4409
  * Definition of the export settings applied to a column within the table.
4134
4410
  */
@@ -5204,18 +5480,58 @@ declare namespace sap {
5204
5480
  >;
5205
5481
  }
5206
5482
  /**
5207
- * Describes the settings that can be provided to the AINotice constructor.
5483
+ * Describes the settings that can be provided to the AlwaysEditableField constructor.
5208
5484
  */
5209
- interface $AINoticeSettings
5210
- extends sap.fe.core.buildingBlocks.$BuildingBlockSettings {
5485
+ interface $AlwaysEditableFieldSettings
5486
+ extends sap.fe.macros.$MacroAPISettings {
5211
5487
  /**
5212
- * The content to display into the popover
5488
+ * Defines the path of the context used in the current page or block.
5489
+ * This setting is defined by the framework.
5213
5490
  */
5214
- popoverContent?:
5215
- | sap.ui.core.Control[]
5216
- | sap.ui.core.Control
5217
- | sap.ui.base.ManagedObject.AggregationBindingInfo
5218
- | `{${string}}`;
5491
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5492
+
5493
+ /**
5494
+ * This is used to optionally provide an external description that comes from a different model than the
5495
+ * oData model.
5496
+ * This must be used in conjunction with the value property.
5497
+ */
5498
+ description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5499
+
5500
+ /**
5501
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
5502
+ * AlwaysEditableField only supports metadata paths with the Property type.
5503
+ */
5504
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5505
+
5506
+ /**
5507
+ * This is used to optionally provide an external value that comes from a different model than the OData
5508
+ * model.
5509
+ * Typically used with JSON models for custom popup scenarios.
5510
+ */
5511
+ value?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5512
+
5513
+ /**
5514
+ * Prefix added to the generated ID of the value help used for the field.
5515
+ */
5516
+ vhIdPrefix?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5517
+
5518
+ /**
5519
+ * A set of options that can be configured.
5520
+ */
5521
+ formatOptions?: sap.fe.macros.field.FieldFormatOptions;
5522
+
5523
+ /**
5524
+ * An event containing details is triggered when the value of the field is changed.
5525
+ */
5526
+ change?: (oEvent: AlwaysEditableField$ChangeEvent) => void;
5527
+
5528
+ /**
5529
+ * An event containing details is triggered when the value of the field is live changed.
5530
+ *
5531
+ *
5532
+ * **Note:** Browsing autocomplete suggestions does not fire the event.
5533
+ */
5534
+ liveChange?: (oEvent: sap.ui.base.Event) => void;
5219
5535
  }
5220
5536
 
5221
5537
  /**
@@ -5480,15 +5796,9 @@ declare namespace sap {
5480
5796
  }
5481
5797
 
5482
5798
  /**
5483
- * Describes the settings that can be provided to the FormElement constructor.
5799
+ * Describes the settings that can be provided to the FilterBar constructor.
5484
5800
  */
5485
- interface $FormElementSettings
5486
- extends sap.ui.layout.form.$FormElementSettings {
5487
- /**
5488
- * Reference to the key of another column already displayed in the table to properly place this one
5489
- */
5490
- anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5491
-
5801
+ interface $FilterBarSettings extends sap.fe.macros.$MacroAPISettings {
5492
5802
  /**
5493
5803
  * Defines the path of the context used in the current page or block.
5494
5804
  * This setting is defined by the framework.
@@ -5496,9 +5806,12 @@ declare namespace sap {
5496
5806
  contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5497
5807
 
5498
5808
  /**
5499
- * Label shown for the field. If not set, the label from the annotations will be shown.
5809
+ * If true, the search is triggered automatically when a filter value is changed.
5500
5810
  */
5501
- label?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5811
+ liveMode?:
5812
+ | boolean
5813
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
5814
+ | `{${string}}`;
5502
5815
 
5503
5816
  /**
5504
5817
  * Defines the relative path of the property in the metamodel, based on the current contextPath.
@@ -5506,42 +5819,123 @@ declare namespace sap {
5506
5819
  metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5507
5820
 
5508
5821
  /**
5509
- * Determines where this column should be placed relative to the defined anchor
5510
- * Allowed values are `Before` and `After`
5822
+ * Comma separated list of navigation properties which are considered for filtering.
5511
5823
  */
5512
- placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5824
+ navigationPropertiesForPersonalization?:
5825
+ | string[]
5826
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
5827
+ | `{${string}}`;
5513
5828
 
5514
5829
  /**
5515
- * If set to false, the FormElement is not rendered.
5830
+ * Handles the visibility of the 'Clear' button on the FilterBar.
5516
5831
  */
5517
- visible?:
5832
+ showClearButton?:
5518
5833
  | boolean
5519
5834
  | sap.ui.base.ManagedObject.PropertyBindingInfo
5520
5835
  | `{${string}}`;
5521
5836
 
5522
5837
  /**
5523
- * Optional aggregation of controls that should be displayed inside the FormElement.
5524
- * If not set, a default Field building block will be rendered
5838
+ * Displays possible errors during the search in a message box
5525
5839
  */
5526
- fields?:
5527
- | sap.ui.core.Control[]
5528
- | sap.ui.core.Control
5840
+ showMessages?:
5841
+ | boolean
5842
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
5843
+ | `{${string}}`;
5844
+
5845
+ /**
5846
+ * Aggregate filter fields of the FilterBar building block
5847
+ */
5848
+ filterFields?:
5849
+ | Array<
5850
+ | sap.fe.macros.filterBar.FilterFieldOverride
5851
+ | sap.fe.macros.filterBar.FilterField
5852
+ >
5853
+ | sap.fe.macros.filterBar.FilterFieldOverride
5854
+ | sap.fe.macros.filterBar.FilterField
5529
5855
  | sap.ui.base.ManagedObject.AggregationBindingInfo
5530
5856
  | `{${string}}`;
5531
- }
5532
5857
 
5533
- /**
5534
- * Describes the settings that can be provided to the KPITag constructor.
5535
- */
5536
- interface $KPITagSettings
5537
- extends sap.fe.core.buildingBlocks.$BuildingBlockSettings {
5538
5858
  /**
5539
- * The Number to be displayed.
5859
+ * This event is fired when the 'Clear' button is pressed. This is only possible when the 'Clear' button
5860
+ * is enabled.
5540
5861
  */
5541
- number?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5862
+ afterClear?: (oEvent: sap.ui.base.Event) => void;
5542
5863
 
5543
5864
  /**
5544
- * Set it to `true` if the KPI should display its status icon.
5865
+ * This event is fired after either a filter value or the visibility of a filter item has been changed.
5866
+ * The event contains conditions that are used as filters.
5867
+ */
5868
+ filterChanged?: (oEvent: sap.ui.base.Event) => void;
5869
+
5870
+ /**
5871
+ * This event is fired when the 'Go' button is pressed or after a condition change.
5872
+ */
5873
+ search?: (oEvent: sap.ui.base.Event) => void;
5874
+ }
5875
+
5876
+ /**
5877
+ * Describes the settings that can be provided to the FormElement constructor.
5878
+ */
5879
+ interface $FormElementSettings
5880
+ extends sap.ui.layout.form.$FormElementSettings {
5881
+ /**
5882
+ * Reference to the key of another column already displayed in the table to properly place this one
5883
+ */
5884
+ anchor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5885
+
5886
+ /**
5887
+ * Defines the path of the context used in the current page or block.
5888
+ * This setting is defined by the framework.
5889
+ */
5890
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5891
+
5892
+ /**
5893
+ * Label shown for the field. If not set, the label from the annotations will be shown.
5894
+ */
5895
+ label?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5896
+
5897
+ /**
5898
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
5899
+ */
5900
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5901
+
5902
+ /**
5903
+ * Determines where this column should be placed relative to the defined anchor
5904
+ * Allowed values are `Before` and `After`
5905
+ */
5906
+ placement?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5907
+
5908
+ /**
5909
+ * If set to false, the FormElement is not rendered.
5910
+ */
5911
+ visible?:
5912
+ | boolean
5913
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
5914
+ | `{${string}}`;
5915
+
5916
+ /**
5917
+ * Optional aggregation of controls that should be displayed inside the FormElement.
5918
+ * If not set, a default Field building block will be rendered
5919
+ */
5920
+ fields?:
5921
+ | sap.ui.core.Control[]
5922
+ | sap.ui.core.Control
5923
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
5924
+ | `{${string}}`;
5925
+ }
5926
+
5927
+ /**
5928
+ * Describes the settings that can be provided to the KPITag constructor.
5929
+ */
5930
+ interface $KPITagSettings
5931
+ extends sap.fe.core.buildingBlocks.$BuildingBlockSettings {
5932
+ /**
5933
+ * The Number to be displayed.
5934
+ */
5935
+ number?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
5936
+
5937
+ /**
5938
+ * Set it to `true` if the KPI should display its status icon.
5545
5939
  */
5546
5940
  showIcon?:
5547
5941
  | boolean
@@ -6117,6 +6511,19 @@ declare namespace sap {
6117
6511
  */
6118
6512
  ignoredFields?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6119
6513
 
6514
+ /**
6515
+ * Indicates if the table should load data when initialized.
6516
+ * This property is used only if a filter bar is associated with the table and doesn't use the liveMode.
6517
+ * If set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or
6518
+ * the mandatory filters are filled in.
6519
+ * If set to `false`, the table waits for the filter bar to be filled in before loading data.
6520
+ * The default value is `false`.
6521
+ */
6522
+ initialLoad?:
6523
+ | boolean
6524
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6525
+ | `{${string}}`;
6526
+
6120
6527
  /**
6121
6528
  * Defines whether to display the search action.
6122
6529
  */
@@ -6518,6 +6925,19 @@ declare namespace sap {
6518
6925
  */
6519
6926
  ignoredFields?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6520
6927
 
6928
+ /**
6929
+ * Indicates if the table should load data when initialized.
6930
+ * This property is used only if a filter bar is associated with the table and doesn't use the liveMode.
6931
+ * If set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or
6932
+ * the mandatory filters are filled in.
6933
+ * If set to `false`, the table waits for the filter bar to be filled in before loading data.
6934
+ * The default value is `false`.
6935
+ */
6936
+ initialLoad?:
6937
+ | boolean
6938
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6939
+ | `{${string}}`;
6940
+
6521
6941
  /**
6522
6942
  * Defines the extension point to control whether a source node can be copied to a specific parent node.
6523
6943
  */
@@ -6824,91 +7244,6 @@ declare namespace sap {
6824
7244
  interface $FlexibleColumnLayoutActionsSettings
6825
7245
  extends sap.ui.core.$ControlSettings {}
6826
7246
 
6827
- /**
6828
- * Describes the settings that can be provided to the FilterBar constructor.
6829
- */
6830
- interface $FilterBarSettings extends sap.fe.macros.$MacroAPISettings {
6831
- /**
6832
- * Defines the path of the context used in the current page or block.
6833
- * This setting is defined by the framework.
6834
- */
6835
- contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6836
-
6837
- /**
6838
- * If true, the search is triggered automatically when a filter value is changed.
6839
- */
6840
- liveMode?:
6841
- | boolean
6842
- | sap.ui.base.ManagedObject.PropertyBindingInfo
6843
- | `{${string}}`;
6844
-
6845
- /**
6846
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
6847
- */
6848
- metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6849
-
6850
- /**
6851
- * Comma separated list of navigation properties which are considered for filtering.
6852
- */
6853
- navigationPropertiesForPersonalization?:
6854
- | string
6855
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
6856
-
6857
- /**
6858
- * Handles the visibility of the 'Clear' button on the FilterBar.
6859
- */
6860
- showClearButton?:
6861
- | boolean
6862
- | sap.ui.base.ManagedObject.PropertyBindingInfo
6863
- | `{${string}}`;
6864
-
6865
- /**
6866
- * Displays possible errors during the search in a message box
6867
- */
6868
- showMessages?:
6869
- | boolean
6870
- | sap.ui.base.ManagedObject.PropertyBindingInfo
6871
- | `{${string}}`;
6872
-
6873
- /**
6874
- * Parameter which sets the visibility of the FilterBar building block
6875
- */
6876
- visible?:
6877
- | boolean
6878
- | sap.ui.base.ManagedObject.PropertyBindingInfo
6879
- | `{${string}}`;
6880
-
6881
- /**
6882
- * Aggregate filter fields of the FilterBar building block
6883
- */
6884
- filterFields?:
6885
- | Array<
6886
- | sap.fe.macros.filterBar.FilterFieldOverride
6887
- | sap.fe.macros.filterBar.FilterField
6888
- >
6889
- | sap.fe.macros.filterBar.FilterFieldOverride
6890
- | sap.fe.macros.filterBar.FilterField
6891
- | sap.ui.base.ManagedObject.AggregationBindingInfo
6892
- | `{${string}}`;
6893
-
6894
- /**
6895
- * This event is fired when the 'Clear' button is pressed. This is only possible when the 'Clear' button
6896
- * is enabled.
6897
- */
6898
- afterClear?: (oEvent: sap.ui.base.Event) => void;
6899
-
6900
- /**
6901
- * This event is fired after either a filter value or the visibility of a filter item has been changed.
6902
- * The event contains conditions that will be used as filters.
6903
- */
6904
- filterChanged?: (oEvent: sap.ui.base.Event) => void;
6905
-
6906
- /**
6907
- * This event is fired when the 'Go' button is pressed or after a condition change.
6908
- */
6909
- search?: (oEvent: sap.ui.base.Event) => void;
6910
- }
6911
-
6912
7247
  /**
6913
7248
  * Describes the settings that can be provided to the Form constructor.
6914
7249
  */
@@ -6967,6 +7302,20 @@ declare namespace sap {
6967
7302
  | `{${string}}`;
6968
7303
  }
6969
7304
 
7305
+ /**
7306
+ * Parameters of the AlwaysEditableField#change event.
7307
+ */
7308
+ interface AlwaysEditableField$ChangeEventParameters {
7309
+ value?: boolean | number | string | undefined;
7310
+
7311
+ isValid?: boolean;
7312
+ }
7313
+
7314
+ /**
7315
+ * Parameters of the AlwaysEditableField#liveChange event.
7316
+ */
7317
+ interface AlwaysEditableField$LiveChangeEventParameters {}
7318
+
6970
7319
  /**
6971
7320
  * Parameters of the Chart#selectionChange event.
6972
7321
  */
@@ -7023,6 +7372,21 @@ declare namespace sap {
7023
7372
  */
7024
7373
  interface Field$LiveChangeEventParameters {}
7025
7374
 
7375
+ /**
7376
+ * Parameters of the FilterBar#afterClear event.
7377
+ */
7378
+ interface FilterBar$AfterClearEventParameters {}
7379
+
7380
+ /**
7381
+ * Parameters of the FilterBar#filterChanged event.
7382
+ */
7383
+ interface FilterBar$FilterChangedEventParameters {}
7384
+
7385
+ /**
7386
+ * Parameters of the FilterBar#search event.
7387
+ */
7388
+ interface FilterBar$SearchEventParameters {}
7389
+
7026
7390
  /**
7027
7391
  * Parameters of the KPITag#press event.
7028
7392
  */
@@ -7083,21 +7447,6 @@ declare namespace sap {
7083
7447
  */
7084
7448
  interface TreeTable$SelectionChangeEventParameters {}
7085
7449
 
7086
- /**
7087
- * Parameters of the FilterBar#afterClear event.
7088
- */
7089
- interface FilterBar$AfterClearEventParameters {}
7090
-
7091
- /**
7092
- * Parameters of the FilterBar#filterChanged event.
7093
- */
7094
- interface FilterBar$FilterChangedEventParameters {}
7095
-
7096
- /**
7097
- * Parameters of the FilterBar#search event.
7098
- */
7099
- interface FilterBar$SearchEventParameters {}
7100
-
7101
7450
  /**
7102
7451
  * Building block that displays a AI notice.
7103
7452
  * It's used to display information related to AI features. This information is rendered either
@@ -7106,34 +7455,65 @@ declare namespace sap {
7106
7455
  *
7107
7456
  * @since 1.145.0
7108
7457
  */
7109
- class AINotice extends sap.fe.core.buildingBlocks.BuildingBlock {}
7458
+ class AINotice extends /* was: sap.fe.controls.AINotice */ Object {}
7110
7459
  /**
7111
- * Building block used to create a chart based on the metadata provided by OData V4.
7112
- * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/chart/chartDefault Overview of Building Blocks}
7460
+ * Building block for creating an always-editable field based on metadata provided by OData V4.
7113
7461
  *
7114
7462
  *
7115
- * Usually, a contextPath and metaPath is expected.
7463
+ * This building block is designed for use with JSON model bindings in custom dialogs and popups,
7464
+ * where the field must always be editable regardless of OData metadata or draft status.
7116
7465
  *
7466
+ *
7467
+ * When creating an AlwaysEditableField building block, you must provide an ID.
7117
7468
  * Usage example:
7118
7469
  *
7119
7470
  * ```javascript
7120
7471
  *
7121
- * <macros:Chart id="MyChart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
7472
+ * <macros:AlwaysEditableField
7473
+ * id="MyAlwaysEditableField"
7474
+ * metaPath="MyProperty"
7475
+ * value="{myJSONModel>/myValue}"
7476
+ * description="{myJSONModel>/myDescription}" />
7122
7477
  * ```
7123
7478
  */
7124
- class Chart
7125
- extends sap.fe.macros.MacroAPI
7126
- implements
7127
- /* was: sap.fe.core.controllerextensions.viewState.IViewStateContributor */ Object
7128
- {
7129
- __implements__sap_fe_core_controllerextensions_viewState_IViewStateContributor: boolean;
7130
-
7479
+ class AlwaysEditableField extends sap.fe.macros.MacroAPI {
7131
7480
  /**
7481
+ * Adds a validation message to the field.
7482
+ * This method creates a new message and associates it with the field's binding path,
7483
+ * making it visible in the field's value state and message popover.
7132
7484
  *
7133
- * @returns Reference to sap.fe.macros.Chart to allow
7134
- * method chaining
7485
+ *
7486
+ * @returns The ID of the created message
7135
7487
  */
7136
- attachSelectionChange(
7488
+ addMessage(
7489
+ /**
7490
+ * The message parameters
7491
+ */
7492
+ parameters: {
7493
+ /**
7494
+ * Detailed message description
7495
+ */
7496
+ description?: string;
7497
+ /**
7498
+ * Message text to display
7499
+ */
7500
+ message?: string;
7501
+ /**
7502
+ * Whether the message persists across refreshes
7503
+ */
7504
+ persistent?: boolean;
7505
+ /**
7506
+ * Type of the message, such as Error, Warning, Success, or Information
7507
+ */
7508
+ type?: /* was: sap.ui.core.message.MessageType */ any;
7509
+ }
7510
+ ): string;
7511
+ /**
7512
+ *
7513
+ * @returns Reference to sap.fe.macros.AlwaysEditableField
7514
+ * to allow method chaining
7515
+ */
7516
+ attachChange(
7137
7517
  /**
7138
7518
  * An application-specific payload object that will be passed to the event handler along with the event
7139
7519
  * object when firing the event
@@ -7142,7 +7522,7 @@ declare namespace sap {
7142
7522
  /**
7143
7523
  * The function to be called when the event occurs
7144
7524
  */
7145
- fnFunction: (p1: Chart$SelectionChangeEvent) => void,
7525
+ fnFunction: (p1: AlwaysEditableField$ChangeEvent) => void,
7146
7526
  /**
7147
7527
  * The context object to call the event handler with. Defaults to this `this` control
7148
7528
  */
@@ -7150,14 +7530,14 @@ declare namespace sap {
7150
7530
  ): this;
7151
7531
  /**
7152
7532
  *
7153
- * @returns Reference to sap.fe.macros.Chart to allow
7154
- * method chaining
7533
+ * @returns Reference to sap.fe.macros.AlwaysEditableField
7534
+ * to allow method chaining
7155
7535
  */
7156
- attachSelectionChange(
7536
+ attachChange(
7157
7537
  /**
7158
7538
  * The function to be called when the event occurs
7159
7539
  */
7160
- fnFunction: (p1: Chart$SelectionChangeEvent) => void,
7540
+ fnFunction: (p1: AlwaysEditableField$ChangeEvent) => void,
7161
7541
  /**
7162
7542
  * The context object to call the event handler with. Defaults to this `this` control
7163
7543
  */
@@ -7165,8 +7545,229 @@ declare namespace sap {
7165
7545
  ): this;
7166
7546
  /**
7167
7547
  *
7168
- * @returns Reference to sap.fe.macros.Chart to allow
7169
- * method chaining
7548
+ * @returns Reference to sap.fe.macros.AlwaysEditableField
7549
+ * to allow method chaining
7550
+ */
7551
+ attachLiveChange(
7552
+ /**
7553
+ * An application-specific payload object that will be passed to the event handler along with the event
7554
+ * object when firing the event
7555
+ */
7556
+ oData: object,
7557
+ /**
7558
+ * The function to be called when the event occurs
7559
+ */
7560
+ fnFunction: (p1: sap.ui.base.Event) => void,
7561
+ /**
7562
+ * The context object to call the event handler with. Defaults to this `this` control
7563
+ */
7564
+ oListener?: object
7565
+ ): this;
7566
+ /**
7567
+ *
7568
+ * @returns Reference to sap.fe.macros.AlwaysEditableField
7569
+ * to allow method chaining
7570
+ */
7571
+ attachLiveChange(
7572
+ /**
7573
+ * The function to be called when the event occurs
7574
+ */
7575
+ fnFunction: (p1: sap.ui.base.Event) => void,
7576
+ /**
7577
+ * The context object to call the event handler with. Defaults to this `this` control
7578
+ */
7579
+ oListener?: object
7580
+ ): this;
7581
+ /**
7582
+ *
7583
+ * @returns Reference to sap.fe.macros.AlwaysEditableField
7584
+ * to allow method chaining
7585
+ */
7586
+ detachChange(
7587
+ /**
7588
+ * The function to be called when the event occurs
7589
+ */
7590
+ fnFunction: (p1: AlwaysEditableField$ChangeEvent) => void,
7591
+ /**
7592
+ * The context object to call the event handler with. Defaults to this `this` control
7593
+ */
7594
+ oListener?: object
7595
+ ): this;
7596
+ /**
7597
+ *
7598
+ * @returns Reference to sap.fe.macros.AlwaysEditableField
7599
+ * to allow method chaining
7600
+ */
7601
+ detachLiveChange(
7602
+ /**
7603
+ * The function to be called when the event occurs
7604
+ */
7605
+ fnFunction: (p1: sap.ui.base.Event) => void,
7606
+ /**
7607
+ * The context object to call the event handler with. Defaults to this `this` control
7608
+ */
7609
+ oListener?: object
7610
+ ): this;
7611
+ /**
7612
+ * Fires event change
7613
+ * to attached listeners.
7614
+ *
7615
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7616
+ *
7617
+ * @returns Reference to sap.fe.macros.AlwaysEditableField
7618
+ * to allow method chaining
7619
+ */
7620
+ fireChange(
7621
+ /**
7622
+ * The parameters to pass along with the event.
7623
+ * See {@link types.EventHandler> }
7624
+ * for the set of parameters that are expected by the event handlers.
7625
+ */
7626
+ mParameters?: sap.fe.macros.AlwaysEditableField$ChangeEventParameters
7627
+ ): this;
7628
+ /**
7629
+ * Fires event liveChange
7630
+ * to attached listeners.
7631
+ *
7632
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7633
+ *
7634
+ * @returns Reference to sap.fe.macros.AlwaysEditableField
7635
+ * to allow method chaining
7636
+ */
7637
+ fireLiveChange(
7638
+ /**
7639
+ * The parameters to pass along with the event.
7640
+ * See {@link types.EventHandler>} for the set of parameters
7641
+ * that are expected by the event handlers.
7642
+ */
7643
+ mParameters?: {}
7644
+ ): this;
7645
+ /**
7646
+ * Gets the current enabled state of the field.
7647
+ * This method handles various control types and wrappers, returning true for controls
7648
+ * that are always enabled, such as Text, and checking the enabled property for interactive controls.
7649
+ *
7650
+ *
7651
+ * @returns Boolean value indicating if the field is enabled, or true if control is not found (graceful
7652
+ * fallback)
7653
+ */
7654
+ getEnabled(): boolean;
7655
+ /**
7656
+ * Gets the message manager instance from the UI5 core.
7657
+ * The message manager is responsible for handling all messages in the application.
7658
+ *
7659
+ *
7660
+ * @returns The Messaging instance
7661
+ */
7662
+ getMessageManager(): /* was: sap.ui.core.Messaging */ any;
7663
+ /**
7664
+ * Gets the current value of the field.
7665
+ * This method handles various control types including CheckBox, Input, Text, MDC Field,
7666
+ * RatingIndicator, Link, Label, ObjectStatus, ObjectIdentifier, and building blocks.
7667
+ *
7668
+ *
7669
+ * @returns The current value of the field or undefined if control is not found
7670
+ */
7671
+ getValue(): boolean | number | string | undefined;
7672
+ /**
7673
+ * Removes a message from the field by its ID.
7674
+ * This method finds the message in the message model and removes it,
7675
+ * clearing it from the field's value state.
7676
+ */
7677
+ removeMessage(
7678
+ /**
7679
+ * The ID of the message to remove
7680
+ */
7681
+ id: string
7682
+ ): void;
7683
+ /**
7684
+ * Sets the current enabled state of the field.
7685
+ * This method handles various control types, setting the appropriate property,
7686
+ * such as enabled, active, titleActive, or edit mode based on the control type.
7687
+ *
7688
+ *
7689
+ * @returns The current field reference for chaining
7690
+ */
7691
+ setEnabled(
7692
+ /**
7693
+ * The enabled state to set
7694
+ */
7695
+ enabled: boolean
7696
+ ): sap.ui.core.Control;
7697
+ /**
7698
+ * Sets the current value of the field.
7699
+ * This method handles various control types including CheckBox, Input, Text, and MDC Field.
7700
+ *
7701
+ *
7702
+ * @returns The current field reference for chaining
7703
+ */
7704
+ setValue(
7705
+ /**
7706
+ * The value to set
7707
+ */
7708
+ value: boolean | number | string
7709
+ ): sap.ui.core.Control;
7710
+ }
7711
+ /**
7712
+ * Building block used to create a chart based on the metadata provided by OData V4.
7713
+ * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/chart/chartDefault Overview of Building Blocks}
7714
+ *
7715
+ *
7716
+ * Usually, a contextPath and metaPath is expected.
7717
+ *
7718
+ * Usage example:
7719
+ *
7720
+ * ```javascript
7721
+ *
7722
+ * <macros:Chart id="MyChart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
7723
+ * ```
7724
+ */
7725
+ class Chart
7726
+ extends sap.fe.macros.MacroAPI
7727
+ implements
7728
+ /* was: sap.fe.core.controllerextensions.viewState.IViewStateContributor */ Object
7729
+ {
7730
+ __implements__sap_fe_core_controllerextensions_viewState_IViewStateContributor: boolean;
7731
+
7732
+ /**
7733
+ *
7734
+ * @returns Reference to sap.fe.macros.Chart to allow
7735
+ * method chaining
7736
+ */
7737
+ attachSelectionChange(
7738
+ /**
7739
+ * An application-specific payload object that will be passed to the event handler along with the event
7740
+ * object when firing the event
7741
+ */
7742
+ oData: object,
7743
+ /**
7744
+ * The function to be called when the event occurs
7745
+ */
7746
+ fnFunction: (p1: Chart$SelectionChangeEvent) => void,
7747
+ /**
7748
+ * The context object to call the event handler with. Defaults to this `this` control
7749
+ */
7750
+ oListener?: object
7751
+ ): this;
7752
+ /**
7753
+ *
7754
+ * @returns Reference to sap.fe.macros.Chart to allow
7755
+ * method chaining
7756
+ */
7757
+ attachSelectionChange(
7758
+ /**
7759
+ * The function to be called when the event occurs
7760
+ */
7761
+ fnFunction: (p1: Chart$SelectionChangeEvent) => void,
7762
+ /**
7763
+ * The context object to call the event handler with. Defaults to this `this` control
7764
+ */
7765
+ oListener?: object
7766
+ ): this;
7767
+ /**
7768
+ *
7769
+ * @returns Reference to sap.fe.macros.Chart to allow
7770
+ * method chaining
7170
7771
  */
7171
7772
  detachSelectionChange(
7172
7773
  /**
@@ -7687,30 +8288,32 @@ declare namespace sap {
7687
8288
  */
7688
8289
  class Field extends sap.fe.macros.MacroAPI {
7689
8290
  /**
7690
- * Adds a message to the field.
8291
+ * Adds a validation message to the field.
8292
+ * This method creates a new message and associates it with the field's binding path,
8293
+ * making it visible in the field's value state and message popover.
7691
8294
  *
7692
8295
  *
7693
- * @returns The id of the message
8296
+ * @returns The ID of the created message
7694
8297
  */
7695
8298
  addMessage(
7696
8299
  /**
7697
- * The parameters to create message
8300
+ * The message parameters
7698
8301
  */
7699
8302
  parameters: {
7700
8303
  /**
7701
- * Message description
8304
+ * Detailed message description
7702
8305
  */
7703
8306
  description?: string;
7704
8307
  /**
7705
- * Message text
8308
+ * Message text to display
7706
8309
  */
7707
8310
  message?: string;
7708
8311
  /**
7709
- * True if the message is persistent
8312
+ * Whether the message persists across refreshes
7710
8313
  */
7711
8314
  persistent?: boolean;
7712
8315
  /**
7713
- * Type of the message
8316
+ * Type of the message, such as Error, Warning, Success, or Information
7714
8317
  */
7715
8318
  type?: /* was: sap.ui.core.message.MessageType */ any;
7716
8319
  }
@@ -7849,59 +8452,109 @@ declare namespace sap {
7849
8452
  mParameters?: {}
7850
8453
  ): this;
7851
8454
  /**
7852
- * Gets the current enablement state of the field.
8455
+ * Gets the current enabled state of the field.
8456
+ * This method handles various control types and wrappers, returning true for controls
8457
+ * that are always enabled, such as Text, and checking the enabled property for interactive controls.
7853
8458
  *
7854
8459
  *
7855
- * @returns Boolean value with the enablement state
8460
+ * @returns Boolean value indicating if the field is enabled, or true if control is not found (graceful
8461
+ * fallback)
7856
8462
  */
7857
8463
  getEnabled(): boolean;
7858
8464
  /**
7859
- * Retrieves the current value of the field.
8465
+ * Gets the message manager instance from the UI5 core.
8466
+ * The message manager is responsible for handling all messages in the application.
7860
8467
  *
7861
8468
  *
7862
- * @returns The current value of the field
8469
+ * @returns The Messaging instance
7863
8470
  */
7864
- getValue(): boolean | float | string | undefined;
8471
+ getMessageManager(): /* was: sap.ui.core.Messaging */ any;
7865
8472
  /**
7866
- * Removes a message from the field.
8473
+ * Gets the current value of the field.
8474
+ * This method handles various control types including CheckBox, Input, Text, MDC Field,
8475
+ * RatingIndicator, Link, Label, ObjectStatus, ObjectIdentifier, and building blocks.
8476
+ *
8477
+ *
8478
+ * @returns The current value of the field or undefined if control is not found
8479
+ */
8480
+ getValue(): boolean | number | string | undefined;
8481
+ /**
8482
+ * Removes a message from the field by its ID.
8483
+ * This method finds the message in the message model and removes it,
8484
+ * clearing it from the field's value state.
7867
8485
  */
7868
8486
  removeMessage(
7869
8487
  /**
7870
- * The id of the message
8488
+ * The ID of the message to remove
7871
8489
  */
7872
8490
  id: string
7873
8491
  ): void;
7874
8492
  /**
7875
- * Sets the current enablement state of the field.
8493
+ * Sets the current enabled state of the field.
8494
+ * This method handles various control types, setting the appropriate property,
8495
+ * such as enabled, active, titleActive, or edit mode based on the control type.
7876
8496
  *
7877
8497
  *
7878
- * @returns The current field reference
8498
+ * @returns The current field reference for chaining
7879
8499
  */
7880
- setEnabled(): sap.ui.core.Control;
8500
+ setEnabled(
8501
+ /**
8502
+ * The enabled state to set
8503
+ */
8504
+ enabled: boolean
8505
+ ): sap.ui.core.Control;
7881
8506
  /**
7882
8507
  * Sets the current value of the field.
8508
+ * This method handles various control types including CheckBox, Input, Text, and MDC Field.
7883
8509
  *
7884
8510
  *
7885
- * @returns The current field reference
8511
+ * @returns The current field reference for chaining
7886
8512
  */
7887
- setValue(): sap.ui.core.Control;
8513
+ setValue(
8514
+ /**
8515
+ * The value to set
8516
+ */
8517
+ value: boolean | number | string
8518
+ ): sap.ui.core.Control;
7888
8519
  }
7889
8520
  /**
7890
- * Building block used to create a form element based on the metadata provided by OData V4.
8521
+ * Building block for creating a FilterBar based on the metadata provided by OData V4.
8522
+ * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/filterBar/filterBarDefault Overview of Building Blocks}
7891
8523
  *
7892
- * @since 1.90.0
7893
- */
7894
- class FormElement extends sap.ui.layout.form.FormElement {}
7895
- /**
7896
- * Building block used to create a KPI tag.
8524
+ *
8525
+ * Usually, a SelectionFields annotation is expected.
8526
+ *
8527
+ * Usage example:
8528
+ *
8529
+ * ```javascript
8530
+ *
8531
+ * <macros:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
8532
+ * ```
7897
8533
  */
7898
- class KPITag extends sap.fe.core.buildingBlocks.BuildingBlock {
8534
+ class FilterBar extends sap.fe.macros.MacroAPI {
7899
8535
  /**
8536
+ * Adds a filterField to the FilterBar.
8537
+ * **Note:** When adding a custom filter field that uses a custom operator, ensure you use the correct configuration.
8538
+ * For more information, see {@link topic :5fb9f57fcf12401bbe39a635e9a32a4e Custom Filters with Custom Operators}.
7900
8539
  *
7901
- * @returns Reference to sap.fe.macros.KPITag to
7902
- * allow method chaining
8540
+ *
8541
+ * @since 1.147.0
8542
+ * @experimental As of version 1.147.0.
8543
+ *
8544
+ * @returns Reference to this to allow method chaining
7903
8545
  */
7904
- attachPress(
8546
+ addFilterField(
8547
+ /**
8548
+ * The filterField to add
8549
+ */
8550
+ filterField: sap.fe.macros.filterBar.FilterField
8551
+ ): this;
8552
+ /**
8553
+ *
8554
+ * @returns Reference to sap.fe.macros.FilterBar
8555
+ * to allow method chaining
8556
+ */
8557
+ attachAfterClear(
7905
8558
  /**
7906
8559
  * An application-specific payload object that will be passed to the event handler along with the event
7907
8560
  * object when firing the event
@@ -7918,10 +8571,10 @@ declare namespace sap {
7918
8571
  ): this;
7919
8572
  /**
7920
8573
  *
7921
- * @returns Reference to sap.fe.macros.KPITag to
7922
- * allow method chaining
8574
+ * @returns Reference to sap.fe.macros.FilterBar
8575
+ * to allow method chaining
7923
8576
  */
7924
- attachPress(
8577
+ attachAfterClear(
7925
8578
  /**
7926
8579
  * The function to be called when the event occurs
7927
8580
  */
@@ -7933,10 +8586,15 @@ declare namespace sap {
7933
8586
  ): this;
7934
8587
  /**
7935
8588
  *
7936
- * @returns Reference to sap.fe.macros.KPITag to
7937
- * allow method chaining
8589
+ * @returns Reference to sap.fe.macros.FilterBar
8590
+ * to allow method chaining
7938
8591
  */
7939
- detachPress(
8592
+ attachFilterChanged(
8593
+ /**
8594
+ * An application-specific payload object that will be passed to the event handler along with the event
8595
+ * object when firing the event
8596
+ */
8597
+ oData: object,
7940
8598
  /**
7941
8599
  * The function to be called when the event occurs
7942
8600
  */
@@ -7947,48 +8605,26 @@ declare namespace sap {
7947
8605
  oListener?: object
7948
8606
  ): this;
7949
8607
  /**
7950
- * Fires event press to attached listeners.
7951
- *
7952
- * @ui5-protected Do not call from applications (only from related classes in the framework)
7953
8608
  *
7954
- * @returns Reference to sap.fe.macros.KPITag to
7955
- * allow method chaining
8609
+ * @returns Reference to sap.fe.macros.FilterBar
8610
+ * to allow method chaining
7956
8611
  */
7957
- firePress(
8612
+ attachFilterChanged(
7958
8613
  /**
7959
- * The parameters to pass along with the event.
7960
- * See {@link .........types.EventHandler>} for the set of parameters that
7961
- * are expected by the event handlers.
8614
+ * The function to be called when the event occurs
7962
8615
  */
7963
- mParameters?: {}
8616
+ fnFunction: (p1: sap.ui.base.Event) => void,
8617
+ /**
8618
+ * The context object to call the event handler with. Defaults to this `this` control
8619
+ */
8620
+ oListener?: object
7964
8621
  ): this;
7965
- }
7966
- /**
7967
- * Base API control for building blocks.
7968
- */
7969
- class MacroAPI
7970
- extends sap.fe.core.buildingBlocks.BuildingBlock
7971
- implements sap.ui.core.IFormContent
7972
- {
7973
- __implements__sap_ui_core_IFormContent: boolean;
7974
- }
7975
- /**
7976
- * Building block used to show bound messages.
7977
- * The Message Button Building Block gets the bound messages from the MessageModel.
7978
- * Usage example:
7979
- *
7980
- * ```javascript
7981
- *
7982
- * <macros:MessageButton visibilityChange=".handler.onMessageButtonVisibilityChange" />
7983
- * ```
7984
- */
7985
- class MessageButton extends sap.fe.core.buildingBlocks.BuildingBlock {
7986
8622
  /**
7987
8623
  *
7988
- * @returns Reference to sap.fe.macros.MessageButton
8624
+ * @returns Reference to sap.fe.macros.FilterBar
7989
8625
  * to allow method chaining
7990
8626
  */
7991
- attachVisibilityChange(
8627
+ attachSearch(
7992
8628
  /**
7993
8629
  * An application-specific payload object that will be passed to the event handler along with the event
7994
8630
  * object when firing the event
@@ -7997,7 +8633,7 @@ declare namespace sap {
7997
8633
  /**
7998
8634
  * The function to be called when the event occurs
7999
8635
  */
8000
- fnFunction: (p1: MessageButton$VisibilityChangeEvent) => void,
8636
+ fnFunction: (p1: sap.ui.base.Event) => void,
8001
8637
  /**
8002
8638
  * The context object to call the event handler with. Defaults to this `this` control
8003
8639
  */
@@ -8005,14 +8641,14 @@ declare namespace sap {
8005
8641
  ): this;
8006
8642
  /**
8007
8643
  *
8008
- * @returns Reference to sap.fe.macros.MessageButton
8644
+ * @returns Reference to sap.fe.macros.FilterBar
8009
8645
  * to allow method chaining
8010
8646
  */
8011
- attachVisibilityChange(
8647
+ attachSearch(
8012
8648
  /**
8013
8649
  * The function to be called when the event occurs
8014
8650
  */
8015
- fnFunction: (p1: MessageButton$VisibilityChangeEvent) => void,
8651
+ fnFunction: (p1: sap.ui.base.Event) => void,
8016
8652
  /**
8017
8653
  * The context object to call the event handler with. Defaults to this `this` control
8018
8654
  */
@@ -8020,76 +8656,25 @@ declare namespace sap {
8020
8656
  ): this;
8021
8657
  /**
8022
8658
  *
8023
- * @returns Reference to sap.fe.macros.MessageButton
8659
+ * @returns Reference to sap.fe.macros.FilterBar
8024
8660
  * to allow method chaining
8025
8661
  */
8026
- detachVisibilityChange(
8662
+ detachAfterClear(
8027
8663
  /**
8028
8664
  * The function to be called when the event occurs
8029
8665
  */
8030
- fnFunction: (p1: MessageButton$VisibilityChangeEvent) => void,
8666
+ fnFunction: (p1: sap.ui.base.Event) => void,
8031
8667
  /**
8032
8668
  * The context object to call the event handler with. Defaults to this `this` control
8033
8669
  */
8034
8670
  oListener?: object
8035
8671
  ): this;
8036
- /**
8037
- * Fires event visibilityChange
8038
- * to attached listeners.
8039
- *
8040
- * @ui5-protected Do not call from applications (only from related classes in the framework)
8041
- *
8042
- * @returns Reference to sap.fe.macros.MessageButton
8043
- * to allow method chaining
8044
- */
8045
- fireVisibilityChange(
8046
- /**
8047
- * The parameters to pass along with the event.
8048
- * See {@link .........types.EventHandler>} for the
8049
- * set of parameters that are expected by the event handlers.
8050
- */
8051
- mParameters?: sap.fe.macros.MessageButton$VisibilityChangeEventParameters
8052
- ): this;
8053
- }
8054
- /**
8055
- * Building block used to create a MicroChart based on the metadata provided by OData V4.
8056
- * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/microchart/ Overview of Micro Chart Building Block}
8057
- *
8058
- *
8059
- * Usually, a contextPath and metaPath is expected.
8060
- *
8061
- * Usage example:
8062
- *
8063
- * ```javascript
8064
- *
8065
- * <macros:MicroChart id="MyMicroChart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
8066
- * ```
8067
- *
8068
- *
8069
- * ```javascript
8070
- *
8071
- * sap.ui.require(["sap/fe/macros/MicroChart"], function(MicroChart) {
8072
- * ...
8073
- * new MicroChart("myMicroChart", {metaPath:"@com.sap.vocabularies.UI.v1.Chart"})
8074
- * })
8075
- * ```
8076
- *
8077
- *
8078
- *
8079
- * @since 1.93.0
8080
- */
8081
- class MicroChart extends sap.fe.core.buildingBlocks.BuildingBlock {
8082
8672
  /**
8083
8673
  *
8084
- * @returns Reference to sap.fe.macros.MicroChart
8674
+ * @returns Reference to sap.fe.macros.FilterBar
8085
8675
  * to allow method chaining
8086
8676
  */
8087
- attachTitlePress(
8088
- /**
8089
- * An application-specific payload object that will be passed to the event handler along with the event
8090
- * object when firing the event
8091
- */
8092
- oData: object,
8677
+ detachFilterChanged(
8093
8678
  /**
8094
8679
  * The function to be called when the event occurs
8095
8680
  */
@@ -8101,10 +8686,10 @@ declare namespace sap {
8101
8686
  ): this;
8102
8687
  /**
8103
8688
  *
8104
- * @returns Reference to sap.fe.macros.MicroChart
8689
+ * @returns Reference to sap.fe.macros.FilterBar
8105
8690
  * to allow method chaining
8106
8691
  */
8107
- attachTitlePress(
8692
+ detachSearch(
8108
8693
  /**
8109
8694
  * The function to be called when the event occurs
8110
8695
  */
@@ -8115,235 +8700,236 @@ declare namespace sap {
8115
8700
  oListener?: object
8116
8701
  ): this;
8117
8702
  /**
8703
+ * Fires event afterClear to
8704
+ * attached listeners.
8118
8705
  *
8119
- * @returns Reference to sap.fe.macros.MicroChart
8706
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8707
+ *
8708
+ * @returns Reference to sap.fe.macros.FilterBar
8120
8709
  * to allow method chaining
8121
8710
  */
8122
- detachTitlePress(
8123
- /**
8124
- * The function to be called when the event occurs
8125
- */
8126
- fnFunction: (p1: sap.ui.base.Event) => void,
8711
+ fireAfterClear(
8127
8712
  /**
8128
- * The context object to call the event handler with. Defaults to this `this` control
8713
+ * The parameters to pass along with the event.
8714
+ * See {@link .........types.EventHandler>} for the set
8715
+ * of parameters that are expected by the event handlers.
8129
8716
  */
8130
- oListener?: object
8717
+ mParameters?: {}
8131
8718
  ): this;
8132
8719
  /**
8133
- * Fires event titlePress
8720
+ * Fires event filterChanged
8134
8721
  * to attached listeners.
8135
8722
  *
8136
8723
  * @ui5-protected Do not call from applications (only from related classes in the framework)
8137
8724
  *
8138
- * @returns Reference to sap.fe.macros.MicroChart
8725
+ * @returns Reference to sap.fe.macros.FilterBar
8139
8726
  * to allow method chaining
8140
8727
  */
8141
- fireTitlePress(
8728
+ fireFilterChanged(
8142
8729
  /**
8143
8730
  * The parameters to pass along with the event.
8144
- * See {@link types.EventHandler>} for the set of parameters that are
8145
- * expected by the event handlers.
8731
+ * See {@link .........types.EventHandler> }
8732
+ * for the set of parameters that are expected by the event handlers.
8146
8733
  */
8147
8734
  mParameters?: {}
8148
8735
  ): this;
8149
8736
  /**
8150
- * Gets current value of property contextPath.
8737
+ * Fires event search to attached
8738
+ * listeners.
8151
8739
  *
8740
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8152
8741
  *
8153
- * @returns Value of property `contextPath`
8742
+ * @returns Reference to sap.fe.macros.FilterBar
8743
+ * to allow method chaining
8154
8744
  */
8155
- getContextPath(): string;
8745
+ fireSearch(
8746
+ /**
8747
+ * The parameters to pass along with the event.
8748
+ * See {@link .........types.EventHandler>} for the set
8749
+ * of parameters that are expected by the event handlers.
8750
+ */
8751
+ mParameters?: {}
8752
+ ): this;
8156
8753
  /**
8157
- * Gets current value of property hideOnNoData.
8754
+ * Get the Active Filters Text Summary for the filter bar.
8158
8755
  *
8159
8756
  *
8160
- * @returns Value of property `hideOnNoData`
8757
+ * @returns Active filters summary as text
8161
8758
  */
8162
- getHideOnNoData(): boolean;
8759
+ getActiveFiltersText(): string;
8163
8760
  /**
8164
- * Gets current value of property linkAriaText.
8761
+ * Gets the key of the current variant in the associated variant management.
8165
8762
  *
8166
8763
  *
8167
- * @returns Value of property `linkAriaText`
8764
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
8168
8765
  */
8169
- getLinkAriaText(): string;
8766
+ getCurrentVariantKey(): null | string;
8170
8767
  /**
8171
- * Gets current value of property metaPath.
8768
+ * Determines whether the field is enabled or disabled.
8172
8769
  *
8173
8770
  *
8174
- * @returns Value of property `metaPath`
8771
+ * @returns Whether the filterField is enabled or disabled.
8175
8772
  */
8176
- getMetaPath(): string;
8773
+ getFilterFieldEnabled(
8774
+ /**
8775
+ * Name of the field.
8776
+ */
8777
+ name: string
8778
+ ): boolean;
8177
8779
  /**
8178
- * Gets current value of property showOnlyChart.
8780
+ * Gets the visibility of a filter field.
8179
8781
  *
8180
8782
  *
8181
- * @returns Value of property `showOnlyChart`
8783
+ * @returns A {@link Promise} that resolves to check whether the filter field is visible or not.
8182
8784
  */
8183
- getShowOnlyChart(): boolean;
8785
+ getFilterFieldVisible(
8786
+ /**
8787
+ * The path to the property as a condition path
8788
+ */
8789
+ conditionPath: string
8790
+ ): Promise<boolean>;
8184
8791
  /**
8185
- * Gets current value of property size.
8792
+ * Provides all the filters that are currently active
8793
+ * along with the search expression.
8186
8794
  *
8187
8795
  *
8188
- * @returns Value of property `size`
8796
+ * @returns An array of active filters and the search expression.
8189
8797
  */
8190
- getSize(): string;
8798
+ getFilters(): object;
8191
8799
  /**
8192
- * Gets current value of property titleAsLink.
8800
+ * Get the selection variant from the filter bar.
8801
+ * Note: This method returns all the filter values that are set in the filter bar, including the text from
8802
+ * the search field (with $search as the property name). However, it doesn't return any filter field condition
8803
+ * that uses a custom operator.
8193
8804
  *
8194
8805
  *
8195
- * @returns Value of property `titleAsLink`
8806
+ * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant}
8196
8807
  */
8197
- getTitleAsLink(): boolean;
8808
+ getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
8198
8809
  /**
8199
- * Gets current value of property contextPath.
8810
+ * Removes a filterField from the FilterBar.
8200
8811
  *
8812
+ * @since 1.147.0
8813
+ * @experimental As of version 1.147.0.
8201
8814
  *
8202
- * @returns Value of property `contextPath`
8815
+ * @returns The removed filterField or null
8203
8816
  */
8204
- setContextPath(): string;
8817
+ removeFilterField(
8818
+ /**
8819
+ * The filterField to remove, or its index or ID
8820
+ */
8821
+ filterField: number | sap.fe.macros.filterBar.FilterField | string
8822
+ ): null | sap.fe.macros.filterBar.FilterField;
8205
8823
  /**
8206
- * Gets current value of property hideOnNoData.
8207
- *
8208
- *
8209
- * @returns Value of property `hideOnNoData`
8824
+ * Sets the new selected variant in the associated variant management.
8210
8825
  */
8211
- setHideOnNoData(): boolean;
8826
+ setCurrentVariantKey(
8827
+ /**
8828
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
8829
+ * ignored.
8830
+ */
8831
+ key: string
8832
+ ): void;
8212
8833
  /**
8213
- * Gets current value of property linkAriaText.
8214
- *
8215
- *
8216
- * @returns Value of property `linkAriaText`
8834
+ * Sets the enablement of the field.
8217
8835
  */
8218
- setLinkAriaText(): string;
8836
+ setFilterFieldEnabled(
8837
+ /**
8838
+ * Name of the field that should be enabled or disabled.
8839
+ */
8840
+ name: string,
8841
+ /**
8842
+ * Whether the field should be enabled or disabled.
8843
+ */
8844
+ enabled: boolean
8845
+ ): void;
8219
8846
  /**
8220
- * Gets current value of property metaPath.
8847
+ * Shows or hides any filter field from the filter bar.
8848
+ * The property will not be hidden inside the adaptation dialog and may be re-added.
8221
8849
  *
8222
8850
  *
8223
- * @returns Value of property `metaPath`
8851
+ * @returns A {@link Promise} resolving once the change in visibility was applied
8224
8852
  */
8225
- setMetaPath(): string;
8853
+ setFilterFieldVisible(
8854
+ /**
8855
+ * The path to the property as a condition path
8856
+ */
8857
+ conditionPath: string,
8858
+ /**
8859
+ * Whether it should be shown or hidden
8860
+ */
8861
+ visible: boolean
8862
+ ): Promise<void>;
8226
8863
  /**
8227
- * Gets current value of property showOnlyChart.
8864
+ * Set the filter values for the given property in the filter bar.
8865
+ * The filter values can be either a single value or an array of values.
8866
+ * Each filter value must be represented as a primitive value.
8228
8867
  *
8229
8868
  *
8230
- * @returns Value of property `showOnlyChart`
8869
+ * @returns A promise for asynchronous handling
8231
8870
  */
8232
- setShowOnlyChart(): boolean;
8233
- /**
8234
- * Gets current value of property size.
8235
- *
8871
+ setFilterValues(
8872
+ /**
8873
+ * The path to the property as a condition path
8874
+ */
8875
+ sConditionPath: string,
8876
+ /**
8877
+ * The operator to be used (optional) - if not set, the default operator (EQ) will be used
8878
+ */
8879
+ sOperator: string | undefined,
8880
+ /**
8881
+ * The values to be applied
8882
+ */
8883
+ vValues?:
8884
+ | boolean
8885
+ | boolean[]
8886
+ | number
8887
+ | number[]
8888
+ | string
8889
+ | string[]
8890
+ | undefined
8891
+ ): Promise<void>;
8892
+ /**
8893
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
8894
+ * existing filters and then apply the SelectionVariant values.
8895
+ * Note: This method cannot set the search field text or any filter field condition that relies on a custom
8896
+ * operator.
8236
8897
  *
8237
- * @returns Value of property `size`
8898
+ *
8899
+ * @returns A promise for asynchronous handling
8238
8900
  */
8239
- setSize(): string;
8901
+ setSelectionVariant(
8902
+ /**
8903
+ * The {@link sap.fe.navigation.SelectionVariant} to apply to the filter bar
8904
+ */
8905
+ selectionVariant: sap.fe.navigation.SelectionVariant,
8906
+ /**
8907
+ * Optional. If true, we will use the associated text property values (if they're available in the selectionVariant)
8908
+ * to display the filter value descriptions, instead of loading them from the backend
8909
+ */
8910
+ prefillDescriptions?: boolean
8911
+ ): Promise<any>;
8240
8912
  /**
8241
- * Gets current value of property titleAsLink.
8913
+ * Triggers the API search on the filter bar.
8242
8914
  *
8243
8915
  *
8244
- * @returns Value of property `titleAsLink`
8916
+ * @returns Returns a promise which resolves if the filter is triggered; otherwise it is rejected.
8245
8917
  */
8246
- setTitleAsLink(): boolean;
8918
+ triggerSearch(): Promise<object | undefined>;
8247
8919
  }
8248
8920
  /**
8249
- * Building block for creating a MultiValueField based on the metadata provided by OData V4.
8250
- *
8251
- *
8252
- * The MultiValueField can be used to display either a DataField or Property directly. It has to point to
8253
- * a collection property.
8254
- *
8255
- *
8256
- * Usage example:
8257
- *
8258
- * ```javascript
8259
- *
8260
- * <macro:MultiValueField
8261
- * id="SomeUniqueIdentifier"
8262
- * contextPath="{entitySet>}"
8263
- * metaPath="{dataField>}"
8264
- * />
8265
- * ```
8266
- *
8267
- *
8268
- * @since 1.118.0
8269
- */
8270
- class MultiValueField extends sap.fe.core.buildingBlocks.BuildingBlock {}
8271
- /**
8272
- * Building block used to create a custom page with a title and the content. By default, the page includes
8273
- * a title.
8274
- */
8275
- class Page extends sap.fe.core.buildingBlocks.BuildingBlock {}
8276
- /**
8277
- * Building block used to create a paginator control.
8278
- * Usage example:
8279
- *
8280
- * ```javascript
8281
- *
8282
- * <macros:Paginator />
8283
- * ```
8284
- *
8285
- *
8286
- *
8287
- * @since 1.94.0
8288
- */
8289
- class Paginator extends sap.fe.core.buildingBlocks.BuildingBlock {}
8290
- /**
8291
- * Building block that exposes the RichTextEditor UI5 control.
8292
- * It's used to enter formatted text, and uses the third-party component called TinyMCE.
8293
- *
8294
- *
8295
- * @since 1.117.0
8296
- */
8297
- class RichTextEditor extends sap.fe.core.buildingBlocks.BuildingBlock {}
8298
- /**
8299
- * Metadata-driven building block that exposes the RichTextEditor UI5 control.
8300
- * It's used to enter formatted text and uses the third-party component called TinyMCE.
8301
- *
8302
- *
8303
- * @since 1.117.0
8304
- */
8305
- class RichTextEditorWithMetadata extends sap.fe.macros.RichTextEditor {}
8306
- /**
8307
- * Building block used to create the ‘Share’ functionality.
8308
- *
8309
- *
8310
- * Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with
8311
- * SAP Jam.
8312
- *
8313
- *
8314
- * If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then
8315
- * the 'Save as Tile' option is not visible.
8316
- *
8317
- * Usage example:
8318
- *
8319
- * ```javascript
8320
- *
8321
- * <macros:Share
8322
- * id="someID"
8323
- * visible="true"
8324
- * />
8325
- * ```
8326
- *
8327
- * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/features/shareDefault Overview of Building Blocks}
8328
- *
8921
+ * Building block used to create a form element based on the metadata provided by OData V4.
8329
8922
  *
8330
- * @since 1.93.0
8923
+ * @since 1.90.0
8331
8924
  */
8332
- class Share extends sap.fe.core.buildingBlocks.BuildingBlock {}
8925
+ class FormElement extends sap.ui.layout.form.FormElement {}
8333
8926
  /**
8334
- * Building block to display a status and criticality.
8335
- *
8336
- * @since 1.143.0
8927
+ * Building block used to create a KPI tag.
8337
8928
  */
8338
- class Status
8339
- extends sap.fe.core.buildingBlocks.BuildingBlock
8340
- implements sap.ui.core.IFormContent
8341
- {
8342
- __implements__sap_ui_core_IFormContent: boolean;
8343
-
8929
+ class KPITag extends sap.fe.core.buildingBlocks.BuildingBlock {
8344
8930
  /**
8345
8931
  *
8346
- * @returns Reference to sap.fe.macros.Status to
8932
+ * @returns Reference to sap.fe.macros.KPITag to
8347
8933
  * allow method chaining
8348
8934
  */
8349
8935
  attachPress(
@@ -8363,7 +8949,7 @@ declare namespace sap {
8363
8949
  ): this;
8364
8950
  /**
8365
8951
  *
8366
- * @returns Reference to sap.fe.macros.Status to
8952
+ * @returns Reference to sap.fe.macros.KPITag to
8367
8953
  * allow method chaining
8368
8954
  */
8369
8955
  attachPress(
@@ -8378,7 +8964,7 @@ declare namespace sap {
8378
8964
  ): this;
8379
8965
  /**
8380
8966
  *
8381
- * @returns Reference to sap.fe.macros.Status to
8967
+ * @returns Reference to sap.fe.macros.KPITag to
8382
8968
  * allow method chaining
8383
8969
  */
8384
8970
  detachPress(
@@ -8396,147 +8982,140 @@ declare namespace sap {
8396
8982
  *
8397
8983
  * @ui5-protected Do not call from applications (only from related classes in the framework)
8398
8984
  *
8399
- * @returns Reference to sap.fe.macros.Status to
8985
+ * @returns Reference to sap.fe.macros.KPITag to
8400
8986
  * allow method chaining
8401
8987
  */
8402
8988
  firePress(
8403
8989
  /**
8404
8990
  * The parameters to pass along with the event.
8991
+ * See {@link .........types.EventHandler>} for the set of parameters that
8992
+ * are expected by the event handlers.
8405
8993
  */
8406
8994
  mParameters?: {}
8407
8995
  ): this;
8408
8996
  }
8409
8997
  /**
8410
- * Building block used to create a table based on the metadata provided by OData V4.
8411
- *
8412
- *
8413
- * Usually, a LineItem, PresentationVariant, or SelectionPresentationVariant annotation is expected, but
8414
- * the Table building block can also be used to display an EntitySet.
8415
- *
8416
- *
8417
- * If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
8418
- *
8419
- *
8420
- * If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
8421
- * also has a UI.LineItem as the first property of the Visualizations.
8998
+ * Base API control for building blocks.
8999
+ */
9000
+ class MacroAPI
9001
+ extends sap.fe.core.buildingBlocks.BuildingBlock
9002
+ implements sap.ui.core.IFormContent
9003
+ {
9004
+ __implements__sap_ui_core_IFormContent: boolean;
9005
+ }
9006
+ /**
9007
+ * Building block used to show bound messages.
9008
+ * The Message Button Building Block gets the bound messages from the MessageModel.
8422
9009
  * Usage example:
8423
9010
  *
8424
9011
  * ```javascript
8425
9012
  *
8426
- * <macros:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
9013
+ * <macros:MessageButton visibilityChange=".handler.onMessageButtonVisibilityChange" />
8427
9014
  * ```
8428
- *
8429
- * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/table/tableDefault Overview of Table Building Blocks}
8430
9015
  */
8431
- class Table
8432
- extends sap.fe.macros.MacroAPI
8433
- implements
8434
- /* was: sap.fe.core.IRowBindingInterface */ Object,
8435
- /* was: sap.fe.macros.Table.ITableBlock */ Object
8436
- {
8437
- __implements__sap_fe_core_IRowBindingInterface: boolean;
8438
- __implements__sap_fe_macros_Table_ITableBlock: boolean;
8439
-
9016
+ class MessageButton extends sap.fe.core.buildingBlocks.BuildingBlock {
8440
9017
  /**
8441
- * Adds an action to the table.
8442
- *
8443
- * @since 1.145.0
8444
- * @experimental As of version 1.145.0.
8445
9018
  *
8446
- * @returns Reference to this to allow method chaining
9019
+ * @returns Reference to sap.fe.macros.MessageButton
9020
+ * to allow method chaining
8447
9021
  */
8448
- addAction(
9022
+ attachVisibilityChange(
8449
9023
  /**
8450
- * The action to add
9024
+ * An application-specific payload object that will be passed to the event handler along with the event
9025
+ * object when firing the event
8451
9026
  */
8452
- action: sap.fe.macros.table.Action
9027
+ oData: object,
9028
+ /**
9029
+ * The function to be called when the event occurs
9030
+ */
9031
+ fnFunction: (p1: MessageButton$VisibilityChangeEvent) => void,
9032
+ /**
9033
+ * The context object to call the event handler with. Defaults to this `this` control
9034
+ */
9035
+ oListener?: object
8453
9036
  ): this;
8454
9037
  /**
8455
- * Adds a column to the table.
8456
9038
  *
8457
- * @since 1.145.0
8458
- * @experimental As of version 1.145.0.
8459
- *
8460
- * @returns Reference to this to allow method chaining
9039
+ * @returns Reference to sap.fe.macros.MessageButton
9040
+ * to allow method chaining
8461
9041
  */
8462
- addColumn(
9042
+ attachVisibilityChange(
8463
9043
  /**
8464
- * The column to add
9044
+ * The function to be called when the event occurs
8465
9045
  */
8466
- column: sap.fe.macros.table.Column
9046
+ fnFunction: (p1: MessageButton$VisibilityChangeEvent) => void,
9047
+ /**
9048
+ * The context object to call the event handler with. Defaults to this `this` control
9049
+ */
9050
+ oListener?: object
8467
9051
  ): this;
8468
9052
  /**
8469
- * Adds a message to the table.
8470
- * The message applies to the whole table and not to an individual table row.
8471
9053
  *
9054
+ * @returns Reference to sap.fe.macros.MessageButton
9055
+ * to allow method chaining
9056
+ */
9057
+ detachVisibilityChange(
9058
+ /**
9059
+ * The function to be called when the event occurs
9060
+ */
9061
+ fnFunction: (p1: MessageButton$VisibilityChangeEvent) => void,
9062
+ /**
9063
+ * The context object to call the event handler with. Defaults to this `this` control
9064
+ */
9065
+ oListener?: object
9066
+ ): this;
9067
+ /**
9068
+ * Fires event visibilityChange
9069
+ * to attached listeners.
8472
9070
  *
9071
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8473
9072
  *
8474
- * @returns Promise The ID of the message
9073
+ * @returns Reference to sap.fe.macros.MessageButton
9074
+ * to allow method chaining
8475
9075
  */
8476
- addMessage(
9076
+ fireVisibilityChange(
8477
9077
  /**
8478
- * The parameters to create the message
9078
+ * The parameters to pass along with the event.
9079
+ * See {@link .........types.EventHandler>} for the
9080
+ * set of parameters that are expected by the event handlers.
8479
9081
  */
8480
- parameters: {
8481
- /**
8482
- * Message description
8483
- */
8484
- description?: string;
8485
- /**
8486
- * Message text
8487
- */
8488
- message?: string;
8489
- /**
8490
- * True if the message is persistent
8491
- */
8492
- persistent?: boolean;
8493
- /**
8494
- * Message type
8495
- */
8496
- type?: /* was: sap.ui.core.message.MessageType */ any;
8497
- }
8498
- ): Promise<string>;
8499
- /**
8500
- *
8501
- * @returns Reference to sap.fe.macros.Table to allow
8502
- * method chaining
8503
- */
8504
- attachBeforeRebindTable(
8505
- /**
8506
- * An application-specific payload object that will be passed to the event handler along with the event
8507
- * object when firing the event
8508
- */
8509
- oData: object,
8510
- /**
8511
- * The function to be called when the event occurs
8512
- */
8513
- fnFunction: (p1: Table$BeforeRebindTableEvent) => void,
8514
- /**
8515
- * The context object to call the event handler with. Defaults to this `this` control
8516
- */
8517
- oListener?: object
8518
- ): this;
8519
- /**
8520
- *
8521
- * @returns Reference to sap.fe.macros.Table to allow
8522
- * method chaining
8523
- */
8524
- attachBeforeRebindTable(
8525
- /**
8526
- * The function to be called when the event occurs
8527
- */
8528
- fnFunction: (p1: Table$BeforeRebindTableEvent) => void,
8529
- /**
8530
- * The context object to call the event handler with. Defaults to this `this` control
8531
- */
8532
- oListener?: object
9082
+ mParameters?: sap.fe.macros.MessageButton$VisibilityChangeEventParameters
8533
9083
  ): this;
9084
+ }
9085
+ /**
9086
+ * Building block used to create a MicroChart based on the metadata provided by OData V4.
9087
+ * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/microchart/ Overview of Micro Chart Building Block}
9088
+ *
9089
+ *
9090
+ * Usually, a contextPath and metaPath is expected.
9091
+ *
9092
+ * Usage example:
9093
+ *
9094
+ * ```javascript
9095
+ *
9096
+ * <macros:MicroChart id="MyMicroChart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
9097
+ * ```
9098
+ *
9099
+ *
9100
+ * ```javascript
9101
+ *
9102
+ * sap.ui.require(["sap/fe/macros/MicroChart"], function(MicroChart) {
9103
+ * ...
9104
+ * new MicroChart("myMicroChart", {metaPath:"@com.sap.vocabularies.UI.v1.Chart"})
9105
+ * })
9106
+ * ```
9107
+ *
9108
+ *
9109
+ *
9110
+ * @since 1.93.0
9111
+ */
9112
+ class MicroChart extends sap.fe.core.buildingBlocks.BuildingBlock {
8534
9113
  /**
8535
9114
  *
8536
- * @returns Reference to sap.fe.macros.Table to allow
8537
- * method chaining
9115
+ * @returns Reference to sap.fe.macros.MicroChart
9116
+ * to allow method chaining
8538
9117
  */
8539
- attachRowPress(
9118
+ attachTitlePress(
8540
9119
  /**
8541
9120
  * An application-specific payload object that will be passed to the event handler along with the event
8542
9121
  * object when firing the event
@@ -8553,10 +9132,10 @@ declare namespace sap {
8553
9132
  ): this;
8554
9133
  /**
8555
9134
  *
8556
- * @returns Reference to sap.fe.macros.Table to allow
8557
- * method chaining
9135
+ * @returns Reference to sap.fe.macros.MicroChart
9136
+ * to allow method chaining
8558
9137
  */
8559
- attachRowPress(
9138
+ attachTitlePress(
8560
9139
  /**
8561
9140
  * The function to be called when the event occurs
8562
9141
  */
@@ -8568,15 +9147,10 @@ declare namespace sap {
8568
9147
  ): this;
8569
9148
  /**
8570
9149
  *
8571
- * @returns Reference to sap.fe.macros.Table to allow
8572
- * method chaining
9150
+ * @returns Reference to sap.fe.macros.MicroChart
9151
+ * to allow method chaining
8573
9152
  */
8574
- attachSelectionChange(
8575
- /**
8576
- * An application-specific payload object that will be passed to the event handler along with the event
8577
- * object when firing the event
8578
- */
8579
- oData: object,
9153
+ detachTitlePress(
8580
9154
  /**
8581
9155
  * The function to be called when the event occurs
8582
9156
  */
@@ -8587,303 +9161,313 @@ declare namespace sap {
8587
9161
  oListener?: object
8588
9162
  ): this;
8589
9163
  /**
9164
+ * Fires event titlePress
9165
+ * to attached listeners.
8590
9166
  *
8591
- * @returns Reference to sap.fe.macros.Table to allow
8592
- * method chaining
9167
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
9168
+ *
9169
+ * @returns Reference to sap.fe.macros.MicroChart
9170
+ * to allow method chaining
8593
9171
  */
8594
- attachSelectionChange(
8595
- /**
8596
- * The function to be called when the event occurs
8597
- */
8598
- fnFunction: (p1: sap.ui.base.Event) => void,
9172
+ fireTitlePress(
8599
9173
  /**
8600
- * The context object to call the event handler with. Defaults to this `this` control
9174
+ * The parameters to pass along with the event.
9175
+ * See {@link types.EventHandler>} for the set of parameters that are
9176
+ * expected by the event handlers.
8601
9177
  */
8602
- oListener?: object
9178
+ mParameters?: {}
8603
9179
  ): this;
8604
9180
  /**
8605
- * Clears the selection.
9181
+ * Gets current value of property contextPath.
8606
9182
  *
8607
- * @since 1.142.0
8608
- */
8609
- clearSelection(): void;
8610
- /**
8611
9183
  *
8612
- * @returns Reference to sap.fe.macros.Table to allow
8613
- * method chaining
9184
+ * @returns Value of property `contextPath`
8614
9185
  */
8615
- detachBeforeRebindTable(
8616
- /**
8617
- * The function to be called when the event occurs
8618
- */
8619
- fnFunction: (p1: Table$BeforeRebindTableEvent) => void,
8620
- /**
8621
- * The context object to call the event handler with. Defaults to this `this` control
8622
- */
8623
- oListener?: object
8624
- ): this;
9186
+ getContextPath(): string;
8625
9187
  /**
9188
+ * Gets current value of property hideOnNoData.
8626
9189
  *
8627
- * @returns Reference to sap.fe.macros.Table to allow
8628
- * method chaining
8629
- */
8630
- detachRowPress(
8631
- /**
8632
- * The function to be called when the event occurs
8633
- */
8634
- fnFunction: (p1: sap.ui.base.Event) => void,
8635
- /**
8636
- * The context object to call the event handler with. Defaults to this `this` control
8637
- */
8638
- oListener?: object
8639
- ): this;
8640
- /**
8641
9190
  *
8642
- * @returns Reference to sap.fe.macros.Table to allow
8643
- * method chaining
9191
+ * @returns Value of property `hideOnNoData`
8644
9192
  */
8645
- detachSelectionChange(
8646
- /**
8647
- * The function to be called when the event occurs
8648
- */
8649
- fnFunction: (p1: sap.ui.base.Event) => void,
8650
- /**
8651
- * The context object to call the event handler with. Defaults to this `this` control
8652
- */
8653
- oListener?: object
8654
- ): this;
9193
+ getHideOnNoData(): boolean;
8655
9194
  /**
8656
- * Fires event beforeRebindTable
8657
- * to attached listeners.
9195
+ * Gets current value of property linkAriaText.
8658
9196
  *
8659
- * @ui5-protected Do not call from applications (only from related classes in the framework)
8660
9197
  *
8661
- * @returns Reference to sap.fe.macros.Table to allow
8662
- * method chaining
9198
+ * @returns Value of property `linkAriaText`
8663
9199
  */
8664
- fireBeforeRebindTable(
8665
- /**
8666
- * The parameters to pass along with the event.
8667
- * See {@link types.EventHandler> }
8668
- * for the set of parameters that are expected by the event handlers.
8669
- */
8670
- mParameters?: sap.fe.macros.Table$BeforeRebindTableEventParameters
8671
- ): this;
9200
+ getLinkAriaText(): string;
8672
9201
  /**
8673
- * Fires event rowPress to attached
8674
- * listeners.
9202
+ * Gets current value of property metaPath.
8675
9203
  *
8676
- * @ui5-protected Do not call from applications (only from related classes in the framework)
8677
9204
  *
8678
- * @returns Reference to sap.fe.macros.Table to allow
8679
- * method chaining
9205
+ * @returns Value of property `metaPath`
8680
9206
  */
8681
- fireRowPress(
8682
- /**
8683
- * The parameters to pass along with the event.
8684
- * See {@link types.EventHandler> }
8685
- * for the set of parameters that are expected by the event handlers.
8686
- */
8687
- mParameters?: {}
8688
- ): this;
9207
+ getMetaPath(): string;
8689
9208
  /**
8690
- * Fires event selectionChange
8691
- * to attached listeners.
9209
+ * Gets current value of property showOnlyChart.
8692
9210
  *
8693
- * @ui5-protected Do not call from applications (only from related classes in the framework)
8694
9211
  *
8695
- * @returns Reference to sap.fe.macros.Table to allow
8696
- * method chaining
9212
+ * @returns Value of property `showOnlyChart`
8697
9213
  */
8698
- fireSelectionChange(
8699
- /**
8700
- * The parameters to pass along with the event.
8701
- * See {@link types.EventHandler>} for the set of parameters that
8702
- * are expected by the event handlers.
8703
- */
8704
- mParameters?: {}
8705
- ): this;
9214
+ getShowOnlyChart(): boolean;
8706
9215
  /**
8707
- * Returns all contexts that are loaded in the table.
8708
- * See also the {@link sap.ui.model.odata.v4.ODataListBinding#getAllCurrentContexts } method.
8709
- *
9216
+ * Gets current value of property size.
8710
9217
  *
8711
- * @since 1.142.0
8712
9218
  *
8713
- * @returns All contexts of the table's list binding, or undefined if the table data is not yet loaded.
9219
+ * @returns Value of property `size`
8714
9220
  */
8715
- getAllCurrentContexts(): sap.ui.model.odata.v4.Context[] | undefined;
9221
+ getSize(): string;
8716
9222
  /**
8717
- * Get the count of the row binding of the table.
9223
+ * Gets current value of property titleAsLink.
8718
9224
  *
8719
9225
  *
8720
- * @returns The count of the row binding
9226
+ * @returns Value of property `titleAsLink`
8721
9227
  */
8722
- getCount(): number | undefined;
9228
+ getTitleAsLink(): boolean;
8723
9229
  /**
8724
- * Get the variant management applied to the table.
9230
+ * Gets current value of property contextPath.
8725
9231
  *
8726
9232
  *
8727
- * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
9233
+ * @returns Value of property `contextPath`
8728
9234
  */
8729
- getCurrentVariantKey(): null | string;
9235
+ setContextPath(): string;
8730
9236
  /**
8731
- * Get the fields that should be ignored when generating the table.
9237
+ * Gets current value of property hideOnNoData.
8732
9238
  *
8733
- * @since 1.124.0
8734
- * @experimental As of version 1.124.0.
8735
9239
  *
8736
- * @returns The value of the ignoredFields property
9240
+ * @returns Value of property `hideOnNoData`
8737
9241
  */
8738
- getIgnoredFields(): string;
9242
+ setHideOnNoData(): boolean;
8739
9243
  /**
8740
- * Get the presentation variant that is currently applied on the table.
9244
+ * Gets current value of property linkAriaText.
8741
9245
  *
8742
9246
  *
8743
- * @returns The presentation variant applied to the table
9247
+ * @returns Value of property `linkAriaText`
8744
9248
  */
8745
- getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
9249
+ setLinkAriaText(): string;
8746
9250
  /**
8747
- * Gets contexts from the table that have been selected by the user.
9251
+ * Gets current value of property metaPath.
8748
9252
  *
8749
9253
  *
8750
- * @returns Contexts of the rows selected by the user
9254
+ * @returns Value of property `metaPath`
8751
9255
  */
8752
- getSelectedContexts(): sap.ui.model.odata.v4.Context[];
9256
+ setMetaPath(): string;
8753
9257
  /**
8754
- * Get the selection variant from the table. This function considers only the selection variant applied
8755
- * at the control level.
9258
+ * Gets current value of property showOnlyChart.
8756
9259
  *
8757
9260
  *
8758
- * @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant}
9261
+ * @returns Value of property `showOnlyChart`
8759
9262
  */
8760
- getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
9263
+ setShowOnlyChart(): boolean;
8761
9264
  /**
8762
- * Hide the columns with the given column keys by setting their availability to Default.
9265
+ * Gets current value of property size.
8763
9266
  *
8764
- * @since 1.124.0
8765
- * @experimental As of version 1.124.0.
8766
9267
  *
8767
- * @returns Promise
8768
- */
8769
- hideColumns(
8770
- /**
8771
- * The keys for the columns to hide
8772
- */
8773
- columnKeys: string[]
8774
- ): Promise<void>;
8775
- /**
8776
- * Requests a refresh of the table.
9268
+ * @returns Value of property `size`
8777
9269
  */
8778
- refresh(): void;
9270
+ setSize(): string;
8779
9271
  /**
8780
- * Removes an action from the table.
9272
+ * Gets current value of property titleAsLink.
8781
9273
  *
8782
- * @since 1.145.0
8783
- * @experimental As of version 1.145.0.
8784
9274
  *
8785
- * @returns The removed action or null
9275
+ * @returns Value of property `titleAsLink`
8786
9276
  */
8787
- removeAction(
8788
- /**
8789
- * The action to remove, or its index or ID
8790
- */
8791
- action: number | sap.fe.macros.table.Action | string
8792
- ): null | sap.fe.macros.table.Action;
9277
+ setTitleAsLink(): boolean;
9278
+ }
9279
+ /**
9280
+ * Building block for creating a MultiValueField based on the metadata provided by OData V4.
9281
+ *
9282
+ *
9283
+ * The MultiValueField can be used to display either a DataField or Property directly. It has to point to
9284
+ * a collection property.
9285
+ *
9286
+ *
9287
+ * Usage example:
9288
+ *
9289
+ * ```javascript
9290
+ *
9291
+ * <macro:MultiValueField
9292
+ * id="SomeUniqueIdentifier"
9293
+ * contextPath="{entitySet>}"
9294
+ * metaPath="{dataField>}"
9295
+ * />
9296
+ * ```
9297
+ *
9298
+ *
9299
+ * @since 1.118.0
9300
+ */
9301
+ class MultiValueField extends sap.fe.core.buildingBlocks.BuildingBlock {}
9302
+ /**
9303
+ * Building block used to create a custom page with a title and the content. By default, the page includes
9304
+ * a title.
9305
+ */
9306
+ class Page extends sap.fe.core.buildingBlocks.BuildingBlock {}
9307
+ /**
9308
+ * Building block used to create a paginator control.
9309
+ * Usage example:
9310
+ *
9311
+ * ```javascript
9312
+ *
9313
+ * <macros:Paginator />
9314
+ * ```
9315
+ *
9316
+ *
9317
+ *
9318
+ * @since 1.94.0
9319
+ */
9320
+ class Paginator extends sap.fe.core.buildingBlocks.BuildingBlock {}
9321
+ /**
9322
+ * Building block that exposes the RichTextEditor UI5 control.
9323
+ * It's used to enter formatted text, and uses the third-party component called TinyMCE.
9324
+ *
9325
+ *
9326
+ * @since 1.117.0
9327
+ */
9328
+ class RichTextEditor extends sap.fe.core.buildingBlocks.BuildingBlock {}
9329
+ /**
9330
+ * Metadata-driven building block that exposes the RichTextEditor UI5 control.
9331
+ * It's used to enter formatted text and uses the third-party component called TinyMCE.
9332
+ *
9333
+ *
9334
+ * @since 1.117.0
9335
+ */
9336
+ class RichTextEditorWithMetadata extends sap.fe.macros.RichTextEditor {}
9337
+ /**
9338
+ * Building block used to create the ‘Share’ functionality.
9339
+ *
9340
+ *
9341
+ * Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with
9342
+ * SAP Jam.
9343
+ *
9344
+ *
9345
+ * If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then
9346
+ * the 'Save as Tile' option is not visible.
9347
+ *
9348
+ * Usage example:
9349
+ *
9350
+ * ```javascript
9351
+ *
9352
+ * <macros:Share
9353
+ * id="someID"
9354
+ * visible="true"
9355
+ * />
9356
+ * ```
9357
+ *
9358
+ * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/features/shareDefault Overview of Building Blocks}
9359
+ *
9360
+ *
9361
+ * @since 1.93.0
9362
+ */
9363
+ class Share extends sap.fe.core.buildingBlocks.BuildingBlock {}
9364
+ /**
9365
+ * Building block to display a status and criticality.
9366
+ *
9367
+ * @since 1.143.0
9368
+ */
9369
+ class Status
9370
+ extends sap.fe.core.buildingBlocks.BuildingBlock
9371
+ implements sap.ui.core.IFormContent
9372
+ {
9373
+ __implements__sap_ui_core_IFormContent: boolean;
9374
+
8793
9375
  /**
8794
- * Removes a column from the table.
8795
- *
8796
- * @since 1.145.0
8797
- * @experimental As of version 1.145.0.
8798
9376
  *
8799
- * @returns The removed column or null
9377
+ * @returns Reference to sap.fe.macros.Status to
9378
+ * allow method chaining
8800
9379
  */
8801
- removeColumn(
9380
+ attachPress(
8802
9381
  /**
8803
- * The column to remove, or its index or ID
9382
+ * An application-specific payload object that will be passed to the event handler along with the event
9383
+ * object when firing the event
8804
9384
  */
8805
- column: number | sap.fe.macros.table.Column | string
8806
- ): null | sap.fe.macros.table.Column;
8807
- /**
8808
- * Removes a message from the table.
8809
- */
8810
- removeMessage(
9385
+ oData: object,
8811
9386
  /**
8812
- * The id of the message
9387
+ * The function to be called when the event occurs
8813
9388
  */
8814
- id: string
8815
- ): void;
8816
- /**
8817
- * Set a variant management to the table.
8818
- */
8819
- setCurrentVariantKey(
9389
+ fnFunction: (p1: sap.ui.base.Event) => void,
8820
9390
  /**
8821
- * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
8822
- * ignored.
9391
+ * The context object to call the event handler with. Defaults to this `this` control
8823
9392
  */
8824
- key: string
8825
- ): void;
9393
+ oListener?: object
9394
+ ): this;
8826
9395
  /**
8827
- * Sets the fields that should be ignored when generating the table.
8828
9396
  *
8829
- * @since 1.124.0
8830
- * @experimental As of version 1.124.0.
8831
- *
8832
- * @returns Reference to this to allow method chaining
9397
+ * @returns Reference to sap.fe.macros.Status to
9398
+ * allow method chaining
8833
9399
  */
8834
- setIgnoredFields(
9400
+ attachPress(
8835
9401
  /**
8836
- * The fields to ignore
9402
+ * The function to be called when the event occurs
8837
9403
  */
8838
- ignoredFields: string
8839
- ): this;
8840
- /**
8841
- * Set a new presentation variant to the table.
8842
- */
8843
- setPresentationVariant(
9404
+ fnFunction: (p1: sap.ui.base.Event) => void,
8844
9405
  /**
8845
- * The new presentation variant that is to be set on the table.
9406
+ * The context object to call the event handler with. Defaults to this `this` control
8846
9407
  */
8847
- tablePV: sap.fe.navigation.PresentationVariant
8848
- ): Promise<void>;
9408
+ oListener?: object
9409
+ ): this;
8849
9410
  /**
8850
- * Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
8851
- * filters and then apply the SelectionVariant values.
8852
9411
  *
8853
- *
8854
- * @returns A promise for asynchronous handling
9412
+ * @returns Reference to sap.fe.macros.Status to
9413
+ * allow method chaining
8855
9414
  */
8856
- setSelectionVariant(
9415
+ detachPress(
8857
9416
  /**
8858
- * The {@link sap.fe.navigation.SelectionVariant} to apply to the table
9417
+ * The function to be called when the event occurs
8859
9418
  */
8860
- selectionVariant: sap.fe.navigation.SelectionVariant,
9419
+ fnFunction: (p1: sap.ui.base.Event) => void,
8861
9420
  /**
8862
- * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
8863
- * to display the filter value descriptions, instead of loading them from the backend
9421
+ * The context object to call the event handler with. Defaults to this `this` control
8864
9422
  */
8865
- prefillDescriptions?: boolean
8866
- ): Promise<any>;
9423
+ oListener?: object
9424
+ ): this;
8867
9425
  /**
8868
- * Show the columns with the given column keys by setting their availability to Default.
9426
+ * Fires event press to attached listeners.
8869
9427
  *
8870
- * @since 1.124.0
8871
- * @experimental As of version 1.124.0.
9428
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8872
9429
  *
8873
- * @returns Promise
9430
+ * @returns Reference to sap.fe.macros.Status to
9431
+ * allow method chaining
8874
9432
  */
8875
- showColumns(
9433
+ firePress(
8876
9434
  /**
8877
- * The keys for the columns to show
9435
+ * The parameters to pass along with the event.
8878
9436
  */
8879
- columnKeys: string[]
8880
- ): Promise<void>;
9437
+ mParameters?: {}
9438
+ ): this;
8881
9439
  }
8882
9440
  /**
8883
- * Building block used to create a tree table based on the metadata provided by OData V4.
8884
- * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/table/treeTable Overview of Tree Table Building Block}
9441
+ * Building block used to create a table based on the metadata provided by OData V4.
9442
+ *
9443
+ *
9444
+ * Usually, a LineItem, PresentationVariant, or SelectionPresentationVariant annotation is expected, but
9445
+ * the Table building block can also be used to display an EntitySet.
9446
+ *
9447
+ *
9448
+ * If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
9449
+ *
9450
+ *
9451
+ * If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
9452
+ * also has a UI.LineItem as the first property of the Visualizations.
9453
+ * Usage example:
9454
+ *
9455
+ * ```javascript
9456
+ *
9457
+ * <macros:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
9458
+ * ```
9459
+ *
9460
+ * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/table/tableDefault Overview of Table Building Blocks}
8885
9461
  */
8886
- class TreeTable extends sap.fe.macros.MacroAPI {
9462
+ class Table
9463
+ extends sap.fe.macros.MacroAPI
9464
+ implements
9465
+ /* was: sap.fe.core.IRowBindingInterface */ Object,
9466
+ /* was: sap.fe.macros.Table.ITableBlock */ Object
9467
+ {
9468
+ __implements__sap_fe_core_IRowBindingInterface: boolean;
9469
+ __implements__sap_fe_macros_Table_ITableBlock: boolean;
9470
+
8887
9471
  /**
8888
9472
  * Adds an action to the table.
8889
9473
  *
@@ -8957,7 +9541,7 @@ declare namespace sap {
8957
9541
  /**
8958
9542
  * The function to be called when the event occurs
8959
9543
  */
8960
- fnFunction: (p1: TreeTable$BeforeRebindTableEvent) => void,
9544
+ fnFunction: (p1: Table$BeforeRebindTableEvent) => void,
8961
9545
  /**
8962
9546
  * The context object to call the event handler with. Defaults to this `this` control
8963
9547
  */
@@ -8972,7 +9556,7 @@ declare namespace sap {
8972
9556
  /**
8973
9557
  * The function to be called when the event occurs
8974
9558
  */
8975
- fnFunction: (p1: TreeTable$BeforeRebindTableEvent) => void,
9559
+ fnFunction: (p1: Table$BeforeRebindTableEvent) => void,
8976
9560
  /**
8977
9561
  * The context object to call the event handler with. Defaults to this `this` control
8978
9562
  */
@@ -9063,7 +9647,7 @@ declare namespace sap {
9063
9647
  /**
9064
9648
  * The function to be called when the event occurs
9065
9649
  */
9066
- fnFunction: (p1: TreeTable$BeforeRebindTableEvent) => void,
9650
+ fnFunction: (p1: Table$BeforeRebindTableEvent) => void,
9067
9651
  /**
9068
9652
  * The context object to call the event handler with. Defaults to this `this` control
9069
9653
  */
@@ -9114,7 +9698,7 @@ declare namespace sap {
9114
9698
  * See {@link types.EventHandler> }
9115
9699
  * for the set of parameters that are expected by the event handlers.
9116
9700
  */
9117
- mParameters?: sap.fe.macros.TreeTable$BeforeRebindTableEventParameters
9701
+ mParameters?: sap.fe.macros.Table$BeforeRebindTableEventParameters
9118
9702
  ): this;
9119
9703
  /**
9120
9704
  * Fires event rowPress to attached
@@ -9327,57 +9911,75 @@ declare namespace sap {
9327
9911
  ): Promise<void>;
9328
9912
  }
9329
9913
  /**
9330
- * Building block used to create a Variant Management based on the metadata provided by OData V4.
9331
- * Usage example:
9332
- *
9333
- * ```javascript
9334
- *
9335
- * <macro:VariantManagement
9336
- * id="SomeUniqueIdentifier"
9337
- * for="{listOfControlIds>}"
9338
- * />
9339
- * ```
9340
- *
9341
- * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/filterBar/filterBarVMWithTable Overview of Building Blocks}
9342
- */
9343
- class VariantManagement extends sap.fe.core.buildingBlocks
9344
- .BuildingBlock {}
9345
- /**
9346
- * Building block for adding overflow toolbar buttons to integrate into the flexible column layout support
9347
- * from Fiori elements.
9348
- * Usage example:
9349
- *
9350
- * ```javascript
9351
- *
9352
- * <macros:FlexibleColumnLayoutActions />
9353
- * ```
9354
- *
9355
- *
9356
- *
9357
- * @since 1.93.0
9358
- */
9359
- class FlexibleColumnLayoutActions extends sap.ui.core.Control {}
9360
- /**
9361
- * Building block for creating a FilterBar based on the metadata provided by OData V4.
9362
- * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/filterBar/filterBarDefault Overview of Building Blocks}
9363
- *
9364
- *
9365
- * Usually, a SelectionFields annotation is expected.
9366
- *
9367
- * Usage example:
9368
- *
9369
- * ```javascript
9370
- *
9371
- * <macros:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
9372
- * ```
9914
+ * Building block used to create a tree table based on the metadata provided by OData V4.
9915
+ * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/table/treeTable Overview of Tree Table Building Block}
9373
9916
  */
9374
- class FilterBar extends sap.fe.macros.MacroAPI {
9917
+ class TreeTable extends sap.fe.macros.MacroAPI {
9375
9918
  /**
9919
+ * Adds an action to the table.
9376
9920
  *
9377
- * @returns Reference to sap.fe.macros.FilterBar
9378
- * to allow method chaining
9921
+ * @since 1.145.0
9922
+ * @experimental As of version 1.145.0.
9923
+ *
9924
+ * @returns Reference to this to allow method chaining
9379
9925
  */
9380
- attachAfterClear(
9926
+ addAction(
9927
+ /**
9928
+ * The action to add
9929
+ */
9930
+ action: sap.fe.macros.table.Action
9931
+ ): this;
9932
+ /**
9933
+ * Adds a column to the table.
9934
+ *
9935
+ * @since 1.145.0
9936
+ * @experimental As of version 1.145.0.
9937
+ *
9938
+ * @returns Reference to this to allow method chaining
9939
+ */
9940
+ addColumn(
9941
+ /**
9942
+ * The column to add
9943
+ */
9944
+ column: sap.fe.macros.table.Column
9945
+ ): this;
9946
+ /**
9947
+ * Adds a message to the table.
9948
+ * The message applies to the whole table and not to an individual table row.
9949
+ *
9950
+ *
9951
+ *
9952
+ * @returns Promise The ID of the message
9953
+ */
9954
+ addMessage(
9955
+ /**
9956
+ * The parameters to create the message
9957
+ */
9958
+ parameters: {
9959
+ /**
9960
+ * Message description
9961
+ */
9962
+ description?: string;
9963
+ /**
9964
+ * Message text
9965
+ */
9966
+ message?: string;
9967
+ /**
9968
+ * True if the message is persistent
9969
+ */
9970
+ persistent?: boolean;
9971
+ /**
9972
+ * Message type
9973
+ */
9974
+ type?: /* was: sap.ui.core.message.MessageType */ any;
9975
+ }
9976
+ ): Promise<string>;
9977
+ /**
9978
+ *
9979
+ * @returns Reference to sap.fe.macros.Table to allow
9980
+ * method chaining
9981
+ */
9982
+ attachBeforeRebindTable(
9381
9983
  /**
9382
9984
  * An application-specific payload object that will be passed to the event handler along with the event
9383
9985
  * object when firing the event
@@ -9386,7 +9988,7 @@ declare namespace sap {
9386
9988
  /**
9387
9989
  * The function to be called when the event occurs
9388
9990
  */
9389
- fnFunction: (p1: sap.ui.base.Event) => void,
9991
+ fnFunction: (p1: TreeTable$BeforeRebindTableEvent) => void,
9390
9992
  /**
9391
9993
  * The context object to call the event handler with. Defaults to this `this` control
9392
9994
  */
@@ -9394,14 +9996,14 @@ declare namespace sap {
9394
9996
  ): this;
9395
9997
  /**
9396
9998
  *
9397
- * @returns Reference to sap.fe.macros.FilterBar
9398
- * to allow method chaining
9999
+ * @returns Reference to sap.fe.macros.Table to allow
10000
+ * method chaining
9399
10001
  */
9400
- attachAfterClear(
10002
+ attachBeforeRebindTable(
9401
10003
  /**
9402
10004
  * The function to be called when the event occurs
9403
10005
  */
9404
- fnFunction: (p1: sap.ui.base.Event) => void,
10006
+ fnFunction: (p1: TreeTable$BeforeRebindTableEvent) => void,
9405
10007
  /**
9406
10008
  * The context object to call the event handler with. Defaults to this `this` control
9407
10009
  */
@@ -9409,10 +10011,10 @@ declare namespace sap {
9409
10011
  ): this;
9410
10012
  /**
9411
10013
  *
9412
- * @returns Reference to sap.fe.macros.FilterBar
9413
- * to allow method chaining
10014
+ * @returns Reference to sap.fe.macros.Table to allow
10015
+ * method chaining
9414
10016
  */
9415
- attachFilterChanged(
10017
+ attachRowPress(
9416
10018
  /**
9417
10019
  * An application-specific payload object that will be passed to the event handler along with the event
9418
10020
  * object when firing the event
@@ -9429,10 +10031,10 @@ declare namespace sap {
9429
10031
  ): this;
9430
10032
  /**
9431
10033
  *
9432
- * @returns Reference to sap.fe.macros.FilterBar
9433
- * to allow method chaining
10034
+ * @returns Reference to sap.fe.macros.Table to allow
10035
+ * method chaining
9434
10036
  */
9435
- attachFilterChanged(
10037
+ attachRowPress(
9436
10038
  /**
9437
10039
  * The function to be called when the event occurs
9438
10040
  */
@@ -9444,10 +10046,10 @@ declare namespace sap {
9444
10046
  ): this;
9445
10047
  /**
9446
10048
  *
9447
- * @returns Reference to sap.fe.macros.FilterBar
9448
- * to allow method chaining
10049
+ * @returns Reference to sap.fe.macros.Table to allow
10050
+ * method chaining
9449
10051
  */
9450
- attachSearch(
10052
+ attachSelectionChange(
9451
10053
  /**
9452
10054
  * An application-specific payload object that will be passed to the event handler along with the event
9453
10055
  * object when firing the event
@@ -9464,10 +10066,10 @@ declare namespace sap {
9464
10066
  ): this;
9465
10067
  /**
9466
10068
  *
9467
- * @returns Reference to sap.fe.macros.FilterBar
9468
- * to allow method chaining
10069
+ * @returns Reference to sap.fe.macros.Table to allow
10070
+ * method chaining
9469
10071
  */
9470
- attachSearch(
10072
+ attachSelectionChange(
9471
10073
  /**
9472
10074
  * The function to be called when the event occurs
9473
10075
  */
@@ -9478,15 +10080,21 @@ declare namespace sap {
9478
10080
  oListener?: object
9479
10081
  ): this;
9480
10082
  /**
10083
+ * Clears the selection.
9481
10084
  *
9482
- * @returns Reference to sap.fe.macros.FilterBar
9483
- * to allow method chaining
10085
+ * @since 1.142.0
9484
10086
  */
9485
- detachAfterClear(
10087
+ clearSelection(): void;
10088
+ /**
10089
+ *
10090
+ * @returns Reference to sap.fe.macros.Table to allow
10091
+ * method chaining
10092
+ */
10093
+ detachBeforeRebindTable(
9486
10094
  /**
9487
10095
  * The function to be called when the event occurs
9488
10096
  */
9489
- fnFunction: (p1: sap.ui.base.Event) => void,
10097
+ fnFunction: (p1: TreeTable$BeforeRebindTableEvent) => void,
9490
10098
  /**
9491
10099
  * The context object to call the event handler with. Defaults to this `this` control
9492
10100
  */
@@ -9494,10 +10102,10 @@ declare namespace sap {
9494
10102
  ): this;
9495
10103
  /**
9496
10104
  *
9497
- * @returns Reference to sap.fe.macros.FilterBar
9498
- * to allow method chaining
10105
+ * @returns Reference to sap.fe.macros.Table to allow
10106
+ * method chaining
9499
10107
  */
9500
- detachFilterChanged(
10108
+ detachRowPress(
9501
10109
  /**
9502
10110
  * The function to be called when the event occurs
9503
10111
  */
@@ -9509,10 +10117,10 @@ declare namespace sap {
9509
10117
  ): this;
9510
10118
  /**
9511
10119
  *
9512
- * @returns Reference to sap.fe.macros.FilterBar
9513
- * to allow method chaining
10120
+ * @returns Reference to sap.fe.macros.Table to allow
10121
+ * method chaining
9514
10122
  */
9515
- detachSearch(
10123
+ detachSelectionChange(
9516
10124
  /**
9517
10125
  * The function to be called when the event occurs
9518
10126
  */
@@ -9523,209 +10131,263 @@ declare namespace sap {
9523
10131
  oListener?: object
9524
10132
  ): this;
9525
10133
  /**
9526
- * Fires event afterClear to
9527
- * attached listeners.
10134
+ * Fires event beforeRebindTable
10135
+ * to attached listeners.
9528
10136
  *
9529
10137
  * @ui5-protected Do not call from applications (only from related classes in the framework)
9530
10138
  *
9531
- * @returns Reference to sap.fe.macros.FilterBar
9532
- * to allow method chaining
10139
+ * @returns Reference to sap.fe.macros.Table to allow
10140
+ * method chaining
9533
10141
  */
9534
- fireAfterClear(
10142
+ fireBeforeRebindTable(
9535
10143
  /**
9536
10144
  * The parameters to pass along with the event.
9537
- * See {@link .........types.EventHandler> }
10145
+ * See {@link types.EventHandler> }
9538
10146
  * for the set of parameters that are expected by the event handlers.
9539
10147
  */
9540
- mParameters?: {}
10148
+ mParameters?: sap.fe.macros.TreeTable$BeforeRebindTableEventParameters
9541
10149
  ): this;
9542
10150
  /**
9543
- * Fires event filterChanged
9544
- * to attached listeners.
10151
+ * Fires event rowPress to attached
10152
+ * listeners.
9545
10153
  *
9546
10154
  * @ui5-protected Do not call from applications (only from related classes in the framework)
9547
10155
  *
9548
- * @returns Reference to sap.fe.macros.FilterBar
9549
- * to allow method chaining
10156
+ * @returns Reference to sap.fe.macros.Table to allow
10157
+ * method chaining
9550
10158
  */
9551
- fireFilterChanged(
10159
+ fireRowPress(
9552
10160
  /**
9553
10161
  * The parameters to pass along with the event.
9554
- * See {@link .........types.EventHandler> }
10162
+ * See {@link types.EventHandler> }
9555
10163
  * for the set of parameters that are expected by the event handlers.
9556
10164
  */
9557
10165
  mParameters?: {}
9558
10166
  ): this;
9559
10167
  /**
9560
- * Fires event search to attached
9561
- * listeners.
10168
+ * Fires event selectionChange
10169
+ * to attached listeners.
9562
10170
  *
9563
10171
  * @ui5-protected Do not call from applications (only from related classes in the framework)
9564
10172
  *
9565
- * @returns Reference to sap.fe.macros.FilterBar
9566
- * to allow method chaining
10173
+ * @returns Reference to sap.fe.macros.Table to allow
10174
+ * method chaining
9567
10175
  */
9568
- fireSearch(
10176
+ fireSelectionChange(
9569
10177
  /**
9570
10178
  * The parameters to pass along with the event.
9571
- * See {@link .........types.EventHandler> }
9572
- * for the set of parameters that are expected by the event handlers.
10179
+ * See {@link types.EventHandler>} for the set of parameters that
10180
+ * are expected by the event handlers.
9573
10181
  */
9574
10182
  mParameters?: {}
9575
10183
  ): this;
9576
10184
  /**
9577
- * Get the Active Filters Text Summary for the filter bar.
10185
+ * Returns all contexts that are loaded in the table.
10186
+ * See also the {@link sap.ui.model.odata.v4.ODataListBinding#getAllCurrentContexts } method.
10187
+ *
10188
+ *
10189
+ * @since 1.142.0
10190
+ *
10191
+ * @returns All contexts of the table's list binding, or undefined if the table data is not yet loaded.
10192
+ */
10193
+ getAllCurrentContexts(): sap.ui.model.odata.v4.Context[] | undefined;
10194
+ /**
10195
+ * Get the count of the row binding of the table.
10196
+ *
10197
+ *
10198
+ * @returns The count of the row binding
10199
+ */
10200
+ getCount(): number | undefined;
10201
+ /**
10202
+ * Get the variant management applied to the table.
10203
+ *
10204
+ *
10205
+ * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
10206
+ */
10207
+ getCurrentVariantKey(): null | string;
10208
+ /**
10209
+ * Get the fields that should be ignored when generating the table.
10210
+ *
10211
+ * @since 1.124.0
10212
+ * @experimental As of version 1.124.0.
10213
+ *
10214
+ * @returns The value of the ignoredFields property
10215
+ */
10216
+ getIgnoredFields(): string;
10217
+ /**
10218
+ * Get the presentation variant that is currently applied on the table.
9578
10219
  *
9579
10220
  *
9580
- * @returns Active filters summary as text
10221
+ * @returns The presentation variant applied to the table
9581
10222
  */
9582
- getActiveFiltersText(): string;
10223
+ getPresentationVariant(): Promise<sap.fe.navigation.PresentationVariant>;
9583
10224
  /**
9584
- * Gets the key of the current variant in the associated variant management.
10225
+ * Gets contexts from the table that have been selected by the user.
9585
10226
  *
9586
10227
  *
9587
- * @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
10228
+ * @returns Contexts of the rows selected by the user
9588
10229
  */
9589
- getCurrentVariantKey(): null | string;
10230
+ getSelectedContexts(): sap.ui.model.odata.v4.Context[];
9590
10231
  /**
9591
- * Determines whether the field is enabled or disabled.
10232
+ * Get the selection variant from the table. This function considers only the selection variant applied
10233
+ * at the control level.
9592
10234
  *
9593
10235
  *
9594
- * @returns Whether the filterField is enabled or disabled.
10236
+ * @returns A promise which resolves with {@link sap.fe.navigation.SelectionVariant}
9595
10237
  */
9596
- getFilterFieldEnabled(
9597
- /**
9598
- * Name of the field.
9599
- */
9600
- name: string
9601
- ): boolean;
10238
+ getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
9602
10239
  /**
9603
- * Gets the visibility of a filter field.
10240
+ * Hide the columns with the given column keys by setting their availability to Default.
9604
10241
  *
10242
+ * @since 1.124.0
10243
+ * @experimental As of version 1.124.0.
9605
10244
  *
9606
- * @returns A {@link Promise} that resolves to check whether the filter field is visible or not.
10245
+ * @returns Promise
9607
10246
  */
9608
- getFilterFieldVisible(
10247
+ hideColumns(
9609
10248
  /**
9610
- * The path to the property as a condition path
10249
+ * The keys for the columns to hide
9611
10250
  */
9612
- conditionPath: string
9613
- ): Promise<boolean>;
10251
+ columnKeys: string[]
10252
+ ): Promise<void>;
9614
10253
  /**
9615
- * Provides all the filters that are currently active
9616
- * along with the search expression.
10254
+ * Requests a refresh of the table.
10255
+ */
10256
+ refresh(): void;
10257
+ /**
10258
+ * Removes an action from the table.
9617
10259
  *
10260
+ * @since 1.145.0
10261
+ * @experimental As of version 1.145.0.
9618
10262
  *
9619
- * @returns An array of active filters and the search expression.
10263
+ * @returns The removed action or null
9620
10264
  */
9621
- getFilters(): object;
10265
+ removeAction(
10266
+ /**
10267
+ * The action to remove, or its index or ID
10268
+ */
10269
+ action: number | sap.fe.macros.table.Action | string
10270
+ ): null | sap.fe.macros.table.Action;
9622
10271
  /**
9623
- * Get the selection variant from the filter bar.
9624
- * Note: This method returns all the filter values that are set in the filter bar, including the text from
9625
- * the search field (with $search as the property name). However, it doesn't return any filter field condition
9626
- * that uses a custom operator.
10272
+ * Removes a column from the table.
9627
10273
  *
10274
+ * @since 1.145.0
10275
+ * @experimental As of version 1.145.0.
9628
10276
  *
9629
- * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant}
10277
+ * @returns The removed column or null
9630
10278
  */
9631
- getSelectionVariant(): Promise<sap.fe.navigation.SelectionVariant>;
10279
+ removeColumn(
10280
+ /**
10281
+ * The column to remove, or its index or ID
10282
+ */
10283
+ column: number | sap.fe.macros.table.Column | string
10284
+ ): null | sap.fe.macros.table.Column;
9632
10285
  /**
9633
- * Sets the new selected variant in the associated variant management.
10286
+ * Removes a message from the table.
9634
10287
  */
9635
- setCurrentVariantKey(
10288
+ removeMessage(
9636
10289
  /**
9637
- * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
9638
- * ignored.
10290
+ * The id of the message
9639
10291
  */
9640
- key: string
10292
+ id: string
9641
10293
  ): void;
9642
10294
  /**
9643
- * Sets the enablement of the field.
10295
+ * Set a variant management to the table.
9644
10296
  */
9645
- setFilterFieldEnabled(
9646
- /**
9647
- * Name of the field that should be enabled or disabled.
9648
- */
9649
- name: string,
10297
+ setCurrentVariantKey(
9650
10298
  /**
9651
- * Whether the field should be enabled or disabled.
10299
+ * Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
10300
+ * ignored.
9652
10301
  */
9653
- enabled: boolean
10302
+ key: string
9654
10303
  ): void;
9655
10304
  /**
9656
- * Shows or hides any filter field from the filter bar.
9657
- * The property will not be hidden inside the adaptation dialog and may be re-added.
10305
+ * Sets the fields that should be ignored when generating the table.
9658
10306
  *
10307
+ * @since 1.124.0
10308
+ * @experimental As of version 1.124.0.
9659
10309
  *
9660
- * @returns A {@link Promise} resolving once the change in visibility was applied
10310
+ * @returns Reference to this to allow method chaining
9661
10311
  */
9662
- setFilterFieldVisible(
9663
- /**
9664
- * The path to the property as a condition path
9665
- */
9666
- conditionPath: string,
10312
+ setIgnoredFields(
9667
10313
  /**
9668
- * Whether it should be shown or hidden
10314
+ * The fields to ignore
9669
10315
  */
9670
- visible: boolean
9671
- ): Promise<void>;
10316
+ ignoredFields: string
10317
+ ): this;
9672
10318
  /**
9673
- * Set the filter values for the given property in the filter bar.
9674
- * The filter values can be either a single value or an array of values.
9675
- * Each filter value must be represented as a primitive value.
9676
- *
9677
- *
9678
- * @returns A promise for asynchronous handling
10319
+ * Set a new presentation variant to the table.
9679
10320
  */
9680
- setFilterValues(
9681
- /**
9682
- * The path to the property as a condition path
9683
- */
9684
- sConditionPath: string,
9685
- /**
9686
- * The operator to be used (optional) - if not set, the default operator (EQ) will be used
9687
- */
9688
- sOperator: string | undefined,
10321
+ setPresentationVariant(
9689
10322
  /**
9690
- * The values to be applied
10323
+ * The new presentation variant that is to be set on the table.
9691
10324
  */
9692
- vValues?:
9693
- | boolean
9694
- | boolean[]
9695
- | number
9696
- | number[]
9697
- | string
9698
- | string[]
9699
- | undefined
10325
+ tablePV: sap.fe.navigation.PresentationVariant
9700
10326
  ): Promise<void>;
9701
10327
  /**
9702
- * Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
9703
- * existing filters and then apply the SelectionVariant values.
9704
- * Note: This method cannot set the search field text or any filter field condition that relies on a custom
9705
- * operator.
10328
+ * Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
10329
+ * filters and then apply the SelectionVariant values.
9706
10330
  *
9707
10331
  *
9708
10332
  * @returns A promise for asynchronous handling
9709
10333
  */
9710
10334
  setSelectionVariant(
9711
10335
  /**
9712
- * The {@link sap.fe.navigation.SelectionVariant} to apply to the filter bar
10336
+ * The {@link sap.fe.navigation.SelectionVariant} to apply to the table
9713
10337
  */
9714
10338
  selectionVariant: sap.fe.navigation.SelectionVariant,
9715
10339
  /**
9716
- * Optional. If true, we will use the associated text property values (if they're available in the selectionVariant)
10340
+ * Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
9717
10341
  * to display the filter value descriptions, instead of loading them from the backend
9718
10342
  */
9719
10343
  prefillDescriptions?: boolean
9720
10344
  ): Promise<any>;
9721
10345
  /**
9722
- * Triggers the API search on the filter bar.
10346
+ * Show the columns with the given column keys by setting their availability to Default.
9723
10347
  *
10348
+ * @since 1.124.0
10349
+ * @experimental As of version 1.124.0.
9724
10350
  *
9725
- * @returns Returns a promise which resolves if filter go is triggered successfully; otherwise gets rejected.
10351
+ * @returns Promise
9726
10352
  */
9727
- triggerSearch(): Promise<object | undefined>;
10353
+ showColumns(
10354
+ /**
10355
+ * The keys for the columns to show
10356
+ */
10357
+ columnKeys: string[]
10358
+ ): Promise<void>;
9728
10359
  }
10360
+ /**
10361
+ * Building block used to create a Variant Management based on the metadata provided by OData V4.
10362
+ * Usage example:
10363
+ *
10364
+ * ```javascript
10365
+ *
10366
+ * <macro:VariantManagement
10367
+ * id="SomeUniqueIdentifier"
10368
+ * for="{listOfControlIds>}"
10369
+ * />
10370
+ * ```
10371
+ *
10372
+ * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/filterBar/filterBarVMWithTable Overview of Building Blocks}
10373
+ */
10374
+ class VariantManagement extends sap.fe.core.buildingBlocks
10375
+ .BuildingBlock {}
10376
+ /**
10377
+ * Building block for adding overflow toolbar buttons to integrate into the flexible column layout support
10378
+ * from Fiori elements.
10379
+ * Usage example:
10380
+ *
10381
+ * ```javascript
10382
+ *
10383
+ * <macros:FlexibleColumnLayoutActions />
10384
+ * ```
10385
+ *
10386
+ *
10387
+ *
10388
+ * @since 1.93.0
10389
+ */
10390
+ class FlexibleColumnLayoutActions extends sap.ui.core.Control {}
9729
10391
  /**
9730
10392
  * Building block for creating a Form based on the metadata provided by OData V4.
9731
10393
  *
@@ -9742,6 +10404,22 @@ declare namespace sap {
9742
10404
  */
9743
10405
  class Form extends sap.ui.core.Control {}
9744
10406
 
10407
+ /**
10408
+ * Event object of the AlwaysEditableField#change event.
10409
+ */
10410
+ type AlwaysEditableField$ChangeEvent = sap.ui.base.Event<
10411
+ AlwaysEditableField$ChangeEventParameters,
10412
+ AlwaysEditableField
10413
+ >;
10414
+
10415
+ /**
10416
+ * Event object of the AlwaysEditableField#liveChange event.
10417
+ */
10418
+ type AlwaysEditableField$LiveChangeEvent = sap.ui.base.Event<
10419
+ AlwaysEditableField$LiveChangeEventParameters,
10420
+ AlwaysEditableField
10421
+ >;
10422
+
9745
10423
  /**
9746
10424
  * Event object of the Chart#selectionChange event.
9747
10425
  */
@@ -9790,6 +10468,30 @@ declare namespace sap {
9790
10468
  Field
9791
10469
  >;
9792
10470
 
10471
+ /**
10472
+ * Event object of the FilterBar#afterClear event.
10473
+ */
10474
+ type FilterBar$AfterClearEvent = sap.ui.base.Event<
10475
+ FilterBar$AfterClearEventParameters,
10476
+ FilterBar
10477
+ >;
10478
+
10479
+ /**
10480
+ * Event object of the FilterBar#filterChanged event.
10481
+ */
10482
+ type FilterBar$FilterChangedEvent = sap.ui.base.Event<
10483
+ FilterBar$FilterChangedEventParameters,
10484
+ FilterBar
10485
+ >;
10486
+
10487
+ /**
10488
+ * Event object of the FilterBar#search event.
10489
+ */
10490
+ type FilterBar$SearchEvent = sap.ui.base.Event<
10491
+ FilterBar$SearchEventParameters,
10492
+ FilterBar
10493
+ >;
10494
+
9793
10495
  /**
9794
10496
  * Event object of the KPITag#press event.
9795
10497
  */
@@ -9869,36 +10571,14 @@ declare namespace sap {
9869
10571
  TreeTable$SelectionChangeEventParameters,
9870
10572
  TreeTable
9871
10573
  >;
9872
-
9873
- /**
9874
- * Event object of the FilterBar#afterClear event.
9875
- */
9876
- type FilterBar$AfterClearEvent = sap.ui.base.Event<
9877
- FilterBar$AfterClearEventParameters,
9878
- FilterBar
9879
- >;
9880
-
9881
- /**
9882
- * Event object of the FilterBar#filterChanged event.
9883
- */
9884
- type FilterBar$FilterChangedEvent = sap.ui.base.Event<
9885
- FilterBar$FilterChangedEventParameters,
9886
- FilterBar
9887
- >;
9888
-
9889
- /**
9890
- * Event object of the FilterBar#search event.
9891
- */
9892
- type FilterBar$SearchEvent = sap.ui.base.Event<
9893
- FilterBar$SearchEventParameters,
9894
- FilterBar
9895
- >;
9896
10574
  }
9897
10575
  }
9898
10576
 
9899
10577
  interface IUI5DefineDependencyNames {
9900
10578
  "sap/fe/macros/AINotice": undefined;
9901
10579
 
10580
+ "sap/fe/macros/AlwaysEditableField": undefined;
10581
+
9902
10582
  "sap/fe/macros/Chart": undefined;
9903
10583
 
9904
10584
  "sap/fe/macros/chart/Action": undefined;
@@ -9933,9 +10613,11 @@ declare namespace sap {
9933
10613
 
9934
10614
  "sap/fe/macros/field/FieldFormatOptions": undefined;
9935
10615
 
9936
- "sap/fe/macros/filterBar/FilterBar": undefined;
10616
+ "sap/fe/macros/field/mixin/FieldMixin": undefined;
10617
+
10618
+ "sap/fe/macros/FilterBar": undefined;
9937
10619
 
9938
- "sap/fe/macros/filterBar/FilterBarAPI": undefined;
10620
+ "sap/fe/macros/filterBar/FilterBar": undefined;
9939
10621
 
9940
10622
  "sap/fe/macros/filterBar/FilterField": undefined;
9941
10623
 
@@ -9993,6 +10675,8 @@ declare namespace sap {
9993
10675
 
9994
10676
  "sap/fe/macros/table/Column": undefined;
9995
10677
 
10678
+ "sap/fe/macros/table/ColumnAINotice": undefined;
10679
+
9996
10680
  "sap/fe/macros/table/ColumnExportSettings": undefined;
9997
10681
 
9998
10682
  "sap/fe/macros/table/ColumnOverride": undefined;