@openui5/ts-types 1.93.3 → 1.96.2

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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.93.3
1
+ // For Library Version: 1.96.2
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -7,7 +7,7 @@ declare namespace sap {
7
7
  * @SINCE 1.92.0
8
8
  * @EXPERIMENTAL (since 1.92.0)
9
9
  *
10
- * UI5 library: sap.ui.webc.fiori
10
+ * SAPUI5 library with controls based on UI5 Web Components
11
11
  */
12
12
  namespace fiori {
13
13
  /**
@@ -125,17 +125,17 @@ declare namespace sap {
125
125
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
126
126
 
127
127
  /**
128
- * Defines the content at the end of the bar
128
+ * Defines the content in the middle of the bar
129
129
  */
130
- endContent?:
130
+ content?:
131
131
  | sap.ui.core.Control[]
132
132
  | sap.ui.core.Control
133
133
  | sap.ui.base.ManagedObject.AggregationBindingInfo;
134
134
 
135
135
  /**
136
- * Defines the content in the middle of the bar
136
+ * Defines the content at the end of the bar
137
137
  */
138
- middleContent?:
138
+ endContent?:
139
139
  | sap.ui.core.Control[]
140
140
  | sap.ui.core.Control
141
141
  | sap.ui.base.ManagedObject.AggregationBindingInfo;
@@ -149,6 +149,19 @@ declare namespace sap {
149
149
  | sap.ui.base.ManagedObject.AggregationBindingInfo;
150
150
  }
151
151
 
152
+ interface $BarcodeScannerDialogSettings
153
+ extends sap.ui.webc.common.$WebComponentSettings {
154
+ /**
155
+ * Fires when the scan fails with error.
156
+ */
157
+ scanError?: (oEvent: sap.ui.base.Event) => void;
158
+
159
+ /**
160
+ * Fires when the scan is completed successfuuly.
161
+ */
162
+ scanSuccess?: (oEvent: sap.ui.base.Event) => void;
163
+ }
164
+
152
165
  interface $FlexibleColumnLayoutSettings
153
166
  extends sap.ui.webc.common.$WebComponentSettings {
154
167
  /**
@@ -232,6 +245,45 @@ declare namespace sap {
232
245
  layoutChange?: (oEvent: sap.ui.base.Event) => void;
233
246
  }
234
247
 
248
+ interface $IllustratedMessageSettings
249
+ extends sap.ui.webc.common.$WebComponentSettings {
250
+ name?:
251
+ | sap.ui.webc.fiori.IllustrationMessageType
252
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
253
+
254
+ /**
255
+ * Defines the subtitle of the component.
256
+ *
257
+ * **Note:** Using this property, the default subtitle text of illustration will be overwritten.
258
+ *
259
+ * **Note:** Using `subtitle` slot, the default of this property will be overwritten.
260
+ */
261
+ subtitleText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
262
+
263
+ /**
264
+ * Defines the title of the component.
265
+ *
266
+ * **Note:** Using this property, the default title text of illustration will be overwritten.
267
+ */
268
+ titleText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
269
+
270
+ /**
271
+ * Defines the component actions.
272
+ */
273
+ actions?:
274
+ | sap.ui.webc.main.IButton[]
275
+ | sap.ui.webc.main.IButton
276
+ | sap.ui.base.ManagedObject.AggregationBindingInfo;
277
+
278
+ /**
279
+ * Defines the subtitle of the component.
280
+ *
281
+ * **Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText`
282
+ * property will be overwritten.
283
+ */
284
+ subtitle?: sap.ui.core.Control;
285
+ }
286
+
235
287
  interface $NotificationActionSettings
236
288
  extends sap.ui.webc.common.$WebComponentSettings {
237
289
  /**
@@ -279,14 +331,14 @@ declare namespace sap {
279
331
  busy?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
280
332
 
281
333
  /**
282
- * Defines if the group is collapsed or expanded.
334
+ * Defines the delay in milliseconds, after which the busy indicator will show up for this component.
283
335
  */
284
- collapsed?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
336
+ busyDelay?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
285
337
 
286
338
  /**
287
- * Defines the `heading` of the item.
339
+ * Defines if the group is collapsed or expanded.
288
340
  */
289
- heading?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
341
+ collapsed?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
290
342
 
291
343
  /**
292
344
  * Defines the `priority` of the item. Available options are:
@@ -302,7 +354,7 @@ declare namespace sap {
302
354
  /**
303
355
  * Defines if the `notification` is new or has been already read.
304
356
  *
305
- * **Note:** if set to `false` the `heading` has bold font, if set to true - it has a normal font.
357
+ * **Note:** if set to `false` the `titleText` has bold font, if set to true - it has a normal font.
306
358
  */
307
359
  read?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
308
360
 
@@ -316,6 +368,11 @@ declare namespace sap {
316
368
  */
317
369
  showCounter?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
318
370
 
371
+ /**
372
+ * Defines the `titleText` of the item.
373
+ */
374
+ titleText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
375
+
319
376
  /**
320
377
  * Defines the actions, displayed in the top-right area.
321
378
  *
@@ -354,14 +411,14 @@ declare namespace sap {
354
411
  busy?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
355
412
 
356
413
  /**
357
- * Defines the content of the control
414
+ * Defines the delay in milliseconds, after which the busy indicator will show up for this component.
358
415
  */
359
- description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
416
+ busyDelay?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
360
417
 
361
418
  /**
362
- * Defines the `heading` of the item.
419
+ * Defines the content of the control
363
420
  */
364
- heading?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
421
+ description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
365
422
 
366
423
  /**
367
424
  * Defines the `priority` of the item. Available options are:
@@ -377,7 +434,7 @@ declare namespace sap {
377
434
  /**
378
435
  * Defines if the `notification` is new or has been already read.
379
436
  *
380
- * **Note:** if set to `false` the `heading` has bold font, if set to true - it has a normal font.
437
+ * **Note:** if set to `false` the `titleText` has bold font, if set to true - it has a normal font.
381
438
  */
382
439
  read?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
383
440
 
@@ -387,13 +444,20 @@ declare namespace sap {
387
444
  showClose?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
388
445
 
389
446
  /**
390
- * Defines if the `heading` and `description` should wrap, they truncate by default.
447
+ * Defines the `titleText` of the item.
448
+ */
449
+ titleText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
450
+
451
+ /**
452
+ * Defines if the `titleText` and `description` should wrap, they truncate by default.
391
453
  *
392
454
  *
393
455
  *
394
- * **Note:** by default the `heading` and `decription`, and a `ShowMore/Less` button would be displayed.
456
+ * **Note:** by default the `titleText` and `decription`, and a `ShowMore/Less` button would be displayed.
395
457
  */
396
- wrap?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
458
+ wrappingType?:
459
+ | sap.ui.webc.main.WrappingType
460
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
397
461
 
398
462
  /**
399
463
  * Defines the actions, displayed in the top-right area.
@@ -418,7 +482,7 @@ declare namespace sap {
418
482
  avatar?: sap.ui.webc.main.IAvatar;
419
483
 
420
484
  /**
421
- * Defines the elements, dipalyed in the footer of the of the `sap.ui.webc.fiori.NotificationListItem`.
485
+ * Defines the elements, displayed in the footer of the of the component.
422
486
  */
423
487
  footnotes?:
424
488
  | sap.ui.core.Control[]
@@ -843,6 +907,19 @@ declare namespace sap {
843
907
  | sap.ui.core.CSSSize
844
908
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
845
909
 
910
+ /**
911
+ * Defines the items orientation.
912
+ *
913
+ *
914
+ *
915
+ * **Note:** Available options are:
916
+ * - `Vertical`
917
+ * - `Horizontal`
918
+ */
919
+ layout?:
920
+ | sap.ui.webc.fiori.TimelineLayout
921
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
922
+
846
923
  /**
847
924
  * Defines the width of the control
848
925
  */
@@ -872,14 +949,14 @@ declare namespace sap {
872
949
  icon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
873
950
 
874
951
  /**
875
- * Defines the name of the item.
952
+ * Defines the name of the item, displayed before the `title-text`.
876
953
  */
877
- itemName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
954
+ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
878
955
 
879
956
  /**
880
- * Defines whether the `itemName` is clickable.
957
+ * Defines if the `name` is clickable.
881
958
  */
882
- itemNameClickable?:
959
+ nameClickable?:
883
960
  | boolean
884
961
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
885
962
 
@@ -904,9 +981,9 @@ declare namespace sap {
904
981
  /**
905
982
  * Fired when the item name is pressed either with a click/tap or by using the Enter or Space key.
906
983
  *
907
- * **Note:** The event will not be fired if the `item-name-clickable` attribute is not set.
984
+ * **Note:** The event will not be fired if the `name-clickable` attribute is not set.
908
985
  */
909
- itemNameClick?: (oEvent: sap.ui.base.Event) => void;
986
+ nameClick?: (oEvent: sap.ui.base.Event) => void;
910
987
  }
911
988
 
912
989
  interface $UploadCollectionSettings
@@ -994,7 +1071,7 @@ declare namespace sap {
994
1071
  * **Note:** A Delete button is displayed on each item, when the `sap.ui.webc.fiori.UploadCollection` `mode`
995
1072
  * property is set to `Delete`.
996
1073
  */
997
- fileDeleted?: (oEvent: sap.ui.base.Event) => void;
1074
+ itemDelete?: (oEvent: sap.ui.base.Event) => void;
998
1075
 
999
1076
  /**
1000
1077
  * Fired when selection is changed by user interaction in `SingleSelect` and `MultiSelect` modes.
@@ -1005,7 +1082,14 @@ declare namespace sap {
1005
1082
  interface $UploadCollectionItemSettings
1006
1083
  extends sap.ui.webc.common.$WebComponentSettings {
1007
1084
  /**
1008
- * Holds `File`, associated with this item.
1085
+ * Disables the delete button.
1086
+ */
1087
+ disableDeleteButton?:
1088
+ | boolean
1089
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1090
+
1091
+ /**
1092
+ * Holds an instance of `File` associated with this item.
1009
1093
  */
1010
1094
  file?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
1011
1095
 
@@ -1021,20 +1105,19 @@ declare namespace sap {
1021
1105
  | boolean
1022
1106
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
1023
1107
 
1024
- /**
1025
- * Removes delete option from `sap.ui.webc.fiori.UploadCollection` with `mode` `Delete` for this item.
1026
- */
1027
- noDelete?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1028
-
1029
1108
  /**
1030
1109
  * Hides the retry button when `uploadState` property is `Error`.
1031
1110
  */
1032
- noRetry?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1111
+ hideRetryButton?:
1112
+ | boolean
1113
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1033
1114
 
1034
1115
  /**
1035
1116
  * Hides the terminate button when `uploadState` property is `Uploading`.
1036
1117
  */
1037
- noTerminate?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1118
+ hideTerminateButton?:
1119
+ | boolean
1120
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1038
1121
 
1039
1122
  /**
1040
1123
  * The upload progress in percentage.
@@ -1097,8 +1180,43 @@ declare namespace sap {
1097
1180
  terminate?: (oEvent: sap.ui.base.Event) => void;
1098
1181
  }
1099
1182
 
1183
+ interface $ViewSettingsDialogSettings
1184
+ extends sap.ui.webc.common.$WebComponentSettings {
1185
+ /**
1186
+ * Defines the initial sort order.
1187
+ */
1188
+ sortDescending?:
1189
+ | boolean
1190
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1191
+
1192
+ /**
1193
+ * Defines the `sortItems` list.
1194
+ */
1195
+ sortItems?:
1196
+ | sap.ui.webc.main.IListItem[]
1197
+ | sap.ui.webc.main.IListItem
1198
+ | sap.ui.base.ManagedObject.AggregationBindingInfo;
1199
+
1200
+ /**
1201
+ * Fired when cancel button is activated.
1202
+ */
1203
+ cancel?: (oEvent: sap.ui.base.Event) => void;
1204
+
1205
+ /**
1206
+ * Fired when confirmation button is activated.
1207
+ */
1208
+ confirm?: (oEvent: sap.ui.base.Event) => void;
1209
+ }
1210
+
1100
1211
  interface $WizardSettings
1101
1212
  extends sap.ui.webc.common.$WebComponentSettings {
1213
+ /**
1214
+ * Sets the accessible aria name of the component.
1215
+ */
1216
+ accessibleName?:
1217
+ | string
1218
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1219
+
1102
1220
  /**
1103
1221
  * Defines the height of the control
1104
1222
  */
@@ -1125,6 +1243,20 @@ declare namespace sap {
1125
1243
 
1126
1244
  interface $WizardStepSettings
1127
1245
  extends sap.ui.webc.common.$WebComponentSettings {
1246
+ /**
1247
+ * Sets the accessible aria name of the component.
1248
+ */
1249
+ accessibleName?:
1250
+ | string
1251
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1252
+
1253
+ /**
1254
+ * Defines the aria-labelledby of the step.
1255
+ */
1256
+ accessibleNameRef?:
1257
+ | string
1258
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1259
+
1128
1260
  /**
1129
1261
  * When `branching` is enabled a dashed line would be displayed after the step, meant to indicate that the
1130
1262
  * next step is not yet known and depends on user choice in the current step.
@@ -1205,16 +1337,23 @@ declare namespace sap {
1205
1337
  *
1206
1338
  * Overview: The Bar is a container which is primarily used to hold titles, buttons and input elements and
1207
1339
  * its design and functionality is the basis for page headers and footers. The component consists of three
1208
- * areas to hold its content - startContent, middleContent and endContent. It has the capability to center
1209
- * content, such as a title, while having other components on the left and right side.
1340
+ * areas to hold its content - startContent slot, default slot and endContent slot. It has the capability
1341
+ * to center content, such as a title, while having other components on the left and right side.
1210
1342
  *
1211
1343
  * Usage: With the use of the design property, you can set the style of the Bar to appear designed like
1212
1344
  * a Header, Subheader, Footer and FloatingFooter.
1213
1345
  * **Note:** Do not place a Bar inside another Bar or inside any bar-like component. Doing so may cause
1214
1346
  * unpredictable behavior.
1215
1347
  *
1216
- * Responsive Behavior: The middleContent will be centered in the available space between the startContent
1348
+ * Responsive Behavior: The default slot will be centered in the available space between the startContent
1217
1349
  * and the endContent areas, therefore it might not always be centered in the entire bar.
1350
+ *
1351
+ * CSS Shadow Parts:
1352
+ *
1353
+ * CSS Shadow Parts
1354
+ * allow developers to style elements inside the Shadow DOM.
1355
+ * The `sap.ui.webc.fiori.Bar` exposes the following CSS Shadow Parts:
1356
+ * - bar - Used to style the wrapper of the content of the component
1218
1357
  */
1219
1358
  class Bar extends sap.ui.webc.common.WebComponent {
1220
1359
  /**
@@ -1274,22 +1413,22 @@ declare namespace sap {
1274
1413
  */
1275
1414
  static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
1276
1415
  /**
1277
- * Adds some endContent to the aggregation {@link #getEndContent endContent}.
1416
+ * Adds some content to the aggregation {@link #getContent content}.
1278
1417
  */
1279
- addEndContent(
1418
+ addContent(
1280
1419
  /**
1281
- * The endContent to add; if empty, nothing is inserted
1420
+ * The content to add; if empty, nothing is inserted
1282
1421
  */
1283
- oEndContent: sap.ui.core.Control
1422
+ oContent: sap.ui.core.Control
1284
1423
  ): this;
1285
1424
  /**
1286
- * Adds some middleContent to the aggregation {@link #getMiddleContent middleContent}.
1425
+ * Adds some endContent to the aggregation {@link #getEndContent endContent}.
1287
1426
  */
1288
- addMiddleContent(
1427
+ addEndContent(
1289
1428
  /**
1290
- * The middleContent to add; if empty, nothing is inserted
1429
+ * The endContent to add; if empty, nothing is inserted
1291
1430
  */
1292
- oMiddleContent: sap.ui.core.Control
1431
+ oEndContent: sap.ui.core.Control
1293
1432
  ): this;
1294
1433
  /**
1295
1434
  * Adds some startContent to the aggregation {@link #getStartContent startContent}.
@@ -1301,17 +1440,23 @@ declare namespace sap {
1301
1440
  oStartContent: sap.ui.core.Control
1302
1441
  ): this;
1303
1442
  /**
1304
- * Destroys all the endContent in the aggregation {@link #getEndContent endContent}.
1443
+ * Destroys all the content in the aggregation {@link #getContent content}.
1305
1444
  */
1306
- destroyEndContent(): this;
1445
+ destroyContent(): this;
1307
1446
  /**
1308
- * Destroys all the middleContent in the aggregation {@link #getMiddleContent middleContent}.
1447
+ * Destroys all the endContent in the aggregation {@link #getEndContent endContent}.
1309
1448
  */
1310
- destroyMiddleContent(): this;
1449
+ destroyEndContent(): this;
1311
1450
  /**
1312
1451
  * Destroys all the startContent in the aggregation {@link #getStartContent startContent}.
1313
1452
  */
1314
1453
  destroyStartContent(): this;
1454
+ /**
1455
+ * Gets content of aggregation {@link #getContent content}.
1456
+ *
1457
+ * Defines the content in the middle of the bar
1458
+ */
1459
+ getContent(): sap.ui.core.Control[];
1315
1460
  /**
1316
1461
  * Gets current value of property {@link #getDesign design}.
1317
1462
  *
@@ -1334,12 +1479,6 @@ declare namespace sap {
1334
1479
  * Defines the content at the end of the bar
1335
1480
  */
1336
1481
  getEndContent(): sap.ui.core.Control[];
1337
- /**
1338
- * Gets content of aggregation {@link #getMiddleContent middleContent}.
1339
- *
1340
- * Defines the content in the middle of the bar
1341
- */
1342
- getMiddleContent(): sap.ui.core.Control[];
1343
1482
  /**
1344
1483
  * Gets content of aggregation {@link #getStartContent startContent}.
1345
1484
  *
@@ -1353,24 +1492,24 @@ declare namespace sap {
1353
1492
  */
1354
1493
  getWidth(): sap.ui.core.CSSSize;
1355
1494
  /**
1356
- * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getEndContent endContent}. and
1357
- * returns its index if found or -1 otherwise.
1495
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
1496
+ * its index if found or -1 otherwise.
1358
1497
  */
1359
- indexOfEndContent(
1498
+ indexOfContent(
1360
1499
  /**
1361
- * The endContent whose index is looked for
1500
+ * The content whose index is looked for
1362
1501
  */
1363
- oEndContent: sap.ui.core.Control
1502
+ oContent: sap.ui.core.Control
1364
1503
  ): int;
1365
1504
  /**
1366
- * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMiddleContent middleContent}.
1367
- * and returns its index if found or -1 otherwise.
1505
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getEndContent endContent}. and
1506
+ * returns its index if found or -1 otherwise.
1368
1507
  */
1369
- indexOfMiddleContent(
1508
+ indexOfEndContent(
1370
1509
  /**
1371
- * The middleContent whose index is looked for
1510
+ * The endContent whose index is looked for
1372
1511
  */
1373
- oMiddleContent: sap.ui.core.Control
1512
+ oEndContent: sap.ui.core.Control
1374
1513
  ): int;
1375
1514
  /**
1376
1515
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getStartContent startContent}.
@@ -1383,31 +1522,31 @@ declare namespace sap {
1383
1522
  oStartContent: sap.ui.core.Control
1384
1523
  ): int;
1385
1524
  /**
1386
- * Inserts a endContent into the aggregation {@link #getEndContent endContent}.
1525
+ * Inserts a content into the aggregation {@link #getContent content}.
1387
1526
  */
1388
- insertEndContent(
1527
+ insertContent(
1389
1528
  /**
1390
- * The endContent to insert; if empty, nothing is inserted
1529
+ * The content to insert; if empty, nothing is inserted
1391
1530
  */
1392
- oEndContent: sap.ui.core.Control,
1531
+ oContent: sap.ui.core.Control,
1393
1532
  /**
1394
- * The `0`-based index the endContent should be inserted at; for a negative value of `iIndex`, the endContent
1395
- * is inserted at position 0; for a value greater than the current size of the aggregation, the endContent
1533
+ * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
1534
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the content
1396
1535
  * is inserted at the last position
1397
1536
  */
1398
1537
  iIndex: int
1399
1538
  ): this;
1400
1539
  /**
1401
- * Inserts a middleContent into the aggregation {@link #getMiddleContent middleContent}.
1540
+ * Inserts a endContent into the aggregation {@link #getEndContent endContent}.
1402
1541
  */
1403
- insertMiddleContent(
1542
+ insertEndContent(
1404
1543
  /**
1405
- * The middleContent to insert; if empty, nothing is inserted
1544
+ * The endContent to insert; if empty, nothing is inserted
1406
1545
  */
1407
- oMiddleContent: sap.ui.core.Control,
1546
+ oEndContent: sap.ui.core.Control,
1408
1547
  /**
1409
- * The `0`-based index the middleContent should be inserted at; for a negative value of `iIndex`, the middleContent
1410
- * is inserted at position 0; for a value greater than the current size of the aggregation, the middleContent
1548
+ * The `0`-based index the endContent should be inserted at; for a negative value of `iIndex`, the endContent
1549
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the endContent
1411
1550
  * is inserted at the last position
1412
1551
  */
1413
1552
  iIndex: int
@@ -1428,17 +1567,17 @@ declare namespace sap {
1428
1567
  iIndex: int
1429
1568
  ): this;
1430
1569
  /**
1431
- * Removes all the controls from the aggregation {@link #getEndContent endContent}.
1570
+ * Removes all the controls from the aggregation {@link #getContent content}.
1432
1571
  *
1433
1572
  * Additionally, it unregisters them from the hosting UIArea.
1434
1573
  */
1435
- removeAllEndContent(): sap.ui.core.Control[];
1574
+ removeAllContent(): sap.ui.core.Control[];
1436
1575
  /**
1437
- * Removes all the controls from the aggregation {@link #getMiddleContent middleContent}.
1576
+ * Removes all the controls from the aggregation {@link #getEndContent endContent}.
1438
1577
  *
1439
1578
  * Additionally, it unregisters them from the hosting UIArea.
1440
1579
  */
1441
- removeAllMiddleContent(): sap.ui.core.Control[];
1580
+ removeAllEndContent(): sap.ui.core.Control[];
1442
1581
  /**
1443
1582
  * Removes all the controls from the aggregation {@link #getStartContent startContent}.
1444
1583
  *
@@ -1446,22 +1585,22 @@ declare namespace sap {
1446
1585
  */
1447
1586
  removeAllStartContent(): sap.ui.core.Control[];
1448
1587
  /**
1449
- * Removes a endContent from the aggregation {@link #getEndContent endContent}.
1588
+ * Removes a content from the aggregation {@link #getContent content}.
1450
1589
  */
1451
- removeEndContent(
1590
+ removeContent(
1452
1591
  /**
1453
- * The endContent to remove or its index or id
1592
+ * The content to remove or its index or id
1454
1593
  */
1455
- vEndContent: int | string | sap.ui.core.Control
1594
+ vContent: int | string | sap.ui.core.Control
1456
1595
  ): sap.ui.core.Control;
1457
1596
  /**
1458
- * Removes a middleContent from the aggregation {@link #getMiddleContent middleContent}.
1597
+ * Removes a endContent from the aggregation {@link #getEndContent endContent}.
1459
1598
  */
1460
- removeMiddleContent(
1599
+ removeEndContent(
1461
1600
  /**
1462
- * The middleContent to remove or its index or id
1601
+ * The endContent to remove or its index or id
1463
1602
  */
1464
- vMiddleContent: int | string | sap.ui.core.Control
1603
+ vEndContent: int | string | sap.ui.core.Control
1465
1604
  ): sap.ui.core.Control;
1466
1605
  /**
1467
1606
  * Removes a startContent from the aggregation {@link #getStartContent startContent}.
@@ -1515,33 +1654,21 @@ declare namespace sap {
1515
1654
  *
1516
1655
  * Overview:
1517
1656
  *
1518
- * The `FlexibleColumnLayout` implements the master-detail-detail paradigm by displaying up to three pages
1519
- * in separate columns. There are several possible layouts that can be changed either with the component
1520
- * API, or by pressing the arrows, displayed between the columns.
1521
- *
1522
- * Usage:
1523
- *
1524
- * Use this component for applications that need to display several logical levels of related information
1525
- * side by side (e.g. list of items, item, sub-item, etc.). The Component is flexible in a sense that the
1526
- * application can focus the user's attention on one particular column.
1527
- *
1528
- * Responsive Behavior:
1529
- *
1530
- * The `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout`
1531
- * property and the window size. The component would display 1 column for window size smaller than 599px,
1532
- * up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
1533
- *
1534
- *
1657
+ * The `BarcodeScannerDialog` component provides barcode scanning functionality for all devices that support
1658
+ * the `MediaDevices.getUserMedia()` native API. Opening the dialog launches the device camera and scans
1659
+ * for known barcode formats.
1535
1660
  *
1536
- * Keyboard Handling:
1661
+ * A `scanSuccess` event fires whenever a barcode is identified and a `scanError` event fires when the
1662
+ * scan failed (for example, due to missing permisions).
1537
1663
  *
1664
+ * Internally, the component uses the zxing-js/library third party OSS.
1538
1665
  *
1539
- * - [SPACE, ENTER, RETURN] - If focus is on the layout toggle button (arrow button), once activated,
1540
- * it triggers the associated action (such as expand/collapse the column).
1666
+ * For a list of supported barcode formats, see the zxing-js/library
1667
+ * documentation.
1541
1668
  */
1542
- class FlexibleColumnLayout extends sap.ui.webc.common.WebComponent {
1669
+ class BarcodeScannerDialog extends sap.ui.webc.common.WebComponent {
1543
1670
  /**
1544
- * Constructor for a new `FlexibleColumnLayout`.
1671
+ * Constructor for a new `BarcodeScannerDialog`.
1545
1672
  *
1546
1673
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1547
1674
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -1551,10 +1678,10 @@ declare namespace sap {
1551
1678
  /**
1552
1679
  * Initial settings for the new control
1553
1680
  */
1554
- mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
1681
+ mSettings?: sap.ui.webc.fiori.$BarcodeScannerDialogSettings
1555
1682
  );
1556
1683
  /**
1557
- * Constructor for a new `FlexibleColumnLayout`.
1684
+ * Constructor for a new `BarcodeScannerDialog`.
1558
1685
  *
1559
1686
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1560
1687
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -1568,11 +1695,11 @@ declare namespace sap {
1568
1695
  /**
1569
1696
  * Initial settings for the new control
1570
1697
  */
1571
- mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
1698
+ mSettings?: sap.ui.webc.fiori.$BarcodeScannerDialogSettings
1572
1699
  );
1573
1700
 
1574
1701
  /**
1575
- * Creates a new subclass of class sap.ui.webc.fiori.FlexibleColumnLayout with name `sClassName` and enriches
1702
+ * Creates a new subclass of class sap.ui.webc.fiori.BarcodeScannerDialog with name `sClassName` and enriches
1576
1703
  * it with the information contained in `oClassInfo`.
1577
1704
  *
1578
1705
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
@@ -1587,7 +1714,7 @@ declare namespace sap {
1587
1714
  */
1588
1715
  oClassInfo?: sap.ClassInfo<
1589
1716
  T,
1590
- sap.ui.webc.fiori.FlexibleColumnLayout
1717
+ sap.ui.webc.fiori.BarcodeScannerDialog
1591
1718
  >,
1592
1719
  /**
1593
1720
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
@@ -1596,19 +1723,18 @@ declare namespace sap {
1596
1723
  FNMetaImpl?: Function
1597
1724
  ): Function;
1598
1725
  /**
1599
- * Returns a metadata object for class sap.ui.webc.fiori.FlexibleColumnLayout.
1726
+ * Returns a metadata object for class sap.ui.webc.fiori.BarcodeScannerDialog.
1600
1727
  */
1601
1728
  static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
1602
1729
  /**
1603
- * Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
1730
+ * Attaches event handler `fnFunction` to the {@link #event:scanError scanError} event of this `sap.ui.webc.fiori.BarcodeScannerDialog`.
1604
1731
  *
1605
1732
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1606
- * otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
1733
+ * otherwise it will be bound to this `sap.ui.webc.fiori.BarcodeScannerDialog` itself.
1607
1734
  *
1608
- * Fired when the layout changes via user interaction by clicking the arrows or by changing the component
1609
- * size due to resizing.
1735
+ * Fires when the scan fails with error.
1610
1736
  */
1611
- attachLayoutChange(
1737
+ attachScanError(
1612
1738
  /**
1613
1739
  * An application-specific payload object that will be passed to the event handler along with the event
1614
1740
  * object when firing the event
@@ -1619,49 +1745,297 @@ declare namespace sap {
1619
1745
  */
1620
1746
  fnFunction: (p1: sap.ui.base.Event) => void,
1621
1747
  /**
1622
- * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
1748
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.BarcodeScannerDialog`
1623
1749
  * itself
1624
1750
  */
1625
1751
  oListener?: object
1626
1752
  ): this;
1627
1753
  /**
1628
- * Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
1754
+ * Attaches event handler `fnFunction` to the {@link #event:scanError scanError} event of this `sap.ui.webc.fiori.BarcodeScannerDialog`.
1629
1755
  *
1630
1756
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1631
- * otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
1757
+ * otherwise it will be bound to this `sap.ui.webc.fiori.BarcodeScannerDialog` itself.
1632
1758
  *
1633
- * Fired when the layout changes via user interaction by clicking the arrows or by changing the component
1634
- * size due to resizing.
1759
+ * Fires when the scan fails with error.
1635
1760
  */
1636
- attachLayoutChange(
1761
+ attachScanError(
1637
1762
  /**
1638
1763
  * The function to be called when the event occurs
1639
1764
  */
1640
1765
  fnFunction: (p1: sap.ui.base.Event) => void,
1641
1766
  /**
1642
- * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
1767
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.BarcodeScannerDialog`
1643
1768
  * itself
1644
1769
  */
1645
1770
  oListener?: object
1646
1771
  ): this;
1647
1772
  /**
1648
- * Destroys the endColumn in the aggregation {@link #getEndColumn endColumn}.
1649
- */
1650
- destroyEndColumn(): this;
1651
- /**
1652
- * Destroys the midColumn in the aggregation {@link #getMidColumn midColumn}.
1653
- */
1654
- destroyMidColumn(): this;
1655
- /**
1656
- * Destroys the startColumn in the aggregation {@link #getStartColumn startColumn}.
1657
- */
1658
- destroyStartColumn(): this;
1659
- /**
1660
- * Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
1773
+ * Attaches event handler `fnFunction` to the {@link #event:scanSuccess scanSuccess} event of this `sap.ui.webc.fiori.BarcodeScannerDialog`.
1661
1774
  *
1662
- * The passed function and listener object must match the ones used for event registration.
1775
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1776
+ * otherwise it will be bound to this `sap.ui.webc.fiori.BarcodeScannerDialog` itself.
1777
+ *
1778
+ * Fires when the scan is completed successfuuly.
1663
1779
  */
1664
- detachLayoutChange(
1780
+ attachScanSuccess(
1781
+ /**
1782
+ * An application-specific payload object that will be passed to the event handler along with the event
1783
+ * object when firing the event
1784
+ */
1785
+ oData: object,
1786
+ /**
1787
+ * The function to be called when the event occurs
1788
+ */
1789
+ fnFunction: (p1: sap.ui.base.Event) => void,
1790
+ /**
1791
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.BarcodeScannerDialog`
1792
+ * itself
1793
+ */
1794
+ oListener?: object
1795
+ ): this;
1796
+ /**
1797
+ * Attaches event handler `fnFunction` to the {@link #event:scanSuccess scanSuccess} event of this `sap.ui.webc.fiori.BarcodeScannerDialog`.
1798
+ *
1799
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1800
+ * otherwise it will be bound to this `sap.ui.webc.fiori.BarcodeScannerDialog` itself.
1801
+ *
1802
+ * Fires when the scan is completed successfuuly.
1803
+ */
1804
+ attachScanSuccess(
1805
+ /**
1806
+ * The function to be called when the event occurs
1807
+ */
1808
+ fnFunction: (p1: sap.ui.base.Event) => void,
1809
+ /**
1810
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.BarcodeScannerDialog`
1811
+ * itself
1812
+ */
1813
+ oListener?: object
1814
+ ): this;
1815
+ /**
1816
+ * Closes the dialog and the scan session.
1817
+ */
1818
+ close(): void;
1819
+ /**
1820
+ * Detaches event handler `fnFunction` from the {@link #event:scanError scanError} event of this `sap.ui.webc.fiori.BarcodeScannerDialog`.
1821
+ *
1822
+ * The passed function and listener object must match the ones used for event registration.
1823
+ */
1824
+ detachScanError(
1825
+ /**
1826
+ * The function to be called, when the event occurs
1827
+ */
1828
+ fnFunction: (p1: sap.ui.base.Event) => void,
1829
+ /**
1830
+ * Context object on which the given function had to be called
1831
+ */
1832
+ oListener?: object
1833
+ ): this;
1834
+ /**
1835
+ * Detaches event handler `fnFunction` from the {@link #event:scanSuccess scanSuccess} event of this `sap.ui.webc.fiori.BarcodeScannerDialog`.
1836
+ *
1837
+ * The passed function and listener object must match the ones used for event registration.
1838
+ */
1839
+ detachScanSuccess(
1840
+ /**
1841
+ * The function to be called, when the event occurs
1842
+ */
1843
+ fnFunction: (p1: sap.ui.base.Event) => void,
1844
+ /**
1845
+ * Context object on which the given function had to be called
1846
+ */
1847
+ oListener?: object
1848
+ ): this;
1849
+ /**
1850
+ * Fires event {@link #event:scanError scanError} to attached listeners.
1851
+ */
1852
+ fireScanError(
1853
+ /**
1854
+ * Parameters to pass along with the event
1855
+ */
1856
+ mParameters?: {
1857
+ /**
1858
+ * the error message
1859
+ */
1860
+ message?: string;
1861
+ }
1862
+ ): this;
1863
+ /**
1864
+ * Fires event {@link #event:scanSuccess scanSuccess} to attached listeners.
1865
+ */
1866
+ fireScanSuccess(
1867
+ /**
1868
+ * Parameters to pass along with the event
1869
+ */
1870
+ mParameters?: {
1871
+ /**
1872
+ * the scan result as string
1873
+ */
1874
+ text?: string;
1875
+ /**
1876
+ * the scan result as a Uint8Array
1877
+ */
1878
+ rawBytes?: object;
1879
+ }
1880
+ ): this;
1881
+ /**
1882
+ * Shows a dialog with the camera videostream. Starts a scan session.
1883
+ */
1884
+ show(): void;
1885
+ }
1886
+ /**
1887
+ * @SINCE 1.92.0
1888
+ * @EXPERIMENTAL (since 1.92.0)
1889
+ *
1890
+ * Overview:
1891
+ *
1892
+ * The `FlexibleColumnLayout` implements the master-detail-detail paradigm by displaying up to three pages
1893
+ * in separate columns. There are several possible layouts that can be changed either with the component
1894
+ * API, or by pressing the arrows, displayed between the columns.
1895
+ *
1896
+ * Usage:
1897
+ *
1898
+ * Use this component for applications that need to display several logical levels of related information
1899
+ * side by side (e.g. list of items, item, sub-item, etc.). The Component is flexible in a sense that the
1900
+ * application can focus the user's attention on one particular column.
1901
+ *
1902
+ * Responsive Behavior:
1903
+ *
1904
+ * The `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout`
1905
+ * property and the window size. The component would display 1 column for window size smaller than 599px,
1906
+ * up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
1907
+ *
1908
+ *
1909
+ *
1910
+ * Keyboard Handling:
1911
+ *
1912
+ *
1913
+ * - [SPACE, ENTER, RETURN] - If focus is on the layout toggle button (arrow button), once activated,
1914
+ * it triggers the associated action (such as expand/collapse the column).
1915
+ */
1916
+ class FlexibleColumnLayout extends sap.ui.webc.common.WebComponent {
1917
+ /**
1918
+ * Constructor for a new `FlexibleColumnLayout`.
1919
+ *
1920
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1921
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1922
+ * of the syntax of the settings object.
1923
+ */
1924
+ constructor(
1925
+ /**
1926
+ * Initial settings for the new control
1927
+ */
1928
+ mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
1929
+ );
1930
+ /**
1931
+ * Constructor for a new `FlexibleColumnLayout`.
1932
+ *
1933
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1934
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1935
+ * of the syntax of the settings object.
1936
+ */
1937
+ constructor(
1938
+ /**
1939
+ * ID for the new control, generated automatically if no ID is given
1940
+ */
1941
+ sId?: string,
1942
+ /**
1943
+ * Initial settings for the new control
1944
+ */
1945
+ mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
1946
+ );
1947
+
1948
+ /**
1949
+ * Creates a new subclass of class sap.ui.webc.fiori.FlexibleColumnLayout with name `sClassName` and enriches
1950
+ * it with the information contained in `oClassInfo`.
1951
+ *
1952
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
1953
+ */
1954
+ static extend<T extends Record<string, unknown>>(
1955
+ /**
1956
+ * Name of the class being created
1957
+ */
1958
+ sClassName: string,
1959
+ /**
1960
+ * Object literal with information about the class
1961
+ */
1962
+ oClassInfo?: sap.ClassInfo<
1963
+ T,
1964
+ sap.ui.webc.fiori.FlexibleColumnLayout
1965
+ >,
1966
+ /**
1967
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1968
+ * used by this class
1969
+ */
1970
+ FNMetaImpl?: Function
1971
+ ): Function;
1972
+ /**
1973
+ * Returns a metadata object for class sap.ui.webc.fiori.FlexibleColumnLayout.
1974
+ */
1975
+ static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
1976
+ /**
1977
+ * Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
1978
+ *
1979
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1980
+ * otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
1981
+ *
1982
+ * Fired when the layout changes via user interaction by clicking the arrows or by changing the component
1983
+ * size due to resizing.
1984
+ */
1985
+ attachLayoutChange(
1986
+ /**
1987
+ * An application-specific payload object that will be passed to the event handler along with the event
1988
+ * object when firing the event
1989
+ */
1990
+ oData: object,
1991
+ /**
1992
+ * The function to be called when the event occurs
1993
+ */
1994
+ fnFunction: (p1: sap.ui.base.Event) => void,
1995
+ /**
1996
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
1997
+ * itself
1998
+ */
1999
+ oListener?: object
2000
+ ): this;
2001
+ /**
2002
+ * Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
2003
+ *
2004
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2005
+ * otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
2006
+ *
2007
+ * Fired when the layout changes via user interaction by clicking the arrows or by changing the component
2008
+ * size due to resizing.
2009
+ */
2010
+ attachLayoutChange(
2011
+ /**
2012
+ * The function to be called when the event occurs
2013
+ */
2014
+ fnFunction: (p1: sap.ui.base.Event) => void,
2015
+ /**
2016
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
2017
+ * itself
2018
+ */
2019
+ oListener?: object
2020
+ ): this;
2021
+ /**
2022
+ * Destroys the endColumn in the aggregation {@link #getEndColumn endColumn}.
2023
+ */
2024
+ destroyEndColumn(): this;
2025
+ /**
2026
+ * Destroys the midColumn in the aggregation {@link #getMidColumn midColumn}.
2027
+ */
2028
+ destroyMidColumn(): this;
2029
+ /**
2030
+ * Destroys the startColumn in the aggregation {@link #getStartColumn startColumn}.
2031
+ */
2032
+ destroyStartColumn(): this;
2033
+ /**
2034
+ * Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
2035
+ *
2036
+ * The passed function and listener object must match the ones used for event registration.
2037
+ */
2038
+ detachLayoutChange(
1665
2039
  /**
1666
2040
  * The function to be called, when the event occurs
1667
2041
  */
@@ -1937,6 +2311,246 @@ declare namespace sap {
1937
2311
  sWidth?: sap.ui.core.CSSSize
1938
2312
  ): this;
1939
2313
  }
2314
+ /**
2315
+ * @SINCE 1.92.0
2316
+ * @EXPERIMENTAL (since 1.92.0)
2317
+ *
2318
+ * Overview: An IllustratedMessage is a recommended combination of a solution-oriented message, an engaging
2319
+ * illustration, and conversational tone to better communicate an empty or a success state than just show
2320
+ * a message alone.
2321
+ *
2322
+ * Each illustration has default internationalised title and subtitle texts. Also they can be managed with
2323
+ * `titleText` and `subtitleText` properties.
2324
+ *
2325
+ * Structure: The IllustratedMessage consists of the following elements, which are displayed below each
2326
+ * other in the following order:
2327
+ *
2328
+ *
2329
+ *
2330
+ * - Illustration
2331
+ * - Title
2332
+ * - Subtitle
2333
+ * - Actions
2334
+ *
2335
+ * Usage: `sap.ui.webc.fiori.IllustratedMessage` is meant to be used inside container component, for example
2336
+ * a `sap.ui.webc.main.Card`, a `sap.ui.webc.main.Dialog` or a `sap.ui.webc.fiori.Page`
2337
+ */
2338
+ class IllustratedMessage extends sap.ui.webc.common.WebComponent {
2339
+ /**
2340
+ * Constructor for a new `IllustratedMessage`.
2341
+ *
2342
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2343
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2344
+ * of the syntax of the settings object.
2345
+ */
2346
+ constructor(
2347
+ /**
2348
+ * Initial settings for the new control
2349
+ */
2350
+ mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
2351
+ );
2352
+ /**
2353
+ * Constructor for a new `IllustratedMessage`.
2354
+ *
2355
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2356
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2357
+ * of the syntax of the settings object.
2358
+ */
2359
+ constructor(
2360
+ /**
2361
+ * ID for the new control, generated automatically if no ID is given
2362
+ */
2363
+ sId?: string,
2364
+ /**
2365
+ * Initial settings for the new control
2366
+ */
2367
+ mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
2368
+ );
2369
+
2370
+ /**
2371
+ * Creates a new subclass of class sap.ui.webc.fiori.IllustratedMessage with name `sClassName` and enriches
2372
+ * it with the information contained in `oClassInfo`.
2373
+ *
2374
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
2375
+ */
2376
+ static extend<T extends Record<string, unknown>>(
2377
+ /**
2378
+ * Name of the class being created
2379
+ */
2380
+ sClassName: string,
2381
+ /**
2382
+ * Object literal with information about the class
2383
+ */
2384
+ oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.IllustratedMessage>,
2385
+ /**
2386
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2387
+ * used by this class
2388
+ */
2389
+ FNMetaImpl?: Function
2390
+ ): Function;
2391
+ /**
2392
+ * Returns a metadata object for class sap.ui.webc.fiori.IllustratedMessage.
2393
+ */
2394
+ static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
2395
+ /**
2396
+ * Adds some action to the aggregation {@link #getActions actions}.
2397
+ */
2398
+ addAction(
2399
+ /**
2400
+ * The action to add; if empty, nothing is inserted
2401
+ */
2402
+ oAction: sap.ui.webc.main.IButton
2403
+ ): this;
2404
+ /**
2405
+ * Destroys all the actions in the aggregation {@link #getActions actions}.
2406
+ */
2407
+ destroyActions(): this;
2408
+ /**
2409
+ * Destroys the subtitle in the aggregation {@link #getSubtitle subtitle}.
2410
+ */
2411
+ destroySubtitle(): this;
2412
+ /**
2413
+ * Gets content of aggregation {@link #getActions actions}.
2414
+ *
2415
+ * Defines the component actions.
2416
+ */
2417
+ getActions(): sap.ui.webc.main.IButton[];
2418
+ /**
2419
+ * Gets current value of property {@link #getName name}.
2420
+ *
2421
+ * Default value is `BeforeSearch`.
2422
+ */
2423
+ getName(): sap.ui.webc.fiori.IllustrationMessageType;
2424
+ /**
2425
+ * Gets content of aggregation {@link #getSubtitle subtitle}.
2426
+ *
2427
+ * Defines the subtitle of the component.
2428
+ *
2429
+ * **Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText`
2430
+ * property will be overwritten.
2431
+ */
2432
+ getSubtitle(): sap.ui.core.Control;
2433
+ /**
2434
+ * Gets current value of property {@link #getSubtitleText subtitleText}.
2435
+ *
2436
+ * Defines the subtitle of the component.
2437
+ *
2438
+ * **Note:** Using this property, the default subtitle text of illustration will be overwritten.
2439
+ *
2440
+ * **Note:** Using `subtitle` slot, the default of this property will be overwritten.
2441
+ *
2442
+ * Default value is `empty string`.
2443
+ */
2444
+ getSubtitleText(): string;
2445
+ /**
2446
+ * Gets current value of property {@link #getTitleText titleText}.
2447
+ *
2448
+ * Defines the title of the component.
2449
+ *
2450
+ * **Note:** Using this property, the default title text of illustration will be overwritten.
2451
+ *
2452
+ * Default value is `empty string`.
2453
+ */
2454
+ getTitleText(): string;
2455
+ /**
2456
+ * Checks for the provided `sap.ui.webc.main.IButton` in the aggregation {@link #getActions actions}. and
2457
+ * returns its index if found or -1 otherwise.
2458
+ */
2459
+ indexOfAction(
2460
+ /**
2461
+ * The action whose index is looked for
2462
+ */
2463
+ oAction: sap.ui.webc.main.IButton
2464
+ ): int;
2465
+ /**
2466
+ * Inserts a action into the aggregation {@link #getActions actions}.
2467
+ */
2468
+ insertAction(
2469
+ /**
2470
+ * The action to insert; if empty, nothing is inserted
2471
+ */
2472
+ oAction: sap.ui.webc.main.IButton,
2473
+ /**
2474
+ * The `0`-based index the action should be inserted at; for a negative value of `iIndex`, the action is
2475
+ * inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
2476
+ * at the last position
2477
+ */
2478
+ iIndex: int
2479
+ ): this;
2480
+ /**
2481
+ * Removes a action from the aggregation {@link #getActions actions}.
2482
+ */
2483
+ removeAction(
2484
+ /**
2485
+ * The action to remove or its index or id
2486
+ */
2487
+ vAction: int | string | sap.ui.webc.main.IButton
2488
+ ): sap.ui.webc.main.IButton;
2489
+ /**
2490
+ * Removes all the controls from the aggregation {@link #getActions actions}.
2491
+ *
2492
+ * Additionally, it unregisters them from the hosting UIArea.
2493
+ */
2494
+ removeAllActions(): sap.ui.webc.main.IButton[];
2495
+ /**
2496
+ * Sets a new value for property {@link #getName name}.
2497
+ *
2498
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2499
+ *
2500
+ * Default value is `BeforeSearch`.
2501
+ */
2502
+ setName(
2503
+ /**
2504
+ * New value for property `name`
2505
+ */
2506
+ sName?: sap.ui.webc.fiori.IllustrationMessageType
2507
+ ): this;
2508
+ /**
2509
+ * Sets the aggregated {@link #getSubtitle subtitle}.
2510
+ */
2511
+ setSubtitle(
2512
+ /**
2513
+ * The subtitle to set
2514
+ */
2515
+ oSubtitle: sap.ui.core.Control
2516
+ ): this;
2517
+ /**
2518
+ * Sets a new value for property {@link #getSubtitleText subtitleText}.
2519
+ *
2520
+ * Defines the subtitle of the component.
2521
+ *
2522
+ * **Note:** Using this property, the default subtitle text of illustration will be overwritten.
2523
+ *
2524
+ * **Note:** Using `subtitle` slot, the default of this property will be overwritten.
2525
+ *
2526
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2527
+ *
2528
+ * Default value is `empty string`.
2529
+ */
2530
+ setSubtitleText(
2531
+ /**
2532
+ * New value for property `subtitleText`
2533
+ */
2534
+ sSubtitleText?: string
2535
+ ): this;
2536
+ /**
2537
+ * Sets a new value for property {@link #getTitleText titleText}.
2538
+ *
2539
+ * Defines the title of the component.
2540
+ *
2541
+ * **Note:** Using this property, the default title text of illustration will be overwritten.
2542
+ *
2543
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2544
+ *
2545
+ * Default value is `empty string`.
2546
+ */
2547
+ setTitleText(
2548
+ /**
2549
+ * New value for property `titleText`
2550
+ */
2551
+ sTitleText?: string
2552
+ ): this;
2553
+ }
1940
2554
  /**
1941
2555
  * @SINCE 1.92.0
1942
2556
  * @EXPERIMENTAL (since 1.92.0)
@@ -2136,7 +2750,7 @@ declare namespace sap {
2136
2750
  * The component consists of:
2137
2751
  * - `Toggle` button to expand and collapse the group
2138
2752
  * - `Priority` icon to display the priority of the group
2139
- * - `Heading` to entitle the group
2753
+ * - `TitleText` to entitle the group
2140
2754
  * - Custom actions - with the use of `sap.ui.webc.fiori.NotificationAction`
2141
2755
  * - Items of the group
2142
2756
  *
@@ -2147,7 +2761,7 @@ declare namespace sap {
2147
2761
  * CSS Shadow Parts
2148
2762
  * allow developers to style elements inside the Shadow DOM.
2149
2763
  * The `sap.ui.webc.fiori.NotificationListGroupItem` exposes the following CSS Shadow Parts:
2150
- * - heading - Used to style the heading of the notification list group item
2764
+ * - title-text - Used to style the titleText of the notification list group item
2151
2765
  */
2152
2766
  class NotificationListGroupItem
2153
2767
  extends sap.ui.webc.common.WebComponent
@@ -2389,21 +3003,21 @@ declare namespace sap {
2389
3003
  */
2390
3004
  getBusy(): boolean;
2391
3005
  /**
2392
- * Gets current value of property {@link #getCollapsed collapsed}.
3006
+ * Gets current value of property {@link #getBusyDelay busyDelay}.
2393
3007
  *
2394
- * Defines if the group is collapsed or expanded.
3008
+ * Defines the delay in milliseconds, after which the busy indicator will show up for this component.
2395
3009
  *
2396
- * Default value is `false`.
3010
+ * Default value is `1000`.
2397
3011
  */
2398
- getCollapsed(): boolean;
3012
+ getBusyDelay(): int;
2399
3013
  /**
2400
- * Gets current value of property {@link #getHeading heading}.
3014
+ * Gets current value of property {@link #getCollapsed collapsed}.
2401
3015
  *
2402
- * Defines the `heading` of the item.
3016
+ * Defines if the group is collapsed or expanded.
2403
3017
  *
2404
- * Default value is `empty string`.
3018
+ * Default value is `false`.
2405
3019
  */
2406
- getHeading(): string;
3020
+ getCollapsed(): boolean;
2407
3021
  /**
2408
3022
  * Gets content of aggregation {@link #getItems items}.
2409
3023
  *
@@ -2428,7 +3042,7 @@ declare namespace sap {
2428
3042
  *
2429
3043
  * Defines if the `notification` is new or has been already read.
2430
3044
  *
2431
- * **Note:** if set to `false` the `heading` has bold font, if set to true - it has a normal font.
3045
+ * **Note:** if set to `false` the `titleText` has bold font, if set to true - it has a normal font.
2432
3046
  *
2433
3047
  * Default value is `false`.
2434
3048
  */
@@ -2449,6 +3063,14 @@ declare namespace sap {
2449
3063
  * Default value is `false`.
2450
3064
  */
2451
3065
  getShowCounter(): boolean;
3066
+ /**
3067
+ * Gets current value of property {@link #getTitleText titleText}.
3068
+ *
3069
+ * Defines the `titleText` of the item.
3070
+ *
3071
+ * Default value is `empty string`.
3072
+ */
3073
+ getTitleText(): string;
2452
3074
  /**
2453
3075
  * Checks for the provided `sap.ui.webc.fiori.INotificationAction` in the aggregation {@link #getActions
2454
3076
  * actions}. and returns its index if found or -1 otherwise.
@@ -2545,34 +3167,34 @@ declare namespace sap {
2545
3167
  bBusy?: boolean
2546
3168
  ): this;
2547
3169
  /**
2548
- * Sets a new value for property {@link #getCollapsed collapsed}.
3170
+ * Sets a new value for property {@link #getBusyDelay busyDelay}.
2549
3171
  *
2550
- * Defines if the group is collapsed or expanded.
3172
+ * Defines the delay in milliseconds, after which the busy indicator will show up for this component.
2551
3173
  *
2552
3174
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2553
3175
  *
2554
- * Default value is `false`.
3176
+ * Default value is `1000`.
2555
3177
  */
2556
- setCollapsed(
3178
+ setBusyDelay(
2557
3179
  /**
2558
- * New value for property `collapsed`
3180
+ * New value for property `busyDelay`
2559
3181
  */
2560
- bCollapsed?: boolean
3182
+ iBusyDelay?: int
2561
3183
  ): this;
2562
3184
  /**
2563
- * Sets a new value for property {@link #getHeading heading}.
3185
+ * Sets a new value for property {@link #getCollapsed collapsed}.
2564
3186
  *
2565
- * Defines the `heading` of the item.
3187
+ * Defines if the group is collapsed or expanded.
2566
3188
  *
2567
3189
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2568
3190
  *
2569
- * Default value is `empty string`.
3191
+ * Default value is `false`.
2570
3192
  */
2571
- setHeading(
3193
+ setCollapsed(
2572
3194
  /**
2573
- * New value for property `heading`
3195
+ * New value for property `collapsed`
2574
3196
  */
2575
- sHeading?: string
3197
+ bCollapsed?: boolean
2576
3198
  ): this;
2577
3199
  /**
2578
3200
  * Sets a new value for property {@link #getPriority priority}.
@@ -2598,7 +3220,7 @@ declare namespace sap {
2598
3220
  *
2599
3221
  * Defines if the `notification` is new or has been already read.
2600
3222
  *
2601
- * **Note:** if set to `false` the `heading` has bold font, if set to true - it has a normal font.
3223
+ * **Note:** if set to `false` the `titleText` has bold font, if set to true - it has a normal font.
2602
3224
  *
2603
3225
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2604
3226
  *
@@ -2640,6 +3262,21 @@ declare namespace sap {
2640
3262
  */
2641
3263
  bShowCounter?: boolean
2642
3264
  ): this;
3265
+ /**
3266
+ * Sets a new value for property {@link #getTitleText titleText}.
3267
+ *
3268
+ * Defines the `titleText` of the item.
3269
+ *
3270
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3271
+ *
3272
+ * Default value is `empty string`.
3273
+ */
3274
+ setTitleText(
3275
+ /**
3276
+ * New value for property `titleText`
3277
+ */
3278
+ sTitleText?: string
3279
+ ): this;
2643
3280
  }
2644
3281
  /**
2645
3282
  * @SINCE 1.92.0
@@ -2649,13 +3286,13 @@ declare namespace sap {
2649
3286
  *
2650
3287
  *
2651
3288
  *
2652
- * The component has a rich set of various properties that allows the user to set `avatar`, `heading`, descriptive
2653
- * `content` and `footnotes` to fully describe a notification.
3289
+ * The component has a rich set of various properties that allows the user to set `avatar`, `titleText`,
3290
+ * descriptive `content` and `footnotes` to fully describe a notification.
2654
3291
  *
2655
3292
  *
2656
3293
  * The user can:
2657
3294
  * - display a `Close` button
2658
- * - can control whether the `heading` and `description` should wrap or truncate and display a `ShowMore`
3295
+ * - can control whether the `titleText` and `description` should wrap or truncate and display a `ShowMore`
2659
3296
  * button to switch between less and more information
2660
3297
  * - add custom actions by using the `sap.ui.webc.fiori.NotificationAction` component
2661
3298
  *
@@ -2666,7 +3303,7 @@ declare namespace sap {
2666
3303
  * CSS Shadow Parts
2667
3304
  * allow developers to style elements inside the Shadow DOM.
2668
3305
  * The `sap.ui.webc.fiori.NotificationListItem` exposes the following CSS Shadow Parts:
2669
- * - heading - Used to style the heading of the notification list item
3306
+ * - title-text - Used to style the titleText of the notification list item
2670
3307
  */
2671
3308
  class NotificationListItem
2672
3309
  extends sap.ui.webc.common.WebComponent
@@ -2860,6 +3497,14 @@ declare namespace sap {
2860
3497
  * Default value is `false`.
2861
3498
  */
2862
3499
  getBusy(): boolean;
3500
+ /**
3501
+ * Gets current value of property {@link #getBusyDelay busyDelay}.
3502
+ *
3503
+ * Defines the delay in milliseconds, after which the busy indicator will show up for this component.
3504
+ *
3505
+ * Default value is `1000`.
3506
+ */
3507
+ getBusyDelay(): int;
2863
3508
  /**
2864
3509
  * Gets current value of property {@link #getDescription description}.
2865
3510
  *
@@ -2871,17 +3516,9 @@ declare namespace sap {
2871
3516
  /**
2872
3517
  * Gets content of aggregation {@link #getFootnotes footnotes}.
2873
3518
  *
2874
- * Defines the elements, dipalyed in the footer of the of the `sap.ui.webc.fiori.NotificationListItem`.
3519
+ * Defines the elements, displayed in the footer of the of the component.
2875
3520
  */
2876
3521
  getFootnotes(): sap.ui.core.Control[];
2877
- /**
2878
- * Gets current value of property {@link #getHeading heading}.
2879
- *
2880
- * Defines the `heading` of the item.
2881
- *
2882
- * Default value is `empty string`.
2883
- */
2884
- getHeading(): string;
2885
3522
  /**
2886
3523
  * Gets current value of property {@link #getPriority priority}.
2887
3524
  *
@@ -2899,7 +3536,7 @@ declare namespace sap {
2899
3536
  *
2900
3537
  * Defines if the `notification` is new or has been already read.
2901
3538
  *
2902
- * **Note:** if set to `false` the `heading` has bold font, if set to true - it has a normal font.
3539
+ * **Note:** if set to `false` the `titleText` has bold font, if set to true - it has a normal font.
2903
3540
  *
2904
3541
  * Default value is `false`.
2905
3542
  */
@@ -2913,17 +3550,25 @@ declare namespace sap {
2913
3550
  */
2914
3551
  getShowClose(): boolean;
2915
3552
  /**
2916
- * Gets current value of property {@link #getWrap wrap}.
3553
+ * Gets current value of property {@link #getTitleText titleText}.
2917
3554
  *
2918
- * Defines if the `heading` and `description` should wrap, they truncate by default.
3555
+ * Defines the `titleText` of the item.
2919
3556
  *
3557
+ * Default value is `empty string`.
3558
+ */
3559
+ getTitleText(): string;
3560
+ /**
3561
+ * Gets current value of property {@link #getWrappingType wrappingType}.
2920
3562
  *
3563
+ * Defines if the `titleText` and `description` should wrap, they truncate by default.
2921
3564
  *
2922
- * **Note:** by default the `heading` and `decription`, and a `ShowMore/Less` button would be displayed.
2923
3565
  *
2924
- * Default value is `false`.
3566
+ *
3567
+ * **Note:** by default the `titleText` and `decription`, and a `ShowMore/Less` button would be displayed.
3568
+ *
3569
+ * Default value is `None`.
2925
3570
  */
2926
- getWrap(): boolean;
3571
+ getWrappingType(): sap.ui.webc.main.WrappingType;
2927
3572
  /**
2928
3573
  * Checks for the provided `sap.ui.webc.fiori.INotificationAction` in the aggregation {@link #getActions
2929
3574
  * actions}. and returns its index if found or -1 otherwise.
@@ -3029,34 +3674,34 @@ declare namespace sap {
3029
3674
  bBusy?: boolean
3030
3675
  ): this;
3031
3676
  /**
3032
- * Sets a new value for property {@link #getDescription description}.
3677
+ * Sets a new value for property {@link #getBusyDelay busyDelay}.
3033
3678
  *
3034
- * Defines the content of the control
3679
+ * Defines the delay in milliseconds, after which the busy indicator will show up for this component.
3035
3680
  *
3036
3681
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3037
3682
  *
3038
- * Default value is `empty string`.
3683
+ * Default value is `1000`.
3039
3684
  */
3040
- setDescription(
3685
+ setBusyDelay(
3041
3686
  /**
3042
- * New value for property `description`
3687
+ * New value for property `busyDelay`
3043
3688
  */
3044
- sDescription?: string
3689
+ iBusyDelay?: int
3045
3690
  ): this;
3046
3691
  /**
3047
- * Sets a new value for property {@link #getHeading heading}.
3692
+ * Sets a new value for property {@link #getDescription description}.
3048
3693
  *
3049
- * Defines the `heading` of the item.
3694
+ * Defines the content of the control
3050
3695
  *
3051
3696
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3052
3697
  *
3053
3698
  * Default value is `empty string`.
3054
3699
  */
3055
- setHeading(
3700
+ setDescription(
3056
3701
  /**
3057
- * New value for property `heading`
3702
+ * New value for property `description`
3058
3703
  */
3059
- sHeading?: string
3704
+ sDescription?: string
3060
3705
  ): this;
3061
3706
  /**
3062
3707
  * Sets a new value for property {@link #getPriority priority}.
@@ -3082,7 +3727,7 @@ declare namespace sap {
3082
3727
  *
3083
3728
  * Defines if the `notification` is new or has been already read.
3084
3729
  *
3085
- * **Note:** if set to `false` the `heading` has bold font, if set to true - it has a normal font.
3730
+ * **Note:** if set to `false` the `titleText` has bold font, if set to true - it has a normal font.
3086
3731
  *
3087
3732
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3088
3733
  *
@@ -3110,23 +3755,38 @@ declare namespace sap {
3110
3755
  bShowClose?: boolean
3111
3756
  ): this;
3112
3757
  /**
3113
- * Sets a new value for property {@link #getWrap wrap}.
3758
+ * Sets a new value for property {@link #getTitleText titleText}.
3114
3759
  *
3115
- * Defines if the `heading` and `description` should wrap, they truncate by default.
3760
+ * Defines the `titleText` of the item.
3116
3761
  *
3762
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3763
+ *
3764
+ * Default value is `empty string`.
3765
+ */
3766
+ setTitleText(
3767
+ /**
3768
+ * New value for property `titleText`
3769
+ */
3770
+ sTitleText?: string
3771
+ ): this;
3772
+ /**
3773
+ * Sets a new value for property {@link #getWrappingType wrappingType}.
3774
+ *
3775
+ * Defines if the `titleText` and `description` should wrap, they truncate by default.
3117
3776
  *
3118
3777
  *
3119
- * **Note:** by default the `heading` and `decription`, and a `ShowMore/Less` button would be displayed.
3778
+ *
3779
+ * **Note:** by default the `titleText` and `decription`, and a `ShowMore/Less` button would be displayed.
3120
3780
  *
3121
3781
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3122
3782
  *
3123
- * Default value is `false`.
3783
+ * Default value is `None`.
3124
3784
  */
3125
- setWrap(
3785
+ setWrappingType(
3126
3786
  /**
3127
- * New value for property `wrap`
3787
+ * New value for property `wrappingType`
3128
3788
  */
3129
- bWrap?: boolean
3789
+ sWrappingType?: sap.ui.webc.main.WrappingType
3130
3790
  ): this;
3131
3791
  }
3132
3792
  /**
@@ -5928,6 +6588,20 @@ declare namespace sap {
5928
6588
  * Determines the content of the `sap.ui.webc.fiori.Timeline`.
5929
6589
  */
5930
6590
  getItems(): sap.ui.webc.fiori.ITimelineItem[];
6591
+ /**
6592
+ * Gets current value of property {@link #getLayout layout}.
6593
+ *
6594
+ * Defines the items orientation.
6595
+ *
6596
+ *
6597
+ *
6598
+ * **Note:** Available options are:
6599
+ * - `Vertical`
6600
+ * - `Horizontal`
6601
+ *
6602
+ * Default value is `Vertical`.
6603
+ */
6604
+ getLayout(): sap.ui.webc.fiori.TimelineLayout;
5931
6605
  /**
5932
6606
  * Gets current value of property {@link #getWidth width}.
5933
6607
  *
@@ -5987,6 +6661,27 @@ declare namespace sap {
5987
6661
  */
5988
6662
  sHeight?: sap.ui.core.CSSSize
5989
6663
  ): this;
6664
+ /**
6665
+ * Sets a new value for property {@link #getLayout layout}.
6666
+ *
6667
+ * Defines the items orientation.
6668
+ *
6669
+ *
6670
+ *
6671
+ * **Note:** Available options are:
6672
+ * - `Vertical`
6673
+ * - `Horizontal`
6674
+ *
6675
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6676
+ *
6677
+ * Default value is `Vertical`.
6678
+ */
6679
+ setLayout(
6680
+ /**
6681
+ * New value for property `layout`
6682
+ */
6683
+ sLayout?: sap.ui.webc.fiori.TimelineLayout
6684
+ ): this;
5990
6685
  /**
5991
6686
  * Sets a new value for property {@link #getWidth width}.
5992
6687
  *
@@ -6079,16 +6774,16 @@ declare namespace sap {
6079
6774
  oContent: sap.ui.core.Control
6080
6775
  ): this;
6081
6776
  /**
6082
- * Attaches event handler `fnFunction` to the {@link #event:itemNameClick itemNameClick} event of this `sap.ui.webc.fiori.TimelineItem`.
6777
+ * Attaches event handler `fnFunction` to the {@link #event:nameClick nameClick} event of this `sap.ui.webc.fiori.TimelineItem`.
6083
6778
  *
6084
6779
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6085
6780
  * otherwise it will be bound to this `sap.ui.webc.fiori.TimelineItem` itself.
6086
6781
  *
6087
6782
  * Fired when the item name is pressed either with a click/tap or by using the Enter or Space key.
6088
6783
  *
6089
- * **Note:** The event will not be fired if the `item-name-clickable` attribute is not set.
6784
+ * **Note:** The event will not be fired if the `name-clickable` attribute is not set.
6090
6785
  */
6091
- attachItemNameClick(
6786
+ attachNameClick(
6092
6787
  /**
6093
6788
  * An application-specific payload object that will be passed to the event handler along with the event
6094
6789
  * object when firing the event
@@ -6104,16 +6799,16 @@ declare namespace sap {
6104
6799
  oListener?: object
6105
6800
  ): this;
6106
6801
  /**
6107
- * Attaches event handler `fnFunction` to the {@link #event:itemNameClick itemNameClick} event of this `sap.ui.webc.fiori.TimelineItem`.
6802
+ * Attaches event handler `fnFunction` to the {@link #event:nameClick nameClick} event of this `sap.ui.webc.fiori.TimelineItem`.
6108
6803
  *
6109
6804
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6110
6805
  * otherwise it will be bound to this `sap.ui.webc.fiori.TimelineItem` itself.
6111
6806
  *
6112
6807
  * Fired when the item name is pressed either with a click/tap or by using the Enter or Space key.
6113
6808
  *
6114
- * **Note:** The event will not be fired if the `item-name-clickable` attribute is not set.
6809
+ * **Note:** The event will not be fired if the `name-clickable` attribute is not set.
6115
6810
  */
6116
- attachItemNameClick(
6811
+ attachNameClick(
6117
6812
  /**
6118
6813
  * The function to be called when the event occurs
6119
6814
  */
@@ -6128,12 +6823,11 @@ declare namespace sap {
6128
6823
  */
6129
6824
  destroyContent(): this;
6130
6825
  /**
6131
- * Detaches event handler `fnFunction` from the {@link #event:itemNameClick itemNameClick} event of this
6132
- * `sap.ui.webc.fiori.TimelineItem`.
6826
+ * Detaches event handler `fnFunction` from the {@link #event:nameClick nameClick} event of this `sap.ui.webc.fiori.TimelineItem`.
6133
6827
  *
6134
6828
  * The passed function and listener object must match the ones used for event registration.
6135
6829
  */
6136
- detachItemNameClick(
6830
+ detachNameClick(
6137
6831
  /**
6138
6832
  * The function to be called, when the event occurs
6139
6833
  */
@@ -6144,9 +6838,9 @@ declare namespace sap {
6144
6838
  oListener?: object
6145
6839
  ): this;
6146
6840
  /**
6147
- * Fires event {@link #event:itemNameClick itemNameClick} to attached listeners.
6841
+ * Fires event {@link #event:nameClick nameClick} to attached listeners.
6148
6842
  */
6149
- fireItemNameClick(
6843
+ fireNameClick(
6150
6844
  /**
6151
6845
  * Parameters to pass along with the event
6152
6846
  */
@@ -6172,21 +6866,21 @@ declare namespace sap {
6172
6866
  */
6173
6867
  getIcon(): string;
6174
6868
  /**
6175
- * Gets current value of property {@link #getItemName itemName}.
6869
+ * Gets current value of property {@link #getName name}.
6176
6870
  *
6177
- * Defines the name of the item.
6871
+ * Defines the name of the item, displayed before the `title-text`.
6178
6872
  *
6179
6873
  * Default value is `empty string`.
6180
6874
  */
6181
- getItemName(): string;
6875
+ getName(): string;
6182
6876
  /**
6183
- * Gets current value of property {@link #getItemNameClickable itemNameClickable}.
6877
+ * Gets current value of property {@link #getNameClickable nameClickable}.
6184
6878
  *
6185
- * Defines whether the `itemName` is clickable.
6879
+ * Defines if the `name` is clickable.
6186
6880
  *
6187
6881
  * Default value is `false`.
6188
6882
  */
6189
- getItemNameClickable(): boolean;
6883
+ getNameClickable(): boolean;
6190
6884
  /**
6191
6885
  * Gets current value of property {@link #getSubtitleText subtitleText}.
6192
6886
  *
@@ -6264,34 +6958,34 @@ declare namespace sap {
6264
6958
  sIcon?: string
6265
6959
  ): this;
6266
6960
  /**
6267
- * Sets a new value for property {@link #getItemName itemName}.
6961
+ * Sets a new value for property {@link #getName name}.
6268
6962
  *
6269
- * Defines the name of the item.
6963
+ * Defines the name of the item, displayed before the `title-text`.
6270
6964
  *
6271
6965
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6272
6966
  *
6273
6967
  * Default value is `empty string`.
6274
6968
  */
6275
- setItemName(
6969
+ setName(
6276
6970
  /**
6277
- * New value for property `itemName`
6971
+ * New value for property `name`
6278
6972
  */
6279
- sItemName?: string
6973
+ sName?: string
6280
6974
  ): this;
6281
6975
  /**
6282
- * Sets a new value for property {@link #getItemNameClickable itemNameClickable}.
6976
+ * Sets a new value for property {@link #getNameClickable nameClickable}.
6283
6977
  *
6284
- * Defines whether the `itemName` is clickable.
6978
+ * Defines if the `name` is clickable.
6285
6979
  *
6286
6980
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6287
6981
  *
6288
6982
  * Default value is `false`.
6289
6983
  */
6290
- setItemNameClickable(
6984
+ setNameClickable(
6291
6985
  /**
6292
- * New value for property `itemNameClickable`
6986
+ * New value for property `nameClickable`
6293
6987
  */
6294
- bItemNameClickable?: boolean
6988
+ bNameClickable?: boolean
6295
6989
  ): this;
6296
6990
  /**
6297
6991
  * Sets a new value for property {@link #getSubtitleText subtitleText}.
@@ -6456,7 +7150,7 @@ declare namespace sap {
6456
7150
  oListener?: object
6457
7151
  ): this;
6458
7152
  /**
6459
- * Attaches event handler `fnFunction` to the {@link #event:fileDeleted fileDeleted} event of this `sap.ui.webc.fiori.UploadCollection`.
7153
+ * Attaches event handler `fnFunction` to the {@link #event:itemDelete itemDelete} event of this `sap.ui.webc.fiori.UploadCollection`.
6460
7154
  *
6461
7155
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6462
7156
  * otherwise it will be bound to this `sap.ui.webc.fiori.UploadCollection` itself.
@@ -6466,7 +7160,7 @@ declare namespace sap {
6466
7160
  * **Note:** A Delete button is displayed on each item, when the `sap.ui.webc.fiori.UploadCollection` `mode`
6467
7161
  * property is set to `Delete`.
6468
7162
  */
6469
- attachFileDeleted(
7163
+ attachItemDelete(
6470
7164
  /**
6471
7165
  * An application-specific payload object that will be passed to the event handler along with the event
6472
7166
  * object when firing the event
@@ -6483,7 +7177,7 @@ declare namespace sap {
6483
7177
  oListener?: object
6484
7178
  ): this;
6485
7179
  /**
6486
- * Attaches event handler `fnFunction` to the {@link #event:fileDeleted fileDeleted} event of this `sap.ui.webc.fiori.UploadCollection`.
7180
+ * Attaches event handler `fnFunction` to the {@link #event:itemDelete itemDelete} event of this `sap.ui.webc.fiori.UploadCollection`.
6487
7181
  *
6488
7182
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6489
7183
  * otherwise it will be bound to this `sap.ui.webc.fiori.UploadCollection` itself.
@@ -6493,7 +7187,7 @@ declare namespace sap {
6493
7187
  * **Note:** A Delete button is displayed on each item, when the `sap.ui.webc.fiori.UploadCollection` `mode`
6494
7188
  * property is set to `Delete`.
6495
7189
  */
6496
- attachFileDeleted(
7190
+ attachItemDelete(
6497
7191
  /**
6498
7192
  * The function to be called when the event occurs
6499
7193
  */
@@ -6573,11 +7267,11 @@ declare namespace sap {
6573
7267
  oListener?: object
6574
7268
  ): this;
6575
7269
  /**
6576
- * Detaches event handler `fnFunction` from the {@link #event:fileDeleted fileDeleted} event of this `sap.ui.webc.fiori.UploadCollection`.
7270
+ * Detaches event handler `fnFunction` from the {@link #event:itemDelete itemDelete} event of this `sap.ui.webc.fiori.UploadCollection`.
6577
7271
  *
6578
7272
  * The passed function and listener object must match the ones used for event registration.
6579
7273
  */
6580
- detachFileDeleted(
7274
+ detachItemDelete(
6581
7275
  /**
6582
7276
  * The function to be called, when the event occurs
6583
7277
  */
@@ -6618,9 +7312,9 @@ declare namespace sap {
6618
7312
  }
6619
7313
  ): this;
6620
7314
  /**
6621
- * Fires event {@link #event:fileDeleted fileDeleted} to attached listeners.
7315
+ * Fires event {@link #event:itemDelete itemDelete} to attached listeners.
6622
7316
  */
6623
- fireFileDeleted(
7317
+ fireItemDelete(
6624
7318
  /**
6625
7319
  * Parameters to pass along with the event
6626
7320
  */
@@ -7272,10 +7966,18 @@ declare namespace sap {
7272
7966
  * Hold the description of the `sap.ui.webc.fiori.UploadCollectionItem`. Will be shown below the file name.
7273
7967
  */
7274
7968
  getContent(): sap.ui.core.Control[];
7969
+ /**
7970
+ * Gets current value of property {@link #getDisableDeleteButton disableDeleteButton}.
7971
+ *
7972
+ * Disables the delete button.
7973
+ *
7974
+ * Default value is `false`.
7975
+ */
7976
+ getDisableDeleteButton(): boolean;
7275
7977
  /**
7276
7978
  * Gets current value of property {@link #getFile file}.
7277
7979
  *
7278
- * Holds `File`, associated with this item.
7980
+ * Holds an instance of `File` associated with this item.
7279
7981
  */
7280
7982
  getFile(): object;
7281
7983
  /**
@@ -7295,29 +7997,21 @@ declare namespace sap {
7295
7997
  */
7296
7998
  getFileNameClickable(): boolean;
7297
7999
  /**
7298
- * Gets current value of property {@link #getNoDelete noDelete}.
7299
- *
7300
- * Removes delete option from `sap.ui.webc.fiori.UploadCollection` with `mode` `Delete` for this item.
7301
- *
7302
- * Default value is `false`.
7303
- */
7304
- getNoDelete(): boolean;
7305
- /**
7306
- * Gets current value of property {@link #getNoRetry noRetry}.
8000
+ * Gets current value of property {@link #getHideRetryButton hideRetryButton}.
7307
8001
  *
7308
8002
  * Hides the retry button when `uploadState` property is `Error`.
7309
8003
  *
7310
8004
  * Default value is `false`.
7311
8005
  */
7312
- getNoRetry(): boolean;
8006
+ getHideRetryButton(): boolean;
7313
8007
  /**
7314
- * Gets current value of property {@link #getNoTerminate noTerminate}.
8008
+ * Gets current value of property {@link #getHideTerminateButton hideTerminateButton}.
7315
8009
  *
7316
8010
  * Hides the terminate button when `uploadState` property is `Uploading`.
7317
8011
  *
7318
8012
  * Default value is `false`.
7319
8013
  */
7320
- getNoTerminate(): boolean;
8014
+ getHideTerminateButton(): boolean;
7321
8015
  /**
7322
8016
  * Gets current value of property {@link #getProgress progress}.
7323
8017
  *
@@ -7350,173 +8044,486 @@ declare namespace sap {
7350
8044
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
7351
8045
  * its index if found or -1 otherwise.
7352
8046
  */
7353
- indexOfContent(
8047
+ indexOfContent(
8048
+ /**
8049
+ * The content whose index is looked for
8050
+ */
8051
+ oContent: sap.ui.core.Control
8052
+ ): int;
8053
+ /**
8054
+ * Inserts a content into the aggregation {@link #getContent content}.
8055
+ */
8056
+ insertContent(
8057
+ /**
8058
+ * The content to insert; if empty, nothing is inserted
8059
+ */
8060
+ oContent: sap.ui.core.Control,
8061
+ /**
8062
+ * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
8063
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the content
8064
+ * is inserted at the last position
8065
+ */
8066
+ iIndex: int
8067
+ ): this;
8068
+ /**
8069
+ * Removes all the controls from the aggregation {@link #getContent content}.
8070
+ *
8071
+ * Additionally, it unregisters them from the hosting UIArea.
8072
+ */
8073
+ removeAllContent(): sap.ui.core.Control[];
8074
+ /**
8075
+ * Removes a content from the aggregation {@link #getContent content}.
8076
+ */
8077
+ removeContent(
8078
+ /**
8079
+ * The content to remove or its index or id
8080
+ */
8081
+ vContent: int | string | sap.ui.core.Control
8082
+ ): sap.ui.core.Control;
8083
+ /**
8084
+ * Sets a new value for property {@link #getDisableDeleteButton disableDeleteButton}.
8085
+ *
8086
+ * Disables the delete button.
8087
+ *
8088
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8089
+ *
8090
+ * Default value is `false`.
8091
+ */
8092
+ setDisableDeleteButton(
8093
+ /**
8094
+ * New value for property `disableDeleteButton`
8095
+ */
8096
+ bDisableDeleteButton?: boolean
8097
+ ): this;
8098
+ /**
8099
+ * Sets a new value for property {@link #getFile file}.
8100
+ *
8101
+ * Holds an instance of `File` associated with this item.
8102
+ *
8103
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8104
+ */
8105
+ setFile(
8106
+ /**
8107
+ * New value for property `file`
8108
+ */
8109
+ oFile?: object
8110
+ ): this;
8111
+ /**
8112
+ * Sets a new value for property {@link #getFileName fileName}.
8113
+ *
8114
+ * The name of the file.
8115
+ *
8116
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8117
+ *
8118
+ * Default value is `empty string`.
8119
+ */
8120
+ setFileName(
8121
+ /**
8122
+ * New value for property `fileName`
8123
+ */
8124
+ sFileName?: string
8125
+ ): this;
8126
+ /**
8127
+ * Sets a new value for property {@link #getFileNameClickable fileNameClickable}.
8128
+ *
8129
+ * If set to `true` the file name will be clickable and it will fire `file-name-click` event upon click.
8130
+ *
8131
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8132
+ *
8133
+ * Default value is `false`.
8134
+ */
8135
+ setFileNameClickable(
8136
+ /**
8137
+ * New value for property `fileNameClickable`
8138
+ */
8139
+ bFileNameClickable?: boolean
8140
+ ): this;
8141
+ /**
8142
+ * Sets a new value for property {@link #getHideRetryButton hideRetryButton}.
8143
+ *
8144
+ * Hides the retry button when `uploadState` property is `Error`.
8145
+ *
8146
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8147
+ *
8148
+ * Default value is `false`.
8149
+ */
8150
+ setHideRetryButton(
8151
+ /**
8152
+ * New value for property `hideRetryButton`
8153
+ */
8154
+ bHideRetryButton?: boolean
8155
+ ): this;
8156
+ /**
8157
+ * Sets a new value for property {@link #getHideTerminateButton hideTerminateButton}.
8158
+ *
8159
+ * Hides the terminate button when `uploadState` property is `Uploading`.
8160
+ *
8161
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8162
+ *
8163
+ * Default value is `false`.
8164
+ */
8165
+ setHideTerminateButton(
8166
+ /**
8167
+ * New value for property `hideTerminateButton`
8168
+ */
8169
+ bHideTerminateButton?: boolean
8170
+ ): this;
8171
+ /**
8172
+ * Sets a new value for property {@link #getProgress progress}.
8173
+ *
8174
+ * The upload progress in percentage.
8175
+ *
8176
+ * **Note:** Expected values are in the interval [0, 100].
8177
+ *
8178
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8179
+ *
8180
+ * Default value is `0`.
8181
+ */
8182
+ setProgress(
8183
+ /**
8184
+ * New value for property `progress`
8185
+ */
8186
+ iProgress?: int
8187
+ ): this;
8188
+ /**
8189
+ * Sets the aggregated {@link #getThumbnail thumbnail}.
8190
+ */
8191
+ setThumbnail(
8192
+ /**
8193
+ * The thumbnail to set
8194
+ */
8195
+ oThumbnail: sap.ui.core.Control
8196
+ ): this;
8197
+ /**
8198
+ * Sets a new value for property {@link #getUploadState uploadState}.
8199
+ *
8200
+ * If set to `Uploading` or `Error`, a progress indicator showing the `progress` is displayed. Also if set
8201
+ * to `Error`, a refresh button is shown. When this icon is pressed `retry` event is fired. If set to `Uploading`,
8202
+ * a terminate button is shown. When this icon is pressed `terminate` event is fired.
8203
+ *
8204
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8205
+ *
8206
+ * Default value is `Ready`.
8207
+ */
8208
+ setUploadState(
8209
+ /**
8210
+ * New value for property `uploadState`
8211
+ */
8212
+ sUploadState?: sap.ui.webc.fiori.UploadState
8213
+ ): this;
8214
+ }
8215
+ /**
8216
+ * @SINCE 1.92.0
8217
+ * @EXPERIMENTAL (since 1.92.0)
8218
+ *
8219
+ * Overview: The `sap.ui.webc.fiori.ViewSettingsDialog` component helps the user to sort data within a list
8220
+ * or a table. It consists of several lists like `Sort order` which is built-in and `Sort By` which must
8221
+ * be provided by the developer. The selected options can be used to create sorters for the table.
8222
+ *
8223
+ * The `sap.ui.webc.fiori.ViewSettingsDialog` interrupts the current application processing as it is the
8224
+ * only focused UI element and the main screen is dimmed/blocked. The `sap.ui.webc.fiori.ViewSettingsDialog`
8225
+ * is modal, which means that user action is required before returning to the parent window is possible.
8226
+ *
8227
+ * Structure: A `sap.ui.webc.fiori.ViewSettingsDialog` consists of a header, content, and a footer for action
8228
+ * buttons. The `sap.ui.webc.fiori.ViewSettingsDialog` is usually displayed at the center of the screen.
8229
+ *
8230
+ * Responsive Behavior: `sap.ui.webc.fiori.ViewSettingsDialog` stretches on full screen on phones.
8231
+ */
8232
+ class ViewSettingsDialog extends sap.ui.webc.common.WebComponent {
8233
+ /**
8234
+ * Constructor for a new `ViewSettingsDialog`.
8235
+ *
8236
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
8237
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
8238
+ * of the syntax of the settings object.
8239
+ */
8240
+ constructor(
8241
+ /**
8242
+ * Initial settings for the new control
8243
+ */
8244
+ mSettings?: sap.ui.webc.fiori.$ViewSettingsDialogSettings
8245
+ );
8246
+ /**
8247
+ * Constructor for a new `ViewSettingsDialog`.
8248
+ *
8249
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
8250
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
8251
+ * of the syntax of the settings object.
8252
+ */
8253
+ constructor(
8254
+ /**
8255
+ * ID for the new control, generated automatically if no ID is given
8256
+ */
8257
+ sId?: string,
8258
+ /**
8259
+ * Initial settings for the new control
8260
+ */
8261
+ mSettings?: sap.ui.webc.fiori.$ViewSettingsDialogSettings
8262
+ );
8263
+
8264
+ /**
8265
+ * Creates a new subclass of class sap.ui.webc.fiori.ViewSettingsDialog with name `sClassName` and enriches
8266
+ * it with the information contained in `oClassInfo`.
8267
+ *
8268
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
8269
+ */
8270
+ static extend<T extends Record<string, unknown>>(
8271
+ /**
8272
+ * Name of the class being created
8273
+ */
8274
+ sClassName: string,
8275
+ /**
8276
+ * Object literal with information about the class
8277
+ */
8278
+ oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.ViewSettingsDialog>,
8279
+ /**
8280
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
8281
+ * used by this class
8282
+ */
8283
+ FNMetaImpl?: Function
8284
+ ): Function;
8285
+ /**
8286
+ * Returns a metadata object for class sap.ui.webc.fiori.ViewSettingsDialog.
8287
+ */
8288
+ static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
8289
+ /**
8290
+ * Adds some sortItem to the aggregation {@link #getSortItems sortItems}.
8291
+ */
8292
+ addSortItem(
8293
+ /**
8294
+ * The sortItem to add; if empty, nothing is inserted
8295
+ */
8296
+ oSortItem: sap.ui.webc.main.IListItem
8297
+ ): this;
8298
+ /**
8299
+ * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
8300
+ *
8301
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8302
+ * otherwise it will be bound to this `sap.ui.webc.fiori.ViewSettingsDialog` itself.
8303
+ *
8304
+ * Fired when cancel button is activated.
8305
+ */
8306
+ attachCancel(
7354
8307
  /**
7355
- * The content whose index is looked for
8308
+ * An application-specific payload object that will be passed to the event handler along with the event
8309
+ * object when firing the event
7356
8310
  */
7357
- oContent: sap.ui.core.Control
7358
- ): int;
7359
- /**
7360
- * Inserts a content into the aggregation {@link #getContent content}.
7361
- */
7362
- insertContent(
8311
+ oData: object,
7363
8312
  /**
7364
- * The content to insert; if empty, nothing is inserted
8313
+ * The function to be called when the event occurs
7365
8314
  */
7366
- oContent: sap.ui.core.Control,
8315
+ fnFunction: (p1: sap.ui.base.Event) => void,
7367
8316
  /**
7368
- * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
7369
- * is inserted at position 0; for a value greater than the current size of the aggregation, the content
7370
- * is inserted at the last position
8317
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.ViewSettingsDialog`
8318
+ * itself
7371
8319
  */
7372
- iIndex: int
8320
+ oListener?: object
7373
8321
  ): this;
7374
8322
  /**
7375
- * Removes all the controls from the aggregation {@link #getContent content}.
8323
+ * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
7376
8324
  *
7377
- * Additionally, it unregisters them from the hosting UIArea.
7378
- */
7379
- removeAllContent(): sap.ui.core.Control[];
7380
- /**
7381
- * Removes a content from the aggregation {@link #getContent content}.
8325
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8326
+ * otherwise it will be bound to this `sap.ui.webc.fiori.ViewSettingsDialog` itself.
8327
+ *
8328
+ * Fired when cancel button is activated.
7382
8329
  */
7383
- removeContent(
8330
+ attachCancel(
7384
8331
  /**
7385
- * The content to remove or its index or id
8332
+ * The function to be called when the event occurs
7386
8333
  */
7387
- vContent: int | string | sap.ui.core.Control
7388
- ): sap.ui.core.Control;
8334
+ fnFunction: (p1: sap.ui.base.Event) => void,
8335
+ /**
8336
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.ViewSettingsDialog`
8337
+ * itself
8338
+ */
8339
+ oListener?: object
8340
+ ): this;
7389
8341
  /**
7390
- * Sets a new value for property {@link #getFile file}.
8342
+ * Attaches event handler `fnFunction` to the {@link #event:confirm confirm} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
7391
8343
  *
7392
- * Holds `File`, associated with this item.
8344
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8345
+ * otherwise it will be bound to this `sap.ui.webc.fiori.ViewSettingsDialog` itself.
7393
8346
  *
7394
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8347
+ * Fired when confirmation button is activated.
7395
8348
  */
7396
- setFile(
8349
+ attachConfirm(
7397
8350
  /**
7398
- * New value for property `file`
8351
+ * An application-specific payload object that will be passed to the event handler along with the event
8352
+ * object when firing the event
7399
8353
  */
7400
- oFile?: object
8354
+ oData: object,
8355
+ /**
8356
+ * The function to be called when the event occurs
8357
+ */
8358
+ fnFunction: (p1: sap.ui.base.Event) => void,
8359
+ /**
8360
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.ViewSettingsDialog`
8361
+ * itself
8362
+ */
8363
+ oListener?: object
7401
8364
  ): this;
7402
8365
  /**
7403
- * Sets a new value for property {@link #getFileName fileName}.
7404
- *
7405
- * The name of the file.
8366
+ * Attaches event handler `fnFunction` to the {@link #event:confirm confirm} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
7406
8367
  *
7407
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8368
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8369
+ * otherwise it will be bound to this `sap.ui.webc.fiori.ViewSettingsDialog` itself.
7408
8370
  *
7409
- * Default value is `empty string`.
8371
+ * Fired when confirmation button is activated.
7410
8372
  */
7411
- setFileName(
8373
+ attachConfirm(
7412
8374
  /**
7413
- * New value for property `fileName`
8375
+ * The function to be called when the event occurs
7414
8376
  */
7415
- sFileName?: string
8377
+ fnFunction: (p1: sap.ui.base.Event) => void,
8378
+ /**
8379
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.ViewSettingsDialog`
8380
+ * itself
8381
+ */
8382
+ oListener?: object
7416
8383
  ): this;
7417
8384
  /**
7418
- * Sets a new value for property {@link #getFileNameClickable fileNameClickable}.
7419
- *
7420
- * If set to `true` the file name will be clickable and it will fire `file-name-click` event upon click.
7421
- *
7422
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8385
+ * Destroys all the sortItems in the aggregation {@link #getSortItems sortItems}.
8386
+ */
8387
+ destroySortItems(): this;
8388
+ /**
8389
+ * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
7423
8390
  *
7424
- * Default value is `false`.
8391
+ * The passed function and listener object must match the ones used for event registration.
7425
8392
  */
7426
- setFileNameClickable(
8393
+ detachCancel(
7427
8394
  /**
7428
- * New value for property `fileNameClickable`
8395
+ * The function to be called, when the event occurs
7429
8396
  */
7430
- bFileNameClickable?: boolean
8397
+ fnFunction: (p1: sap.ui.base.Event) => void,
8398
+ /**
8399
+ * Context object on which the given function had to be called
8400
+ */
8401
+ oListener?: object
7431
8402
  ): this;
7432
8403
  /**
7433
- * Sets a new value for property {@link #getNoDelete noDelete}.
7434
- *
7435
- * Removes delete option from `sap.ui.webc.fiori.UploadCollection` with `mode` `Delete` for this item.
7436
- *
7437
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8404
+ * Detaches event handler `fnFunction` from the {@link #event:confirm confirm} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
7438
8405
  *
7439
- * Default value is `false`.
8406
+ * The passed function and listener object must match the ones used for event registration.
7440
8407
  */
7441
- setNoDelete(
8408
+ detachConfirm(
8409
+ /**
8410
+ * The function to be called, when the event occurs
8411
+ */
8412
+ fnFunction: (p1: sap.ui.base.Event) => void,
7442
8413
  /**
7443
- * New value for property `noDelete`
8414
+ * Context object on which the given function had to be called
7444
8415
  */
7445
- bNoDelete?: boolean
8416
+ oListener?: object
7446
8417
  ): this;
7447
8418
  /**
7448
- * Sets a new value for property {@link #getNoRetry noRetry}.
7449
- *
7450
- * Hides the retry button when `uploadState` property is `Error`.
7451
- *
7452
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7453
- *
7454
- * Default value is `false`.
8419
+ * Fires event {@link #event:cancel cancel} to attached listeners.
7455
8420
  */
7456
- setNoRetry(
8421
+ fireCancel(
7457
8422
  /**
7458
- * New value for property `noRetry`
8423
+ * Parameters to pass along with the event
7459
8424
  */
7460
- bNoRetry?: boolean
8425
+ mParameters?: {
8426
+ /**
8427
+ * The current sort order selected.
8428
+ */
8429
+ sortOrder?: string;
8430
+ /**
8431
+ * The current sort by selected.
8432
+ */
8433
+ sortBy?: string;
8434
+ }
7461
8435
  ): this;
7462
8436
  /**
7463
- * Sets a new value for property {@link #getNoTerminate noTerminate}.
7464
- *
7465
- * Hides the terminate button when `uploadState` property is `Uploading`.
7466
- *
7467
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7468
- *
7469
- * Default value is `false`.
8437
+ * Fires event {@link #event:confirm confirm} to attached listeners.
7470
8438
  */
7471
- setNoTerminate(
8439
+ fireConfirm(
7472
8440
  /**
7473
- * New value for property `noTerminate`
8441
+ * Parameters to pass along with the event
7474
8442
  */
7475
- bNoTerminate?: boolean
8443
+ mParameters?: {
8444
+ /**
8445
+ * The current sort order selected.
8446
+ */
8447
+ sortOrder?: string;
8448
+ /**
8449
+ * The current sort by selected.
8450
+ */
8451
+ sortBy?: string;
8452
+ }
7476
8453
  ): this;
7477
8454
  /**
7478
- * Sets a new value for property {@link #getProgress progress}.
8455
+ * Gets current value of property {@link #getSortDescending sortDescending}.
7479
8456
  *
7480
- * The upload progress in percentage.
7481
- *
7482
- * **Note:** Expected values are in the interval [0, 100].
8457
+ * Defines the initial sort order.
7483
8458
  *
7484
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8459
+ * Default value is `false`.
8460
+ */
8461
+ getSortDescending(): boolean;
8462
+ /**
8463
+ * Gets content of aggregation {@link #getSortItems sortItems}.
7485
8464
  *
7486
- * Default value is `0`.
8465
+ * Defines the `sortItems` list.
7487
8466
  */
7488
- setProgress(
8467
+ getSortItems(): sap.ui.webc.main.IListItem[];
8468
+ /**
8469
+ * Checks for the provided `sap.ui.webc.main.IListItem` in the aggregation {@link #getSortItems sortItems}.
8470
+ * and returns its index if found or -1 otherwise.
8471
+ */
8472
+ indexOfSortItem(
7489
8473
  /**
7490
- * New value for property `progress`
8474
+ * The sortItem whose index is looked for
7491
8475
  */
7492
- iProgress?: int
7493
- ): this;
8476
+ oSortItem: sap.ui.webc.main.IListItem
8477
+ ): int;
7494
8478
  /**
7495
- * Sets the aggregated {@link #getThumbnail thumbnail}.
8479
+ * Inserts a sortItem into the aggregation {@link #getSortItems sortItems}.
7496
8480
  */
7497
- setThumbnail(
8481
+ insertSortItem(
7498
8482
  /**
7499
- * The thumbnail to set
8483
+ * The sortItem to insert; if empty, nothing is inserted
7500
8484
  */
7501
- oThumbnail: sap.ui.core.Control
8485
+ oSortItem: sap.ui.webc.main.IListItem,
8486
+ /**
8487
+ * The `0`-based index the sortItem should be inserted at; for a negative value of `iIndex`, the sortItem
8488
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the sortItem
8489
+ * is inserted at the last position
8490
+ */
8491
+ iIndex: int
7502
8492
  ): this;
7503
8493
  /**
7504
- * Sets a new value for property {@link #getUploadState uploadState}.
8494
+ * Removes all the controls from the aggregation {@link #getSortItems sortItems}.
7505
8495
  *
7506
- * If set to `Uploading` or `Error`, a progress indicator showing the `progress` is displayed. Also if set
7507
- * to `Error`, a refresh button is shown. When this icon is pressed `retry` event is fired. If set to `Uploading`,
7508
- * a terminate button is shown. When this icon is pressed `terminate` event is fired.
8496
+ * Additionally, it unregisters them from the hosting UIArea.
8497
+ */
8498
+ removeAllSortItems(): sap.ui.webc.main.IListItem[];
8499
+ /**
8500
+ * Removes a sortItem from the aggregation {@link #getSortItems sortItems}.
8501
+ */
8502
+ removeSortItem(
8503
+ /**
8504
+ * The sortItem to remove or its index or id
8505
+ */
8506
+ vSortItem: int | string | sap.ui.webc.main.IListItem
8507
+ ): sap.ui.webc.main.IListItem;
8508
+ /**
8509
+ * Sets a new value for property {@link #getSortDescending sortDescending}.
8510
+ *
8511
+ * Defines the initial sort order.
7509
8512
  *
7510
8513
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7511
8514
  *
7512
- * Default value is `Ready`.
8515
+ * Default value is `false`.
7513
8516
  */
7514
- setUploadState(
8517
+ setSortDescending(
7515
8518
  /**
7516
- * New value for property `uploadState`
8519
+ * New value for property `sortDescending`
7517
8520
  */
7518
- sUploadState?: sap.ui.webc.fiori.UploadState
8521
+ bSortDescending?: boolean
7519
8522
  ): this;
8523
+ /**
8524
+ * Shows the dialog.
8525
+ */
8526
+ show(): void;
7520
8527
  }
7521
8528
  /**
7522
8529
  * @SINCE 1.92.0
@@ -7727,6 +8734,14 @@ declare namespace sap {
7727
8734
  changeWithClick?: boolean;
7728
8735
  }
7729
8736
  ): this;
8737
+ /**
8738
+ * Gets current value of property {@link #getAccessibleName accessibleName}.
8739
+ *
8740
+ * Sets the accessible aria name of the component.
8741
+ *
8742
+ * Default value is `undefined`.
8743
+ */
8744
+ getAccessibleName(): string;
7730
8745
  /**
7731
8746
  * Gets current value of property {@link #getHeight height}.
7732
8747
  *
@@ -7781,6 +8796,21 @@ declare namespace sap {
7781
8796
  */
7782
8797
  vStep: int | string | sap.ui.webc.fiori.IWizardStep
7783
8798
  ): sap.ui.webc.fiori.IWizardStep;
8799
+ /**
8800
+ * Sets a new value for property {@link #getAccessibleName accessibleName}.
8801
+ *
8802
+ * Sets the accessible aria name of the component.
8803
+ *
8804
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8805
+ *
8806
+ * Default value is `undefined`.
8807
+ */
8808
+ setAccessibleName(
8809
+ /**
8810
+ * New value for property `accessibleName`
8811
+ */
8812
+ sAccessibleName?: string
8813
+ ): this;
7784
8814
  /**
7785
8815
  * Sets a new value for property {@link #getHeight height}.
7786
8816
  *
@@ -7886,6 +8916,22 @@ declare namespace sap {
7886
8916
  * Destroys all the content in the aggregation {@link #getContent content}.
7887
8917
  */
7888
8918
  destroyContent(): this;
8919
+ /**
8920
+ * Gets current value of property {@link #getAccessibleName accessibleName}.
8921
+ *
8922
+ * Sets the accessible aria name of the component.
8923
+ *
8924
+ * Default value is `empty string`.
8925
+ */
8926
+ getAccessibleName(): string;
8927
+ /**
8928
+ * Gets current value of property {@link #getAccessibleNameRef accessibleNameRef}.
8929
+ *
8930
+ * Defines the aria-labelledby of the step.
8931
+ *
8932
+ * Default value is `empty string`.
8933
+ */
8934
+ getAccessibleNameRef(): string;
7889
8935
  /**
7890
8936
  * Gets current value of property {@link #getBranching branching}.
7891
8937
  *
@@ -8015,6 +9061,36 @@ declare namespace sap {
8015
9061
  */
8016
9062
  vContent: int | string | sap.ui.core.Control
8017
9063
  ): sap.ui.core.Control;
9064
+ /**
9065
+ * Sets a new value for property {@link #getAccessibleName accessibleName}.
9066
+ *
9067
+ * Sets the accessible aria name of the component.
9068
+ *
9069
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9070
+ *
9071
+ * Default value is `empty string`.
9072
+ */
9073
+ setAccessibleName(
9074
+ /**
9075
+ * New value for property `accessibleName`
9076
+ */
9077
+ sAccessibleName?: string
9078
+ ): this;
9079
+ /**
9080
+ * Sets a new value for property {@link #getAccessibleNameRef accessibleNameRef}.
9081
+ *
9082
+ * Defines the aria-labelledby of the step.
9083
+ *
9084
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9085
+ *
9086
+ * Default value is `empty string`.
9087
+ */
9088
+ setAccessibleNameRef(
9089
+ /**
9090
+ * New value for property `accessibleNameRef`
9091
+ */
9092
+ sAccessibleNameRef?: string
9093
+ ): this;
8018
9094
  /**
8019
9095
  * Sets a new value for property {@link #getBranching branching}.
8020
9096
  *
@@ -8238,6 +9314,58 @@ declare namespace sap {
8238
9314
  */
8239
9315
  TwoColumnsStartExpanded = "TwoColumnsStartExpanded",
8240
9316
  }
9317
+ /**
9318
+ * @SINCE 1.92.0
9319
+ * @EXPERIMENTAL (since 1.92.0)
9320
+ *
9321
+ * Different illustration types of Illustrated Message.
9322
+ */
9323
+ enum IllustrationMessageType {
9324
+ /**
9325
+ * "BeforeSearch" illustration type.
9326
+ */
9327
+ BeforeSearch = "BeforeSearch",
9328
+ /**
9329
+ * "NoActivities" illustration type.
9330
+ */
9331
+ NoActivities = "NoActivities",
9332
+ /**
9333
+ * "NoData" illustration type.
9334
+ */
9335
+ NoData = "NoData",
9336
+ /**
9337
+ * "NoEntries" illustration type.
9338
+ */
9339
+ NoEntries = "NoEntries",
9340
+ /**
9341
+ * "NoMail" illustration type.
9342
+ */
9343
+ NoMail = "NoMail",
9344
+ /**
9345
+ * "NoNotifications" illustration type.
9346
+ */
9347
+ NoNotifications = "NoNotifications",
9348
+ /**
9349
+ * "NoSavedItems" illustration type.
9350
+ */
9351
+ NoSavedItems = "NoSavedItems",
9352
+ /**
9353
+ * "NoSearchResults" illustration type.
9354
+ */
9355
+ NoSearchResults = "NoSearchResults",
9356
+ /**
9357
+ * "NoTasks" illustration type.
9358
+ */
9359
+ NoTasks = "NoTasks",
9360
+ /**
9361
+ * "UnableToLoad" illustration type.
9362
+ */
9363
+ UnableToLoad = "UnableToLoad",
9364
+ /**
9365
+ * "UnableToUpload" illustration type.
9366
+ */
9367
+ UnableToUpload = "UnableToUpload",
9368
+ }
8241
9369
  /**
8242
9370
  * @SINCE 1.92.0
8243
9371
  * @EXPERIMENTAL (since 1.92.0)
@@ -8258,6 +9386,22 @@ declare namespace sap {
8258
9386
  */
8259
9387
  Transparent = "Transparent",
8260
9388
  }
9389
+ /**
9390
+ * @SINCE 1.92.0
9391
+ * @EXPERIMENTAL (since 1.92.0)
9392
+ *
9393
+ * Different types of Timeline.
9394
+ */
9395
+ enum TimelineLayout {
9396
+ /**
9397
+ * Horizontal layout
9398
+ */
9399
+ Horizontal = "Horizontal",
9400
+ /**
9401
+ * Vertical layout Default type
9402
+ */
9403
+ Vertical = "Vertical",
9404
+ }
8261
9405
  /**
8262
9406
  * @SINCE 1.92.0
8263
9407
  * @EXPERIMENTAL (since 1.92.0)
@@ -8289,8 +9433,12 @@ declare namespace sap {
8289
9433
  interface IUI5DefineDependencyNames {
8290
9434
  "sap/ui/webc/fiori/Bar": undefined;
8291
9435
 
9436
+ "sap/ui/webc/fiori/BarcodeScannerDialog": undefined;
9437
+
8292
9438
  "sap/ui/webc/fiori/FlexibleColumnLayout": undefined;
8293
9439
 
9440
+ "sap/ui/webc/fiori/IllustratedMessage": undefined;
9441
+
8294
9442
  "sap/ui/webc/fiori/library": undefined;
8295
9443
 
8296
9444
  "sap/ui/webc/fiori/NotificationAction": undefined;
@@ -8323,6 +9471,8 @@ declare namespace sap {
8323
9471
 
8324
9472
  "sap/ui/webc/fiori/UploadCollectionItem": undefined;
8325
9473
 
9474
+ "sap/ui/webc/fiori/ViewSettingsDialog": undefined;
9475
+
8326
9476
  "sap/ui/webc/fiori/Wizard": undefined;
8327
9477
 
8328
9478
  "sap/ui/webc/fiori/WizardStep": undefined;