@openui5/ts-types 1.144.0 → 1.146.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.
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.144.0
282
+ // For Library Version: 1.146.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -5499,211 +5499,418 @@ declare module "sap/ui/events/ControlEvents" {
5499
5499
 
5500
5500
  declare module "sap/ui/events/KeyCodes" {
5501
5501
  /**
5502
+ * KeyCodes enumeration.
5503
+ *
5502
5504
  * @since 1.58
5503
5505
  */
5504
5506
  enum KeyCodes {
5507
+ /**
5508
+ * Letter A key
5509
+ */
5505
5510
  A = "65",
5506
-
5511
+ /**
5512
+ * Alt key
5513
+ */
5507
5514
  ALT = "18",
5508
-
5515
+ /**
5516
+ * Down arrow key
5517
+ */
5509
5518
  ARROW_DOWN = "40",
5510
-
5519
+ /**
5520
+ * Left arrow key
5521
+ */
5511
5522
  ARROW_LEFT = "37",
5512
-
5523
+ /**
5524
+ * Right arrow key
5525
+ */
5513
5526
  ARROW_RIGHT = "39",
5514
-
5527
+ /**
5528
+ * Up arrow key
5529
+ */
5515
5530
  ARROW_UP = "38",
5516
-
5531
+ /**
5532
+ * Letter B key
5533
+ */
5517
5534
  B = "66",
5518
-
5535
+ /**
5536
+ * Backslash (\) key
5537
+ */
5519
5538
  BACKSLASH = "226",
5520
-
5539
+ /**
5540
+ * Backspace key
5541
+ */
5521
5542
  BACKSPACE = "8",
5522
-
5543
+ /**
5544
+ * Pause/Break key
5545
+ */
5523
5546
  BREAK = "19",
5524
-
5547
+ /**
5548
+ * Letter C key
5549
+ */
5525
5550
  C = "67",
5526
-
5551
+ /**
5552
+ * Caps Lock key
5553
+ */
5527
5554
  CAPS_LOCK = "20",
5528
-
5555
+ /**
5556
+ * Comma (,) key
5557
+ */
5529
5558
  COMMA = "188",
5530
-
5559
+ /**
5560
+ * Context menu key
5561
+ */
5531
5562
  CONTEXT_MENU = "93",
5532
-
5563
+ /**
5564
+ * Control key
5565
+ */
5533
5566
  CONTROL = "17",
5534
-
5567
+ /**
5568
+ * Letter D key
5569
+ */
5535
5570
  D = "68",
5536
-
5571
+ /**
5572
+ * Delete key
5573
+ */
5537
5574
  DELETE = "46",
5538
-
5575
+ /**
5576
+ * Digit 0 key
5577
+ */
5539
5578
  DIGIT_0 = "48",
5540
-
5579
+ /**
5580
+ * Digit 1 key
5581
+ */
5541
5582
  DIGIT_1 = "49",
5542
-
5583
+ /**
5584
+ * Digit 2 key
5585
+ */
5543
5586
  DIGIT_2 = "50",
5544
-
5587
+ /**
5588
+ * Digit 3 key
5589
+ */
5545
5590
  DIGIT_3 = "51",
5546
-
5591
+ /**
5592
+ * Digit 4 key
5593
+ */
5547
5594
  DIGIT_4 = "52",
5548
-
5595
+ /**
5596
+ * Digit 5 key
5597
+ */
5549
5598
  DIGIT_5 = "53",
5550
-
5599
+ /**
5600
+ * Digit 6 key
5601
+ */
5551
5602
  DIGIT_6 = "54",
5552
-
5603
+ /**
5604
+ * Digit 7 key
5605
+ */
5553
5606
  DIGIT_7 = "55",
5554
-
5607
+ /**
5608
+ * Digit 8 key
5609
+ */
5555
5610
  DIGIT_8 = "56",
5556
-
5611
+ /**
5612
+ * Digit 9 key
5613
+ */
5557
5614
  DIGIT_9 = "57",
5558
-
5615
+ /**
5616
+ * Dot/period (.) key
5617
+ */
5559
5618
  DOT = "190",
5560
-
5619
+ /**
5620
+ * Letter E key
5621
+ */
5561
5622
  E = "69",
5562
-
5623
+ /**
5624
+ * End key
5625
+ */
5563
5626
  END = "35",
5564
-
5627
+ /**
5628
+ * Enter key
5629
+ */
5565
5630
  ENTER = "13",
5566
-
5631
+ /**
5632
+ * Equals (=) key
5633
+ */
5567
5634
  EQUALS = "221",
5568
-
5635
+ /**
5636
+ * Escape key
5637
+ */
5569
5638
  ESCAPE = "27",
5570
-
5639
+ /**
5640
+ * Letter F key
5641
+ */
5571
5642
  F = "70",
5572
-
5643
+ /**
5644
+ * F1 function key
5645
+ */
5573
5646
  F1 = "112",
5574
-
5647
+ /**
5648
+ * F10 function key
5649
+ */
5575
5650
  F10 = "121",
5576
-
5651
+ /**
5652
+ * F11 function key
5653
+ */
5577
5654
  F11 = "122",
5578
-
5655
+ /**
5656
+ * F12 function key
5657
+ */
5579
5658
  F12 = "123",
5580
-
5659
+ /**
5660
+ * F2 function key
5661
+ */
5581
5662
  F2 = "113",
5582
-
5663
+ /**
5664
+ * F3 function key
5665
+ */
5583
5666
  F3 = "114",
5584
-
5667
+ /**
5668
+ * F4 function key
5669
+ */
5585
5670
  F4 = "115",
5586
-
5671
+ /**
5672
+ * F5 function key
5673
+ */
5587
5674
  F5 = "116",
5588
-
5675
+ /**
5676
+ * F6 function key
5677
+ */
5589
5678
  F6 = "117",
5590
-
5679
+ /**
5680
+ * F7 function key
5681
+ */
5591
5682
  F7 = "118",
5592
-
5683
+ /**
5684
+ * F8 function key
5685
+ */
5593
5686
  F8 = "119",
5594
-
5687
+ /**
5688
+ * F9 function key
5689
+ */
5595
5690
  F9 = "120",
5596
-
5691
+ /**
5692
+ * Letter G key
5693
+ */
5597
5694
  G = "71",
5598
-
5695
+ /**
5696
+ * Grave accent (`) key
5697
+ */
5599
5698
  GREAT_ACCENT = "220",
5600
-
5699
+ /**
5700
+ * Letter H key
5701
+ */
5601
5702
  H = "72",
5602
-
5703
+ /**
5704
+ * Home key
5705
+ */
5603
5706
  HOME = "36",
5604
-
5707
+ /**
5708
+ * Letter I key
5709
+ */
5605
5710
  I = "73",
5606
-
5711
+ /**
5712
+ * Insert key
5713
+ */
5607
5714
  INSERT = "45",
5608
-
5715
+ /**
5716
+ * Letter J key
5717
+ */
5609
5718
  J = "74",
5610
-
5719
+ /**
5720
+ * Letter K key
5721
+ */
5611
5722
  K = "75",
5612
-
5723
+ /**
5724
+ * Letter L key
5725
+ */
5613
5726
  L = "76",
5614
-
5727
+ /**
5728
+ * Letter M key
5729
+ */
5615
5730
  M = "77",
5616
-
5731
+ /**
5732
+ * Minus (-) key
5733
+ */
5617
5734
  MINUS = "219",
5618
-
5735
+ /**
5736
+ * Letter N key
5737
+ */
5619
5738
  N = "78",
5620
-
5739
+ /**
5740
+ * Num Lock key
5741
+ */
5621
5742
  NUM_LOCK = "144",
5622
-
5743
+ /**
5744
+ * Numpad 0 key
5745
+ */
5623
5746
  NUMPAD_0 = "96",
5624
-
5747
+ /**
5748
+ * Numpad 1 key
5749
+ */
5625
5750
  NUMPAD_1 = "97",
5626
-
5751
+ /**
5752
+ * Numpad 2 key
5753
+ */
5627
5754
  NUMPAD_2 = "98",
5628
-
5755
+ /**
5756
+ * Numpad 3 key
5757
+ */
5629
5758
  NUMPAD_3 = "99",
5630
-
5759
+ /**
5760
+ * Numpad 4 key
5761
+ */
5631
5762
  NUMPAD_4 = "100",
5632
-
5763
+ /**
5764
+ * Numpad 5 key
5765
+ */
5633
5766
  NUMPAD_5 = "101",
5634
-
5767
+ /**
5768
+ * Numpad 6 key
5769
+ */
5635
5770
  NUMPAD_6 = "102",
5636
-
5771
+ /**
5772
+ * Numpad 7 key
5773
+ */
5637
5774
  NUMPAD_7 = "103",
5638
-
5775
+ /**
5776
+ * Numpad 8 key
5777
+ */
5639
5778
  NUMPAD_8 = "104",
5640
-
5779
+ /**
5780
+ * Numpad 9 key
5781
+ */
5641
5782
  NUMPAD_9 = "105",
5642
-
5783
+ /**
5784
+ * Numpad asterisk (*) key
5785
+ */
5643
5786
  NUMPAD_ASTERISK = "106",
5644
-
5787
+ /**
5788
+ * Numpad comma/decimal (.) key
5789
+ */
5645
5790
  NUMPAD_COMMA = "110",
5646
-
5791
+ /**
5792
+ * Numpad minus (-) key
5793
+ */
5647
5794
  NUMPAD_MINUS = "109",
5648
-
5795
+ /**
5796
+ * Numpad plus (+) key
5797
+ */
5649
5798
  NUMPAD_PLUS = "107",
5650
-
5799
+ /**
5800
+ * Numpad slash (/) key
5801
+ */
5651
5802
  NUMPAD_SLASH = "111",
5652
-
5803
+ /**
5804
+ * Letter O key
5805
+ */
5653
5806
  O = "79",
5654
-
5807
+ /**
5808
+ * Open bracket ([) key
5809
+ */
5655
5810
  OPEN_BRACKET = "186",
5656
-
5811
+ /**
5812
+ * Letter P key
5813
+ */
5657
5814
  P = "80",
5658
-
5815
+ /**
5816
+ * Page Down key
5817
+ */
5659
5818
  PAGE_DOWN = "34",
5660
-
5819
+ /**
5820
+ * Page Up key
5821
+ */
5661
5822
  PAGE_UP = "33",
5662
-
5823
+ /**
5824
+ * Pipe (|) key
5825
+ */
5663
5826
  PIPE = "191",
5664
-
5827
+ /**
5828
+ * Plus (+) key
5829
+ */
5665
5830
  PLUS = "187",
5666
-
5831
+ /**
5832
+ * Print Screen key
5833
+ */
5667
5834
  PRINT = "44",
5668
-
5835
+ /**
5836
+ * Letter Q key
5837
+ */
5669
5838
  Q = "81",
5670
-
5839
+ /**
5840
+ * Letter R key
5841
+ */
5671
5842
  R = "82",
5672
-
5843
+ /**
5844
+ * Letter S key
5845
+ */
5673
5846
  S = "83",
5674
-
5847
+ /**
5848
+ * Scroll Lock key
5849
+ */
5675
5850
  SCROLL_LOCK = "145",
5676
-
5851
+ /**
5852
+ * Semicolon (;) key
5853
+ */
5677
5854
  SEMICOLON = "192",
5678
-
5855
+ /**
5856
+ * Shift key
5857
+ */
5679
5858
  SHIFT = "16",
5680
-
5859
+ /**
5860
+ * Single quote (') key
5861
+ */
5681
5862
  SINGLE_QUOTE = "222",
5682
-
5863
+ /**
5864
+ * Slash (/) key
5865
+ */
5683
5866
  SLASH = "189",
5684
-
5867
+ /**
5868
+ * Sleep key
5869
+ */
5685
5870
  SLEEP = "95",
5686
-
5871
+ /**
5872
+ * Space bar key
5873
+ */
5687
5874
  SPACE = "32",
5688
-
5875
+ /**
5876
+ * Letter T key
5877
+ */
5689
5878
  T = "84",
5690
-
5879
+ /**
5880
+ * Tab key
5881
+ */
5691
5882
  TAB = "9",
5692
-
5883
+ /**
5884
+ * Turn off key
5885
+ */
5693
5886
  TURN_OFF = "94",
5694
-
5887
+ /**
5888
+ * Letter U key
5889
+ */
5695
5890
  U = "85",
5696
-
5891
+ /**
5892
+ * Letter V key
5893
+ */
5697
5894
  V = "86",
5698
-
5895
+ /**
5896
+ * Letter W key
5897
+ */
5699
5898
  W = "87",
5700
-
5899
+ /**
5900
+ * Windows key (or Meta key on Mac)
5901
+ */
5701
5902
  WINDOWS = "91",
5702
-
5903
+ /**
5904
+ * Letter X key
5905
+ */
5703
5906
  X = "88",
5704
-
5907
+ /**
5908
+ * Letter Y key
5909
+ */
5705
5910
  Y = "89",
5706
-
5911
+ /**
5912
+ * Letter Z key
5913
+ */
5707
5914
  Z = "90",
5708
5915
  }
5709
5916
  export default KeyCodes;
@@ -5761,6 +5968,24 @@ declare module "sap/ui/model/FilterProcessor" {
5761
5968
  * @since 1.71
5762
5969
  */
5763
5970
  interface FilterProcessor {
5971
+ /**
5972
+ * Combines control filters and application filters using AND and returns the resulting filter
5973
+ *
5974
+ * @since 1.146.0
5975
+ *
5976
+ * @returns A single filter containing all filters of the arrays combined or `undefined` if no filters are
5977
+ * given
5978
+ */
5979
+ combineFilters(
5980
+ /**
5981
+ * The control filters
5982
+ */
5983
+ aFilters?: sap.ui.model.Filter[],
5984
+ /**
5985
+ * The application filters
5986
+ */
5987
+ aApplicationFilters?: sap.ui.model.Filter[]
5988
+ ): sap.ui.model.Filter | undefined;
5764
5989
  /**
5765
5990
  * Groups filters according to their path and combines filters on the same path using "OR" and filters on
5766
5991
  * different paths using "AND", all multi-filters contained are ANDed.
@@ -7206,14 +7431,15 @@ declare module "sap/ui/test/starter/config" {
7206
7431
  */
7207
7432
  export type CoverageConfiguration = {
7208
7433
  /**
7209
- * List of modules or packages that should be instrumented. If not given, all modules are instrumented.
7210
- * Default is null
7434
+ * A single module or package name, or a list of such names, that should be instrumented. If not given,
7435
+ * all modules are instrumented. Default is null
7211
7436
  */
7212
- only?: string[];
7437
+ only?: string | string[];
7213
7438
  /**
7214
- * List of modules or packages that never should be instrumented. Default is null
7439
+ * A single module or package name, or a list of such names, that never should be instrumented. Default
7440
+ * is null
7215
7441
  */
7216
- never?: string[];
7442
+ never?: string | string[];
7217
7443
 
7218
7444
  branchTracking?: boolean;
7219
7445
  /**
@@ -10723,7 +10949,7 @@ declare namespace sap {
10723
10949
  * Returns the application root component.
10724
10950
  *
10725
10951
  * @since 1.13.1
10726
- * @deprecated As of version 1.14.
10952
+ * @deprecated As of version 1.14. superseded by {@link sap.ui.core.Component}.
10727
10953
  *
10728
10954
  * @returns The root component
10729
10955
  */
@@ -11226,13 +11452,20 @@ declare namespace sap {
11226
11452
  */
11227
11453
  length?: int;
11228
11454
  /**
11229
- * The initial sort order (optional)
11455
+ * The initial sort order
11230
11456
  */
11231
11457
  sorter?: sap.ui.model.Sorter | sap.ui.model.Sorter[];
11232
11458
  /**
11233
- * The predefined filters for this aggregation (optional)
11459
+ * The predefined {@link sap.ui.model.FilterType.Application application filters} for this aggregation where
11460
+ * filter values are constants.
11234
11461
  */
11235
11462
  filters?: sap.ui.model.Filter | sap.ui.model.Filter[];
11463
+ /**
11464
+ * The predefined {@link sap.ui.model.FilterType.ApplicationBound bound application filters} for this aggregation.
11465
+ * Filter values support binding expressions. The aggregation updates its filters whenever a filter value
11466
+ * changes through data binding. Supported since 1.146.0.
11467
+ */
11468
+ boundFilters?: sap.ui.model.Filter | sap.ui.model.Filter[];
11236
11469
  /**
11237
11470
  * Name of the key property or a function getting the context as only parameter to calculate a key for entries.
11238
11471
  * This can be used to improve update behaviour in models, where a key is not already available.
@@ -12704,8 +12937,8 @@ declare namespace sap {
12704
12937
  * ```
12705
12938
  *
12706
12939
  *
12707
- * Note that when setting string values, any curly braces in those values need to be escaped, so they are
12708
- * not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
12940
+ * Note that when setting string values, any curly braces and backslashes in those values need to be escaped,
12941
+ * so they are not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
12709
12942
  *
12710
12943
  * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
12711
12944
  * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
@@ -12826,8 +13059,8 @@ declare namespace sap {
12826
13059
  * ```
12827
13060
  *
12828
13061
  *
12829
- * Note that when setting string values, any curly braces in those values need to be escaped, so they are
12830
- * not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
13062
+ * Note that when setting string values, any curly braces and backslashes in those values need to be escaped,
13063
+ * so they are not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
12831
13064
  *
12832
13065
  * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
12833
13066
  * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
@@ -12891,17 +13124,46 @@ declare namespace sap {
12891
13124
  );
12892
13125
 
12893
13126
  /**
12894
- * Escapes the given value so it can be used in the constructor's settings object. Should be used when property
12895
- * values are initialized with static string values which could contain binding characters (curly braces).
13127
+ * Escapes the given value so it can be used in the constructor's settings object.
13128
+ *
13129
+ * Use this method when passing static string values that might contain binding syntax characters. Without
13130
+ * escaping, curly braces in strings would be misinterpreted as data binding expressions.
13131
+ *
13132
+ * **Characters that are escaped:**
13133
+ * - `{` (opening curly brace) - binding expression start
13134
+ * - `}` (closing curly brace) - binding expression end
13135
+ * - `\` (backslash) - escape character itself
13136
+ *
13137
+ * Each of the above characters is prefixed with a backslash, e.g. `{foo}` becomes `\{foo\}`.
13138
+ *
13139
+ * **When to use:**
13140
+ * - Static string values containing curly braces that should be displayed literally
13141
+ * - Rendering escaped backslashes (e.g. expecting `\\\\` to result in `\\`)
13142
+ * - User input or external data used as property values in constructors
13143
+ * - JSON content that should not be parsed as bindings
13144
+ *
13145
+ * Example usage:
13146
+ * ```javascript
13147
+ *
13148
+ * new MyControl({
13149
+ * // Without escaping: "{info}" would be interpreted as a binding to the path "info"
13150
+ * // With escaping: displays the literal text "{info}"
13151
+ * text: ManagedObject.escapeSettingsValue("{info}")
13152
+ * });
13153
+ * ```
13154
+ *
13155
+ *
13156
+ * **Note:** This is only needed when setting values via the constructor or {@link #applySettings}. Setter
13157
+ * method calls, e.g. `setText("{info}")` do not interpret binding syntax and thus do not require escaping.
12896
13158
  *
12897
13159
  * @since 1.52
12898
13160
  *
12899
- * @returns The given value, escaped for usage as static property value in the constructor's settings object
12900
- * (or unchanged, if not of type string)
13161
+ * @returns The escaped string value, or the original value if not a string
12901
13162
  */
12902
13163
  static escapeSettingsValue(
12903
13164
  /**
12904
- * Value to escape; only needs to be done for string values, but the call will work for all types
13165
+ * Value to escape; only strings are escaped, other types (e.g. objects) are returned through unchanged.
13166
+ * Strings nested in objects must be escaped individually.
12905
13167
  */
12906
13168
  vValue: any
12907
13169
  ): any;
@@ -13583,9 +13845,18 @@ declare namespace sap {
13583
13845
  * Destroys (all) the managed object(s) in the aggregation named `sAggregationName` and empties the aggregation.
13584
13846
  * If the aggregation did contain any object, this ManagedObject is marked as changed.
13585
13847
  *
13848
+ * **Note:** Destroying an aggregation by calling this method (or indirectly via `destroyXYZ`) does
13849
+ * not call the named aggregation mutators (`setXYZ` for a 0..1 aggregation, `removeXYZ` for
13850
+ * a 0..n aggregation) for the aggregated children. Controls that implement side effects in those methods
13851
+ * therefore must also implement similar side effects in their `destroyXYZ` method.
13852
+ *
13853
+ * While this is understood as inconvenient, it was decided (February 2026, after a thorough investigation),
13854
+ * not to change it. Too many existing controls depend on the current behavior, and, even worse, would have
13855
+ * severe problems with a changed behavior.
13856
+ *
13586
13857
  * **Note:** This method is a low-level API as described in the class documentation.
13587
13858
  * Applications or frameworks must not use this method to generically destroy all objects in an aggregation.
13588
- * Use the concrete method destroyXYZ for aggregation 'XYZ' instead.
13859
+ * Use the concrete method `destroyXYZ` for aggregation 'XYZ' instead.
13589
13860
  *
13590
13861
  * @ui5-protected Do not call from applications (only from related classes in the framework)
13591
13862
  *
@@ -22519,15 +22790,15 @@ declare namespace sap {
22519
22790
  */
22520
22791
  sViewType: string,
22521
22792
  /**
22522
- * declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be executed
22523
- * also for sync views. Please be aware that any kind of async processing (like Promises, XHR, etc) may
22524
- * break the view initialization and lead to unexpected results.
22793
+ * Deprecated as of version 1.145, because this parameter is only applicable to sync views and is no longer
22794
+ * used. Declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be
22795
+ * executed also for sync views. Please be aware that any kind of async processing (like Promises, XHR,
22796
+ * etc) may break the view initialization and lead to unexpected results.
22525
22797
  */
22526
22798
  bSyncSupport: boolean,
22527
22799
  /**
22528
22800
  * on-demand preprocessor which enables developers to quickly activate the preprocessor for a view, by setting
22529
- * `preprocessors : { xml }`, for example. This should be false except for very special cases. There can
22530
- * only be one on-demand preprocessor per content type.
22801
+ * `preprocessors : { xml }`, for example. There can only be one on-demand preprocessor per content type.
22531
22802
  */
22532
22803
  bOnDemand?: boolean,
22533
22804
  /**
@@ -23458,9 +23729,10 @@ declare namespace sap {
23458
23729
  */
23459
23730
  sViewType: string,
23460
23731
  /**
23461
- * declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be executed
23462
- * also for sync views. Please be aware that any kind of async processing (like Promises, XHR, etc) may
23463
- * break the view initialization and lead to unexpected results.
23732
+ * Deprecated as of version 1.145, because this parameter is only applicable to sync views and is no longer
23733
+ * used. Declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be
23734
+ * executed also for sync views. Please be aware that any kind of async processing (like Promises, XHR,
23735
+ * etc) may break the view initialization and lead to unexpected results.
23464
23736
  */
23465
23737
  bSyncSupport: boolean,
23466
23738
  /**
@@ -23507,9 +23779,10 @@ declare namespace sap {
23507
23779
  p3: object
23508
23780
  ) => void),
23509
23781
  /**
23510
- * declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be executed
23511
- * also for sync views. Please be aware that any kind of async processing (like Promises, XHR, etc) may
23512
- * break the view initialization and lead to unexpected results.
23782
+ * Deprecated as of version 1.145, because this parameter is only applicable to sync views and is no longer
23783
+ * used. Declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be
23784
+ * executed also for sync views. Please be aware that any kind of async processing (like Promises, XHR,
23785
+ * etc) may break the view initialization and lead to unexpected results.
23513
23786
  */
23514
23787
  bSyncSupport: boolean,
23515
23788
  /**
@@ -23563,7 +23836,8 @@ declare namespace sap {
23563
23836
  /**
23564
23837
  * JS View
23565
23838
  *
23566
- * @deprecated As of version 1.90.
23839
+ * @deprecated As of version 1.90. Consider using {@link sap.ui.core.mvx.XMLView XMLViews} or "typed views"
23840
+ * (view classes written in JavaScript) instead.
23567
23841
  */
23568
23842
  JS = "JS",
23569
23843
  /**
@@ -23576,7 +23850,8 @@ declare namespace sap {
23576
23850
  /**
23577
23851
  * Template View
23578
23852
  *
23579
- * @deprecated As of version 1.56.
23853
+ * @deprecated As of version 1.56. Consider using {@link sap.ui.core.mvx.XMLView XMLViews} or "typed views"
23854
+ * (view classes written in JavaScript) instead.
23580
23855
  */
23581
23856
  Template = "Template",
23582
23857
  /**
@@ -24783,34 +25058,65 @@ declare namespace sap {
24783
25058
  * This enum is part of the 'sap/ui/core/Popup' module export and must be accessed by the property 'Dock'.
24784
25059
  */
24785
25060
  enum Dock {
25061
+ /**
25062
+ * Docks the popup at the begin of the reference element, at the bottom.
25063
+ */
24786
25064
  BeginBottom = "BeginBottom",
24787
-
25065
+ /**
25066
+ * Docks the popup at the begin of the reference element, vertically centered.
25067
+ */
24788
25068
  BeginCenter = "BeginCenter",
24789
-
25069
+ /**
25070
+ * Docks the popup at the begin of the reference element, at the top.
25071
+ */
24790
25072
  BeginTop = "BeginTop",
24791
-
25073
+ /**
25074
+ * Docks the popup horizontally centered to the reference element, at the bottom.
25075
+ */
24792
25076
  CenterBottom = "CenterBottom",
24793
-
25077
+ /**
25078
+ * Docks the popup horizontally and vertically centered to the reference element.
25079
+ */
24794
25080
  CenterCenter = "CenterCenter",
24795
-
25081
+ /**
25082
+ * Docks the popup horizontally centered to the reference element, at the top.
25083
+ */
24796
25084
  CenterTop = "CenterTop",
24797
-
25085
+ /**
25086
+ * Docks the popup at the end of the reference element, at the bottom.
25087
+ */
24798
25088
  EndBottom = "EndBottom",
24799
-
25089
+ /**
25090
+ * Docks the popup at the end of the reference element, vertically centered.
25091
+ */
24800
25092
  EndCenter = "EndCenter",
24801
-
25093
+ /**
25094
+ * Docks the popup at the end of the reference element, at the top.
25095
+ */
24802
25096
  EndTop = "EndTop",
24803
-
25097
+ /**
25098
+ * Docks the popup at the left side of the reference element, at the bottom.
25099
+ */
24804
25100
  LeftBottom = "LeftBottom",
24805
-
25101
+ /**
25102
+ * Docks the popup at the left side of the reference element, vertically centered.
25103
+ */
24806
25104
  LeftCenter = "LeftCenter",
24807
-
25105
+ /**
25106
+ * Docks the popup at the left side of the reference element, at the top.
25107
+ */
24808
25108
  LeftTop = "LeftTop",
24809
-
25109
+ /**
25110
+ * Docks the popup at the right side of the reference element, at the bottom.
25111
+ */
24810
25112
  RightBottom = "RightBottom",
24811
-
25113
+ /**
25114
+ * Docks the popup at the right side of the reference element, vertically centered.
25115
+ */
24812
25116
  RightCenter = "RightCenter",
24813
-
25117
+ /**
25118
+ * Docks the popup at the right side of the reference element, at the top.
25119
+ */
24814
25120
  RightTop = "RightTop",
24815
25121
  }
24816
25122
 
@@ -27198,34 +27504,6 @@ declare namespace sap {
27198
27504
  * @returns Metadata object describing this class
27199
27505
  */
27200
27506
  static getMetadata(): sap.ui.base.Metadata;
27201
- /**
27202
- * This function is called between the target view is loaded and the view is added to the container.
27203
- *
27204
- * This function can be used for applying modification on the view or the container to make the rerendering
27205
- * occur together with the later aggregation change.
27206
- *
27207
- * @since 1.46.1
27208
- * @ui5-protected Do not call from applications (only from related classes in the framework)
27209
- */
27210
- _beforePlacingViewIntoContainer(
27211
- /**
27212
- * the object containing the arguments
27213
- */
27214
- mArguments: {
27215
- /**
27216
- * the container where the view will be added
27217
- */
27218
- container: sap.ui.core.Control;
27219
- /**
27220
- * the view which will be added to the container
27221
- */
27222
- view: sap.ui.core.Control;
27223
- /**
27224
- * the data passed from {@link sap.ui.core.routing.Target#display} method
27225
- */
27226
- data?: object;
27227
- }
27228
- ): void;
27229
27507
  /**
27230
27508
  * Attaches event handler `fnFunction` to the {@link #event:display display} event of this `sap.ui.core.routing.Target`.
27231
27509
  *
@@ -27269,6 +27547,37 @@ declare namespace sap {
27269
27547
  */
27270
27548
  oListener?: object
27271
27549
  ): this;
27550
+ /**
27551
+ * This function is called between the target view is loaded and the view is added to the container.
27552
+ *
27553
+ * This function can be used for applying modification on the view or the container to make the rerendering
27554
+ * occur together with the later aggregation change.
27555
+ *
27556
+ * **Note:** This function was previously named `_beforePlacingViewIntoContainer` (with a leading underscore)
27557
+ * and has been renamed to be protected instead of private.
27558
+ *
27559
+ * @since 1.46.1
27560
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
27561
+ */
27562
+ beforePlacingViewIntoContainer(
27563
+ /**
27564
+ * the object containing the arguments
27565
+ */
27566
+ mArguments: {
27567
+ /**
27568
+ * the container where the view will be added
27569
+ */
27570
+ container: sap.ui.core.Control;
27571
+ /**
27572
+ * the view which will be added to the container
27573
+ */
27574
+ view: sap.ui.core.Control;
27575
+ /**
27576
+ * the data passed from {@link sap.ui.core.routing.Target#display} method
27577
+ */
27578
+ data?: object;
27579
+ }
27580
+ ): void;
27272
27581
  /**
27273
27582
  * Destroys the target, will be called by {@link sap.m.routing.Targets} don't call this directly.
27274
27583
  *
@@ -28916,7 +29225,7 @@ declare namespace sap {
28916
29225
  get(
28917
29226
  /**
28918
29227
  * the (array with) CSS parameter name(s) or an object containing the (array with) CSS parameter name(s),
28919
- * the scopeElement and a callback for async retrieval of parameters.
29228
+ * and a callback for async retrieval of parameters.
28920
29229
  */
28921
29230
  vName:
28922
29231
  | string
@@ -28926,22 +29235,12 @@ declare namespace sap {
28926
29235
  * the (array with) CSS parameter name(s)
28927
29236
  */
28928
29237
  name: string | string[];
28929
- /**
28930
- * Element / control instance to take into account when looking for a parameter value. This can make a difference
28931
- * when a parameter value is overridden in a theme scope set via a CSS class.
28932
- */
28933
- scopeElement?: sap.ui.core.Element;
28934
29238
  /**
28935
29239
  * If given, the callback is only executed in case there are still parameters pending and one or more of
28936
29240
  * the requested parameters is missing.
28937
29241
  */
28938
29242
  callback?: (p1: sap.ui.core.theming.Parameters.Value) => void;
28939
- },
28940
- /**
28941
- * Element / control instance to take into account when looking for a parameter value. This can make a difference
28942
- * when a parameter value is overridden in a theme scope set via a CSS class.
28943
- */
28944
- oElement?: sap.ui.core.Element
29243
+ }
28945
29244
  ): sap.ui.core.theming.Parameters.Value;
28946
29245
  /**
28947
29246
  * Resets the CSS parameters which finally will reload the parameters the next time they are queried via
@@ -30684,16 +30983,29 @@ declare namespace sap {
30684
30983
  * 'HTTPMETHOD'.
30685
30984
  */
30686
30985
  enum HTTPMETHOD {
30986
+ /**
30987
+ * HTTP DELETE method.
30988
+ */
30687
30989
  DELETE = "DELETE",
30688
-
30990
+ /**
30991
+ * HTTP GET method.
30992
+ */
30689
30993
  GET = "GET",
30690
-
30994
+ /**
30995
+ * HTTP MERGE method.
30996
+ */
30691
30997
  MERGE = "MERGE",
30692
-
30998
+ /**
30999
+ * HTTP PATCH method.
31000
+ */
30693
31001
  PATCH = "PATCH",
30694
-
31002
+ /**
31003
+ * HTTP POST method.
31004
+ */
30695
31005
  POST = "POST",
30696
-
31006
+ /**
31007
+ * HTTP PUT method.
31008
+ */
30697
31009
  PUT = "PUT",
30698
31010
  }
30699
31011
 
@@ -34183,13 +34495,13 @@ declare namespace sap {
34183
34495
 
34184
34496
  /**
34185
34497
  * Dependents are not rendered, but their databinding context and lifecycle are bound to the aggregating
34186
- * Element.
34498
+ * ManagedObject.
34187
34499
  *
34188
34500
  * @since 1.19
34189
34501
  */
34190
34502
  dependents?:
34191
- | sap.ui.core.Element[]
34192
- | sap.ui.core.Element
34503
+ | sap.ui.base.ManagedObject[]
34504
+ | sap.ui.base.ManagedObject
34193
34505
  | sap.ui.base.ManagedObject.AggregationBindingInfo
34194
34506
  | `{${string}}`;
34195
34507
 
@@ -34216,6 +34528,9 @@ declare namespace sap {
34216
34528
  * Describes the settings that can be provided to the Fragment constructor.
34217
34529
  */
34218
34530
  interface $FragmentSettings extends sap.ui.base.$ManagedObjectSettings {
34531
+ /**
34532
+ * The Fragment type.
34533
+ */
34219
34534
  type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
34220
34535
 
34221
34536
  fragmentName?: string;
@@ -34592,8 +34907,18 @@ declare namespace sap {
34592
34907
  * Describes the settings that can be provided to the Popup constructor.
34593
34908
  */
34594
34909
  interface $PopupSettings extends sap.ui.base.$ManagedObjectSettings {
34910
+ /**
34911
+ * Fired when the popup has completely opened (after any animation).
34912
+ *
34913
+ * @since 1.2
34914
+ */
34595
34915
  opened?: (oEvent: sap.ui.base.Event) => void;
34596
34916
 
34917
+ /**
34918
+ * Fired when the popup has completely closed (after any animation).
34919
+ *
34920
+ * @since 1.2
34921
+ */
34597
34922
  closed?: (oEvent: sap.ui.base.Event) => void;
34598
34923
  }
34599
34924
 
@@ -37318,24 +37643,24 @@ declare namespace sap {
37318
37643
  * ```
37319
37644
  *
37320
37645
  *
37321
- * If parts of the theme are at different locations (e.g. because you provide a standard theme like "sap_belize"
37646
+ * If parts of the theme are at different locations (e.g. because you provide a standard theme like "sap_horizon"
37322
37647
  * for a custom control library and this self-made part of the standard theme is at a different location
37323
37648
  * than the UI5 resources), you can also specify for which control libraries the setting should be used,
37324
37649
  * by giving an array with the names of the respective control libraries as second parameter:
37325
37650
  * ```javascript
37326
37651
  *
37327
- * sap.ui.getCore().setThemeRoot("sap_belize", ["my.own.library"], "https://mythemeserver.com/allThemes");
37652
+ * sap.ui.getCore().setThemeRoot("sap_horizon", ["my.own.library"], "https://mythemeserver.com/allThemes");
37328
37653
  * ```
37329
37654
  *
37330
37655
  *
37331
- * This will cause the Belize theme to be loaded from the UI5 location for all standard libraries. Resources
37656
+ * This will cause the Horizon theme to be loaded from the UI5 location for all standard libraries. Resources
37332
37657
  * for styling the `my.own.library` controls will be loaded from the configured location:
37333
37658
  * ```javascript
37334
37659
  *
37335
- * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_belize/library.css
37336
- * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_belize/library.css
37337
- * https://sdk.openui5.org/resources/sap/m/themes/sap_belize/library.css
37338
- * https://mythemeserver.com/allThemes/my/own/library/themes/sap_belize/library.css
37660
+ * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_horizon/library.css
37661
+ * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_horizon/library.css
37662
+ * https://sdk.openui5.org/resources/sap/m/themes/sap_horizon/library.css
37663
+ * https://mythemeserver.com/allThemes/my/own/library/themes/sap_horizon/library.css
37339
37664
  * ```
37340
37665
  *
37341
37666
  *
@@ -37389,24 +37714,24 @@ declare namespace sap {
37389
37714
  * ```
37390
37715
  *
37391
37716
  *
37392
- * If parts of the theme are at different locations (e.g. because you provide a standard theme like "sap_belize"
37717
+ * If parts of the theme are at different locations (e.g. because you provide a standard theme like "sap_horizon"
37393
37718
  * for a custom control library and this self-made part of the standard theme is at a different location
37394
37719
  * than the UI5 resources), you can also specify for which control libraries the setting should be used,
37395
37720
  * by giving an array with the names of the respective control libraries as second parameter:
37396
37721
  * ```javascript
37397
37722
  *
37398
- * sap.ui.getCore().setThemeRoot("sap_belize", ["my.own.library"], "https://mythemeserver.com/allThemes");
37723
+ * sap.ui.getCore().setThemeRoot("sap_horizon", ["my.own.library"], "https://mythemeserver.com/allThemes");
37399
37724
  * ```
37400
37725
  *
37401
37726
  *
37402
- * This will cause the Belize theme to be loaded from the UI5 location for all standard libraries. Resources
37727
+ * This will cause the Horizon theme to be loaded from the UI5 location for all standard libraries. Resources
37403
37728
  * for styling the `my.own.library` controls will be loaded from the configured location:
37404
37729
  * ```javascript
37405
37730
  *
37406
- * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_belize/library.css
37407
- * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_belize/library.css
37408
- * https://sdk.openui5.org/resources/sap/m/themes/sap_belize/library.css
37409
- * https://mythemeserver.com/allThemes/my/own/library/themes/sap_belize/library.css
37731
+ * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_horizon/library.css
37732
+ * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_horizon/library.css
37733
+ * https://sdk.openui5.org/resources/sap/m/themes/sap_horizon/library.css
37734
+ * https://mythemeserver.com/allThemes/my/own/library/themes/sap_horizon/library.css
37410
37735
  * ```
37411
37736
  *
37412
37737
  *
@@ -38084,56 +38409,56 @@ declare namespace sap {
38084
38409
  }
38085
38410
 
38086
38411
  /**
38412
+ * The CommandExecution registers a shortcut when it is added to the dependent aggregation of a control.
38413
+ * The shortcut information is retrieved from the owner components manifest (`/sap.ui5/commands/<command>`).
38414
+ *
38415
+ * You can use a CommandExecution instead of an event handler in XMLViews by using `cmd:` plus the command
38416
+ * name.
38417
+ *
38418
+ * Example for `sap.m.Button`:
38419
+ *
38420
+ *
38421
+ * ```javascript
38422
+ *
38423
+ * <Button press="cmd:MyCommand" />
38424
+ * ```
38425
+ *
38426
+ *
38427
+ * When the press event is fired, the CommandExecution will be triggered and the `execute` event is fired.
38428
+ *
38429
+ * When using commands, the component will create a model named `$cmd`. The model data provides the enabled
38430
+ * and visible state of all CommandExecutions. With that, action-triggering controls (e.g. a button) can
38431
+ * be bound to the enable/visible property of the CommandExecution to centrally control their state.
38432
+ *
38433
+ * **Note: The usage of the `$cmd` model is restricted to `sap.suite.ui.generic`**
38434
+ *
38435
+ * When binding a button's enabled state to this model, it follows the enabled state of the CommandExecution.
38436
+ * The binding path must be relative like `myCommand/enabled`:
38437
+ *
38438
+ *
38439
+ * ```javascript
38440
+ *
38441
+ * <Button press="cmd:MyCommand" enabled="$cmd>MyCommand/enabled" />
38442
+ * ```
38443
+ *
38444
+ *
38445
+ * A CommandExecution can have three states:
38446
+ * - the CommandExecution is visible and enabled. If the configured shortcut is executed, the configured
38447
+ * event handler of this CommandExecution is called
38448
+ * - the CommandExecution is visible but not enabled. If the configured shortcut is executed, neither
38449
+ * the configured event handler of this CommandExecution nor any event handler configured on CommandExecutions
38450
+ * in the ancestor chain is called
38451
+ * - the CommandExecution is not visible. If the configured shortcut is executed, the configured event
38452
+ * handler of this CommandExecution is not called, but the event is propagated to its parent, which can
38453
+ * then handle the event by a configured CommandExecution or propagate the event to its parent, until no
38454
+ * parent exits anymore and the browser can handle the executed shortcut
38455
+ *
38087
38456
  * @since 1.70
38088
38457
  */
38089
38458
  class CommandExecution extends sap.ui.core.Element {
38090
38459
  /**
38091
38460
  * Creates and initializes a new CommandExecution.
38092
38461
  *
38093
- * The CommandExecution registers a shortcut when it is added to the dependent aggregation of a control.
38094
- * The shortcut information is retrieved from the owner components manifest (`/sap.ui5/commands/<command>`).
38095
- *
38096
- * You can use a CommandExecution instead of an event handler in XMLViews by using `cmd:` plus the command
38097
- * name.
38098
- *
38099
- * Example for `sap.m.Button`:
38100
- *
38101
- *
38102
- * ```javascript
38103
- *
38104
- * <Button press="cmd:MyCommand" />
38105
- * ```
38106
- *
38107
- *
38108
- * When the press event is fired, the CommandExecution will be triggered and the `execute` event is fired.
38109
- *
38110
- * When using commands, the component will create a model named `$cmd`. The model data provides the enabled
38111
- * and visible state of all CommandExecutions. With that, action-triggering controls (e.g. a button) can
38112
- * be bound to the enable/visible property of the CommandExecution to centrally control their state.
38113
- *
38114
- * **Note: The usage of the `$cmd` model is restricted to `sap.suite.ui.generic`**
38115
- *
38116
- * When binding a button's enabled state to this model, it follows the enabled state of the CommandExecution.
38117
- * The binding path must be relative like `myCommand/enabled`:
38118
- *
38119
- *
38120
- * ```javascript
38121
- *
38122
- * <Button press="cmd:MyCommand" enabled="$cmd>MyCommand/enabled" />
38123
- * ```
38124
- *
38125
- *
38126
- * A CommandExecution can have three states:
38127
- * - the CommandExecution is visible and enabled. If the configured shortcut is executed, the configured
38128
- * event handler of this CommandExecution is called
38129
- * - the CommandExecution is visible but not enabled. If the configured shortcut is executed, neither
38130
- * the configured event handler of this CommandExecution nor any event handler configured on CommandExecutions
38131
- * in the ancestor chain is called
38132
- * - the CommandExecution is not visible. If the configured shortcut is executed, the configured event
38133
- * handler of this CommandExecution is not called, but the event is propagated to its parent, which can
38134
- * then handle the event by a configured CommandExecution or propagate the event to its parent, until no
38135
- * parent exits anymore and the browser can handle the executed shortcut
38136
- *
38137
38462
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
38138
38463
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
38139
38464
  * of the syntax of the settings object.
@@ -39808,7 +40133,7 @@ declare namespace sap {
39808
40133
  *
39809
40134
  * The configuration above can be accessed via `sample.Component.getMetadata().getCustomEntry("my.custom.config")`.
39810
40135
  *
39811
- * @deprecated As of version 1.27.1. Please use the sap.ui.core.ComponentMetadata#getManifestEntry
40136
+ * @deprecated As of version 1.27.1. without replacement.
39812
40137
  *
39813
40138
  * @returns custom Component configuration with the specified key.
39814
40139
  */
@@ -41334,7 +41659,7 @@ declare namespace sap {
41334
41659
  /**
41335
41660
  * The dependent to add; if empty, nothing is inserted
41336
41661
  */
41337
- oDependent: sap.ui.core.Element
41662
+ oDependent: sap.ui.base.ManagedObject
41338
41663
  ): this;
41339
41664
  /**
41340
41665
  * Adds some dragDropConfig to the aggregation {@link #getDragDropConfig dragDropConfig}.
@@ -41718,11 +42043,11 @@ declare namespace sap {
41718
42043
  * Gets content of aggregation {@link #getDependents dependents}.
41719
42044
  *
41720
42045
  * Dependents are not rendered, but their databinding context and lifecycle are bound to the aggregating
41721
- * Element.
42046
+ * ManagedObject.
41722
42047
  *
41723
42048
  * @since 1.19
41724
42049
  */
41725
- getDependents(): sap.ui.core.Element[];
42050
+ getDependents(): sap.ui.base.ManagedObject[];
41726
42051
  /**
41727
42052
  * Returns the best suitable DOM Element that represents this UI5 Element. By default the DOM Element with
41728
42053
  * the same ID as this Element is returned. Subclasses should override this method if the lookup via id
@@ -41895,8 +42220,8 @@ declare namespace sap {
41895
42220
  oCustomData: sap.ui.core.CustomData
41896
42221
  ): int;
41897
42222
  /**
41898
- * Checks for the provided `sap.ui.core.Element` in the aggregation {@link #getDependents dependents}. and
41899
- * returns its index if found or -1 otherwise.
42223
+ * Checks for the provided `sap.ui.base.ManagedObject` in the aggregation {@link #getDependents dependents}.
42224
+ * and returns its index if found or -1 otherwise.
41900
42225
  *
41901
42226
  * @since 1.19
41902
42227
  *
@@ -41906,7 +42231,7 @@ declare namespace sap {
41906
42231
  /**
41907
42232
  * The dependent whose index is looked for
41908
42233
  */
41909
- oDependent: sap.ui.core.Element
42234
+ oDependent: sap.ui.base.ManagedObject
41910
42235
  ): int;
41911
42236
  /**
41912
42237
  * Checks for the provided `sap.ui.core.dnd.DragDropBase` in the aggregation {@link #getDragDropConfig dragDropConfig}.
@@ -41970,7 +42295,7 @@ declare namespace sap {
41970
42295
  /**
41971
42296
  * The dependent to insert; if empty, nothing is inserted
41972
42297
  */
41973
- oDependent: sap.ui.core.Element,
42298
+ oDependent: sap.ui.base.ManagedObject,
41974
42299
  /**
41975
42300
  * The `0`-based index the dependent should be inserted at; for a negative value of `iIndex`, the dependent
41976
42301
  * is inserted at position 0; for a value greater than the current size of the aggregation, the dependent
@@ -42109,7 +42434,7 @@ declare namespace sap {
42109
42434
  *
42110
42435
  * @returns An array of the removed elements (might be empty)
42111
42436
  */
42112
- removeAllDependents(): sap.ui.core.Element[];
42437
+ removeAllDependents(): sap.ui.base.ManagedObject[];
42113
42438
  /**
42114
42439
  * Removes all the controls from the aggregation {@link #getDragDropConfig dragDropConfig}.
42115
42440
  *
@@ -42143,8 +42468,8 @@ declare namespace sap {
42143
42468
  /**
42144
42469
  * The dependent to remove or its index or id
42145
42470
  */
42146
- vDependent: int | string | sap.ui.core.Element
42147
- ): sap.ui.core.Element | null;
42471
+ vDependent: int | string | sap.ui.base.ManagedObject
42472
+ ): sap.ui.base.ManagedObject | null;
42148
42473
  /**
42149
42474
  * Removes a dragDropConfig from the aggregation {@link #getDragDropConfig dragDropConfig}.
42150
42475
  *
@@ -42852,6 +43177,8 @@ declare namespace sap {
42852
43177
  /**
42853
43178
  * Gets current value of property {@link #getType type}.
42854
43179
  *
43180
+ * The Fragment type.
43181
+ *
42855
43182
  *
42856
43183
  * @returns Value of property `type`
42857
43184
  */
@@ -42859,6 +43186,8 @@ declare namespace sap {
42859
43186
  /**
42860
43187
  * Sets a new value for property {@link #getType type}.
42861
43188
  *
43189
+ * The Fragment type.
43190
+ *
42862
43191
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
42863
43192
  *
42864
43193
  *
@@ -44655,8 +44984,9 @@ declare namespace sap {
44655
44984
  * is e.g. useful when an application merges the CSS for multiple libraries and already loaded the resulting
44656
44985
  * stylesheet.
44657
44986
  *
44658
- * If a list of library `dependencies` is specified in the info object, those libraries will be loaded
44659
- * synchronously if they haven't been loaded yet.
44987
+ *
44988
+ * - If a list of library `dependencies` is specified in the info object, those libraries will be loaded
44989
+ * synchronously if they haven't been loaded yet.
44660
44990
  *
44661
44991
  * **Note:** Dependencies between libraries have to be modeled consistently in several places:
44662
44992
  * - Both eager and lazy dependencies have to be modelled in the `.library` file.
@@ -44687,10 +45017,72 @@ declare namespace sap {
44687
45017
  * Library API-Version 2:
44688
45018
  *
44689
45019
  * The Library API Version 2 has been introduced to avoid access to the global namespace when retrieving
44690
- * enum types. With Library API Version 2 a library must declare its enum types via {@link module:sap/ui/base/DataType.registerEnum DataType.registerEnum}.
45020
+ * enum types. With Library API Version 2 a library must declare its enum types via {@link sap.ui.base.DataType.registerEnum }
45021
+ * as described in the "Defining Enums" section below.
45022
+ *
45023
+ * Library API version 2 is defined as a number (int) in the library's `init()` call:
45024
+ * ```javascript
45025
+ *
45026
+ * var thisLib = Library.init({
45027
+ * apiVersion: 2,
45028
+ * name: "my.library",
45029
+ * ...
45030
+ * });
45031
+ * ```
45032
+ *
45033
+ *
45034
+ * **Important:** The object returned by `Library.init()` should be used as the return value of the `library.js`
45035
+ * module.
45036
+ *
45037
+ * **Defining Enums**
45038
+ *
45039
+ * Enums that are exposed through a library (not as separate modules) should be defined as properties on
45040
+ * the object returned by `Library.init()`. Each enum must be registered via {@link sap.ui.base.DataType.registerEnum }
45041
+ * to make it available to the framework.
45042
+ *
45043
+ * Example for a simple enum definition:
45044
+ * ```javascript
45045
+ *
45046
+ * // The return value "thisLib" will be used to expose enums
45047
+ * var thisLib = Library.init({
45048
+ * apiVersion: 2,
45049
+ * name: "my.library",
45050
+ * ...
45051
+ * });
45052
+ *
45053
+ * // Note that enum keys and values must match
45054
+ * thisLib.MyEnumType = {
45055
+ * Small: "Small",
45056
+ * Medium: "Medium",
45057
+ * Large: "Large"
45058
+ * };
45059
+ *
45060
+ * // make sure to register the enum and make it know to the framework for later type checks
45061
+ * DataType.registerEnum("my.library.MyEnumType", thisLib.MyEnumType);
45062
+ * ```
45063
+ *
45064
+ *
45065
+ * **Special case: enums in nested namespaces**
45066
+ *
45067
+ * Ensure to create the namespace first and then define the enum:
45068
+ *
45069
+ *
45070
+ * ```javascript
45071
+ *
45072
+ * thisLib.cards = thisLib.cards || {};
45073
+ *
45074
+ * thisLib.cards.HeaderPosition = {
45075
+ * Top: "Top",
45076
+ * Bottom: "Bottom"
45077
+ * };
45078
+ *
45079
+ * DataType.registerEnum("my.library.cards.HeaderPosition", thisLib.cards.HeaderPosition);
45080
+ * ```
44691
45081
  *
44692
45082
  *
44693
- * @returns Returns the library namespace, based on the given library name.
45083
+ *
45084
+ * @returns Returns an object with the exports of the library (enums, helpers, ...). This object should
45085
+ * be used as the return value of the `library.js` module from which `Library.init` is called.
44694
45086
  */
44695
45087
  static init(
44696
45088
  /**
@@ -47094,6 +47486,9 @@ declare namespace sap {
47094
47486
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
47095
47487
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
47096
47488
  *
47489
+ * Fired when the popup has completely closed (after any animation).
47490
+ *
47491
+ * @since 1.2
47097
47492
  *
47098
47493
  * @returns Reference to `this` in order to allow method chaining
47099
47494
  */
@@ -47118,6 +47513,9 @@ declare namespace sap {
47118
47513
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
47119
47514
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
47120
47515
  *
47516
+ * Fired when the popup has completely closed (after any animation).
47517
+ *
47518
+ * @since 1.2
47121
47519
  *
47122
47520
  * @returns Reference to `this` in order to allow method chaining
47123
47521
  */
@@ -47137,6 +47535,9 @@ declare namespace sap {
47137
47535
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
47138
47536
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
47139
47537
  *
47538
+ * Fired when the popup has completely opened (after any animation).
47539
+ *
47540
+ * @since 1.2
47140
47541
  *
47141
47542
  * @returns Reference to `this` in order to allow method chaining
47142
47543
  */
@@ -47161,6 +47562,9 @@ declare namespace sap {
47161
47562
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
47162
47563
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
47163
47564
  *
47565
+ * Fired when the popup has completely opened (after any animation).
47566
+ *
47567
+ * @since 1.2
47164
47568
  *
47165
47569
  * @returns Reference to `this` in order to allow method chaining
47166
47570
  */
@@ -47198,6 +47602,7 @@ declare namespace sap {
47198
47602
  *
47199
47603
  * The passed function and listener object must match the ones used for event registration.
47200
47604
  *
47605
+ * @since 1.2
47201
47606
  *
47202
47607
  * @returns Reference to `this` in order to allow method chaining
47203
47608
  */
@@ -47216,6 +47621,7 @@ declare namespace sap {
47216
47621
  *
47217
47622
  * The passed function and listener object must match the ones used for event registration.
47218
47623
  *
47624
+ * @since 1.2
47219
47625
  *
47220
47626
  * @returns Reference to `this` in order to allow method chaining
47221
47627
  */
@@ -47237,6 +47643,7 @@ declare namespace sap {
47237
47643
  /**
47238
47644
  * Fires event {@link #event:closed closed} to attached listeners.
47239
47645
  *
47646
+ * @since 1.2
47240
47647
  * @ui5-protected Do not call from applications (only from related classes in the framework)
47241
47648
  *
47242
47649
  * @returns Reference to `this` in order to allow method chaining
@@ -47250,6 +47657,7 @@ declare namespace sap {
47250
47657
  /**
47251
47658
  * Fires event {@link #event:opened opened} to attached listeners.
47252
47659
  *
47660
+ * @since 1.2
47253
47661
  * @ui5-protected Do not call from applications (only from related classes in the framework)
47254
47662
  *
47255
47663
  * @returns Reference to `this` in order to allow method chaining
@@ -55402,47 +55810,15 @@ declare namespace sap {
55402
55810
  */
55403
55811
  namespace json {
55404
55812
  /**
55405
- * List binding implementation for JSON format.
55813
+ * List binding implementation for JSON model.
55406
55814
  *
55407
55815
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
55408
55816
  */
55409
55817
  class JSONListBinding extends sap.ui.model.ClientListBinding {
55410
55818
  /**
55411
- * Creates a new JSONListBinding.
55412
- *
55413
- * This constructor should only be called by subclasses or model implementations, not by application or
55414
- * control code. Such code should use {@link sap.ui.model.json.JSONModel#bindList JSONModel#bindList} on
55415
- * the corresponding model instance instead.
55416
- *
55417
55819
  * @ui5-protected Do not call from applications (only from related classes in the framework)
55418
55820
  */
55419
- protected constructor(
55420
- /**
55421
- * Model instance that this binding is created for and that it belongs to
55422
- */
55423
- oModel: sap.ui.model.json.JSONModel,
55424
- /**
55425
- * Binding path to be used for this binding
55426
- */
55427
- sPath: string,
55428
- /**
55429
- * Binding context relative to which a relative binding path will be resolved
55430
- */
55431
- oContext: sap.ui.model.Context,
55432
- /**
55433
- * The sorters used initially; call {@link #sort} to replace them
55434
- */
55435
- aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
55436
- /**
55437
- * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
55438
- * to replace them
55439
- */
55440
- aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
55441
- /**
55442
- * Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
55443
- */
55444
- mParameters?: object
55445
- );
55821
+ protected constructor();
55446
55822
  }
55447
55823
  /**
55448
55824
  * Model implementation for the JSON format.
@@ -55504,6 +55880,145 @@ declare namespace sap {
55504
55880
  * @returns Metadata object describing this class
55505
55881
  */
55506
55882
  static getMetadata(): sap.ui.base.Metadata;
55883
+ /**
55884
+ * Returns the value of the property for the given `sPath` and `oContext`.
55885
+ *
55886
+ * @deprecated As of version 1.145.0. use {@link #getProperty} instead
55887
+ *
55888
+ * @returns The value for the given `sPath` and `oContext`. If the property path derived from the given
55889
+ * `sPath` and `oContext` is absolute (starts with a "/") but does not lead to a property in the data structure,
55890
+ * `undefined` is returned. If the property `sPath` is not absolute, `null` is returned.
55891
+ */
55892
+ static getObject(
55893
+ /**
55894
+ * The path to the object you want to read
55895
+ */
55896
+ sPath: string,
55897
+ /**
55898
+ * The context that resolves the path
55899
+ */
55900
+ oContext?: sap.ui.model.Context
55901
+ ): any | null | undefined;
55902
+ /**
55903
+ * Returns the original value for the property with the given `sPath` and `oContext`.
55904
+ *
55905
+ * @deprecated As of version 1.145.0. use {@link #getProperty} instead
55906
+ *
55907
+ * @returns The value of the property for the given `sPath` and `oContext`. If the property path derived
55908
+ * from the given `sPath` and `oContext` is absolute (starts with a "/") but does not lead to a property
55909
+ * in the data structure, `undefined` is returned. If the property `sPath` is not absolute, `null` is returned.
55910
+ */
55911
+ static getOriginalProperty(
55912
+ /**
55913
+ * The path/name of the property
55914
+ */
55915
+ sPath: string,
55916
+ /**
55917
+ * Context for accessing the property value
55918
+ */
55919
+ oContext?: sap.ui.model.Context
55920
+ ): any | null | undefined;
55921
+ /**
55922
+ * Creates a new {@link sap.ui.model.json.JSONListBinding}.
55923
+ *
55924
+ *
55925
+ * @returns The newly created JSONListBinding
55926
+ */
55927
+ bindList(
55928
+ /**
55929
+ * The path to the list or array to bind
55930
+ */
55931
+ sPath: string,
55932
+ /**
55933
+ * The context for the binding. This is mandatory when a relative binding path is provided.
55934
+ */
55935
+ oContext?: sap.ui.model.Context,
55936
+ /**
55937
+ * The sorters used initially. To replace them, call {@link sap.ui.model.ListBinding#sort}.
55938
+ */
55939
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
55940
+ /**
55941
+ * The filters initially used with type {@link sap.ui.model.FilterType.Application}. To replace them, call
55942
+ * {@link sap.ui.model.ListBinding#filter}.
55943
+ */
55944
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
55945
+ /**
55946
+ * Map of optional parameters as defined by subclasses. This class does not introduce any own parameters.
55947
+ */
55948
+ mParameters?: Record<string, any>
55949
+ ): sap.ui.model.json.JSONListBinding;
55950
+ /**
55951
+ * Creates a new {@link sap.ui.model.json.JSONPropertyBinding}.
55952
+ *
55953
+ *
55954
+ * @returns The newly created JSONPropertyBinding
55955
+ */
55956
+ bindProperty(
55957
+ /**
55958
+ * The path to the property to bind
55959
+ */
55960
+ sPath: string,
55961
+ /**
55962
+ * The context for the binding. This is mandatory when a relative binding path is provided.
55963
+ */
55964
+ oContext?: sap.ui.model.Context,
55965
+ /**
55966
+ * Additional model-specific parameters
55967
+ */
55968
+ mParameters?: {
55969
+ /**
55970
+ * Whether this binding ignores model messages instead of propagating them to the control. Supported since
55971
+ * 1.119.0. Some composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages
55972
+ * for some of their parts, depending on their format options. Setting this parameter to `true` or `false`
55973
+ * overrules the automatism of the type.
55974
+ *
55975
+ * **Example:** A binding for a currency code is used in a composite binding for rendering the proper number
55976
+ * of decimals, but the currency code itself is not displayed in the attached control. In this case, messages
55977
+ * for the currency code aren't displayed at that control, only messages for the amount.
55978
+ */
55979
+ ignoreMessages?: boolean;
55980
+ }
55981
+ ): sap.ui.model.json.JSONPropertyBinding;
55982
+ /**
55983
+ * Creates a new {@link sap.ui.model.json.JSONTreeBinding}. The bound data can contain JSON objects and
55984
+ * arrays. Both are used to build the tree structure.
55985
+ *
55986
+ *
55987
+ * @returns The newly created JSONTreeBinding
55988
+ */
55989
+ bindTree(
55990
+ /**
55991
+ * The path pointing to the tree or array that is bound
55992
+ */
55993
+ sPath: string,
55994
+ /**
55995
+ * The context for the binding. This is mandatory when a relative binding path is provided.
55996
+ */
55997
+ oContext?: sap.ui.model.Context,
55998
+ /**
55999
+ * The filters initially used with type {@link sap.ui.model.FilterType.Application}. To replace them, call
56000
+ * {@link sap.ui.model.TreeBinding#filter}.
56001
+ */
56002
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
56003
+ /**
56004
+ * Additional model-specific parameters
56005
+ */
56006
+ mParameters?: {
56007
+ /**
56008
+ * Keys of arrays to be used for building the tree structure. If not specified, all arrays and objects in
56009
+ * the bound data are used. Note: For arrays nested within other arrays with different names, add both array
56010
+ * names to `arrayNames`. To include a nested array in the hierarchy, you must list the names of all containing
56011
+ * arrays. If an array name is missing from the list, its child arrays are also excluded from the hierarchy,
56012
+ * even if you add them to `arrayNames`. If this parameter is set, all other objects and arrays in the bound
56013
+ * data are ignored.
56014
+ */
56015
+ arrayNames?: string[];
56016
+ },
56017
+ /**
56018
+ * The sorters used initially. To replace them, call {@link sap.ui.model.TreeBinding#sort}.
56019
+ */
56020
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
56021
+ ): sap.ui.model.json.JSONTreeBinding;
55507
56022
  /**
55508
56023
  * Returns a Promise of the current data-loading state. Every currently running {@link sap.ui.model.json.JSONModel#loadData }
55509
56024
  * call is respected by the returned Promise. This also includes a potential loadData call from the JSONModel's
@@ -55523,7 +56038,7 @@ declare namespace sap {
55523
56038
  */
55524
56039
  getJSON(): string;
55525
56040
  /**
55526
- * Returns the value for the property with the given path and context.
56041
+ * Returns the value for the given `sPath` and `oContext`.
55527
56042
  *
55528
56043
  *
55529
56044
  * @returns The value of the property. If the property is not found, `null` or `undefined` is returned.
@@ -55647,38 +56162,15 @@ declare namespace sap {
55647
56162
  ): boolean;
55648
56163
  }
55649
56164
  /**
55650
- * Property binding implementation for JSON format.
56165
+ * Property binding implementation for JSON model.
55651
56166
  *
55652
56167
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
55653
56168
  */
55654
56169
  class JSONPropertyBinding extends sap.ui.model.ClientPropertyBinding {
55655
56170
  /**
55656
- * Creates a new JSONListBinding.
55657
- *
55658
- * This constructor should only be called by subclasses or model implementations, not by application or
55659
- * control code. Such code should use {@link sap.ui.model.json.JSONModel#bindProperty JSONModel#bindProperty }
55660
- * on the corresponding model instance instead.
55661
- *
55662
56171
  * @ui5-protected Do not call from applications (only from related classes in the framework)
55663
56172
  */
55664
- protected constructor(
55665
- /**
55666
- * Model instance that this binding is created for and that it belongs to
55667
- */
55668
- oModel: sap.ui.model.json.JSONModel,
55669
- /**
55670
- * Binding path to be used for this binding
55671
- */
55672
- sPath: string,
55673
- /**
55674
- * Binding context relative to which a relative binding path will be resolved
55675
- */
55676
- oContext: sap.ui.model.Context,
55677
- /**
55678
- * Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
55679
- */
55680
- mParameters?: object
55681
- );
56173
+ protected constructor();
55682
56174
 
55683
56175
  /**
55684
56176
  * Creates a new subclass of class sap.ui.model.json.JSONPropertyBinding with name `sClassName` and enriches
@@ -55718,59 +56210,15 @@ declare namespace sap {
55718
56210
  static getMetadata(): sap.ui.base.Metadata;
55719
56211
  }
55720
56212
  /**
55721
- * Tree binding implementation for JSON format.
55722
- *
55723
- * The bound data can contain JSON objects and arrays. Both will be used to build the tree structure. You
55724
- * can optionally define a set of arrays to be used for the tree structure in the parameter `arrayNames`.
55725
- * If this parameter is set, all other objects and arrays will be ignored.
56213
+ * Tree binding implementation for JSON model. See {@link sap.ui.model.json.JSONModel#bindTree}
55726
56214
  *
55727
56215
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
55728
56216
  */
55729
56217
  class JSONTreeBinding extends sap.ui.model.ClientTreeBinding {
55730
56218
  /**
55731
- * Creates a new JSONListBinding.
55732
- *
55733
- * This constructor should only be called by subclasses or model implementations, not by application or
55734
- * control code. Such code should use {@link sap.ui.model.json.JSONModel#bindTree JSONModel#bindTree} on
55735
- * the corresponding model instance instead.
55736
- *
55737
56219
  * @ui5-protected Do not call from applications (only from related classes in the framework)
55738
56220
  */
55739
- protected constructor(
55740
- /**
55741
- * Model instance that this binding is created for and that it belongs to
55742
- */
55743
- oModel: sap.ui.model.json.JSONModel,
55744
- /**
55745
- * Path pointing to the tree or array that should be bound
55746
- */
55747
- sPath: string,
55748
- /**
55749
- * Context object for this binding, mandatory when a relative binding path is given
55750
- */
55751
- oContext?: object,
55752
- /**
55753
- * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
55754
- * to replace them
55755
- */
55756
- aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
55757
- /**
55758
- * Additional model-specific parameters
55759
- */
55760
- mParameters?: {
55761
- /**
55762
- * Keys of arrays to be used for building the tree structure. If not specified, all arrays and objects in
55763
- * the bound data will be used. Note that for arrays nested inside differently named arrays, you need to
55764
- * add both to `arrayNames`. You always have to add the complete parent chain. If any array is ignored,
55765
- * its child arrays will be ignored as well even if they have been added to `arrayNames`.
55766
- */
55767
- arrayNames?: string[];
55768
- },
55769
- /**
55770
- * The sorters used initially; call {@link #sort} to replace them
55771
- */
55772
- aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
55773
- );
56221
+ protected constructor();
55774
56222
  }
55775
56223
  }
55776
56224
  /**
@@ -59472,8 +59920,8 @@ declare namespace sap {
59472
59920
  */
59473
59921
  groupId?: string;
59474
59922
  /**
59475
- * ID of the `ChangeSet` that this request should belong to. If not provided, the `changeSetId` defined
59476
- * for the type of the entity to be deleted is used.
59923
+ * ID of the change set that this request should belong to. If not provided, the `changeSetId` defined for
59924
+ * the type of the entity to be deleted is used.
59477
59925
  */
59478
59926
  changeSetId?: string;
59479
59927
  /**
@@ -60391,7 +60839,7 @@ declare namespace sap {
60391
60839
  */
60392
60840
  mParameters?: {
60393
60841
  /**
60394
- * The ID of the `ChangeSet` that this request should belong to
60842
+ * The ID of the change set that this request should belong to
60395
60843
  */
60396
60844
  changeSetId?: string;
60397
60845
  /**
@@ -61550,7 +61998,7 @@ declare namespace sap {
61550
61998
  */
61551
61999
  adjustDeepPath?: Function;
61552
62000
  /**
61553
- * ID of the `ChangeSet` that this request belongs to
62001
+ * ID of the change set that this request belongs to
61554
62002
  */
61555
62003
  changeSetId?: string;
61556
62004
  /**
@@ -61573,7 +62021,7 @@ declare namespace sap {
61573
62021
  * - the HTTP method used for the function import is "POST",
61574
62022
  * - the function import returns a single entity,
61575
62023
  * - the back-end service must support the "Content-ID" header,
61576
- * - the back end must allow GET requests relative to this content ID outside the changeset within the
62024
+ * - the back end must allow GET requests relative to this content ID outside the change set within the
61577
62025
  * `$batch` request. The success and error callback functions are called only once, even if there
61578
62026
  * are two requests in the `$batch` related to a single call of {@link #callFunction}.
61579
62027
  * - If both requests succeed, the success callback is called with the merged data of the POST and the
@@ -61692,7 +62140,7 @@ declare namespace sap {
61692
62140
  */
61693
62141
  groupId?: string;
61694
62142
  /**
61695
- * ID of the `ChangeSet` that this request should belong to
62143
+ * ID of the change set that this request should belong to
61696
62144
  */
61697
62145
  changeSetId?: string;
61698
62146
  /**
@@ -61784,7 +62232,7 @@ declare namespace sap {
61784
62232
  * The parameter `expand` is supported since 1.78.0. If this parameter is set, the given navigation properties
61785
62233
  * are expanded automatically with the same $batch request in which the POST request for the creation is
61786
62234
  * contained. Ensure that the batch mode is used and the back-end service supports GET requests relative
61787
- * to a content ID outside the changeset. The success and error callback functions are called only once,
62235
+ * to a content ID outside the change set. The success and error callback functions are called only once,
61788
62236
  * even if there are two requests in the `$batch` related to a single call of {@link #createEntry}:
61789
62237
  *
61790
62238
  * - a POST request for creating an entity,
@@ -61830,7 +62278,7 @@ declare namespace sap {
61830
62278
  */
61831
62279
  batchGroupId?: string;
61832
62280
  /**
61833
- * The ID of the `ChangeSet` that this request should belong to
62281
+ * The ID of the change set that this request should belong to
61834
62282
  */
61835
62283
  changeSetId?: string;
61836
62284
  /**
@@ -61853,7 +62301,7 @@ declare namespace sap {
61853
62301
  * GET request. **Note:** The following prerequisites must be fulfilled:
61854
62302
  * - batch mode must be enabled; see constructor parameter `useBatch`,
61855
62303
  * - the back-end service must support the "Content-ID" header,
61856
- * - the back end must allow GET requests relative to this content ID outside the changeset within the
62304
+ * - the back end must allow GET requests relative to this content ID outside the change set within the
61857
62305
  * `$batch` request.
61858
62306
  */
61859
62307
  expand?: string;
@@ -62822,7 +63270,7 @@ declare namespace sap {
62822
63270
  */
62823
63271
  groupId?: string;
62824
63272
  /**
62825
- * ID of the `ChangeSet` that this request should belong to
63273
+ * ID of the change set that this request should belong to
62826
63274
  */
62827
63275
  changeSetId?: string;
62828
63276
  /**
@@ -63193,7 +63641,7 @@ declare namespace sap {
63193
63641
  */
63194
63642
  groupId?: string;
63195
63643
  /**
63196
- * ID of the `ChangeSet` that this request should belong to
63644
+ * ID of the change set that this request should belong to
63197
63645
  */
63198
63646
  changeSetId?: string;
63199
63647
  /**
@@ -63850,6 +64298,8 @@ declare namespace sap {
63850
64298
 
63851
64299
  /**
63852
64300
  * Parameters of the ODataModel#parseError event.
64301
+ *
64302
+ * @deprecated As of version 1.37.0. this event is not supported
63853
64303
  */
63854
64304
  interface ODataModel$ParseErrorEventParameters
63855
64305
  extends sap.ui.model.Model$ParseErrorEventParameters {}
@@ -63873,18 +64323,24 @@ declare namespace sap {
63873
64323
 
63874
64324
  /**
63875
64325
  * Parameters of the ODataModel#requestCompleted event.
64326
+ *
64327
+ * @deprecated As of version 1.37.0. this event is not supported
63876
64328
  */
63877
64329
  interface ODataModel$RequestCompletedEventParameters
63878
64330
  extends sap.ui.model.Model$RequestCompletedEventParameters {}
63879
64331
 
63880
64332
  /**
63881
64333
  * Parameters of the ODataModel#requestFailed event.
64334
+ *
64335
+ * @deprecated As of version 1.37.0. this event is not supported
63882
64336
  */
63883
64337
  interface ODataModel$RequestFailedEventParameters
63884
64338
  extends sap.ui.model.Model$RequestFailedEventParameters {}
63885
64339
 
63886
64340
  /**
63887
64341
  * Parameters of the ODataModel#requestSent event.
64342
+ *
64343
+ * @deprecated As of version 1.37.0. this event is not supported
63888
64344
  */
63889
64345
  interface ODataModel$RequestSentEventParameters
63890
64346
  extends sap.ui.model.Model$RequestSentEventParameters {}
@@ -64692,7 +65148,7 @@ declare namespace sap {
64692
65148
  * (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
64693
65149
  * Such a deletion is not a pending change.
64694
65150
  *
64695
- * When using data aggregation without group levels, single entities can be deleted (@experimental as of
65151
+ * When using data aggregation without `groupLevels`, single entities can be deleted (@experimental as of
64696
65152
  * version 1.144.0, see {@link #isAggregated}). The same restrictions as for a recursive hierarchy apply.
64697
65153
  * See:
64698
65154
  * #hasPendingChanges
@@ -64735,12 +65191,15 @@ declare namespace sap {
64735
65191
  bDoNotRequestCount?: boolean
64736
65192
  ): Promise<void>;
64737
65193
  /**
65194
+ * Note: You may want to call {@link #delete} instead in order to delete the OData entity on the server
65195
+ * side.
65196
+ *
64738
65197
  * Destroys this context, that is, it removes this context from all dependent bindings and drops references
64739
65198
  * to {@link #getBinding binding} and {@link #getModel model}, so that the context cannot be used anymore;
64740
65199
  * it keeps path and index for debugging purposes. A destroyed context can be recognized by calling {@link #getBinding},
64741
65200
  * which returns `undefined`.
64742
65201
  *
64743
- * **BEWARE:** Do not call this function! The lifetime of an OData V4 context is completely controlled by
65202
+ * **BEWARE: Do not call this function!** The lifetime of an OData V4 context is completely controlled by
64744
65203
  * its binding.
64745
65204
  * See:
64746
65205
  * sap.ui.base.Object#destroy
@@ -65076,6 +65535,10 @@ declare namespace sap {
65076
65535
  * Refreshes the single entity represented by this context. Use {@link #requestRefresh} if you want to wait
65077
65536
  * for the refresh.
65078
65537
  *
65538
+ * When using data aggregation without `groupLevels` and without `"grandTotal like 1.84"` (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}),
65539
+ * single entities (see {@link #isAggregated}) can be refreshed and the grand total is updated accordingly
65540
+ * (@experimental as of version 1.145.0).
65541
+ *
65079
65542
  * @since 1.53.0
65080
65543
  */
65081
65544
  refresh(
@@ -65209,7 +65672,7 @@ declare namespace sap {
65209
65672
  */
65210
65673
  sGroupId?: string,
65211
65674
  /**
65212
- * Allows to remove the context
65675
+ * Allows to remove the context, see {@link #refresh} for details
65213
65676
  */
65214
65677
  bAllowRemoval?: boolean
65215
65678
  ): Promise<void>;
@@ -65245,6 +65708,12 @@ declare namespace sap {
65245
65708
  * 'dataRequested', can instead be done before calling {@link #requestSideEffects}. 'dataReceived',
65246
65709
  * can instead be done once the `oPromise` returned by {@link #requestSideEffects} fulfills or rejects (using
65247
65710
  * `oPromise.then(function () {...}, function () {...})`).
65711
+ *
65712
+ * Since 1.109.0, this context can also represent a node in a recursive hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
65713
+ *
65714
+ * When using data aggregation but no recursive hierarchy, and without `groupLevels` or `"grandTotal like
65715
+ * 1.84"` (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}), this context can also represent
65716
+ * a single entity (see {@link #isAggregated}, @experimental as of version 1.146.0).
65248
65717
  * See:
65249
65718
  * sap.ui.model.odata.v4.ODataContextBinding#getBoundContext
65250
65719
  * sap.ui.model.odata.v4.ODataContextBinding#invoke
@@ -65253,8 +65722,8 @@ declare namespace sap {
65253
65722
  *
65254
65723
  * @since 1.61.0
65255
65724
  *
65256
- * @returns A promise which is resolved without a defined result, or rejected with an error if loading of
65257
- * side effects fails. Use it to set fields affected by side effects to read-only before {@link #requestSideEffects }
65725
+ * @returns A promise which is resolved without a defined result, or rejected with an error if the side
65726
+ * effects fail to load. Use it to set fields affected by side effects to read-only before {@link #requestSideEffects }
65258
65727
  * and make them editable again when the promise resolves; in the error handler, you can repeat the loading
65259
65728
  * of side effects.
65260
65729
  * The promise is rejected if the call wants to refresh a whole list binding (via header context or an
@@ -65274,8 +65743,11 @@ declare namespace sap {
65274
65743
  *
65275
65744
  * Since 1.82.0, absolute paths are supported. Absolute paths must start with the entity container (example
65276
65745
  * "/com.sap.gateway.default.iwbep.tea_busi.v0001.Container/TEAMS") of the service. All (navigation) properties
65277
- * in the complete model matching such an absolute path are updated. Since 1.85.0, "14.3.11 Expression edm:String"
65278
- * is accepted as well.
65746
+ * in the complete model matching such an absolute path are updated. Since 1.146.0, {@link sap.ui.model.odata.v4.ODataModel#requestSideEffects }
65747
+ * can be used as well.
65748
+ *
65749
+ * Since 1.85.0, "14.3.11 Expression edm:String" is accepted as well. Since 1.145.0, you can use `null`
65750
+ * values (and `{$Null : null}`) as synonyms for empty navigation property paths.
65279
65751
  *
65280
65752
  * Since 1.108.8, a property path matching the "com.sap.vocabularies.Common.v1.Messages" annotation of a
65281
65753
  * list binding's entity type is treated specially for a row context of a list binding: It is loaded even
@@ -65288,8 +65760,8 @@ declare namespace sap {
65288
65760
  | string
65289
65761
  >,
65290
65762
  /**
65291
- * The group ID to be used (since 1.69.0); if not specified, the update group ID for the context's binding
65292
- * is used, see {@link #getUpdateGroupId}. If a different group ID is specified, make sure that {@link #requestSideEffects }
65763
+ * The group ID to be used (since 1.69.0). If not specified, the {@link #getUpdateGroupId update group ID }
65764
+ * for the context's binding is used. If a different group ID is specified, make sure that {@link #requestSideEffects }
65293
65765
  * is called after the corresponding updates have been successfully processed by the server and that there
65294
65766
  * are no pending changes for the affected properties.
65295
65767
  */
@@ -65326,9 +65798,10 @@ declare namespace sap {
65326
65798
  * Note: This can be used for single entities in a data aggregation scenario (@experimental as of version
65327
65799
  * 1.144.0), see {@link #isAggregated}. Such a kept-alive context
65328
65800
  * can be used as a binding context, can be used for updating data (see {@link #setProperty}),
65329
- * is refreshed when its list binding's {@link sap.ui.model.odata.v4.ODataListBinding#refresh}) is called,
65330
- * and is refreshed when {@link #requestSideEffects}) is called on its list binding's header context.
65331
- * Other APIs are not supported.
65801
+ * can be refreshed (see {@link #refresh} and {@link #requestRefresh}), is refreshed when its list
65802
+ * binding's {@link sap.ui.model.odata.v4.ODataListBinding#refresh}) is called, and is refreshed when
65803
+ * {@link #requestSideEffects}) is called on its list binding's header context. Other APIs are not
65804
+ * supported.
65332
65805
  * See:
65333
65806
  * #isKeepAlive
65334
65807
  *
@@ -65863,6 +66336,7 @@ declare namespace sap {
65863
66336
  * Method not supported
65864
66337
  *
65865
66338
  * @since 1.37.0
66339
+ * @deprecated As of version 1.37.0. calling this method is not supported
65866
66340
  */
65867
66341
  isInitial(): boolean;
65868
66342
  /**
@@ -66299,6 +66773,9 @@ declare namespace sap {
66299
66773
  * is set to `undefined`. The created context always knows its {@link sap.ui.model.odata.v4.Context#getPath path},
66300
66774
  * which can be used for {@link #getKeepAliveContext}.
66301
66775
  *
66776
+ * When using data aggregation without `groupLevels` and without `"grandTotal like 1.84"` (see {@link #setAggregation}),
66777
+ * single entities can be created (@experimental as of version 1.146.0, see {@link sap.ui.model.odata.v4.Context#isAggregated}).
66778
+ *
66302
66779
  * @since 1.43.0
66303
66780
  *
66304
66781
  * @returns The context object for the created entity; its method {@link sap.ui.model.odata.v4.Context#created }
@@ -66503,7 +66980,8 @@ declare namespace sap {
66503
66980
  */
66504
66981
  vFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
66505
66982
  /**
66506
- * The filter type to be used
66983
+ * The filter type to be used. Since 1.146.0, you may use {@link sap.ui.model.FilterType.ApplicationBound }
66984
+ * to replace bound application filters.
66507
66985
  */
66508
66986
  sFilterType?: sap.ui.model.FilterType
66509
66987
  ): this;
@@ -66630,8 +67108,9 @@ declare namespace sap {
66630
67108
  * sap.ui.model.ListBinding#getDistinctValues
66631
67109
  *
66632
67110
  * @since 1.37.0
67111
+ * @deprecated As of version 1.37.0. calling this method is not supported
66633
67112
  */
66634
- getDistinctValues(_sPath?: string): any[];
67113
+ getDistinctValues(): any[];
66635
67114
  /**
66636
67115
  * Returns a URL by which the complete content of the list can be downloaded in JSON format. The request
66637
67116
  * delivers all entities considering the binding's query options (such as filters or sorters). Returns `null`
@@ -66814,6 +67293,7 @@ declare namespace sap {
66814
67293
  * Method not supported
66815
67294
  *
66816
67295
  * @since 1.37.0
67296
+ * @deprecated As of version 1.37.0. calling this method is not supported
66817
67297
  */
66818
67298
  isInitial(): boolean;
66819
67299
  /**
@@ -67009,10 +67489,10 @@ declare namespace sap {
67009
67489
  */
67010
67490
  aggregate?: object;
67011
67491
  /**
67012
- * Whether created nodes are shown in place at the position specified by the service (since 1.130.0); only
67013
- * the value `true` is allowed. Otherwise, created nodes are displayed out of place as the first children
67014
- * of their parent or as the first roots, but not in their usual position as defined by the service and
67015
- * the current sort order.
67492
+ * Whether created nodes are shown in place at the position specified by the service (since 1.130.0), supported
67493
+ * only if a `hierarchyQualifier` is given; only the value `true` is allowed. Otherwise, created nodes are
67494
+ * displayed out of place as the first children of their parent or as the first roots, but not in their
67495
+ * usual position as defined by the service and the current sort order.
67016
67496
  */
67017
67497
  createInPlace?: boolean;
67018
67498
  /**
@@ -67385,18 +67865,9 @@ declare namespace sap {
67385
67865
  * sap.ui.model.Model#bindTree
67386
67866
  *
67387
67867
  * @since 1.37.0
67868
+ * @deprecated As of version 1.37.0. calling this method is not supported
67388
67869
  */
67389
- bindTree(
67390
- _sPath: string,
67391
-
67392
- _oContext?: sap.ui.model.Context,
67393
-
67394
- _aFilters?: sap.ui.model.Filter[],
67395
-
67396
- _mParameters?: object,
67397
-
67398
- _aSorters?: sap.ui.model.Sorter[]
67399
- ): sap.ui.model.TreeBinding;
67870
+ bindTree(): sap.ui.model.TreeBinding;
67400
67871
  /**
67401
67872
  * Returns a snapshot of each $metadata or annotation file loaded so far, combined into a single "JSON"
67402
67873
  * object according to the streamlined OData V4 Metadata JSON Format.
@@ -67496,6 +67967,7 @@ declare namespace sap {
67496
67967
  * Method not supported
67497
67968
  *
67498
67969
  * @since 1.37.0
67970
+ * @deprecated As of version 1.37.0. calling this method is not supported
67499
67971
  */
67500
67972
  getOriginalProperty(): void;
67501
67973
  /**
@@ -67563,6 +68035,7 @@ declare namespace sap {
67563
68035
  * sap.ui.model.Model#refresh
67564
68036
  *
67565
68037
  * @since 1.37.0
68038
+ * @deprecated As of version 1.37.0. calling this method is not supported
67566
68039
  */
67567
68040
  refresh(): void;
67568
68041
  /**
@@ -67607,7 +68080,7 @@ declare namespace sap {
67607
68080
 
67608
68081
  Text: string;
67609
68082
 
67610
- UnitSpecificScale: string;
68083
+ UnitSpecificScale: number;
67611
68084
  }
67612
68085
  > | null>;
67613
68086
  /**
@@ -67911,7 +68384,7 @@ declare namespace sap {
67911
68384
 
67912
68385
  Text: string;
67913
68386
 
67914
- UnitSpecificScale: string;
68387
+ UnitSpecificScale: number;
67915
68388
  }
67916
68389
  > | null>;
67917
68390
  /**
@@ -67987,6 +68460,7 @@ declare namespace sap {
67987
68460
  * Method not supported
67988
68461
  *
67989
68462
  * @since 1.37.0
68463
+ * @deprecated As of version 1.37.0. calling this method is not supported
67990
68464
  */
67991
68465
  setLegacySyntax(): void;
67992
68466
  /**
@@ -68005,7 +68479,7 @@ declare namespace sap {
68005
68479
  *
68006
68480
  * Every resource path (relative to the service root URL, no query options) according to "4 Resource Path" in specification "OData Version 4.01. Part 2: URL Conventions" is a valid data
68007
68481
  * binding path within this model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')"
68008
- * to access an entity instance with key "A/B&C". Note that appropriate URI encoding is necessary, see the
68482
+ * to access an entity instance with key "A/B&C". Note that appropriate URL encoding is necessary, see the
68009
68483
  * example of {@link sap.ui.model.odata.v4.ODataUtils.formatLiteral}. "4.5.1 Addressing Actions" needs an
68010
68484
  * operation binding, see {@link sap.ui.model.odata.v4.ODataContextBinding}.
68011
68485
  *
@@ -68571,18 +69045,9 @@ declare namespace sap {
68571
69045
  * sap.ui.model.Model#bindTree
68572
69046
  *
68573
69047
  * @since 1.37.0
69048
+ * @deprecated As of version 1.37.0. calling this method is not supported
68574
69049
  */
68575
- bindTree(
68576
- _sPath: string,
68577
-
68578
- _oContext?: sap.ui.model.Context,
68579
-
68580
- _aFilters?: sap.ui.model.Filter[],
68581
-
68582
- _mParameters?: object,
68583
-
68584
- _aSorters?: sap.ui.model.Sorter[]
68585
- ): sap.ui.model.TreeBinding;
69050
+ bindTree(): sap.ui.model.TreeBinding;
68586
69051
  /**
68587
69052
  * Changes the HTTP headers used for data and metadata requests sent by this model.
68588
69053
  *
@@ -68699,6 +69164,7 @@ declare namespace sap {
68699
69164
  * Method not supported
68700
69165
  *
68701
69166
  * @since 1.37.0
69167
+ * @deprecated As of version 1.37.0. calling this method is not supported
68702
69168
  */
68703
69169
  destroyBindingContext(): void;
68704
69170
  /**
@@ -68845,7 +69311,7 @@ declare namespace sap {
68845
69311
  *
68846
69312
  * @since 1.107.0
68847
69313
  *
68848
- * @returns The proper URI-encoded key predicate, for example "(Sector='A%2FB%26C',ID='42')" or "('42')",
69314
+ * @returns The proper URL-encoded key predicate, for example "(Sector='A%2FB%26C',ID='42')" or "('42')",
68849
69315
  * or `undefined` if at least one key property is undefined.
68850
69316
  */
68851
69317
  getKeyPredicate(
@@ -68888,6 +69354,7 @@ declare namespace sap {
68888
69354
  * Method not supported
68889
69355
  *
68890
69356
  * @since 1.37.0
69357
+ * @deprecated As of version 1.37.0. calling this method is not supported
68891
69358
  */
68892
69359
  getObject(): void;
68893
69360
  /**
@@ -68902,6 +69369,7 @@ declare namespace sap {
68902
69369
  * Method not supported
68903
69370
  *
68904
69371
  * @since 1.37.0
69372
+ * @deprecated As of version 1.37.0. calling this method is not supported
68905
69373
  */
68906
69374
  getOriginalProperty(): void;
68907
69375
  /**
@@ -68910,6 +69378,7 @@ declare namespace sap {
68910
69378
  * sap.ui.model.Model#getProperty
68911
69379
  *
68912
69380
  * @since 1.37.0
69381
+ * @deprecated As of version 1.37.0. calling this method is not supported
68913
69382
  */
68914
69383
  getProperty(): void;
68915
69384
  /**
@@ -69004,7 +69473,7 @@ declare namespace sap {
69004
69473
  *
69005
69474
  * @since 1.107.0
69006
69475
  *
69007
- * @returns A promise that gets resolved with the proper URI-encoded key predicate, for example "(Sector='A%2FB%26C',ID='42')"
69476
+ * @returns A promise that gets resolved with the proper URL-encoded key predicate, for example "(Sector='A%2FB%26C',ID='42')"
69008
69477
  * or "('42')", or `undefined` if at least one key property is undefined. It gets rejected if the metadata
69009
69478
  * cannot be fetched, or in case the entity has no key properties according to the metadata.
69010
69479
  */
@@ -69018,6 +69487,25 @@ declare namespace sap {
69018
69487
  */
69019
69488
  oEntity: object
69020
69489
  ): Promise<string | undefined>;
69490
+ /**
69491
+ * Loads side effects for the given absolute paths on all affected bindings. For more information about
69492
+ * side effects in general, see {@link sap.ui.model.odata.v4.Context#requestSideEffects}.
69493
+ *
69494
+ * @since 1.146.0
69495
+ *
69496
+ * @returns A promise which is resolved without a defined result, or rejected with an error if the side
69497
+ * effects fail to load.
69498
+ */
69499
+ requestSideEffects(
69500
+ /**
69501
+ * The absolute paths for which to request side effects, for example "/SalesOrderList/SO_2_SOITEM/Note".
69502
+ */
69503
+ aAbsolutePaths: string[],
69504
+ /**
69505
+ * The group ID to be used. If not specified, the {@link #getUpdateGroupId update group ID} is used.
69506
+ */
69507
+ sGroupId?: string
69508
+ ): Promise<void>;
69021
69509
  /**
69022
69510
  * Resets all property changes, created entities, and entity deletions associated with the given group ID
69023
69511
  * which have not been successfully submitted via {@link #submitBatch}. Resets also invalid user input for
@@ -69063,6 +69551,7 @@ declare namespace sap {
69063
69551
  * Method not supported
69064
69552
  *
69065
69553
  * @since 1.37.0
69554
+ * @deprecated As of version 1.37.0. calling this method is not supported
69066
69555
  */
69067
69556
  setLegacySyntax(): void;
69068
69557
  /**
@@ -69082,7 +69571,7 @@ declare namespace sap {
69082
69571
  /**
69083
69572
  * A "Retry-After" handler
69084
69573
  */
69085
- fnRetryAfter: (p1: Error) => Promise<undefined>
69574
+ fnRetryAfter: (p1: Error) => Promise<void>
69086
69575
  ): void;
69087
69576
  /**
69088
69577
  * Submits the requests associated with the given group ID in one batch request. Requests from subsequent
@@ -69277,6 +69766,7 @@ declare namespace sap {
69277
69766
  * Method not supported
69278
69767
  *
69279
69768
  * @since 1.37.0
69769
+ * @deprecated As of version 1.37.0. calling this method is not supported
69280
69770
  */
69281
69771
  isInitial(): boolean;
69282
69772
  /**
@@ -69379,6 +69869,7 @@ declare namespace sap {
69379
69869
  * sap.ui.model.Binding#resume
69380
69870
  *
69381
69871
  * @since 1.37.0
69872
+ * @deprecated As of version 1.37.0. calling this method is not supported
69382
69873
  */
69383
69874
  resume(): void;
69384
69875
  /**
@@ -69443,6 +69934,7 @@ declare namespace sap {
69443
69934
  * sap.ui.model.Binding#suspend
69444
69935
  *
69445
69936
  * @since 1.37.0
69937
+ * @deprecated As of version 1.37.0. calling this method is not supported
69446
69938
  */
69447
69939
  suspend(): void;
69448
69940
  /**
@@ -69646,6 +70138,8 @@ declare namespace sap {
69646
70138
 
69647
70139
  /**
69648
70140
  * Event object of the ODataModel#parseError event.
70141
+ *
70142
+ * @deprecated As of version 1.37.0. this event is not supported
69649
70143
  */
69650
70144
  type ODataModel$ParseErrorEvent = sap.ui.base.Event<
69651
70145
  ODataModel$ParseErrorEventParameters,
@@ -69662,6 +70156,8 @@ declare namespace sap {
69662
70156
 
69663
70157
  /**
69664
70158
  * Event object of the ODataModel#requestCompleted event.
70159
+ *
70160
+ * @deprecated As of version 1.37.0. this event is not supported
69665
70161
  */
69666
70162
  type ODataModel$RequestCompletedEvent = sap.ui.base.Event<
69667
70163
  ODataModel$RequestCompletedEventParameters,
@@ -69670,6 +70166,8 @@ declare namespace sap {
69670
70166
 
69671
70167
  /**
69672
70168
  * Event object of the ODataModel#requestFailed event.
70169
+ *
70170
+ * @deprecated As of version 1.37.0. this event is not supported
69673
70171
  */
69674
70172
  type ODataModel$RequestFailedEvent = sap.ui.base.Event<
69675
70173
  ODataModel$RequestFailedEventParameters,
@@ -69678,6 +70176,8 @@ declare namespace sap {
69678
70176
 
69679
70177
  /**
69680
70178
  * Event object of the ODataModel#requestSent event.
70179
+ *
70180
+ * @deprecated As of version 1.37.0. this event is not supported
69681
70181
  */
69682
70182
  type ODataModel$RequestSentEvent = sap.ui.base.Event<
69683
70183
  ODataModel$RequestSentEventParameters,
@@ -72732,7 +73232,7 @@ declare namespace sap {
72732
73232
  /**
72733
73233
  * Appends the change batch operations to the end of the batch stack. Only `PUTPOST` or `DELETE`
72734
73234
  * batch operations should be included in the specified array. The operations in the array will be included
72735
- * in a single changeset. To embed change operations in different change sets call this method with the
73235
+ * in a single change set. To embed change operations in different change sets call this method with the
72736
73236
  * corresponding change operations again. If an illegal batch operation is added to the change set nothing
72737
73237
  * will be performed and false will be returned.
72738
73238
  *
@@ -76754,7 +77254,9 @@ declare namespace sap {
76754
77254
  aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
76755
77255
  /**
76756
77256
  * The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
76757
- * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
77257
+ * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}.
77258
+ * Since 1.146.0, you may use {@link sap.ui.model.FilterType.ApplicationBound} to set bound application
77259
+ * filters.
76758
77260
  */
76759
77261
  sFilterType?: sap.ui.model.FilterType
76760
77262
  ): this;
@@ -76837,6 +77339,26 @@ declare namespace sap {
76837
77339
  * @returns Metadata object describing this class
76838
77340
  */
76839
77341
  static getMetadata(): sap.ui.base.Metadata;
77342
+ /**
77343
+ * Creates a `sap.ui.model.ClientContextBinding`.
77344
+ *
77345
+ *
77346
+ * @returns The newly created `ClientContextBinding`
77347
+ */
77348
+ bindContext(
77349
+ /**
77350
+ * The path pointing to the property that should be bound
77351
+ */
77352
+ sPath: string,
77353
+ /**
77354
+ * The context object for this databinding
77355
+ */
77356
+ oContext?: sap.ui.model.Context,
77357
+ /**
77358
+ * Additional model-specific parameters
77359
+ */
77360
+ mParameters?: object
77361
+ ): sap.ui.model.ClientContextBinding;
76840
77362
  /**
76841
77363
  * Creates a new property binding for this model.
76842
77364
  * See:
@@ -76861,14 +77383,14 @@ declare namespace sap {
76861
77383
  */
76862
77384
  mParameters?: {
76863
77385
  /**
76864
- * Whether this binding does not propagate model messages to the control; supported since 1.119.0. Some
76865
- * composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages for some
76866
- * of their parts depending on their format options; setting this parameter to `true` or `false` overrules
76867
- * the automatism of the type.
77386
+ * Whether this binding ignores model messages instead of propagating them to the control. Supported since
77387
+ * 1.119.0. Some composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages
77388
+ * for some of their parts, depending on their format options. Setting this parameter to `true` or `false`
77389
+ * overrules the automatism of the type.
76868
77390
  *
76869
- * For example, a binding for a currency code is used in a composite binding for rendering the proper number
76870
- * of decimals, but the currency code is not displayed in the attached control. In that case, messages for
76871
- * the currency code shall not be displayed at that control, only messages for the amount.
77391
+ * **Example:** A binding for a currency code is used in a composite binding for rendering the proper number
77392
+ * of decimals, but the currency code itself is not displayed in the attached control. In this case, messages
77393
+ * for the currency code aren't displayed at that control, only messages for the amount.
76872
77394
  */
76873
77395
  ignoreMessages?: boolean;
76874
77396
  }
@@ -77092,7 +77614,9 @@ declare namespace sap {
77092
77614
  aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
77093
77615
  /**
77094
77616
  * The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
77095
- * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
77617
+ * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}.
77618
+ * Since 1.146.0, you may use {@link sap.ui.model.FilterType.ApplicationBound} to set bound application
77619
+ * filters.
77096
77620
  */
77097
77621
  sFilterType?: sap.ui.model.FilterType
77098
77622
  ): this;
@@ -78674,6 +79198,26 @@ declare namespace sap {
78674
79198
  */
78675
79199
  oListener?: object
78676
79200
  ): void;
79201
+ /**
79202
+ * Computes the binding's application filters by replacing application filters of the given type with the
79203
+ * given new filters. Subclasses call this method from their filter method implementation.
79204
+ *
79205
+ * @since 1.146.0
79206
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
79207
+ *
79208
+ * @returns The new application filters
79209
+ */
79210
+ computeApplicationFilters(
79211
+ /**
79212
+ * The new filters for the given filter type
79213
+ */
79214
+ vFilter?: sap.ui.model.Filter[] | sap.ui.model.Filter,
79215
+ /**
79216
+ * The type of the application filters to replace
79217
+ */
79218
+ sFilterType?: /* was: sap.ui.model.FilterType.Application */
79219
+ any | /* was: sap.ui.model.FilterType.ApplicationBound */ any
79220
+ ): sap.ui.model.Filter[] | sap.ui.model.Filter | undefined;
78677
79221
  /**
78678
79222
  * Detaches event handler `fnFunction` from the {@link #event:filter filter} event of this `sap.ui.model.ListBinding`.
78679
79223
  *
@@ -78786,7 +79330,9 @@ declare namespace sap {
78786
79330
  */
78787
79331
  aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
78788
79332
  /**
78789
- * The type of the filter to replace; if no type is given, the behavior depends on the model implementation
79333
+ * The type of filter to replace. If no type is specified, the behavior depends on the model implementation.
79334
+ * Since 1.146.0, you can use `sap.ui.model.FilterType.ApplicationBound` to replace bound application filters
79335
+ * if the model implementation supports it.
78790
79336
  */
78791
79337
  sFilterType?: sap.ui.model.FilterType
78792
79338
  ): this;
@@ -79658,16 +80204,19 @@ declare namespace sap {
79658
80204
  */
79659
80205
  getMetaModel(): sap.ui.model.MetaModel | undefined;
79660
80206
  /**
80207
+ * Returns the value of the property for the given `sPath` and `oContext`.
80208
+ *
79661
80209
  *
79662
- * @returns The value for the given path/context or `undefined` if data could not be found
80210
+ * @returns The the value of the property for the given path/context or `undefined` if data could not be
80211
+ * found
79663
80212
  */
79664
80213
  getObject(
79665
80214
  /**
79666
- * Path to where to read the object
80215
+ * The path to the object you want to read
79667
80216
  */
79668
80217
  sPath: string,
79669
80218
  /**
79670
- * Context with which the path should be resolved
80219
+ * The context that resolves the path
79671
80220
  */
79672
80221
  oContext?: sap.ui.model.Context,
79673
80222
  /**
@@ -79681,29 +80230,31 @@ declare namespace sap {
79681
80230
  * The original value is the value that was last responded by a server if using a server model implementation.
79682
80231
  *
79683
80232
  *
79684
- * @returns vValue The value of the property
80233
+ * @returns The value of the property
79685
80234
  */
79686
80235
  getOriginalProperty(
79687
80236
  /**
79688
- * Path/name of the property
80237
+ * The path/name of the property
79689
80238
  */
79690
80239
  sPath: string,
79691
80240
  /**
79692
- * Context if available to access the property value
80241
+ * Context for accessing the property value
79693
80242
  */
79694
80243
  oContext?: sap.ui.model.Context
79695
80244
  ): any;
79696
80245
  /**
80246
+ * Returns the value of the property for the given `sPath` and `oContext`.
79697
80247
  *
79698
- * @returns Value of the addressed property
80248
+ *
80249
+ * @returns The value of the addressed property
79699
80250
  */
79700
80251
  getProperty(
79701
80252
  /**
79702
- * The path to where to read the attribute value
80253
+ * The path to the attribute value you want to read
79703
80254
  */
79704
80255
  sPath: string,
79705
80256
  /**
79706
- * The context with which the path should be resolved
80257
+ * The context that resolves the path
79707
80258
  */
79708
80259
  oContext?: sap.ui.model.Context
79709
80260
  ): any;
@@ -80747,6 +81298,26 @@ declare namespace sap {
80747
81298
  */
80748
81299
  oListener?: object
80749
81300
  ): void;
81301
+ /**
81302
+ * Computes the binding's application filters by replacing application filters of the given type with the
81303
+ * given new filters. Subclasses call this method from their filter method implementation.
81304
+ *
81305
+ * @since 1.146.0
81306
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
81307
+ *
81308
+ * @returns The new application filters
81309
+ */
81310
+ computeApplicationFilters(
81311
+ /**
81312
+ * The new filters for the given filter type
81313
+ */
81314
+ vFilter?: sap.ui.model.Filter[] | sap.ui.model.Filter,
81315
+ /**
81316
+ * The type of the application filters to replace
81317
+ */
81318
+ sFilterType?: /* was: sap.ui.model.FilterType.Application */
81319
+ any | /* was: sap.ui.model.FilterType.ApplicationBound */ any
81320
+ ): sap.ui.model.Filter[] | sap.ui.model.Filter | undefined;
80750
81321
  /**
80751
81322
  * Detaches event handler `fnFunction` from the {@link #event:_filter _filter} event of this `sap.ui.model.TreeBinding`.
80752
81323
  *
@@ -80776,7 +81347,9 @@ declare namespace sap {
80776
81347
  */
80777
81348
  aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
80778
81349
  /**
80779
- * The type of the filter to replace; if no type is given, the behavior depends on the model implementation
81350
+ * The type of filter to replace. If no type is specified, the behavior depends on the model implementation.
81351
+ * Since 1.146.0, you can use `sap.ui.model.FilterType.ApplicationBound` to set bound application filters
81352
+ * if the model implementation supports it.
80780
81353
  */
80781
81354
  sFilterType?: sap.ui.model.FilterType
80782
81355
  ): void;
@@ -81159,9 +81732,20 @@ declare namespace sap {
81159
81732
  */
81160
81733
  enum FilterType {
81161
81734
  /**
81162
- * Filters which are provided by the application.
81735
+ * Filters which are provided by the application and have constant values. Filters defined via the property
81736
+ * `filters` in {@link sap.ui.base.ManagedObject.AggregationBindingInfo} have this type. Filters of this
81737
+ * type are called "unbound application filters".
81163
81738
  */
81164
81739
  Application = "Application",
81740
+ /**
81741
+ * Filters provided by the application that may have values which are binding expressions. Filters defined
81742
+ * via the property `boundFilters` in {@link sap.ui.base.ManagedObject.AggregationBindingInfo} have this
81743
+ * type. Filters of this type are called "bound application filters". When a filter value changes through
81744
+ * data binding, the aggregation binding that uses this filter is filtered automatically.
81745
+ *
81746
+ * @since 1.146.0
81747
+ */
81748
+ ApplicationBound = "ApplicationBound",
81165
81749
  /**
81166
81750
  * Filters which are set by a control itself.
81167
81751
  *
@@ -81484,7 +82068,7 @@ declare namespace sap {
81484
82068
  * have the possibility to customize the user agent, and to explicitly add this information.
81485
82069
  *
81486
82070
  * @since 1.31.0
81487
- * @deprecated As of version 1.98.
82071
+ * @deprecated As of version 1.98. without replacement, refer to the above note.
81488
82072
  */
81489
82073
  export const webview: boolean;
81490
82074
 
@@ -82231,11 +82815,24 @@ declare namespace sap {
82231
82815
  | sap.ui.base.ManagedObject.PropertyBindingInfo
82232
82816
  | `{${string}}`;
82233
82817
 
82818
+ /**
82819
+ * If it is set to `true`, the input will remain focused after text is entered. Use this for inputs with
82820
+ * a suggestion list that you want to keep open.
82821
+ *
82822
+ * @since 1.67
82823
+ */
82234
82824
  keepFocus?:
82235
82825
  | boolean
82236
82826
  | sap.ui.base.ManagedObject.PropertyBindingInfo
82237
82827
  | `{${string}}`;
82238
82828
 
82829
+ /**
82830
+ * If it is set to `true`, an ENTER key will be entered after the text. Use this for inputs that shouldn't
82831
+ * lose the focus after a text is entered. (e.g. inputs in a sap.m.Popover shouldn't be focused out, as
82832
+ * this will make the popover close in FF and IE11)
82833
+ *
82834
+ * @since 1.76
82835
+ */
82239
82836
  pressEnterKey?:
82240
82837
  | boolean
82241
82838
  | sap.ui.base.ManagedObject.PropertyBindingInfo
@@ -82297,17 +82894,45 @@ declare namespace sap {
82297
82894
  | float
82298
82895
  | sap.ui.base.ManagedObject.PropertyBindingInfo
82299
82896
  | `{${string}}`;
82897
+
82898
+ /**
82899
+ * If it is set to `true`, a `keydown` keyboard event will be dispatched instead of mouse events. The modifier
82900
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
82901
+ *
82902
+ * @since 1.146
82903
+ */
82904
+ keyDown?:
82905
+ | boolean
82906
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
82907
+ | `{${string}}`;
82908
+
82909
+ /**
82910
+ * If it is set to `true`, a `keyup` keyboard event will be dispatched instead of mouse events. The modifier
82911
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
82912
+ *
82913
+ * @since 1.146
82914
+ */
82915
+ keyUp?:
82916
+ | boolean
82917
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
82918
+ | `{${string}}`;
82300
82919
  }
82301
82920
 
82302
82921
  /**
82303
82922
  * Describes the settings that can be provided to the Scroll constructor.
82304
82923
  */
82305
82924
  interface $ScrollSettings extends sap.ui.test.actions.$ActionSettings {
82925
+ /**
82926
+ * The x scroll position.
82927
+ */
82306
82928
  x?:
82307
82929
  | int
82308
82930
  | sap.ui.base.ManagedObject.PropertyBindingInfo
82309
82931
  | `{${string}}`;
82310
82932
 
82933
+ /**
82934
+ * The y scroll position.
82935
+ */
82311
82936
  y?:
82312
82937
  | int
82313
82938
  | sap.ui.base.ManagedObject.PropertyBindingInfo
@@ -82790,8 +83415,12 @@ declare namespace sap {
82790
83415
  /**
82791
83416
  * Gets current value of property {@link #getKeepFocus keepFocus}.
82792
83417
  *
83418
+ * If it is set to `true`, the input will remain focused after text is entered. Use this for inputs with
83419
+ * a suggestion list that you want to keep open.
83420
+ *
82793
83421
  * Default value is `false`.
82794
83422
  *
83423
+ * @since 1.67
82795
83424
  *
82796
83425
  * @returns Value of property `keepFocus`
82797
83426
  */
@@ -82799,8 +83428,13 @@ declare namespace sap {
82799
83428
  /**
82800
83429
  * Gets current value of property {@link #getPressEnterKey pressEnterKey}.
82801
83430
  *
83431
+ * If it is set to `true`, an ENTER key will be entered after the text. Use this for inputs that shouldn't
83432
+ * lose the focus after a text is entered. (e.g. inputs in a sap.m.Popover shouldn't be focused out, as
83433
+ * this will make the popover close in FF and IE11)
83434
+ *
82802
83435
  * Default value is `false`.
82803
83436
  *
83437
+ * @since 1.76
82804
83438
  *
82805
83439
  * @returns Value of property `pressEnterKey`
82806
83440
  */
@@ -82840,10 +83474,14 @@ declare namespace sap {
82840
83474
  /**
82841
83475
  * Sets a new value for property {@link #getKeepFocus keepFocus}.
82842
83476
  *
83477
+ * If it is set to `true`, the input will remain focused after text is entered. Use this for inputs with
83478
+ * a suggestion list that you want to keep open.
83479
+ *
82843
83480
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
82844
83481
  *
82845
83482
  * Default value is `false`.
82846
83483
  *
83484
+ * @since 1.67
82847
83485
  *
82848
83486
  * @returns Reference to `this` in order to allow method chaining
82849
83487
  */
@@ -82856,10 +83494,15 @@ declare namespace sap {
82856
83494
  /**
82857
83495
  * Sets a new value for property {@link #getPressEnterKey pressEnterKey}.
82858
83496
  *
83497
+ * If it is set to `true`, an ENTER key will be entered after the text. Use this for inputs that shouldn't
83498
+ * lose the focus after a text is entered. (e.g. inputs in a sap.m.Popover shouldn't be focused out, as
83499
+ * this will make the popover close in FF and IE11)
83500
+ *
82859
83501
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
82860
83502
  *
82861
83503
  * Default value is `false`.
82862
83504
  *
83505
+ * @since 1.76
82863
83506
  *
82864
83507
  * @returns Reference to `this` in order to allow method chaining
82865
83508
  */
@@ -82989,7 +83632,8 @@ declare namespace sap {
82989
83632
  static getMetadata(): sap.ui.base.ManagedObjectMetadata;
82990
83633
  /**
82991
83634
  * Sets focus on given control and triggers a 'tap' event on it (which is internally translated into a 'press'
82992
- * event). Logs an error if control is not visible (i.e. has no dom representation)
83635
+ * event). If `keyDown` or `keyUp` is set to `true`, dispatches the corresponding keyboard event instead
83636
+ * of mouse events. Logs an error if control is not visible (i.e. has no dom representation)
82993
83637
  */
82994
83638
  executeOn(
82995
83639
  /**
@@ -83017,6 +83661,28 @@ declare namespace sap {
83017
83661
  * @returns Value of property `ctrlKey`
83018
83662
  */
83019
83663
  getCtrlKey(): boolean;
83664
+ /**
83665
+ * Gets current value of property {@link #getKeyDown keyDown}.
83666
+ *
83667
+ * If it is set to `true`, a `keydown` keyboard event will be dispatched instead of mouse events. The modifier
83668
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
83669
+ *
83670
+ * @since 1.146
83671
+ *
83672
+ * @returns Value of property `keyDown`
83673
+ */
83674
+ getKeyDown(): boolean;
83675
+ /**
83676
+ * Gets current value of property {@link #getKeyUp keyUp}.
83677
+ *
83678
+ * If it is set to `true`, a `keyup` keyboard event will be dispatched instead of mouse events. The modifier
83679
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
83680
+ *
83681
+ * @since 1.146
83682
+ *
83683
+ * @returns Value of property `keyUp`
83684
+ */
83685
+ getKeyUp(): boolean;
83020
83686
  /**
83021
83687
  * Gets current value of property {@link #getShiftKey shiftKey}.
83022
83688
  *
@@ -83083,6 +83749,42 @@ declare namespace sap {
83083
83749
  */
83084
83750
  bCtrlKey: boolean
83085
83751
  ): this;
83752
+ /**
83753
+ * Sets a new value for property {@link #getKeyDown keyDown}.
83754
+ *
83755
+ * If it is set to `true`, a `keydown` keyboard event will be dispatched instead of mouse events. The modifier
83756
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
83757
+ *
83758
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
83759
+ *
83760
+ * @since 1.146
83761
+ *
83762
+ * @returns Reference to `this` in order to allow method chaining
83763
+ */
83764
+ setKeyDown(
83765
+ /**
83766
+ * New value for property `keyDown`
83767
+ */
83768
+ bKeyDown: boolean
83769
+ ): this;
83770
+ /**
83771
+ * Sets a new value for property {@link #getKeyUp keyUp}.
83772
+ *
83773
+ * If it is set to `true`, a `keyup` keyboard event will be dispatched instead of mouse events. The modifier
83774
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
83775
+ *
83776
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
83777
+ *
83778
+ * @since 1.146
83779
+ *
83780
+ * @returns Reference to `this` in order to allow method chaining
83781
+ */
83782
+ setKeyUp(
83783
+ /**
83784
+ * New value for property `keyUp`
83785
+ */
83786
+ bKeyUp: boolean
83787
+ ): this;
83086
83788
  /**
83087
83789
  * Sets a new value for property {@link #getShiftKey shiftKey}.
83088
83790
  *
@@ -83207,6 +83909,8 @@ declare namespace sap {
83207
83909
  /**
83208
83910
  * Gets current value of property {@link #getX x}.
83209
83911
  *
83912
+ * The x scroll position.
83913
+ *
83210
83914
  * Default value is `0`.
83211
83915
  *
83212
83916
  *
@@ -83216,6 +83920,8 @@ declare namespace sap {
83216
83920
  /**
83217
83921
  * Gets current value of property {@link #getY y}.
83218
83922
  *
83923
+ * The y scroll position.
83924
+ *
83219
83925
  * Default value is `0`.
83220
83926
  *
83221
83927
  *
@@ -83225,6 +83931,8 @@ declare namespace sap {
83225
83931
  /**
83226
83932
  * Sets a new value for property {@link #getX x}.
83227
83933
  *
83934
+ * The x scroll position.
83935
+ *
83228
83936
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
83229
83937
  *
83230
83938
  * Default value is `0`.
@@ -83241,6 +83949,8 @@ declare namespace sap {
83241
83949
  /**
83242
83950
  * Sets a new value for property {@link #getY y}.
83243
83951
  *
83952
+ * The y scroll position.
83953
+ *
83244
83954
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
83245
83955
  *
83246
83956
  * Default value is `0`.
@@ -85789,8 +86499,13 @@ declare namespace sap {
85789
86499
  * 'InteractionType'.
85790
86500
  */
85791
86501
  enum InteractionType {
86502
+ /**
86503
+ * "EnterText" interaction type.
86504
+ */
85792
86505
  EnterText = "ENTER_TEXT",
85793
-
86506
+ /**
86507
+ * "Press" Interaction type.
86508
+ */
85794
86509
  Press = "PRESS",
85795
86510
  }
85796
86511
  /**
@@ -87595,6 +88310,8 @@ declare namespace sap {
87595
88310
 
87596
88311
  "sap/ui/dom/denormalizeScrollLeftRTL": undefined;
87597
88312
 
88313
+ "sap/ui/dom/detectTextSelection": undefined;
88314
+
87598
88315
  "sap/ui/dom/getOwnerWindow": undefined;
87599
88316
 
87600
88317
  "sap/ui/dom/getScrollbarSize": undefined;