@openui5/ts-types 1.117.0 → 1.118.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,9 +1,8 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  /**
5
5
  * @since 1.83
6
- * @experimental (since 1.83)
7
6
  *
8
7
  * Starts UI adaptation, initiated for an application at the passed root control instance. With this API
9
8
  * you are also able to modify the UI adaptation plugins list and or add some event handler functions to
@@ -57,7 +56,6 @@ declare module "sap/ui/rta/api/startAdaptation" {
57
56
  declare module "sap/ui/rta/api/startKeyUserAdaptation" {
58
57
  /**
59
58
  * @since 1.71
60
- * @experimental (since 1.71)
61
59
  *
62
60
  * Starts key user adaptation, initiated for an application at the passed root control instance. It subsequently
63
61
  * extends to all valid child controls.
@@ -83,7 +81,6 @@ declare namespace sap {
83
81
  namespace enablement {
84
82
  /**
85
83
  * @since 1.77
86
- * @experimental (since 1.77)
87
84
  *
88
85
  * sap.ui.fl Delegate to be used in elementActionTests.
89
86
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -712,6 +712,16 @@ declare namespace sap {
712
712
  | Function
713
713
  | sap.ui.base.ManagedObject.PropertyBindingInfo
714
714
  | `{${string}}`;
715
+
716
+ /**
717
+ * @since 1.118
718
+ *
719
+ * Indicates if the column is grouped.
720
+ */
721
+ grouped?:
722
+ | boolean
723
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
724
+ | `{${string}}`;
715
725
  }
716
726
 
717
727
  interface $AnalyticalColumnMenuSettings
@@ -837,6 +847,13 @@ declare namespace sap {
837
847
  | boolean
838
848
  | sap.ui.base.ManagedObject.PropertyBindingInfo
839
849
  | `{${string}}`;
850
+
851
+ /**
852
+ * @since 1.118
853
+ *
854
+ * Fired when the table is grouped.
855
+ */
856
+ group?: (oEvent: AnalyticalTable$GroupEvent) => void;
840
857
  }
841
858
 
