@openui5/ts-types 1.93.3 → 1.96.2
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.
- package/package.json +1 -1
- package/types/sap.f.d.ts +314 -42
- package/types/sap.m.d.ts +931 -132
- package/types/sap.tnt.d.ts +11 -12
- package/types/sap.ui.codeeditor.d.ts +29 -31
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +873 -376
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +3 -1
- package/types/sap.ui.integration.d.ts +420 -15
- package/types/sap.ui.layout.d.ts +19 -1
- package/types/sap.ui.mdc.d.ts +51 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +6 -6
- package/types/sap.ui.table.d.ts +8 -5
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +142 -14
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +1503 -353
- package/types/sap.ui.webc.main.d.ts +5815 -4373
- package/types/sap.uxap.d.ts +1 -1
package/types/sap.ui.core.d.ts
CHANGED
|
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
|
|
|
264
264
|
): jQuery;
|
|
265
265
|
}
|
|
266
266
|
|
|
267
|
-
// For Library Version: 1.
|
|
267
|
+
// For Library Version: 1.96.2
|
|
268
268
|
|
|
269
269
|
declare module "sap/base/assert" {
|
|
270
270
|
/**
|
|
@@ -8606,7 +8606,7 @@ declare namespace sap {
|
|
|
8606
8606
|
* the name of the model or `undefined`
|
|
8607
8607
|
*/
|
|
8608
8608
|
sModelName?: string
|
|
8609
|
-
): sap.ui.model.Context;
|
|
8609
|
+
): sap.ui.model.Context | null | undefined;
|
|
8610
8610
|
/**
|
|
8611
8611
|
* Returns the binding info for the given property or aggregation.
|
|
8612
8612
|
*
|
|
@@ -14325,27 +14325,28 @@ declare namespace sap {
|
|
|
14325
14325
|
/**
|
|
14326
14326
|
* @SINCE 1.93
|
|
14327
14327
|
*
|
|
14328
|
-
* Loads a Fragment by {@link sap.ui.core.Fragment.load}.
|
|
14329
|
-
* fragment content creation is done, the controller takes care of an asynchronous destroy of the fragment
|
|
14330
|
-
* content. Otherwise the content must be destroyed by the caller as usual. If the controller has an owner
|
|
14331
|
-
* component, it is passed to the fragment content. The fragment content will be prefixed with the view
|
|
14332
|
-
* ID to avoid duplicate ID issues. The prefixing is enabled by default and can be switched off by the `autoPrefixId`
|
|
14333
|
-
* option.
|
|
14334
|
-
*
|
|
14335
|
-
* When `autoPrefixId` is enabled, the fragment content can be accessed by calling {@link sap.ui.core.mvc.Controller.byId}.
|
|
14336
|
-
*
|
|
14337
|
-
* Example (no mOptions.id given): var myCOntrol = this.byId("myControl");
|
|
14338
|
-
*
|
|
14339
|
-
* Example (mOptions.id given): var myCOntrol = this.byId("prefix--myControl");
|
|
14328
|
+
* Loads a Fragment by {@link sap.ui.core.Fragment.load}.
|
|
14340
14329
|
*
|
|
14341
14330
|
* The fragment content will be added to the `dependents` aggregation of the view by default. This behavior
|
|
14342
14331
|
* can be suppressed by setting `mOptions.addToDependents` to false.
|
|
14343
14332
|
*
|
|
14344
|
-
*
|
|
14345
|
-
* exit hook of the controller.
|
|
14346
|
-
*
|
|
14347
|
-
* The controller is passed to the Fragment by default so the (event handler) methods referenced in the
|
|
14333
|
+
* The controller is passed to the Fragment by default, so the (event handler) methods referenced in the
|
|
14348
14334
|
* Fragment will be called on this Controller.
|
|
14335
|
+
*
|
|
14336
|
+
* If the controller has an owner component, it is passed to the fragment content. By default the fragment
|
|
14337
|
+
* content will be prefixed with the view ID to avoid duplicate ID issues. The prefixing can be switched
|
|
14338
|
+
* off with the `autoPrefixId` option.
|
|
14339
|
+
*
|
|
14340
|
+
* When `autoPrefixId` is enabled, the fragment content can be accessed by calling {@link sap.ui.core.mvc.Controller.byId}.
|
|
14341
|
+
*
|
|
14342
|
+
* **Destroy behavior**: Different scenarios concerning the destruction of the fragment's content exist,
|
|
14343
|
+
* of which some must be addressed by the caller, while others are handled automatically.
|
|
14344
|
+
* - The controller instance is destroyed before the fragment content creation has finished: In this case,
|
|
14345
|
+
* the controller instance takes care of asynchronously destroying the fragment content
|
|
14346
|
+
* - The fragment content is aggregated within a control (e.g. `dependents` aggregation by default): In
|
|
14347
|
+
* this case, the content will be destroyed during the regular destroy lifecycle.
|
|
14348
|
+
* - The fragment content is not aggregated within a control: In this case, ***it must be destroyed manually***
|
|
14349
|
+
* in the exit hook of the controller.
|
|
14349
14350
|
*/
|
|
14350
14351
|
loadFragment(
|
|
14351
14352
|
/**
|
|
@@ -14926,6 +14927,11 @@ declare namespace sap {
|
|
|
14926
14927
|
* #byId}, elements or controls can be found with their view-local ID. Also see {@link topic:91f28be26f4d1014b6dd926db0e91070
|
|
14927
14928
|
* "Support for Unique IDs"} in the documentation.
|
|
14928
14929
|
*
|
|
14930
|
+
* **Note: For Views defined using XML markup** On root level, you can only define content for the default
|
|
14931
|
+
* aggregation, e.g. without adding the `<content>` tag. If you want to specify content for another
|
|
14932
|
+
* aggregation of a view like `dependents`, place it in a child control's dependents aggregation or add
|
|
14933
|
+
* it by using {@link sap.ui.core.mvc.XMLView.addDependent}.
|
|
14934
|
+
*
|
|
14929
14935
|
* View Definition: A view can be defined by {@link sap.ui.core.mvc.View.extend extending} this class and
|
|
14930
14936
|
* implementing the {@link #createContent} method. The method must return one or many root controls that
|
|
14931
14937
|
* will be rendered as content of the view.
|
|
@@ -16038,7 +16044,9 @@ declare namespace sap {
|
|
|
16038
16044
|
*/
|
|
16039
16045
|
interface Parameters {
|
|
16040
16046
|
/**
|
|
16041
|
-
* Returns the current value for one or more theming parameters, depending on the given arguments.
|
|
16047
|
+
* Returns the current value for one or more theming parameters, depending on the given arguments. The
|
|
16048
|
+
* synchronous usage of this API has been deprecated and only the asynchronous usage should still be used
|
|
16049
|
+
* (see the 4th bullet point and the code examples below).
|
|
16042
16050
|
*
|
|
16043
16051
|
* The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
|
|
16044
16052
|
* API calls for the same parameter name will always result in the same parameter value.
|
|
@@ -16052,14 +16060,15 @@ declare namespace sap {
|
|
|
16052
16060
|
*
|
|
16053
16061
|
*
|
|
16054
16062
|
* The following API variants are available (see also the below examples):
|
|
16055
|
-
* - **(deprecated since 1.92) If no parameter is given a key-value map containing all parameters
|
|
16056
|
-
*
|
|
16057
|
-
* - If a `string` is given as first parameter the value is returned as a
|
|
16058
|
-
*
|
|
16059
|
-
*
|
|
16063
|
+
* - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
|
|
16064
|
+
* returned
|
|
16065
|
+
* - **(deprecated since 1.94)** If a `string` is given as first parameter the value is returned as a
|
|
16066
|
+
* `string`
|
|
16067
|
+
* - **(deprecated since 1.94)** If an `array` is given as first parameter a key-value map containing
|
|
16068
|
+
* all parameters from the `array` is returned
|
|
16060
16069
|
* - If an `object` is given as first parameter the result is returned immediately in case all parameters
|
|
16061
16070
|
* are loaded and available or within the callback in case not all CSS files are already loaded. This is
|
|
16062
|
-
* the only asynchronous** API variant. This variant is the preferred way to retrieve theming parameters.
|
|
16071
|
+
* the **only asynchronous** API variant. This variant is the preferred way to retrieve theming parameters.
|
|
16063
16072
|
* The structure of the return value is the same as listed above depending on the type of the name property
|
|
16064
16073
|
* within the `object`.
|
|
16065
16074
|
*
|
|
@@ -18208,7 +18217,7 @@ declare namespace sap {
|
|
|
18208
18217
|
* The hash to be matched
|
|
18209
18218
|
*/
|
|
18210
18219
|
sHash: string
|
|
18211
|
-
):
|
|
18220
|
+
): sap.ui.core.routing.RouteInfo | undefined;
|
|
18212
18221
|
/**
|
|
18213
18222
|
* Returns a target by its name.
|
|
18214
18223
|
*
|
|
@@ -18713,6 +18722,14 @@ declare namespace sap {
|
|
|
18713
18722
|
*/
|
|
18714
18723
|
oParameters?: object
|
|
18715
18724
|
): this;
|
|
18725
|
+
/**
|
|
18726
|
+
* Suspends the object which is loaded by the target.
|
|
18727
|
+
*
|
|
18728
|
+
* Currently this function stops the router of the component when the object which is loaded by this target
|
|
18729
|
+
* is an instance of UIComponent. This is done only when the target is already loaded. When the target is
|
|
18730
|
+
* not loaded yet or still being loaded, the router of the component isn't stopped.
|
|
18731
|
+
*/
|
|
18732
|
+
suspend(): sap.ui.core.routing.Target;
|
|
18716
18733
|
}
|
|
18717
18734
|
/**
|
|
18718
18735
|
* @SINCE 1.28.1
|
|
@@ -19435,6 +19452,17 @@ declare namespace sap {
|
|
|
19435
19452
|
fullHash?: string;
|
|
19436
19453
|
};
|
|
19437
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
|
+
|
|
19438
19466
|
/**
|
|
19439
19467
|
* @SINCE 1.84.0
|
|
19440
19468
|
*
|
|
@@ -20400,6 +20428,10 @@ declare namespace sap {
|
|
|
20400
20428
|
*/
|
|
20401
20429
|
mSettings?: sap.ui.core.tmpl.$TemplateSettings
|
|
20402
20430
|
);
|
|
20431
|
+
/**
|
|
20432
|
+
* parses the given path and extracts the model and path
|
|
20433
|
+
*/
|
|
20434
|
+
static parsePath: undefined;
|
|
20403
20435
|
|
|
20404
20436
|
/**
|
|
20405
20437
|
* Returns the registered template for the given ID, if any.
|
|
@@ -20430,15 +20462,6 @@ declare namespace sap {
|
|
|
20430
20462
|
* Returns a metadata object for class sap.ui.core.tmpl.Template.
|
|
20431
20463
|
*/
|
|
20432
20464
|
static getMetadata(): sap.ui.base.ManagedObjectMetadata;
|
|
20433
|
-
/**
|
|
20434
|
-
* parses the given path and extracts the model and path
|
|
20435
|
-
*/
|
|
20436
|
-
static parsePath(
|
|
20437
|
-
/**
|
|
20438
|
-
* the path
|
|
20439
|
-
*/
|
|
20440
|
-
sPath: string
|
|
20441
|
-
): object;
|
|
20442
20465
|
/**
|
|
20443
20466
|
* Creates an anonymous TemplateControl for the Template.
|
|
20444
20467
|
*/
|
|
@@ -24492,6 +24515,8 @@ declare namespace sap {
|
|
|
24492
24515
|
sId: sap.ui.core.ID | null | undefined
|
|
24493
24516
|
): sap.ui.core.Element | undefined;
|
|
24494
24517
|
/**
|
|
24518
|
+
* @deprecated (since 1.95) - Please use {@link sap.ui.core.Component.create Component.create} instead.
|
|
24519
|
+
*
|
|
24495
24520
|
* Creates a component with the provided id and settings.
|
|
24496
24521
|
*
|
|
24497
24522
|
* When the optional parameter `sUrl` is given, then all request for resources of the library will be redirected
|
|
@@ -24545,7 +24570,7 @@ declare namespace sap {
|
|
|
24545
24570
|
* the settings object for the component
|
|
24546
24571
|
*/
|
|
24547
24572
|
mSettings?: object
|
|
24548
|
-
):
|
|
24573
|
+
): sap.ui.core.Component;
|
|
24549
24574
|
/**
|
|
24550
24575
|
* Returns a new instance of the RenderManager for exclusive use by the caller.
|
|
24551
24576
|
*
|
|
@@ -24817,6 +24842,8 @@ declare namespace sap {
|
|
|
24817
24842
|
*/
|
|
24818
24843
|
getApplication(): sap.ui.app.Application;
|
|
24819
24844
|
/**
|
|
24845
|
+
* @deprecated (since 1.95) - Please use {@link sap.ui.core.Component.get Component.get} instead.
|
|
24846
|
+
*
|
|
24820
24847
|
* Returns the registered component for the given id, if any.
|
|
24821
24848
|
*/
|
|
24822
24849
|
getComponent(sId: string): sap.ui.core.Component;
|
|
@@ -24937,6 +24964,9 @@ declare namespace sap {
|
|
|
24937
24964
|
*/
|
|
24938
24965
|
getRenderManager(): void;
|
|
24939
24966
|
/**
|
|
24967
|
+
* @deprecated (since 1.95) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also {@link
|
|
24968
|
+
* topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
|
|
24969
|
+
*
|
|
24940
24970
|
* Returns the instance of the root component (if exists).
|
|
24941
24971
|
*/
|
|
24942
24972
|
getRootComponent(): sap.ui.core.Component;
|
|
@@ -25186,7 +25216,7 @@ declare namespace sap {
|
|
|
25186
25216
|
*/
|
|
25187
25217
|
loadLibrary(
|
|
25188
25218
|
/**
|
|
25189
|
-
*
|
|
25219
|
+
* Name of the library to load
|
|
25190
25220
|
*/
|
|
25191
25221
|
sLibrary: string,
|
|
25192
25222
|
/**
|
|
@@ -25196,16 +25226,16 @@ declare namespace sap {
|
|
|
25196
25226
|
| string
|
|
25197
25227
|
| boolean
|
|
25198
25228
|
| {
|
|
25199
|
-
/**
|
|
25200
|
-
* URL to load the library from
|
|
25201
|
-
*/
|
|
25202
|
-
url?: string;
|
|
25203
25229
|
/**
|
|
25204
25230
|
* Whether to load the library asynchronously
|
|
25205
25231
|
*/
|
|
25206
25232
|
async?: boolean;
|
|
25233
|
+
/**
|
|
25234
|
+
* URL to load the library from
|
|
25235
|
+
*/
|
|
25236
|
+
url?: string;
|
|
25207
25237
|
}
|
|
25208
|
-
):
|
|
25238
|
+
): object | Promise<object>;
|
|
25209
25239
|
/**
|
|
25210
25240
|
* Locks the Core. No browser events are dispatched to the controls.
|
|
25211
25241
|
*
|
|
@@ -25626,6 +25656,23 @@ declare namespace sap {
|
|
|
25626
25656
|
*/
|
|
25627
25657
|
collectionName?: string
|
|
25628
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;
|
|
25629
25676
|
/**
|
|
25630
25677
|
* Returns whether the given `uri` is an icon URI.
|
|
25631
25678
|
*
|
|
@@ -27266,12 +27313,6 @@ declare namespace sap {
|
|
|
27266
27313
|
* Container width in CSS size
|
|
27267
27314
|
*/
|
|
27268
27315
|
getWidth(): sap.ui.core.CSSSize;
|
|
27269
|
-
/**
|
|
27270
|
-
* @SINCE 1.91
|
|
27271
|
-
*
|
|
27272
|
-
* Hides the placeholder that is shown on the component container.
|
|
27273
|
-
*/
|
|
27274
|
-
hidePlaceholder(): void;
|
|
27275
27316
|
/**
|
|
27276
27317
|
* Sets a new value for property {@link #getAsync async}.
|
|
27277
27318
|
*
|
|
@@ -27476,22 +27517,6 @@ declare namespace sap {
|
|
|
27476
27517
|
*/
|
|
27477
27518
|
sWidth?: sap.ui.core.CSSSize
|
|
27478
27519
|
): this;
|
|
27479
|
-
/**
|
|
27480
|
-
* @SINCE 1.91
|
|
27481
|
-
*
|
|
27482
|
-
* Shows the provided placeholder on the component container.
|
|
27483
|
-
*/
|
|
27484
|
-
showPlaceholder(
|
|
27485
|
-
/**
|
|
27486
|
-
* Object containing the placeholder object
|
|
27487
|
-
*/
|
|
27488
|
-
mSettings: {
|
|
27489
|
-
/**
|
|
27490
|
-
* The placeholder instance
|
|
27491
|
-
*/
|
|
27492
|
-
placeholder: /* was: sap.ui.core.Placeholder */ any;
|
|
27493
|
-
}
|
|
27494
|
-
): void;
|
|
27495
27520
|
}
|
|
27496
27521
|
/**
|
|
27497
27522
|
* @SINCE 1.9.2
|
|
@@ -27574,7 +27599,7 @@ declare namespace sap {
|
|
|
27574
27599
|
*/
|
|
27575
27600
|
getDependencies(): Object;
|
|
27576
27601
|
/**
|
|
27577
|
-
* @deprecated (since 1.27.1) -
|
|
27602
|
+
* @deprecated (since 1.27.1) - For CSS, please use {@link sap.ui.core.Component#getManifestEntry}("/sap.ui5/resources/css").
|
|
27578
27603
|
*
|
|
27579
27604
|
* Returns the array of the included files that the Component requires such as CSS and JavaScript. If not
|
|
27580
27605
|
* specified or the array is empty, the return value is null. **Important:**
|
|
@@ -27787,7 +27812,8 @@ declare namespace sap {
|
|
|
27787
27812
|
*/
|
|
27788
27813
|
getAppCacheBusterMode(): string;
|
|
27789
27814
|
/**
|
|
27790
|
-
* @deprecated (since 1.15.1) - Please use
|
|
27815
|
+
* @deprecated (since 1.15.1) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also
|
|
27816
|
+
* {@link topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
|
|
27791
27817
|
*
|
|
27792
27818
|
* The name of the application to start or empty.
|
|
27793
27819
|
*/
|
|
@@ -27901,7 +27927,8 @@ declare namespace sap {
|
|
|
27901
27927
|
*/
|
|
27902
27928
|
getOriginInfo(): boolean;
|
|
27903
27929
|
/**
|
|
27904
|
-
* @
|
|
27930
|
+
* @deprecated (since 1.95) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also {@link
|
|
27931
|
+
* topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
|
|
27905
27932
|
*
|
|
27906
27933
|
* The name of the root component to start or empty.
|
|
27907
27934
|
*/
|
|
@@ -27919,6 +27946,14 @@ declare namespace sap {
|
|
|
27919
27946
|
* It will be returned in uppercase. e.g. "EN", "DE"
|
|
27920
27947
|
*/
|
|
27921
27948
|
getSAPLogonLanguage(): string;
|
|
27949
|
+
/**
|
|
27950
|
+
* @SINCE 1.95.0
|
|
27951
|
+
*
|
|
27952
|
+
* Returns the security token handlers of an OData V4 model.
|
|
27953
|
+
* See:
|
|
27954
|
+
* #setSecurityTokenHandlers
|
|
27955
|
+
*/
|
|
27956
|
+
getSecurityTokenHandlers(): Function[];
|
|
27922
27957
|
/**
|
|
27923
27958
|
* Returns the theme name
|
|
27924
27959
|
*/
|
|
@@ -28069,6 +28104,20 @@ declare namespace sap {
|
|
|
28069
28104
|
*/
|
|
28070
28105
|
bRTL: boolean | null
|
|
28071
28106
|
): this;
|
|
28107
|
+
/**
|
|
28108
|
+
* @SINCE 1.95.0
|
|
28109
|
+
*
|
|
28110
|
+
* Sets the security token handlers for an OData V4 model. See chapter "Security Token Handling" in {@link
|
|
28111
|
+
* topic:9613f1f2d88747cab21896f7216afdac Model Instantiation and Data Access}.
|
|
28112
|
+
* See:
|
|
28113
|
+
* #getSecurityTokenHandlers
|
|
28114
|
+
*/
|
|
28115
|
+
setSecurityTokenHandlers(
|
|
28116
|
+
/**
|
|
28117
|
+
* The security token handlers
|
|
28118
|
+
*/
|
|
28119
|
+
aSecurityTokenHandlers: Function[]
|
|
28120
|
+
): void;
|
|
28072
28121
|
}
|
|
28073
28122
|
/**
|
|
28074
28123
|
* Base Class for Controls.
|
|
@@ -29939,23 +29988,29 @@ declare namespace sap {
|
|
|
29939
29988
|
*/
|
|
29940
29989
|
getElementName(): string;
|
|
29941
29990
|
}
|
|
29942
|
-
|
|
29943
|
-
* Helper Class for enhancement of a Control with propagation of enabled property.
|
|
29944
|
-
*/
|
|
29991
|
+
|
|
29945
29992
|
class EnabledPropagator {
|
|
29946
29993
|
/**
|
|
29947
|
-
*
|
|
29994
|
+
* Mixin for enhancement of a control prototype with propagation of the `enabled` property.
|
|
29995
|
+
*
|
|
29996
|
+
* Controls that apply this mixin calculate their effective `enabled` state on read access as the logical
|
|
29997
|
+
* OR of their own `enabled` property and the `enabled` state of the nearest ancestor control which has
|
|
29998
|
+
* either an `enabled` property or a `getEnabled` method.
|
|
29999
|
+
*
|
|
30000
|
+
* Applying this mixin adds the `enabled` property, if it not already exists, to the control metadata.
|
|
29948
30001
|
*
|
|
29949
|
-
*
|
|
29950
|
-
*
|
|
30002
|
+
* Also adds the `useEnabledPropagator(boolean)` helper method to the prototype of the given control. `myControlInstance.useEnabledPropagator(false)`
|
|
30003
|
+
* can be used to prevent a single instance from using `EnabledPropagator`. In this case, the effective
|
|
30004
|
+
* `enabled` state does not take any ancestors `enabled` state into account, only the control's own `enabled`
|
|
30005
|
+
* property.
|
|
29951
30006
|
*/
|
|
29952
30007
|
constructor(
|
|
29953
30008
|
/**
|
|
29954
|
-
*
|
|
30009
|
+
* Value that should be used as default value for the enhancement of the control.
|
|
29955
30010
|
*/
|
|
29956
30011
|
bDefault?: boolean,
|
|
29957
30012
|
/**
|
|
29958
|
-
*
|
|
30013
|
+
* Whether the introduced property should use the old name `Enabled`.
|
|
29959
30014
|
*/
|
|
29960
30015
|
bLegacy?: boolean
|
|
29961
30016
|
);
|
|
@@ -34482,6 +34537,9 @@ declare namespace sap {
|
|
|
34482
34537
|
* When an <img> tag is rendered, the following two attributes are added by default and can be overwritten
|
|
34483
34538
|
* with corresponding values in the `mAttributes` parameter:
|
|
34484
34539
|
* - `role: "presentation"` `alt: ""`
|
|
34540
|
+
*
|
|
34541
|
+
* **Note:** This function requires the {@link sap.ui.core.IconPool} module. Ensure that the module is loaded
|
|
34542
|
+
* before this function is called to avoid syncXHRs.
|
|
34485
34543
|
*/
|
|
34486
34544
|
icon(
|
|
34487
34545
|
/**
|
|
@@ -36129,7 +36187,7 @@ declare namespace sap {
|
|
|
36129
36187
|
* A `sap.ui.core.UIComponent` subclass can additionally implement the {@link sap.ui.core.IAsyncContentCreation}
|
|
36130
36188
|
* interface. When implementing this interface the loading and processing of an asynchronous `rootView`
|
|
36131
36189
|
* will be chained into the result Promise of the {@link sap.ui.core.Component.create Component.create}
|
|
36132
|
-
* factory. See Sample 1 below.
|
|
36190
|
+
* factory. An additional async flag can be omitted. See Sample 1 below.
|
|
36133
36191
|
*
|
|
36134
36192
|
* Samples 2 and 3 show how subclasses can overwrite the `createContent` function to run asynchronously.
|
|
36135
36193
|
* To create the root control asynchronously, the subclass has to define the `sap.ui.core.IAsyncContentCreation`
|
|
@@ -37884,11 +37942,11 @@ declare namespace sap {
|
|
|
37884
37942
|
/**
|
|
37885
37943
|
* The SAPUI5 Data Binding API.
|
|
37886
37944
|
*
|
|
37887
|
-
* The default binding mode for model implementations (if not implemented otherwise) is two
|
|
37888
|
-
* supported binding modes by the model are one
|
|
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
|
|
37889
37947
|
* be changed by the application for each model instance. A model implementation should specify its supported
|
|
37890
|
-
* binding modes and set the default binding mode accordingly (e.g. if the model supports only one
|
|
37891
|
-
* the default binding mode should also be set to one
|
|
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).
|
|
37892
37950
|
*
|
|
37893
37951
|
* The default size limit for models is 100. The size limit determines the number of entries used for the
|
|
37894
37952
|
* list bindings.
|
|
@@ -37922,6 +37980,9 @@ declare namespace sap {
|
|
|
37922
37980
|
);
|
|
37923
37981
|
}
|
|
37924
37982
|
/**
|
|
37983
|
+
* @deprecated (since 1.94) - use {@link sap.ui.model.analytics.odata4analytics.Model.ReferenceByModel}
|
|
37984
|
+
* instead
|
|
37985
|
+
*
|
|
37925
37986
|
* Handle to an OData model by the URI pointing to it.
|
|
37926
37987
|
*/
|
|
37927
37988
|
class ReferenceByURI {
|
|
@@ -37956,11 +38017,12 @@ declare namespace sap {
|
|
|
37956
38017
|
*/
|
|
37957
38018
|
constructor(
|
|
37958
38019
|
/**
|
|
37959
|
-
*
|
|
38020
|
+
* Holds a reference to the OData model, obtained by {@link sap.ui.model.analytics.odata4analytics.Model.ReferenceByModel},
|
|
38021
|
+
* or by {@link sap.ui.model.analytics.odata4analytics.Model.ReferenceByURI} which is deprecated.
|
|
37960
38022
|
*/
|
|
37961
38023
|
oModel: object,
|
|
37962
38024
|
/**
|
|
37963
|
-
*
|
|
38025
|
+
* All workarounds to be applied.
|
|
37964
38026
|
*/
|
|
37965
38027
|
aWorkaroundID: string[]
|
|
37966
38028
|
);
|
|
@@ -38550,15 +38612,18 @@ declare namespace sap {
|
|
|
38550
38612
|
*/
|
|
38551
38613
|
constructor(
|
|
38552
38614
|
/**
|
|
38553
|
-
* An instance of
|
|
38615
|
+
* An instance of {@link sap.ui.model.analytics.odata4analytics.Model.ReferenceByModel} or {@link sap.ui.model.analytics.odata4analytics.Model.ReferenceWithWorkaround}
|
|
38616
|
+
* for locating the OData service. {@link sap.ui.model.analytics.odata4analytics.Model.ReferenceByURI} is
|
|
38617
|
+
* deprecated.
|
|
38554
38618
|
*/
|
|
38555
38619
|
oModelReference: object,
|
|
38556
38620
|
/**
|
|
38557
38621
|
* Additional parameters for controlling the model construction. Currently supported are:
|
|
38558
38622
|
* - sAnnotationJSONDoc - A JSON document providing extra annotations to the elements of the structure
|
|
38559
38623
|
* of the given service
|
|
38560
|
-
* - modelVersion - Parameter to define which ODataModel version should be used
|
|
38561
|
-
*
|
|
38624
|
+
* - modelVersion (deprecated) - Parameter to define which ODataModel version should be used if you use
|
|
38625
|
+
* {@link sap.ui.model.analytics.odata4analytics.Model.ReferenceByURI}; supported values are: 1 (default),
|
|
38626
|
+
* 2
|
|
38562
38627
|
*/
|
|
38563
38628
|
mParameter?: object
|
|
38564
38629
|
);
|
|
@@ -40050,7 +40115,9 @@ declare namespace sap {
|
|
|
40050
40115
|
): any[];
|
|
40051
40116
|
}
|
|
40052
40117
|
/**
|
|
40053
|
-
* Model implementation for JSON format
|
|
40118
|
+
* Model implementation for the JSON format.
|
|
40119
|
+
*
|
|
40120
|
+
* This model is not prepared to be inherited from.
|
|
40054
40121
|
*/
|
|
40055
40122
|
class JSONModel extends sap.ui.model.ClientModel {
|
|
40056
40123
|
/**
|
|
@@ -40292,7 +40359,9 @@ declare namespace sap {
|
|
|
40292
40359
|
*/
|
|
40293
40360
|
namespace message {
|
|
40294
40361
|
/**
|
|
40295
|
-
* Model implementation for Messages
|
|
40362
|
+
* Model implementation for Messages.
|
|
40363
|
+
*
|
|
40364
|
+
* This model is not prepared to be inherited from.
|
|
40296
40365
|
*/
|
|
40297
40366
|
class MessageModel extends sap.ui.model.ClientModel {
|
|
40298
40367
|
/**
|
|
@@ -40331,17 +40400,17 @@ declare namespace sap {
|
|
|
40331
40400
|
*/
|
|
40332
40401
|
static getMetadata(): sap.ui.base.Metadata;
|
|
40333
40402
|
/**
|
|
40334
|
-
* Returns the value for the property with the given `sPropertyName
|
|
40403
|
+
* Returns the value for the property with the given `sPropertyName`.
|
|
40335
40404
|
*/
|
|
40336
40405
|
getProperty(
|
|
40337
40406
|
/**
|
|
40338
|
-
*
|
|
40407
|
+
* The path to the property
|
|
40339
40408
|
*/
|
|
40340
40409
|
sPath: string,
|
|
40341
40410
|
/**
|
|
40342
|
-
*
|
|
40411
|
+
* The context to resolve a relative path with
|
|
40343
40412
|
*/
|
|
40344
|
-
oContext?:
|
|
40413
|
+
oContext?: sap.ui.model.Context
|
|
40345
40414
|
): any;
|
|
40346
40415
|
/**
|
|
40347
40416
|
* Sets the message data to the model.
|
|
@@ -40358,7 +40427,20 @@ declare namespace sap {
|
|
|
40358
40427
|
* Other models provide this method to set a new value for a specific property. `MessageModel` does not
|
|
40359
40428
|
* support it as it supports the `OneWay` mode only.
|
|
40360
40429
|
*/
|
|
40361
|
-
setProperty(
|
|
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;
|
|
40362
40444
|
}
|
|
40363
40445
|
}
|
|
40364
40446
|
/**
|
|
@@ -42881,6 +42963,7 @@ declare namespace sap {
|
|
|
42881
42963
|
* A context for the OData V2 model cannot be created at will, it has to be retrieved via:
|
|
42882
42964
|
* - an OData binding
|
|
42883
42965
|
* - a view element
|
|
42966
|
+
* - {@link sap.ui.model.odata.v2.ODataModel#callFunction}
|
|
42884
42967
|
* - {@link sap.ui.model.odata.v2.ODataModel#createBindingContext}
|
|
42885
42968
|
* - {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
42886
42969
|
*/
|
|
@@ -42912,6 +42995,26 @@ declare namespace sap {
|
|
|
42912
42995
|
* Returns a metadata object for class sap.ui.model.odata.v2.Context.
|
|
42913
42996
|
*/
|
|
42914
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>;
|
|
43010
|
+
/**
|
|
43011
|
+
* @SINCE 1.94.0
|
|
43012
|
+
*
|
|
43013
|
+
* For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry}, the method returns
|
|
43014
|
+
* `true` if the context is transient or `false` if the context is not transient. A transient context represents
|
|
43015
|
+
* an entity created on the client which has not been persisted in the back end.
|
|
43016
|
+
*/
|
|
43017
|
+
isTransient(): boolean;
|
|
42915
43018
|
}
|
|
42916
43019
|
/**
|
|
42917
43020
|
* @SINCE 1.37.0
|
|
@@ -43524,6 +43627,14 @@ declare namespace sap {
|
|
|
43524
43627
|
* Defines the count mode of this binding; if not specified, the default count mode of the `oModel` is applied
|
|
43525
43628
|
*/
|
|
43526
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;
|
|
43527
43638
|
/**
|
|
43528
43639
|
* An optional map of custom query parameters. Custom parameters must not start with `$`
|
|
43529
43640
|
*/
|
|
@@ -43711,6 +43822,8 @@ declare namespace sap {
|
|
|
43711
43822
|
* Model implementation based on the OData protocol.
|
|
43712
43823
|
*
|
|
43713
43824
|
* See chapter {@link topic:6c47b2b39db9404582994070ec3d57a2 OData V2 Model} for a general introduction.
|
|
43825
|
+
*
|
|
43826
|
+
* This model is not prepared to be inherited from.
|
|
43714
43827
|
*/
|
|
43715
43828
|
class ODataModel extends sap.ui.model.Model {
|
|
43716
43829
|
/**
|
|
@@ -44234,6 +44347,14 @@ declare namespace sap {
|
|
|
44234
44347
|
* Count mode for this binding; if not specified, the default count mode for this model is used
|
|
44235
44348
|
*/
|
|
44236
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;
|
|
44237
44358
|
/**
|
|
44238
44359
|
* Operation mode for this binding; if not specified, the default operation mode of this model is used
|
|
44239
44360
|
*/
|
|
@@ -44675,7 +44796,11 @@ declare namespace sap {
|
|
|
44675
44796
|
* Name. A context object is returned which can be used to bind against the newly created object.
|
|
44676
44797
|
*
|
|
44677
44798
|
* For each created entry a request is created and stored in a request queue. The request queue can be submitted
|
|
44678
|
-
* by calling {@link #submitChanges}.
|
|
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.
|
|
44679
44804
|
*
|
|
44680
44805
|
* The optional parameter `mParameters.properties` can be used as follows:
|
|
44681
44806
|
* - `properties` could be an array containing the property names which should be included in the new
|
|
@@ -44686,7 +44811,7 @@ declare namespace sap {
|
|
|
44686
44811
|
*
|
|
44687
44812
|
* If there are no values specified, the properties will have `undefined` values.
|
|
44688
44813
|
*
|
|
44689
|
-
*
|
|
44814
|
+
* The `properties` can be modified via property bindings relative to the returned context instance.
|
|
44690
44815
|
*
|
|
44691
44816
|
* The parameter `expand` is supported since 1.78.0. If this parameter is set, the given navigation properties
|
|
44692
44817
|
* are expanded automatically with the same $batch request in which the POST request for the creation is
|
|
@@ -44705,6 +44830,14 @@ declare namespace sap {
|
|
|
44705
44830
|
* handler is called with the data and the response of the POST request. The response object of the success
|
|
44706
44831
|
* handler call and the response parameter of the corresponding `requestFailed` and `requestCompleted` events
|
|
44707
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.
|
|
44708
44841
|
*/
|
|
44709
44842
|
createEntry(
|
|
44710
44843
|
/**
|
|
@@ -44790,7 +44923,12 @@ declare namespace sap {
|
|
|
44790
44923
|
oKeyProperties: object
|
|
44791
44924
|
): string;
|
|
44792
44925
|
/**
|
|
44926
|
+
* @deprecated - since 1.95.0; use {@link #resetChanges} instead
|
|
44927
|
+
*
|
|
44793
44928
|
* Deletes a created entry from the request queue and from the model.
|
|
44929
|
+
*
|
|
44930
|
+
* **Note:** Controls are not updated. Use {@link #resetChanges} instead to update also the controls, for
|
|
44931
|
+
* example: `oModel.resetChanges([oContext.getPath()], undefined, true);`
|
|
44794
44932
|
*/
|
|
44795
44933
|
deleteCreatedEntry(
|
|
44796
44934
|
/**
|
|
@@ -45243,8 +45381,10 @@ declare namespace sap {
|
|
|
45243
45381
|
* To get a copy of the entity without internal attributes, use `{select: "*"}` instead.
|
|
45244
45382
|
*
|
|
45245
45383
|
* **Note:** If `mParameters.select` is given and not all selected properties are available, this method
|
|
45246
|
-
* returns `undefined` instead of incomplete data.
|
|
45247
|
-
*
|
|
45384
|
+
* returns `undefined` instead of incomplete data.
|
|
45385
|
+
*
|
|
45386
|
+
* **Note:** If `mParameters.select` is not given, all properties and navigation properties available on
|
|
45387
|
+
* the client are returned.
|
|
45248
45388
|
*
|
|
45249
45389
|
* Example:
|
|
45250
45390
|
* With `mParameters` given as `{select: "Products/ProductName, Products", expand:"Products"}` no properties
|
|
@@ -45627,31 +45767,38 @@ declare namespace sap {
|
|
|
45627
45767
|
*/
|
|
45628
45768
|
changeSetId?: string;
|
|
45629
45769
|
/**
|
|
45630
|
-
* Since 1.46; defines whether to update all bindings after submitting this change operation
|
|
45631
|
-
* #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
|
|
45632
45772
|
* only.
|
|
45633
45773
|
*/
|
|
45634
45774
|
refreshAfterChange?: boolean;
|
|
45635
45775
|
}
|
|
45636
45776
|
): object;
|
|
45637
45777
|
/**
|
|
45638
|
-
* Resets changes
|
|
45778
|
+
* Resets pending changes and aborts corresponding requests.
|
|
45639
45779
|
*
|
|
45640
|
-
* By default, only
|
|
45641
|
-
*
|
|
45780
|
+
* By default, only changes triggered through {@link #createEntry} or {@link #setProperty} are taken into
|
|
45781
|
+
* account. If `bAll` is set, also deferred requests triggered through {@link #create}, {@link #update}
|
|
45782
|
+
* or {@link #remove} are taken into account.
|
|
45642
45783
|
*
|
|
45643
|
-
* If `
|
|
45644
|
-
*
|
|
45784
|
+
* If `bDeleteCreatedEntities` is set, the entity is completely removed, provided it has been created
|
|
45785
|
+
*
|
|
45786
|
+
* - via {@link #createEntry} and it is not yet persisted in the back end, or
|
|
45787
|
+
* - via {@link #callFunction}.
|
|
45645
45788
|
*/
|
|
45646
45789
|
resetChanges(
|
|
45647
45790
|
/**
|
|
45648
|
-
*
|
|
45791
|
+
* Paths to be be reset; if no array is passed, all changes are reset
|
|
45649
45792
|
*/
|
|
45650
45793
|
aPath?: any[],
|
|
45651
45794
|
/**
|
|
45652
|
-
*
|
|
45795
|
+
* Whether also deferred requests are taken into account
|
|
45653
45796
|
*/
|
|
45654
|
-
bAll?: boolean
|
|
45797
|
+
bAll?: boolean,
|
|
45798
|
+
/**
|
|
45799
|
+
* Whether to delete the entities created via {@link #createEntry} or {@link #callFunction}; since 1.95.0
|
|
45800
|
+
*/
|
|
45801
|
+
bDeleteCreatedEntities?: boolean
|
|
45655
45802
|
): Promise<any>;
|
|
45656
45803
|
/**
|
|
45657
45804
|
* Returns a promise, which will resolve with the security token as soon as it is available.
|
|
@@ -46032,17 +46179,17 @@ declare namespace sap {
|
|
|
46032
46179
|
* Applies the given filters to the ODataTreeBinding.
|
|
46033
46180
|
*
|
|
46034
46181
|
* Please note that filters of type `FilterType.Control` are not supported for `OperationMode.Server`, here
|
|
46035
|
-
* only filters of type `FilterType.Application` are allowed. Filters given via
|
|
46036
|
-
* of type `Application` and will be sent with every
|
|
46037
|
-
*
|
|
46182
|
+
* only filters of type `FilterType.Application` are allowed. Filters given via {@link sap.ui.model.odata.v2.ODataModel#bindTree}
|
|
46183
|
+
* are always of type `Application` and will be sent with every back-end request. For more information,
|
|
46184
|
+
* see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
|
|
46038
46185
|
*
|
|
46039
46186
|
* Since 1.34.0, complete client-side filtering is supported for `OperationMode.Client` and also in `OperationMode.Auto`
|
|
46040
|
-
* if the
|
|
46041
|
-
* on the client. See also: {@link sap.ui.model.odata.OperationMode.Auto}
|
|
46187
|
+
* if the back-end count is lower than the threshold. In this case, all types of filters will be applied
|
|
46188
|
+
* on the client. See also: {@link sap.ui.model.odata.OperationMode.Auto} and {@link sap.ui.model.FilterType}.
|
|
46042
46189
|
*
|
|
46043
|
-
* For the `OperationMode.Client` and `OperationMode.Auto`, you may also specify the
|
|
46044
|
-
*
|
|
46045
|
-
* and trigger an OData request.
|
|
46190
|
+
* For the `OperationMode.Client` and `OperationMode.Auto`, you may also specify the `useServersideApplicationFilters`
|
|
46191
|
+
* binding parameter when creating an instance. If it is set, the filters of type `Application` will always
|
|
46192
|
+
* be applied on the back end and trigger an OData request. For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
|
|
46046
46193
|
* See:
|
|
46047
46194
|
* sap.ui.model.TreeBinding.prototype.filter
|
|
46048
46195
|
*/
|
|
@@ -46140,8 +46287,8 @@ declare namespace sap {
|
|
|
46140
46287
|
oContext: sap.ui.model.Context
|
|
46141
46288
|
): boolean;
|
|
46142
46289
|
/**
|
|
46143
|
-
*
|
|
46144
|
-
*
|
|
46290
|
+
* Initializes the binding. Fires a refresh event once initialization is completed in case the binding is
|
|
46291
|
+
* resolved, or immediately in case it is unresolved.
|
|
46145
46292
|
*/
|
|
46146
46293
|
initialize(): sap.ui.model.odata.v2.ODataTreeBinding;
|
|
46147
46294
|
/**
|
|
@@ -46160,10 +46307,10 @@ declare namespace sap {
|
|
|
46160
46307
|
sGroupId?: string
|
|
46161
46308
|
): void;
|
|
46162
46309
|
/**
|
|
46163
|
-
* Sets the rootLevel The root level is the level of the topmost tree nodes
|
|
46310
|
+
* Sets the `rootLevel`. The root level is the level of the topmost tree nodes that will be used as an entry
|
|
46164
46311
|
* point for OData services. This is only possible (and necessary) for OData services implementing the hierarchy
|
|
46165
46312
|
* annotation specification, or when providing the annotation information locally as a binding parameter.
|
|
46166
|
-
*
|
|
46313
|
+
* For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
|
|
46167
46314
|
*/
|
|
46168
46315
|
setRootLevel(iRootLevel: int): void;
|
|
46169
46316
|
/**
|
|
@@ -47271,8 +47418,8 @@ declare namespace sap {
|
|
|
47271
47418
|
* @SINCE 1.37.0
|
|
47272
47419
|
*
|
|
47273
47420
|
* Context binding for an OData V4 model. An event handler can only be attached to this binding for the
|
|
47274
|
-
* following events: 'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested',
|
|
47275
|
-
* For other events, an error is thrown.
|
|
47421
|
+
* following events: 'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested', 'DataStateChange',
|
|
47422
|
+
* 'patchCompleted', and 'patchSent'. For other events, an error is thrown.
|
|
47276
47423
|
*
|
|
47277
47424
|
* A context binding can also be used as an operation binding to support bound actions, action imports,
|
|
47278
47425
|
* bound functions and function imports. If you want to control the execution time of an operation, for
|
|
@@ -47539,6 +47686,20 @@ declare namespace sap {
|
|
|
47539
47686
|
* Method not supported
|
|
47540
47687
|
*/
|
|
47541
47688
|
isInitial(): boolean;
|
|
47689
|
+
/**
|
|
47690
|
+
* @SINCE 1.95.0
|
|
47691
|
+
* @EXPERIMENTAL
|
|
47692
|
+
*
|
|
47693
|
+
* Moves the bound entity into the given list binding. This binding loses its data. The method may only
|
|
47694
|
+
* be called when this binding has finished loading. You can verify this by calling `oBinding.getBoundContext().requestObject()`.
|
|
47695
|
+
* If that promise resolves, the binding has finished loading.
|
|
47696
|
+
*/
|
|
47697
|
+
moveEntityTo(
|
|
47698
|
+
/**
|
|
47699
|
+
* The list binding to take the entity
|
|
47700
|
+
*/
|
|
47701
|
+
oListBinding: sap.ui.model.odata.v4.ODataListBinding
|
|
47702
|
+
): void;
|
|
47542
47703
|
/**
|
|
47543
47704
|
* @SINCE 1.37.0
|
|
47544
47705
|
*
|
|
@@ -47593,6 +47754,18 @@ declare namespace sap {
|
|
|
47593
47754
|
*/
|
|
47594
47755
|
sPath?: string
|
|
47595
47756
|
): Promise<any>;
|
|
47757
|
+
/**
|
|
47758
|
+
* @SINCE 1.87.0
|
|
47759
|
+
*
|
|
47760
|
+
* Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
|
|
47761
|
+
* #refresh} if you do not need the promise.
|
|
47762
|
+
*/
|
|
47763
|
+
requestRefresh(
|
|
47764
|
+
/**
|
|
47765
|
+
* The group ID to be used
|
|
47766
|
+
*/
|
|
47767
|
+
sGroupId?: string
|
|
47768
|
+
): Promise<any>;
|
|
47596
47769
|
/**
|
|
47597
47770
|
* @SINCE 1.40.1
|
|
47598
47771
|
*
|
|
@@ -47640,13 +47813,20 @@ declare namespace sap {
|
|
|
47640
47813
|
* #resume
|
|
47641
47814
|
*/
|
|
47642
47815
|
suspend(): void;
|
|
47816
|
+
/**
|
|
47817
|
+
* @SINCE 1.37.0
|
|
47818
|
+
*
|
|
47819
|
+
* Returns a string representation of this object including the binding path. If the binding is relative,
|
|
47820
|
+
* the parent path is also given, separated by a '|'.
|
|
47821
|
+
*/
|
|
47822
|
+
toString(): string;
|
|
47643
47823
|
}
|
|
47644
47824
|
/**
|
|
47645
47825
|
* @SINCE 1.37.0
|
|
47646
47826
|
*
|
|
47647
47827
|
* List binding for an OData V4 model. An event handler can only be attached to this binding for the following
|
|
47648
|
-
* events: 'AggregatedDataStateChange', 'change', '
|
|
47649
|
-
* 'refresh'. For other events, an error is thrown.
|
|
47828
|
+
* events: 'AggregatedDataStateChange', 'change', 'createCompleted', 'createSent', 'dataReceived', 'dataRequested',
|
|
47829
|
+
* 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an error is thrown.
|
|
47650
47830
|
*/
|
|
47651
47831
|
class ODataListBinding extends sap.ui.model.ListBinding {
|
|
47652
47832
|
constructor();
|
|
@@ -47918,6 +48098,19 @@ declare namespace sap {
|
|
|
47918
48098
|
*
|
|
47919
48099
|
* Filters are case sensitive unless the property `caseSensitive` is set to `false`. This property has to
|
|
47920
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.
|
|
47921
48114
|
* See:
|
|
47922
48115
|
* sap.ui.model.ListBinding#filter
|
|
47923
48116
|
* #setAggregation
|
|
@@ -48215,6 +48408,18 @@ declare namespace sap {
|
|
|
48215
48408
|
*/
|
|
48216
48409
|
fnFilter?: (p1: sap.ui.core.message.Message) => boolean
|
|
48217
48410
|
): Promise<sap.ui.model.Filter>;
|
|
48411
|
+
/**
|
|
48412
|
+
* @SINCE 1.87.0
|
|
48413
|
+
*
|
|
48414
|
+
* Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
|
|
48415
|
+
* #refresh} if you do not need the promise.
|
|
48416
|
+
*/
|
|
48417
|
+
requestRefresh(
|
|
48418
|
+
/**
|
|
48419
|
+
* The group ID to be used
|
|
48420
|
+
*/
|
|
48421
|
+
sGroupId?: string
|
|
48422
|
+
): Promise<any>;
|
|
48218
48423
|
/**
|
|
48219
48424
|
* @SINCE 1.40.1
|
|
48220
48425
|
*
|
|
@@ -48335,6 +48540,13 @@ declare namespace sap {
|
|
|
48335
48540
|
* #resume
|
|
48336
48541
|
*/
|
|
48337
48542
|
suspend(): void;
|
|
48543
|
+
/**
|
|
48544
|
+
* @SINCE 1.37.0
|
|
48545
|
+
*
|
|
48546
|
+
* Returns a string representation of this object including the binding path. If the binding is relative,
|
|
48547
|
+
* the parent path is also given, separated by a '|'.
|
|
48548
|
+
*/
|
|
48549
|
+
toString(): string;
|
|
48338
48550
|
/**
|
|
48339
48551
|
* @SINCE 1.53.0
|
|
48340
48552
|
*
|
|
@@ -48406,6 +48618,8 @@ declare namespace sap {
|
|
|
48406
48618
|
* not support any public events; attaching an event handler leads to an error.
|
|
48407
48619
|
*
|
|
48408
48620
|
* This model is read-only.
|
|
48621
|
+
*
|
|
48622
|
+
* This model is not prepared to be inherited from.
|
|
48409
48623
|
*/
|
|
48410
48624
|
class ODataMetaModel extends sap.ui.model.MetaModel {
|
|
48411
48625
|
constructor();
|
|
@@ -49024,6 +49238,8 @@ declare namespace sap {
|
|
|
49024
49238
|
*
|
|
49025
49239
|
* Model implementation for OData V4.
|
|
49026
49240
|
*
|
|
49241
|
+
* This model is not prepared to be inherited from.
|
|
49242
|
+
*
|
|
49027
49243
|
* Every resource path (relative to the service root URL, no query options) according to "4 Resource Path"
|
|
49028
49244
|
* in specification "OData Version 4.0 Part 2: URL Conventions" is a valid data binding path within this
|
|
49029
49245
|
* model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')" to access an entity
|
|
@@ -49247,9 +49463,8 @@ declare namespace sap {
|
|
|
49247
49463
|
$$groupId?: string;
|
|
49248
49464
|
/**
|
|
49249
49465
|
* For operation bindings only: Whether $expand and $select from the parent binding are used in the request
|
|
49250
|
-
* sent on {@link #execute}. If set to `true`, the binding must not set the $expand
|
|
49251
|
-
*
|
|
49252
|
-
* 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.
|
|
49253
49468
|
*/
|
|
49254
49469
|
$$inheritExpandSelect?: boolean;
|
|
49255
49470
|
/**
|
|
@@ -49280,7 +49495,7 @@ declare namespace sap {
|
|
|
49280
49495
|
*/
|
|
49281
49496
|
bindList(
|
|
49282
49497
|
/**
|
|
49283
|
-
* The binding path in the model; must not
|
|
49498
|
+
* The binding path in the model; must not end with a slash
|
|
49284
49499
|
*/
|
|
49285
49500
|
sPath: string,
|
|
49286
49501
|
/**
|
|
@@ -49381,8 +49596,7 @@ declare namespace sap {
|
|
|
49381
49596
|
* as a separator and splits it into two parts. The part before the separator is resolved with the binding's
|
|
49382
49597
|
* context and the result is transformed into a metadata context (see {@link sap.ui.model.odata.v4.ODataMetaModel#getMetaContext}).
|
|
49383
49598
|
* The part following the separator is then interpreted relative to this metadata context, even if it starts
|
|
49384
|
-
* with a '/';
|
|
49385
|
-
* for the effect it has.
|
|
49599
|
+
* with a '/'; see {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject} for more details.
|
|
49386
49600
|
*
|
|
49387
49601
|
* If the target type specified in the corresponding control property's binding info is "any" and the binding
|
|
49388
49602
|
* is relative or points to metadata, the binding may have an object value; in this case and unless the
|
|
@@ -49394,8 +49608,7 @@ declare namespace sap {
|
|
|
49394
49608
|
*/
|
|
49395
49609
|
bindProperty(
|
|
49396
49610
|
/**
|
|
49397
|
-
* The binding path in the model; must not
|
|
49398
|
-
* metadata.
|
|
49611
|
+
* The binding path in the model; must not end with a slash
|
|
49399
49612
|
*/
|
|
49400
49613
|
sPath: string,
|
|
49401
49614
|
/**
|
|
@@ -49404,12 +49617,14 @@ declare namespace sap {
|
|
|
49404
49617
|
oContext?: sap.ui.model.Context,
|
|
49405
49618
|
/**
|
|
49406
49619
|
* Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2:
|
|
49407
|
-
* URL Conventions" or the binding-specific
|
|
49408
|
-
*
|
|
49409
|
-
*
|
|
49410
|
-
* The
|
|
49411
|
-
*
|
|
49412
|
-
*
|
|
49620
|
+
* URL Conventions" or the binding-specific parameters as specified below. The following OData query options
|
|
49621
|
+
* are allowed:
|
|
49622
|
+
* All "5.2 Custom Query Options" except for those with a name starting with "sap-" (unless starting with
|
|
49623
|
+
* "sap-valid-") The $apply, $filter, and $search "5.1 System Query Options" if the path ends with
|
|
49624
|
+
* a "$count" segment. All other query options lead to an error. Query options specified for the binding
|
|
49625
|
+
* overwrite model query options. Note: The binding only creates its own data service request if it is absolute
|
|
49626
|
+
* or if it is relative to a context created via {@link #createBindingContext}. The binding parameters are
|
|
49627
|
+
* ignored in case the binding creates no own data service request or in case the binding points to metadata.
|
|
49413
49628
|
*/
|
|
49414
49629
|
mParameters?: {
|
|
49415
49630
|
/**
|
|
@@ -49898,6 +50113,18 @@ declare namespace sap {
|
|
|
49898
50113
|
*/
|
|
49899
50114
|
sGroupId?: string | boolean
|
|
49900
50115
|
): void;
|
|
50116
|
+
/**
|
|
50117
|
+
* @SINCE 1.87.0
|
|
50118
|
+
*
|
|
50119
|
+
* Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
|
|
50120
|
+
* #refresh} if you do not need the promise.
|
|
50121
|
+
*/
|
|
50122
|
+
requestRefresh(
|
|
50123
|
+
/**
|
|
50124
|
+
* The group ID to be used
|
|
50125
|
+
*/
|
|
50126
|
+
sGroupId?: string
|
|
50127
|
+
): Promise<any>;
|
|
49901
50128
|
/**
|
|
49902
50129
|
* @SINCE 1.69
|
|
49903
50130
|
*
|
|
@@ -49993,6 +50220,13 @@ declare namespace sap {
|
|
|
49993
50220
|
* sap.ui.model.Binding#suspend
|
|
49994
50221
|
*/
|
|
49995
50222
|
suspend(): void;
|
|
50223
|
+
/**
|
|
50224
|
+
* @SINCE 1.37.0
|
|
50225
|
+
*
|
|
50226
|
+
* Returns a string representation of this object including the binding path. If the binding is relative,
|
|
50227
|
+
* the parent path is also given, separated by a '|'.
|
|
50228
|
+
*/
|
|
50229
|
+
toString(): string;
|
|
49996
50230
|
}
|
|
49997
50231
|
/**
|
|
49998
50232
|
* Modes to control the use of batch requests for a group ID.
|
|
@@ -50392,15 +50626,15 @@ declare namespace sap {
|
|
|
50392
50626
|
*/
|
|
50393
50627
|
formatValue(
|
|
50394
50628
|
/**
|
|
50395
|
-
*
|
|
50629
|
+
* The value to format
|
|
50396
50630
|
*/
|
|
50397
50631
|
vValue: any,
|
|
50398
50632
|
/**
|
|
50399
|
-
*
|
|
50633
|
+
* The EDM type (e.g. Edm.Decimal)
|
|
50400
50634
|
*/
|
|
50401
50635
|
sType: string,
|
|
50402
50636
|
/**
|
|
50403
|
-
*
|
|
50637
|
+
* Whether strings gets compared case sensitive or not
|
|
50404
50638
|
*/
|
|
50405
50639
|
bCaseSensitive: boolean
|
|
50406
50640
|
): string;
|
|
@@ -51297,6 +51531,8 @@ declare namespace sap {
|
|
|
51297
51531
|
* V4 annotations from the existing {@link sap.ui.model.odata.ODataAnnotations} directly into the corresponding
|
|
51298
51532
|
* model element.
|
|
51299
51533
|
*
|
|
51534
|
+
* This model is not prepared to be inherited from.
|
|
51535
|
+
*
|
|
51300
51536
|
* Also, annotations from the "http://www.sap.com/Protocols/SAPData" namespace are lifted up from the `extensions`
|
|
51301
51537
|
* array and transformed from objects into simple properties with an "sap:" prefix for their name. Note
|
|
51302
51538
|
* that this happens in addition, thus the following example shows both representations. This way, such
|
|
@@ -53004,6 +53240,8 @@ declare namespace sap {
|
|
|
53004
53240
|
/**
|
|
53005
53241
|
* Model implementation for resource bundles.
|
|
53006
53242
|
*
|
|
53243
|
+
* This model is not prepared to be inherited from.
|
|
53244
|
+
*
|
|
53007
53245
|
* This model allows to bind control properties against translatable texts. Its data is taken from a {@link
|
|
53008
53246
|
* module:sap/base/i18n/ResourceBundle} and it only supports property bindings.
|
|
53009
53247
|
*
|
|
@@ -53225,7 +53463,9 @@ declare namespace sap {
|
|
|
53225
53463
|
*/
|
|
53226
53464
|
namespace xml {
|
|
53227
53465
|
/**
|
|
53228
|
-
* Model implementation for XML format
|
|
53466
|
+
* Model implementation for the XML format.
|
|
53467
|
+
*
|
|
53468
|
+
* This model is not prepared to be inherited from.
|
|
53229
53469
|
*/
|
|
53230
53470
|
class XMLModel extends sap.ui.model.ClientModel {
|
|
53231
53471
|
/**
|
|
@@ -53264,35 +53504,35 @@ declare namespace sap {
|
|
|
53264
53504
|
*/
|
|
53265
53505
|
static getMetadata(): sap.ui.base.Metadata;
|
|
53266
53506
|
/**
|
|
53267
|
-
* Returns the object for the given
|
|
53507
|
+
* Returns the object for the given path and context.
|
|
53268
53508
|
*/
|
|
53269
53509
|
getObject(
|
|
53270
53510
|
/**
|
|
53271
|
-
*
|
|
53511
|
+
* The path to the object
|
|
53272
53512
|
*/
|
|
53273
53513
|
sPath: string,
|
|
53274
53514
|
/**
|
|
53275
|
-
*
|
|
53515
|
+
* The context which will be used to retrieve the object
|
|
53276
53516
|
*/
|
|
53277
53517
|
oContext?: object
|
|
53278
|
-
):
|
|
53518
|
+
): object;
|
|
53279
53519
|
/**
|
|
53280
|
-
* Returns the value for the property with the given `sPropertyName
|
|
53520
|
+
* Returns the value for the property with the given `sPropertyName`.
|
|
53281
53521
|
*/
|
|
53282
53522
|
getProperty(
|
|
53283
53523
|
/**
|
|
53284
|
-
*
|
|
53524
|
+
* The path to the property
|
|
53285
53525
|
*/
|
|
53286
53526
|
sPath: string,
|
|
53287
53527
|
/**
|
|
53288
|
-
*
|
|
53528
|
+
* The context which will be used to retrieve the property
|
|
53289
53529
|
*/
|
|
53290
53530
|
oContext?: object
|
|
53291
|
-
):
|
|
53531
|
+
): string;
|
|
53292
53532
|
/**
|
|
53293
53533
|
* Serializes the current XML data of the model into a string.
|
|
53294
53534
|
*/
|
|
53295
|
-
getXML():
|
|
53535
|
+
getXML(): string;
|
|
53296
53536
|
/**
|
|
53297
53537
|
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the
|
|
53298
53538
|
* model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
|
|
@@ -53340,11 +53580,11 @@ declare namespace sap {
|
|
|
53340
53580
|
*/
|
|
53341
53581
|
setNameSpace(
|
|
53342
53582
|
/**
|
|
53343
|
-
*
|
|
53583
|
+
* The namespace URI
|
|
53344
53584
|
*/
|
|
53345
53585
|
sNameSpace: string,
|
|
53346
53586
|
/**
|
|
53347
|
-
*
|
|
53587
|
+
* The prefix for the namespace
|
|
53348
53588
|
*/
|
|
53349
53589
|
sPrefix?: string
|
|
53350
53590
|
): void;
|
|
@@ -53354,19 +53594,19 @@ declare namespace sap {
|
|
|
53354
53594
|
*/
|
|
53355
53595
|
setProperty(
|
|
53356
53596
|
/**
|
|
53357
|
-
*
|
|
53597
|
+
* Path of the property to set
|
|
53358
53598
|
*/
|
|
53359
53599
|
sPath: string,
|
|
53360
53600
|
/**
|
|
53361
|
-
*
|
|
53601
|
+
* Value to set the property to
|
|
53362
53602
|
*/
|
|
53363
53603
|
oValue: any,
|
|
53364
53604
|
/**
|
|
53365
|
-
*
|
|
53605
|
+
* The context which will be used to set the property
|
|
53366
53606
|
*/
|
|
53367
53607
|
oContext?: object,
|
|
53368
53608
|
/**
|
|
53369
|
-
*
|
|
53609
|
+
* Whether to update other bindings dependent on this property asynchronously
|
|
53370
53610
|
*/
|
|
53371
53611
|
bAsyncUpdate?: boolean
|
|
53372
53612
|
): boolean;
|
|
@@ -53755,8 +53995,12 @@ declare namespace sap {
|
|
|
53755
53995
|
* Returns a metadata object for class sap.ui.model.type.Date.
|
|
53756
53996
|
*/
|
|
53757
53997
|
static getMetadata(): sap.ui.base.Metadata;
|
|
53758
|
-
|
|
53759
|
-
|
|
53998
|
+
/**
|
|
53999
|
+
* Returns the output pattern.
|
|
54000
|
+
* See:
|
|
54001
|
+
* sap.ui.core.format.DateFormat.getDateInstance
|
|
54002
|
+
*/
|
|
54003
|
+
getOutputPattern(): string;
|
|
53760
54004
|
}
|
|
53761
54005
|
/**
|
|
53762
54006
|
* This class represents the Date interval composite type.
|
|
@@ -54576,18 +54820,20 @@ declare namespace sap {
|
|
|
54576
54820
|
*/
|
|
54577
54821
|
constructor(
|
|
54578
54822
|
/**
|
|
54579
|
-
*
|
|
54823
|
+
* The model
|
|
54580
54824
|
*/
|
|
54581
54825
|
oModel: sap.ui.model.Model,
|
|
54582
54826
|
/**
|
|
54583
|
-
*
|
|
54827
|
+
* The path
|
|
54584
54828
|
*/
|
|
54585
54829
|
sPath: string,
|
|
54586
54830
|
/**
|
|
54587
|
-
*
|
|
54831
|
+
* The context object
|
|
54588
54832
|
*/
|
|
54589
54833
|
oContext: sap.ui.model.Context,
|
|
54590
|
-
|
|
54834
|
+
/**
|
|
54835
|
+
* Additional, implementation-specific parameters
|
|
54836
|
+
*/
|
|
54591
54837
|
mParameters?: object
|
|
54592
54838
|
);
|
|
54593
54839
|
|
|
@@ -54625,27 +54871,27 @@ declare namespace sap {
|
|
|
54625
54871
|
*/
|
|
54626
54872
|
attachAggregatedDataStateChange(
|
|
54627
54873
|
/**
|
|
54628
|
-
* The function to be called
|
|
54874
|
+
* The function to be called when the event occurs
|
|
54629
54875
|
*/
|
|
54630
54876
|
fnFunction: Function,
|
|
54631
54877
|
/**
|
|
54632
|
-
* Context object to call the event handler with
|
|
54878
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54633
54879
|
*/
|
|
54634
54880
|
oListener?: object
|
|
54635
54881
|
): void;
|
|
54636
54882
|
/**
|
|
54637
|
-
* Attaches
|
|
54883
|
+
* Attaches the `fnFunction` event handler to the {@link #event:change change} event of this `sap.ui.model.Model`.
|
|
54638
54884
|
*
|
|
54639
54885
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
54640
54886
|
* otherwise it will be bound to this `sap.ui.model.Binding` itself.
|
|
54641
54887
|
*/
|
|
54642
54888
|
attachChange(
|
|
54643
54889
|
/**
|
|
54644
|
-
* The function to be called
|
|
54890
|
+
* The function to be called when the event occurs
|
|
54645
54891
|
*/
|
|
54646
54892
|
fnFunction: Function,
|
|
54647
54893
|
/**
|
|
54648
|
-
* Context object to call the event handler with
|
|
54894
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54649
54895
|
*/
|
|
54650
54896
|
oListener?: object
|
|
54651
54897
|
): void;
|
|
@@ -54657,11 +54903,11 @@ declare namespace sap {
|
|
|
54657
54903
|
*/
|
|
54658
54904
|
attachDataReceived(
|
|
54659
54905
|
/**
|
|
54660
|
-
* Function to be called
|
|
54906
|
+
* Function to be called when the event occurs
|
|
54661
54907
|
*/
|
|
54662
54908
|
fnFunction: Function,
|
|
54663
54909
|
/**
|
|
54664
|
-
* Context object to call the event handler with
|
|
54910
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54665
54911
|
*/
|
|
54666
54912
|
oListener?: object
|
|
54667
54913
|
): void;
|
|
@@ -54673,35 +54919,40 @@ declare namespace sap {
|
|
|
54673
54919
|
*/
|
|
54674
54920
|
attachDataRequested(
|
|
54675
54921
|
/**
|
|
54676
|
-
* The function to be called
|
|
54922
|
+
* The function to be called when the event occurs
|
|
54677
54923
|
*/
|
|
54678
54924
|
fnFunction: Function,
|
|
54679
54925
|
/**
|
|
54680
|
-
* Context object to call the event handler with
|
|
54926
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54681
54927
|
*/
|
|
54682
54928
|
oListener?: object
|
|
54683
54929
|
): void;
|
|
54684
54930
|
/**
|
|
54685
|
-
* Attaches
|
|
54686
|
-
* `sap.ui.model.Binding`.
|
|
54931
|
+
* Attaches the `fnFunction` event handler to the {@link #event:DataStateChange DataStateChange} event of
|
|
54932
|
+
* thi `sap.ui.model.Binding`.
|
|
54687
54933
|
*
|
|
54688
54934
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
54689
54935
|
* otherwise it will be bound to this `sap.ui.model.Binding` itself.
|
|
54690
54936
|
*/
|
|
54691
54937
|
attachDataStateChange(
|
|
54692
54938
|
/**
|
|
54693
|
-
* Function to be called
|
|
54939
|
+
* Function to be called when the event occurs
|
|
54694
54940
|
*/
|
|
54695
54941
|
fnFunction: Function,
|
|
54696
54942
|
/**
|
|
54697
|
-
* Context object to call the event handler with
|
|
54943
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54698
54944
|
*/
|
|
54699
54945
|
oListener?: object
|
|
54700
54946
|
): void;
|
|
54701
54947
|
/**
|
|
54702
54948
|
* Attach multiple events.
|
|
54703
54949
|
*/
|
|
54704
|
-
attachEvents(
|
|
54950
|
+
attachEvents(
|
|
54951
|
+
/**
|
|
54952
|
+
* Events to attach to this binding
|
|
54953
|
+
*/
|
|
54954
|
+
oEvents: Record<string, Function>
|
|
54955
|
+
): sap.ui.model.Binding;
|
|
54705
54956
|
/**
|
|
54706
54957
|
* Attaches event handler `fnFunction` to the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
|
|
54707
54958
|
*
|
|
@@ -54710,11 +54961,11 @@ declare namespace sap {
|
|
|
54710
54961
|
*/
|
|
54711
54962
|
attachRefresh(
|
|
54712
54963
|
/**
|
|
54713
|
-
* The function to be called
|
|
54964
|
+
* The function to be called when the event occurs
|
|
54714
54965
|
*/
|
|
54715
54966
|
fnFunction: Function,
|
|
54716
54967
|
/**
|
|
54717
|
-
* Context object to call the event handler with
|
|
54968
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54718
54969
|
*/
|
|
54719
54970
|
oListener?: object
|
|
54720
54971
|
): void;
|
|
@@ -54731,7 +54982,7 @@ declare namespace sap {
|
|
|
54731
54982
|
*/
|
|
54732
54983
|
detachAggregatedDataStateChange(
|
|
54733
54984
|
/**
|
|
54734
|
-
* The function to be called
|
|
54985
|
+
* The function to be called when the event occurs
|
|
54735
54986
|
*/
|
|
54736
54987
|
fnFunction: Function,
|
|
54737
54988
|
/**
|
|
@@ -54744,7 +54995,7 @@ declare namespace sap {
|
|
|
54744
54995
|
*/
|
|
54745
54996
|
detachChange(
|
|
54746
54997
|
/**
|
|
54747
|
-
* Function to be called
|
|
54998
|
+
* Function to be called when the event occurs
|
|
54748
54999
|
*/
|
|
54749
55000
|
fnFunction: Function,
|
|
54750
55001
|
/**
|
|
@@ -54757,7 +55008,7 @@ declare namespace sap {
|
|
|
54757
55008
|
*/
|
|
54758
55009
|
detachDataReceived(
|
|
54759
55010
|
/**
|
|
54760
|
-
* Function to be called
|
|
55011
|
+
* Function to be called when the event occurs
|
|
54761
55012
|
*/
|
|
54762
55013
|
fnFunction: Function,
|
|
54763
55014
|
/**
|
|
@@ -54771,7 +55022,7 @@ declare namespace sap {
|
|
|
54771
55022
|
*/
|
|
54772
55023
|
detachDataRequested(
|
|
54773
55024
|
/**
|
|
54774
|
-
* The function to be called
|
|
55025
|
+
* The function to be called when the event occurs
|
|
54775
55026
|
*/
|
|
54776
55027
|
fnFunction: Function,
|
|
54777
55028
|
/**
|
|
@@ -54785,7 +55036,7 @@ declare namespace sap {
|
|
|
54785
55036
|
*/
|
|
54786
55037
|
detachDataStateChange(
|
|
54787
55038
|
/**
|
|
54788
|
-
* The function to be called
|
|
55039
|
+
* The function to be called when the event occurs
|
|
54789
55040
|
*/
|
|
54790
55041
|
fnFunction: Function,
|
|
54791
55042
|
/**
|
|
@@ -54796,17 +55047,22 @@ declare namespace sap {
|
|
|
54796
55047
|
/**
|
|
54797
55048
|
* Detach multiple events.
|
|
54798
55049
|
*/
|
|
54799
|
-
detachEvents(
|
|
55050
|
+
detachEvents(
|
|
55051
|
+
/**
|
|
55052
|
+
* Events to detach from this binding
|
|
55053
|
+
*/
|
|
55054
|
+
oEvents: Record<string, Function>
|
|
55055
|
+
): sap.ui.model.Binding;
|
|
54800
55056
|
/**
|
|
54801
55057
|
* Detaches event handler `fnFunction` from the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
|
|
54802
55058
|
*/
|
|
54803
55059
|
detachRefresh(
|
|
54804
55060
|
/**
|
|
54805
|
-
* The function to be called
|
|
55061
|
+
* The function to be called when the event occurs
|
|
54806
55062
|
*/
|
|
54807
55063
|
fnFunction: Function,
|
|
54808
55064
|
/**
|
|
54809
|
-
*
|
|
55065
|
+
* Object on which to call the given function.
|
|
54810
55066
|
*/
|
|
54811
55067
|
oListener?: object
|
|
54812
55068
|
): void;
|
|
@@ -54817,11 +55073,11 @@ declare namespace sap {
|
|
|
54817
55073
|
*/
|
|
54818
55074
|
fireDataReceived(
|
|
54819
55075
|
/**
|
|
54820
|
-
* Parameters to pass along with the event
|
|
55076
|
+
* Parameters to pass along with the event
|
|
54821
55077
|
*/
|
|
54822
55078
|
oParameters: {
|
|
54823
55079
|
/**
|
|
54824
|
-
* Data received
|
|
55080
|
+
* Data received; on error cases it will be undefined
|
|
54825
55081
|
*/
|
|
54826
55082
|
data?: object;
|
|
54827
55083
|
}
|
|
@@ -54831,7 +55087,7 @@ declare namespace sap {
|
|
|
54831
55087
|
*/
|
|
54832
55088
|
fireDataRequested(
|
|
54833
55089
|
/**
|
|
54834
|
-
* Parameters to pass along with the event
|
|
55090
|
+
* Parameters to pass along with the event
|
|
54835
55091
|
*/
|
|
54836
55092
|
oParameters: object
|
|
54837
55093
|
): void;
|
|
@@ -54877,11 +55133,11 @@ declare namespace sap {
|
|
|
54877
55133
|
*/
|
|
54878
55134
|
initialize(): void;
|
|
54879
55135
|
/**
|
|
54880
|
-
* 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.
|
|
54881
55137
|
*/
|
|
54882
55138
|
isInitial(): boolean;
|
|
54883
55139
|
/**
|
|
54884
|
-
* 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.
|
|
54885
55141
|
*/
|
|
54886
55142
|
isRelative(): boolean;
|
|
54887
55143
|
/**
|
|
@@ -54914,8 +55170,8 @@ declare namespace sap {
|
|
|
54914
55170
|
/**
|
|
54915
55171
|
* Resumes the binding update. Change events will be fired again.
|
|
54916
55172
|
*
|
|
54917
|
-
* When the binding is resumed, a change event will be fired immediately
|
|
54918
|
-
*
|
|
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
|
|
54919
55175
|
* was requested while the binding was suspended.
|
|
54920
55176
|
*/
|
|
54921
55177
|
resume(): void;
|
|
@@ -55363,9 +55619,9 @@ declare namespace sap {
|
|
|
55363
55619
|
*/
|
|
55364
55620
|
sort(
|
|
55365
55621
|
/**
|
|
55366
|
-
* array of Sorter instances which will be applied
|
|
55622
|
+
* An array of Sorter instances which will be applied
|
|
55367
55623
|
*/
|
|
55368
|
-
|
|
55624
|
+
aSorters: sap.ui.model.Sorter[]
|
|
55369
55625
|
): this;
|
|
55370
55626
|
}
|
|
55371
55627
|
|
|
@@ -55381,7 +55637,7 @@ declare namespace sap {
|
|
|
55381
55637
|
*
|
|
55382
55638
|
* A `CompositeBinding` combines the values from all its binding parts (each an instance of `PropertyBinding`),
|
|
55383
55639
|
* either by calling a formatter function or by involving a {@link sap.ui.model.CompositeType composite
|
|
55384
|
-
* type}. When a formatter function is used,
|
|
55640
|
+
* type}. When a formatter function is used, the composite binding is automatically limited to `OneWay`
|
|
55385
55641
|
* mode. When a type is used, the binding can also operate in `TwoWay` mode.
|
|
55386
55642
|
*
|
|
55387
55643
|
* Higher layers of the framework derive composite bindings from easy-to-write string representations (the
|
|
@@ -55447,7 +55703,7 @@ declare namespace sap {
|
|
|
55447
55703
|
*/
|
|
55448
55704
|
fnFunction: Function,
|
|
55449
55705
|
/**
|
|
55450
|
-
*
|
|
55706
|
+
* Object on which to call the given function
|
|
55451
55707
|
*/
|
|
55452
55708
|
oListener?: object
|
|
55453
55709
|
): void;
|
|
@@ -55463,7 +55719,7 @@ declare namespace sap {
|
|
|
55463
55719
|
*/
|
|
55464
55720
|
fnFunction: Function,
|
|
55465
55721
|
/**
|
|
55466
|
-
*
|
|
55722
|
+
* Object on which to call the given function
|
|
55467
55723
|
*/
|
|
55468
55724
|
oListener?: object
|
|
55469
55725
|
): void;
|
|
@@ -55479,7 +55735,7 @@ declare namespace sap {
|
|
|
55479
55735
|
*/
|
|
55480
55736
|
fnFunction: Function,
|
|
55481
55737
|
/**
|
|
55482
|
-
*
|
|
55738
|
+
* Object on which to call the given function
|
|
55483
55739
|
*/
|
|
55484
55740
|
oListener?: object
|
|
55485
55741
|
): void;
|
|
@@ -55492,7 +55748,7 @@ declare namespace sap {
|
|
|
55492
55748
|
*/
|
|
55493
55749
|
fnFunction: Function,
|
|
55494
55750
|
/**
|
|
55495
|
-
*
|
|
55751
|
+
* Object on which to call the given function
|
|
55496
55752
|
*/
|
|
55497
55753
|
oListener?: object
|
|
55498
55754
|
): void;
|
|
@@ -55505,7 +55761,7 @@ declare namespace sap {
|
|
|
55505
55761
|
*/
|
|
55506
55762
|
fnFunction: Function,
|
|
55507
55763
|
/**
|
|
55508
|
-
*
|
|
55764
|
+
* Object on which to call the given function
|
|
55509
55765
|
*/
|
|
55510
55766
|
oListener?: object
|
|
55511
55767
|
): void;
|
|
@@ -55518,7 +55774,7 @@ declare namespace sap {
|
|
|
55518
55774
|
*/
|
|
55519
55775
|
fnFunction: Function,
|
|
55520
55776
|
/**
|
|
55521
|
-
*
|
|
55777
|
+
* Object on which to call the given function
|
|
55522
55778
|
*/
|
|
55523
55779
|
oListener?: object
|
|
55524
55780
|
): void;
|
|
@@ -55532,12 +55788,12 @@ declare namespace sap {
|
|
|
55532
55788
|
getExternalValue(): object;
|
|
55533
55789
|
/**
|
|
55534
55790
|
* Returns the current internal value of the bound target which is an array of the internal (JS native)
|
|
55535
|
-
* values of nested bindings
|
|
55791
|
+
* values of nested bindings.
|
|
55536
55792
|
*/
|
|
55537
55793
|
getInternalValue(): any[];
|
|
55538
55794
|
/**
|
|
55539
55795
|
* Returns the current raw value of the bound target which is an array of the raw (model) values of nested
|
|
55540
|
-
* bindings
|
|
55796
|
+
* bindings.
|
|
55541
55797
|
*/
|
|
55542
55798
|
getRawValue(): any[];
|
|
55543
55799
|
/**
|
|
@@ -55546,10 +55802,10 @@ declare namespace sap {
|
|
|
55546
55802
|
getValue(): object;
|
|
55547
55803
|
/**
|
|
55548
55804
|
* Initialize the binding. The method should be called when creating a binding. The default implementation
|
|
55549
|
-
* calls checkUpdate(true). Prevent checkUpdate to be triggered while initializing
|
|
55550
|
-
*
|
|
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.
|
|
55551
55807
|
*/
|
|
55552
|
-
initialize():
|
|
55808
|
+
initialize(): this;
|
|
55553
55809
|
/**
|
|
55554
55810
|
* Suspends the binding update. No change events will be fired.
|
|
55555
55811
|
*
|
|
@@ -55560,12 +55816,12 @@ declare namespace sap {
|
|
|
55560
55816
|
resume(): void;
|
|
55561
55817
|
/**
|
|
55562
55818
|
* Sets the external value of a composite binding. If no CompositeType is assigned to the binding, the default
|
|
55563
|
-
* implementation assumes a space
|
|
55819
|
+
* implementation assumes a space-separated list of values. This will cause the setValue to be called for
|
|
55564
55820
|
* each nested binding, except for undefined values in the array.
|
|
55565
55821
|
*/
|
|
55566
55822
|
setExternalValue(
|
|
55567
55823
|
/**
|
|
55568
|
-
*
|
|
55824
|
+
* The value to set for this binding
|
|
55569
55825
|
*/
|
|
55570
55826
|
oValue: object
|
|
55571
55827
|
): undefined | Promise<any>;
|
|
@@ -55578,7 +55834,7 @@ declare namespace sap {
|
|
|
55578
55834
|
* the new values of the nested bindings
|
|
55579
55835
|
*/
|
|
55580
55836
|
aValues: any[]
|
|
55581
|
-
):
|
|
55837
|
+
): undefined | Promise<any>;
|
|
55582
55838
|
/**
|
|
55583
55839
|
* Sets the raw value of the bound target. Parameter must be an array of values matching the raw (model)
|
|
55584
55840
|
* types of nested bindings.
|
|
@@ -55588,7 +55844,7 @@ declare namespace sap {
|
|
|
55588
55844
|
* the new values of the nested bindings
|
|
55589
55845
|
*/
|
|
55590
55846
|
aValues: any[]
|
|
55591
|
-
):
|
|
55847
|
+
): undefined | Promise<any>;
|
|
55592
55848
|
/**
|
|
55593
55849
|
* Sets the optional type and internal type for the binding. The type and internal type are used to do the
|
|
55594
55850
|
* parsing/formatting correctly. The internal type is the property type of the element which the value is
|
|
@@ -55596,11 +55852,11 @@ declare namespace sap {
|
|
|
55596
55852
|
*/
|
|
55597
55853
|
setType(
|
|
55598
55854
|
/**
|
|
55599
|
-
*
|
|
55855
|
+
* The type for the binding
|
|
55600
55856
|
*/
|
|
55601
55857
|
oType: sap.ui.model.CompositeType,
|
|
55602
55858
|
/**
|
|
55603
|
-
*
|
|
55859
|
+
* The internal type of the element property which this binding is bound against.
|
|
55604
55860
|
*/
|
|
55605
55861
|
sInternalType: string
|
|
55606
55862
|
): void;
|
|
@@ -55610,7 +55866,7 @@ declare namespace sap {
|
|
|
55610
55866
|
*/
|
|
55611
55867
|
setValue(
|
|
55612
55868
|
/**
|
|
55613
|
-
*
|
|
55869
|
+
* The values to set for this binding
|
|
55614
55870
|
*/
|
|
55615
55871
|
aValues: any[]
|
|
55616
55872
|
): void;
|
|
@@ -56202,17 +56458,19 @@ declare namespace sap {
|
|
|
56202
56458
|
* You either pass a single object literal with the filter parameters or use the individual constructor
|
|
56203
56459
|
* arguments. No matter which variant is used, only certain combinations of parameters are supported (the
|
|
56204
56460
|
* following list uses the names from the object literal):
|
|
56205
|
-
*
|
|
56206
|
-
*
|
|
56207
|
-
*
|
|
56208
|
-
*
|
|
56209
|
-
*
|
|
56210
|
-
*
|
|
56211
|
-
*
|
|
56212
|
-
*
|
|
56213
|
-
*
|
|
56214
|
-
*
|
|
56215
|
-
*
|
|
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.
|
|
56216
56474
|
*/
|
|
56217
56475
|
constructor(
|
|
56218
56476
|
/**
|
|
@@ -56225,15 +56483,19 @@ declare namespace sap {
|
|
|
56225
56483
|
*/
|
|
56226
56484
|
path?: string;
|
|
56227
56485
|
/**
|
|
56228
|
-
* Function
|
|
56229
|
-
*
|
|
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.
|
|
56230
56489
|
*/
|
|
56231
|
-
test?:
|
|
56490
|
+
test?: (p1: any) => boolean;
|
|
56232
56491
|
/**
|
|
56233
|
-
* Function
|
|
56234
|
-
*
|
|
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.
|
|
56235
56497
|
*/
|
|
56236
|
-
comparator?:
|
|
56498
|
+
comparator?: (p1: any, p2: any) => number;
|
|
56237
56499
|
/**
|
|
56238
56500
|
* Operator used for the filter
|
|
56239
56501
|
*/
|
|
@@ -56243,44 +56505,52 @@ declare namespace sap {
|
|
|
56243
56505
|
*/
|
|
56244
56506
|
value1?: any;
|
|
56245
56507
|
/**
|
|
56246
|
-
* Second value to use with the filter operator
|
|
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
|
|
56247
56510
|
*/
|
|
56248
56511
|
value2?: any;
|
|
56249
56512
|
/**
|
|
56250
|
-
* The variable used in lambda operators (
|
|
56513
|
+
* The variable name used in lambda operators ({@link sap.ui.model.FilterOperator.Any "Any"} and {@link
|
|
56514
|
+
* sap.ui.model.FilterOperator.All "All"})
|
|
56251
56515
|
*/
|
|
56252
56516
|
variable?: string;
|
|
56253
56517
|
/**
|
|
56254
|
-
* A
|
|
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"})
|
|
56255
56520
|
*/
|
|
56256
56521
|
condition?: sap.ui.model.Filter;
|
|
56257
56522
|
/**
|
|
56258
|
-
*
|
|
56523
|
+
* An array of filters on which the logical conjunction is applied
|
|
56259
56524
|
*/
|
|
56260
56525
|
filters?: sap.ui.model.Filter[];
|
|
56261
56526
|
/**
|
|
56262
56527
|
* Indicates whether an "AND" logical conjunction is applied on the filters. If it's not set or set to `false`,
|
|
56263
|
-
* an "OR" conjunction is applied
|
|
56528
|
+
* an "OR" conjunction is applied.
|
|
56264
56529
|
*/
|
|
56265
56530
|
and?: boolean;
|
|
56266
56531
|
/**
|
|
56267
|
-
* 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.
|
|
56268
56534
|
*/
|
|
56269
56535
|
caseSensitive?: boolean;
|
|
56270
56536
|
}
|
|
56271
56537
|
| string
|
|
56272
56538
|
| sap.ui.model.Filter[],
|
|
56273
56539
|
/**
|
|
56274
|
-
* Either a filter operator or a custom filter function or a
|
|
56275
|
-
* filters
|
|
56540
|
+
* Either a filter operator or a custom filter function or a `boolean` flag that defines how to combine
|
|
56541
|
+
* multiple filters
|
|
56276
56542
|
*/
|
|
56277
|
-
vOperator?:
|
|
56543
|
+
vOperator?:
|
|
56544
|
+
| sap.ui.model.FilterOperator
|
|
56545
|
+
| ((p1: any) => boolean)
|
|
56546
|
+
| boolean,
|
|
56278
56547
|
/**
|
|
56279
56548
|
* First value to use with the given filter operator
|
|
56280
56549
|
*/
|
|
56281
56550
|
vValue1?: any,
|
|
56282
56551
|
/**
|
|
56283
|
-
* Second value to use with the given filter operator
|
|
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
|
|
56284
56554
|
*/
|
|
56285
56555
|
vValue2?: any
|
|
56286
56556
|
);
|
|
@@ -56288,7 +56558,7 @@ declare namespace sap {
|
|
|
56288
56558
|
/**
|
|
56289
56559
|
* Compares two values
|
|
56290
56560
|
*
|
|
56291
|
-
* This is the default comparator function used for
|
|
56561
|
+
* This is the default comparator function used for client-side filtering, if no custom comparator is given
|
|
56292
56562
|
* in the constructor. It does compare just by using equal/less than/greater than with automatic type casting,
|
|
56293
56563
|
* except for null values, which are neither less or greater, and string values where localeCompare is used.
|
|
56294
56564
|
*
|
|
@@ -56303,7 +56573,7 @@ declare namespace sap {
|
|
|
56303
56573
|
* the second value to compare
|
|
56304
56574
|
*/
|
|
56305
56575
|
b: any
|
|
56306
|
-
):
|
|
56576
|
+
): number;
|
|
56307
56577
|
/**
|
|
56308
56578
|
* Creates a new subclass of class sap.ui.model.Filter with name `sClassName` and enriches it with the information
|
|
56309
56579
|
* contained in `oClassInfo`.
|
|
@@ -56329,6 +56599,83 @@ declare namespace sap {
|
|
|
56329
56599
|
* Returns a metadata object for class sap.ui.model.Filter.
|
|
56330
56600
|
*/
|
|
56331
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;
|
|
56332
56679
|
}
|
|
56333
56680
|
/**
|
|
56334
56681
|
* Instances of this exception are thrown when converting a model value to its representation on the UI
|
|
@@ -56423,7 +56770,7 @@ declare namespace sap {
|
|
|
56423
56770
|
*/
|
|
56424
56771
|
fnFunction: Function,
|
|
56425
56772
|
/**
|
|
56426
|
-
* Context object to call the event handler with
|
|
56773
|
+
* Context object to call the event handler with; defaults to this `ListBinding` itself
|
|
56427
56774
|
*/
|
|
56428
56775
|
oListener?: object
|
|
56429
56776
|
): void;
|
|
@@ -56442,7 +56789,7 @@ declare namespace sap {
|
|
|
56442
56789
|
*/
|
|
56443
56790
|
fnFunction: Function,
|
|
56444
56791
|
/**
|
|
56445
|
-
* Context object to call the event handler with
|
|
56792
|
+
* Context object to call the event handler with; defaults to this `ListBinding` itself
|
|
56446
56793
|
*/
|
|
56447
56794
|
oListener?: object
|
|
56448
56795
|
): void;
|
|
@@ -56457,7 +56804,7 @@ declare namespace sap {
|
|
|
56457
56804
|
*/
|
|
56458
56805
|
fnFunction: Function,
|
|
56459
56806
|
/**
|
|
56460
|
-
*
|
|
56807
|
+
* On which object the given function had to be called
|
|
56461
56808
|
*/
|
|
56462
56809
|
oListener?: object
|
|
56463
56810
|
): void;
|
|
@@ -56513,7 +56860,11 @@ declare namespace sap {
|
|
|
56513
56860
|
* The path of the property containing the key or a function getting the context as only parameter to calculate
|
|
56514
56861
|
* a key to identify an entry
|
|
56515
56862
|
*/
|
|
56516
|
-
vKey: Function | string
|
|
56863
|
+
vKey: Function | string,
|
|
56864
|
+
/**
|
|
56865
|
+
* The configuration for the change detection
|
|
56866
|
+
*/
|
|
56867
|
+
oExtendedChangeDetectionConfig: object
|
|
56517
56868
|
): void;
|
|
56518
56869
|
/**
|
|
56519
56870
|
* Applies a new set of filters to the list represented by this binding.
|
|
@@ -56522,18 +56873,18 @@ declare namespace sap {
|
|
|
56522
56873
|
* a server and it might execute asynchronously.
|
|
56523
56874
|
*
|
|
56524
56875
|
* Application and Control Filters: Each list binding maintains two separate lists of filters, one for filters
|
|
56525
|
-
* 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
|
|
56526
56877
|
* in addition. When executing the filter operation, both sets of filters are combined.
|
|
56527
56878
|
*
|
|
56528
|
-
* By using the
|
|
56879
|
+
* By using the `sFilterType` parameter of the `filter` method, the caller can control which set of filters
|
|
56529
56880
|
* is modified. If no type is given, then the behavior depends on the model implementation and should be
|
|
56530
56881
|
* documented in the API reference for that model.
|
|
56531
56882
|
*
|
|
56532
56883
|
* Auto-Grouping of Filters: Filters are first grouped according to their binding path. All filters belonging
|
|
56533
|
-
* to the same
|
|
56534
|
-
* filters applied to
|
|
56535
|
-
*
|
|
56536
|
-
*
|
|
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.
|
|
56537
56888
|
*/
|
|
56538
56889
|
filter(
|
|
56539
56890
|
/**
|
|
@@ -56562,22 +56913,22 @@ declare namespace sap {
|
|
|
56562
56913
|
*/
|
|
56563
56914
|
getContexts(
|
|
56564
56915
|
/**
|
|
56565
|
-
*
|
|
56916
|
+
* The startIndex where to start the retrieval of contexts
|
|
56566
56917
|
*/
|
|
56567
56918
|
iStartIndex?: int,
|
|
56568
56919
|
/**
|
|
56569
|
-
*
|
|
56920
|
+
* Determines how many contexts to retrieve beginning from the start index.
|
|
56570
56921
|
*/
|
|
56571
56922
|
iLength?: int,
|
|
56572
56923
|
/**
|
|
56573
56924
|
* The maximum number of contexts to read before and after the given range; with this, controls can prefetch
|
|
56574
|
-
* data that is likely to be needed soon, e.g. when scrolling down in a table
|
|
56575
|
-
* 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
|
|
56576
56927
|
*/
|
|
56577
56928
|
iMaximumPrefetchSize?: int,
|
|
56578
56929
|
/**
|
|
56579
56930
|
* Whether this call keeps the result of {@link #getCurrentContexts} untouched; since 1.86.0. This parameter
|
|
56580
|
-
* is model-specific and not implemented by all models
|
|
56931
|
+
* is model-specific and not implemented by all models
|
|
56581
56932
|
*/
|
|
56582
56933
|
bKeepCurrent?: boolean
|
|
56583
56934
|
): sap.ui.model.Context[];
|
|
@@ -56599,7 +56950,7 @@ declare namespace sap {
|
|
|
56599
56950
|
*
|
|
56600
56951
|
* Returns an array of currently used binding contexts of the bound control.
|
|
56601
56952
|
*
|
|
56602
|
-
* This method does not trigger any data requests from the
|
|
56953
|
+
* This method does not trigger any data requests from the back end or a delta calculation, but just returns
|
|
56603
56954
|
* the context array as last requested by the control. This can be used by the application to get access
|
|
56604
56955
|
* to the data currently displayed by a list control.
|
|
56605
56956
|
*/
|
|
@@ -56613,6 +56964,17 @@ declare namespace sap {
|
|
|
56613
56964
|
*/
|
|
56614
56965
|
sPath: string
|
|
56615
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[];
|
|
56616
56978
|
/**
|
|
56617
56979
|
* Gets the group for the given context. Must only be called if `isGrouped()` returns that grouping is enabled
|
|
56618
56980
|
* for this binding. The grouping will be performed using the first sorter (in case multiple sorters are
|
|
@@ -56636,8 +56998,8 @@ declare namespace sap {
|
|
|
56636
56998
|
*/
|
|
56637
56999
|
getLength(): int;
|
|
56638
57000
|
/**
|
|
56639
|
-
* Indicates whether grouping is enabled for the binding. Grouping is enabled for a list binding
|
|
56640
|
-
*
|
|
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.
|
|
56641
57003
|
*/
|
|
56642
57004
|
isGrouped(): boolean;
|
|
56643
57005
|
/**
|
|
@@ -56674,7 +57036,7 @@ declare namespace sap {
|
|
|
56674
57036
|
* Instead of a single sorter also an array of sorters can be passed to the sort method. In this case they
|
|
56675
57037
|
* are processed in the sequence in which they are contained in the array.
|
|
56676
57038
|
*
|
|
56677
|
-
* Grouping: Sorting and grouping are closely related
|
|
57039
|
+
* Grouping: Sorting and grouping are closely related. In case a list should be grouped, it must be sorted
|
|
56678
57040
|
* by the property to group with. Grouping is enabled by setting the `group` property on the sorter object.
|
|
56679
57041
|
* If it is enabled, you can get the current group of an item using {@link sap.ui.model.ListBinding.prototype.getGroup}.
|
|
56680
57042
|
* In case multiple sorters are provided, grouping can only be done on the first sorter, nested grouping
|
|
@@ -56682,7 +57044,7 @@ declare namespace sap {
|
|
|
56682
57044
|
*/
|
|
56683
57045
|
sort(
|
|
56684
57046
|
/**
|
|
56685
|
-
*
|
|
57047
|
+
* The Sorter object or an array of sorters which defines the sort order
|
|
56686
57048
|
*/
|
|
56687
57049
|
aSorters: sap.ui.model.Sorter | any[]
|
|
56688
57050
|
): this;
|
|
@@ -56772,7 +57134,7 @@ declare namespace sap {
|
|
|
56772
57134
|
*/
|
|
56773
57135
|
oData: object,
|
|
56774
57136
|
/**
|
|
56775
|
-
* The function to be called
|
|
57137
|
+
* The function to be called when the event occurs
|
|
56776
57138
|
*/
|
|
56777
57139
|
fnFunction: Function,
|
|
56778
57140
|
/**
|
|
@@ -56788,7 +57150,7 @@ declare namespace sap {
|
|
|
56788
57150
|
*/
|
|
56789
57151
|
attachParseError(
|
|
56790
57152
|
/**
|
|
56791
|
-
* The function to be called
|
|
57153
|
+
* The function to be called when the event occurs
|
|
56792
57154
|
*/
|
|
56793
57155
|
fnFunction: Function,
|
|
56794
57156
|
/**
|
|
@@ -56810,7 +57172,7 @@ declare namespace sap {
|
|
|
56810
57172
|
*/
|
|
56811
57173
|
oData: object,
|
|
56812
57174
|
/**
|
|
56813
|
-
* The function to be called
|
|
57175
|
+
* The function to be called when the event occurs
|
|
56814
57176
|
*/
|
|
56815
57177
|
fnFunction: Function,
|
|
56816
57178
|
/**
|
|
@@ -56827,7 +57189,7 @@ declare namespace sap {
|
|
|
56827
57189
|
*/
|
|
56828
57190
|
attachPropertyChange(
|
|
56829
57191
|
/**
|
|
56830
|
-
* The function to be called
|
|
57192
|
+
* The function to be called when the event occurs
|
|
56831
57193
|
*/
|
|
56832
57194
|
fnFunction: Function,
|
|
56833
57195
|
/**
|
|
@@ -56849,7 +57211,7 @@ declare namespace sap {
|
|
|
56849
57211
|
*/
|
|
56850
57212
|
oData: object,
|
|
56851
57213
|
/**
|
|
56852
|
-
* The function to be called
|
|
57214
|
+
* The function to be called when the event occurs
|
|
56853
57215
|
*/
|
|
56854
57216
|
fnFunction: Function,
|
|
56855
57217
|
/**
|
|
@@ -56866,7 +57228,7 @@ declare namespace sap {
|
|
|
56866
57228
|
*/
|
|
56867
57229
|
attachRequestCompleted(
|
|
56868
57230
|
/**
|
|
56869
|
-
* The function to be called
|
|
57231
|
+
* The function to be called when the event occurs
|
|
56870
57232
|
*/
|
|
56871
57233
|
fnFunction: Function,
|
|
56872
57234
|
/**
|
|
@@ -56887,7 +57249,7 @@ declare namespace sap {
|
|
|
56887
57249
|
*/
|
|
56888
57250
|
oData: object,
|
|
56889
57251
|
/**
|
|
56890
|
-
* The function to be called
|
|
57252
|
+
* The function to be called when the event occurs
|
|
56891
57253
|
*/
|
|
56892
57254
|
fnFunction: Function,
|
|
56893
57255
|
/**
|
|
@@ -56903,7 +57265,7 @@ declare namespace sap {
|
|
|
56903
57265
|
*/
|
|
56904
57266
|
attachRequestFailed(
|
|
56905
57267
|
/**
|
|
56906
|
-
* The function to be called
|
|
57268
|
+
* The function to be called when the event occurs
|
|
56907
57269
|
*/
|
|
56908
57270
|
fnFunction: Function,
|
|
56909
57271
|
/**
|
|
@@ -56924,7 +57286,7 @@ declare namespace sap {
|
|
|
56924
57286
|
*/
|
|
56925
57287
|
oData: object,
|
|
56926
57288
|
/**
|
|
56927
|
-
* The function to be called
|
|
57289
|
+
* The function to be called when the event occurs
|
|
56928
57290
|
*/
|
|
56929
57291
|
fnFunction: Function,
|
|
56930
57292
|
/**
|
|
@@ -56940,7 +57302,7 @@ declare namespace sap {
|
|
|
56940
57302
|
*/
|
|
56941
57303
|
attachRequestSent(
|
|
56942
57304
|
/**
|
|
56943
|
-
* The function to be called
|
|
57305
|
+
* The function to be called when the event occurs
|
|
56944
57306
|
*/
|
|
56945
57307
|
fnFunction: Function,
|
|
56946
57308
|
/**
|
|
@@ -56953,111 +57315,103 @@ declare namespace sap {
|
|
|
56953
57315
|
*/
|
|
56954
57316
|
bindContext(
|
|
56955
57317
|
/**
|
|
56956
|
-
*
|
|
57318
|
+
* The path pointing to the property that should be bound
|
|
56957
57319
|
*/
|
|
56958
57320
|
sPath: string,
|
|
56959
57321
|
/**
|
|
56960
|
-
*
|
|
57322
|
+
* The context object for this databinding
|
|
56961
57323
|
*/
|
|
56962
57324
|
oContext?: sap.ui.model.Context,
|
|
56963
57325
|
/**
|
|
56964
|
-
*
|
|
57326
|
+
* Additional model-specific parameters
|
|
56965
57327
|
*/
|
|
56966
57328
|
mParameters?: object,
|
|
56967
57329
|
/**
|
|
56968
|
-
*
|
|
57330
|
+
* Event handlers can be passed to the binding ({change:myHandler})
|
|
56969
57331
|
*/
|
|
56970
57332
|
oEvents?: object
|
|
56971
57333
|
): sap.ui.model.ContextBinding;
|
|
56972
|
-
|
|
56973
|
-
* Implement in inheriting classes.
|
|
56974
|
-
*/
|
|
57334
|
+
|
|
56975
57335
|
bindList(
|
|
56976
57336
|
/**
|
|
56977
|
-
*
|
|
57337
|
+
* The path pointing to the list / array that should be bound
|
|
56978
57338
|
*/
|
|
56979
57339
|
sPath: string,
|
|
56980
57340
|
/**
|
|
56981
|
-
*
|
|
57341
|
+
* The context object for this databinding
|
|
56982
57342
|
*/
|
|
56983
57343
|
oContext?: sap.ui.model.Context,
|
|
56984
57344
|
/**
|
|
56985
|
-
*
|
|
57345
|
+
* Initial sort order (can be either a sorter or an array of sorters)
|
|
56986
57346
|
*/
|
|
56987
57347
|
aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
|
|
56988
57348
|
/**
|
|
56989
|
-
*
|
|
57349
|
+
* Predefined filter/s (can be either a filter or an array of filters)
|
|
56990
57350
|
*/
|
|
56991
57351
|
aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
|
|
56992
57352
|
/**
|
|
56993
|
-
*
|
|
57353
|
+
* Additional model-specific parameters
|
|
56994
57354
|
*/
|
|
56995
57355
|
mParameters?: object
|
|
56996
57356
|
): sap.ui.model.ListBinding;
|
|
56997
|
-
|
|
56998
|
-
* Implement in inheriting classes.
|
|
56999
|
-
*/
|
|
57357
|
+
|
|
57000
57358
|
bindProperty(
|
|
57001
57359
|
/**
|
|
57002
|
-
*
|
|
57360
|
+
* The path pointing to the property that should be bound
|
|
57003
57361
|
*/
|
|
57004
57362
|
sPath: string,
|
|
57005
57363
|
/**
|
|
57006
|
-
*
|
|
57364
|
+
* The context object for this databinding
|
|
57007
57365
|
*/
|
|
57008
57366
|
oContext?: sap.ui.model.Context,
|
|
57009
57367
|
/**
|
|
57010
|
-
*
|
|
57368
|
+
* Additional model-specific parameters
|
|
57011
57369
|
*/
|
|
57012
57370
|
mParameters?: object
|
|
57013
57371
|
): sap.ui.model.PropertyBinding;
|
|
57014
|
-
|
|
57015
|
-
* Implement in inheriting classes.
|
|
57016
|
-
*/
|
|
57372
|
+
|
|
57017
57373
|
bindTree(
|
|
57018
57374
|
/**
|
|
57019
|
-
*
|
|
57375
|
+
* The path pointing to the tree / array that should be bound
|
|
57020
57376
|
*/
|
|
57021
57377
|
sPath: string,
|
|
57022
57378
|
/**
|
|
57023
|
-
*
|
|
57379
|
+
* The context object for this databinding
|
|
57024
57380
|
*/
|
|
57025
57381
|
oContext?: sap.ui.model.Context,
|
|
57026
57382
|
/**
|
|
57027
|
-
*
|
|
57383
|
+
* Predefined filter/s contained in an array
|
|
57028
57384
|
*/
|
|
57029
57385
|
aFilters?: sap.ui.model.Filter[],
|
|
57030
57386
|
/**
|
|
57031
|
-
*
|
|
57387
|
+
* Additional model specific parameters
|
|
57032
57388
|
*/
|
|
57033
57389
|
mParameters?: object,
|
|
57034
57390
|
/**
|
|
57035
|
-
*
|
|
57391
|
+
* Predefined sap.ui.model.sorter/s contained in an array
|
|
57036
57392
|
*/
|
|
57037
57393
|
aSorters?: sap.ui.model.Sorter[]
|
|
57038
57394
|
): sap.ui.model.TreeBinding;
|
|
57039
|
-
|
|
57040
|
-
* Implement in inheriting classes.
|
|
57041
|
-
*/
|
|
57395
|
+
|
|
57042
57396
|
createBindingContext(
|
|
57043
57397
|
/**
|
|
57044
|
-
*
|
|
57398
|
+
* The path to create the new context from
|
|
57045
57399
|
*/
|
|
57046
57400
|
sPath: string,
|
|
57047
57401
|
/**
|
|
57048
|
-
*
|
|
57402
|
+
* The context which should be used to create the new binding context
|
|
57049
57403
|
*/
|
|
57050
57404
|
oContext?: sap.ui.model.Context,
|
|
57051
57405
|
/**
|
|
57052
|
-
*
|
|
57406
|
+
* The parameters used to create the new binding context
|
|
57053
57407
|
*/
|
|
57054
57408
|
mParameters?: object,
|
|
57055
57409
|
/**
|
|
57056
|
-
*
|
|
57410
|
+
* The function which should be called after the binding context has been created
|
|
57057
57411
|
*/
|
|
57058
57412
|
fnCallBack?: Function,
|
|
57059
57413
|
/**
|
|
57060
|
-
*
|
|
57414
|
+
* Force reload even if data is already available; for server-side models this should refetch the data from
|
|
57061
57415
|
* the server
|
|
57062
57416
|
*/
|
|
57063
57417
|
bReload?: boolean
|
|
@@ -57065,18 +57419,16 @@ declare namespace sap {
|
|
|
57065
57419
|
/**
|
|
57066
57420
|
* Destroys the model and clears the model data.
|
|
57067
57421
|
*
|
|
57068
|
-
* A model implementation may override this function and perform model
|
|
57422
|
+
* A model implementation may override this function and perform model-specific cleanup tasks e.g. abort
|
|
57069
57423
|
* requests, prevent new requests, etc.
|
|
57070
57424
|
* See:
|
|
57071
57425
|
* sap.ui.base.Object.prototype.destroy
|
|
57072
57426
|
*/
|
|
57073
57427
|
destroy(): void;
|
|
57074
|
-
|
|
57075
|
-
* Implement in inheriting classes.
|
|
57076
|
-
*/
|
|
57428
|
+
|
|
57077
57429
|
destroyBindingContext(
|
|
57078
57430
|
/**
|
|
57079
|
-
* to destroy
|
|
57431
|
+
* The context to destroy
|
|
57080
57432
|
*/
|
|
57081
57433
|
oContext: sap.ui.model.Context
|
|
57082
57434
|
): void;
|
|
@@ -57087,7 +57439,7 @@ declare namespace sap {
|
|
|
57087
57439
|
*/
|
|
57088
57440
|
detachParseError(
|
|
57089
57441
|
/**
|
|
57090
|
-
* The function to be called
|
|
57442
|
+
* The function to be called when the event occurs
|
|
57091
57443
|
*/
|
|
57092
57444
|
fnFunction: Function,
|
|
57093
57445
|
/**
|
|
@@ -57103,7 +57455,7 @@ declare namespace sap {
|
|
|
57103
57455
|
*/
|
|
57104
57456
|
detachPropertyChange(
|
|
57105
57457
|
/**
|
|
57106
|
-
* The function to be called
|
|
57458
|
+
* The function to be called when the event occurs
|
|
57107
57459
|
*/
|
|
57108
57460
|
fnFunction: Function,
|
|
57109
57461
|
/**
|
|
@@ -57135,7 +57487,7 @@ declare namespace sap {
|
|
|
57135
57487
|
*/
|
|
57136
57488
|
detachRequestFailed(
|
|
57137
57489
|
/**
|
|
57138
|
-
* The function to be called
|
|
57490
|
+
* The function to be called when the event occurs
|
|
57139
57491
|
*/
|
|
57140
57492
|
fnFunction: Function,
|
|
57141
57493
|
/**
|
|
@@ -57198,11 +57550,11 @@ declare namespace sap {
|
|
|
57198
57550
|
*/
|
|
57199
57551
|
path?: string;
|
|
57200
57552
|
/**
|
|
57201
|
-
*
|
|
57553
|
+
* The context of the property
|
|
57202
57554
|
*/
|
|
57203
57555
|
context?: object;
|
|
57204
57556
|
/**
|
|
57205
|
-
*
|
|
57557
|
+
* The value of the property
|
|
57206
57558
|
*/
|
|
57207
57559
|
value?: object;
|
|
57208
57560
|
}
|
|
@@ -57216,7 +57568,7 @@ declare namespace sap {
|
|
|
57216
57568
|
*/
|
|
57217
57569
|
oParameters?: {
|
|
57218
57570
|
/**
|
|
57219
|
-
* The url which was sent to the
|
|
57571
|
+
* The url which was sent to the back end.
|
|
57220
57572
|
*/
|
|
57221
57573
|
url?: string;
|
|
57222
57574
|
/**
|
|
@@ -57258,7 +57610,7 @@ declare namespace sap {
|
|
|
57258
57610
|
*/
|
|
57259
57611
|
statusText?: string;
|
|
57260
57612
|
/**
|
|
57261
|
-
* Response that has been received for the request
|
|
57613
|
+
* Response that has been received for the request, as a text string
|
|
57262
57614
|
*/
|
|
57263
57615
|
responseText?: string;
|
|
57264
57616
|
}
|
|
@@ -57272,7 +57624,7 @@ declare namespace sap {
|
|
|
57272
57624
|
*/
|
|
57273
57625
|
oParameters?: {
|
|
57274
57626
|
/**
|
|
57275
|
-
* The url which is sent to the
|
|
57627
|
+
* The url which is sent to the back end.
|
|
57276
57628
|
*/
|
|
57277
57629
|
url?: string;
|
|
57278
57630
|
/**
|
|
@@ -57284,7 +57636,7 @@ declare namespace sap {
|
|
|
57284
57636
|
*/
|
|
57285
57637
|
async?: boolean;
|
|
57286
57638
|
/**
|
|
57287
|
-
*
|
|
57639
|
+
* Additional information for the request (if available) **deprecated**
|
|
57288
57640
|
*/
|
|
57289
57641
|
info?: string;
|
|
57290
57642
|
/**
|
|
@@ -57329,9 +57681,7 @@ declare namespace sap {
|
|
|
57329
57681
|
* Returns the meta model associated with this model if it is available for the concrete model type.
|
|
57330
57682
|
*/
|
|
57331
57683
|
getMetaModel(): sap.ui.model.MetaModel;
|
|
57332
|
-
|
|
57333
|
-
* Implement in inheriting classes.
|
|
57334
|
-
*/
|
|
57684
|
+
|
|
57335
57685
|
getObject(
|
|
57336
57686
|
/**
|
|
57337
57687
|
* Path to where to read the object
|
|
@@ -57342,7 +57692,7 @@ declare namespace sap {
|
|
|
57342
57692
|
*/
|
|
57343
57693
|
oContext?: sap.ui.model.Context,
|
|
57344
57694
|
/**
|
|
57345
|
-
* Additional model
|
|
57695
|
+
* Additional model-specific parameters
|
|
57346
57696
|
*/
|
|
57347
57697
|
mParameters?: object
|
|
57348
57698
|
): any;
|
|
@@ -57361,16 +57711,14 @@ declare namespace sap {
|
|
|
57361
57711
|
*/
|
|
57362
57712
|
oContext?: sap.ui.model.Context
|
|
57363
57713
|
): any;
|
|
57364
|
-
|
|
57365
|
-
* Implement in inheriting classes.
|
|
57366
|
-
*/
|
|
57714
|
+
|
|
57367
57715
|
getProperty(
|
|
57368
57716
|
/**
|
|
57369
|
-
*
|
|
57717
|
+
* The path to where to read the attribute value
|
|
57370
57718
|
*/
|
|
57371
57719
|
sPath: string,
|
|
57372
57720
|
/**
|
|
57373
|
-
*
|
|
57721
|
+
* The context with which the path should be resolved
|
|
57374
57722
|
*/
|
|
57375
57723
|
oContext?: sap.ui.model.Context
|
|
57376
57724
|
): any;
|
|
@@ -57511,7 +57859,7 @@ declare namespace sap {
|
|
|
57511
57859
|
*/
|
|
57512
57860
|
static getMetadata(): sap.ui.base.Metadata;
|
|
57513
57861
|
/**
|
|
57514
|
-
* Returns the binding mode
|
|
57862
|
+
* Returns the binding mode.
|
|
57515
57863
|
*/
|
|
57516
57864
|
getBindingMode(): sap.ui.model.BindingMode;
|
|
57517
57865
|
/**
|
|
@@ -57519,7 +57867,7 @@ declare namespace sap {
|
|
|
57519
57867
|
*/
|
|
57520
57868
|
getExternalValue(): any;
|
|
57521
57869
|
/**
|
|
57522
|
-
* Returns the formatter function
|
|
57870
|
+
* Returns the formatter function.
|
|
57523
57871
|
*/
|
|
57524
57872
|
getFormatter(): Function;
|
|
57525
57873
|
/**
|
|
@@ -57527,21 +57875,21 @@ declare namespace sap {
|
|
|
57527
57875
|
* model format} of this binding's type. If this binding doesn't have a type, the original value which is
|
|
57528
57876
|
* stored in the model is returned.
|
|
57529
57877
|
*
|
|
57530
|
-
* This method will be used when targetType
|
|
57878
|
+
* This method will be used when targetType is set to "internal" or when it's included in a {@link sap.ui.model.CompositeBinding
|
|
57531
57879
|
* CompositeBinding} and the CompositeBinding needs to have the related JavaScript primitive values for
|
|
57532
57880
|
* its type or formatter.
|
|
57533
57881
|
*/
|
|
57534
57882
|
getInternalValue(): any;
|
|
57535
57883
|
/**
|
|
57536
|
-
* 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.
|
|
57537
57885
|
*
|
|
57538
|
-
* This method will be used when targetType of a binding is set to "raw" or it's
|
|
57539
|
-
* CompositeBinding} and the CompositeBinding needs to have the related JavaScript
|
|
57540
|
-
* 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.
|
|
57541
57889
|
*/
|
|
57542
57890
|
getRawValue(): any;
|
|
57543
57891
|
/**
|
|
57544
|
-
* Returns the type if any for the binding.
|
|
57892
|
+
* Returns the type (if any) for the binding.
|
|
57545
57893
|
*/
|
|
57546
57894
|
getType(): sap.ui.model.Type;
|
|
57547
57895
|
/**
|
|
@@ -57556,22 +57904,22 @@ declare namespace sap {
|
|
|
57556
57904
|
*/
|
|
57557
57905
|
resume(): void;
|
|
57558
57906
|
/**
|
|
57559
|
-
* Sets the binding mode
|
|
57907
|
+
* Sets the binding mode.
|
|
57560
57908
|
*/
|
|
57561
57909
|
setBindingMode(
|
|
57562
57910
|
/**
|
|
57563
|
-
*
|
|
57911
|
+
* The binding mode
|
|
57564
57912
|
*/
|
|
57565
57913
|
sBindingMode: sap.ui.model.BindingMode
|
|
57566
57914
|
): void;
|
|
57567
57915
|
/**
|
|
57568
57916
|
* Sets the value for this binding. The value is parsed and validated against its type and then set to the
|
|
57569
57917
|
* binding. A model implementation should check if the current default binding mode permits setting the
|
|
57570
|
-
* binding value and if so set the new value
|
|
57918
|
+
* binding value, and if so, set the new value in the model, too.
|
|
57571
57919
|
*/
|
|
57572
57920
|
setExternalValue(
|
|
57573
57921
|
/**
|
|
57574
|
-
*
|
|
57922
|
+
* The value to set for this binding
|
|
57575
57923
|
*/
|
|
57576
57924
|
vValue: any
|
|
57577
57925
|
): undefined | Promise<any>;
|
|
@@ -57580,7 +57928,7 @@ declare namespace sap {
|
|
|
57580
57928
|
*/
|
|
57581
57929
|
setFormatter(
|
|
57582
57930
|
/**
|
|
57583
|
-
*
|
|
57931
|
+
* The formatter function for the binding
|
|
57584
57932
|
*/
|
|
57585
57933
|
fnFormatter: Function
|
|
57586
57934
|
): void;
|
|
@@ -57591,20 +57939,20 @@ declare namespace sap {
|
|
|
57591
57939
|
*/
|
|
57592
57940
|
setInternalValue(
|
|
57593
57941
|
/**
|
|
57594
|
-
*
|
|
57942
|
+
* The value to set for this binding
|
|
57595
57943
|
*/
|
|
57596
57944
|
vValue: any
|
|
57597
|
-
):
|
|
57945
|
+
): Promise<any> | undefined;
|
|
57598
57946
|
/**
|
|
57599
57947
|
* Sets the value for this binding with the raw model value. This setter will perform type validation, in
|
|
57600
57948
|
* case a type is defined on the binding.
|
|
57601
57949
|
*/
|
|
57602
57950
|
setRawValue(
|
|
57603
57951
|
/**
|
|
57604
|
-
*
|
|
57952
|
+
* The value to set for this binding
|
|
57605
57953
|
*/
|
|
57606
57954
|
vValue: any
|
|
57607
|
-
):
|
|
57955
|
+
): Promise<any> | undefined;
|
|
57608
57956
|
/**
|
|
57609
57957
|
* Sets the optional type and internal type for the binding. The type and internal type are used to do the
|
|
57610
57958
|
* parsing/formatting correctly. The internal type is the property type of the element which the value is
|
|
@@ -57612,17 +57960,17 @@ declare namespace sap {
|
|
|
57612
57960
|
*/
|
|
57613
57961
|
setType(
|
|
57614
57962
|
/**
|
|
57615
|
-
*
|
|
57963
|
+
* The type for the binding
|
|
57616
57964
|
*/
|
|
57617
57965
|
oType: sap.ui.model.Type,
|
|
57618
57966
|
/**
|
|
57619
|
-
*
|
|
57967
|
+
* The internal type of the element property which this binding is bound against.
|
|
57620
57968
|
*/
|
|
57621
57969
|
sInternalType: string
|
|
57622
57970
|
): void;
|
|
57623
57971
|
/**
|
|
57624
57972
|
* Sets the value for this binding. A model implementation should check if the current default binding mode
|
|
57625
|
-
* permits setting the binding value and if so set the new value
|
|
57973
|
+
* permits setting the binding value, and if so, set the new value in the model, too.
|
|
57626
57974
|
*/
|
|
57627
57975
|
setValue(
|
|
57628
57976
|
/**
|
|
@@ -58332,18 +58680,18 @@ declare namespace sap {
|
|
|
58332
58680
|
* @deprecated (since 1.52) - This method is marked as 'protected' which was meant to be overwritten by
|
|
58333
58681
|
* its subclasses. It may be renamed or deleted and should only be called from this class or its subclasses.
|
|
58334
58682
|
*
|
|
58335
|
-
* Calculate the request length based on the given information
|
|
58683
|
+
* Calculate the request length based on the given information.
|
|
58336
58684
|
*/
|
|
58337
58685
|
_calculateRequestLength(
|
|
58338
58686
|
/**
|
|
58339
|
-
*
|
|
58687
|
+
* The maximum group size
|
|
58340
58688
|
*/
|
|
58341
|
-
iMaxGroupSize:
|
|
58689
|
+
iMaxGroupSize: number,
|
|
58342
58690
|
/**
|
|
58343
|
-
*
|
|
58691
|
+
* The information of the current section
|
|
58344
58692
|
*/
|
|
58345
58693
|
oSection: object
|
|
58346
|
-
):
|
|
58694
|
+
): number;
|
|
58347
58695
|
/**
|
|
58348
58696
|
* Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of
|
|
58349
58697
|
* this `sap.ui.model.TreeBindingAdapter`.
|
|
@@ -58442,6 +58790,10 @@ declare namespace sap {
|
|
|
58442
58790
|
*/
|
|
58443
58791
|
iThreshold?: number
|
|
58444
58792
|
): sap.ui.model.Context[];
|
|
58793
|
+
/**
|
|
58794
|
+
* Returns the number of entries in the tree.
|
|
58795
|
+
*/
|
|
58796
|
+
getLength(): number;
|
|
58445
58797
|
/**
|
|
58446
58798
|
* Gets an array of nodes for the requested part of the tree.
|
|
58447
58799
|
*/
|
|
@@ -58460,7 +58812,9 @@ declare namespace sap {
|
|
|
58460
58812
|
iThreshold?: number
|
|
58461
58813
|
): object[];
|
|
58462
58814
|
}
|
|
58463
|
-
|
|
58815
|
+
/**
|
|
58816
|
+
* @deprecated - use {@link sap.ui.model.TreeBindingAdapter} instead
|
|
58817
|
+
*/
|
|
58464
58818
|
class TreeBindingCompatibilityAdapter {
|
|
58465
58819
|
/**
|
|
58466
58820
|
* Adapter for TreeBindings to add the ListBinding functionality and use the tree structure in list based
|
|
@@ -58468,7 +58822,16 @@ declare namespace sap {
|
|
|
58468
58822
|
*
|
|
58469
58823
|
* This module is only for experimental and internal use!
|
|
58470
58824
|
*/
|
|
58471
|
-
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
|
+
);
|
|
58472
58835
|
}
|
|
58473
58836
|
/**
|
|
58474
58837
|
* This is an abstract base class for type objects.
|
|
@@ -59526,11 +59889,13 @@ declare namespace sap {
|
|
|
59526
59889
|
/**
|
|
59527
59890
|
* Provides a basic categorization of the used device based on various indicators.
|
|
59528
59891
|
*
|
|
59529
|
-
* These indicators are for example the support of touch events, the
|
|
59530
|
-
*
|
|
59892
|
+
* These indicators are, for example, the support of touch events, the used operating system, and the user
|
|
59893
|
+
* agent of the browser.
|
|
59531
59894
|
*
|
|
59532
|
-
* **Note:**
|
|
59533
|
-
*
|
|
59895
|
+
* **Note:** There is no easy way to precisely determine the used device from the information provided by
|
|
59896
|
+
* the browser. We therefore rely especially on the user agent. In combination with given device capabilities,
|
|
59897
|
+
* it is therefore possible that multiple flags are set to `true`. This is mostly the case for desktop devices
|
|
59898
|
+
* with touch capability, and for mobile devices requesting web pages as desktop pages.
|
|
59534
59899
|
*/
|
|
59535
59900
|
namespace system {
|
|
59536
59901
|
/**
|
|
@@ -59538,9 +59903,7 @@ declare namespace sap {
|
|
|
59538
59903
|
*
|
|
59539
59904
|
* Furthermore, a CSS class `sap-combi` is added to the document root element.
|
|
59540
59905
|
*
|
|
59541
|
-
* **Note:** This property is
|
|
59542
|
-
* touch event may be supported natively by the browser being used. This property is set to `true` only
|
|
59543
|
-
* when both mouse and touch event are natively supported.
|
|
59906
|
+
* **Note:** This property is set to `true` only when both a desktop and a mobile device is detected.
|
|
59544
59907
|
*/
|
|
59545
59908
|
export const combi: boolean;
|
|
59546
59909
|
|
|
@@ -59548,6 +59911,10 @@ declare namespace sap {
|
|
|
59548
59911
|
* If this flag is set to `true`, the device is recognized as a desktop system.
|
|
59549
59912
|
*
|
|
59550
59913
|
* Furthermore, a CSS class `sap-desktop` is added to the document root element.
|
|
59914
|
+
*
|
|
59915
|
+
* **Note:** This flag is by default also true for Safari on iPads running on iOS 13 or higher. The end
|
|
59916
|
+
* user can change this behavior by disabling "Request Desktop Website -> All websites" within the iOS settings.
|
|
59917
|
+
* See also the documentation for {@link sap.ui.Device.system.combi} devices.
|
|
59551
59918
|
*/
|
|
59552
59919
|
export const desktop: boolean;
|
|
59553
59920
|
|
|
@@ -59555,6 +59922,10 @@ declare namespace sap {
|
|
|
59555
59922
|
* If this flag is set to `true`, the device is recognized as a phone.
|
|
59556
59923
|
*
|
|
59557
59924
|
* Furthermore, a CSS class `sap-phone` is added to the document root element.
|
|
59925
|
+
*
|
|
59926
|
+
* **Note:** In case a phone requests a web page as a "Desktop Page", it is possible that all properties
|
|
59927
|
+
* except `Device.system.phone` are set to `true`. In this case it is not possible to differentiate between
|
|
59928
|
+
* tablet and phone relying on the user agent.
|
|
59558
59929
|
*/
|
|
59559
59930
|
export const phone: boolean;
|
|
59560
59931
|
|
|
@@ -59563,9 +59934,9 @@ declare namespace sap {
|
|
|
59563
59934
|
*
|
|
59564
59935
|
* Furthermore, a CSS class `sap-tablet` is added to the document root element.
|
|
59565
59936
|
*
|
|
59566
|
-
* **Note:** This flag is also true for some browsers on desktop devices
|
|
59567
|
-
*
|
|
59568
|
-
*
|
|
59937
|
+
* **Note:** This flag is also `true` for some browsers running on desktop devices. See the documentation
|
|
59938
|
+
* for {@link sap.ui.Device.system.combi} devices. You can use the following logic to ensure that the current
|
|
59939
|
+
* device is a tablet device:
|
|
59569
59940
|
*
|
|
59570
59941
|
*
|
|
59571
59942
|
* ```javascript
|
|
@@ -59744,11 +60115,26 @@ declare namespace sap {
|
|
|
59744
60115
|
* sap.ui.test.actions.Drop} action.
|
|
59745
60116
|
*
|
|
59746
60117
|
* The `Drag` action targets the DOM focus reference of the control.
|
|
59747
|
-
*
|
|
59748
|
-
* The `Drag` action is not supported in IE11!
|
|
59749
60118
|
*/
|
|
59750
60119
|
class Drag extends sap.ui.test.actions.Action {
|
|
59751
|
-
constructor(
|
|
60120
|
+
constructor(
|
|
60121
|
+
/**
|
|
60122
|
+
* Optional object with initial settings for the new instance
|
|
60123
|
+
*/
|
|
60124
|
+
mSettings?: sap.ui.test.actions.$DragSettings
|
|
60125
|
+
);
|
|
60126
|
+
|
|
60127
|
+
constructor(
|
|
60128
|
+
/**
|
|
60129
|
+
* Optional ID for the new instance; generated automatically if no non-empty ID is given. Note: this can
|
|
60130
|
+
* be omitted, no matter whether `mSettings` are given or not!
|
|
60131
|
+
*/
|
|
60132
|
+
sId?: string,
|
|
60133
|
+
/**
|
|
60134
|
+
* Optional object with initial settings for the new instance
|
|
60135
|
+
*/
|
|
60136
|
+
mSettings?: sap.ui.test.actions.$DragSettings
|
|
60137
|
+
);
|
|
59752
60138
|
|
|
59753
60139
|
/**
|
|
59754
60140
|
* Creates a new subclass of class sap.ui.test.actions.Drag with name `sClassName` and enriches it with
|
|
@@ -59789,8 +60175,6 @@ declare namespace sap {
|
|
|
59789
60175
|
* by specifying its ID suffix. You can do this by directly passing the ID suffix to the Drop constructor,
|
|
59790
60176
|
* or by defining a control adapter function. You can also set the traget to be the root DOM element of
|
|
59791
60177
|
* a given aggregation, by specifying the aggregation name in the Drop constructor.
|
|
59792
|
-
*
|
|
59793
|
-
* * The `Drop` action is not supported in IE11!
|
|
59794
60178
|
*/
|
|
59795
60179
|
class Drop extends sap.ui.test.actions.Action {
|
|
59796
60180
|
/**
|
|
@@ -59798,7 +60182,28 @@ declare namespace sap {
|
|
|
59798
60182
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
59799
60183
|
* of the syntax of the settings object.
|
|
59800
60184
|
*/
|
|
59801
|
-
constructor(
|
|
60185
|
+
constructor(
|
|
60186
|
+
/**
|
|
60187
|
+
* Optional object with initial settings for the new instance
|
|
60188
|
+
*/
|
|
60189
|
+
mSettings?: sap.ui.test.actions.$DropSettings
|
|
60190
|
+
);
|
|
60191
|
+
/**
|
|
60192
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
60193
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
60194
|
+
* of the syntax of the settings object.
|
|
60195
|
+
*/
|
|
60196
|
+
constructor(
|
|
60197
|
+
/**
|
|
60198
|
+
* Optional ID for the new instance; generated automatically if no non-empty ID is given. Note: this can
|
|
60199
|
+
* be omitted, no matter whether `mSettings` are given or not!
|
|
60200
|
+
*/
|
|
60201
|
+
sId?: string,
|
|
60202
|
+
/**
|
|
60203
|
+
* Optional object with initial settings for the new instance
|
|
60204
|
+
*/
|
|
60205
|
+
mSettings?: sap.ui.test.actions.$DropSettings
|
|
60206
|
+
);
|
|
59802
60207
|
|
|
59803
60208
|
/**
|
|
59804
60209
|
* Creates a new subclass of class sap.ui.test.actions.Drop with name `sClassName` and enriches it with
|
|
@@ -59909,7 +60314,28 @@ declare namespace sap {
|
|
|
59909
60314
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
59910
60315
|
* of the syntax of the settings object.
|
|
59911
60316
|
*/
|
|
59912
|
-
constructor(
|
|
60317
|
+
constructor(
|
|
60318
|
+
/**
|
|
60319
|
+
* Optional object with initial settings for the new instance
|
|
60320
|
+
*/
|
|
60321
|
+
mSettings?: sap.ui.test.actions.$EnterTextSettings
|
|
60322
|
+
);
|
|
60323
|
+
/**
|
|
60324
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
60325
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
60326
|
+
* of the syntax of the settings object.
|
|
60327
|
+
*/
|
|
60328
|
+
constructor(
|
|
60329
|
+
/**
|
|
60330
|
+
* Optional ID for the new instance; generated automatically if no non-empty ID is given. Note: this can
|
|
60331
|
+
* be omitted, no matter whether `mSettings` are given or not!
|
|
60332
|
+
*/
|
|
60333
|
+
sId?: string,
|
|
60334
|
+
/**
|
|
60335
|
+
* Optional object with initial settings for the new instance
|
|
60336
|
+
*/
|
|
60337
|
+
mSettings?: sap.ui.test.actions.$EnterTextSettings
|
|
60338
|
+
);
|
|
59913
60339
|
|
|
59914
60340
|
/**
|
|
59915
60341
|
* Creates a new subclass of class sap.ui.test.actions.EnterText with name `sClassName` and enriches it
|
|
@@ -60055,7 +60481,24 @@ declare namespace sap {
|
|
|
60055
60481
|
* see {@link sap.ui.test.actions.Press.controlAdapters}.
|
|
60056
60482
|
*/
|
|
60057
60483
|
class Press extends sap.ui.test.actions.Action {
|
|
60058
|
-
constructor(
|
|
60484
|
+
constructor(
|
|
60485
|
+
/**
|
|
60486
|
+
* Optional object with initial settings for the new instance
|
|
60487
|
+
*/
|
|
60488
|
+
mSettings?: sap.ui.test.actions.$PressSettings
|
|
60489
|
+
);
|
|
60490
|
+
|
|
60491
|
+
constructor(
|
|
60492
|
+
/**
|
|
60493
|
+
* Optional ID for the new instance; generated automatically if no non-empty ID is given. Note: this can
|
|
60494
|
+
* be omitted, no matter whether `mSettings` are given or not!
|
|
60495
|
+
*/
|
|
60496
|
+
sId?: string,
|
|
60497
|
+
/**
|
|
60498
|
+
* Optional object with initial settings for the new instance
|
|
60499
|
+
*/
|
|
60500
|
+
mSettings?: sap.ui.test.actions.$PressSettings
|
|
60501
|
+
);
|
|
60059
60502
|
|
|
60060
60503
|
/**
|
|
60061
60504
|
* Creates a new subclass of class sap.ui.test.actions.Press with name `sClassName` and enriches it with
|
|
@@ -60106,7 +60549,28 @@ declare namespace sap {
|
|
|
60106
60549
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
60107
60550
|
* of the syntax of the settings object.
|
|
60108
60551
|
*/
|
|
60109
|
-
constructor(
|
|
60552
|
+
constructor(
|
|
60553
|
+
/**
|
|
60554
|
+
* Optional object with initial settings for the new instance
|
|
60555
|
+
*/
|
|
60556
|
+
mSettings?: sap.ui.test.actions.$ScrollSettings
|
|
60557
|
+
);
|
|
60558
|
+
/**
|
|
60559
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
60560
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
60561
|
+
* of the syntax of the settings object.
|
|
60562
|
+
*/
|
|
60563
|
+
constructor(
|
|
60564
|
+
/**
|
|
60565
|
+
* Optional ID for the new instance; generated automatically if no non-empty ID is given. Note: this can
|
|
60566
|
+
* be omitted, no matter whether `mSettings` are given or not!
|
|
60567
|
+
*/
|
|
60568
|
+
sId?: string,
|
|
60569
|
+
/**
|
|
60570
|
+
* Optional object with initial settings for the new instance
|
|
60571
|
+
*/
|
|
60572
|
+
mSettings?: sap.ui.test.actions.$ScrollSettings
|
|
60573
|
+
);
|
|
60110
60574
|
|
|
60111
60575
|
/**
|
|
60112
60576
|
* Creates a new subclass of class sap.ui.test.actions.Scroll with name `sClassName` and enriches it with
|
|
@@ -60572,6 +61036,13 @@ declare namespace sap {
|
|
|
60572
61036
|
* The name of the {@link sap.ui.model.resource.ResourceModel} assigned to the control.
|
|
60573
61037
|
*/
|
|
60574
61038
|
modelName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
61039
|
+
|
|
61040
|
+
/**
|
|
61041
|
+
* The boolean flag to indicate whether to utiliize the library bundle of the control
|
|
61042
|
+
*/
|
|
61043
|
+
useLibraryBundle?:
|
|
61044
|
+
| boolean
|
|
61045
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
60575
61046
|
}
|
|
60576
61047
|
|
|
60577
61048
|
interface $InteractableSettings
|
|
@@ -61247,7 +61718,8 @@ declare namespace sap {
|
|
|
61247
61718
|
* The I18NText matcher checks if a control property has the same value as a text from an I18N file.
|
|
61248
61719
|
*
|
|
61249
61720
|
* The matcher automatically:
|
|
61250
|
-
* - retrieves the text from the assigned 'i18n' model (name can be changed)
|
|
61721
|
+
* - retrieves the text from the assigned 'i18n' model (name can be changed) or library resource bundle
|
|
61722
|
+
*
|
|
61251
61723
|
* - checks that the I18N key does actually exist in the file
|
|
61252
61724
|
* - checks if asynchronously loaded I18N have actually been loaded
|
|
61253
61725
|
*
|
|
@@ -61262,6 +61734,10 @@ declare namespace sap {
|
|
|
61262
61734
|
* }
|
|
61263
61735
|
* }
|
|
61264
61736
|
* ```
|
|
61737
|
+
*
|
|
61738
|
+
*
|
|
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.
|
|
61265
61741
|
*/
|
|
61266
61742
|
class I18NText extends sap.ui.test.matchers.Matcher {
|
|
61267
61743
|
/**
|
|
@@ -61327,6 +61803,12 @@ declare namespace sap {
|
|
|
61327
61803
|
* The name of the control property to match the I18N text with.
|
|
61328
61804
|
*/
|
|
61329
61805
|
getPropertyName(): string;
|
|
61806
|
+
/**
|
|
61807
|
+
* Gets current value of property {@link #getUseLibraryBundle useLibraryBundle}.
|
|
61808
|
+
*
|
|
61809
|
+
* The boolean flag to indicate whether to utiliize the library bundle of the control
|
|
61810
|
+
*/
|
|
61811
|
+
getUseLibraryBundle(): boolean;
|
|
61330
61812
|
/**
|
|
61331
61813
|
* Checks if the control has a property that matches the I18N text
|
|
61332
61814
|
*/
|
|
@@ -61390,6 +61872,19 @@ declare namespace sap {
|
|
|
61390
61872
|
*/
|
|
61391
61873
|
sPropertyName: string
|
|
61392
61874
|
): this;
|
|
61875
|
+
/**
|
|
61876
|
+
* Sets a new value for property {@link #getUseLibraryBundle useLibraryBundle}.
|
|
61877
|
+
*
|
|
61878
|
+
* The boolean flag to indicate whether to utiliize the library bundle of the control
|
|
61879
|
+
*
|
|
61880
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
61881
|
+
*/
|
|
61882
|
+
setUseLibraryBundle(
|
|
61883
|
+
/**
|
|
61884
|
+
* New value for property `useLibraryBundle`
|
|
61885
|
+
*/
|
|
61886
|
+
bUseLibraryBundle: boolean
|
|
61887
|
+
): this;
|
|
61393
61888
|
}
|
|
61394
61889
|
/**
|
|
61395
61890
|
* @SINCE 1.34
|
|
@@ -64363,6 +64858,8 @@ declare namespace sap {
|
|
|
64363
64858
|
|
|
64364
64859
|
"sap/base/strings/hyphenate": undefined;
|
|
64365
64860
|
|
|
64861
|
+
"sap/base/strings/whitespaceReplacer": undefined;
|
|
64862
|
+
|
|
64366
64863
|
"sap/base/util/array/diff": undefined;
|
|
64367
64864
|
|
|
64368
64865
|
"sap/base/util/array/uniqueSort": undefined;
|