@sapui5/ts-types 1.95.0 → 1.96.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.
Files changed (64) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +235 -1
  8. package/types/sap.f.d.ts +59 -40
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +73 -2
  11. package/types/sap.fe.macros.d.ts +27 -3
  12. package/types/sap.fe.navigation.d.ts +1 -1
  13. package/types/sap.fe.placeholder.d.ts +1 -1
  14. package/types/sap.fe.plugins.d.ts +1 -1
  15. package/types/sap.fe.semantics.d.ts +1 -1
  16. package/types/sap.fe.templates.d.ts +1 -1
  17. package/types/sap.fe.test.d.ts +1 -1
  18. package/types/sap.fe.tools.d.ts +1 -1
  19. package/types/sap.feedback.ui.d.ts +1 -1
  20. package/types/sap.gantt.d.ts +340 -40
  21. package/types/sap.landvisz.d.ts +1 -1
  22. package/types/sap.m.d.ts +542 -107
  23. package/types/sap.makit.d.ts +1 -1
  24. package/types/sap.me.d.ts +1 -1
  25. package/types/sap.ndc.d.ts +2 -7
  26. package/types/sap.ovp.d.ts +1 -1
  27. package/types/sap.rules.ui.d.ts +1 -1
  28. package/types/sap.sac.grid.d.ts +635 -0
  29. package/types/sap.suite.ui.commons.d.ts +1 -1
  30. package/types/sap.suite.ui.generic.template.d.ts +6 -2
  31. package/types/sap.suite.ui.microchart.d.ts +1 -1
  32. package/types/sap.tnt.d.ts +1 -1
  33. package/types/sap.ui.codeeditor.d.ts +1 -1
  34. package/types/sap.ui.commons.d.ts +1 -1
  35. package/types/sap.ui.comp.d.ts +142 -11
  36. package/types/sap.ui.core.d.ts +656 -460
  37. package/types/sap.ui.dt.d.ts +1 -1
  38. package/types/sap.ui.export.d.ts +119 -69
  39. package/types/sap.ui.fl.d.ts +1 -1
  40. package/types/sap.ui.generic.app.d.ts +1 -1
  41. package/types/sap.ui.generic.template.d.ts +1 -1
  42. package/types/sap.ui.integration.d.ts +220 -1
  43. package/types/sap.ui.layout.d.ts +19 -1
  44. package/types/sap.ui.mdc.d.ts +39 -1
  45. package/types/sap.ui.richtexteditor.d.ts +1 -1
  46. package/types/sap.ui.rta.d.ts +1 -1
  47. package/types/sap.ui.suite.d.ts +1 -1
  48. package/types/sap.ui.support.d.ts +6 -6
  49. package/types/sap.ui.table.d.ts +1 -1
  50. package/types/sap.ui.testrecorder.d.ts +1 -1
  51. package/types/sap.ui.unified.d.ts +1 -1
  52. package/types/sap.ui.ux3.d.ts +1 -1
  53. package/types/sap.ui.vbm.d.ts +1 -1
  54. package/types/sap.ui.vk.d.ts +704 -115
  55. package/types/sap.ui.vtm.d.ts +1 -1
  56. package/types/sap.uiext.inbox.d.ts +1 -1
  57. package/types/sap.ushell.d.ts +45 -35
  58. package/types/sap.ushell_abap.d.ts +1 -1
  59. package/types/sap.uxap.d.ts +1 -1
  60. package/types/sap.viz.d.ts +1 -1
  61. package/types/sap.webanalytics.core.d.ts +1 -1
  62. package/types/sap.zen.commons.d.ts +1 -1
  63. package/types/sap.zen.crosstab.d.ts +1 -1
  64. package/types/sap.zen.dsh.d.ts +53 -34
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
264
264
  ): jQuery;
265
265
  }
266
266
 
267
- // For Library Version: 1.95.0
267
+ // For Library Version: 1.96.0
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -13300,206 +13300,6 @@ declare namespace sap {
13300
13300
  ): number | any[] | string;
13301
13301
  }
13302
13302
  }
13303
- /**
13304
- * The IconPool is a static class for retrieving or registering icons. It also provides helping methods
13305
- * for easier consumption of icons. There are already icons registered in IconPool, please use the Demo
13306
- * App named "Icon Explorer" to find the name of the icon.
13307
- *
13308
- * In order to use the icon inside an existing control, please call {@link sap.ui.core.IconPool.getIconURI}
13309
- * and assign the URI to the control's property which supports icons. If you want to support both, icons
13310
- * and standard images in your own control, please use the static method {@link sap.ui.core.IconPool.createControlByURI}
13311
- * to either create an Icon in case the first argument is an icon-URL or another control which you define
13312
- * by providing it as the second argument.
13313
- */
13314
- namespace IconPool {
13315
- /**
13316
- * Register an additional icon to the sap.ui.core.IconPool.
13317
- */
13318
- function addIcon(
13319
- /**
13320
- * the name of the icon.
13321
- */
13322
- iconName: string,
13323
- /**
13324
- * the name of icon collection. The built in icons are with empty collectionName, so if additional icons
13325
- * need to be registered in IconPool, the collectionName can't be empty.
13326
- */
13327
- collectionName: string,
13328
- /**
13329
- * the icon info which contains the following properties:
13330
- */
13331
- iconInfo: {
13332
- /**
13333
- * is the name of the font when importing the font using @font-face in CSS
13334
- */
13335
- fontFamily: string;
13336
- /**
13337
- * is the special hexadecimal code without the prefix, for example "e000" or several of them
13338
- */
13339
- content: string | string[];
13340
- /**
13341
- * indicates if already registered icons should be overwritten when the same name and collection are given.
13342
- * The built in icons can never be overwritten.
13343
- */
13344
- overWrite?: boolean;
13345
- /**
13346
- * indicates whether this icon should NOT be mirrored in RTL (right to left) mode.
13347
- */
13348
- suppressMirroring?: boolean;
13349
- /**
13350
- * ResourceBundle to be used for translation. Key format: "Icon.".
13351
- */
13352
- resourceBundle?: import("sap/base/i18n/ResourceBundle").default;
13353
- }
13354
- ): object;
13355
- /**
13356
- * Creates an instance of {@link sap.ui.core.Icon} if the given URI is an icon URI, otherwise the given
13357
- * constructor is called. The given URI is set to the src property of the control.
13358
- */
13359
- function createControlByURI(
13360
- /**
13361
- * Contains the properties which will be used to instantiate the returned control. All properties of the
13362
- * associated constructor can be used. Unknown properties are ignored. It should contain at least a property
13363
- * named src. If it's given with a string type, it will be taken as the value of src property.
13364
- */
13365
- setting: string | object,
13366
- /**
13367
- * The constructor function which is called when the given URI isn't an icon URI
13368
- */
13369
- constructor: Function
13370
- ): sap.ui.core.Control;
13371
- /**
13372
- * @SINCE 1.56.0
13373
- *
13374
- * Checks if the icon font is loaded
13375
- */
13376
- function fontLoaded(
13377
- /**
13378
- * icon collection name
13379
- */
13380
- sCollectionName: string
13381
- ): Promise<any> | undefined;
13382
- /**
13383
- * Returns all names of registered collections in IconPool
13384
- */
13385
- function getIconCollectionNames(): any[];
13386
- /**
13387
- * @SINCE 1.25.0
13388
- *
13389
- * Returns the icon url based on the given mime type
13390
- */
13391
- function getIconForMimeType(
13392
- /**
13393
- * the mime type of a file (e.g. "application/zip")
13394
- */
13395
- sMimeType: string
13396
- ): string;
13397
- /**
13398
- * Returns an info object for the icon with the given `iconName` and `collectionName`.
13399
- *
13400
- * Instead of giving name and collection, a complete icon-URI can be provided as `iconName`. The method
13401
- * will determine name and collection from the URI, see {@link #.isIconURI IconPool.isIconURI} for details.
13402
- *
13403
- * The returned info object has the following properties:
13404
- * - `string: name` Name of the icon
13405
- * - `string: collection` Name of the collection that contains the icon or `undefined` in case of the
13406
- * default collection
13407
- * - `string: uri` Icon URI that identifies the icon
13408
- * - `string: fontFamily` CSS font family to use for this icon
13409
- * - `string: content` Character sequence that represents the icon in the icon font
13410
- * - `string: text` Alternative text describing the icon (optional, might be empty)
13411
- * - `boolean: suppressMirroring` Whether the icon needs no mirroring in right-to-left mode
13412
- */
13413
- function getIconInfo(
13414
- /**
13415
- * Name of the icon, or a complete icon-URI with icon collection and icon name; must not be empty
13416
- */
13417
- iconName: string,
13418
- /**
13419
- * Name of the icon collection; to access built-in icons, omit the collection name
13420
- */
13421
- collectionName?: string,
13422
- /**
13423
- * The approach for loading the icon info, if it is not already available: sync - font metadata is loaded
13424
- * synchronously and the icon info is returned immediately async - a promise is returned that returns the
13425
- * icon info when the font metadata is loaded mixed - until the font metadata is loaded a promise is returned,
13426
- * afterwards the icon info
13427
- */
13428
- loadingMode?: string
13429
- ): object | Promise<any> | undefined;
13430
- /**
13431
- * Returns all name of icons that are registered under the given collection.
13432
- */
13433
- function getIconNames(
13434
- /**
13435
- * the name of collection where icon names are retrieved.
13436
- */
13437
- collectionName: string
13438
- ): any[];
13439
- /**
13440
- * Returns the URI of the icon in the pool which has the given `iconName` and `collectionName`.
13441
- */
13442
- function getIconURI(
13443
- /**
13444
- * Name of the icon, must not be empty
13445
- */
13446
- iconName: string,
13447
- /**
13448
- * Name of the icon collection; to access built-in icons, omit the collection name
13449
- */
13450
- collectionName?: string
13451
- ): string;
13452
- /**
13453
- * Returns whether the given `uri` is an icon URI.
13454
- *
13455
- * A string is an icon URI when it can be parsed as a URI and when it has one of the two forms
13456
- * - sap-icon://collectionName/iconName
13457
- * - sap-icon://iconName where collectionName and iconName must be non-empty.
13458
- */
13459
- function isIconURI(
13460
- /**
13461
- * The URI to check
13462
- */
13463
- uri: string
13464
- ): boolean;
13465
- /**
13466
- * @SINCE 1.56.0
13467
- *
13468
- * Registers an additional icon font to the icon pool
13469
- */
13470
- function registerFont(
13471
- /**
13472
- * configuration object for registering the font
13473
- */
13474
- oConfig: {
13475
- /**
13476
- * the file name of the font face
13477
- */
13478
- fontFamily: string;
13479
- /**
13480
- * a collection name for the font, if not specified the font face will be used
13481
- */
13482
- collectionName?: string;
13483
- /**
13484
- * the location where the font files are physically located
13485
- */
13486
- fontURI: sap.ui.core.URI;
13487
- /**
13488
- * a configuration object mapping the icon name to the hexadecimal icon address in the font
13489
- */
13490
- metadata?: object;
13491
- /**
13492
- * an URI to a file containing the configuration object specified with oConfig.metadata
13493
- */
13494
- metadataURI?: object;
13495
- /**
13496
- * load the icon font metadata only when an icon is requested with {@link #.getIconInfo} if not specified
13497
- * a JSON file with the name oConfig.fontFamily will be loaded from the location specified in oConfig.fontURI
13498
- */
13499
- lazy?: boolean;
13500
- }
13501
- ): void;
13502
- }
13503
13303
 
