@openui5/types 1.117.1 → 1.118.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 +416 -2
- package/types/sap.m.d.ts +214 -90
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +5 -2
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +1026 -192
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +51 -4
- package/types/sap.ui.integration.d.ts +68 -3
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +423 -141
- package/types/sap.ui.rta.d.ts +1 -4
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +180 -39
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -20
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +76 -35
- package/types/sap.ui.webc.fiori.d.ts +1 -1
- package/types/sap.ui.webc.main.d.ts +1 -1
- package/types/sap.uxap.d.ts +116 -1
package/types/sap.ui.core.d.ts
CHANGED
|
@@ -280,7 +280,7 @@ declare namespace sap {
|
|
|
280
280
|
}
|
|
281
281
|
}
|
|
282
282
|
|
|
283
|
-
// For Library Version: 1.
|
|
283
|
+
// For Library Version: 1.118.0
|
|
284
284
|
|
|
285
285
|
declare module "sap/base/assert" {
|
|
286
286
|
/**
|
|
@@ -3332,6 +3332,113 @@ declare module "sap/ui/core/InvisibleRenderer" {
|
|
|
3332
3332
|
export default InvisibleRenderer;
|
|
3333
3333
|
}
|
|
3334
3334
|
|
|
3335
|
+
declare module "sap/ui/core/Messaging" {
|
|
3336
|
+
import Message from "sap/ui/core/message/Message";
|
|
3337
|
+
|
|
3338
|
+
import MessageModel from "sap/ui/model/message/MessageModel";
|
|
3339
|
+
|
|
3340
|
+
import MessageProcessor from "sap/ui/core/message/MessageProcessor";
|
|
3341
|
+
|
|
3342
|
+
import ManagedObject from "sap/ui/base/ManagedObject";
|
|
3343
|
+
|
|
3344
|
+
/**
|
|
3345
|
+
* @since 1.118.0
|
|
3346
|
+
*
|
|
3347
|
+
* Messaging provides a central place for managing `sap.ui.core.message.Messages`.
|
|
3348
|
+
*/
|
|
3349
|
+
interface Messaging {
|
|
3350
|
+
/**
|
|
3351
|
+
* Add messages to Messaging
|
|
3352
|
+
*/
|
|
3353
|
+
addMessages(
|
|
3354
|
+
/**
|
|
3355
|
+
* Array of sap.ui.core.message.Message or single sap.ui.core.message.Message
|
|
3356
|
+
*/
|
|
3357
|
+
vMessages: Message | Message[]
|
|
3358
|
+
): void;
|
|
3359
|
+
/**
|
|
3360
|
+
* Get the MessageModel
|
|
3361
|
+
*
|
|
3362
|
+
* @returns oMessageModel The Message Model
|
|
3363
|
+
*/
|
|
3364
|
+
getMessageModel(): MessageModel;
|
|
3365
|
+
/**
|
|
3366
|
+
* Register MessageProcessor
|
|
3367
|
+
*/
|
|
3368
|
+
registerMessageProcessor(
|
|
3369
|
+
/**
|
|
3370
|
+
* The MessageProcessor
|
|
3371
|
+
*/
|
|
3372
|
+
oProcessor: MessageProcessor
|
|
3373
|
+
): void;
|
|
3374
|
+
/**
|
|
3375
|
+
* When using the databinding type system, the validation/parsing of a new property value could fail. In
|
|
3376
|
+
* this case, a validationError/parseError event is fired. These events bubble up to the core. For registered
|
|
3377
|
+
* ManagedObjects, the Messaging attaches to these events and creates a `sap.ui.core.message.Message` (bHandleValidation=true)
|
|
3378
|
+
* for each of these errors and cancels the event bubbling.
|
|
3379
|
+
*/
|
|
3380
|
+
registerObject(
|
|
3381
|
+
/**
|
|
3382
|
+
* The sap.ui.base.ManagedObject
|
|
3383
|
+
*/
|
|
3384
|
+
oObject: ManagedObject,
|
|
3385
|
+
/**
|
|
3386
|
+
* Handle validationError/parseError events for this object. If set to true, the Messaging creates a Message
|
|
3387
|
+
* for each validation/parse error. The event bubbling is canceled in every case.
|
|
3388
|
+
*/
|
|
3389
|
+
bHandleValidation: boolean
|
|
3390
|
+
): void;
|
|
3391
|
+
/**
|
|
3392
|
+
* Remove all messages
|
|
3393
|
+
*/
|
|
3394
|
+
removeAllMessages(): void;
|
|
3395
|
+
/**
|
|
3396
|
+
* Remove given Messages
|
|
3397
|
+
*/
|
|
3398
|
+
removeMessages(
|
|
3399
|
+
/**
|
|
3400
|
+
* The message(s) to be removed.
|
|
3401
|
+
*/
|
|
3402
|
+
vMessages: Message | Message[]
|
|
3403
|
+
): void;
|
|
3404
|
+
/**
|
|
3405
|
+
* Deregister MessageProcessor
|
|
3406
|
+
*/
|
|
3407
|
+
unregisterMessageProcessor(
|
|
3408
|
+
/**
|
|
3409
|
+
* The MessageProcessor
|
|
3410
|
+
*/
|
|
3411
|
+
oProcessor: MessageProcessor
|
|
3412
|
+
): void;
|
|
3413
|
+
/**
|
|
3414
|
+
* Unregister ManagedObject
|
|
3415
|
+
*/
|
|
3416
|
+
unregisterObject(
|
|
3417
|
+
/**
|
|
3418
|
+
* The sap.ui.base.ManagedObject
|
|
3419
|
+
*/
|
|
3420
|
+
oObject: ManagedObject
|
|
3421
|
+
): void;
|
|
3422
|
+
/**
|
|
3423
|
+
* Update Messages by providing two arrays of old and new messages.
|
|
3424
|
+
*
|
|
3425
|
+
* The old ones will be removed, the new ones will be added.
|
|
3426
|
+
*/
|
|
3427
|
+
updateMessages(
|
|
3428
|
+
/**
|
|
3429
|
+
* Array of old messages to be removed
|
|
3430
|
+
*/
|
|
3431
|
+
aOldMessages: Message[],
|
|
3432
|
+
/**
|
|
3433
|
+
* Array of new messages to be added
|
|
3434
|
+
*/
|
|
3435
|
+
aNewMessages: Message[]
|
|
3436
|
+
): void;
|
|
3437
|
+
}
|
|
3438
|
+
const Messaging: Messaging;
|
|
3439
|
+
export default Messaging;
|
|
3440
|
+
}
|
|
3441
|
+
|
|
3335
3442
|
declare module "sap/ui/core/syncStyleClass" {
|
|
3336
3443
|
import Control from "sap/ui/core/Control";
|
|
3337
3444
|
|
|
@@ -3361,6 +3468,55 @@ declare module "sap/ui/core/syncStyleClass" {
|
|
|
3361
3468
|
): jQuery | Element;
|
|
3362
3469
|
}
|
|
3363
3470
|
|
|
3471
|
+
declare module "sap/ui/core/Theming" {
|
|
3472
|
+
/**
|
|
3473
|
+
* @since 1.118
|
|
3474
|
+
*
|
|
3475
|
+
* Provides theming related API
|
|
3476
|
+
*/
|
|
3477
|
+
interface Theming {
|
|
3478
|
+
/**
|
|
3479
|
+
* Attaches event handler `fnFunction` to the {@link #event:applied applied} event
|
|
3480
|
+
*/
|
|
3481
|
+
attachApplied(
|
|
3482
|
+
/**
|
|
3483
|
+
* The function to be called, when the event occurs
|
|
3484
|
+
*/
|
|
3485
|
+
fnFunction: Function
|
|
3486
|
+
): void;
|
|
3487
|
+
/**
|
|
3488
|
+
* Detaches event handler `fnFunction` from the {@link #event:applied applied} event
|
|
3489
|
+
*
|
|
3490
|
+
* The passed function must match the one used for event registration.
|
|
3491
|
+
*/
|
|
3492
|
+
detachApplied(
|
|
3493
|
+
/**
|
|
3494
|
+
* The function to be called, when the event occurs
|
|
3495
|
+
*/
|
|
3496
|
+
fnFunction: Function
|
|
3497
|
+
): void;
|
|
3498
|
+
/**
|
|
3499
|
+
* Returns the theme name
|
|
3500
|
+
*
|
|
3501
|
+
* @returns the theme name
|
|
3502
|
+
*/
|
|
3503
|
+
getTheme(): string;
|
|
3504
|
+
/**
|
|
3505
|
+
* Allows setting the theme name
|
|
3506
|
+
*
|
|
3507
|
+
* @returns `this` to allow method chaining
|
|
3508
|
+
*/
|
|
3509
|
+
setTheme(
|
|
3510
|
+
/**
|
|
3511
|
+
* the theme name
|
|
3512
|
+
*/
|
|
3513
|
+
sTheme: string
|
|
3514
|
+
): this;
|
|
3515
|
+
}
|
|
3516
|
+
const Theming: Theming;
|
|
3517
|
+
export default Theming;
|
|
3518
|
+
}
|
|
3519
|
+
|
|
3364
3520
|
declare module "sap/ui/dom/containsOrEquals" {
|
|
3365
3521
|
/**
|
|
3366
3522
|
* @since 1.58
|
|
@@ -8164,7 +8320,9 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
8164
8320
|
*/
|
|
8165
8321
|
groupHeaderFactory?: (p1: { key: string }) => ManagedObject;
|
|
8166
8322
|
/**
|
|
8167
|
-
* Map of event handler functions keyed by the name of the binding events that they should be attached to
|
|
8323
|
+
* Map of event handler functions keyed by the name of the binding events that they should be attached to.
|
|
8324
|
+
* The names and value ranges of the supported events depend on the model implementation and should be documented
|
|
8325
|
+
* with the model-specific subclass of `sap.ui.model.ListBinding`.
|
|
8168
8326
|
*/
|
|
8169
8327
|
events?: Record<string, Function>;
|
|
8170
8328
|
};
|
|
@@ -8347,7 +8505,9 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
8347
8505
|
*/
|
|
8348
8506
|
parameters?: object;
|
|
8349
8507
|
/**
|
|
8350
|
-
* Map of event handler functions keyed by the name of the binding events that they are attached to
|
|
8508
|
+
* Map of event handler functions keyed by the name of the binding events that they are attached to. The
|
|
8509
|
+
* names and value ranges of the supported events depend on the model implementation and should be documented
|
|
8510
|
+
* with the model-specific subclass of `sap.ui.model.ContextBinding`.
|
|
8351
8511
|
*/
|
|
8352
8512
|
events?: Record<string, Function>;
|
|
8353
8513
|
};
|
|
@@ -11066,32 +11226,9 @@ declare module "sap/ui/core/library" {
|
|
|
11066
11226
|
}
|
|
11067
11227
|
|
|
11068
11228
|
/**
|
|
11069
|
-
*
|
|
11070
|
-
*
|
|
11071
|
-
* Defines the different message types.
|
|
11229
|
+
* Specifies possible message types.
|
|
11072
11230
|
*/
|
|
11073
|
-
export enum MessageType {
|
|
11074
|
-
/**
|
|
11075
|
-
* Message is an error
|
|
11076
|
-
*/
|
|
11077
|
-
Error = "Error",
|
|
11078
|
-
/**
|
|
11079
|
-
* Message should be just an information
|
|
11080
|
-
*/
|
|
11081
|
-
Information = "Information",
|
|
11082
|
-
/**
|
|
11083
|
-
* Message has no specific level
|
|
11084
|
-
*/
|
|
11085
|
-
None = "None",
|
|
11086
|
-
/**
|
|
11087
|
-
* Message is a success message
|
|
11088
|
-
*/
|
|
11089
|
-
Success = "Success",
|
|
11090
|
-
/**
|
|
11091
|
-
* Message is a warning
|
|
11092
|
-
*/
|
|
11093
|
-
Warning = "Warning",
|
|
11094
|
-
}
|
|
11231
|
+
export enum MessageType {}
|
|
11095
11232
|
/**
|
|
11096
11233
|
* Defines the different possible states of an element that can be open or closed and does not only toggle
|
|
11097
11234
|
* between these states, but also spends some time in between (e.g. because of an animation).
|
|
@@ -12218,7 +12355,7 @@ declare module "sap/ui/core/Component" {
|
|
|
12218
12355
|
*/
|
|
12219
12356
|
altManifestUrl?: string;
|
|
12220
12357
|
/**
|
|
12221
|
-
* If set to `true` validation of the component is handled by the `
|
|
12358
|
+
* If set to `true` validation of the component is handled by the `Messaging`
|
|
12222
12359
|
*/
|
|
12223
12360
|
handleValidation?: string;
|
|
12224
12361
|
/**
|
|
@@ -12784,14 +12921,20 @@ declare module "sap/ui/core/Component" {
|
|
|
12784
12921
|
}
|
|
12785
12922
|
/**
|
|
12786
12923
|
* The structure of the "metadata" object which is passed when inheriting from sap.ui.core.Component using
|
|
12787
|
-
* its static "extend" method. See {@link sap.ui.core.Component.extend}
|
|
12924
|
+
* its static "extend" method. See {@link sap.ui.core.Component.extend} and {@link sap.ui.core.Component.create }
|
|
12925
|
+
* for additional details on its usage.
|
|
12788
12926
|
*/
|
|
12789
12927
|
export type MetadataOptions = MetadataOptions1 & {
|
|
12790
12928
|
/**
|
|
12791
|
-
*
|
|
12929
|
+
* The manifest option determines how a component manifest should be evaluated. Default is `undefined`.
|
|
12930
|
+
*
|
|
12931
|
+
* When set to `false` or `undefined`, no manifest.json is present for this Component, however the Component
|
|
12932
|
+
* can still be started with a manifest given as an argument of the factory function, see {@link sap.ui.core.Component.create}.
|
|
12933
|
+
* When set to an object, this object will be interpreted as a manifest and must adhere to the {@link https://ui5.sap.com/#/topic/be0cf40f61184b358b5faedaec98b2da descriptor schema for components}.
|
|
12934
|
+
* When set to the string literal `"json"`, this property indicates that the component configuration should
|
|
12792
12935
|
* be read from a manifest.json file which is assumed to exist next to the Component.js file.
|
|
12793
12936
|
*/
|
|
12794
|
-
manifest?: "json";
|
|
12937
|
+
manifest?: undefined | false | object | "json";
|
|
12795
12938
|
};
|
|
12796
12939
|
|
|
12797
12940
|
/**
|
|
@@ -13231,8 +13374,8 @@ declare module "sap/ui/core/ComponentContainer" {
|
|
|
13231
13374
|
/**
|
|
13232
13375
|
* Gets current value of property {@link #getHandleValidation handleValidation}.
|
|
13233
13376
|
*
|
|
13234
|
-
* Enable/disable validation handling by
|
|
13235
|
-
*
|
|
13377
|
+
* Enable/disable validation handling by Messaging for this component. The resulting Messages will be propagated
|
|
13378
|
+
* to the controls. This property can only be applied initially.
|
|
13236
13379
|
*
|
|
13237
13380
|
* Default value is `false`.
|
|
13238
13381
|
*
|
|
@@ -13391,8 +13534,8 @@ declare module "sap/ui/core/ComponentContainer" {
|
|
|
13391
13534
|
/**
|
|
13392
13535
|
* Sets a new value for property {@link #getHandleValidation handleValidation}.
|
|
13393
13536
|
*
|
|
13394
|
-
* Enable/disable validation handling by
|
|
13395
|
-
*
|
|
13537
|
+
* Enable/disable validation handling by Messaging for this component. The resulting Messages will be propagated
|
|
13538
|
+
* to the controls. This property can only be applied initially.
|
|
13396
13539
|
*
|
|
13397
13540
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
13398
13541
|
*
|
|
@@ -13584,8 +13727,8 @@ declare module "sap/ui/core/ComponentContainer" {
|
|
|
13584
13727
|
async?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
13585
13728
|
|
|
13586
13729
|
/**
|
|
13587
|
-
* Enable/disable validation handling by
|
|
13588
|
-
*
|
|
13730
|
+
* Enable/disable validation handling by Messaging for this component. The resulting Messages will be propagated
|
|
13731
|
+
* to the controls. This property can only be applied initially.
|
|
13589
13732
|
*/
|
|
13590
13733
|
handleValidation?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
13591
13734
|
|
|
@@ -14303,8 +14446,6 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14303
14446
|
*/
|
|
14304
14447
|
getTheme(): string;
|
|
14305
14448
|
/**
|
|
14306
|
-
* @since 1.99.0
|
|
14307
|
-
*
|
|
14308
14449
|
* Retrieves the configured IANA timezone ID.
|
|
14309
14450
|
*
|
|
14310
14451
|
* @returns The configured IANA timezone ID, e.g. "America/New_York"
|
|
@@ -15110,6 +15251,24 @@ declare module "sap/ui/core/Control" {
|
|
|
15110
15251
|
*/
|
|
15111
15252
|
FNMetaImpl?: Function
|
|
15112
15253
|
): Function;
|
|
15254
|
+
/**
|
|
15255
|
+
* @since 1.118
|
|
15256
|
+
*
|
|
15257
|
+
* Returns a list of all controls with a field group ID. See {@link sap.ui.core.Control#checkFieldGroupIds Control.prototype.checkFieldGroupIds }
|
|
15258
|
+
* for a description of the `vFieldGroupIds` parameter.
|
|
15259
|
+
*
|
|
15260
|
+
* If possible please use the respective method on a Control instance (see {@link sap.ui.core.Control#getControlsByFieldGroupId}).
|
|
15261
|
+
* The control method only respects aggregated child controls, which is more effective and should be sufficient
|
|
15262
|
+
* for most use-cases.
|
|
15263
|
+
*
|
|
15264
|
+
* @returns The list of controls with matching field group IDs
|
|
15265
|
+
*/
|
|
15266
|
+
static getControlsByFieldGroupId(
|
|
15267
|
+
/**
|
|
15268
|
+
* ID of the field group or an array of field group IDs to match
|
|
15269
|
+
*/
|
|
15270
|
+
vFieldGroupIds?: string | string[]
|
|
15271
|
+
): Control[];
|
|
15113
15272
|
/**
|
|
15114
15273
|
* Returns a metadata object for class sap.ui.core.Control.
|
|
15115
15274
|
*
|
|
@@ -16004,10 +16163,12 @@ declare module "sap/ui/core/Core" {
|
|
|
16004
16163
|
*/
|
|
16005
16164
|
getMetadata(): Metadata;
|
|
16006
16165
|
/**
|
|
16166
|
+
* @deprecated (since 1.118)
|
|
16167
|
+
*
|
|
16007
16168
|
* Enforces an immediate update of the visible UI (aka "rendering").
|
|
16008
16169
|
*
|
|
16009
|
-
* In general, applications should avoid calling this method and instead let the framework
|
|
16010
|
-
* rendering.
|
|
16170
|
+
* In general, applications and Controls should avoid calling this method and instead let the framework
|
|
16171
|
+
* manage any necessary rendering.
|
|
16011
16172
|
*/
|
|
16012
16173
|
applyChanges(): void;
|
|
16013
16174
|
/**
|
|
@@ -16055,6 +16216,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16055
16216
|
oListener?: object
|
|
16056
16217
|
): void;
|
|
16057
16218
|
/**
|
|
16219
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachFormatError ManagedObject#attachFormatError }
|
|
16220
|
+
* instead.
|
|
16221
|
+
*
|
|
16058
16222
|
* Attaches event handler `fnFunction` to the {@link #event:formatError formatError} event of `sap.ui.core.Core`.
|
|
16059
16223
|
*
|
|
16060
16224
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16079,6 +16243,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16079
16243
|
oListener?: object
|
|
16080
16244
|
): this;
|
|
16081
16245
|
/**
|
|
16246
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachFormatError ManagedObject#attachFormatError }
|
|
16247
|
+
* instead.
|
|
16248
|
+
*
|
|
16082
16249
|
* Attaches event handler `fnFunction` to the {@link #event:formatError formatError} event of `sap.ui.core.Core`.
|
|
16083
16250
|
*
|
|
16084
16251
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16100,6 +16267,7 @@ declare module "sap/ui/core/Core" {
|
|
|
16100
16267
|
): this;
|
|
16101
16268
|
/**
|
|
16102
16269
|
* @since 1.13.2
|
|
16270
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.core.Core.ready Core.ready} instead.
|
|
16103
16271
|
*
|
|
16104
16272
|
* Registers a given function that is executed after the framework has been initialized.
|
|
16105
16273
|
*
|
|
@@ -16151,6 +16319,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16151
16319
|
oListener?: object
|
|
16152
16320
|
): void;
|
|
16153
16321
|
/**
|
|
16322
|
+
* @deprecated (since 1.118) - Please use {@link sap.base.i18n.Localization#attachChange Localization#attachChange }
|
|
16323
|
+
* instead.
|
|
16324
|
+
*
|
|
16154
16325
|
* Register a listener for the {@link #event:localizationChanged localizationChanged} event.
|
|
16155
16326
|
*
|
|
16156
16327
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16167,6 +16338,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16167
16338
|
oListener?: object
|
|
16168
16339
|
): void;
|
|
16169
16340
|
/**
|
|
16341
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachParseError ManagedObject#attachParseError }
|
|
16342
|
+
* instead.
|
|
16343
|
+
*
|
|
16170
16344
|
* Attaches event handler `fnFunction` to the {@link #event:parseError parseError} event of `sap.ui.core.Core`.
|
|
16171
16345
|
*
|
|
16172
16346
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16192,6 +16366,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16192
16366
|
oListener?: object
|
|
16193
16367
|
): this;
|
|
16194
16368
|
/**
|
|
16369
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachParseError ManagedObject#attachParseError }
|
|
16370
|
+
* instead.
|
|
16371
|
+
*
|
|
16195
16372
|
* Attaches event handler `fnFunction` to the {@link #event:parseError parseError} event of `sap.ui.core.Core`.
|
|
16196
16373
|
*
|
|
16197
16374
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16212,6 +16389,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16212
16389
|
oListener?: object
|
|
16213
16390
|
): this;
|
|
16214
16391
|
/**
|
|
16392
|
+
* @deprecated (since 1.118) - See {@link sap.ui.core.Theming#attachApplied Theming#attachApplied} instead.
|
|
16393
|
+
*
|
|
16215
16394
|
* Attaches event handler `fnFunction` to the {@link #event:ThemeChanged ThemeChanged} event of this `sap.ui.core.Core`.
|
|
16216
16395
|
*
|
|
16217
16396
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -16228,6 +16407,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16228
16407
|
oListener?: object
|
|
16229
16408
|
): void;
|
|
16230
16409
|
/**
|
|
16410
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachValidationError ManagedObject#attachValidationError }
|
|
16411
|
+
* instead.
|
|
16412
|
+
*
|
|
16231
16413
|
* Attaches event handler `fnFunction` to the {@link #event:validationError validationError} event of `sap.ui.core.Core`.
|
|
16232
16414
|
*
|
|
16233
16415
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16253,6 +16435,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16253
16435
|
oListener?: object
|
|
16254
16436
|
): this;
|
|
16255
16437
|
/**
|
|
16438
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachValidationError ManagedObject#attachValidationError }
|
|
16439
|
+
* instead.
|
|
16440
|
+
*
|
|
16256
16441
|
* Attaches event handler `fnFunction` to the {@link #event:validationError validationError} event of `sap.ui.core.Core`.
|
|
16257
16442
|
*
|
|
16258
16443
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16273,6 +16458,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16273
16458
|
oListener?: object
|
|
16274
16459
|
): this;
|
|
16275
16460
|
/**
|
|
16461
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachValidationSuccess ManagedObject#attachValidationSuccess }
|
|
16462
|
+
* instead.
|
|
16463
|
+
*
|
|
16276
16464
|
* Attaches event handler `fnFunction` to the {@link #event:validationSuccess validationSuccess} event of
|
|
16277
16465
|
* `sap.ui.core.Core`.
|
|
16278
16466
|
*
|
|
@@ -16298,6 +16486,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16298
16486
|
oListener?: object
|
|
16299
16487
|
): this;
|
|
16300
16488
|
/**
|
|
16489
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachValidationSuccess ManagedObject#attachValidationSuccess }
|
|
16490
|
+
* instead.
|
|
16491
|
+
*
|
|
16301
16492
|
* Attaches event handler `fnFunction` to the {@link #event:validationSuccess validationSuccess} event of
|
|
16302
16493
|
* `sap.ui.core.Core`.
|
|
16303
16494
|
*
|
|
@@ -16319,6 +16510,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16319
16510
|
oListener?: object
|
|
16320
16511
|
): this;
|
|
16321
16512
|
/**
|
|
16513
|
+
* @deprecated (since 1.118) - use {@link sap.ui.core.Control#getControlsByFieldGroup Control.prototype.getControlsByFieldGroup }
|
|
16514
|
+
* instead.
|
|
16515
|
+
*
|
|
16322
16516
|
* Returns a list of all controls with a field group ID. See {@link sap.ui.core.Control#checkFieldGroupIds Control.prototype.checkFieldGroupIds }
|
|
16323
16517
|
* for a description of the `vFieldGroupIds` parameter.
|
|
16324
16518
|
*
|
|
@@ -16446,6 +16640,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16446
16640
|
oListener?: object
|
|
16447
16641
|
): void;
|
|
16448
16642
|
/**
|
|
16643
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#detachFormatError ManagedObject#detachFormatError }
|
|
16644
|
+
* instead.
|
|
16645
|
+
*
|
|
16449
16646
|
* Detaches event handler `fnFunction` from the {@link #event:formatError formatError} event of `sap.ui.core.Core`.
|
|
16450
16647
|
*
|
|
16451
16648
|
* The passed function and listener object must match the ones used for event registration.
|
|
@@ -16483,6 +16680,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16483
16680
|
oListener?: object
|
|
16484
16681
|
): void;
|
|
16485
16682
|
/**
|
|
16683
|
+
* @deprecated (since 1.118) - Please use {@link sap.base.i18n.Localization#detachChange Localization#detachChange }
|
|
16684
|
+
* instead.
|
|
16685
|
+
*
|
|
16486
16686
|
* Unregister a listener from the {@link #event:localizationChanged localizationChanged} event.
|
|
16487
16687
|
*
|
|
16488
16688
|
* The listener will only be unregistered if the same function/context combination is given as in the call
|
|
@@ -16499,6 +16699,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16499
16699
|
oListener?: object
|
|
16500
16700
|
): void;
|
|
16501
16701
|
/**
|
|
16702
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#detachParseError ManagedObject#detachParseError }
|
|
16703
|
+
* instead.
|
|
16704
|
+
*
|
|
16502
16705
|
* Detaches event handler `fnFunction` from the {@link #event:parseError parseError} event of `sap.ui.core.Core`.
|
|
16503
16706
|
*
|
|
16504
16707
|
* The passed function and listener object must match the ones used for event registration.
|
|
@@ -16516,6 +16719,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16516
16719
|
oListener?: object
|
|
16517
16720
|
): this;
|
|
16518
16721
|
/**
|
|
16722
|
+
* @deprecated (since 1.118) - See {@link sap.ui.core.Theming#detachApplied Theming#detachApplied} instead.
|
|
16723
|
+
*
|
|
16519
16724
|
* Detaches event handler `fnFunction` from the {@link #event:ThemeChanged ThemeChanged} event of this `sap.ui.core.Core`.
|
|
16520
16725
|
*
|
|
16521
16726
|
* The passed function and listener object must match the ones used for event registration.
|
|
@@ -16531,6 +16736,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16531
16736
|
oListener?: object
|
|
16532
16737
|
): void;
|
|
16533
16738
|
/**
|
|
16739
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#detachValidationError ManagedObject#detachValidationError }
|
|
16740
|
+
* instead.
|
|
16741
|
+
*
|
|
16534
16742
|
* Detaches event handler `fnFunction` from the {@link #event:validationError validationError} event of
|
|
16535
16743
|
* `sap.ui.core.Core`.
|
|
16536
16744
|
*
|
|
@@ -16549,6 +16757,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16549
16757
|
oListener?: object
|
|
16550
16758
|
): this;
|
|
16551
16759
|
/**
|
|
16760
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#detachValidationSuccess ManagedObject#detachValidationSuccess }
|
|
16761
|
+
* instead.
|
|
16762
|
+
*
|
|
16552
16763
|
* Detaches event handler `fnFunction` from the {@link #event:validationSuccess validationSuccess} event
|
|
16553
16764
|
* of `sap.ui.core.Core`.
|
|
16554
16765
|
*
|
|
@@ -16567,6 +16778,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16567
16778
|
oListener?: object
|
|
16568
16779
|
): this;
|
|
16569
16780
|
/**
|
|
16781
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#fireFormatError ManagedObject#fireFormatError }
|
|
16782
|
+
* instead.
|
|
16570
16783
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
16571
16784
|
*
|
|
16572
16785
|
* Fires event {@link #event:formatError formatError} to attached listeners.
|
|
@@ -16605,6 +16818,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16605
16818
|
}
|
|
16606
16819
|
): this;
|
|
16607
16820
|
/**
|
|
16821
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#fireParseError ManagedObject#fireParseError }
|
|
16822
|
+
* instead.
|
|
16608
16823
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
16609
16824
|
*
|
|
16610
16825
|
* Fires event {@link #event:parseError parseError} to attached listeners.
|
|
@@ -16643,6 +16858,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16643
16858
|
}
|
|
16644
16859
|
): this;
|
|
16645
16860
|
/**
|
|
16861
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#fireValidationError ManagedObject.fireValidationError }
|
|
16862
|
+
* instead.
|
|
16646
16863
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
16647
16864
|
*
|
|
16648
16865
|
* Fires event {@link #event:validationError validationError} to attached listeners.
|
|
@@ -16681,6 +16898,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16681
16898
|
}
|
|
16682
16899
|
): this;
|
|
16683
16900
|
/**
|
|
16901
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#fireValidationSuccess ManagedObject#fireValidationSuccess }
|
|
16902
|
+
* instead.
|
|
16684
16903
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
16685
16904
|
*
|
|
16686
16905
|
* Fires event {@link #event:validationSuccess validationSuccess} to attached listeners.
|
|
@@ -16868,11 +17087,15 @@ declare module "sap/ui/core/Core" {
|
|
|
16868
17087
|
getLoadedLibraries(): Record<string, Object>;
|
|
16869
17088
|
/**
|
|
16870
17089
|
* @since 1.33.0
|
|
17090
|
+
* @deprecated (since 1.119) - Please use {@link sap.ui.core.Messaging Messaging} instead.
|
|
16871
17091
|
*
|
|
16872
17092
|
* Returns the active `MessageManager` instance.
|
|
16873
17093
|
*/
|
|
16874
17094
|
getMessageManager(): MessageManager;
|
|
16875
17095
|
/**
|
|
17096
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#getModel ManagedObject#getModel }
|
|
17097
|
+
* instead.
|
|
17098
|
+
*
|
|
16876
17099
|
* Get the model with the given model name.
|
|
16877
17100
|
*
|
|
16878
17101
|
* The name can be omitted to reference the default model or it must be a non-empty string.
|
|
@@ -16938,6 +17161,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16938
17161
|
o: string | Element
|
|
16939
17162
|
): UIArea | null | undefined;
|
|
16940
17163
|
/**
|
|
17164
|
+
* @deprecated (since 1.118)
|
|
17165
|
+
*
|
|
16941
17166
|
* Returns `true` if there are any pending rendering tasks or when such rendering tasks are currently being
|
|
16942
17167
|
* executed.
|
|
16943
17168
|
*
|
|
@@ -16945,6 +17170,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16945
17170
|
*/
|
|
16946
17171
|
getUIDirty(): boolean;
|
|
16947
17172
|
/**
|
|
17173
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#hasModel ManagedObject#hasModel }
|
|
17174
|
+
* instead.
|
|
17175
|
+
*
|
|
16948
17176
|
* Check if a Model is set to the core
|
|
16949
17177
|
*
|
|
16950
17178
|
* @returns true or false
|
|
@@ -17036,6 +17264,8 @@ declare module "sap/ui/core/Core" {
|
|
|
17036
17264
|
oLibInfo: LibraryInfo
|
|
17037
17265
|
): object | undefined;
|
|
17038
17266
|
/**
|
|
17267
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.core.Core.ready Core.ready} instead.
|
|
17268
|
+
*
|
|
17039
17269
|
* Returns true if the Core has already been initialized. This means that instances of RenderManager etc.
|
|
17040
17270
|
* do already exist and the init event has already been fired (and will not be fired again).
|
|
17041
17271
|
*
|
|
@@ -17043,12 +17273,16 @@ declare module "sap/ui/core/Core" {
|
|
|
17043
17273
|
*/
|
|
17044
17274
|
isInitialized(): boolean;
|
|
17045
17275
|
/**
|
|
17276
|
+
* @deprecated (since 1.118)
|
|
17277
|
+
*
|
|
17046
17278
|
* Returns the locked state of the `sap.ui.core.Core`
|
|
17047
17279
|
*
|
|
17048
17280
|
* @returns locked state
|
|
17049
17281
|
*/
|
|
17050
17282
|
isLocked(): boolean;
|
|
17051
17283
|
/**
|
|
17284
|
+
* @deprecated (since 1.118) - use {@link sap.ui.Device.browser.mobile Device.browser.mobile} instead.
|
|
17285
|
+
*
|
|
17052
17286
|
* Check if the script is running on mobile
|
|
17053
17287
|
*
|
|
17054
17288
|
* @returns true or false
|
|
@@ -17168,6 +17402,8 @@ declare module "sap/ui/core/Core" {
|
|
|
17168
17402
|
}
|
|
17169
17403
|
): LibraryInfo | Promise<LibraryInfo>;
|
|
17170
17404
|
/**
|
|
17405
|
+
* @deprecated (since 1.118)
|
|
17406
|
+
*
|
|
17171
17407
|
* Locks the Core. No browser events are dispatched to the controls.
|
|
17172
17408
|
*
|
|
17173
17409
|
* Lock should be called before and after the DOM is modified for rendering, roundtrips... Exceptions might
|
|
@@ -17185,6 +17421,19 @@ declare module "sap/ui/core/Core" {
|
|
|
17185
17421
|
* DOM, for example changing the cozy/compact CSS class at a single control
|
|
17186
17422
|
*/
|
|
17187
17423
|
notifyContentDensityChanged(): void;
|
|
17424
|
+
/**
|
|
17425
|
+
* @since 1.118.0
|
|
17426
|
+
*
|
|
17427
|
+
* Returns a Promise that resolves if the Core is initialized.
|
|
17428
|
+
*
|
|
17429
|
+
* @returns The ready promise
|
|
17430
|
+
*/
|
|
17431
|
+
ready(
|
|
17432
|
+
/**
|
|
17433
|
+
* If the Core is ready the function will be called immediately, otherwise when the ready Promise resolves.
|
|
17434
|
+
*/
|
|
17435
|
+
fnReady?: () => void
|
|
17436
|
+
): Promise<undefined>;
|
|
17188
17437
|
/**
|
|
17189
17438
|
* @deprecated (since 1.73) - Plugins never have been meant as a public offering, but were intended for
|
|
17190
17439
|
* internal usage only. They unfortunately allow access to all internals of the Core and therefore break
|
|
@@ -17207,6 +17456,9 @@ declare module "sap/ui/core/Core" {
|
|
|
17207
17456
|
oPlugin: object
|
|
17208
17457
|
): void;
|
|
17209
17458
|
/**
|
|
17459
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#setModel ManagedObject#setModel }
|
|
17460
|
+
* instead.
|
|
17461
|
+
*
|
|
17210
17462
|
* Sets or unsets a model for the given model name.
|
|
17211
17463
|
*
|
|
17212
17464
|
* The `sName` must either be `undefined` (or omitted) or a non-empty string. When the name is omitted,
|
|
@@ -17383,6 +17635,8 @@ declare module "sap/ui/core/Core" {
|
|
|
17383
17635
|
bForceUpdate?: boolean
|
|
17384
17636
|
): this;
|
|
17385
17637
|
/**
|
|
17638
|
+
* @deprecated (since 1.118)
|
|
17639
|
+
*
|
|
17386
17640
|
* Unlocks the Core.
|
|
17387
17641
|
*
|
|
17388
17642
|
* Browser events are dispatched to the controls again after this method is called.
|
|
@@ -26139,6 +26393,275 @@ declare module "sap/ui/core/LayoutData" {
|
|
|
26139
26393
|
export interface $LayoutDataSettings extends $ElementSettings {}
|
|
26140
26394
|
}
|
|
26141
26395
|
|
|
26396
|
+
declare module "sap/ui/core/Lib" {
|
|
26397
|
+
import BaseObject from "sap/ui/base/Object";
|
|
26398
|
+
|
|
26399
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
26400
|
+
|
|
26401
|
+
import ResourceBundle from "sap/base/i18n/ResourceBundle";
|
|
26402
|
+
|
|
26403
|
+
/**
|
|
26404
|
+
* @since 1.118
|
|
26405
|
+
*
|
|
26406
|
+
* Library Loading: To load a library, {@link #.load} can be used directly without creating a library instance
|
|
26407
|
+
* in advance.
|
|
26408
|
+
*
|
|
26409
|
+
* What a library does:
|
|
26410
|
+
* - preload: {@link #preload} loads the library-preload bundle and its resource bundle and apply the
|
|
26411
|
+
* same for its dependencies
|
|
26412
|
+
* - theming: {@link #_includeTheme} creates a <link> in the page referring to the corresponding
|
|
26413
|
+
* `library.css`
|
|
26414
|
+
* - resource bundle: {@link #getResourceBundle} returns the resource bundle directly when it's already
|
|
26415
|
+
* loaded or triggers a synchronous request to load it. {@link #loadResourceBundle} loads a library's resource
|
|
26416
|
+
* bundle file asynchronously. The resource bundle file is also loaded when the `preload` function is called
|
|
26417
|
+
*/
|
|
26418
|
+
export default class Lib extends BaseObject {
|
|
26419
|
+
constructor();
|
|
26420
|
+
|
|
26421
|
+
/**
|
|
26422
|
+
* Creates a new subclass of class sap.ui.core.Lib with name `sClassName` and enriches it with the information
|
|
26423
|
+
* contained in `oClassInfo`.
|
|
26424
|
+
*
|
|
26425
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
26426
|
+
*
|
|
26427
|
+
* @returns Created class / constructor function
|
|
26428
|
+
*/
|
|
26429
|
+
static extend<T extends Record<string, unknown>>(
|
|
26430
|
+
/**
|
|
26431
|
+
* Name of the class being created
|
|
26432
|
+
*/
|
|
26433
|
+
sClassName: string,
|
|
26434
|
+
/**
|
|
26435
|
+
* Object literal with information about the class
|
|
26436
|
+
*/
|
|
26437
|
+
oClassInfo?: sap.ClassInfo<T, Lib>,
|
|
26438
|
+
/**
|
|
26439
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
26440
|
+
* used by this class
|
|
26441
|
+
*/
|
|
26442
|
+
FNMetaImpl?: Function
|
|
26443
|
+
): Function;
|
|
26444
|
+
/**
|
|
26445
|
+
* Returns a metadata object for class sap.ui.core.Lib.
|
|
26446
|
+
*
|
|
26447
|
+
* @returns Metadata object describing this class
|
|
26448
|
+
*/
|
|
26449
|
+
static getMetadata(): Metadata;
|
|
26450
|
+
/**
|
|
26451
|
+
* Retrieves a resource bundle for the given library and locale.
|
|
26452
|
+
*
|
|
26453
|
+
* If only one argument is given, it is assumed to be the library name. The locale then falls back to the
|
|
26454
|
+
* current {@link sap.ui.core.Configuration#getLanguage session locale}.
|
|
26455
|
+
*
|
|
26456
|
+
* @returns The best matching resource bundle for the given parameters or `undefined`
|
|
26457
|
+
*/
|
|
26458
|
+
static getResourceBundleFor(
|
|
26459
|
+
/**
|
|
26460
|
+
* Name of the library to retrieve the bundle for
|
|
26461
|
+
*/
|
|
26462
|
+
sLibrary: string,
|
|
26463
|
+
/**
|
|
26464
|
+
* Locale to retrieve the resource bundle for
|
|
26465
|
+
*/
|
|
26466
|
+
sLocale?: string
|
|
26467
|
+
): ResourceBundle | undefined;
|
|
26468
|
+
/**
|
|
26469
|
+
* Provides information about a library.
|
|
26470
|
+
*
|
|
26471
|
+
* This method is intended to be called exactly once while the main module of a library (its `library.js`
|
|
26472
|
+
* module) is executing, typically at its begin. The single parameter `oLibInfo` is an info object that
|
|
26473
|
+
* describes the content of the library.
|
|
26474
|
+
*
|
|
26475
|
+
* When the `mSettings` has been processed, a normalized version will be set on the library instance Finally,
|
|
26476
|
+
* this function fires {@link #event:LibraryChanged} event with operation 'add' for the newly loaded library.
|
|
26477
|
+
*
|
|
26478
|
+
* Side Effects:
|
|
26479
|
+
*
|
|
26480
|
+
* While analyzing the `mSettings`, the framework takes some additional actions:
|
|
26481
|
+
*
|
|
26482
|
+
*
|
|
26483
|
+
* - If the object contains a list of `interfaces`, they will be registered with the {@link sap.ui.base.DataType }
|
|
26484
|
+
* class to make them available as aggregation types in managed objects.
|
|
26485
|
+
*
|
|
26486
|
+
*
|
|
26487
|
+
* - If the object contains a list of `controls` or `elements`, {@link sap.ui.lazyRequire lazy stubs }
|
|
26488
|
+
* will be created for their constructor as well as for their static `extend` and `getMetadata` methods.
|
|
26489
|
+
* **Note:** Future versions might abandon the concept of lazy stubs as it requires synchronous XMLHttpRequests
|
|
26490
|
+
* which have been deprecated (see {@link http://xhr.spec.whatwg.org}). To be on the safe side, productive
|
|
26491
|
+
* applications should always require any modules that they directly depend on.
|
|
26492
|
+
*
|
|
26493
|
+
*
|
|
26494
|
+
* - With the `noLibraryCSS` property, the library can be marked as 'theming-free'. Otherwise, the framework
|
|
26495
|
+
* will add a <link> tag to the page's head, pointing to the library's theme-specific stylesheet.
|
|
26496
|
+
* The creation of such a <link> tag can be suppressed with the {@link sap.ui.core.Configuration global configuration option }
|
|
26497
|
+
* `preloadLibCss`. It can contain a list of library names for which no stylesheet should be included. This
|
|
26498
|
+
* is e.g. useful when an application merges the CSS for multiple libraries and already loaded the resulting
|
|
26499
|
+
* stylesheet.
|
|
26500
|
+
*
|
|
26501
|
+
*
|
|
26502
|
+
* - If a list of library `dependencies` is specified in the info object, those libraries will be loaded
|
|
26503
|
+
* synchronously.
|
|
26504
|
+
* **Note:** Dependencies between libraries don't have to be modeled as AMD dependencies. Only when enums
|
|
26505
|
+
* or types from an additional library are used in the coding of the `library.js` module, the library should
|
|
26506
|
+
* be additionally listed in the AMD dependencies.
|
|
26507
|
+
*
|
|
26508
|
+
* Last but not least, higher layer frameworks might want to include their own metadata for libraries. The
|
|
26509
|
+
* property `extensions` might contain such additional metadata. Its structure is not defined by the framework,
|
|
26510
|
+
* but it is strongly suggested that each extension only occupies a single property in the `extensions`
|
|
26511
|
+
* object and that the name of that property contains some namespace information (e.g. library name that
|
|
26512
|
+
* introduces the feature) to avoid conflicts with other extensions. The framework won't touch the content
|
|
26513
|
+
* of `extensions` but will make it available in the library info objects returned by {@link #.getInitializedLibraries}.
|
|
26514
|
+
*
|
|
26515
|
+
* Relationship to Descriptor for Libraries (manifest.json):
|
|
26516
|
+
*
|
|
26517
|
+
* The information contained in `mSettings` is partially redundant to the content of the descriptor for
|
|
26518
|
+
* the same library (its `manifest.json` file). Future versions of UI5 might ignore the information provided
|
|
26519
|
+
* in `oLibInfo` and might evaluate the descriptor file instead. Library developers therefore should keep
|
|
26520
|
+
* the information in both files in sync.
|
|
26521
|
+
*
|
|
26522
|
+
* When the `manifest.json` is generated from the `.library` file (which is the default for UI5 libraries
|
|
26523
|
+
* built with Maven), then the content of the `.library` and `library.js` files must be kept in sync.
|
|
26524
|
+
*
|
|
26525
|
+
* @returns As of version 1.101; returns the library namespace, based on the given library name.
|
|
26526
|
+
*/
|
|
26527
|
+
static init(
|
|
26528
|
+
/**
|
|
26529
|
+
* Info object for the library
|
|
26530
|
+
*/
|
|
26531
|
+
mSettings: {
|
|
26532
|
+
/**
|
|
26533
|
+
* Name of the library; It must match the name by which the library has been loaded
|
|
26534
|
+
*/
|
|
26535
|
+
name: string;
|
|
26536
|
+
/**
|
|
26537
|
+
* Version of the library
|
|
26538
|
+
*/
|
|
26539
|
+
version?: string;
|
|
26540
|
+
/**
|
|
26541
|
+
* List of libraries that this library depends on; names are in dot notation (e.g. "sap.ui.core")
|
|
26542
|
+
*/
|
|
26543
|
+
dependencies?: string[];
|
|
26544
|
+
/**
|
|
26545
|
+
* List of names of types that this library provides; names are in dot notation (e.g. "sap.ui.core.CSSSize")
|
|
26546
|
+
*/
|
|
26547
|
+
types?: string[];
|
|
26548
|
+
/**
|
|
26549
|
+
* List of names of interface types that this library provides; names are in dot notation (e.g. "sap.ui.core.PopupInterface")
|
|
26550
|
+
*/
|
|
26551
|
+
interfaces?: string[];
|
|
26552
|
+
/**
|
|
26553
|
+
* Names of control types that this library provides; names are in dot notation (e.g. "sap.ui.core.ComponentContainer")
|
|
26554
|
+
*/
|
|
26555
|
+
controls?: string[];
|
|
26556
|
+
/**
|
|
26557
|
+
* Names of element types that this library provides (excluding controls); names are in dot notation (e.g.
|
|
26558
|
+
* "sap.ui.core.Item")
|
|
26559
|
+
*/
|
|
26560
|
+
elements?: string[];
|
|
26561
|
+
/**
|
|
26562
|
+
* Indicates whether the library doesn't provide / use theming. When set to true, no library.css will be
|
|
26563
|
+
* loaded for this library
|
|
26564
|
+
*/
|
|
26565
|
+
noLibraryCSS?: boolean;
|
|
26566
|
+
/**
|
|
26567
|
+
* Potential extensions of the library metadata; structure not defined by the UI5 core framework.
|
|
26568
|
+
*/
|
|
26569
|
+
extensions?: object;
|
|
26570
|
+
}
|
|
26571
|
+
): object;
|
|
26572
|
+
/**
|
|
26573
|
+
* Checks whether the library for the given `sName` has been loaded or not.
|
|
26574
|
+
*
|
|
26575
|
+
* @returns Returns `true` if the library is loaded. Otherwise `false`.
|
|
26576
|
+
*/
|
|
26577
|
+
static isLoaded(
|
|
26578
|
+
/**
|
|
26579
|
+
* The name of the library
|
|
26580
|
+
*/
|
|
26581
|
+
sName: string
|
|
26582
|
+
): boolean;
|
|
26583
|
+
/**
|
|
26584
|
+
* Loads the given library and its dependencies and makes its content available to the application.
|
|
26585
|
+
*
|
|
26586
|
+
* What it does:
|
|
26587
|
+
*
|
|
26588
|
+
* When library preloads are not suppressed for the given library, then a library-preload bundle will be
|
|
26589
|
+
* loaded for it.
|
|
26590
|
+
*
|
|
26591
|
+
* After preloading the bundle, dependency information from the bundle is evaluated and any missing libraries
|
|
26592
|
+
* are also preloaded.
|
|
26593
|
+
*
|
|
26594
|
+
* Only then the library entry module (named `your/lib/library.js`) will be required and executed.
|
|
26595
|
+
* The module is supposed to call {@link #.init} providing the framework with additional metadata about
|
|
26596
|
+
* the library, e.g. its version, the set of contained enums, types, interfaces, controls and elements and
|
|
26597
|
+
* whether the library requires CSS. If the library requires CSS, a <link> will be added to the page
|
|
26598
|
+
* referring to the corresponding `library.css` stylesheet for the library and the current theme.
|
|
26599
|
+
*
|
|
26600
|
+
* When the optional parameter `mOptions.url` is given, then that URL will be registered for the namespace
|
|
26601
|
+
* of the library and all resources will be loaded from that location. This is convenience for a call like
|
|
26602
|
+
*
|
|
26603
|
+
* ```javascript
|
|
26604
|
+
*
|
|
26605
|
+
* sap.ui.loader.config({
|
|
26606
|
+
* paths: {
|
|
26607
|
+
* "lib/with/slashes": mOptions.url
|
|
26608
|
+
* }
|
|
26609
|
+
* });
|
|
26610
|
+
* ```
|
|
26611
|
+
*
|
|
26612
|
+
*
|
|
26613
|
+
* When the given library has been loaded already, no further action will be taken, especially, a given
|
|
26614
|
+
* URL will not be registered. A Promise will be returned, but will be resolved immediately.
|
|
26615
|
+
*
|
|
26616
|
+
* When to use:
|
|
26617
|
+
*
|
|
26618
|
+
* For applications that follow the best practices and use components with component descriptors (manifest.json),
|
|
26619
|
+
* the framework will load all declared mandatory libraries and their dependencies automatically before
|
|
26620
|
+
* instantiating the application component.
|
|
26621
|
+
*
|
|
26622
|
+
* The same is true for libraries that are listed in the bootstrap configuration (e.g. with the attribute
|
|
26623
|
+
* `data-sap-ui-libs`). They will be loaded before the `init` event of the UI5 Core is fired.
|
|
26624
|
+
*
|
|
26625
|
+
* Only when an app declares a library to be a lazy library dependency or when code does not use descriptors
|
|
26626
|
+
* at all, then an explicit call to `loadLibrary` becomes necessary. The call should be made before artifacts
|
|
26627
|
+
* (controls, elements, types, helpers, modules etc.) from the library are used or required. This allows
|
|
26628
|
+
* the framework to optimize access to those artifacts.
|
|
26629
|
+
*
|
|
26630
|
+
* For example, when an app uses a heavy-weight charting library that shouldn't be loaded during startup,
|
|
26631
|
+
* it can declare it as "lazy" and load it just before it loads and displays a view that uses the charting
|
|
26632
|
+
* library:
|
|
26633
|
+
* ```javascript
|
|
26634
|
+
*
|
|
26635
|
+
* Lib.load({name: "heavy.charting"})
|
|
26636
|
+
* .then(function() {
|
|
26637
|
+
* View.create({
|
|
26638
|
+
* name: "myapp.views.HeavyChartingView",
|
|
26639
|
+
* type: ViewType.XML
|
|
26640
|
+
* });
|
|
26641
|
+
* });
|
|
26642
|
+
* ```
|
|
26643
|
+
*
|
|
26644
|
+
*
|
|
26645
|
+
* @returns A promise that resolves with the library instance after the loading of the library is finished
|
|
26646
|
+
*/
|
|
26647
|
+
static load(
|
|
26648
|
+
/**
|
|
26649
|
+
* The options object that contains the following properties
|
|
26650
|
+
*/
|
|
26651
|
+
mOptions: {
|
|
26652
|
+
/**
|
|
26653
|
+
* The name of the library
|
|
26654
|
+
*/
|
|
26655
|
+
name: string;
|
|
26656
|
+
/**
|
|
26657
|
+
* URL to load the library from
|
|
26658
|
+
*/
|
|
26659
|
+
url?: string;
|
|
26660
|
+
}
|
|
26661
|
+
): Promise<Lib>;
|
|
26662
|
+
}
|
|
26663
|
+
}
|
|
26664
|
+
|
|
26142
26665
|
declare module "sap/ui/core/ListItem" {
|
|
26143
26666
|
import { default as Item, $ItemSettings } from "sap/ui/core/Item";
|
|
26144
26667
|
|
|
@@ -27864,7 +28387,7 @@ declare module "sap/ui/core/Message" {
|
|
|
27864
28387
|
*
|
|
27865
28388
|
* @returns Value of property `level`
|
|
27866
28389
|
*/
|
|
27867
|
-
getLevel(): MessageType
|
|
28390
|
+
getLevel(): MessageType;
|
|
27868
28391
|
/**
|
|
27869
28392
|
* @since 1.19.0
|
|
27870
28393
|
*
|
|
@@ -27925,7 +28448,7 @@ declare module "sap/ui/core/Message" {
|
|
|
27925
28448
|
/**
|
|
27926
28449
|
* New value for property `level`
|
|
27927
28450
|
*/
|
|
27928
|
-
sLevel?: MessageType
|
|
28451
|
+
sLevel?: MessageType
|
|
27929
28452
|
): this;
|
|
27930
28453
|
/**
|
|
27931
28454
|
* @since 1.19.0
|
|
@@ -28000,10 +28523,7 @@ declare module "sap/ui/core/Message" {
|
|
|
28000
28523
|
/**
|
|
28001
28524
|
* Setting the message's level.
|
|
28002
28525
|
*/
|
|
28003
|
-
level?:
|
|
28004
|
-
| (MessageType | keyof typeof MessageType)
|
|
28005
|
-
| PropertyBindingInfo
|
|
28006
|
-
| `{${string}}`;
|
|
28526
|
+
level?: MessageType | PropertyBindingInfo | `{${string}}`;
|
|
28007
28527
|
|
|
28008
28528
|
/**
|
|
28009
28529
|
* @since 1.19.0
|
|
@@ -28125,7 +28645,7 @@ declare module "sap/ui/core/message/Message" {
|
|
|
28125
28645
|
/**
|
|
28126
28646
|
* The message type
|
|
28127
28647
|
*/
|
|
28128
|
-
type?: MessageType
|
|
28648
|
+
type?: MessageType;
|
|
28129
28649
|
/**
|
|
28130
28650
|
* The message code
|
|
28131
28651
|
*/
|
|
@@ -28302,7 +28822,7 @@ declare module "sap/ui/core/message/Message" {
|
|
|
28302
28822
|
*
|
|
28303
28823
|
* @returns type
|
|
28304
28824
|
*/
|
|
28305
|
-
getType(): MessageType
|
|
28825
|
+
getType(): MessageType;
|
|
28306
28826
|
/**
|
|
28307
28827
|
* Sets the additionaltext for the message or merge different additionaltext strings
|
|
28308
28828
|
*/
|
|
@@ -28424,30 +28944,25 @@ declare module "sap/ui/core/message/Message" {
|
|
|
28424
28944
|
/**
|
|
28425
28945
|
* The Message type
|
|
28426
28946
|
*/
|
|
28427
|
-
sType: MessageType
|
|
28947
|
+
sType: MessageType
|
|
28428
28948
|
): void;
|
|
28429
28949
|
}
|
|
28430
28950
|
}
|
|
28431
28951
|
|
|
28432
28952
|
declare module "sap/ui/core/message/MessageManager" {
|
|
28433
|
-
import
|
|
28434
|
-
|
|
28435
|
-
import Message from "sap/ui/core/message/Message";
|
|
28436
|
-
|
|
28437
|
-
import MessageModel from "sap/ui/model/message/MessageModel";
|
|
28953
|
+
import BaseObject from "sap/ui/base/Object";
|
|
28438
28954
|
|
|
28439
28955
|
import Metadata from "sap/ui/base/Metadata";
|
|
28440
28956
|
|
|
28441
|
-
|
|
28442
|
-
|
|
28443
|
-
|
|
28444
|
-
|
|
28445
|
-
export default class MessageManager extends EventProvider {
|
|
28957
|
+
/**
|
|
28958
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.core.Messaging Messaging} instead.
|
|
28959
|
+
*/
|
|
28960
|
+
export default class MessageManager extends BaseObject {
|
|
28446
28961
|
/**
|
|
28447
28962
|
* Constructor for a new MessageManager.
|
|
28448
28963
|
*
|
|
28449
|
-
* Creating own instances of MessageManager is deprecated. Please require 'sap/ui/core/
|
|
28450
|
-
*
|
|
28964
|
+
* Creating own instances of MessageManager is deprecated. Please require 'sap/ui/core/Messaging' instead
|
|
28965
|
+
* and use the module export directly without using 'new'.
|
|
28451
28966
|
*/
|
|
28452
28967
|
constructor();
|
|
28453
28968
|
|
|
@@ -28455,7 +28970,7 @@ declare module "sap/ui/core/message/MessageManager" {
|
|
|
28455
28970
|
* Creates a new subclass of class sap.ui.core.message.MessageManager with name `sClassName` and enriches
|
|
28456
28971
|
* it with the information contained in `oClassInfo`.
|
|
28457
28972
|
*
|
|
28458
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.
|
|
28973
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
28459
28974
|
*
|
|
28460
28975
|
* @returns Created class / constructor function
|
|
28461
28976
|
*/
|
|
@@ -28480,101 +28995,6 @@ declare module "sap/ui/core/message/MessageManager" {
|
|
|
28480
28995
|
* @returns Metadata object describing this class
|
|
28481
28996
|
*/
|
|
28482
28997
|
static getMetadata(): Metadata;
|
|
28483
|
-
/**
|
|
28484
|
-
* Add messages to MessageManager
|
|
28485
|
-
*/
|
|
28486
|
-
addMessages(
|
|
28487
|
-
/**
|
|
28488
|
-
* Array of sap.ui.core.message.Message or single sap.ui.core.message.Message
|
|
28489
|
-
*/
|
|
28490
|
-
vMessages: Message | Message[]
|
|
28491
|
-
): void;
|
|
28492
|
-
/**
|
|
28493
|
-
* @deprecated (since 1.32) - do not call `destroy()` on a `MessageManager`.
|
|
28494
|
-
*
|
|
28495
|
-
* Destroy MessageManager
|
|
28496
|
-
*/
|
|
28497
|
-
destroy(): void;
|
|
28498
|
-
/**
|
|
28499
|
-
* Get the MessageModel
|
|
28500
|
-
*
|
|
28501
|
-
* @returns oMessageModel The Message Model
|
|
28502
|
-
*/
|
|
28503
|
-
getMessageModel(): MessageModel;
|
|
28504
|
-
/**
|
|
28505
|
-
* Register MessageProcessor
|
|
28506
|
-
*/
|
|
28507
|
-
registerMessageProcessor(
|
|
28508
|
-
/**
|
|
28509
|
-
* The MessageProcessor
|
|
28510
|
-
*/
|
|
28511
|
-
oProcessor: MessageProcessor
|
|
28512
|
-
): void;
|
|
28513
|
-
/**
|
|
28514
|
-
* When using the databinding type system, the validation/parsing of a new property value could fail. In
|
|
28515
|
-
* this case, a validationError/parseError event is fired. These events bubble up to the core. For registered
|
|
28516
|
-
* ManagedObjects, the MessageManager attaches to these events and creates a `sap.ui.core.message.Message`
|
|
28517
|
-
* (bHandleValidation=true) for each of these errors and cancels the event bubbling.
|
|
28518
|
-
*/
|
|
28519
|
-
registerObject(
|
|
28520
|
-
/**
|
|
28521
|
-
* The sap.ui.base.ManagedObject
|
|
28522
|
-
*/
|
|
28523
|
-
oObject: ManagedObject,
|
|
28524
|
-
/**
|
|
28525
|
-
* Handle validationError/parseError events for this object. If set to true, the MessageManager creates
|
|
28526
|
-
* a Message for each validation/parse error. The event bubbling is canceled in every case.
|
|
28527
|
-
*/
|
|
28528
|
-
bHandleValidation: boolean
|
|
28529
|
-
): void;
|
|
28530
|
-
/**
|
|
28531
|
-
* Remove all messages
|
|
28532
|
-
*/
|
|
28533
|
-
removeAllMessages(): void;
|
|
28534
|
-
/**
|
|
28535
|
-
* Remove given Messages
|
|
28536
|
-
*/
|
|
28537
|
-
removeMessages(
|
|
28538
|
-
/**
|
|
28539
|
-
* The message(s) to be removed.
|
|
28540
|
-
*/
|
|
28541
|
-
vMessages: Message | Message[]
|
|
28542
|
-
): void;
|
|
28543
|
-
/**
|
|
28544
|
-
* Deregister MessageProcessor
|
|
28545
|
-
*/
|
|
28546
|
-
unregisterMessageProcessor(
|
|
28547
|
-
/**
|
|
28548
|
-
* The MessageProcessor
|
|
28549
|
-
*/
|
|
28550
|
-
oProcessor: MessageProcessor
|
|
28551
|
-
): void;
|
|
28552
|
-
/**
|
|
28553
|
-
* Unregister ManagedObject
|
|
28554
|
-
*/
|
|
28555
|
-
unregisterObject(
|
|
28556
|
-
/**
|
|
28557
|
-
* The sap.ui.base.ManagedObject
|
|
28558
|
-
*/
|
|
28559
|
-
oObject: ManagedObject
|
|
28560
|
-
): void;
|
|
28561
|
-
/**
|
|
28562
|
-
* @since 1.115
|
|
28563
|
-
*
|
|
28564
|
-
* Update Messages by providing two arrays of old and new messages.
|
|
28565
|
-
*
|
|
28566
|
-
* The old ones will be removed, the new ones will be added.
|
|
28567
|
-
*/
|
|
28568
|
-
updateMessages(
|
|
28569
|
-
/**
|
|
28570
|
-
* Array of old messages to be removed
|
|
28571
|
-
*/
|
|
28572
|
-
aOldMessages: any[],
|
|
28573
|
-
/**
|
|
28574
|
-
* Array of new messages to be added
|
|
28575
|
-
*/
|
|
28576
|
-
aNewMessages: any[]
|
|
28577
|
-
): void;
|
|
28578
28998
|
}
|
|
28579
28999
|
}
|
|
28580
29000
|
|
|
@@ -28771,7 +29191,7 @@ declare module "sap/ui/core/message/MessageProcessor" {
|
|
|
28771
29191
|
oListener?: object
|
|
28772
29192
|
): this;
|
|
28773
29193
|
/**
|
|
28774
|
-
* @deprecated - 1.115 Use {@link sap.ui.core.
|
|
29194
|
+
* @deprecated - 1.115 Use {@link sap.ui.core.Messaging#updateMessages} instead
|
|
28775
29195
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
28776
29196
|
*
|
|
28777
29197
|
* Fires event {@link #event:messageChange messageChange} to attached listeners.
|
|
@@ -28819,6 +29239,35 @@ declare module "sap/ui/core/message/MessageProcessor" {
|
|
|
28819
29239
|
>;
|
|
28820
29240
|
}
|
|
28821
29241
|
|
|
29242
|
+
declare module "sap/ui/core/message/MessageType" {
|
|
29243
|
+
/**
|
|
29244
|
+
* Specifies possible message types.
|
|
29245
|
+
*/
|
|
29246
|
+
enum MessageType {
|
|
29247
|
+
/**
|
|
29248
|
+
* Message is an error
|
|
29249
|
+
*/
|
|
29250
|
+
Error = "Error",
|
|
29251
|
+
/**
|
|
29252
|
+
* Message should be just an information
|
|
29253
|
+
*/
|
|
29254
|
+
Information = "Information",
|
|
29255
|
+
/**
|
|
29256
|
+
* Message has no specific level
|
|
29257
|
+
*/
|
|
29258
|
+
None = "None",
|
|
29259
|
+
/**
|
|
29260
|
+
* Message is a success message
|
|
29261
|
+
*/
|
|
29262
|
+
Success = "Success",
|
|
29263
|
+
/**
|
|
29264
|
+
* Message is a warning
|
|
29265
|
+
*/
|
|
29266
|
+
Warning = "Warning",
|
|
29267
|
+
}
|
|
29268
|
+
export default MessageType;
|
|
29269
|
+
}
|
|
29270
|
+
|
|
28822
29271
|
declare module "sap/ui/core/mvc/Controller" {
|
|
28823
29272
|
import EventProvider from "sap/ui/base/EventProvider";
|
|
28824
29273
|
|
|
@@ -33399,9 +33848,6 @@ declare module "sap/ui/core/ResizeHandler" {
|
|
|
33399
33848
|
/**
|
|
33400
33849
|
* Registers the given event handler for resize events on the given DOM element or control.
|
|
33401
33850
|
*
|
|
33402
|
-
* **Note:** This function must not be used before the UI5 framework is initialized. Please use the {@link sap.ui.core.Core#attachInit init event }
|
|
33403
|
-
* of UI5 if you are not sure whether this is the case.
|
|
33404
|
-
*
|
|
33405
33851
|
* The resize handler periodically checks the dimensions of the registered reference. Whenever it detects
|
|
33406
33852
|
* changes, an event is fired. Be careful when changing dimensions within the event handler which might
|
|
33407
33853
|
* cause another resize event and so on.
|
|
@@ -40123,14 +40569,6 @@ declare module "sap/ui/core/UIArea" {
|
|
|
40123
40569
|
* @returns True if the control is still in the active DOM
|
|
40124
40570
|
*/
|
|
40125
40571
|
isActive(): boolean;
|
|
40126
|
-
/**
|
|
40127
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
40128
|
-
*
|
|
40129
|
-
* Returns whether re-rendering is currently suppressed on this UIArea.
|
|
40130
|
-
*
|
|
40131
|
-
* @returns Whether re-rendering is currently suppressed on this UIArea
|
|
40132
|
-
*/
|
|
40133
|
-
isInvalidateSuppressed(): boolean;
|
|
40134
40572
|
/**
|
|
40135
40573
|
* Returns the locked state of the `sap.ui.core.UIArea`
|
|
40136
40574
|
*
|
|
@@ -42929,6 +43367,300 @@ declare module "sap/ui/core/VariantLayoutData" {
|
|
|
42929
43367
|
}
|
|
42930
43368
|
}
|
|
42931
43369
|
|
|
43370
|
+
declare module "sap/ui/core/webc/WebComponent" {
|
|
43371
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
43372
|
+
|
|
43373
|
+
import WebComponentMetadata from "sap/ui/core/webc/WebComponentMetadata";
|
|
43374
|
+
|
|
43375
|
+
import { MetadataOptions as MetadataOptions1 } from "sap/ui/core/Element";
|
|
43376
|
+
|
|
43377
|
+
import { MetadataOptions as MetadataOptions2 } from "sap/ui/base/ManagedObject";
|
|
43378
|
+
|
|
43379
|
+
/**
|
|
43380
|
+
* @since 1.118.0
|
|
43381
|
+
* @experimental (since 1.118.0) - The API might change. It is not intended for productive usage yet!
|
|
43382
|
+
*
|
|
43383
|
+
* Base Class for Web Components. Web Components are agnostic UI elements which can be integrated into the
|
|
43384
|
+
* UI5 programming model by using this wrapper control. This wrapper control takes care to propagate the
|
|
43385
|
+
* properties, the aggregations and the events. It also ensures to render the control and put the aggregated
|
|
43386
|
+
* controls in the dedicated slots of the Web Component.
|
|
43387
|
+
*/
|
|
43388
|
+
export default class WebComponent extends Control {
|
|
43389
|
+
/**
|
|
43390
|
+
* Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
|
|
43391
|
+
*
|
|
43392
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
43393
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
43394
|
+
* of the syntax of the settings object.
|
|
43395
|
+
*/
|
|
43396
|
+
constructor(
|
|
43397
|
+
/**
|
|
43398
|
+
* Object with initial settings for the new control
|
|
43399
|
+
*/
|
|
43400
|
+
mSettings?: $WebComponentSettings
|
|
43401
|
+
);
|
|
43402
|
+
/**
|
|
43403
|
+
* Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
|
|
43404
|
+
*
|
|
43405
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
43406
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
43407
|
+
* of the syntax of the settings object.
|
|
43408
|
+
*/
|
|
43409
|
+
constructor(
|
|
43410
|
+
/**
|
|
43411
|
+
* Optional ID for the new control; generated automatically if no non-empty ID is given Note: this can be
|
|
43412
|
+
* omitted, no matter whether `mSettings` will be given or not!
|
|
43413
|
+
*/
|
|
43414
|
+
sId?: string,
|
|
43415
|
+
/**
|
|
43416
|
+
* Object with initial settings for the new control
|
|
43417
|
+
*/
|
|
43418
|
+
mSettings?: $WebComponentSettings
|
|
43419
|
+
);
|
|
43420
|
+
|
|
43421
|
+
/**
|
|
43422
|
+
* Defines a new subclass of WebComponent with the name `sClassName` and enriches it with the information
|
|
43423
|
+
* contained in `oClassInfo`.
|
|
43424
|
+
*
|
|
43425
|
+
* `oClassInfo` can contain the same information that {@link sap.ui.base.ManagedObject.extend} already accepts,
|
|
43426
|
+
* plus the `dnd` property in the metadata object literal to configure drag-and-drop behavior (see {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions }
|
|
43427
|
+
* for details). Objects describing aggregations can also have a `dnd` property when used for a class extending
|
|
43428
|
+
* `WebComponent` (see {@link sap.ui.base.ManagedObject.MetadataOptions.AggregationDnD AggregationDnD}).
|
|
43429
|
+
*
|
|
43430
|
+
* Example:
|
|
43431
|
+
* ```javascript
|
|
43432
|
+
*
|
|
43433
|
+
* WebComponent.extend('sap.mylib.MyElement', {
|
|
43434
|
+
* metadata : {
|
|
43435
|
+
* library : 'sap.mylib',
|
|
43436
|
+
* tag : 'my-webcomponent',
|
|
43437
|
+
* properties : {
|
|
43438
|
+
* value : 'string',
|
|
43439
|
+
* width : {
|
|
43440
|
+
* type: 'sap.ui.core.CSSSize',
|
|
43441
|
+
* mapping: 'style'
|
|
43442
|
+
* }
|
|
43443
|
+
* },
|
|
43444
|
+
* defaultAggregation: "content",
|
|
43445
|
+
* aggregations : {
|
|
43446
|
+
* content : {
|
|
43447
|
+
* type: 'sap.ui.core.Control',
|
|
43448
|
+
* multiple : true
|
|
43449
|
+
* },
|
|
43450
|
+
* header : {
|
|
43451
|
+
* type : 'sap.ui.core.Control',
|
|
43452
|
+
* multiple : false,
|
|
43453
|
+
* slot: 'header'
|
|
43454
|
+
* }
|
|
43455
|
+
* }
|
|
43456
|
+
* }
|
|
43457
|
+
* });
|
|
43458
|
+
* ```
|
|
43459
|
+
*
|
|
43460
|
+
*
|
|
43461
|
+
* @returns Created class / constructor function
|
|
43462
|
+
*/
|
|
43463
|
+
static extend<T extends Record<string, unknown>>(
|
|
43464
|
+
/**
|
|
43465
|
+
* Name of the class to be created
|
|
43466
|
+
*/
|
|
43467
|
+
sClassName: string,
|
|
43468
|
+
/**
|
|
43469
|
+
* Object literal with information about the class
|
|
43470
|
+
*/
|
|
43471
|
+
oClassInfo?: sap.ClassInfo<T, WebComponent>,
|
|
43472
|
+
/**
|
|
43473
|
+
* Constructor function for the metadata object. If not given, it defaults to `sap.ui.core.ElementMetadata`.
|
|
43474
|
+
*/
|
|
43475
|
+
FNMetaImpl?: Function
|
|
43476
|
+
): Function;
|
|
43477
|
+
/**
|
|
43478
|
+
* Returns a metadata object for class sap.ui.core.webc.WebComponent.
|
|
43479
|
+
*
|
|
43480
|
+
* @returns Metadata object describing this class
|
|
43481
|
+
*/
|
|
43482
|
+
static getMetadata(): WebComponentMetadata;
|
|
43483
|
+
}
|
|
43484
|
+
/**
|
|
43485
|
+
* The structure of the "metadata" object which is passed when inheriting from sap.ui.core.Element using
|
|
43486
|
+
* its static "extend" method. See {@link sap.ui.core.Element.extend} for details on its usage.
|
|
43487
|
+
*/
|
|
43488
|
+
export type MetadataOptions = MetadataOptions1 & {
|
|
43489
|
+
/**
|
|
43490
|
+
* Tag name of the Web Component to be used in the renderer to render the HTML.
|
|
43491
|
+
*/
|
|
43492
|
+
tag: string;
|
|
43493
|
+
/**
|
|
43494
|
+
* An object literal whose properties each define a new managed property in the WebComponent subclass. See
|
|
43495
|
+
* {@link sap.ui.base.ManagedObject.MetadataOptions.Property Property} for more details.
|
|
43496
|
+
*/
|
|
43497
|
+
properties?: Record<string, string | MetadataOptions.Property>;
|
|
43498
|
+
/**
|
|
43499
|
+
* An object literal whose properties each define a new aggregation in the ManagedObject subclass. See {@link sap.ui.base.ManagedObject.MetadataOptions.Aggregation Aggregation }
|
|
43500
|
+
* for more details.
|
|
43501
|
+
*/
|
|
43502
|
+
aggregations?: Record<string, string | MetadataOptions.Aggregation>;
|
|
43503
|
+
/**
|
|
43504
|
+
* An object literal whose properties each define a new association in the ManagedObject subclass. See {@link sap.ui.base.ManagedObject.MetadataOptions.Association Association }
|
|
43505
|
+
* for more details.
|
|
43506
|
+
*/
|
|
43507
|
+
associations?: Record<string, string | MetadataOptions.Association>;
|
|
43508
|
+
/**
|
|
43509
|
+
* Proxied public getters of the Web Component which are directly accessible on the wrapper Control.
|
|
43510
|
+
*/
|
|
43511
|
+
getters?: string[];
|
|
43512
|
+
/**
|
|
43513
|
+
* Proxied public methods of the Web Component which are directly accessible on the wrapper Control.
|
|
43514
|
+
*/
|
|
43515
|
+
methods?: string[];
|
|
43516
|
+
};
|
|
43517
|
+
|
|
43518
|
+
/**
|
|
43519
|
+
* HACK! This mapping omits the `no-unnecessary-qualifier` error or we need to extend the `tslint.json`!
|
|
43520
|
+
*/
|
|
43521
|
+
export type MetadataOptionsAssociationMapping = MetadataOptions.Association.Mapping;
|
|
43522
|
+
|
|
43523
|
+
/**
|
|
43524
|
+
* HACK! This mapping omits the `no-unnecessary-qualifier` error or we need to extend the `tslint.json`!
|
|
43525
|
+
*/
|
|
43526
|
+
export type MetadataOptionsPropertyMapping = MetadataOptions.Property.Mapping;
|
|
43527
|
+
|
|
43528
|
+
export interface $WebComponentSettings extends $ControlSettings {}
|
|
43529
|
+
|
|
43530
|
+
export namespace MetadataOptions {
|
|
43531
|
+
namespace Association {
|
|
43532
|
+
/**
|
|
43533
|
+
* An object literal describing the mapping of an association as property of a class derived from `sap.ui.core.webc.WebComponent`.
|
|
43534
|
+
*/
|
|
43535
|
+
type Mapping = {
|
|
43536
|
+
/**
|
|
43537
|
+
* Defines the mapping of the association which defaults to "property". Associations are forwarded to the
|
|
43538
|
+
* corresponding mutator of the Web Component.
|
|
43539
|
+
*/
|
|
43540
|
+
type?: "property";
|
|
43541
|
+
/**
|
|
43542
|
+
* Defines the target of the mapping of the association to which property it will be mapped to.
|
|
43543
|
+
*/
|
|
43544
|
+
to?: string;
|
|
43545
|
+
/**
|
|
43546
|
+
* Defines the name of the formatter function at the WebComponent instance to format the value before its
|
|
43547
|
+
* being mapped.
|
|
43548
|
+
*/
|
|
43549
|
+
formatter?: string;
|
|
43550
|
+
};
|
|
43551
|
+
}
|
|
43552
|
+
|
|
43553
|
+
namespace Property {
|
|
43554
|
+
/**
|
|
43555
|
+
* An object literal describing the mapping of a property of a class derived from `sap.ui.core.webc.WebComponent`.
|
|
43556
|
+
*/
|
|
43557
|
+
type Mapping = {
|
|
43558
|
+
/**
|
|
43559
|
+
* Defines the mapping of the property to be either "property", "style", "textContent", "slot", or "none".
|
|
43560
|
+
* The default mapping of a property is "property" which either renders the value of the property into an
|
|
43561
|
+
* attribute of the custom tag or forwards object properties to the mutator in the onAfterRendering phase.
|
|
43562
|
+
*/
|
|
43563
|
+
type?: "property" | "style" | "textContent" | "slot" | "none";
|
|
43564
|
+
/**
|
|
43565
|
+
* Defines the target of the mapping of the property (e.g. the name of the attribute/property).
|
|
43566
|
+
*/
|
|
43567
|
+
to?: string;
|
|
43568
|
+
/**
|
|
43569
|
+
* Defines the name of the formatter function at the WebComponent instance to format the value before its
|
|
43570
|
+
* being mapped.
|
|
43571
|
+
*/
|
|
43572
|
+
formatter?: string;
|
|
43573
|
+
};
|
|
43574
|
+
}
|
|
43575
|
+
|
|
43576
|
+
/**
|
|
43577
|
+
* An object literal describing a property of a class derived from `sap.ui.core.webc.WebComponent`. See
|
|
43578
|
+
* {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions} for details on its usage.
|
|
43579
|
+
*/
|
|
43580
|
+
type Aggregation = MetadataOptions2.Aggregation & {
|
|
43581
|
+
/**
|
|
43582
|
+
* Flag that marks the property as deprecated (defaults to false). May lead to an additional warning log
|
|
43583
|
+
* message at runtime when the property is still used. For the documentation, also add a `@deprecated` tag
|
|
43584
|
+
* in the JSDoc, describing since when it is deprecated and what any alternatives are.
|
|
43585
|
+
*/
|
|
43586
|
+
slot?: string;
|
|
43587
|
+
};
|
|
43588
|
+
|
|
43589
|
+
/**
|
|
43590
|
+
* An object literal describing an association of a class derived from `sap.ui.core.webc.WebComponent`.
|
|
43591
|
+
* See {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions} for details on its usage.
|
|
43592
|
+
*/
|
|
43593
|
+
type Association = MetadataOptions2.Association & {
|
|
43594
|
+
/**
|
|
43595
|
+
* Defines the mapping of the association which defaults to "property". Associations are forwarded to the
|
|
43596
|
+
* corresponding mutator of the Web Component.
|
|
43597
|
+
*/
|
|
43598
|
+
mapping?: "property" | MetadataOptionsAssociationMapping;
|
|
43599
|
+
};
|
|
43600
|
+
|
|
43601
|
+
/**
|
|
43602
|
+
* An object literal describing a property of a class derived from `sap.ui.core.webc.WebComponent`. See
|
|
43603
|
+
* {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions} for details on its usage.
|
|
43604
|
+
*/
|
|
43605
|
+
type Property = MetadataOptions2.Property & {
|
|
43606
|
+
/**
|
|
43607
|
+
* Defines the mapping of the property to be either "property", "style", "textContent", "slot", or "none".
|
|
43608
|
+
* The default mapping of a property is "property" which either renders the value of the property into an
|
|
43609
|
+
* attribute of the custom tag or forwards object properties to the mutator in the onAfterRendering phase.
|
|
43610
|
+
*/
|
|
43611
|
+
mapping?:
|
|
43612
|
+
| "property"
|
|
43613
|
+
| "style"
|
|
43614
|
+
| "textContent"
|
|
43615
|
+
| "slot"
|
|
43616
|
+
| "none"
|
|
43617
|
+
| MetadataOptionsPropertyMapping;
|
|
43618
|
+
};
|
|
43619
|
+
}
|
|
43620
|
+
}
|
|
43621
|
+
|
|
43622
|
+
declare module "sap/ui/core/webc/WebComponentMetadata" {
|
|
43623
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
43624
|
+
|
|
43625
|
+
/**
|
|
43626
|
+
* @since 1.118.0
|
|
43627
|
+
* @experimental (since 1.118.0) - The API might change. It is not intended for productive usage yet!
|
|
43628
|
+
*/
|
|
43629
|
+
export default class WebComponentMetadata extends ElementMetadata {
|
|
43630
|
+
/**
|
|
43631
|
+
* Creates a new metadata object for a WebComponent Wrapper subclass.
|
|
43632
|
+
*/
|
|
43633
|
+
constructor(
|
|
43634
|
+
/**
|
|
43635
|
+
* fully qualified name of the class that is described by this metadata object
|
|
43636
|
+
*/
|
|
43637
|
+
sClassName: string,
|
|
43638
|
+
/**
|
|
43639
|
+
* static info to construct the metadata from
|
|
43640
|
+
*/
|
|
43641
|
+
oClassInfo: object
|
|
43642
|
+
);
|
|
43643
|
+
|
|
43644
|
+
/**
|
|
43645
|
+
* Returns the list of public getters, proxied by the Component Wrapper to the component itself
|
|
43646
|
+
*/
|
|
43647
|
+
getGetters(): any[];
|
|
43648
|
+
/**
|
|
43649
|
+
* Returns the list of public methods, proxied by the Component Wrapper to the component itself
|
|
43650
|
+
*/
|
|
43651
|
+
getMethods(): any[];
|
|
43652
|
+
/**
|
|
43653
|
+
* Retrieves the renderer for the described web component class. Note: this is always the default renderer
|
|
43654
|
+
* and Web Component wrappers should not define their own renderers.
|
|
43655
|
+
*/
|
|
43656
|
+
getRenderer(): void;
|
|
43657
|
+
/**
|
|
43658
|
+
* Returns the tag, used to render the Component Wrapper
|
|
43659
|
+
*/
|
|
43660
|
+
getTag(): string;
|
|
43661
|
+
}
|
|
43662
|
+
}
|
|
43663
|
+
|
|
42932
43664
|
declare module "sap/ui/core/ws/ReadyState" {
|
|
42933
43665
|
/**
|
|
42934
43666
|
* Defines the different ready states for a WebSocket connection.
|
|
@@ -49141,7 +49873,7 @@ declare module "sap/ui/model/Context" {
|
|
|
49141
49873
|
*/
|
|
49142
49874
|
export default class Context extends BaseObject {
|
|
49143
49875
|
/**
|
|
49144
|
-
* Constructor for Context class.
|
|
49876
|
+
* Constructor for Context class. The constructor must only be called by model-internal methods.
|
|
49145
49877
|
*/
|
|
49146
49878
|
constructor(
|
|
49147
49879
|
/**
|
|
@@ -52737,6 +53469,8 @@ declare module "sap/ui/model/odata/ODataListBinding" {
|
|
|
52737
53469
|
|
|
52738
53470
|
import FilterType from "sap/ui/model/FilterType";
|
|
52739
53471
|
|
|
53472
|
+
import Context1 from "sap/ui/model/odata/v2/Context";
|
|
53473
|
+
|
|
52740
53474
|
import Metadata from "sap/ui/base/Metadata";
|
|
52741
53475
|
|
|
52742
53476
|
import Sorter from "sap/ui/model/Sorter";
|
|
@@ -52844,6 +53578,17 @@ declare module "sap/ui/model/odata/ODataListBinding" {
|
|
|
52844
53578
|
*/
|
|
52845
53579
|
bReturnSuccess?: boolean
|
|
52846
53580
|
): this;
|
|
53581
|
+
/**
|
|
53582
|
+
* @since 1.98.0
|
|
53583
|
+
*
|
|
53584
|
+
* Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
|
|
53585
|
+
* this method does not request any data from a back end and does not change the binding's state. In contrast
|
|
53586
|
+
* to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
|
|
53587
|
+
* control, but all contexts that are currently available in the binding.
|
|
53588
|
+
*
|
|
53589
|
+
* @returns All current contexts of this list binding, in no special order
|
|
53590
|
+
*/
|
|
53591
|
+
getAllCurrentContexts(): Context1[];
|
|
52847
53592
|
/**
|
|
52848
53593
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
52849
53594
|
*
|
|
@@ -64325,6 +65070,11 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
64325
65070
|
|
|
64326
65071
|
import Metadata from "sap/ui/base/Metadata";
|
|
64327
65072
|
|
|
65073
|
+
import {
|
|
65074
|
+
NavigationPropertyPathExpression,
|
|
65075
|
+
PropertyPathExpression,
|
|
65076
|
+
} from "sap/ui/model/odata/v4/ts";
|
|
65077
|
+
|
|
64328
65078
|
/**
|
|
64329
65079
|
* @since 1.39.0
|
|
64330
65080
|
*
|
|
@@ -64429,6 +65179,11 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
64429
65179
|
* `delete`, and to possibly rebind it after reset or failure. The model itself ensures that all bindings
|
|
64430
65180
|
* depending on this context become unresolved, but no attempt is made to restore these bindings in case
|
|
64431
65181
|
* of reset or failure.
|
|
65182
|
+
*
|
|
65183
|
+
* Deleting a child node is supported (@experimental as of version 1.118.0) in a recursive hierarchy (see
|
|
65184
|
+
* {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}). As a precondition, `oAggregation.expandTo`
|
|
65185
|
+
* must be equal to one, and the context must not be {@link #setKeepAlive kept-alive} and hidden (for example
|
|
65186
|
+
* due to a filter).
|
|
64432
65187
|
* See:
|
|
64433
65188
|
* #hasPendingChanges
|
|
64434
65189
|
* #resetChanges
|
|
@@ -64825,8 +65580,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
64825
65580
|
* ID has submit mode {@link sap.ui.model.odata.v4.SubmitMode.Auto} and there are currently running updates
|
|
64826
65581
|
* or creates this method first waits for them to be processed.
|
|
64827
65582
|
*
|
|
64828
|
-
* The
|
|
64829
|
-
* attached to...
|
|
65583
|
+
* The 'dataRequested' and 'dataReceived' events are not fired unless a binding is refreshed completely.
|
|
65584
|
+
* Whatever should happen in the event handler attached to...
|
|
64830
65585
|
* 'dataRequested', can instead be done before calling {@link #requestSideEffects}. 'dataReceived',
|
|
64831
65586
|
* can instead be done once the `oPromise` returned by {@link #requestSideEffects} fulfills or rejects (using
|
|
64832
65587
|
* `oPromise.then(function () {...}, function () {...})`).
|
|
@@ -64865,7 +65620,9 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
64865
65620
|
* if it has not yet been requested by that list binding. This way, exactly the messages for a single row
|
|
64866
65621
|
* can be updated. Same for a "*" segment or an empty navigation property path.
|
|
64867
65622
|
*/
|
|
64868
|
-
aPathExpressions:
|
|
65623
|
+
aPathExpressions: Array<
|
|
65624
|
+
NavigationPropertyPathExpression | PropertyPathExpression | string
|
|
65625
|
+
>,
|
|
64869
65626
|
/**
|
|
64870
65627
|
* The group ID to be used (since 1.69.0); if not specified, the update group ID for the context's binding
|
|
64871
65628
|
* is used, see {@link #getUpdateGroupId}. If a different group ID is specified, make sure that {@link #requestSideEffects }
|
|
@@ -64912,10 +65669,13 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
64912
65669
|
*/
|
|
64913
65670
|
bKeepAlive: boolean,
|
|
64914
65671
|
/**
|
|
64915
|
-
* Callback function that is executed once for a kept-alive context
|
|
64916
|
-
*
|
|
65672
|
+
* Callback function that is executed once for a kept-alive context without any argument just before the
|
|
65673
|
+
* context is destroyed; see {@link #destroy}. If a context has been replaced in a list binding (see {@link #replaceWith }
|
|
65674
|
+
* and {@link sap.ui.odata.v4.ODataContextBinding#execute}), the callback will later also be called just
|
|
65675
|
+
* before the replacing context is destroyed, but with that context as the only argument. Supported since
|
|
65676
|
+
* 1.84.0
|
|
64917
65677
|
*/
|
|
64918
|
-
fnOnBeforeDestroy?:
|
|
65678
|
+
fnOnBeforeDestroy?: (p1: Context | undefined) => void,
|
|
64919
65679
|
/**
|
|
64920
65680
|
* Whether to request messages for this entity. Only used if `bKeepAlive` is `true`. Determines the messages
|
|
64921
65681
|
* property from the annotation "com.sap.vocabularies.Common.v1.Messages" at the entity type. If found,
|
|
@@ -65015,6 +65775,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
65015
65775
|
declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
65016
65776
|
import ContextBinding from "sap/ui/model/ContextBinding";
|
|
65017
65777
|
|
|
65778
|
+
import Message from "sap/ui/core/message/Message";
|
|
65779
|
+
|
|
65018
65780
|
import Context from "sap/ui/model/odata/v4/Context";
|
|
65019
65781
|
|
|
65020
65782
|
import Metadata from "sap/ui/base/Metadata";
|
|
@@ -65268,7 +66030,7 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
65268
66030
|
* the bound action should either be repeated **without** applying the preference or rejected with an `Error`
|
|
65269
66031
|
* instance `oError` where `oError.canceled === true`. Since 1.92.0.
|
|
65270
66032
|
*/
|
|
65271
|
-
fnOnStrictHandlingFailed?:
|
|
66033
|
+
fnOnStrictHandlingFailed?: (p1: Message[]) => Promise<boolean>,
|
|
65272
66034
|
/**
|
|
65273
66035
|
* Whether this operation binding's parent context, which must belong to a list binding, is replaced with
|
|
65274
66036
|
* the operation's return value context (see below) and that list context is returned instead. That list
|
|
@@ -65812,12 +66574,10 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
65812
66574
|
* `created` promises of all nested contexts are always rejected with an instance of `Error`, even if the
|
|
65813
66575
|
* deep create succeeds. This error always has the property `canceled` with the value `true`.
|
|
65814
66576
|
*
|
|
65815
|
-
* Since 1.
|
|
66577
|
+
* Since 1.118.0 deep create also supports single-valued navigation properties; no API call is required
|
|
65816
66578
|
* in this case. Simply bind properties of the related entity relative to a transient context. An update
|
|
65817
66579
|
* to the property adds it to the POST request of the parent entity, and by this the create becomes deep.
|
|
65818
66580
|
*
|
|
65819
|
-
* **Note**: Deep create for single-valued navigation properties is **experimental**.
|
|
65820
|
-
*
|
|
65821
66581
|
* Deep create requires the `autoExpandSelect` parameter at the {@link sap.ui.model.odata.v4.ODataModel#constructor model}.
|
|
65822
66582
|
* The refresh after a deep create is optimized. Only the (navigation) properties missing from the POST
|
|
65823
66583
|
* response are actually requested. If the POST response contains all required properties, no request is
|
|
@@ -65843,7 +66603,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
65843
66603
|
/**
|
|
65844
66604
|
* The initial data for the created entity
|
|
65845
66605
|
*/
|
|
65846
|
-
oInitialData?:
|
|
66606
|
+
oInitialData?: Record<string, any>,
|
|
65847
66607
|
/**
|
|
65848
66608
|
* Whether an automatic refresh of the created entity will be skipped.
|
|
65849
66609
|
* **Note:** Do not use this parameter for a deep create. It leads to multiple single row requests if the
|
|
@@ -65887,7 +66647,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
65887
66647
|
/**
|
|
65888
66648
|
* The function to call when the event occurs
|
|
65889
66649
|
*/
|
|
65890
|
-
fnFunction:
|
|
66650
|
+
fnFunction: (evt: ODataListBinding$CreateActivateEvent) => void,
|
|
65891
66651
|
/**
|
|
65892
66652
|
* Object on which to call the given function
|
|
65893
66653
|
*/
|
|
@@ -66220,7 +66980,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
66220
66980
|
* Whether system query options should be returned as well. The parameter value `true` is not supported.
|
|
66221
66981
|
*/
|
|
66222
66982
|
bWithSystemQueryOptions?: boolean
|
|
66223
|
-
):
|
|
66983
|
+
): Record<string, any>;
|
|
66224
66984
|
/**
|
|
66225
66985
|
* @since 1.53.0
|
|
66226
66986
|
*
|
|
@@ -66672,7 +67432,20 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
66672
67432
|
*/
|
|
66673
67433
|
as?: string;
|
|
66674
67434
|
}>
|
|
66675
|
-
):
|
|
67435
|
+
):
|
|
67436
|
+
| {
|
|
67437
|
+
measureRangePromise: Promise<
|
|
67438
|
+
Record<
|
|
67439
|
+
string,
|
|
67440
|
+
{
|
|
67441
|
+
min: number;
|
|
67442
|
+
|
|
67443
|
+
max: number;
|
|
67444
|
+
}
|
|
67445
|
+
>
|
|
67446
|
+
>;
|
|
67447
|
+
}
|
|
67448
|
+
| undefined;
|
|
66676
67449
|
}
|
|
66677
67450
|
|
|
66678
67451
|
export interface ODataListBinding$ChangeEventParameters
|
|
@@ -66690,7 +67463,12 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
66690
67463
|
ODataListBinding
|
|
66691
67464
|
>;
|
|
66692
67465
|
|
|
66693
|
-
export interface ODataListBinding$CreateActivateEventParameters {
|
|
67466
|
+
export interface ODataListBinding$CreateActivateEventParameters {
|
|
67467
|
+
/**
|
|
67468
|
+
* The affected context
|
|
67469
|
+
*/
|
|
67470
|
+
context?: Context;
|
|
67471
|
+
}
|
|
66694
67472
|
|
|
66695
67473
|
export type ODataListBinding$CreateActivateEvent = Event<
|
|
66696
67474
|
ODataListBinding$CreateActivateEventParameters,
|
|
@@ -68185,7 +68963,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
68185
68963
|
/**
|
|
68186
68964
|
* Map of HTTP header names to their values
|
|
68187
68965
|
*/
|
|
68188
|
-
mHeaders?:
|
|
68966
|
+
mHeaders?: Record<string, string | undefined>
|
|
68189
68967
|
): void;
|
|
68190
68968
|
/**
|
|
68191
68969
|
* @since 1.37.0
|
|
@@ -68362,7 +69140,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
68362
69140
|
* Whether to include the "SAP-ContextId" header (@since 1.86.0)
|
|
68363
69141
|
*/
|
|
68364
69142
|
bIncludeContextId?: boolean
|
|
68365
|
-
):
|
|
69143
|
+
): Record<string, string>;
|
|
68366
69144
|
/**
|
|
68367
69145
|
* @since 1.99.0
|
|
68368
69146
|
*
|
|
@@ -69242,6 +70020,49 @@ declare module "sap/ui/model/odata/v4/SubmitMode" {
|
|
|
69242
70020
|
export default SubmitMode;
|
|
69243
70021
|
}
|
|
69244
70022
|
|
|
70023
|
+
declare module "sap/ui/model/odata/v4/ts" {
|
|
70024
|
+
/**
|
|
70025
|
+
* @since 1.118.0
|
|
70026
|
+
*
|
|
70027
|
+
* Namespace for TypeScript type definitions of the OData V4 model.
|
|
70028
|
+
*/
|
|
70029
|
+
interface ts {}
|
|
70030
|
+
const ts: ts;
|
|
70031
|
+
export default ts;
|
|
70032
|
+
|
|
70033
|
+
/**
|
|
70034
|
+
* @since 1.118.0
|
|
70035
|
+
*
|
|
70036
|
+
* An object representing a "14.5.11 Expression edm:NavigationPropertyPath". Its shape corresponds exactly
|
|
70037
|
+
* to the shape of such an expression in the {@link https://ui5.sap.com/#/topic/87aac894a40640f89920d7b2a414499b OData V4 Metadata JSON Format }
|
|
70038
|
+
* as returned by {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject}.
|
|
70039
|
+
* See:
|
|
70040
|
+
* {@link sap.ui.model.odata.v4.Context#requestSideEffects}
|
|
70041
|
+
*/
|
|
70042
|
+
export type NavigationPropertyPathExpression = {
|
|
70043
|
+
/**
|
|
70044
|
+
* A value of type `Edm.NavigationPropertyPath`.
|
|
70045
|
+
*/
|
|
70046
|
+
$NavigationPropertyPath: string;
|
|
70047
|
+
};
|
|
70048
|
+
|
|
70049
|
+
/**
|
|
70050
|
+
* @since 1.118.0
|
|
70051
|
+
*
|
|
70052
|
+
* An object representing a "14.5.13 Expression edm:PropertyPath". Its shape corresponds exactly to the
|
|
70053
|
+
* shape of such an expression in the {@link https://ui5.sap.com/#/topic/87aac894a40640f89920d7b2a414499b OData V4 Metadata JSON Format }
|
|
70054
|
+
* as returned by {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject}.
|
|
70055
|
+
* See:
|
|
70056
|
+
* {@link sap.ui.model.odata.v4.Context#requestSideEffects}
|
|
70057
|
+
*/
|
|
70058
|
+
export type PropertyPathExpression = {
|
|
70059
|
+
/**
|
|
70060
|
+
* A value of type `Edm.PropertyPath`.
|
|
70061
|
+
*/
|
|
70062
|
+
$PropertyPath: string;
|
|
70063
|
+
};
|
|
70064
|
+
}
|
|
70065
|
+
|
|
69245
70066
|
declare module "sap/ui/model/odata/v4/ValueListType" {
|
|
69246
70067
|
/**
|
|
69247
70068
|
* @since 1.45.0
|
|
@@ -71279,8 +72100,8 @@ declare module "sap/ui/model/type/DateInterval" {
|
|
|
71279
72100
|
/**
|
|
71280
72101
|
* Parses the given value to an array of two values representing the start date and the end date of the
|
|
71281
72102
|
* interval, where the time part of the start date is 0 and the time part of end date is the end of day
|
|
71282
|
-
* (23:59:59
|
|
71283
|
-
*
|
|
72103
|
+
* (23:59:59). If the `singleIntervalValue` format option is used, the second entry is `null` if no end
|
|
72104
|
+
* date is given.
|
|
71284
72105
|
*
|
|
71285
72106
|
* @returns The start and the end date of the interval. The resulting values in the array are:
|
|
71286
72107
|
* - Two `Date` or `module:sap/ui/core/date/UI5Date` objects, or
|
|
@@ -78520,7 +79341,7 @@ declare namespace sap {
|
|
|
78520
79341
|
*/
|
|
78521
79342
|
manifestFirst?: boolean;
|
|
78522
79343
|
/**
|
|
78523
|
-
* If set to `true` validation of the component is handled by the `
|
|
79344
|
+
* If set to `true` validation of the component is handled by the `Messaging`
|
|
78524
79345
|
*/
|
|
78525
79346
|
handleValidation?: string;
|
|
78526
79347
|
}
|
|
@@ -79624,6 +80445,9 @@ declare namespace sap {
|
|
|
79624
80445
|
| import("sap/ui/core/Control").default
|
|
79625
80446
|
| Array<import("sap/ui/core/Control").default>;
|
|
79626
80447
|
/**
|
|
80448
|
+
* @deprecated (since 1.118) - Please require 'sap/ui/core/Core' instead and use the module export directly
|
|
80449
|
+
* without using 'new'."
|
|
80450
|
+
*
|
|
79627
80451
|
* Retrieve the {@link sap.ui.core.Core SAPUI5 Core} instance for the current window.
|
|
79628
80452
|
*
|
|
79629
80453
|
* @returns the API of the current SAPUI5 Core instance.
|
|
@@ -81461,6 +82285,10 @@ declare namespace sap {
|
|
|
81461
82285
|
|
|
81462
82286
|
"sap/ui/core/message/MessageProcessor": undefined;
|
|
81463
82287
|
|
|
82288
|
+
"sap/ui/core/message/MessageType": undefined;
|
|
82289
|
+
|
|
82290
|
+
"sap/ui/core/Messaging": undefined;
|
|
82291
|
+
|
|
81464
82292
|
"sap/ui/core/mvc/Controller": undefined;
|
|
81465
82293
|
|
|
81466
82294
|
"sap/ui/core/mvc/ControllerExtension": undefined;
|
|
@@ -81609,6 +82437,10 @@ declare namespace sap {
|
|
|
81609
82437
|
|
|
81610
82438
|
"sap/ui/core/VariantLayoutData": undefined;
|
|
81611
82439
|
|
|
82440
|
+
"sap/ui/core/webc/WebComponent": undefined;
|
|
82441
|
+
|
|
82442
|
+
"sap/ui/core/webc/WebComponentMetadata": undefined;
|
|
82443
|
+
|
|
81612
82444
|
"sap/ui/core/ws/ReadyState": undefined;
|
|
81613
82445
|
|
|
81614
82446
|
"sap/ui/core/ws/SapPcpWebSocket": undefined;
|
|
@@ -81863,6 +82695,8 @@ declare namespace sap {
|
|
|
81863
82695
|
|
|
81864
82696
|
"sap/ui/model/odata/v4/SubmitMode": undefined;
|
|
81865
82697
|
|
|
82698
|
+
"sap/ui/model/odata/v4/ts": undefined;
|
|
82699
|
+
|
|
81866
82700
|
"sap/ui/model/odata/v4/ValueListType": undefined;
|
|
81867
82701
|
|
|
81868
82702
|
"sap/ui/model/ParseException": undefined;
|