@openui5/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
  /**
@@ -5531,211 +5531,418 @@ declare module "sap/ui/events/ControlEvents" {
5531
5531
 
5532
5532
  declare module "sap/ui/events/KeyCodes" {
5533
5533
  /**
5534
+ * KeyCodes enumeration.
5535
+ *
5534
5536
  * @since 1.58
5535
5537
  */
5536
5538
  enum KeyCodes {
5539
+ /**
5540
+ * Letter A key
5541
+ */
5537
5542
  A = "65",
5538
-
5543
+ /**
5544
+ * Alt key
5545
+ */
5539
5546
  ALT = "18",
5540
-
5547
+ /**
5548
+ * Down arrow key
5549
+ */
5541
5550
  ARROW_DOWN = "40",
5542
-
5551
+ /**
5552
+ * Left arrow key
5553
+ */
5543
5554
  ARROW_LEFT = "37",
5544
-
5555
+ /**
5556
+ * Right arrow key
5557
+ */
5545
5558
  ARROW_RIGHT = "39",
5546
-
5559
+ /**
5560
+ * Up arrow key
5561
+ */
5547
5562
  ARROW_UP = "38",
5548
-
5563
+ /**
5564
+ * Letter B key
5565
+ */
5549
5566
  B = "66",
5550
-
5567
+ /**
5568
+ * Backslash (\) key
5569
+ */
5551
5570
  BACKSLASH = "226",
5552
-
5571
+ /**
5572
+ * Backspace key
5573
+ */
5553
5574
  BACKSPACE = "8",
5554
-
5575
+ /**
5576
+ * Pause/Break key
5577
+ */
5555
5578
  BREAK = "19",
5556
-
5579
+ /**
5580
+ * Letter C key
5581
+ */
5557
5582
  C = "67",
5558
-
5583
+ /**
5584
+ * Caps Lock key
5585
+ */
5559
5586
  CAPS_LOCK = "20",
5560
-
5587
+ /**
5588
+ * Comma (,) key
5589
+ */
5561
5590
  COMMA = "188",
5562
-
5591
+ /**
5592
+ * Context menu key
5593
+ */
5563
5594
  CONTEXT_MENU = "93",
5564
-
5595
+ /**
5596
+ * Control key
5597
+ */
5565
5598
  CONTROL = "17",
5566
-
5599
+ /**
5600
+ * Letter D key
5601
+ */
5567
5602
  D = "68",
5568
-
5603
+ /**
5604
+ * Delete key
5605
+ */
5569
5606
  DELETE = "46",
5570
-
5607
+ /**
5608
+ * Digit 0 key
5609
+ */
5571
5610
  DIGIT_0 = "48",
5572
-
5611
+ /**
5612
+ * Digit 1 key
5613
+ */
5573
5614
  DIGIT_1 = "49",
5574
-
5615
+ /**
5616
+ * Digit 2 key
5617
+ */
5575
5618
  DIGIT_2 = "50",
5576
-
5619
+ /**
5620
+ * Digit 3 key
5621
+ */
5577
5622
  DIGIT_3 = "51",
5578
-
5623
+ /**
5624
+ * Digit 4 key
5625
+ */
5579
5626
  DIGIT_4 = "52",
5580
-
5627
+ /**
5628
+ * Digit 5 key
5629
+ */
5581
5630
  DIGIT_5 = "53",
5582
-
5631
+ /**
5632
+ * Digit 6 key
5633
+ */
5583
5634
  DIGIT_6 = "54",
5584
-
5635
+ /**
5636
+ * Digit 7 key
5637
+ */
5585
5638
  DIGIT_7 = "55",
5586
-
5639
+ /**
5640
+ * Digit 8 key
5641
+ */
5587
5642
  DIGIT_8 = "56",
5588
-
5643
+ /**
5644
+ * Digit 9 key
5645
+ */
5589
5646
  DIGIT_9 = "57",
5590
-
5647
+ /**
5648
+ * Dot/period (.) key
5649
+ */
5591
5650
  DOT = "190",
5592
-
5651
+ /**
5652
+ * Letter E key
5653
+ */
5593
5654
  E = "69",
5594
-
5655
+ /**
5656
+ * End key
5657
+ */
5595
5658
  END = "35",
5596
-
5659
+ /**
5660
+ * Enter key
5661
+ */
5597
5662
  ENTER = "13",
5598
-
5663
+ /**
5664
+ * Equals (=) key
5665
+ */
5599
5666
  EQUALS = "221",
5600
-
5667
+ /**
5668
+ * Escape key
5669
+ */
5601
5670
  ESCAPE = "27",
5602
-
5671
+ /**
5672
+ * Letter F key
5673
+ */
5603
5674
  F = "70",
5604
-
5675
+ /**
5676
+ * F1 function key
5677
+ */
5605
5678
  F1 = "112",
5606
-
5679
+ /**
5680
+ * F10 function key
5681
+ */
5607
5682
  F10 = "121",
5608
-
5683
+ /**
5684
+ * F11 function key
5685
+ */
5609
5686
  F11 = "122",
5610
-
5687
+ /**
5688
+ * F12 function key
5689
+ */
5611
5690
  F12 = "123",
5612
-
5691
+ /**
5692
+ * F2 function key
5693
+ */
5613
5694
  F2 = "113",
5614
-
5695
+ /**
5696
+ * F3 function key
5697
+ */
5615
5698
  F3 = "114",
5616
-
5699
+ /**
5700
+ * F4 function key
5701
+ */
5617
5702
  F4 = "115",
5618
-
5703
+ /**
5704
+ * F5 function key
5705
+ */
5619
5706
  F5 = "116",
5620
-
5707
+ /**
5708
+ * F6 function key
5709
+ */
5621
5710
  F6 = "117",
5622
-
5711
+ /**
5712
+ * F7 function key
5713
+ */
5623
5714
  F7 = "118",
5624
-
5715
+ /**
5716
+ * F8 function key
5717
+ */
5625
5718
  F8 = "119",
5626
-
5719
+ /**
5720
+ * F9 function key
5721
+ */
5627
5722
  F9 = "120",
5628
-
5723
+ /**
5724
+ * Letter G key
5725
+ */
5629
5726
  G = "71",
5630
-
5727
+ /**
5728
+ * Grave accent (`) key
5729
+ */
5631
5730
  GREAT_ACCENT = "220",
5632
-
5731
+ /**
5732
+ * Letter H key
5733
+ */
5633
5734
  H = "72",
5634
-
5735
+ /**
5736
+ * Home key
5737
+ */
5635
5738
  HOME = "36",
5636
-
5739
+ /**
5740
+ * Letter I key
5741
+ */
5637
5742
  I = "73",
5638
-
5743
+ /**
5744
+ * Insert key
5745
+ */
5639
5746
  INSERT = "45",
5640
-
5747
+ /**
5748
+ * Letter J key
5749
+ */
5641
5750
  J = "74",
5642
-
5751
+ /**
5752
+ * Letter K key
5753
+ */
5643
5754
  K = "75",
5644
-
5755
+ /**
5756
+ * Letter L key
5757
+ */
5645
5758
  L = "76",
5646
-
5759
+ /**
5760
+ * Letter M key
5761
+ */
5647
5762
  M = "77",
5648
-
5763
+ /**
5764
+ * Minus (-) key
5765
+ */
5649
5766
  MINUS = "219",
5650
-
5767
+ /**
5768
+ * Letter N key
5769
+ */
5651
5770
  N = "78",
5652
-
5771
+ /**
5772
+ * Num Lock key
5773
+ */
5653
5774
  NUM_LOCK = "144",
5654
-
5775
+ /**
5776
+ * Numpad 0 key
5777
+ */
5655
5778
  NUMPAD_0 = "96",
5656
-
5779
+ /**
5780
+ * Numpad 1 key
5781
+ */
5657
5782
  NUMPAD_1 = "97",
5658
-
5783
+ /**
5784
+ * Numpad 2 key
5785
+ */
5659
5786
  NUMPAD_2 = "98",
5660
-
5787
+ /**
5788
+ * Numpad 3 key
5789
+ */
5661
5790
  NUMPAD_3 = "99",
5662
-
5791
+ /**
5792
+ * Numpad 4 key
5793
+ */
5663
5794
  NUMPAD_4 = "100",
5664
-
5795
+ /**
5796
+ * Numpad 5 key
5797
+ */
5665
5798
  NUMPAD_5 = "101",
5666
-
5799
+ /**
5800
+ * Numpad 6 key
5801
+ */
5667
5802
  NUMPAD_6 = "102",
5668
-
5803
+ /**
5804
+ * Numpad 7 key
5805
+ */
5669
5806
  NUMPAD_7 = "103",
5670
-
5807
+ /**
5808
+ * Numpad 8 key
5809
+ */
5671
5810
  NUMPAD_8 = "104",
5672
-
5811
+ /**
5812
+ * Numpad 9 key
5813
+ */
5673
5814
  NUMPAD_9 = "105",
5674
-
5815
+ /**
5816
+ * Numpad asterisk (*) key
5817
+ */
5675
5818
  NUMPAD_ASTERISK = "106",
5676
-
5819
+ /**
5820
+ * Numpad comma/decimal (.) key
5821
+ */
5677
5822
  NUMPAD_COMMA = "110",
5678
-
5823
+ /**
5824
+ * Numpad minus (-) key
5825
+ */
5679
5826
  NUMPAD_MINUS = "109",
5680
-
5827
+ /**
5828
+ * Numpad plus (+) key
5829
+ */
5681
5830
  NUMPAD_PLUS = "107",
5682
-
5831
+ /**
5832
+ * Numpad slash (/) key
5833
+ */
5683
5834
  NUMPAD_SLASH = "111",
5684
-
5835
+ /**
5836
+ * Letter O key
5837
+ */
5685
5838
  O = "79",
5686
-
5839
+ /**
5840
+ * Open bracket ([) key
5841
+ */
5687
5842
  OPEN_BRACKET = "186",
5688
-
5843
+ /**
5844
+ * Letter P key
5845
+ */
5689
5846
  P = "80",
5690
-
5847
+ /**
5848
+ * Page Down key
5849
+ */
5691
5850
  PAGE_DOWN = "34",
5692
-
5851
+ /**
5852
+ * Page Up key
5853
+ */
5693
5854
  PAGE_UP = "33",
5694
-
5855
+ /**
5856
+ * Pipe (|) key
5857
+ */
5695
5858
  PIPE = "191",
5696
-
5859
+ /**
5860
+ * Plus (+) key
5861
+ */
5697
5862
  PLUS = "187",
5698
-
5863
+ /**
5864
+ * Print Screen key
5865
+ */
5699
5866
  PRINT = "44",
5700
-
5867
+ /**
5868
+ * Letter Q key
5869
+ */
5701
5870
  Q = "81",
5702
-
5871
+ /**
5872
+ * Letter R key
5873
+ */
5703
5874
  R = "82",
5704
-
5875
+ /**
5876
+ * Letter S key
5877
+ */
5705
5878
  S = "83",
5706
-
5879
+ /**
5880
+ * Scroll Lock key
5881
+ */
5707
5882
  SCROLL_LOCK = "145",
5708
-
5883
+ /**
5884
+ * Semicolon (;) key
5885
+ */
5709
5886
  SEMICOLON = "192",
5710
-
5887
+ /**
5888
+ * Shift key
5889
+ */
5711
5890
  SHIFT = "16",
5712
-
5891
+ /**
5892
+ * Single quote (') key
5893
+ */
5713
5894
  SINGLE_QUOTE = "222",
5714
-
5895
+ /**
5896
+ * Slash (/) key
5897
+ */
5715
5898
  SLASH = "189",
5716
-
5899
+ /**
5900
+ * Sleep key
5901
+ */
5717
5902
  SLEEP = "95",
5718
-
5903
+ /**
5904
+ * Space bar key
5905
+ */
5719
5906
  SPACE = "32",
5720
-
5907
+ /**
5908
+ * Letter T key
5909
+ */
5721
5910
  T = "84",
5722
-
5911
+ /**
5912
+ * Tab key
5913
+ */
5723
5914
  TAB = "9",
5724
-
5915
+ /**
5916
+ * Turn off key
5917
+ */
5725
5918
  TURN_OFF = "94",
5726
-
5919
+ /**
5920
+ * Letter U key
5921
+ */
5727
5922
  U = "85",
5728
-
5923
+ /**
5924
+ * Letter V key
5925
+ */
5729
5926
  V = "86",
5730
-
5927
+ /**
5928
+ * Letter W key
5929
+ */
5731
5930
  W = "87",
5732
-
5931
+ /**
5932
+ * Windows key (or Meta key on Mac)
5933
+ */
5733
5934
  WINDOWS = "91",
5734
-
5935
+ /**
5936
+ * Letter X key
5937
+ */
5735
5938
  X = "88",
5736
-
5939
+ /**
5940
+ * Letter Y key
5941
+ */
5737
5942
  Y = "89",
5738
-
5943
+ /**
5944
+ * Letter Z key
5945
+ */
5739
5946
  Z = "90",
5740
5947
  }