13504
13304
  namespace message {
13505
13305
  /**
@@ -18417,7 +18217,7 @@ declare namespace sap {
18417
18217
  * The hash to be matched
18418
18218
  */
18419
18219
  sHash: string
18420
- ): object | undefined;
18220
+ ): sap.ui.core.routing.RouteInfo | undefined;
18421
18221
  /**
18422
18222
  * Returns a target by its name.
18423
18223
  *
@@ -19652,6 +19452,17 @@ declare namespace sap {
19652
19452
  fullHash?: string;
19653
19453
  };
19654
19454
 
19455
+ type RouteInfo = {
19456
+ /**
19457
+ * The route name
19458
+ */
19459
+ name: string;
19460
+ /**
19461
+ * The route data
19462
+ */
19463
+ arguments: Record<string, string>;
19464
+ };
19465
+
19655
19466
  /**
19656
19467
  * @SINCE 1.84.0
19657
19468
  *
@@ -25696,6 +25507,225 @@ declare namespace sap {
25696
25507
  }
25697
25508
  const ExtensionPoint: ExtensionPoint;
25698
25509
 
25510
+ /**
25511
+ * The IconPool is a static class for retrieving or registering icons. It also provides helping methods
25512
+ * for easier consumption of icons. There are already icons registered in IconPool, please use the Demo
25513
+ * App named "Icon Explorer" to find the name of the icon.
25514
+ *
25515
+ * In order to use the icon inside an existing control, please call {@link sap.ui.core.IconPool.getIconURI}
25516
+ * and assign the URI to the control's property which supports icons. If you want to support both, icons
25517
+ * and standard images in your own control, please use the static method {@link sap.ui.core.IconPool.createControlByURI}
25518
+ * to either create an Icon in case the first argument is an icon-URL or another control which you define
25519
+ * by providing it as the second argument.
25520
+ */
25521
+ interface IconPool {
25522
+ /**
25523
+ * Register an additional icon to the sap.ui.core.IconPool.
25524
+ */
25525
+ addIcon(
25526
+ /**
25527
+ * the name of the icon.
25528
+ */
25529
+ iconName: string,
25530
+ /**
25531
+ * the name of icon collection. The built in icons are with empty collectionName, so if additional icons
25532
+ * need to be registered in IconPool, the collectionName can't be empty.
25533
+ */
25534
+ collectionName: string,
25535
+ /**
25536
+ * the icon info which contains the following properties:
25537
+ */
25538
+ iconInfo: {
25539
+ /**
25540
+ * is the name of the font when importing the font using @font-face in CSS
25541
+ */
25542
+ fontFamily: string;
25543
+ /**
25544
+ * is the special hexadecimal code without the prefix, for example "e000" or several of them
25545
+ */
25546
+ content: string | string[];
25547
+ /**
25548
+ * indicates if already registered icons should be overwritten when the same name and collection are given.
25549
+ * The built in icons can never be overwritten.
25550
+ */
25551
+ overWrite?: boolean;
25552
+ /**
25553
+ * indicates whether this icon should NOT be mirrored in RTL (right to left) mode.
25554
+ */
25555
+ suppressMirroring?: boolean;
25556
+ /**
25557
+ * ResourceBundle to be used for translation. Key format: "Icon.".
25558
+ */
25559
+ resourceBundle?: import("sap/base/i18n/ResourceBundle").default;
25560
+ }
25561
+ ): object;
25562
+ /**
25563
+ * Creates an instance of {@link sap.ui.core.Icon} if the given URI is an icon URI, otherwise the given
25564
+ * constructor is called. The given URI is set to the src property of the control.
25565
+ */
25566
+ createControlByURI(
25567
+ /**
25568
+ * Contains the properties which will be used to instantiate the returned control. All properties of the
25569
+ * associated constructor can be used. Unknown properties are ignored. It should contain at least a property
25570
+ * named src. If it's given with a string type, it will be taken as the value of src property.
25571
+ */
25572
+ setting: string | object,
25573
+ /**
25574
+ * The constructor function which is called when the given URI isn't an icon URI
25575
+ */
25576
+ constructor: Function
25577
+ ): sap.ui.core.Control;
25578
+ /**
25579
+ * @SINCE 1.56.0
25580
+ *
25581
+ * Checks if the icon font is loaded
25582
+ */
25583
+ fontLoaded(
25584
+ /**
25585
+ * icon collection name
25586
+ */
25587
+ sCollectionName: string
25588
+ ): Promise<any> | undefined;
25589
+ /**
25590
+ * Returns all names of registered collections in IconPool
25591
+ */
25592
+ getIconCollectionNames(): any[];
25593
+ /**
25594
+ * @SINCE 1.25.0
25595
+ *
25596
+ * Returns the icon url based on the given mime type
25597
+ */
25598
+ getIconForMimeType(
25599
+ /**
25600
+ * the mime type of a file (e.g. "application/zip")
25601
+ */
25602
+ sMimeType: string
25603
+ ): string;
25604
+ /**
25605
+ * Returns an info object for the icon with the given `iconName` and `collectionName`.
25606
+ *
25607
+ * Instead of giving name and collection, a complete icon-URI can be provided as `iconName`. The method
25608
+ * will determine name and collection from the URI, see {@link #.isIconURI IconPool.isIconURI} for details.
25609
+ *
25610
+ * The returned info object has the following properties:
25611
+ * - `string: name` Name of the icon
25612
+ * - `string: collection` Name of the collection that contains the icon or `undefined` in case of the
25613
+ * default collection
25614
+ * - `string: uri` Icon URI that identifies the icon
25615
+ * - `string: fontFamily` CSS font family to use for this icon
25616
+ * - `string: content` Character sequence that represents the icon in the icon font
25617
+ * - `string: text` Alternative text describing the icon (optional, might be empty)
25618
+ * - `boolean: suppressMirroring` Whether the icon needs no mirroring in right-to-left mode
25619
+ */
25620
+ getIconInfo(
25621
+ /**
25622
+ * Name of the icon, or a complete icon-URI with icon collection and icon name; must not be empty
25623
+ */
25624
+ iconName: string,
25625
+ /**
25626
+ * Name of the icon collection; to access built-in icons, omit the collection name
25627
+ */
25628
+ collectionName?: string,
25629
+ /**
25630
+ * The approach for loading the icon info, if it is not already available: sync - font metadata is loaded
25631
+ * synchronously and the icon info is returned immediately async - a promise is returned that returns the
25632
+ * icon info when the font metadata is loaded mixed - until the font metadata is loaded a promise is returned,
25633
+ * afterwards the icon info
25634
+ */
25635
+ loadingMode?: string
25636
+ ): object | Promise<any> | undefined;
25637
+ /**
25638
+ * Returns all name of icons that are registered under the given collection.
25639
+ */
25640
+ getIconNames(
25641
+ /**
25642
+ * the name of collection where icon names are retrieved.
25643
+ */
25644
+ collectionName: string
25645
+ ): any[];
25646
+ /**
25647
+ * Returns the URI of the icon in the pool which has the given `iconName` and `collectionName`.
25648
+ */
25649
+ getIconURI(
25650
+ /**
25651
+ * Name of the icon, must not be empty
25652
+ */
25653
+ iconName: string,
25654
+ /**
25655
+ * Name of the icon collection; to access built-in icons, omit the collection name
25656
+ */
25657
+ collectionName?: string
25658
+ ): string;
25659
+ /**
25660
+ * Adds CSS code to load an icon font to the DOM
25661
+ */
25662
+ insertFontFaceStyle(
25663
+ /**
25664
+ * the file name of the font face
25665
+ */
25666
+ sFontFace: string,
25667
+ /**
25668
+ * the path to the font file
25669
+ */
25670
+ sPath: string,
25671
+ /**
25672
+ * the collection name, if not specified the font face is used
25673
+ */
25674
+ sCollectionName?: string
25675
+ ): void;
25676
+ /**
25677
+ * Returns whether the given `uri` is an icon URI.
25678
+ *
25679
+ * A string is an icon URI when it can be parsed as a URI and when it has one of the two forms
25680
+ * - sap-icon://collectionName/iconName
25681
+ * - sap-icon://iconName where collectionName and iconName must be non-empty.
25682
+ */
25683
+ isIconURI(
25684
+ /**
25685
+ * The URI to check
25686
+ */
25687
+ uri: string
25688
+ ): boolean;
25689
+ /**
25690
+ * @SINCE 1.56.0
25691
+ *
25692
+ * Registers an additional icon font to the icon pool
25693
+ */
25694
+ registerFont(
25695
+ /**
25696
+ * configuration object for registering the font
25697
+ */
25698
+ oConfig: {
25699
+ /**
25700
+ * the file name of the font face
25701
+ */
25702
+ fontFamily: string;
25703
+ /**
25704
+ * a collection name for the font, if not specified the font face will be used
25705
+ */
25706
+ collectionName?: string;
25707
+ /**
25708
+ * the location where the font files are physically located
25709
+ */
25710
+ fontURI: sap.ui.core.URI;
25711
+ /**
25712
+ * a configuration object mapping the icon name to the hexadecimal icon address in the font
25713
+ */
25714
+ metadata?: object;
25715
+ /**
25716
+ * an URI to a file containing the configuration object specified with oConfig.metadata
25717
+ */
25718
+ metadataURI?: object;
25719
+ /**
25720
+ * load the icon font metadata only when an icon is requested with {@link #.getIconInfo} if not specified
25721
+ * a JSON file with the name oConfig.fontFamily will be loaded from the location specified in oConfig.fontURI
25722
+ */
25723
+ lazy?: boolean;
25724
+ }
25725
+ ): void;
25726
+ }
25727
+ const IconPool: IconPool;
25728
+
25699
25729
  /**
25700
25730
  * @SINCE 1.66
25701
25731
  *
@@ -27283,12 +27313,6 @@ declare namespace sap {
27283
27313
  * Container width in CSS size
27284
27314
  */
27285
27315
  getWidth(): sap.ui.core.CSSSize;
27286
- /**
27287
- * @SINCE 1.91
27288
- *
27289
- * Hides the placeholder that is shown on the component container.
27290
- */
27291
- hidePlaceholder(): void;
27292
27316
  /**
27293
27317
  * Sets a new value for property {@link #getAsync async}.
27294
27318
  *
@@ -27493,22 +27517,6 @@ declare namespace sap {
27493
27517
  */
27494
27518
  sWidth?: sap.ui.core.CSSSize
27495
27519
  ): this;
27496
- /**
27497
- * @SINCE 1.91
27498
- *
27499
- * Shows the provided placeholder on the component container.
27500
- */
27501
- showPlaceholder(
27502
- /**
27503
- * Object containing the placeholder object
27504
- */
27505
- mSettings: {
27506
- /**
27507
- * The placeholder instance
27508
- */
27509
- placeholder: /* was: sap.ui.core.Placeholder */ any;
27510
- }
27511
- ): Promise<any>;
27512
27520
  }
27513
27521
  /**
27514
27522
  * @SINCE 1.9.2
@@ -36179,7 +36187,7 @@ declare namespace sap {
36179
36187
  * A `sap.ui.core.UIComponent` subclass can additionally implement the {@link sap.ui.core.IAsyncContentCreation}
36180
36188
  * interface. When implementing this interface the loading and processing of an asynchronous `rootView`
36181
36189
  * will be chained into the result Promise of the {@link sap.ui.core.Component.create Component.create}
36182
- * factory. See Sample 1 below.
36190
+ * factory. An additional async flag can be omitted. See Sample 1 below.
36183
36191
  *
36184
36192
  * Samples 2 and 3 show how subclasses can overwrite the `createContent` function to run asynchronously.
36185
36193
  * To create the root control asynchronously, the subclass has to define the `sap.ui.core.IAsyncContentCreation`
@@ -37934,11 +37942,11 @@ declare namespace sap {
37934
37942
  /**
37935
37943
  * The SAPUI5 Data Binding API.
37936
37944
  *
37937
- * The default binding mode for model implementations (if not implemented otherwise) is two way and the
37938
- * supported binding modes by the model are one way, two way and one time. The default binding mode can
37945
+ * The default binding mode for model implementations (if not implemented otherwise) is two-way and the
37946
+ * supported binding modes by the model are one-way, two-way and one-time. The default binding mode can
37939
37947
  * be changed by the application for each model instance. A model implementation should specify its supported
37940
- * binding modes and set the default binding mode accordingly (e.g. if the model supports only one way binding
37941
- * the default binding mode should also be set to one way).
37948
+ * binding modes and set the default binding mode accordingly (e.g. if the model supports only one-way binding
37949
+ * the default binding mode should also be set to one-way).
37942
37950
  *
37943
37951
  * The default size limit for models is 100. The size limit determines the number of entries used for the
37944
37952
  * list bindings.
@@ -40392,17 +40400,17 @@ declare namespace sap {
40392
40400
  */
