@openui5/ts-types 1.119.0 → 1.120.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.119.0
1
+ // For Library Version: 1.120.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -153,14 +153,6 @@ declare namespace sap {
153
153
  interface $BarSettings extends sap.ui.core.webc.$WebComponentSettings {
154
154
  /**
155
155
  * Defines the component's design.
156
- *
157
- *
158
- *
159
- * **Note:** Available options are:
160
- * - `Header`
161
- * - `Subheader`
162
- * - `Footer`
163
- * - `FloatingFooter`
164
156
  */
165
157
  design?:
166
158
  | sap.ui.webc.fiori.BarDesign
@@ -176,7 +168,7 @@ declare namespace sap {
176
168
  | `{${string}}`;
177
169
 
178
170
  /**
179
- * Defines the content at the end of the bar
171
+ * Defines the content at the end of the bar.
180
172
  */
181
173
  endContent?:
182
174
  | sap.ui.core.Control[]
@@ -185,7 +177,7 @@ declare namespace sap {
185
177
  | `{${string}}`;
186
178
 
187
179
  /**
188
- * Defines the content in the middle of the bar
180
+ * Defines the content in the middle of the bar.
189
181
  */
190
182
  middleContent?:
191
183
  | sap.ui.core.Control[]
@@ -194,7 +186,7 @@ declare namespace sap {
194
186
  | `{${string}}`;
195
187
 
196
188
  /**
197
- * Defines the content at the start of the bar
189
+ * Defines the content at the start of the bar.
198
190
  */
199
191
  startContent?:
200
192
  | sap.ui.core.Control[]
@@ -679,15 +671,6 @@ declare namespace sap {
679
671
  extends sap.ui.core.webc.$WebComponentSettings {
680
672
  /**
681
673
  * Defines the action design.
682
- *
683
- *
684
- *
685
- * **Note:**
686
- * - `Default`
687
- * - `Emphasized`
688
- * - `Positive`
689
- * - `Negative`
690
- * - `Transparent`
691
674
  */
692
675
  design?:
693
676
  | sap.ui.webc.main.ButtonDesign
@@ -749,11 +732,7 @@ declare namespace sap {
749
732
  | `{${string}}`;
750
733
 
751
734
  /**
752
- * Defines the `priority` of the item. Available options are:
753
- * - `None`
754
- * - `Low`
755
- * - `Medium`
756
- * - `High`
735
+ * Defines the `priority` of the item.
757
736
  */
758
737
  priority?:
759
738
  | sap.ui.webc.main.Priority
@@ -770,6 +749,14 @@ declare namespace sap {
770
749
  | sap.ui.base.ManagedObject.PropertyBindingInfo
771
750
  | `{${string}}`;
772
751
 
752
+ /**
753
+ * Defines the selected state of the `ListItem`.
754
+ */
755
+ selected?:
756
+ | boolean
757
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
758
+ | `{${string}}`;
759
+
773
760
  /**
774
761
  * Defines if the `close` button would be displayed.
775
762
  */
@@ -847,11 +834,7 @@ declare namespace sap {
847
834
  description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
848
835
 
849
836
  /**
850
- * Defines the `priority` of the item. Available options are:
851
- * - `None`
852
- * - `Low`
853
- * - `Medium`
854
- * - `High`
837
+ * Defines the `priority` of the item.
855
838
  */
856
839
  priority?:
857
840
  | sap.ui.webc.main.Priority
@@ -868,6 +851,14 @@ declare namespace sap {
868
851
  | sap.ui.base.ManagedObject.PropertyBindingInfo
869
852
  | `{${string}}`;
870
853
 
854
+ /**
855
+ * Defines the selected state of the `ListItem`.
856
+ */
857
+ selected?:
858
+ | boolean
859
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
860
+ | `{${string}}`;
861
+
871
862
  /**
872
863
  * Defines if the `close` button would be displayed.
873
864
  */
@@ -937,11 +928,6 @@ declare namespace sap {
937
928
  *
938
929
  * **Note:** When a ui5-list is placed inside the page, we recommend using “List” to ensure better color
939
930
  * contrast.
940
- *
941
- * Available options are:
942
- * - `Solid` (default)
943
- * - `Transparent`
944
- * - `List`
945
931
  */
946
932
  backgroundDesign?:
947
933
  | sap.ui.webc.fiori.PageBackgroundDesign
@@ -1276,6 +1262,8 @@ declare namespace sap {
1276
1262
 
1277
1263
  /**
1278
1264
  * Defines the item text.
1265
+ *
1266
+ * **Note:** The text is only displayed inside the overflow popover list view.
1279
1267
  */
1280
1268
  text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1281
1269
 
@@ -1581,12 +1569,8 @@ declare namespace sap {
1581
1569
  * Defines the mode of the `sap.ui.webc.fiori.UploadCollection`.
1582
1570
  *
1583
1571
  *
1584
- *
1585
- * **Note:**
1586
- * - `None`
1587
- * - `SingleSelect`
1588
- * - `MultiSelect`
1589
- * - `Delete`
1572
+ * **Note:** Mode "Delete" has no effect. The delete button is controlled by the `hideDeleteButton` property
1573
+ * of UploadCollectionItem
1590
1574
  */
1591
1575
  mode?:
1592
1576
  | sap.ui.webc.main.ListMode
@@ -1644,10 +1628,7 @@ declare namespace sap {
1644
1628
  drop?: (oEvent: UploadCollection$DropEvent) => void;
1645
1629
 
1646
1630
  /**
1647
- * Fired when the Delete button of any item is pressed.
1648
- *
1649
- * **Note:** A Delete button is displayed on each item, when the `sap.ui.webc.fiori.UploadCollection` `mode`
1650
- * property is set to `Delete`.
1631
+ * Fired when the delete button of any item is pressed.
1651
1632
  */
1652
1633
  itemDelete?: (oEvent: UploadCollection$ItemDeleteEvent) => void;
1653
1634
 
@@ -1661,6 +1642,26 @@ declare namespace sap {
1661
1642
 
1662
1643
  interface $UploadCollectionItemSettings
1663
1644
  extends sap.ui.core.webc.$WebComponentSettings {
1645
+ /**
1646
+ * An object of strings that defines several additional accessibility attribute values for customization
1647
+ * depending on the use case.
1648
+ *
1649
+ * It supports the following fields:
1650
+ *
1651
+ *
1652
+ * - `ariaSetsize`: Defines the number of items in the current set of listitems or treeitems when not
1653
+ * all items in the set are present in the DOM. The value of each `aria-setsize` is an integer reflecting
1654
+ * number of items in the complete set. **Note: ** If the size of the entire set is unknown, set `aria-setsize="-1"`.
1655
+ *
1656
+ * - `ariaPosinset`: Defines an element's number or position in the current set of listitems or treeitems
1657
+ * when not all items are present in the DOM. The value of each `aria-posinset` is an integer greater than
1658
+ * or equal to 1, and less than or equal to the size of the set when that size is known.
1659
+ */
1660
+ accessibilityAttributes?:
1661
+ | object
1662
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1663
+ | `{${string}}`;
1664
+
1664
1665
  /**
1665
1666
  * Disables the delete button.
1666
1667
  */
@@ -1690,6 +1691,15 @@ declare namespace sap {
1690
1691
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1691
1692
  | `{${string}}`;
1692
1693
 
1694
+ /**
1695
+ * By default, the delete button will always be shown, regardless of the `sap.ui.webc.fiori.UploadCollection`'s
1696
+ * property `mode`. Setting this property to `true` will hide the delete button.
1697
+ */
1698
+ hideDeleteButton?:
1699
+ | boolean
1700
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1701
+ | `{${string}}`;
1702
+
1693
1703
  /**
1694
1704
  * Hides the retry button when `uploadState` property is `Error`.
1695
1705
  */
@@ -1706,6 +1716,15 @@ declare namespace sap {
1706
1716
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1707
1717
  | `{${string}}`;
1708
1718
 
1719
+ /**
1720
+ * The navigated state of the list item. If set to `true`, a navigation indicator is displayed at the end
1721
+ * of the list item.
1722
+ */
1723
+ navigated?:
1724
+ | boolean
1725
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1726
+ | `{${string}}`;
1727
+
1709
1728
  /**
1710
1729
  * The upload progress in percentage.
1711
1730
  *
@@ -1716,6 +1735,26 @@ declare namespace sap {
1716
1735
  | sap.ui.base.ManagedObject.PropertyBindingInfo
1717
1736
  | `{${string}}`;
1718
1737
 
1738
+ /**
1739
+ * Defines the selected state of the `ListItem`.
1740
+ */
1741
+ selected?:
1742
+ | boolean
1743
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1744
+ | `{${string}}`;
1745
+
1746
+ /**
1747
+ * Defines the visual indication and behavior of the list items. Available options are `Active` (by default),
1748
+ * `Inactive`, `Detail` and `Navigation`.
1749
+ *
1750
+ * **Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and
1751
+ * hover, while with type `Inactive` and `Detail` - will not.
1752
+ */
1753
+ type?:
1754
+ | sap.ui.webc.main.ListItemType
1755
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1756
+ | `{${string}}`;
1757
+
1719
1758
  /**
1720
1759
  * If set to `Uploading` or `Error`, a progress indicator showing the `progress` is displayed. Also if set
1721
1760
  * to `Error`, a refresh button is shown. When this icon is pressed `retry` event is fired. If set to `Uploading`,
@@ -1735,6 +1774,13 @@ declare namespace sap {
1735
1774
  | sap.ui.base.ManagedObject.AggregationBindingInfo
1736
1775
  | `{${string}}`;
1737
1776
 
1777
+ /**
1778
+ * Defines the delete button, displayed in "Delete" mode. **Note:** While the slot allows custom buttons,
1779
+ * to match design guidelines, please use the `sap.ui.webc.main.Button` component. **Note:** When the slot
1780
+ * is not present, a built-in delete button will be displayed.
1781
+ */
1782
+ deleteButton?: sap.ui.webc.main.IButton;
1783
+
1738
1784
  /**
1739
1785
  * A thumbnail, which will be shown in the beginning of the `sap.ui.webc.fiori.UploadCollectionItem`.
1740
1786
  *
@@ -1742,6 +1788,11 @@ declare namespace sap {
1742
1788
  */
1743
1789
  thumbnail?: sap.ui.core.Control;
1744
1790
 
1791
+ /**
1792
+ * Fired when the user clicks on the detail button when type is `Detail`.
1793
+ */
1794
+ detailClick?: (oEvent: sap.ui.base.Event) => void;
1795
+
1745
1796
  /**
1746
1797
  * Fired when the file name is clicked.
1747
1798
  *
@@ -2112,7 +2163,7 @@ declare namespace sap {
2112
2163
 
2113
2164
  interface UploadCollection$ItemDeleteEventParameters {
2114
2165
  /**
2115
- * The `sap.ui.webc.fiori.UploadCollectionItem` which was renamed.
2166
+ * The `sap.ui.webc.fiori.UploadCollectionItem` which was deleted.
2116
2167
  */
2117
2168
  item?: HTMLElement;
2118
2169
  }
@@ -2124,6 +2175,8 @@ declare namespace sap {
2124
2175
  selectedItems?: any[];
2125
2176
  }
2126
2177
 
2178
+ interface UploadCollectionItem$DetailClickEventParameters {}
2179
+
2127
2180
  interface UploadCollectionItem$FileNameClickEventParameters {}
2128
2181
 
2129
2182
  interface UploadCollectionItem$RenameEventParameters {}
@@ -2351,14 +2404,6 @@ declare namespace sap {
2351
2404
  *
2352
2405
  * Defines the component's design.
2353
2406
  *
2354
- *
2355
- *
2356
- * **Note:** Available options are:
2357
- * - `Header`
2358
- * - `Subheader`
2359
- * - `Footer`
2360
- * - `FloatingFooter`
2361
- *
2362
2407
  * Default value is `Header`.
2363
2408
  *
2364
2409
  * @returns Value of property `design`
@@ -2367,19 +2412,19 @@ declare namespace sap {
2367
2412
  /**
2368
2413
  * Gets content of aggregation {@link #getEndContent endContent}.
2369
2414
  *
2370
- * Defines the content at the end of the bar
2415
+ * Defines the content at the end of the bar.
2371
2416
  */
2372
2417
  getEndContent(): sap.ui.core.Control[];
2373
2418
  /**
2374
2419
  * Gets content of aggregation {@link #getMiddleContent middleContent}.
2375
2420
  *
2376
- * Defines the content in the middle of the bar
2421
+ * Defines the content in the middle of the bar.
2377
2422
  */
2378
2423
  getMiddleContent(): sap.ui.core.Control[];
2379
2424
  /**
2380
2425
  * Gets content of aggregation {@link #getStartContent startContent}.
2381
2426
  *
2382
- * Defines the content at the start of the bar
2427
+ * Defines the content at the start of the bar.
2383
2428
  */
2384
2429
  getStartContent(): sap.ui.core.Control[];
2385
2430
  /**
@@ -2539,14 +2584,6 @@ declare namespace sap {
2539
2584
  *
2540
2585
  * Defines the component's design.
2541
2586
  *
2542
- *
2543
- *
2544
- * **Note:** Available options are:
2545
- * - `Header`
2546
- * - `Subheader`
2547
- * - `Footer`
2548
- * - `FloatingFooter`
2549
- *
2550
2587
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2551
2588
  *
2552
2589
  * Default value is `Header`.
@@ -5517,15 +5554,6 @@ declare namespace sap {
5517
5554
  *
5518
5555
  * Defines the action design.
5519
5556
  *
5520
- *
5521
- *
5522
- * **Note:**
5523
- * - `Default`
5524
- * - `Emphasized`
5525
- * - `Positive`
5526
- * - `Negative`
5527
- * - `Transparent`
5528
- *
5529
5557
  * Default value is `Transparent`.
5530
5558
  *
5531
5559
  * @returns Value of property `design`
@@ -5570,15 +5598,6 @@ declare namespace sap {
5570
5598
  *
5571
5599
  * Defines the action design.
5572
5600
  *
5573
- *
5574
- *
5575
- * **Note:**
5576
- * - `Default`
5577
- * - `Emphasized`
5578
- * - `Positive`
5579
- * - `Negative`
5580
- * - `Transparent`
5581
- *
5582
5601
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5583
5602
  *
5584
5603
  * Default value is `Transparent`.
@@ -5974,11 +5993,7 @@ declare namespace sap {
5974
5993
  /**
5975
5994
  * Gets current value of property {@link #getPriority priority}.
5976
5995
  *
5977
- * Defines the `priority` of the item. Available options are:
5978
- * - `None`
5979
- * - `Low`
5980
- * - `Medium`
5981
- * - `High`
5996
+ * Defines the `priority` of the item.
5982
5997
  *
5983
5998
  * Default value is `None`.
5984
5999
  *
@@ -5997,6 +6012,16 @@ declare namespace sap {
5997
6012
  * @returns Value of property `read`
5998
6013
  */
5999
6014
  getRead(): boolean;
6015
+ /**
6016
+ * Gets current value of property {@link #getSelected selected}.
6017
+ *
6018
+ * Defines the selected state of the `ListItem`.
6019
+ *
6020
+ * Default value is `false`.
6021
+ *
6022
+ * @returns Value of property `selected`
6023
+ */
6024
+ getSelected(): boolean;
6000
6025
  /**
6001
6026
  * Gets current value of property {@link #getShowClose showClose}.
6002
6027
  *
@@ -6177,11 +6202,7 @@ declare namespace sap {
6177
6202
  /**
6178
6203
  * Sets a new value for property {@link #getPriority priority}.
6179
6204
  *
6180
- * Defines the `priority` of the item. Available options are:
6181
- * - `None`
6182
- * - `Low`
6183
- * - `Medium`
6184
- * - `High`
6205
+ * Defines the `priority` of the item.
6185
6206
  *
6186
6207
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6187
6208
  *
@@ -6214,6 +6235,23 @@ declare namespace sap {
6214
6235
  */
6215
6236
  bRead?: boolean
6216
6237
  ): this;
6238
+ /**
6239
+ * Sets a new value for property {@link #getSelected selected}.
6240
+ *
6241
+ * Defines the selected state of the `ListItem`.
6242
+ *
6243
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6244
+ *
6245
+ * Default value is `false`.
6246
+ *
6247
+ * @returns Reference to `this` in order to allow method chaining
6248
+ */
6249
+ setSelected(
6250
+ /**
6251
+ * New value for property `selected`
6252
+ */
6253
+ bSelected?: boolean
6254
+ ): this;
6217
6255
  /**
6218
6256
  * Sets a new value for property {@link #getShowClose showClose}.
6219
6257
  *
@@ -6540,11 +6578,7 @@ declare namespace sap {
6540
6578
  /**
6541
6579
  * Gets current value of property {@link #getPriority priority}.
6542
6580
  *
6543
- * Defines the `priority` of the item. Available options are:
6544
- * - `None`
6545
- * - `Low`
6546
- * - `Medium`
6547
- * - `High`
6581
+ * Defines the `priority` of the item.
6548
6582
  *
6549
6583
  * Default value is `None`.
6550
6584
  *
@@ -6563,6 +6597,16 @@ declare namespace sap {
6563
6597
  * @returns Value of property `read`
6564
6598
  */
6565
6599
  getRead(): boolean;
6600
+ /**
6601
+ * Gets current value of property {@link #getSelected selected}.
6602
+ *
6603
+ * Defines the selected state of the `ListItem`.
6604
+ *
6605
+ * Default value is `false`.
6606
+ *
6607
+ * @returns Value of property `selected`
6608
+ */
6609
+ getSelected(): boolean;
6566
6610
  /**
6567
6611
  * Gets current value of property {@link #getShowClose showClose}.
6568
6612
  *
@@ -6758,11 +6802,7 @@ declare namespace sap {
6758
6802
  /**
6759
6803
  * Sets a new value for property {@link #getPriority priority}.
6760
6804
  *
6761
- * Defines the `priority` of the item. Available options are:
6762
- * - `None`
6763
- * - `Low`
6764
- * - `Medium`
6765
- * - `High`
6805
+ * Defines the `priority` of the item.
6766
6806
  *
6767
6807
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6768
6808
  *
@@ -6795,6 +6835,23 @@ declare namespace sap {
6795
6835
  */
6796
6836
  bRead?: boolean
6797
6837
  ): this;
6838
+ /**
6839
+ * Sets a new value for property {@link #getSelected selected}.
6840
+ *
6841
+ * Defines the selected state of the `ListItem`.
6842
+ *
6843
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6844
+ *
6845
+ * Default value is `false`.
6846
+ *
6847
+ * @returns Reference to `this` in order to allow method chaining
6848
+ */
6849
+ setSelected(
6850
+ /**
6851
+ * New value for property `selected`
6852
+ */
6853
+ bSelected?: boolean
6854
+ ): this;
6798
6855
  /**
6799
6856
  * Sets a new value for property {@link #getShowClose showClose}.
6800
6857
  *
@@ -6869,6 +6926,13 @@ declare namespace sap {
6869
6926
  * the intended design you have to make sure that there is enough space for the `sap.ui.webc.fiori.Page`
6870
6927
  * to be rendered. **Note:** In order for the `sap.ui.webc.fiori.Page` to be displayed, the parent element
6871
6928
  * should have fixed height.
6929
+ *
6930
+ * CSS Shadow Parts:
6931
+ *
6932
+ * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/::part CSS Shadow Parts} allow developers to
6933
+ * style elements inside the Shadow DOM.
6934
+ * The `sap.ui.webc.fiori.Page` exposes the following CSS Shadow Parts:
6935
+ * - content - Used to style the content section of the component
6872
6936
  */
6873
6937
  class Page extends sap.ui.core.webc.WebComponent {
6874
6938
  /**
@@ -6968,10 +7032,7 @@ declare namespace sap {
6968
7032
  * **Note:** When a ui5-list is placed inside the page, we recommend using “List” to ensure better color
6969
7033
  * contrast.
6970
7034
  *
6971
- * Available options are:
6972
- * - `Solid` (default)
6973
- * - `Transparent`
6974
- * - `List`
7035
+ *
6975
7036
  *
6976
7037
  * Default value is `Solid`.
6977
7038
  *
@@ -7101,10 +7162,7 @@ declare namespace sap {
7101
7162
  * **Note:** When a ui5-list is placed inside the page, we recommend using “List” to ensure better color
7102
7163
  * contrast.
7103
7164
  *
7104
- * Available options are:
7105
- * - `Solid` (default)
7106
- * - `Transparent`
7107
- * - `List`
7165
+ *
7108
7166
  *
7109
7167
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7110
7168
  *
@@ -9031,6 +9089,8 @@ declare namespace sap {
9031
9089
  *
9032
9090
  * Defines the item text.
9033
9091
  *
9092
+ * **Note:** The text is only displayed inside the overflow popover list view.
9093
+ *
9034
9094
  * Default value is `empty string`.
9035
9095
  *
9036
9096
  * @returns Value of property `text`
@@ -9075,6 +9135,8 @@ declare namespace sap {
9075
9135
  *
9076
9136
  * Defines the item text.
9077
9137
  *
9138
+ * **Note:** The text is only displayed inside the overflow popover list view.
9139
+ *
9078
9140
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9079
9141
  *
9080
9142
  * Default value is `empty string`.
@@ -11021,10 +11083,7 @@ declare namespace sap {
11021
11083
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
11022
11084
  * otherwise it will be bound to this `sap.ui.webc.fiori.UploadCollection` itself.
11023
11085
  *
11024
- * Fired when the Delete button of any item is pressed.
11025
- *
11026
- * **Note:** A Delete button is displayed on each item, when the `sap.ui.webc.fiori.UploadCollection` `mode`
11027
- * property is set to `Delete`.
11086
+ * Fired when the delete button of any item is pressed.
11028
11087
  *
11029
11088
  * @returns Reference to `this` in order to allow method chaining
11030
11089
  */
@@ -11050,10 +11109,7 @@ declare namespace sap {
11050
11109
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
11051
11110
  * otherwise it will be bound to this `sap.ui.webc.fiori.UploadCollection` itself.
11052
11111
  *
11053
- * Fired when the Delete button of any item is pressed.
11054
- *
11055
- * **Note:** A Delete button is displayed on each item, when the `sap.ui.webc.fiori.UploadCollection` `mode`
11056
- * property is set to `Delete`.
11112
+ * Fired when the delete button of any item is pressed.
11057
11113
  *
11058
11114
  * @returns Reference to `this` in order to allow method chaining
11059
11115
  */
@@ -11274,12 +11330,8 @@ declare namespace sap {
11274
11330
  * Defines the mode of the `sap.ui.webc.fiori.UploadCollection`.
11275
11331
  *
11276
11332
  *
11277
- *
11278
- * **Note:**
11279
- * - `None`
11280
- * - `SingleSelect`
11281
- * - `MultiSelect`
11282
- * - `Delete`
11333
+ * **Note:** Mode "Delete" has no effect. The delete button is controlled by the `hideDeleteButton` property
11334
+ * of UploadCollectionItem
11283
11335
  *
11284
11336
  * Default value is `None`.
11285
11337
  *
@@ -11469,12 +11521,8 @@ declare namespace sap {
11469
11521
  * Defines the mode of the `sap.ui.webc.fiori.UploadCollection`.
11470
11522
  *
11471
11523
  *
11472
- *
11473
- * **Note:**
11474
- * - `None`
11475
- * - `SingleSelect`
11476
- * - `MultiSelect`
11477
- * - `Delete`
11524
+ * **Note:** Mode "Delete" has no effect. The delete button is controlled by the `hideDeleteButton` property
11525
+ * of UploadCollectionItem
11478
11526
  *
11479
11527
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
11480
11528
  *
@@ -11622,6 +11670,53 @@ declare namespace sap {
11622
11670
  */
11623
11671
  oContent: sap.ui.core.Control
11624
11672
  ): this;
11673
+ /**
11674
+ * Attaches event handler `fnFunction` to the {@link #event:detailClick detailClick} event of this `sap.ui.webc.fiori.UploadCollectionItem`.
11675
+ *
11676
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
11677
+ * otherwise it will be bound to this `sap.ui.webc.fiori.UploadCollectionItem` itself.
11678
+ *
11679
+ * Fired when the user clicks on the detail button when type is `Detail`.
11680
+ *
11681
+ * @returns Reference to `this` in order to allow method chaining
11682
+ */
11683
+ attachDetailClick(
11684
+ /**
11685
+ * An application-specific payload object that will be passed to the event handler along with the event
11686
+ * object when firing the event
11687
+ */
11688
+ oData: object,
11689
+ /**
11690
+ * The function to be called when the event occurs
11691
+ */
11692
+ fnFunction: (p1: sap.ui.base.Event) => void,
11693
+ /**
11694
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.UploadCollectionItem`
11695
+ * itself
11696
+ */
11697
+ oListener?: object
11698
+ ): this;
11699
+ /**
11700
+ * Attaches event handler `fnFunction` to the {@link #event:detailClick detailClick} event of this `sap.ui.webc.fiori.UploadCollectionItem`.
11701
+ *
11702
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
11703
+ * otherwise it will be bound to this `sap.ui.webc.fiori.UploadCollectionItem` itself.
11704
+ *
11705
+ * Fired when the user clicks on the detail button when type is `Detail`.
11706
+ *
11707
+ * @returns Reference to `this` in order to allow method chaining
11708
+ */
11709
+ attachDetailClick(
11710
+ /**
11711
+ * The function to be called when the event occurs
11712
+ */
11713
+ fnFunction: (p1: sap.ui.base.Event) => void,
11714
+ /**
11715
+ * Context object to call the event handler with. Defaults to this `sap.ui.webc.fiori.UploadCollectionItem`
11716
+ * itself
11717
+ */
11718
+ oListener?: object
11719
+ ): this;
11625
11720
  /**
11626
11721
  * Attaches event handler `fnFunction` to the {@link #event:fileNameClick fileNameClick} event of this `sap.ui.webc.fiori.UploadCollectionItem`.
11627
11722
  *
@@ -11834,12 +11929,35 @@ declare namespace sap {
11834
11929
  * @returns Reference to `this` in order to allow method chaining
11835
11930
  */
11836
11931
  destroyContent(): this;
11932
+ /**
11933
+ * Destroys the deleteButton in the aggregation {@link #getDeleteButton deleteButton}.
11934
+ *
11935
+ * @returns Reference to `this` in order to allow method chaining
11936
+ */
11937
+ destroyDeleteButton(): this;
11837
11938
  /**
11838
11939
  * Destroys the thumbnail in the aggregation {@link #getThumbnail thumbnail}.
11839
11940
  *
11840
11941
  * @returns Reference to `this` in order to allow method chaining
11841
11942
  */
11842
11943
  destroyThumbnail(): this;
11944
+ /**
11945
+ * Detaches event handler `fnFunction` from the {@link #event:detailClick detailClick} event of this `sap.ui.webc.fiori.UploadCollectionItem`.
11946
+ *
11947
+ * The passed function and listener object must match the ones used for event registration.
11948
+ *
11949
+ * @returns Reference to `this` in order to allow method chaining
11950
+ */
11951
+ detachDetailClick(
11952
+ /**
11953
+ * The function to be called, when the event occurs
11954
+ */
11955
+ fnFunction: (p1: sap.ui.base.Event) => void,
11956
+ /**
11957
+ * Context object on which the given function had to be called
11958
+ */
11959
+ oListener?: object
11960
+ ): this;
11843
11961
  /**
11844
11962
  * Detaches event handler `fnFunction` from the {@link #event:fileNameClick fileNameClick} event of this
11845
11963
  * `sap.ui.webc.fiori.UploadCollectionItem`.
@@ -11909,6 +12027,19 @@ declare namespace sap {
11909
12027
  */
11910
12028
  oListener?: object
11911
12029
  ): this;
12030
+ /**
12031
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
12032
+ *
12033
+ * Fires event {@link #event:detailClick detailClick} to attached listeners.
12034
+ *
12035
+ * @returns Reference to `this` in order to allow method chaining
12036
+ */
12037
+ fireDetailClick(
12038
+ /**
12039
+ * Parameters to pass along with the event
12040
+ */
12041
+ mParameters?: object
12042
+ ): this;
11912
12043
  /**
11913
12044
  * @ui5-protected Do not call from applications (only from related classes in the framework)
11914
12045
  *
@@ -11961,12 +12092,42 @@ declare namespace sap {
11961
12092
  */
11962
12093
  mParameters?: object
11963
12094
  ): this;
12095
+ /**
12096
+ * Gets current value of property {@link #getAccessibilityAttributes accessibilityAttributes}.
12097
+ *
12098
+ * An object of strings that defines several additional accessibility attribute values for customization
12099
+ * depending on the use case.
12100
+ *
12101
+ * It supports the following fields:
12102
+ *
12103
+ *
12104
+ * - `ariaSetsize`: Defines the number of items in the current set of listitems or treeitems when not
12105
+ * all items in the set are present in the DOM. The value of each `aria-setsize` is an integer reflecting
12106
+ * number of items in the complete set. **Note: ** If the size of the entire set is unknown, set `aria-setsize="-1"`.
12107
+ *
12108
+ * - `ariaPosinset`: Defines an element's number or position in the current set of listitems or treeitems
12109
+ * when not all items are present in the DOM. The value of each `aria-posinset` is an integer greater than
12110
+ * or equal to 1, and less than or equal to the size of the set when that size is known.
12111
+ *
12112
+ * Default value is `{}`.
12113
+ *
12114
+ * @returns Value of property `accessibilityAttributes`
12115
+ */
12116
+ getAccessibilityAttributes(): object;
11964
12117
  /**
11965
12118
  * Gets content of aggregation {@link #getContent content}.
11966
12119
  *
11967
12120
  * Hold the description of the `sap.ui.webc.fiori.UploadCollectionItem`. Will be shown below the file name.
11968
12121
  */
11969
12122
  getContent(): sap.ui.core.Control[];
12123
+ /**
12124
+ * Gets content of aggregation {@link #getDeleteButton deleteButton}.
12125
+ *
12126
+ * Defines the delete button, displayed in "Delete" mode. **Note:** While the slot allows custom buttons,
12127
+ * to match design guidelines, please use the `sap.ui.webc.main.Button` component. **Note:** When the slot
12128
+ * is not present, a built-in delete button will be displayed.
12129
+ */
12130
+ getDeleteButton(): sap.ui.webc.main.IButton;
11970
12131
  /**
11971
12132
  * Gets current value of property {@link #getDisableDeleteButton disableDeleteButton}.
11972
12133
  *
@@ -12005,6 +12166,17 @@ declare namespace sap {
12005
12166
  * @returns Value of property `fileNameClickable`
12006
12167
  */
12007
12168
  getFileNameClickable(): boolean;
12169
+ /**
12170
+ * Gets current value of property {@link #getHideDeleteButton hideDeleteButton}.
12171
+ *
12172
+ * By default, the delete button will always be shown, regardless of the `sap.ui.webc.fiori.UploadCollection`'s
12173
+ * property `mode`. Setting this property to `true` will hide the delete button.
12174
+ *
12175
+ * Default value is `false`.
12176
+ *
12177
+ * @returns Value of property `hideDeleteButton`
12178
+ */
12179
+ getHideDeleteButton(): boolean;
12008
12180
  /**
12009
12181
  * Gets current value of property {@link #getHideRetryButton hideRetryButton}.
12010
12182
  *
@@ -12025,6 +12197,15 @@ declare namespace sap {
12025
12197
  * @returns Value of property `hideTerminateButton`
12026
12198
  */
12027
12199
  getHideTerminateButton(): boolean;
12200
+ /**
12201
+ * Gets current value of property {@link #getNavigated navigated}.
12202
+ *
12203
+ * The navigated state of the list item. If set to `true`, a navigation indicator is displayed at the end
12204
+ * of the list item.
12205
+ *
12206
+ * @returns Value of property `navigated`
12207
+ */
12208
+ getNavigated(): boolean;
12028
12209
  /**
12029
12210
  * Gets current value of property {@link #getProgress progress}.
12030
12211
  *
@@ -12037,6 +12218,16 @@ declare namespace sap {
12037
12218
  * @returns Value of property `progress`
12038
12219
  */
12039
12220
  getProgress(): int;
12221
+ /**
12222
+ * Gets current value of property {@link #getSelected selected}.
12223
+ *
12224
+ * Defines the selected state of the `ListItem`.
12225
+ *
12226
+ * Default value is `false`.
12227
+ *
12228
+ * @returns Value of property `selected`
12229
+ */
12230
+ getSelected(): boolean;
12040
12231
  /**
12041
12232
  * Gets content of aggregation {@link #getThumbnail thumbnail}.
12042
12233
  *
@@ -12045,6 +12236,20 @@ declare namespace sap {
12045
12236
  * **Note:** Use `sap.ui.webc.main.Icon` or `img` for the intended design.
12046
12237
  */
12047
12238
  getThumbnail(): sap.ui.core.Control;
12239
+ /**
12240
+ * Gets current value of property {@link #getType type}.
12241
+ *
12242
+ * Defines the visual indication and behavior of the list items. Available options are `Active` (by default),
12243
+ * `Inactive`, `Detail` and `Navigation`.
12244
+ *
12245
+ * **Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and
12246
+ * hover, while with type `Inactive` and `Detail` - will not.
12247
+ *
12248
+ * Default value is `Active`.
12249
+ *
12250
+ * @returns Value of property `type`
12251
+ */
12252
+ getType(): sap.ui.webc.main.ListItemType;
12048
12253
  /**
12049
12254
  * Gets current value of property {@link #getUploadState uploadState}.
12050
12255
  *
@@ -12105,6 +12310,46 @@ declare namespace sap {
12105
12310
  */
12106
12311
  vContent: int | string | sap.ui.core.Control
12107
12312
  ): sap.ui.core.Control | null;
12313
+ /**
12314
+ * Sets a new value for property {@link #getAccessibilityAttributes accessibilityAttributes}.
12315
+ *
12316
+ * An object of strings that defines several additional accessibility attribute values for customization
12317
+ * depending on the use case.
12318
+ *
12319
+ * It supports the following fields:
12320
+ *
12321
+ *
12322
+ * - `ariaSetsize`: Defines the number of items in the current set of listitems or treeitems when not
12323
+ * all items in the set are present in the DOM. The value of each `aria-setsize` is an integer reflecting
12324
+ * number of items in the complete set. **Note: ** If the size of the entire set is unknown, set `aria-setsize="-1"`.
12325
+ *
12326
+ * - `ariaPosinset`: Defines an element's number or position in the current set of listitems or treeitems
12327
+ * when not all items are present in the DOM. The value of each `aria-posinset` is an integer greater than
12328
+ * or equal to 1, and less than or equal to the size of the set when that size is known.
12329
+ *
12330
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12331
+ *
12332
+ * Default value is `{}`.
12333
+ *
12334
+ * @returns Reference to `this` in order to allow method chaining
12335
+ */
12336
+ setAccessibilityAttributes(
12337
+ /**
12338
+ * New value for property `accessibilityAttributes`
12339
+ */
12340
+ oAccessibilityAttributes?: object
12341
+ ): this;
12342
+ /**
12343
+ * Sets the aggregated {@link #getDeleteButton deleteButton}.
12344
+ *
12345
+ * @returns Reference to `this` in order to allow method chaining
12346
+ */
12347
+ setDeleteButton(
12348
+ /**
12349
+ * The deleteButton to set
12350
+ */
12351
+ oDeleteButton: sap.ui.webc.main.IButton
12352
+ ): this;
12108
12353
  /**
12109
12354
  * Sets a new value for property {@link #getDisableDeleteButton disableDeleteButton}.
12110
12355
  *
@@ -12171,6 +12416,24 @@ declare namespace sap {
12171
12416
  */
12172
12417
  bFileNameClickable?: boolean
12173
12418
  ): this;
12419
+ /**
12420
+ * Sets a new value for property {@link #getHideDeleteButton hideDeleteButton}.
12421
+ *
12422
+ * By default, the delete button will always be shown, regardless of the `sap.ui.webc.fiori.UploadCollection`'s
12423
+ * property `mode`. Setting this property to `true` will hide the delete button.
12424
+ *
12425
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12426
+ *
12427
+ * Default value is `false`.
12428
+ *
12429
+ * @returns Reference to `this` in order to allow method chaining
12430
+ */
12431
+ setHideDeleteButton(
12432
+ /**
12433
+ * New value for property `hideDeleteButton`
12434
+ */
12435
+ bHideDeleteButton?: boolean
12436
+ ): this;
12174
12437
  /**
12175
12438
  * Sets a new value for property {@link #getHideRetryButton hideRetryButton}.
12176
12439
  *
@@ -12205,6 +12468,22 @@ declare namespace sap {
12205
12468
  */
12206
12469
  bHideTerminateButton?: boolean
12207
12470
  ): this;
12471
+ /**
12472
+ * Sets a new value for property {@link #getNavigated navigated}.
12473
+ *
12474
+ * The navigated state of the list item. If set to `true`, a navigation indicator is displayed at the end
12475
+ * of the list item.
12476
+ *
12477
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12478
+ *
12479
+ * @returns Reference to `this` in order to allow method chaining
12480
+ */
12481
+ setNavigated(
12482
+ /**
12483
+ * New value for property `navigated`
12484
+ */
12485
+ bNavigated: boolean
12486
+ ): this;
12208
12487
  /**
12209
12488
  * Sets a new value for property {@link #getProgress progress}.
12210
12489
  *
@@ -12224,6 +12503,23 @@ declare namespace sap {
12224
12503
  */
12225
12504
  iProgress?: int
12226
12505
  ): this;
12506
+ /**
12507
+ * Sets a new value for property {@link #getSelected selected}.
12508
+ *
12509
+ * Defines the selected state of the `ListItem`.
12510
+ *
12511
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12512
+ *
12513
+ * Default value is `false`.
12514
+ *
12515
+ * @returns Reference to `this` in order to allow method chaining
12516
+ */
12517
+ setSelected(
12518
+ /**
12519
+ * New value for property `selected`
12520
+ */
12521
+ bSelected?: boolean
12522
+ ): this;
12227
12523
  /**
12228
12524
  * Sets the aggregated {@link #getThumbnail thumbnail}.
12229
12525
  *
@@ -12235,6 +12531,27 @@ declare namespace sap {
12235
12531
  */
12236
12532
  oThumbnail: sap.ui.core.Control
12237
12533
  ): this;
12534
+ /**
12535
+ * Sets a new value for property {@link #getType type}.
12536
+ *
12537
+ * Defines the visual indication and behavior of the list items. Available options are `Active` (by default),
12538
+ * `Inactive`, `Detail` and `Navigation`.
12539
+ *
12540
+ * **Note:** When set to `Active` or `Navigation`, the item will provide visual response upon press and
12541
+ * hover, while with type `Inactive` and `Detail` - will not.
12542
+ *
12543
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
12544
+ *
12545
+ * Default value is `Active`.
12546
+ *
12547
+ * @returns Reference to `this` in order to allow method chaining
12548
+ */
12549
+ setType(
12550
+ /**
12551
+ * New value for property `type`
12552
+ */
12553
+ sType?: sap.ui.webc.main.ListItemType
12554
+ ): this;
12238
12555
  /**
12239
12556
  * Sets a new value for property {@link #getUploadState uploadState}.
12240
12557
  *
@@ -12715,10 +13032,22 @@ declare namespace sap {
12715
13032
  ): sap.ui.webc.fiori.ISortItem | null;
12716
13033
  /**
12717
13034
  * Sets a JavaScript object, as settings to the `sap.ui.webc.fiori.ViewSettingsDialog`. This method can
12718
- * be used after the dialog is initially open, as the dialog need to set its initial settings. The `sap.ui.webc.fiori.ViewSettingsDialog`
12719
- * throws an event called "before-open", this can be used as trigger point. The object should have the following
12720
- * format: ` {sortOrder: "Ascending", sortBy: "Name", filters: [{"Filter 1": ["Some filter 1", "Some filter
12721
- * 2"]}, {"Filter 2": ["Some filter 4"]}]} `
13035
+ * be used after the dialog is initially open, as the dialog needs to set its initial settings.
13036
+ * The `sap.ui.webc.fiori.ViewSettingsDialog` throws an event called "before-open", which can be used as
13037
+ * a trigger point.
13038
+ * The object should have the following format:
13039
+ *
13040
+ * ```javascript
13041
+ *
13042
+ * {
13043
+ * sortOrder: "Ascending",
13044
+ * sortBy: "Name",
13045
+ * filters: [
13046
+ * {"Filter 1": ["Some filter 1", "Some filter 2"]},
13047
+ * {"Filter 2": ["Some filter 4"]},
13048
+ * ]
13049
+ * }
13050
+ * ```
12722
13051
  */
12723
13052
  setConfirmedSettings(
12724
13053
  /**
@@ -14338,6 +14667,11 @@ declare namespace sap {
14338
14667
  UploadCollection
14339
14668
  >;
14340
14669
 
14670
+ type UploadCollectionItem$DetailClickEvent = sap.ui.base.Event<
14671
+ UploadCollectionItem$DetailClickEventParameters,
14672
+ UploadCollectionItem
14673
+ >;
14674
+
14341
14675
  type UploadCollectionItem$FileNameClickEvent = sap.ui.base.Event<
14342
14676
  UploadCollectionItem$FileNameClickEventParameters,
14343
14677
  UploadCollectionItem