@sapui5/ts-types 1.94.1 → 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/index.d.ts +3 -2
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.esh.search.ui.d.ts +235 -1
- package/types/sap.f.d.ts +310 -40
- package/types/sap.fe.common.d.ts +1 -1
- package/types/sap.fe.core.d.ts +102 -1
- package/types/{sap.fe.macros.d.ts → sap.fe.macros-1.96.0-d.ts} +36 -12
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.placeholder-1.96.0-d.ts +3 -0
- package/types/sap.fe.plugins.d.ts +1 -1
- package/types/sap.fe.semantics.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +2 -2
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +1106 -44
- package/types/sap.landvisz.d.ts +1 -1
- package/types/sap.m.d.ts +643 -115
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +21 -29
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.grid.d.ts +635 -0
- package/types/sap.suite.ui.commons.d.ts +177 -3
- package/types/sap.suite.ui.generic.template.d.ts +49 -6
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +41 -12
- package/types/sap.ui.codeeditor.d.ts +29 -31
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +149 -18
- package/types/sap.ui.core.d.ts +708 -332
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +119 -69
- package/types/sap.ui.fl.d.ts +3 -1
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +232 -1
- package/types/sap.ui.layout.d.ts +19 -1
- package/types/sap.ui.mdc.d.ts +51 -1
- package/types/sap.ui.richtexteditor.d.ts +1 -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 +7 -4
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +140 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +793 -130
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +2 -1
- package/types/sap.ushell.d.ts +69 -49
- package/types/sap.ushell_abap.d.ts +2 -2
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +49 -34
- package/types/sap.fe.placeholder.d.ts +0 -3
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.3
|
|
268
268
|
|
|
269
269
|
declare module "sap/base/assert" {
|
|
270
270
|
/**
|
|
@@ -14927,6 +14927,11 @@ declare namespace sap {
|
|
|
14927
14927
|
* #byId}, elements or controls can be found with their view-local ID. Also see {@link topic:91f28be26f4d1014b6dd926db0e91070
|
|
14928
14928
|
* "Support for Unique IDs"} in the documentation.
|
|
14929
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
|
+
*
|
|
14930
14935
|
* View Definition: A view can be defined by {@link sap.ui.core.mvc.View.extend extending} this class and
|
|
14931
14936
|
* implementing the {@link #createContent} method. The method must return one or many root controls that
|
|
14932
14937
|
* will be rendered as content of the view.
|
|
@@ -16039,11 +16044,14 @@ declare namespace sap {
|
|
|
16039
16044
|
*/
|
|
16040
16045
|
interface Parameters {
|
|
16041
16046
|
/**
|
|
16042
|
-
*
|
|
16043
|
-
* usage of this API has been deprecated and only the asynchronous usage should still be used
|
|
16044
|
-
* bullet point and the code examples below).
|
|
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).
|
|
16045
16050
|
*
|
|
16051
|
+
* The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
|
|
16052
|
+
* API calls for the same parameter name will always result in the same parameter value.
|
|
16046
16053
|
*
|
|
16054
|
+
* The following API variants are available (see also the below examples):
|
|
16047
16055
|
* - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
|
|
16048
16056
|
* returned
|
|
16049
16057
|
* - **(deprecated since 1.94)** If a `string` is given as first parameter the value is returned as a
|
|
@@ -16054,8 +16062,9 @@ declare namespace sap {
|
|
|
16054
16062
|
* are loaded and available or within the callback in case not all CSS files are already loaded. This is
|
|
16055
16063
|
* the **only asynchronous** API variant. This variant is the preferred way to retrieve theming parameters.
|
|
16056
16064
|
* The structure of the return value is the same as listed above depending on the type of the name property
|
|
16057
|
-
* within the `object`.
|
|
16058
|
-
*
|
|
16065
|
+
* within the `object`.
|
|
16066
|
+
*
|
|
16067
|
+
* The returned key-value maps are a copy so changing values in the map does not have any effect
|
|
16059
16068
|
*
|
|
16060
16069
|
* Please see the examples below for a detailed guide on how to use the **asynchronous variant** of
|
|
16061
16070
|
* the API.
|
|
@@ -18200,7 +18209,7 @@ declare namespace sap {
|
|
|
18200
18209
|
* The hash to be matched
|
|
18201
18210
|
*/
|
|
18202
18211
|
sHash: string
|
|
18203
|
-
):
|
|
18212
|
+
): sap.ui.core.routing.RouteInfo | undefined;
|
|
18204
18213
|
/**
|
|
18205
18214
|
* Returns a target by its name.
|
|
18206
18215
|
*
|
|
@@ -19435,6 +19444,17 @@ declare namespace sap {
|
|
|
19435
19444
|
fullHash?: string;
|
|
19436
19445
|
};
|
|
19437
19446
|
|
|
19447
|
+
type RouteInfo = {
|
|
19448
|
+
/**
|
|
19449
|
+
* The route name
|
|
19450
|
+
*/
|
|
19451
|
+
name: string;
|
|
19452
|
+
/**
|
|
19453
|
+
* The route data
|
|
19454
|
+
*/
|
|
19455
|
+
arguments: Record<string, string>;
|
|
19456
|
+
};
|
|
19457
|
+
|
|
19438
19458
|
/**
|
|
19439
19459
|
* @SINCE 1.84.0
|
|
19440
19460
|
*
|
|
@@ -24487,6 +24507,8 @@ declare namespace sap {
|
|
|
24487
24507
|
sId: sap.ui.core.ID | null | undefined
|
|
24488
24508
|
): sap.ui.core.Element | undefined;
|
|
24489
24509
|
/**
|
|
24510
|
+
* @deprecated (since 1.95) - Please use {@link sap.ui.core.Component.create Component.create} instead.
|
|
24511
|
+
*
|
|
24490
24512
|
* Creates a component with the provided id and settings.
|
|
24491
24513
|
*
|
|
24492
24514
|
* When the optional parameter `sUrl` is given, then all request for resources of the library will be redirected
|
|
@@ -24540,7 +24562,7 @@ declare namespace sap {
|
|
|
24540
24562
|
* the settings object for the component
|
|
24541
24563
|
*/
|
|
24542
24564
|
mSettings?: object
|
|
24543
|
-
):
|
|
24565
|
+
): sap.ui.core.Component;
|
|
24544
24566
|
/**
|
|
24545
24567
|
* Returns a new instance of the RenderManager for exclusive use by the caller.
|
|
24546
24568
|
*
|
|
@@ -24812,6 +24834,8 @@ declare namespace sap {
|
|
|
24812
24834
|
*/
|
|
24813
24835
|
getApplication(): sap.ui.app.Application;
|
|
24814
24836
|
/**
|
|
24837
|
+
* @deprecated (since 1.95) - Please use {@link sap.ui.core.Component.get Component.get} instead.
|
|
24838
|
+
*
|
|
24815
24839
|
* Returns the registered component for the given id, if any.
|
|
24816
24840
|
*/
|
|
24817
24841
|
getComponent(sId: string): sap.ui.core.Component;
|
|
@@ -24932,6 +24956,9 @@ declare namespace sap {
|
|
|
24932
24956
|
*/
|
|
24933
24957
|
getRenderManager(): void;
|
|
24934
24958
|
/**
|
|
24959
|
+
* @deprecated (since 1.95) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also {@link
|
|
24960
|
+
* topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
|
|
24961
|
+
*
|
|
24935
24962
|
* Returns the instance of the root component (if exists).
|
|
24936
24963
|
*/
|
|
24937
24964
|
getRootComponent(): sap.ui.core.Component;
|
|
@@ -25181,7 +25208,7 @@ declare namespace sap {
|
|
|
25181
25208
|
*/
|
|
25182
25209
|
loadLibrary(
|
|
25183
25210
|
/**
|
|
25184
|
-
*
|
|
25211
|
+
* Name of the library to load
|
|
25185
25212
|
*/
|
|
25186
25213
|
sLibrary: string,
|
|
25187
25214
|
/**
|
|
@@ -25191,16 +25218,16 @@ declare namespace sap {
|
|
|
25191
25218
|
| string
|
|
25192
25219
|
| boolean
|
|
25193
25220
|
| {
|
|
25194
|
-
/**
|
|
25195
|
-
* URL to load the library from
|
|
25196
|
-
*/
|
|
25197
|
-
url?: string;
|
|
25198
25221
|
/**
|
|
25199
25222
|
* Whether to load the library asynchronously
|
|
25200
25223
|
*/
|
|
25201
25224
|
async?: boolean;
|
|
25225
|
+
/**
|
|
25226
|
+
* URL to load the library from
|
|
25227
|
+
*/
|
|
25228
|
+
url?: string;
|
|
25202
25229
|
}
|
|
25203
|
-
):
|
|
25230
|
+
): object | Promise<object>;
|
|
25204
25231
|
/**
|
|
25205
25232
|
* Locks the Core. No browser events are dispatched to the controls.
|
|
25206
25233
|
*
|
|
@@ -25621,6 +25648,23 @@ declare namespace sap {
|
|
|
25621
25648
|
*/
|
|
25622
25649
|
collectionName?: string
|
|
25623
25650
|
): string;
|
|
25651
|
+
/**
|
|
25652
|
+
* Adds CSS code to load an icon font to the DOM
|
|
25653
|
+
*/
|
|
25654
|
+
insertFontFaceStyle(
|
|
25655
|
+
/**
|
|
25656
|
+
* the file name of the font face
|
|
25657
|
+
*/
|
|
25658
|
+
sFontFace: string,
|
|
25659
|
+
/**
|
|
25660
|
+
* the path to the font file
|
|
25661
|
+
*/
|
|
25662
|
+
sPath: string,
|
|
25663
|
+
/**
|
|
25664
|
+
* the collection name, if not specified the font face is used
|
|
25665
|
+
*/
|
|
25666
|
+
sCollectionName?: string
|
|
25667
|
+
): void;
|
|
25624
25668
|
/**
|
|
25625
25669
|
* Returns whether the given `uri` is an icon URI.
|
|
25626
25670
|
*
|
|
@@ -27261,12 +27305,6 @@ declare namespace sap {
|
|
|
27261
27305
|
* Container width in CSS size
|
|
27262
27306
|
*/
|
|
27263
27307
|
getWidth(): sap.ui.core.CSSSize;
|
|
27264
|
-
/**
|
|
27265
|
-
* @SINCE 1.91
|
|
27266
|
-
*
|
|
27267
|
-
* Hides the placeholder that is shown on the component container.
|
|
27268
|
-
*/
|
|
27269
|
-
hidePlaceholder(): void;
|
|
27270
27308
|
/**
|
|
27271
27309
|
* Sets a new value for property {@link #getAsync async}.
|
|
27272
27310
|
*
|
|
@@ -27471,22 +27509,6 @@ declare namespace sap {
|
|
|
27471
27509
|
*/
|
|
27472
27510
|
sWidth?: sap.ui.core.CSSSize
|
|
27473
27511
|
): this;
|
|
27474
|
-
/**
|
|
27475
|
-
* @SINCE 1.91
|
|
27476
|
-
*
|
|
27477
|
-
* Shows the provided placeholder on the component container.
|
|
27478
|
-
*/
|
|
27479
|
-
showPlaceholder(
|
|
27480
|
-
/**
|
|
27481
|
-
* Object containing the placeholder object
|
|
27482
|
-
*/
|
|
27483
|
-
mSettings: {
|
|
27484
|
-
/**
|
|
27485
|
-
* The placeholder instance
|
|
27486
|
-
*/
|
|
27487
|
-
placeholder: /* was: sap.ui.core.Placeholder */ any;
|
|
27488
|
-
}
|
|
27489
|
-
): Promise<any>;
|
|
27490
27512
|
}
|
|
27491
27513
|
/**
|
|
27492
27514
|
* @SINCE 1.9.2
|
|
@@ -27782,7 +27804,8 @@ declare namespace sap {
|
|
|
27782
27804
|
*/
|
|
27783
27805
|
getAppCacheBusterMode(): string;
|
|
27784
27806
|
/**
|
|
27785
|
-
* @deprecated (since 1.15.1) - Please use
|
|
27807
|
+
* @deprecated (since 1.15.1) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also
|
|
27808
|
+
* {@link topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
|
|
27786
27809
|
*
|
|
27787
27810
|
* The name of the application to start or empty.
|
|
27788
27811
|
*/
|
|
@@ -27896,7 +27919,8 @@ declare namespace sap {
|
|
|
27896
27919
|
*/
|
|
27897
27920
|
getOriginInfo(): boolean;
|
|
27898
27921
|
/**
|
|
27899
|
-
* @
|
|
27922
|
+
* @deprecated (since 1.95) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also {@link
|
|
27923
|
+
* topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
|
|
27900
27924
|
*
|
|
27901
27925
|
* The name of the root component to start or empty.
|
|
27902
27926
|
*/
|
|
@@ -27914,6 +27938,14 @@ declare namespace sap {
|
|
|
27914
27938
|
* It will be returned in uppercase. e.g. "EN", "DE"
|
|
27915
27939
|
*/
|
|
27916
27940
|
getSAPLogonLanguage(): string;
|
|
27941
|
+
/**
|
|
27942
|
+
* @SINCE 1.95.0
|
|
27943
|
+
*
|
|
27944
|
+
* Returns the security token handlers of an OData V4 model.
|
|
27945
|
+
* See:
|
|
27946
|
+
* #setSecurityTokenHandlers
|
|
27947
|
+
*/
|
|
27948
|
+
getSecurityTokenHandlers(): Function[];
|
|
27917
27949
|
/**
|
|
27918
27950
|
* Returns the theme name
|
|
27919
27951
|
*/
|
|
@@ -28064,6 +28096,20 @@ declare namespace sap {
|
|
|
28064
28096
|
*/
|
|
28065
28097
|
bRTL: boolean | null
|
|
28066
28098
|
): this;
|
|
28099
|
+
/**
|
|
28100
|
+
* @SINCE 1.95.0
|
|
28101
|
+
*
|
|
28102
|
+
* Sets the security token handlers for an OData V4 model. See chapter "Security Token Handling" in {@link
|
|
28103
|
+
* topic:9613f1f2d88747cab21896f7216afdac Model Instantiation and Data Access}.
|
|
28104
|
+
* See:
|
|
28105
|
+
* #getSecurityTokenHandlers
|
|
28106
|
+
*/
|
|
28107
|
+
setSecurityTokenHandlers(
|
|
28108
|
+
/**
|
|
28109
|
+
* The security token handlers
|
|
28110
|
+
*/
|
|
28111
|
+
aSecurityTokenHandlers: Function[]
|
|
28112
|
+
): void;
|
|
28067
28113
|
}
|
|
28068
28114
|
/**
|
|
28069
28115
|
* Base Class for Controls.
|
|
@@ -34483,6 +34529,9 @@ declare namespace sap {
|
|
|
34483
34529
|
* When an <img> tag is rendered, the following two attributes are added by default and can be overwritten
|
|
34484
34530
|
* with corresponding values in the `mAttributes` parameter:
|
|
34485
34531
|
* - `role: "presentation"` `alt: ""`
|
|
34532
|
+
*
|
|
34533
|
+
* **Note:** This function requires the {@link sap.ui.core.IconPool} module. Ensure that the module is loaded
|
|
34534
|
+
* before this function is called to avoid syncXHRs.
|
|
34486
34535
|
*/
|
|
34487
34536
|
icon(
|
|
34488
34537
|
/**
|
|
@@ -36130,7 +36179,7 @@ declare namespace sap {
|
|
|
36130
36179
|
* A `sap.ui.core.UIComponent` subclass can additionally implement the {@link sap.ui.core.IAsyncContentCreation}
|
|
36131
36180
|
* interface. When implementing this interface the loading and processing of an asynchronous `rootView`
|
|
36132
36181
|
* will be chained into the result Promise of the {@link sap.ui.core.Component.create Component.create}
|
|
36133
|
-
* factory. See Sample 1 below.
|
|
36182
|
+
* factory. An additional async flag can be omitted. See Sample 1 below.
|
|
36134
36183
|
*
|
|
36135
36184
|
* Samples 2 and 3 show how subclasses can overwrite the `createContent` function to run asynchronously.
|
|
36136
36185
|
* To create the root control asynchronously, the subclass has to define the `sap.ui.core.IAsyncContentCreation`
|
|
@@ -37885,11 +37934,11 @@ declare namespace sap {
|
|
|
37885
37934
|
/**
|
|
37886
37935
|
* The SAPUI5 Data Binding API.
|
|
37887
37936
|
*
|
|
37888
|
-
* The default binding mode for model implementations (if not implemented otherwise) is two
|
|
37889
|
-
* supported binding modes by the model are one
|
|
37937
|
+
* The default binding mode for model implementations (if not implemented otherwise) is two-way and the
|
|
37938
|
+
* supported binding modes by the model are one-way, two-way and one-time. The default binding mode can
|
|
37890
37939
|
* be changed by the application for each model instance. A model implementation should specify its supported
|
|
37891
|
-
* binding modes and set the default binding mode accordingly (e.g. if the model supports only one
|
|
37892
|
-
* the default binding mode should also be set to one
|
|
37940
|
+
* binding modes and set the default binding mode accordingly (e.g. if the model supports only one-way binding
|
|
37941
|
+
* the default binding mode should also be set to one-way).
|
|
37893
37942
|
*
|
|
37894
37943
|
* The default size limit for models is 100. The size limit determines the number of entries used for the
|
|
37895
37944
|
* list bindings.
|
|
@@ -39499,10 +39548,9 @@ declare namespace sap {
|
|
|
39499
39548
|
/**
|
|
39500
39549
|
* A comma-separated list of property names that need to be selected.
|
|
39501
39550
|
* If the `select` parameter is given, it has to contain all properties that are contained in the analytical
|
|
39502
|
-
* information (see {@link sap.ui.model.analytics.AnalyticalBinding#updateAnalyticalInfo})
|
|
39503
|
-
* dimensions
|
|
39504
|
-
*
|
|
39505
|
-
* of a dimension that is also selected.
|
|
39551
|
+
* information (see {@link sap.ui.model.analytics.AnalyticalBinding#updateAnalyticalInfo}). It must not
|
|
39552
|
+
* contain additional dimensions or measures or associated properties for additional dimensions or measures.
|
|
39553
|
+
* But it may contain additional properties like a text property of a dimension that is also selected.
|
|
39506
39554
|
* All properties of the `select` parameter are also considered in {@link sap.ui.model.analytics.AnalyticalBinding#getDownloadUrl}.
|
|
39507
39555
|
* The `select` parameter must not contain any duplicate entry.
|
|
39508
39556
|
* If the `select` parameter does not fit to the analytical information or if the `select` parameter contains
|
|
@@ -39861,34 +39909,41 @@ declare namespace sap {
|
|
|
39861
39909
|
* Updates the binding's structure with new analytical information.
|
|
39862
39910
|
*
|
|
39863
39911
|
* Analytical information is the mapping of UI columns to properties in the bound OData entity set. Every
|
|
39864
|
-
* column object contains the name of the bound property and in addition:
|
|
39912
|
+
* column object contains the `name` of the bound property and in addition:
|
|
39865
39913
|
* - A column bound to a dimension property has further boolean properties:
|
|
39866
|
-
* grouped: dimension
|
|
39867
|
-
* - visible: if the column is visible, values for the related property will be fetched from the OData
|
|
39868
|
-
* service
|
|
39914
|
+
* grouped: dimension is used for building groups
|
|
39869
39915
|
* - inResult: if the column is not visible, but declared to be part of the result, values for the related
|
|
39870
|
-
* property
|
|
39916
|
+
* property are also fetched from the OData service
|
|
39917
|
+
* - visible: if the column is visible, values for the related property are fetched from the OData service
|
|
39918
|
+
*
|
|
39871
39919
|
* - A column bound to a measure property has further boolean properties:
|
|
39872
|
-
*
|
|
39920
|
+
* inResult: if the column is not visible, but declared to be part of the result, values for the related
|
|
39921
|
+
* property are also fetched from the OData service
|
|
39922
|
+
* - total: totals and sub-totals are provided for the measure at all aggregation levels
|
|
39923
|
+
* - visible: if the column is visible, values for the related property are fetched from the OData service
|
|
39873
39924
|
*
|
|
39874
39925
|
* - A column bound to a hierarchy property has further properties:
|
|
39875
|
-
* grouped: boolean value; indicates whether the hierarchy
|
|
39926
|
+
* grouped: boolean value; indicates whether the hierarchy is used for building groups
|
|
39876
39927
|
* - level: integer value; the hierarchy level is mandatory for at least one of those columns that represent
|
|
39877
|
-
* the same hierarchy
|
|
39928
|
+
* the same hierarchy
|
|
39878
39929
|
*
|
|
39879
39930
|
* Invoking this function resets the state of the binding and subsequent data requests such as calls to
|
|
39880
|
-
* getNodeContexts()
|
|
39881
|
-
*
|
|
39931
|
+
* getNodeContexts() trigger OData requests in order to fetch the data that are in line with this analytical
|
|
39932
|
+
* information.
|
|
39882
39933
|
*
|
|
39883
|
-
*
|
|
39884
|
-
*
|
|
39885
|
-
*
|
|
39934
|
+
* Be aware that a call of this function might lead to additional back-end requests, as well as a control
|
|
39935
|
+
* re-rendering later on. Whenever possible use the API of the analytical control, instead of relying on
|
|
39936
|
+
* the binding.
|
|
39886
39937
|
*/
|
|
39887
39938
|
updateAnalyticalInfo(
|
|
39888
39939
|
/**
|
|
39889
|
-
*
|
|
39940
|
+
* An array with objects holding the analytical information for every column
|
|
39890
39941
|
*/
|
|
39891
|
-
aColumns:
|
|
39942
|
+
aColumns: object[],
|
|
39943
|
+
/**
|
|
39944
|
+
* Whether to fire a change event asynchronously even if columns didn't change
|
|
39945
|
+
*/
|
|
39946
|
+
bForceChange: boolean
|
|
39892
39947
|
): void;
|
|
39893
39948
|
}
|
|
39894
39949
|
|
|
@@ -40058,7 +40113,9 @@ declare namespace sap {
|
|
|
40058
40113
|
): any[];
|
|
40059
40114
|
}
|
|
40060
40115
|
/**
|
|
40061
|
-
* Model implementation for JSON format
|
|
40116
|
+
* Model implementation for the JSON format.
|
|
40117
|
+
*
|
|
40118
|
+
* This model is not prepared to be inherited from.
|
|
40062
40119
|
*/
|
|
40063
40120
|
class JSONModel extends sap.ui.model.ClientModel {
|
|
40064
40121
|
/**
|
|
@@ -40300,7 +40357,9 @@ declare namespace sap {
|
|
|
40300
40357
|
*/
|
|
40301
40358
|
namespace message {
|
|
40302
40359
|
/**
|
|
40303
|
-
* Model implementation for Messages
|
|
40360
|
+
* Model implementation for Messages.
|
|
40361
|
+
*
|
|
40362
|
+
* This model is not prepared to be inherited from.
|
|
40304
40363
|
*/
|
|
40305
40364
|
class MessageModel extends sap.ui.model.ClientModel {
|
|
40306
40365
|
/**
|
|
@@ -40339,17 +40398,17 @@ declare namespace sap {
|
|
|
40339
40398
|
*/
|
|
40340
40399
|
static getMetadata(): sap.ui.base.Metadata;
|
|
40341
40400
|
/**
|
|
40342
|
-
* Returns the value for the property with the given `sPropertyName
|
|
40401
|
+
* Returns the value for the property with the given `sPropertyName`.
|
|
40343
40402
|
*/
|
|
40344
40403
|
getProperty(
|
|
40345
40404
|
/**
|
|
40346
|
-
*
|
|
40405
|
+
* The path to the property
|
|
40347
40406
|
*/
|
|
40348
40407
|
sPath: string,
|
|
40349
40408
|
/**
|
|
40350
|
-
*
|
|
40409
|
+
* The context to resolve a relative path with
|
|
40351
40410
|
*/
|
|
40352
|
-
oContext?:
|
|
40411
|
+
oContext?: sap.ui.model.Context
|
|
40353
40412
|
): any;
|
|
40354
40413
|
/**
|
|
40355
40414
|
* Sets the message data to the model.
|
|
@@ -40366,7 +40425,20 @@ declare namespace sap {
|
|
|
40366
40425
|
* Other models provide this method to set a new value for a specific property. `MessageModel` does not
|
|
40367
40426
|
* support it as it supports the `OneWay` mode only.
|
|
40368
40427
|
*/
|
|
40369
|
-
setProperty(
|
|
40428
|
+
setProperty(
|
|
40429
|
+
/**
|
|
40430
|
+
* Unused in this implementation
|
|
40431
|
+
*/
|
|
40432
|
+
sPath: string,
|
|
40433
|
+
/**
|
|
40434
|
+
* Unused in this implementation
|
|
40435
|
+
*/
|
|
40436
|
+
oValue: object,
|
|
40437
|
+
/**
|
|
40438
|
+
* Unused in this implementation
|
|
40439
|
+
*/
|
|
40440
|
+
oContext: sap.ui.model.Context
|
|
40441
|
+
): void;
|
|
40370
40442
|
}
|
|
40371
40443
|
}
|
|
40372
40444
|
/**
|
|
@@ -42889,6 +42961,7 @@ declare namespace sap {
|
|
|
42889
42961
|
* A context for the OData V2 model cannot be created at will, it has to be retrieved via:
|
|
42890
42962
|
* - an OData binding
|
|
42891
42963
|
* - a view element
|
|
42964
|
+
* - {@link sap.ui.model.odata.v2.ODataModel#callFunction}
|
|
42892
42965
|
* - {@link sap.ui.model.odata.v2.ODataModel#createBindingContext}
|
|
42893
42966
|
* - {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
42894
42967
|
*/
|
|
@@ -42920,6 +42993,18 @@ declare namespace sap {
|
|
|
42920
42993
|
* Returns a metadata object for class sap.ui.model.odata.v2.Context.
|
|
42921
42994
|
*/
|
|
42922
42995
|
static getMetadata(): sap.ui.base.Metadata;
|
|
42996
|
+
/**
|
|
42997
|
+
* @SINCE 1.96.0
|
|
42998
|
+
*
|
|
42999
|
+
* Returns a promise on the creation state of this context if it has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry};
|
|
43000
|
+
* otherwise returns `undefined`.
|
|
43001
|
+
*
|
|
43002
|
+
* As long as the promise is not yet resolved or rejected, the entity represented by this context is transient.
|
|
43003
|
+
*
|
|
43004
|
+
* Once the promise is resolved, the entity for this context is stored in the back end and {@link #getPath}
|
|
43005
|
+
* returns a path including the key predicate of the new entity.
|
|
43006
|
+
*/
|
|
43007
|
+
created(): Promise<any>;
|
|
42923
43008
|
/**
|
|
42924
43009
|
* @SINCE 1.94.0
|
|
42925
43010
|
*
|
|
@@ -43540,6 +43625,14 @@ declare namespace sap {
|
|
|
43540
43625
|
* Defines the count mode of this binding; if not specified, the default count mode of the `oModel` is applied
|
|
43541
43626
|
*/
|
|
43542
43627
|
countMode?: sap.ui.model.odata.CountMode;
|
|
43628
|
+
/**
|
|
43629
|
+
* A key used in combination with the resolved path of this binding to identify the entities created this
|
|
43630
|
+
* binding's {@link #create} method.
|
|
43631
|
+
*
|
|
43632
|
+
* **Note:** Different controls or control aggregation bindings to the same collection must have different
|
|
43633
|
+
* `createdEntitiesKey` values.
|
|
43634
|
+
*/
|
|
43635
|
+
createdEntitiesKey?: string;
|
|
43543
43636
|
/**
|
|
43544
43637
|
* An optional map of custom query parameters. Custom parameters must not start with `$`
|
|
43545
43638
|
*/
|
|
@@ -43727,6 +43820,8 @@ declare namespace sap {
|
|
|
43727
43820
|
* Model implementation based on the OData protocol.
|
|
43728
43821
|
*
|
|
43729
43822
|
* See chapter {@link topic:6c47b2b39db9404582994070ec3d57a2 OData V2 Model} for a general introduction.
|
|
43823
|
+
*
|
|
43824
|
+
* This model is not prepared to be inherited from.
|
|
43730
43825
|
*/
|
|
43731
43826
|
class ODataModel extends sap.ui.model.Model {
|
|
43732
43827
|
/**
|
|
@@ -44250,6 +44345,14 @@ declare namespace sap {
|
|
|
44250
44345
|
* Count mode for this binding; if not specified, the default count mode for this model is used
|
|
44251
44346
|
*/
|
|
44252
44347
|
countMode?: sap.ui.model.odata.CountMode;
|
|
44348
|
+
/**
|
|
44349
|
+
* A key used in combination with the resolved path of the binding to identify the entities created via
|
|
44350
|
+
* the binding's {@link #create} method.
|
|
44351
|
+
*
|
|
44352
|
+
* **Note:** Different controls or control aggregation bindings to the same collection must have different
|
|
44353
|
+
* `createdEntitiesKey` values.
|
|
44354
|
+
*/
|
|
44355
|
+
createdEntitiesKey?: string;
|
|
44253
44356
|
/**
|
|
44254
44357
|
* Operation mode for this binding; if not specified, the default operation mode of this model is used
|
|
44255
44358
|
*/
|
|
@@ -44691,7 +44794,11 @@ declare namespace sap {
|
|
|
44691
44794
|
* Name. A context object is returned which can be used to bind against the newly created object.
|
|
44692
44795
|
*
|
|
44693
44796
|
* For each created entry a request is created and stored in a request queue. The request queue can be submitted
|
|
44694
|
-
* by calling {@link #submitChanges}.
|
|
44797
|
+
* by calling {@link #submitChanges}. As long as the context is transient (see {@link sap.ui.model.odata.v2.Context#isTransient}),
|
|
44798
|
+
* {@link sap.ui.model.odata.v2.ODataModel#resetChanges} with the `bDeleteCreatedEntities` parameter set
|
|
44799
|
+
* to `true` can be used to delete the created entity again.
|
|
44800
|
+
*
|
|
44801
|
+
* If the creation of the entity on the server failed, it is repeated automatically.
|
|
44695
44802
|
*
|
|
44696
44803
|
* The optional parameter `mParameters.properties` can be used as follows:
|
|
44697
44804
|
* - `properties` could be an array containing the property names which should be included in the new
|
|
@@ -44702,7 +44809,7 @@ declare namespace sap {
|
|
|
44702
44809
|
*
|
|
44703
44810
|
* If there are no values specified, the properties will have `undefined` values.
|
|
44704
44811
|
*
|
|
44705
|
-
*
|
|
44812
|
+
* The `properties` can be modified via property bindings relative to the returned context instance.
|
|
44706
44813
|
*
|
|
44707
44814
|
* The parameter `expand` is supported since 1.78.0. If this parameter is set, the given navigation properties
|
|
44708
44815
|
* are expanded automatically with the same $batch request in which the POST request for the creation is
|
|
@@ -44721,6 +44828,14 @@ declare namespace sap {
|
|
|
44721
44828
|
* handler is called with the data and the response of the POST request. The response object of the success
|
|
44722
44829
|
* handler call and the response parameter of the corresponding `requestFailed` and `requestCompleted` events
|
|
44723
44830
|
* have an additional property `expandAfterCreateFailed` set to `true`.
|
|
44831
|
+
*
|
|
44832
|
+
* Note: If a server requires a property in the request, you must supply this property in the initial data,
|
|
44833
|
+
* for example if the server requires a unit for an amount. This also applies if this property has a default
|
|
44834
|
+
* value.
|
|
44835
|
+
*
|
|
44836
|
+
* Note: A deep create (including data defined by navigation properties) is not supported. The dependent
|
|
44837
|
+
* entity has to be created using a second list binding, after this entity has been saved successfully in
|
|
44838
|
+
* the back-end system.
|
|
44724
44839
|
*/
|
|
44725
44840
|
createEntry(
|
|
44726
44841
|
/**
|
|
@@ -44806,7 +44921,12 @@ declare namespace sap {
|
|
|
44806
44921
|
oKeyProperties: object
|
|
44807
44922
|
): string;
|
|
44808
44923
|
/**
|
|
44924
|
+
* @deprecated - since 1.95.0; use {@link #resetChanges} instead
|
|
44925
|
+
*
|
|
44809
44926
|
* Deletes a created entry from the request queue and from the model.
|
|
44927
|
+
*
|
|
44928
|
+
* **Note:** Controls are not updated. Use {@link #resetChanges} instead to update also the controls, for
|
|
44929
|
+
* example: `oModel.resetChanges([oContext.getPath()], undefined, true);`
|
|
44810
44930
|
*/
|
|
44811
44931
|
deleteCreatedEntry(
|
|
44812
44932
|
/**
|
|
@@ -45259,8 +45379,10 @@ declare namespace sap {
|
|
|
45259
45379
|
* To get a copy of the entity without internal attributes, use `{select: "*"}` instead.
|
|
45260
45380
|
*
|
|
45261
45381
|
* **Note:** If `mParameters.select` is given and not all selected properties are available, this method
|
|
45262
|
-
* returns `undefined` instead of incomplete data.
|
|
45263
|
-
*
|
|
45382
|
+
* returns `undefined` instead of incomplete data.
|
|
45383
|
+
*
|
|
45384
|
+
* **Note:** If `mParameters.select` is not given, all properties and navigation properties available on
|
|
45385
|
+
* the client are returned.
|
|
45264
45386
|
*
|
|
45265
45387
|
* Example:
|
|
45266
45388
|
* With `mParameters` given as `{select: "Products/ProductName, Products", expand:"Products"}` no properties
|
|
@@ -45643,31 +45765,38 @@ declare namespace sap {
|
|
|
45643
45765
|
*/
|
|
45644
45766
|
changeSetId?: string;
|
|
45645
45767
|
/**
|
|
45646
|
-
* Since 1.46; defines whether to update all bindings after submitting this change operation
|
|
45647
|
-
* #setRefreshAfterChange} If given, this overrules the model-wide `refreshAfterChange` flag for this operation
|
|
45768
|
+
* Since 1.46; defines whether to update all bindings after submitting this change operation, see {@link
|
|
45769
|
+
* #setRefreshAfterChange}. If given, this overrules the model-wide `refreshAfterChange` flag for this operation
|
|
45648
45770
|
* only.
|
|
45649
45771
|
*/
|
|
45650
45772
|
refreshAfterChange?: boolean;
|
|
45651
45773
|
}
|
|
45652
45774
|
): object;
|
|
45653
45775
|
/**
|
|
45654
|
-
* Resets changes
|
|
45776
|
+
* Resets pending changes and aborts corresponding requests.
|
|
45655
45777
|
*
|
|
45656
|
-
* By default, only
|
|
45657
|
-
*
|
|
45778
|
+
* By default, only changes triggered through {@link #createEntry} or {@link #setProperty} are taken into
|
|
45779
|
+
* account. If `bAll` is set, also deferred requests triggered through {@link #create}, {@link #update}
|
|
45780
|
+
* or {@link #remove} are taken into account.
|
|
45658
45781
|
*
|
|
45659
|
-
* If `
|
|
45660
|
-
*
|
|
45782
|
+
* If `bDeleteCreatedEntities` is set, the entity is completely removed, provided it has been created
|
|
45783
|
+
*
|
|
45784
|
+
* - via {@link #createEntry} and it is not yet persisted in the back end, or
|
|
45785
|
+
* - via {@link #callFunction}.
|
|
45661
45786
|
*/
|
|
45662
45787
|
resetChanges(
|
|
45663
45788
|
/**
|
|
45664
|
-
*
|
|
45789
|
+
* Paths to be be reset; if no array is passed, all changes are reset
|
|
45665
45790
|
*/
|
|
45666
45791
|
aPath?: any[],
|
|
45667
45792
|
/**
|
|
45668
|
-
*
|
|
45793
|
+
* Whether also deferred requests are taken into account
|
|
45669
45794
|
*/
|
|
45670
|
-
bAll?: boolean
|
|
45795
|
+
bAll?: boolean,
|
|
45796
|
+
/**
|
|
45797
|
+
* Whether to delete the entities created via {@link #createEntry} or {@link #callFunction}; since 1.95.0
|
|
45798
|
+
*/
|
|
45799
|
+
bDeleteCreatedEntities?: boolean
|
|
45671
45800
|
): Promise<any>;
|
|
45672
45801
|
/**
|
|
45673
45802
|
* Returns a promise, which will resolve with the security token as soon as it is available.
|
|
@@ -46048,17 +46177,17 @@ declare namespace sap {
|
|
|
46048
46177
|
* Applies the given filters to the ODataTreeBinding.
|
|
46049
46178
|
*
|
|
46050
46179
|
* Please note that filters of type `FilterType.Control` are not supported for `OperationMode.Server`, here
|
|
46051
|
-
* only filters of type `FilterType.Application` are allowed. Filters given via
|
|
46052
|
-
* of type `Application` and will be sent with every
|
|
46053
|
-
*
|
|
46180
|
+
* only filters of type `FilterType.Application` are allowed. Filters given via {@link sap.ui.model.odata.v2.ODataModel#bindTree}
|
|
46181
|
+
* are always of type `Application` and will be sent with every back-end request. For more information,
|
|
46182
|
+
* see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
|
|
46054
46183
|
*
|
|
46055
46184
|
* Since 1.34.0, complete client-side filtering is supported for `OperationMode.Client` and also in `OperationMode.Auto`
|
|
46056
|
-
* if the
|
|
46057
|
-
* on the client. See also: {@link sap.ui.model.odata.OperationMode.Auto}
|
|
46185
|
+
* if the back-end count is lower than the threshold. In this case, all types of filters will be applied
|
|
46186
|
+
* on the client. See also: {@link sap.ui.model.odata.OperationMode.Auto} and {@link sap.ui.model.FilterType}.
|
|
46058
46187
|
*
|
|
46059
|
-
* For the `OperationMode.Client` and `OperationMode.Auto`, you may also specify the
|
|
46060
|
-
*
|
|
46061
|
-
* and trigger an OData request.
|
|
46188
|
+
* For the `OperationMode.Client` and `OperationMode.Auto`, you may also specify the `useServersideApplicationFilters`
|
|
46189
|
+
* binding parameter when creating an instance. If it is set, the filters of type `Application` will always
|
|
46190
|
+
* be applied on the back end and trigger an OData request. For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
|
|
46062
46191
|
* See:
|
|
46063
46192
|
* sap.ui.model.TreeBinding.prototype.filter
|
|
46064
46193
|
*/
|
|
@@ -46176,10 +46305,10 @@ declare namespace sap {
|
|
|
46176
46305
|
sGroupId?: string
|
|
46177
46306
|
): void;
|
|
46178
46307
|
/**
|
|
46179
|
-
* Sets the rootLevel The root level is the level of the topmost tree nodes
|
|
46308
|
+
* Sets the `rootLevel`. The root level is the level of the topmost tree nodes that will be used as an entry
|
|
46180
46309
|
* point for OData services. This is only possible (and necessary) for OData services implementing the hierarchy
|
|
46181
46310
|
* annotation specification, or when providing the annotation information locally as a binding parameter.
|
|
46182
|
-
*
|
|
46311
|
+
* For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
|
|
46183
46312
|
*/
|
|
46184
46313
|
setRootLevel(iRootLevel: int): void;
|
|
46185
46314
|
/**
|
|
@@ -47287,8 +47416,8 @@ declare namespace sap {
|
|
|
47287
47416
|
* @SINCE 1.37.0
|
|
47288
47417
|
*
|
|
47289
47418
|
* Context binding for an OData V4 model. An event handler can only be attached to this binding for the
|
|
47290
|
-
* following events: 'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested',
|
|
47291
|
-
* For other events, an error is thrown.
|
|
47419
|
+
* following events: 'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested', 'DataStateChange',
|
|
47420
|
+
* 'patchCompleted', and 'patchSent'. For other events, an error is thrown.
|
|
47292
47421
|
*
|
|
47293
47422
|
* A context binding can also be used as an operation binding to support bound actions, action imports,
|
|
47294
47423
|
* bound functions and function imports. If you want to control the execution time of an operation, for
|
|
@@ -47555,6 +47684,20 @@ declare namespace sap {
|
|
|
47555
47684
|
* Method not supported
|
|
47556
47685
|
*/
|
|
47557
47686
|
isInitial(): boolean;
|
|
47687
|
+
/**
|
|
47688
|
+
* @SINCE 1.95.0
|
|
47689
|
+
* @EXPERIMENTAL
|
|
47690
|
+
*
|
|
47691
|
+
* Moves the bound entity into the given list binding. This binding loses its data. The method may only
|
|
47692
|
+
* be called when this binding has finished loading. You can verify this by calling `oBinding.getBoundContext().requestObject()`.
|
|
47693
|
+
* If that promise resolves, the binding has finished loading.
|
|
47694
|
+
*/
|
|
47695
|
+
moveEntityTo(
|
|
47696
|
+
/**
|
|
47697
|
+
* The list binding to take the entity
|
|
47698
|
+
*/
|
|
47699
|
+
oListBinding: sap.ui.model.odata.v4.ODataListBinding
|
|
47700
|
+
): void;
|
|
47558
47701
|
/**
|
|
47559
47702
|
* @SINCE 1.37.0
|
|
47560
47703
|
*
|
|
@@ -47609,6 +47752,18 @@ declare namespace sap {
|
|
|
47609
47752
|
*/
|
|
47610
47753
|
sPath?: string
|
|
47611
47754
|
): Promise<any>;
|
|
47755
|
+
/**
|
|
47756
|
+
* @SINCE 1.87.0
|
|
47757
|
+
*
|
|
47758
|
+
* Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
|
|
47759
|
+
* #refresh} if you do not need the promise.
|
|
47760
|
+
*/
|
|
47761
|
+
requestRefresh(
|
|
47762
|
+
/**
|
|
47763
|
+
* The group ID to be used
|
|
47764
|
+
*/
|
|
47765
|
+
sGroupId?: string
|
|
47766
|
+
): Promise<any>;
|
|
47612
47767
|
/**
|
|
47613
47768
|
* @SINCE 1.40.1
|
|
47614
47769
|
*
|
|
@@ -47656,13 +47811,20 @@ declare namespace sap {
|
|
|
47656
47811
|
* #resume
|
|
47657
47812
|
*/
|
|
47658
47813
|
suspend(): void;
|
|
47814
|
+
/**
|
|
47815
|
+
* @SINCE 1.37.0
|
|
47816
|
+
*
|
|
47817
|
+
* Returns a string representation of this object including the binding path. If the binding is relative,
|
|
47818
|
+
* the parent path is also given, separated by a '|'.
|
|
47819
|
+
*/
|
|
47820
|
+
toString(): string;
|
|
47659
47821
|
}
|
|
47660
47822
|
/**
|
|
47661
47823
|
* @SINCE 1.37.0
|
|
47662
47824
|
*
|
|
47663
47825
|
* List binding for an OData V4 model. An event handler can only be attached to this binding for the following
|
|
47664
|
-
* events: 'AggregatedDataStateChange', 'change', '
|
|
47665
|
-
* 'refresh'. For other events, an error is thrown.
|
|
47826
|
+
* events: 'AggregatedDataStateChange', 'change', 'createCompleted', 'createSent', 'dataReceived', 'dataRequested',
|
|
47827
|
+
* 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an error is thrown.
|
|
47666
47828
|
*/
|
|
47667
47829
|
class ODataListBinding extends sap.ui.model.ListBinding {
|
|
47668
47830
|
constructor();
|
|
@@ -47934,6 +48096,19 @@ declare namespace sap {
|
|
|
47934
48096
|
*
|
|
47935
48097
|
* Filters are case sensitive unless the property `caseSensitive` is set to `false`. This property has to
|
|
47936
48098
|
* be set on each filter, it is not inherited from a multi-filter.
|
|
48099
|
+
*
|
|
48100
|
+
* Application and Control Filters: Each list binding maintains two separate lists of filters, one for filters
|
|
48101
|
+
* defined by the control that owns the binding, and another list for filters that an application can define
|
|
48102
|
+
* in addition. When executing the filter operation, both sets of filters are combined.
|
|
48103
|
+
*
|
|
48104
|
+
* By using the `sFilterType` parameter of the `filter` method, the caller can control which set of filters
|
|
48105
|
+
* is modified.
|
|
48106
|
+
*
|
|
48107
|
+
* Auto-Grouping of Filters: Filters are first grouped according to their binding path. All filters belonging
|
|
48108
|
+
* to the same path are ORed, and after that the results of all paths are ANDed. Usually this means that
|
|
48109
|
+
* all filters applied to the same property are ORed, while filters on different properties are ANDed. Please
|
|
48110
|
+
* use either the automatic grouping of filters (where applicable) or explicit AND/OR filters, as a mixture
|
|
48111
|
+
* of both is not supported.
|
|
47937
48112
|
* See:
|
|
47938
48113
|
* sap.ui.model.ListBinding#filter
|
|
47939
48114
|
* #setAggregation
|
|
@@ -48231,6 +48406,18 @@ declare namespace sap {
|
|
|
48231
48406
|
*/
|
|
48232
48407
|
fnFilter?: (p1: sap.ui.core.message.Message) => boolean
|
|
48233
48408
|
): Promise<sap.ui.model.Filter>;
|
|
48409
|
+
/**
|
|
48410
|
+
* @SINCE 1.87.0
|
|
48411
|
+
*
|
|
48412
|
+
* Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
|
|
48413
|
+
* #refresh} if you do not need the promise.
|
|
48414
|
+
*/
|
|
48415
|
+
requestRefresh(
|
|
48416
|
+
/**
|
|
48417
|
+
* The group ID to be used
|
|
48418
|
+
*/
|
|
48419
|
+
sGroupId?: string
|
|
48420
|
+
): Promise<any>;
|
|
48234
48421
|
/**
|
|
48235
48422
|
* @SINCE 1.40.1
|
|
48236
48423
|
*
|
|
@@ -48351,6 +48538,13 @@ declare namespace sap {
|
|
|
48351
48538
|
* #resume
|
|
48352
48539
|
*/
|
|
48353
48540
|
suspend(): void;
|
|
48541
|
+
/**
|
|
48542
|
+
* @SINCE 1.37.0
|
|
48543
|
+
*
|
|
48544
|
+
* Returns a string representation of this object including the binding path. If the binding is relative,
|
|
48545
|
+
* the parent path is also given, separated by a '|'.
|
|
48546
|
+
*/
|
|
48547
|
+
toString(): string;
|
|
48354
48548
|
/**
|
|
48355
48549
|
* @SINCE 1.53.0
|
|
48356
48550
|
*
|
|
@@ -48422,6 +48616,8 @@ declare namespace sap {
|
|
|
48422
48616
|
* not support any public events; attaching an event handler leads to an error.
|
|
48423
48617
|
*
|
|
48424
48618
|
* This model is read-only.
|
|
48619
|
+
*
|
|
48620
|
+
* This model is not prepared to be inherited from.
|
|
48425
48621
|
*/
|
|
48426
48622
|
class ODataMetaModel extends sap.ui.model.MetaModel {
|
|
48427
48623
|
constructor();
|
|
@@ -49040,6 +49236,8 @@ declare namespace sap {
|
|
|
49040
49236
|
*
|
|
49041
49237
|
* Model implementation for OData V4.
|
|
49042
49238
|
*
|
|
49239
|
+
* This model is not prepared to be inherited from.
|
|
49240
|
+
*
|
|
49043
49241
|
* Every resource path (relative to the service root URL, no query options) according to "4 Resource Path"
|
|
49044
49242
|
* in specification "OData Version 4.0 Part 2: URL Conventions" is a valid data binding path within this
|
|
49045
49243
|
* model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')" to access an entity
|
|
@@ -49263,9 +49461,8 @@ declare namespace sap {
|
|
|
49263
49461
|
$$groupId?: string;
|
|
49264
49462
|
/**
|
|
49265
49463
|
* For operation bindings only: Whether $expand and $select from the parent binding are used in the request
|
|
49266
|
-
* sent on {@link #execute}. If set to `true`, the binding must not set the $expand
|
|
49267
|
-
*
|
|
49268
|
-
* same entity set.
|
|
49464
|
+
* sent on {@link #execute}. If set to `true`, the binding must not set the $expand itself, the operation
|
|
49465
|
+
* must be bound, and the return value and the binding parameter must belong to the same entity set.
|
|
49269
49466
|
*/
|
|
49270
49467
|
$$inheritExpandSelect?: boolean;
|
|
49271
49468
|
/**
|
|
@@ -49296,7 +49493,7 @@ declare namespace sap {
|
|
|
49296
49493
|
*/
|
|
49297
49494
|
bindList(
|
|
49298
49495
|
/**
|
|
49299
|
-
* The binding path in the model; must not
|
|
49496
|
+
* The binding path in the model; must not end with a slash
|
|
49300
49497
|
*/
|
|
49301
49498
|
sPath: string,
|
|
49302
49499
|
/**
|
|
@@ -49397,8 +49594,7 @@ declare namespace sap {
|
|
|
49397
49594
|
* as a separator and splits it into two parts. The part before the separator is resolved with the binding's
|
|
49398
49595
|
* context and the result is transformed into a metadata context (see {@link sap.ui.model.odata.v4.ODataMetaModel#getMetaContext}).
|
|
49399
49596
|
* The part following the separator is then interpreted relative to this metadata context, even if it starts
|
|
49400
|
-
* with a '/';
|
|
49401
|
-
* for the effect it has.
|
|
49597
|
+
* with a '/'; see {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject} for more details.
|
|
49402
49598
|
*
|
|
49403
49599
|
* If the target type specified in the corresponding control property's binding info is "any" and the binding
|
|
49404
49600
|
* is relative or points to metadata, the binding may have an object value; in this case and unless the
|
|
@@ -49410,8 +49606,7 @@ declare namespace sap {
|
|
|
49410
49606
|
*/
|
|
49411
49607
|
bindProperty(
|
|
49412
49608
|
/**
|
|
49413
|
-
* The binding path in the model; must not
|
|
49414
|
-
* metadata.
|
|
49609
|
+
* The binding path in the model; must not end with a slash
|
|
49415
49610
|
*/
|
|
49416
49611
|
sPath: string,
|
|
49417
49612
|
/**
|
|
@@ -49420,12 +49615,14 @@ declare namespace sap {
|
|
|
49420
49615
|
oContext?: sap.ui.model.Context,
|
|
49421
49616
|
/**
|
|
49422
49617
|
* Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2:
|
|
49423
|
-
* URL Conventions" or the binding-specific
|
|
49424
|
-
*
|
|
49425
|
-
*
|
|
49426
|
-
* The
|
|
49427
|
-
*
|
|
49428
|
-
*
|
|
49618
|
+
* URL Conventions" or the binding-specific parameters as specified below. The following OData query options
|
|
49619
|
+
* are allowed:
|
|
49620
|
+
* All "5.2 Custom Query Options" except for those with a name starting with "sap-" (unless starting with
|
|
49621
|
+
* "sap-valid-") The $apply, $filter, and $search "5.1 System Query Options" if the path ends with
|
|
49622
|
+
* a "$count" segment. All other query options lead to an error. Query options specified for the binding
|
|
49623
|
+
* overwrite model query options. Note: The binding only creates its own data service request if it is absolute
|
|
49624
|
+
* or if it is relative to a context created via {@link #createBindingContext}. The binding parameters are
|
|
49625
|
+
* ignored in case the binding creates no own data service request or in case the binding points to metadata.
|
|
49429
49626
|
*/
|
|
49430
49627
|
mParameters?: {
|
|
49431
49628
|
/**
|
|
@@ -49914,6 +50111,18 @@ declare namespace sap {
|
|
|
49914
50111
|
*/
|
|
49915
50112
|
sGroupId?: string | boolean
|
|
49916
50113
|
): void;
|
|
50114
|
+
/**
|
|
50115
|
+
* @SINCE 1.87.0
|
|
50116
|
+
*
|
|
50117
|
+
* Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
|
|
50118
|
+
* #refresh} if you do not need the promise.
|
|
50119
|
+
*/
|
|
50120
|
+
requestRefresh(
|
|
50121
|
+
/**
|
|
50122
|
+
* The group ID to be used
|
|
50123
|
+
*/
|
|
50124
|
+
sGroupId?: string
|
|
50125
|
+
): Promise<any>;
|
|
49917
50126
|
/**
|
|
49918
50127
|
* @SINCE 1.69
|
|
49919
50128
|
*
|
|
@@ -50009,6 +50218,13 @@ declare namespace sap {
|
|
|
50009
50218
|
* sap.ui.model.Binding#suspend
|
|
50010
50219
|
*/
|
|
50011
50220
|
suspend(): void;
|
|
50221
|
+
/**
|
|
50222
|
+
* @SINCE 1.37.0
|
|
50223
|
+
*
|
|
50224
|
+
* Returns a string representation of this object including the binding path. If the binding is relative,
|
|
50225
|
+
* the parent path is also given, separated by a '|'.
|
|
50226
|
+
*/
|
|
50227
|
+
toString(): string;
|
|
50012
50228
|
}
|
|
50013
50229
|
/**
|
|
50014
50230
|
* Modes to control the use of batch requests for a group ID.
|
|
@@ -50408,15 +50624,15 @@ declare namespace sap {
|
|
|
50408
50624
|
*/
|
|
50409
50625
|
formatValue(
|
|
50410
50626
|
/**
|
|
50411
|
-
*
|
|
50627
|
+
* The value to format
|
|
50412
50628
|
*/
|
|
50413
50629
|
vValue: any,
|
|
50414
50630
|
/**
|
|
50415
|
-
*
|
|
50631
|
+
* The EDM type (e.g. Edm.Decimal)
|
|
50416
50632
|
*/
|
|
50417
50633
|
sType: string,
|
|
50418
50634
|
/**
|
|
50419
|
-
*
|
|
50635
|
+
* Whether strings gets compared case sensitive or not
|
|
50420
50636
|
*/
|
|
50421
50637
|
bCaseSensitive: boolean
|
|
50422
50638
|
): string;
|
|
@@ -51313,6 +51529,8 @@ declare namespace sap {
|
|
|
51313
51529
|
* V4 annotations from the existing {@link sap.ui.model.odata.ODataAnnotations} directly into the corresponding
|
|
51314
51530
|
* model element.
|
|
51315
51531
|
*
|
|
51532
|
+
* This model is not prepared to be inherited from.
|
|
51533
|
+
*
|
|
51316
51534
|
* Also, annotations from the "http://www.sap.com/Protocols/SAPData" namespace are lifted up from the `extensions`
|
|
51317
51535
|
* array and transformed from objects into simple properties with an "sap:" prefix for their name. Note
|
|
51318
51536
|
* that this happens in addition, thus the following example shows both representations. This way, such
|
|
@@ -53020,6 +53238,8 @@ declare namespace sap {
|
|
|
53020
53238
|
/**
|
|
53021
53239
|
* Model implementation for resource bundles.
|
|
53022
53240
|
*
|
|
53241
|
+
* This model is not prepared to be inherited from.
|
|
53242
|
+
*
|
|
53023
53243
|
* This model allows to bind control properties against translatable texts. Its data is taken from a {@link
|
|
53024
53244
|
* module:sap/base/i18n/ResourceBundle} and it only supports property bindings.
|
|
53025
53245
|
*
|
|
@@ -53241,7 +53461,9 @@ declare namespace sap {
|
|
|
53241
53461
|
*/
|
|
53242
53462
|
namespace xml {
|
|
53243
53463
|
/**
|
|
53244
|
-
* Model implementation for XML format
|
|
53464
|
+
* Model implementation for the XML format.
|
|
53465
|
+
*
|
|
53466
|
+
* This model is not prepared to be inherited from.
|
|
53245
53467
|
*/
|
|
53246
53468
|
class XMLModel extends sap.ui.model.ClientModel {
|
|
53247
53469
|
/**
|
|
@@ -53280,35 +53502,35 @@ declare namespace sap {
|
|
|
53280
53502
|
*/
|
|
53281
53503
|
static getMetadata(): sap.ui.base.Metadata;
|
|
53282
53504
|
/**
|
|
53283
|
-
* Returns the object for the given
|
|
53505
|
+
* Returns the object for the given path and context.
|
|
53284
53506
|
*/
|
|
53285
53507
|
getObject(
|
|
53286
53508
|
/**
|
|
53287
|
-
*
|
|
53509
|
+
* The path to the object
|
|
53288
53510
|
*/
|
|
53289
53511
|
sPath: string,
|
|
53290
53512
|
/**
|
|
53291
|
-
*
|
|
53513
|
+
* The context which will be used to retrieve the object
|
|
53292
53514
|
*/
|
|
53293
53515
|
oContext?: object
|
|
53294
|
-
):
|
|
53516
|
+
): object;
|
|
53295
53517
|
/**
|
|
53296
|
-
* Returns the value for the property with the given `sPropertyName
|
|
53518
|
+
* Returns the value for the property with the given `sPropertyName`.
|
|
53297
53519
|
*/
|
|
53298
53520
|
getProperty(
|
|
53299
53521
|
/**
|
|
53300
|
-
*
|
|
53522
|
+
* The path to the property
|
|
53301
53523
|
*/
|
|
53302
53524
|
sPath: string,
|
|
53303
53525
|
/**
|
|
53304
|
-
*
|
|
53526
|
+
* The context which will be used to retrieve the property
|
|
53305
53527
|
*/
|
|
53306
53528
|
oContext?: object
|
|
53307
|
-
):
|
|
53529
|
+
): string;
|
|
53308
53530
|
/**
|
|
53309
53531
|
* Serializes the current XML data of the model into a string.
|
|
53310
53532
|
*/
|
|
53311
|
-
getXML():
|
|
53533
|
+
getXML(): string;
|
|
53312
53534
|
/**
|
|
53313
53535
|
* Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the
|
|
53314
53536
|
* model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
|
|
@@ -53356,11 +53578,11 @@ declare namespace sap {
|
|
|
53356
53578
|
*/
|
|
53357
53579
|
setNameSpace(
|
|
53358
53580
|
/**
|
|
53359
|
-
*
|
|
53581
|
+
* The namespace URI
|
|
53360
53582
|
*/
|
|
53361
53583
|
sNameSpace: string,
|
|
53362
53584
|
/**
|
|
53363
|
-
*
|
|
53585
|
+
* The prefix for the namespace
|
|
53364
53586
|
*/
|
|
53365
53587
|
sPrefix?: string
|
|
53366
53588
|
): void;
|
|
@@ -53370,19 +53592,19 @@ declare namespace sap {
|
|
|
53370
53592
|
*/
|
|
53371
53593
|
setProperty(
|
|
53372
53594
|
/**
|
|
53373
|
-
*
|
|
53595
|
+
* Path of the property to set
|
|
53374
53596
|
*/
|
|
53375
53597
|
sPath: string,
|
|
53376
53598
|
/**
|
|
53377
|
-
*
|
|
53599
|
+
* Value to set the property to
|
|
53378
53600
|
*/
|
|
53379
53601
|
oValue: any,
|
|
53380
53602
|
/**
|
|
53381
|
-
*
|
|
53603
|
+
* The context which will be used to set the property
|
|
53382
53604
|
*/
|
|
53383
53605
|
oContext?: object,
|
|
53384
53606
|
/**
|
|
53385
|
-
*
|
|
53607
|
+
* Whether to update other bindings dependent on this property asynchronously
|
|
53386
53608
|
*/
|
|
53387
53609
|
bAsyncUpdate?: boolean
|
|
53388
53610
|
): boolean;
|
|
@@ -53771,8 +53993,12 @@ declare namespace sap {
|
|
|
53771
53993
|
* Returns a metadata object for class sap.ui.model.type.Date.
|
|
53772
53994
|
*/
|
|
53773
53995
|
static getMetadata(): sap.ui.base.Metadata;
|
|
53774
|
-
|
|
53775
|
-
|
|
53996
|
+
/**
|
|
53997
|
+
* Returns the output pattern.
|
|
53998
|
+
* See:
|
|
53999
|
+
* sap.ui.core.format.DateFormat.getDateInstance
|
|
54000
|
+
*/
|
|
54001
|
+
getOutputPattern(): string;
|
|
53776
54002
|
}
|
|
53777
54003
|
/**
|
|
53778
54004
|
* This class represents the Date interval composite type.
|
|
@@ -54592,18 +54818,20 @@ declare namespace sap {
|
|
|
54592
54818
|
*/
|
|
54593
54819
|
constructor(
|
|
54594
54820
|
/**
|
|
54595
|
-
*
|
|
54821
|
+
* The model
|
|
54596
54822
|
*/
|
|
54597
54823
|
oModel: sap.ui.model.Model,
|
|
54598
54824
|
/**
|
|
54599
|
-
*
|
|
54825
|
+
* The path
|
|
54600
54826
|
*/
|
|
54601
54827
|
sPath: string,
|
|
54602
54828
|
/**
|
|
54603
|
-
*
|
|
54829
|
+
* The context object
|
|
54604
54830
|
*/
|
|
54605
54831
|
oContext: sap.ui.model.Context,
|
|
54606
|
-
|
|
54832
|
+
/**
|
|
54833
|
+
* Additional, implementation-specific parameters
|
|
54834
|
+
*/
|
|
54607
54835
|
mParameters?: object
|
|
54608
54836
|
);
|
|
54609
54837
|
|
|
@@ -54641,27 +54869,27 @@ declare namespace sap {
|
|
|
54641
54869
|
*/
|
|
54642
54870
|
attachAggregatedDataStateChange(
|
|
54643
54871
|
/**
|
|
54644
|
-
* The function to be called
|
|
54872
|
+
* The function to be called when the event occurs
|
|
54645
54873
|
*/
|
|
54646
54874
|
fnFunction: Function,
|
|
54647
54875
|
/**
|
|
54648
|
-
* Context object to call the event handler with
|
|
54876
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54649
54877
|
*/
|
|
54650
54878
|
oListener?: object
|
|
54651
54879
|
): void;
|
|
54652
54880
|
/**
|
|
54653
|
-
* Attaches
|
|
54881
|
+
* Attaches the `fnFunction` event handler to the {@link #event:change change} event of this `sap.ui.model.Model`.
|
|
54654
54882
|
*
|
|
54655
54883
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
54656
54884
|
* otherwise it will be bound to this `sap.ui.model.Binding` itself.
|
|
54657
54885
|
*/
|
|
54658
54886
|
attachChange(
|
|
54659
54887
|
/**
|
|
54660
|
-
* The function to be called
|
|
54888
|
+
* The function to be called when the event occurs
|
|
54661
54889
|
*/
|
|
54662
54890
|
fnFunction: Function,
|
|
54663
54891
|
/**
|
|
54664
|
-
* Context object to call the event handler with
|
|
54892
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54665
54893
|
*/
|
|
54666
54894
|
oListener?: object
|
|
54667
54895
|
): void;
|
|
@@ -54673,11 +54901,11 @@ declare namespace sap {
|
|
|
54673
54901
|
*/
|
|
54674
54902
|
attachDataReceived(
|
|
54675
54903
|
/**
|
|
54676
|
-
* Function to be called
|
|
54904
|
+
* Function to be called when the event occurs
|
|
54677
54905
|
*/
|
|
54678
54906
|
fnFunction: Function,
|
|
54679
54907
|
/**
|
|
54680
|
-
* Context object to call the event handler with
|
|
54908
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54681
54909
|
*/
|
|
54682
54910
|
oListener?: object
|
|
54683
54911
|
): void;
|
|
@@ -54689,35 +54917,40 @@ declare namespace sap {
|
|
|
54689
54917
|
*/
|
|
54690
54918
|
attachDataRequested(
|
|
54691
54919
|
/**
|
|
54692
|
-
* The function to be called
|
|
54920
|
+
* The function to be called when the event occurs
|
|
54693
54921
|
*/
|
|
54694
54922
|
fnFunction: Function,
|
|
54695
54923
|
/**
|
|
54696
|
-
* Context object to call the event handler with
|
|
54924
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54697
54925
|
*/
|
|
54698
54926
|
oListener?: object
|
|
54699
54927
|
): void;
|
|
54700
54928
|
/**
|
|
54701
|
-
* Attaches
|
|
54702
|
-
* `sap.ui.model.Binding`.
|
|
54929
|
+
* Attaches the `fnFunction` event handler to the {@link #event:DataStateChange DataStateChange} event of
|
|
54930
|
+
* thi `sap.ui.model.Binding`.
|
|
54703
54931
|
*
|
|
54704
54932
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
54705
54933
|
* otherwise it will be bound to this `sap.ui.model.Binding` itself.
|
|
54706
54934
|
*/
|
|
54707
54935
|
attachDataStateChange(
|
|
54708
54936
|
/**
|
|
54709
|
-
* Function to be called
|
|
54937
|
+
* Function to be called when the event occurs
|
|
54710
54938
|
*/
|
|
54711
54939
|
fnFunction: Function,
|
|
54712
54940
|
/**
|
|
54713
|
-
* Context object to call the event handler with
|
|
54941
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54714
54942
|
*/
|
|
54715
54943
|
oListener?: object
|
|
54716
54944
|
): void;
|
|
54717
54945
|
/**
|
|
54718
54946
|
* Attach multiple events.
|
|
54719
54947
|
*/
|
|
54720
|
-
attachEvents(
|
|
54948
|
+
attachEvents(
|
|
54949
|
+
/**
|
|
54950
|
+
* Events to attach to this binding
|
|
54951
|
+
*/
|
|
54952
|
+
oEvents: Record<string, Function>
|
|
54953
|
+
): sap.ui.model.Binding;
|
|
54721
54954
|
/**
|
|
54722
54955
|
* Attaches event handler `fnFunction` to the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
|
|
54723
54956
|
*
|
|
@@ -54726,11 +54959,11 @@ declare namespace sap {
|
|
|
54726
54959
|
*/
|
|
54727
54960
|
attachRefresh(
|
|
54728
54961
|
/**
|
|
54729
|
-
* The function to be called
|
|
54962
|
+
* The function to be called when the event occurs
|
|
54730
54963
|
*/
|
|
54731
54964
|
fnFunction: Function,
|
|
54732
54965
|
/**
|
|
54733
|
-
* Context object to call the event handler with
|
|
54966
|
+
* Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
|
|
54734
54967
|
*/
|
|
54735
54968
|
oListener?: object
|
|
54736
54969
|
): void;
|
|
@@ -54747,7 +54980,7 @@ declare namespace sap {
|
|
|
54747
54980
|
*/
|
|
54748
54981
|
detachAggregatedDataStateChange(
|
|
54749
54982
|
/**
|
|
54750
|
-
* The function to be called
|
|
54983
|
+
* The function to be called when the event occurs
|
|
54751
54984
|
*/
|
|
54752
54985
|
fnFunction: Function,
|
|
54753
54986
|
/**
|
|
@@ -54760,7 +54993,7 @@ declare namespace sap {
|
|
|
54760
54993
|
*/
|
|
54761
54994
|
detachChange(
|
|
54762
54995
|
/**
|
|
54763
|
-
* Function to be called
|
|
54996
|
+
* Function to be called when the event occurs
|
|
54764
54997
|
*/
|
|
54765
54998
|
fnFunction: Function,
|
|
54766
54999
|
/**
|
|
@@ -54773,7 +55006,7 @@ declare namespace sap {
|
|
|
54773
55006
|
*/
|
|
54774
55007
|
detachDataReceived(
|
|
54775
55008
|
/**
|
|
54776
|
-
* Function to be called
|
|
55009
|
+
* Function to be called when the event occurs
|
|
54777
55010
|
*/
|
|
54778
55011
|
fnFunction: Function,
|
|
54779
55012
|
/**
|
|
@@ -54787,7 +55020,7 @@ declare namespace sap {
|
|
|
54787
55020
|
*/
|
|
54788
55021
|
detachDataRequested(
|
|
54789
55022
|
/**
|
|
54790
|
-
* The function to be called
|
|
55023
|
+
* The function to be called when the event occurs
|
|
54791
55024
|
*/
|
|
54792
55025
|
fnFunction: Function,
|
|
54793
55026
|
/**
|
|
@@ -54801,7 +55034,7 @@ declare namespace sap {
|
|
|
54801
55034
|
*/
|
|
54802
55035
|
detachDataStateChange(
|
|
54803
55036
|
/**
|
|
54804
|
-
* The function to be called
|
|
55037
|
+
* The function to be called when the event occurs
|
|
54805
55038
|
*/
|
|
54806
55039
|
fnFunction: Function,
|
|
54807
55040
|
/**
|
|
@@ -54812,17 +55045,22 @@ declare namespace sap {
|
|
|
54812
55045
|
/**
|
|
54813
55046
|
* Detach multiple events.
|
|
54814
55047
|
*/
|
|
54815
|
-
detachEvents(
|
|
55048
|
+
detachEvents(
|
|
55049
|
+
/**
|
|
55050
|
+
* Events to detach from this binding
|
|
55051
|
+
*/
|
|
55052
|
+
oEvents: Record<string, Function>
|
|
55053
|
+
): sap.ui.model.Binding;
|
|
54816
55054
|
/**
|
|
54817
55055
|
* Detaches event handler `fnFunction` from the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
|
|
54818
55056
|
*/
|
|
54819
55057
|
detachRefresh(
|
|
54820
55058
|
/**
|
|
54821
|
-
* The function to be called
|
|
55059
|
+
* The function to be called when the event occurs
|
|
54822
55060
|
*/
|
|
54823
55061
|
fnFunction: Function,
|
|
54824
55062
|
/**
|
|
54825
|
-
*
|
|
55063
|
+
* Object on which to call the given function.
|
|
54826
55064
|
*/
|
|
54827
55065
|
oListener?: object
|
|
54828
55066
|
): void;
|
|
@@ -54833,11 +55071,11 @@ declare namespace sap {
|
|
|
54833
55071
|
*/
|
|
54834
55072
|
fireDataReceived(
|
|
54835
55073
|
/**
|
|
54836
|
-
* Parameters to pass along with the event
|
|
55074
|
+
* Parameters to pass along with the event
|
|
54837
55075
|
*/
|
|
54838
55076
|
oParameters: {
|
|
54839
55077
|
/**
|
|
54840
|
-
* Data received
|
|
55078
|
+
* Data received; on error cases it will be undefined
|
|
54841
55079
|
*/
|
|
54842
55080
|
data?: object;
|
|
54843
55081
|
}
|
|
@@ -54847,7 +55085,7 @@ declare namespace sap {
|
|
|
54847
55085
|
*/
|
|
54848
55086
|
fireDataRequested(
|
|
54849
55087
|
/**
|
|
54850
|
-
* Parameters to pass along with the event
|
|
55088
|
+
* Parameters to pass along with the event
|
|
54851
55089
|
*/
|
|
54852
55090
|
oParameters: object
|
|
54853
55091
|
): void;
|
|
@@ -54893,11 +55131,11 @@ declare namespace sap {
|
|
|
54893
55131
|
*/
|
|
54894
55132
|
initialize(): void;
|
|
54895
55133
|
/**
|
|
54896
|
-
* Returns whether the binding is initial, which means it did not get an initial value yet
|
|
55134
|
+
* Returns whether the binding is initial, which means it did not get an initial value yet.
|
|
54897
55135
|
*/
|
|
54898
55136
|
isInitial(): boolean;
|
|
54899
55137
|
/**
|
|
54900
|
-
* Returns whether the binding is relative, which means its path does not start with a slash
|
|
55138
|
+
* Returns whether the binding is relative, which means its path does not start with a slash.
|
|
54901
55139
|
*/
|
|
54902
55140
|
isRelative(): boolean;
|
|
54903
55141
|
/**
|
|
@@ -54930,8 +55168,8 @@ declare namespace sap {
|
|
|
54930
55168
|
/**
|
|
54931
55169
|
* Resumes the binding update. Change events will be fired again.
|
|
54932
55170
|
*
|
|
54933
|
-
* When the binding is resumed, a change event will be fired immediately
|
|
54934
|
-
*
|
|
55171
|
+
* When the binding is resumed, a change event will be fired immediately if the data has changed while the
|
|
55172
|
+
* binding was suspended. For server-side models, a request to the server will be triggered if a refresh
|
|
54935
55173
|
* was requested while the binding was suspended.
|
|
54936
55174
|
*/
|
|
54937
55175
|
resume(): void;
|
|
@@ -55379,9 +55617,9 @@ declare namespace sap {
|
|
|
55379
55617
|
*/
|
|
55380
55618
|
sort(
|
|
55381
55619
|
/**
|
|
55382
|
-
* array of Sorter instances which will be applied
|
|
55620
|
+
* An array of Sorter instances which will be applied
|
|
55383
55621
|
*/
|
|
55384
|
-
|
|
55622
|
+
aSorters: sap.ui.model.Sorter[]
|
|
55385
55623
|
): this;
|
|
55386
55624
|
}
|
|
55387
55625
|
|
|
@@ -55397,7 +55635,7 @@ declare namespace sap {
|
|
|
55397
55635
|
*
|
|
55398
55636
|
* A `CompositeBinding` combines the values from all its binding parts (each an instance of `PropertyBinding`),
|
|
55399
55637
|
* either by calling a formatter function or by involving a {@link sap.ui.model.CompositeType composite
|
|
55400
|
-
* type}. When a formatter function is used,
|
|
55638
|
+
* type}. When a formatter function is used, the composite binding is automatically limited to `OneWay`
|
|
55401
55639
|
* mode. When a type is used, the binding can also operate in `TwoWay` mode.
|
|
55402
55640
|
*
|
|
55403
55641
|
* Higher layers of the framework derive composite bindings from easy-to-write string representations (the
|
|
@@ -55463,7 +55701,7 @@ declare namespace sap {
|
|
|
55463
55701
|
*/
|
|
55464
55702
|
fnFunction: Function,
|
|
55465
55703
|
/**
|
|
55466
|
-
*
|
|
55704
|
+
* Object on which to call the given function
|
|
55467
55705
|
*/
|
|
55468
55706
|
oListener?: object
|
|
55469
55707
|
): void;
|
|
@@ -55479,7 +55717,7 @@ declare namespace sap {
|
|
|
55479
55717
|
*/
|
|
55480
55718
|
fnFunction: Function,
|
|
55481
55719
|
/**
|
|
55482
|
-
*
|
|
55720
|
+
* Object on which to call the given function
|
|
55483
55721
|
*/
|
|
55484
55722
|
oListener?: object
|
|
55485
55723
|
): void;
|
|
@@ -55495,7 +55733,7 @@ declare namespace sap {
|
|
|
55495
55733
|
*/
|
|
55496
55734
|
fnFunction: Function,
|
|
55497
55735
|
/**
|
|
55498
|
-
*
|
|
55736
|
+
* Object on which to call the given function
|
|
55499
55737
|
*/
|
|
55500
55738
|
oListener?: object
|
|
55501
55739
|
): void;
|
|
@@ -55508,7 +55746,7 @@ declare namespace sap {
|
|
|
55508
55746
|
*/
|
|
55509
55747
|
fnFunction: Function,
|
|
55510
55748
|
/**
|
|
55511
|
-
*
|
|
55749
|
+
* Object on which to call the given function
|
|
55512
55750
|
*/
|
|
55513
55751
|
oListener?: object
|
|
55514
55752
|
): void;
|
|
@@ -55521,7 +55759,7 @@ declare namespace sap {
|
|
|
55521
55759
|
*/
|
|
55522
55760
|
fnFunction: Function,
|
|
55523
55761
|
/**
|
|
55524
|
-
*
|
|
55762
|
+
* Object on which to call the given function
|
|
55525
55763
|
*/
|
|
55526
55764
|
oListener?: object
|
|
55527
55765
|
): void;
|
|
@@ -55534,7 +55772,7 @@ declare namespace sap {
|
|
|
55534
55772
|
*/
|
|
55535
55773
|
fnFunction: Function,
|
|
55536
55774
|
/**
|
|
55537
|
-
*
|
|
55775
|
+
* Object on which to call the given function
|
|
55538
55776
|
*/
|
|
55539
55777
|
oListener?: object
|
|
55540
55778
|
): void;
|
|
@@ -55548,12 +55786,12 @@ declare namespace sap {
|
|
|
55548
55786
|
getExternalValue(): object;
|
|
55549
55787
|
/**
|
|
55550
55788
|
* Returns the current internal value of the bound target which is an array of the internal (JS native)
|
|
55551
|
-
* values of nested bindings
|
|
55789
|
+
* values of nested bindings.
|
|
55552
55790
|
*/
|
|
55553
55791
|
getInternalValue(): any[];
|
|
55554
55792
|
/**
|
|
55555
55793
|
* Returns the current raw value of the bound target which is an array of the raw (model) values of nested
|
|
55556
|
-
* bindings
|
|
55794
|
+
* bindings.
|
|
55557
55795
|
*/
|
|
55558
55796
|
getRawValue(): any[];
|
|
55559
55797
|
/**
|
|
@@ -55562,10 +55800,10 @@ declare namespace sap {
|
|
|
55562
55800
|
getValue(): object;
|
|
55563
55801
|
/**
|
|
55564
55802
|
* Initialize the binding. The method should be called when creating a binding. The default implementation
|
|
55565
|
-
* calls checkUpdate(true). Prevent checkUpdate to be triggered while initializing
|
|
55566
|
-
*
|
|
55803
|
+
* calls checkUpdate(true). Prevent checkUpdate to be triggered while initializing nested bindings, it is
|
|
55804
|
+
* sufficient to call checkUpdate when all nested bindings are initialized.
|
|
55567
55805
|
*/
|
|
55568
|
-
initialize():
|
|
55806
|
+
initialize(): this;
|
|
55569
55807
|
/**
|
|
55570
55808
|
* Suspends the binding update. No change events will be fired.
|
|
55571
55809
|
*
|
|
@@ -55576,12 +55814,12 @@ declare namespace sap {
|
|
|
55576
55814
|
resume(): void;
|
|
55577
55815
|
/**
|
|
55578
55816
|
* Sets the external value of a composite binding. If no CompositeType is assigned to the binding, the default
|
|
55579
|
-
* implementation assumes a space
|
|
55817
|
+
* implementation assumes a space-separated list of values. This will cause the setValue to be called for
|
|
55580
55818
|
* each nested binding, except for undefined values in the array.
|
|
55581
55819
|
*/
|
|
55582
55820
|
setExternalValue(
|
|
55583
55821
|
/**
|
|
55584
|
-
*
|
|
55822
|
+
* The value to set for this binding
|
|
55585
55823
|
*/
|
|
55586
55824
|
oValue: object
|
|
55587
55825
|
): undefined | Promise<any>;
|
|
@@ -55594,7 +55832,7 @@ declare namespace sap {
|
|
|
55594
55832
|
* the new values of the nested bindings
|
|
55595
55833
|
*/
|
|
55596
55834
|
aValues: any[]
|
|
55597
|
-
):
|
|
55835
|
+
): undefined | Promise<any>;
|
|
55598
55836
|
/**
|
|
55599
55837
|
* Sets the raw value of the bound target. Parameter must be an array of values matching the raw (model)
|
|
55600
55838
|
* types of nested bindings.
|
|
@@ -55604,7 +55842,7 @@ declare namespace sap {
|
|
|
55604
55842
|
* the new values of the nested bindings
|
|
55605
55843
|
*/
|
|
55606
55844
|
aValues: any[]
|
|
55607
|
-
):
|
|
55845
|
+
): undefined | Promise<any>;
|
|
55608
55846
|
/**
|
|
55609
55847
|
* Sets the optional type and internal type for the binding. The type and internal type are used to do the
|
|
55610
55848
|
* parsing/formatting correctly. The internal type is the property type of the element which the value is
|
|
@@ -55612,11 +55850,11 @@ declare namespace sap {
|
|
|
55612
55850
|
*/
|
|
55613
55851
|
setType(
|
|
55614
55852
|
/**
|
|
55615
|
-
*
|
|
55853
|
+
* The type for the binding
|
|
55616
55854
|
*/
|
|
55617
55855
|
oType: sap.ui.model.CompositeType,
|
|
55618
55856
|
/**
|
|
55619
|
-
*
|
|
55857
|
+
* The internal type of the element property which this binding is bound against.
|
|
55620
55858
|
*/
|
|
55621
55859
|
sInternalType: string
|
|
55622
55860
|
): void;
|
|
@@ -55626,7 +55864,7 @@ declare namespace sap {
|
|
|
55626
55864
|
*/
|
|
55627
55865
|
setValue(
|
|
55628
55866
|
/**
|
|
55629
|
-
*
|
|
55867
|
+
* The values to set for this binding
|
|
55630
55868
|
*/
|
|
55631
55869
|
aValues: any[]
|
|
55632
55870
|
): void;
|
|
@@ -56218,17 +56456,19 @@ declare namespace sap {
|
|
|
56218
56456
|
* You either pass a single object literal with the filter parameters or use the individual constructor
|
|
56219
56457
|
* arguments. No matter which variant is used, only certain combinations of parameters are supported (the
|
|
56220
56458
|
* following list uses the names from the object literal):
|
|
56221
|
-
*
|
|
56222
|
-
*
|
|
56223
|
-
*
|
|
56224
|
-
*
|
|
56225
|
-
*
|
|
56226
|
-
*
|
|
56227
|
-
*
|
|
56228
|
-
*
|
|
56229
|
-
*
|
|
56230
|
-
*
|
|
56231
|
-
*
|
|
56459
|
+
* A `path`, `operator` and one or two values (`value1`, `value2`), depending on the operator A `path`
|
|
56460
|
+
* and a custom filter function `test` An array of other filters named `filters` and a Boolean flag
|
|
56461
|
+
* `and` that specifies whether to combine the filters with an AND (`true`) or an OR (`false`) operator.
|
|
56462
|
+
* An error will be logged to the console if an invalid combination of parameters is provided.
|
|
56463
|
+
*
|
|
56464
|
+
* Please note that a model implementation may not support a custom filter function, e.g. if the model does
|
|
56465
|
+
* not perform client-side filtering. It also depends on the model implementation if the filtering is case
|
|
56466
|
+
* sensitive or not. Client models filter case insensitive compared to the OData models which filter case
|
|
56467
|
+
* sensitive by default. See particular model documentation for details.
|
|
56468
|
+
*
|
|
56469
|
+
* The filter operators {@link sap.ui.model.FilterOperator.Any "Any"} and {@link sap.ui.model.FilterOperator.All
|
|
56470
|
+
* "All"} are only supported in V4 OData models. When creating a filter instance with these filter operators,
|
|
56471
|
+
* the argument `variable` only accepts a string identifier and `condition` needs to be another filter instance.
|
|
56232
56472
|
*/
|
|
56233
56473
|
constructor(
|
|
56234
56474
|
/**
|
|
@@ -56241,15 +56481,19 @@ declare namespace sap {
|
|
|
56241
56481
|
*/
|
|
56242
56482
|
path?: string;
|
|
56243
56483
|
/**
|
|
56244
|
-
* Function
|
|
56245
|
-
*
|
|
56484
|
+
* Function used for the client-side filtering of items. It should return a Boolean indicating whether the
|
|
56485
|
+
* current item passes the filter. If no test function is given, a default test function is used, based
|
|
56486
|
+
* on the given filter operator and the comparator function.
|
|
56246
56487
|
*/
|
|
56247
|
-
test?:
|
|
56488
|
+
test?: (p1: any) => boolean;
|
|
56248
56489
|
/**
|
|
56249
|
-
* Function
|
|
56250
|
-
*
|
|
56490
|
+
* Function used to compare two values for equality and order during client-side filtering. Two values are
|
|
56491
|
+
* given as parameters. The function is expected to return:
|
|
56492
|
+
* a negative number if the first value is smaller than the second value, `0` if the two values are
|
|
56493
|
+
* equal, a positive number if the first value is larger than the second value, `NaN` for non-comparable
|
|
56494
|
+
* values. If no function is given, {@link sap.ui.model.Filter.defaultComparator} is used.
|
|
56251
56495
|
*/
|
|
56252
|
-
comparator?:
|
|
56496
|
+
comparator?: (p1: any, p2: any) => number;
|
|
56253
56497
|
/**
|
|
56254
56498
|
* Operator used for the filter
|
|
56255
56499
|
*/
|
|
@@ -56259,44 +56503,52 @@ declare namespace sap {
|
|
|
56259
56503
|
*/
|
|
56260
56504
|
value1?: any;
|
|
56261
56505
|
/**
|
|
56262
|
-
* Second value to use with the filter operator
|
|
56506
|
+
* Second value to use with the given filter operator, used only for the {@link sap.ui.model.FilterOperator.BT
|
|
56507
|
+
* "BT" between} and {@link sap.ui.model.FilterOperator.NB "NB" not between} filter operators
|
|
56263
56508
|
*/
|
|
56264
56509
|
value2?: any;
|
|
56265
56510
|
/**
|
|
56266
|
-
* The variable used in lambda operators (
|
|
56511
|
+
* The variable name used in lambda operators ({@link sap.ui.model.FilterOperator.Any "Any"} and {@link
|
|
56512
|
+
* sap.ui.model.FilterOperator.All "All"})
|
|
56267
56513
|
*/
|
|
56268
56514
|
variable?: string;
|
|
56269
56515
|
/**
|
|
56270
|
-
* A
|
|
56516
|
+
* A filter instance which will be used as the condition for lambda operators ({@link sap.ui.model.FilterOperator.Any
|
|
56517
|
+
* "Any"} and {@link sap.ui.model.FilterOperator.All "All"})
|
|
56271
56518
|
*/
|
|
56272
56519
|
condition?: sap.ui.model.Filter;
|
|
56273
56520
|
/**
|
|
56274
|
-
*
|
|
56521
|
+
* An array of filters on which the logical conjunction is applied
|
|
56275
56522
|
*/
|
|
56276
56523
|
filters?: sap.ui.model.Filter[];
|
|
56277
56524
|
/**
|
|
56278
56525
|
* Indicates whether an "AND" logical conjunction is applied on the filters. If it's not set or set to `false`,
|
|
56279
|
-
* an "OR" conjunction is applied
|
|
56526
|
+
* an "OR" conjunction is applied.
|
|
56280
56527
|
*/
|
|
56281
56528
|
and?: boolean;
|
|
56282
56529
|
/**
|
|
56283
|
-
* Indicates whether a string value should be compared case sensitive or not.
|
|
56530
|
+
* Indicates whether a string value should be compared case sensitive or not. The handling of `undefined`
|
|
56531
|
+
* depends on the model implementation.
|
|
56284
56532
|
*/
|
|
56285
56533
|
caseSensitive?: boolean;
|
|
56286
56534
|
}
|
|
56287
56535
|
| string
|
|
56288
56536
|
| sap.ui.model.Filter[],
|
|
56289
56537
|
/**
|
|
56290
|
-
* Either a filter operator or a custom filter function or a
|
|
56291
|
-
* filters
|
|
56538
|
+
* Either a filter operator or a custom filter function or a `boolean` flag that defines how to combine
|
|
56539
|
+
* multiple filters
|
|
56292
56540
|
*/
|
|
56293
|
-
vOperator?:
|
|
56541
|
+
vOperator?:
|
|
56542
|
+
| sap.ui.model.FilterOperator
|
|
56543
|
+
| ((p1: any) => boolean)
|
|
56544
|
+
| boolean,
|
|
56294
56545
|
/**
|
|
56295
56546
|
* First value to use with the given filter operator
|
|
56296
56547
|
*/
|
|
56297
56548
|
vValue1?: any,
|
|
56298
56549
|
/**
|
|
56299
|
-
* Second value to use with the given filter operator
|
|
56550
|
+
* Second value to use with the given filter operator, used only for the {@link sap.ui.model.FilterOperator.BT
|
|
56551
|
+
* "BT" between} and {@link sap.ui.model.FilterOperator.NB "NB" not between} filter operators
|
|
56300
56552
|
*/
|
|
56301
56553
|
vValue2?: any
|
|
56302
56554
|
);
|
|
@@ -56304,7 +56556,7 @@ declare namespace sap {
|
|
|
56304
56556
|
/**
|
|
56305
56557
|
* Compares two values
|
|
56306
56558
|
*
|
|
56307
|
-
* This is the default comparator function used for
|
|
56559
|
+
* This is the default comparator function used for client-side filtering, if no custom comparator is given
|
|
56308
56560
|
* in the constructor. It does compare just by using equal/less than/greater than with automatic type casting,
|
|
56309
56561
|
* except for null values, which are neither less or greater, and string values where localeCompare is used.
|
|
56310
56562
|
*
|
|
@@ -56319,7 +56571,7 @@ declare namespace sap {
|
|
|
56319
56571
|
* the second value to compare
|
|
56320
56572
|
*/
|
|
56321
56573
|
b: any
|
|
56322
|
-
):
|
|
56574
|
+
): number;
|
|
56323
56575
|
/**
|
|
56324
56576
|
* Creates a new subclass of class sap.ui.model.Filter with name `sClassName` and enriches it with the information
|
|
56325
56577
|
* contained in `oClassInfo`.
|
|
@@ -56345,6 +56597,83 @@ declare namespace sap {
|
|
|
56345
56597
|
* Returns a metadata object for class sap.ui.model.Filter.
|
|
56346
56598
|
*/
|
|
56347
56599
|
static getMetadata(): sap.ui.base.Metadata;
|
|
56600
|
+
/**
|
|
56601
|
+
* @SINCE 1.96.0
|
|
56602
|
+
*
|
|
56603
|
+
* Returns the comparator function as provided on construction of this filter, see {@link sap.ui.model.Filter#constructor},
|
|
56604
|
+
* parameter `vFilterInfo.comparator`.
|
|
56605
|
+
*/
|
|
56606
|
+
getComparator(): ((p1: any) => boolean) | undefined;
|
|
56607
|
+
/**
|
|
56608
|
+
* @SINCE 1.96.0
|
|
56609
|
+
*
|
|
56610
|
+
* Returns the filter instance which is used as the condition for lambda operators, see {@link sap.ui.model.Filter#constructor},
|
|
56611
|
+
* parameter `vFilterInfo.condition`.
|
|
56612
|
+
*/
|
|
56613
|
+
getCondition(): sap.ui.model.Filter | undefined;
|
|
56614
|
+
/**
|
|
56615
|
+
* @SINCE 1.96.0
|
|
56616
|
+
*
|
|
56617
|
+
* Returns the array of filters as specified on construction of this filter, see {@link sap.ui.model.Filter#constructor},
|
|
56618
|
+
* parameter `vFilterInfo.filters`
|
|
56619
|
+
*/
|
|
56620
|
+
getFilters(): sap.ui.model.Filter[] | undefined;
|
|
56621
|
+
/**
|
|
56622
|
+
* @SINCE 1.96.0
|
|
56623
|
+
*
|
|
56624
|
+
* Returns the filter operator used for this filter, see {@link sap.ui.model.Filter#constructor}, parameter
|
|
56625
|
+
* `vFilterInfo.operator` or `vOperator`.
|
|
56626
|
+
*/
|
|
56627
|
+
getOperator(): sap.ui.model.FilterOperator | undefined;
|
|
56628
|
+
/**
|
|
56629
|
+
* @SINCE 1.96.0
|
|
56630
|
+
*
|
|
56631
|
+
* Returns the binding path for this filter, see {@link sap.ui.model.Filter#constructor}, parameter `vFilterInfo`
|
|
56632
|
+
* or `vFilterInfo.path`.
|
|
56633
|
+
*/
|
|
56634
|
+
getPath(): string | undefined;
|
|
56635
|
+
/**
|
|
56636
|
+
* @SINCE 1.96.0
|
|
56637
|
+
*
|
|
56638
|
+
* Returns the test function which is used to filter the items, see {@link sap.ui.model.Filter#constructor},
|
|
56639
|
+
* parameter `vFilterInfo.test`.
|
|
56640
|
+
*/
|
|
56641
|
+
getTest(): ((p1: any, p2: any) => boolean) | undefined;
|
|
56642
|
+
/**
|
|
56643
|
+
* @SINCE 1.96.0
|
|
56644
|
+
*
|
|
56645
|
+
* Returns the first value that is used with the given filter operator, see {@link sap.ui.model.Filter#constructor},
|
|
56646
|
+
* parameter `vFilterInfo.value1` or `vValue1`.
|
|
56647
|
+
*/
|
|
56648
|
+
getValue1(): any;
|
|
56649
|
+
/**
|
|
56650
|
+
* @SINCE 1.96.0
|
|
56651
|
+
*
|
|
56652
|
+
* Returns the second value that is used with the given filter operator, see {@link sap.ui.model.Filter#constructor},
|
|
56653
|
+
* parameter `vFilterInfo.value2` or `vValue2`.
|
|
56654
|
+
*/
|
|
56655
|
+
getValue2(): any;
|
|
56656
|
+
/**
|
|
56657
|
+
* @SINCE 1.96.0
|
|
56658
|
+
*
|
|
56659
|
+
* Returns the variable name used in lambda operators, see {@link sap.ui.model.Filter#constructor}, parameter
|
|
56660
|
+
* `vFilterInfo.variable`.
|
|
56661
|
+
*/
|
|
56662
|
+
getVariable(): string | undefined;
|
|
56663
|
+
/**
|
|
56664
|
+
* @SINCE 1.96.0
|
|
56665
|
+
*
|
|
56666
|
+
* Indicates whether an "AND" logical conjunction is applied on the filters, see {@link sap.ui.model.Filter#constructor},
|
|
56667
|
+
* parameter `vFilterInfo.and`.
|
|
56668
|
+
*/
|
|
56669
|
+
isAnd(): boolean;
|
|
56670
|
+
/**
|
|
56671
|
+
* @SINCE 1.96.0
|
|
56672
|
+
*
|
|
56673
|
+
* Indicates whether a string value should be compared case sensitive, see {@link sap.ui.model.Filter#constructor},
|
|
56674
|
+
* parameter `vFilterInfo.caseSensitive`.
|
|
56675
|
+
*/
|
|
56676
|
+
isCaseSensitive(): boolean;
|
|
56348
56677
|
}
|
|
56349
56678
|
/**
|
|
56350
56679
|
* Instances of this exception are thrown when converting a model value to its representation on the UI
|
|
@@ -56439,7 +56768,7 @@ declare namespace sap {
|
|
|
56439
56768
|
*/
|
|
56440
56769
|
fnFunction: Function,
|
|
56441
56770
|
/**
|
|
56442
|
-
* Context object to call the event handler with
|
|
56771
|
+
* Context object to call the event handler with; defaults to this `ListBinding` itself
|
|
56443
56772
|
*/
|
|
56444
56773
|
oListener?: object
|
|
56445
56774
|
): void;
|
|
@@ -56458,7 +56787,7 @@ declare namespace sap {
|
|
|
56458
56787
|
*/
|
|
56459
56788
|
fnFunction: Function,
|
|
56460
56789
|
/**
|
|
56461
|
-
* Context object to call the event handler with
|
|
56790
|
+
* Context object to call the event handler with; defaults to this `ListBinding` itself
|
|
56462
56791
|
*/
|
|
56463
56792
|
oListener?: object
|
|
56464
56793
|
): void;
|
|
@@ -56473,7 +56802,7 @@ declare namespace sap {
|
|
|
56473
56802
|
*/
|
|
56474
56803
|
fnFunction: Function,
|
|
56475
56804
|
/**
|
|
56476
|
-
*
|
|
56805
|
+
* On which object the given function had to be called
|
|
56477
56806
|
*/
|
|
56478
56807
|
oListener?: object
|
|
56479
56808
|
): void;
|
|
@@ -56529,7 +56858,11 @@ declare namespace sap {
|
|
|
56529
56858
|
* The path of the property containing the key or a function getting the context as only parameter to calculate
|
|
56530
56859
|
* a key to identify an entry
|
|
56531
56860
|
*/
|
|
56532
|
-
vKey: Function | string
|
|
56861
|
+
vKey: Function | string,
|
|
56862
|
+
/**
|
|
56863
|
+
* The configuration for the change detection
|
|
56864
|
+
*/
|
|
56865
|
+
oExtendedChangeDetectionConfig: object
|
|
56533
56866
|
): void;
|
|
56534
56867
|
/**
|
|
56535
56868
|
* Applies a new set of filters to the list represented by this binding.
|
|
@@ -56538,18 +56871,18 @@ declare namespace sap {
|
|
|
56538
56871
|
* a server and it might execute asynchronously.
|
|
56539
56872
|
*
|
|
56540
56873
|
* Application and Control Filters: Each list binding maintains two separate lists of filters, one for filters
|
|
56541
|
-
* defined by the control that owns the binding and another list for filters that an application can define
|
|
56874
|
+
* defined by the control that owns the binding, and another list for filters that an application can define
|
|
56542
56875
|
* in addition. When executing the filter operation, both sets of filters are combined.
|
|
56543
56876
|
*
|
|
56544
|
-
* By using the
|
|
56877
|
+
* By using the `sFilterType` parameter of the `filter` method, the caller can control which set of filters
|
|
56545
56878
|
* is modified. If no type is given, then the behavior depends on the model implementation and should be
|
|
56546
56879
|
* documented in the API reference for that model.
|
|
56547
56880
|
*
|
|
56548
56881
|
* Auto-Grouping of Filters: Filters are first grouped according to their binding path. All filters belonging
|
|
56549
|
-
* to the same
|
|
56550
|
-
* filters applied to
|
|
56551
|
-
*
|
|
56552
|
-
*
|
|
56882
|
+
* to the same path are ORed, and after that the results of all paths are ANDed. Usually this means that
|
|
56883
|
+
* all filters applied to the same property are ORed, while filters on different properties are ANDed. Please
|
|
56884
|
+
* use either the automatic grouping of filters (where applicable) or explicit AND/OR filters, as a mixture
|
|
56885
|
+
* of both is not supported.
|
|
56553
56886
|
*/
|
|
56554
56887
|
filter(
|
|
56555
56888
|
/**
|
|
@@ -56578,22 +56911,22 @@ declare namespace sap {
|
|
|
56578
56911
|
*/
|
|
56579
56912
|
getContexts(
|
|
56580
56913
|
/**
|
|
56581
|
-
*
|
|
56914
|
+
* The startIndex where to start the retrieval of contexts
|
|
56582
56915
|
*/
|
|
56583
56916
|
iStartIndex?: int,
|
|
56584
56917
|
/**
|
|
56585
|
-
*
|
|
56918
|
+
* Determines how many contexts to retrieve beginning from the start index.
|
|
56586
56919
|
*/
|
|
56587
56920
|
iLength?: int,
|
|
56588
56921
|
/**
|
|
56589
56922
|
* The maximum number of contexts to read before and after the given range; with this, controls can prefetch
|
|
56590
|
-
* data that is likely to be needed soon, e.g. when scrolling down in a table
|
|
56591
|
-
* and not implemented by all models
|
|
56923
|
+
* data that is likely to be needed soon, e.g. when scrolling down in a table; this parameter is model-specific
|
|
56924
|
+
* and not implemented by all models
|
|
56592
56925
|
*/
|
|
56593
56926
|
iMaximumPrefetchSize?: int,
|
|
56594
56927
|
/**
|
|
56595
56928
|
* Whether this call keeps the result of {@link #getCurrentContexts} untouched; since 1.86.0. This parameter
|
|
56596
|
-
* is model-specific and not implemented by all models
|
|
56929
|
+
* is model-specific and not implemented by all models
|
|
56597
56930
|
*/
|
|
56598
56931
|
bKeepCurrent?: boolean
|
|
56599
56932
|
): sap.ui.model.Context[];
|
|
@@ -56615,7 +56948,7 @@ declare namespace sap {
|
|
|
56615
56948
|
*
|
|
56616
56949
|
* Returns an array of currently used binding contexts of the bound control.
|
|
56617
56950
|
*
|
|
56618
|
-
* This method does not trigger any data requests from the
|
|
56951
|
+
* This method does not trigger any data requests from the back end or a delta calculation, but just returns
|
|
56619
56952
|
* the context array as last requested by the control. This can be used by the application to get access
|
|
56620
56953
|
* to the data currently displayed by a list control.
|
|
56621
56954
|
*/
|
|
@@ -56629,6 +56962,17 @@ declare namespace sap {
|
|
|
56629
56962
|
*/
|
|
56630
56963
|
sPath: string
|
|
56631
56964
|
): any[];
|
|
56965
|
+
/**
|
|
56966
|
+
* @SINCE 1.96.0
|
|
56967
|
+
*
|
|
56968
|
+
* Returns the filters set via the constructor or via {@link #filter} for the given {@link sap.ui.model.FilterType}.
|
|
56969
|
+
*/
|
|
56970
|
+
getFilters(
|
|
56971
|
+
/**
|
|
56972
|
+
* The FilterType
|
|
56973
|
+
*/
|
|
56974
|
+
sFilterType: sap.ui.model.FilterType
|
|
56975
|
+
): sap.ui.model.Filter[];
|
|
56632
56976
|
/**
|
|
56633
56977
|
* Gets the group for the given context. Must only be called if `isGrouped()` returns that grouping is enabled
|
|
56634
56978
|
* for this binding. The grouping will be performed using the first sorter (in case multiple sorters are
|
|
@@ -56652,8 +56996,8 @@ declare namespace sap {
|
|
|
56652
56996
|
*/
|
|
56653
56997
|
getLength(): int;
|
|
56654
56998
|
/**
|
|
56655
|
-
* Indicates whether grouping is enabled for the binding. Grouping is enabled for a list binding
|
|
56656
|
-
*
|
|
56999
|
+
* Indicates whether grouping is enabled for the binding. Grouping is enabled for a list binding if at least
|
|
57000
|
+
* one sorter exists on the binding and the first sorter is a grouping sorter.
|
|
56657
57001
|
*/
|
|
56658
57002
|
isGrouped(): boolean;
|
|
56659
57003
|
/**
|
|
@@ -56690,7 +57034,7 @@ declare namespace sap {
|
|
|
56690
57034
|
* Instead of a single sorter also an array of sorters can be passed to the sort method. In this case they
|
|
56691
57035
|
* are processed in the sequence in which they are contained in the array.
|
|
56692
57036
|
*
|
|
56693
|
-
* Grouping: Sorting and grouping are closely related
|
|
57037
|
+
* Grouping: Sorting and grouping are closely related. In case a list should be grouped, it must be sorted
|
|
56694
57038
|
* by the property to group with. Grouping is enabled by setting the `group` property on the sorter object.
|
|
56695
57039
|
* If it is enabled, you can get the current group of an item using {@link sap.ui.model.ListBinding.prototype.getGroup}.
|
|
56696
57040
|
* In case multiple sorters are provided, grouping can only be done on the first sorter, nested grouping
|
|
@@ -56698,7 +57042,7 @@ declare namespace sap {
|
|
|
56698
57042
|
*/
|
|
56699
57043
|
sort(
|
|
56700
57044
|
/**
|
|
56701
|
-
*
|
|
57045
|
+
* The Sorter object or an array of sorters which defines the sort order
|
|
56702
57046
|
*/
|
|
56703
57047
|
aSorters: sap.ui.model.Sorter | any[]
|
|
56704
57048
|
): this;
|
|
@@ -56788,7 +57132,7 @@ declare namespace sap {
|
|
|
56788
57132
|
*/
|
|
56789
57133
|
oData: object,
|
|
56790
57134
|
/**
|
|
56791
|
-
* The function to be called
|
|
57135
|
+
* The function to be called when the event occurs
|
|
56792
57136
|
*/
|
|
56793
57137
|
fnFunction: Function,
|
|
56794
57138
|
/**
|
|
@@ -56804,7 +57148,7 @@ declare namespace sap {
|
|
|
56804
57148
|
*/
|
|
56805
57149
|
attachParseError(
|
|
56806
57150
|
/**
|
|
56807
|
-
* The function to be called
|
|
57151
|
+
* The function to be called when the event occurs
|
|
56808
57152
|
*/
|
|
56809
57153
|
fnFunction: Function,
|
|
56810
57154
|
/**
|
|
@@ -56826,7 +57170,7 @@ declare namespace sap {
|
|
|
56826
57170
|
*/
|
|
56827
57171
|
oData: object,
|
|
56828
57172
|
/**
|
|
56829
|
-
* The function to be called
|
|
57173
|
+
* The function to be called when the event occurs
|
|
56830
57174
|
*/
|
|
56831
57175
|
fnFunction: Function,
|
|
56832
57176
|
/**
|
|
@@ -56843,7 +57187,7 @@ declare namespace sap {
|
|
|
56843
57187
|
*/
|
|
56844
57188
|
attachPropertyChange(
|
|
56845
57189
|
/**
|
|
56846
|
-
* The function to be called
|
|
57190
|
+
* The function to be called when the event occurs
|
|
56847
57191
|
*/
|
|
56848
57192
|
fnFunction: Function,
|
|
56849
57193
|
/**
|
|
@@ -56865,7 +57209,7 @@ declare namespace sap {
|
|
|
56865
57209
|
*/
|
|
56866
57210
|
oData: object,
|
|
56867
57211
|
/**
|
|
56868
|
-
* The function to be called
|
|
57212
|
+
* The function to be called when the event occurs
|
|
56869
57213
|
*/
|
|
56870
57214
|
fnFunction: Function,
|
|
56871
57215
|
/**
|
|
@@ -56882,7 +57226,7 @@ declare namespace sap {
|
|
|
56882
57226
|
*/
|
|
56883
57227
|
attachRequestCompleted(
|
|
56884
57228
|
/**
|
|
56885
|
-
* The function to be called
|
|
57229
|
+
* The function to be called when the event occurs
|
|
56886
57230
|
*/
|
|
56887
57231
|
fnFunction: Function,
|
|
56888
57232
|
/**
|
|
@@ -56903,7 +57247,7 @@ declare namespace sap {
|
|
|
56903
57247
|
*/
|
|
56904
57248
|
oData: object,
|
|
56905
57249
|
/**
|
|
56906
|
-
* The function to be called
|
|
57250
|
+
* The function to be called when the event occurs
|
|
56907
57251
|
*/
|
|
56908
57252
|
fnFunction: Function,
|
|
56909
57253
|
/**
|
|
@@ -56919,7 +57263,7 @@ declare namespace sap {
|
|
|
56919
57263
|
*/
|
|
56920
57264
|
attachRequestFailed(
|
|
56921
57265
|
/**
|
|
56922
|
-
* The function to be called
|
|
57266
|
+
* The function to be called when the event occurs
|
|
56923
57267
|
*/
|
|
56924
57268
|
fnFunction: Function,
|
|
56925
57269
|
/**
|
|
@@ -56940,7 +57284,7 @@ declare namespace sap {
|
|
|
56940
57284
|
*/
|
|
56941
57285
|
oData: object,
|
|
56942
57286
|
/**
|
|
56943
|
-
* The function to be called
|
|
57287
|
+
* The function to be called when the event occurs
|
|
56944
57288
|
*/
|
|
56945
57289
|
fnFunction: Function,
|
|
56946
57290
|
/**
|
|
@@ -56956,7 +57300,7 @@ declare namespace sap {
|
|
|
56956
57300
|
*/
|
|
56957
57301
|
attachRequestSent(
|
|
56958
57302
|
/**
|
|
56959
|
-
* The function to be called
|
|
57303
|
+
* The function to be called when the event occurs
|
|
56960
57304
|
*/
|
|
56961
57305
|
fnFunction: Function,
|
|
56962
57306
|
/**
|
|
@@ -56969,111 +57313,103 @@ declare namespace sap {
|
|
|
56969
57313
|
*/
|
|
56970
57314
|
bindContext(
|
|
56971
57315
|
/**
|
|
56972
|
-
*
|
|
57316
|
+
* The path pointing to the property that should be bound
|
|
56973
57317
|
*/
|
|
56974
57318
|
sPath: string,
|
|
56975
57319
|
/**
|
|
56976
|
-
*
|
|
57320
|
+
* The context object for this databinding
|
|
56977
57321
|
*/
|
|
56978
57322
|
oContext?: sap.ui.model.Context,
|
|
56979
57323
|
/**
|
|
56980
|
-
*
|
|
57324
|
+
* Additional model-specific parameters
|
|
56981
57325
|
*/
|
|
56982
57326
|
mParameters?: object,
|
|
56983
57327
|
/**
|
|
56984
|
-
*
|
|
57328
|
+
* Event handlers can be passed to the binding ({change:myHandler})
|
|
56985
57329
|
*/
|
|
56986
57330
|
oEvents?: object
|
|
56987
57331
|
): sap.ui.model.ContextBinding;
|
|
56988
|
-
|
|
56989
|
-
* Implement in inheriting classes.
|
|
56990
|
-
*/
|
|
57332
|
+
|
|
56991
57333
|
bindList(
|
|
56992
57334
|
/**
|
|
56993
|
-
*
|
|
57335
|
+
* The path pointing to the list / array that should be bound
|
|
56994
57336
|
*/
|
|
56995
57337
|
sPath: string,
|
|
56996
57338
|
/**
|
|
56997
|
-
*
|
|
57339
|
+
* The context object for this databinding
|
|
56998
57340
|
*/
|
|
56999
57341
|
oContext?: sap.ui.model.Context,
|
|
57000
57342
|
/**
|
|
57001
|
-
*
|
|
57343
|
+
* Initial sort order (can be either a sorter or an array of sorters)
|
|
57002
57344
|
*/
|
|
57003
57345
|
aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
|
|
57004
57346
|
/**
|
|
57005
|
-
*
|
|
57347
|
+
* Predefined filter/s (can be either a filter or an array of filters)
|
|
57006
57348
|
*/
|
|
57007
57349
|
aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
|
|
57008
57350
|
/**
|
|
57009
|
-
*
|
|
57351
|
+
* Additional model-specific parameters
|
|
57010
57352
|
*/
|
|
57011
57353
|
mParameters?: object
|
|
57012
57354
|
): sap.ui.model.ListBinding;
|
|
57013
|
-
|
|
57014
|
-
* Implement in inheriting classes.
|
|
57015
|
-
*/
|
|
57355
|
+
|
|
57016
57356
|
bindProperty(
|
|
57017
57357
|
/**
|
|
57018
|
-
*
|
|
57358
|
+
* The path pointing to the property that should be bound
|
|
57019
57359
|
*/
|
|
57020
57360
|
sPath: string,
|
|
57021
57361
|
/**
|
|
57022
|
-
*
|
|
57362
|
+
* The context object for this databinding
|
|
57023
57363
|
*/
|
|
57024
57364
|
oContext?: sap.ui.model.Context,
|
|
57025
57365
|
/**
|
|
57026
|
-
*
|
|
57366
|
+
* Additional model-specific parameters
|
|
57027
57367
|
*/
|
|
57028
57368
|
mParameters?: object
|
|
57029
57369
|
): sap.ui.model.PropertyBinding;
|
|
57030
|
-
|
|
57031
|
-
* Implement in inheriting classes.
|
|
57032
|
-
*/
|
|
57370
|
+
|
|
57033
57371
|
bindTree(
|
|
57034
57372
|
/**
|
|
57035
|
-
*
|
|
57373
|
+
* The path pointing to the tree / array that should be bound
|
|
57036
57374
|
*/
|
|
57037
57375
|
sPath: string,
|
|
57038
57376
|
/**
|
|
57039
|
-
*
|
|
57377
|
+
* The context object for this databinding
|
|
57040
57378
|
*/
|
|
57041
57379
|
oContext?: sap.ui.model.Context,
|
|
57042
57380
|
/**
|
|
57043
|
-
*
|
|
57381
|
+
* Predefined filter/s contained in an array
|
|
57044
57382
|
*/
|
|
57045
57383
|
aFilters?: sap.ui.model.Filter[],
|
|
57046
57384
|
/**
|
|
57047
|
-
*
|
|
57385
|
+
* Additional model specific parameters
|
|
57048
57386
|
*/
|
|
57049
57387
|
mParameters?: object,
|
|
57050
57388
|
/**
|
|
57051
|
-
*
|
|
57389
|
+
* Predefined sap.ui.model.sorter/s contained in an array
|
|
57052
57390
|
*/
|
|
57053
57391
|
aSorters?: sap.ui.model.Sorter[]
|
|
57054
57392
|
): sap.ui.model.TreeBinding;
|
|
57055
|
-
|
|
57056
|
-
* Implement in inheriting classes.
|
|
57057
|
-
*/
|
|
57393
|
+
|
|
57058
57394
|
createBindingContext(
|
|
57059
57395
|
/**
|
|
57060
|
-
*
|
|
57396
|
+
* The path to create the new context from
|
|
57061
57397
|
*/
|
|
57062
57398
|
sPath: string,
|
|
57063
57399
|
/**
|
|
57064
|
-
*
|
|
57400
|
+
* The context which should be used to create the new binding context
|
|
57065
57401
|
*/
|
|
57066
57402
|
oContext?: sap.ui.model.Context,
|
|
57067
57403
|
/**
|
|
57068
|
-
*
|
|
57404
|
+
* The parameters used to create the new binding context
|
|
57069
57405
|
*/
|
|
57070
57406
|
mParameters?: object,
|
|
57071
57407
|
/**
|
|
57072
|
-
*
|
|
57408
|
+
* The function which should be called after the binding context has been created
|
|
57073
57409
|
*/
|
|
57074
57410
|
fnCallBack?: Function,
|
|
57075
57411
|
/**
|
|
57076
|
-
*
|
|
57412
|
+
* Force reload even if data is already available; for server-side models this should refetch the data from
|
|
57077
57413
|
* the server
|
|
57078
57414
|
*/
|
|
57079
57415
|
bReload?: boolean
|
|
@@ -57081,18 +57417,16 @@ declare namespace sap {
|
|
|
57081
57417
|
/**
|
|
57082
57418
|
* Destroys the model and clears the model data.
|
|
57083
57419
|
*
|
|
57084
|
-
* A model implementation may override this function and perform model
|
|
57420
|
+
* A model implementation may override this function and perform model-specific cleanup tasks e.g. abort
|
|
57085
57421
|
* requests, prevent new requests, etc.
|
|
57086
57422
|
* See:
|
|
57087
57423
|
* sap.ui.base.Object.prototype.destroy
|
|
57088
57424
|
*/
|
|
57089
57425
|
destroy(): void;
|
|
57090
|
-
|
|
57091
|
-
* Implement in inheriting classes.
|
|
57092
|
-
*/
|
|
57426
|
+
|
|
57093
57427
|
destroyBindingContext(
|
|
57094
57428
|
/**
|
|
57095
|
-
* to destroy
|
|
57429
|
+
* The context to destroy
|
|
57096
57430
|
*/
|
|
57097
57431
|
oContext: sap.ui.model.Context
|
|
57098
57432
|
): void;
|
|
@@ -57103,7 +57437,7 @@ declare namespace sap {
|
|
|
57103
57437
|
*/
|
|
57104
57438
|
detachParseError(
|
|
57105
57439
|
/**
|
|
57106
|
-
* The function to be called
|
|
57440
|
+
* The function to be called when the event occurs
|
|
57107
57441
|
*/
|
|
57108
57442
|
fnFunction: Function,
|
|
57109
57443
|
/**
|
|
@@ -57119,7 +57453,7 @@ declare namespace sap {
|
|
|
57119
57453
|
*/
|
|
57120
57454
|
detachPropertyChange(
|
|
57121
57455
|
/**
|
|
57122
|
-
* The function to be called
|
|
57456
|
+
* The function to be called when the event occurs
|
|
57123
57457
|
*/
|
|
57124
57458
|
fnFunction: Function,
|
|
57125
57459
|
/**
|
|
@@ -57151,7 +57485,7 @@ declare namespace sap {
|
|
|
57151
57485
|
*/
|
|
57152
57486
|
detachRequestFailed(
|
|
57153
57487
|
/**
|
|
57154
|
-
* The function to be called
|
|
57488
|
+
* The function to be called when the event occurs
|
|
57155
57489
|
*/
|
|
57156
57490
|
fnFunction: Function,
|
|
57157
57491
|
/**
|
|
@@ -57214,11 +57548,11 @@ declare namespace sap {
|
|
|
57214
57548
|
*/
|
|
57215
57549
|
path?: string;
|
|
57216
57550
|
/**
|
|
57217
|
-
*
|
|
57551
|
+
* The context of the property
|
|
57218
57552
|
*/
|
|
57219
57553
|
context?: object;
|
|
57220
57554
|
/**
|
|
57221
|
-
*
|
|
57555
|
+
* The value of the property
|
|
57222
57556
|
*/
|
|
57223
57557
|
value?: object;
|
|
57224
57558
|
}
|
|
@@ -57232,7 +57566,7 @@ declare namespace sap {
|
|
|
57232
57566
|
*/
|
|
57233
57567
|
oParameters?: {
|
|
57234
57568
|
/**
|
|
57235
|
-
* The url which was sent to the
|
|
57569
|
+
* The url which was sent to the back end.
|
|
57236
57570
|
*/
|
|
57237
57571
|
url?: string;
|
|
57238
57572
|
/**
|
|
@@ -57274,7 +57608,7 @@ declare namespace sap {
|
|
|
57274
57608
|
*/
|
|
57275
57609
|
statusText?: string;
|
|
57276
57610
|
/**
|
|
57277
|
-
* Response that has been received for the request
|
|
57611
|
+
* Response that has been received for the request, as a text string
|
|
57278
57612
|
*/
|
|
57279
57613
|
responseText?: string;
|
|
57280
57614
|
}
|
|
@@ -57288,7 +57622,7 @@ declare namespace sap {
|
|
|
57288
57622
|
*/
|
|
57289
57623
|
oParameters?: {
|
|
57290
57624
|
/**
|
|
57291
|
-
* The url which is sent to the
|
|
57625
|
+
* The url which is sent to the back end.
|
|
57292
57626
|
*/
|
|
57293
57627
|
url?: string;
|
|
57294
57628
|
/**
|
|
@@ -57300,7 +57634,7 @@ declare namespace sap {
|
|
|
57300
57634
|
*/
|
|
57301
57635
|
async?: boolean;
|
|
57302
57636
|
/**
|
|
57303
|
-
*
|
|
57637
|
+
* Additional information for the request (if available) **deprecated**
|
|
57304
57638
|
*/
|
|
57305
57639
|
info?: string;
|
|
57306
57640
|
/**
|
|
@@ -57345,9 +57679,7 @@ declare namespace sap {
|
|
|
57345
57679
|
* Returns the meta model associated with this model if it is available for the concrete model type.
|
|
57346
57680
|
*/
|
|
57347
57681
|
getMetaModel(): sap.ui.model.MetaModel;
|
|
57348
|
-
|
|
57349
|
-
* Implement in inheriting classes.
|
|
57350
|
-
*/
|
|
57682
|
+
|
|
57351
57683
|
getObject(
|
|
57352
57684
|
/**
|
|
57353
57685
|
* Path to where to read the object
|
|
@@ -57358,7 +57690,7 @@ declare namespace sap {
|
|
|
57358
57690
|
*/
|
|
57359
57691
|
oContext?: sap.ui.model.Context,
|
|
57360
57692
|
/**
|
|
57361
|
-
* Additional model
|
|
57693
|
+
* Additional model-specific parameters
|
|
57362
57694
|
*/
|
|
57363
57695
|
mParameters?: object
|
|
57364
57696
|
): any;
|
|
@@ -57377,16 +57709,14 @@ declare namespace sap {
|
|
|
57377
57709
|
*/
|
|
57378
57710
|
oContext?: sap.ui.model.Context
|
|
57379
57711
|
): any;
|
|
57380
|
-
|
|
57381
|
-
* Implement in inheriting classes.
|
|
57382
|
-
*/
|
|
57712
|
+
|
|
57383
57713
|
getProperty(
|
|
57384
57714
|
/**
|
|
57385
|
-
*
|
|
57715
|
+
* The path to where to read the attribute value
|
|
57386
57716
|
*/
|
|
57387
57717
|
sPath: string,
|
|
57388
57718
|
/**
|
|
57389
|
-
*
|
|
57719
|
+
* The context with which the path should be resolved
|
|
57390
57720
|
*/
|
|
57391
57721
|
oContext?: sap.ui.model.Context
|
|
57392
57722
|
): any;
|
|
@@ -57527,7 +57857,7 @@ declare namespace sap {
|
|
|
57527
57857
|
*/
|
|
57528
57858
|
static getMetadata(): sap.ui.base.Metadata;
|
|
57529
57859
|
/**
|
|
57530
|
-
* Returns the binding mode
|
|
57860
|
+
* Returns the binding mode.
|
|
57531
57861
|
*/
|
|
57532
57862
|
getBindingMode(): sap.ui.model.BindingMode;
|
|
57533
57863
|
/**
|
|
@@ -57535,7 +57865,7 @@ declare namespace sap {
|
|
|
57535
57865
|
*/
|
|
57536
57866
|
getExternalValue(): any;
|
|
57537
57867
|
/**
|
|
57538
|
-
* Returns the formatter function
|
|
57868
|
+
* Returns the formatter function.
|
|
57539
57869
|
*/
|
|
57540
57870
|
getFormatter(): Function;
|
|
57541
57871
|
/**
|
|
@@ -57543,21 +57873,21 @@ declare namespace sap {
|
|
|
57543
57873
|
* model format} of this binding's type. If this binding doesn't have a type, the original value which is
|
|
57544
57874
|
* stored in the model is returned.
|
|
57545
57875
|
*
|
|
57546
|
-
* This method will be used when targetType
|
|
57876
|
+
* This method will be used when targetType is set to "internal" or when it's included in a {@link sap.ui.model.CompositeBinding
|
|
57547
57877
|
* CompositeBinding} and the CompositeBinding needs to have the related JavaScript primitive values for
|
|
57548
57878
|
* its type or formatter.
|
|
57549
57879
|
*/
|
|
57550
57880
|
getInternalValue(): any;
|
|
57551
57881
|
/**
|
|
57552
|
-
* Returns the raw model value, as it exists in the model dataset
|
|
57882
|
+
* Returns the raw model value, as it exists in the model dataset.
|
|
57553
57883
|
*
|
|
57554
|
-
* This method will be used when targetType of a binding is set to "raw" or it's
|
|
57555
|
-
* CompositeBinding} and the CompositeBinding needs to have the related JavaScript
|
|
57556
|
-
* its type or formatter.
|
|
57884
|
+
* This method will be used when targetType of a binding is set to "raw" or when it's include in a {@link
|
|
57885
|
+
* sap.ui.model.CompositeBinding CompositeBinding} and the CompositeBinding needs to have the related JavaScript
|
|
57886
|
+
* primitive values for its type or formatter.
|
|
57557
57887
|
*/
|
|
57558
57888
|
getRawValue(): any;
|
|
57559
57889
|
/**
|
|
57560
|
-
* Returns the type if any for the binding.
|
|
57890
|
+
* Returns the type (if any) for the binding.
|
|
57561
57891
|
*/
|
|
57562
57892
|
getType(): sap.ui.model.Type;
|
|
57563
57893
|
/**
|
|
@@ -57572,22 +57902,22 @@ declare namespace sap {
|
|
|
57572
57902
|
*/
|
|
57573
57903
|
resume(): void;
|
|
57574
57904
|
/**
|
|
57575
|
-
* Sets the binding mode
|
|
57905
|
+
* Sets the binding mode.
|
|
57576
57906
|
*/
|
|
57577
57907
|
setBindingMode(
|
|
57578
57908
|
/**
|
|
57579
|
-
*
|
|
57909
|
+
* The binding mode
|
|
57580
57910
|
*/
|
|
57581
57911
|
sBindingMode: sap.ui.model.BindingMode
|
|
57582
57912
|
): void;
|
|
57583
57913
|
/**
|
|
57584
57914
|
* Sets the value for this binding. The value is parsed and validated against its type and then set to the
|
|
57585
57915
|
* binding. A model implementation should check if the current default binding mode permits setting the
|
|
57586
|
-
* binding value and if so set the new value
|
|
57916
|
+
* binding value, and if so, set the new value in the model, too.
|
|
57587
57917
|
*/
|
|
57588
57918
|
setExternalValue(
|
|
57589
57919
|
/**
|
|
57590
|
-
*
|
|
57920
|
+
* The value to set for this binding
|
|
57591
57921
|
*/
|
|
57592
57922
|
vValue: any
|
|
57593
57923
|
): undefined | Promise<any>;
|
|
@@ -57596,7 +57926,7 @@ declare namespace sap {
|
|
|
57596
57926
|
*/
|
|
57597
57927
|
setFormatter(
|
|
57598
57928
|
/**
|
|
57599
|
-
*
|
|
57929
|
+
* The formatter function for the binding
|
|
57600
57930
|
*/
|
|
57601
57931
|
fnFormatter: Function
|
|
57602
57932
|
): void;
|
|
@@ -57607,20 +57937,20 @@ declare namespace sap {
|
|
|
57607
57937
|
*/
|
|
57608
57938
|
setInternalValue(
|
|
57609
57939
|
/**
|
|
57610
|
-
*
|
|
57940
|
+
* The value to set for this binding
|
|
57611
57941
|
*/
|
|
57612
57942
|
vValue: any
|
|
57613
|
-
):
|
|
57943
|
+
): Promise<any> | undefined;
|
|
57614
57944
|
/**
|
|
57615
57945
|
* Sets the value for this binding with the raw model value. This setter will perform type validation, in
|
|
57616
57946
|
* case a type is defined on the binding.
|
|
57617
57947
|
*/
|
|
57618
57948
|
setRawValue(
|
|
57619
57949
|
/**
|
|
57620
|
-
*
|
|
57950
|
+
* The value to set for this binding
|
|
57621
57951
|
*/
|
|
57622
57952
|
vValue: any
|
|
57623
|
-
):
|
|
57953
|
+
): Promise<any> | undefined;
|
|
57624
57954
|
/**
|
|
57625
57955
|
* Sets the optional type and internal type for the binding. The type and internal type are used to do the
|
|
57626
57956
|
* parsing/formatting correctly. The internal type is the property type of the element which the value is
|
|
@@ -57628,17 +57958,17 @@ declare namespace sap {
|
|
|
57628
57958
|
*/
|
|
57629
57959
|
setType(
|
|
57630
57960
|
/**
|
|
57631
|
-
*
|
|
57961
|
+
* The type for the binding
|
|
57632
57962
|
*/
|
|
57633
57963
|
oType: sap.ui.model.Type,
|
|
57634
57964
|
/**
|
|
57635
|
-
*
|
|
57965
|
+
* The internal type of the element property which this binding is bound against.
|
|
57636
57966
|
*/
|
|
57637
57967
|
sInternalType: string
|
|
57638
57968
|
): void;
|
|
57639
57969
|
/**
|
|
57640
57970
|
* Sets the value for this binding. A model implementation should check if the current default binding mode
|
|
57641
|
-
* permits setting the binding value and if so set the new value
|
|
57971
|
+
* permits setting the binding value, and if so, set the new value in the model, too.
|
|
57642
57972
|
*/
|
|
57643
57973
|
setValue(
|
|
57644
57974
|
/**
|
|
@@ -58348,18 +58678,18 @@ declare namespace sap {
|
|
|
58348
58678
|
* @deprecated (since 1.52) - This method is marked as 'protected' which was meant to be overwritten by
|
|
58349
58679
|
* its subclasses. It may be renamed or deleted and should only be called from this class or its subclasses.
|
|
58350
58680
|
*
|
|
58351
|
-
* Calculate the request length based on the given information
|
|
58681
|
+
* Calculate the request length based on the given information.
|
|
58352
58682
|
*/
|
|
58353
58683
|
_calculateRequestLength(
|
|
58354
58684
|
/**
|
|
58355
|
-
*
|
|
58685
|
+
* The maximum group size
|
|
58356
58686
|
*/
|
|
58357
|
-
iMaxGroupSize:
|
|
58687
|
+
iMaxGroupSize: number,
|
|
58358
58688
|
/**
|
|
58359
|
-
*
|
|
58689
|
+
* The information of the current section
|
|
58360
58690
|
*/
|
|
58361
58691
|
oSection: object
|
|
58362
|
-
):
|
|
58692
|
+
): number;
|
|
58363
58693
|
/**
|
|
58364
58694
|
* Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of
|
|
58365
58695
|
* this `sap.ui.model.TreeBindingAdapter`.
|
|
@@ -58458,6 +58788,10 @@ declare namespace sap {
|
|
|
58458
58788
|
*/
|
|
58459
58789
|
iThreshold?: number
|
|
58460
58790
|
): sap.ui.model.Context[];
|
|
58791
|
+
/**
|
|
58792
|
+
* Returns the number of entries in the tree.
|
|
58793
|
+
*/
|
|
58794
|
+
getLength(): number;
|
|
58461
58795
|
/**
|
|
58462
58796
|
* Gets an array of nodes for the requested part of the tree.
|
|
58463
58797
|
*/
|
|
@@ -58476,7 +58810,9 @@ declare namespace sap {
|
|
|
58476
58810
|
iThreshold?: number
|
|
58477
58811
|
): object[];
|
|
58478
58812
|
}
|
|
58479
|
-
|
|
58813
|
+
/**
|
|
58814
|
+
* @deprecated - use {@link sap.ui.model.TreeBindingAdapter} instead
|
|
58815
|
+
*/
|
|
58480
58816
|
class TreeBindingCompatibilityAdapter {
|
|
58481
58817
|
/**
|
|
58482
58818
|
* Adapter for TreeBindings to add the ListBinding functionality and use the tree structure in list based
|
|
@@ -58484,7 +58820,16 @@ declare namespace sap {
|
|
|
58484
58820
|
*
|
|
58485
58821
|
* This module is only for experimental and internal use!
|
|
58486
58822
|
*/
|
|
58487
|
-
constructor(
|
|
58823
|
+
constructor(
|
|
58824
|
+
/**
|
|
58825
|
+
* The binding to add ListBinding functionality to
|
|
58826
|
+
*/
|
|
58827
|
+
oBinding: sap.ui.model.TreeBinding,
|
|
58828
|
+
/**
|
|
58829
|
+
* The tree or tree table control using the given binding; the control is used for selection handling
|
|
58830
|
+
*/
|
|
58831
|
+
oControl: object
|
|
58832
|
+
);
|
|
58488
58833
|
}
|
|
58489
58834
|
/**
|
|
58490
58835
|
* This is an abstract base class for type objects.
|
|
@@ -60689,6 +61034,13 @@ declare namespace sap {
|
|
|
60689
61034
|
* The name of the {@link sap.ui.model.resource.ResourceModel} assigned to the control.
|
|
60690
61035
|
*/
|
|
60691
61036
|
modelName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
61037
|
+
|
|
61038
|
+
/**
|
|
61039
|
+
* The boolean flag to indicate whether to utiliize the library bundle of the control
|
|
61040
|
+
*/
|
|
61041
|
+
useLibraryBundle?:
|
|
61042
|
+
| boolean
|
|
61043
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
60692
61044
|
}
|
|
60693
61045
|
|
|
60694
61046
|
interface $InteractableSettings
|
|
@@ -61364,7 +61716,8 @@ declare namespace sap {
|
|
|
61364
61716
|
* The I18NText matcher checks if a control property has the same value as a text from an I18N file.
|
|
61365
61717
|
*
|
|
61366
61718
|
* The matcher automatically:
|
|
61367
|
-
* - retrieves the text from the assigned 'i18n' model (name can be changed)
|
|
61719
|
+
* - retrieves the text from the assigned 'i18n' model (name can be changed) or library resource bundle
|
|
61720
|
+
*
|
|
61368
61721
|
* - checks that the I18N key does actually exist in the file
|
|
61369
61722
|
* - checks if asynchronously loaded I18N have actually been loaded
|
|
61370
61723
|
*
|
|
@@ -61379,6 +61732,10 @@ declare namespace sap {
|
|
|
61379
61732
|
* }
|
|
61380
61733
|
* }
|
|
61381
61734
|
* ```
|
|
61735
|
+
*
|
|
61736
|
+
*
|
|
61737
|
+
* As of version 1.95 if the `useLibraryBundle` flag is set to `true`, the library resource bundle of the
|
|
61738
|
+
* control is used to resolve the i18n key.
|
|
61382
61739
|
*/
|
|
61383
61740
|
class I18NText extends sap.ui.test.matchers.Matcher {
|
|
61384
61741
|
/**
|
|
@@ -61444,6 +61801,12 @@ declare namespace sap {
|
|
|
61444
61801
|
* The name of the control property to match the I18N text with.
|
|
61445
61802
|
*/
|
|
61446
61803
|
getPropertyName(): string;
|
|
61804
|
+
/**
|
|
61805
|
+
* Gets current value of property {@link #getUseLibraryBundle useLibraryBundle}.
|
|
61806
|
+
*
|
|
61807
|
+
* The boolean flag to indicate whether to utiliize the library bundle of the control
|
|
61808
|
+
*/
|
|
61809
|
+
getUseLibraryBundle(): boolean;
|
|
61447
61810
|
/**
|
|
61448
61811
|
* Checks if the control has a property that matches the I18N text
|
|
61449
61812
|
*/
|
|
@@ -61507,6 +61870,19 @@ declare namespace sap {
|
|
|
61507
61870
|
*/
|
|
61508
61871
|
sPropertyName: string
|
|
61509
61872
|
): this;
|
|
61873
|
+
/**
|
|
61874
|
+
* Sets a new value for property {@link #getUseLibraryBundle useLibraryBundle}.
|
|
61875
|
+
*
|
|
61876
|
+
* The boolean flag to indicate whether to utiliize the library bundle of the control
|
|
61877
|
+
*
|
|
61878
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
61879
|
+
*/
|
|
61880
|
+
setUseLibraryBundle(
|
|
61881
|
+
/**
|
|
61882
|
+
* New value for property `useLibraryBundle`
|
|
61883
|
+
*/
|
|
61884
|
+
bUseLibraryBundle: boolean
|
|
61885
|
+
): this;
|
|
61510
61886
|
}
|
|
61511
61887
|
/**
|
|
61512
61888
|
* @SINCE 1.34
|