5741
5948
  export default KeyCodes;
@@ -5795,6 +6002,24 @@ declare module "sap/ui/model/FilterProcessor" {
5795
6002
  * @since 1.71
5796
6003
  */
5797
6004
  interface FilterProcessor {
6005
+ /**
6006
+ * Combines control filters and application filters using AND and returns the resulting filter
6007
+ *
6008
+ * @since 1.146.0
6009
+ *
6010
+ * @returns A single filter containing all filters of the arrays combined or `undefined` if no filters are
6011
+ * given
6012
+ */
6013
+ combineFilters(
6014
+ /**
6015
+ * The control filters
6016
+ */
6017
+ aFilters?: Filter[],
6018
+ /**
6019
+ * The application filters
6020
+ */
6021
+ aApplicationFilters?: Filter[]
6022
+ ): Filter | undefined;
5798
6023
  /**
5799
6024
  * Groups filters according to their path and combines filters on the same path using "OR" and filters on
5800
6025
  * different paths using "AND", all multi-filters contained are ANDed.
@@ -11310,7 +11535,7 @@ declare module "sap/ui/app/Application" {
11310
11535
  * Returns the application root component.
11311
11536
  *
11312
11537
  * @since 1.13.1
11313
- * @deprecated As of version 1.14.
11538
+ * @deprecated As of version 1.14. superseded by {@link sap.ui.core.Component}.
11314
11539
  *
11315
11540
  * @returns The root component
11316
11541
  */
@@ -12392,8 +12617,8 @@ declare module "sap/ui/base/ManagedObject" {
12392
12617
  * ```
12393
12618
  *
12394
12619
  *
12395
- * Note that when setting string values, any curly braces in those values need to be escaped, so they are
12396
- * not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
12620
+ * Note that when setting string values, any curly braces and backslashes in those values need to be escaped,
12621
+ * so they are not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
12397
12622
  *
12398
12623
  * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
12399
12624
  * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
@@ -12514,8 +12739,8 @@ declare module "sap/ui/base/ManagedObject" {
12514
12739
  * ```
12515
12740
  *
12516
12741
  *
12517
- * Note that when setting string values, any curly braces in those values need to be escaped, so they are
12518
- * not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
12742
+ * Note that when setting string values, any curly braces and backslashes in those values need to be escaped,
12743
+ * so they are not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
12519
12744
  *
12520
12745
  * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
12521
12746
  * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
@@ -12579,17 +12804,46 @@ declare module "sap/ui/base/ManagedObject" {
12579
12804
  );
12580
12805
 
12581
12806
  /**
12582
- * Escapes the given value so it can be used in the constructor's settings object. Should be used when property
12583
- * values are initialized with static string values which could contain binding characters (curly braces).
12807
+ * Escapes the given value so it can be used in the constructor's settings object.
12808
+ *
12809
+ * Use this method when passing static string values that might contain binding syntax characters. Without
12810
+ * escaping, curly braces in strings would be misinterpreted as data binding expressions.
12811
+ *
12812
+ * **Characters that are escaped:**
12813
+ * - `{` (opening curly brace) - binding expression start
12814
+ * - `}` (closing curly brace) - binding expression end
12815
+ * - `\` (backslash) - escape character itself
12816
+ *
12817
+ * Each of the above characters is prefixed with a backslash, e.g. `{foo}` becomes `\{foo\}`.
12818
+ *
12819
+ * **When to use:**
12820
+ * - Static string values containing curly braces that should be displayed literally
12821
+ * - Rendering escaped backslashes (e.g. expecting `\\\\` to result in `\\`)
12822
+ * - User input or external data used as property values in constructors
12823
+ * - JSON content that should not be parsed as bindings
12824
+ *
12825
+ * Example usage:
12826
+ * ```javascript
12827
+ *
12828
+ * new MyControl({
12829
+ * // Without escaping: "{info}" would be interpreted as a binding to the path "info"
12830
+ * // With escaping: displays the literal text "{info}"
12831
+ * text: ManagedObject.escapeSettingsValue("{info}")
12832
+ * });
12833
+ * ```
12834
+ *
12835
+ *
12836
+ * **Note:** This is only needed when setting values via the constructor or {@link #applySettings}. Setter
12837
+ * method calls, e.g. `setText("{info}")` do not interpret binding syntax and thus do not require escaping.
12584
12838
  *
12585
12839
  * @since 1.52
12586
12840
  *
12587
- * @returns The given value, escaped for usage as static property value in the constructor's settings object
12588
- * (or unchanged, if not of type string)
12841
+ * @returns The escaped string value, or the original value if not a string
12589
12842
  */
12590
12843
  static escapeSettingsValue(
12591
12844
  /**
12592
- * Value to escape; only needs to be done for string values, but the call will work for all types
12845
+ * Value to escape; only strings are escaped, other types (e.g. objects) are returned through unchanged.
12846
+ * Strings nested in objects must be escaped individually.
12593
12847
  */
12594
12848
  vValue: any
12595
12849
  ): any;
@@ -13264,9 +13518,18 @@ declare module "sap/ui/base/ManagedObject" {
13264
13518
  * Destroys (all) the managed object(s) in the aggregation named `sAggregationName` and empties the aggregation.
13265
13519
  * If the aggregation did contain any object, this ManagedObject is marked as changed.
13266
13520
  *
13521
+ * **Note:** Destroying an aggregation by calling this method (or indirectly via `destroyXYZ`) does
13522
+ * not call the named aggregation mutators (`setXYZ` for a 0..1 aggregation, `removeXYZ` for
13523
+ * a 0..n aggregation) for the aggregated children. Controls that implement side effects in those methods
13524
+ * therefore must also implement similar side effects in their `destroyXYZ` method.
13525
+ *
13526
+ * While this is understood as inconvenient, it was decided (February 2026, after a thorough investigation),
13527
+ * not to change it. Too many existing controls depend on the current behavior, and, even worse, would have
13528
+ * severe problems with a changed behavior.
13529
+ *
13267
13530
  * **Note:** This method is a low-level API as described in the class documentation.
13268
13531
  * Applications or frameworks must not use this method to generically destroy all objects in an aggregation.
13269
- * Use the concrete method destroyXYZ for aggregation 'XYZ' instead.
13532
+ * Use the concrete method `destroyXYZ` for aggregation 'XYZ' instead.
13270
13533
  *
13271
13534
  * @ui5-protected Do not call from applications (only from related classes in the framework)
13272
13535
  *
@@ -14507,13 +14770,20 @@ declare module "sap/ui/base/ManagedObject" {
14507
14770
  */
14508
14771
  length?: int;
14509
14772
  /**
14510
- * The initial sort order (optional)
14773
+ * The initial sort order
14511
14774
  */
14512
14775
  sorter?: Sorter | Sorter[];
14513
14776
  /**
14514
- * The predefined filters for this aggregation (optional)
14777
+ * The predefined {@link sap.ui.model.FilterType.Application application filters} for this aggregation where
14778
+ * filter values are constants.
14515
14779
  */
14516
14780
  filters?: Filter | Filter[];
14781
+ /**
14782
+ * The predefined {@link sap.ui.model.FilterType.ApplicationBound bound application filters} for this aggregation.
14783
+ * Filter values support binding expressions. The aggregation updates its filters whenever a filter value
14784
+ * changes through data binding. Supported since 1.146.0.
14785
+ */
14786
+ boundFilters?: Filter | Filter[];
14517
14787
  /**
14518
14788
  * Name of the key property or a function getting the context as only parameter to calculate a key for entries.
14519
14789
  * This can be used to improve update behaviour in models, where a key is not already available.
@@ -18507,56 +18777,56 @@ declare module "sap/ui/core/CommandExecution" {
18507
18777
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
18508
18778
 
18509
18779
  /**
18780
+ * The CommandExecution registers a shortcut when it is added to the dependent aggregation of a control.
18781
+ * The shortcut information is retrieved from the owner components manifest (`/sap.ui5/commands/<command>`).
18782
+ *
18783
+ * You can use a CommandExecution instead of an event handler in XMLViews by using `cmd:` plus the command
18784
+ * name.
18785
+ *
18786
+ * Example for `sap.m.Button`:
18787
+ *
18788
+ *
18789
+ * ```javascript
18790
+ *
18791
+ * <Button press="cmd:MyCommand" />
18792
+ * ```
18793
+ *
18794
+ *
18795
+ * When the press event is fired, the CommandExecution will be triggered and the `execute` event is fired.
18796
+ *
18797
+ * When using commands, the component will create a model named `$cmd`. The model data provides the enabled
18798
+ * and visible state of all CommandExecutions. With that, action-triggering controls (e.g. a button) can
18799
+ * be bound to the enable/visible property of the CommandExecution to centrally control their state.
18800
+ *
18801
+ * **Note: The usage of the `$cmd` model is restricted to `sap.suite.ui.generic`**
18802
+ *
18803
+ * When binding a button's enabled state to this model, it follows the enabled state of the CommandExecution.
18804
+ * The binding path must be relative like `myCommand/enabled`:
18805
+ *
18806
+ *
18807
+ * ```javascript
18808
+ *
18809
+ * <Button press="cmd:MyCommand" enabled="$cmd>MyCommand/enabled" />
18810
+ * ```
18811
+ *
18812
+ *
18813
+ * A CommandExecution can have three states:
18814
+ * - the CommandExecution is visible and enabled. If the configured shortcut is executed, the configured
18815
+ * event handler of this CommandExecution is called
18816
+ * - the CommandExecution is visible but not enabled. If the configured shortcut is executed, neither
18817
+ * the configured event handler of this CommandExecution nor any event handler configured on CommandExecutions
18818
+ * in the ancestor chain is called
18819
+ * - the CommandExecution is not visible. If the configured shortcut is executed, the configured event
18820
+ * handler of this CommandExecution is not called, but the event is propagated to its parent, which can
18821
+ * then handle the event by a configured CommandExecution or propagate the event to its parent, until no
18822
+ * parent exits anymore and the browser can handle the executed shortcut
18823
+ *
18510
18824
  * @since 1.70
18511
18825
  */
18512
18826
  export default class CommandExecution extends UI5Element {
18513
18827
  /**
18514
18828
  * Creates and initializes a new CommandExecution.
18515
18829
  *
18516
- * The CommandExecution registers a shortcut when it is added to the dependent aggregation of a control.
18517
- * The shortcut information is retrieved from the owner components manifest (`/sap.ui5/commands/<command>`).
18518
- *
18519
- * You can use a CommandExecution instead of an event handler in XMLViews by using `cmd:` plus the command
18520
- * name.
18521
- *
18522
- * Example for `sap.m.Button`:
18523
- *
18524
- *
18525
- * ```javascript
18526
- *
18527
- * <Button press="cmd:MyCommand" />
18528
- * ```
18529
- *
18530
- *
18531
- * When the press event is fired, the CommandExecution will be triggered and the `execute` event is fired.
18532
- *
18533
- * When using commands, the component will create a model named `$cmd`. The model data provides the enabled
18534
- * and visible state of all CommandExecutions. With that, action-triggering controls (e.g. a button) can
18535
- * be bound to the enable/visible property of the CommandExecution to centrally control their state.
18536
- *
18537
- * **Note: The usage of the `$cmd` model is restricted to `sap.suite.ui.generic`**
18538
- *
18539
- * When binding a button's enabled state to this model, it follows the enabled state of the CommandExecution.
18540
- * The binding path must be relative like `myCommand/enabled`:
18541
- *
18542
- *
18543
- * ```javascript
18544
- *
18545
- * <Button press="cmd:MyCommand" enabled="$cmd>MyCommand/enabled" />
18546
- * ```
18547
- *
18548
- *
18549
- * A CommandExecution can have three states:
18550
- * - the CommandExecution is visible and enabled. If the configured shortcut is executed, the configured
18551
- * event handler of this CommandExecution is called
18552
- * - the CommandExecution is visible but not enabled. If the configured shortcut is executed, neither
18553
- * the configured event handler of this CommandExecution nor any event handler configured on CommandExecutions
18554
- * in the ancestor chain is called
18555
- * - the CommandExecution is not visible. If the configured shortcut is executed, the configured event
18556
- * handler of this CommandExecution is not called, but the event is propagated to its parent, which can
18557
- * then handle the event by a configured CommandExecution or propagate the event to its parent, until no
18558
- * parent exits anymore and the browser can handle the executed shortcut
18559
- *
18560
18830
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
18561
18831
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
18562
18832
  * of the syntax of the settings object.
@@ -24531,24 +24801,24 @@ declare module "sap/ui/core/Core" {
24531
24801
  * ```
24532
24802
  *
24533
24803
  *
24534
- * If parts of the theme are at different locations (e.g. because you provide a standard theme like "sap_belize"
24804
+ * If parts of the theme are at different locations (e.g. because you provide a standard theme like "sap_horizon"
24535
24805
  * for a custom control library and this self-made part of the standard theme is at a different location
24536
24806
  * than the UI5 resources), you can also specify for which control libraries the setting should be used,
24537
24807
  * by giving an array with the names of the respective control libraries as second parameter:
24538
24808
  * ```javascript
24539
24809
  *
24540
- * sap.ui.getCore().setThemeRoot("sap_belize", ["my.own.library"], "https://mythemeserver.com/allThemes");
24810
+ * sap.ui.getCore().setThemeRoot("sap_horizon", ["my.own.library"], "https://mythemeserver.com/allThemes");
24541
24811
  * ```
24542
24812
  *
24543
24813
  *
24544
- * This will cause the Belize theme to be loaded from the UI5 location for all standard libraries. Resources
24814
+ * This will cause the Horizon theme to be loaded from the UI5 location for all standard libraries. Resources
24545
24815
  * for styling the `my.own.library` controls will be loaded from the configured location:
24546
24816
  * ```javascript
24547
24817
  *
24548
- * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_belize/library.css
24549
- * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_belize/library.css
24550
- * https://sdk.openui5.org/resources/sap/m/themes/sap_belize/library.css
24551
- * https://mythemeserver.com/allThemes/my/own/library/themes/sap_belize/library.css
24818
+ * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_horizon/library.css
24819
+ * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_horizon/library.css
24820
+ * https://sdk.openui5.org/resources/sap/m/themes/sap_horizon/library.css
24821
+ * https://mythemeserver.com/allThemes/my/own/library/themes/sap_horizon/library.css
24552
24822
  * ```
24553
24823
  *
24554
24824
  *
@@ -24602,24 +24872,24 @@ declare module "sap/ui/core/Core" {
24602
24872
  * ```
24603
24873
  *
24604
24874
  *
24605
- * If parts of the theme are at different locations (e.g. because you provide a standard theme like "sap_belize"
24875
+ * If parts of the theme are at different locations (e.g. because you provide a standard theme like "sap_horizon"
24606
24876
  * for a custom control library and this self-made part of the standard theme is at a different location
24607
24877
  * than the UI5 resources), you can also specify for which control libraries the setting should be used,
24608
24878
  * by giving an array with the names of the respective control libraries as second parameter:
24609
24879
  * ```javascript
24610
24880
  *
24611
- * sap.ui.getCore().setThemeRoot("sap_belize", ["my.own.library"], "https://mythemeserver.com/allThemes");
24881
+ * sap.ui.getCore().setThemeRoot("sap_horizon", ["my.own.library"], "https://mythemeserver.com/allThemes");
24612
24882
  * ```
24613
24883
  *
24614
24884
  *
24615
- * This will cause the Belize theme to be loaded from the UI5 location for all standard libraries. Resources
24885
+ * This will cause the Horizon theme to be loaded from the UI5 location for all standard libraries. Resources
24616
24886
  * for styling the `my.own.library` controls will be loaded from the configured location:
24617
24887
  * ```javascript
24618
24888
  *
24619
- * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_belize/library.css
24620
- * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_belize/library.css
24621
- * https://sdk.openui5.org/resources/sap/m/themes/sap_belize/library.css
24622
- * https://mythemeserver.com/allThemes/my/own/library/themes/sap_belize/library.css
24889
+ * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_horizon/library.css
24890
+ * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_horizon/library.css
24891
+ * https://sdk.openui5.org/resources/sap/m/themes/sap_horizon/library.css
24892
+ * https://mythemeserver.com/allThemes/my/own/library/themes/sap_horizon/library.css
24623
24893
  * ```
24624
24894
  *
24625
24895
  *
@@ -31432,6 +31702,8 @@ declare module "sap/ui/core/Fragment" {
31432
31702
  /**
31433
31703
  * Gets current value of property {@link #getType type}.
31434
31704
  *
31705
+ * The Fragment type.
31706
+ *
31435
31707
  *
31436
31708
  * @returns Value of property `type`
31437
31709
  */
@@ -31439,6 +31711,8 @@ declare module "sap/ui/core/Fragment" {
31439
31711
  /**
31440
31712
  * Sets a new value for property {@link #getType type}.
31441
31713
  *
31714
+ * The Fragment type.
31715
+ *
31442
31716
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
31443
31717
  *
31444
31718
  *
@@ -31455,6 +31729,9 @@ declare module "sap/ui/core/Fragment" {
31455
31729
  * Describes the settings that can be provided to the Fragment constructor.
31456
31730
  */
31457
31731
  export interface $FragmentSettings extends $ManagedObjectSettings {
31732
+ /**
31733
+ * The Fragment type.
31734
+ */
31458
31735
  type?: string | PropertyBindingInfo;
31459
31736
 
31460
31737
  fragmentName?: string;
@@ -34236,8 +34513,9 @@ declare module "sap/ui/core/Lib" {
34236
34513
  * is e.g. useful when an application merges the CSS for multiple libraries and already loaded the resulting
34237
34514
  * stylesheet.
34238
34515
  *
34239
- * If a list of library `dependencies` is specified in the info object, those libraries will be loaded
34240
- * synchronously if they haven't been loaded yet.
34516
+ *
34517
+ * - If a list of library `dependencies` is specified in the info object, those libraries will be loaded
34518
+ * synchronously if they haven't been loaded yet.
34241
34519
  *
34242
34520
  * **Note:** Dependencies between libraries have to be modeled consistently in several places:
34243
34521
  * - Both eager and lazy dependencies have to be modelled in the `.library` file.
@@ -34268,10 +34546,72 @@ declare module "sap/ui/core/Lib" {
34268
34546
  * Library API-Version 2:
34269
34547
  *
34270
34548
  * The Library API Version 2 has been introduced to avoid access to the global namespace when retrieving
34271
- * enum types. With Library API Version 2 a library must declare its enum types via {@link module:sap/ui/base/DataType.registerEnum DataType.registerEnum}.
34549
+ * enum types. With Library API Version 2 a library must declare its enum types via {@link sap.ui.base.DataType.registerEnum }
34550
+ * as described in the "Defining Enums" section below.
34551
+ *
34552
+ * Library API version 2 is defined as a number (int) in the library's `init()` call:
34553
+ * ```javascript
34554
+ *
34555
+ * var thisLib = Library.init({
34556
+ * apiVersion: 2,
34557
+ * name: "my.library",
34558
+ * ...
34559
+ * });
34560
+ * ```
34561
+ *
34562
+ *
34563
+ * **Important:** The object returned by `Library.init()` should be used as the return value of the `library.js`
34564
+ * module.
34565
+ *
34566
+ * **Defining Enums**
34567
+ *
34568
+ * Enums that are exposed through a library (not as separate modules) should be defined as properties on
34569
+ * the object returned by `Library.init()`. Each enum must be registered via {@link sap.ui.base.DataType.registerEnum }
34570
+ * to make it available to the framework.
34571
+ *
34572
+ * Example for a simple enum definition:
34573
+ * ```javascript
34574
+ *
34575
+ * // The return value "thisLib" will be used to expose enums
34576
+ * var thisLib = Library.init({
34577
+ * apiVersion: 2,
34578
+ * name: "my.library",
34579
+ * ...
34580
+ * });
34581
+ *
34582
+ * // Note that enum keys and values must match
34583
+ * thisLib.MyEnumType = {
34584
+ * Small: "Small",
34585
+ * Medium: "Medium",
34586
+ * Large: "Large"
34587
+ * };
34588
+ *
34589
+ * // make sure to register the enum and make it know to the framework for later type checks
34590
+ * DataType.registerEnum("my.library.MyEnumType", thisLib.MyEnumType);
34591
+ * ```
34592
+ *
34593
+ *
34594
+ * **Special case: enums in nested namespaces**
34595
+ *
34596
+ * Ensure to create the namespace first and then define the enum:
34272
34597
  *
34273
34598
  *
34274
- * @returns Returns the library namespace, based on the given library name.
34599
+ * ```javascript
34600
+ *
34601
+ * thisLib.cards = thisLib.cards || {};
34602
+ *
34603
+ * thisLib.cards.HeaderPosition = {
34604
+ * Top: "Top",
34605
+ * Bottom: "Bottom"
34606
+ * };
34607
+ *
34608
+ * DataType.registerEnum("my.library.cards.HeaderPosition", thisLib.cards.HeaderPosition);
34609
+ * ```
34610
+ *
34611
+ *
34612
+ *
34613
+ * @returns Returns an object with the exports of the library (enums, helpers, ...). This object should
34614
+ * be used as the return value of the `library.js` module from which `Library.init` is called.
34275
34615
  */
34276
34616
  static init(
34277
34617
  /**
@@ -39710,7 +40050,8 @@ declare module "sap/ui/core/mvc/ViewType" {
39710
40050
  /**
39711
40051
  * JS View
39712
40052
  *
39713
- * @deprecated As of version 1.90.
40053
+ * @deprecated As of version 1.90. Consider using {@link sap.ui.core.mvx.XMLView XMLViews} or "typed views"
40054
+ * (view classes written in JavaScript) instead.
39714
40055
  */
39715
40056
  JS = "JS",
39716
40057
  /**
@@ -39723,7 +40064,8 @@ declare module "sap/ui/core/mvc/ViewType" {
39723
40064
  /**
39724
40065
  * Template View
39725
40066
  *
39726
- * @deprecated As of version 1.56.
40067
+ * @deprecated As of version 1.56. Consider using {@link sap.ui.core.mvx.XMLView XMLViews} or "typed views"
40068
+ * (view classes written in JavaScript) instead.
39727
40069
  */
39728
40070
  Template = "Template",
39729
40071
  /**
@@ -40366,6 +40708,9 @@ declare module "sap/ui/core/Popup" {
40366
40708
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
40367
40709
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
40368
40710
  *
40711
+ * Fired when the popup has completely closed (after any animation).
40712
+ *
40713
+ * @since 1.2
40369
40714
  *
40370
40715
  * @returns Reference to `this` in order to allow method chaining
40371
40716
  */
@@ -40390,6 +40735,9 @@ declare module "sap/ui/core/Popup" {
40390
40735
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
40391
40736
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
40392
40737
  *
40738
+ * Fired when the popup has completely closed (after any animation).
40739
+ *
40740
+ * @since 1.2
40393
40741
  *
40394
40742
  * @returns Reference to `this` in order to allow method chaining
40395
40743
  */
@@ -40409,6 +40757,9 @@ declare module "sap/ui/core/Popup" {
40409
40757
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
40410
40758
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
40411
40759
  *
40760
+ * Fired when the popup has completely opened (after any animation).
40761
+ *
40762
+ * @since 1.2
40412
40763
  *
40413
40764
  * @returns Reference to `this` in order to allow method chaining
40414
40765
  */
@@ -40433,6 +40784,9 @@ declare module "sap/ui/core/Popup" {
40433
40784
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
40434
40785
  * otherwise it will be bound to this `sap.ui.core.Popup` itself.
40435
40786
  *
40787
+ * Fired when the popup has completely opened (after any animation).
40788
+ *
40789
+ * @since 1.2
40436
40790
  *
40437
40791
  * @returns Reference to `this` in order to allow method chaining
40438
40792
  */
@@ -40470,6 +40824,7 @@ declare module "sap/ui/core/Popup" {
40470
40824
  *
40471
40825
  * The passed function and listener object must match the ones used for event registration.
40472
40826
  *
40827
+ * @since 1.2
40473
40828
  *
40474
40829
  * @returns Reference to `this` in order to allow method chaining
40475
40830
  */
@@ -40488,6 +40843,7 @@ declare module "sap/ui/core/Popup" {
40488
40843
  *
40489
40844
  * The passed function and listener object must match the ones used for event registration.
40490
40845
  *
40846
+ * @since 1.2
40491
40847
  *
40492
40848
  * @returns Reference to `this` in order to allow method chaining
40493
40849
  */
@@ -40509,6 +40865,7 @@ declare module "sap/ui/core/Popup" {
40509
40865
  /**
40510
40866
  * Fires event {@link #event:closed closed} to attached listeners.
40511
40867
  *
40868
+ * @since 1.2
40512
40869
  * @ui5-protected Do not call from applications (only from related classes in the framework)
40513
40870
  *
40514
40871
  * @returns Reference to `this` in order to allow method chaining
@@ -40522,6 +40879,7 @@ declare module "sap/ui/core/Popup" {
40522
40879
  /**
40523
40880
  * Fires event {@link #event:opened opened} to attached listeners.
40524
40881
  *
40882
+ * @since 1.2
40525
40883
  * @ui5-protected Do not call from applications (only from related classes in the framework)
40526
40884
  *
40527
40885
  * @returns Reference to `this` in order to allow method chaining
@@ -40877,34 +41235,65 @@ declare module "sap/ui/core/Popup" {
40877
41235
  * This enum is part of the 'sap/ui/core/Popup' module export and must be accessed by the property 'Dock'.
40878
41236
  */
40879
41237
  enum Dock {
41238
+ /**
41239
+ * Docks the popup at the begin of the reference element, at the bottom.
41240
+ */
40880
41241
  BeginBottom = "BeginBottom",
40881
-
41242
+ /**
41243
+ * Docks the popup at the begin of the reference element, vertically centered.
41244
+ */
40882
41245
  BeginCenter = "BeginCenter",
40883
-
41246
+ /**
41247
+ * Docks the popup at the begin of the reference element, at the top.
41248
+ */
40884
41249
  BeginTop = "BeginTop",
40885
-
41250
+ /**
41251
+ * Docks the popup horizontally centered to the reference element, at the bottom.
41252
+ */
40886
41253
  CenterBottom = "CenterBottom",
40887
-
41254
+ /**
41255
+ * Docks the popup horizontally and vertically centered to the reference element.
41256
+ */
40888
41257
  CenterCenter = "CenterCenter",
40889
-
41258
+ /**
41259
+ * Docks the popup horizontally centered to the reference element, at the top.
41260
+ */
40890
41261
  CenterTop = "CenterTop",
40891
-
41262
+ /**
41263
+ * Docks the popup at the end of the reference element, at the bottom.
41264
+ */
40892
41265
  EndBottom = "EndBottom",
40893
-
41266
+ /**
41267
+ * Docks the popup at the end of the reference element, vertically centered.
41268
+ */
40894
41269
  EndCenter = "EndCenter",
40895
-
41270
+ /**
41271
+ * Docks the popup at the end of the reference element, at the top.
41272
+ */
40896
41273
  EndTop = "EndTop",
40897
-
41274
+ /**
41275
+ * Docks the popup at the left side of the reference element, at the bottom.
41276
+ */
40898
41277
  LeftBottom = "LeftBottom",
40899
-
41278
+ /**
41279
+ * Docks the popup at the left side of the reference element, vertically centered.
41280
+ */
40900
41281
  LeftCenter = "LeftCenter",
40901
-
41282
+ /**
41283
+ * Docks the popup at the left side of the reference element, at the top.
41284
+ */
40902
41285
  LeftTop = "LeftTop",
40903
-
41286
+ /**
41287
+ * Docks the popup at the right side of the reference element, at the bottom.
41288
+ */
40904
41289
  RightBottom = "RightBottom",
40905
-
41290
+ /**
41291
+ * Docks the popup at the right side of the reference element, vertically centered.
41292
+ */
40906
41293
  RightCenter = "RightCenter",
40907
-
41294
+ /**
41295
+ * Docks the popup at the right side of the reference element, at the top.
41296
+ */
40908
41297
  RightTop = "RightTop",
40909
41298
  }
40910
41299
 
@@ -40927,8 +41316,18 @@ declare module "sap/ui/core/Popup" {
40927
41316
  * Describes the settings that can be provided to the Popup constructor.
40928
41317
  */
40929
41318
  export interface $PopupSettings extends $ManagedObjectSettings {
41319
+ /**
41320
+ * Fired when the popup has completely opened (after any animation).
41321
+ *
41322
+ * @since 1.2
41323
+ */
40930
41324
  opened?: (oEvent: Event) => void;
40931
41325
 
41326
+ /**
41327
+ * Fired when the popup has completely closed (after any animation).
41328
+ *
41329
+ * @since 1.2
41330
+ */
40932
41331
  closed?: (oEvent: Event) => void;
40933
41332
  }
40934
41333
 
@@ -43191,34 +43590,6 @@ declare module "sap/ui/core/routing/Target" {
43191
43590
  * @returns Metadata object describing this class
43192
43591
  */
43193
43592
  static getMetadata(): Metadata;
43194
- /**
43195
- * This function is called between the target view is loaded and the view is added to the container.
43196
- *
43197
- * This function can be used for applying modification on the view or the container to make the rerendering
43198
- * occur together with the later aggregation change.
43199
- *
43200
- * @since 1.46.1
43201
- * @ui5-protected Do not call from applications (only from related classes in the framework)
43202
- */
43203
- _beforePlacingViewIntoContainer(
43204
- /**
43205
- * the object containing the arguments
43206
- */
43207
- mArguments: {
43208
- /**
43209
- * the container where the view will be added
43210
- */
43211
- container: Control;
43212
- /**
43213
- * the view which will be added to the container
43214
- */
43215
- view: Control;
43216
- /**
43217
- * the data passed from {@link sap.ui.core.routing.Target#display} method
43218
- */
43219
- data?: object;
43220
- }
43221
- ): void;
43222
43593
  /**
43223
43594
  * Attaches event handler `fnFunction` to the {@link #event:display display} event of this `sap.ui.core.routing.Target`.
43224
43595
  *
@@ -43262,6 +43633,37 @@ declare module "sap/ui/core/routing/Target" {
43262
43633
  */
43263
43634
  oListener?: object
43264
43635
  ): this;
43636
+ /**
43637
+ * This function is called between the target view is loaded and the view is added to the container.
43638
+ *
43639
+ * This function can be used for applying modification on the view or the container to make the rerendering
43640
+ * occur together with the later aggregation change.
43641
+ *
43642
+ * **Note:** This function was previously named `_beforePlacingViewIntoContainer` (with a leading underscore)
43643
+ * and has been renamed to be protected instead of private.
43644
+ *
43645
+ * @since 1.46.1
43646
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
43647
+ */
43648
+ beforePlacingViewIntoContainer(
43649
+ /**
43650
+ * the object containing the arguments
43651
+ */
43652
+ mArguments: {
43653
+ /**
43654
+ * the container where the view will be added
43655
+ */
43656
+ container: Control;
43657
+ /**
43658
+ * the view which will be added to the container
43659
+ */
43660
+ view: Control;
43661
+ /**
43662
+ * the data passed from {@link sap.ui.core.routing.Target#display} method
43663
+ */
43664
+ data?: object;
43665
+ }
43666
+ ): void;
43265
43667
  /**
43266
43668
  * Destroys the target, will be called by {@link sap.m.routing.Targets} don't call this directly.
43267
43669
  *
@@ -51746,16 +52148,29 @@ declare module "sap/ui/core/util/MockServer" {
51746
52148
  * 'HTTPMETHOD'.
51747
52149
  */
51748
52150
  enum HTTPMETHOD {
52151
+ /**
52152
+ * HTTP DELETE method.
52153
+ */
51749
52154
  DELETE = "DELETE",
51750
-
52155
+ /**
52156
+ * HTTP GET method.
52157
+ */
51751
52158
  GET = "GET",
51752
-
52159
+ /**
52160
+ * HTTP MERGE method.
52161
+ */
51753
52162
  MERGE = "MERGE",
51754
-
52163
+ /**
52164
+ * HTTP PATCH method.
52165
+ */
51755
52166
  PATCH = "PATCH",
51756
-
52167
+ /**
52168
+ * HTTP POST method.
52169
+ */
51757
52170
  POST = "POST",
51758
-
52171
+ /**
52172
+ * HTTP PUT method.
52173
+ */
51759
52174
  PUT = "PUT",
51760
52175
  }
51761
52176
 
@@ -54002,7 +54417,7 @@ declare module "sap/ui/Device" {
54002
54417
  * have the possibility to customize the user agent, and to explicitly add this information.
54003
54418
  *
54004
54419
  * @since 1.31.0
54005
- * @deprecated As of version 1.98.
54420
+ * @deprecated As of version 1.98. without replacement, refer to the above note.
54006
54421
  */
54007
54422
  export const webview: boolean;
54008
54423
 
@@ -58174,7 +58589,9 @@ declare module "sap/ui/model/ClientListBinding" {
58174
58589
  aFilters?: Filter[] | Filter,
58175
58590
  /**
58176
58591
  * The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
58177
- * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
58592
+ * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}.
58593
+ * Since 1.146.0, you may use {@link sap.ui.model.FilterType.ApplicationBound} to set bound application
58594
+ * filters.
58178
58595
  */
58179
58596
  sFilterType?: FilterType | keyof typeof FilterType
58180
58597
  ): this;
@@ -58219,6 +58636,8 @@ declare module "sap/ui/model/ClientModel" {
58219
58636
 
58220
58637
  import Context from "sap/ui/model/Context";
58221
58638
 
58639
+ import ClientContextBinding from "sap/ui/model/ClientContextBinding";
58640
+
58222
58641
  import PropertyBinding from "sap/ui/model/PropertyBinding";
58223
58642
 
58224
58643
  import Metadata from "sap/ui/base/Metadata";
@@ -58268,6 +58687,26 @@ declare module "sap/ui/model/ClientModel" {
58268
58687
  * @returns Metadata object describing this class
58269
58688
  */
58270
58689
  static getMetadata(): Metadata;
58690
+ /**
58691
+ * Creates a `sap.ui.model.ClientContextBinding`.
58692
+ *
58693
+ *
58694
+ * @returns The newly created `ClientContextBinding`
58695
+ */
58696
+ bindContext(
58697
+ /**
58698
+ * The path pointing to the property that should be bound
58699
+ */
58700
+ sPath: string,
58701
+ /**
58702
+ * The context object for this databinding
58703
+ */
58704
+ oContext?: Context,
58705
+ /**
58706
+ * Additional model-specific parameters
58707
+ */
58708
+ mParameters?: object
58709
+ ): ClientContextBinding;
58271
58710
  /**
58272
58711
  * Creates a new property binding for this model.
58273
58712
  * See:
@@ -58292,14 +58731,14 @@ declare module "sap/ui/model/ClientModel" {
58292
58731
  */
58293
58732
  mParameters?: {
58294
58733
  /**
58295
- * Whether this binding does not propagate model messages to the control; supported since 1.119.0. Some
58296
- * composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages for some
58297
- * of their parts depending on their format options; setting this parameter to `true` or `false` overrules
58298
- * the automatism of the type.
58734
+ * Whether this binding ignores model messages instead of propagating them to the control. Supported since
58735
+ * 1.119.0. Some composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages
58736
+ * for some of their parts, depending on their format options. Setting this parameter to `true` or `false`
58737
+ * overrules the automatism of the type.
58299
58738
  *
58300
- * For example, a binding for a currency code is used in a composite binding for rendering the proper number
58301
- * of decimals, but the currency code is not displayed in the attached control. In that case, messages for
58302
- * the currency code shall not be displayed at that control, only messages for the amount.
58739
+ * **Example:** A binding for a currency code is used in a composite binding for rendering the proper number
58740
+ * of decimals, but the currency code itself is not displayed in the attached control. In this case, messages
58741
+ * for the currency code aren't displayed at that control, only messages for the amount.
58303
58742
  */
58304
58743
  ignoreMessages?: boolean;
58305
58744
  }
@@ -58551,7 +58990,9 @@ declare module "sap/ui/model/ClientTreeBinding" {
58551
58990
  aFilters?: Filter[] | Filter,
58552
58991
  /**
58553
58992
  * The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
58554
- * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
58993
+ * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}.
58994
+ * Since 1.146.0, you may use {@link sap.ui.model.FilterType.ApplicationBound} to set bound application
58995
+ * filters.
58555
58996
  */
58556
58997
  sFilterType?: FilterType | keyof typeof FilterType
58557
58998
  ): this;
@@ -60231,9 +60672,20 @@ declare module "sap/ui/model/FilterType" {
60231
60672
  */
60232
60673
  enum FilterType {
60233
60674
  /**
60234
- * Filters which are provided by the application.
60675
+ * Filters which are provided by the application and have constant values. Filters defined via the property
60676
+ * `filters` in {@link sap.ui.base.ManagedObject.AggregationBindingInfo} have this type. Filters of this
60677
+ * type are called "unbound application filters".
60235
60678
  */
60236
60679
  Application = "Application",
60680
+ /**
60681
+ * Filters provided by the application that may have values which are binding expressions. Filters defined
60682
+ * via the property `boundFilters` in {@link sap.ui.base.ManagedObject.AggregationBindingInfo} have this
60683
+ * type. Filters of this type are called "bound application filters". When a filter value changes through
60684
+ * data binding, the aggregation binding that uses this filter is filtered automatically.
60685
+ *
60686
+ * @since 1.146.0
60687
+ */
60688
+ ApplicationBound = "ApplicationBound",
60237
60689
  /**
60238
60690
  * Filters which are set by a control itself.
60239
60691
  *
@@ -60269,66 +60721,36 @@ declare module "sap/ui/model/FormatException" {
60269
60721
  declare module "sap/ui/model/json/JSONListBinding" {
60270
60722
  import ClientListBinding from "sap/ui/model/ClientListBinding";
60271
60723
 
60272
- import JSONModel from "sap/ui/model/json/JSONModel";
60273
-
60274
- import Context from "sap/ui/model/Context";
60275
-
60276
- import Sorter from "sap/ui/model/Sorter";
60277
-
60278
- import Filter from "sap/ui/model/Filter";
60279
-
60280
60724
  /**
60281
- * List binding implementation for JSON format.
60725
+ * List binding implementation for JSON model.
60282
60726
  *
60283
60727
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
60284
60728
  */
60285
60729
  export default class JSONListBinding extends ClientListBinding {
60286
60730
  /**
60287
- * Creates a new JSONListBinding.
60288
- *
60289
- * This constructor should only be called by subclasses or model implementations, not by application or
60290
- * control code. Such code should use {@link sap.ui.model.json.JSONModel#bindList JSONModel#bindList} on
60291
- * the corresponding model instance instead.
60292
- *
60293
60731
  * @ui5-protected Do not call from applications (only from related classes in the framework)
60294
60732
  */
60295
- protected constructor(
60296
- /**
60297
- * Model instance that this binding is created for and that it belongs to
60298
- */
60299
- oModel: JSONModel,
60300
- /**
60301
- * Binding path to be used for this binding
60302
- */
60303
- sPath: string,
60304
- /**
60305
- * Binding context relative to which a relative binding path will be resolved
60306
- */
60307
- oContext: Context,
60308
- /**
60309
- * The sorters used initially; call {@link #sort} to replace them
60310
- */
60311
- aSorters?: Sorter[] | Sorter,
60312
- /**
60313
- * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
60314
- * to replace them
60315
- */
60316
- aFilters?: Filter[] | Filter,
60317
- /**
60318
- * Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
60319
- */
60320
- mParameters?: object
60321
- );
60733
+ protected constructor();
60322
60734
  }
60323
60735
  }
60324
60736
 
60325
60737
  declare module "sap/ui/model/json/JSONModel" {
60326
60738
  import ClientModel from "sap/ui/model/ClientModel";
60327
60739
 
60328
- import Metadata from "sap/ui/base/Metadata";
60329
-
60330
60740
  import Context from "sap/ui/model/Context";
60331
60741
 
60742
+ import Sorter from "sap/ui/model/Sorter";
60743
+
60744
+ import Filter from "sap/ui/model/Filter";
60745
+
60746
+ import JSONListBinding from "sap/ui/model/json/JSONListBinding";
60747
+
60748
+ import JSONPropertyBinding from "sap/ui/model/json/JSONPropertyBinding";
60749
+
60750
+ import JSONTreeBinding from "sap/ui/model/json/JSONTreeBinding";
60751
+
60752
+ import Metadata from "sap/ui/base/Metadata";
60753
+
60332
60754
  /**
60333
60755
  * Model implementation for the JSON format.
60334
60756
  *
@@ -60427,6 +60849,107 @@ declare module "sap/ui/model/json/JSONModel" {
60427
60849
  */
60428
60850
  oContext?: Context
60429
60851
  ): any | null | undefined;
60852
+ /**
60853
+ * Creates a new {@link sap.ui.model.json.JSONListBinding}.
60854
+ *
60855
+ *
60856
+ * @returns The newly created JSONListBinding
60857
+ */
60858
+ bindList(
60859
+ /**
60860
+ * The path to the list or array to bind
60861
+ */
60862
+ sPath: string,
60863
+ /**
60864
+ * The context for the binding. This is mandatory when a relative binding path is provided.
60865
+ */
60866
+ oContext?: Context,
60867
+ /**
60868
+ * The sorters used initially. To replace them, call {@link sap.ui.model.ListBinding#sort}.
60869
+ */
60870
+ aSorters?: Sorter[] | Sorter,
60871
+ /**
60872
+ * The filters initially used with type {@link sap.ui.model.FilterType.Application}. To replace them, call
60873
+ * {@link sap.ui.model.ListBinding#filter}.
60874
+ */
60875
+ aFilters?: Filter[] | Filter,
60876
+ /**
60877
+ * Map of optional parameters as defined by subclasses. This class does not introduce any own parameters.
60878
+ */
60879
+ mParameters?: Record<string, any>
60880
+ ): JSONListBinding;
60881
+ /**
60882
+ * Creates a new {@link sap.ui.model.json.JSONPropertyBinding}.
60883
+ *
60884
+ *
60885
+ * @returns The newly created JSONPropertyBinding
60886
+ */
60887
+ bindProperty(
60888
+ /**
60889
+ * The path to the property to bind
60890
+ */
60891
+ sPath: string,
60892
+ /**
60893
+ * The context for the binding. This is mandatory when a relative binding path is provided.
60894
+ */
60895
+ oContext?: Context,
60896
+ /**
60897
+ * Additional model-specific parameters
60898
+ */
60899
+ mParameters?: {
60900
+ /**
60901
+ * Whether this binding ignores model messages instead of propagating them to the control. Supported since
60902
+ * 1.119.0. Some composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages
60903
+ * for some of their parts, depending on their format options. Setting this parameter to `true` or `false`
60904
+ * overrules the automatism of the type.
60905
+ *
60906
+ * **Example:** A binding for a currency code is used in a composite binding for rendering the proper number
60907
+ * of decimals, but the currency code itself is not displayed in the attached control. In this case, messages
60908
+ * for the currency code aren't displayed at that control, only messages for the amount.
60909
+ */
60910
+ ignoreMessages?: boolean;
60911
+ }
60912
+ ): JSONPropertyBinding;
60913
+ /**
60914
+ * Creates a new {@link sap.ui.model.json.JSONTreeBinding}. The bound data can contain JSON objects and
60915
+ * arrays. Both are used to build the tree structure.
60916
+ *
60917
+ *
60918
+ * @returns The newly created JSONTreeBinding
60919
+ */
60920
+ bindTree(
60921
+ /**
60922
+ * The path pointing to the tree or array that is bound
60923
+ */
60924
+ sPath: string,
60925
+ /**
60926
+ * The context for the binding. This is mandatory when a relative binding path is provided.
60927
+ */
60928
+ oContext?: Context,
60929
+ /**
60930
+ * The filters initially used with type {@link sap.ui.model.FilterType.Application}. To replace them, call
60931
+ * {@link sap.ui.model.TreeBinding#filter}.
60932
+ */
60933
+ aFilters?: Filter[] | Filter,
60934
+ /**
60935
+ * Additional model-specific parameters
60936
+ */
60937
+ mParameters?: {
60938
+ /**
60939
+ * Keys of arrays to be used for building the tree structure. If not specified, all arrays and objects in
60940
+ * the bound data are used. Note: For arrays nested within other arrays with different names, add both array
60941
+ * names to `arrayNames`. To include a nested array in the hierarchy, you must list the names of all containing
60942
+ * arrays. If an array name is missing from the list, its child arrays are also excluded from the hierarchy,
60943
+ * even if you add them to `arrayNames`. If this parameter is set, all other objects and arrays in the bound
60944
+ * data are ignored.
60945
+ */
60946
+ arrayNames?: string[];
60947
+ },
60948
+ /**
60949
+ * The sorters used initially. To replace them, call {@link sap.ui.model.TreeBinding#sort}.
60950
+ */
60951
+ aSorters?: Sorter[] | Sorter
60952
+ ): JSONTreeBinding;
60430
60953
  /**
60431
60954
  * Returns a Promise of the current data-loading state. Every currently running {@link sap.ui.model.json.JSONModel#loadData }
60432
60955
  * call is respected by the returned Promise. This also includes a potential loadData call from the JSONModel's
@@ -60828,45 +61351,18 @@ declare module "sap/ui/model/json/TypedJSONContext" {
60828
61351
  declare module "sap/ui/model/json/JSONPropertyBinding" {
60829
61352
  import ClientPropertyBinding from "sap/ui/model/ClientPropertyBinding";
60830
61353
 
60831
- import JSONModel from "sap/ui/model/json/JSONModel";
60832
-
60833
- import Context from "sap/ui/model/Context";
60834
-
60835
61354
  import Metadata from "sap/ui/base/Metadata";
60836
61355
 
60837
61356
  /**
60838
- * Property binding implementation for JSON format.
61357
+ * Property binding implementation for JSON model.
60839
61358
  *
60840
61359
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
60841
61360
  */
60842
61361
  export default class JSONPropertyBinding extends ClientPropertyBinding {
60843
61362
  /**
60844
- * Creates a new JSONListBinding.
60845
- *
60846
- * This constructor should only be called by subclasses or model implementations, not by application or
60847
- * control code. Such code should use {@link sap.ui.model.json.JSONModel#bindProperty JSONModel#bindProperty }
60848
- * on the corresponding model instance instead.
60849
- *
60850
61363
  * @ui5-protected Do not call from applications (only from related classes in the framework)
60851
61364
  */
60852
- protected constructor(
60853
- /**
60854
- * Model instance that this binding is created for and that it belongs to
60855
- */
60856
- oModel: JSONModel,
60857
- /**
60858
- * Binding path to be used for this binding
60859
- */
60860
- sPath: string,
60861
- /**
60862
- * Binding context relative to which a relative binding path will be resolved
60863
- */
60864
- oContext: Context,
60865
- /**
60866
- * Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
60867
- */
60868
- mParameters?: object
60869
- );
61365
+ protected constructor();
60870
61366
 
60871
61367
  /**
60872
61368
  * Creates a new subclass of class sap.ui.model.json.JSONPropertyBinding with name `sClassName` and enriches
@@ -60907,66 +61403,16 @@ declare module "sap/ui/model/json/JSONPropertyBinding" {
60907
61403
  declare module "sap/ui/model/json/JSONTreeBinding" {
60908
61404
  import ClientTreeBinding from "sap/ui/model/ClientTreeBinding";
60909
61405
 
60910
- import JSONModel from "sap/ui/model/json/JSONModel";
60911
-
60912
- import Filter from "sap/ui/model/Filter";
60913
-
60914
- import Sorter from "sap/ui/model/Sorter";
60915
-
60916
61406
  /**
60917
- * Tree binding implementation for JSON format.
60918
- *
60919
- * The bound data can contain JSON objects and arrays. Both will be used to build the tree structure. You
60920
- * can optionally define a set of arrays to be used for the tree structure in the parameter `arrayNames`.
60921
- * If this parameter is set, all other objects and arrays will be ignored.
61407
+ * Tree binding implementation for JSON model. See {@link sap.ui.model.json.JSONModel#bindTree}
60922
61408
  *
60923
61409
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
60924
61410
  */
60925
61411
  export default class JSONTreeBinding extends ClientTreeBinding {
60926
61412
  /**
60927
- * Creates a new JSONListBinding.
60928
- *
60929
- * This constructor should only be called by subclasses or model implementations, not by application or
60930
- * control code. Such code should use {@link sap.ui.model.json.JSONModel#bindTree JSONModel#bindTree} on
60931
- * the corresponding model instance instead.
60932
- *
60933
61413
  * @ui5-protected Do not call from applications (only from related classes in the framework)
60934
61414
  */
60935
- protected constructor(
60936
- /**
60937
- * Model instance that this binding is created for and that it belongs to
60938
- */
60939
- oModel: JSONModel,
60940
- /**
60941
- * Path pointing to the tree or array that should be bound
60942
- */
60943
- sPath: string,
60944
- /**
60945
- * Context object for this binding, mandatory when a relative binding path is given
60946
- */
60947
- oContext?: object,
60948
- /**
60949
- * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
60950
- * to replace them
60951
- */
60952
- aFilters?: Filter[] | Filter,
60953
- /**
60954
- * Additional model-specific parameters
60955
- */
60956
- mParameters?: {
60957
- /**
60958
- * Keys of arrays to be used for building the tree structure. If not specified, all arrays and objects in
60959
- * the bound data will be used. Note that for arrays nested inside differently named arrays, you need to
60960
- * add both to `arrayNames`. You always have to add the complete parent chain. If any array is ignored,
60961
- * its child arrays will be ignored as well even if they have been added to `arrayNames`.
60962
- */
60963
- arrayNames?: string[];
60964
- },
60965
- /**
60966
- * The sorters used initially; call {@link #sort} to replace them
60967
- */
60968
- aSorters?: Sorter[] | Sorter
60969
- );
61415
+ protected constructor();
60970
61416
  }
60971
61417
  }
60972
61418
 
@@ -61097,6 +61543,26 @@ declare module "sap/ui/model/ListBinding" {
61097
61543
  */
61098
61544
  oListener?: object
61099
61545
  ): void;
61546
+ /**
61547
+ * Computes the binding's application filters by replacing application filters of the given type with the
61548
+ * given new filters. Subclasses call this method from their filter method implementation.
61549
+ *
61550
+ * @since 1.146.0
61551
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
61552
+ *
61553
+ * @returns The new application filters
61554
+ */
61555
+ computeApplicationFilters(
61556
+ /**
61557
+ * The new filters for the given filter type
61558
+ */
61559
+ vFilter?: Filter[] | Filter,
61560
+ /**
61561
+ * The type of the application filters to replace
61562
+ */
61563
+ sFilterType?: /* was: sap.ui.model.FilterType.Application */
61564
+ any | /* was: sap.ui.model.FilterType.ApplicationBound */ any
61565
+ ): Filter[] | Filter | undefined;
61100
61566
  /**
61101
61567
  * Detaches event handler `fnFunction` from the {@link #event:filter filter} event of this `sap.ui.model.ListBinding`.
61102
61568
  *
@@ -61209,7 +61675,9 @@ declare module "sap/ui/model/ListBinding" {
61209
61675
  */
61210
61676
  aFilters?: Filter[] | Filter,
61211
61677
  /**
61212
- * The type of the filter to replace; if no type is given, the behavior depends on the model implementation
61678
+ * The type of filter to replace. If no type is specified, the behavior depends on the model implementation.
61679
+ * Since 1.146.0, you can use `sap.ui.model.FilterType.ApplicationBound` to replace bound application filters
61680
+ * if the model implementation supports it.
61213
61681
  */
61214
61682
  sFilterType?: FilterType | keyof typeof FilterType
61215
61683
  ): this;
@@ -72852,7 +73320,7 @@ declare module "sap/ui/model/odata/v4/Context" {
72852
73320
  * (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
72853
73321
  * Such a deletion is not a pending change.
72854
73322
  *
72855
- * When using data aggregation without group levels, single entities can be deleted (@experimental as of
73323
+ * When using data aggregation without `groupLevels`, single entities can be deleted (@experimental as of
72856
73324
  * version 1.144.0, see {@link #isAggregated}). The same restrictions as for a recursive hierarchy apply.
72857
73325
  * See:
72858
73326
  * #hasPendingChanges
@@ -73410,6 +73878,12 @@ declare module "sap/ui/model/odata/v4/Context" {
73410
73878
  * 'dataRequested', can instead be done before calling {@link #requestSideEffects}. 'dataReceived',
73411
73879
  * can instead be done once the `oPromise` returned by {@link #requestSideEffects} fulfills or rejects (using
73412
73880
  * `oPromise.then(function () {...}, function () {...})`).
73881
+ *
73882
+ * Since 1.109.0, this context can also represent a node in a recursive hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
73883
+ *
73884
+ * When using data aggregation but no recursive hierarchy, and without `groupLevels` or `"grandTotal like
73885
+ * 1.84"` (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}), this context can also represent
73886
+ * a single entity (see {@link #isAggregated}, @experimental as of version 1.146.0).
73413
73887
  * See:
73414
73888
  * sap.ui.model.odata.v4.ODataContextBinding#getBoundContext
73415
73889
  * sap.ui.model.odata.v4.ODataContextBinding#invoke
@@ -73418,8 +73892,8 @@ declare module "sap/ui/model/odata/v4/Context" {
73418
73892
  *
73419
73893
  * @since 1.61.0
73420
73894
  *
73421
- * @returns A promise which is resolved without a defined result, or rejected with an error if loading of
73422
- * side effects fails. Use it to set fields affected by side effects to read-only before {@link #requestSideEffects }
73895
+ * @returns A promise which is resolved without a defined result, or rejected with an error if the side
73896
+ * effects fail to load. Use it to set fields affected by side effects to read-only before {@link #requestSideEffects }
73423
73897
  * and make them editable again when the promise resolves; in the error handler, you can repeat the loading
73424
73898
  * of side effects.
73425
73899
  * The promise is rejected if the call wants to refresh a whole list binding (via header context or an
@@ -73439,9 +73913,11 @@ declare module "sap/ui/model/odata/v4/Context" {
73439
73913
  *
73440
73914
  * Since 1.82.0, absolute paths are supported. Absolute paths must start with the entity container (example
73441
73915
  * "/com.sap.gateway.default.iwbep.tea_busi.v0001.Container/TEAMS") of the service. All (navigation) properties
73442
- * in the complete model matching such an absolute path are updated. Since 1.85.0, "14.3.11 Expression edm:String"
73443
- * is accepted as well. Since 1.145.0, you can use `null` values (and `{$Null : null}`) as synonyms for
73444
- * empty navigation property paths.
73916
+ * in the complete model matching such an absolute path are updated. Since 1.146.0, {@link sap.ui.model.odata.v4.ODataModel#requestSideEffects }
73917
+ * can be used as well.
73918
+ *
73919
+ * Since 1.85.0, "14.3.11 Expression edm:String" is accepted as well. Since 1.145.0, you can use `null`
73920
+ * values (and `{$Null : null}`) as synonyms for empty navigation property paths.
73445
73921
  *
73446
73922
  * Since 1.108.8, a property path matching the "com.sap.vocabularies.Common.v1.Messages" annotation of a
73447
73923
  * list binding's entity type is treated specially for a row context of a list binding: It is loaded even
@@ -73452,8 +73928,8 @@ declare module "sap/ui/model/odata/v4/Context" {
73452
73928
  NavigationPropertyPathExpression | PropertyPathExpression | string
73453
73929
  >,
73454
73930
  /**
73455
- * The group ID to be used (since 1.69.0); if not specified, the update group ID for the context's binding
73456
- * is used, see {@link #getUpdateGroupId}. If a different group ID is specified, make sure that {@link #requestSideEffects }
73931
+ * The group ID to be used (since 1.69.0). If not specified, the {@link #getUpdateGroupId update group ID }
73932
+ * for the context's binding is used. If a different group ID is specified, make sure that {@link #requestSideEffects }
73457
73933
  * is called after the corresponding updates have been successfully processed by the server and that there
73458
73934
  * are no pending changes for the affected properties.
73459
73935
  */
@@ -74582,6 +75058,9 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
74582
75058
  * is set to `undefined`. The created context always knows its {@link sap.ui.model.odata.v4.Context#getPath path},
74583
75059
  * which can be used for {@link #getKeepAliveContext}.
74584
75060
  *
75061
+ * When using data aggregation without `groupLevels` and without `"grandTotal like 1.84"` (see {@link #setAggregation}),
75062
+ * single entities can be created (@experimental as of version 1.146.0, see {@link sap.ui.model.odata.v4.Context#isAggregated}).
75063
+ *
74585
75064
  * @since 1.43.0
74586
75065
  *
74587
75066
  * @returns The context object for the created entity; its method {@link sap.ui.model.odata.v4.Context#created }
@@ -74786,7 +75265,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
74786
75265
  */
74787
75266
  vFilters?: Filter | Filter[],
74788
75267
  /**
74789
- * The filter type to be used
75268
+ * The filter type to be used. Since 1.146.0, you may use {@link sap.ui.model.FilterType.ApplicationBound }
75269
+ * to replace bound application filters.
74790
75270
  */
74791
75271
  sFilterType?: FilterType | keyof typeof FilterType
74792
75272
  ): this;
@@ -75294,10 +75774,10 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
75294
75774
  */
75295
75775
  aggregate?: object;
75296
75776
  /**
75297
- * Whether created nodes are shown in place at the position specified by the service (since 1.130.0); only
75298
- * the value `true` is allowed. Otherwise, created nodes are displayed out of place as the first children
75299
- * of their parent or as the first roots, but not in their usual position as defined by the service and
75300
- * the current sort order.
75777
+ * Whether created nodes are shown in place at the position specified by the service (since 1.130.0), supported
75778
+ * only if a `hierarchyQualifier` is given; only the value `true` is allowed. Otherwise, created nodes are
75779
+ * displayed out of place as the first children of their parent or as the first roots, but not in their
75780
+ * usual position as defined by the service and the current sort order.
75301
75781
  */
75302
75782
  createInPlace?: boolean;
75303
75783
  /**
@@ -76557,7 +77037,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
76557
77037
  *
76558
77038
  * 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
76559
77039
  * binding path within this model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')"
76560
- * to access an entity instance with key "A/B&C". Note that appropriate URI encoding is necessary, see the
77040
+ * to access an entity instance with key "A/B&C". Note that appropriate URL encoding is necessary, see the
76561
77041
  * example of {@link sap.ui.model.odata.v4.ODataUtils.formatLiteral}. "4.5.1 Addressing Actions" needs an
76562
77042
  * operation binding, see {@link sap.ui.model.odata.v4.ODataContextBinding}.
76563
77043
  *
@@ -77389,7 +77869,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
77389
77869
  *
77390
77870
  * @since 1.107.0
77391
77871
  *
77392
- * @returns The proper URI-encoded key predicate, for example "(Sector='A%2FB%26C',ID='42')" or "('42')",
77872
+ * @returns The proper URL-encoded key predicate, for example "(Sector='A%2FB%26C',ID='42')" or "('42')",
77393
77873
  * or `undefined` if at least one key property is undefined.
77394
77874
  */
77395
77875
  getKeyPredicate(
@@ -77551,7 +78031,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
77551
78031
  *
77552
78032
  * @since 1.107.0
77553
78033
  *
77554
- * @returns A promise that gets resolved with the proper URI-encoded key predicate, for example "(Sector='A%2FB%26C',ID='42')"
78034
+ * @returns A promise that gets resolved with the proper URL-encoded key predicate, for example "(Sector='A%2FB%26C',ID='42')"
77555
78035
  * or "('42')", or `undefined` if at least one key property is undefined. It gets rejected if the metadata
77556
78036
  * cannot be fetched, or in case the entity has no key properties according to the metadata.
77557
78037
  */
@@ -77565,6 +78045,25 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
77565
78045
  */
77566
78046
  oEntity: object
77567
78047
  ): Promise<string | undefined>;
78048
+ /**
78049
+ * Loads side effects for the given absolute paths on all affected bindings. For more information about
78050
+ * side effects in general, see {@link sap.ui.model.odata.v4.Context#requestSideEffects}.
78051
+ *
78052
+ * @since 1.146.0
78053
+ *
78054
+ * @returns A promise which is resolved without a defined result, or rejected with an error if the side
78055
+ * effects fail to load.
78056
+ */
78057
+ requestSideEffects(
78058
+ /**
78059
+ * The absolute paths for which to request side effects, for example "/SalesOrderList/SO_2_SOITEM/Note".
78060
+ */
78061
+ aAbsolutePaths: string[],
78062
+ /**
78063
+ * The group ID to be used. If not specified, the {@link #getUpdateGroupId update group ID} is used.
78064
+ */
78065
+ sGroupId?: string
78066
+ ): Promise<void>;
77568
78067
  /**
77569
78068
  * Resets all property changes, created entities, and entity deletions associated with the given group ID
77570
78069
  * which have not been successfully submitted via {@link #submitBatch}. Resets also invalid user input for
@@ -77712,12 +78211,16 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
77712
78211
 
77713
78212
  /**
77714
78213
  * Parameters of the ODataModel#parseError event.
78214
+ *
78215
+ * @deprecated As of version 1.37.0. this event is not supported
77715
78216
  */
77716
78217
  export interface ODataModel$ParseErrorEventParameters
77717
78218
  extends Model$ParseErrorEventParameters {}
77718
78219
 
77719
78220
  /**
77720
78221
  * Event object of the ODataModel#parseError event.
78222
+ *
78223
+ * @deprecated As of version 1.37.0. this event is not supported
77721
78224
  */
77722
78225
  export type ODataModel$ParseErrorEvent = Event<
77723
78226
  ODataModel$ParseErrorEventParameters,
@@ -77751,12 +78254,16 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
77751
78254
 
77752
78255
  /**
77753
78256
  * Parameters of the ODataModel#requestCompleted event.
78257
+ *
78258
+ * @deprecated As of version 1.37.0. this event is not supported
77754
78259
  */
77755
78260
  export interface ODataModel$RequestCompletedEventParameters
77756
78261
  extends Model$RequestCompletedEventParameters {}
77757
78262
 
77758
78263
  /**
77759
78264
  * Event object of the ODataModel#requestCompleted event.
78265
+ *
78266
+ * @deprecated As of version 1.37.0. this event is not supported
77760
78267
  */
77761
78268
  export type ODataModel$RequestCompletedEvent = Event<
77762
78269
  ODataModel$RequestCompletedEventParameters,
@@ -77765,12 +78272,16 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
77765
78272
 
77766
78273
  /**
77767
78274
  * Parameters of the ODataModel#requestFailed event.
78275
+ *
78276
+ * @deprecated As of version 1.37.0. this event is not supported
77768
78277
  */
77769
78278
  export interface ODataModel$RequestFailedEventParameters
77770
78279
  extends Model$RequestFailedEventParameters {}
77771
78280
 
77772
78281
  /**
77773
78282
  * Event object of the ODataModel#requestFailed event.
78283
+ *
78284
+ * @deprecated As of version 1.37.0. this event is not supported
77774
78285
  */
77775
78286
  export type ODataModel$RequestFailedEvent = Event<
77776
78287
  ODataModel$RequestFailedEventParameters,
@@ -77779,12 +78290,16 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
77779
78290
 
77780
78291
  /**
77781
78292
  * Parameters of the ODataModel#requestSent event.
78293
+ *
78294
+ * @deprecated As of version 1.37.0. this event is not supported
77782
78295
  */
77783
78296
  export interface ODataModel$RequestSentEventParameters
77784
78297
  extends Model$RequestSentEventParameters {}
77785
78298
 
77786
78299
  /**
77787
78300
  * Event object of the ODataModel#requestSent event.
78301
+ *
78302
+ * @deprecated As of version 1.37.0. this event is not supported
77788
78303
  */
77789
78304
  export type ODataModel$RequestSentEvent = Event<
77790
78305
  ODataModel$RequestSentEventParameters,
@@ -79708,6 +80223,26 @@ declare module "sap/ui/model/TreeBinding" {
79708
80223
  */
79709
80224
  oListener?: object
79710
80225
  ): void;
80226
+ /**
80227
+ * Computes the binding's application filters by replacing application filters of the given type with the
80228
+ * given new filters. Subclasses call this method from their filter method implementation.
80229
+ *
80230
+ * @since 1.146.0
80231
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
80232
+ *
80233
+ * @returns The new application filters
80234
+ */
80235
+ computeApplicationFilters(
80236
+ /**
80237
+ * The new filters for the given filter type
80238
+ */
80239
+ vFilter?: Filter[] | Filter,
80240
+ /**
80241
+ * The type of the application filters to replace
80242
+ */
80243
+ sFilterType?: /* was: sap.ui.model.FilterType.Application */
80244
+ any | /* was: sap.ui.model.FilterType.ApplicationBound */ any
80245
+ ): Filter[] | Filter | undefined;
79711
80246
  /**
79712
80247
  * Detaches event handler `fnFunction` from the {@link #event:_filter _filter} event of this `sap.ui.model.TreeBinding`.
79713
80248
  *
@@ -79737,7 +80272,9 @@ declare module "sap/ui/model/TreeBinding" {
79737
80272
  */
79738
80273
  aFilters?: Filter[] | Filter,
79739
80274
  /**
79740
- * The type of the filter to replace; if no type is given, the behavior depends on the model implementation
80275
+ * The type of filter to replace. If no type is specified, the behavior depends on the model implementation.
80276
+ * Since 1.146.0, you can use `sap.ui.model.FilterType.ApplicationBound` to set bound application filters
80277
+ * if the model implementation supports it.
79741
80278
  */
79742
80279
  sFilterType?: FilterType | keyof typeof FilterType
79743
80280
  ): void;
@@ -82114,8 +82651,12 @@ declare module "sap/ui/test/actions/EnterText" {
82114
82651
  /**
82115
82652
  * Gets current value of property {@link #getKeepFocus keepFocus}.
82116
82653
  *
82654
+ * If it is set to `true`, the input will remain focused after text is entered. Use this for inputs with
82655
+ * a suggestion list that you want to keep open.
82656
+ *
82117
82657
  * Default value is `false`.
82118
82658
  *
82659
+ * @since 1.67
82119
82660
  *
82120
82661
  * @returns Value of property `keepFocus`
82121
82662
  */
@@ -82123,8 +82664,13 @@ declare module "sap/ui/test/actions/EnterText" {
82123
82664
  /**
82124
82665
  * Gets current value of property {@link #getPressEnterKey pressEnterKey}.
82125
82666
  *
82667
+ * If it is set to `true`, an ENTER key will be entered after the text. Use this for inputs that shouldn't
82668
+ * lose the focus after a text is entered. (e.g. inputs in a sap.m.Popover shouldn't be focused out, as
82669
+ * this will make the popover close in FF and IE11)
82670
+ *
82126
82671
  * Default value is `false`.
82127
82672
  *
82673
+ * @since 1.76
82128
82674
  *
82129
82675
  * @returns Value of property `pressEnterKey`
82130
82676
  */
@@ -82164,10 +82710,14 @@ declare module "sap/ui/test/actions/EnterText" {
82164
82710
  /**
82165
82711
  * Sets a new value for property {@link #getKeepFocus keepFocus}.
82166
82712
  *
82713
+ * If it is set to `true`, the input will remain focused after text is entered. Use this for inputs with
82714
+ * a suggestion list that you want to keep open.
82715
+ *
82167
82716
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
82168
82717
  *
82169
82718
  * Default value is `false`.
82170
82719
  *
82720
+ * @since 1.67
82171
82721
  *
82172
82722
  * @returns Reference to `this` in order to allow method chaining
82173
82723
  */
@@ -82180,10 +82730,15 @@ declare module "sap/ui/test/actions/EnterText" {
82180
82730
  /**
82181
82731
  * Sets a new value for property {@link #getPressEnterKey pressEnterKey}.
82182
82732
  *
82733
+ * If it is set to `true`, an ENTER key will be entered after the text. Use this for inputs that shouldn't
82734
+ * lose the focus after a text is entered. (e.g. inputs in a sap.m.Popover shouldn't be focused out, as
82735
+ * this will make the popover close in FF and IE11)
82736
+ *
82183
82737
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
82184
82738
  *
82185
82739
  * Default value is `false`.
82186
82740
  *
82741
+ * @since 1.76
82187
82742
  *
82188
82743
  * @returns Reference to `this` in order to allow method chaining
82189
82744
  */
@@ -82231,8 +82786,21 @@ declare module "sap/ui/test/actions/EnterText" {
82231
82786
  */
82232
82787
  clearTextFirst?: boolean | PropertyBindingInfo | `{${string}}`;
82233
82788
 
82789
+ /**
82790
+ * If it is set to `true`, the input will remain focused after text is entered. Use this for inputs with
82791
+ * a suggestion list that you want to keep open.
82792
+ *
82793
+ * @since 1.67
82794
+ */
82234
82795
  keepFocus?: boolean | PropertyBindingInfo | `{${string}}`;
82235
82796
 
82797
+ /**
82798
+ * If it is set to `true`, an ENTER key will be entered after the text. Use this for inputs that shouldn't
82799
+ * lose the focus after a text is entered. (e.g. inputs in a sap.m.Popover shouldn't be focused out, as
82800
+ * this will make the popover close in FF and IE11)
82801
+ *
82802
+ * @since 1.76
82803
+ */
82236
82804
  pressEnterKey?: boolean | PropertyBindingInfo | `{${string}}`;
82237
82805
  }
82238
82806
  }
@@ -82348,7 +82916,8 @@ declare module "sap/ui/test/actions/Press" {
82348
82916
  static getMetadata(): ManagedObjectMetadata;
82349
82917
  /**
82350
82918
  * Sets focus on given control and triggers a 'tap' event on it (which is internally translated into a 'press'
82351
- * event). Logs an error if control is not visible (i.e. has no dom representation)
82919
+ * event). If `keyDown` or `keyUp` is set to `true`, dispatches the corresponding keyboard event instead
82920
+ * of mouse events. Logs an error if control is not visible (i.e. has no dom representation)
82352
82921
  */
82353
82922
  executeOn(
82354
82923
  /**
@@ -82376,6 +82945,28 @@ declare module "sap/ui/test/actions/Press" {
82376
82945
  * @returns Value of property `ctrlKey`
82377
82946
  */
82378
82947
  getCtrlKey(): boolean;
82948
+ /**
82949
+ * Gets current value of property {@link #getKeyDown keyDown}.
82950
+ *
82951
+ * If it is set to `true`, a `keydown` keyboard event will be dispatched instead of mouse events. The modifier
82952
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
82953
+ *
82954
+ * @since 1.146
82955
+ *
82956
+ * @returns Value of property `keyDown`
82957
+ */
82958
+ getKeyDown(): boolean;
82959
+ /**
82960
+ * Gets current value of property {@link #getKeyUp keyUp}.
82961
+ *
82962
+ * If it is set to `true`, a `keyup` keyboard event will be dispatched instead of mouse events. The modifier
82963
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
82964
+ *
82965
+ * @since 1.146
82966
+ *
82967
+ * @returns Value of property `keyUp`
82968
+ */
82969
+ getKeyUp(): boolean;
82379
82970
  /**
82380
82971
  * Gets current value of property {@link #getShiftKey shiftKey}.
82381
82972
  *
@@ -82442,6 +83033,42 @@ declare module "sap/ui/test/actions/Press" {
82442
83033
  */
82443
83034
  bCtrlKey: boolean
82444
83035
  ): this;
83036
+ /**
83037
+ * Sets a new value for property {@link #getKeyDown keyDown}.
83038
+ *
83039
+ * If it is set to `true`, a `keydown` keyboard event will be dispatched instead of mouse events. The modifier
83040
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
83041
+ *
83042
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
83043
+ *
83044
+ * @since 1.146
83045
+ *
83046
+ * @returns Reference to `this` in order to allow method chaining
83047
+ */
83048
+ setKeyDown(
83049
+ /**
83050
+ * New value for property `keyDown`
83051
+ */
83052
+ bKeyDown: boolean
83053
+ ): this;
83054
+ /**
83055
+ * Sets a new value for property {@link #getKeyUp keyUp}.
83056
+ *
83057
+ * If it is set to `true`, a `keyup` keyboard event will be dispatched instead of mouse events. The modifier
83058
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
83059
+ *
83060
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
83061
+ *
83062
+ * @since 1.146
83063
+ *
83064
+ * @returns Reference to `this` in order to allow method chaining
83065
+ */
83066
+ setKeyUp(
83067
+ /**
83068
+ * New value for property `keyUp`
83069
+ */
83070
+ bKeyUp: boolean
83071
+ ): this;
82445
83072
  /**
82446
83073
  * Sets a new value for property {@link #getShiftKey shiftKey}.
82447
83074
  *
@@ -82536,6 +83163,22 @@ declare module "sap/ui/test/actions/Press" {
82536
83163
  * @since 1.98
82537
83164
  */
82538
83165
  yPercentage?: float | PropertyBindingInfo | `{${string}}`;
83166
+
83167
+ /**
83168
+ * If it is set to `true`, a `keydown` keyboard event will be dispatched instead of mouse events. The modifier
83169
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
83170
+ *
83171
+ * @since 1.146
83172
+ */
83173
+ keyDown?: boolean | PropertyBindingInfo | `{${string}}`;
83174
+
83175
+ /**
83176
+ * If it is set to `true`, a `keyup` keyboard event will be dispatched instead of mouse events. The modifier
83177
+ * keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
83178
+ *
83179
+ * @since 1.146
83180
+ */
83181
+ keyUp?: boolean | PropertyBindingInfo | `{${string}}`;
82539
83182
  }
82540
83183
  }
82541
83184
 
@@ -82619,6 +83262,8 @@ declare module "sap/ui/test/actions/Scroll" {
82619
83262
  /**
82620
83263
  * Gets current value of property {@link #getX x}.
82621
83264
  *
83265
+ * The x scroll position.
83266
+ *
82622
83267
  * Default value is `0`.
82623
83268
  *
82624
83269
  *
@@ -82628,6 +83273,8 @@ declare module "sap/ui/test/actions/Scroll" {
82628
83273
  /**
82629
83274
  * Gets current value of property {@link #getY y}.
82630
83275
  *
83276
+ * The y scroll position.
83277
+ *
82631
83278
  * Default value is `0`.
82632
83279
  *
82633
83280
  *
@@ -82637,6 +83284,8 @@ declare module "sap/ui/test/actions/Scroll" {
82637
83284
  /**
82638
83285
  * Sets a new value for property {@link #getX x}.
82639
83286
  *
83287
+ * The x scroll position.
83288
+ *
82640
83289
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
82641
83290
  *
82642
83291
  * Default value is `0`.
@@ -82653,6 +83302,8 @@ declare module "sap/ui/test/actions/Scroll" {
82653
83302
  /**
82654
83303
  * Sets a new value for property {@link #getY y}.
82655
83304
  *
83305
+ * The y scroll position.
83306
+ *
82656
83307
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
82657
83308
  *
82658
83309
  * Default value is `0`.
@@ -82671,8 +83322,14 @@ declare module "sap/ui/test/actions/Scroll" {
82671
83322
  * Describes the settings that can be provided to the Scroll constructor.
82672
83323
  */
82673
83324
  export interface $ScrollSettings extends $ActionSettings {
83325
+ /**
83326
+ * The x scroll position.
83327
+ */
82674
83328
  x?: int | PropertyBindingInfo | `{${string}}`;
82675
83329
 
83330
+ /**
83331
+ * The y scroll position.
83332
+ */
82676
83333
  y?: int | PropertyBindingInfo | `{${string}}`;
82677
83334
  }
82678
83335
  }
@@ -86628,8 +87285,13 @@ declare module "sap/ui/test/RecordReplay" {
86628
87285
  * 'InteractionType'.
86629
87286
  */
86630
87287
  enum InteractionType {
87288
+ /**
87289
+ * "EnterText" interaction type.
87290
+ */
86631
87291
  EnterText = "ENTER_TEXT",
86632
-
87292
+ /**
87293
+ * "Press" Interaction type.
87294
+ */
86633
87295
  Press = "PRESS",
86634
87296
  }
86635
87297
  }