40393
40401
  static getMetadata(): sap.ui.base.Metadata;
40394
40402
  /**
40395
- * Returns the value for the property with the given `sPropertyName`
40403
+ * Returns the value for the property with the given `sPropertyName`.
40396
40404
  */
40397
40405
  getProperty(
40398
40406
  /**
40399
- * the path to the property
40407
+ * The path to the property
40400
40408
  */
40401
40409
  sPath: string,
40402
40410
  /**
40403
- * the context which will be used to retrieve the property
40411
+ * The context to resolve a relative path with
40404
40412
  */
40405
- oContext?: object
40413
+ oContext?: sap.ui.model.Context
40406
40414
  ): any;
40407
40415
  /**
40408
40416
  * Sets the message data to the model.
@@ -40419,7 +40427,20 @@ declare namespace sap {
40419
40427
  * Other models provide this method to set a new value for a specific property. `MessageModel` does not
40420
40428
  * support it as it supports the `OneWay` mode only.
40421
40429
  */
40422
- setProperty(): void;
40430
+ setProperty(
40431
+ /**
40432
+ * Unused in this implementation
40433
+ */
40434
+ sPath: string,
40435
+ /**
40436
+ * Unused in this implementation
40437
+ */
40438
+ oValue: object,
40439
+ /**
40440
+ * Unused in this implementation
40441
+ */
40442
+ oContext: sap.ui.model.Context
40443
+ ): void;
40423
40444
  }
40424
40445
  }
40425
40446
  /**
@@ -42942,6 +42963,7 @@ declare namespace sap {
42942
42963
  * A context for the OData V2 model cannot be created at will, it has to be retrieved via:
42943
42964
  * - an OData binding
42944
42965
  * - a view element
42966
+ * - {@link sap.ui.model.odata.v2.ODataModel#callFunction}
42945
42967
  * - {@link sap.ui.model.odata.v2.ODataModel#createBindingContext}
42946
42968
  * - {@link sap.ui.model.odata.v2.ODataModel#createEntry}
42947
42969
  */
