@openui5/ts-types 1.145.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.145.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.
@@ -10724,7 +10949,7 @@ declare namespace sap {
10724
10949
  * Returns the application root component.
10725
10950
  *
10726
10951
  * @since 1.13.1
10727
- * @deprecated As of version 1.14.
10952
+ * @deprecated As of version 1.14. superseded by {@link sap.ui.core.Component}.
10728
10953
  *
10729
10954
  * @returns The root component
10730
10955
  */
@@ -11227,13 +11452,20 @@ declare namespace sap {
11227
11452
  */
11228
11453
  length?: int;
11229
11454
  /**
11230
- * The initial sort order (optional)
11455
+ * The initial sort order
11231
11456
  */
11232
11457
  sorter?: sap.ui.model.Sorter | sap.ui.model.Sorter[];
11233
11458
  /**
11234
- * 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.
11235
11461
  */
11236
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[];
11237
11469
  /**
11238
11470
  * Name of the key property or a function getting the context as only parameter to calculate a key for entries.
11239
11471
  * This can be used to improve update behaviour in models, where a key is not already available.
@@ -12705,8 +12937,8 @@ declare namespace sap {
12705
12937
  * ```
12706
12938
  *
12707
12939
  *
12708
- * Note that when setting string values, any curly braces in those values need to be escaped, so they are
12709
- * 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.
12710
12942
  *
12711
12943
  * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
12712
12944
  * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
@@ -12827,8 +13059,8 @@ declare namespace sap {
12827
13059
  * ```
12828
13060
  *
12829
13061
  *
12830
- * Note that when setting string values, any curly braces in those values need to be escaped, so they are
12831
- * 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.
12832
13064
  *
12833
13065
  * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
12834
13066
  * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
@@ -12892,17 +13124,46 @@ declare namespace sap {
12892
13124
  );
12893
13125
 
12894
13126
  /**
12895
- * Escapes the given value so it can be used in the constructor's settings object. Should be used when property
12896
- * 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.
12897
13158
  *
12898
13159
  * @since 1.52
12899
13160
  *
12900
- * @returns The given value, escaped for usage as static property value in the constructor's settings object
12901
- * (or unchanged, if not of type string)
13161
+ * @returns The escaped string value, or the original value if not a string
12902
13162
  */
12903
13163
  static escapeSettingsValue(
12904
13164
  /**
12905
- * 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.
12906
13167
  */
12907
13168
  vValue: any
12908
13169
  ): any;
@@ -13584,9 +13845,18 @@ declare namespace sap {
13584
13845
  * Destroys (all) the managed object(s) in the aggregation named `sAggregationName` and empties the aggregation.
13585
13846
  * If the aggregation did contain any object, this ManagedObject is marked as changed.
13586
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
+ *
13587
13857
  * **Note:** This method is a low-level API as described in the class documentation.
13588
13858
  * Applications or frameworks must not use this method to generically destroy all objects in an aggregation.
13589
- * Use the concrete method destroyXYZ for aggregation 'XYZ' instead.
13859
+ * Use the concrete method `destroyXYZ` for aggregation 'XYZ' instead.
13590
13860
  *
13591
13861
  * @ui5-protected Do not call from applications (only from related classes in the framework)
13592
13862
  *
@@ -23566,7 +23836,8 @@ declare namespace sap {
23566
23836
  /**
23567
23837
  * JS View
23568
23838
  *
23569
- * @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.
23570
23841
  */
23571
23842
  JS = "JS",
23572
23843
  /**
@@ -23579,7 +23850,8 @@ declare namespace sap {
23579
23850
  /**
23580
23851
  * Template View
23581
23852
  *
23582
- * @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.
23583
23855
  */
23584
23856
  Template = "Template",
23585
23857
  /**
@@ -24786,34 +25058,65 @@ declare namespace sap {
24786
25058
  * This enum is part of the 'sap/ui/core/Popup' module export and must be accessed by the property 'Dock'.
24787
25059
  */
24788
25060
  enum Dock {
25061
+ /**
25062
+ * Docks the popup at the begin of the reference element, at the bottom.
25063
+ */
24789
25064
  BeginBottom = "BeginBottom",
24790
-
25065
+ /**
25066
+ * Docks the popup at the begin of the reference element, vertically centered.
25067
+ */
24791
25068
  BeginCenter = "BeginCenter",
24792
-
25069
+ /**
25070
+ * Docks the popup at the begin of the reference element, at the top.
25071
+ */
24793
25072
  BeginTop = "BeginTop",
24794
-
25073
+ /**
25074
+ * Docks the popup horizontally centered to the reference element, at the bottom.
25075
+ */
24795
25076
  CenterBottom = "CenterBottom",
24796
-
25077
+ /**
25078
+ * Docks the popup horizontally and vertically centered to the reference element.
25079
+ */
24797
25080
  CenterCenter = "CenterCenter",
24798
-
25081
+ /**
25082
+ * Docks the popup horizontally centered to the reference element, at the top.
25083
+ */
24799
25084
  CenterTop = "CenterTop",
24800
-
25085
+ /**
25086
+ * Docks the popup at the end of the reference element, at the bottom.
25087
+ */
24801
25088
  EndBottom = "EndBottom",
24802
-
25089
+ /**
25090
+ * Docks the popup at the end of the reference element, vertically centered.
25091
+ */
24803
25092
  EndCenter = "EndCenter",
24804
-
25093
+ /**
25094
+ * Docks the popup at the end of the reference element, at the top.
25095
+ */
24805
25096
  EndTop = "EndTop",
24806
-
25097
+ /**
25098
+ * Docks the popup at the left side of the reference element, at the bottom.
25099
+ */
24807
25100
  LeftBottom = "LeftBottom",
24808
-
25101
+ /**
25102
+ * Docks the popup at the left side of the reference element, vertically centered.
25103
+ */
24809
25104
  LeftCenter = "LeftCenter",
24810
-
25105
+ /**
25106
+ * Docks the popup at the left side of the reference element, at the top.
25107
+ */
24811
25108
  LeftTop = "LeftTop",
24812
-
25109
+ /**
25110
+ * Docks the popup at the right side of the reference element, at the bottom.
25111
+ */
24813
25112
  RightBottom = "RightBottom",
24814
-
25113
+ /**
25114
+ * Docks the popup at the right side of the reference element, vertically centered.
25115
+ */
24815
25116
  RightCenter = "RightCenter",
24816
-
25117
+ /**
25118
+ * Docks the popup at the right side of the reference element, at the top.
25119
+ */
24817
25120
  RightTop = "RightTop",
24818
25121
  }
24819
25122
 
@@ -27201,34 +27504,6 @@ declare namespace sap {
27201
27504
  * @returns Metadata object describing this class
27202
27505
  */
27203
27506
  static getMetadata(): sap.ui.base.Metadata;
27204
- /**
27205
- * This function is called between the target view is loaded and the view is added to the container.
27206
- *
27207
- * This function can be used for applying modification on the view or the container to make the rerendering
27208
- * occur together with the later aggregation change.
27209
- *
27210
- * @since 1.46.1
27211
- * @ui5-protected Do not call from applications (only from related classes in the framework)
27212
- */
27213
- _beforePlacingViewIntoContainer(
27214
- /**
27215
- * the object containing the arguments
27216
- */
27217
- mArguments: {
27218
- /**
27219
- * the container where the view will be added
27220
- */
27221
- container: sap.ui.core.Control;
27222
- /**
27223
- * the view which will be added to the container
27224
- */
27225
- view: sap.ui.core.Control;
27226
- /**
27227
- * the data passed from {@link sap.ui.core.routing.Target#display} method
27228
- */
27229
- data?: object;
27230
- }
27231
- ): void;
27232
27507
  /**
27233
27508
  * Attaches event handler `fnFunction` to the {@link #event:display display} event of this `sap.ui.core.routing.Target`.
27234
27509
  *
@@ -27272,6 +27547,37 @@ declare namespace sap {
27272
27547
  */
27273
27548
  oListener?: object
27274
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;
27275
27581
  /**
27276
27582
  * Destroys the target, will be called by {@link sap.m.routing.Targets} don't call this directly.
27277
27583
  *
@@ -30677,16 +30983,29 @@ declare namespace sap {
30677
30983
  * 'HTTPMETHOD'.
30678
30984
  */
30679
30985
  enum HTTPMETHOD {
30986
+ /**
30987
+ * HTTP DELETE method.
30988
+ */
30680
30989
  DELETE = "DELETE",
30681
-
30990
+ /**
30991
+ * HTTP GET method.
30992
+ */
30682
30993
  GET = "GET",
30683
-
30994
+ /**
30995
+ * HTTP MERGE method.
30996
+ */
30684
30997
  MERGE = "MERGE",
30685
-
30998
+ /**
30999
+ * HTTP PATCH method.
31000
+ */
30686
31001
  PATCH = "PATCH",
30687
-
31002
+ /**
31003
+ * HTTP POST method.
31004
+ */
30688
31005
  POST = "POST",
30689
-
31006
+ /**
31007
+ * HTTP PUT method.
31008
+ */
30690
31009
  PUT = "PUT",
30691
31010
  }
30692
31011
 
@@ -34209,6 +34528,9 @@ declare namespace sap {
34209
34528
  * Describes the settings that can be provided to the Fragment constructor.
34210
34529
  */
34211
34530
  interface $FragmentSettings extends sap.ui.base.$ManagedObjectSettings {
34531
+ /**
34532
+ * The Fragment type.
34533
+ */
34212
34534
  type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
34213
34535
 
34214
34536
  fragmentName?: string;
@@ -34585,8 +34907,18 @@ declare namespace sap {
34585
34907
  * Describes the settings that can be provided to the Popup constructor.
34586
34908
  */
34587
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
+ */
34588
34915
  opened?: (oEvent: sap.ui.base.Event) => void;
34589
34916
 
34917
+ /**
34918
+ * Fired when the popup has completely closed (after any animation).
34919
+ *
34920
+ * @since 1.2
34921
+ */
34590
34922
  closed?: (oEvent: sap.ui.base.Event) => void;
34591
34923
  }
34592
34924
 
@@ -37311,24 +37643,24 @@ declare namespace sap {
37311
37643
  * ```
37312
37644
  *
37313
37645
  *
37314
- * 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"
37315
37647
  * for a custom control library and this self-made part of the standard theme is at a different location
37316
37648
  * than the UI5 resources), you can also specify for which control libraries the setting should be used,
37317
37649
  * by giving an array with the names of the respective control libraries as second parameter:
37318
37650
  * ```javascript
37319
37651
  *
37320
- * 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");
37321
37653
  * ```
37322
37654
  *
37323
37655
  *
37324
- * 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
37325
37657
  * for styling the `my.own.library` controls will be loaded from the configured location:
37326
37658
  * ```javascript
37327
37659
  *
37328
- * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_belize/library.css
37329
- * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_belize/library.css
37330
- * https://sdk.openui5.org/resources/sap/m/themes/sap_belize/library.css
37331
- * 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
37332
37664
  * ```
37333
37665
  *
37334
37666
  *
@@ -37382,24 +37714,24 @@ declare namespace sap {
37382
37714
  * ```
37383
37715
  *
37384
37716
  *
37385
- * 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"
37386
37718
  * for a custom control library and this self-made part of the standard theme is at a different location
37387
37719
  * than the UI5 resources), you can also specify for which control libraries the setting should be used,
37388
37720
  * by giving an array with the names of the respective control libraries as second parameter:
37389
37721
  * ```javascript
37390
37722
  *
37391
- * 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");
37392
37724
  * ```
37393
37725
  *
37394
37726
  *
37395
- * 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
37396
37728
  * for styling the `my.own.library` controls will be loaded from the configured location:
37397
37729
  * ```javascript
37398
37730
  *
37399
- * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_belize/library.css
37400
- * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_belize/library.css
37401
- * https://sdk.openui5.org/resources/sap/m/themes/sap_belize/library.css
37402
- * 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
37403
37735
  * ```
37404
37736
  *
37405
37737
  *
@@ -38077,56 +38409,56 @@ declare namespace sap {
38077
38409
  }
38078
38410
 
38079
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
+ *
38080
38456
  * @since 1.70
38081
38457
  */
38082
38458
  class CommandExecution extends sap.ui.core.Element {
38083
38459
  /**
38084
38460
  * Creates and initializes a new CommandExecution.
38085
38461
  *
38086
- * The CommandExecution registers a shortcut when it is added to the dependent aggregation of a control.
38087
- * The shortcut information is retrieved from the owner components manifest (`/sap.ui5/commands/<command>`).
38088
- *
38089
- * You can use a CommandExecution instead of an event handler in XMLViews by using `cmd:` plus the command
38090
- * name.
38091
- *
38092
- * Example for `sap.m.Button`:
38093
- *
38094
- *
38095
- * ```javascript
38096
- *
38097
- * <Button press="cmd:MyCommand" />
38098
- * ```
38099
- *
38100
- *
38101
- * When the press event is fired, the CommandExecution will be triggered and the `execute` event is fired.
38102
- *
38103
- * When using commands, the component will create a model named `$cmd`. The model data provides the enabled
38104
- * and visible state of all CommandExecutions. With that, action-triggering controls (e.g. a button) can
38105
- * be bound to the enable/visible property of the CommandExecution to centrally control their state.
38106
- *
38107
- * **Note: The usage of the `$cmd` model is restricted to `sap.suite.ui.generic`**
38108
- *
38109
- * When binding a button's enabled state to this model, it follows the enabled state of the CommandExecution.
38110
- * The binding path must be relative like `myCommand/enabled`:
38111
- *
38112
- *
38113
- * ```javascript
38114
- *
38115
- * <Button press="cmd:MyCommand" enabled="$cmd>MyCommand/enabled" />
38116
- * ```
38117
- *
38118
- *
38119
- * A CommandExecution can have three states:
38120
- * - the CommandExecution is visible and enabled. If the configured shortcut is executed, the configured
38121
- * event handler of this CommandExecution is called
38122
- * - the CommandExecution is visible but not enabled. If the configured shortcut is executed, neither
38123
- * the configured event handler of this CommandExecution nor any event handler configured on CommandExecutions
38124
- * in the ancestor chain is called
38125
- * - the CommandExecution is not visible. If the configured shortcut is executed, the configured event
38126
- * handler of this CommandExecution is not called, but the event is propagated to its parent, which can
38127
- * then handle the event by a configured CommandExecution or propagate the event to its parent, until no
38128
- * parent exits anymore and the browser can handle the executed shortcut
38129
- *
38130
38462
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
38131
38463
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
38132
38464
  * of the syntax of the settings object.
@@ -42845,6 +43177,8 @@ declare namespace sap {
42845
43177
  /**
42846
43178
  * Gets current value of property {@link #getType type}.
42847
43179
  *
43180
+ * The Fragment type.
43181
+ *
42848
43182
  *
42849
43183
  * @returns Value of property `type`
42850
43184
  */
@@ -42852,6 +43186,8 @@ declare namespace sap {
42852
43186
  /**
42853
43187
  * Sets a new value for property {@link #getType type}.
42854
43188
  *
43189
+ * The Fragment type.
43190
+ *
42855
43191
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
42856
43192
  *
42857
43193
  *
@@ -44648,8 +44984,9 @@ declare namespace sap {
44648
44984
  * is e.g. useful when an application merges the CSS for multiple libraries and already loaded the resulting
44649
44985
  * stylesheet.
44650
44986
  *
44651
- * If a list of library `dependencies` is specified in the info object, those libraries will be loaded
44652
- * 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.
44653
44990
  *
44654
44991
  * **Note:** Dependencies between libraries have to be modeled consistently in several places:
44655
44992
  * - Both eager and lazy dependencies have to be modelled in the `.library` file.
@@ -44680,10 +45017,72 @@ declare namespace sap {
44680
45017
  * Library API-Version 2:
44681
45018
  *
44682
45019
  * The Library API Version 2 has been introduced to avoid access to the global namespace when retrieving
44683
- * 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.
44684
45022
  *
45023
+ * Library API version 2 is defined as a number (int) in the library's `init()` call:
45024
+ * ```javascript
44685
45025
  *
44686
- * @returns Returns the library namespace, based on the given library name.
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
+ * ```
45081
+ *
45082
+ *
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.
44687
45086
  */
44688
45087
  static init(
44689
45088
  /**
@@ -47087,6 +47486,9 @@ declare namespace sap {
47087
47486
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
47088
47487
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
47089
47488
  *
47489
+ * Fired when the popup has completely closed (after any animation).
47490
+ *
47491
+ * @since 1.2
47090
47492
  *
47091
47493
  * @returns Reference to `this` in order to allow method chaining
47092
47494
  */
@@ -47111,6 +47513,9 @@ declare namespace sap {
47111
47513
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
47112
47514
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
47113
47515
  *
47516
+ * Fired when the popup has completely closed (after any animation).
47517
+ *
47518
+ * @since 1.2
47114
47519
  *
47115
47520
  * @returns Reference to `this` in order to allow method chaining
47116
47521
  */
@@ -47130,6 +47535,9 @@ declare namespace sap {
47130
47535
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
47131
47536
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
47132
47537
  *
47538
+ * Fired when the popup has completely opened (after any animation).
47539
+ *
47540
+ * @since 1.2
47133
47541
  *
47134
47542
  * @returns Reference to `this` in order to allow method chaining
47135
47543
  */
@@ -47154,6 +47562,9 @@ declare namespace sap {
47154
47562
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
47155
47563
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
47156
47564
  *
47565
+ * Fired when the popup has completely opened (after any animation).
47566
+ *
47567
+ * @since 1.2
47157
47568
  *
47158
47569
  * @returns Reference to `this` in order to allow method chaining
47159
47570
  */
@@ -47191,6 +47602,7 @@ declare namespace sap {
47191
47602
  *
47192
47603
  * The passed function and listener object must match the ones used for event registration.
47193
47604
  *
47605
+ * @since 1.2
47194
47606
  *
47195
47607
  * @returns Reference to `this` in order to allow method chaining
47196
47608
  */
@@ -47209,6 +47621,7 @@ declare namespace sap {
47209
47621
  *
47210
47622
  * The passed function and listener object must match the ones used for event registration.
47211
47623
  *
47624
+ * @since 1.2
47212
47625
  *
47213
47626
  * @returns Reference to `this` in order to allow method chaining
47214
47627
  */
@@ -47230,6 +47643,7 @@ declare namespace sap {
47230
47643
  /**
47231
47644
  * Fires event {@link #event:closed closed} to attached listeners.
47232
47645
  *
47646
+ * @since 1.2
47233
47647
  * @ui5-protected Do not call from applications (only from related classes in the framework)
47234
47648
  *
47235
47649
  * @returns Reference to `this` in order to allow method chaining
@@ -47243,6 +47657,7 @@ declare namespace sap {
47243
47657
  /**
47244
47658
  * Fires event {@link #event:opened opened} to attached listeners.
47245
47659
  *
47660
+ * @since 1.2
47246
47661
  * @ui5-protected Do not call from applications (only from related classes in the framework)
47247
47662
  *
47248
47663
  * @returns Reference to `this` in order to allow method chaining
@@ -55395,47 +55810,15 @@ declare namespace sap {
55395
55810
  */
55396
55811
  namespace json {
55397
55812
  /**
55398
- * List binding implementation for JSON format.
55813
+ * List binding implementation for JSON model.
55399
55814
  *
55400
55815
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
55401
55816
  */
55402
55817
  class JSONListBinding extends sap.ui.model.ClientListBinding {
55403
55818
  /**
55404
- * Creates a new JSONListBinding.
55405
- *
55406
- * This constructor should only be called by subclasses or model implementations, not by application or
55407
- * control code. Such code should use {@link sap.ui.model.json.JSONModel#bindList JSONModel#bindList} on
55408
- * the corresponding model instance instead.
55409
- *
55410
55819
  * @ui5-protected Do not call from applications (only from related classes in the framework)
55411
55820
  */
55412
- protected constructor(
55413
- /**
55414
- * Model instance that this binding is created for and that it belongs to
55415
- */
55416
- oModel: sap.ui.model.json.JSONModel,
55417
- /**
55418
- * Binding path to be used for this binding
55419
- */
55420
- sPath: string,
55421
- /**
55422
- * Binding context relative to which a relative binding path will be resolved
55423
- */
55424
- oContext: sap.ui.model.Context,
55425
- /**
55426
- * The sorters used initially; call {@link #sort} to replace them
55427
- */
55428
- aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
55429
- /**
55430
- * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
55431
- * to replace them
55432
- */
55433
- aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
55434
- /**
55435
- * Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
55436
- */
55437
- mParameters?: object
55438
- );
55821
+ protected constructor();
55439
55822
  }
55440
55823
  /**
55441
55824
  * Model implementation for the JSON format.
@@ -55535,6 +55918,107 @@ declare namespace sap {
55535
55918
  */
55536
55919
  oContext?: sap.ui.model.Context
55537
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;
55538
56022
  /**
55539
56023
  * Returns a Promise of the current data-loading state. Every currently running {@link sap.ui.model.json.JSONModel#loadData }
55540
56024
  * call is respected by the returned Promise. This also includes a potential loadData call from the JSONModel's
@@ -55678,38 +56162,15 @@ declare namespace sap {
55678
56162
  ): boolean;
55679
56163
  }
55680
56164
  /**
55681
- * Property binding implementation for JSON format.
56165
+ * Property binding implementation for JSON model.
55682
56166
  *
55683
56167
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
55684
56168
  */
55685
56169
  class JSONPropertyBinding extends sap.ui.model.ClientPropertyBinding {
55686
56170
  /**
55687
- * Creates a new JSONListBinding.
55688
- *
55689
- * This constructor should only be called by subclasses or model implementations, not by application or
55690
- * control code. Such code should use {@link sap.ui.model.json.JSONModel#bindProperty JSONModel#bindProperty }
55691
- * on the corresponding model instance instead.
55692
- *
55693
56171
  * @ui5-protected Do not call from applications (only from related classes in the framework)
55694
56172
  */
55695
- protected constructor(
55696
- /**
55697
- * Model instance that this binding is created for and that it belongs to
55698
- */
55699
- oModel: sap.ui.model.json.JSONModel,
55700
- /**
55701
- * Binding path to be used for this binding
55702
- */
55703
- sPath: string,
55704
- /**
55705
- * Binding context relative to which a relative binding path will be resolved
55706
- */
55707
- oContext: sap.ui.model.Context,
55708
- /**
55709
- * Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
55710
- */
55711
- mParameters?: object
55712
- );
56173
+ protected constructor();
55713
56174
 
55714
56175
  /**
55715
56176
  * Creates a new subclass of class sap.ui.model.json.JSONPropertyBinding with name `sClassName` and enriches
@@ -55749,59 +56210,15 @@ declare namespace sap {
55749
56210
  static getMetadata(): sap.ui.base.Metadata;
55750
56211
  }
55751
56212
  /**
55752
- * Tree binding implementation for JSON format.
55753
- *
55754
- * The bound data can contain JSON objects and arrays. Both will be used to build the tree structure. You
55755
- * can optionally define a set of arrays to be used for the tree structure in the parameter `arrayNames`.
55756
- * 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}
55757
56214
  *
55758
56215
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
55759
56216
  */
55760
56217
  class JSONTreeBinding extends sap.ui.model.ClientTreeBinding {
55761
56218
  /**
55762
- * Creates a new JSONListBinding.
55763
- *
55764
- * This constructor should only be called by subclasses or model implementations, not by application or
55765
- * control code. Such code should use {@link sap.ui.model.json.JSONModel#bindTree JSONModel#bindTree} on
55766
- * the corresponding model instance instead.
55767
- *
55768
56219
  * @ui5-protected Do not call from applications (only from related classes in the framework)
55769
56220
  */
55770
- protected constructor(
55771
- /**
55772
- * Model instance that this binding is created for and that it belongs to
55773
- */
55774
- oModel: sap.ui.model.json.JSONModel,
55775
- /**
55776
- * Path pointing to the tree or array that should be bound
55777
- */
55778
- sPath: string,
55779
- /**
55780
- * Context object for this binding, mandatory when a relative binding path is given
55781
- */
55782
- oContext?: object,
55783
- /**
55784
- * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
55785
- * to replace them
55786
- */
55787
- aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
55788
- /**
55789
- * Additional model-specific parameters
55790
- */
55791
- mParameters?: {
55792
- /**
55793
- * Keys of arrays to be used for building the tree structure. If not specified, all arrays and objects in
55794
- * the bound data will be used. Note that for arrays nested inside differently named arrays, you need to
55795
- * add both to `arrayNames`. You always have to add the complete parent chain. If any array is ignored,
55796
- * its child arrays will be ignored as well even if they have been added to `arrayNames`.
55797
- */
55798
- arrayNames?: string[];
55799
- },
55800
- /**
55801
- * The sorters used initially; call {@link #sort} to replace them
55802
- */
55803
- aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
55804
- );
56221
+ protected constructor();
55805
56222
  }
55806
56223
  }
55807
56224
  /**
@@ -63881,6 +64298,8 @@ declare namespace sap {
63881
64298
 
63882
64299
  /**
63883
64300
  * Parameters of the ODataModel#parseError event.
64301
+ *
64302
+ * @deprecated As of version 1.37.0. this event is not supported
63884
64303
  */
63885
64304
  interface ODataModel$ParseErrorEventParameters
63886
64305
  extends sap.ui.model.Model$ParseErrorEventParameters {}
@@ -63904,18 +64323,24 @@ declare namespace sap {
63904
64323
 
63905
64324
  /**
63906
64325
  * Parameters of the ODataModel#requestCompleted event.
64326
+ *
64327
+ * @deprecated As of version 1.37.0. this event is not supported
63907
64328
  */
63908
64329
  interface ODataModel$RequestCompletedEventParameters
63909
64330
  extends sap.ui.model.Model$RequestCompletedEventParameters {}
63910
64331
 
63911
64332
  /**
63912
64333
  * Parameters of the ODataModel#requestFailed event.
64334
+ *
64335
+ * @deprecated As of version 1.37.0. this event is not supported
63913
64336
  */
63914
64337
  interface ODataModel$RequestFailedEventParameters
63915
64338
  extends sap.ui.model.Model$RequestFailedEventParameters {}
63916
64339
 
63917
64340
  /**
63918
64341
  * Parameters of the ODataModel#requestSent event.
64342
+ *
64343
+ * @deprecated As of version 1.37.0. this event is not supported
63919
64344
  */
63920
64345
  interface ODataModel$RequestSentEventParameters
63921
64346
  extends sap.ui.model.Model$RequestSentEventParameters {}
@@ -64723,7 +65148,7 @@ declare namespace sap {
64723
65148
  * (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
64724
65149
  * Such a deletion is not a pending change.
64725
65150
  *
64726
- * 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
64727
65152
  * version 1.144.0, see {@link #isAggregated}). The same restrictions as for a recursive hierarchy apply.
64728
65153
  * See:
64729
65154
  * #hasPendingChanges
@@ -65283,6 +65708,12 @@ declare namespace sap {
65283
65708
  * 'dataRequested', can instead be done before calling {@link #requestSideEffects}. 'dataReceived',
65284
65709
  * can instead be done once the `oPromise` returned by {@link #requestSideEffects} fulfills or rejects (using
65285
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).
65286
65717
  * See:
65287
65718
  * sap.ui.model.odata.v4.ODataContextBinding#getBoundContext
65288
65719
  * sap.ui.model.odata.v4.ODataContextBinding#invoke
@@ -65291,8 +65722,8 @@ declare namespace sap {
65291
65722
  *
65292
65723
  * @since 1.61.0
65293
65724
  *
65294
- * @returns A promise which is resolved without a defined result, or rejected with an error if loading of
65295
- * 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 }
65296
65727
  * and make them editable again when the promise resolves; in the error handler, you can repeat the loading
65297
65728
  * of side effects.
65298
65729
  * The promise is rejected if the call wants to refresh a whole list binding (via header context or an
@@ -65312,9 +65743,11 @@ declare namespace sap {
65312
65743
  *
65313
65744
  * Since 1.82.0, absolute paths are supported. Absolute paths must start with the entity container (example
65314
65745
  * "/com.sap.gateway.default.iwbep.tea_busi.v0001.Container/TEAMS") of the service. All (navigation) properties
65315
- * in the complete model matching such an absolute path are updated. Since 1.85.0, "14.3.11 Expression edm:String"
65316
- * is accepted as well. Since 1.145.0, you can use `null` values (and `{$Null : null}`) as synonyms for
65317
- * empty navigation property paths.
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.
65318
65751
  *
65319
65752
  * Since 1.108.8, a property path matching the "com.sap.vocabularies.Common.v1.Messages" annotation of a
65320
65753
  * list binding's entity type is treated specially for a row context of a list binding: It is loaded even
@@ -65327,8 +65760,8 @@ declare namespace sap {
65327
65760
  | string
65328
65761
  >,
65329
65762
  /**
65330
- * The group ID to be used (since 1.69.0); if not specified, the update group ID for the context's binding
65331
- * 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 }
65332
65765
  * is called after the corresponding updates have been successfully processed by the server and that there
65333
65766
  * are no pending changes for the affected properties.
65334
65767
  */
@@ -66340,6 +66773,9 @@ declare namespace sap {
66340
66773
  * is set to `undefined`. The created context always knows its {@link sap.ui.model.odata.v4.Context#getPath path},
66341
66774
  * which can be used for {@link #getKeepAliveContext}.
66342
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
+ *
66343
66779
  * @since 1.43.0
66344
66780
  *
66345
66781
  * @returns The context object for the created entity; its method {@link sap.ui.model.odata.v4.Context#created }
@@ -66544,7 +66980,8 @@ declare namespace sap {
66544
66980
  */
66545
66981
  vFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
66546
66982
  /**
66547
- * 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.
66548
66985
  */
66549
66986
  sFilterType?: sap.ui.model.FilterType
66550
66987
  ): this;
@@ -67052,10 +67489,10 @@ declare namespace sap {
67052
67489
  */
67053
67490
  aggregate?: object;
67054
67491
  /**
67055
- * Whether created nodes are shown in place at the position specified by the service (since 1.130.0); only
67056
- * the value `true` is allowed. Otherwise, created nodes are displayed out of place as the first children
67057
- * of their parent or as the first roots, but not in their usual position as defined by the service and
67058
- * 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.
67059
67496
  */
67060
67497
  createInPlace?: boolean;
67061
67498
  /**
@@ -68042,7 +68479,7 @@ declare namespace sap {
68042
68479
  *
68043
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
68044
68481
  * binding path within this model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')"
68045
- * 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
68046
68483
  * example of {@link sap.ui.model.odata.v4.ODataUtils.formatLiteral}. "4.5.1 Addressing Actions" needs an
68047
68484
  * operation binding, see {@link sap.ui.model.odata.v4.ODataContextBinding}.
68048
68485
  *
@@ -68874,7 +69311,7 @@ declare namespace sap {
68874
69311
  *
68875
69312
  * @since 1.107.0
68876
69313
  *
68877
- * @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')",
68878
69315
  * or `undefined` if at least one key property is undefined.
68879
69316
  */
68880
69317
  getKeyPredicate(
@@ -69036,7 +69473,7 @@ declare namespace sap {
69036
69473
  *
69037
69474
  * @since 1.107.0
69038
69475
  *
69039
- * @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')"
69040
69477
  * or "('42')", or `undefined` if at least one key property is undefined. It gets rejected if the metadata
69041
69478
  * cannot be fetched, or in case the entity has no key properties according to the metadata.
69042
69479
  */
@@ -69050,6 +69487,25 @@ declare namespace sap {
69050
69487
  */
69051
69488
  oEntity: object
69052
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>;
69053
69509
  /**
69054
69510
  * Resets all property changes, created entities, and entity deletions associated with the given group ID
69055
69511
  * which have not been successfully submitted via {@link #submitBatch}. Resets also invalid user input for
@@ -69682,6 +70138,8 @@ declare namespace sap {
69682
70138
 
69683
70139
  /**
69684
70140
  * Event object of the ODataModel#parseError event.
70141
+ *
70142
+ * @deprecated As of version 1.37.0. this event is not supported
69685
70143
  */
69686
70144
  type ODataModel$ParseErrorEvent = sap.ui.base.Event<
69687
70145
  ODataModel$ParseErrorEventParameters,
@@ -69698,6 +70156,8 @@ declare namespace sap {
69698
70156
 
69699
70157
  /**
69700
70158
  * Event object of the ODataModel#requestCompleted event.
70159
+ *
70160
+ * @deprecated As of version 1.37.0. this event is not supported
69701
70161
  */
69702
70162
  type ODataModel$RequestCompletedEvent = sap.ui.base.Event<
69703
70163
  ODataModel$RequestCompletedEventParameters,
@@ -69706,6 +70166,8 @@ declare namespace sap {
69706
70166
 
69707
70167
  /**
69708
70168
  * Event object of the ODataModel#requestFailed event.
70169
+ *
70170
+ * @deprecated As of version 1.37.0. this event is not supported
69709
70171
  */
69710
70172
  type ODataModel$RequestFailedEvent = sap.ui.base.Event<
69711
70173
  ODataModel$RequestFailedEventParameters,
@@ -69714,6 +70176,8 @@ declare namespace sap {
69714
70176
 
69715
70177
  /**
69716
70178
  * Event object of the ODataModel#requestSent event.
70179
+ *
70180
+ * @deprecated As of version 1.37.0. this event is not supported
69717
70181
  */
69718
70182
  type ODataModel$RequestSentEvent = sap.ui.base.Event<
69719
70183
  ODataModel$RequestSentEventParameters,
@@ -76790,7 +77254,9 @@ declare namespace sap {
76790
77254
  aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
76791
77255
  /**
76792
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 }
76793
- * 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.
76794
77260
  */
76795
77261
  sFilterType?: sap.ui.model.FilterType
76796
77262
  ): this;
@@ -76873,6 +77339,26 @@ declare namespace sap {
76873
77339
  * @returns Metadata object describing this class
76874
77340
  */
76875
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;
76876
77362
  /**
76877
77363
  * Creates a new property binding for this model.
76878
77364
  * See:
@@ -76897,14 +77383,14 @@ declare namespace sap {
76897
77383
  */
76898
77384
  mParameters?: {
76899
77385
  /**
76900
- * Whether this binding does not propagate model messages to the control; supported since 1.119.0. Some
76901
- * composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages for some
76902
- * of their parts depending on their format options; setting this parameter to `true` or `false` overrules
76903
- * 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.
76904
77390
  *
76905
- * For example, a binding for a currency code is used in a composite binding for rendering the proper number
76906
- * of decimals, but the currency code is not displayed in the attached control. In that case, messages for
76907
- * 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.
76908
77394
  */
76909
77395
  ignoreMessages?: boolean;
76910
77396
  }
@@ -77128,7 +77614,9 @@ declare namespace sap {
77128
77614
  aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
77129
77615
  /**
77130
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 }
77131
- * 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.
77132
77620
  */
77133
77621
  sFilterType?: sap.ui.model.FilterType
77134
77622
  ): this;
@@ -78710,6 +79198,26 @@ declare namespace sap {
78710
79198
  */
78711
79199
  oListener?: object
78712
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;
78713
79221
  /**
78714
79222
  * Detaches event handler `fnFunction` from the {@link #event:filter filter} event of this `sap.ui.model.ListBinding`.
78715
79223
  *
@@ -78822,7 +79330,9 @@ declare namespace sap {
78822
79330
  */
78823
79331
  aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
78824
79332
  /**
78825
- * 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.
78826
79336
  */
78827
79337
  sFilterType?: sap.ui.model.FilterType
78828
79338
  ): this;
@@ -80788,6 +81298,26 @@ declare namespace sap {
80788
81298
  */
80789
81299
  oListener?: object
80790
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;
80791
81321
  /**
80792
81322
  * Detaches event handler `fnFunction` from the {@link #event:_filter _filter} event of this `sap.ui.model.TreeBinding`.
80793
81323
  *
@@ -80817,7 +81347,9 @@ declare namespace sap {
80817
81347
  */
80818
81348
  aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
80819
81349
  /**
80820
- * 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.
80821
81353
  */
80822
81354
  sFilterType?: sap.ui.model.FilterType
80823
81355
  ): void;
@@ -81200,9 +81732,20 @@ declare namespace sap {
81200
81732
  */
81201
81733
  enum FilterType {
81202
81734
  /**
81203
- * 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".
81204
81738
  */
81205
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",
81206
81749
  /**
81207
81750
  * Filters which are set by a control itself.
81208
81751
  *
@@ -81525,7 +82068,7 @@ declare namespace sap {
81525
82068
  * have the possibility to customize the user agent, and to explicitly add this information.
81526
82069
  *
81527
82070
  * @since 1.31.0
81528
- * @deprecated As of version 1.98.
82071
+ * @deprecated As of version 1.98. without replacement, refer to the above note.
81529
82072
  */
81530
82073
  export const webview: boolean;
81531
82074
 
@@ -82272,11 +82815,24 @@ declare namespace sap {
82272
82815
  | sap.ui.base.ManagedObject.PropertyBindingInfo
82273
82816
  | `{${string}}`;
82274
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
+ */
82275
82824
  keepFocus?:
82276
82825
  | boolean
82277
82826
  | sap.ui.base.ManagedObject.PropertyBindingInfo
82278
82827
  | `{${string}}`;
82279
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
+ */
82280
82836
  pressEnterKey?:
82281
82837
  | boolean
82282
82838
  | sap.ui.base.ManagedObject.PropertyBindingInfo
@@ -82338,17 +82894,45 @@ declare namespace sap {
82338
82894
  | float
82339
82895
  | sap.ui.base.ManagedObject.PropertyBindingInfo
82340
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}}`;
82341
82919
  }
82342
82920
 
82343
82921
  /**
82344
82922
  * Describes the settings that can be provided to the Scroll constructor.
82345
82923
  */
82346
82924
  interface $ScrollSettings extends sap.ui.test.actions.$ActionSettings {
82925
+ /**
82926
+ * The x scroll position.
82927
+ */
82347
82928
  x?:
82348
82929
  | int
82349
82930
  | sap.ui.base.ManagedObject.PropertyBindingInfo
82350
82931
  | `{${string}}`;
82351
82932
 
82933
+ /**
82934
+ * The y scroll position.
82935
+ */
82352
82936
  y?:
82353
82937
  | int
82354
82938
  | sap.ui.base.ManagedObject.PropertyBindingInfo
@@ -82831,8 +83415,12 @@ declare namespace sap {
82831
83415
  /**
82832
83416
  * Gets current value of property {@link #getKeepFocus keepFocus}.
82833
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
+ *
82834
83421
  * Default value is `false`.
82835
83422
  *
83423
+ * @since 1.67
82836
83424
  *
82837
83425
  * @returns Value of property `keepFocus`
82838
83426
  */
@@ -82840,8 +83428,13 @@ declare namespace sap {
82840
83428
  /**
82841
83429
  * Gets current value of property {@link #getPressEnterKey pressEnterKey}.
82842
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
+ *
82843
83435
  * Default value is `false`.
82844
83436
  *
83437
+ * @since 1.76
82845
83438
  *
82846
83439
  * @returns Value of property `pressEnterKey`
82847
83440
  */
@@ -82881,10 +83474,14 @@ declare namespace sap {
82881
83474
  /**
82882
83475
  * Sets a new value for property {@link #getKeepFocus keepFocus}.
82883
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
+ *
82884
83480
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
82885
83481
  *
82886
83482
  * Default value is `false`.
82887
83483
  *
83484
+ * @since 1.67
82888
83485
  *
82889
83486
  * @returns Reference to `this` in order to allow method chaining
82890
83487
  */
@@ -82897,10 +83494,15 @@ declare namespace sap {
82897
83494
  /**
82898
83495
  * Sets a new value for property {@link #getPressEnterKey pressEnterKey}.
82899
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
+ *
82900
83501
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
82901
83502
  *
82902
83503
  * Default value is `false`.
82903
83504
  *
83505
+ * @since 1.76
82904
83506
  *
82905
83507
  * @returns Reference to `this` in order to allow method chaining
82906
83508
  */
@@ -83030,7 +83632,8 @@ declare namespace sap {
83030
83632
  static getMetadata(): sap.ui.base.ManagedObjectMetadata;
83031
83633
  /**
83032
83634
  * Sets focus on given control and triggers a 'tap' event on it (which is internally translated into a 'press'
83033
- * 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)
83034
83637
  */
83035
83638
  executeOn(
83036
83639
  /**
@@ -83058,6 +83661,28 @@ declare namespace sap {
83058
83661
  * @returns Value of property `ctrlKey`
83059
83662
  */
83060
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;
83061
83686
  /**
83062
83687
  * Gets current value of property {@link #getShiftKey shiftKey}.
83063
83688
  *
@@ -83124,6 +83749,42 @@ declare namespace sap {
83124
83749
  */
83125
83750
  bCtrlKey: boolean
83126
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;
83127
83788
  /**
83128
83789
  * Sets a new value for property {@link #getShiftKey shiftKey}.
83129
83790
  *
@@ -83248,6 +83909,8 @@ declare namespace sap {
83248
83909
  /**
83249
83910
  * Gets current value of property {@link #getX x}.
83250
83911
  *
83912
+ * The x scroll position.
83913
+ *
83251
83914
  * Default value is `0`.
83252
83915
  *
83253
83916
  *
@@ -83257,6 +83920,8 @@ declare namespace sap {
83257
83920
  /**
83258
83921
  * Gets current value of property {@link #getY y}.
83259
83922
  *
83923
+ * The y scroll position.
83924
+ *
83260
83925
  * Default value is `0`.
83261
83926
  *
83262
83927
  *
@@ -83266,6 +83931,8 @@ declare namespace sap {
83266
83931
  /**
83267
83932
  * Sets a new value for property {@link #getX x}.
83268
83933
  *
83934
+ * The x scroll position.
83935
+ *
83269
83936
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
83270
83937
  *
83271
83938
  * Default value is `0`.
@@ -83282,6 +83949,8 @@ declare namespace sap {
83282
83949
  /**
83283
83950
  * Sets a new value for property {@link #getY y}.
83284
83951
  *
83952
+ * The y scroll position.
83953
+ *
83285
83954
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
83286
83955
  *
83287
83956
  * Default value is `0`.
@@ -85830,8 +86499,13 @@ declare namespace sap {
85830
86499
  * 'InteractionType'.
85831
86500
  */
85832
86501
  enum InteractionType {
86502
+ /**
86503
+ * "EnterText" interaction type.
86504
+ */
85833
86505
  EnterText = "ENTER_TEXT",
85834
-
86506
+ /**
86507
+ * "Press" Interaction type.
86508
+ */
85835
86509
  Press = "PRESS",
85836
86510
  }
85837
86511
  /**