@openui5/ts-types 1.97.1 → 1.100.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.97.1
1
+ // For Library Version: 1.100.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -10,6 +10,16 @@ declare namespace sap {
10
10
  * SAPUI5 library with controls based on UI5 Web Components
11
11
  */
12
12
  namespace fiori {
13
+ /**
14
+ * @SINCE 1.99.0
15
+ * @EXPERIMENTAL (since 1.99.0)
16
+ *
17
+ * Interface for components that may be slotted inside `ui5-page` as header and footer.
18
+ */
19
+ interface IBar {
20
+ __implements__sap_ui_webc_fiori_IBar: boolean;
21
+ }
22
+
13
23
  /**
14
24
  * @SINCE 1.97.0
15
25
  * @EXPERIMENTAL (since 1.97.0)
@@ -30,6 +40,16 @@ declare namespace sap {
30
40
  __implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
31
41
  }
32
42
 
43
+ /**
44
+ * @SINCE 1.99.0
45
+ * @EXPERIMENTAL (since 1.99.0)
46
+ *
47
+ * Interface for components that can be slotted inside `ui5-media-gallery` as items.
48
+ */
49
+ interface IMediaGalleryItem {
50
+ __implements__sap_ui_webc_fiori_IMediaGalleryItem: boolean;
51
+ }
52
+
33
53
  /**
34
54
  * @SINCE 1.92.0
35
55
  * @EXPERIMENTAL (since 1.92.0)
@@ -155,17 +175,17 @@ declare namespace sap {
155
175
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
156
176
 
157
177
  /**
158
- * Defines the content in the middle of the bar
178
+ * Defines the content at the end of the bar
159
179
  */
160
- content?:
180
+ endContent?:
161
181
  | sap.ui.core.Control[]
162
182
  | sap.ui.core.Control
163
183
  | sap.ui.base.ManagedObject.AggregationBindingInfo;
164
184
 
165
185
  /**
166
- * Defines the content at the end of the bar
186
+ * Defines the content in the middle of the bar
167
187
  */
168
- endContent?:
188
+ middleContent?:
169
189
  | sap.ui.core.Control[]
170
190
  | sap.ui.core.Control
171
191
  | sap.ui.base.ManagedObject.AggregationBindingInfo;
@@ -192,6 +212,102 @@ declare namespace sap {
192
212
  scanSuccess?: (oEvent: sap.ui.base.Event) => void;
193
213
  }
194
214
 
215
+ interface $DynamicSideContentSettings
216
+ extends sap.ui.webc.common.$WebComponentSettings {
217
+ /**
218
+ * Defines whether the component is in equal split mode. In this mode, the side and the main content take
219
+ * 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
220
+ * are switching visibility using the toggle method.
221
+ */
222
+ equalSplit?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
223
+
224
+ /**
225
+ * Defines the visibility of the main content.
226
+ */
227
+ hideMainContent?:
228
+ | boolean
229
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
230
+
231
+ /**
232
+ * Defines the visibility of the side content.
233
+ */
234
+ hideSideContent?:
235
+ | boolean
236
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
237
+
238
+ /**
239
+ * Defines on which breakpoints the side content falls down below the main content.
240
+ *
241
+ *
242
+ *
243
+ * **The available values are:**
244
+ *
245
+ *
246
+ * - `BelowXL`
247
+ * - `BelowL`
248
+ * - `BelowM`
249
+ * - `OnMinimumWidth`
250
+ */
251
+ sideContentFallDown?:
252
+ | sap.ui.webc.fiori.SideContentFallDown
253
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
254
+
255
+ /**
256
+ * Defines whether the side content is positioned before the main content (left side in LTR mode), or after
257
+ * the the main content (right side in LTR mode).
258
+ *
259
+ *
260
+ *
261
+ * **The available values are:**
262
+ *
263
+ *
264
+ * - `Start`
265
+ * - `End`
266
+ */
267
+ sideContentPosition?:
268
+ | sap.ui.webc.fiori.SideContentPosition
269
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
270
+
271
+ /**
272
+ * Defines on which breakpoints the side content is visible.
273
+ *
274
+ *
275
+ *
276
+ * **The available values are:**
277
+ *
278
+ *
279
+ * - `AlwaysShow`
280
+ * - `ShowAboveL`
281
+ * - `ShowAboveM`
282
+ * - `ShowAboveS`
283
+ * - `NeverShow`
284
+ */
285
+ sideContentVisibility?:
286
+ | sap.ui.webc.fiori.SideContentVisibility
287
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
288
+
289
+ /**
290
+ * Defines the main content.
291
+ */
292
+ content?:
293
+ | sap.ui.core.Control[]
294
+ | sap.ui.core.Control
295
+ | sap.ui.base.ManagedObject.AggregationBindingInfo;
296
+
297
+ /**
298
+ * Defines the side content.
299
+ */
300
+ sideContent?:
301
+ | sap.ui.core.Control[]
302
+ | sap.ui.core.Control
303
+ | sap.ui.base.ManagedObject.AggregationBindingInfo;
304
+
305
+ /**
306
+ * Fires when the current breakpoint has been changed.
307
+ */
308
+ layoutChange?: (oEvent: sap.ui.base.Event) => void;
309
+ }
310
+
195
311
  interface $FilterItemSettings
196
312
  extends sap.ui.webc.common.$WebComponentSettings {
197
313
  /**
@@ -223,6 +339,19 @@ declare namespace sap {
223
339
 
224
340
  interface $FlexibleColumnLayoutSettings
225
341
  extends sap.ui.webc.common.$WebComponentSettings {
342
+ /**
343
+ * An object of strings that defines additional accessibility roles for further customization.
344
+ *
345
+ * It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
346
+ * `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
347
+ * and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
348
+ * the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
349
+ * the accessibility role for the `endColumn`
350
+ */
351
+ accessibilityRoles?:
352
+ | object
353
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
354
+
226
355
  /**
227
356
  * An object of strings that defines several additional accessibility texts for even further customization.
228
357
  *
@@ -233,7 +362,9 @@ declare namespace sap {
233
362
  * the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
234
363
  * right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
235
364
  * have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
236
- * and `end` columns) will have when pointing to the right
365
+ * and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
366
+ * that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
367
+ * the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
237
368
  */
238
369
  accessibilityTexts?:
239
370
  | object
@@ -343,6 +474,126 @@ declare namespace sap {
343
474
  subtitle?: sap.ui.core.Control;
344
475
  }
345
476
 
477
+ interface $MediaGallerySettings
478
+ extends sap.ui.webc.common.$WebComponentSettings {
479
+ /**
480
+ * If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
481
+ * The display area is the central area that contains the enlarged content of the currently selected item.
482
+ */
483
+ interactiveDisplayArea?:
484
+ | boolean
485
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
486
+
487
+ /**
488
+ * Determines the layout of the component.
489
+ *
490
+ * Available options are:
491
+ * - `Auto`
492
+ * - `Vertical`
493
+ * - `Horizontal`
494
+ */
495
+ layout?:
496
+ | sap.ui.webc.fiori.MediaGalleryLayout
497
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
498
+
499
+ /**
500
+ * Determines the horizontal alignment of the thumbnails menu vs. the central display area.
501
+ *
502
+ * Available options are:
503
+ * - `Left`
504
+ * - `Right`
505
+ */
506
+ menuHorizontalAlign?:
507
+ | sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign
508
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
509
+
510
+ /**
511
+ * Determines the vertical alignment of the thumbnails menu vs. the central display area.
512
+ *
513
+ * Available options are:
514
+ * - `Top`
515
+ * - `Bottom`
516
+ */
517
+ menuVerticalAlign?:
518
+ | sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign
519
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
520
+
521
+ /**
522
+ * If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
523
+ * thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
524
+ */
525
+ showAllThumbnails?:
526
+ | boolean
527
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
528
+
529
+ /**
530
+ * Defines the component items.
531
+ *
532
+ *
533
+ *
534
+ * **Note:** Only one selected item is allowed.
535
+ *
536
+ *
537
+ *
538
+ * **Note:** Use the `sap.ui.webc.fiori.MediaGalleryItem` component to define the desired items.
539
+ */
540
+ items?:
541
+ | sap.ui.webc.fiori.IMediaGalleryItem[]
542
+ | sap.ui.webc.fiori.IMediaGalleryItem
543
+ | sap.ui.base.ManagedObject.AggregationBindingInfo;
544
+
545
+ /**
546
+ * Fired when the display area is clicked.
547
+ * The display area is the central area that contains the enlarged content of the currently selected item.
548
+ */
549
+ displayAreaClick?: (oEvent: sap.ui.base.Event) => void;
550
+
551
+ /**
552
+ * Fired when the thumbnails overflow button is clicked.
553
+ */
554
+ overflowClick?: (oEvent: sap.ui.base.Event) => void;
555
+
556
+ /**
557
+ * Fired when selection is changed by user interaction.
558
+ */
559
+ selectionChange?: (oEvent: sap.ui.base.Event) => void;
560
+ }
561
+
562
+ interface $MediaGalleryItemSettings
563
+ extends sap.ui.webc.common.$WebComponentSettings {
564
+ /**
565
+ * Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
566
+ * the tab chain.
567
+ */
568
+ enabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
569
+
570
+ /**
571
+ * Determines the layout of the item container.
572
+ *
573
+ * Available options are:
574
+ * - `Square`
575
+ * - `Wide`
576
+ */
577
+ layout?:
578
+ | sap.ui.webc.fiori.MediaGalleryItemLayout
579
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
580
+
581
+ /**
582
+ * Defines the selected state of the component.
583
+ */
584
+ selected?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
585
+
586
+ /**
587
+ * Defines the content of the component.
588
+ */
589
+ content?: sap.ui.core.Control;
590
+
591
+ /**
592
+ * Defines the content of the thumbnail.
593
+ */
594
+ thumbnail?: sap.ui.core.Control;
595
+ }
596
+
346
597
  interface $NotificationActionSettings
347
598
  extends sap.ui.webc.common.$WebComponentSettings {
348
599
  /**
@@ -362,11 +613,10 @@ declare namespace sap {
362
613
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
363
614
 
364
615
  /**
365
- * Defines if the action is disabled.
366
- *
367
- * **Note:** a disabled action can't be pressed or focused, and it is not in the tab chain.
616
+ * Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
617
+ * the tab chain.
368
618
  */
369
- disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
619
+ enabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
370
620
 
371
621
  /**
372
622
  * Defines the `icon` source URI.
@@ -618,18 +868,12 @@ declare namespace sap {
618
868
  /**
619
869
  * Defines the footer HTML Element.
620
870
  */
621
- footer?:
622
- | sap.ui.core.Control[]
623
- | sap.ui.core.Control
624
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
871
+ footer?: sap.ui.webc.fiori.IBar;
625
872
 
626
873
  /**
627
874
  * Defines the header HTML Element.
628
875
  */
629
- header?:
630
- | sap.ui.core.Control[]
631
- | sap.ui.core.Control
632
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
876
+ header?: sap.ui.webc.fiori.IBar;
633
877
  }
634
878
 
635
879
  interface $ProductSwitchSettings
@@ -694,6 +938,16 @@ declare namespace sap {
694
938
 
695
939
  interface $ShellBarSettings
696
940
  extends sap.ui.webc.common.$WebComponentSettings {
941
+ /**
942
+ * An object of strings that defines several additional accessibility texts for even further customization.
943
+ *
944
+ * It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
945
+ * - `logoTitle`: defines the tooltip for the logo
946
+ */
947
+ accessibilityTexts?:
948
+ | object
949
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
950
+
697
951
  /**
698
952
  * Defines the `notificationsCount`, displayed in the notification icon top-right corner.
699
953
  */
@@ -795,7 +1049,7 @@ declare namespace sap {
795
1049
  logoClick?: (oEvent: sap.ui.base.Event) => void;
796
1050
 
797
1051
  /**
798
- * Fired, when a menu item is activated **Note:** You can prevent closing of oveflow popover by calling
1052
+ * Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
799
1053
  * `event.preventDefault()`.
800
1054
  */
801
1055
  menuItemClick?: (oEvent: sap.ui.base.Event) => void;
@@ -806,7 +1060,7 @@ declare namespace sap {
806
1060
  notificationsClick?: (oEvent: sap.ui.base.Event) => void;
807
1061
 
808
1062
  /**
809
- * Fired, when the product switch icon is activated. **Note:** You can prevent closing of oveflow popover
1063
+ * Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
810
1064
  * by calling `event.preventDefault()`.
811
1065
  */
812
1066
  productSwitchClick?: (oEvent: sap.ui.base.Event) => void;
@@ -837,7 +1091,7 @@ declare namespace sap {
837
1091
  /**
838
1092
  * Fired, when the item is pressed.
839
1093
  */
840
- itemClick?: (oEvent: sap.ui.base.Event) => void;
1094
+ click?: (oEvent: sap.ui.base.Event) => void;
841
1095
  }
842
1096
 
843
1097
  interface $SideNavigationSettings
@@ -972,6 +1226,13 @@ declare namespace sap {
972
1226
 
973
1227
  interface $TimelineSettings
974
1228
  extends sap.ui.webc.common.$WebComponentSettings {
1229
+ /**
1230
+ * Defines the accessible aria name of the component.
1231
+ */
1232
+ accessibleName?:
1233
+ | string
1234
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1235
+
975
1236
  /**
976
1237
  * Defines the height of the control
977
1238
  */
@@ -1061,7 +1322,7 @@ declare namespace sap {
1061
1322
  interface $UploadCollectionSettings
1062
1323
  extends sap.ui.webc.common.$WebComponentSettings {
1063
1324
  /**
1064
- * Sets the accessible aria name of the component.
1325
+ * Defines the accessible aria name of the component.
1065
1326
  */
1066
1327
  accessibleName?:
1067
1328
  | string
@@ -1294,13 +1555,6 @@ declare namespace sap {
1294
1555
 
1295
1556
  interface $WizardSettings
1296
1557
  extends sap.ui.webc.common.$WebComponentSettings {
1297
- /**
1298
- * Sets the accessible aria name of the component.
1299
- */
1300
- accessibleName?:
1301
- | string
1302
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1303
-
1304
1558
  /**
1305
1559
  * Defines the height of the control
1306
1560
  */
@@ -1327,20 +1581,6 @@ declare namespace sap {
1327
1581
 
1328
1582
  interface $WizardStepSettings
1329
1583
  extends sap.ui.webc.common.$WebComponentSettings {
1330
- /**
1331
- * Sets the accessible aria name of the component.
1332
- */
1333
- accessibleName?:
1334
- | string
1335
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1336
-
1337
- /**
1338
- * Defines the aria-labelledby of the step.
1339
- */
1340
- accessibleNameRef?:
1341
- | string
1342
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1343
-
1344
1584
  /**
1345
1585
  * When `branching` is enabled a dashed line would be displayed after the step, meant to indicate that the
1346
1586
  * next step is not yet known and depends on user choice in the current step.
@@ -1353,15 +1593,10 @@ declare namespace sap {
1353
1593
  branching?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1354
1594
 
1355
1595
  /**
1356
- * Defines if the step is `disabled`. When disabled the step is displayed, but the user can't select the
1357
- * step by clicking or navigate to it with scrolling.
1358
- *
1359
- *
1360
- *
1361
- * **Note:** Step can't be `selected` and `disabled` at the same time. In this case the `selected` property
1362
- * would take precedence.
1596
+ * Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
1597
+ * the tab chain.
1363
1598
  */
1364
- disabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1599
+ enabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1365
1600
 
1366
1601
  /**
1367
1602
  * Defines the `icon` of the step.
@@ -1436,8 +1671,13 @@ declare namespace sap {
1436
1671
  * allow developers to style elements inside the Shadow DOM.
1437
1672
  * The `sap.ui.webc.fiori.Bar` exposes the following CSS Shadow Parts:
1438
1673
  * - bar - Used to style the wrapper of the content of the component
1674
+ *
1675
+ * Keyboard Handling:
1439
1676
  */
1440
- class Bar extends sap.ui.webc.common.WebComponent {
1677
+ class Bar
1678
+ extends sap.ui.webc.common.WebComponent
1679
+ implements sap.ui.webc.fiori.IBar {
1680
+ __implements__sap_ui_webc_fiori_IBar: boolean;
1441
1681
  /**
1442
1682
  * Constructor for a new `Bar`.
1443
1683
  *
@@ -1495,22 +1735,22 @@ declare namespace sap {
1495
1735
  */
1496
1736
  static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
1497
1737
  /**
1498
- * Adds some content to the aggregation {@link #getContent content}.
1738
+ * Adds some endContent to the aggregation {@link #getEndContent endContent}.
1499
1739
  */
1500
- addContent(
1740
+ addEndContent(
1501
1741
  /**
1502
- * The content to add; if empty, nothing is inserted
1742
+ * The endContent to add; if empty, nothing is inserted
1503
1743
  */
1504
- oContent: sap.ui.core.Control
1744
+ oEndContent: sap.ui.core.Control
1505
1745
  ): this;
1506
1746
  /**
1507
- * Adds some endContent to the aggregation {@link #getEndContent endContent}.
1747
+ * Adds some middleContent to the aggregation {@link #getMiddleContent middleContent}.
1508
1748
  */
1509
- addEndContent(
1749
+ addMiddleContent(
1510
1750
  /**
1511
- * The endContent to add; if empty, nothing is inserted
1751
+ * The middleContent to add; if empty, nothing is inserted
1512
1752
  */
1513
- oEndContent: sap.ui.core.Control
1753
+ oMiddleContent: sap.ui.core.Control
1514
1754
  ): this;
1515
1755
  /**
1516
1756
  * Adds some startContent to the aggregation {@link #getStartContent startContent}.
@@ -1521,24 +1761,18 @@ declare namespace sap {
1521
1761
  */
1522
1762
  oStartContent: sap.ui.core.Control
1523
1763
  ): this;
1524
- /**
1525
- * Destroys all the content in the aggregation {@link #getContent content}.
1526
- */
1527
- destroyContent(): this;
1528
1764
  /**
1529
1765
  * Destroys all the endContent in the aggregation {@link #getEndContent endContent}.
1530
1766
  */
1531
1767
  destroyEndContent(): this;
1532
1768
  /**
1533
- * Destroys all the startContent in the aggregation {@link #getStartContent startContent}.
1769
+ * Destroys all the middleContent in the aggregation {@link #getMiddleContent middleContent}.
1534
1770
  */
1535
- destroyStartContent(): this;
1771
+ destroyMiddleContent(): this;
1536
1772
  /**
1537
- * Gets content of aggregation {@link #getContent content}.
1538
- *
1539
- * Defines the content in the middle of the bar
1773
+ * Destroys all the startContent in the aggregation {@link #getStartContent startContent}.
1540
1774
  */
1541
- getContent(): sap.ui.core.Control[];
1775
+ destroyStartContent(): this;
1542
1776
  /**
1543
1777
  * Gets current value of property {@link #getDesign design}.
1544
1778
  *
@@ -1561,6 +1795,12 @@ declare namespace sap {
1561
1795
  * Defines the content at the end of the bar
1562
1796
  */
1563
1797
  getEndContent(): sap.ui.core.Control[];
1798
+ /**
1799
+ * Gets content of aggregation {@link #getMiddleContent middleContent}.
1800
+ *
1801
+ * Defines the content in the middle of the bar
1802
+ */
1803
+ getMiddleContent(): sap.ui.core.Control[];
1564
1804
  /**
1565
1805
  * Gets content of aggregation {@link #getStartContent startContent}.
1566
1806
  *
@@ -1573,16 +1813,6 @@ declare namespace sap {
1573
1813
  * Defines the width of the control
1574
1814
  */
1575
1815
  getWidth(): sap.ui.core.CSSSize;
1576
- /**
1577
- * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
1578
- * its index if found or -1 otherwise.
1579
- */
1580
- indexOfContent(
1581
- /**
1582
- * The content whose index is looked for
1583
- */
1584
- oContent: sap.ui.core.Control
1585
- ): int;
1586
1816
  /**
1587
1817
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getEndContent endContent}. and
1588
1818
  * returns its index if found or -1 otherwise.
@@ -1593,6 +1823,16 @@ declare namespace sap {
1593
1823
  */
1594
1824
  oEndContent: sap.ui.core.Control
1595
1825
  ): int;
1826
+ /**
1827
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMiddleContent middleContent}.
1828
+ * and returns its index if found or -1 otherwise.
1829
+ */
1830
+ indexOfMiddleContent(
1831
+ /**
1832
+ * The middleContent whose index is looked for
1833
+ */
1834
+ oMiddleContent: sap.ui.core.Control
1835
+ ): int;
1596
1836
  /**
1597
1837
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getStartContent startContent}.
1598
1838
  * and returns its index if found or -1 otherwise.
@@ -1604,31 +1844,31 @@ declare namespace sap {
1604
1844
  oStartContent: sap.ui.core.Control
1605
1845
  ): int;
1606
1846
  /**
1607
- * Inserts a content into the aggregation {@link #getContent content}.
1847
+ * Inserts a endContent into the aggregation {@link #getEndContent endContent}.
1608
1848
  */
1609
- insertContent(
1849
+ insertEndContent(
1610
1850
  /**
1611
- * The content to insert; if empty, nothing is inserted
1851
+ * The endContent to insert; if empty, nothing is inserted
1612
1852
  */
1613
- oContent: sap.ui.core.Control,
1853
+ oEndContent: sap.ui.core.Control,
1614
1854
  /**
1615
- * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
1616
- * is inserted at position 0; for a value greater than the current size of the aggregation, the content
1855
+ * The `0`-based index the endContent should be inserted at; for a negative value of `iIndex`, the endContent
1856
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the endContent
1617
1857
  * is inserted at the last position
1618
1858
  */
1619
1859
  iIndex: int
1620
1860
  ): this;
1621
1861
  /**
1622
- * Inserts a endContent into the aggregation {@link #getEndContent endContent}.
1862
+ * Inserts a middleContent into the aggregation {@link #getMiddleContent middleContent}.
1623
1863
  */
1624
- insertEndContent(
1864
+ insertMiddleContent(
1625
1865
  /**
1626
- * The endContent to insert; if empty, nothing is inserted
1866
+ * The middleContent to insert; if empty, nothing is inserted
1627
1867
  */
1628
- oEndContent: sap.ui.core.Control,
1868
+ oMiddleContent: sap.ui.core.Control,
1629
1869
  /**
1630
- * The `0`-based index the endContent should be inserted at; for a negative value of `iIndex`, the endContent
1631
- * is inserted at position 0; for a value greater than the current size of the aggregation, the endContent
1870
+ * The `0`-based index the middleContent should be inserted at; for a negative value of `iIndex`, the middleContent
1871
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the middleContent
1632
1872
  * is inserted at the last position
1633
1873
  */
1634
1874
  iIndex: int
@@ -1649,17 +1889,17 @@ declare namespace sap {
1649
1889
  iIndex: int
1650
1890
  ): this;
1651
1891
  /**
1652
- * Removes all the controls from the aggregation {@link #getContent content}.
1892
+ * Removes all the controls from the aggregation {@link #getEndContent endContent}.
1653
1893
  *
1654
1894
  * Additionally, it unregisters them from the hosting UIArea.
1655
1895
  */
1656
- removeAllContent(): sap.ui.core.Control[];
1896
+ removeAllEndContent(): sap.ui.core.Control[];
1657
1897
  /**
1658
- * Removes all the controls from the aggregation {@link #getEndContent endContent}.
1898
+ * Removes all the controls from the aggregation {@link #getMiddleContent middleContent}.
1659
1899
  *
1660
1900
  * Additionally, it unregisters them from the hosting UIArea.
1661
1901
  */
1662
- removeAllEndContent(): sap.ui.core.Control[];
1902
+ removeAllMiddleContent(): sap.ui.core.Control[];
1663
1903
  /**
1664
1904
  * Removes all the controls from the aggregation {@link #getStartContent startContent}.
1665
1905
  *
@@ -1667,22 +1907,22 @@ declare namespace sap {
1667
1907
  */
1668
1908
  removeAllStartContent(): sap.ui.core.Control[];
1669
1909
  /**
1670
- * Removes a content from the aggregation {@link #getContent content}.
1910
+ * Removes a endContent from the aggregation {@link #getEndContent endContent}.
1671
1911
  */
1672
- removeContent(
1912
+ removeEndContent(
1673
1913
  /**
1674
- * The content to remove or its index or id
1914
+ * The endContent to remove or its index or id
1675
1915
  */
1676
- vContent: int | string | sap.ui.core.Control
1916
+ vEndContent: int | string | sap.ui.core.Control
1677
1917
  ): sap.ui.core.Control;
1678
1918
  /**
1679
- * Removes a endContent from the aggregation {@link #getEndContent endContent}.
1919
+ * Removes a middleContent from the aggregation {@link #getMiddleContent middleContent}.
1680
1920
  */
1681
- removeEndContent(
1921
+ removeMiddleContent(
1682
1922
  /**
1683
- * The endContent to remove or its index or id
1923
+ * The middleContent to remove or its index or id
1684
1924
  */
1685
- vEndContent: int | string | sap.ui.core.Control
1925
+ vMiddleContent: int | string | sap.ui.core.Control
1686
1926
  ): sap.ui.core.Control;
1687
1927
  /**
1688
1928
  * Removes a startContent from the aggregation {@link #getStartContent startContent}.
@@ -1966,19 +2206,68 @@ declare namespace sap {
1966
2206
  show(): void;
1967
2207
  }
1968
2208
  /**
1969
- * @SINCE 1.97.0
1970
- * @EXPERIMENTAL (since 1.97.0)
2209
+ * @SINCE 1.99.0
2210
+ * @EXPERIMENTAL (since 1.99.0)
1971
2211
  *
1972
2212
  * Overview:
1973
2213
  *
2214
+ * The DynamicSideContent (`sap.ui.webc.fiori.DynamicSideContent`) is a layout component that allows additional
2215
+ * content to be displayed in a way that flexibly adapts to different screen sizes. The side content appears
2216
+ * in a container next to or directly below the main content (it doesn't overlay). When the side content
2217
+ * is triggered, the main content becomes narrower (if appearing side-by-side). The side content contains
2218
+ * a separate scrollbar when appearing next to the main content.
2219
+ *
1974
2220
  * Usage:
2221
+ *
2222
+ * When to use?
2223
+ *
2224
+ * Use this component if you want to display relevant information that is not critical for users to complete
2225
+ * a task. Users should have access to all the key functions and critical information in the app even if
2226
+ * they do not see the side content. This is important because on smaller screen sizes it may be difficult
2227
+ * to display the side content in a way that is easily accessible for the user.
2228
+ *
2229
+ * When not to use?
2230
+ *
2231
+ * Don't use it if you want to display navigation or critical information that prevents users from completing
2232
+ * a task when they have no access to the side content.
2233
+ *
2234
+ * Responsive Behavior:
2235
+ *
2236
+ * Screen width > 1440px
2237
+ *
2238
+ *
2239
+ * - Main vs. side content ratio is 75 vs. 25 percent (with a minimum of 320px each).
2240
+ * - If the application defines a trigger, the side content can be hidden.
2241
+ *
2242
+ * Screen width <= 1440px and> 1024px
2243
+ *
2244
+ *
2245
+ * - Main vs. side content ratio is 66.666 vs. 33.333 percent (with a minimum of 320px each). If the side
2246
+ * content width falls below 320 px, it automatically slides under the main content, unless the app development
2247
+ * team specifies that it should disappear.
2248
+ *
2249
+ * Screen width <= 1024px and> 720px
2250
+ *
2251
+ *
2252
+ * - The side content ratio is fixed to 340px, and the main content takes the rest of the width. Only
2253
+ * if the `sideContentFallDown` is set to `OnMinimumWidth` and screen width is <= 960px and> 720px the side
2254
+ * content falls below the main content.
2255
+ *
2256
+ * Screen width <= 720px (for example on a mobile device)
2257
+ * - In this case, the side content automatically disappears from the screen (unless specified to stay
2258
+ * under the content by setting of `sideContentVisibility` property to `AlwaysShow`) and can be triggered
2259
+ * from a pre-set trigger (specified within the app). When the side content is triggered, it replaces the
2260
+ * main content. We recommend that you always place the trigger for the side content in the same location,
2261
+ * such as in the app footer.
2262
+ *
2263
+ * A special case allows switching the comparison mode between the main and side content. In this case,
2264
+ * the screen is split into 50:50 percent for main vs. side content. The responsive behavior of the equal
2265
+ * split is the same as in the standard view - the side content disappears on screen widths of less than
2266
+ * 720 px and can only be viewed by triggering it.
1975
2267
  */
1976
- class FilterItem
1977
- extends sap.ui.webc.common.WebComponent
1978
- implements sap.ui.webc.fiori.IFilterItem {
1979
- __implements__sap_ui_webc_fiori_IFilterItem: boolean;
2268
+ class DynamicSideContent extends sap.ui.webc.common.WebComponent {
1980
2269
  /**
1981
- * Constructor for a new `FilterItem`.
2270
+ * Constructor for a new `DynamicSideContent`.
1982
2271
  *
1983
2272
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1984
2273
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -1988,10 +2277,10 @@ declare namespace sap {
1988
2277
  /**
1989
2278
  * Initial settings for the new control
1990
2279
  */
1991
- mSettings?: sap.ui.webc.fiori.$FilterItemSettings
2280
+ mSettings?: sap.ui.webc.fiori.$DynamicSideContentSettings
1992
2281
  );
1993
2282
  /**
1994
- * Constructor for a new `FilterItem`.
2283
+ * Constructor for a new `DynamicSideContent`.
1995
2284
  *
1996
2285
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1997
2286
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -2005,12 +2294,12 @@ declare namespace sap {
2005
2294
  /**
2006
2295
  * Initial settings for the new control
2007
2296
  */
2008
- mSettings?: sap.ui.webc.fiori.$FilterItemSettings
2297
+ mSettings?: sap.ui.webc.fiori.$DynamicSideContentSettings
2009
2298
  );
2010
2299
 
2011
2300
  /**
2012
- * Creates a new subclass of class sap.ui.webc.fiori.FilterItem with name `sClassName` and enriches it with
2013
- * the information contained in `oClassInfo`.
2301
+ * Creates a new subclass of class sap.ui.webc.fiori.DynamicSideContent with name `sClassName` and enriches
2302
+ * it with the information contained in `oClassInfo`.
2014
2303
  *
2015
2304
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
2016
2305
  */
@@ -2022,7 +2311,7 @@ declare namespace sap {
2022
2311
  /**
2023
2312
  * Object literal with information about the class
2024
2313
  */
2025
- oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItem>,
2314
+ oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.DynamicSideContent>,
2026
2315
  /**
2027
2316
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2028
2317
  * used by this class
@@ -2030,240 +2319,1415 @@ declare namespace sap {
2030
2319
  FNMetaImpl?: Function
2031
2320
  ): Function;
2032
2321
  /**
2033
- * Returns a metadata object for class sap.ui.webc.fiori.FilterItem.
2322
+ * Returns a metadata object for class sap.ui.webc.fiori.DynamicSideContent.
2034
2323
  */
2035
2324
  static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
2036
2325
  /**
2037
- * Adds some value to the aggregation {@link #getValues values}.
2326
+ * Adds some content to the aggregation {@link #getContent content}.
2038
2327
  */
2039
- addValue(
2328
+ addContent(
2040
2329
  /**
2041
- * The value to add; if empty, nothing is inserted
2330
+ * The content to add; if empty, nothing is inserted
2042
2331
  */
2043
- oValue: sap.ui.webc.fiori.IFilterItemOption
2332
+ oContent: sap.ui.core.Control
2044
2333
  ): this;
2045
2334
  /**
2046
- * Destroys all the values in the aggregation {@link #getValues values}.
2335
+ * Adds some sideContent to the aggregation {@link #getSideContent sideContent}.
2047
2336
  */
2048
- destroyValues(): this;
2337
+ addSideContent(
2338
+ /**
2339
+ * The sideContent to add; if empty, nothing is inserted
2340
+ */
2341
+ oSideContent: sap.ui.core.Control
2342
+ ): this;
2049
2343
  /**
2050
- * Gets current value of property {@link #getText text}.
2051
- *
2052
- * Defines the text of the component.
2344
+ * Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
2053
2345
  *
2054
- * Default value is `empty string`.
2055
- */
2056
- getText(): string;
2057
- /**
2058
- * Gets content of aggregation {@link #getValues values}.
2346
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2347
+ * otherwise it will be bound to this `sap.ui.webc.fiori.DynamicSideContent` itself.
2059
2348
  *
2060
- * Defines the `values` list.
2061
- */
2062
- getValues(): sap.ui.webc.fiori.IFilterItemOption[];
2063
- /**
2064
- * Checks for the provided `sap.ui.webc.fiori.IFilterItemOption` in the aggregation {@link #getValues values}.
2065
- * and returns its index if found or -1 otherwise.
2349
+ * Fires when the current breakpoint has been changed.
2066
2350
  */
2067
- indexOfValue(
2351
+ attachLayoutChange(
2068
2352
  /**
2069
- * The value whose index is looked for
2353
+ * An application-specific payload object that will be passed to the event handler along with the event
2354
+ * object when firing the event
2070
2355
  */
2071
- oValue: sap.ui.webc.fiori.IFilterItemOption
2072
- ): int;
2073
- /**
2074
- * Inserts a value into the aggregation {@link #getValues values}.
2075
- */
2076
- insertValue(
2356
+ oData: object,
2077
2357
  /**
2078
- * The value to insert; if empty, nothing is inserted
2358
+ * The function to be called when the event occurs
2079
2359
  */
2080
- oValue: sap.ui.webc.fiori.IFilterItemOption,
2360
+ fnFunction: (p1: sap.ui.base.Event) => void,
2081
2361
  /**
2082
- * The `0`-based index the value should be inserted at; for a negative value of `iIndex`, the value is inserted
2083
- * at position 0; for a value greater than the current size of the aggregation, the value is inserted at
2084
- * the last position
2362
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.DynamicSideContent`
2363
+ * itself
2085
2364
  */
2086
- iIndex: int
2365
+ oListener?: object
2087
2366
  ): this;
2088
2367
  /**
2089
- * Removes all the controls from the aggregation {@link #getValues values}.
2368
+ * Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
2090
2369
  *
2091
- * Additionally, it unregisters them from the hosting UIArea.
2092
- */
2093
- removeAllValues(): sap.ui.webc.fiori.IFilterItemOption[];
2094
- /**
2095
- * Removes a value from the aggregation {@link #getValues values}.
2370
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2371
+ * otherwise it will be bound to this `sap.ui.webc.fiori.DynamicSideContent` itself.
2372
+ *
2373
+ * Fires when the current breakpoint has been changed.
2096
2374
  */
2097
- removeValue(
2375
+ attachLayoutChange(
2098
2376
  /**
2099
- * The value to remove or its index or id
2377
+ * The function to be called when the event occurs
2100
2378
  */
2101
- vValue: int | string | sap.ui.webc.fiori.IFilterItemOption
2102
- ): sap.ui.webc.fiori.IFilterItemOption;
2103
- /**
2104
- * Sets a new value for property {@link #getText text}.
2105
- *
2106
- * Defines the text of the component.
2107
- *
2108
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2109
- *
2110
- * Default value is `empty string`.
2111
- */
2112
- setText(
2379
+ fnFunction: (p1: sap.ui.base.Event) => void,
2113
2380
  /**
2114
- * New value for property `text`
2381
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.DynamicSideContent`
2382
+ * itself
2115
2383
  */
2116
- sText?: string
2384
+ oListener?: object
2117
2385
  ): this;
2118
- }
2119
- /**
2120
- * @SINCE 1.97.0
2121
- * @EXPERIMENTAL (since 1.97.0)
2122
- *
2123
- * Overview:
2124
- *
2125
- * Usage:
2126
- */
2127
- class FilterItemOption
2128
- extends sap.ui.webc.common.WebComponent
2129
- implements sap.ui.webc.fiori.IFilterItemOption {
2130
- __implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
2131
2386
  /**
2132
- * Constructor for a new `FilterItemOption`.
2133
- *
2134
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2135
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2136
- * of the syntax of the settings object.
2387
+ * Destroys all the content in the aggregation {@link #getContent content}.
2137
2388
  */
2138
- constructor(
2139
- /**
2140
- * Initial settings for the new control
2141
- */
2142
- mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
2143
- );
2389
+ destroyContent(): this;
2144
2390
  /**
2145
- * Constructor for a new `FilterItemOption`.
2146
- *
2147
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2148
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2149
- * of the syntax of the settings object.
2391
+ * Destroys all the sideContent in the aggregation {@link #getSideContent sideContent}.
2150
2392
  */
2151
- constructor(
2152
- /**
2153
- * ID for the new control, generated automatically if no ID is given
2154
- */
2155
- sId?: string,
2156
- /**
2157
- * Initial settings for the new control
2158
- */
2159
- mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
2160
- );
2161
-
2393
+ destroySideContent(): this;
2162
2394
  /**
2163
- * Creates a new subclass of class sap.ui.webc.fiori.FilterItemOption with name `sClassName` and enriches
2164
- * it with the information contained in `oClassInfo`.
2395
+ * Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.DynamicSideContent`.
2165
2396
  *
2166
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
2397
+ * The passed function and listener object must match the ones used for event registration.
2167
2398
  */
2168
- static extend<T extends Record<string, unknown>>(
2399
+ detachLayoutChange(
2169
2400
  /**
2170
- * Name of the class being created
2401
+ * The function to be called, when the event occurs
2171
2402
  */
2172
- sClassName: string,
2403
+ fnFunction: (p1: sap.ui.base.Event) => void,
2173
2404
  /**
2174
- * Object literal with information about the class
2405
+ * Context object on which the given function had to be called
2175
2406
  */
2176
- oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItemOption>,
2407
+ oListener?: object
2408
+ ): this;
2409
+ /**
2410
+ * Fires event {@link #event:layoutChange layoutChange} to attached listeners.
2411
+ */
2412
+ fireLayoutChange(
2177
2413
  /**
2178
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2179
- * used by this class
2414
+ * Parameters to pass along with the event
2180
2415
  */
2181
- FNMetaImpl?: Function
2182
- ): Function;
2416
+ mParameters?: {
2417
+ /**
2418
+ * the current breakpoint.
2419
+ */
2420
+ currentBreakpoint?: string;
2421
+ /**
2422
+ * the breakpoint that was active before change to current breakpoint.
2423
+ */
2424
+ previousBreakpoint?: string;
2425
+ /**
2426
+ * visibility of the main content.
2427
+ */
2428
+ mainContentVisible?: boolean;
2429
+ /**
2430
+ * visibility of the side content.
2431
+ */
2432
+ sideContentVisible?: boolean;
2433
+ }
2434
+ ): this;
2183
2435
  /**
2184
- * Returns a metadata object for class sap.ui.webc.fiori.FilterItemOption.
2436
+ * Gets content of aggregation {@link #getContent content}.
2437
+ *
2438
+ * Defines the main content.
2185
2439
  */
2186
- static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
2440
+ getContent(): sap.ui.core.Control[];
2187
2441
  /**
2188
- * Gets current value of property {@link #getSelected selected}.
2442
+ * Gets current value of property {@link #getEqualSplit equalSplit}.
2189
2443
  *
2190
- * Defines whether the option is selected
2444
+ * Defines whether the component is in equal split mode. In this mode, the side and the main content take
2445
+ * 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
2446
+ * are switching visibility using the toggle method.
2191
2447
  *
2192
2448
  * Default value is `false`.
2193
2449
  */
2194
- getSelected(): boolean;
2450
+ getEqualSplit(): boolean;
2195
2451
  /**
2196
- * Gets current value of property {@link #getText text}.
2452
+ * Gets current value of property {@link #getHideMainContent hideMainContent}.
2197
2453
  *
2198
- * Defines the text of the component.
2454
+ * Defines the visibility of the main content.
2199
2455
  *
2200
- * Default value is `empty string`.
2456
+ * Default value is `false`.
2201
2457
  */
2202
- getText(): string;
2458
+ getHideMainContent(): boolean;
2203
2459
  /**
2204
- * Sets a new value for property {@link #getSelected selected}.
2205
- *
2206
- * Defines whether the option is selected
2460
+ * Gets current value of property {@link #getHideSideContent hideSideContent}.
2207
2461
  *
2208
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2462
+ * Defines the visibility of the side content.
2209
2463
  *
2210
2464
  * Default value is `false`.
2211
2465
  */
2212
- setSelected(
2213
- /**
2214
- * New value for property `selected`
2215
- */
2216
- bSelected?: boolean
2217
- ): this;
2466
+ getHideSideContent(): boolean;
2218
2467
  /**
2219
- * Sets a new value for property {@link #getText text}.
2468
+ * Gets content of aggregation {@link #getSideContent sideContent}.
2220
2469
  *
2221
- * Defines the text of the component.
2470
+ * Defines the side content.
2471
+ */
2472
+ getSideContent(): sap.ui.core.Control[];
2473
+ /**
2474
+ * Gets current value of property {@link #getSideContentFallDown sideContentFallDown}.
2222
2475
  *
2223
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2476
+ * Defines on which breakpoints the side content falls down below the main content.
2224
2477
  *
2225
- * Default value is `empty string`.
2478
+ *
2479
+ *
2480
+ * **The available values are:**
2481
+ *
2482
+ *
2483
+ * - `BelowXL`
2484
+ * - `BelowL`
2485
+ * - `BelowM`
2486
+ * - `OnMinimumWidth`
2487
+ *
2488
+ * Default value is `OnMinimumWidth`.
2226
2489
  */
2227
- setText(
2228
- /**
2229
- * New value for property `text`
2490
+ getSideContentFallDown(): sap.ui.webc.fiori.SideContentFallDown;
2491
+ /**
2492
+ * Gets current value of property {@link #getSideContentPosition sideContentPosition}.
2493
+ *
2494
+ * Defines whether the side content is positioned before the main content (left side in LTR mode), or after
2495
+ * the the main content (right side in LTR mode).
2496
+ *
2497
+ *
2498
+ *
2499
+ * **The available values are:**
2500
+ *
2501
+ *
2502
+ * - `Start`
2503
+ * - `End`
2504
+ *
2505
+ * Default value is `End`.
2506
+ */
2507
+ getSideContentPosition(): sap.ui.webc.fiori.SideContentPosition;
2508
+ /**
2509
+ * Gets current value of property {@link #getSideContentVisibility sideContentVisibility}.
2510
+ *
2511
+ * Defines on which breakpoints the side content is visible.
2512
+ *
2513
+ *
2514
+ *
2515
+ * **The available values are:**
2516
+ *
2517
+ *
2518
+ * - `AlwaysShow`
2519
+ * - `ShowAboveL`
2520
+ * - `ShowAboveM`
2521
+ * - `ShowAboveS`
2522
+ * - `NeverShow`
2523
+ *
2524
+ * Default value is `ShowAboveS`.
2525
+ */
2526
+ getSideContentVisibility(): sap.ui.webc.fiori.SideContentVisibility;
2527
+ /**
2528
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
2529
+ * its index if found or -1 otherwise.
2530
+ */
2531
+ indexOfContent(
2532
+ /**
2533
+ * The content whose index is looked for
2534
+ */
2535
+ oContent: sap.ui.core.Control
2536
+ ): int;
2537
+ /**
2538
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getSideContent sideContent}.
2539
+ * and returns its index if found or -1 otherwise.
2540
+ */
2541
+ indexOfSideContent(
2542
+ /**
2543
+ * The sideContent whose index is looked for
2544
+ */
2545
+ oSideContent: sap.ui.core.Control
2546
+ ): int;
2547
+ /**
2548
+ * Inserts a content into the aggregation {@link #getContent content}.
2549
+ */
2550
+ insertContent(
2551
+ /**
2552
+ * The content to insert; if empty, nothing is inserted
2553
+ */
2554
+ oContent: sap.ui.core.Control,
2555
+ /**
2556
+ * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
2557
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the content
2558
+ * is inserted at the last position
2559
+ */
2560
+ iIndex: int
2561
+ ): this;
2562
+ /**
2563
+ * Inserts a sideContent into the aggregation {@link #getSideContent sideContent}.
2564
+ */
2565
+ insertSideContent(
2566
+ /**
2567
+ * The sideContent to insert; if empty, nothing is inserted
2568
+ */
2569
+ oSideContent: sap.ui.core.Control,
2570
+ /**
2571
+ * The `0`-based index the sideContent should be inserted at; for a negative value of `iIndex`, the sideContent
2572
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the sideContent
2573
+ * is inserted at the last position
2574
+ */
2575
+ iIndex: int
2576
+ ): this;
2577
+ /**
2578
+ * Removes all the controls from the aggregation {@link #getContent content}.
2579
+ *
2580
+ * Additionally, it unregisters them from the hosting UIArea.
2581
+ */
2582
+ removeAllContent(): sap.ui.core.Control[];
2583
+ /**
2584
+ * Removes all the controls from the aggregation {@link #getSideContent sideContent}.
2585
+ *
2586
+ * Additionally, it unregisters them from the hosting UIArea.
2587
+ */
2588
+ removeAllSideContent(): sap.ui.core.Control[];
2589
+ /**
2590
+ * Removes a content from the aggregation {@link #getContent content}.
2591
+ */
2592
+ removeContent(
2593
+ /**
2594
+ * The content to remove or its index or id
2595
+ */
2596
+ vContent: int | string | sap.ui.core.Control
2597
+ ): sap.ui.core.Control;
2598
+ /**
2599
+ * Removes a sideContent from the aggregation {@link #getSideContent sideContent}.
2600
+ */
2601
+ removeSideContent(
2602
+ /**
2603
+ * The sideContent to remove or its index or id
2604
+ */
2605
+ vSideContent: int | string | sap.ui.core.Control
2606
+ ): sap.ui.core.Control;
2607
+ /**
2608
+ * Sets a new value for property {@link #getEqualSplit equalSplit}.
2609
+ *
2610
+ * Defines whether the component is in equal split mode. In this mode, the side and the main content take
2611
+ * 50:50 percent of the container on all screen sizes except for phone, where the main and side contents
2612
+ * are switching visibility using the toggle method.
2613
+ *
2614
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2615
+ *
2616
+ * Default value is `false`.
2617
+ */
2618
+ setEqualSplit(
2619
+ /**
2620
+ * New value for property `equalSplit`
2621
+ */
2622
+ bEqualSplit?: boolean
2623
+ ): this;
2624
+ /**
2625
+ * Sets a new value for property {@link #getHideMainContent hideMainContent}.
2626
+ *
2627
+ * Defines the visibility of the main content.
2628
+ *
2629
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2630
+ *
2631
+ * Default value is `false`.
2632
+ */
2633
+ setHideMainContent(
2634
+ /**
2635
+ * New value for property `hideMainContent`
2636
+ */
2637
+ bHideMainContent?: boolean
2638
+ ): this;
2639
+ /**
2640
+ * Sets a new value for property {@link #getHideSideContent hideSideContent}.
2641
+ *
2642
+ * Defines the visibility of the side content.
2643
+ *
2644
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2645
+ *
2646
+ * Default value is `false`.
2647
+ */
2648
+ setHideSideContent(
2649
+ /**
2650
+ * New value for property `hideSideContent`
2651
+ */
2652
+ bHideSideContent?: boolean
2653
+ ): this;
2654
+ /**
2655
+ * Sets a new value for property {@link #getSideContentFallDown sideContentFallDown}.
2656
+ *
2657
+ * Defines on which breakpoints the side content falls down below the main content.
2658
+ *
2659
+ *
2660
+ *
2661
+ * **The available values are:**
2662
+ *
2663
+ *
2664
+ * - `BelowXL`
2665
+ * - `BelowL`
2666
+ * - `BelowM`
2667
+ * - `OnMinimumWidth`
2668
+ *
2669
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2670
+ *
2671
+ * Default value is `OnMinimumWidth`.
2672
+ */
2673
+ setSideContentFallDown(
2674
+ /**
2675
+ * New value for property `sideContentFallDown`
2676
+ */
2677
+ sSideContentFallDown?: sap.ui.webc.fiori.SideContentFallDown
2678
+ ): this;
2679
+ /**
2680
+ * Sets a new value for property {@link #getSideContentPosition sideContentPosition}.
2681
+ *
2682
+ * Defines whether the side content is positioned before the main content (left side in LTR mode), or after
2683
+ * the the main content (right side in LTR mode).
2684
+ *
2685
+ *
2686
+ *
2687
+ * **The available values are:**
2688
+ *
2689
+ *
2690
+ * - `Start`
2691
+ * - `End`
2692
+ *
2693
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2694
+ *
2695
+ * Default value is `End`.
2696
+ */
2697
+ setSideContentPosition(
2698
+ /**
2699
+ * New value for property `sideContentPosition`
2700
+ */
2701
+ sSideContentPosition?: sap.ui.webc.fiori.SideContentPosition
2702
+ ): this;
2703
+ /**
2704
+ * Sets a new value for property {@link #getSideContentVisibility sideContentVisibility}.
2705
+ *
2706
+ * Defines on which breakpoints the side content is visible.
2707
+ *
2708
+ *
2709
+ *
2710
+ * **The available values are:**
2711
+ *
2712
+ *
2713
+ * - `AlwaysShow`
2714
+ * - `ShowAboveL`
2715
+ * - `ShowAboveM`
2716
+ * - `ShowAboveS`
2717
+ * - `NeverShow`
2718
+ *
2719
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2720
+ *
2721
+ * Default value is `ShowAboveS`.
2722
+ */
2723
+ setSideContentVisibility(
2724
+ /**
2725
+ * New value for property `sideContentVisibility`
2726
+ */
2727
+ sSideContentVisibility?: sap.ui.webc.fiori.SideContentVisibility
2728
+ ): this;
2729
+ /**
2730
+ * Toggles visibility of main and side contents on S screen size (mobile device).
2731
+ */
2732
+ toggleContents(): void;
2733
+ }
2734
+ /**
2735
+ * @SINCE 1.97.0
2736
+ * @EXPERIMENTAL (since 1.97.0)
2737
+ *
2738
+ * Overview:
2739
+ *
2740
+ * Usage:
2741
+ */
2742
+ class FilterItem
2743
+ extends sap.ui.webc.common.WebComponent
2744
+ implements sap.ui.webc.fiori.IFilterItem {
2745
+ __implements__sap_ui_webc_fiori_IFilterItem: boolean;
2746
+ /**
2747
+ * Constructor for a new `FilterItem`.
2748
+ *
2749
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2750
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2751
+ * of the syntax of the settings object.
2752
+ */
2753
+ constructor(
2754
+ /**
2755
+ * Initial settings for the new control
2756
+ */
2757
+ mSettings?: sap.ui.webc.fiori.$FilterItemSettings
2758
+ );
2759
+ /**
2760
+ * Constructor for a new `FilterItem`.
2761
+ *
2762
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2763
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2764
+ * of the syntax of the settings object.
2765
+ */
2766
+ constructor(
2767
+ /**
2768
+ * ID for the new control, generated automatically if no ID is given
2769
+ */
2770
+ sId?: string,
2771
+ /**
2772
+ * Initial settings for the new control
2773
+ */
2774
+ mSettings?: sap.ui.webc.fiori.$FilterItemSettings
2775
+ );
2776
+
2777
+ /**
2778
+ * Creates a new subclass of class sap.ui.webc.fiori.FilterItem with name `sClassName` and enriches it with
2779
+ * the information contained in `oClassInfo`.
2780
+ *
2781
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
2782
+ */
2783
+ static extend<T extends Record<string, unknown>>(
2784
+ /**
2785
+ * Name of the class being created
2786
+ */
2787
+ sClassName: string,
2788
+ /**
2789
+ * Object literal with information about the class
2790
+ */
2791
+ oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItem>,
2792
+ /**
2793
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2794
+ * used by this class
2795
+ */
2796
+ FNMetaImpl?: Function
2797
+ ): Function;
2798
+ /**
2799
+ * Returns a metadata object for class sap.ui.webc.fiori.FilterItem.
2800
+ */
2801
+ static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
2802
+ /**
2803
+ * Adds some value to the aggregation {@link #getValues values}.
2804
+ */
2805
+ addValue(
2806
+ /**
2807
+ * The value to add; if empty, nothing is inserted
2808
+ */
2809
+ oValue: sap.ui.webc.fiori.IFilterItemOption
2810
+ ): this;
2811
+ /**
2812
+ * Destroys all the values in the aggregation {@link #getValues values}.
2813
+ */
2814
+ destroyValues(): this;
2815
+ /**
2816
+ * Gets current value of property {@link #getText text}.
2817
+ *
2818
+ * Defines the text of the component.
2819
+ *
2820
+ * Default value is `empty string`.
2821
+ */
2822
+ getText(): string;
2823
+ /**
2824
+ * Gets content of aggregation {@link #getValues values}.
2825
+ *
2826
+ * Defines the `values` list.
2827
+ */
2828
+ getValues(): sap.ui.webc.fiori.IFilterItemOption[];
2829
+ /**
2830
+ * Checks for the provided `sap.ui.webc.fiori.IFilterItemOption` in the aggregation {@link #getValues values}.
2831
+ * and returns its index if found or -1 otherwise.
2832
+ */
2833
+ indexOfValue(
2834
+ /**
2835
+ * The value whose index is looked for
2836
+ */
2837
+ oValue: sap.ui.webc.fiori.IFilterItemOption
2838
+ ): int;
2839
+ /**
2840
+ * Inserts a value into the aggregation {@link #getValues values}.
2841
+ */
2842
+ insertValue(
2843
+ /**
2844
+ * The value to insert; if empty, nothing is inserted
2845
+ */
2846
+ oValue: sap.ui.webc.fiori.IFilterItemOption,
2847
+ /**
2848
+ * The `0`-based index the value should be inserted at; for a negative value of `iIndex`, the value is inserted
2849
+ * at position 0; for a value greater than the current size of the aggregation, the value is inserted at
2850
+ * the last position
2851
+ */
2852
+ iIndex: int
2853
+ ): this;
2854
+ /**
2855
+ * Removes all the controls from the aggregation {@link #getValues values}.
2856
+ *
2857
+ * Additionally, it unregisters them from the hosting UIArea.
2858
+ */
2859
+ removeAllValues(): sap.ui.webc.fiori.IFilterItemOption[];
2860
+ /**
2861
+ * Removes a value from the aggregation {@link #getValues values}.
2862
+ */
2863
+ removeValue(
2864
+ /**
2865
+ * The value to remove or its index or id
2866
+ */
2867
+ vValue: int | string | sap.ui.webc.fiori.IFilterItemOption
2868
+ ): sap.ui.webc.fiori.IFilterItemOption;
2869
+ /**
2870
+ * Sets a new value for property {@link #getText text}.
2871
+ *
2872
+ * Defines the text of the component.
2873
+ *
2874
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2875
+ *
2876
+ * Default value is `empty string`.
2877
+ */
2878
+ setText(
2879
+ /**
2880
+ * New value for property `text`
2881
+ */
2882
+ sText?: string
2883
+ ): this;
2884
+ }
2885
+ /**
2886
+ * @SINCE 1.97.0
2887
+ * @EXPERIMENTAL (since 1.97.0)
2888
+ *
2889
+ * Overview:
2890
+ *
2891
+ * Usage:
2892
+ */
2893
+ class FilterItemOption
2894
+ extends sap.ui.webc.common.WebComponent
2895
+ implements sap.ui.webc.fiori.IFilterItemOption {
2896
+ __implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
2897
+ /**
2898
+ * Constructor for a new `FilterItemOption`.
2899
+ *
2900
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2901
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2902
+ * of the syntax of the settings object.
2903
+ */
2904
+ constructor(
2905
+ /**
2906
+ * Initial settings for the new control
2907
+ */
2908
+ mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
2909
+ );
2910
+ /**
2911
+ * Constructor for a new `FilterItemOption`.
2912
+ *
2913
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2914
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2915
+ * of the syntax of the settings object.
2916
+ */
2917
+ constructor(
2918
+ /**
2919
+ * ID for the new control, generated automatically if no ID is given
2920
+ */
2921
+ sId?: string,
2922
+ /**
2923
+ * Initial settings for the new control
2924
+ */
2925
+ mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
2926
+ );
2927
+
2928
+ /**
2929
+ * Creates a new subclass of class sap.ui.webc.fiori.FilterItemOption with name `sClassName` and enriches
2930
+ * it with the information contained in `oClassInfo`.
2931
+ *
2932
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
2933
+ */
2934
+ static extend<T extends Record<string, unknown>>(
2935
+ /**
2936
+ * Name of the class being created
2937
+ */
2938
+ sClassName: string,
2939
+ /**
2940
+ * Object literal with information about the class
2941
+ */
2942
+ oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItemOption>,
2943
+ /**
2944
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2945
+ * used by this class
2946
+ */
2947
+ FNMetaImpl?: Function
2948
+ ): Function;
2949
+ /**
2950
+ * Returns a metadata object for class sap.ui.webc.fiori.FilterItemOption.
2951
+ */
2952
+ static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
2953
+ /**
2954
+ * Gets current value of property {@link #getSelected selected}.
2955
+ *
2956
+ * Defines whether the option is selected
2957
+ *
2958
+ * Default value is `false`.
2959
+ */
2960
+ getSelected(): boolean;
2961
+ /**
2962
+ * Gets current value of property {@link #getText text}.
2963
+ *
2964
+ * Defines the text of the component.
2965
+ *
2966
+ * Default value is `empty string`.
2967
+ */
2968
+ getText(): string;
2969
+ /**
2970
+ * Sets a new value for property {@link #getSelected selected}.
2971
+ *
2972
+ * Defines whether the option is selected
2973
+ *
2974
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2975
+ *
2976
+ * Default value is `false`.
2977
+ */
2978
+ setSelected(
2979
+ /**
2980
+ * New value for property `selected`
2981
+ */
2982
+ bSelected?: boolean
2983
+ ): this;
2984
+ /**
2985
+ * Sets a new value for property {@link #getText text}.
2986
+ *
2987
+ * Defines the text of the component.
2988
+ *
2989
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2990
+ *
2991
+ * Default value is `empty string`.
2992
+ */
2993
+ setText(
2994
+ /**
2995
+ * New value for property `text`
2996
+ */
2997
+ sText?: string
2998
+ ): this;
2999
+ }
3000
+ /**
3001
+ * @SINCE 1.92.0
3002
+ * @EXPERIMENTAL (since 1.92.0)
3003
+ *
3004
+ * Overview:
3005
+ *
3006
+ * The `FlexibleColumnLayout` implements the master-detail-detail paradigm by displaying up to three pages
3007
+ * in separate columns. There are several possible layouts that can be changed either with the component
3008
+ * API, or by pressing the arrows, displayed between the columns.
3009
+ *
3010
+ * Usage:
3011
+ *
3012
+ * Use this component for applications that need to display several logical levels of related information
3013
+ * side by side (e.g. list of items, item, sub-item, etc.). The Component is flexible in a sense that the
3014
+ * application can focus the user's attention on one particular column.
3015
+ *
3016
+ * Responsive Behavior:
3017
+ *
3018
+ * The `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout`
3019
+ * property and the window size. The component would display 1 column for window size smaller than 599px,
3020
+ * up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
3021
+ *
3022
+ *
3023
+ *
3024
+ * Keyboard Handling:
3025
+ */
3026
+ class FlexibleColumnLayout extends sap.ui.webc.common.WebComponent {
3027
+ /**
3028
+ * Constructor for a new `FlexibleColumnLayout`.
3029
+ *
3030
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3031
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3032
+ * of the syntax of the settings object.
3033
+ */
3034
+ constructor(
3035
+ /**
3036
+ * Initial settings for the new control
3037
+ */
3038
+ mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
3039
+ );
3040
+ /**
3041
+ * Constructor for a new `FlexibleColumnLayout`.
3042
+ *
3043
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3044
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3045
+ * of the syntax of the settings object.
3046
+ */
3047
+ constructor(
3048
+ /**
3049
+ * ID for the new control, generated automatically if no ID is given
3050
+ */
3051
+ sId?: string,
3052
+ /**
3053
+ * Initial settings for the new control
3054
+ */
3055
+ mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
3056
+ );
3057
+
3058
+ /**
3059
+ * Creates a new subclass of class sap.ui.webc.fiori.FlexibleColumnLayout with name `sClassName` and enriches
3060
+ * it with the information contained in `oClassInfo`.
3061
+ *
3062
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
3063
+ */
3064
+ static extend<T extends Record<string, unknown>>(
3065
+ /**
3066
+ * Name of the class being created
3067
+ */
3068
+ sClassName: string,
3069
+ /**
3070
+ * Object literal with information about the class
3071
+ */
3072
+ oClassInfo?: sap.ClassInfo<
3073
+ T,
3074
+ sap.ui.webc.fiori.FlexibleColumnLayout
3075
+ >,
3076
+ /**
3077
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3078
+ * used by this class
3079
+ */
3080
+ FNMetaImpl?: Function
3081
+ ): Function;
3082
+ /**
3083
+ * Returns a metadata object for class sap.ui.webc.fiori.FlexibleColumnLayout.
3084
+ */
3085
+ static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
3086
+ /**
3087
+ * Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
3088
+ *
3089
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3090
+ * otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
3091
+ *
3092
+ * Fired when the layout changes via user interaction by clicking the arrows or by changing the component
3093
+ * size due to resizing.
3094
+ */
3095
+ attachLayoutChange(
3096
+ /**
3097
+ * An application-specific payload object that will be passed to the event handler along with the event
3098
+ * object when firing the event
3099
+ */
3100
+ oData: object,
3101
+ /**
3102
+ * The function to be called when the event occurs
3103
+ */
3104
+ fnFunction: (p1: sap.ui.base.Event) => void,
3105
+ /**
3106
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
3107
+ * itself
3108
+ */
3109
+ oListener?: object
3110
+ ): this;
3111
+ /**
3112
+ * Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
3113
+ *
3114
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3115
+ * otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
3116
+ *
3117
+ * Fired when the layout changes via user interaction by clicking the arrows or by changing the component
3118
+ * size due to resizing.
3119
+ */
3120
+ attachLayoutChange(
3121
+ /**
3122
+ * The function to be called when the event occurs
3123
+ */
3124
+ fnFunction: (p1: sap.ui.base.Event) => void,
3125
+ /**
3126
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
3127
+ * itself
3128
+ */
3129
+ oListener?: object
3130
+ ): this;
3131
+ /**
3132
+ * Destroys the endColumn in the aggregation {@link #getEndColumn endColumn}.
3133
+ */
3134
+ destroyEndColumn(): this;
3135
+ /**
3136
+ * Destroys the midColumn in the aggregation {@link #getMidColumn midColumn}.
3137
+ */
3138
+ destroyMidColumn(): this;
3139
+ /**
3140
+ * Destroys the startColumn in the aggregation {@link #getStartColumn startColumn}.
3141
+ */
3142
+ destroyStartColumn(): this;
3143
+ /**
3144
+ * Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
3145
+ *
3146
+ * The passed function and listener object must match the ones used for event registration.
3147
+ */
3148
+ detachLayoutChange(
3149
+ /**
3150
+ * The function to be called, when the event occurs
3151
+ */
3152
+ fnFunction: (p1: sap.ui.base.Event) => void,
3153
+ /**
3154
+ * Context object on which the given function had to be called
3155
+ */
3156
+ oListener?: object
3157
+ ): this;
3158
+ /**
3159
+ * Fires event {@link #event:layoutChange layoutChange} to attached listeners.
3160
+ */
3161
+ fireLayoutChange(
3162
+ /**
3163
+ * Parameters to pass along with the event
3164
+ */
3165
+ mParameters?: {
3166
+ /**
3167
+ * The current layout
3168
+ */
3169
+ layout?: FCLLayout;
3170
+ /**
3171
+ * The effective column layout, f.e [67%, 33%, 0]
3172
+ */
3173
+ columnLayout?: any[];
3174
+ /**
3175
+ * Indicates if the start column is currently visible
3176
+ */
3177
+ startColumnVisible?: boolean;
3178
+ /**
3179
+ * Indicates if the middle column is currently visible
3180
+ */
3181
+ midColumnVisible?: boolean;
3182
+ /**
3183
+ * Indicates if the end column is currently visible
3184
+ */
3185
+ endColumnVisible?: boolean;
3186
+ /**
3187
+ * Indicates if the layout is changed via the arrows
3188
+ */
3189
+ arrowsUsed?: boolean;
3190
+ /**
3191
+ * Indicates if the layout is changed via resizing
3192
+ */
3193
+ resize?: boolean;
3194
+ }
3195
+ ): this;
3196
+ /**
3197
+ * Gets current value of property {@link #getAccessibilityRoles accessibilityRoles}.
3198
+ *
3199
+ * An object of strings that defines additional accessibility roles for further customization.
3200
+ *
3201
+ * It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
3202
+ * `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
3203
+ * and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
3204
+ * the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
3205
+ * the accessibility role for the `endColumn`
3206
+ *
3207
+ * Default value is `{}`.
3208
+ */
3209
+ getAccessibilityRoles(): object;
3210
+ /**
3211
+ * Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
3212
+ *
3213
+ * An object of strings that defines several additional accessibility texts for even further customization.
3214
+ *
3215
+ * It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
3216
+ * region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
3217
+ * the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
3218
+ * (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
3219
+ * the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
3220
+ * right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
3221
+ * have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
3222
+ * and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
3223
+ * that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
3224
+ * the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
3225
+ *
3226
+ * Default value is `{}`.
3227
+ */
3228
+ getAccessibilityTexts(): object;
3229
+ /**
3230
+ * Returns the current column layout, based on both the `layout` property and the screen size.
3231
+ *
3232
+ * **For example:** ["67%", "33%", 0], ["100%", 0, 0], ["25%", "50%", "25%"], etc, where the numbers represents
3233
+ * the width of the start, middle and end columns.
3234
+ */
3235
+ getColumnLayout(): void;
3236
+ /**
3237
+ * Gets content of aggregation {@link #getEndColumn endColumn}.
3238
+ *
3239
+ * Defines the content in the end column.
3240
+ */
3241
+ getEndColumn(): sap.ui.core.Control;
3242
+ /**
3243
+ * Returns if the `end` column is visible.
3244
+ */
3245
+ getEndColumnVisible(): void;
3246
+ /**
3247
+ * Gets current value of property {@link #getHeight height}.
3248
+ *
3249
+ * Defines the height of the control
3250
+ */
3251
+ getHeight(): sap.ui.core.CSSSize;
3252
+ /**
3253
+ * Gets current value of property {@link #getHideArrows hideArrows}.
3254
+ *
3255
+ * Defines the visibility of the arrows, used for expanding and shrinking the columns.
3256
+ *
3257
+ * Default value is `false`.
3258
+ */
3259
+ getHideArrows(): boolean;
3260
+ /**
3261
+ * Gets current value of property {@link #getLayout layout}.
3262
+ *
3263
+ * Defines the columns layout and their proportion.
3264
+ *
3265
+ * **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
3266
+ * columns between 599px and 1023px and three columns for sizes bigger than 1023px.
3267
+ *
3268
+ * Available options are:
3269
+ * - `OneColumn`
3270
+ * - `TwoColumnsStartExpanded`
3271
+ * - `TwoColumnsMidExpanded`
3272
+ * - `ThreeColumnsMidExpanded`
3273
+ * - `ThreeColumnsEndExpanded`
3274
+ * - `ThreeColumnsStartExpandedEndHidden`
3275
+ * - `ThreeColumnsMidExpandedEndHidden`
3276
+ * - `MidColumnFullScreen`
3277
+ * - `EndColumnFullScreen`
3278
+ *
3279
+ * **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
3280
+ * 67%/33% proportion.
3281
+ *
3282
+ * Default value is `OneColumn`.
3283
+ */
3284
+ getLayout(): sap.ui.webc.fiori.FCLLayout;
3285
+ /**
3286
+ * Gets content of aggregation {@link #getMidColumn midColumn}.
3287
+ *
3288
+ * Defines the content in the middle column.
3289
+ */
3290
+ getMidColumn(): sap.ui.core.Control;
3291
+ /**
3292
+ * Returns if the `middle` column is visible.
3293
+ */
3294
+ getMidColumnVisible(): void;
3295
+ /**
3296
+ * Gets content of aggregation {@link #getStartColumn startColumn}.
3297
+ *
3298
+ * Defines the content in the start column.
3299
+ */
3300
+ getStartColumn(): sap.ui.core.Control;
3301
+ /**
3302
+ * Returns if the `start` column is visible.
3303
+ */
3304
+ getStartColumnVisible(): void;
3305
+ /**
3306
+ * Returns the number of currently visible columns.
3307
+ */
3308
+ getVisibleColumns(): void;
3309
+ /**
3310
+ * Gets current value of property {@link #getWidth width}.
3311
+ *
3312
+ * Defines the width of the control
3313
+ */
3314
+ getWidth(): sap.ui.core.CSSSize;
3315
+ /**
3316
+ * Sets a new value for property {@link #getAccessibilityRoles accessibilityRoles}.
3317
+ *
3318
+ * An object of strings that defines additional accessibility roles for further customization.
3319
+ *
3320
+ * It supports the following fields: - `startColumnRole`: the accessibility role for the `startColumn` -
3321
+ * `startArrowContainerRole`: the accessibility role for the first arrow container (between the `begin`
3322
+ * and `mid` columns) - `midColumnRole`: the accessibility role for the `midColumn` - `endArrowContainerRole`:
3323
+ * the accessibility role for the second arrow container (between the `mid` and `end` columns) - `endColumnRole`:
3324
+ * the accessibility role for the `endColumn`
3325
+ *
3326
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3327
+ *
3328
+ * Default value is `{}`.
3329
+ */
3330
+ setAccessibilityRoles(
3331
+ /**
3332
+ * New value for property `accessibilityRoles`
3333
+ */
3334
+ oAccessibilityRoles?: object
3335
+ ): this;
3336
+ /**
3337
+ * Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
3338
+ *
3339
+ * An object of strings that defines several additional accessibility texts for even further customization.
3340
+ *
3341
+ * It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
3342
+ * region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
3343
+ * the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
3344
+ * (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
3345
+ * the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
3346
+ * right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
3347
+ * have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
3348
+ * and `end` columns) will have when pointing to the right - `startArrowContainerAccessibleName`: the text
3349
+ * that the first arrow container (between the `begin` and `mid` columns) will have as `aria-label` - `endArrowContainerAccessibleName`:
3350
+ * the text that the second arrow container (between the `mid` and `end` columns) will have as `aria-label`
3351
+ *
3352
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3353
+ *
3354
+ * Default value is `{}`.
3355
+ */
3356
+ setAccessibilityTexts(
3357
+ /**
3358
+ * New value for property `accessibilityTexts`
3359
+ */
3360
+ oAccessibilityTexts?: object
3361
+ ): this;
3362
+ /**
3363
+ * Sets the aggregated {@link #getEndColumn endColumn}.
3364
+ */
3365
+ setEndColumn(
3366
+ /**
3367
+ * The endColumn to set
3368
+ */
3369
+ oEndColumn: sap.ui.core.Control
3370
+ ): this;
3371
+ /**
3372
+ * Sets a new value for property {@link #getHeight height}.
3373
+ *
3374
+ * Defines the height of the control
3375
+ *
3376
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3377
+ */
3378
+ setHeight(
3379
+ /**
3380
+ * New value for property `height`
3381
+ */
3382
+ sHeight?: sap.ui.core.CSSSize
3383
+ ): this;
3384
+ /**
3385
+ * Sets a new value for property {@link #getHideArrows hideArrows}.
3386
+ *
3387
+ * Defines the visibility of the arrows, used for expanding and shrinking the columns.
3388
+ *
3389
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3390
+ *
3391
+ * Default value is `false`.
3392
+ */
3393
+ setHideArrows(
3394
+ /**
3395
+ * New value for property `hideArrows`
3396
+ */
3397
+ bHideArrows?: boolean
3398
+ ): this;
3399
+ /**
3400
+ * Sets a new value for property {@link #getLayout layout}.
3401
+ *
3402
+ * Defines the columns layout and their proportion.
3403
+ *
3404
+ * **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
3405
+ * columns between 599px and 1023px and three columns for sizes bigger than 1023px.
3406
+ *
3407
+ * Available options are:
3408
+ * - `OneColumn`
3409
+ * - `TwoColumnsStartExpanded`
3410
+ * - `TwoColumnsMidExpanded`
3411
+ * - `ThreeColumnsMidExpanded`
3412
+ * - `ThreeColumnsEndExpanded`
3413
+ * - `ThreeColumnsStartExpandedEndHidden`
3414
+ * - `ThreeColumnsMidExpandedEndHidden`
3415
+ * - `MidColumnFullScreen`
3416
+ * - `EndColumnFullScreen`
3417
+ *
3418
+ * **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
3419
+ * 67%/33% proportion.
3420
+ *
3421
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3422
+ *
3423
+ * Default value is `OneColumn`.
3424
+ */
3425
+ setLayout(
3426
+ /**
3427
+ * New value for property `layout`
3428
+ */
3429
+ sLayout?: sap.ui.webc.fiori.FCLLayout
3430
+ ): this;
3431
+ /**
3432
+ * Sets the aggregated {@link #getMidColumn midColumn}.
3433
+ */
3434
+ setMidColumn(
3435
+ /**
3436
+ * The midColumn to set
3437
+ */
3438
+ oMidColumn: sap.ui.core.Control
3439
+ ): this;
3440
+ /**
3441
+ * Sets the aggregated {@link #getStartColumn startColumn}.
3442
+ */
3443
+ setStartColumn(
3444
+ /**
3445
+ * The startColumn to set
2230
3446
  */
2231
- sText?: string
3447
+ oStartColumn: sap.ui.core.Control
3448
+ ): this;
3449
+ /**
3450
+ * Sets a new value for property {@link #getWidth width}.
3451
+ *
3452
+ * Defines the width of the control
3453
+ *
3454
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3455
+ */
3456
+ setWidth(
3457
+ /**
3458
+ * New value for property `width`
3459
+ */
3460
+ sWidth?: sap.ui.core.CSSSize
2232
3461
  ): this;
2233
3462
  }
2234
3463
  /**
2235
- * @SINCE 1.92.0
2236
- * @EXPERIMENTAL (since 1.92.0)
3464
+ * @SINCE 1.95.0
3465
+ * @EXPERIMENTAL (since 1.95.0)
2237
3466
  *
2238
- * Overview:
3467
+ * Overview: An IllustratedMessage is a recommended combination of a solution-oriented message, an engaging
3468
+ * illustration, and conversational tone to better communicate an empty or a success state than just show
3469
+ * a message alone.
2239
3470
  *
2240
- * The `FlexibleColumnLayout` implements the master-detail-detail paradigm by displaying up to three pages
2241
- * in separate columns. There are several possible layouts that can be changed either with the component
2242
- * API, or by pressing the arrows, displayed between the columns.
3471
+ * Each illustration has default internationalised title and subtitle texts. Also they can be managed with
3472
+ * `titleText` and `subtitleText` properties.
2243
3473
  *
2244
- * Usage:
3474
+ * Structure: The IllustratedMessage consists of the following elements, which are displayed below each
3475
+ * other in the following order:
2245
3476
  *
2246
- * Use this component for applications that need to display several logical levels of related information
2247
- * side by side (e.g. list of items, item, sub-item, etc.). The Component is flexible in a sense that the
2248
- * application can focus the user's attention on one particular column.
2249
3477
  *
2250
- * Responsive Behavior:
2251
3478
  *
2252
- * The `FlexibleColumnLayout` automatically displays the maximum possible number of columns based on `layout`
2253
- * property and the window size. The component would display 1 column for window size smaller than 599px,
2254
- * up to two columns between 599px and 1023px, and 3 columns for sizes bigger than 1023px.
3479
+ * - Illustration
3480
+ * - Title
3481
+ * - Subtitle
3482
+ * - Actions
3483
+ *
3484
+ * Usage: `sap.ui.webc.fiori.IllustratedMessage` is meant to be used inside container component, for example
3485
+ * a `sap.ui.webc.main.Card`, a `sap.ui.webc.main.Dialog` or a `sap.ui.webc.fiori.Page`
3486
+ */
3487
+ class IllustratedMessage extends sap.ui.webc.common.WebComponent {
3488
+ /**
3489
+ * Constructor for a new `IllustratedMessage`.
3490
+ *
3491
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3492
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3493
+ * of the syntax of the settings object.
3494
+ */
3495
+ constructor(
3496
+ /**
3497
+ * Initial settings for the new control
3498
+ */
3499
+ mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
3500
+ );
3501
+ /**
3502
+ * Constructor for a new `IllustratedMessage`.
3503
+ *
3504
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3505
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3506
+ * of the syntax of the settings object.
3507
+ */
3508
+ constructor(
3509
+ /**
3510
+ * ID for the new control, generated automatically if no ID is given
3511
+ */
3512
+ sId?: string,
3513
+ /**
3514
+ * Initial settings for the new control
3515
+ */
3516
+ mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
3517
+ );
3518
+
3519
+ /**
3520
+ * Creates a new subclass of class sap.ui.webc.fiori.IllustratedMessage with name `sClassName` and enriches
3521
+ * it with the information contained in `oClassInfo`.
3522
+ *
3523
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
3524
+ */
3525
+ static extend<T extends Record<string, unknown>>(
3526
+ /**
3527
+ * Name of the class being created
3528
+ */
3529
+ sClassName: string,
3530
+ /**
3531
+ * Object literal with information about the class
3532
+ */
3533
+ oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.IllustratedMessage>,
3534
+ /**
3535
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3536
+ * used by this class
3537
+ */
3538
+ FNMetaImpl?: Function
3539
+ ): Function;
3540
+ /**
3541
+ * Returns a metadata object for class sap.ui.webc.fiori.IllustratedMessage.
3542
+ */
3543
+ static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
3544
+ /**
3545
+ * Adds some action to the aggregation {@link #getActions actions}.
3546
+ */
3547
+ addAction(
3548
+ /**
3549
+ * The action to add; if empty, nothing is inserted
3550
+ */
3551
+ oAction: sap.ui.webc.main.IButton
3552
+ ): this;
3553
+ /**
3554
+ * Destroys all the actions in the aggregation {@link #getActions actions}.
3555
+ */
3556
+ destroyActions(): this;
3557
+ /**
3558
+ * Destroys the subtitle in the aggregation {@link #getSubtitle subtitle}.
3559
+ */
3560
+ destroySubtitle(): this;
3561
+ /**
3562
+ * Gets content of aggregation {@link #getActions actions}.
3563
+ *
3564
+ * Defines the component actions.
3565
+ */
3566
+ getActions(): sap.ui.webc.main.IButton[];
3567
+ /**
3568
+ * Gets current value of property {@link #getName name}.
3569
+ *
3570
+ * Default value is `BeforeSearch`.
3571
+ */
3572
+ getName(): sap.ui.webc.fiori.IllustrationMessageType;
3573
+ /**
3574
+ * Gets content of aggregation {@link #getSubtitle subtitle}.
3575
+ *
3576
+ * Defines the subtitle of the component.
3577
+ *
3578
+ * **Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText`
3579
+ * property will be overwritten.
3580
+ */
3581
+ getSubtitle(): sap.ui.core.Control;
3582
+ /**
3583
+ * Gets current value of property {@link #getSubtitleText subtitleText}.
3584
+ *
3585
+ * Defines the subtitle of the component.
3586
+ *
3587
+ * **Note:** Using this property, the default subtitle text of illustration will be overwritten.
3588
+ *
3589
+ * **Note:** Using `subtitle` slot, the default of this property will be overwritten.
3590
+ *
3591
+ * Default value is `empty string`.
3592
+ */
3593
+ getSubtitleText(): string;
3594
+ /**
3595
+ * Gets current value of property {@link #getTitleText titleText}.
3596
+ *
3597
+ * Defines the title of the component.
3598
+ *
3599
+ * **Note:** Using this property, the default title text of illustration will be overwritten.
3600
+ *
3601
+ * Default value is `empty string`.
3602
+ */
3603
+ getTitleText(): string;
3604
+ /**
3605
+ * Checks for the provided `sap.ui.webc.main.IButton` in the aggregation {@link #getActions actions}. and
3606
+ * returns its index if found or -1 otherwise.
3607
+ */
3608
+ indexOfAction(
3609
+ /**
3610
+ * The action whose index is looked for
3611
+ */
3612
+ oAction: sap.ui.webc.main.IButton
3613
+ ): int;
3614
+ /**
3615
+ * Inserts a action into the aggregation {@link #getActions actions}.
3616
+ */
3617
+ insertAction(
3618
+ /**
3619
+ * The action to insert; if empty, nothing is inserted
3620
+ */
3621
+ oAction: sap.ui.webc.main.IButton,
3622
+ /**
3623
+ * The `0`-based index the action should be inserted at; for a negative value of `iIndex`, the action is
3624
+ * inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
3625
+ * at the last position
3626
+ */
3627
+ iIndex: int
3628
+ ): this;
3629
+ /**
3630
+ * Removes a action from the aggregation {@link #getActions actions}.
3631
+ */
3632
+ removeAction(
3633
+ /**
3634
+ * The action to remove or its index or id
3635
+ */
3636
+ vAction: int | string | sap.ui.webc.main.IButton
3637
+ ): sap.ui.webc.main.IButton;
3638
+ /**
3639
+ * Removes all the controls from the aggregation {@link #getActions actions}.
3640
+ *
3641
+ * Additionally, it unregisters them from the hosting UIArea.
3642
+ */
3643
+ removeAllActions(): sap.ui.webc.main.IButton[];
3644
+ /**
3645
+ * Sets a new value for property {@link #getName name}.
3646
+ *
3647
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3648
+ *
3649
+ * Default value is `BeforeSearch`.
3650
+ */
3651
+ setName(
3652
+ /**
3653
+ * New value for property `name`
3654
+ */
3655
+ sName?: sap.ui.webc.fiori.IllustrationMessageType
3656
+ ): this;
3657
+ /**
3658
+ * Sets the aggregated {@link #getSubtitle subtitle}.
3659
+ */
3660
+ setSubtitle(
3661
+ /**
3662
+ * The subtitle to set
3663
+ */
3664
+ oSubtitle: sap.ui.core.Control
3665
+ ): this;
3666
+ /**
3667
+ * Sets a new value for property {@link #getSubtitleText subtitleText}.
3668
+ *
3669
+ * Defines the subtitle of the component.
3670
+ *
3671
+ * **Note:** Using this property, the default subtitle text of illustration will be overwritten.
3672
+ *
3673
+ * **Note:** Using `subtitle` slot, the default of this property will be overwritten.
3674
+ *
3675
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3676
+ *
3677
+ * Default value is `empty string`.
3678
+ */
3679
+ setSubtitleText(
3680
+ /**
3681
+ * New value for property `subtitleText`
3682
+ */
3683
+ sSubtitleText?: string
3684
+ ): this;
3685
+ /**
3686
+ * Sets a new value for property {@link #getTitleText titleText}.
3687
+ *
3688
+ * Defines the title of the component.
3689
+ *
3690
+ * **Note:** Using this property, the default title text of illustration will be overwritten.
3691
+ *
3692
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3693
+ *
3694
+ * Default value is `empty string`.
3695
+ */
3696
+ setTitleText(
3697
+ /**
3698
+ * New value for property `titleText`
3699
+ */
3700
+ sTitleText?: string
3701
+ ): this;
3702
+ }
3703
+ /**
3704
+ * @SINCE 1.99.0
3705
+ * @EXPERIMENTAL (since 1.99.0)
3706
+ *
3707
+ * Overview:
3708
+ *
3709
+ * The `ui-media-gallery` component allows the user to browse through multimedia items. Currently, the supported
3710
+ * items are images and videos. The items should be defined using the `sap.ui.webc.fiori.MediaGalleryItem`
3711
+ * component.
2255
3712
  *
3713
+ * The items are initially displayed as thumbnails. When the user selects a thumbnail, the corresponding
3714
+ * item is displayed in larger size.
3715
+ * The component is responsive by default and adjusts the position of the menu with respect to viewport
3716
+ * size, but the application is able to further customize the layout via the provided API.
2256
3717
  *
3718
+ * Keyboard Handling: The `sap.ui.webc.fiori.MediaGallery` provides advanced keyboard handling.
3719
+ * When the thumbnails menu is focused the following keyboard shortcuts allow the user to navigate through
3720
+ * the thumbnail items:
2257
3721
  *
2258
- * Keyboard Handling:
2259
3722
  *
2260
3723
  *
2261
- * - [SPACE, ENTER, RETURN] - If focus is on the layout toggle button (arrow button), once activated,
2262
- * it triggers the associated action (such as expand/collapse the column).
3724
+ * - [UP/DOWN] - Navigates up and down the items
3725
+ * - [HOME] - Navigates to first item
3726
+ * - [END] - Navigates to the last item [SPACE/ENTER] - Select an item
2263
3727
  */
2264
- class FlexibleColumnLayout extends sap.ui.webc.common.WebComponent {
3728
+ class MediaGallery extends sap.ui.webc.common.WebComponent {
2265
3729
  /**
2266
- * Constructor for a new `FlexibleColumnLayout`.
3730
+ * Constructor for a new `MediaGallery`.
2267
3731
  *
2268
3732
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2269
3733
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -2273,10 +3737,10 @@ declare namespace sap {
2273
3737
  /**
2274
3738
  * Initial settings for the new control
2275
3739
  */
2276
- mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
3740
+ mSettings?: sap.ui.webc.fiori.$MediaGallerySettings
2277
3741
  );
2278
3742
  /**
2279
- * Constructor for a new `FlexibleColumnLayout`.
3743
+ * Constructor for a new `MediaGallery`.
2280
3744
  *
2281
3745
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2282
3746
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -2290,12 +3754,12 @@ declare namespace sap {
2290
3754
  /**
2291
3755
  * Initial settings for the new control
2292
3756
  */
2293
- mSettings?: sap.ui.webc.fiori.$FlexibleColumnLayoutSettings
3757
+ mSettings?: sap.ui.webc.fiori.$MediaGallerySettings
2294
3758
  );
2295
3759
 
2296
3760
  /**
2297
- * Creates a new subclass of class sap.ui.webc.fiori.FlexibleColumnLayout with name `sClassName` and enriches
2298
- * it with the information contained in `oClassInfo`.
3761
+ * Creates a new subclass of class sap.ui.webc.fiori.MediaGallery with name `sClassName` and enriches it
3762
+ * with the information contained in `oClassInfo`.
2299
3763
  *
2300
3764
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
2301
3765
  */
@@ -2307,10 +3771,7 @@ declare namespace sap {
2307
3771
  /**
2308
3772
  * Object literal with information about the class
2309
3773
  */
2310
- oClassInfo?: sap.ClassInfo<
2311
- T,
2312
- sap.ui.webc.fiori.FlexibleColumnLayout
2313
- >,
3774
+ oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.MediaGallery>,
2314
3775
  /**
2315
3776
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2316
3777
  * used by this class
@@ -2318,19 +3779,29 @@ declare namespace sap {
2318
3779
  FNMetaImpl?: Function
2319
3780
  ): Function;
2320
3781
  /**
2321
- * Returns a metadata object for class sap.ui.webc.fiori.FlexibleColumnLayout.
3782
+ * Returns a metadata object for class sap.ui.webc.fiori.MediaGallery.
2322
3783
  */
2323
3784
  static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
2324
3785
  /**
2325
- * Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
3786
+ * Adds some item to the aggregation {@link #getItems items}.
3787
+ */
3788
+ addItem(
3789
+ /**
3790
+ * The item to add; if empty, nothing is inserted
3791
+ */
3792
+ oItem: sap.ui.webc.fiori.IMediaGalleryItem
3793
+ ): this;
3794
+ /**
3795
+ * Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
3796
+ * this `sap.ui.webc.fiori.MediaGallery`.
2326
3797
  *
2327
3798
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2328
- * otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
3799
+ * otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
2329
3800
  *
2330
- * Fired when the layout changes via user interaction by clicking the arrows or by changing the component
2331
- * size due to resizing.
3801
+ * Fired when the display area is clicked.
3802
+ * The display area is the central area that contains the enlarged content of the currently selected item.
2332
3803
  */
2333
- attachLayoutChange(
3804
+ attachDisplayAreaClick(
2334
3805
  /**
2335
3806
  * An application-specific payload object that will be passed to the event handler along with the event
2336
3807
  * object when firing the event
@@ -2341,351 +3812,423 @@ declare namespace sap {
2341
3812
  */
2342
3813
  fnFunction: (p1: sap.ui.base.Event) => void,
2343
3814
  /**
2344
- * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
2345
- * itself
3815
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
2346
3816
  */
2347
3817
  oListener?: object
2348
3818
  ): this;
2349
3819
  /**
2350
- * Attaches event handler `fnFunction` to the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
3820
+ * Attaches event handler `fnFunction` to the {@link #event:displayAreaClick displayAreaClick} event of
3821
+ * this `sap.ui.webc.fiori.MediaGallery`.
2351
3822
  *
2352
3823
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2353
- * otherwise it will be bound to this `sap.ui.webc.fiori.FlexibleColumnLayout` itself.
3824
+ * otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
2354
3825
  *
2355
- * Fired when the layout changes via user interaction by clicking the arrows or by changing the component
2356
- * size due to resizing.
3826
+ * Fired when the display area is clicked.
3827
+ * The display area is the central area that contains the enlarged content of the currently selected item.
2357
3828
  */
2358
- attachLayoutChange(
3829
+ attachDisplayAreaClick(
2359
3830
  /**
2360
3831
  * The function to be called when the event occurs
2361
3832
  */
2362
3833
  fnFunction: (p1: sap.ui.base.Event) => void,
2363
3834
  /**
2364
- * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.FlexibleColumnLayout`
2365
- * itself
3835
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
2366
3836
  */
2367
3837
  oListener?: object
2368
3838
  ): this;
2369
3839
  /**
2370
- * Destroys the endColumn in the aggregation {@link #getEndColumn endColumn}.
2371
- */
2372
- destroyEndColumn(): this;
2373
- /**
2374
- * Destroys the midColumn in the aggregation {@link #getMidColumn midColumn}.
2375
- */
2376
- destroyMidColumn(): this;
2377
- /**
2378
- * Destroys the startColumn in the aggregation {@link #getStartColumn startColumn}.
2379
- */
2380
- destroyStartColumn(): this;
2381
- /**
2382
- * Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ui.webc.fiori.FlexibleColumnLayout`.
3840
+ * Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
2383
3841
  *
2384
- * The passed function and listener object must match the ones used for event registration.
3842
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3843
+ * otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
3844
+ *
3845
+ * Fired when the thumbnails overflow button is clicked.
2385
3846
  */
2386
- detachLayoutChange(
3847
+ attachOverflowClick(
2387
3848
  /**
2388
- * The function to be called, when the event occurs
3849
+ * An application-specific payload object that will be passed to the event handler along with the event
3850
+ * object when firing the event
3851
+ */
3852
+ oData: object,
3853
+ /**
3854
+ * The function to be called when the event occurs
2389
3855
  */
2390
3856
  fnFunction: (p1: sap.ui.base.Event) => void,
2391
3857
  /**
2392
- * Context object on which the given function had to be called
3858
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
2393
3859
  */
2394
3860
  oListener?: object
2395
3861
  ): this;
2396
3862
  /**
2397
- * Fires event {@link #event:layoutChange layoutChange} to attached listeners.
3863
+ * Attaches event handler `fnFunction` to the {@link #event:overflowClick overflowClick} event of this `sap.ui.webc.fiori.MediaGallery`.
3864
+ *
3865
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3866
+ * otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
3867
+ *
3868
+ * Fired when the thumbnails overflow button is clicked.
2398
3869
  */
2399
- fireLayoutChange(
3870
+ attachOverflowClick(
2400
3871
  /**
2401
- * Parameters to pass along with the event
3872
+ * The function to be called when the event occurs
2402
3873
  */
2403
- mParameters?: {
2404
- /**
2405
- * The current layout
2406
- */
2407
- layout?: FCLLayout;
2408
- /**
2409
- * The effective column layout, f.e [67%, 33%, 0]
2410
- */
2411
- columnLayout?: any[];
2412
- /**
2413
- * Indicates if the start column is currently visible
2414
- */
2415
- startColumnVisible?: boolean;
2416
- /**
2417
- * Indicates if the middle column is currently visible
2418
- */
2419
- midColumnVisible?: boolean;
2420
- /**
2421
- * Indicates if the end column is currently visible
2422
- */
2423
- endColumnVisible?: boolean;
2424
- /**
2425
- * Indicates if the layout is changed via the arrows
2426
- */
2427
- arrowsUsed?: boolean;
2428
- /**
2429
- * Indicates if the layout is changed via resizing
2430
- */
2431
- resize?: boolean;
2432
- }
3874
+ fnFunction: (p1: sap.ui.base.Event) => void,
3875
+ /**
3876
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
3877
+ */
3878
+ oListener?: object
2433
3879
  ): this;
2434
3880
  /**
2435
- * Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
2436
- *
2437
- * An object of strings that defines several additional accessibility texts for even further customization.
3881
+ * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
3882
+ * `sap.ui.webc.fiori.MediaGallery`.
2438
3883
  *
2439
- * It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
2440
- * region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
2441
- * the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
2442
- * (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
2443
- * the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
2444
- * right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
2445
- * have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
2446
- * and `end` columns) will have when pointing to the right
3884
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3885
+ * otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
2447
3886
  *
2448
- * Default value is `{}`.
3887
+ * Fired when selection is changed by user interaction.
2449
3888
  */
2450
- getAccessibilityTexts(): object;
3889
+ attachSelectionChange(
3890
+ /**
3891
+ * An application-specific payload object that will be passed to the event handler along with the event
3892
+ * object when firing the event
3893
+ */
3894
+ oData: object,
3895
+ /**
3896
+ * The function to be called when the event occurs
3897
+ */
3898
+ fnFunction: (p1: sap.ui.base.Event) => void,
3899
+ /**
3900
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
3901
+ */
3902
+ oListener?: object
3903
+ ): this;
2451
3904
  /**
2452
- * Returns the current column layout, based on both the `layout` property and the screen size.
3905
+ * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
3906
+ * `sap.ui.webc.fiori.MediaGallery`.
2453
3907
  *
2454
- * **For example:** ["67%", "33%", 0], ["100%", 0, 0], ["25%", "50%", "25%"], etc, where the numbers represents
2455
- * the width of the start, middle and end columns.
2456
- */
2457
- getColumnLayout(): void;
2458
- /**
2459
- * Gets content of aggregation {@link #getEndColumn endColumn}.
3908
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3909
+ * otherwise it will be bound to this `sap.ui.webc.fiori.MediaGallery` itself.
2460
3910
  *
2461
- * Defines the content in the end column.
3911
+ * Fired when selection is changed by user interaction.
2462
3912
  */
2463
- getEndColumn(): sap.ui.core.Control;
3913
+ attachSelectionChange(
3914
+ /**
3915
+ * The function to be called when the event occurs
3916
+ */
3917
+ fnFunction: (p1: sap.ui.base.Event) => void,
3918
+ /**
3919
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.MediaGallery` itself
3920
+ */
3921
+ oListener?: object
3922
+ ): this;
2464
3923
  /**
2465
- * Returns if the `end` column is visible.
3924
+ * Destroys all the items in the aggregation {@link #getItems items}.
2466
3925
  */
2467
- getEndColumnVisible(): void;
3926
+ destroyItems(): this;
2468
3927
  /**
2469
- * Gets current value of property {@link #getHeight height}.
3928
+ * Detaches event handler `fnFunction` from the {@link #event:displayAreaClick displayAreaClick} event of
3929
+ * this `sap.ui.webc.fiori.MediaGallery`.
2470
3930
  *
2471
- * Defines the height of the control
3931
+ * The passed function and listener object must match the ones used for event registration.
2472
3932
  */
2473
- getHeight(): sap.ui.core.CSSSize;
3933
+ detachDisplayAreaClick(
3934
+ /**
3935
+ * The function to be called, when the event occurs
3936
+ */
3937
+ fnFunction: (p1: sap.ui.base.Event) => void,
3938
+ /**
3939
+ * Context object on which the given function had to be called
3940
+ */
3941
+ oListener?: object
3942
+ ): this;
2474
3943
  /**
2475
- * Gets current value of property {@link #getHideArrows hideArrows}.
2476
- *
2477
- * Defines the visibility of the arrows, used for expanding and shrinking the columns.
3944
+ * Detaches event handler `fnFunction` from the {@link #event:overflowClick overflowClick} event of this
3945
+ * `sap.ui.webc.fiori.MediaGallery`.
2478
3946
  *
2479
- * Default value is `false`.
3947
+ * The passed function and listener object must match the ones used for event registration.
2480
3948
  */
2481
- getHideArrows(): boolean;
3949
+ detachOverflowClick(
3950
+ /**
3951
+ * The function to be called, when the event occurs
3952
+ */
3953
+ fnFunction: (p1: sap.ui.base.Event) => void,
3954
+ /**
3955
+ * Context object on which the given function had to be called
3956
+ */
3957
+ oListener?: object
3958
+ ): this;
2482
3959
  /**
2483
- * Gets current value of property {@link #getLayout layout}.
2484
- *
2485
- * Defines the columns layout and their proportion.
2486
- *
2487
- * **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
2488
- * columns between 599px and 1023px and three columns for sizes bigger than 1023px.
2489
- *
2490
- * Available options are:
2491
- * - `OneColumn`
2492
- * - `TwoColumnsStartExpanded`
2493
- * - `TwoColumnsMidExpanded`
2494
- * - `ThreeColumnsMidExpanded`
2495
- * - `ThreeColumnsEndExpanded`
2496
- * - `ThreeColumnsStartExpandedEndHidden`
2497
- * - `ThreeColumnsMidExpandedEndHidden`
2498
- * - `MidColumnFullScreen`
2499
- * - `EndColumnFullScreen`
2500
- *
2501
- * **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
2502
- * 67%/33% proportion.
3960
+ * Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of
3961
+ * this `sap.ui.webc.fiori.MediaGallery`.
2503
3962
  *
2504
- * Default value is `OneColumn`.
3963
+ * The passed function and listener object must match the ones used for event registration.
2505
3964
  */
2506
- getLayout(): sap.ui.webc.fiori.FCLLayout;
3965
+ detachSelectionChange(
3966
+ /**
3967
+ * The function to be called, when the event occurs
3968
+ */
3969
+ fnFunction: (p1: sap.ui.base.Event) => void,
3970
+ /**
3971
+ * Context object on which the given function had to be called
3972
+ */
3973
+ oListener?: object
3974
+ ): this;
2507
3975
  /**
2508
- * Gets content of aggregation {@link #getMidColumn midColumn}.
2509
- *
2510
- * Defines the content in the middle column.
3976
+ * Fires event {@link #event:displayAreaClick displayAreaClick} to attached listeners.
2511
3977
  */
2512
- getMidColumn(): sap.ui.core.Control;
3978
+ fireDisplayAreaClick(
3979
+ /**
3980
+ * Parameters to pass along with the event
3981
+ */
3982
+ mParameters?: object
3983
+ ): this;
2513
3984
  /**
2514
- * Returns if the `middle` column is visible.
3985
+ * Fires event {@link #event:overflowClick overflowClick} to attached listeners.
2515
3986
  */
2516
- getMidColumnVisible(): void;
3987
+ fireOverflowClick(
3988
+ /**
3989
+ * Parameters to pass along with the event
3990
+ */
3991
+ mParameters?: object
3992
+ ): this;
3993
+ /**
3994
+ * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
3995
+ */
3996
+ fireSelectionChange(
3997
+ /**
3998
+ * Parameters to pass along with the event
3999
+ */
4000
+ mParameters?: {
4001
+ /**
4002
+ * the selected item.
4003
+ */
4004
+ item?: HTMLElement;
4005
+ }
4006
+ ): this;
2517
4007
  /**
2518
- * Gets content of aggregation {@link #getStartColumn startColumn}.
4008
+ * Gets current value of property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
2519
4009
  *
2520
- * Defines the content in the start column.
4010
+ * If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
4011
+ * The display area is the central area that contains the enlarged content of the currently selected item.
4012
+ *
4013
+ * Default value is `false`.
2521
4014
  */
2522
- getStartColumn(): sap.ui.core.Control;
4015
+ getInteractiveDisplayArea(): boolean;
2523
4016
  /**
2524
- * Returns if the `start` column is visible.
4017
+ * Gets content of aggregation {@link #getItems items}.
4018
+ *
4019
+ * Defines the component items.
4020
+ *
4021
+ *
4022
+ *
4023
+ * **Note:** Only one selected item is allowed.
4024
+ *
4025
+ *
4026
+ *
4027
+ * **Note:** Use the `sap.ui.webc.fiori.MediaGalleryItem` component to define the desired items.
2525
4028
  */
2526
- getStartColumnVisible(): void;
4029
+ getItems(): sap.ui.webc.fiori.IMediaGalleryItem[];
2527
4030
  /**
2528
- * Returns the number of currently visible columns.
4031
+ * Gets current value of property {@link #getLayout layout}.
4032
+ *
4033
+ * Determines the layout of the component.
4034
+ *
4035
+ * Available options are:
4036
+ * - `Auto`
4037
+ * - `Vertical`
4038
+ * - `Horizontal`
4039
+ *
4040
+ * Default value is `Auto`.
2529
4041
  */
2530
- getVisibleColumns(): void;
4042
+ getLayout(): sap.ui.webc.fiori.MediaGalleryLayout;
2531
4043
  /**
2532
- * Gets current value of property {@link #getWidth width}.
4044
+ * Gets current value of property {@link #getMenuHorizontalAlign menuHorizontalAlign}.
2533
4045
  *
2534
- * Defines the width of the control
4046
+ * Determines the horizontal alignment of the thumbnails menu vs. the central display area.
4047
+ *
4048
+ * Available options are:
4049
+ * - `Left`
4050
+ * - `Right`
4051
+ *
4052
+ * Default value is `Left`.
2535
4053
  */
2536
- getWidth(): sap.ui.core.CSSSize;
4054
+ getMenuHorizontalAlign(): sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign;
2537
4055
  /**
2538
- * Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
4056
+ * Gets current value of property {@link #getMenuVerticalAlign menuVerticalAlign}.
2539
4057
  *
2540
- * An object of strings that defines several additional accessibility texts for even further customization.
4058
+ * Determines the vertical alignment of the thumbnails menu vs. the central display area.
2541
4059
  *
2542
- * It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
2543
- * region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
2544
- * the accessibility name for the `endColumn` region - `startArrowLeftText`: the text that the first arrow
2545
- * (between the `begin` and `mid` columns) will have when pointing to the left - `startArrowRightText`:
2546
- * the text that the first arrow (between the `begin` and `mid` columns) will have when pointing to the
2547
- * right - `endArrowLeftText`: the text that the second arrow (between the `mid` and `end` columns) will
2548
- * have when pointing to the left - `endArrowRightText`: the text that the second arrow (between the `mid`
2549
- * and `end` columns) will have when pointing to the right
4060
+ * Available options are:
4061
+ * - `Top`
4062
+ * - `Bottom`
2550
4063
  *
2551
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4064
+ * Default value is `Bottom`.
4065
+ */
4066
+ getMenuVerticalAlign(): sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign;
4067
+ /**
4068
+ * Gets current value of property {@link #getShowAllThumbnails showAllThumbnails}.
2552
4069
  *
2553
- * Default value is `{}`.
4070
+ * If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
4071
+ * thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
4072
+ *
4073
+ * Default value is `false`.
2554
4074
  */
2555
- setAccessibilityTexts(
4075
+ getShowAllThumbnails(): boolean;
4076
+ /**
4077
+ * Checks for the provided `sap.ui.webc.fiori.IMediaGalleryItem` in the aggregation {@link #getItems items}.
4078
+ * and returns its index if found or -1 otherwise.
4079
+ */
4080
+ indexOfItem(
2556
4081
  /**
2557
- * New value for property `accessibilityTexts`
4082
+ * The item whose index is looked for
2558
4083
  */
2559
- oAccessibilityTexts?: object
2560
- ): this;
4084
+ oItem: sap.ui.webc.fiori.IMediaGalleryItem
4085
+ ): int;
2561
4086
  /**
2562
- * Sets the aggregated {@link #getEndColumn endColumn}.
4087
+ * Inserts a item into the aggregation {@link #getItems items}.
2563
4088
  */
2564
- setEndColumn(
4089
+ insertItem(
2565
4090
  /**
2566
- * The endColumn to set
4091
+ * The item to insert; if empty, nothing is inserted
2567
4092
  */
2568
- oEndColumn: sap.ui.core.Control
4093
+ oItem: sap.ui.webc.fiori.IMediaGalleryItem,
4094
+ /**
4095
+ * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
4096
+ * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
4097
+ * the last position
4098
+ */
4099
+ iIndex: int
2569
4100
  ): this;
2570
4101
  /**
2571
- * Sets a new value for property {@link #getHeight height}.
2572
- *
2573
- * Defines the height of the control
4102
+ * Removes all the controls from the aggregation {@link #getItems items}.
2574
4103
  *
2575
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4104
+ * Additionally, it unregisters them from the hosting UIArea.
2576
4105
  */
2577
- setHeight(
4106
+ removeAllItems(): sap.ui.webc.fiori.IMediaGalleryItem[];
4107
+ /**
4108
+ * Removes a item from the aggregation {@link #getItems items}.
4109
+ */
4110
+ removeItem(
2578
4111
  /**
2579
- * New value for property `height`
4112
+ * The item to remove or its index or id
2580
4113
  */
2581
- sHeight?: sap.ui.core.CSSSize
2582
- ): this;
4114
+ vItem: int | string | sap.ui.webc.fiori.IMediaGalleryItem
4115
+ ): sap.ui.webc.fiori.IMediaGalleryItem;
2583
4116
  /**
2584
- * Sets a new value for property {@link #getHideArrows hideArrows}.
4117
+ * Sets a new value for property {@link #getInteractiveDisplayArea interactiveDisplayArea}.
2585
4118
  *
2586
- * Defines the visibility of the arrows, used for expanding and shrinking the columns.
4119
+ * If enabled, a `display-area-click` event is fired when the user clicks or taps on the display area.
4120
+ * The display area is the central area that contains the enlarged content of the currently selected item.
2587
4121
  *
2588
4122
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2589
4123
  *
2590
4124
  * Default value is `false`.
2591
4125
  */
2592
- setHideArrows(
4126
+ setInteractiveDisplayArea(
2593
4127
  /**
2594
- * New value for property `hideArrows`
4128
+ * New value for property `interactiveDisplayArea`
2595
4129
  */
2596
- bHideArrows?: boolean
4130
+ bInteractiveDisplayArea?: boolean
2597
4131
  ): this;
2598
4132
  /**
2599
4133
  * Sets a new value for property {@link #getLayout layout}.
2600
4134
  *
2601
- * Defines the columns layout and their proportion.
2602
- *
2603
- * **Note:** The layout also depends on the screen size - one column for screens smaller than 599px, two
2604
- * columns between 599px and 1023px and three columns for sizes bigger than 1023px.
4135
+ * Determines the layout of the component.
2605
4136
  *
2606
4137
  * Available options are:
2607
- * - `OneColumn`
2608
- * - `TwoColumnsStartExpanded`
2609
- * - `TwoColumnsMidExpanded`
2610
- * - `ThreeColumnsMidExpanded`
2611
- * - `ThreeColumnsEndExpanded`
2612
- * - `ThreeColumnsStartExpandedEndHidden`
2613
- * - `ThreeColumnsMidExpandedEndHidden`
2614
- * - `MidColumnFullScreen`
2615
- * - `EndColumnFullScreen`
2616
- *
2617
- * **For example:** layout=`TwoColumnsStartExpanded` means the layout will display up to two columns in
2618
- * 67%/33% proportion.
4138
+ * - `Auto`
4139
+ * - `Vertical`
4140
+ * - `Horizontal`
2619
4141
  *
2620
4142
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2621
4143
  *
2622
- * Default value is `OneColumn`.
4144
+ * Default value is `Auto`.
2623
4145
  */
2624
4146
  setLayout(
2625
4147
  /**
2626
4148
  * New value for property `layout`
2627
4149
  */
2628
- sLayout?: sap.ui.webc.fiori.FCLLayout
4150
+ sLayout?: sap.ui.webc.fiori.MediaGalleryLayout
2629
4151
  ): this;
2630
4152
  /**
2631
- * Sets the aggregated {@link #getMidColumn midColumn}.
4153
+ * Sets a new value for property {@link #getMenuHorizontalAlign menuHorizontalAlign}.
4154
+ *
4155
+ * Determines the horizontal alignment of the thumbnails menu vs. the central display area.
4156
+ *
4157
+ * Available options are:
4158
+ * - `Left`
4159
+ * - `Right`
4160
+ *
4161
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4162
+ *
4163
+ * Default value is `Left`.
2632
4164
  */
2633
- setMidColumn(
4165
+ setMenuHorizontalAlign(
2634
4166
  /**
2635
- * The midColumn to set
4167
+ * New value for property `menuHorizontalAlign`
2636
4168
  */
2637
- oMidColumn: sap.ui.core.Control
4169
+ sMenuHorizontalAlign?: sap.ui.webc.fiori.MediaGalleryMenuHorizontalAlign
2638
4170
  ): this;
2639
4171
  /**
2640
- * Sets the aggregated {@link #getStartColumn startColumn}.
4172
+ * Sets a new value for property {@link #getMenuVerticalAlign menuVerticalAlign}.
4173
+ *
4174
+ * Determines the vertical alignment of the thumbnails menu vs. the central display area.
4175
+ *
4176
+ * Available options are:
4177
+ * - `Top`
4178
+ * - `Bottom`
4179
+ *
4180
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4181
+ *
4182
+ * Default value is `Bottom`.
2641
4183
  */
2642
- setStartColumn(
4184
+ setMenuVerticalAlign(
2643
4185
  /**
2644
- * The startColumn to set
4186
+ * New value for property `menuVerticalAlign`
2645
4187
  */
2646
- oStartColumn: sap.ui.core.Control
4188
+ sMenuVerticalAlign?: sap.ui.webc.fiori.MediaGalleryMenuVerticalAlign
2647
4189
  ): this;
2648
4190
  /**
2649
- * Sets a new value for property {@link #getWidth width}.
4191
+ * Sets a new value for property {@link #getShowAllThumbnails showAllThumbnails}.
2650
4192
  *
2651
- * Defines the width of the control
4193
+ * If set to `true`, all thumbnails are rendered in a scrollable container. If `false`, only up to five
4194
+ * thumbnails are rendered, followed by an overflow button that shows the count of the remaining thumbnails.
2652
4195
  *
2653
4196
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4197
+ *
4198
+ * Default value is `false`.
2654
4199
  */
2655
- setWidth(
4200
+ setShowAllThumbnails(
2656
4201
  /**
2657
- * New value for property `width`
4202
+ * New value for property `showAllThumbnails`
2658
4203
  */
2659
- sWidth?: sap.ui.core.CSSSize
4204
+ bShowAllThumbnails?: boolean
2660
4205
  ): this;
2661
4206
  }
2662
4207
  /**
2663
- * @SINCE 1.95.0
2664
- * @EXPERIMENTAL (since 1.95.0)
4208
+ * @SINCE 1.99.0
4209
+ * @EXPERIMENTAL (since 1.99.0)
2665
4210
  *
2666
- * Overview: An IllustratedMessage is a recommended combination of a solution-oriented message, an engaging
2667
- * illustration, and conversational tone to better communicate an empty or a success state than just show
2668
- * a message alone.
4211
+ * Overview: The `sap.ui.webc.fiori.MediaGalleryItem` web component represents the items displayed in the
4212
+ * `sap.ui.webc.fiori.MediaGallery` web component.
2669
4213
  *
2670
- * Each illustration has default internationalised title and subtitle texts. Also they can be managed with
2671
- * `titleText` and `subtitleText` properties.
4214
+ * **Note:** `sap.ui.webc.fiori.MediaGalleryItem` is not supported when used outside of `sap.ui.webc.fiori.MediaGallery`.
2672
4215
  *
2673
- * Structure: The IllustratedMessage consists of the following elements, which are displayed below each
2674
- * other in the following order:
2675
4216
  *
2676
4217
  *
2677
4218
  *
2678
- * - Illustration
2679
- * - Title
2680
- * - Subtitle
2681
- * - Actions
4219
+ * Keyboard Handling: The `sap.ui.webc.fiori.MediaGallery` provides advanced keyboard handling. When focused,
4220
+ * the user can use the following keyboard shortcuts in order to perform a navigation:
2682
4221
  *
2683
- * Usage: `sap.ui.webc.fiori.IllustratedMessage` is meant to be used inside container component, for example
2684
- * a `sap.ui.webc.main.Card`, a `sap.ui.webc.main.Dialog` or a `sap.ui.webc.fiori.Page`
4222
+ *
4223
+ *
4224
+ * - [SPACE/ENTER/RETURN] - Trigger `ui5-click` event
2685
4225
  */
2686
- class IllustratedMessage extends sap.ui.webc.common.WebComponent {
4226
+ class MediaGalleryItem
4227
+ extends sap.ui.webc.common.WebComponent
4228
+ implements sap.ui.webc.fiori.IMediaGalleryItem {
4229
+ __implements__sap_ui_webc_fiori_IMediaGalleryItem: boolean;
2687
4230
  /**
2688
- * Constructor for a new `IllustratedMessage`.
4231
+ * Constructor for a new `MediaGalleryItem`.
2689
4232
  *
2690
4233
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2691
4234
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -2695,10 +4238,10 @@ declare namespace sap {
2695
4238
  /**
2696
4239
  * Initial settings for the new control
2697
4240
  */
2698
- mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
4241
+ mSettings?: sap.ui.webc.fiori.$MediaGalleryItemSettings
2699
4242
  );
2700
4243
  /**
2701
- * Constructor for a new `IllustratedMessage`.
4244
+ * Constructor for a new `MediaGalleryItem`.
2702
4245
  *
2703
4246
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2704
4247
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -2712,11 +4255,11 @@ declare namespace sap {
2712
4255
  /**
2713
4256
  * Initial settings for the new control
2714
4257
  */
2715
- mSettings?: sap.ui.webc.fiori.$IllustratedMessageSettings
4258
+ mSettings?: sap.ui.webc.fiori.$MediaGalleryItemSettings
2716
4259
  );
2717
4260
 
2718
4261
  /**
2719
- * Creates a new subclass of class sap.ui.webc.fiori.IllustratedMessage with name `sClassName` and enriches
4262
+ * Creates a new subclass of class sap.ui.webc.fiori.MediaGalleryItem with name `sClassName` and enriches
2720
4263
  * it with the information contained in `oClassInfo`.
2721
4264
  *
2722
4265
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
@@ -2729,7 +4272,7 @@ declare namespace sap {
2729
4272
  /**
2730
4273
  * Object literal with information about the class
2731
4274
  */
2732
- oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.IllustratedMessage>,
4275
+ oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.MediaGalleryItem>,
2733
4276
  /**
2734
4277
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2735
4278
  * used by this class
@@ -2737,166 +4280,125 @@ declare namespace sap {
2737
4280
  FNMetaImpl?: Function
2738
4281
  ): Function;
2739
4282
  /**
2740
- * Returns a metadata object for class sap.ui.webc.fiori.IllustratedMessage.
4283
+ * Returns a metadata object for class sap.ui.webc.fiori.MediaGalleryItem.
2741
4284
  */
2742
4285
  static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
2743
4286
  /**
2744
- * Adds some action to the aggregation {@link #getActions actions}.
2745
- */
2746
- addAction(
2747
- /**
2748
- * The action to add; if empty, nothing is inserted
2749
- */
2750
- oAction: sap.ui.webc.main.IButton
2751
- ): this;
2752
- /**
2753
- * Destroys all the actions in the aggregation {@link #getActions actions}.
2754
- */
2755
- destroyActions(): this;
2756
- /**
2757
- * Destroys the subtitle in the aggregation {@link #getSubtitle subtitle}.
2758
- */
2759
- destroySubtitle(): this;
2760
- /**
2761
- * Gets content of aggregation {@link #getActions actions}.
2762
- *
2763
- * Defines the component actions.
2764
- */
2765
- getActions(): sap.ui.webc.main.IButton[];
2766
- /**
2767
- * Gets current value of property {@link #getName name}.
2768
- *
2769
- * Default value is `BeforeSearch`.
4287
+ * Destroys the content in the aggregation {@link #getContent content}.
2770
4288
  */
2771
- getName(): sap.ui.webc.fiori.IllustrationMessageType;
4289
+ destroyContent(): this;
2772
4290
  /**
2773
- * Gets content of aggregation {@link #getSubtitle subtitle}.
2774
- *
2775
- * Defines the subtitle of the component.
2776
- *
2777
- * **Note:** Using this slot, the default subtitle text of illustration and the value of `subtitleText`
2778
- * property will be overwritten.
4291
+ * Destroys the thumbnail in the aggregation {@link #getThumbnail thumbnail}.
2779
4292
  */
2780
- getSubtitle(): sap.ui.core.Control;
4293
+ destroyThumbnail(): this;
2781
4294
  /**
2782
- * Gets current value of property {@link #getSubtitleText subtitleText}.
2783
- *
2784
- * Defines the subtitle of the component.
2785
- *
2786
- * **Note:** Using this property, the default subtitle text of illustration will be overwritten.
2787
- *
2788
- * **Note:** Using `subtitle` slot, the default of this property will be overwritten.
4295
+ * Gets content of aggregation {@link #getContent content}.
2789
4296
  *
2790
- * Default value is `empty string`.
4297
+ * Defines the content of the component.
2791
4298
  */
2792
- getSubtitleText(): string;
4299
+ getContent(): sap.ui.core.Control;
2793
4300
  /**
2794
- * Gets current value of property {@link #getTitleText titleText}.
2795
- *
2796
- * Defines the title of the component.
2797
- *
2798
- * **Note:** Using this property, the default title text of illustration will be overwritten.
4301
+ * Gets current value of property {@link #getEnabled enabled}.
2799
4302
  *
2800
- * Default value is `empty string`.
2801
- */
2802
- getTitleText(): string;
2803
- /**
2804
- * Checks for the provided `sap.ui.webc.main.IButton` in the aggregation {@link #getActions actions}. and
2805
- * returns its index if found or -1 otherwise.
2806
- */
2807
- indexOfAction(
2808
- /**
2809
- * The action whose index is looked for
2810
- */
2811
- oAction: sap.ui.webc.main.IButton
2812
- ): int;
2813
- /**
2814
- * Inserts a action into the aggregation {@link #getActions actions}.
2815
- */
2816
- insertAction(
2817
- /**
2818
- * The action to insert; if empty, nothing is inserted
2819
- */
2820
- oAction: sap.ui.webc.main.IButton,
2821
- /**
2822
- * The `0`-based index the action should be inserted at; for a negative value of `iIndex`, the action is
2823
- * inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
2824
- * at the last position
2825
- */
2826
- iIndex: int
2827
- ): this;
2828
- /**
2829
- * Removes a action from the aggregation {@link #getActions actions}.
2830
- */
2831
- removeAction(
2832
- /**
2833
- * The action to remove or its index or id
2834
- */
2835
- vAction: int | string | sap.ui.webc.main.IButton
2836
- ): sap.ui.webc.main.IButton;
4303
+ * Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
4304
+ * the tab chain.
4305
+ *
4306
+ * Default value is `true`.
4307
+ */
4308
+ getEnabled(): boolean;
2837
4309
  /**
2838
- * Removes all the controls from the aggregation {@link #getActions actions}.
4310
+ * Gets current value of property {@link #getLayout layout}.
2839
4311
  *
2840
- * Additionally, it unregisters them from the hosting UIArea.
4312
+ * Determines the layout of the item container.
4313
+ *
4314
+ * Available options are:
4315
+ * - `Square`
4316
+ * - `Wide`
4317
+ *
4318
+ * Default value is `Square`.
2841
4319
  */
2842
- removeAllActions(): sap.ui.webc.main.IButton[];
4320
+ getLayout(): sap.ui.webc.fiori.MediaGalleryItemLayout;
2843
4321
  /**
2844
- * Sets a new value for property {@link #getName name}.
4322
+ * Gets current value of property {@link #getSelected selected}.
2845
4323
  *
2846
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4324
+ * Defines the selected state of the component.
2847
4325
  *
2848
- * Default value is `BeforeSearch`.
4326
+ * Default value is `false`.
2849
4327
  */
2850
- setName(
4328
+ getSelected(): boolean;
4329
+ /**
4330
+ * Gets content of aggregation {@link #getThumbnail thumbnail}.
4331
+ *
4332
+ * Defines the content of the thumbnail.
4333
+ */
4334
+ getThumbnail(): sap.ui.core.Control;
4335
+ /**
4336
+ * Sets the aggregated {@link #getContent content}.
4337
+ */
4338
+ setContent(
2851
4339
  /**
2852
- * New value for property `name`
4340
+ * The content to set
2853
4341
  */
2854
- sName?: sap.ui.webc.fiori.IllustrationMessageType
4342
+ oContent: sap.ui.core.Control
2855
4343
  ): this;
2856
4344
  /**
2857
- * Sets the aggregated {@link #getSubtitle subtitle}.
4345
+ * Sets a new value for property {@link #getEnabled enabled}.
4346
+ *
4347
+ * Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
4348
+ * the tab chain.
4349
+ *
4350
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4351
+ *
4352
+ * Default value is `true`.
2858
4353
  */
2859
- setSubtitle(
4354
+ setEnabled(
2860
4355
  /**
2861
- * The subtitle to set
4356
+ * New value for property `enabled`
2862
4357
  */
2863
- oSubtitle: sap.ui.core.Control
4358
+ bEnabled?: boolean
2864
4359
  ): this;
2865
4360
  /**
2866
- * Sets a new value for property {@link #getSubtitleText subtitleText}.
2867
- *
2868
- * Defines the subtitle of the component.
4361
+ * Sets a new value for property {@link #getLayout layout}.
2869
4362
  *
2870
- * **Note:** Using this property, the default subtitle text of illustration will be overwritten.
4363
+ * Determines the layout of the item container.
2871
4364
  *
2872
- * **Note:** Using `subtitle` slot, the default of this property will be overwritten.
4365
+ * Available options are:
4366
+ * - `Square`
4367
+ * - `Wide`
2873
4368
  *
2874
4369
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2875
4370
  *
2876
- * Default value is `empty string`.
4371
+ * Default value is `Square`.
2877
4372
  */
2878
- setSubtitleText(
4373
+ setLayout(
2879
4374
  /**
2880
- * New value for property `subtitleText`
4375
+ * New value for property `layout`
2881
4376
  */
2882
- sSubtitleText?: string
4377
+ sLayout?: sap.ui.webc.fiori.MediaGalleryItemLayout
2883
4378
  ): this;
2884
4379
  /**
2885
- * Sets a new value for property {@link #getTitleText titleText}.
2886
- *
2887
- * Defines the title of the component.
4380
+ * Sets a new value for property {@link #getSelected selected}.
2888
4381
  *
2889
- * **Note:** Using this property, the default title text of illustration will be overwritten.
4382
+ * Defines the selected state of the component.
2890
4383
  *
2891
4384
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2892
4385
  *
2893
- * Default value is `empty string`.
4386
+ * Default value is `false`.
2894
4387
  */
2895
- setTitleText(
4388
+ setSelected(
2896
4389
  /**
2897
- * New value for property `titleText`
4390
+ * New value for property `selected`
2898
4391
  */
2899
- sTitleText?: string
4392
+ bSelected?: boolean
4393
+ ): this;
4394
+ /**
4395
+ * Sets the aggregated {@link #getThumbnail thumbnail}.
4396
+ */
4397
+ setThumbnail(
4398
+ /**
4399
+ * The thumbnail to set
4400
+ */
4401
+ oThumbnail: sap.ui.core.Control
2900
4402
  ): this;
2901
4403
  }
2902
4404
  /**
@@ -2984,15 +4486,14 @@ declare namespace sap {
2984
4486
  */
2985
4487
  getDesign(): sap.ui.webc.main.ButtonDesign;
2986
4488
  /**
2987
- * Gets current value of property {@link #getDisabled disabled}.
2988
- *
2989
- * Defines if the action is disabled.
4489
+ * Gets current value of property {@link #getEnabled enabled}.
2990
4490
  *
2991
- * **Note:** a disabled action can't be pressed or focused, and it is not in the tab chain.
4491
+ * Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
4492
+ * the tab chain.
2992
4493
  *
2993
- * Default value is `false`.
4494
+ * Default value is `true`.
2994
4495
  */
2995
- getDisabled(): boolean;
4496
+ getEnabled(): boolean;
2996
4497
  /**
2997
4498
  * Gets current value of property {@link #getIcon icon}.
2998
4499
  *
@@ -3037,21 +4538,20 @@ declare namespace sap {
3037
4538
  sDesign?: sap.ui.webc.main.ButtonDesign
3038
4539
  ): this;
3039
4540
  /**
3040
- * Sets a new value for property {@link #getDisabled disabled}.
4541
+ * Sets a new value for property {@link #getEnabled enabled}.
3041
4542
  *
3042
- * Defines if the action is disabled.
3043
- *
3044
- * **Note:** a disabled action can't be pressed or focused, and it is not in the tab chain.
4543
+ * Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
4544
+ * the tab chain.
3045
4545
  *
3046
4546
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3047
4547
  *
3048
- * Default value is `false`.
4548
+ * Default value is `true`.
3049
4549
  */
3050
- setDisabled(
4550
+ setEnabled(
3051
4551
  /**
3052
- * New value for property `disabled`
4552
+ * New value for property `enabled`
3053
4553
  */
3054
- bDisabled?: boolean
4554
+ bEnabled?: boolean
3055
4555
  ): this;
3056
4556
  /**
3057
4557
  * Sets a new value for property {@link #getIcon icon}.
@@ -4221,34 +5721,16 @@ declare namespace sap {
4221
5721
  */
4222
5722
  oContent: sap.ui.core.Control
4223
5723
  ): this;
4224
- /**
4225
- * Adds some footer to the aggregation {@link #getFooter footer}.
4226
- */
4227
- addFooter(
4228
- /**
4229
- * The footer to add; if empty, nothing is inserted
4230
- */
4231
- oFooter: sap.ui.core.Control
4232
- ): this;
4233
- /**
4234
- * Adds some header to the aggregation {@link #getHeader header}.
4235
- */
4236
- addHeader(
4237
- /**
4238
- * The header to add; if empty, nothing is inserted
4239
- */
4240
- oHeader: sap.ui.core.Control
4241
- ): this;
4242
5724
  /**
4243
5725
  * Destroys all the content in the aggregation {@link #getContent content}.
4244
5726
  */
4245
5727
  destroyContent(): this;
4246
5728
  /**
4247
- * Destroys all the footer in the aggregation {@link #getFooter footer}.
5729
+ * Destroys the footer in the aggregation {@link #getFooter footer}.
4248
5730
  */
4249
5731
  destroyFooter(): this;
4250
5732
  /**
4251
- * Destroys all the header in the aggregation {@link #getHeader header}.
5733
+ * Destroys the header in the aggregation {@link #getHeader header}.
4252
5734
  */
4253
5735
  destroyHeader(): this;
4254
5736
  /**
@@ -4297,13 +5779,13 @@ declare namespace sap {
4297
5779
  *
4298
5780
  * Defines the footer HTML Element.
4299
5781
  */
4300
- getFooter(): sap.ui.core.Control[];
5782
+ getFooter(): sap.ui.webc.fiori.IBar;
4301
5783
  /**
4302
5784
  * Gets content of aggregation {@link #getHeader header}.
4303
5785
  *
4304
5786
  * Defines the header HTML Element.
4305
5787
  */
4306
- getHeader(): sap.ui.core.Control[];
5788
+ getHeader(): sap.ui.webc.fiori.IBar;
4307
5789
  /**
4308
5790
  * Gets current value of property {@link #getHeight height}.
4309
5791
  *
@@ -4334,26 +5816,6 @@ declare namespace sap {
4334
5816
  */
4335
5817
  oContent: sap.ui.core.Control
4336
5818
  ): int;
4337
- /**
4338
- * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getFooter footer}. and returns
4339
- * its index if found or -1 otherwise.
4340
- */
4341
- indexOfFooter(
4342
- /**
4343
- * The footer whose index is looked for
4344
- */
4345
- oFooter: sap.ui.core.Control
4346
- ): int;
4347
- /**
4348
- * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getHeader header}. and returns
4349
- * its index if found or -1 otherwise.
4350
- */
4351
- indexOfHeader(
4352
- /**
4353
- * The header whose index is looked for
4354
- */
4355
- oHeader: sap.ui.core.Control
4356
- ): int;
4357
5819
  /**
4358
5820
  * Inserts a content into the aggregation {@link #getContent content}.
4359
5821
  */
@@ -4369,54 +5831,12 @@ declare namespace sap {
4369
5831
  */
4370
5832
  iIndex: int
4371
5833
  ): this;
4372
- /**
4373
- * Inserts a footer into the aggregation {@link #getFooter footer}.
4374
- */
4375
- insertFooter(
4376
- /**
4377
- * The footer to insert; if empty, nothing is inserted
4378
- */
4379
- oFooter: sap.ui.core.Control,
4380
- /**
4381
- * The `0`-based index the footer should be inserted at; for a negative value of `iIndex`, the footer is
4382
- * inserted at position 0; for a value greater than the current size of the aggregation, the footer is inserted
4383
- * at the last position
4384
- */
4385
- iIndex: int
4386
- ): this;
4387
- /**
4388
- * Inserts a header into the aggregation {@link #getHeader header}.
4389
- */
4390
- insertHeader(
4391
- /**
4392
- * The header to insert; if empty, nothing is inserted
4393
- */
4394
- oHeader: sap.ui.core.Control,
4395
- /**
4396
- * The `0`-based index the header should be inserted at; for a negative value of `iIndex`, the header is
4397
- * inserted at position 0; for a value greater than the current size of the aggregation, the header is inserted
4398
- * at the last position
4399
- */
4400
- iIndex: int
4401
- ): this;
4402
5834
  /**
4403
5835
  * Removes all the controls from the aggregation {@link #getContent content}.
4404
5836
  *
4405
5837
  * Additionally, it unregisters them from the hosting UIArea.
4406
5838
  */
4407
5839
  removeAllContent(): sap.ui.core.Control[];
4408
- /**
4409
- * Removes all the controls from the aggregation {@link #getFooter footer}.
4410
- *
4411
- * Additionally, it unregisters them from the hosting UIArea.
4412
- */
4413
- removeAllFooter(): sap.ui.core.Control[];
4414
- /**
4415
- * Removes all the controls from the aggregation {@link #getHeader header}.
4416
- *
4417
- * Additionally, it unregisters them from the hosting UIArea.
4418
- */
4419
- removeAllHeader(): sap.ui.core.Control[];
4420
5840
  /**
4421
5841
  * Removes a content from the aggregation {@link #getContent content}.
4422
5842
  */
@@ -4426,24 +5846,6 @@ declare namespace sap {
4426
5846
  */
4427
5847
  vContent: int | string | sap.ui.core.Control
4428
5848
  ): sap.ui.core.Control;
4429
- /**
4430
- * Removes a footer from the aggregation {@link #getFooter footer}.
4431
- */
4432
- removeFooter(
4433
- /**
4434
- * The footer to remove or its index or id
4435
- */
4436
- vFooter: int | string | sap.ui.core.Control
4437
- ): sap.ui.core.Control;
4438
- /**
4439
- * Removes a header from the aggregation {@link #getHeader header}.
4440
- */
4441
- removeHeader(
4442
- /**
4443
- * The header to remove or its index or id
4444
- */
4445
- vHeader: int | string | sap.ui.core.Control
4446
- ): sap.ui.core.Control;
4447
5849
  /**
4448
5850
  * Sets a new value for property {@link #getBackgroundDesign backgroundDesign}.
4449
5851
  *
@@ -4500,6 +5902,24 @@ declare namespace sap {
4500
5902
  */
4501
5903
  bFloatingFooter?: boolean
4502
5904
  ): this;
5905
+ /**
5906
+ * Sets the aggregated {@link #getFooter footer}.
5907
+ */
5908
+ setFooter(
5909
+ /**
5910
+ * The footer to set
5911
+ */
5912
+ oFooter: sap.ui.webc.fiori.IBar
5913
+ ): this;
5914
+ /**
5915
+ * Sets the aggregated {@link #getHeader header}.
5916
+ */
5917
+ setHeader(
5918
+ /**
5919
+ * The header to set
5920
+ */
5921
+ oHeader: sap.ui.webc.fiori.IBar
5922
+ ): this;
4503
5923
  /**
4504
5924
  * Sets a new value for property {@link #getHeight height}.
4505
5925
  *
@@ -4994,16 +6414,14 @@ declare namespace sap {
4994
6414
  * - profile
4995
6415
  * - product-switch
4996
6416
  *
4997
- * In the context of `sap.ui.webc.fiori.ShellBar`, you can provide a custom stable DOM refs for:
4998
- * - Every `sap.ui.webc.fiori.ShellBarItem` that you provide. Example: `
4999
- * `
5000
- *
5001
6417
  * CSS Shadow Parts:
5002
6418
  *
5003
6419
  * CSS Shadow Parts
5004
6420
  * allow developers to style elements inside the Shadow DOM.
5005
6421
  * The `sap.ui.webc.fiori.ShellBar` exposes the following CSS Shadow Parts:
5006
6422
  * - root - Used to style the outermost wrapper of the `sap.ui.webc.fiori.ShellBar`
6423
+ *
6424
+ * Keyboard Handling:
5007
6425
  */
5008
6426
  class ShellBar extends sap.ui.webc.common.WebComponent {
5009
6427
  /**
@@ -5168,7 +6586,7 @@ declare namespace sap {
5168
6586
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
5169
6587
  * otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
5170
6588
  *
5171
- * Fired, when a menu item is activated **Note:** You can prevent closing of oveflow popover by calling
6589
+ * Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
5172
6590
  * `event.preventDefault()`.
5173
6591
  */
5174
6592
  attachMenuItemClick(
@@ -5192,7 +6610,7 @@ declare namespace sap {
5192
6610
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
5193
6611
  * otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
5194
6612
  *
5195
- * Fired, when a menu item is activated **Note:** You can prevent closing of oveflow popover by calling
6613
+ * Fired, when a menu item is activated **Note:** You can prevent closing of overflow popover by calling
5196
6614
  * `event.preventDefault()`.
5197
6615
  */
5198
6616
  attachMenuItemClick(
@@ -5255,7 +6673,7 @@ declare namespace sap {
5255
6673
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
5256
6674
  * otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
5257
6675
  *
5258
- * Fired, when the product switch icon is activated. **Note:** You can prevent closing of oveflow popover
6676
+ * Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
5259
6677
  * by calling `event.preventDefault()`.
5260
6678
  */
5261
6679
  attachProductSwitchClick(
@@ -5280,7 +6698,7 @@ declare namespace sap {
5280
6698
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
5281
6699
  * otherwise it will be bound to this `sap.ui.webc.fiori.ShellBar` itself.
5282
6700
  *
5283
- * Fired, when the product switch icon is activated. **Note:** You can prevent closing of oveflow popover
6701
+ * Fired, when the product switch icon is activated. **Note:** You can prevent closing of overflow popover
5284
6702
  * by calling `event.preventDefault()`.
5285
6703
  */
5286
6704
  attachProductSwitchClick(
@@ -5546,6 +6964,21 @@ declare namespace sap {
5546
6964
  targetRef?: HTMLElement;
5547
6965
  }
5548
6966
  ): this;
6967
+ /**
6968
+ * Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
6969
+ *
6970
+ * An object of strings that defines several additional accessibility texts for even further customization.
6971
+ *
6972
+ * It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
6973
+ * - `logoTitle`: defines the tooltip for the logo
6974
+ *
6975
+ * Default value is `{}`.
6976
+ */
6977
+ getAccessibilityTexts(): object;
6978
+ /**
6979
+ * Returns the `copilot` DOM ref.
6980
+ */
6981
+ getCopilotDomRef(): void;
5549
6982
  /**
5550
6983
  * Gets content of aggregation {@link #getItems items}.
5551
6984
  *
@@ -5561,6 +6994,10 @@ declare namespace sap {
5561
6994
  * or `img` elements as logo.
5562
6995
  */
5563
6996
  getLogo(): sap.ui.webc.main.IAvatar;
6997
+ /**
6998
+ * Returns the `logo` DOM ref.
6999
+ */
7000
+ getLogoDomRef(): void;
5564
7001
  /**
5565
7002
  * Gets content of aggregation {@link #getMenuItems menuItems}.
5566
7003
  *
@@ -5577,6 +7014,14 @@ declare namespace sap {
5577
7014
  * Default value is `empty string`.
5578
7015
  */
5579
7016
  getNotificationsCount(): string;
7017
+ /**
7018
+ * Returns the `notifications` icon DOM ref.
7019
+ */
7020
+ getNotificationsDomRef(): void;
7021
+ /**
7022
+ * Returns the `overflow` icon DOM ref.
7023
+ */
7024
+ getOverflowDomRef(): void;
5580
7025
  /**
5581
7026
  * Gets current value of property {@link #getPrimaryTitle primaryTitle}.
5582
7027
  *
@@ -5587,6 +7032,10 @@ declare namespace sap {
5587
7032
  * Default value is `empty string`.
5588
7033
  */
5589
7034
  getPrimaryTitle(): string;
7035
+ /**
7036
+ * Returns the `product-switch` icon DOM ref.
7037
+ */
7038
+ getProductSwitchDomRef(): void;
5590
7039
  /**
5591
7040
  * Gets content of aggregation {@link #getProfile profile}.
5592
7041
  *
@@ -5597,6 +7046,10 @@ declare namespace sap {
5597
7046
  * specific size by design in the context of `sap.ui.webc.fiori.ShellBar` profile.
5598
7047
  */
5599
7048
  getProfile(): sap.ui.webc.main.IAvatar;
7049
+ /**
7050
+ * Returns the `profile` icon DOM ref.
7051
+ */
7052
+ getProfileDomRef(): void;
5600
7053
  /**
5601
7054
  * Gets content of aggregation {@link #getSearchField searchField}.
5602
7055
  *
@@ -5726,6 +7179,24 @@ declare namespace sap {
5726
7179
  */
5727
7180
  vMenuItem: int | string | sap.ui.webc.main.IListItem
5728
7181
  ): sap.ui.webc.main.IListItem;
7182
+ /**
7183
+ * Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
7184
+ *
7185
+ * An object of strings that defines several additional accessibility texts for even further customization.
7186
+ *
7187
+ * It supports the following fields: - `profileButtonTitle`: defines the tooltip for the profile button
7188
+ * - `logoTitle`: defines the tooltip for the logo
7189
+ *
7190
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7191
+ *
7192
+ * Default value is `{}`.
7193
+ */
7194
+ setAccessibilityTexts(
7195
+ /**
7196
+ * New value for property `accessibilityTexts`
7197
+ */
7198
+ oAccessibilityTexts?: object
7199
+ ): this;
5729
7200
  /**
5730
7201
  * Sets the aggregated {@link #getLogo logo}.
5731
7202
  */
@@ -5924,14 +7395,14 @@ declare namespace sap {
5924
7395
  */
5925
7396
  static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
5926
7397
  /**
5927
- * Attaches event handler `fnFunction` to the {@link #event:itemClick itemClick} event of this `sap.ui.webc.fiori.ShellBarItem`.
7398
+ * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
5928
7399
  *
5929
7400
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
5930
7401
  * otherwise it will be bound to this `sap.ui.webc.fiori.ShellBarItem` itself.
5931
7402
  *
5932
7403
  * Fired, when the item is pressed.
5933
7404
  */
5934
- attachItemClick(
7405
+ attachClick(
5935
7406
  /**
5936
7407
  * An application-specific payload object that will be passed to the event handler along with the event
5937
7408
  * object when firing the event
@@ -5947,14 +7418,14 @@ declare namespace sap {
5947
7418
  oListener?: object
5948
7419
  ): this;
5949
7420
  /**
5950
- * Attaches event handler `fnFunction` to the {@link #event:itemClick itemClick} event of this `sap.ui.webc.fiori.ShellBarItem`.
7421
+ * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
5951
7422
  *
5952
7423
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
5953
7424
  * otherwise it will be bound to this `sap.ui.webc.fiori.ShellBarItem` itself.
5954
7425
  *
5955
7426
  * Fired, when the item is pressed.
5956
7427
  */
5957
- attachItemClick(
7428
+ attachClick(
5958
7429
  /**
5959
7430
  * The function to be called when the event occurs
5960
7431
  */
@@ -5965,11 +7436,11 @@ declare namespace sap {
5965
7436
  oListener?: object
5966
7437
  ): this;
5967
7438
  /**
5968
- * Detaches event handler `fnFunction` from the {@link #event:itemClick itemClick} event of this `sap.ui.webc.fiori.ShellBarItem`.
7439
+ * Detaches event handler `fnFunction` from the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
5969
7440
  *
5970
7441
  * The passed function and listener object must match the ones used for event registration.
5971
7442
  */
5972
- detachItemClick(
7443
+ detachClick(
5973
7444
  /**
5974
7445
  * The function to be called, when the event occurs
5975
7446
  */
@@ -5980,12 +7451,12 @@ declare namespace sap {
5980
7451
  oListener?: object
5981
7452
  ): this;
5982
7453
  /**
5983
- * Fires event {@link #event:itemClick itemClick} to attached listeners.
7454
+ * Fires event {@link #event:click click} to attached listeners.
5984
7455
  *
5985
7456
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
5986
7457
  * event object. The return value of this method indicates whether the default action should be executed.
5987
7458
  */
5988
- fireItemClick(
7459
+ fireClick(
5989
7460
  /**
5990
7461
  * Parameters to pass along with the event
5991
7462
  */
@@ -6086,6 +7557,8 @@ declare namespace sap {
6086
7557
  * components to build your menu. The items can consist of text only or an icon with text. The use or non-use
6087
7558
  * of icons must be consistent for all items on one level. You must not combine entries with and without
6088
7559
  * icons on the same level. We strongly recommend that you do not use icons on the second level.
7560
+ *
7561
+ * Keyboard Handling:
6089
7562
  */
6090
7563
  class SideNavigation extends sap.ui.webc.common.WebComponent {
6091
7564
  /**
@@ -6244,6 +7717,9 @@ declare namespace sap {
6244
7717
  ): this;
6245
7718
  /**
6246
7719
  * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
7720
+ *
7721
+ * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
7722
+ * event object. The return value of this method indicates whether the default action should be executed.
6247
7723
  */
6248
7724
  fireSelectionChange(
6249
7725
  /**
@@ -6255,7 +7731,7 @@ declare namespace sap {
6255
7731
  */
6256
7732
  item?: HTMLElement;
6257
7733
  }
6258
- ): this;
7734
+ ): boolean;
6259
7735
  /**
6260
7736
  * Gets current value of property {@link #getCollapsed collapsed}.
6261
7737
  *
@@ -7039,6 +8515,12 @@ declare namespace sap {
7039
8515
  * Destroys all the items in the aggregation {@link #getItems items}.
7040
8516
  */
7041
8517
  destroyItems(): this;
8518
+ /**
8519
+ * Gets current value of property {@link #getAccessibleName accessibleName}.
8520
+ *
8521
+ * Defines the accessible aria name of the component.
8522
+ */
8523
+ getAccessibleName(): string;
7042
8524
  /**
7043
8525
  * Gets current value of property {@link #getHeight height}.
7044
8526
  *
@@ -7111,6 +8593,19 @@ declare namespace sap {
7111
8593
  */
7112
8594
  vItem: int | string | sap.ui.webc.fiori.ITimelineItem
7113
8595
  ): sap.ui.webc.fiori.ITimelineItem;
8596
+ /**
8597
+ * Sets a new value for property {@link #getAccessibleName accessibleName}.
8598
+ *
8599
+ * Defines the accessible aria name of the component.
8600
+ *
8601
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8602
+ */
8603
+ setAccessibleName(
8604
+ /**
8605
+ * New value for property `accessibleName`
8606
+ */
8607
+ sAccessibleName: string
8608
+ ): this;
7114
8609
  /**
7115
8610
  * Sets a new value for property {@link #getHeight height}.
7116
8611
  *
@@ -7805,7 +9300,7 @@ declare namespace sap {
7805
9300
  /**
7806
9301
  * Gets current value of property {@link #getAccessibleName accessibleName}.
7807
9302
  *
7808
- * Sets the accessible aria name of the component.
9303
+ * Defines the accessible aria name of the component.
7809
9304
  *
7810
9305
  * Default value is `empty string`.
7811
9306
  */
@@ -7965,7 +9460,7 @@ declare namespace sap {
7965
9460
  /**
7966
9461
  * Sets a new value for property {@link #getAccessibleName accessibleName}.
7967
9462
  *
7968
- * Sets the accessible aria name of the component.
9463
+ * Defines the accessible aria name of the component.
7969
9464
  *
7970
9465
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7971
9466
  *
@@ -8934,6 +10429,18 @@ declare namespace sap {
8934
10429
  * The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
8935
10430
  */
8936
10431
  sortBy?: string;
10432
+ /**
10433
+ * The currently selected `sap.ui.webc.fiori.SortItem`.
10434
+ */
10435
+ sortByItem?: HTMLElement;
10436
+ /**
10437
+ * The selected sort order (true = descending, false = ascending).
10438
+ */
10439
+ sortDescending?: boolean;
10440
+ /**
10441
+ * The selected filters items.
10442
+ */
10443
+ filterItems?: any[];
8937
10444
  }
8938
10445
  ): this;
8939
10446
  /**
@@ -8952,6 +10459,18 @@ declare namespace sap {
8952
10459
  * The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
8953
10460
  */
8954
10461
  sortBy?: string;
10462
+ /**
10463
+ * The currently selected `sap.ui.webc.fiori.SortItem`.
10464
+ */
10465
+ sortByItem?: HTMLElement;
10466
+ /**
10467
+ * The selected sort order (true = descending, false = ascending).
10468
+ */
10469
+ sortDescending?: boolean;
10470
+ /**
10471
+ * The selected filters items.
10472
+ */
10473
+ filterItems?: any[];
8955
10474
  }
8956
10475
  ): this;
8957
10476
  /**
@@ -9091,6 +10610,16 @@ declare namespace sap {
9091
10610
  * **Note:** If no selected step is defined, the first step will be auto selected.
9092
10611
  * **Note:** If multiple selected steps are defined, the last step will be selected.
9093
10612
  *
10613
+ * Keyboard Handling: The user can navigate using the following keyboard shortcuts:
10614
+ *
10615
+ *
10616
+ * Wizard Progress Navigation:
10617
+ * - [LEFT], [DOWN] - Focus moves backward to the WizardProgressNavAnchors.
10618
+ * - [UP], [RIGHT] - Focus moves forward to the WizardProgressNavAnchor.
10619
+ * - [SPACE] or [ENTER], [RETURN] - Selects an active step
10620
+ * - [HOME] or [PAGE UP] - Focus goes to the first step
10621
+ * - [END] or [PAGE DOWN] - Focus goes to the last step
10622
+ *
9094
10623
  * Content: The content occupies the main part of the page. It can hold any type of HTML elements. It's
9095
10624
  * defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard`.
9096
10625
  *
@@ -9278,16 +10807,8 @@ declare namespace sap {
9278
10807
  * The step change occurs due to user's click or 'Enter'/'Space' key press on step within the navigation.
9279
10808
  */
9280
10809
  changeWithClick?: boolean;
9281
- }
9282
- ): this;
9283
- /**
9284
- * Gets current value of property {@link #getAccessibleName accessibleName}.
9285
- *
9286
- * Sets the accessible aria name of the component.
9287
- *
9288
- * Default value is `undefined`.
9289
- */
9290
- getAccessibleName(): string;
10810
+ }
10811
+ ): this;
9291
10812
  /**
9292
10813
  * Gets current value of property {@link #getHeight height}.
9293
10814
  *
@@ -9342,21 +10863,6 @@ declare namespace sap {
9342
10863
  */
9343
10864
  vStep: int | string | sap.ui.webc.fiori.IWizardStep
9344
10865
  ): sap.ui.webc.fiori.IWizardStep;
9345
- /**
9346
- * Sets a new value for property {@link #getAccessibleName accessibleName}.
9347
- *
9348
- * Sets the accessible aria name of the component.
9349
- *
9350
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9351
- *
9352
- * Default value is `undefined`.
9353
- */
9354
- setAccessibleName(
9355
- /**
9356
- * New value for property `accessibleName`
9357
- */
9358
- sAccessibleName?: string
9359
- ): this;
9360
10866
  /**
9361
10867
  * Sets a new value for property {@link #getHeight height}.
9362
10868
  *
@@ -9462,22 +10968,6 @@ declare namespace sap {
9462
10968
  * Destroys all the content in the aggregation {@link #getContent content}.
9463
10969
  */
9464
10970
  destroyContent(): this;
9465
- /**
9466
- * Gets current value of property {@link #getAccessibleName accessibleName}.
9467
- *
9468
- * Sets the accessible aria name of the component.
9469
- *
9470
- * Default value is `empty string`.
9471
- */
9472
- getAccessibleName(): string;
9473
- /**
9474
- * Gets current value of property {@link #getAccessibleNameRef accessibleNameRef}.
9475
- *
9476
- * Defines the aria-labelledby of the step.
9477
- *
9478
- * Default value is `empty string`.
9479
- */
9480
- getAccessibleNameRef(): string;
9481
10971
  /**
9482
10972
  * Gets current value of property {@link #getBranching branching}.
9483
10973
  *
@@ -9499,19 +10989,14 @@ declare namespace sap {
9499
10989
  */
9500
10990
  getContent(): sap.ui.core.Control[];
9501
10991
  /**
9502
- * Gets current value of property {@link #getDisabled disabled}.
9503
- *
9504
- * Defines if the step is `disabled`. When disabled the step is displayed, but the user can't select the
9505
- * step by clicking or navigate to it with scrolling.
10992
+ * Gets current value of property {@link #getEnabled enabled}.
9506
10993
  *
10994
+ * Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
10995
+ * the tab chain.
9507
10996
  *
9508
- *
9509
- * **Note:** Step can't be `selected` and `disabled` at the same time. In this case the `selected` property
9510
- * would take precedence.
9511
- *
9512
- * Default value is `false`.
10997
+ * Default value is `true`.
9513
10998
  */
9514
- getDisabled(): boolean;
10999
+ getEnabled(): boolean;
9515
11000
  /**
9516
11001
  * Gets current value of property {@link #getIcon icon}.
9517
11002
  *
@@ -9605,36 +11090,6 @@ declare namespace sap {
9605
11090
  */
9606
11091
  vContent: int | string | sap.ui.core.Control
9607
11092
  ): sap.ui.core.Control;
9608
- /**
9609
- * Sets a new value for property {@link #getAccessibleName accessibleName}.
9610
- *
9611
- * Sets the accessible aria name of the component.
9612
- *
9613
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9614
- *
9615
- * Default value is `empty string`.
9616
- */
9617
- setAccessibleName(
9618
- /**
9619
- * New value for property `accessibleName`
9620
- */
9621
- sAccessibleName?: string
9622
- ): this;
9623
- /**
9624
- * Sets a new value for property {@link #getAccessibleNameRef accessibleNameRef}.
9625
- *
9626
- * Defines the aria-labelledby of the step.
9627
- *
9628
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9629
- *
9630
- * Default value is `empty string`.
9631
- */
9632
- setAccessibleNameRef(
9633
- /**
9634
- * New value for property `accessibleNameRef`
9635
- */
9636
- sAccessibleNameRef?: string
9637
- ): this;
9638
11093
  /**
9639
11094
  * Sets a new value for property {@link #getBranching branching}.
9640
11095
  *
@@ -9657,25 +11112,20 @@ declare namespace sap {
9657
11112
  bBranching?: boolean
9658
11113
  ): this;
9659
11114
  /**
9660
- * Sets a new value for property {@link #getDisabled disabled}.
9661
- *
9662
- * Defines if the step is `disabled`. When disabled the step is displayed, but the user can't select the
9663
- * step by clicking or navigate to it with scrolling.
9664
- *
11115
+ * Sets a new value for property {@link #getEnabled enabled}.
9665
11116
  *
9666
- *
9667
- * **Note:** Step can't be `selected` and `disabled` at the same time. In this case the `selected` property
9668
- * would take precedence.
11117
+ * Defines whether the control is enabled. A disabled control can't be interacted with, and it is not in
11118
+ * the tab chain.
9669
11119
  *
9670
11120
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9671
11121
  *
9672
- * Default value is `false`.
11122
+ * Default value is `true`.
9673
11123
  */
9674
- setDisabled(
11124
+ setEnabled(
9675
11125
  /**
9676
- * New value for property `disabled`
11126
+ * New value for property `enabled`
9677
11127
  */
9678
- bDisabled?: boolean
11128
+ bEnabled?: boolean
9679
11129
  ): this;
9680
11130
  /**
9681
11131
  * Sets a new value for property {@link #getIcon icon}.
@@ -9864,41 +11314,241 @@ declare namespace sap {
9864
11314
  */
9865
11315
  enum IllustrationMessageType {
9866
11316
  /**
9867
- * "BeforeSearch" illustration type.
11317
+ * "Add Column" illustration type.
11318
+ */
11319
+ AddColumn = "AddColumn",
11320
+ /**
11321
+ * "Add People" illustration type.
11322
+ */
11323
+ AddPeople = "AddPeople",
11324
+ /**
11325
+ * "Balloon Sky" illustration type.
11326
+ */
11327
+ BalloonSky = "BalloonSky",
11328
+ /**
11329
+ * "Before Search" illustration type.
9868
11330
  */
9869
11331
  BeforeSearch = "BeforeSearch",
9870
11332
  /**
9871
- * "NoActivities" illustration type.
11333
+ * "Connection" illustration type.
11334
+ */
11335
+ Connection = "Connection",
11336
+ /**
11337
+ * "Empty Calendar" illustration type.
11338
+ */
11339
+ EmptyCalendar = "EmptyCalendar",
11340
+ /**
11341
+ * "Empty List" illustration type.
11342
+ */
11343
+ EmptyList = "EmptyList",
11344
+ /**
11345
+ * "Empty Planning Calendar" illustration type.
11346
+ */
11347
+ EmptyPlanningCalendar = "EmptyPlanningCalendar",
11348
+ /**
11349
+ * "Error Screen" illustration type.
11350
+ */
11351
+ ErrorScreen = "ErrorScreen",
11352
+ /**
11353
+ * "Filter Table" illustration type.
11354
+ */
11355
+ FilterTable = "FilterTable",
11356
+ /**
11357
+ * "Group Table" illustration type.
11358
+ */
11359
+ GroupTable = "GroupTable",
11360
+ /**
11361
+ * "No Activities" illustration type.
9872
11362
  */
9873
11363
  NoActivities = "NoActivities",
9874
11364
  /**
9875
- * "NoData" illustration type.
11365
+ * "No Data" illustration type.
9876
11366
  */
9877
11367
  NoData = "NoData",
9878
11368
  /**
9879
- * "NoEntries" illustration type.
11369
+ * "No Entries" illustration type.
9880
11370
  */
9881
11371
  NoEntries = "NoEntries",
9882
11372
  /**
9883
- * "NoMail" illustration type.
11373
+ * "No Filter Results" illustration type.
11374
+ */
11375
+ NoFilterResults = "NoFilterResults",
11376
+ /**
11377
+ * "No Email" illustration type.
9884
11378
  */
9885
11379
  NoMail = "NoMail",
9886
11380
  /**
9887
- * "NoNotifications" illustration type.
11381
+ * "No Email v1" illustration type.
11382
+ */
11383
+ NoMail_v1 = "NoMail_v1",
11384
+ /**
11385
+ * "No Notifications" illustration type.
9888
11386
  */
9889
11387
  NoNotifications = "NoNotifications",
9890
11388
  /**
9891
- * "NoSavedItems" illustration type.
11389
+ * "No Saved Items" illustration type.
9892
11390
  */
9893
11391
  NoSavedItems = "NoSavedItems",
9894
11392
  /**
9895
- * "NoSearchResults" illustration type.
11393
+ * "No Saved Items v1" illustration type.
11394
+ */
11395
+ NoSavedItems_v1 = "NoSavedItems_v1",
11396
+ /**
11397
+ * "No Search Results" illustration type.
9896
11398
  */
9897
11399
  NoSearchResults = "NoSearchResults",
9898
11400
  /**
9899
- * "NoTasks" illustration type.
11401
+ * "No Tasks" illustration type.
9900
11402
  */
9901
11403
  NoTasks = "NoTasks",
11404
+ /**
11405
+ * "No Tasks v1" illustration type.
11406
+ */
11407
+ NoTasks_v1 = "NoTasks_v1",
11408
+ /**
11409
+ * "Page Not Found" illustration type.
11410
+ */
11411
+ PageNotFound = "PageNotFound",
11412
+ /**
11413
+ * "Reload Screen" illustration type.
11414
+ */
11415
+ ReloadScreen = "ReloadScreen",
11416
+ /**
11417
+ * "Resize Column" illustration type.
11418
+ */
11419
+ ResizeColumn = "ResizeColumn",
11420
+ /**
11421
+ * "Search Earth" illustration type.
11422
+ */
11423
+ SearchEarth = "SearchEarth",
11424
+ /**
11425
+ * "Search Folder" illustration type.
11426
+ */
11427
+ SearchFolder = "SearchFolder",
11428
+ /**
11429
+ * "Simple Balloon" illustration type.
11430
+ */
11431
+ SimpleBalloon = "SimpleBalloon",
11432
+ /**
11433
+ * "Simple Bell" illustration type.
11434
+ */
11435
+ SimpleBell = "SimpleBell",
11436
+ /**
11437
+ * "Simple Calendar" illustration type.
11438
+ */
11439
+ SimpleCalendar = "SimpleCalendar",
11440
+ /**
11441
+ * "Simple CheckMark" illustration type.
11442
+ */
11443
+ SimpleCheckMark = "SimpleCheckMark",
11444
+ /**
11445
+ * "Simple Connection" illustration type.
11446
+ */
11447
+ SimpleConnection = "SimpleConnection",
11448
+ /**
11449
+ * "Simple Empty Doc" illustration type.
11450
+ */
11451
+ SimpleEmptyDoc = "SimpleEmptyDoc",
11452
+ /**
11453
+ * "Simple Empty List" illustration type.
11454
+ */
11455
+ SimpleEmptyList = "SimpleEmptyList",
11456
+ /**
11457
+ * "Simple Error" illustration type.
11458
+ */
11459
+ SimpleError = "SimpleError",
11460
+ /**
11461
+ * "Simple Magnifier" illustration type.
11462
+ */
11463
+ SimpleMagnifier = "SimpleMagnifier",
11464
+ /**
11465
+ * "Simple Mail" illustration type.
11466
+ */
11467
+ SimpleMail = "SimpleMail",
11468
+ /**
11469
+ * "Simple No Saved Items" illustration type.
11470
+ */
11471
+ SimpleNoSavedItems = "SimpleNoSavedItems",
11472
+ /**
11473
+ * "Simple Not Found Magnifier" illustration type.
11474
+ */
11475
+ SimpleNotFoundMagnifier = "SimpleNotFoundMagnifier",
11476
+ /**
11477
+ * "Simple Reload" illustration type.
11478
+ */
11479
+ SimpleReload = "SimpleReload",
11480
+ /**
11481
+ * "Simple Task" illustration type.
11482
+ */
11483
+ SimpleTask = "SimpleTask",
11484
+ /**
11485
+ * "Sleeping Bell" illustration type.
11486
+ */
11487
+ SleepingBell = "SleepingBell",
11488
+ /**
11489
+ * "Sort Column" illustration type.
11490
+ */
11491
+ SortColumn = "SortColumn",
11492
+ /**
11493
+ * "Success Balloon" illustration type.
11494
+ */
11495
+ SuccessBalloon = "SuccessBalloon",
11496
+ /**
11497
+ * "Success CheckMark" illustration type.
11498
+ */
11499
+ SuccessCheckMark = "SuccessCheckMark",
11500
+ /**
11501
+ * "Success HighFive" illustration type.
11502
+ */
11503
+ SuccessHighFive = "SuccessHighFive",
11504
+ /**
11505
+ * "Success Screen" illustration type.
11506
+ */
11507
+ SuccessScreen = "SuccessScreen",
11508
+ /**
11509
+ * "Tent" illustration type.
11510
+ */
11511
+ Tent = "Tent",
11512
+ /**
11513
+ * "TntChartArea" illustration type.
11514
+ */
11515
+ TntChartArea = "TntChartArea",
11516
+ /**
11517
+ * "TntChartArea2" illustration type.
11518
+ */
11519
+ TntChartArea2 = "TntChartArea2",
11520
+ /**
11521
+ * "TntChartBar" illustration type.
11522
+ */
11523
+ TntChartBar = "TntChartBar",
11524
+ /**
11525
+ * "TntChartBPMNFlow" illustration type.
11526
+ */
11527
+ TntChartBPMNFlow = "TntChartBPMNFlow",
11528
+ /**
11529
+ * "TntChartBullet" illustration type.
11530
+ */
11531
+ TntChartBullet = "TntChartBullet",
11532
+ /**
11533
+ * "TntChartDoughnut" illustration type.
11534
+ */
11535
+ TntChartDoughnut = "TntChartDoughnut",
11536
+ /**
11537
+ * "TntChartFlow" illustration type.
11538
+ */
11539
+ TntChartFlow = "TntChartFlow",
11540
+ /**
11541
+ * "TntChartGantt" illustration type.
11542
+ */
11543
+ TntChartGantt = "TntChartGantt",
11544
+ /**
11545
+ * "TntChartOrg" illustration type.
11546
+ */
11547
+ TntChartOrg = "TntChartOrg",
11548
+ /**
11549
+ * "TntChartPie" illustration type.
11550
+ */
11551
+ TntChartPie = "TntChartPie",
9902
11552
  /**
9903
11553
  * "TntCodePlaceholder" illustration type.
9904
11554
  */
@@ -9907,6 +11557,10 @@ declare namespace sap {
9907
11557
  * "TntCompany" illustration type.
9908
11558
  */
9909
11559
  TntCompany = "TntCompany",
11560
+ /**
11561
+ * "TntComponents" illustration type.
11562
+ */
11563
+ TntComponents = "TntComponents",
9910
11564
  /**
9911
11565
  * "TntExternalLink" illustration type.
9912
11566
  */
@@ -9943,6 +11597,10 @@ declare namespace sap {
9943
11597
  * "TntRadar" illustration type.
9944
11598
  */
9945
11599
  TntRadar = "TntRadar",
11600
+ /**
11601
+ * "TntSecrets" illustration type.
11602
+ */
11603
+ TntSecrets = "TntSecrets",
9946
11604
  /**
9947
11605
  * "TntServices" illustration type.
9948
11606
  */
@@ -9963,6 +11621,22 @@ declare namespace sap {
9963
11621
  * "TntSuccessfulAuth" illustration type.
9964
11622
  */
9965
11623
  TntSuccessfulAuth = "TntSuccessfulAuth",
11624
+ /**
11625
+ * "TntSystems" illustration type.
11626
+ */
11627
+ TntSystems = "TntSystems",
11628
+ /**
11629
+ * "TntTeams" illustration type.
11630
+ */
11631
+ TntTeams = "TntTeams",
11632
+ /**
11633
+ * "TntTools" illustration type.
11634
+ */
11635
+ TntTools = "TntTools",
11636
+ /**
11637
+ * "TntUnableToLoad" illustration type.
11638
+ */
11639
+ TntUnableToLoad = "TntUnableToLoad",
9966
11640
  /**
9967
11641
  * "TntUnlock" illustration type.
9968
11642
  */
@@ -9972,13 +11646,97 @@ declare namespace sap {
9972
11646
  */
9973
11647
  TntUnsuccessfulAuth = "TntUnsuccessfulAuth",
9974
11648
  /**
9975
- * "UnableToLoad" illustration type.
11649
+ * "TntUser2" illustration type.
11650
+ */
11651
+ TntUser2 = "TntUser2",
11652
+ /**
11653
+ * "Unable To Load" illustration type.
9976
11654
  */
9977
11655
  UnableToLoad = "UnableToLoad",
9978
11656
  /**
9979
- * "UnableToUpload" illustration type.
11657
+ * "Unable To Load Image" illustration type.
11658
+ */
11659
+ UnableToLoadImage = "UnableToLoadImage",
11660
+ /**
11661
+ * "Unable To Upload" illustration type.
9980
11662
  */
9981
11663
  UnableToUpload = "UnableToUpload",
11664
+ /**
11665
+ * "Upload Collection" illustration type.
11666
+ */
11667
+ UploadCollection = "UploadCollection",
11668
+ }
11669
+ /**
11670
+ * @SINCE 1.99.0
11671
+ * @EXPERIMENTAL (since 1.99.0)
11672
+ *
11673
+ * Defines the layout of the content displayed in the `ui5-media-gallery-item`.
11674
+ */
11675
+ enum MediaGalleryItemLayout {
11676
+ /**
11677
+ * Recommended to use when the item contains an image.
11678
+ * When a thumbnail is selected, it makes the corresponding enlarged content appear in a square display
11679
+ * area.
11680
+ */
11681
+ Square = "Square",
11682
+ /**
11683
+ * Recommended to use when the item contains video content.
11684
+ * When a thumbnail is selected, it makes the corresponding enlarged content appear in a wide display area
11685
+ * (stretched to fill all of the available width) for optimal user experiance.
11686
+ */
11687
+ Wide = "Wide",
11688
+ }
11689
+ /**
11690
+ * @SINCE 1.99.0
11691
+ * @EXPERIMENTAL (since 1.99.0)
11692
+ *
11693
+ * Defines the layout type of the thumbnails list of the `ui5-media-gallery` component.
11694
+ */
11695
+ enum MediaGalleryLayout {
11696
+ /**
11697
+ * The layout is determined automatically.
11698
+ */
11699
+ Auto = "Auto",
11700
+ /**
11701
+ * Displays the layout as a horizontal split between the thumbnails list and the selected image.
11702
+ */
11703
+ Horizontal = "Horizontal",
11704
+ /**
11705
+ * Displays the layout as a vertical split between the thumbnails list and the selected image.
11706
+ */
11707
+ Vertical = "Vertical",
11708
+ }
11709
+ /**
11710
+ * @SINCE 1.99.0
11711
+ * @EXPERIMENTAL (since 1.99.0)
11712
+ *
11713
+ * Defines the horizontal alignment of the thumbnails menu of the `ui5-media-gallery` component.
11714
+ */
11715
+ enum MediaGalleryMenuHorizontalAlign {
11716
+ /**
11717
+ * Displays the menu on the left side of the target.
11718
+ */
11719
+ Left = "Left",
11720
+ /**
11721
+ * Displays the menu on the right side of the target.
11722
+ */
11723
+ Right = "Right",
11724
+ }
11725
+ /**
11726
+ * @SINCE 1.99.0
11727
+ * @EXPERIMENTAL (since 1.99.0)
11728
+ *
11729
+ * Types for the vertical alignment of the thumbnails menu of the `ui5-media-gallery` component.
11730
+ */
11731
+ enum MediaGalleryMenuVerticalAlign {
11732
+ /**
11733
+ * Displays the menu at the bottom of the reference control.
11734
+ */
11735
+ Bottom = "Bottom",
11736
+ /**
11737
+ * Displays the menu at the top of the reference control.
11738
+ */
11739
+ Top = "Top",
9982
11740
  }
9983
11741
  /**
9984
11742
  * @SINCE 1.92.0
@@ -10000,6 +11758,76 @@ declare namespace sap {
10000
11758
  */
10001
11759
  Transparent = "Transparent",
10002
11760
  }
11761
+ /**
11762
+ * @SINCE 1.99.0
11763
+ * @EXPERIMENTAL (since 1.99.0)
11764
+ *
11765
+ * SideContent FallDown options.
11766
+ */
11767
+ enum SideContentFallDown {
11768
+ /**
11769
+ * Side content falls down on breakpoints below L
11770
+ */
11771
+ BelowL = "BelowL",
11772
+ /**
11773
+ * Side content falls down on breakpoints below M
11774
+ */
11775
+ BelowM = "BelowM",
11776
+ /**
11777
+ * Side content falls down on breakpoints below XL
11778
+ */
11779
+ BelowXL = "BelowXL",
11780
+ /**
11781
+ * Side content falls down on breakpoint M and the minimum width for the side content
11782
+ */
11783
+ OnMinimumWidth = "OnMinimumWidth",
11784
+ }
11785
+ /**
11786
+ * @SINCE 1.99.0
11787
+ * @EXPERIMENTAL (since 1.99.0)
11788
+ *
11789
+ * Side Content position options.
11790
+ */
11791
+ enum SideContentPosition {
11792
+ /**
11793
+ * The side content is on the right side of the main container in left-to-right mode and on the left side
11794
+ * in right-to-left mode.
11795
+ */
11796
+ End = "End",
11797
+ /**
11798
+ * The side content is on the left side of the main container in left-to-right mode and on the right side
11799
+ * in right-to-left mode.
11800
+ */
11801
+ Start = "Start",
11802
+ }
11803
+ /**
11804
+ * @SINCE 1.99.0
11805
+ * @EXPERIMENTAL (since 1.99.0)
11806
+ *
11807
+ * Side Content visibility options.
11808
+ */
11809
+ enum SideContentVisibility {
11810
+ /**
11811
+ * Show the side content on any breakpoint
11812
+ */
11813
+ AlwaysShow = "AlwaysShow",
11814
+ /**
11815
+ * Don't show the side content on any breakpoints
11816
+ */
11817
+ NeverShow = "NeverShow",
11818
+ /**
11819
+ * Show the side content on XL breakpoint
11820
+ */
11821
+ ShowAboveL = "ShowAboveL",
11822
+ /**
11823
+ * Show the side content on L and XL breakpoints
11824
+ */
11825
+ ShowAboveM = "ShowAboveM",
11826
+ /**
11827
+ * Show the side content on M, L and XL breakpoints
11828
+ */
11829
+ ShowAboveS = "ShowAboveS",
11830
+ }
10003
11831
  /**
10004
11832
  * @SINCE 1.92.0
10005
11833
  * @EXPERIMENTAL (since 1.92.0)
@@ -10049,6 +11877,8 @@ declare namespace sap {
10049
11877
 
10050
11878
  "sap/ui/webc/fiori/BarcodeScannerDialog": undefined;
10051
11879
 
11880
+ "sap/ui/webc/fiori/DynamicSideContent": undefined;
11881
+
10052
11882
  "sap/ui/webc/fiori/FilterItem": undefined;
10053
11883
 
10054
11884
  "sap/ui/webc/fiori/FilterItemOption": undefined;
@@ -10059,6 +11889,10 @@ declare namespace sap {
10059
11889
 
10060
11890
  "sap/ui/webc/fiori/library": undefined;
10061
11891
 
11892
+ "sap/ui/webc/fiori/MediaGallery": undefined;
11893
+
11894
+ "sap/ui/webc/fiori/MediaGalleryItem": undefined;
11895
+
10062
11896
  "sap/ui/webc/fiori/NotificationAction": undefined;
10063
11897
 
10064
11898
  "sap/ui/webc/fiori/NotificationListGroupItem": undefined;