@@ -42973,6 +42995,18 @@ declare namespace sap {
42973
42995
  * Returns a metadata object for class sap.ui.model.odata.v2.Context.
42974
42996
  */
42975
42997
  static getMetadata(): sap.ui.base.Metadata;
42998
+ /**
42999
+ * @SINCE 1.96.0
43000
+ *
43001
+ * Returns a promise on the creation state of this context if it has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry};
43002
+ * otherwise returns `undefined`.
43003
+ *
43004
+ * As long as the promise is not yet resolved or rejected, the entity represented by this context is transient.
43005
+ *
43006
+ * Once the promise is resolved, the entity for this context is stored in the back end and {@link #getPath}
43007
+ * returns a path including the key predicate of the new entity.
43008
+ */
43009
+ created(): Promise<any>;
42976
43010
  /**
42977
43011
  * @SINCE 1.94.0
42978
43012
  *
@@ -43593,6 +43627,14 @@ declare namespace sap {
43593
43627
  * Defines the count mode of this binding; if not specified, the default count mode of the `oModel` is applied
43594
43628
  */
43595
43629
  countMode?: sap.ui.model.odata.CountMode;
43630
+ /**
43631
+ * A key used in combination with the resolved path of this binding to identify the entities created this
43632
+ * binding's {@link #create} method.
43633
+ *
43634
+ * **Note:** Different controls or control aggregation bindings to the same collection must have different
43635
+ * `createdEntitiesKey` values.
43636
+ */
43637
+ createdEntitiesKey?: string;
43596
43638
  /**
43597
43639
  * An optional map of custom query parameters. Custom parameters must not start with `$`
43598
43640
  */
@@ -44305,6 +44347,14 @@ declare namespace sap {
44305
44347
  * Count mode for this binding; if not specified, the default count mode for this model is used
44306
44348
  */
44307
44349
  countMode?: sap.ui.model.odata.CountMode;
44350
+ /**
44351
+ * A key used in combination with the resolved path of the binding to identify the entities created via
44352
+ * the binding's {@link #create} method.
44353
+ *
44354
+ * **Note:** Different controls or control aggregation bindings to the same collection must have different
44355
+ * `createdEntitiesKey` values.
44356
+ */
44357
+ createdEntitiesKey?: string;
44308
44358
  /**
44309
44359
  * Operation mode for this binding; if not specified, the default operation mode of this model is used
44310
44360
  */
@@ -44746,8 +44796,11 @@ declare namespace sap {
44746
44796
  * Name. A context object is returned which can be used to bind against the newly created object.
44747
44797
  *
44748
44798
  * For each created entry a request is created and stored in a request queue. The request queue can be submitted
44749
- * by calling {@link #submitChanges}. To delete a created entry from the request queue call {@link #resetChanges}
44750
- * with the context path and the `bDeleteCreatedEntities` parameter set to `true`.
44799
+ * by calling {@link #submitChanges}. As long as the context is transient (see {@link sap.ui.model.odata.v2.Context#isTransient}),
44800
+ * {@link sap.ui.model.odata.v2.ODataModel#resetChanges} with the `bDeleteCreatedEntities` parameter set
44801
+ * to `true` can be used to delete the created entity again.
44802
+ *
44803
+ * If the creation of the entity on the server failed, it is repeated automatically.
44751
44804
  *
44752
44805
  * The optional parameter `mParameters.properties` can be used as follows:
44753
44806
  * - `properties` could be an array containing the property names which should be included in the new
@@ -44758,7 +44811,7 @@ declare namespace sap {
44758
44811
  *
44759
44812
  * If there are no values specified, the properties will have `undefined` values.
44760
44813
  *
44761
- * Please note that deep creates (including data defined by navigation properties) are not supported.
44814
+ * The `properties` can be modified via property bindings relative to the returned context instance.
44762
44815
  *
44763
44816
  * The parameter `expand` is supported since 1.78.0. If this parameter is set, the given navigation properties
44764
44817
  * are expanded automatically with the same $batch request in which the POST request for the creation is
@@ -44777,6 +44830,14 @@ declare namespace sap {
44777
44830
  * handler is called with the data and the response of the POST request. The response object of the success
44778
44831
  * handler call and the response parameter of the corresponding `requestFailed` and `requestCompleted` events
44779
44832
  * have an additional property `expandAfterCreateFailed` set to `true`.
44833
+ *
44834
+ * Note: If a server requires a property in the request, you must supply this property in the initial data,
44835
+ * for example if the server requires a unit for an amount. This also applies if this property has a default
44836
+ * value.
44837
+ *
44838
+ * Note: A deep create (including data defined by navigation properties) is not supported. The dependent
44839
+ * entity has to be created using a second list binding, after this entity has been saved successfully in
44840
+ * the back-end system.
44780
44841
  */
44781
44842
  createEntry(
44782
44843
  /**
@@ -45706,8 +45767,8 @@ declare namespace sap {
45706
45767
  */
45707
45768
  changeSetId?: string;
45708
45769
  /**
45709
- * Since 1.46; defines whether to update all bindings after submitting this change operation. See {@link
45710
- * #setRefreshAfterChange} If given, this overrules the model-wide `refreshAfterChange` flag for this operation
45770
+ * Since 1.46; defines whether to update all bindings after submitting this change operation, see {@link
45771
+ * #setRefreshAfterChange}. If given, this overrules the model-wide `refreshAfterChange` flag for this operation
45711
45772
  * only.
45712
45773
  */
45713
45774
  refreshAfterChange?: boolean;
@@ -48037,6 +48098,19 @@ declare namespace sap {
48037
48098
  *
48038
48099
  * Filters are case sensitive unless the property `caseSensitive` is set to `false`. This property has to
48039
48100
  * be set on each filter, it is not inherited from a multi-filter.
48101
+ *
48102
+ * Application and Control Filters: Each list binding maintains two separate lists of filters, one for filters
48103
+ * defined by the control that owns the binding, and another list for filters that an application can define
48104
+ * in addition. When executing the filter operation, both sets of filters are combined.
48105
+ *
48106
+ * By using the `sFilterType` parameter of the `filter` method, the caller can control which set of filters
48107
+ * is modified.
48108
+ *
48109
+ * Auto-Grouping of Filters: Filters are first grouped according to their binding path. All filters belonging
48110
+ * to the same path are ORed, and after that the results of all paths are ANDed. Usually this means that
48111
+ * all filters applied to the same property are ORed, while filters on different properties are ANDed. Please
48112
+ * use either the automatic grouping of filters (where applicable) or explicit AND/OR filters, as a mixture
48113
+ * of both is not supported.
48040
48114
  * See:
48041
48115
  * sap.ui.model.ListBinding#filter
48042
48116
  * #setAggregation
@@ -49389,9 +49463,8 @@ declare namespace sap {
49389
49463
  $$groupId?: string;
49390
49464
  /**
49391
49465
  * For operation bindings only: Whether $expand and $select from the parent binding are used in the request
49392
- * sent on {@link #execute}. If set to `true`, the binding must not set the $expand or $select parameter
49393
- * itself, the operation must be bound, and the return value and the binding parameter must belong to the
49394
- * same entity set.
49466
+ * sent on {@link #execute}. If set to `true`, the binding must not set the $expand itself, the operation
49467
+ * must be bound, and the return value and the binding parameter must belong to the same entity set.
49395
49468
  */
49396
49469
  $$inheritExpandSelect?: boolean;
49397
49470
  /**
@@ -53431,35 +53504,35 @@ declare namespace sap {
53431
53504
  */
53432
53505
  static getMetadata(): sap.ui.base.Metadata;
53433
53506
  /**
53434
- * Returns the object for the given `path`
53507
+ * Returns the object for the given path and context.
53435
53508
  */
53436
53509
  getObject(
53437
53510
  /**
53438
- * the path to the object
53511
+ * The path to the object
53439
53512
  */
53440
53513
  sPath: string,
53441
53514
  /**
53442
- * the context which will be used to retrieve the object
53515
+ * The context which will be used to retrieve the object
53443
53516
  */
53444
53517
  oContext?: object
53445
- ): any;
53518
+ ): object;
53446
53519
  /**
53447
- * Returns the value for the property with the given `sPropertyName`
53520
+ * Returns the value for the property with the given `sPropertyName`.
53448
53521
  */
53449
53522
  getProperty(
53450
53523
  /**
53451
- * the path to the property
53524
+ * The path to the property
53452
53525
  */
53453
53526
  sPath: string,
53454
53527
  /**
53455
- * the context which will be used to retrieve the property
53528
+ * The context which will be used to retrieve the property
53456
53529
  */
53457
53530
  oContext?: object
53458
- ): any;
53531
+ ): string;
53459
53532
  /**
53460
53533
  * Serializes the current XML data of the model into a string.
53461
53534
  */
53462
- getXML(): undefined;
53535
+ getXML(): string;
53463
53536
  /**
53464
53537
  * Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the
53465
53538
  * model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
@@ -53507,11 +53580,11 @@ declare namespace sap {
53507
53580
  */
53508
53581
  setNameSpace(
53509
53582
  /**
53510
- * the namespace URI
53583
+ * The namespace URI
53511
53584
  */
53512
53585
  sNameSpace: string,
53513
53586
  /**
53514
- * the prefix for the namespace (optional)
53587
+ * The prefix for the namespace
53515
53588
  */
53516
53589
  sPrefix?: string
53517
53590
  ): void;
@@ -53521,19 +53594,19 @@ declare namespace sap {
53521
53594
  */
53522
53595
  setProperty(
53523
53596
  /**
53524
- * path of the property to set
53597
+ * Path of the property to set
53525
53598
  */
53526
53599
  sPath: string,
53527
53600
  /**
53528
- * value to set the property to
53601
+ * Value to set the property to
53529
53602
  */
53530
53603
  oValue: any,
53531
53604
  /**
53532
- * the context which will be used to set the property
53605
+ * The context which will be used to set the property
53533
53606
  */
53534
53607
  oContext?: object,
53535
53608
  /**
53536
- * whether to update other bindings dependent on this property asynchronously
53609
+ * Whether to update other bindings dependent on this property asynchronously
53537
53610
  */
53538
53611
  bAsyncUpdate?: boolean
53539
53612
  ): boolean;
@@ -53922,8 +53995,12 @@ declare namespace sap {
53922
53995
  * Returns a metadata object for class sap.ui.model.type.Date.
53923
53996
  */
53924
53997
  static getMetadata(): sap.ui.base.Metadata;
53925
-
53926
- getOutputPattern(): void;
53998
+ /**
53999
+ * Returns the output pattern.
54000
+ * See:
54001
+ * sap.ui.core.format.DateFormat.getDateInstance
54002
+ */
54003
+ getOutputPattern(): string;
53927
54004
  }
53928
54005
  /**
53929
54006
  * This class represents the Date interval composite type.
@@ -54743,18 +54820,20 @@ declare namespace sap {
54743
54820
  */
54744
54821
  constructor(
54745
54822
  /**
54746
- * the model
54823
+ * The model
54747
54824
  */
54748
54825
  oModel: sap.ui.model.Model,
54749
54826
  /**
54750
- * the path
54827
+ * The path
54751
54828
  */
54752
54829
  sPath: string,
54753
54830
  /**
54754
- * the context object
54831
+ * The context object
54755
54832
  */
54756
54833
  oContext: sap.ui.model.Context,
54757
-
54834
+ /**
54835
+ * Additional, implementation-specific parameters
54836
+ */
54758
54837
  mParameters?: object
54759
54838
  );
54760
54839
 
@@ -54792,27 +54871,27 @@ declare namespace sap {
54792
54871
  */
54793
54872
  attachAggregatedDataStateChange(
54794
54873
  /**
54795
- * The function to be called, when the event occurs
54874
+ * The function to be called when the event occurs
54796
54875
  */
54797
54876
  fnFunction: Function,
54798
54877
  /**
54799
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54878
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54800
54879
  */
54801
54880
  oListener?: object
54802
54881
  ): void;
54803
54882
  /**
54804
- * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.model.Model`.
54883
+ * Attaches the `fnFunction` event handler to the {@link #event:change change} event of this `sap.ui.model.Model`.
54805
54884
  *
54806
54885
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
54807
54886
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
54808
54887
  */
54809
54888
  attachChange(
54810
54889
  /**
54811
- * The function to be called, when the event occurs
54890
+ * The function to be called when the event occurs
54812
54891
  */
54813
54892
  fnFunction: Function,
54814
54893
  /**
54815
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54894
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54816
54895
  */
54817
54896
  oListener?: object
54818
54897
  ): void;
@@ -54824,11 +54903,11 @@ declare namespace sap {
54824
54903
  */
54825
54904
  attachDataReceived(
54826
54905
  /**
54827
- * Function to be called, when the event occurs
54906
+ * Function to be called when the event occurs
54828
54907
  */
54829
54908
  fnFunction: Function,
54830
54909
  /**
54831
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54910
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54832
54911
  */
54833
54912
  oListener?: object
54834
54913
  ): void;
@@ -54840,35 +54919,40 @@ declare namespace sap {
54840
54919
  */
54841
54920
  attachDataRequested(
54842
54921
  /**
54843
- * The function to be called, when the event occurs
54922
+ * The function to be called when the event occurs
54844
54923
  */
54845
54924
  fnFunction: Function,
54846
54925
  /**
54847
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54926
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54848
54927
  */
54849
54928
  oListener?: object
54850
54929
  ): void;
54851
54930
  /**
54852
- * Attaches event handler `fnFunction` to the {@link #event:DataStateChange DataStateChange} event of this
54853
- * `sap.ui.model.Binding`.
54931
+ * Attaches the `fnFunction` event handler to the {@link #event:DataStateChange DataStateChange} event of
54932
+ * thi `sap.ui.model.Binding`.
54854
54933
  *
54855
54934
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
54856
54935
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
54857
54936
  */
54858
54937
  attachDataStateChange(
54859
54938
  /**
54860
- * Function to be called, when the event occurs
54939
+ * Function to be called when the event occurs
54861
54940
  */
54862
54941
  fnFunction: Function,
54863
54942
  /**
54864
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54943
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54865
54944
  */
54866
54945
  oListener?: object
54867
54946
  ): void;
54868
54947
  /**
54869
54948
  * Attach multiple events.
54870
54949
  */
54871
- attachEvents(oEvents: Record<string, Function>): void;
54950
+ attachEvents(
54951
+ /**
54952
+ * Events to attach to this binding
54953
+ */
54954
+ oEvents: Record<string, Function>
54955
+ ): sap.ui.model.Binding;
54872
54956
  /**
54873
54957
  * Attaches event handler `fnFunction` to the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
54874
54958
  *
@@ -54877,11 +54961,11 @@ declare namespace sap {
54877
54961
  */
54878
54962
  attachRefresh(
54879
54963
  /**
54880
- * The function to be called, when the event occurs
54964
+ * The function to be called when the event occurs
54881
54965
  */
54882
54966
  fnFunction: Function,
54883
54967
  /**
54884
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
54968
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54885
54969
  */
54886
54970
  oListener?: object
54887
54971
  ): void;
@@ -54898,7 +54982,7 @@ declare namespace sap {
54898
54982
  */
54899
54983
  detachAggregatedDataStateChange(
54900
54984
  /**
54901
- * The function to be called, when the event occurs
54985
+ * The function to be called when the event occurs
54902
54986
  */
54903
54987
  fnFunction: Function,
54904
54988
  /**
@@ -54911,7 +54995,7 @@ declare namespace sap {
54911
54995
  */
54912
54996
  detachChange(
54913
54997
  /**
54914
- * Function to be called, when the event occurs
54998
+ * Function to be called when the event occurs
54915
54999
  */
54916
55000
  fnFunction: Function,
54917
55001
  /**
@@ -54924,7 +55008,7 @@ declare namespace sap {
54924
55008
  */
54925
55009
  detachDataReceived(
54926
55010
  /**
54927
- * Function to be called, when the event occurs
55011
+ * Function to be called when the event occurs
54928
55012
  */
54929
55013
  fnFunction: Function,
54930
55014
  /**
@@ -54938,7 +55022,7 @@ declare namespace sap {
54938
55022
  */
54939
55023
  detachDataRequested(
54940
55024
  /**
54941
- * The function to be called, when the event occurs
55025
+ * The function to be called when the event occurs
54942
55026
  */
54943
55027
  fnFunction: Function,
54944
55028
  /**
@@ -54952,7 +55036,7 @@ declare namespace sap {
54952
55036
  */
54953
55037
  detachDataStateChange(
54954
55038
  /**
54955
- * The function to be called, when the event occurs
55039
+ * The function to be called when the event occurs
54956
55040
  */
54957
55041
  fnFunction: Function,
54958
55042
  /**
@@ -54963,17 +55047,22 @@ declare namespace sap {
54963
55047
  /**
54964
55048
  * Detach multiple events.
54965
55049
  */
54966
- detachEvents(oEvents: Record<string, Function>): void;
55050
+ detachEvents(
55051
+ /**
55052
+ * Events to detach from this binding
55053
+ */
55054
+ oEvents: Record<string, Function>
55055
+ ): sap.ui.model.Binding;
54967
55056
  /**
54968
55057
  * Detaches event handler `fnFunction` from the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
54969
55058
  */
54970
55059
  detachRefresh(
54971
55060
  /**
54972
- * The function to be called, when the event occurs
55061
+ * The function to be called when the event occurs
54973
55062
  */
54974
55063
  fnFunction: Function,
54975
55064
  /**
54976
- * object on which to call the given function.
55065
+ * Object on which to call the given function.
54977
55066
  */
54978
55067
  oListener?: object
54979
55068
  ): void;
@@ -54984,11 +55073,11 @@ declare namespace sap {
54984
55073
  */
54985
55074
  fireDataReceived(
54986
55075
  /**
54987
- * Parameters to pass along with the event.
55076
+ * Parameters to pass along with the event
54988
55077
  */
54989
55078
  oParameters: {
54990
55079
  /**
54991
- * Data received. In error cases it will be undefined.
55080
+ * Data received; on error cases it will be undefined
54992
55081
  */
54993
55082
  data?: object;
54994
55083
  }
@@ -54998,7 +55087,7 @@ declare namespace sap {
54998
55087
  */
54999
55088
  fireDataRequested(
55000
55089
  /**
55001
- * Parameters to pass along with the event.
55090
+ * Parameters to pass along with the event
55002
55091
  */
55003
55092
  oParameters: object
55004
55093
  ): void;
@@ -55044,11 +55133,11 @@ declare namespace sap {
55044
55133
  */
55045
55134
  initialize(): void;
55046
55135
  /**
55047
- * Returns whether the binding is initial, which means it did not get an initial value yet
55136
+ * Returns whether the binding is initial, which means it did not get an initial value yet.
55048
55137
  */
55049
55138
  isInitial(): boolean;
55050
55139
  /**
55051
- * Returns whether the binding is relative, which means its path does not start with a slash ('/')
55140
+ * Returns whether the binding is relative, which means its path does not start with a slash.
55052
55141
  */
55053
55142
  isRelative(): boolean;
55054
55143
  /**
@@ -55081,8 +55170,8 @@ declare namespace sap {
55081
55170
  /**
55082
55171
  * Resumes the binding update. Change events will be fired again.
55083
55172
  *
55084
- * When the binding is resumed, a change event will be fired immediately, if the data has changed while
55085
- * the binding was suspended. For server-side models, a request to the server will be triggered, if a refresh
55173
+ * When the binding is resumed, a change event will be fired immediately if the data has changed while the
55174
+ * binding was suspended. For server-side models, a request to the server will be triggered if a refresh
55086
55175
  * was requested while the binding was suspended.
55087
55176
  */
55088
55177
  resume(): void;
@@ -55548,7 +55637,7 @@ declare namespace sap {
55548
55637
  *
55549
55638
  * A `CompositeBinding` combines the values from all its binding parts (each an instance of `PropertyBinding`),
55550
55639
  * either by calling a formatter function or by involving a {@link sap.ui.model.CompositeType composite
55551
- * type}. When a formatter function is used, then the composite binding is automatically limited to `OneWay`
55640
+ * type}. When a formatter function is used, the composite binding is automatically limited to `OneWay`
55552
55641
  * mode. When a type is used, the binding can also operate in `TwoWay` mode.
55553
55642
  *
55554
55643
  * Higher layers of the framework derive composite bindings from easy-to-write string representations (the
@@ -55614,7 +55703,7 @@ declare namespace sap {
55614
55703
  */
55615
55704
  fnFunction: Function,
55616
55705
  /**
55617
- * object on which to call the given function.
55706
+ * Object on which to call the given function
55618
55707
  */
55619
55708
  oListener?: object
55620
55709
  ): void;
@@ -55630,7 +55719,7 @@ declare namespace sap {
55630
55719
  */
55631
55720
  fnFunction: Function,
55632
55721
  /**
55633
- * object on which to call the given function
55722
+ * Object on which to call the given function
55634
55723
  */
55635
55724
  oListener?: object
55636
55725
  ): void;
@@ -55646,7 +55735,7 @@ declare namespace sap {
55646
55735
  */
55647
55736
  fnFunction: Function,
55648
55737
  /**
55649
- * object on which to call the given function
55738
+ * Object on which to call the given function
55650
55739
  */
55651
55740
  oListener?: object
55652
55741
  ): void;
@@ -55659,7 +55748,7 @@ declare namespace sap {
55659
55748
  */
55660
55749
  fnFunction: Function,
55661
55750
  /**
55662
- * object on which to call the given function
55751
+ * Object on which to call the given function
55663
55752
  */
55664
55753
  oListener?: object
55665
55754
  ): void;
@@ -55672,7 +55761,7 @@ declare namespace sap {
55672
55761
  */
55673
55762
  fnFunction: Function,
55674
55763
  /**
55675
- * object on which to call the given function
55764
+ * Object on which to call the given function
55676
55765
  */
55677
55766
  oListener?: object
55678
55767
  ): void;
@@ -55685,7 +55774,7 @@ declare namespace sap {
55685
55774
  */
55686
55775
  fnFunction: Function,
55687
55776
  /**
55688
- * object on which to call the given function
55777
+ * Object on which to call the given function
55689
55778
  */
55690
55779
  oListener?: object
55691
55780
  ): void;
@@ -55699,12 +55788,12 @@ declare namespace sap {
55699
55788
  getExternalValue(): object;
55700
55789
  /**
55701
55790
  * Returns the current internal value of the bound target which is an array of the internal (JS native)
55702
- * values of nested bindings
55791
+ * values of nested bindings.
55703
55792
  */
55704
55793
  getInternalValue(): any[];
55705
55794
  /**
55706
55795
  * Returns the current raw value of the bound target which is an array of the raw (model) values of nested
55707
- * bindings
55796
+ * bindings.
55708
55797
  */
55709
55798
  getRawValue(): any[];
55710
55799
  /**
@@ -55713,10 +55802,10 @@ declare namespace sap {
55713
55802
  getValue(): object;
55714
55803
  /**
55715
55804
  * Initialize the binding. The method should be called when creating a binding. The default implementation
55716
- * calls checkUpdate(true). Prevent checkUpdate to be triggered while initializing nestend bindings, it
55717
- * is sufficient to call checkUpdate when all nested bindings are initialized.
55805
+ * calls checkUpdate(true). Prevent checkUpdate to be triggered while initializing nested bindings, it is
55806
+ * sufficient to call checkUpdate when all nested bindings are initialized.
55718
55807
  */
55719
- initialize(): void;
55808
+ initialize(): this;
55720
55809
  /**
55721
55810
  * Suspends the binding update. No change events will be fired.
55722
55811
  *
@@ -55727,12 +55816,12 @@ declare namespace sap {
55727
55816
  resume(): void;
55728
55817
  /**
55729
55818
  * Sets the external value of a composite binding. If no CompositeType is assigned to the binding, the default
55730
- * implementation assumes a space separated list of values. This will cause the setValue to be called for
55819
+ * implementation assumes a space-separated list of values. This will cause the setValue to be called for
55731
55820
  * each nested binding, except for undefined values in the array.
55732
55821
  */
55733
55822
  setExternalValue(
55734
55823
  /**
55735
- * the value to set for this binding
55824
+ * The value to set for this binding
55736
55825
  */
55737
55826
  oValue: object
55738
55827
  ): undefined | Promise<any>;
@@ -55745,7 +55834,7 @@ declare namespace sap {
55745
55834
  * the new values of the nested bindings
55746
55835
  */
55747
55836
  aValues: any[]
55748
- ): void;
55837
+ ): undefined | Promise<any>;
55749
55838
  /**
55750
55839
  * Sets the raw value of the bound target. Parameter must be an array of values matching the raw (model)
55751
55840
  * types of nested bindings.
@@ -55755,7 +55844,7 @@ declare namespace sap {
55755
55844
  * the new values of the nested bindings
55756
55845
  */
55757
55846
  aValues: any[]
55758
- ): void;
55847
+ ): undefined | Promise<any>;
55759
55848
  /**
55760
55849
  * Sets the optional type and internal type for the binding. The type and internal type are used to do the
55761
55850
  * parsing/formatting correctly. The internal type is the property type of the element which the value is
@@ -55763,11 +55852,11 @@ declare namespace sap {
55763
55852
  */
55764
55853
  setType(
55765
55854
  /**
55766
- * the type for the binding
55855
+ * The type for the binding
55767
55856
  */
55768
55857
  oType: sap.ui.model.CompositeType,
55769
55858
  /**
55770
- * the internal type of the element property which this binding is bound against.
55859
+ * The internal type of the element property which this binding is bound against.
55771
55860
  */
55772
55861
  sInternalType: string
55773
55862
  ): void;
@@ -55777,7 +55866,7 @@ declare namespace sap {
55777
55866
  */
55778
55867
  setValue(
55779
55868
  /**
55780
- * the values to set for this binding
55869
+ * The values to set for this binding
55781
55870
  */
55782
55871
  aValues: any[]
55783
55872
  ): void;
@@ -56369,17 +56458,19 @@ declare namespace sap {
56369
56458
  * You either pass a single object literal with the filter parameters or use the individual constructor
56370
56459
  * arguments. No matter which variant is used, only certain combinations of parameters are supported (the
56371
56460
  * following list uses the names from the object literal):
56372
- * - A `path`, `operator` and one or two values (`value1`, `value2`), depending on the operator
56373
- * - A `path` and a custom filter function `test`
56374
- * - An array of other filters named `filters` and a Boolean flag `and` that specifies whether to combine
56375
- * the filters with an AND (`true`) or an OR (`false`) operator. An error will be logged to the console
56376
- * if an invalid combination of parameters is provided. Please note that a model implementation may not
56377
- * support a custom filter function, e.g. if the model does not perform client side filtering. It also depends
56378
- * on the model implementation if the filtering is case sensitive or not. Client models filter case insensitive
56379
- * compared to the OData models which filter case sensitive by default. See particular model documentation
56380
- * for details The filter operators `Any` and `All` are only supported in V4 OData models. When creating
56381
- * a filter instance with these filter operators, the argument `variable` only accepts a string identifier
56382
- * and `condition` needs to be another filter instance.
56461
+ * A `path`, `operator` and one or two values (`value1`, `value2`), depending on the operator A `path`
56462
+ * and a custom filter function `test` An array of other filters named `filters` and a Boolean flag
56463
+ * `and` that specifies whether to combine the filters with an AND (`true`) or an OR (`false`) operator.
56464
+ * An error will be logged to the console if an invalid combination of parameters is provided.
56465
+ *
56466
+ * Please note that a model implementation may not support a custom filter function, e.g. if the model does
56467
+ * not perform client-side filtering. It also depends on the model implementation if the filtering is case
56468
+ * sensitive or not. Client models filter case insensitive compared to the OData models which filter case
56469
+ * sensitive by default. See particular model documentation for details.
56470
+ *
56471
+ * The filter operators {@link sap.ui.model.FilterOperator.Any "Any"} and {@link sap.ui.model.FilterOperator.All
56472
+ * "All"} are only supported in V4 OData models. When creating a filter instance with these filter operators,
56473
+ * the argument `variable` only accepts a string identifier and `condition` needs to be another filter instance.
56383
56474
  */
56384
56475
  constructor(
56385
56476
  /**
@@ -56392,15 +56483,19 @@ declare namespace sap {
56392
56483
  */
56393
56484
  path?: string;
56394
56485
  /**
56395
- * Function which is used to filter the items and which should return a Boolean value to indicate whether
56396
- * the current item passes the filter
56486
+ * Function used for the client-side filtering of items. It should return a Boolean indicating whether the
56487
+ * current item passes the filter. If no test function is given, a default test function is used, based
56488
+ * on the given filter operator and the comparator function.
56397
56489
  */
56398
- test?: Function;
56490
+ test?: (p1: any) => boolean;
56399
56491
  /**
56400
- * Function which is used to compare two values, this is used for processing of equal, less than and greater
56401
- * than operators
56492
+ * Function used to compare two values for equality and order during client-side filtering. Two values are
56493
+ * given as parameters. The function is expected to return:
56494
+ * a negative number if the first value is smaller than the second value, `0` if the two values are
56495
+ * equal, a positive number if the first value is larger than the second value, `NaN` for non-comparable
56496
+ * values. If no function is given, {@link sap.ui.model.Filter.defaultComparator} is used.
56402
56497
  */
56403
- comparator?: Function;
56498
+ comparator?: (p1: any, p2: any) => number;
56404
56499
  /**
56405
56500
  * Operator used for the filter
56406
56501
  */
@@ -56410,44 +56505,52 @@ declare namespace sap {
56410
56505
  */
56411
56506
  value1?: any;
56412
56507
  /**
56413
- * Second value to use with the filter operator (only for some operators)
56508
+ * Second value to use with the given filter operator, used only for the {@link sap.ui.model.FilterOperator.BT
56509
+ * "BT" between} and {@link sap.ui.model.FilterOperator.NB "NB" not between} filter operators
56414
56510
  */
56415
56511
  value2?: any;
56416
56512
  /**
56417
- * The variable used in lambda operators (`Any` and `All`)
56513
+ * The variable name used in lambda operators ({@link sap.ui.model.FilterOperator.Any "Any"} and {@link
56514
+ * sap.ui.model.FilterOperator.All "All"})
56418
56515
  */
56419
56516
  variable?: string;
56420
56517
  /**
56421
- * A `Filter` instance which will be used as the condition for the lambda operator
56518
+ * A filter instance which will be used as the condition for lambda operators ({@link sap.ui.model.FilterOperator.Any
56519
+ * "Any"} and {@link sap.ui.model.FilterOperator.All "All"})
56422
56520
  */
56423
56521
  condition?: sap.ui.model.Filter;
56424
56522
  /**
56425
- * Array of filters on which logical conjunction is applied
56523
+ * An array of filters on which the logical conjunction is applied
56426
56524
  */
56427
56525
  filters?: sap.ui.model.Filter[];
56428
56526
  /**
56429
56527
  * Indicates whether an "AND" logical conjunction is applied on the filters. If it's not set or set to `false`,
56430
- * an "OR" conjunction is applied
56528
+ * an "OR" conjunction is applied.
56431
56529
  */
56432
56530
  and?: boolean;
56433
56531
  /**
56434
- * Indicates whether a string value should be compared case sensitive or not.
56532
+ * Indicates whether a string value should be compared case sensitive or not. The handling of `undefined`
56533
+ * depends on the model implementation.
56435
56534
  */
56436
56535
  caseSensitive?: boolean;
56437
56536
  }
56438
56537
  | string
56439
56538
  | sap.ui.model.Filter[],
56440
56539
  /**
56441
- * Either a filter operator or a custom filter function or a Boolean flag that defines how to combine multiple
56442
- * filters
56540
+ * Either a filter operator or a custom filter function or a `boolean` flag that defines how to combine
56541
+ * multiple filters
56443
56542
  */
56444
- vOperator?: sap.ui.model.FilterOperator | Function | boolean,
56543
+ vOperator?:
56544
+ | sap.ui.model.FilterOperator
56545
+ | ((p1: any) => boolean)
56546
+ | boolean,
56445
56547
  /**
56446
56548
  * First value to use with the given filter operator
56447
56549
  */
56448
56550
  vValue1?: any,
56449
56551
  /**
56450
- * Second value to use with the given filter operator (only for some operators)
56552
+ * Second value to use with the given filter operator, used only for the {@link sap.ui.model.FilterOperator.BT
56553
+ * "BT" between} and {@link sap.ui.model.FilterOperator.NB "NB" not between} filter operators
56451
56554
  */
56452
56555
  vValue2?: any
56453
56556
  );
@@ -56455,7 +56558,7 @@ declare namespace sap {
56455
56558
  /**
56456
56559
  * Compares two values
56457
56560
  *
56458
- * This is the default comparator function used for clientside filtering, if no custom comparator is given
56561
+ * This is the default comparator function used for client-side filtering, if no custom comparator is given
56459
56562
  * in the constructor. It does compare just by using equal/less than/greater than with automatic type casting,
56460
56563
  * except for null values, which are neither less or greater, and string values where localeCompare is used.
56461
56564
  *
@@ -56470,7 +56573,7 @@ declare namespace sap {
56470
56573
  * the second value to compare
56471
56574
  */
56472
56575
  b: any
56473
- ): int;
56576
+ ): number;
56474
56577
  /**
56475
56578
  * Creates a new subclass of class sap.ui.model.Filter with name `sClassName` and enriches it with the information
56476
56579
  * contained in `oClassInfo`.
@@ -56496,6 +56599,83 @@ declare namespace sap {
56496
56599
  * Returns a metadata object for class sap.ui.model.Filter.
56497
56600
  */
56498
56601
  static getMetadata(): sap.ui.base.Metadata;
56602
+ /**
56603
+ * @SINCE 1.96.0
56604
+ *
56605
+ * Returns the comparator function as provided on construction of this filter, see {@link sap.ui.model.Filter#constructor},
56606
+ * parameter `vFilterInfo.comparator`.
56607
+ */
56608
+ getComparator(): ((p1: any) => boolean) | undefined;
56609
+ /**
56610
+ * @SINCE 1.96.0
56611
+ *
56612
+ * Returns the filter instance which is used as the condition for lambda operators, see {@link sap.ui.model.Filter#constructor},
56613
+ * parameter `vFilterInfo.condition`.
56614
+ */
56615
+ getCondition(): sap.ui.model.Filter | undefined;
56616
+ /**
56617
+ * @SINCE 1.96.0
56618
+ *
56619
+ * Returns the array of filters as specified on construction of this filter, see {@link sap.ui.model.Filter#constructor},
56620
+ * parameter `vFilterInfo.filters`
56621
+ */
56622
+ getFilters(): sap.ui.model.Filter[] | undefined;
56623
+ /**
56624
+ * @SINCE 1.96.0
56625
+ *
56626
+ * Returns the filter operator used for this filter, see {@link sap.ui.model.Filter#constructor}, parameter
56627
+ * `vFilterInfo.operator` or `vOperator`.
56628
+ */
56629
+ getOperator(): sap.ui.model.FilterOperator | undefined;
56630
+ /**
56631
+ * @SINCE 1.96.0
56632
+ *
56633
+ * Returns the binding path for this filter, see {@link sap.ui.model.Filter#constructor}, parameter `vFilterInfo`
56634
+ * or `vFilterInfo.path`.
56635
+ */
56636
+ getPath(): string | undefined;
56637
+ /**
56638
+ * @SINCE 1.96.0
56639
+ *
56640
+ * Returns the test function which is used to filter the items, see {@link sap.ui.model.Filter#constructor},
56641
+ * parameter `vFilterInfo.test`.
56642
+ */
56643
+ getTest(): ((p1: any, p2: any) => boolean) | undefined;
56644
+ /**
56645
+ * @SINCE 1.96.0
56646
+ *
56647
+ * Returns the first value that is used with the given filter operator, see {@link sap.ui.model.Filter#constructor},
56648
+ * parameter `vFilterInfo.value1` or `vValue1`.
56649
+ */
56650
+ getValue1(): any;
56651
+ /**
56652
+ * @SINCE 1.96.0
56653
+ *
56654
+ * Returns the second value that is used with the given filter operator, see {@link sap.ui.model.Filter#constructor},
56655
+ * parameter `vFilterInfo.value2` or `vValue2`.
56656
+ */
56657
+ getValue2(): any;
56658
+ /**
56659
+ * @SINCE 1.96.0
56660
+ *
56661
+ * Returns the variable name used in lambda operators, see {@link sap.ui.model.Filter#constructor}, parameter
56662
+ * `vFilterInfo.variable`.
56663
+ */
56664
+ getVariable(): string | undefined;
56665
+ /**
56666
+ * @SINCE 1.96.0
56667
+ *
56668
+ * Indicates whether an "AND" logical conjunction is applied on the filters, see {@link sap.ui.model.Filter#constructor},
56669
+ * parameter `vFilterInfo.and`.
56670
+ */
56671
+ isAnd(): boolean;
56672
+ /**
56673
+ * @SINCE 1.96.0
56674
+ *
56675
+ * Indicates whether a string value should be compared case sensitive, see {@link sap.ui.model.Filter#constructor},
56676
+ * parameter `vFilterInfo.caseSensitive`.
56677
+ */
56678
+ isCaseSensitive(): boolean;
56499
56679
  }
56500
56680
  /**
56501
56681
  * Instances of this exception are thrown when converting a model value to its representation on the UI
@@ -56590,7 +56770,7 @@ declare namespace sap {
56590
56770
  */
56591
56771
  fnFunction: Function,
56592
56772
  /**
56593
- * Context object to call the event handler with, defaults to this `ListBinding` itself
56773
+ * Context object to call the event handler with; defaults to this `ListBinding` itself
56594
56774
  */
56595
56775
  oListener?: object
56596
56776
  ): void;
@@ -56609,7 +56789,7 @@ declare namespace sap {
56609
56789
  */
56610
56790
  fnFunction: Function,
56611
56791
  /**
56612
- * Context object to call the event handler with, defaults to this `ListBinding` itself
56792
+ * Context object to call the event handler with; defaults to this `ListBinding` itself
56613
56793
  */
56614
56794
  oListener?: object
56615
56795
  ): void;
@@ -56624,7 +56804,7 @@ declare namespace sap {
56624
56804
  */
56625
56805
  fnFunction: Function,
56626
56806
  /**
56627
- * on which the given function had to be called
56807
+ * On which object the given function had to be called
56628
56808
  */
56629
56809
  oListener?: object
56630
56810
  ): void;
@@ -56680,7 +56860,11 @@ declare namespace sap {
56680
56860
  * The path of the property containing the key or a function getting the context as only parameter to calculate
56681
56861
  * a key to identify an entry
56682
56862
  */
56683
- vKey: Function | string
56863
+ vKey: Function | string,
56864
+ /**
56865
+ * The configuration for the change detection
56866
+ */
56867
+ oExtendedChangeDetectionConfig: object
56684
56868
  ): void;
56685
56869
  /**
56686
56870
  * Applies a new set of filters to the list represented by this binding.
@@ -56689,18 +56873,18 @@ declare namespace sap {
56689
56873
  * a server and it might execute asynchronously.
56690
56874
  *
56691
56875
  * Application and Control Filters: Each list binding maintains two separate lists of filters, one for filters
56692
- * defined by the control that owns the binding and another list for filters that an application can define
56876
+ * defined by the control that owns the binding, and another list for filters that an application can define
56693
56877
  * in addition. When executing the filter operation, both sets of filters are combined.
56694
56878
  *
56695
- * By using the second parameter `sFilterType` of method `filter`, the caller can control which set of filters
56879
+ * By using the `sFilterType` parameter of the `filter` method, the caller can control which set of filters
56696
56880
  * is modified. If no type is given, then the behavior depends on the model implementation and should be
56697
56881
  * documented in the API reference for that model.
56698
56882
  *
56699
56883
  * Auto-Grouping of Filters: Filters are first grouped according to their binding path. All filters belonging
56700
- * to the same group are ORed and after that the results of all groups are ANDed. Usually this means, all
56701
- * filters applied to a single table column are ORed, while filters on different table columns are ANDed.
56702
- * Please either use the automatic grouping of filters (where applicable) or use explicit AND/OR filters,
56703
- * a mixture of both is not supported.
56884
+ * to the same path are ORed, and after that the results of all paths are ANDed. Usually this means that
56885
+ * all filters applied to the same property are ORed, while filters on different properties are ANDed. Please
56886
+ * use either the automatic grouping of filters (where applicable) or explicit AND/OR filters, as a mixture
56887
+ * of both is not supported.
56704
56888
  */
56705
56889
  filter(
56706
56890
  /**
@@ -56729,22 +56913,22 @@ declare namespace sap {
56729
56913
  */
56730
56914
  getContexts(
56731
56915
  /**
56732
- * the startIndex where to start the retrieval of contexts
56916
+ * The startIndex where to start the retrieval of contexts
56733
56917
  */
56734
56918
  iStartIndex?: int,
56735
56919
  /**
56736
- * determines how many contexts to retrieve beginning from the start index.
56920
+ * Determines how many contexts to retrieve beginning from the start index.
56737
56921
  */
56738
56922
  iLength?: int,
56739
56923
  /**
56740
56924
  * The maximum number of contexts to read before and after the given range; with this, controls can prefetch
56741
- * data that is likely to be needed soon, e.g. when scrolling down in a table. This parameter is model-specific
56742
- * and not implemented by all models.
56925
+ * data that is likely to be needed soon, e.g. when scrolling down in a table; this parameter is model-specific
56926
+ * and not implemented by all models
56743
56927
  */
56744
56928
  iMaximumPrefetchSize?: int,
56745
56929
  /**
56746
56930
  * Whether this call keeps the result of {@link #getCurrentContexts} untouched; since 1.86.0. This parameter
56747
- * is model-specific and not implemented by all models.
56931
+ * is model-specific and not implemented by all models
56748
56932
  */
56749
56933
  bKeepCurrent?: boolean
56750
56934
  ): sap.ui.model.Context[];
@@ -56766,7 +56950,7 @@ declare namespace sap {
56766
56950
  *
56767
56951
  * Returns an array of currently used binding contexts of the bound control.
56768
56952
  *
56769
- * This method does not trigger any data requests from the backend or delta calculation, but just returns
56953
+ * This method does not trigger any data requests from the back end or a delta calculation, but just returns
56770
56954
  * the context array as last requested by the control. This can be used by the application to get access
56771
56955
  * to the data currently displayed by a list control.
56772
56956
  */
@@ -56780,6 +56964,17 @@ declare namespace sap {
56780
56964
  */
56781
56965
  sPath: string
56782
56966
  ): any[];
56967
+ /**
56968
+ * @SINCE 1.96.0
56969
+ *
56970
+ * Returns the filters set via the constructor or via {@link #filter} for the given {@link sap.ui.model.FilterType}.
56971
+ */
56972
+ getFilters(
56973
+ /**
56974
+ * The FilterType
56975
+ */
56976
+ sFilterType: sap.ui.model.FilterType
56977
+ ): sap.ui.model.Filter[];
56783
56978
  /**
56784
56979
  * Gets the group for the given context. Must only be called if `isGrouped()` returns that grouping is enabled
56785
56980
  * for this binding. The grouping will be performed using the first sorter (in case multiple sorters are
@@ -56803,8 +56998,8 @@ declare namespace sap {
56803
56998
  */
56804
56999
  getLength(): int;
56805
57000
  /**
56806
- * Indicates whether grouping is enabled for the binding. Grouping is enabled for a list binding, if at
56807
- * least one sorter exists on the binding and the first sorter is a grouping sorter.
57001
+ * Indicates whether grouping is enabled for the binding. Grouping is enabled for a list binding if at least
57002
+ * one sorter exists on the binding and the first sorter is a grouping sorter.
56808
57003
  */
56809
57004
  isGrouped(): boolean;
56810
57005
  /**
@@ -56841,7 +57036,7 @@ declare namespace sap {
56841
57036
  * Instead of a single sorter also an array of sorters can be passed to the sort method. In this case they
56842
57037
  * are processed in the sequence in which they are contained in the array.
56843
57038
  *
56844
- * Grouping: Sorting and grouping are closely related, in case a list should be grouped, it must be sorted
57039
+ * Grouping: Sorting and grouping are closely related. In case a list should be grouped, it must be sorted
56845
57040
  * by the property to group with. Grouping is enabled by setting the `group` property on the sorter object.
56846
57041
  * If it is enabled, you can get the current group of an item using {@link sap.ui.model.ListBinding.prototype.getGroup}.
56847
57042
  * In case multiple sorters are provided, grouping can only be done on the first sorter, nested grouping
@@ -56849,7 +57044,7 @@ declare namespace sap {
56849
57044
  */
56850
57045
  sort(
56851
57046
  /**
56852
- * the Sorter object or an array of sorters which defines the sort order
57047
+ * The Sorter object or an array of sorters which defines the sort order
56853
57048
  */
56854
57049
  aSorters: sap.ui.model.Sorter | any[]
56855
57050
  ): this;
@@ -56939,7 +57134,7 @@ declare namespace sap {
56939
57134
  */
56940
57135
  oData: object,
56941
57136
  /**
56942
- * The function to be called, when the event occurs
57137
+ * The function to be called when the event occurs
56943
57138
  */
56944
57139
  fnFunction: Function,
56945
57140
  /**
@@ -56955,7 +57150,7 @@ declare namespace sap {
56955
57150
  */
56956
57151
  attachParseError(
56957
57152
  /**
56958
- * The function to be called, when the event occurs
57153
+ * The function to be called when the event occurs
56959
57154
  */
56960
57155
  fnFunction: Function,
56961
57156
  /**
@@ -56977,7 +57172,7 @@ declare namespace sap {
56977
57172
  */
56978
57173
  oData: object,
56979
57174
  /**
56980
- * The function to be called, when the event occurs
57175
+ * The function to be called when the event occurs
56981
57176
  */
56982
57177
  fnFunction: Function,
56983
57178
  /**
@@ -56994,7 +57189,7 @@ declare namespace sap {
56994
57189
  */
56995
57190
  attachPropertyChange(
56996
57191
  /**
56997
- * The function to be called, when the event occurs
57192
+ * The function to be called when the event occurs
56998
57193
  */
56999
57194
  fnFunction: Function,
57000
57195
  /**
@@ -57016,7 +57211,7 @@ declare namespace sap {
57016
57211
  */
57017
57212
  oData: object,
57018
57213
  /**
57019
- * The function to be called, when the event occurs
57214
+ * The function to be called when the event occurs
57020
57215
  */
57021
57216
  fnFunction: Function,
57022
57217
  /**
@@ -57033,7 +57228,7 @@ declare namespace sap {
57033
57228
  */
57034
57229
  attachRequestCompleted(
57035
57230
  /**
57036
- * The function to be called, when the event occurs
57231
+ * The function to be called when the event occurs
57037
57232
  */
57038
57233
  fnFunction: Function,
57039
57234
  /**
@@ -57054,7 +57249,7 @@ declare namespace sap {
57054
57249
  */
57055
57250
  oData: object,
57056
57251
  /**
57057
- * The function to be called, when the event occurs
57252
+ * The function to be called when the event occurs
57058
57253
  */
57059
57254
  fnFunction: Function,
57060
57255
  /**
@@ -57070,7 +57265,7 @@ declare namespace sap {
57070
57265
  */
57071
57266
  attachRequestFailed(
57072
57267
  /**
57073
- * The function to be called, when the event occurs
57268
+ * The function to be called when the event occurs
57074
57269
  */
57075
57270
  fnFunction: Function,
57076
57271
  /**
@@ -57091,7 +57286,7 @@ declare namespace sap {
57091
57286
  */
57092
57287
  oData: object,
57093
57288
  /**
57094
- * The function to be called, when the event occurs
57289
+ * The function to be called when the event occurs
57095
57290
  */
57096
57291
  fnFunction: Function,
57097
57292
  /**
@@ -57107,7 +57302,7 @@ declare namespace sap {
57107
57302
  */
57108
57303
  attachRequestSent(
57109
57304
  /**
57110
- * The function to be called, when the event occurs
57305
+ * The function to be called when the event occurs
57111
57306
  */
57112
57307
  fnFunction: Function,
57113
57308
  /**
@@ -57120,111 +57315,103 @@ declare namespace sap {
57120
57315
  */
57121
57316
  bindContext(
57122
57317
  /**
57123
- * the path pointing to the property that should be bound
57318
+ * The path pointing to the property that should be bound
57124
57319
  */
57125
57320
  sPath: string,
57126
57321
  /**
57127
- * the context object for this databinding (optional)
57322
+ * The context object for this databinding
57128
57323
  */
57129
57324
  oContext?: sap.ui.model.Context,
57130
57325
  /**
57131
- * additional model specific parameters (optional)
57326
+ * Additional model-specific parameters
57132
57327
  */
57133
57328
  mParameters?: object,
57134
57329
  /**
57135
- * event handlers can be passed to the binding ({change:myHandler})
57330
+ * Event handlers can be passed to the binding ({change:myHandler})
57136
57331
  */
57137
57332
  oEvents?: object
57138
57333
  ): sap.ui.model.ContextBinding;
57139
- /**
57140
- * Implement in inheriting classes.
57141
- */
57334
+
57142
57335
  bindList(
57143
57336
  /**
57144
- * the path pointing to the list / array that should be bound
57337
+ * The path pointing to the list / array that should be bound
57145
57338
  */
57146
57339
  sPath: string,
57147
57340
  /**
57148
- * the context object for this databinding (optional)
57341
+ * The context object for this databinding
57149
57342
  */
57150
57343
  oContext?: sap.ui.model.Context,
57151
57344
  /**
57152
- * initial sort order (can be either a sorter or an array of sorters) (optional)
57345
+ * Initial sort order (can be either a sorter or an array of sorters)
57153
57346
  */
57154
57347
  aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
57155
57348
  /**
57156
- * predefined filter/s (can be either a filter or an array of filters) (optional)
57349
+ * Predefined filter/s (can be either a filter or an array of filters)
57157
57350
  */
57158
57351
  aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
57159
57352
  /**
57160
- * additional model specific parameters (optional)
57353
+ * Additional model-specific parameters
57161
57354
  */
57162
57355
  mParameters?: object
57163
57356
  ): sap.ui.model.ListBinding;
57164
- /**
57165
- * Implement in inheriting classes.
57166
- */
57357
+
57167
57358
  bindProperty(
57168
57359
  /**
57169
- * the path pointing to the property that should be bound
57360
+ * The path pointing to the property that should be bound
57170
57361
  */
57171
57362
  sPath: string,
57172
57363
  /**
57173
- * the context object for this databinding (optional)
57364
+ * The context object for this databinding
57174
57365
  */
57175
57366
  oContext?: sap.ui.model.Context,
57176
57367
  /**
57177
- * additional model specific parameters (optional)
57368
+ * Additional model-specific parameters
57178
57369
  */
57179
57370
  mParameters?: object
57180
57371
  ): sap.ui.model.PropertyBinding;
57181
- /**
57182
- * Implement in inheriting classes.
57183
- */
57372
+
57184
57373
  bindTree(
57185
57374
  /**
57186
- * the path pointing to the tree / array that should be bound
57375
+ * The path pointing to the tree / array that should be bound
57187
57376
  */
57188
57377
  sPath: string,
57189
57378
  /**
57190
- * the context object for this databinding (optional)
57379
+ * The context object for this databinding
57191
57380
  */
57192
57381
  oContext?: sap.ui.model.Context,
57193
57382
  /**
57194
- * predefined filter/s contained in an array (optional)
57383
+ * Predefined filter/s contained in an array
57195
57384
  */
57196
57385
  aFilters?: sap.ui.model.Filter[],
57197
57386
  /**
57198
- * additional model specific parameters (optional)
57387
+ * Additional model specific parameters
57199
57388
  */
57200
57389
  mParameters?: object,
57201
57390
  /**
57202
- * predefined sap.ui.model.sorter/s contained in an array (optional)
57391
+ * Predefined sap.ui.model.sorter/s contained in an array
57203
57392
  */
57204
57393
  aSorters?: sap.ui.model.Sorter[]
57205
57394
  ): sap.ui.model.TreeBinding;
57206
- /**
57207
- * Implement in inheriting classes.
57208
- */
57395
+
57209
57396
  createBindingContext(
57210
57397
  /**
57211
- * the path to create the new context from
57398
+ * The path to create the new context from
57212
57399
  */
57213
57400
  sPath: string,
57214
57401
  /**
57215
- * the context which should be used to create the new binding context
57402
+ * The context which should be used to create the new binding context
57216
57403
  */
57217
57404
  oContext?: sap.ui.model.Context,
57218
57405
  /**
57219
- * the parameters used to create the new binding context
57406
+ * The parameters used to create the new binding context
57220
57407
  */
57221
57408
  mParameters?: object,
57222
57409
  /**
57223
- * the function which should be called after the binding context has been created
57410
+ * The function which should be called after the binding context has been created
57224
57411
  */
57225
57412
  fnCallBack?: Function,
57226
57413
  /**
57227
- * force reload even if data is already available. For server side models this should refetch the data from
57414
+ * Force reload even if data is already available; for server-side models this should refetch the data from
57228
57415
  * the server
57229
57416
  */
57230
57417
  bReload?: boolean
@@ -57232,18 +57419,16 @@ declare namespace sap {
57232
57419
  /**
57233
57420
  * Destroys the model and clears the model data.
57234
57421
  *
57235
- * A model implementation may override this function and perform model specific cleanup tasks e.g. abort
57422
+ * A model implementation may override this function and perform model-specific cleanup tasks e.g. abort
57236
57423
  * requests, prevent new requests, etc.
57237
57424
  * See:
57238
57425
  * sap.ui.base.Object.prototype.destroy
57239
57426
  */
57240
57427
  destroy(): void;
57241
- /**
57242
- * Implement in inheriting classes.
57243
- */
57428
+
57244
57429
  destroyBindingContext(
57245
57430
  /**
57246
- * to destroy
57431
+ * The context to destroy
57247
57432
  */
57248
57433
  oContext: sap.ui.model.Context
57249
57434
  ): void;
@@ -57254,7 +57439,7 @@ declare namespace sap {
57254
57439
  */
57255
57440
  detachParseError(
57256
57441
  /**
57257
- * The function to be called, when the event occurs
57442
+ * The function to be called when the event occurs
57258
57443
  */
57259
57444
  fnFunction: Function,
57260
57445
  /**
@@ -57270,7 +57455,7 @@ declare namespace sap {
57270
57455
  */
57271
57456
  detachPropertyChange(
57272
57457
  /**
57273
- * The function to be called, when the event occurs
57458
+ * The function to be called when the event occurs
57274
57459
  */
57275
57460
  fnFunction: Function,
57276
57461
  /**
@@ -57302,7 +57487,7 @@ declare namespace sap {
57302
57487
  */
57303
57488
  detachRequestFailed(
57304
57489
  /**
57305
- * The function to be called, when the event occurs
57490
+ * The function to be called when the event occurs
57306
57491
  */
57307
57492
  fnFunction: Function,
57308
57493
  /**
@@ -57365,11 +57550,11 @@ declare namespace sap {
57365
57550
  */
57366
57551
  path?: string;
57367
57552
  /**
57368
- * the context of the property
57553
+ * The context of the property
57369
57554
  */
57370
57555
  context?: object;
57371
57556
  /**
57372
- * the value of the property
57557
+ * The value of the property
57373
57558
  */
57374
57559
  value?: object;
57375
57560
  }
@@ -57383,7 +57568,7 @@ declare namespace sap {
57383
57568
  */
57384
57569
  oParameters?: {
57385
57570
  /**
57386
- * The url which was sent to the backend.
57571
+ * The url which was sent to the back end.
57387
57572
  */
57388
57573
  url?: string;
57389
57574
  /**
@@ -57425,7 +57610,7 @@ declare namespace sap {
57425
57610
  */
57426
57611
  statusText?: string;
57427
57612
  /**
57428
- * Response that has been received for the request ,as a text string
57613
+ * Response that has been received for the request, as a text string
57429
57614
  */
57430
57615
  responseText?: string;
57431
57616
  }
@@ -57439,7 +57624,7 @@ declare namespace sap {
57439
57624
  */
57440
57625
  oParameters?: {
57441
57626
  /**
57442
- * The url which is sent to the backend.
57627
+ * The url which is sent to the back end.
57443
57628
  */
57444
57629
  url?: string;
57445
57630
  /**
@@ -57451,7 +57636,7 @@ declare namespace sap {
57451
57636
  */
57452
57637
  async?: boolean;
57453
57638
  /**
57454
- * additional information for the request (if available) **deprecated**
57639
+ * Additional information for the request (if available) **deprecated**
57455
57640
  */
57456
57641
  info?: string;
57457
57642
  /**
@@ -57496,9 +57681,7 @@ declare namespace sap {
57496
57681
  * Returns the meta model associated with this model if it is available for the concrete model type.
57497
57682
  */
57498
57683
  getMetaModel(): sap.ui.model.MetaModel;
57499
- /**
57500
- * Implement in inheriting classes.
57501
- */
57684
+
57502
57685
  getObject(
57503
57686
  /**
57504
57687
  * Path to where to read the object
@@ -57509,7 +57692,7 @@ declare namespace sap {
57509
57692
  */
57510
57693
  oContext?: sap.ui.model.Context,
57511
57694
  /**
57512
- * Additional model specific parameters
57695
+ * Additional model-specific parameters
57513
57696
  */
57514
57697
  mParameters?: object
57515
57698
  ): any;
@@ -57528,16 +57711,14 @@ declare namespace sap {
57528
57711
  */
57529
57712
  oContext?: sap.ui.model.Context
57530
57713
  ): any;
57531
- /**
57532
- * Implement in inheriting classes.
57533
- */
57714
+
57534
57715
  getProperty(
57535
57716
  /**
57536
- * the path to where to read the attribute value
57717
+ * The path to where to read the attribute value
57537
57718
  */
57538
57719
  sPath: string,
57539
57720
  /**
57540
- * the context with which the path should be resolved
57721
+ * The context with which the path should be resolved
57541
57722
  */
57542
57723
  oContext?: sap.ui.model.Context
57543
57724
  ): any;
@@ -57678,7 +57859,7 @@ declare namespace sap {
57678
57859
  */
57679
57860
  static getMetadata(): sap.ui.base.Metadata;
57680
57861
  /**
57681
- * Returns the binding mode
57862
+ * Returns the binding mode.
57682
57863
  */
57683
57864
  getBindingMode(): sap.ui.model.BindingMode;
57684
57865
  /**
@@ -57686,7 +57867,7 @@ declare namespace sap {
57686
57867
  */
57687
57868
  getExternalValue(): any;
57688
57869
  /**
57689
- * Returns the formatter function
57870
+ * Returns the formatter function.
57690
57871
  */
57691
57872
  getFormatter(): Function;
57692
57873
  /**
@@ -57694,21 +57875,21 @@ declare namespace sap {
57694
57875
  * model format} of this binding's type. If this binding doesn't have a type, the original value which is
57695
57876
  * stored in the model is returned.
57696
57877
  *
57697
- * This method will be used when targetType if set to "internal" or it's included in a {@link sap.ui.model.CompositeBinding
57878
+ * This method will be used when targetType is set to "internal" or when it's included in a {@link sap.ui.model.CompositeBinding
57698
57879
  * CompositeBinding} and the CompositeBinding needs to have the related JavaScript primitive values for
57699
57880
  * its type or formatter.
57700
57881
  */
57701
57882
  getInternalValue(): any;
57702
57883
  /**
57703
- * Returns the raw model value, as it exists in the model dataset
57884
+ * Returns the raw model value, as it exists in the model dataset.
57704
57885
  *
57705
- * This method will be used when targetType of a binding is set to "raw" or it's included in a {@link sap.ui.model.CompositeBinding
57706
- * CompositeBinding} and the CompositeBinding needs to have the related JavaScript primitive values for
57707
- * its type or formatter.
57886
+ * This method will be used when targetType of a binding is set to "raw" or when it's include in a {@link
57887
+ * sap.ui.model.CompositeBinding CompositeBinding} and the CompositeBinding needs to have the related JavaScript
57888
+ * primitive values for its type or formatter.
57708
57889
  */
57709
57890
  getRawValue(): any;
57710
57891
  /**
57711
- * Returns the type if any for the binding.
57892
+ * Returns the type (if any) for the binding.
57712
57893
  */
57713
57894
  getType(): sap.ui.model.Type;
57714
57895
  /**
@@ -57723,22 +57904,22 @@ declare namespace sap {
57723
57904
  */
57724
57905
  resume(): void;
57725
57906
  /**
57726
- * Sets the binding mode
57907
+ * Sets the binding mode.
57727
57908
  */
57728
57909
  setBindingMode(
57729
57910
  /**
57730
- * the binding mode
57911
+ * The binding mode
57731
57912
  */
57732
57913
  sBindingMode: sap.ui.model.BindingMode
57733
57914
  ): void;
57734
57915
  /**
57735
57916
  * Sets the value for this binding. The value is parsed and validated against its type and then set to the
57736
57917
  * binding. A model implementation should check if the current default binding mode permits setting the
57737
- * binding value and if so set the new value also in the model.
57918
+ * binding value, and if so, set the new value in the model, too.
57738
57919
  */
57739
57920
  setExternalValue(
57740
57921
  /**
57741
- * the value to set for this binding
57922
+ * The value to set for this binding
57742
57923
  */
57743
57924
  vValue: any
57744
57925
  ): undefined | Promise<any>;
@@ -57747,7 +57928,7 @@ declare namespace sap {
57747
57928
  */
57748
57929
  setFormatter(
57749
57930
  /**
57750
- * the formatter function for the binding
57931
+ * The formatter function for the binding
57751
57932
  */
57752
57933
  fnFormatter: Function
57753
57934
  ): void;
@@ -57758,20 +57939,20 @@ declare namespace sap {
57758
57939
  */
57759
57940
  setInternalValue(
57760
57941
  /**
57761
- * the value to set for this binding
57942
+ * The value to set for this binding
57762
57943
  */
57763
57944
  vValue: any
57764
- ): void;
57945
+ ): Promise<any> | undefined;
57765
57946
  /**
57766
57947
  * Sets the value for this binding with the raw model value. This setter will perform type validation, in
57767
57948
  * case a type is defined on the binding.
57768
57949
  */
57769
57950
  setRawValue(
57770
57951
  /**
57771
- * the value to set for this binding
57952
+ * The value to set for this binding
57772
57953
  */
57773
57954
  vValue: any
57774
- ): void;
57955
+ ): Promise<any> | undefined;
57775
57956
  /**
57776
57957
  * Sets the optional type and internal type for the binding. The type and internal type are used to do the
57777
57958
  * parsing/formatting correctly. The internal type is the property type of the element which the value is
@@ -57779,17 +57960,17 @@ declare namespace sap {
57779
57960
  */
57780
57961
  setType(
57781
57962
  /**
57782
- * the type for the binding
57963
+ * The type for the binding
57783
57964
  */
57784
57965
  oType: sap.ui.model.Type,
57785
57966
  /**
57786
- * the internal type of the element property which this binding is bound against.
57967
+ * The internal type of the element property which this binding is bound against.
57787
57968
  */
57788
57969
  sInternalType: string
57789
57970
  ): void;
57790
57971
  /**
57791
57972
  * Sets the value for this binding. A model implementation should check if the current default binding mode
57792
- * permits setting the binding value and if so set the new value also in the model.
57973
+ * permits setting the binding value, and if so, set the new value in the model, too.
57793
57974
  */
57794
57975
  setValue(
57795
57976
  /**
@@ -58499,18 +58680,18 @@ declare namespace sap {
58499
58680
  * @deprecated (since 1.52) - This method is marked as 'protected' which was meant to be overwritten by
58500
58681
  * its subclasses. It may be renamed or deleted and should only be called from this class or its subclasses.
58501
58682
  *
58502
- * Calculate the request length based on the given information
58683
+ * Calculate the request length based on the given information.
58503
58684
  */
58504
58685
  _calculateRequestLength(
58505
58686
  /**
58506
- * the maximum group size
58687
+ * The maximum group size
58507
58688
  */
58508
- iMaxGroupSize: int,
58689
+ iMaxGroupSize: number,
58509
58690
  /**
58510
- * the information of the current section
58691
+ * The information of the current section
58511
58692
  */
58512
58693
  oSection: object
58513
- ): void;
58694
+ ): number;
58514
58695
  /**
58515
58696
  * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of
58516
58697
  * this `sap.ui.model.TreeBindingAdapter`.
@@ -58609,6 +58790,10 @@ declare namespace sap {
58609
58790
  */
58610
58791
  iThreshold?: number
58611
58792
  ): sap.ui.model.Context[];
58793
+ /**
58794
+ * Returns the number of entries in the tree.
58795
+ */
58796
+ getLength(): number;
58612
58797
  /**
58613
58798
  * Gets an array of nodes for the requested part of the tree.
58614
58799
  */
@@ -58627,7 +58812,9 @@ declare namespace sap {
58627
58812
  iThreshold?: number
58628
58813
  ): object[];
58629
58814
  }
58630
-
58815
+ /**
58816
+ * @deprecated - use {@link sap.ui.model.TreeBindingAdapter} instead
58817
+ */
58631
58818
  class TreeBindingCompatibilityAdapter {
58632
58819
  /**
58633
58820
  * Adapter for TreeBindings to add the ListBinding functionality and use the tree structure in list based
@@ -58635,7 +58822,16 @@ declare namespace sap {
58635
58822
  *
58636
58823
  * This module is only for experimental and internal use!
58637
58824
  */
58638
- constructor();
58825
+ constructor(
58826
+ /**
58827
+ * The binding to add ListBinding functionality to
58828
+ */
58829
+ oBinding: sap.ui.model.TreeBinding,
58830
+ /**
58831
+ * The tree or tree table control using the given binding; the control is used for selection handling
58832
+ */
58833
+ oControl: object
58834
+ );
58639
58835
  }
58640
58836
  /**
58641
58837
  * This is an abstract base class for type objects.
@@ -61540,8 +61736,8 @@ declare namespace sap {
61540
61736
  * ```
61541
61737
  *
61542
61738
  *
61543
- * As of version 1.96 if the flag useLibraryBundle is true the library resource bundle of the control is
61544
- * used to resolve the i18n key
61739
+ * As of version 1.95 if the `useLibraryBundle` flag is set to `true`, the library resource bundle of the
61740
+ * control is used to resolve the i18n key.
61545
61741
  */
61546
61742
  class I18NText extends sap.ui.test.matchers.Matcher {
61547
61743
  /**
@@ -64736,8 +64932,6 @@ declare namespace sap {
64736
64932
 
64737
64933
  "sap/ui/base/ObjectPool": undefined;
64738
64934
 
64739
- "sap/ui/core/_IconRegistry": undefined;
64740
-
64741
64935
  "sap/ui/core/AppCacheBuster": undefined;
64742
64936
 
64743
64937
  "sap/ui/core/BusyIndicator": undefined;
@@ -64812,6 +65006,8 @@ declare namespace sap {
64812
65006
 
64813
65007
  "sap/ui/core/Icon": undefined;
64814
65008
 
65009
+ "sap/ui/core/IconPool": undefined;
65010
+
64815
65011
  "sap/ui/core/IndicationColorSupport": undefined;
64816
65012
 
64817
65013
  "sap/ui/core/IntervalTrigger": undefined;