@openui5/ts-types 1.134.0 → 1.136.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.134.0
282
+ // For Library Version: 1.136.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -1516,7 +1516,8 @@ declare module "sap/base/i18n/ResourceBundle" {
1516
1516
  enhanceWith?: Configuration[];
1517
1517
  /**
1518
1518
  * Whether the first bundle should be loaded asynchronously Note: Fallback bundles loaded by {@link #getText }
1519
- * are always loaded synchronously.
1519
+ * are always loaded synchronously. **As of version 1.135, synchronous loading is deprecated.** The `async`
1520
+ * parameter must have the value `true`.
1520
1521
  */
1521
1522
  async?: boolean;
1522
1523
  }
@@ -1747,7 +1748,7 @@ declare module "sap/base/Log" {
1747
1748
  sComponent?: string,
1748
1749
  /**
1749
1750
  * Callback that returns an additional support object to be logged in support mode. This function is only
1750
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1751
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1751
1752
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1752
1753
  * with mostly static and stable content.
1753
1754
  */
@@ -1772,7 +1773,7 @@ declare module "sap/base/Log" {
1772
1773
  sComponent?: string,
1773
1774
  /**
1774
1775
  * Callback that returns an additional support object to be logged in support mode. This function is only
1775
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1776
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1776
1777
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1777
1778
  * with mostly static and stable content.
1778
1779
  */
@@ -1797,7 +1798,7 @@ declare module "sap/base/Log" {
1797
1798
  sComponent?: string,
1798
1799
  /**
1799
1800
  * Callback that returns an additional support object to be logged in support mode. This function is only
1800
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1801
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1801
1802
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1802
1803
  * with mostly static and stable content.
1803
1804
  */
@@ -1871,7 +1872,7 @@ declare module "sap/base/Log" {
1871
1872
  sComponent?: string,
1872
1873
  /**
1873
1874
  * Callback that returns an additional support object to be logged in support mode. This function is only
1874
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1875
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1875
1876
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1876
1877
  * with mostly static and stable content.
1877
1878
  */
@@ -1943,7 +1944,7 @@ declare module "sap/base/Log" {
1943
1944
  sComponent?: string,
1944
1945
  /**
1945
1946
  * Callback that returns an additional support object to be logged in support mode. This function is only
1946
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1947
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1947
1948
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1948
1949
  * with mostly static and stable content.
1949
1950
  */
@@ -1968,7 +1969,7 @@ declare module "sap/base/Log" {
1968
1969
  sComponent?: string,
1969
1970
  /**
1970
1971
  * Callback that returns an additional support object to be logged in support mode. This function is only
1971
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1972
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1972
1973
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1973
1974
  * with mostly static and stable content.
1974
1975
  */
@@ -2132,7 +2133,7 @@ declare module "sap/base/Log" {
2132
2133
  sComponent?: string,
2133
2134
  /**
2134
2135
  * Callback that returns an additional support object to be logged in support mode. This function is only
2135
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2136
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2136
2137
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2137
2138
  * with mostly static and stable content.
2138
2139
  */
@@ -2157,7 +2158,7 @@ declare module "sap/base/Log" {
2157
2158
  sComponent?: string,
2158
2159
  /**
2159
2160
  * Callback that returns an additional support object to be logged in support mode. This function is only
2160
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2161
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2161
2162
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2162
2163
  * with mostly static and stable content.
2163
2164
  */
@@ -2182,7 +2183,7 @@ declare module "sap/base/Log" {
2182
2183
  sComponent?: string,
2183
2184
  /**
2184
2185
  * Callback that returns an additional support object to be logged in support mode. This function is only
2185
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2186
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2186
2187
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2187
2188
  * with mostly static and stable content.
2188
2189
  */
@@ -2221,7 +2222,7 @@ declare module "sap/base/Log" {
2221
2222
  sComponent?: string,
2222
2223
  /**
2223
2224
  * Callback that returns an additional support object to be logged in support mode. This function is only
2224
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2225
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2225
2226
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2226
2227
  * with mostly static and stable content.
2227
2228
  */
@@ -2284,7 +2285,7 @@ declare module "sap/base/Log" {
2284
2285
  sComponent?: string,
2285
2286
  /**
2286
2287
  * Callback that returns an additional support object to be logged in support mode. This function is only
2287
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2288
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2288
2289
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2289
2290
  * with mostly static and stable content.
2290
2291
  */
@@ -2309,7 +2310,7 @@ declare module "sap/base/Log" {
2309
2310
  sComponent?: string,
2310
2311
  /**
2311
2312
  * Callback that returns an additional support object to be logged in support mode. This function is only
2312
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2313
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2313
2314
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2314
2315
  * with mostly static and stable content.
2315
2316
  */
@@ -5155,6 +5156,20 @@ declare module "sap/ui/core/Theming" {
5155
5156
  * @since 1.118.0
5156
5157
  */
5157
5158
  notifyContentDensityChanged(): void;
5159
+ /**
5160
+ * Sets the favicon. The path must be relative to the current origin. Absolute URLs are not allowed.
5161
+ *
5162
+ * @since 1.135
5163
+ *
5164
+ * @returns A promise that resolves when the favicon has been set with undefined
5165
+ */
5166
+ setFavicon(
5167
+ /**
5168
+ * A string containing a specific relative path to the favicon, 'true' to use a favicon from custom theme
5169
+ * or the default favicon in case no custom favicon is maintained, 'false' or undefined to disable the favicon
5170
+ */
5171
+ vFavicon: string | boolean | undefined
5172
+ ): Promise<undefined>;
5158
5173
  /**
5159
5174
  * Allows setting the theme name
5160
5175
  *
@@ -12825,6 +12840,9 @@ declare namespace sap {
12825
12840
  *
12826
12841
  * For more information on the `oBindingInfo.key` property and its usage, see {@link https://ui5.sap.com/#/topic/7cdff73f308b4b10bdf7d83b7aba72e7 Extended Change Detection}.
12827
12842
  *
12843
+ * Providing sorters and/or filters as positional parameters is deprecated as of 1.135.0. Provide them as
12844
+ * part of a `BindingInfo` object instead.
12845
+ *
12828
12846
  *
12829
12847
  * @returns Returns `this` to allow method chaining
12830
12848
  */
@@ -12834,9 +12852,21 @@ declare namespace sap {
12834
12852
  */
12835
12853
  sName: string,
12836
12854
  /**
12837
- * Binding info
12855
+ * A `BindingInfo` object or just the path, if no further properties are required
12838
12856
  */
12839
- oBindingInfo: sap.ui.base.ManagedObject.AggregationBindingInfo
12857
+ vBindingInfo:
12858
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
12859
+ | string,
12860
+ /**
12861
+ * The template to clone for each item in the aggregation; either a template `Element` or a factory function
12862
+ * must be given
12863
+ */
12864
+ vTemplate?:
12865
+ | sap.ui.base.ManagedObject
12866
+ | ((
12867
+ p1: string,
12868
+ p2: sap.ui.model.Context
12869
+ ) => sap.ui.base.ManagedObject)
12840
12870
  ): this;
12841
12871
  /**
12842
12872
  * Bind the object to the referenced entity in the model, which is used as the binding context to resolve
@@ -12873,14 +12903,17 @@ declare namespace sap {
12873
12903
  * Also see {@link https://ui5.sap.com/#/topic/91f05e8b6f4d1014b6dd926db0e91070 Context Binding} in the
12874
12904
  * documentation.
12875
12905
  *
12906
+ * As of 1.135, providing 'parameters' as positional parameter is deprecated. Provide them as part of a
12907
+ * `BindingInfo` object instead.
12908
+ *
12876
12909
  *
12877
12910
  * @returns Returns `this` to allow method chaining
12878
12911
  */
12879
12912
  bindObject(
12880
12913
  /**
12881
- * Binding info
12914
+ * A `BindingInfo` object or just the path, if no further properties are required
12882
12915
  */
12883
- oBindingInfo: sap.ui.base.ManagedObject.ObjectBindingInfo
12916
+ vBindingInfo: sap.ui.base.ManagedObject.ObjectBindingInfo | string
12884
12917
  ): this;
12885
12918
  /**
12886
12919
  * Binds a property to the model.
@@ -12943,6 +12976,9 @@ declare namespace sap {
12943
12976
  * Also see {@link https://ui5.sap.com/#/topic/91f0652b6f4d1014b6dd926db0e91070 Property Binding} in the
12944
12977
  * documentation.
12945
12978
  *
12979
+ * Providing a type, formatter, or bindingMode as a positional parameter is deprecated as of 1.135.0. Provide
12980
+ * them as part of a `BindingInfo` object instead.
12981
+ *
12946
12982
  *
12947
12983
  * @returns Returns `this` to allow method chaining
12948
12984
  */
@@ -12953,9 +12989,9 @@ declare namespace sap {
12953
12989
  */
12954
12990
  sName: string,
12955
12991
  /**
12956
- * Binding information
12992
+ * A `BindingInfo` object or just the path, if no further properties are required
12957
12993
  */
12958
- oBindingInfo: sap.ui.base.ManagedObject.PropertyBindingInfo
12994
+ vBindingInfo: sap.ui.base.ManagedObject.PropertyBindingInfo | string
12959
12995
  ): this;
12960
12996
  /**
12961
12997
  * Clones a tree of objects starting with the object on which clone is called first (root object).
@@ -20599,6 +20635,18 @@ declare namespace sap {
20599
20635
  XML = "xml",
20600
20636
  }
20601
20637
  }
20638
+
20639
+ namespace ControllerExtension {
20640
+ /**
20641
+ * The type of the `overrides` property
20642
+ */
20643
+ type Overrides = { [key: string]: any } & Partial<
20644
+ Pick<
20645
+ (typeof Controller)["prototype"],
20646
+ "onAfterRendering" | "onBeforeRendering" | "onExit" | "onInit"
20647
+ >
20648
+ >;
20649
+ }
20602
20650
  /**
20603
20651
  * Marker interface for a ControllerExtension.
20604
20652
  *
@@ -20839,7 +20887,8 @@ declare namespace sap {
20839
20887
  mOptions: {
20840
20888
  /**
20841
20889
  * The controller name that corresponds to a JS module that can be loaded via the module system (mOptions.name
20842
- * + suffix ".controller.js")
20890
+ * + suffix ".controller.js"). It can be specified either in dot notation (`my.sample.Controller`) or in
20891
+ * module name syntax (`module:my/sample/Controller`).
20843
20892
  */
20844
20893
  name: string;
20845
20894
  }
@@ -20876,86 +20925,15 @@ declare namespace sap {
20876
20925
  */
20877
20926
  static getMetadata(): sap.ui.base.Metadata;
20878
20927
  /**
20879
- * Registers a callback module, which provides code enhancements for the lifecycle and event handler functions
20880
- * of a specific controller. The code enhancements are returned either in sync or async mode.
20881
- *
20882
- * The extension provider module provides the `getControllerExtensions` function which returns either directly
20883
- * an array of objects or a Promise that returns an array of objects when it resolves. These objects are
20884
- * object literals defining the methods and properties of the controller in a similar way as for {@link sap.ui.core.mvc.Controller Controller }
20885
- * subclasses.
20886
- *
20887
- * **Example for a callback module definition (sync):**
20888
- * ```javascript
20889
- *
20890
- * sap.ui.define("my/custom/sync/ExtensionProvider", [], function() {
20891
- * var ExtensionProvider = function() {};
20892
- * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
20893
- * if (!bAsync && sControllerName == "my.own.Controller") {
20894
- * // IMPORTANT: only return extensions for a specific controller
20895
- * return [{
20896
- * onInit: function() {
20897
- * // Do something here...
20898
- * },
20899
- * onAfterRendering: function() {
20900
- * // Do something here...
20901
- * },
20902
- * onButtonClick: function(oEvent) {
20903
- * // Handle the button click event
20904
- * }
20905
- * }
20906
- * }];
20907
- * };
20908
- * return ExtensionProvider;
20909
- * });
20910
- * ```
20911
- *
20912
- *
20913
- * **Example for a callback module definition (async):**
20914
- * ```javascript
20915
- *
20916
- * sap.ui.define("my/custom/async/ExtensionProvider", [], function() {
20917
- * var ExtensionProvider = function() {};
20918
- * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
20919
- * if (bAsync && sControllerName == "my.own.Controller") {
20920
- * // IMPORTANT:
20921
- * // only return a Promise for a specific controller since it
20922
- * // requires the View/Controller and its parents to run in async
20923
- * // mode!
20924
- * return new Promise(function(fnResolve, fnReject) {
20925
- * fnResolve([{
20926
- * onInit: function() {
20927
- * // Do something here...
20928
- * },
20929
- * onAfterRendering: function() {
20930
- * // Do something here...
20931
- * },
20932
- * onButtonClick: function(oEvent) {
20933
- * // Handle the button click event
20934
- * }
20935
- * }]);
20936
- * }
20937
- * };
20938
- * };
20939
- * return ExtensionProvider;
20940
- * });
20941
- * ```
20942
- *
20943
- *
20944
- * The lifecycle functions `onInit`, `onExit`, `onBeforeRendering` and `onAfterRendering` are added before
20945
- * or after the lifecycle functions of the original controller. The event handler functions, such as `onButtonClick`,
20946
- * are replacing the original controller's function.
20947
- *
20948
- * When using an async extension provider, you need to ensure that the view is loaded in async mode.
20949
- *
20950
- * In both cases, return `undefined` if no controller extension shall be applied.
20928
+ * See {@link sap.ui.core.mvc.ControllerExtensionProvider.registerExtensionProvider}.
20951
20929
  *
20952
20930
  * @since 1.34.0
20931
+ * @deprecated As of version 1.136.0. without replacement, the extension provider concept is intended for
20932
+ * framework internal use only.
20953
20933
  */
20954
20934
  static registerExtensionProvider(
20955
20935
  /**
20956
20936
  * the module name of the extension provider
20957
- *
20958
- * See {@link sap.ui.core.mvc.Controller} for an overview of the available functions for controllers.
20959
20937
  */
20960
20938
  sExtensionProvider: string
20961
20939
  ): void;
@@ -21043,8 +21021,9 @@ declare namespace sap {
21043
21021
  */
21044
21022
  mOptions: {
21045
21023
  /**
21046
- * The Fragment name, which must correspond to a Fragment which can be loaded via the module system (fragmentName
21047
- * + suffix ".fragment.[typeextension]") and which contains the Fragment definition.
21024
+ * The fragment name, which must correspond to a fragment which can be loaded via the module system (mOptions.name
21025
+ * + suffix ".fragment.[typeextension]") and must contain the fragment definition. It can be specified either
21026
+ * in dot notation (`my.sample.myFragment`) or, for JS fragments, in module name syntax (`module:my/sample/myFragment`).
21048
21027
  */
21049
21028
  name: string;
21050
21029
  /**
@@ -21056,11 +21035,12 @@ declare namespace sap {
21056
21035
  */
21057
21036
  autoPrefixId?: boolean;
21058
21037
  /**
21059
- * the ID of the Fragment
21038
+ * the ID of the fragment
21060
21039
  */
21061
21040
  id?: string;
21062
21041
  /**
21063
- * the Fragment type, e.g. "XML", "JS", or "HTML" (see above). Default is "XML"
21042
+ * the fragment type, e.g. "XML", "JS", or "HTML" (see above). Default is "XML". If the fragment name is
21043
+ * given in module name syntax (e.g., `module:my/sample/myFragment`) the type must be omitted.
21064
21044
  */
21065
21045
  type?: string;
21066
21046
  }
@@ -21158,6 +21138,11 @@ declare namespace sap {
21158
21138
  * @ui5-protected Do not call from applications (only from related classes in the framework)
21159
21139
  */
21160
21140
  protected constructor();
21141
+ /**
21142
+ * The `overrides` definition object, which is used to specify methods of the base class to override. The
21143
+ * names of this object's properties are method names like `onInit` and the values are the respective implementation.
21144
+ */
21145
+ static readonly overrides?: sap.ui.core.mvc.ControllerExtension.Overrides;
21161
21146
 
21162
21147
  /**
21163
21148
  * Creates a new subclass of class sap.ui.core.mvc.ControllerExtension with name `sClassName` and enriches
@@ -21835,14 +21820,17 @@ declare namespace sap {
21835
21820
  * ```
21836
21821
  *
21837
21822
  *
21838
- * Other Methods: Besides `createContent`, there are two other methods that a view can implement: Method
21839
- * {@link #getControllerName getControllerName} defines the name of the controller that should be instantiated
21840
- * and used for the view. The name must be in class name notation (dot notation), without the `".controller"`
21841
- * suffix. The suffix will be added by the framework when loading the module containing the controller.
21842
- *
21843
- * {@link #getAutoPrefixId getAutoPrefixId} defines whether the IDs of controls created during the execution
21844
- * of `createContent` will be prefixed with the ID of the view automatically. The default implementation
21845
- * of this method returns `false`.
21823
+ * Other Methods: Besides `createContent`, there are other methods that a view can implement:
21824
+ * - Method {@link #getControllerName getControllerName} defines the name of the controller that should
21825
+ * be instantiated and used for the view. The name must be in class name notation (dot notation), without
21826
+ * the `".controller"` suffix. The suffix will be added by the framework when loading the module containing
21827
+ * the controller.
21828
+ * - Method {@link #getControllerModuleName getControllerModuleName} defines the module name of the controller
21829
+ * that should be loaded for the view. Unlike `getControllerName`, the name must be in `sap.ui.define/sap.ui.require`
21830
+ * syntax (slash-separated name without '.js' suffix).
21831
+ * - {@link #getAutoPrefixId getAutoPrefixId} defines whether the IDs of controls created during the execution
21832
+ * of `createContent` will be prefixed with the ID of the view automatically. The default implementation
21833
+ * of this method returns `false`.
21846
21834
  */
21847
21835
  abstract class View extends sap.ui.core.Control {
21848
21836
  /**
@@ -22474,6 +22462,16 @@ declare namespace sap {
22474
22462
  * @returns Controller of this view.
22475
22463
  */
22476
22464
  getController(): sap.ui.core.mvc.Controller;
22465
+ /**
22466
+ * An optional method that views can implement to return the controller's module name in `sap.ui.define/sap.ui.require`
22467
+ * syntax (slash-separated name without '.js' suffix). If no controller instance is provided at the time
22468
+ * of View instantiation AND this method exists, the View attempts to load and instantiate the controller
22469
+ * and to connect it to itself.
22470
+ *
22471
+ *
22472
+ * @returns Name of the module name from which to load the view definition.
22473
+ */
22474
+ getControllerModuleName(): string;
22477
22475
  /**
22478
22476
  * An (optional) method to be implemented by Views. When no controller instance is given at View instantiation
22479
22477
  * time AND this method exists and returns the (package and class) name of a controller, the View tries
@@ -24227,35 +24225,35 @@ declare namespace sap {
24227
24225
  * This enum is part of the 'sap/ui/core/Popup' module export and must be accessed by the property 'Dock'.
24228
24226
  */
24229
24227
  enum Dock {
24230
- BeginBottom = "begin bottom",
24228
+ BeginBottom = "BeginBottom",
24231
24229
 
24232
- BeginCenter = "begin center",
24230
+ BeginCenter = "BeginCenter",
24233
24231
 
24234
- BeginTop = "begin top",
24232
+ BeginTop = "BeginTop",
24235
24233
 
24236
- CenterBottom = "center bottom",
24234
+ CenterBottom = "CenterBottom",
24237
24235
 
24238
- CenterCenter = "center center",
24236
+ CenterCenter = "CenterCenter",
24239
24237
 
24240
- CenterTop = "center top",
24238
+ CenterTop = "CenterTop",
24241
24239
 
24242
- EndBottom = "end bottom",
24240
+ EndBottom = "EndBottom",
24243
24241
 
24244
- EndCenter = "end center",
24242
+ EndCenter = "EndCenter",
24245
24243
 
24246
- EndTop = "end top",
24244
+ EndTop = "EndTop",
24247
24245
 
24248
- LeftBottom = "left bottom",
24246
+ LeftBottom = "LeftBottom",
24249
24247
 
24250
- LeftCenter = "left center",
24248
+ LeftCenter = "LeftCenter",
24251
24249
 
24252
- LeftTop = "left top",
24250
+ LeftTop = "LeftTop",
24253
24251
 
24254
- RightBottom = "right bottom",
24252
+ RightBottom = "RightBottom",
24255
24253
 
24256
- RightCenter = "right center",
24254
+ RightCenter = "RightCenter",
24257
24255
 
24258
- RightTop = "right top",
24256
+ RightTop = "RightTop",
24259
24257
  }
24260
24258
 
24261
24259
  type PositionInfo = {
@@ -37805,7 +37803,9 @@ declare namespace sap {
37805
37803
  * the manifest will not be evaluated before the controller. It might still be loaded synchronously if declared
37806
37804
  * in the Component metadata. A non-empty string value will be interpreted as the URL to load the manifest
37807
37805
  * from. If the manifest could not be loaded from a given URL, the Promise returned by the Component.create
37808
- * factory rejects. A non-null object value will be interpreted as manifest content.
37806
+ * factory rejects. A non-null object value will be interpreted as manifest content. **Note:** If a manifest
37807
+ * is provided as URL or plain object, it must use the same major schema version as the original manifest
37808
+ * to avoid incompatible changes in the behavior of the component.
37809
37809
  */
37810
37810
  manifest?: boolean | string | object;
37811
37811
  /**
@@ -38110,6 +38110,8 @@ declare namespace sap {
38110
38110
  * The properties can also be defined in the descriptor. These properties can be overwritten by the local
38111
38111
  * properties of that function.
38112
38112
  *
38113
+ * Synchronous Component creation is deprecated as of 1.135.0.
38114
+ *
38113
38115
  * @since 1.47.0
38114
38116
  *
38115
38117
  * @returns Component instance or Promise which will be resolved with the component instance (defaults to
@@ -40506,7 +40508,7 @@ declare namespace sap {
40506
40508
  );
40507
40509
 
40508
40510
  /**
40509
- * Returns the nearest [UI5 Element]{@link sap.ui.core.Element} that wraps the given DOM element.
40511
+ * Returns the nearest {@link sap.ui.core.Element UI5 Element} that wraps the given DOM element.
40510
40512
  *
40511
40513
  * A DOM element or a CSS selector is accepted as a given parameter. When a CSS selector is given as parameter,
40512
40514
  * only the first DOM element that matches the CSS selector is taken to find the nearest UI5 Element that
@@ -40793,13 +40795,16 @@ declare namespace sap {
40793
40795
  */
40794
40796
  bindElement(
40795
40797
  /**
40796
- * the binding path or an object with more detailed binding options
40798
+ * A `BindingInfo` object or just the path, if no further properties are required
40797
40799
  */
40798
- vPath: string | sap.ui.base.ManagedObject.ObjectBindingInfo,
40800
+ vBindingInfo: sap.ui.base.ManagedObject.ObjectBindingInfo | string,
40799
40801
  /**
40800
40802
  * map of additional parameters for this binding. Only taken into account when `vPath` is a string. In that
40801
40803
  * case it corresponds to `mParameters` of {@link sap.ui.base.ManagedObject.ObjectBindingInfo}. The supported
40802
40804
  * parameters are listed in the corresponding model-specific implementation of `sap.ui.model.ContextBinding`.
40805
+ *
40806
+ * Providing 'parameters' as positional parameter is deprecated as of 1.135.0. Provide them as part of a
40807
+ * `BindingInfo` object instead.
40803
40808
  */
40804
40809
  mParameters?: object
40805
40810
  ): this;
@@ -42145,15 +42150,18 @@ declare namespace sap {
42145
42150
  */
42146
42151
  mOptions: {
42147
42152
  /**
42148
- * must be supplied if no `definition` parameter is given. The fragment name must correspond to an XML fragment
42149
- * which can be loaded via the module system (fragmentName + suffix `.fragment.<typeExtension>`)
42150
- * and which contains the fragment definition. If `mOptions.controller` is supplied, the (event handler)
42151
- * methods referenced in the fragment will be called on that controller. Note that fragments may require
42152
- * a controller to be given and certain methods to be implemented by it.
42153
+ * Must be provided if no `definition` parameter is given. The fragment name must correspond to an XML fragment
42154
+ * which can be loaded via the module system and must contain the fragment definition. It can be specified
42155
+ * either in dot notation (fragmentName + suffix `.fragment.<typeExtension>`) or, for JS fragments,
42156
+ * in module name syntax (`module:my/sample/AsyncButton`). If `mOptions.controller` is supplied, the (event
42157
+ * handler) methods referenced in the fragment will be called on that controller. Note that fragments may
42158
+ * require a controller to be given and certain methods to be implemented by it.
42153
42159
  */
42154
42160
  name?: string;
42155
42161
  /**
42156
- * the fragment type, e.g. `"XML"`, `"JS"`, or `"HTML"` (type `"HTML"` is deprecated). Default is `"XML"`
42162
+ * the fragment type, e.g. `"XML"`, `"JS"`, or `"HTML"` (type `"HTML"` is deprecated). Default is `"XML"`.
42163
+ * If the fragment name is given in module name syntax (e.g., `module:my/sample/AsyncButton`) the type must
42164
+ * be omitted.
42157
42165
  */
42158
42166
  type?: string;
42159
42167
  /**
@@ -44790,15 +44798,16 @@ declare namespace sap {
44790
44798
  sCurrencySymbol: string
44791
44799
  ): string;
44792
44800
  /**
44793
- * Returns the number of digits of the specified currency.
44801
+ * Returns the number of digits of the given currency considering a custom currency first and falling back
44802
+ * to the CLDR data if no custom currency is defined.
44794
44803
  *
44795
44804
  * @since 1.21.1
44796
44805
  *
44797
- * @returns digits of the currency
44806
+ * @returns The number of digits for the given currency
44798
44807
  */
44799
44808
  getCurrencyDigits(
44800
44809
  /**
44801
- * ISO 4217 currency code
44810
+ * The ISO 4217 currency code
44802
44811
  */
44803
44812
  sCurrency: string
44804
44813
  ): int;
@@ -45650,14 +45659,14 @@ declare namespace sap {
45650
45659
  * @since 1.54
45651
45660
  *
45652
45661
  * @returns The unit format pattern for the given unit name as a map from a pattern key like `"unitPattern-count-other"`
45653
- * to the corresponding pattern
45662
+ * to the corresponding pattern or `undefined` if no corresponding pattern is found
45654
45663
  */
45655
45664
  getUnitFormat(
45656
45665
  /**
45657
45666
  * unit name, e.g. "duration-hour"
45658
45667
  */
45659
45668
  sUnit: string
45660
- ): Record<string, string>;
45669
+ ): Record<string, string> | undefined;
45661
45670
  /**
45662
45671
  * Retrieves unit format patterns for all units see {@link #getResolvedUnitFormat} for an example of a unit
45663
45672
  * format pattern.
@@ -51720,6 +51729,7 @@ declare namespace sap {
51720
51729
  * },
51721
51730
  *
51722
51731
  * // activate real async loading and module definitions
51732
+ * // (will become obsolete in 2.0 contexts as async will be the only mode there)
51723
51733
  * async: true,
51724
51734
  *
51725
51735
  * // provide dependency and export metadata for non-UI5 modules
@@ -51861,6 +51871,8 @@ declare namespace sap {
51861
51871
  * on the application bootstrap tag.
51862
51872
  *
51863
51873
  * **Note:** Switching back from async to sync is not supported and trying to do so will throw an `Error`
51874
+ *
51875
+ * In the next major version of UI5, this option will become obsolete as async will be the only mode.
51864
51876
  */
51865
51877
  async?: boolean;
51866
51878
  /**
@@ -60816,10 +60828,7 @@ declare namespace sap {
60816
60828
  * - `properties` could be an array containing the property names which should be included in the new
60817
60829
  * entry. Other properties defined in the entity type won't be included.
60818
60830
  * - `properties` could be an object which includes the desired properties and the corresponding values
60819
- * which should be used for the created entry. If `properties` is not specified, all properties in
60820
- * the entity type will be included in the created entry.
60821
- *
60822
- * If there are no values specified, the properties will have `undefined` values.
60831
+ * which should be used for the created entry.
60823
60832
  *
60824
60833
  * The `properties` can be modified via property bindings relative to the returned context instance.
60825
60834
  *
@@ -63775,6 +63784,8 @@ declare namespace sap {
63775
63784
  *
63776
63785
  * Note: For a transient context (see {@link #isTransient}) a wrong path is returned unless all key properties
63777
63786
  * are available within the initial data.
63787
+ * See:
63788
+ * #requestCanonicalPath
63778
63789
  *
63779
63790
  * @since 1.39.0
63780
63791
  *
@@ -64023,14 +64034,19 @@ declare namespace sap {
64023
64034
  *
64024
64035
  * @since 1.125.0
64025
64036
  *
64026
- * @returns A promise which is resolved without a defined result when the move is finished, or rejected
64027
- * in case of an error
64037
+ * @returns A promise which is resolved without a defined result when the move is finished, or with the
64038
+ * index for the copied node, or rejected in case of an error
64028
64039
  */
64029
64040
  move(
64030
64041
  /**
64031
64042
  * A parameter object
64032
64043
  */
64033
64044
  oParameters: {
64045
+ /**
64046
+ * Whether the node should be copied instead of moved (@experimental as of version 1.135.0). The returned
64047
+ * promise resolves with the index for the copied node.
64048
+ */
64049
+ copy?: boolean;
64034
64050
  /**
64035
64051
  * The next sibling's context, or `null` to turn this node into the last sibling. Omitting the sibling moves
64036
64052
  * this node to a position determined by the server.
@@ -64041,7 +64057,7 @@ declare namespace sap {
64041
64057
  */
64042
64058
  parent: sap.ui.model.odata.v4.Context | null;
64043
64059
  }
64044
- ): Promise<void>;
64060
+ ): Promise<number | undefined>;
64045
64061
  /**
64046
64062
  * Refreshes the single entity represented by this context. Use {@link #requestRefresh} if you want to wait
64047
64063
  * for the refresh.
@@ -64087,6 +64103,8 @@ declare namespace sap {
64087
64103
  *
64088
64104
  * Note: For a transient context (see {@link #isTransient}) a wrong path is returned unless all key properties
64089
64105
  * are available within the initial data.
64106
+ * See:
64107
+ * #getCanonicalPath
64090
64108
  *
64091
64109
  * @since 1.39.0
64092
64110
  *
@@ -64547,7 +64565,9 @@ declare namespace sap {
64547
64565
  /**
64548
64566
  * Changes this binding's parameters and refreshes the binding. Since 1.111.0, a list binding's header context
64549
64567
  * is deselected, but (since 1.120.13) only if the binding parameter '$$clearSelectionOnFilter' is set and
64550
- * the '$filter' or '$search' parameter is changed.
64568
+ * the '$filter' or '$search' parameter is changed. In all other cases, the caller of this method needs
64569
+ * to evaluate whether the changed parameters invalidate the current selection and then deselect the header
64570
+ * context if needed.
64551
64571
  *
64552
64572
  * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges }
64553
64573
  * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch }
@@ -65112,10 +65132,46 @@ declare namespace sap {
65112
65132
  */
65113
65133
  oListener?: object
65114
65134
  ): this;
65135
+ /**
65136
+ * Attach event handler `fnFunction` to the 'selectionChanged' event of this binding.
65137
+ *
65138
+ * @since 1.136.0
65139
+ *
65140
+ * @returns `this` to allow method chaining
65141
+ */
65142
+ attachSelectionChanged(
65143
+ /**
65144
+ * The function to call when the event occurs
65145
+ */
65146
+ fnFunction: Function,
65147
+ /**
65148
+ * Object on which to call the given function
65149
+ */
65150
+ oListener?: object
65151
+ ): this;
65152
+ /**
65153
+ * Attach event handler `fnFunction` to the 'separateReceived' event of this binding.
65154
+ *
65155
+ * @since 1.136.0
65156
+ *
65157
+ * @returns `this` to allow method chaining
65158
+ */
65159
+ attachSeparateReceived(
65160
+ /**
65161
+ * The function to call when the event occurs
65162
+ */
65163
+ fnFunction: Function,
65164
+ /**
65165
+ * Object on which to call the given function
65166
+ */
65167
+ oListener?: object
65168
+ ): this;
65115
65169
  /**
65116
65170
  * Changes this binding's parameters and refreshes the binding. Since 1.111.0, a list binding's header context
65117
65171
  * is deselected, but (since 1.120.13) only if the binding parameter '$$clearSelectionOnFilter' is set and
65118
- * the '$filter' or '$search' parameter is changed.
65172
+ * the '$filter' or '$search' parameter is changed. In all other cases, the caller of this method needs
65173
+ * to evaluate whether the changed parameters invalidate the current selection and then deselect the header
65174
+ * context if needed.
65119
65175
  *
65120
65176
  * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges }
65121
65177
  * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch }
@@ -65341,6 +65397,40 @@ declare namespace sap {
65341
65397
  */
65342
65398
  oListener?: object
65343
65399
  ): this;
65400
+ /**
65401
+ * Detach event handler `fnFunction` from the 'selectionChanged' event of this binding.
65402
+ *
65403
+ * @since 1.136.0
65404
+ *
65405
+ * @returns `this` to allow method chaining
65406
+ */
65407
+ detachSelectionChanged(
65408
+ /**
65409
+ * The function to call when the event occurs
65410
+ */
65411
+ fnFunction: (evt: ODataListBinding$SelectionChangedEvent) => void,
65412
+ /**
65413
+ * Object on which to call the given function
65414
+ */
65415
+ oListener?: object
65416
+ ): this;
65417
+ /**
65418
+ * Detach event handler `fnFunction` from the 'separateReceived' event of this binding.
65419
+ *
65420
+ * @since 1.136.0
65421
+ *
65422
+ * @returns `this` to allow method chaining
65423
+ */
65424
+ detachSeparateReceived(
65425
+ /**
65426
+ * The function to call when the event occurs
65427
+ */
65428
+ fnFunction: (evt: ODataListBinding$SeparateReceivedEvent) => void,
65429
+ /**
65430
+ * Object on which to call the given function
65431
+ */
65432
+ oListener?: object
65433
+ ): this;
65344
65434
  /**
65345
65435
  * Filters the list with the given filters. Since 1.97.0, if filters are unchanged, no request is sent,
65346
65436
  * regardless of pending changes. Since 1.111.0, all contexts (incl. the header context) are deselected,
@@ -65619,6 +65709,17 @@ declare namespace sap {
65619
65709
  | sap.ui.model.odata.v4.ODataListBinding
65620
65710
  | sap.ui.model.odata.v4.ODataPropertyBinding
65621
65711
  | undefined;
65712
+ /**
65713
+ * Returns the count of selected elements as a number of type `Edm.Int64`. The count is bindable via the
65714
+ * header context (see {@link #getHeaderContext}) and path `$selectionCount`; it is either available synchronously
65715
+ * or unknown. It is unknown if the binding is relative but has no context and also if the list binding's
65716
+ * {@link sap.ui.model.odata.v4.ODataListBinding#getHeaderContext header context} is selected ("select all").
65717
+ *
65718
+ * @since 1.135.0
65719
+ *
65720
+ * @returns The count of selected elements or `undefined` if the count or the header context is not available.
65721
+ */
65722
+ getSelectionCount(): number | undefined;
65622
65723
  /**
65623
65724
  * Returns the group ID of the binding that is used for update requests. The update group ID of the binding
65624
65725
  * is alternatively defined by
@@ -66414,6 +66515,17 @@ declare namespace sap {
66414
66515
  */
66415
66516
  sPropertyPath: string
66416
66517
  ): sap.ui.model.odata.v4.ValueListType;
66518
+ /**
66519
+ * Tells whether this metadata model's service prefers requests to use a resource path with navigation properties
66520
+ * instead of a canonical path, thus reflecting the object composition. See "com.sap.vocabularies.Common.v1.AddressViaNavigationPath"
66521
+ * for more details.
66522
+ *
66523
+ * @since 1.135.0
66524
+ *
66525
+ * @returns `true` if the "com.sap.vocabularies.Common.v1.AddressViaNavigationPath" tag is present, `undefined`
66526
+ * if it is missing or metadata is not (yet) available
66527
+ */
66528
+ isAddressViaNavigationPath(): boolean | undefined;
66417
66529
  /**
66418
66530
  * Method not supported
66419
66531
  * See:
@@ -67241,7 +67353,10 @@ declare namespace sap {
67241
67353
  $$canonicalPath?: boolean;
67242
67354
  /**
67243
67355
  * Whether the selection state of the list binding is cleared when a filter is changed; this includes dynamic
67244
- * filters, '$filter', '$search', and `$$aggregation.search`. Supported since 1.120.13.
67356
+ * filters, '$filter', '$search', and `$$aggregation.search`. Supported since 1.120.13. Since 1.135.0, the
67357
+ * selection state is validated when reloading the list binding's data. The {@link sap.ui.model.odata.v4.Context#isSelected selection states of contexts }
67358
+ * which no longer match the current filter are reset. **Note:** The selection state is not validated if
67359
+ * the `$$aggregation` parameter is used.
67245
67360
  */
67246
67361
  $$clearSelectionOnFilter?: boolean;
67247
67362
  /**
@@ -67328,6 +67443,16 @@ declare namespace sap {
67328
67443
  * binding refers to an action advertisement the binding's mode must be {@link sap.ui.model.BindingMode.OneTime}.
67329
67444
  * {@link sap.ui.model.BindingMode.OneWay OneWay} is also supported (since 1.130.0) for complex types and
67330
67445
  * collections thereof; for entity types, use {@link #bindContext} instead.
67446
+ *
67447
+ * Since 1.135.0, the binding may also point to an array element inside a collection of primitive type,
67448
+ * for example in the context of geography locations. Let's assume "GeoLocation" is a structural property
67449
+ * of type "Edm.GeographyPoint", then "coordinates" is a structural property of type "Collection(Edm.Double)":
67450
+ *
67451
+ * ```javascript
67452
+ *
67453
+ * <Text id="longitude" text="{Address/GeoLocation/coordinates/0}"/>
67454
+ * ```
67455
+ *
67331
67456
  * See:
67332
67457
  * sap.ui.base.ManagedObject#bindProperty
67333
67458
  * sap.ui.model.Model#bindProperty
@@ -86013,6 +86138,8 @@ declare namespace sap {
86013
86138
 
86014
86139
  "sap/ui/core/Element": undefined;
86015
86140
 
86141
+ "sap/ui/core/ElementHooks": undefined;
86142
+
86016
86143
  "sap/ui/core/ElementMetadata": undefined;
86017
86144
 
86018
86145
  "sap/ui/core/ElementRegistry": undefined;