@openui5/ts-types 1.115.0 → 1.115.1

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,14 +1,14 @@
1
- // For Library Version: 1.115.0
1
+ // For Library Version: 1.115.1
2
2
 
3
3
  declare namespace sap {
4
4
  /**
5
- * @SINCE 1.36
5
+ * @since 1.36
6
6
  *
7
7
  * SAPUI5 library with controls specialized for administrative applications.
8
8
  */
9
9
  namespace tnt {
10
10
  /**
11
- * @SINCE 1.68
11
+ * @since 1.68
12
12
  *
13
13
  * Interface for controls suitable for the `header` aggregation of {@link sap.tnt.ToolPage}.
14
14
  */
@@ -70,7 +70,7 @@ declare namespace sap {
70
70
  | `{${string}}`;
71
71
 
72
72
  /**
73
- * @SINCE 1.74
73
+ * @since 1.74
74
74
  *
75
75
  * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
76
76
  * the icon font.
@@ -99,7 +99,7 @@ declare namespace sap {
99
99
  | `{${string}}`;
100
100
 
101
101
  /**
102
- * @SINCE 1.62.0
102
+ * @since 1.62.0
103
103
  *
104
104
  * Specifies the currently selected key.
105
105
  */
@@ -125,7 +125,7 @@ declare namespace sap {
125
125
  ariaLabelledBy?: Array<sap.ui.core.Control | string>;
126
126
 
127
127
  /**
128
- * @SINCE 1.52.0
128
+ * @since 1.52.0
129
129
  *
130
130
  * The currently selected `NavigationListItem`.
131
131
  */
@@ -135,7 +135,7 @@ declare namespace sap {
135
135
  * Fired when an item is selected.
136
136
  */
137
137
  itemSelect?: (
138
- oEvent: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
138
+ oEvent: sap.ui.base.Event<sap.tnt.NavigationList$ItemSelectEventParameters>
139
139
  ) => void;
140
140
  }
141
141
 
@@ -165,7 +165,7 @@ declare namespace sap {
165
165
  | `{${string}}`;
166
166
 
167
167
  /**
168
- * @SINCE 1.52
168
+ * @since 1.52
169
169
  *
170
170
  * Specifies if the item should be shown.
171
171
  */
@@ -205,7 +205,7 @@ declare namespace sap {
205
205
  * Fired when this item is selected.
206
206
  */
207
207
  select?: (
208
- oEvent: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
208
+ oEvent: sap.ui.base.Event<sap.tnt.NavigationListItem$SelectEventParameters>
209
209
  ) => void;
210
210
  }
211
211
 
@@ -219,14 +219,14 @@ declare namespace sap {
219
219
  | `{${string}}`;
220
220
 
221
221
  /**
222
- * @SINCE 1.62.0
222
+ * @since 1.62.0
223
223
  *
224
224
  * Specifies the currently selected key.
225
225
  */
226
226
  selectedKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
227
227
 
228
228
  /**
229
- * @SINCE 1.98
229
+ * @since 1.98
230
230
  *
231
231
  * Specifies an optional aria-label that can be used by the screen readers.
232
232
  */
@@ -248,7 +248,7 @@ declare namespace sap {
248
248
  footer?: sap.tnt.NavigationList;
249
249
 
250
250
  /**
251
- * @SINCE 1.52.0
251
+ * @since 1.52.0
252
252
  *
253
253
  * The selected `NavigationListItem`.
254
254
  */
@@ -258,7 +258,7 @@ declare namespace sap {
258
258
  * Fired when an item is selected.
259
259
  */
260
260
  itemSelect?: (
261
- oEvent: sap.ui.base.Event<sap.tnt.$SideNavigationItemSelectEventParameters>
261
+ oEvent: sap.ui.base.Event<sap.tnt.SideNavigation$ItemSelectEventParameters>
262
262
  ) => void;
263
263
  }
264
264
 
@@ -277,7 +277,7 @@ declare namespace sap {
277
277
  | `{${string}}`;
278
278
 
279
279
  /**
280
- * @SINCE 1.115
280
+ * @since 1.115
281
281
  *
282
282
  * Specifies the content background design.
283
283
  */
@@ -292,7 +292,7 @@ declare namespace sap {
292
292
  header?: sap.tnt.IToolHeader;
293
293
 
294
294
  /**
295
- * @SINCE 1.93
295
+ * @since 1.93
296
296
  *
297
297
  * The control to appear in the subheader area.
298
298
  */
@@ -313,21 +313,21 @@ declare namespace sap {
313
313
  | `{${string}}`;
314
314
  }
315
315
 
316
- interface $NavigationListItemSelectEventParameters {
316
+ interface NavigationList$ItemSelectEventParameters {
317
317
  /**
318
318
  * The selected item.
319
319
  */
320
320
  item?: sap.ui.core.Item;
321
321
  }
322
322
 
323
- interface $NavigationListItemSelectEventParameters {
323
+ interface NavigationListItem$SelectEventParameters {
324
324
  /**
325
325
  * The selected item.
326
326
  */
327
327
  item?: sap.ui.core.Item;
328
328
  }
329
329
 
330
- interface $SideNavigationItemSelectEventParameters {
330
+ interface SideNavigation$ItemSelectEventParameters {
331
331
  /**
332
332
  * The selected item.
333
333
  */
@@ -335,7 +335,7 @@ declare namespace sap {
335
335
  }
336
336
 
337
337
  /**
338
- * @SINCE 1.54
338
+ * @since 1.54
339
339
  *
340
340
  * The `InfoLabel` is a small non-interactive control which contains text information and non-semantic color
341
341
  * chosen from a list of predefined color schemes. It serves the purpose to attract the user attention to
@@ -462,7 +462,7 @@ declare namespace sap {
462
462
  */
463
463
  getDisplayOnly(): boolean;
464
464
  /**
465
- * @SINCE 1.74
465
+ * @since 1.74
466
466
  *
467
467
  * Gets current value of property {@link #getIcon icon}.
468
468
  *
@@ -554,7 +554,7 @@ declare namespace sap {
554
554
  bDisplayOnly?: boolean
555
555
  ): this;
556
556
  /**
557
- * @SINCE 1.74
557
+ * @since 1.74
558
558
  *
559
559
  * Sets a new value for property {@link #getIcon icon}.
560
560
  *
@@ -650,7 +650,7 @@ declare namespace sap {
650
650
  unbindText(): this;
651
651
  }
652
652
  /**
653
- * @SINCE 1.34
653
+ * @since 1.34
654
654
  *
655
655
  * The NavigationList control is an interactive control, which provides a choice of different items, ordered
656
656
  * as a list.
@@ -768,9 +768,7 @@ declare namespace sap {
768
768
  /**
769
769
  * The function to be called when the event occurs
770
770
  */
771
- fnFunction: (
772
- p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
773
- ) => void,
771
+ fnFunction: (p1: NavigationList$ItemSelectEvent) => void,
774
772
  /**
775
773
  * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
776
774
  */
@@ -790,9 +788,7 @@ declare namespace sap {
790
788
  /**
791
789
  * The function to be called when the event occurs
792
790
  */
793
- fnFunction: (
794
- p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
795
- ) => void,
791
+ fnFunction: (p1: NavigationList$ItemSelectEvent) => void,
796
792
  /**
797
793
  * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself
798
794
  */
@@ -815,16 +811,14 @@ declare namespace sap {
815
811
  /**
816
812
  * The function to be called, when the event occurs
817
813
  */
818
- fnFunction: (
819
- p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
820
- ) => void,
814
+ fnFunction: (p1: NavigationList$ItemSelectEvent) => void,
821
815
  /**
822
816
  * Context object on which the given function had to be called
823
817
  */
824
818
  oListener?: object
825
819
  ): this;
826
820
  /**
827
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
821
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
828
822
  *
829
823
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
830
824
  *
@@ -834,7 +828,7 @@ declare namespace sap {
834
828
  /**
835
829
  * Parameters to pass along with the event
836
830
  */
837
- mParameters?: sap.tnt.$NavigationListItemSelectEventParameters
831
+ mParameters?: sap.tnt.NavigationList$ItemSelectEventParameters
838
832
  ): this;
839
833
  /**
840
834
  * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
@@ -867,7 +861,7 @@ declare namespace sap {
867
861
  */
868
862
  getSelectedItem(): sap.tnt.NavigationListItem | null;
869
863
  /**
870
- * @SINCE 1.62.0
864
+ * @since 1.62.0
871
865
  *
872
866
  * Gets current value of property {@link #getSelectedKey selectedKey}.
873
867
  *
@@ -1022,7 +1016,7 @@ declare namespace sap {
1022
1016
  ): this;
1023
1017
  }
1024
1018
  /**
1025
- * @SINCE 1.34
1019
+ * @since 1.34
1026
1020
  *
1027
1021
  * The NavigationListItem control represents an action, which can be selected by the user. It can provide
1028
1022
  * sub items.
@@ -1118,9 +1112,7 @@ declare namespace sap {
1118
1112
  /**
1119
1113
  * The function to be called when the event occurs
1120
1114
  */
1121
- fnFunction: (
1122
- p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
1123
- ) => void,
1115
+ fnFunction: (p1: NavigationListItem$SelectEvent) => void,
1124
1116
  /**
1125
1117
  * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
1126
1118
  */
@@ -1140,9 +1132,7 @@ declare namespace sap {
1140
1132
  /**
1141
1133
  * The function to be called when the event occurs
1142
1134
  */
1143
- fnFunction: (
1144
- p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
1145
- ) => void,
1135
+ fnFunction: (p1: NavigationListItem$SelectEvent) => void,
1146
1136
  /**
1147
1137
  * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
1148
1138
  */
@@ -1165,16 +1155,14 @@ declare namespace sap {
1165
1155
  /**
1166
1156
  * The function to be called, when the event occurs
1167
1157
  */
1168
- fnFunction: (
1169
- p1: sap.ui.base.Event<sap.tnt.$NavigationListItemSelectEventParameters>
1170
- ) => void,
1158
+ fnFunction: (p1: NavigationListItem$SelectEvent) => void,
1171
1159
  /**
1172
1160
  * Context object on which the given function had to be called
1173
1161
  */
1174
1162
  oListener?: object
1175
1163
  ): this;
1176
1164
  /**
1177
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1165
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1178
1166
  *
1179
1167
  * Fires event {@link #event:select select} to attached listeners.
1180
1168
  *
@@ -1184,7 +1172,7 @@ declare namespace sap {
1184
1172
  /**
1185
1173
  * Parameters to pass along with the event
1186
1174
  */
1187
- mParameters?: sap.tnt.$NavigationListItemSelectEventParameters
1175
+ mParameters?: sap.tnt.NavigationListItem$SelectEventParameters
1188
1176
  ): this;
1189
1177
  /**
1190
1178
  * Gets current value of property {@link #getExpanded expanded}.
@@ -1197,7 +1185,7 @@ declare namespace sap {
1197
1185
  */
1198
1186
  getExpanded(): boolean;
1199
1187
  /**
1200
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1188
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1201
1189
  *
1202
1190
  * Returns the DOM Element that should get the focus.
1203
1191
  *
@@ -1252,7 +1240,7 @@ declare namespace sap {
1252
1240
  */
1253
1241
  getTarget(): string;
1254
1242
  /**
1255
- * @SINCE 1.52
1243
+ * @since 1.52
1256
1244
  *
1257
1245
  * Gets current value of property {@link #getVisible visible}.
1258
1246
  *
@@ -1398,7 +1386,7 @@ declare namespace sap {
1398
1386
  sTarget?: string
1399
1387
  ): this;
1400
1388
  /**
1401
- * @SINCE 1.52
1389
+ * @since 1.52
1402
1390
  *
1403
1391
  * Sets a new value for property {@link #getVisible visible}.
1404
1392
  *
@@ -1418,7 +1406,7 @@ declare namespace sap {
1418
1406
  ): this;
1419
1407
  }
1420
1408
  /**
1421
- * @SINCE 1.34
1409
+ * @since 1.34
1422
1410
  *
1423
1411
  * The SideNavigation control is a container, which consists of flexible and fixed parts on top of each
1424
1412
  * other. Responsive Behavior:
@@ -1510,9 +1498,7 @@ declare namespace sap {
1510
1498
  /**
1511
1499
  * The function to be called when the event occurs
1512
1500
  */
1513
- fnFunction: (
1514
- p1: sap.ui.base.Event<sap.tnt.$SideNavigationItemSelectEventParameters>
1515
- ) => void,
1501
+ fnFunction: (p1: SideNavigation$ItemSelectEvent) => void,
1516
1502
  /**
1517
1503
  * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
1518
1504
  */
@@ -1532,9 +1518,7 @@ declare namespace sap {
1532
1518
  /**
1533
1519
  * The function to be called when the event occurs
1534
1520
  */
1535
- fnFunction: (
1536
- p1: sap.ui.base.Event<sap.tnt.$SideNavigationItemSelectEventParameters>
1537
- ) => void,
1521
+ fnFunction: (p1: SideNavigation$ItemSelectEvent) => void,
1538
1522
  /**
1539
1523
  * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself
1540
1524
  */
@@ -1583,16 +1567,14 @@ declare namespace sap {
1583
1567
  /**
1584
1568
  * The function to be called, when the event occurs
1585
1569
  */
1586
- fnFunction: (
1587
- p1: sap.ui.base.Event<sap.tnt.$SideNavigationItemSelectEventParameters>
1588
- ) => void,
1570
+ fnFunction: (p1: SideNavigation$ItemSelectEvent) => void,
1589
1571
  /**
1590
1572
  * Context object on which the given function had to be called
1591
1573
  */
1592
1574
  oListener?: object
1593
1575
  ): this;
1594
1576
  /**
1595
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1577
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1596
1578
  *
1597
1579
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
1598
1580
  *
@@ -1602,10 +1584,10 @@ declare namespace sap {
1602
1584
  /**
1603
1585
  * Parameters to pass along with the event
1604
1586
  */
1605
- mParameters?: sap.tnt.$SideNavigationItemSelectEventParameters
1587
+ mParameters?: sap.tnt.SideNavigation$ItemSelectEventParameters
1606
1588
  ): this;
1607
1589
  /**
1608
- * @SINCE 1.98
1590
+ * @since 1.98
1609
1591
  *
1610
1592
  * Gets current value of property {@link #getAriaLabel ariaLabel}.
1611
1593
  *
@@ -1643,14 +1625,14 @@ declare namespace sap {
1643
1625
  */
1644
1626
  getItem(): sap.tnt.NavigationList;
1645
1627
  /**
1646
- * @SINCE 1.52.0
1628
+ * @since 1.52.0
1647
1629
  *
1648
1630
  * ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
1649
1631
  * or `null`.
1650
1632
  */
1651
1633
  getSelectedItem(): sap.ui.core.ID;
1652
1634
  /**
1653
- * @SINCE 1.62.0
1635
+ * @since 1.62.0
1654
1636
  *
1655
1637
  * Gets current value of property {@link #getSelectedKey selectedKey}.
1656
1638
  *
@@ -1660,7 +1642,7 @@ declare namespace sap {
1660
1642
  */
1661
1643
  getSelectedKey(): string;
1662
1644
  /**
1663
- * @SINCE 1.98
1645
+ * @since 1.98
1664
1646
  *
1665
1647
  * Sets a new value for property {@link #getAriaLabel ariaLabel}.
1666
1648
  *
@@ -1750,7 +1732,7 @@ declare namespace sap {
1750
1732
  unbindItem(): this;
1751
1733
  }
1752
1734
  /**
1753
- * @SINCE 1.34
1735
+ * @since 1.34
1754
1736
  *
1755
1737
  * The ToolHeader control is a horizontal container that is most commonly used to display buttons, texts,
1756
1738
  * and other various input controls. Overview: The ToolHeader control is based on {@link sap.m.OverflowToolbar}.
@@ -1863,7 +1845,7 @@ declare namespace sap {
1863
1845
  static getMetadata(): sap.ui.core.ElementMetadata;
1864
1846
  }
1865
1847
  /**
1866
- * @SINCE 1.16
1848
+ * @since 1.16
1867
1849
  *
1868
1850
  * The ToolHeaderUtilitySeparator control is used in the sap.tnt.ToolHeader control to specify where the
1869
1851
  * overflow button is placed.
@@ -1937,7 +1919,7 @@ declare namespace sap {
1937
1919
  static getMetadata(): sap.ui.core.ElementMetadata;
1938
1920
  }
1939
1921
  /**
1940
- * @SINCE 1.34
1922
+ * @since 1.34
1941
1923
  *
1942
1924
  * The ToolPage is a layout control, used to create a basic tools app that has a header, side navigation
1943
1925
  * and contents area. Overview: The control has three main areas - a header on top, navigation to the side
@@ -2036,7 +2018,7 @@ declare namespace sap {
2036
2018
  */
2037
2019
  destroySideContent(): this;
2038
2020
  /**
2039
- * @SINCE 1.93
2021
+ * @since 1.93
2040
2022
  *
2041
2023
  * Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
2042
2024
  *
@@ -2044,7 +2026,7 @@ declare namespace sap {
2044
2026
  */
2045
2027
  destroySubHeader(): this;
2046
2028
  /**
2047
- * @SINCE 1.115
2029
+ * @since 1.115
2048
2030
  *
2049
2031
  * Gets current value of property {@link #getContentBackgroundDesign contentBackgroundDesign}.
2050
2032
  *
@@ -2084,7 +2066,7 @@ declare namespace sap {
2084
2066
  */
2085
2067
  getSideExpanded(): boolean;
2086
2068
  /**
2087
- * @SINCE 1.93
2069
+ * @since 1.93
2088
2070
  *
2089
2071
  * Gets content of aggregation {@link #getSubHeader subHeader}.
2090
2072
  *
@@ -2140,7 +2122,7 @@ declare namespace sap {
2140
2122
  vMainContent: int | string | sap.ui.core.Control
2141
2123
  ): sap.ui.core.Control | null;
2142
2124
  /**
2143
- * @SINCE 1.115
2125
+ * @since 1.115
2144
2126
  *
2145
2127
  * Sets a new value for property {@link #getContentBackgroundDesign contentBackgroundDesign}.
2146
2128
  *
@@ -2192,7 +2174,7 @@ declare namespace sap {
2192
2174
  bSideExpanded: boolean
2193
2175
  ): this;
2194
2176
  /**
2195
- * @SINCE 1.93
2177
+ * @since 1.93
2196
2178
  *
2197
2179
  * Sets the aggregated {@link #getSubHeader subHeader}.
2198
2180
  *
@@ -2224,6 +2206,18 @@ declare namespace sap {
2224
2206
  */
2225
2207
  Narrow = "Narrow",
2226
2208
  }
2209
+
2210
+ type NavigationList$ItemSelectEvent = sap.ui.base.Event<NavigationList$ItemSelectEventParameters>;
2211
+
2212
+ type NavigationListItem$SelectEvent = sap.ui.base.Event<NavigationListItem$SelectEventParameters>;
2213
+
2214
+ /**
2215
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'SideNavigation$ItemSelectEventParameters'
2216
+ * in 1.115.1 and any later releases.
2217
+ */
2218
+ type $SideNavigationItemSelectEventParameters = sap.tnt.SideNavigation$ItemSelectEventParameters;
2219
+
2220
+ type SideNavigation$ItemSelectEvent = sap.ui.base.Event<SideNavigation$ItemSelectEventParameters>;
2227
2221
  }
2228
2222
 
2229
2223
  interface IUI5DefineDependencyNames {