@openui5/ts-types 1.112.2 → 1.113.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.112.2
1
+ // For Library Version: 1.113.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -233,6 +233,8 @@ declare namespace sap {
233
233
  oListener?: object
234
234
  ): this;
235
235
  /**
236
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
237
+ *
236
238
  * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
237
239
  *
238
240
  * @returns Reference to `this` in order to allow method chaining
@@ -598,6 +600,8 @@ declare namespace sap {
598
600
  oListener?: object
599
601
  ): this;
600
602
  /**
603
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
604
+ *
601
605
  * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
602
606
  *
603
607
  * @returns Reference to `this` in order to allow method chaining
@@ -1532,7 +1536,7 @@ declare namespace sap {
1532
1536
  | `{${string}}`;
1533
1537
 
1534
1538
  /**
1535
- * @deprecated (since 1.72) - Use the `extension` aggregation instead.
1539
+ * @deprecated (since 1.72) - Use, for example, a `sap.m.Title` control in the `extension` aggregation instead.
1536
1540
  *
1537
1541
  * Control or text of title section of the Table (if not set it will be hidden)
1538
1542
  */
@@ -1591,6 +1595,12 @@ declare namespace sap {
1591
1595
  * of rows can be defined with the {@link sap.ui.table.Table#setRowActionTemplate rowActionTemplate} aggregation
1592
1596
  * of the table. Furthermore, row-specific settings can be defined with the {@link sap.ui.table.Table#setRowSettingsTemplate
1593
1597
  * rowSettingsTemplate} aggregation of the table.
1598
+ *
1599
+ * **Note:** During the binding of rows, the (exact) count needs to be available in the table and has to
1600
+ * be requested. If the count is not requested, this may lead to unexpected behavior in the table, such
1601
+ * as scrolling, accessibility, or keyboard issues. Please refer to the documentation of the used model
1602
+ * for information on requesting the count, for example, {@link sap.ui.model.odata.v2.ODataModel} or {@link
1603
+ * sap.ui.model.odata.v4.ODataModel}.
1594
1604
  */
1595
1605
  rows?:
1596
1606
  | sap.ui.table.Row[]
@@ -2568,6 +2578,8 @@ declare namespace sap {
2568
2578
  iToIndex: int
2569
2579
  ): this;
2570
2580
  /**
2581
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2582
+ *
2571
2583
  * This function is used by some composite controls to force updating the AnalyticalInfo
2572
2584
  */
2573
2585
  resumeUpdateAnalyticalInfo(
@@ -2814,6 +2826,8 @@ declare namespace sap {
2814
2826
  bSumOnTop?: boolean
2815
2827
  ): this;
2816
2828
  /**
2829
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2830
+ *
2817
2831
  * This function is used by some composite controls to avoid updating the AnalyticalInfo when several column
2818
2832
  * are added to the table. In order to finally update the AnalyticalInfo and request data, resumeUpdateAnalyticalInfo
2819
2833
  * must be called.
@@ -2996,6 +3010,7 @@ declare namespace sap {
2996
3010
  ): this;
2997
3011
  /**
2998
3012
  * @SINCE 1.33.0
3013
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2999
3014
  *
3000
3015
  * Fires event {@link #event:columnMenuOpen columnMenuOpen} to attached listeners.
3001
3016
  *
@@ -3312,6 +3327,8 @@ declare namespace sap {
3312
3327
  */
3313
3328
  getTemplate(): sap.ui.core.Control | string;
3314
3329
  /**
3330
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
3331
+ *
3315
3332
  * Returns a template clone. It either finds an unused clone or clones a new one from the template.
3316
3333
  *
3317
3334
  * @returns Clone of the template, or `null` if no template is defined
@@ -3855,6 +3872,8 @@ declare namespace sap {
3855
3872
  sWidth?: sap.ui.core.CSSSize
3856
3873
  ): this;
3857
3874
  /**
3875
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
3876
+ *
3858
3877
  * Returns whether the column should be rendered.
3859
3878
  *
3860
3879
  * @returns Returns `true`, if the column should be rendered
@@ -4401,6 +4420,8 @@ declare namespace sap {
4401
4420
  oListener?: object
4402
4421
  ): this;
4403
4422
  /**
4423
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
4424
+ *
4404
4425
  * Fires event {@link #event:press press} to attached listeners.
4405
4426
  *
4406
4427
  * @returns Reference to `this` in order to allow method chaining
@@ -5822,7 +5843,7 @@ declare namespace sap {
5822
5843
  */
5823
5844
  destroyRowSettingsTemplate(): this;
5824
5845
  /**
5825
- * @deprecated (since 1.72) - Use the `extension` aggregation instead.
5846
+ * @deprecated (since 1.72) - Use, for example, a `sap.m.Title` control in the `extension` aggregation instead.
5826
5847
  *
5827
5848
  * Destroys the title in the aggregation {@link #getTitle title}.
5828
5849
  *
@@ -6186,6 +6207,7 @@ declare namespace sap {
6186
6207
  ): void;
6187
6208
  /**
6188
6209
  * @SINCE 1.54
6210
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6189
6211
  *
6190
6212
  * Fires event {@link #event:beforeOpenContextMenu beforeOpenContextMenu} to attached listeners.
6191
6213
  *
@@ -6215,6 +6237,7 @@ declare namespace sap {
6215
6237
  ): boolean;
6216
6238
  /**
6217
6239
  * @SINCE 1.37.0
6240
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6218
6241
  *
6219
6242
  * Fires event {@link #event:busyStateChanged busyStateChanged} to attached listeners.
6220
6243
  *
@@ -6233,6 +6256,7 @@ declare namespace sap {
6233
6256
  ): this;
6234
6257
  /**
6235
6258
  * @SINCE 1.21.0
6259
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6236
6260
  *
6237
6261
  * Fires event {@link #event:cellClick cellClick} to attached listeners.
6238
6262
  *
@@ -6276,6 +6300,7 @@ declare namespace sap {
6276
6300
  /**
6277
6301
  * @SINCE 1.21.0
6278
6302
  * @deprecated (since 1.54) - replaced by `beforeOpenContextMenu`.
6303
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6279
6304
  *
6280
6305
  * Fires event {@link #event:cellContextmenu cellContextmenu} to attached listeners.
6281
6306
  *
@@ -6318,6 +6343,7 @@ declare namespace sap {
6318
6343
  ): boolean;
6319
6344
  /**
6320
6345
  * @SINCE 1.21.0
6346
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6321
6347
  *
6322
6348
  * Fires event {@link #event:columnFreeze columnFreeze} to attached listeners.
6323
6349
  *
@@ -6338,6 +6364,8 @@ declare namespace sap {
6338
6364
  }
6339
6365
  ): boolean;
6340
6366
  /**
6367
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6368
+ *
6341
6369
  * Fires event {@link #event:columnMove columnMove} to attached listeners.
6342
6370
  *
6343
6371
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -6361,6 +6389,8 @@ declare namespace sap {
6361
6389
  }
6362
6390
  ): boolean;
6363
6391
  /**
6392
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6393
+ *
6364
6394
  * Fires event {@link #event:columnResize columnResize} to attached listeners.
6365
6395
  *
6366
6396
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -6384,6 +6414,8 @@ declare namespace sap {
6384
6414
  }
6385
6415
  ): boolean;
6386
6416
  /**
6417
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6418
+ *
6387
6419
  * Fires event {@link #event:columnSelect columnSelect} to attached listeners.
6388
6420
  *
6389
6421
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -6403,6 +6435,8 @@ declare namespace sap {
6403
6435
  }
6404
6436
  ): boolean;
6405
6437
  /**
6438
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6439
+ *
6406
6440
  * Fires event {@link #event:columnVisibility columnVisibility} to attached listeners.
6407
6441
  *
6408
6442
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -6427,6 +6461,7 @@ declare namespace sap {
6427
6461
  ): boolean;
6428
6462
  /**
6429
6463
  * @SINCE 1.23.0
6464
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6430
6465
  *
6431
6466
  * Fires event {@link #event:customFilter customFilter} to attached listeners.
6432
6467
  *
@@ -6448,6 +6483,8 @@ declare namespace sap {
6448
6483
  }
6449
6484
  ): this;
6450
6485
  /**
6486
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6487
+ *
6451
6488
  * Fires event {@link #event:filter filter} to attached listeners.
6452
6489
  *
6453
6490
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -6472,6 +6509,7 @@ declare namespace sap {
6472
6509
  ): boolean;
6473
6510
  /**
6474
6511
  * @SINCE 1.37.0
6512
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6475
6513
  *
6476
6514
  * Fires event {@link #event:firstVisibleRowChanged firstVisibleRowChanged} to attached listeners.
6477
6515
  *
@@ -6489,6 +6527,8 @@ declare namespace sap {
6489
6527
  }
6490
6528
  ): this;
6491
6529
  /**
6530
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6531
+ *
6492
6532
  * Fires event {@link #event:group group} to attached listeners.
6493
6533
  *
6494
6534
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -6509,6 +6549,7 @@ declare namespace sap {
6509
6549
  ): boolean;
6510
6550
  /**
6511
6551
  * @SINCE 1.60
6552
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6512
6553
  *
6513
6554
  * Fires event {@link #event:paste paste} to attached listeners.
6514
6555
  *
@@ -6530,6 +6571,8 @@ declare namespace sap {
6530
6571
  }
6531
6572
  ): boolean;
6532
6573
  /**
6574
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6575
+ *
6533
6576
  * Fires event {@link #event:rowSelectionChange rowSelectionChange} to attached listeners.
6534
6577
  *
6535
6578
  * @returns Reference to `this` in order to allow method chaining
@@ -6564,6 +6607,7 @@ declare namespace sap {
6564
6607
  ): this;
6565
6608
  /**
6566
6609
  * @SINCE 1.86
6610
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6567
6611
  *
6568
6612
  * Fires event {@link #event:rowsUpdated rowsUpdated} to attached listeners.
6569
6613
  *
@@ -6576,6 +6620,8 @@ declare namespace sap {
6576
6620
  mParameters?: object
6577
6621
  ): this;
6578
6622
  /**
6623
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6624
+ *
6579
6625
  * Fires event {@link #event:sort sort} to attached listeners.
6580
6626
  *
6581
6627
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
@@ -6605,8 +6651,8 @@ declare namespace sap {
6605
6651
  /**
6606
6652
  * Sets the focus to the stored focus DOM reference.
6607
6653
  *
6608
- * If {@param oFocusInfo.targetInfo} is of type {@type sap.ui.core.message.Message}, the focus will be set
6609
- * as accurately as possible according to the information provided by {@type sap.ui.core.message.Message}.
6654
+ * If `oFocusInfo.targetInfo` is of type {@link sap.ui.core.message.Message}, the focus will be set as accurately
6655
+ * as possible according to the information provided by {@link sap.ui.core.message.Message}.
6610
6656
  */
6611
6657
  focus(
6612
6658
  /**
@@ -7027,6 +7073,12 @@ declare namespace sap {
7027
7073
  * of rows can be defined with the {@link sap.ui.table.Table#setRowActionTemplate rowActionTemplate} aggregation
7028
7074
  * of the table. Furthermore, row-specific settings can be defined with the {@link sap.ui.table.Table#setRowSettingsTemplate
7029
7075
  * rowSettingsTemplate} aggregation of the table.
7076
+ *
7077
+ * **Note:** During the binding of rows, the (exact) count needs to be available in the table and has to
7078
+ * be requested. If the count is not requested, this may lead to unexpected behavior in the table, such
7079
+ * as scrolling, accessibility, or keyboard issues. Please refer to the documentation of the used model
7080
+ * for information on requesting the count, for example, {@link sap.ui.model.odata.v2.ODataModel} or {@link
7081
+ * sap.ui.model.odata.v4.ODataModel}.
7030
7082
  */
7031
7083
  getRows(): sap.ui.table.Row[];
7032
7084
  /**
@@ -7139,7 +7191,7 @@ declare namespace sap {
7139
7191
  */
7140
7192
  getThreshold(): int;
7141
7193
  /**
7142
- * @deprecated (since 1.72) - Use the `extension` aggregation instead.
7194
+ * @deprecated (since 1.72) - Use, for example, a `sap.m.Title` control in the `extension` aggregation instead.
7143
7195
  *
7144
7196
  * Gets content of aggregation {@link #getTitle title}.
7145
7197
  *
@@ -8048,7 +8100,7 @@ declare namespace sap {
8048
8100
  iThreshold: int
8049
8101
  ): this;
8050
8102
  /**
8051
- * @deprecated (since 1.72) - Use the `extension` aggregation instead.
8103
+ * @deprecated (since 1.72) - Use, for example, a `sap.m.Title` control in the `extension` aggregation instead.
8052
8104
  *
8053
8105
  * Sets the aggregated {@link #getTitle title}.
8054
8106
  *
@@ -8649,6 +8701,8 @@ declare namespace sap {
8649
8701
  iLevel: int
8650
8702
  ): this;
8651
8703
  /**
8704
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8705
+ *
8652
8706
  * Fires event {@link #event:toggleOpenState toggleOpenState} to attached listeners.
8653
8707
  *
8654
8708
  * @returns Reference to `this` in order to allow method chaining
@@ -9021,6 +9075,8 @@ declare namespace sap {
9021
9075
  iToIndex: int
9022
9076
  ): this;
9023
9077
  /**
9078
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9079
+ *
9024
9080
  * Allows to hide the tree structure (tree icons, indentation) in tree mode (property `useGroupMode` is
9025
9081
  * set to `false`).
9026
9082
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.112.2
1
+ // For Library Version: 1.113.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {