@openui5/ts-types 1.97.1 → 1.98.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/sap.f.d.ts +108 -573
- package/types/sap.m.d.ts +2648 -268
- package/types/sap.tnt.d.ts +31 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +819 -199
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +7 -1
- package/types/sap.ui.integration.d.ts +21 -3
- package/types/sap.ui.layout.d.ts +4 -4
- package/types/sap.ui.mdc.d.ts +12 -6
- 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 +30 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +35 -105
- package/types/sap.ui.webc.main.d.ts +16 -29
- package/types/sap.uxap.d.ts +1 -1
package/types/sap.ui.core.d.ts
CHANGED
|
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
|
|
|
264
264
|
): jQuery;
|
|
265
265
|
}
|
|
266
266
|
|
|
267
|
-
// For Library Version: 1.
|
|
267
|
+
// For Library Version: 1.98.0
|
|
268
268
|
|
|
269
269
|
declare module "sap/base/assert" {
|
|
270
270
|
/**
|
|
@@ -2001,6 +2001,76 @@ declare module "sap/base/util/Version" {
|
|
|
2001
2001
|
}
|
|
2002
2002
|
}
|
|
2003
2003
|
|
|
2004
|
+
declare module "sap/ui/util/XMLHelper" {
|
|
2005
|
+
/**
|
|
2006
|
+
* Error information as provided by the `DOMParser`.
|
|
2007
|
+
*
|
|
2008
|
+
* Note that the set of properties with meaningful content differs between browsers.
|
|
2009
|
+
*/
|
|
2010
|
+
export type XMLParseErrorInfo = {
|
|
2011
|
+
errorCode?: int;
|
|
2012
|
+
|
|
2013
|
+
url?: sap.ui.core.URI;
|
|
2014
|
+
|
|
2015
|
+
reason?: string;
|
|
2016
|
+
|
|
2017
|
+
srcText?: string;
|
|
2018
|
+
|
|
2019
|
+
line?: int;
|
|
2020
|
+
|
|
2021
|
+
linepos?: int;
|
|
2022
|
+
|
|
2023
|
+
filepos?: int;
|
|
2024
|
+
|
|
2025
|
+
type?: "error" | "warning";
|
|
2026
|
+
};
|
|
2027
|
+
|
|
2028
|
+
/**
|
|
2029
|
+
* @SINCE 1.58
|
|
2030
|
+
*
|
|
2031
|
+
* Provides functionality for parsing XML formatted strings and serializing XML documents.
|
|
2032
|
+
*/
|
|
2033
|
+
interface XMLHelper {
|
|
2034
|
+
/**
|
|
2035
|
+
* Extracts parse error information from the specified document (if any).
|
|
2036
|
+
*
|
|
2037
|
+
* If an error was found, the returned object contains a browser-specific subset of the properties described
|
|
2038
|
+
* in {@link module:sap/base/util/XMLHelper.XMLParseErrorInfo XMLParseErrorInfo}. Otherwise, it just contains
|
|
2039
|
+
* an `errorCode` property with value 0.
|
|
2040
|
+
*/
|
|
2041
|
+
getParseError(
|
|
2042
|
+
/**
|
|
2043
|
+
* The parsed XML document
|
|
2044
|
+
*/
|
|
2045
|
+
oDocument: XMLDocument
|
|
2046
|
+
): XMLParseErrorInfo;
|
|
2047
|
+
/**
|
|
2048
|
+
* Parses the specified XML string into an XML document, using the native parsing functionality of the browser.
|
|
2049
|
+
* If an error occurs during parsing, a {@link module:sap/base/util/XMLHelper.XMLParseErrorInfo parse error
|
|
2050
|
+
* info object} is attached as the `parseError` property of the returned document.
|
|
2051
|
+
*/
|
|
2052
|
+
parse(
|
|
2053
|
+
/**
|
|
2054
|
+
* An XML string
|
|
2055
|
+
*/
|
|
2056
|
+
sXMLText: string
|
|
2057
|
+
): XMLDocument;
|
|
2058
|
+
/**
|
|
2059
|
+
* Serializes the specified DOM tree into a string representation.
|
|
2060
|
+
* See:
|
|
2061
|
+
* {@link https://developer.mozilla.org/en-US/docs/Web/API/XMLSerializer/serializeToString}
|
|
2062
|
+
*/
|
|
2063
|
+
serialize(
|
|
2064
|
+
/**
|
|
2065
|
+
* the XML document object to be serialized as string
|
|
2066
|
+
*/
|
|
2067
|
+
oXMLDocument: Node | Attr
|
|
2068
|
+
): string;
|
|
2069
|
+
}
|
|
2070
|
+
const XMLHelper: XMLHelper;
|
|
2071
|
+
export default XMLHelper;
|
|
2072
|
+
}
|
|
2073
|
+
|
|
2004
2074
|
declare module "sap/ui/core/ComponentSupport" {
|
|
2005
2075
|
/**
|
|
2006
2076
|
* @SINCE 1.58.0
|
|
@@ -3527,51 +3597,6 @@ declare module "sap/ui/util/Storage" {
|
|
|
3527
3597
|
}
|
|
3528
3598
|
}
|
|
3529
3599
|
|
|
3530
|
-
declare module "sap/ui/util/XMLHelper" {
|
|
3531
|
-
/**
|
|
3532
|
-
* @SINCE 1.58
|
|
3533
|
-
*
|
|
3534
|
-
* Provides functionality for parsing XML formatted strings and serializing XML documents.
|
|
3535
|
-
*/
|
|
3536
|
-
interface XMLHelper {
|
|
3537
|
-
/**
|
|
3538
|
-
* Extracts parse error information from the specified document (if any).
|
|
3539
|
-
*
|
|
3540
|
-
* If an error was found the returned object has the following error information parameters: errorCode,
|
|
3541
|
-
* url, reason, srcText, line, linepos, filepos
|
|
3542
|
-
*/
|
|
3543
|
-
getParseError(
|
|
3544
|
-
/**
|
|
3545
|
-
* the parsed XML document
|
|
3546
|
-
*/
|
|
3547
|
-
oDocument: string
|
|
3548
|
-
): object;
|
|
3549
|
-
/**
|
|
3550
|
-
* Parses the specified XML formatted string text using native parsing function of the browser and returns
|
|
3551
|
-
* a valid XML document. If an error occurred during parsing a parse error xobject is returned as property
|
|
3552
|
-
* (parseError) of the returned XML document object. The parse error object has the following error information
|
|
3553
|
-
* parameters: errorCode, url, reason, srcText, line, linepos, filepos
|
|
3554
|
-
*/
|
|
3555
|
-
parse(
|
|
3556
|
-
/**
|
|
3557
|
-
* the XML data as string
|
|
3558
|
-
*/
|
|
3559
|
-
sXMLText: string
|
|
3560
|
-
): object;
|
|
3561
|
-
/**
|
|
3562
|
-
* Serializes the specified XML document into a string representation.
|
|
3563
|
-
*/
|
|
3564
|
-
serialize(
|
|
3565
|
-
/**
|
|
3566
|
-
* the XML document object to be serialized as string
|
|
3567
|
-
*/
|
|
3568
|
-
oXMLDocument: string
|
|
3569
|
-
): object;
|
|
3570
|
-
}
|
|
3571
|
-
const XMLHelper: XMLHelper;
|
|
3572
|
-
export default XMLHelper;
|
|
3573
|
-
}
|
|
3574
|
-
|
|
3575
3600
|
declare module "sap/ui/VersionInfo" {
|
|
3576
3601
|
/**
|
|
3577
3602
|
* @SINCE 1.56.0
|
|
@@ -3974,8 +3999,8 @@ declare namespace sap {
|
|
|
3974
3999
|
* using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
|
|
3975
4000
|
* executing the factory function.
|
|
3976
4001
|
*
|
|
3977
|
-
*
|
|
3978
|
-
* - **
|
|
4002
|
+
* Restrictions, Design Considerations:
|
|
4003
|
+
* - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
|
|
3979
4004
|
* proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
|
|
3980
4005
|
* this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
|
|
3981
4006
|
* loading is implemented.
|
|
@@ -4223,8 +4248,8 @@ declare namespace sap {
|
|
|
4223
4248
|
* using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
|
|
4224
4249
|
* executing the factory function.
|
|
4225
4250
|
*
|
|
4226
|
-
*
|
|
4227
|
-
* - **
|
|
4251
|
+
* Restrictions, Design Considerations:
|
|
4252
|
+
* - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
|
|
4228
4253
|
* proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
|
|
4229
4254
|
* this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
|
|
4230
4255
|
* loading is implemented.
|
|
@@ -4466,8 +4491,8 @@ declare namespace sap {
|
|
|
4466
4491
|
* using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
|
|
4467
4492
|
* executing the factory function.
|
|
4468
4493
|
*
|
|
4469
|
-
*
|
|
4470
|
-
* - **
|
|
4494
|
+
* Restrictions, Design Considerations:
|
|
4495
|
+
* - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
|
|
4471
4496
|
* proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
|
|
4472
4497
|
* this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
|
|
4473
4498
|
* loading is implemented.
|
|
@@ -4710,8 +4735,8 @@ declare namespace sap {
|
|
|
4710
4735
|
* using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
|
|
4711
4736
|
* executing the factory function.
|
|
4712
4737
|
*
|
|
4713
|
-
*
|
|
4714
|
-
* - **
|
|
4738
|
+
* Restrictions, Design Considerations:
|
|
4739
|
+
* - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
|
|
4715
4740
|
* proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
|
|
4716
4741
|
* this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
|
|
4717
4742
|
* loading is implemented.
|
|
@@ -5442,7 +5467,7 @@ declare namespace sap {
|
|
|
5442
5467
|
fnCallback?: Function,
|
|
5443
5468
|
/**
|
|
5444
5469
|
* Callback function to execute if an error was detected while loading the dependencies or executing the
|
|
5445
|
-
* factory function. Note that due to browser
|
|
5470
|
+
* factory function. Note that due to browser restrictions not all errors will be reported via this callback.
|
|
5446
5471
|
* In general, module loading is designed for the non-error case. Error handling is not complete.
|
|
5447
5472
|
*/
|
|
5448
5473
|
fnErrback?: Function
|
|
@@ -7439,15 +7464,14 @@ declare namespace sap {
|
|
|
7439
7464
|
* - `byValue: boolean` (either can be omitted or set to the boolean value `true`) If set to `true`,
|
|
7440
7465
|
* the property value will be {@link module:sap/base/util/deepClone deep cloned} on write and read operations
|
|
7441
7466
|
* to ensure that the internal value can't be modified by the outside. The property `byValue` is currently
|
|
7442
|
-
*
|
|
7443
|
-
* boolean values for the flag (or omit it), but readers of ManagedObject metadata should handle any
|
|
7444
|
-
* value as `true` to be future safe. Note that using `byValue:true` has a performance impact on
|
|
7445
|
-
* access and therefore should be used carefully. It also doesn't make sense to set this option
|
|
7446
|
-
* with a primitive type (they have value semantic anyhow) or for properties with arrays
|
|
7447
|
-
* (they
|
|
7448
|
-
*
|
|
7449
|
-
*
|
|
7450
|
-
* Appearance, Behavior, Data, Designtime, Dimension, Identification, Misc
|
|
7467
|
+
* restricted to a `boolean` value. Other types are reserved for future use. Class definitions must only
|
|
7468
|
+
* use boolean values for the flag (or omit it), but readers of ManagedObject metadata should handle any
|
|
7469
|
+
* truthy value as `true` to be future safe. Note that using `byValue:true` has a performance impact on
|
|
7470
|
+
* property access and therefore should be used carefully. It also doesn't make sense to set this option
|
|
7471
|
+
* for properties with a primitive type (they have value semantic anyhow) or for properties with arrays
|
|
7472
|
+
* of primitive types (they are already cloned with a less expensive implementation). `group:string`
|
|
7473
|
+
* a semantic grouping of the properties, intended to be used in design time tools. Allowed values are (case
|
|
7474
|
+
* sensitive): Accessibility, Appearance, Behavior, Data, Designtime, Dimension, Identification, Misc
|
|
7451
7475
|
* - `defaultValue: any` the default value for the property or null if there is no defaultValue.
|
|
7452
7476
|
*
|
|
7453
7477
|
* - `bindable: boolean|string` (either can be omitted or set to the boolean value `true` or the
|
|
@@ -14040,6 +14064,8 @@ declare namespace sap {
|
|
|
14040
14064
|
|
|
14041
14065
|
namespace XMLView {
|
|
14042
14066
|
/**
|
|
14067
|
+
* @SINCE 1.34
|
|
14068
|
+
*
|
|
14043
14069
|
* Specifies the available preprocessor types for XMLViews
|
|
14044
14070
|
* See:
|
|
14045
14071
|
* sap.ui.core.mvc.XMLView
|
|
@@ -14677,6 +14703,8 @@ declare namespace sap {
|
|
|
14677
14703
|
static asyncSupport: boolean;
|
|
14678
14704
|
|
|
14679
14705
|
/**
|
|
14706
|
+
* @SINCE 1.56.0
|
|
14707
|
+
*
|
|
14680
14708
|
* Creates a JSON view of the given configuration.
|
|
14681
14709
|
*/
|
|
14682
14710
|
static create(
|
|
@@ -15146,6 +15174,8 @@ declare namespace sap {
|
|
|
15146
15174
|
*/
|
|
15147
15175
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
15148
15176
|
/**
|
|
15177
|
+
* @SINCE 1.30
|
|
15178
|
+
*
|
|
15149
15179
|
* Register a preprocessor for all views of a specific type.
|
|
15150
15180
|
*
|
|
15151
15181
|
* The preprocessor can be registered for several stages of view initialization, which are dependent on
|
|
@@ -15816,6 +15846,8 @@ declare namespace sap {
|
|
|
15816
15846
|
static asyncSupport: boolean;
|
|
15817
15847
|
|
|
15818
15848
|
/**
|
|
15849
|
+
* @SINCE 1.56.0
|
|
15850
|
+
*
|
|
15819
15851
|
* Instantiates an XMLView from the given configuration options.
|
|
15820
15852
|
*
|
|
15821
15853
|
* If a `viewName` is given, it must be a dot-separated name of an XML view resource (without the mandatory
|
|
@@ -15901,6 +15933,8 @@ declare namespace sap {
|
|
|
15901
15933
|
*/
|
|
15902
15934
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
15903
15935
|
/**
|
|
15936
|
+
* @SINCE 1.30
|
|
15937
|
+
*
|
|
15904
15938
|
* Register a preprocessor for all views of a specific type.
|
|
15905
15939
|
*
|
|
15906
15940
|
* The preprocessor can be registered for several stages of view initialization, for xml views these are
|
|
@@ -15947,6 +15981,8 @@ declare namespace sap {
|
|
|
15947
15981
|
mSettings?: object
|
|
15948
15982
|
): void;
|
|
15949
15983
|
/**
|
|
15984
|
+
* @SINCE 1.30
|
|
15985
|
+
*
|
|
15950
15986
|
* Register a preprocessor for all views of a specific type.
|
|
15951
15987
|
*
|
|
15952
15988
|
* The preprocessor can be registered for several stages of view initialization, for xml views these are
|
|
@@ -16055,14 +16091,6 @@ declare namespace sap {
|
|
|
16055
16091
|
* The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
|
|
16056
16092
|
* API calls for the same parameter name will always result in the same parameter value.
|
|
16057
16093
|
*
|
|
16058
|
-
* **Important, since 1.93:** When using the `Parameters.get()` API to retrieve theming parameters defined
|
|
16059
|
-
* as CSS variables, please be aware that the API can also unknowingly retrieve arbitrary CSS variables
|
|
16060
|
-
* defined in the DOM. All CSS variables defined via the `:root` pseudo-class can be retrieved this way.
|
|
16061
|
-
* Please make sure to only access theming parameters defined in a UI5 theme/library.
|
|
16062
|
-
*
|
|
16063
|
-
*
|
|
16064
|
-
*
|
|
16065
|
-
*
|
|
16066
16094
|
* The following API variants are available (see also the below examples):
|
|
16067
16095
|
* - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
|
|
16068
16096
|
* returned
|
|
@@ -17185,7 +17213,7 @@ declare namespace sap {
|
|
|
17185
17213
|
|
|
17186
17214
|
class Route extends sap.ui.base.EventProvider {
|
|
17187
17215
|
/**
|
|
17188
|
-
* Instantiates
|
|
17216
|
+
* Instantiates a route
|
|
17189
17217
|
*/
|
|
17190
17218
|
constructor(
|
|
17191
17219
|
/**
|
|
@@ -17264,21 +17292,21 @@ declare namespace sap {
|
|
|
17264
17292
|
targetParent?: string;
|
|
17265
17293
|
/**
|
|
17266
17294
|
* **Deprecated since 1.28, use `target.controlId` instead.**
|
|
17267
|
-
* Views will be put into a container Control, this might be
|
|
17268
|
-
* sap.m.NavContainer} if working with mobile, or any other container. The id of this control has
|
|
17269
|
-
* put in here
|
|
17295
|
+
* Views will be put into a container Control, this might be an {@link sap.ui.ux3.Shell} control or an
|
|
17296
|
+
* {@link sap.m.NavContainer} if working with mobile, or any other container. The id of this control has
|
|
17297
|
+
* to be put in here
|
|
17270
17298
|
*/
|
|
17271
17299
|
targetControl?: string;
|
|
17272
17300
|
/**
|
|
17273
17301
|
* **Deprecated since 1.28, use `target.controlAggregation` instead.**
|
|
17274
|
-
* The name of an aggregation of the targetControl, that contains views. Eg:
|
|
17302
|
+
* The name of an aggregation of the targetControl, that contains views. Eg: an {@link sap.m.NavContainer}
|
|
17275
17303
|
* has an aggregation "pages", another Example is the {@link sap.ui.ux3.Shell} it has "content".
|
|
17276
17304
|
*/
|
|
17277
17305
|
targetAggregation?: string;
|
|
17278
17306
|
/**
|
|
17279
17307
|
* **Deprecated since 1.28, use `target.clearControlAggregation` instead.**
|
|
17280
17308
|
* Defines a boolean that can be passed to specify if the aggregation should be cleared before adding the
|
|
17281
|
-
* View to it. When using
|
|
17309
|
+
* View to it. When using an {@link sap.ui.ux3.Shell} this should be true. For an {@link sap.m.NavContainer}
|
|
17282
17310
|
* it should be false
|
|
17283
17311
|
*/
|
|
17284
17312
|
clearTarget?: boolean;
|
|
@@ -17543,7 +17571,7 @@ declare namespace sap {
|
|
|
17543
17571
|
|
|
17544
17572
|
class Router extends sap.ui.base.EventProvider {
|
|
17545
17573
|
/**
|
|
17546
|
-
* Instantiates a
|
|
17574
|
+
* Instantiates a router
|
|
17547
17575
|
*/
|
|
17548
17576
|
constructor(
|
|
17549
17577
|
/**
|
|
@@ -17681,7 +17709,8 @@ declare namespace sap {
|
|
|
17681
17709
|
* {
|
|
17682
17710
|
* //same name as in the config.bypassed.target
|
|
17683
17711
|
* notFound: {
|
|
17684
|
-
*
|
|
17712
|
+
* type: "View"
|
|
17713
|
+
* name: "notFound",
|
|
17685
17714
|
* ...
|
|
17686
17715
|
* // more properties to place the view in the correct container
|
|
17687
17716
|
* }
|
|
@@ -18753,8 +18782,8 @@ declare namespace sap {
|
|
|
18753
18782
|
*/
|
|
18754
18783
|
constructor(oOptions: {
|
|
18755
18784
|
/**
|
|
18756
|
-
* the views instance will create the
|
|
18757
|
-
* the same instance of the
|
|
18785
|
+
* the views instance will create the instances of all the targets defined, so if 2 targets have the same
|
|
18786
|
+
* `type` and `name` set, the same instance of the target will be displayed.
|
|
18758
18787
|
*/
|
|
18759
18788
|
views: sap.ui.core.routing.Views;
|
|
18760
18789
|
/**
|
|
@@ -18892,8 +18921,8 @@ declare namespace sap {
|
|
|
18892
18921
|
/**
|
|
18893
18922
|
* Defines the name of the View or Component that will be created. For type 'Component', use option 'usage'
|
|
18894
18923
|
* instead if an owner component exists. To place the view or component into a Control, use the options
|
|
18895
|
-
*
|
|
18896
|
-
* or
|
|
18924
|
+
* `controlAggregation` and `controlId`. Instance of View or Component will only be created once per `name`
|
|
18925
|
+
* or `usage` combined with `id`.
|
|
18897
18926
|
* ```javascript
|
|
18898
18927
|
*
|
|
18899
18928
|
*
|
|
@@ -18928,21 +18957,22 @@ declare namespace sap {
|
|
|
18928
18957
|
*
|
|
18929
18958
|
* {
|
|
18930
18959
|
* targets: {
|
|
18931
|
-
* // If display("masterWelcome") is called, the
|
|
18960
|
+
* // If display("masterWelcome") is called, the view with name "Welcome" will be placed in the 'MasterPages' of a control with the id splitContainter
|
|
18932
18961
|
* masterWelcome: {
|
|
18933
18962
|
* type: "View",
|
|
18934
18963
|
* name: "Welcome",
|
|
18935
|
-
* controlId: "splitContainer",
|
|
18936
|
-
* controlAggregation: "masterPages",
|
|
18937
18964
|
* id: "masterWelcome",
|
|
18965
|
+
* controlId: "splitContainer",
|
|
18966
|
+
* controlAggregation: "masterPages"
|
|
18938
18967
|
* },
|
|
18939
|
-
* // If display("detailWelcome") is called after the masterWelcome, a second instance with
|
|
18968
|
+
* // If display("detailWelcome") is called after the "masterWelcome" target, a second instance of the same view with its own controller instance will be added in the detail pages.
|
|
18940
18969
|
* detailWelcome: {
|
|
18941
18970
|
* type: "View",
|
|
18942
|
-
* name: "
|
|
18971
|
+
* name: "Welcome",
|
|
18972
|
+
* // another instance will be created because a different id is used
|
|
18973
|
+
* id: "detailWelcome",
|
|
18943
18974
|
* controlId: "splitContainer",
|
|
18944
|
-
* controlAggregation: "detailPages"
|
|
18945
|
-
* id: "detailWelcome"
|
|
18975
|
+
* controlAggregation: "detailPages"
|
|
18946
18976
|
* }
|
|
18947
18977
|
* }
|
|
18948
18978
|
* }
|
|
@@ -18962,8 +18992,9 @@ declare namespace sap {
|
|
|
18962
18992
|
*/
|
|
18963
18993
|
viewType?: string;
|
|
18964
18994
|
/**
|
|
18965
|
-
* A prefix that will be prepended in front of the name
|
|
18966
|
-
* **Example:** name is set to "myView" and path is set to "myApp" - the created view name will be
|
|
18995
|
+
* A prefix that will be prepended in front of the `name`.
|
|
18996
|
+
* **Example:** `name` is set to "myView" and `path` is set to "myApp" - the created view's name will be
|
|
18997
|
+
* "myApp.myView".
|
|
18967
18998
|
*/
|
|
18968
18999
|
path?: string;
|
|
18969
19000
|
/**
|
|
@@ -21059,6 +21090,153 @@ declare namespace sap {
|
|
|
21059
21090
|
|
|
21060
21091
|
namespace util {
|
|
21061
21092
|
namespace MockServer {
|
|
21093
|
+
/**
|
|
21094
|
+
* Methods that can be used to respond to a request.
|
|
21095
|
+
*/
|
|
21096
|
+
interface Response {
|
|
21097
|
+
__implements__sap_ui_core_util_MockServer_Response: boolean;
|
|
21098
|
+
|
|
21099
|
+
/**
|
|
21100
|
+
* Responds to the incoming request with the given `iStatusCode`, `mHeaders` and `sBody`.
|
|
21101
|
+
*/
|
|
21102
|
+
respond(
|
|
21103
|
+
/**
|
|
21104
|
+
* HTTP status code to send with the response
|
|
21105
|
+
*/
|
|
21106
|
+
StatusCode?: int,
|
|
21107
|
+
/**
|
|
21108
|
+
* HTTP headers to send with the response
|
|
21109
|
+
*/
|
|
21110
|
+
mHeaders?: Record<string, string>,
|
|
21111
|
+
/**
|
|
21112
|
+
* A string that will be sent as response body
|
|
21113
|
+
*/
|
|
21114
|
+
sBody?: string
|
|
21115
|
+
): void;
|
|
21116
|
+
/**
|
|
21117
|
+
* Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
|
|
21118
|
+
*
|
|
21119
|
+
* This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
|
|
21120
|
+
* the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
|
|
21121
|
+
* or {@link #respond}, using the given `iStatus` and `mHeaders`.
|
|
21122
|
+
*
|
|
21123
|
+
* The status code and headers of the received response are ignored. In particular, the `Content-Type` header
|
|
21124
|
+
* is not used for the mock server's response.
|
|
21125
|
+
*/
|
|
21126
|
+
respondFile(
|
|
21127
|
+
/**
|
|
21128
|
+
* HTTP status code to send with the response
|
|
21129
|
+
*/
|
|
21130
|
+
iStatusCode: int,
|
|
21131
|
+
/**
|
|
21132
|
+
* HTTP Headers to send with the response
|
|
21133
|
+
*/
|
|
21134
|
+
mHeaders: Record<string, string>,
|
|
21135
|
+
/**
|
|
21136
|
+
* URL to get the response body from
|
|
21137
|
+
*/
|
|
21138
|
+
sFileUrl: string
|
|
21139
|
+
): void;
|
|
21140
|
+
/**
|
|
21141
|
+
* Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
|
|
21142
|
+
*
|
|
21143
|
+
* This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
|
|
21144
|
+
* the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
|
|
21145
|
+
* or {@link #respond}, using the given `iStatus` and `mHeaders`.
|
|
21146
|
+
*
|
|
21147
|
+
* The status code and headers of the received response are ignored. In particular, the `Content-Type` header
|
|
21148
|
+
* is not used for the mock server's response.
|
|
21149
|
+
*/
|
|
21150
|
+
respondFile(
|
|
21151
|
+
/**
|
|
21152
|
+
* HTTP status code to send with the response
|
|
21153
|
+
*/
|
|
21154
|
+
iStatusCode: int,
|
|
21155
|
+
/**
|
|
21156
|
+
* URL to get the response body from
|
|
21157
|
+
*/
|
|
21158
|
+
sFileUrl: string
|
|
21159
|
+
): void;
|
|
21160
|
+
/**
|
|
21161
|
+
* Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
|
|
21162
|
+
*
|
|
21163
|
+
* This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
|
|
21164
|
+
* the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
|
|
21165
|
+
* or {@link #respond}, using the given `iStatus` and `mHeaders`.
|
|
21166
|
+
*
|
|
21167
|
+
* The status code and headers of the received response are ignored. In particular, the `Content-Type` header
|
|
21168
|
+
* is not used for the mock server's response.
|
|
21169
|
+
*/
|
|
21170
|
+
respondFile(
|
|
21171
|
+
/**
|
|
21172
|
+
* HTTP Headers to send with the response
|
|
21173
|
+
*/
|
|
21174
|
+
mHeaders: Record<string, string>,
|
|
21175
|
+
/**
|
|
21176
|
+
* URL to get the response body from
|
|
21177
|
+
*/
|
|
21178
|
+
sFileUrl: string
|
|
21179
|
+
): void;
|
|
21180
|
+
/**
|
|
21181
|
+
* Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
|
|
21182
|
+
*
|
|
21183
|
+
* This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
|
|
21184
|
+
* the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
|
|
21185
|
+
* or {@link #respond}, using the given `iStatus` and `mHeaders`.
|
|
21186
|
+
*
|
|
21187
|
+
* The status code and headers of the received response are ignored. In particular, the `Content-Type` header
|
|
21188
|
+
* is not used for the mock server's response.
|
|
21189
|
+
*/
|
|
21190
|
+
respondFile(
|
|
21191
|
+
/**
|
|
21192
|
+
* URL to get the response body from
|
|
21193
|
+
*/
|
|
21194
|
+
sFileUrl: string
|
|
21195
|
+
): void;
|
|
21196
|
+
/**
|
|
21197
|
+
* Convenience variant of {@link #respond} which simplifies sending a JSON response.
|
|
21198
|
+
*
|
|
21199
|
+
* The response content `vBody` can either be given as a string, which is then assumed to be in JSON format.
|
|
21200
|
+
* Or it can be any JSON-stringifiable value which then will be converted to a string using `JSON.stringify`.
|
|
21201
|
+
* If no `vBody` is given, an empty response will be sent.
|
|
21202
|
+
*
|
|
21203
|
+
* If no `Content-Type` header is given, it will be set to `application/json`.
|
|
21204
|
+
*/
|
|
21205
|
+
respondJSON(
|
|
21206
|
+
/**
|
|
21207
|
+
* HTTP status code to send with the response
|
|
21208
|
+
*/
|
|
21209
|
+
iStatusCode?: int,
|
|
21210
|
+
/**
|
|
21211
|
+
* HTTP Headers to send with the response
|
|
21212
|
+
*/
|
|
21213
|
+
mHeaders?: Record<string, string>,
|
|
21214
|
+
/**
|
|
21215
|
+
* A valid JSON-string or a JSON-stringifiable object that should be sent as response body
|
|
21216
|
+
*/
|
|
21217
|
+
vBody?: object | string
|
|
21218
|
+
): void;
|
|
21219
|
+
/**
|
|
21220
|
+
* Convenience variant of {@link #respond} which simplifies sending an XML response.
|
|
21221
|
+
*
|
|
21222
|
+
* If no `Content-Type` header is given, it will be set to `application/xml`.
|
|
21223
|
+
*/
|
|
21224
|
+
respondXML(
|
|
21225
|
+
/**
|
|
21226
|
+
* HTTP status code to send with the response
|
|
21227
|
+
*/
|
|
21228
|
+
iStatusCode?: int,
|
|
21229
|
+
/**
|
|
21230
|
+
* HTTP Headers to send with the response
|
|
21231
|
+
*/
|
|
21232
|
+
mHeaders?: Record<string, string>,
|
|
21233
|
+
/**
|
|
21234
|
+
* XML string to send as response body
|
|
21235
|
+
*/
|
|
21236
|
+
sXmlString?: string
|
|
21237
|
+
): void;
|
|
21238
|
+
}
|
|
21239
|
+
|
|
21062
21240
|
/**
|
|
21063
21241
|
* Enum for the method.
|
|
21064
21242
|
*/
|
|
@@ -21075,6 +21253,29 @@ declare namespace sap {
|
|
|
21075
21253
|
|
|
21076
21254
|
PUT = "PUT",
|
|
21077
21255
|
}
|
|
21256
|
+
|
|
21257
|
+
type RequestHandler = {
|
|
21258
|
+
/**
|
|
21259
|
+
* Any HTTP verb
|
|
21260
|
+
*/
|
|
21261
|
+
method: sap.ui.core.util.MockServer.HTTPMETHOD;
|
|
21262
|
+
/**
|
|
21263
|
+
* A string path is converted to a regular expression, so it can contain normal regular expression syntax.
|
|
21264
|
+
*
|
|
21265
|
+
* All regular expression groups are forwarded as arguments to the `response` function. In addition to this,
|
|
21266
|
+
* parameters can be written in this notation: `:param`. These placeholders will be replaced by regular
|
|
21267
|
+
* expression groups.
|
|
21268
|
+
*/
|
|
21269
|
+
path: string | RegExp;
|
|
21270
|
+
/**
|
|
21271
|
+
* A response handler function that will be called when an incoming request matches `method` and `path`.
|
|
21272
|
+
* The first parameter of the handler will be a `Response` object which can be used to respond on the request.
|
|
21273
|
+
*/
|
|
21274
|
+
response: (
|
|
21275
|
+
p1: sap.ui.core.util.MockServer.Response,
|
|
21276
|
+
p2: any
|
|
21277
|
+
) => void;
|
|
21278
|
+
};
|
|
21078
21279
|
}
|
|
21079
21280
|
|
|
21080
21281
|
namespace XMLPreprocessor {
|
|
@@ -22436,7 +22637,7 @@ declare namespace sap {
|
|
|
22436
22637
|
*
|
|
22437
22638
|
* Default value is `[]`
|
|
22438
22639
|
*/
|
|
22439
|
-
getRequests():
|
|
22640
|
+
getRequests(): sap.ui.core.util.MockServer.RequestHandler[];
|
|
22440
22641
|
/**
|
|
22441
22642
|
* Getter for property `rootUri`. Has to be relative and requires a trailing '/'. It also needs to match
|
|
22442
22643
|
* the URI set in OData/JSON models or simple XHR calls in order for the mock server to intercept them.
|
|
@@ -22474,34 +22675,14 @@ declare namespace sap {
|
|
|
22474
22675
|
/**
|
|
22475
22676
|
* Setter for property `requests`.
|
|
22476
22677
|
*
|
|
22477
|
-
* Default value is
|
|
22478
|
-
*
|
|
22479
|
-
* Each array entry should consist of an object with the following properties / values:
|
|
22480
|
-
*
|
|
22481
|
-
*
|
|
22482
|
-
* - **method : "GET"|"POST"|"DELETE|"PUT"**
|
|
22483
|
-
* (any HTTP verb)
|
|
22484
|
-
* - **path : "/path/to/resource"**
|
|
22485
|
-
* The path is converted to a regular expression, so it can contain normal regular expression syntax. All
|
|
22486
|
-
* regular expression groups are forwarded as arguments to the `response` function. In addition to this,
|
|
22487
|
-
* parameters can be written in this notation: `:param`. These placeholder will be replaced by regular expression
|
|
22488
|
-
* groups.
|
|
22489
|
-
* - **response : function(xhr, param1, param2, ...) { }**
|
|
22490
|
-
* The xhr object can be used to respond on the request. Supported methods are:
|
|
22491
|
-
* `xhr.respond(iStatusCode, mHeaders, sBody)`
|
|
22492
|
-
* `xhr.respondJSON(iStatusCode, mHeaders, oJsonObjectOrString)`. By default a JSON header is set for response
|
|
22493
|
-
* header
|
|
22494
|
-
* `xhr.respondXML(iStatusCode, mHeaders, sXmlString)`. By default an XML header is set for response header
|
|
22495
|
-
*
|
|
22496
|
-
* `xhr.respondFile(iStatusCode, mHeaders, sFileUrl)`. By default the mime type of the file is set for
|
|
22497
|
-
* response header
|
|
22678
|
+
* Default value is `[]`
|
|
22498
22679
|
*/
|
|
22499
22680
|
setRequests(
|
|
22500
22681
|
/**
|
|
22501
|
-
* new value for
|
|
22682
|
+
* new value for the `requests` property
|
|
22502
22683
|
*/
|
|
22503
|
-
requests:
|
|
22504
|
-
):
|
|
22684
|
+
requests: sap.ui.core.util.MockServer.RequestHandler[]
|
|
22685
|
+
): this;
|
|
22505
22686
|
/**
|
|
22506
22687
|
* Setter for property `rootUri`. All request path URI are prefixed with this root URI if set.
|
|
22507
22688
|
*
|
|
@@ -23047,6 +23228,38 @@ declare namespace sap {
|
|
|
23047
23228
|
__implements__sap_ui_core_IAsyncContentCreation: boolean;
|
|
23048
23229
|
}
|
|
23049
23230
|
|
|
23231
|
+
/**
|
|
23232
|
+
* @SINCE 1.98.0
|
|
23233
|
+
* @EXPERIMENTAL (since 1.98)
|
|
23234
|
+
*
|
|
23235
|
+
* Marker interface for controls that can serve as a menu for a table column header.
|
|
23236
|
+
*
|
|
23237
|
+
* Implementation of this interface implements the `openBy` and `getAriaHasPopupType` methods.
|
|
23238
|
+
*/
|
|
23239
|
+
interface IColumnHeaderMenu {
|
|
23240
|
+
__implements__sap_ui_core_IColumnHeaderMenu: boolean;
|
|
23241
|
+
|
|
23242
|
+
/**
|
|
23243
|
+
* @SINCE 1.98.0
|
|
23244
|
+
* @EXPERIMENTAL (since 1.98)
|
|
23245
|
+
*
|
|
23246
|
+
* Returns the sap.ui.core.aria.HasPopup<\code> type of the menu.
|
|
23247
|
+
*/
|
|
23248
|
+
getAriaHasPopupType(): sap.ui.core.aria.HasPopup;
|
|
23249
|
+
/**
|
|
23250
|
+
* @SINCE 1.98.0
|
|
23251
|
+
* @EXPERIMENTAL (since 1.98)
|
|
23252
|
+
*
|
|
23253
|
+
* Opens the menu using the column header.
|
|
23254
|
+
*/
|
|
23255
|
+
openBy(
|
|
23256
|
+
/**
|
|
23257
|
+
* Specifies the control where the menu is placed.
|
|
23258
|
+
*/
|
|
23259
|
+
oControl: sap.ui.core.Control
|
|
23260
|
+
): void;
|
|
23261
|
+
}
|
|
23262
|
+
|
|
23050
23263
|
/**
|
|
23051
23264
|
* Marker interface for controls that can serve as a context menu.
|
|
23052
23265
|
*
|
|
@@ -28115,8 +28328,8 @@ declare namespace sap {
|
|
|
28115
28328
|
/**
|
|
28116
28329
|
* @SINCE 1.95.0
|
|
28117
28330
|
*
|
|
28118
|
-
* Sets the security token handlers for an OData V4 model. See chapter
|
|
28119
|
-
*
|
|
28331
|
+
* Sets the security token handlers for an OData V4 model. See chapter {@link topic:9613f1f2d88747cab21896f7216afdac/section_STH
|
|
28332
|
+
* Security Token Handling}.
|
|
28120
28333
|
* See:
|
|
28121
28334
|
* #getSecurityTokenHandlers
|
|
28122
28335
|
*/
|
|
@@ -29625,6 +29838,10 @@ declare namespace sap {
|
|
|
29625
29838
|
* visible before the focus is set
|
|
29626
29839
|
*/
|
|
29627
29840
|
preventScroll?: boolean;
|
|
29841
|
+
/**
|
|
29842
|
+
* Further control-specific setting of the focus target within the control @since 1.98
|
|
29843
|
+
*/
|
|
29844
|
+
targetInfo?: any;
|
|
29628
29845
|
}
|
|
29629
29846
|
): void;
|
|
29630
29847
|
/**
|
|
@@ -37635,7 +37852,7 @@ declare namespace sap {
|
|
|
37635
37852
|
*
|
|
37636
37853
|
* Noteworthy details:
|
|
37637
37854
|
* - whitespace is mandatory around a '-' or '+' operator and optional otherwise
|
|
37638
|
-
* - parentheses are accepted but not checked for being balanced (a
|
|
37855
|
+
* - parentheses are accepted but not checked for being balanced (a restriction of regexp based checks)
|
|
37639
37856
|
*
|
|
37640
37857
|
* - semantic constraints like type restrictions are not checked
|
|
37641
37858
|
*
|
|
@@ -37693,7 +37910,7 @@ declare namespace sap {
|
|
|
37693
37910
|
*
|
|
37694
37911
|
* Noteworthy details:
|
|
37695
37912
|
* - whitespace is mandatory around a '-' or '+' operator and optional otherwise
|
|
37696
|
-
* - parentheses are accepted but not checked for being balanced (a
|
|
37913
|
+
* - parentheses are accepted but not checked for being balanced (a restriction of regexp based checks)
|
|
37697
37914
|
*
|
|
37698
37915
|
* - semantic constraints like type restrictions are not checked
|
|
37699
37916
|
*
|
|
@@ -39564,10 +39781,9 @@ declare namespace sap {
|
|
|
39564
39781
|
/**
|
|
39565
39782
|
* A comma-separated list of property names that need to be selected.
|
|
39566
39783
|
* If the `select` parameter is given, it has to contain all properties that are contained in the analytical
|
|
39567
|
-
* information (see {@link sap.ui.model.analytics.AnalyticalBinding#updateAnalyticalInfo})
|
|
39568
|
-
* dimensions
|
|
39569
|
-
*
|
|
39570
|
-
* of a dimension that is also selected.
|
|
39784
|
+
* information (see {@link sap.ui.model.analytics.AnalyticalBinding#updateAnalyticalInfo}). It must not
|
|
39785
|
+
* contain additional dimensions or measures or associated properties for additional dimensions or measures.
|
|
39786
|
+
* But it may contain additional properties like a text property of a dimension that is also selected.
|
|
39571
39787
|
* All properties of the `select` parameter are also considered in {@link sap.ui.model.analytics.AnalyticalBinding#getDownloadUrl}.
|
|
39572
39788
|
* The `select` parameter must not contain any duplicate entry.
|
|
39573
39789
|
* If the `select` parameter does not fit to the analytical information or if the `select` parameter contains
|
|
@@ -39926,34 +40142,41 @@ declare namespace sap {
|
|
|
39926
40142
|
* Updates the binding's structure with new analytical information.
|
|
39927
40143
|
*
|
|
39928
40144
|
* Analytical information is the mapping of UI columns to properties in the bound OData entity set. Every
|
|
39929
|
-
* column object contains the name of the bound property and in addition:
|
|
40145
|
+
* column object contains the `name` of the bound property and in addition:
|
|
39930
40146
|
* - A column bound to a dimension property has further boolean properties:
|
|
39931
|
-
* grouped: dimension
|
|
39932
|
-
* - visible: if the column is visible, values for the related property will be fetched from the OData
|
|
39933
|
-
* service
|
|
40147
|
+
* grouped: dimension is used for building groups
|
|
39934
40148
|
* - inResult: if the column is not visible, but declared to be part of the result, values for the related
|
|
39935
|
-
* property
|
|
40149
|
+
* property are also fetched from the OData service
|
|
40150
|
+
* - visible: if the column is visible, values for the related property are fetched from the OData service
|
|
40151
|
+
*
|
|
39936
40152
|
* - A column bound to a measure property has further boolean properties:
|
|
39937
|
-
*
|
|
40153
|
+
* inResult: if the column is not visible, but declared to be part of the result, values for the related
|
|
40154
|
+
* property are also fetched from the OData service
|
|
40155
|
+
* - total: totals and sub-totals are provided for the measure at all aggregation levels
|
|
40156
|
+
* - visible: if the column is visible, values for the related property are fetched from the OData service
|
|
39938
40157
|
*
|
|
39939
40158
|
* - A column bound to a hierarchy property has further properties:
|
|
39940
|
-
* grouped: boolean value; indicates whether the hierarchy
|
|
40159
|
+
* grouped: boolean value; indicates whether the hierarchy is used for building groups
|
|
39941
40160
|
* - level: integer value; the hierarchy level is mandatory for at least one of those columns that represent
|
|
39942
|
-
* the same hierarchy
|
|
40161
|
+
* the same hierarchy
|
|
39943
40162
|
*
|
|
39944
40163
|
* Invoking this function resets the state of the binding and subsequent data requests such as calls to
|
|
39945
|
-
* getNodeContexts()
|
|
39946
|
-
*
|
|
40164
|
+
* getNodeContexts() trigger OData requests in order to fetch the data that are in line with this analytical
|
|
40165
|
+
* information.
|
|
39947
40166
|
*
|
|
39948
|
-
*
|
|
39949
|
-
*
|
|
39950
|
-
*
|
|
40167
|
+
* Be aware that a call of this function might lead to additional back-end requests, as well as a control
|
|
40168
|
+
* re-rendering later on. Whenever possible use the API of the analytical control, instead of relying on
|
|
40169
|
+
* the binding.
|
|
39951
40170
|
*/
|
|
39952
40171
|
updateAnalyticalInfo(
|
|
39953
40172
|
/**
|
|
39954
|
-
*
|
|
40173
|
+
* An array with objects holding the analytical information for every column
|
|
39955
40174
|
*/
|
|
39956
|
-
aColumns:
|
|
40175
|
+
aColumns: object[],
|
|
40176
|
+
/**
|
|
40177
|
+
* Whether to fire a change event asynchronously even if columns didn't change
|
|
40178
|
+
*/
|
|
40179
|
+
bForceChange: boolean
|
|
39957
40180
|
): void;
|
|
39958
40181
|
}
|
|
39959
40182
|
|
|
@@ -43022,6 +43245,16 @@ declare namespace sap {
|
|
|
43022
43245
|
* and the entity for this context has been stored in the back end, {@link #created} returns `undefined`.
|
|
43023
43246
|
*/
|
|
43024
43247
|
created(): Promise<any>;
|
|
43248
|
+
/**
|
|
43249
|
+
* @SINCE 1.98.0
|
|
43250
|
+
*
|
|
43251
|
+
* Returns whether this context is inactive. An inactive context will only be sent to the server after the
|
|
43252
|
+
* first property update. From then on it behaves like any other created context.
|
|
43253
|
+
* See:
|
|
43254
|
+
* sap.ui.model.odata.v2.ODataListBinding#create
|
|
43255
|
+
* sap.ui.model.odata.v2.ODataModel#createEntry
|
|
43256
|
+
*/
|
|
43257
|
+
isInactive(): boolean;
|
|
43025
43258
|
/**
|
|
43026
43259
|
* @SINCE 1.94.0
|
|
43027
43260
|
*
|
|
@@ -43643,8 +43876,8 @@ declare namespace sap {
|
|
|
43643
43876
|
*/
|
|
43644
43877
|
countMode?: sap.ui.model.odata.CountMode;
|
|
43645
43878
|
/**
|
|
43646
|
-
* A key used in combination with the resolved path of this binding to identify the entities created
|
|
43647
|
-
* binding's {@link #create} method.
|
|
43879
|
+
* A key used in combination with the resolved path of this binding to identify the entities created by
|
|
43880
|
+
* this binding's {@link #create} method.
|
|
43648
43881
|
*
|
|
43649
43882
|
* **Note:** Different controls or control aggregation bindings to the same collection must have different
|
|
43650
43883
|
* `createdEntitiesKey` values.
|
|
@@ -43719,6 +43952,230 @@ declare namespace sap {
|
|
|
43719
43952
|
* Returns a metadata object for class sap.ui.model.odata.v2.ODataListBinding.
|
|
43720
43953
|
*/
|
|
43721
43954
|
static getMetadata(): sap.ui.base.Metadata;
|
|
43955
|
+
/**
|
|
43956
|
+
* @SINCE 1.98.0
|
|
43957
|
+
*
|
|
43958
|
+
* Attach event handler `fnFunction` to the 'createActivate' event of this binding.
|
|
43959
|
+
*/
|
|
43960
|
+
attachCreateActivate(
|
|
43961
|
+
/**
|
|
43962
|
+
* The function to call when the event occurs
|
|
43963
|
+
*/
|
|
43964
|
+
fnFunction: Function,
|
|
43965
|
+
/**
|
|
43966
|
+
* Object on which to call the given function
|
|
43967
|
+
*/
|
|
43968
|
+
oListener?: object
|
|
43969
|
+
): void;
|
|
43970
|
+
/**
|
|
43971
|
+
* @SINCE 1.98.0
|
|
43972
|
+
*
|
|
43973
|
+
* Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
43974
|
+
* using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
|
|
43975
|
+
* parameter.
|
|
43976
|
+
*
|
|
43977
|
+
* Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
|
|
43978
|
+
*/
|
|
43979
|
+
create(
|
|
43980
|
+
/**
|
|
43981
|
+
* The initial data for the created entity; see the `mParameters.properties` parameter of {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
43982
|
+
*/
|
|
43983
|
+
oInitialData: object,
|
|
43984
|
+
/**
|
|
43985
|
+
* Whether the entity is inserted at the end of the list. The first insertion determines the overall position
|
|
43986
|
+
* of created contexts within the list. Every succeeding insertion is relative to the created contexts within
|
|
43987
|
+
* this list. Note: the order of created contexts in the binding does not necessarily correspond to the
|
|
43988
|
+
* order of the resulting back end creation requests.
|
|
43989
|
+
*/
|
|
43990
|
+
bAtEnd: boolean,
|
|
43991
|
+
/**
|
|
43992
|
+
* A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
|
|
43993
|
+
* the following subset of these is supported.
|
|
43994
|
+
*/
|
|
43995
|
+
mParameters: {
|
|
43996
|
+
/**
|
|
43997
|
+
* The ID of the `ChangeSet` that this request should belong to
|
|
43998
|
+
*/
|
|
43999
|
+
changeSetId?: string;
|
|
44000
|
+
/**
|
|
44001
|
+
* The error callback function
|
|
44002
|
+
*/
|
|
44003
|
+
error?: Function;
|
|
44004
|
+
/**
|
|
44005
|
+
* A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
|
|
44006
|
+
* sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
44007
|
+
*/
|
|
44008
|
+
expand?: string;
|
|
44009
|
+
/**
|
|
44010
|
+
* The ID of a request group; requests belonging to the same group will be bundled in one batch request
|
|
44011
|
+
*/
|
|
44012
|
+
groupId?: string;
|
|
44013
|
+
/**
|
|
44014
|
+
* Whether the created context is inactive. An inactive context will only be sent to the server after the
|
|
44015
|
+
* first property update. From then on it behaves like any other created context.
|
|
44016
|
+
*/
|
|
44017
|
+
inactive?: boolean;
|
|
44018
|
+
/**
|
|
44019
|
+
* The success callback function
|
|
44020
|
+
*/
|
|
44021
|
+
success?: Function;
|
|
44022
|
+
}
|
|
44023
|
+
): sap.ui.model.odata.v2.Context;
|
|
44024
|
+
/**
|
|
44025
|
+
* @SINCE 1.98.0
|
|
44026
|
+
*
|
|
44027
|
+
* Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
44028
|
+
* using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
|
|
44029
|
+
* parameter.
|
|
44030
|
+
*
|
|
44031
|
+
* Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
|
|
44032
|
+
*/
|
|
44033
|
+
create(
|
|
44034
|
+
/**
|
|
44035
|
+
* The initial data for the created entity; see the `mParameters.properties` parameter of {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
44036
|
+
*/
|
|
44037
|
+
oInitialData: object,
|
|
44038
|
+
/**
|
|
44039
|
+
* A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
|
|
44040
|
+
* the following subset of these is supported.
|
|
44041
|
+
*/
|
|
44042
|
+
mParameters: {
|
|
44043
|
+
/**
|
|
44044
|
+
* The ID of the `ChangeSet` that this request should belong to
|
|
44045
|
+
*/
|
|
44046
|
+
changeSetId?: string;
|
|
44047
|
+
/**
|
|
44048
|
+
* The error callback function
|
|
44049
|
+
*/
|
|
44050
|
+
error?: Function;
|
|
44051
|
+
/**
|
|
44052
|
+
* A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
|
|
44053
|
+
* sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
44054
|
+
*/
|
|
44055
|
+
expand?: string;
|
|
44056
|
+
/**
|
|
44057
|
+
* The ID of a request group; requests belonging to the same group will be bundled in one batch request
|
|
44058
|
+
*/
|
|
44059
|
+
groupId?: string;
|
|
44060
|
+
/**
|
|
44061
|
+
* Whether the created context is inactive. An inactive context will only be sent to the server after the
|
|
44062
|
+
* first property update. From then on it behaves like any other created context.
|
|
44063
|
+
*/
|
|
44064
|
+
inactive?: boolean;
|
|
44065
|
+
/**
|
|
44066
|
+
* The success callback function
|
|
44067
|
+
*/
|
|
44068
|
+
success?: Function;
|
|
44069
|
+
}
|
|
44070
|
+
): sap.ui.model.odata.v2.Context;
|
|
44071
|
+
/**
|
|
44072
|
+
* @SINCE 1.98.0
|
|
44073
|
+
*
|
|
44074
|
+
* Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
44075
|
+
* using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
|
|
44076
|
+
* parameter.
|
|
44077
|
+
*
|
|
44078
|
+
* Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
|
|
44079
|
+
*/
|
|
44080
|
+
create(
|
|
44081
|
+
/**
|
|
44082
|
+
* Whether the entity is inserted at the end of the list. The first insertion determines the overall position
|
|
44083
|
+
* of created contexts within the list. Every succeeding insertion is relative to the created contexts within
|
|
44084
|
+
* this list. Note: the order of created contexts in the binding does not necessarily correspond to the
|
|
44085
|
+
* order of the resulting back end creation requests.
|
|
44086
|
+
*/
|
|
44087
|
+
bAtEnd: boolean,
|
|
44088
|
+
/**
|
|
44089
|
+
* A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
|
|
44090
|
+
* the following subset of these is supported.
|
|
44091
|
+
*/
|
|
44092
|
+
mParameters: {
|
|
44093
|
+
/**
|
|
44094
|
+
* The ID of the `ChangeSet` that this request should belong to
|
|
44095
|
+
*/
|
|
44096
|
+
changeSetId?: string;
|
|
44097
|
+
/**
|
|
44098
|
+
* The error callback function
|
|
44099
|
+
*/
|
|
44100
|
+
error?: Function;
|
|
44101
|
+
/**
|
|
44102
|
+
* A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
|
|
44103
|
+
* sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
44104
|
+
*/
|
|
44105
|
+
expand?: string;
|
|
44106
|
+
/**
|
|
44107
|
+
* The ID of a request group; requests belonging to the same group will be bundled in one batch request
|
|
44108
|
+
*/
|
|
44109
|
+
groupId?: string;
|
|
44110
|
+
/**
|
|
44111
|
+
* Whether the created context is inactive. An inactive context will only be sent to the server after the
|
|
44112
|
+
* first property update. From then on it behaves like any other created context.
|
|
44113
|
+
*/
|
|
44114
|
+
inactive?: boolean;
|
|
44115
|
+
/**
|
|
44116
|
+
* The success callback function
|
|
44117
|
+
*/
|
|
44118
|
+
success?: Function;
|
|
44119
|
+
}
|
|
44120
|
+
): sap.ui.model.odata.v2.Context;
|
|
44121
|
+
/**
|
|
44122
|
+
* @SINCE 1.98.0
|
|
44123
|
+
*
|
|
44124
|
+
* Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
44125
|
+
* using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
|
|
44126
|
+
* parameter.
|
|
44127
|
+
*
|
|
44128
|
+
* Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
|
|
44129
|
+
*/
|
|
44130
|
+
create(
|
|
44131
|
+
/**
|
|
44132
|
+
* A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
|
|
44133
|
+
* the following subset of these is supported.
|
|
44134
|
+
*/
|
|
44135
|
+
mParameters: {
|
|
44136
|
+
/**
|
|
44137
|
+
* The ID of the `ChangeSet` that this request should belong to
|
|
44138
|
+
*/
|
|
44139
|
+
changeSetId?: string;
|
|
44140
|
+
/**
|
|
44141
|
+
* The error callback function
|
|
44142
|
+
*/
|
|
44143
|
+
error?: Function;
|
|
44144
|
+
/**
|
|
44145
|
+
* A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
|
|
44146
|
+
* sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
44147
|
+
*/
|
|
44148
|
+
expand?: string;
|
|
44149
|
+
/**
|
|
44150
|
+
* The ID of a request group; requests belonging to the same group will be bundled in one batch request
|
|
44151
|
+
*/
|
|
44152
|
+
groupId?: string;
|
|
44153
|
+
/**
|
|
44154
|
+
* Whether the created context is inactive. An inactive context will only be sent to the server after the
|
|
44155
|
+
* first property update. From then on it behaves like any other created context.
|
|
44156
|
+
*/
|
|
44157
|
+
inactive?: boolean;
|
|
44158
|
+
/**
|
|
44159
|
+
* The success callback function
|
|
44160
|
+
*/
|
|
44161
|
+
success?: Function;
|
|
44162
|
+
}
|
|
44163
|
+
): sap.ui.model.odata.v2.Context;
|
|
44164
|
+
/**
|
|
44165
|
+
* @SINCE 1.98.0
|
|
44166
|
+
*
|
|
44167
|
+
* Detach event handler `fnFunction` from the 'createActivate' event of this binding.
|
|
44168
|
+
*/
|
|
44169
|
+
detachCreateActivate(
|
|
44170
|
+
/**
|
|
44171
|
+
* The function to call when the event occurs
|
|
44172
|
+
*/
|
|
44173
|
+
fnFunction: Function,
|
|
44174
|
+
/**
|
|
44175
|
+
* Object on which to call the given function
|
|
44176
|
+
*/
|
|
44177
|
+
oListener?: object
|
|
44178
|
+
): void;
|
|
43722
44179
|
/**
|
|
43723
44180
|
* Filters the list.
|
|
43724
44181
|
*
|
|
@@ -43745,6 +44202,15 @@ declare namespace sap {
|
|
|
43745
44202
|
*/
|
|
43746
44203
|
bReturnSuccess?: boolean
|
|
43747
44204
|
): this;
|
|
44205
|
+
/**
|
|
44206
|
+
* @SINCE 1.98.0
|
|
44207
|
+
*
|
|
44208
|
+
* Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
|
|
44209
|
+
* this method does not request any data from a back end and does not change the binding's state. In contrast
|
|
44210
|
+
* to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
|
|
44211
|
+
* control, but all contexts that are currently available in the binding.
|
|
44212
|
+
*/
|
|
44213
|
+
getAllCurrentContexts(): sap.ui.model.odata.v2.Context[];
|
|
43748
44214
|
/**
|
|
43749
44215
|
* Return contexts for the list.
|
|
43750
44216
|
*/
|
|
@@ -43762,6 +44228,18 @@ declare namespace sap {
|
|
|
43762
44228
|
*/
|
|
43763
44229
|
iThreshold?: int
|
|
43764
44230
|
): sap.ui.model.odata.v2.Context[];
|
|
44231
|
+
/**
|
|
44232
|
+
* @SINCE 1.98.0
|
|
44233
|
+
*
|
|
44234
|
+
* Returns the count of active entries in the list if the list length is final, otherwise `undefined`. Contrary
|
|
44235
|
+
* to {#getLength}, this method does not consider inactive entries which are created via {#create}.
|
|
44236
|
+
* See:
|
|
44237
|
+
* #create
|
|
44238
|
+
* #getLength
|
|
44239
|
+
* #isLengthFinal
|
|
44240
|
+
* sap.ui.model.odata.v2.Context#isInactive
|
|
44241
|
+
*/
|
|
44242
|
+
getCount(): number | undefined;
|
|
43765
44243
|
/**
|
|
43766
44244
|
* @SINCE 1.24
|
|
43767
44245
|
*
|
|
@@ -43787,6 +44265,13 @@ declare namespace sap {
|
|
|
43787
44265
|
* do nothing, method will be called again when metadata is loaded.
|
|
43788
44266
|
*/
|
|
43789
44267
|
initialize(): sap.ui.model.odata.v2.ODataListBinding;
|
|
44268
|
+
/**
|
|
44269
|
+
* @SINCE 1.98.0
|
|
44270
|
+
*
|
|
44271
|
+
* Returns whether the overall position of created entries is at the end of the list; this is determined
|
|
44272
|
+
* by the first call to {@link sap.ui.model.odata.v2.ODataListBinding#create}.
|
|
44273
|
+
*/
|
|
44274
|
+
isFirstCreateAtEnd(): boolean | undefined;
|
|
43790
44275
|
/**
|
|
43791
44276
|
* Refreshes the binding, check whether the model data has been changed and fire change event if this is
|
|
43792
44277
|
* the case. For server side models this should refetch the data from the server. To update a control, even
|
|
@@ -44686,7 +45171,7 @@ declare namespace sap {
|
|
|
44686
45171
|
* Maps the function import parameter name as specified in the function import's metadata to its value;
|
|
44687
45172
|
* the value is formatted based on the parameter's type as specified in the metadata
|
|
44688
45173
|
*/
|
|
44689
|
-
urlParameters?: Record<string,
|
|
45174
|
+
urlParameters?: Record<string, any>;
|
|
44690
45175
|
/**
|
|
44691
45176
|
* **Deprecated - use `groupId` instead**
|
|
44692
45177
|
*/
|
|
@@ -44912,6 +45397,11 @@ declare namespace sap {
|
|
|
44912
45397
|
* A map of headers
|
|
44913
45398
|
*/
|
|
44914
45399
|
headers?: Record<string, string>;
|
|
45400
|
+
/**
|
|
45401
|
+
* Whether the created context is inactive. An inactive context will only be sent to the server after the
|
|
45402
|
+
* first property update. From then on it behaves like any other created context. Supported since 1.98.0
|
|
45403
|
+
*/
|
|
45404
|
+
inactive?: boolean;
|
|
44915
45405
|
/**
|
|
44916
45406
|
* An array that specifies a set of properties or the entry
|
|
44917
45407
|
*/
|
|
@@ -44947,7 +45437,7 @@ declare namespace sap {
|
|
|
44947
45437
|
oKeyProperties: object
|
|
44948
45438
|
): string;
|
|
44949
45439
|
/**
|
|
44950
|
-
* @deprecated
|
|
45440
|
+
* @deprecated (since 1.95.0) - use {@link #resetChanges} instead
|
|
44951
45441
|
*
|
|
44952
45442
|
* Deletes a created entry from the request queue and from the model.
|
|
44953
45443
|
*
|
|
@@ -45812,7 +46302,7 @@ declare namespace sap {
|
|
|
45812
46302
|
*/
|
|
45813
46303
|
resetChanges(
|
|
45814
46304
|
/**
|
|
45815
|
-
* Paths to be
|
|
46305
|
+
* Paths to be reset; if no array is passed, all changes are reset
|
|
45816
46306
|
*/
|
|
45817
46307
|
aPath?: any[],
|
|
45818
46308
|
/**
|
|
@@ -46749,7 +47239,7 @@ declare namespace sap {
|
|
|
46749
47239
|
*/
|
|
46750
47240
|
context: sap.ui.model.Context;
|
|
46751
47241
|
}
|
|
46752
|
-
): string | Promise<any
|
|
47242
|
+
): string | Promise<any> | undefined;
|
|
46753
47243
|
/**
|
|
46754
47244
|
* @SINCE 1.63.0
|
|
46755
47245
|
*
|
|
@@ -47080,11 +47570,15 @@ declare namespace sap {
|
|
|
47080
47570
|
* The group ID to be used for the DELETE request; if not specified, the update group ID for the context's
|
|
47081
47571
|
* binding is used, see {@link #getUpdateGroupId}; the resulting group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
|
|
47082
47572
|
* Since 1.81, if this context is transient (see {@link #isTransient}), no group ID needs to be specified.
|
|
47573
|
+
* Since 1.98.0, you can use `null` to prevent the DELETE request in case of a kept-alive context that is
|
|
47574
|
+
* not in the collection and of which you know that it does not exist on the server anymore (for example,
|
|
47575
|
+
* a draft after activation).
|
|
47083
47576
|
*/
|
|
47084
47577
|
sGroupId?: string,
|
|
47085
47578
|
/**
|
|
47086
47579
|
* Whether not to request the new count from the server; useful in case of {@link #replaceWith} where it
|
|
47087
|
-
* is known that the count remains unchanged (since 1.97.0)
|
|
47580
|
+
* is known that the count remains unchanged (since 1.97.0). Since 1.98.0, this is implied if a `null` group
|
|
47581
|
+
* ID is used.
|
|
47088
47582
|
*/
|
|
47089
47583
|
bDoNotRequestCount?: boolean
|
|
47090
47584
|
): Promise<any>;
|
|
@@ -47206,6 +47700,16 @@ declare namespace sap {
|
|
|
47206
47700
|
* #expand
|
|
47207
47701
|
*/
|
|
47208
47702
|
isExpanded(): boolean | undefined;
|
|
47703
|
+
/**
|
|
47704
|
+
* @SINCE 1.98.0
|
|
47705
|
+
*
|
|
47706
|
+
* Returns whether this context is inactive. The result of this function can also be accessed via instance
|
|
47707
|
+
* annotation "@$ui5.context.isInactive" at the entity.
|
|
47708
|
+
* See:
|
|
47709
|
+
* sap.ui.model.odata.v4.ODataListBinding#create
|
|
47710
|
+
* sap.ui.model.odata.v4.ODataListBinding#event:createActivate
|
|
47711
|
+
*/
|
|
47712
|
+
isInactive(): boolean;
|
|
47209
47713
|
/**
|
|
47210
47714
|
* @SINCE 1.81.0
|
|
47211
47715
|
*
|
|
@@ -47250,8 +47754,9 @@ declare namespace sap {
|
|
|
47250
47754
|
/**
|
|
47251
47755
|
* @SINCE 1.97.0
|
|
47252
47756
|
*
|
|
47253
|
-
* Replaces this context with the given other context
|
|
47254
|
-
*
|
|
47757
|
+
* Replaces this context with the given other context "in situ", that is, at the index it currently has
|
|
47758
|
+
* in its list binding's collection. You probably want to delete this context afterwards without requesting
|
|
47759
|
+
* the new count from the server, see the `bDoNotRequestCount` parameter of {@link #delete}.
|
|
47255
47760
|
*/
|
|
47256
47761
|
replaceWith(
|
|
47257
47762
|
/**
|
|
@@ -47398,6 +47903,12 @@ declare namespace sap {
|
|
|
47398
47903
|
* Sets this context's `keepAlive` attribute. If `true` the context is kept alive even when it is removed
|
|
47399
47904
|
* from its binding's collection, for example if a filter is applied and the entity represented by this
|
|
47400
47905
|
* context does not match the filter criteria.
|
|
47906
|
+
*
|
|
47907
|
+
* Normally, a context's lifecycle is managed implicitly. It is created once it is needed and destroyed
|
|
47908
|
+
* if it is not needed anymore, for example, because it is no longer part of its list binding's collection.
|
|
47909
|
+
* It is thus unsafe to keep a reference to a context instance which is not explicitly kept alive. Once
|
|
47910
|
+
* a context is not kept alive anymore, the implicit lifecycle management again takes control and destroys
|
|
47911
|
+
* the context if it is no longer needed.
|
|
47401
47912
|
* See:
|
|
47402
47913
|
* #isKeepAlive
|
|
47403
47914
|
*/
|
|
@@ -47646,6 +48157,12 @@ declare namespace sap {
|
|
|
47646
48157
|
* The value of this binding is the result of the operation. To access a result of primitive type, bind
|
|
47647
48158
|
* a control to the path "value", for example `<Text text="{value}"/>`. If the result has a complex or
|
|
47648
48159
|
* entity type, you can bind properties as usual, for example `<Text text="{street}"/>`.
|
|
48160
|
+
*
|
|
48161
|
+
* Since 1.98.0, a single-valued navigation property can be treated like a function if
|
|
48162
|
+
* it has the same type as the operation binding's parent context, that parent context is in the
|
|
48163
|
+
* collection (has an index, see {@link sap.ui.model.odata.v4.Context#getIndex}) of a list binding for a
|
|
48164
|
+
* top-level entity set, there is a navigation property binding which points to that same entity set,
|
|
48165
|
+
* no operation parameters have been set, the `bReplaceWithRVC` parameter is used.
|
|
47649
48166
|
*/
|
|
47650
48167
|
execute(
|
|
47651
48168
|
/**
|
|
@@ -47713,7 +48230,8 @@ declare namespace sap {
|
|
|
47713
48230
|
getRootBinding():
|
|
47714
48231
|
| sap.ui.model.odata.v4.ODataContextBinding
|
|
47715
48232
|
| sap.ui.model.odata.v4.ODataListBinding
|
|
47716
|
-
| sap.ui.model.odata.v4.ODataPropertyBinding
|
|
48233
|
+
| sap.ui.model.odata.v4.ODataPropertyBinding
|
|
48234
|
+
| undefined;
|
|
47717
48235
|
/**
|
|
47718
48236
|
* @SINCE 1.81.0
|
|
47719
48237
|
*
|
|
@@ -47762,6 +48280,7 @@ declare namespace sap {
|
|
|
47762
48280
|
isInitial(): boolean;
|
|
47763
48281
|
/**
|
|
47764
48282
|
* @SINCE 1.95.0
|
|
48283
|
+
* @deprecated (since 1.96.5)
|
|
47765
48284
|
* @EXPERIMENTAL
|
|
47766
48285
|
*
|
|
47767
48286
|
* Moves the bound entity into the given list binding. This binding loses its data. The method may only
|
|
@@ -47900,8 +48419,9 @@ declare namespace sap {
|
|
|
47900
48419
|
* @SINCE 1.37.0
|
|
47901
48420
|
*
|
|
47902
48421
|
* List binding for an OData V4 model. An event handler can only be attached to this binding for the following
|
|
47903
|
-
* events: 'AggregatedDataStateChange', 'change', '
|
|
47904
|
-
* 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an
|
|
48422
|
+
* events: 'AggregatedDataStateChange', 'change', 'createActivate', 'createCompleted', 'createSent', 'dataReceived',
|
|
48423
|
+
* 'dataRequested', 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an
|
|
48424
|
+
* error is thrown.
|
|
47905
48425
|
*/
|
|
47906
48426
|
class ODataListBinding extends sap.ui.model.ListBinding {
|
|
47907
48427
|
constructor();
|
|
@@ -47934,6 +48454,21 @@ declare namespace sap {
|
|
|
47934
48454
|
* Returns a metadata object for class sap.ui.model.odata.v4.ODataListBinding.
|
|
47935
48455
|
*/
|
|
47936
48456
|
static getMetadata(): sap.ui.base.Metadata;
|
|
48457
|
+
/**
|
|
48458
|
+
* @SINCE 1.98.0
|
|
48459
|
+
*
|
|
48460
|
+
* Attach event handler `fnFunction` to the 'createActivate' event of this binding.
|
|
48461
|
+
*/
|
|
48462
|
+
attachCreateActivate(
|
|
48463
|
+
/**
|
|
48464
|
+
* The function to call when the event occurs
|
|
48465
|
+
*/
|
|
48466
|
+
fnFunction: Function,
|
|
48467
|
+
/**
|
|
48468
|
+
* Object on which to call the given function
|
|
48469
|
+
*/
|
|
48470
|
+
oListener?: object
|
|
48471
|
+
): void;
|
|
47937
48472
|
/**
|
|
47938
48473
|
* @SINCE 1.66.0
|
|
47939
48474
|
*
|
|
@@ -48107,6 +48642,21 @@ declare namespace sap {
|
|
|
48107
48642
|
* sap.ui.model.Binding#destroy
|
|
48108
48643
|
*/
|
|
48109
48644
|
destroy(): void;
|
|
48645
|
+
/**
|
|
48646
|
+
* @SINCE 1.98.0
|
|
48647
|
+
*
|
|
48648
|
+
* Detach event handler `fnFunction` from the 'createActivate' event of this binding.
|
|
48649
|
+
*/
|
|
48650
|
+
detachCreateActivate(
|
|
48651
|
+
/**
|
|
48652
|
+
* The function to call when the event occurs
|
|
48653
|
+
*/
|
|
48654
|
+
fnFunction: Function,
|
|
48655
|
+
/**
|
|
48656
|
+
* Object on which to call the given function
|
|
48657
|
+
*/
|
|
48658
|
+
oListener?: object
|
|
48659
|
+
): void;
|
|
48110
48660
|
/**
|
|
48111
48661
|
* @SINCE 1.66.0
|
|
48112
48662
|
*
|
|
@@ -48211,6 +48761,17 @@ declare namespace sap {
|
|
|
48211
48761
|
*/
|
|
48212
48762
|
sFilterType?: sap.ui.model.FilterType
|
|
48213
48763
|
): this;
|
|
48764
|
+
/**
|
|
48765
|
+
* @SINCE 1.98.0
|
|
48766
|
+
*
|
|
48767
|
+
* Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
|
|
48768
|
+
* this method does not request any data from a back end and does not change the binding's state. In contrast
|
|
48769
|
+
* to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
|
|
48770
|
+
* control, but all contexts that are currently available in the binding, including kept-alive contexts.
|
|
48771
|
+
* To filter out kept-alive contexts that are not part of the list, you could check whether the index is
|
|
48772
|
+
* `undefined`, as described in {@link sap.ui.model.odata.v4.Context#getIndex}.
|
|
48773
|
+
*/
|
|
48774
|
+
getAllCurrentContexts(): sap.ui.model.odata.v4.Context[];
|
|
48214
48775
|
/**
|
|
48215
48776
|
* @SINCE 1.37.0
|
|
48216
48777
|
*
|
|
@@ -48346,7 +48907,8 @@ declare namespace sap {
|
|
|
48346
48907
|
getRootBinding():
|
|
48347
48908
|
| sap.ui.model.odata.v4.ODataContextBinding
|
|
48348
48909
|
| sap.ui.model.odata.v4.ODataListBinding
|
|
48349
|
-
| sap.ui.model.odata.v4.ODataPropertyBinding
|
|
48910
|
+
| sap.ui.model.odata.v4.ODataPropertyBinding
|
|
48911
|
+
| undefined;
|
|
48350
48912
|
/**
|
|
48351
48913
|
* @SINCE 1.81.0
|
|
48352
48914
|
*
|
|
@@ -48701,7 +49263,7 @@ declare namespace sap {
|
|
|
48701
49263
|
*/
|
|
48702
49264
|
as?: string;
|
|
48703
49265
|
}>
|
|
48704
|
-
): object;
|
|
49266
|
+
): object | undefined;
|
|
48705
49267
|
}
|
|
48706
49268
|
/**
|
|
48707
49269
|
* @SINCE 1.37.0
|
|
@@ -48869,7 +49431,7 @@ declare namespace sap {
|
|
|
48869
49431
|
* See:
|
|
48870
49432
|
* #requestData
|
|
48871
49433
|
*/
|
|
48872
|
-
getData(): object;
|
|
49434
|
+
getData(): object | undefined;
|
|
48873
49435
|
/**
|
|
48874
49436
|
* @SINCE 1.51.0
|
|
48875
49437
|
*
|
|
@@ -50126,7 +50688,8 @@ declare namespace sap {
|
|
|
50126
50688
|
getRootBinding():
|
|
50127
50689
|
| sap.ui.model.odata.v4.ODataContextBinding
|
|
50128
50690
|
| sap.ui.model.odata.v4.ODataListBinding
|
|
50129
|
-
| sap.ui.model.odata.v4.ODataPropertyBinding
|
|
50691
|
+
| sap.ui.model.odata.v4.ODataPropertyBinding
|
|
50692
|
+
| undefined;
|
|
50130
50693
|
/**
|
|
50131
50694
|
* @SINCE 1.81.0
|
|
50132
50695
|
*
|
|
@@ -56058,6 +56621,13 @@ declare namespace sap {
|
|
|
56058
56621
|
*/
|
|
56059
56622
|
bNewState?: boolean
|
|
56060
56623
|
): boolean;
|
|
56624
|
+
/**
|
|
56625
|
+
* @SINCE 1.98.0
|
|
56626
|
+
*
|
|
56627
|
+
* Returns an array of all model and control messages of all parts of the composite binding, regardless
|
|
56628
|
+
* of whether they are old or new.
|
|
56629
|
+
*/
|
|
56630
|
+
getAllMessages(): sap.ui.core.Message[];
|
|
56061
56631
|
/**
|
|
56062
56632
|
* Returns the changes of the data state in a map that the control can use in the `refreshDataState` method.
|
|
56063
56633
|
* The changed property's name is the key in the map. Each element in the map contains an object of below
|
|
@@ -56080,7 +56650,7 @@ declare namespace sap {
|
|
|
56080
56650
|
}
|
|
56081
56651
|
>;
|
|
56082
56652
|
/**
|
|
56083
|
-
* Returns the array of state messages of the control.
|
|
56653
|
+
* Returns the array of current state messages of the control.
|
|
56084
56654
|
*/
|
|
56085
56655
|
getControlMessages(): sap.ui.core.Message[];
|
|
56086
56656
|
/**
|
|
@@ -56099,11 +56669,11 @@ declare namespace sap {
|
|
|
56099
56669
|
*/
|
|
56100
56670
|
getInvalidValue(): any;
|
|
56101
56671
|
/**
|
|
56102
|
-
* Returns the array of all state messages combining the model and control messages.
|
|
56672
|
+
* Returns the array of all current state messages combining the model and control messages.
|
|
56103
56673
|
*/
|
|
56104
56674
|
getMessages(): sap.ui.core.Message[];
|
|
56105
56675
|
/**
|
|
56106
|
-
* Returns the array of state messages of the model
|
|
56676
|
+
* Returns the array of current state messages of the model.
|
|
56107
56677
|
*/
|
|
56108
56678
|
getModelMessages(): sap.ui.core.Message[];
|
|
56109
56679
|
/**
|
|
@@ -56472,6 +57042,12 @@ declare namespace sap {
|
|
|
56472
57042
|
*/
|
|
56473
57043
|
bNewState?: boolean
|
|
56474
57044
|
): boolean;
|
|
57045
|
+
/**
|
|
57046
|
+
* @SINCE 1.98.0
|
|
57047
|
+
*
|
|
57048
|
+
* Returns an array of all model and control messages, regardless of whether they are old or new.
|
|
57049
|
+
*/
|
|
57050
|
+
getAllMessages(): sap.ui.core.Message[];
|
|
56475
57051
|
/**
|
|
56476
57052
|
* Returns the changes of the data state in a map that the control can use in the `refreshDataState` method.
|
|
56477
57053
|
* The changed property's name is the key in the map. Each element in the map contains an object with the
|
|
@@ -56480,7 +57056,7 @@ declare namespace sap {
|
|
|
56480
57056
|
*/
|
|
56481
57057
|
getChanges(): object;
|
|
56482
57058
|
/**
|
|
56483
|
-
* Returns the array of
|
|
57059
|
+
* Returns the array of this data state's current control messages.
|
|
56484
57060
|
*/
|
|
56485
57061
|
getControlMessages(): sap.ui.core.Message[];
|
|
56486
57062
|
/**
|
|
@@ -56490,12 +57066,12 @@ declare namespace sap {
|
|
|
56490
57066
|
*/
|
|
56491
57067
|
getInvalidValue(): any;
|
|
56492
57068
|
/**
|
|
56493
|
-
* Returns the array of this data state's messages combining the model and control messages. The
|
|
56494
|
-
* sorted descendingly by message severity.
|
|
57069
|
+
* Returns the array of this data state's current messages combining the model and control messages. The
|
|
57070
|
+
* array is sorted descendingly by message severity.
|
|
56495
57071
|
*/
|
|
56496
57072
|
getMessages(): sap.ui.core.Message[];
|
|
56497
57073
|
/**
|
|
56498
|
-
* Returns the array of
|
|
57074
|
+
* Returns the array of this data state's current model messages.
|
|
56499
57075
|
*/
|
|
56500
57076
|
getModelMessages(): sap.ui.core.Message[];
|
|
56501
57077
|
/**
|
|
@@ -57029,8 +57605,8 @@ declare namespace sap {
|
|
|
57029
57605
|
*
|
|
57030
57606
|
* Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
|
|
57031
57607
|
* this method does not request any data from a back end and does not change the binding's state. In contrast
|
|
57032
|
-
* to {@link #getCurrentContexts}, it does not only return
|
|
57033
|
-
* but all that are currently available in the binding.
|
|
57608
|
+
* to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
|
|
57609
|
+
* control, but all contexts that are currently available in the binding.
|
|
57034
57610
|
*/
|
|
57035
57611
|
getAllCurrentContexts(): sap.ui.model.Context[];
|
|
57036
57612
|
/**
|
|
@@ -57551,7 +58127,7 @@ declare namespace sap {
|
|
|
57551
58127
|
* the server
|
|
57552
58128
|
*/
|
|
57553
58129
|
bReload?: boolean
|
|
57554
|
-
): sap.ui.model.Context;
|
|
58130
|
+
): sap.ui.model.Context | undefined;
|
|
57555
58131
|
/**
|
|
57556
58132
|
* Destroys the model and clears the model data.
|
|
57557
58133
|
*
|
|
@@ -59351,9 +59927,8 @@ declare namespace sap {
|
|
|
59351
59927
|
*
|
|
59352
59928
|
* If this flag is set to `true`, the Safari browser runs in standalone fullscreen mode on iOS.
|
|
59353
59929
|
*
|
|
59354
|
-
* **Note:** This flag is only available if the Safari browser was detected.
|
|
59355
|
-
*
|
|
59356
|
-
* detection, e.g. the availability of {@link sap.ui.Device.browser.version}.
|
|
59930
|
+
* **Note:** This flag is only available if the Safari browser was detected. There might be slight differences
|
|
59931
|
+
* in behavior and detection, e.g. regarding the availability of {@link sap.ui.Device.browser.version}.
|
|
59357
59932
|
*/
|
|
59358
59933
|
export const fullscreen: boolean;
|
|
59359
59934
|
|
|
@@ -59414,12 +59989,13 @@ declare namespace sap {
|
|
|
59414
59989
|
|
|
59415
59990
|
/**
|
|
59416
59991
|
* @SINCE 1.31.0
|
|
59992
|
+
* @deprecated (since 1.98)
|
|
59417
59993
|
*
|
|
59418
59994
|
* If this flag is set to `true`, the Safari browser runs in webview mode on iOS.
|
|
59419
59995
|
*
|
|
59420
|
-
* **Note:**
|
|
59421
|
-
*
|
|
59422
|
-
*
|
|
59996
|
+
* **Note:** Since iOS 11 it is no longer reliably possible to detect whether an application runs in `webview`.
|
|
59997
|
+
* The flag is `true` if the browser's user agent contains 'SAPFioriClient'. Applications using WKWebView
|
|
59998
|
+
* have the possibility to customize the user agent, and to explicitly add this information.
|
|
59423
59999
|
*/
|
|
59424
60000
|
export const webview: boolean;
|
|
59425
60001
|
|
|
@@ -59800,11 +60376,6 @@ declare namespace sap {
|
|
|
59800
60376
|
*/
|
|
59801
60377
|
export const android: boolean;
|
|
59802
60378
|
|
|
59803
|
-
/**
|
|
59804
|
-
* If this flag is set to `true`, a Blackberry operating system is used.
|
|
59805
|
-
*/
|
|
59806
|
-
export const blackberry: boolean;
|
|
59807
|
-
|
|
59808
60379
|
/**
|
|
59809
60380
|
* If this flag is set to `true`, an iOS operating system is used.
|
|
59810
60381
|
*/
|
|
@@ -59832,14 +60403,14 @@ declare namespace sap {
|
|
|
59832
60403
|
/**
|
|
59833
60404
|
* The version of the operating system as `float`.
|
|
59834
60405
|
*
|
|
59835
|
-
* Might be `-1` if no version can be determined.
|
|
60406
|
+
* Might be `-1` if no version can reliably be determined.
|
|
59836
60407
|
*/
|
|
59837
60408
|
export const version: float;
|
|
59838
60409
|
|
|
59839
60410
|
/**
|
|
59840
60411
|
* The version of the operating system as `string`.
|
|
59841
60412
|
*
|
|
59842
|
-
* Might be empty if no version can be determined.
|
|
60413
|
+
* Might be empty if no version can reliably be determined.
|
|
59843
60414
|
*/
|
|
59844
60415
|
export const versionStr: string;
|
|
59845
60416
|
|
|
@@ -59848,11 +60419,6 @@ declare namespace sap {
|
|
|
59848
60419
|
*/
|
|
59849
60420
|
export const windows: boolean;
|
|
59850
60421
|
|
|
59851
|
-
/**
|
|
59852
|
-
* If this flag is set to `true`, a Windows Phone operating system is used.
|
|
59853
|
-
*/
|
|
59854
|
-
export const windows_phone: boolean;
|
|
59855
|
-
|
|
59856
60422
|
/**
|
|
59857
60423
|
* Enumeration containing the names of known operating systems.
|
|
59858
60424
|
*/
|
|
@@ -59864,13 +60430,6 @@ declare namespace sap {
|
|
|
59864
60430
|
*/
|
|
59865
60431
|
export const ANDROID: undefined;
|
|
59866
60432
|
|
|
59867
|
-
/**
|
|
59868
|
-
* Blackberry operating system name.
|
|
59869
|
-
* See:
|
|
59870
|
-
* sap.ui.Device.os.name
|
|
59871
|
-
*/
|
|
59872
|
-
export const BLACKBERRY: undefined;
|
|
59873
|
-
|
|
59874
60433
|
/**
|
|
59875
60434
|
* iOS operating system name.
|
|
59876
60435
|
* See:
|
|
@@ -59898,13 +60457,6 @@ declare namespace sap {
|
|
|
59898
60457
|
* sap.ui.Device.os.name
|
|
59899
60458
|
*/
|
|
59900
60459
|
export const WINDOWS: undefined;
|
|
59901
|
-
|
|
59902
|
-
/**
|
|
59903
|
-
* Windows Phone operating system name.
|
|
59904
|
-
* See:
|
|
59905
|
-
* sap.ui.Device.os.name
|
|
59906
|
-
*/
|
|
59907
|
-
export const WINDOWS_PHONE: undefined;
|
|
59908
60460
|
}
|
|
59909
60461
|
}
|
|
59910
60462
|
/**
|
|
@@ -60164,6 +60716,22 @@ declare namespace sap {
|
|
|
60164
60716
|
* If it is set to `true`, the Control Key modifier will be used
|
|
60165
60717
|
*/
|
|
60166
60718
|
ctrlKey?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
60719
|
+
|
|
60720
|
+
/**
|
|
60721
|
+
* @SINCE 1.98
|
|
60722
|
+
*
|
|
60723
|
+
* Provide percent value for the X coordinate axis to calculate the position of the click event. The value
|
|
60724
|
+
* must be in the range [0 - 100]
|
|
60725
|
+
*/
|
|
60726
|
+
xPercentage?: float | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
60727
|
+
|
|
60728
|
+
/**
|
|
60729
|
+
* @SINCE 1.98
|
|
60730
|
+
*
|
|
60731
|
+
* Provide percent value for the Y coordinate axis to calculate the position of the click event. The value
|
|
60732
|
+
* must be in the range [0 - 100]
|
|
60733
|
+
*/
|
|
60734
|
+
yPercentage?: float | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
60167
60735
|
}
|
|
60168
60736
|
|
|
60169
60737
|
interface $ScrollSettings extends sap.ui.test.actions.$ActionSettings {
|
|
@@ -60714,6 +61282,24 @@ declare namespace sap {
|
|
|
60714
61282
|
* If it is set to `true`, the Shift Key modifier will be used
|
|
60715
61283
|
*/
|
|
60716
61284
|
getShiftKey(): boolean;
|
|
61285
|
+
/**
|
|
61286
|
+
* @SINCE 1.98
|
|
61287
|
+
*
|
|
61288
|
+
* Gets current value of property {@link #getXPercentage xPercentage}.
|
|
61289
|
+
*
|
|
61290
|
+
* Provide percent value for the X coordinate axis to calculate the position of the click event. The value
|
|
61291
|
+
* must be in the range [0 - 100]
|
|
61292
|
+
*/
|
|
61293
|
+
getXPercentage(): float;
|
|
61294
|
+
/**
|
|
61295
|
+
* @SINCE 1.98
|
|
61296
|
+
*
|
|
61297
|
+
* Gets current value of property {@link #getYPercentage yPercentage}.
|
|
61298
|
+
*
|
|
61299
|
+
* Provide percent value for the Y coordinate axis to calculate the position of the click event. The value
|
|
61300
|
+
* must be in the range [0 - 100]
|
|
61301
|
+
*/
|
|
61302
|
+
getYPercentage(): float;
|
|
60717
61303
|
/**
|
|
60718
61304
|
* @SINCE 1.97
|
|
60719
61305
|
*
|
|
@@ -60759,6 +61345,38 @@ declare namespace sap {
|
|
|
60759
61345
|
*/
|
|
60760
61346
|
bShiftKey: boolean
|
|
60761
61347
|
): this;
|
|
61348
|
+
/**
|
|
61349
|
+
* @SINCE 1.98
|
|
61350
|
+
*
|
|
61351
|
+
* Sets a new value for property {@link #getXPercentage xPercentage}.
|
|
61352
|
+
*
|
|
61353
|
+
* Provide percent value for the X coordinate axis to calculate the position of the click event. The value
|
|
61354
|
+
* must be in the range [0 - 100]
|
|
61355
|
+
*
|
|
61356
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
61357
|
+
*/
|
|
61358
|
+
setXPercentage(
|
|
61359
|
+
/**
|
|
61360
|
+
* New value for property `xPercentage`
|
|
61361
|
+
*/
|
|
61362
|
+
fXPercentage: float
|
|
61363
|
+
): this;
|
|
61364
|
+
/**
|
|
61365
|
+
* @SINCE 1.98
|
|
61366
|
+
*
|
|
61367
|
+
* Sets a new value for property {@link #getYPercentage yPercentage}.
|
|
61368
|
+
*
|
|
61369
|
+
* Provide percent value for the Y coordinate axis to calculate the position of the click event. The value
|
|
61370
|
+
* must be in the range [0 - 100]
|
|
61371
|
+
*
|
|
61372
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
61373
|
+
*/
|
|
61374
|
+
setYPercentage(
|
|
61375
|
+
/**
|
|
61376
|
+
* New value for property `yPercentage`
|
|
61377
|
+
*/
|
|
61378
|
+
fYPercentage: float
|
|
61379
|
+
): this;
|
|
60762
61380
|
}
|
|
60763
61381
|
/**
|
|
60764
61382
|
* @SINCE 1.90
|
|
@@ -65296,6 +65914,8 @@ declare namespace sap {
|
|
|
65296
65914
|
|
|
65297
65915
|
"sap/ui/core/Patcher": undefined;
|
|
65298
65916
|
|
|
65917
|
+
"sap/ui/core/Placeholder": undefined;
|
|
65918
|
+
|
|
65299
65919
|
"sap/ui/core/Popup": undefined;
|
|
65300
65920
|
|
|
65301
65921
|
"sap/ui/core/postmessage/Bus": undefined;
|