842
859
  interface $ColumnSettings extends sap.ui.core.$ElementSettings {
@@ -995,6 +1012,8 @@ declare namespace sap {
995
1012
  | `{${string}}`;
996
1013
 
997
1014
  /**
1015
+ * @deprecated (since 1.118)
1016
+ *
998
1017
  * Indicates if the column is grouped.
999
1018
  */
1000
1019
  grouped?:
@@ -1070,6 +1089,8 @@ declare namespace sap {
1070
1089
  * Label of the column which is displayed in the column header. This aggregation is for the standard behavior,
1071
1090
  * where you only want to display one single row header. If a string is supplied, a default label control
1072
1091
  * will be created. Which control this is depends on the loaded libraries.
1092
+ *
1093
+ * **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control` instead.
1073
1094
  */
1074
1095
  label?:
1075
1096
  | string
@@ -1098,6 +1119,8 @@ declare namespace sap {
1098
1119
  * in the documentation for more details. While it is technically possible to also use other controls, doing
1099
1120
  * so might lead to issues with regards to scrolling, alignment, condensed mode, screen reader support,
1100
1121
  * and keyboard support.
1122
+ *
1123
+ * **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control` instead.
1101
1124
  */
1102
1125
  template?:
1103
1126
  | string
@@ -1487,8 +1510,6 @@ declare namespace sap {
1487
1510
  /**
1488
1511
  * Number of rows that are fix on the top. When you use a vertical scrollbar, only the rows which are not
1489
1512
  * fixed, will scroll.
1490
- *
1491
- * This property is only supported if the `rows` aggregation is bound to a {@link sap.ui.model.ClientModel client model}.
1492
1513
  */
1493
1514
  fixedRowCount?:
1494
1515
  | int
@@ -1500,8 +1521,6 @@ declare namespace sap {
1500
1521
  *
1501
1522
  * Number of rows that are fix on the bottom. When you use a vertical scrollbar, only the rows which are
1502
1523
  * not fixed, will scroll.
1503
- *
1504
- * This property is only supported if the `rows` aggregation is bound to a {@link sap.ui.model.ClientModel client model}.
1505
1524
  */
1506
1525
  fixedBottomRowCount?:
1507
1526
  | int
@@ -1607,7 +1626,9 @@ declare namespace sap {
1607
1626
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
1608
1627
 
1609
1628
  /**
1610
- * Control or text of footer section of the Table (if not set it will be hidden)
1629
+ * Control or text of footer section of the Table (if not set it will be hidden).
1630
+ *
1631
+ * **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control` instead.
1611
1632
  */
1612
1633
  footer?:
1613
1634
  | string
@@ -1723,6 +1744,7 @@ declare namespace sap {
1723
1744
  | `{${string}}`;
1724
1745
 
1725
1746
  /**
1747
+ * @deprecated (since 1.110)
1726
1748
  * @experimental (since 1.28) - This feature has a limited functionality.
1727
1749
  *
1728
1750
  * The column by which the table is grouped. Grouping will only be performed if `enableGrouping` is set
@@ -1776,6 +1798,8 @@ declare namespace sap {
1776
1798
  filter?: (oEvent: Table$FilterEvent) => void;
1777
1799
 
1778
1800
  /**
1801
+ * @deprecated (since 1.118)
1802
+ *
1779
1803
  * fired when the table is grouped (experimental!).
1780
1804
  */
1781
1805
  group?: (oEvent: Table$GroupEvent) => void;
@@ -2017,6 +2041,9 @@ declare namespace sap {
2017
2041
  toggleOpenState?: (oEvent: TreeTable$ToggleOpenStateEvent) => void;
2018
2042
  }
2019
2043
 
2044
+ interface AnalyticalTable$GroupEventParameters
2045
+ extends sap.ui.table.Table$GroupEventParameters {}
2046
+
2020
2047
  interface Column$ColumnMenuOpenEventParameters {
2021
2048
  /**
2022
2049
  * Refence to the selected `menu` instance to be opened.
@@ -2351,6 +2378,18 @@ declare namespace sap {
2351
2378
  * @returns Metadata object describing this class
2352
2379
  */
2353
2380
  static getMetadata(): sap.ui.core.ElementMetadata;
2381
+ /**
2382
+ * @since 1.118
2383
+ *
2384
+ * Gets current value of property {@link #getGrouped grouped}.
2385
+ *
2386
+ * Indicates if the column is grouped.
2387
+ *
2388
+ * Default value is `false`.
2389
+ *
2390
+ * @returns Value of property `grouped`
2391
+ */
2392
+ getGrouped(): boolean;
2354
2393
  /**
2355
2394
  * Gets current value of property {@link #getGroupHeaderFormatter groupHeaderFormatter}.
2356
2395
  *
@@ -2400,6 +2439,25 @@ declare namespace sap {
2400
2439
  * @returns Value of property `summed`
2401
2440
  */
2402
2441
  getSummed(): boolean;
2442
+ /**
2443
+ * @since 1.118
2444
+ *
2445
+ * Sets a new value for property {@link #getGrouped grouped}.
2446
+ *
2447
+ * Indicates if the column is grouped.
2448
+ *
2449
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2450
+ *
2451
+ * Default value is `false`.
2452
+ *
2453
+ * @returns Reference to `this` in order to allow method chaining
2454
+ */
2455
+ setGrouped(
2456
+ /**
2457
+ * New value for property `grouped`
2458
+ */
2459
+ bGrouped?: boolean
2460
+ ): this;
2403
2461
  /**
2404
2462
  * Sets a new value for property {@link #getGroupHeaderFormatter groupHeaderFormatter}.
2405
2463
  *
@@ -2654,6 +2712,55 @@ declare namespace sap {
2654
2712
  */
2655
2713
  iToIndex: int
2656
2714
  ): this;
2715
+ /**
2716
+ * @since 1.118
2717
+ *
2718
+ * Attaches event handler `fnFunction` to the {@link #event:group group} event of this `sap.ui.table.AnalyticalTable`.
2719
+ *
2720
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2721
+ * otherwise it will be bound to this `sap.ui.table.AnalyticalTable` itself.
2722
+ *
2723
+ * Fired when the table is grouped.
2724
+ *
2725
+ * @returns Reference to `this` in order to allow method chaining
2726
+ */
2727
+ attachGroup(
2728
+ /**
2729
+ * An application-specific payload object that will be passed to the event handler along with the event
2730
+ * object when firing the event
2731
+ */
2732
+ oData: object,
2733
+ /**
2734
+ * The function to be called when the event occurs
2735
+ */
2736
+ fnFunction: (p1: AnalyticalTable$GroupEvent) => void,
2737
+ /**
2738
+ * Context object to call the event handler with. Defaults to this `sap.ui.table.AnalyticalTable` itself
2739
+ */
2740
+ oListener?: object
2741
+ ): this;
2742
+ /**
2743
+ * @since 1.118
2744
+ *
2745
+ * Attaches event handler `fnFunction` to the {@link #event:group group} event of this `sap.ui.table.AnalyticalTable`.
2746
+ *
2747
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2748
+ * otherwise it will be bound to this `sap.ui.table.AnalyticalTable` itself.
2749
+ *
2750
+ * Fired when the table is grouped.
2751
+ *
2752
+ * @returns Reference to `this` in order to allow method chaining
2753
+ */
2754
+ attachGroup(
2755
+ /**
2756
+ * The function to be called when the event occurs
2757
+ */
2758
+ fnFunction: (p1: AnalyticalTable$GroupEvent) => void,
2759
+ /**
2760
+ * Context object to call the event handler with. Defaults to this `sap.ui.table.AnalyticalTable` itself
2761
+ */
2762
+ oListener?: object
2763
+ ): this;
2657
2764
  /**
2658
2765
  * Collapses one or more rows.
2659
2766
  *
@@ -2671,6 +2778,25 @@ declare namespace sap {
2671
2778
  * @returns Reference to `this` in order to allow method chaining
2672
2779
  */
2673
2780
  collapseAll(): this;
2781
+ /**
2782
+ * @since 1.118
2783
+ *
2784
+ * Detaches event handler `fnFunction` from the {@link #event:group group} event of this `sap.ui.table.AnalyticalTable`.
2785
+ *
2786
+ * The passed function and listener object must match the ones used for event registration.
2787
+ *
2788
+ * @returns Reference to `this` in order to allow method chaining
2789
+ */
2790
+ detachGroup(
2791
+ /**
2792
+ * The function to be called, when the event occurs
2793
+ */
2794
+ fnFunction: (p1: AnalyticalTable$GroupEvent) => void,
2795
+ /**
2796
+ * Context object on which the given function had to be called
2797
+ */
2798
+ oListener?: object
2799
+ ): this;
2674
2800
  /**
2675
2801
  * Expands one or more rows.
2676
2802
  *
@@ -2692,6 +2818,23 @@ declare namespace sap {
2692
2818
  * @returns Reference to `this` in order to allow method chaining
2693
2819
  */
2694
2820
  expandAll(): this;
2821
+ /**
2822
+ * @since 1.118
2823
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2824
+ *
2825
+ * Fires event {@link #event:group group} to attached listeners.
2826
+ *
2827
+ * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
2828
+ * event object. The return value of this method indicates whether the default action should be executed.
2829
+ *
2830
+ * @returns Whether or not to prevent the default action
2831
+ */
2832
+ fireGroup(
2833
+ /**
2834
+ * Parameters to pass along with the event
2835
+ */
2836
+ mParameters?: sap.ui.table.AnalyticalTable$GroupEventParameters
2837
+ ): boolean;
2695
2838
  /**
2696
2839
  * @deprecated (since 1.44) - replaced by the `autoExpandMode` binding parameter
2697
2840
  *
@@ -2760,17 +2903,6 @@ declare namespace sap {
2760
2903
  * @returns Value of property `columnVisibilityMenuSorter`
2761
2904
  */
2762
2905
  getColumnVisibilityMenuSorter(): any;
2763
- /**
2764
- * Returns the context of a row by its index.
2765
- *
2766
- * @returns The context of a row by its index
2767
- */
2768
- getContextByIndex(
2769
- /**
2770
- * Index of the row to return the context from.
2771
- */
2772
- iIndex: int
2773
- ): sap.ui.model.Context;
2774
2906
  /**
2775
2907
  * @deprecated (since 1.21.2) - replaced by {@link sap.ui.table.Table#setShowOverlay}
2776
2908
  *
@@ -3486,6 +3618,8 @@ declare namespace sap {
3486
3618
  */
3487
3619
  getFlexible(): boolean;
3488
3620
  /**
3621
+ * @deprecated (since 1.118)
3622
+ *
3489
3623
  * Gets current value of property {@link #getGrouped grouped}.
3490
3624
  *
3491
3625
  * Indicates if the column is grouped.
@@ -3534,6 +3668,8 @@ declare namespace sap {
3534
3668
  * Label of the column which is displayed in the column header. This aggregation is for the standard behavior,
3535
3669
  * where you only want to display one single row header. If a string is supplied, a default label control
3536
3670
  * will be created. Which control this is depends on the loaded libraries.
3671
+ *
3672
+ * **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control` instead.
3537
3673
  */
3538
3674
  getLabel(): sap.ui.core.Control | string;
3539
3675
  /**
@@ -3666,6 +3802,8 @@ declare namespace sap {
3666
3802
  * in the documentation for more details. While it is technically possible to also use other controls, doing
3667
3803
  * so might lead to issues with regards to scrolling, alignment, condensed mode, screen reader support,
3668
3804
  * and keyboard support.
3805
+ *
3806
+ * **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control` instead.
3669
3807
  */
3670
3808
  getTemplate(): sap.ui.core.Control | string;
3671
3809
  /**
@@ -3920,6 +4058,8 @@ declare namespace sap {
3920
4058
  bFlexible?: boolean
3921
4059
  ): this;
3922
4060
  /**
4061
+ * @deprecated (since 1.118)
4062
+ *
3923
4063
  * Sets a new value for property {@link #getGrouped grouped}.
3924
4064
  *
3925
4065
  * Indicates if the column is grouped.
@@ -5822,6 +5962,8 @@ declare namespace sap {
5822
5962
  oListener?: object
5823
5963
  ): this;
5824
5964
  /**
5965
+ * @deprecated (since 1.118)
5966
+ *
5825
5967
  * Attaches event handler `fnFunction` to the {@link #event:group group} event of this `sap.ui.table.Table`.
5826
5968
  *
5827
5969
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -5847,6 +5989,8 @@ declare namespace sap {
5847
5989
  oListener?: object
5848
5990
  ): this;
5849
5991
  /**
5992
+ * @deprecated (since 1.118)
5993
+ *
5850
5994
  * Attaches event handler `fnFunction` to the {@link #event:group group} event of this `sap.ui.table.Table`.
5851
5995
  *
5852
5996
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
@@ -6423,6 +6567,8 @@ declare namespace sap {
6423
6567
  oListener?: object
6424
6568
  ): this;
6425
6569
  /**
6570
+ * @deprecated (since 1.118)
6571
+ *
6426
6572
  * Detaches event handler `fnFunction` from the {@link #event:group group} event of this `sap.ui.table.Table`.
6427
6573
  *
6428
6574
  * The passed function and listener object must match the ones used for event registration.
@@ -6738,6 +6884,7 @@ declare namespace sap {
6738
6884
  mParameters?: sap.ui.table.Table$FirstVisibleRowChangedEventParameters
6739
6885
  ): this;
6740
6886
  /**
6887
+ * @deprecated (since 1.118)
6741
6888
  * @ui5-protected Do not call from applications (only from related classes in the framework)
6742
6889
  *
6743
6890
  * Fires event {@link #event:group group} to attached listeners.
@@ -6897,14 +7044,14 @@ declare namespace sap {
6897
7044
  getColumns(): sap.ui.table.Column[];
6898
7045
  /**
6899
7046
  * Returns the context of a row by its index. Please note that for server-based models like OData, the supplied
6900
- * index might not have been loaded yet. If the context is not available at the client, the binding will
7047
+ * index might not have been loaded yet. If the context is not available at the client, the binding may
6901
7048
  * trigger a backend request and request this single context. Although this API looks synchronous it may
6902
7049
  * not return a context but load it and fire a change event on the binding.
6903
7050
  *
6904
7051
  * For server-based models you should consider to only make this API call when the index is within the currently
6905
7052
  * visible scroll area.
6906
7053
  *
6907
- * @returns The context at this index or `null`
7054
+ * @returns The context at this index if available
6908
7055
  */
6909
7056
  getContextByIndex(
6910
7057
  /**
@@ -7086,8 +7233,6 @@ declare namespace sap {
7086
7233
  * Number of rows that are fix on the bottom. When you use a vertical scrollbar, only the rows which are
7087
7234
  * not fixed, will scroll.
7088
7235
  *
7089
- * This property is only supported if the `rows` aggregation is bound to a {@link sap.ui.model.ClientModel client model}.
7090
- *
7091
7236
  * Default value is `0`.
7092
7237
  *
7093
7238
  * @returns Value of property `fixedBottomRowCount`
@@ -7115,8 +7260,6 @@ declare namespace sap {
7115
7260
  * Number of rows that are fix on the top. When you use a vertical scrollbar, only the rows which are not
7116
7261
  * fixed, will scroll.
7117
7262
  *
7118
- * This property is only supported if the `rows` aggregation is bound to a {@link sap.ui.model.ClientModel client model}.
7119
- *
7120
7263
  * Default value is `0`.
7121
7264
  *
7122
7265
  * @returns Value of property `fixedRowCount`
@@ -7125,10 +7268,13 @@ declare namespace sap {
7125
7268
  /**
7126
7269
  * Gets content of aggregation {@link #getFooter footer}.
7127
7270
  *
7128
- * Control or text of footer section of the Table (if not set it will be hidden)
7271
+ * Control or text of footer section of the Table (if not set it will be hidden).
7272
+ *
7273
+ * **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control` instead.
7129
7274
  */
7130
7275
  getFooter(): sap.ui.core.Control | string;
7131
7276
  /**
7277
+ * @deprecated (since 1.110)
7132
7278
  * @experimental (since 1.28) - This feature has a limited functionality.
7133
7279
  *
7134
7280
  * ID of the element which is the current target of the association {@link #getGroupBy groupBy}, or `null`.
@@ -7940,8 +8086,6 @@ declare namespace sap {
7940
8086
  * Number of rows that are fix on the bottom. When you use a vertical scrollbar, only the rows which are
7941
8087
  * not fixed, will scroll.
7942
8088
  *
7943
- * This property is only supported if the `rows` aggregation is bound to a {@link sap.ui.model.ClientModel client model}.
7944
- *
7945
8089
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7946
8090
  *
7947
8091
  * Default value is `0`.
@@ -7983,8 +8127,6 @@ declare namespace sap {
7983
8127
  * Number of rows that are fix on the top. When you use a vertical scrollbar, only the rows which are not
7984
8128
  * fixed, will scroll.
7985
8129
  *
7986
- * This property is only supported if the `rows` aggregation is bound to a {@link sap.ui.model.ClientModel client model}.
7987
- *
7988
8130
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7989
8131
  *
7990
8132
  * Default value is `0`.
@@ -8009,6 +8151,7 @@ declare namespace sap {
8009
8151
  vFooter: sap.ui.core.Control | string
8010
8152
  ): this;
8011
8153
  /**
8154
+ * @deprecated (since 1.110)
8012
8155
  * @experimental (since 1.28) - This feature has a limited functionality.
8013
8156
  *
8014
8157
  * Sets the associated {@link #getGroupBy groupBy}.
@@ -9449,6 +9592,11 @@ declare namespace sap {
9449
9592
  */
9450
9593
  type TreeAutoExpandMode = sap.ui.model.TreeAutoExpandMode;
9451
9594
 
9595
+ type AnalyticalTable$GroupEvent = sap.ui.base.Event<
9596
+ AnalyticalTable$GroupEventParameters,
9597
+ AnalyticalTable
9598
+ >;
9599
+
9452
9600
  type Column$ColumnMenuOpenEvent = sap.ui.base.Event<
9453
9601
  Column$ColumnMenuOpenEventParameters,
9454
9602
  Column
@@ -9576,14 +9724,6 @@ declare namespace sap {
9576
9724
 
9577
9725
  "sap/ui/table/RowActionItem": undefined;
9578
9726
 
9579
- "sap/ui/table/rowmodes/AutoRowMode": undefined;
9580
-
9581
- "sap/ui/table/rowmodes/FixedRowMode": undefined;
9582
-
9583
- "sap/ui/table/rowmodes/InteractiveRowMode": undefined;
9584
-
9585
- "sap/ui/table/rowmodes/RowMode": undefined;
9586
-
9587
9727
  "sap/ui/table/RowSettings": undefined;
9588
9728
 
9589
9729
  "sap/ui/table/Table": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -5444,25 +5444,6 @@ declare namespace sap {
5444
5444
  */
5445
5445
  sSecondaryCalendarType: sap.ui.core.CalendarType
5446
5446
  ): this;
5447
- /**
5448
- * @deprecated (since 1.34.0) - replaced by `date` property
5449
- *
5450
- * Sets a new value for property {@link #getYear year}.
5451
- *
5452
- * The year is initial focused and selected The value must be between 0 and 9999
5453
- *
5454
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5455
- *
5456
- * Default value is `2000`.
5457
- *
5458
- * @returns Reference to `this` in order to allow method chaining
5459
- */
5460
- setYear(
5461
- /**
5462
- * New value for property `year`
5463
- */
5464
- iYear?: int
5465
- ): this;
5466
5447
  /**
5467
5448
  * @since 1.30.0
5468
5449
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {