@openui5/types 1.117.1 → 1.119.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 +536 -4
- package/types/sap.m.d.ts +696 -169
- package/types/sap.tnt.d.ts +17 -15
- 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 +1406 -228
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +1 -4
- package/types/sap.ui.integration.d.ts +78 -3
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +1586 -533
- 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 +1183 -128
- 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 +85 -85
- package/types/sap.ui.webc.main.d.ts +225 -225
- 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.119.0
|
|
284
284
|
|
|
285
285
|
declare module "sap/base/assert" {
|
|
286
286
|
/**
|
|
@@ -2207,6 +2207,7 @@ declare module "sap/base/util/uid" {
|
|
|
2207
2207
|
declare module "sap/base/util/UriParameters" {
|
|
2208
2208
|
/**
|
|
2209
2209
|
* @since 1.68
|
|
2210
|
+
* @deprecated (since 1.119) - See class description for details.
|
|
2210
2211
|
*
|
|
2211
2212
|
* Provides access to the individual parameters of a URL query string.
|
|
2212
2213
|
*
|
|
@@ -2215,29 +2216,38 @@ declare module "sap/base/util/UriParameters" {
|
|
|
2215
2216
|
* for a parameter and to {@link #getAll get a list of all values (`getAll()`)} for a parameter. Another
|
|
2216
2217
|
* method allows to {@link #keys iterate over all parameter names (`keys()`)}.
|
|
2217
2218
|
*
|
|
2218
|
-
* The signature and behavior of those methods is aligned with the corresponding methods of the upcoming
|
|
2219
|
-
* Web API `URLSearchParams`.
|
|
2220
|
-
*
|
|
2221
2219
|
* Decoding:
|
|
2222
2220
|
*
|
|
2223
2221
|
* The constructor and the factory methods expect percentage encoded input whereas all other APIs expect
|
|
2224
2222
|
* and return decoded strings. After parsing the query string, any plus sign (0x2b) in names or values is
|
|
2225
2223
|
* replaced by a blank (0x20) and the resulting strings are percentage decoded (`decodeURIComponent`).
|
|
2226
2224
|
*
|
|
2227
|
-
*
|
|
2228
|
-
*
|
|
2229
|
-
*
|
|
2230
|
-
*
|
|
2231
|
-
*
|
|
2232
|
-
*
|
|
2233
|
-
*
|
|
2234
|
-
*
|
|
2235
|
-
*
|
|
2236
|
-
*
|
|
2237
|
-
*
|
|
2238
|
-
*
|
|
2239
|
-
*
|
|
2240
|
-
*
|
|
2225
|
+
* Deprecation:
|
|
2226
|
+
*
|
|
2227
|
+
* This class is deprecated in favor of the URL web standard classes `URLSearchParams` / `URL`.
|
|
2228
|
+
*
|
|
2229
|
+
* `UriParameters.fromQuery(input)` can be migrated to `new URLSearchParams(input)`
|
|
2230
|
+
*
|
|
2231
|
+
* `UriParameters.fromURL(input)` can be migrated to `new URL(input).searchParams`
|
|
2232
|
+
*
|
|
2233
|
+
* Caveats:
|
|
2234
|
+
*
|
|
2235
|
+
* The API has already been designed to be a drop-in replacement but there are some important caveats to
|
|
2236
|
+
* consider when switching to the standard APIs `URLSearchParams` / `URL`:
|
|
2237
|
+
* - `new URL(input).searchParams` validates the given URL according to the WHATWG URL Standard ({@link https://url.spec.whatwg.org}).
|
|
2238
|
+
* `UriParameters.fromURL(input)` only extracts the query string from the given input but does not perform
|
|
2239
|
+
* any validation.
|
|
2240
|
+
* - In some edge cases, especially for incomplete/invalid encoding, decoding behaves differently. Decoding
|
|
2241
|
+
* in `UriParameters` is described in the section above. For details about the encoding/decoding of `URLSearchParams`,
|
|
2242
|
+
* see the WHATWG URL Standard ({@link https://url.spec.whatwg.org}).
|
|
2243
|
+
* - The `get` method's second parameter, `bAll`, is not available; use the `getAll` method instead.
|
|
2244
|
+
* - The `keys` method's return value contains an entry for every occurrence of the key within the query,
|
|
2245
|
+
* in the defined order and including duplicates. `UriParameters#keys()` yields unique key values, even
|
|
2246
|
+
* when there are multiple values for the same key.
|
|
2247
|
+
* - The internal `mParams` property is not available anymore (you should never access internal properties
|
|
2248
|
+
* of UI5 classes or objects). With the predecessor of this API, access to `mParams` was often used to check
|
|
2249
|
+
* whether a parameter is defined at all. Using the `has` method or checking the result of `get` against
|
|
2250
|
+
* `null` serves the same purpose.
|
|
2241
2251
|
*/
|
|
2242
2252
|
export default class UriParameters {
|
|
2243
2253
|
/**
|
|
@@ -3261,6 +3271,24 @@ declare module "sap/ui/core/date/UI5Date" {
|
|
|
3261
3271
|
}
|
|
3262
3272
|
}
|
|
3263
3273
|
|
|
3274
|
+
declare module "sap/ui/core/getCompatibilityVersion" {
|
|
3275
|
+
import Version from "sap/base/util/Version";
|
|
3276
|
+
|
|
3277
|
+
/**
|
|
3278
|
+
* @deprecated (since 1.119.0)
|
|
3279
|
+
*
|
|
3280
|
+
* Returns the used compatibility version for the given feature.
|
|
3281
|
+
*
|
|
3282
|
+
* @returns the used compatibility version
|
|
3283
|
+
*/
|
|
3284
|
+
export default function getCompatibilityVersion(
|
|
3285
|
+
/**
|
|
3286
|
+
* the key of desired feature
|
|
3287
|
+
*/
|
|
3288
|
+
sFeature: string
|
|
3289
|
+
): Version;
|
|
3290
|
+
}
|
|
3291
|
+
|
|
3264
3292
|
declare module "sap/ui/core/InvisibleRenderer" {
|
|
3265
3293
|
import Control from "sap/ui/core/Control";
|
|
3266
3294
|
|
|
@@ -3332,6 +3360,187 @@ declare module "sap/ui/core/InvisibleRenderer" {
|
|
|
3332
3360
|
export default InvisibleRenderer;
|
|
3333
3361
|
}
|
|
3334
3362
|
|
|
3363
|
+
declare module "sap/ui/core/message/MessageType" {
|
|
3364
|
+
/**
|
|
3365
|
+
* @since 1.118
|
|
3366
|
+
*
|
|
3367
|
+
* Specifies possible message types.
|
|
3368
|
+
*/
|
|
3369
|
+
enum MessageType {
|
|
3370
|
+
/**
|
|
3371
|
+
* Message is an error
|
|
3372
|
+
*/
|
|
3373
|
+
Error = "Error",
|
|
3374
|
+
/**
|
|
3375
|
+
* Message should be just an information
|
|
3376
|
+
*/
|
|
3377
|
+
Information = "Information",
|
|
3378
|
+
/**
|
|
3379
|
+
* Message has no specific level
|
|
3380
|
+
*/
|
|
3381
|
+
None = "None",
|
|
3382
|
+
/**
|
|
3383
|
+
* Message is a success message
|
|
3384
|
+
*/
|
|
3385
|
+
Success = "Success",
|
|
3386
|
+
/**
|
|
3387
|
+
* Message is a warning
|
|
3388
|
+
*/
|
|
3389
|
+
Warning = "Warning",
|
|
3390
|
+
}
|
|
3391
|
+
export default MessageType;
|
|
3392
|
+
}
|
|
3393
|
+
|
|
3394
|
+
declare module "sap/ui/core/Messaging" {
|
|
3395
|
+
import Message from "sap/ui/core/message/Message";
|
|
3396
|
+
|
|
3397
|
+
import MessageModel from "sap/ui/model/message/MessageModel";
|
|
3398
|
+
|
|
3399
|
+
import MessageProcessor from "sap/ui/core/message/MessageProcessor";
|
|
3400
|
+
|
|
3401
|
+
import ManagedObject from "sap/ui/base/ManagedObject";
|
|
3402
|
+
|
|
3403
|
+
/**
|
|
3404
|
+
* @since 1.118.0
|
|
3405
|
+
*
|
|
3406
|
+
* Messaging provides a central place for managing `sap.ui.core.message.Messages`.
|
|
3407
|
+
*/
|
|
3408
|
+
interface Messaging {
|
|
3409
|
+
/**
|
|
3410
|
+
* Add messages to Messaging
|
|
3411
|
+
*/
|
|
3412
|
+
addMessages(
|
|
3413
|
+
/**
|
|
3414
|
+
* Array of sap.ui.core.message.Message or single sap.ui.core.message.Message
|
|
3415
|
+
*/
|
|
3416
|
+
vMessages: Message | Message[]
|
|
3417
|
+
): void;
|
|
3418
|
+
/**
|
|
3419
|
+
* Get the MessageModel
|
|
3420
|
+
*
|
|
3421
|
+
* @returns oMessageModel The Message Model
|
|
3422
|
+
*/
|
|
3423
|
+
getMessageModel(): MessageModel;
|
|
3424
|
+
/**
|
|
3425
|
+
* Register MessageProcessor
|
|
3426
|
+
*/
|
|
3427
|
+
registerMessageProcessor(
|
|
3428
|
+
/**
|
|
3429
|
+
* The MessageProcessor
|
|
3430
|
+
*/
|
|
3431
|
+
oProcessor: MessageProcessor
|
|
3432
|
+
): void;
|
|
3433
|
+
/**
|
|
3434
|
+
* When using the databinding type system, the validation/parsing of a new property value could fail. In
|
|
3435
|
+
* this case, a validationError/parseError event is fired. These events bubble up to the core. For registered
|
|
3436
|
+
* ManagedObjects, the Messaging attaches to these events and creates a `sap.ui.core.message.Message` (bHandleValidation=true)
|
|
3437
|
+
* for each of these errors and cancels the event bubbling.
|
|
3438
|
+
*/
|
|
3439
|
+
registerObject(
|
|
3440
|
+
/**
|
|
3441
|
+
* The sap.ui.base.ManagedObject
|
|
3442
|
+
*/
|
|
3443
|
+
oObject: ManagedObject,
|
|
3444
|
+
/**
|
|
3445
|
+
* Handle validationError/parseError events for this object. If set to true, the Messaging creates a Message
|
|
3446
|
+
* for each validation/parse error. The event bubbling is canceled in every case.
|
|
3447
|
+
*/
|
|
3448
|
+
bHandleValidation: boolean
|
|
3449
|
+
): void;
|
|
3450
|
+
/**
|
|
3451
|
+
* Remove all messages
|
|
3452
|
+
*/
|
|
3453
|
+
removeAllMessages(): void;
|
|
3454
|
+
/**
|
|
3455
|
+
* Remove given Messages
|
|
3456
|
+
*/
|
|
3457
|
+
removeMessages(
|
|
3458
|
+
/**
|
|
3459
|
+
* The message(s) to be removed.
|
|
3460
|
+
*/
|
|
3461
|
+
vMessages: Message | Message[]
|
|
3462
|
+
): void;
|
|
3463
|
+
/**
|
|
3464
|
+
* Deregister MessageProcessor
|
|
3465
|
+
*/
|
|
3466
|
+
unregisterMessageProcessor(
|
|
3467
|
+
/**
|
|
3468
|
+
* The MessageProcessor
|
|
3469
|
+
*/
|
|
3470
|
+
oProcessor: MessageProcessor
|
|
3471
|
+
): void;
|
|
3472
|
+
/**
|
|
3473
|
+
* Unregister ManagedObject
|
|
3474
|
+
*/
|
|
3475
|
+
unregisterObject(
|
|
3476
|
+
/**
|
|
3477
|
+
* The sap.ui.base.ManagedObject
|
|
3478
|
+
*/
|
|
3479
|
+
oObject: ManagedObject
|
|
3480
|
+
): void;
|
|
3481
|
+
/**
|
|
3482
|
+
* Update Messages by providing two arrays of old and new messages.
|
|
3483
|
+
*
|
|
3484
|
+
* The old ones will be removed, the new ones will be added.
|
|
3485
|
+
*/
|
|
3486
|
+
updateMessages(
|
|
3487
|
+
/**
|
|
3488
|
+
* Array of old messages to be removed
|
|
3489
|
+
*/
|
|
3490
|
+
aOldMessages: Message[],
|
|
3491
|
+
/**
|
|
3492
|
+
* Array of new messages to be added
|
|
3493
|
+
*/
|
|
3494
|
+
aNewMessages: Message[]
|
|
3495
|
+
): void;
|
|
3496
|
+
}
|
|
3497
|
+
const Messaging: Messaging;
|
|
3498
|
+
export default Messaging;
|
|
3499
|
+
}
|
|
3500
|
+
|
|
3501
|
+
declare module "sap/ui/core/StaticArea" {
|
|
3502
|
+
import UIArea from "sap/ui/core/UIArea";
|
|
3503
|
+
|
|
3504
|
+
/**
|
|
3505
|
+
* Helper module to access the static area.
|
|
3506
|
+
*
|
|
3507
|
+
* The static area is a hidden DOM element with a unique ID and managed by the framework. It is typically
|
|
3508
|
+
* used for hidden or temporarily hidden elements like InvisibleText, Popup, Shadow, Blocklayer etc.
|
|
3509
|
+
*
|
|
3510
|
+
* All methods throw an `Error` when they are called before the document is ready.
|
|
3511
|
+
*/
|
|
3512
|
+
interface StaticArea {
|
|
3513
|
+
/**
|
|
3514
|
+
* Checks whether the given DOM element is part of the static area.
|
|
3515
|
+
*
|
|
3516
|
+
* @returns Whether the given DOM reference is part of the static UIArea
|
|
3517
|
+
*/
|
|
3518
|
+
contains(
|
|
3519
|
+
/**
|
|
3520
|
+
* The DOM element to check
|
|
3521
|
+
*/
|
|
3522
|
+
oDomRef: Element
|
|
3523
|
+
): boolean;
|
|
3524
|
+
/**
|
|
3525
|
+
* Returns the root element of the static, hidden area.
|
|
3526
|
+
*
|
|
3527
|
+
* It can be used e.g. for hiding elements like Popup, Shadow, Blocklayer etc. If it is not yet available,
|
|
3528
|
+
* a DIV element is created and appended to the body.
|
|
3529
|
+
*
|
|
3530
|
+
* @returns the root DOM element of the static, hidden area
|
|
3531
|
+
*/
|
|
3532
|
+
getDomRef(): Element;
|
|
3533
|
+
/**
|
|
3534
|
+
* Returns the `UIArea` instance for the static area. If none exists yet, one gets created.
|
|
3535
|
+
*
|
|
3536
|
+
* @returns The `UIArea` instance for the static area
|
|
3537
|
+
*/
|
|
3538
|
+
getUIArea(): UIArea;
|
|
3539
|
+
}
|
|
3540
|
+
const StaticArea: StaticArea;
|
|
3541
|
+
export default StaticArea;
|
|
3542
|
+
}
|
|
3543
|
+
|
|
3335
3544
|
declare module "sap/ui/core/syncStyleClass" {
|
|
3336
3545
|
import Control from "sap/ui/core/Control";
|
|
3337
3546
|
|
|
@@ -3361,6 +3570,63 @@ declare module "sap/ui/core/syncStyleClass" {
|
|
|
3361
3570
|
): jQuery | Element;
|
|
3362
3571
|
}
|
|
3363
3572
|
|
|
3573
|
+
declare module "sap/ui/core/Theming" {
|
|
3574
|
+
/**
|
|
3575
|
+
* @since 1.118
|
|
3576
|
+
*
|
|
3577
|
+
* Provides theming related API
|
|
3578
|
+
*/
|
|
3579
|
+
interface Theming {
|
|
3580
|
+
/**
|
|
3581
|
+
* Attaches event handler `fnFunction` to the {@link #event:applied applied} event.
|
|
3582
|
+
*
|
|
3583
|
+
* The given handler is called when the the applied event is fired. If the theme is already applied the
|
|
3584
|
+
* handler will be called immediately. The handler stays attached to the applied event for future theme
|
|
3585
|
+
* changes.
|
|
3586
|
+
*/
|
|
3587
|
+
attachApplied(
|
|
3588
|
+
/**
|
|
3589
|
+
* The function to be called, when the event occurs
|
|
3590
|
+
*/
|
|
3591
|
+
fnFunction: Function
|
|
3592
|
+
): void;
|
|
3593
|
+
/**
|
|
3594
|
+
* Detaches event handler `fnFunction` from the {@link #event:applied applied} event
|
|
3595
|
+
*
|
|
3596
|
+
* The passed function must match the one used for event registration.
|
|
3597
|
+
*/
|
|
3598
|
+
detachApplied(
|
|
3599
|
+
/**
|
|
3600
|
+
* The function to be called, when the event occurs
|
|
3601
|
+
*/
|
|
3602
|
+
fnFunction: Function
|
|
3603
|
+
): void;
|
|
3604
|
+
/**
|
|
3605
|
+
* Returns the theme name
|
|
3606
|
+
*
|
|
3607
|
+
* @returns the theme name
|
|
3608
|
+
*/
|
|
3609
|
+
getTheme(): string;
|
|
3610
|
+
/**
|
|
3611
|
+
* Notify content density changes
|
|
3612
|
+
*/
|
|
3613
|
+
notifyContentDensityChanged(): void;
|
|
3614
|
+
/**
|
|
3615
|
+
* Allows setting the theme name
|
|
3616
|
+
*
|
|
3617
|
+
* @returns `this` to allow method chaining
|
|
3618
|
+
*/
|
|
3619
|
+
setTheme(
|
|
3620
|
+
/**
|
|
3621
|
+
* the theme name
|
|
3622
|
+
*/
|
|
3623
|
+
sTheme: string
|
|
3624
|
+
): this;
|
|
3625
|
+
}
|
|
3626
|
+
const Theming: Theming;
|
|
3627
|
+
export default Theming;
|
|
3628
|
+
}
|
|
3629
|
+
|
|
3364
3630
|
declare module "sap/ui/dom/containsOrEquals" {
|
|
3365
3631
|
/**
|
|
3366
3632
|
* @since 1.58
|
|
@@ -7270,7 +7536,7 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
7270
7536
|
* the same ID as an element or another `ManagedObject`.
|
|
7271
7537
|
*
|
|
7272
7538
|
* For the same reason, there is no general lookup for `ManagedObject`s via their ID. Only for subclasses
|
|
7273
|
-
* that enforce unique IDs, there might be lookup mechanisms (e.g. {@link sap.ui.core.
|
|
7539
|
+
* that enforce unique IDs, there might be lookup mechanisms (e.g. {@link sap.ui.core.Element#getElementById sap.ui.core.Element.getElementById }
|
|
7274
7540
|
* for elements).
|
|
7275
7541
|
*
|
|
7276
7542
|
* @returns The objects's ID.
|
|
@@ -8164,7 +8430,9 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
8164
8430
|
*/
|
|
8165
8431
|
groupHeaderFactory?: (p1: { key: string }) => ManagedObject;
|
|
8166
8432
|
/**
|
|
8167
|
-
* Map of event handler functions keyed by the name of the binding events that they should be attached to
|
|
8433
|
+
* Map of event handler functions keyed by the name of the binding events that they should be attached to.
|
|
8434
|
+
* The names and value ranges of the supported events depend on the model implementation and should be documented
|
|
8435
|
+
* with the model-specific subclass of `sap.ui.model.ListBinding`.
|
|
8168
8436
|
*/
|
|
8169
8437
|
events?: Record<string, Function>;
|
|
8170
8438
|
};
|
|
@@ -8347,7 +8615,9 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
8347
8615
|
*/
|
|
8348
8616
|
parameters?: object;
|
|
8349
8617
|
/**
|
|
8350
|
-
* Map of event handler functions keyed by the name of the binding events that they are attached to
|
|
8618
|
+
* Map of event handler functions keyed by the name of the binding events that they are attached to. The
|
|
8619
|
+
* names and value ranges of the supported events depend on the model implementation and should be documented
|
|
8620
|
+
* with the model-specific subclass of `sap.ui.model.ContextBinding`.
|
|
8351
8621
|
*/
|
|
8352
8622
|
events?: Record<string, Function>;
|
|
8353
8623
|
};
|
|
@@ -9045,6 +9315,14 @@ declare module "sap/ui/base/ManagedObjectMetadata" {
|
|
|
9045
9315
|
*/
|
|
9046
9316
|
oAggregatedObject: ManagedObject
|
|
9047
9317
|
): void;
|
|
9318
|
+
/**
|
|
9319
|
+
* @since 1.119.0
|
|
9320
|
+
*
|
|
9321
|
+
* Get the prefix used for the generated IDs from configuration
|
|
9322
|
+
*
|
|
9323
|
+
* @returns The prefix for the generated IDs
|
|
9324
|
+
*/
|
|
9325
|
+
static getUIDPrefix(): string;
|
|
9048
9326
|
/**
|
|
9049
9327
|
* Test whether a given ID looks like it was automatically generated.
|
|
9050
9328
|
*
|
|
@@ -11066,9 +11344,7 @@ declare module "sap/ui/core/library" {
|
|
|
11066
11344
|
}
|
|
11067
11345
|
|
|
11068
11346
|
/**
|
|
11069
|
-
*
|
|
11070
|
-
*
|
|
11071
|
-
* Defines the different message types.
|
|
11347
|
+
* Specifies possible message types.
|
|
11072
11348
|
*/
|
|
11073
11349
|
export enum MessageType {
|
|
11074
11350
|
/**
|
|
@@ -12218,7 +12494,7 @@ declare module "sap/ui/core/Component" {
|
|
|
12218
12494
|
*/
|
|
12219
12495
|
altManifestUrl?: string;
|
|
12220
12496
|
/**
|
|
12221
|
-
* If set to `true` validation of the component is handled by the `
|
|
12497
|
+
* If set to `true` validation of the component is handled by the `Messaging`
|
|
12222
12498
|
*/
|
|
12223
12499
|
handleValidation?: string;
|
|
12224
12500
|
/**
|
|
@@ -12729,6 +13005,8 @@ declare module "sap/ui/core/Component" {
|
|
|
12729
13005
|
onDeactivate(): void;
|
|
12730
13006
|
/**
|
|
12731
13007
|
* @since 1.15.1
|
|
13008
|
+
* @deprecated (since 1.119) - recommended to use the browser-native page lifecycle API, providing events
|
|
13009
|
+
* such as 'pageshow' and 'pagehide'
|
|
12732
13010
|
*
|
|
12733
13011
|
* The window before unload hook. Override this method in your Component class implementation, to handle
|
|
12734
13012
|
* cleanup before the real unload or to prompt a question to the user, if the component should be exited.
|
|
@@ -12739,6 +13017,8 @@ declare module "sap/ui/core/Component" {
|
|
|
12739
13017
|
onWindowBeforeUnload(): string | undefined;
|
|
12740
13018
|
/**
|
|
12741
13019
|
* @since 1.15.1
|
|
13020
|
+
* @deprecated (since 1.119) - recommended to use the browser-native API to listen for errors: window.addEventListener("error",
|
|
13021
|
+
* function() { ... })
|
|
12742
13022
|
*
|
|
12743
13023
|
* The window error hook. Override this method in your Component class implementation to listen to unhandled
|
|
12744
13024
|
* errors.
|
|
@@ -12759,6 +13039,9 @@ declare module "sap/ui/core/Component" {
|
|
|
12759
13039
|
): void;
|
|
12760
13040
|
/**
|
|
12761
13041
|
* @since 1.15.1
|
|
13042
|
+
* @deprecated (since 1.119) - Newer browser versions deprecate the browser-native 'unload' event. Therefore,
|
|
13043
|
+
* the former API won't reliably work anymore. Please have a look at the browser-native page lifecycle API,
|
|
13044
|
+
* e.g. its events 'pageshow' and 'pagehide'.
|
|
12762
13045
|
*
|
|
12763
13046
|
* The window unload hook. Override this method in your Component class implementation, to handle cleanup
|
|
12764
13047
|
* of the component once the window will be unloaded (e.g. closed).
|
|
@@ -12784,14 +13067,20 @@ declare module "sap/ui/core/Component" {
|
|
|
12784
13067
|
}
|
|
12785
13068
|
/**
|
|
12786
13069
|
* 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}
|
|
13070
|
+
* its static "extend" method. See {@link sap.ui.core.Component.extend} and {@link sap.ui.core.Component.create }
|
|
13071
|
+
* for additional details on its usage.
|
|
12788
13072
|
*/
|
|
12789
13073
|
export type MetadataOptions = MetadataOptions1 & {
|
|
12790
13074
|
/**
|
|
12791
|
-
*
|
|
13075
|
+
* The manifest option determines how a component manifest should be evaluated. Default is `undefined`.
|
|
13076
|
+
*
|
|
13077
|
+
* When set to `false` or `undefined`, no manifest.json is present for this Component, however the Component
|
|
13078
|
+
* can still be started with a manifest given as an argument of the factory function, see {@link sap.ui.core.Component.create}.
|
|
13079
|
+
* 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}.
|
|
13080
|
+
* When set to the string literal `"json"`, this property indicates that the component configuration should
|
|
12792
13081
|
* be read from a manifest.json file which is assumed to exist next to the Component.js file.
|
|
12793
13082
|
*/
|
|
12794
|
-
manifest?: "json";
|
|
13083
|
+
manifest?: undefined | false | object | "json";
|
|
12795
13084
|
};
|
|
12796
13085
|
|
|
12797
13086
|
/**
|
|
@@ -13231,8 +13520,8 @@ declare module "sap/ui/core/ComponentContainer" {
|
|
|
13231
13520
|
/**
|
|
13232
13521
|
* Gets current value of property {@link #getHandleValidation handleValidation}.
|
|
13233
13522
|
*
|
|
13234
|
-
* Enable/disable validation handling by
|
|
13235
|
-
*
|
|
13523
|
+
* Enable/disable validation handling by Messaging for this component. The resulting Messages will be propagated
|
|
13524
|
+
* to the controls. This property can only be applied initially.
|
|
13236
13525
|
*
|
|
13237
13526
|
* Default value is `false`.
|
|
13238
13527
|
*
|
|
@@ -13391,8 +13680,8 @@ declare module "sap/ui/core/ComponentContainer" {
|
|
|
13391
13680
|
/**
|
|
13392
13681
|
* Sets a new value for property {@link #getHandleValidation handleValidation}.
|
|
13393
13682
|
*
|
|
13394
|
-
* Enable/disable validation handling by
|
|
13395
|
-
*
|
|
13683
|
+
* Enable/disable validation handling by Messaging for this component. The resulting Messages will be propagated
|
|
13684
|
+
* to the controls. This property can only be applied initially.
|
|
13396
13685
|
*
|
|
13397
13686
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
13398
13687
|
*
|
|
@@ -13584,8 +13873,8 @@ declare module "sap/ui/core/ComponentContainer" {
|
|
|
13584
13873
|
async?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
13585
13874
|
|
|
13586
13875
|
/**
|
|
13587
|
-
* Enable/disable validation handling by
|
|
13588
|
-
*
|
|
13876
|
+
* Enable/disable validation handling by Messaging for this component. The resulting Messages will be propagated
|
|
13877
|
+
* to the controls. This property can only be applied initially.
|
|
13589
13878
|
*/
|
|
13590
13879
|
handleValidation?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
13591
13880
|
|
|
@@ -14036,6 +14325,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14036
14325
|
getAccessibility(): boolean;
|
|
14037
14326
|
/**
|
|
14038
14327
|
* @since 1.77.0
|
|
14328
|
+
* @deprecated (since 1.118) - Please use {@link module:sap/base/i18n/Localization.getActiveTerminologies }
|
|
14329
|
+
* instead.
|
|
14039
14330
|
*
|
|
14040
14331
|
* Returns the list of active terminologies defined via the Configuration.
|
|
14041
14332
|
*
|
|
@@ -14103,6 +14394,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14103
14394
|
*/
|
|
14104
14395
|
getCalendarWeekNumbering(): CalendarWeekNumbering;
|
|
14105
14396
|
/**
|
|
14397
|
+
* @deprecated (since 1.119.0)
|
|
14398
|
+
*
|
|
14106
14399
|
* Returns the used compatibility version for the given feature.
|
|
14107
14400
|
*
|
|
14108
14401
|
* @returns the used compatibility version
|
|
@@ -14303,14 +14596,15 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14303
14596
|
*/
|
|
14304
14597
|
getTheme(): string;
|
|
14305
14598
|
/**
|
|
14306
|
-
* @since 1.99.0
|
|
14307
|
-
*
|
|
14308
14599
|
* Retrieves the configured IANA timezone ID.
|
|
14309
14600
|
*
|
|
14310
14601
|
* @returns The configured IANA timezone ID, e.g. "America/New_York"
|
|
14311
14602
|
*/
|
|
14312
14603
|
getTimezone(): string;
|
|
14313
14604
|
/**
|
|
14605
|
+
* @deprecated (since 1.119.0) - Please use {@link sap.ui.base.ManagedObjectMetadata.getUIDPrefix ManagedObjectMetadata.getUIDPrefix }
|
|
14606
|
+
* instead.
|
|
14607
|
+
*
|
|
14314
14608
|
* Prefix to be used for automatically generated control IDs. Default is a double underscore "__".
|
|
14315
14609
|
*
|
|
14316
14610
|
* @returns the prefix to be used
|
|
@@ -15110,6 +15404,24 @@ declare module "sap/ui/core/Control" {
|
|
|
15110
15404
|
*/
|
|
15111
15405
|
FNMetaImpl?: Function
|
|
15112
15406
|
): Function;
|
|
15407
|
+
/**
|
|
15408
|
+
* @since 1.118
|
|
15409
|
+
*
|
|
15410
|
+
* Returns a list of all controls with a field group ID. See {@link sap.ui.core.Control#checkFieldGroupIds Control.prototype.checkFieldGroupIds }
|
|
15411
|
+
* for a description of the `vFieldGroupIds` parameter.
|
|
15412
|
+
*
|
|
15413
|
+
* If possible please use the respective method on a Control instance (see {@link sap.ui.core.Control#getControlsByFieldGroupId}).
|
|
15414
|
+
* The control method only respects aggregated child controls, which is more effective and should be sufficient
|
|
15415
|
+
* for most use-cases.
|
|
15416
|
+
*
|
|
15417
|
+
* @returns The list of controls with matching field group IDs
|
|
15418
|
+
*/
|
|
15419
|
+
static getControlsByFieldGroupId(
|
|
15420
|
+
/**
|
|
15421
|
+
* ID of the field group or an array of field group IDs to match
|
|
15422
|
+
*/
|
|
15423
|
+
vFieldGroupIds?: string | string[]
|
|
15424
|
+
): Control[];
|
|
15113
15425
|
/**
|
|
15114
15426
|
* Returns a metadata object for class sap.ui.core.Control.
|
|
15115
15427
|
*
|
|
@@ -15913,7 +16225,7 @@ declare module "sap/ui/core/Core" {
|
|
|
15913
16225
|
|
|
15914
16226
|
import UI5Element from "sap/ui/core/Element";
|
|
15915
16227
|
|
|
15916
|
-
import Component from "sap/ui/core/Component";
|
|
16228
|
+
import { default as Component, MetadataOptions } from "sap/ui/core/Component";
|
|
15917
16229
|
|
|
15918
16230
|
import RenderManager from "sap/ui/core/RenderManager";
|
|
15919
16231
|
|
|
@@ -15929,7 +16241,7 @@ declare module "sap/ui/core/Core" {
|
|
|
15929
16241
|
|
|
15930
16242
|
import ResourceBundle from "sap/base/i18n/ResourceBundle";
|
|
15931
16243
|
|
|
15932
|
-
import
|
|
16244
|
+
import Messaging from "sap/ui/core/Messaging";
|
|
15933
16245
|
|
|
15934
16246
|
import Metadata from "sap/ui/base/Metadata";
|
|
15935
16247
|
|
|
@@ -15940,77 +16252,70 @@ declare module "sap/ui/core/Core" {
|
|
|
15940
16252
|
/**
|
|
15941
16253
|
* Core Class of the SAP UI Library.
|
|
15942
16254
|
*
|
|
15943
|
-
* This class boots the Core framework and makes it available for the application
|
|
16255
|
+
* This class boots the Core framework and makes it available for the application by requiring `sap.ui.core.Core`.
|
|
15944
16256
|
*
|
|
15945
|
-
*
|
|
15946
|
-
* ```javascript
|
|
15947
|
-
*
|
|
15948
|
-
*
|
|
15949
|
-
* var oCore = sap.ui.getCore();
|
|
15950
|
-
*
|
|
15951
|
-
* ```
|
|
15952
|
-
*
|
|
15953
|
-
*
|
|
15954
|
-
* With methods of the Core framework you can {@link #attachInit execute code} after the framework has been
|
|
15955
|
-
* initialized. It provides access to the {@link #getConfiguration configuration} and exposes events that
|
|
15956
|
-
* an application or a control can register to (e.g. {@link #event:localizationChanged localizationChanged},
|
|
15957
|
-
* {@link #event:parseError parseError}, {@link #event:validationError validationError}, {@link #event:formatError formatError},
|
|
15958
|
-
* {@link #event:validationSuccess validationSuccess}).
|
|
16257
|
+
* The Core provides a {@link #ready ready function} to execute code after the core was booted.
|
|
15959
16258
|
*
|
|
15960
16259
|
* Example:
|
|
15961
16260
|
* ```javascript
|
|
15962
16261
|
*
|
|
15963
16262
|
*
|
|
15964
|
-
* oCore.
|
|
15965
|
-
* if ( oCore.getConfiguration().getRTL() ) {
|
|
16263
|
+
* oCore.ready(function() {
|
|
15966
16264
|
* ...
|
|
15967
|
-
* }
|
|
15968
16265
|
* });
|
|
15969
16266
|
*
|
|
15970
|
-
* oCore.
|
|
15971
|
-
*
|
|
15972
|
-
* });
|
|
16267
|
+
* await oCore.ready();
|
|
16268
|
+
* ...
|
|
15973
16269
|
*
|
|
15974
16270
|
* ```
|
|
15975
16271
|
*/
|
|
15976
16272
|
interface Core {
|
|
15977
16273
|
/**
|
|
15978
|
-
*
|
|
16274
|
+
* @deprecated (since 1.119.0)
|
|
16275
|
+
*
|
|
16276
|
+
* Creates a new subclass of class `sap.ui.core.Core` with name `sClassName` and enriches it with the information
|
|
15979
16277
|
* contained in `oClassInfo`.
|
|
15980
16278
|
*
|
|
15981
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.
|
|
16279
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
|
|
15982
16280
|
*
|
|
15983
|
-
* @returns
|
|
16281
|
+
* @returns The created class / constructor function
|
|
15984
16282
|
*/
|
|
15985
16283
|
extend(
|
|
15986
16284
|
/**
|
|
15987
|
-
*
|
|
16285
|
+
* Qualified name of the newly created class
|
|
15988
16286
|
*/
|
|
15989
16287
|
sClassName: string,
|
|
15990
16288
|
/**
|
|
15991
16289
|
* Object literal with information about the class
|
|
15992
16290
|
*/
|
|
15993
|
-
oClassInfo?:
|
|
15994
|
-
|
|
15995
|
-
|
|
15996
|
-
|
|
15997
|
-
|
|
15998
|
-
|
|
16291
|
+
oClassInfo?: {
|
|
16292
|
+
/**
|
|
16293
|
+
* The metadata object describing the class. See {@link sap.ui.core.Component.MetadataOptions MetadataOptions }
|
|
16294
|
+
* for the values allowed in every extend.
|
|
16295
|
+
*/
|
|
16296
|
+
metadata?: MetadataOptions;
|
|
16297
|
+
}
|
|
15999
16298
|
): Function;
|
|
16000
16299
|
/**
|
|
16001
|
-
*
|
|
16300
|
+
* @deprecated (since 1.119.0)
|
|
16301
|
+
*
|
|
16302
|
+
* Returns the metadata for class `sap.ui.core.Core`.
|
|
16002
16303
|
*
|
|
16003
16304
|
* @returns Metadata object describing this class
|
|
16004
16305
|
*/
|
|
16005
16306
|
getMetadata(): Metadata;
|
|
16006
16307
|
/**
|
|
16308
|
+
* @deprecated (since 1.118)
|
|
16309
|
+
*
|
|
16007
16310
|
* Enforces an immediate update of the visible UI (aka "rendering").
|
|
16008
16311
|
*
|
|
16009
|
-
* In general, applications should avoid calling this method and instead let the framework
|
|
16010
|
-
* rendering.
|
|
16312
|
+
* In general, applications and Controls should avoid calling this method and instead let the framework
|
|
16313
|
+
* manage any necessary rendering.
|
|
16011
16314
|
*/
|
|
16012
16315
|
applyChanges(): void;
|
|
16013
16316
|
/**
|
|
16317
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.setTheme Theming.setTheme} instead.
|
|
16318
|
+
*
|
|
16014
16319
|
* Applies the theme with the given name (by loading the respective style sheets, which does not disrupt
|
|
16015
16320
|
* the application).
|
|
16016
16321
|
*
|
|
@@ -16039,6 +16344,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16039
16344
|
sThemeBaseUrl?: string
|
|
16040
16345
|
): void;
|
|
16041
16346
|
/**
|
|
16347
|
+
* @deprecated (since 1.119)
|
|
16348
|
+
*
|
|
16042
16349
|
* Registers a listener for control events.
|
|
16043
16350
|
*
|
|
16044
16351
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16055,6 +16362,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16055
16362
|
oListener?: object
|
|
16056
16363
|
): void;
|
|
16057
16364
|
/**
|
|
16365
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachFormatError ManagedObject#attachFormatError }
|
|
16366
|
+
* instead.
|
|
16367
|
+
*
|
|
16058
16368
|
* Attaches event handler `fnFunction` to the {@link #event:formatError formatError} event of `sap.ui.core.Core`.
|
|
16059
16369
|
*
|
|
16060
16370
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16079,6 +16389,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16079
16389
|
oListener?: object
|
|
16080
16390
|
): this;
|
|
16081
16391
|
/**
|
|
16392
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachFormatError ManagedObject#attachFormatError }
|
|
16393
|
+
* instead.
|
|
16394
|
+
*
|
|
16082
16395
|
* Attaches event handler `fnFunction` to the {@link #event:formatError formatError} event of `sap.ui.core.Core`.
|
|
16083
16396
|
*
|
|
16084
16397
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16100,6 +16413,7 @@ declare module "sap/ui/core/Core" {
|
|
|
16100
16413
|
): this;
|
|
16101
16414
|
/**
|
|
16102
16415
|
* @since 1.13.2
|
|
16416
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.core.Core.ready Core.ready} instead.
|
|
16103
16417
|
*
|
|
16104
16418
|
* Registers a given function that is executed after the framework has been initialized.
|
|
16105
16419
|
*
|
|
@@ -16151,6 +16465,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16151
16465
|
oListener?: object
|
|
16152
16466
|
): void;
|
|
16153
16467
|
/**
|
|
16468
|
+
* @deprecated (since 1.118) - Please use {@link sap.base.i18n.Localization#attachChange Localization#attachChange }
|
|
16469
|
+
* instead.
|
|
16470
|
+
*
|
|
16154
16471
|
* Register a listener for the {@link #event:localizationChanged localizationChanged} event.
|
|
16155
16472
|
*
|
|
16156
16473
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16167,6 +16484,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16167
16484
|
oListener?: object
|
|
16168
16485
|
): void;
|
|
16169
16486
|
/**
|
|
16487
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachParseError ManagedObject#attachParseError }
|
|
16488
|
+
* instead.
|
|
16489
|
+
*
|
|
16170
16490
|
* Attaches event handler `fnFunction` to the {@link #event:parseError parseError} event of `sap.ui.core.Core`.
|
|
16171
16491
|
*
|
|
16172
16492
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16192,6 +16512,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16192
16512
|
oListener?: object
|
|
16193
16513
|
): this;
|
|
16194
16514
|
/**
|
|
16515
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachParseError ManagedObject#attachParseError }
|
|
16516
|
+
* instead.
|
|
16517
|
+
*
|
|
16195
16518
|
* Attaches event handler `fnFunction` to the {@link #event:parseError parseError} event of `sap.ui.core.Core`.
|
|
16196
16519
|
*
|
|
16197
16520
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16212,6 +16535,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16212
16535
|
oListener?: object
|
|
16213
16536
|
): this;
|
|
16214
16537
|
/**
|
|
16538
|
+
* @deprecated (since 1.118) - See {@link sap.ui.core.Theming#attachApplied Theming#attachApplied} instead.
|
|
16539
|
+
*
|
|
16215
16540
|
* Attaches event handler `fnFunction` to the {@link #event:ThemeChanged ThemeChanged} event of this `sap.ui.core.Core`.
|
|
16216
16541
|
*
|
|
16217
16542
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
@@ -16228,6 +16553,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16228
16553
|
oListener?: object
|
|
16229
16554
|
): void;
|
|
16230
16555
|
/**
|
|
16556
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachValidationError ManagedObject#attachValidationError }
|
|
16557
|
+
* instead.
|
|
16558
|
+
*
|
|
16231
16559
|
* Attaches event handler `fnFunction` to the {@link #event:validationError validationError} event of `sap.ui.core.Core`.
|
|
16232
16560
|
*
|
|
16233
16561
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16253,6 +16581,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16253
16581
|
oListener?: object
|
|
16254
16582
|
): this;
|
|
16255
16583
|
/**
|
|
16584
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachValidationError ManagedObject#attachValidationError }
|
|
16585
|
+
* instead.
|
|
16586
|
+
*
|
|
16256
16587
|
* Attaches event handler `fnFunction` to the {@link #event:validationError validationError} event of `sap.ui.core.Core`.
|
|
16257
16588
|
*
|
|
16258
16589
|
* When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
|
|
@@ -16273,6 +16604,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16273
16604
|
oListener?: object
|
|
16274
16605
|
): this;
|
|
16275
16606
|
/**
|
|
16607
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachValidationSuccess ManagedObject#attachValidationSuccess }
|
|
16608
|
+
* instead.
|
|
16609
|
+
*
|
|
16276
16610
|
* Attaches event handler `fnFunction` to the {@link #event:validationSuccess validationSuccess} event of
|
|
16277
16611
|
* `sap.ui.core.Core`.
|
|
16278
16612
|
*
|
|
@@ -16298,6 +16632,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16298
16632
|
oListener?: object
|
|
16299
16633
|
): this;
|
|
16300
16634
|
/**
|
|
16635
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#attachValidationSuccess ManagedObject#attachValidationSuccess }
|
|
16636
|
+
* instead.
|
|
16637
|
+
*
|
|
16301
16638
|
* Attaches event handler `fnFunction` to the {@link #event:validationSuccess validationSuccess} event of
|
|
16302
16639
|
* `sap.ui.core.Core`.
|
|
16303
16640
|
*
|
|
@@ -16319,6 +16656,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16319
16656
|
oListener?: object
|
|
16320
16657
|
): this;
|
|
16321
16658
|
/**
|
|
16659
|
+
* @deprecated (since 1.118) - use {@link sap.ui.core.Control#getControlsByFieldGroup Control.prototype.getControlsByFieldGroup }
|
|
16660
|
+
* instead.
|
|
16661
|
+
*
|
|
16322
16662
|
* Returns a list of all controls with a field group ID. See {@link sap.ui.core.Control#checkFieldGroupIds Control.prototype.checkFieldGroupIds }
|
|
16323
16663
|
* for a description of the `vFieldGroupIds` parameter.
|
|
16324
16664
|
*
|
|
@@ -16331,6 +16671,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16331
16671
|
vFieldGroupIds?: string | string[]
|
|
16332
16672
|
): Control[];
|
|
16333
16673
|
/**
|
|
16674
|
+
* @deprecated (since 1.119) - Please use {@link sap.ui.core.Element.getElementById Element.getElementById }
|
|
16675
|
+
* instead.
|
|
16676
|
+
*
|
|
16334
16677
|
* Returns the registered element with the given ID, if any.
|
|
16335
16678
|
*
|
|
16336
16679
|
* The ID must be the globally unique ID of an element, the same as returned by `oElement.getId()`.
|
|
@@ -16409,6 +16752,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16409
16752
|
mSettings?: object
|
|
16410
16753
|
): Component | Promise<Component>;
|
|
16411
16754
|
/**
|
|
16755
|
+
* @deprecated (since 1.119)
|
|
16756
|
+
*
|
|
16412
16757
|
* Returns a new instance of the RenderManager for exclusive use by the caller.
|
|
16413
16758
|
*
|
|
16414
16759
|
* The caller must take care to destroy the render manager when it is no longer needed. Calling this method
|
|
@@ -16431,6 +16776,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16431
16776
|
oDomRef: string | Element
|
|
16432
16777
|
): UIArea;
|
|
16433
16778
|
/**
|
|
16779
|
+
* @deprecated (since 1.119)
|
|
16780
|
+
*
|
|
16434
16781
|
* Unregisters a listener for control events.
|
|
16435
16782
|
*
|
|
16436
16783
|
* The passed function and listener object must match the ones used for event registration.
|
|
@@ -16446,6 +16793,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16446
16793
|
oListener?: object
|
|
16447
16794
|
): void;
|
|
16448
16795
|
/**
|
|
16796
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#detachFormatError ManagedObject#detachFormatError }
|
|
16797
|
+
* instead.
|
|
16798
|
+
*
|
|
16449
16799
|
* Detaches event handler `fnFunction` from the {@link #event:formatError formatError} event of `sap.ui.core.Core`.
|
|
16450
16800
|
*
|
|
16451
16801
|
* The passed function and listener object must match the ones used for event registration.
|
|
@@ -16483,6 +16833,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16483
16833
|
oListener?: object
|
|
16484
16834
|
): void;
|
|
16485
16835
|
/**
|
|
16836
|
+
* @deprecated (since 1.118) - Please use {@link sap.base.i18n.Localization#detachChange Localization#detachChange }
|
|
16837
|
+
* instead.
|
|
16838
|
+
*
|
|
16486
16839
|
* Unregister a listener from the {@link #event:localizationChanged localizationChanged} event.
|
|
16487
16840
|
*
|
|
16488
16841
|
* The listener will only be unregistered if the same function/context combination is given as in the call
|
|
@@ -16499,6 +16852,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16499
16852
|
oListener?: object
|
|
16500
16853
|
): void;
|
|
16501
16854
|
/**
|
|
16855
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#detachParseError ManagedObject#detachParseError }
|
|
16856
|
+
* instead.
|
|
16857
|
+
*
|
|
16502
16858
|
* Detaches event handler `fnFunction` from the {@link #event:parseError parseError} event of `sap.ui.core.Core`.
|
|
16503
16859
|
*
|
|
16504
16860
|
* The passed function and listener object must match the ones used for event registration.
|
|
@@ -16516,6 +16872,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16516
16872
|
oListener?: object
|
|
16517
16873
|
): this;
|
|
16518
16874
|
/**
|
|
16875
|
+
* @deprecated (since 1.118) - See {@link sap.ui.core.Theming#detachApplied Theming#detachApplied} instead.
|
|
16876
|
+
*
|
|
16519
16877
|
* Detaches event handler `fnFunction` from the {@link #event:ThemeChanged ThemeChanged} event of this `sap.ui.core.Core`.
|
|
16520
16878
|
*
|
|
16521
16879
|
* The passed function and listener object must match the ones used for event registration.
|
|
@@ -16531,6 +16889,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16531
16889
|
oListener?: object
|
|
16532
16890
|
): void;
|
|
16533
16891
|
/**
|
|
16892
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#detachValidationError ManagedObject#detachValidationError }
|
|
16893
|
+
* instead.
|
|
16894
|
+
*
|
|
16534
16895
|
* Detaches event handler `fnFunction` from the {@link #event:validationError validationError} event of
|
|
16535
16896
|
* `sap.ui.core.Core`.
|
|
16536
16897
|
*
|
|
@@ -16549,6 +16910,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16549
16910
|
oListener?: object
|
|
16550
16911
|
): this;
|
|
16551
16912
|
/**
|
|
16913
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#detachValidationSuccess ManagedObject#detachValidationSuccess }
|
|
16914
|
+
* instead.
|
|
16915
|
+
*
|
|
16552
16916
|
* Detaches event handler `fnFunction` from the {@link #event:validationSuccess validationSuccess} event
|
|
16553
16917
|
* of `sap.ui.core.Core`.
|
|
16554
16918
|
*
|
|
@@ -16567,6 +16931,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16567
16931
|
oListener?: object
|
|
16568
16932
|
): this;
|
|
16569
16933
|
/**
|
|
16934
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#fireFormatError ManagedObject#fireFormatError }
|
|
16935
|
+
* instead.
|
|
16570
16936
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
16571
16937
|
*
|
|
16572
16938
|
* Fires event {@link #event:formatError formatError} to attached listeners.
|
|
@@ -16605,6 +16971,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16605
16971
|
}
|
|
16606
16972
|
): this;
|
|
16607
16973
|
/**
|
|
16974
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#fireParseError ManagedObject#fireParseError }
|
|
16975
|
+
* instead.
|
|
16608
16976
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
16609
16977
|
*
|
|
16610
16978
|
* Fires event {@link #event:parseError parseError} to attached listeners.
|
|
@@ -16643,6 +17011,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16643
17011
|
}
|
|
16644
17012
|
): this;
|
|
16645
17013
|
/**
|
|
17014
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#fireValidationError ManagedObject.fireValidationError }
|
|
17015
|
+
* instead.
|
|
16646
17016
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
16647
17017
|
*
|
|
16648
17018
|
* Fires event {@link #event:validationError validationError} to attached listeners.
|
|
@@ -16681,6 +17051,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16681
17051
|
}
|
|
16682
17052
|
): this;
|
|
16683
17053
|
/**
|
|
17054
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#fireValidationSuccess ManagedObject#fireValidationSuccess }
|
|
17055
|
+
* instead.
|
|
16684
17056
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
16685
17057
|
*
|
|
16686
17058
|
* Fires event {@link #event:validationSuccess validationSuccess} to attached listeners.
|
|
@@ -16736,6 +17108,10 @@ declare module "sap/ui/core/Core" {
|
|
|
16736
17108
|
sId: ID | null | undefined
|
|
16737
17109
|
): UI5Element | undefined;
|
|
16738
17110
|
/**
|
|
17111
|
+
* @deprecated (since 1.119) - Please use {@link sap.ui.core.Element.getActiveElement Element.getActiveElement }
|
|
17112
|
+
* to get the currently focused element. You can then retrieve the ID of that element with {@link sap.ui.core.Element#getId Element#getId}.
|
|
17113
|
+
* Please be aware, {@link sap.ui.core.Element.getActiveElement Element.getActiveElement} can return 'undefined'.
|
|
17114
|
+
*
|
|
16739
17115
|
* Returns the Id of the control/element currently in focus.
|
|
16740
17116
|
*
|
|
16741
17117
|
* @returns the Id of the control/element currently in focus.
|
|
@@ -16756,6 +17132,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16756
17132
|
): UI5Element | undefined;
|
|
16757
17133
|
/**
|
|
16758
17134
|
* @since 1.8.0
|
|
17135
|
+
* @deprecated (since 1.119.0) - Please use {@link sap.ui.core.EventBus.getInstance EventBus.getInstance }
|
|
17136
|
+
* for global usage instead. Creating an own local instance is the preferred usage.
|
|
16759
17137
|
*
|
|
16760
17138
|
* Returns the event bus.
|
|
16761
17139
|
*
|
|
@@ -16763,6 +17141,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16763
17141
|
*/
|
|
16764
17142
|
getEventBus(): EventBus;
|
|
16765
17143
|
/**
|
|
17144
|
+
* @deprecated (since 1.119) - Please use {@link sap.ui.core.Lib.getResourceBundleFor Lib.getResourceBundleFor }
|
|
17145
|
+
* instead.
|
|
17146
|
+
*
|
|
16766
17147
|
* Retrieves a resource bundle for the given library and locale.
|
|
16767
17148
|
*
|
|
16768
17149
|
* If only one argument is given, it is assumed to be the libraryName. The locale then falls back to the
|
|
@@ -16810,6 +17191,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16810
17191
|
bAsync?: boolean
|
|
16811
17192
|
): ResourceBundle | undefined | Promise<ResourceBundle | undefined>;
|
|
16812
17193
|
/**
|
|
17194
|
+
* @deprecated (since 1.119) - Please use {@link sap.ui.core.Lib.getResourceBundleFor Lib.getResourceBundleFor }
|
|
17195
|
+
* instead.
|
|
17196
|
+
*
|
|
16813
17197
|
* Retrieves a resource bundle for the given library and locale.
|
|
16814
17198
|
*
|
|
16815
17199
|
* If only one argument is given, it is assumed to be the libraryName. The locale then falls back to the
|
|
@@ -16853,6 +17237,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16853
17237
|
bAsync?: boolean
|
|
16854
17238
|
): ResourceBundle | undefined | Promise<ResourceBundle | undefined>;
|
|
16855
17239
|
/**
|
|
17240
|
+
* @deprecated (since 1.119)
|
|
17241
|
+
*
|
|
16856
17242
|
* Returns a map of library info objects for all currently loaded libraries, keyed by their names.
|
|
16857
17243
|
*
|
|
16858
17244
|
* The structure of the library info objects matches the structure of the info object that the {@link #initLibrary }
|
|
@@ -16868,11 +17254,15 @@ declare module "sap/ui/core/Core" {
|
|
|
16868
17254
|
getLoadedLibraries(): Record<string, Object>;
|
|
16869
17255
|
/**
|
|
16870
17256
|
* @since 1.33.0
|
|
17257
|
+
* @deprecated (since 1.118) - Please use {@link module:sap/ui/core/Messaging Messaging} instead.
|
|
16871
17258
|
*
|
|
16872
|
-
* Returns the
|
|
17259
|
+
* Returns the `Messaging` module.
|
|
16873
17260
|
*/
|
|
16874
|
-
getMessageManager():
|
|
17261
|
+
getMessageManager(): Messaging;
|
|
16875
17262
|
/**
|
|
17263
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#getModel ManagedObject#getModel }
|
|
17264
|
+
* instead.
|
|
17265
|
+
*
|
|
16876
17266
|
* Get the model with the given model name.
|
|
16877
17267
|
*
|
|
16878
17268
|
* The name can be omitted to reference the default model or it must be a non-empty string.
|
|
@@ -16905,6 +17295,9 @@ declare module "sap/ui/core/Core" {
|
|
|
16905
17295
|
*/
|
|
16906
17296
|
getRootComponent(): Component;
|
|
16907
17297
|
/**
|
|
17298
|
+
* @deprecated (since 1.119.0) - Please use {@link module:sap/ui/core/StaticArea.getDomRef StaticArea.getDomRef }
|
|
17299
|
+
* instead.
|
|
17300
|
+
*
|
|
16908
17301
|
* Returns the static, hidden area DOM element belonging to this core instance.
|
|
16909
17302
|
*
|
|
16910
17303
|
* It can be used e.g. for hiding elements like Popups, Shadow, Blocklayer etc.
|
|
@@ -16924,8 +17317,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16924
17317
|
*/
|
|
16925
17318
|
getTemplate(sId: string): Component;
|
|
16926
17319
|
/**
|
|
16927
|
-
* @deprecated (since 1.107) - use {@link sap
|
|
16928
|
-
*
|
|
17320
|
+
* @deprecated (since 1.107) - For access to the static UIArea, please use the {@link module:sap/ui/core/StaticArea StaticArea }
|
|
17321
|
+
* instead.
|
|
16929
17322
|
*
|
|
16930
17323
|
* Returns the {@link sap.ui.core.UIArea UIArea} with the given ID or that belongs to the given DOM element.
|
|
16931
17324
|
*
|
|
@@ -16938,6 +17331,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16938
17331
|
o: string | Element
|
|
16939
17332
|
): UIArea | null | undefined;
|
|
16940
17333
|
/**
|
|
17334
|
+
* @deprecated (since 1.118)
|
|
17335
|
+
*
|
|
16941
17336
|
* Returns `true` if there are any pending rendering tasks or when such rendering tasks are currently being
|
|
16942
17337
|
* executed.
|
|
16943
17338
|
*
|
|
@@ -16945,12 +17340,17 @@ declare module "sap/ui/core/Core" {
|
|
|
16945
17340
|
*/
|
|
16946
17341
|
getUIDirty(): boolean;
|
|
16947
17342
|
/**
|
|
17343
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#hasModel ManagedObject#hasModel }
|
|
17344
|
+
* instead.
|
|
17345
|
+
*
|
|
16948
17346
|
* Check if a Model is set to the core
|
|
16949
17347
|
*
|
|
16950
17348
|
* @returns true or false
|
|
16951
17349
|
*/
|
|
16952
17350
|
hasModel(): boolean;
|
|
16953
17351
|
/**
|
|
17352
|
+
* @deprecated (since 1.119)
|
|
17353
|
+
*
|
|
16954
17354
|
* Includes a library theme into the current page (if a variant is specified it will include the variant
|
|
16955
17355
|
* library theme)
|
|
16956
17356
|
*/
|
|
@@ -16969,6 +17369,8 @@ declare module "sap/ui/core/Core" {
|
|
|
16969
17369
|
sQuery?: string
|
|
16970
17370
|
): void;
|
|
16971
17371
|
/**
|
|
17372
|
+
* @deprecated (since 1.119) - Please use {@link sap.ui.core.Lib.init Lib.init} instead.
|
|
17373
|
+
*
|
|
16972
17374
|
* Provides the framework with information about a library.
|
|
16973
17375
|
*
|
|
16974
17376
|
* This method is intended to be called exactly once while the main module of a library (its `library.js`
|
|
@@ -17036,6 +17438,8 @@ declare module "sap/ui/core/Core" {
|
|
|
17036
17438
|
oLibInfo: LibraryInfo
|
|
17037
17439
|
): object | undefined;
|
|
17038
17440
|
/**
|
|
17441
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.core.Core.ready Core.ready} instead.
|
|
17442
|
+
*
|
|
17039
17443
|
* Returns true if the Core has already been initialized. This means that instances of RenderManager etc.
|
|
17040
17444
|
* do already exist and the init event has already been fired (and will not be fired again).
|
|
17041
17445
|
*
|
|
@@ -17043,18 +17447,24 @@ declare module "sap/ui/core/Core" {
|
|
|
17043
17447
|
*/
|
|
17044
17448
|
isInitialized(): boolean;
|
|
17045
17449
|
/**
|
|
17450
|
+
* @deprecated (since 1.118)
|
|
17451
|
+
*
|
|
17046
17452
|
* Returns the locked state of the `sap.ui.core.Core`
|
|
17047
17453
|
*
|
|
17048
17454
|
* @returns locked state
|
|
17049
17455
|
*/
|
|
17050
17456
|
isLocked(): boolean;
|
|
17051
17457
|
/**
|
|
17458
|
+
* @deprecated (since 1.118) - use {@link sap.ui.Device.browser.mobile Device.browser.mobile} instead.
|
|
17459
|
+
*
|
|
17052
17460
|
* Check if the script is running on mobile
|
|
17053
17461
|
*
|
|
17054
17462
|
* @returns true or false
|
|
17055
17463
|
*/
|
|
17056
17464
|
isMobile(): boolean;
|
|
17057
17465
|
/**
|
|
17466
|
+
* @deprecated (since 1.119.0) - Please use {@link module:sap/ui/core/StaticArea.contains StaticArea.contains }
|
|
17467
|
+
* instead.
|
|
17058
17468
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
17059
17469
|
*
|
|
17060
17470
|
* Checks whether the given DOM element is the root of the static area.
|
|
@@ -17068,6 +17478,9 @@ declare module "sap/ui/core/Core" {
|
|
|
17068
17478
|
oDomRef: Element
|
|
17069
17479
|
): boolean;
|
|
17070
17480
|
/**
|
|
17481
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.attachApplied Theming.attachApplied }
|
|
17482
|
+
* instead.
|
|
17483
|
+
*
|
|
17071
17484
|
* Returns true, if the styles of the current theme are already applied, false otherwise.
|
|
17072
17485
|
*
|
|
17073
17486
|
* This function must not be used before the init event of the Core. If the styles are not yet applied a
|
|
@@ -17077,6 +17490,8 @@ declare module "sap/ui/core/Core" {
|
|
|
17077
17490
|
*/
|
|
17078
17491
|
isThemeApplied(): boolean;
|
|
17079
17492
|
/**
|
|
17493
|
+
* @deprecated (since 1.119) - Please use {@link sap.ui.core.Lib.load Lib.load} instead.
|
|
17494
|
+
*
|
|
17080
17495
|
* Loads the given library and its dependencies and makes its content available to the application.
|
|
17081
17496
|
*
|
|
17082
17497
|
* What it does:
|
|
@@ -17168,6 +17583,8 @@ declare module "sap/ui/core/Core" {
|
|
|
17168
17583
|
}
|
|
17169
17584
|
): LibraryInfo | Promise<LibraryInfo>;
|
|
17170
17585
|
/**
|
|
17586
|
+
* @deprecated (since 1.118)
|
|
17587
|
+
*
|
|
17171
17588
|
* Locks the Core. No browser events are dispatched to the controls.
|
|
17172
17589
|
*
|
|
17173
17590
|
* Lock should be called before and after the DOM is modified for rendering, roundtrips... Exceptions might
|
|
@@ -17175,6 +17592,9 @@ declare module "sap/ui/core/Core" {
|
|
|
17175
17592
|
*/
|
|
17176
17593
|
lock(): void;
|
|
17177
17594
|
/**
|
|
17595
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.notifyContentDensityChanged Theming.notifyContentDensityChanged }
|
|
17596
|
+
* instead.
|
|
17597
|
+
*
|
|
17178
17598
|
* Triggers a realignment of controls
|
|
17179
17599
|
*
|
|
17180
17600
|
* This method should be called after changing the cozy/compact CSS class of a DOM element at runtime, for
|
|
@@ -17185,6 +17605,19 @@ declare module "sap/ui/core/Core" {
|
|
|
17185
17605
|
* DOM, for example changing the cozy/compact CSS class at a single control
|
|
17186
17606
|
*/
|
|
17187
17607
|
notifyContentDensityChanged(): void;
|
|
17608
|
+
/**
|
|
17609
|
+
* @since 1.118.0
|
|
17610
|
+
*
|
|
17611
|
+
* Returns a Promise that resolves if the Core is initialized.
|
|
17612
|
+
*
|
|
17613
|
+
* @returns The ready promise
|
|
17614
|
+
*/
|
|
17615
|
+
ready(
|
|
17616
|
+
/**
|
|
17617
|
+
* If the Core is ready the function will be called immediately, otherwise when the ready Promise resolves.
|
|
17618
|
+
*/
|
|
17619
|
+
fnReady?: () => void
|
|
17620
|
+
): Promise<undefined>;
|
|
17188
17621
|
/**
|
|
17189
17622
|
* @deprecated (since 1.73) - Plugins never have been meant as a public offering, but were intended for
|
|
17190
17623
|
* internal usage only. They unfortunately allow access to all internals of the Core and therefore break
|
|
@@ -17207,6 +17640,9 @@ declare module "sap/ui/core/Core" {
|
|
|
17207
17640
|
oPlugin: object
|
|
17208
17641
|
): void;
|
|
17209
17642
|
/**
|
|
17643
|
+
* @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#setModel ManagedObject#setModel }
|
|
17644
|
+
* instead.
|
|
17645
|
+
*
|
|
17210
17646
|
* Sets or unsets a model for the given model name.
|
|
17211
17647
|
*
|
|
17212
17648
|
* The `sName` must either be `undefined` (or omitted) or a non-empty string. When the name is omitted,
|
|
@@ -17250,6 +17686,7 @@ declare module "sap/ui/core/Core" {
|
|
|
17250
17686
|
): void;
|
|
17251
17687
|
/**
|
|
17252
17688
|
* @since 1.10
|
|
17689
|
+
* @deprecated (since 1.119)
|
|
17253
17690
|
*
|
|
17254
17691
|
* Defines the root directory from below which UI5 should load the theme with the given name. Optionally
|
|
17255
17692
|
* allows restricting the setting to parts of a theme covering specific control libraries.
|
|
@@ -17319,6 +17756,7 @@ declare module "sap/ui/core/Core" {
|
|
|
17319
17756
|
): this;
|
|
17320
17757
|
/**
|
|
17321
17758
|
* @since 1.10
|
|
17759
|
+
* @deprecated (since 1.119)
|
|
17322
17760
|
*
|
|
17323
17761
|
* Defines the root directory from below which UI5 should load the theme with the given name. Optionally
|
|
17324
17762
|
* allows restricting the setting to parts of a theme covering specific control libraries.
|
|
@@ -17383,6 +17821,8 @@ declare module "sap/ui/core/Core" {
|
|
|
17383
17821
|
bForceUpdate?: boolean
|
|
17384
17822
|
): this;
|
|
17385
17823
|
/**
|
|
17824
|
+
* @deprecated (since 1.118)
|
|
17825
|
+
*
|
|
17386
17826
|
* Unlocks the Core.
|
|
17387
17827
|
*
|
|
17388
17828
|
* Browser events are dispatched to the controls again after this method is called.
|
|
@@ -18859,7 +19299,7 @@ declare module "sap/ui/core/dnd/DragDropInfo" {
|
|
|
18859
19299
|
/**
|
|
18860
19300
|
* The underlying browser event
|
|
18861
19301
|
*/
|
|
18862
|
-
browserEvent?:
|
|
19302
|
+
browserEvent?: DragEvent;
|
|
18863
19303
|
}
|
|
18864
19304
|
|
|
18865
19305
|
export type DragDropInfo$DragStartEvent = Event<
|
|
@@ -18964,7 +19404,7 @@ declare module "sap/ui/core/dnd/DragInfo" {
|
|
|
18964
19404
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
18965
19405
|
* otherwise it will be bound to this `sap.ui.core.dnd.DragInfo` itself.
|
|
18966
19406
|
*
|
|
18967
|
-
* This event is fired when a drag operation is
|
|
19407
|
+
* This event is fired when a drag operation is ended.
|
|
18968
19408
|
*
|
|
18969
19409
|
* @returns Reference to `this` in order to allow method chaining
|
|
18970
19410
|
*/
|
|
@@ -18991,7 +19431,7 @@ declare module "sap/ui/core/dnd/DragInfo" {
|
|
|
18991
19431
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
18992
19432
|
* otherwise it will be bound to this `sap.ui.core.dnd.DragInfo` itself.
|
|
18993
19433
|
*
|
|
18994
|
-
* This event is fired when a drag operation is
|
|
19434
|
+
* This event is fired when a drag operation is ended.
|
|
18995
19435
|
*
|
|
18996
19436
|
* @returns Reference to `this` in order to allow method chaining
|
|
18997
19437
|
*/
|
|
@@ -19158,7 +19598,7 @@ declare module "sap/ui/core/dnd/DragInfo" {
|
|
|
19158
19598
|
/**
|
|
19159
19599
|
* @since 1.56
|
|
19160
19600
|
*
|
|
19161
|
-
* This event is fired when a drag operation is
|
|
19601
|
+
* This event is fired when a drag operation is ended.
|
|
19162
19602
|
*/
|
|
19163
19603
|
dragEnd?: (oEvent: DragInfo$DragEndEvent) => void;
|
|
19164
19604
|
}
|
|
@@ -19177,7 +19617,7 @@ declare module "sap/ui/core/dnd/DragInfo" {
|
|
|
19177
19617
|
/**
|
|
19178
19618
|
* The underlying browser event
|
|
19179
19619
|
*/
|
|
19180
|
-
browserEvent?:
|
|
19620
|
+
browserEvent?: DragEvent;
|
|
19181
19621
|
}
|
|
19182
19622
|
|
|
19183
19623
|
export type DragInfo$DragEndEvent = Event<
|
|
@@ -19199,7 +19639,7 @@ declare module "sap/ui/core/dnd/DragInfo" {
|
|
|
19199
19639
|
/**
|
|
19200
19640
|
* The underlying browser event
|
|
19201
19641
|
*/
|
|
19202
|
-
browserEvent?:
|
|
19642
|
+
browserEvent?: DragEvent;
|
|
19203
19643
|
}
|
|
19204
19644
|
|
|
19205
19645
|
export type DragInfo$DragStartEvent = Event<
|
|
@@ -19853,7 +20293,7 @@ declare module "sap/ui/core/dnd/DropInfo" {
|
|
|
19853
20293
|
/**
|
|
19854
20294
|
* The underlying browser event
|
|
19855
20295
|
*/
|
|
19856
|
-
browserEvent?:
|
|
20296
|
+
browserEvent?: DragEvent;
|
|
19857
20297
|
}
|
|
19858
20298
|
|
|
19859
20299
|
export type DropInfo$DragEnterEvent = Event<
|
|
@@ -19873,7 +20313,7 @@ declare module "sap/ui/core/dnd/DropInfo" {
|
|
|
19873
20313
|
dragSession?: DragSession;
|
|
19874
20314
|
|
|
19875
20315
|
/**
|
|
19876
|
-
* The calculated position of the drop action relative to the `target
|
|
20316
|
+
* The calculated position of the drop action relative to the `target`
|
|
19877
20317
|
*/
|
|
19878
20318
|
dropPosition?:
|
|
19879
20319
|
| dnd.RelativeDropPosition
|
|
@@ -19882,7 +20322,7 @@ declare module "sap/ui/core/dnd/DropInfo" {
|
|
|
19882
20322
|
/**
|
|
19883
20323
|
* The underlying browser event
|
|
19884
20324
|
*/
|
|
19885
|
-
browserEvent?:
|
|
20325
|
+
browserEvent?: DragEvent;
|
|
19886
20326
|
}
|
|
19887
20327
|
|
|
19888
20328
|
export type DropInfo$DragOverEvent = Event<
|
|
@@ -19907,7 +20347,7 @@ declare module "sap/ui/core/dnd/DropInfo" {
|
|
|
19907
20347
|
droppedControl?: UI5Element;
|
|
19908
20348
|
|
|
19909
20349
|
/**
|
|
19910
|
-
* The calculated position of the drop action relative to the `droppedControl
|
|
20350
|
+
* The calculated position of the drop action relative to the `droppedControl`
|
|
19911
20351
|
*/
|
|
19912
20352
|
dropPosition?:
|
|
19913
20353
|
| dnd.RelativeDropPosition
|
|
@@ -19916,7 +20356,7 @@ declare module "sap/ui/core/dnd/DropInfo" {
|
|
|
19916
20356
|
/**
|
|
19917
20357
|
* The underlying browser event
|
|
19918
20358
|
*/
|
|
19919
|
-
browserEvent?:
|
|
20359
|
+
browserEvent?: DragEvent;
|
|
19920
20360
|
}
|
|
19921
20361
|
|
|
19922
20362
|
export type DropInfo$DropEvent = Event<
|
|
@@ -19943,12 +20383,12 @@ declare module "sap/ui/core/Element" {
|
|
|
19943
20383
|
|
|
19944
20384
|
import ContextBinding from "sap/ui/model/ContextBinding";
|
|
19945
20385
|
|
|
20386
|
+
import { ID } from "sap/ui/core/library";
|
|
20387
|
+
|
|
19946
20388
|
import LayoutData from "sap/ui/core/LayoutData";
|
|
19947
20389
|
|
|
19948
20390
|
import TooltipBase from "sap/ui/core/TooltipBase";
|
|
19949
20391
|
|
|
19950
|
-
import { ID } from "sap/ui/core/library";
|
|
19951
|
-
|
|
19952
20392
|
/**
|
|
19953
20393
|
* Base Class for UI Elements.
|
|
19954
20394
|
*
|
|
@@ -20127,7 +20567,7 @@ declare module "sap/ui/core/Element" {
|
|
|
20127
20567
|
* to `data-sap-ui`
|
|
20128
20568
|
*/
|
|
20129
20569
|
bIncludeRelated?: boolean
|
|
20130
|
-
): UI5Element;
|
|
20570
|
+
): UI5Element | undefined;
|
|
20131
20571
|
/**
|
|
20132
20572
|
* @deprecated (since 1.3.1) - Use the static `extend` method of the desired base class (e.g. {@link sap.ui.core.Element.extend})
|
|
20133
20573
|
*
|
|
@@ -20194,6 +20634,28 @@ declare module "sap/ui/core/Element" {
|
|
|
20194
20634
|
*/
|
|
20195
20635
|
FNMetaImpl?: Function
|
|
20196
20636
|
): Function;
|
|
20637
|
+
/**
|
|
20638
|
+
* @since 1.119
|
|
20639
|
+
*
|
|
20640
|
+
* Returns the element currently in focus.
|
|
20641
|
+
*
|
|
20642
|
+
* @returns The currently focused element
|
|
20643
|
+
*/
|
|
20644
|
+
static getActiveElement(): UI5Element | undefined;
|
|
20645
|
+
/**
|
|
20646
|
+
* Retrieves an Element by its ID.
|
|
20647
|
+
*
|
|
20648
|
+
* When the ID is `null` or `undefined` or when there's no element with the given ID, then `undefined` is
|
|
20649
|
+
* returned.
|
|
20650
|
+
*
|
|
20651
|
+
* @returns Element with the given ID or `undefined`
|
|
20652
|
+
*/
|
|
20653
|
+
static getElementById(
|
|
20654
|
+
/**
|
|
20655
|
+
* ID of the element to retrieve
|
|
20656
|
+
*/
|
|
20657
|
+
id: ID
|
|
20658
|
+
): UI5Element | undefined;
|
|
20197
20659
|
/**
|
|
20198
20660
|
* Returns a metadata object for class sap.ui.core.Element.
|
|
20199
20661
|
*
|
|
@@ -21096,20 +21558,6 @@ declare module "sap/ui/core/Element" {
|
|
|
21096
21558
|
*/
|
|
21097
21559
|
thisArg?: Object
|
|
21098
21560
|
): void;
|
|
21099
|
-
/**
|
|
21100
|
-
* Retrieves an Element by its ID.
|
|
21101
|
-
*
|
|
21102
|
-
* When the ID is `null` or `undefined` or when there's no element with the given ID, then `undefined` is
|
|
21103
|
-
* returned.
|
|
21104
|
-
*
|
|
21105
|
-
* @returns Element with the given ID or `undefined`
|
|
21106
|
-
*/
|
|
21107
|
-
get(
|
|
21108
|
-
/**
|
|
21109
|
-
* ID of the element to retrieve
|
|
21110
|
-
*/
|
|
21111
|
-
id: ID
|
|
21112
|
-
): UI5Element | undefined;
|
|
21113
21561
|
}
|
|
21114
21562
|
export const registry: registry;
|
|
21115
21563
|
|
|
@@ -21277,6 +21725,14 @@ declare module "sap/ui/core/EventBus" {
|
|
|
21277
21725
|
*/
|
|
21278
21726
|
FNMetaImpl?: Function
|
|
21279
21727
|
): Function;
|
|
21728
|
+
/**
|
|
21729
|
+
* @since 1.119.0
|
|
21730
|
+
*
|
|
21731
|
+
* Returns the singleton instance of the EventBus for global usage.
|
|
21732
|
+
*
|
|
21733
|
+
* @returns the event bus
|
|
21734
|
+
*/
|
|
21735
|
+
static getInstance(): EventBus;
|
|
21280
21736
|
/**
|
|
21281
21737
|
* Returns a metadata object for class sap.ui.core.EventBus.
|
|
21282
21738
|
*
|
|
@@ -26139,6 +26595,286 @@ declare module "sap/ui/core/LayoutData" {
|
|
|
26139
26595
|
export interface $LayoutDataSettings extends $ElementSettings {}
|
|
26140
26596
|
}
|
|
26141
26597
|
|
|
26598
|
+
declare module "sap/ui/core/Lib" {
|
|
26599
|
+
import BaseObject from "sap/ui/base/Object";
|
|
26600
|
+
|
|
26601
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
26602
|
+
|
|
26603
|
+
import ResourceBundle from "sap/base/i18n/ResourceBundle";
|
|
26604
|
+
|
|
26605
|
+
/**
|
|
26606
|
+
* @since 1.118
|
|
26607
|
+
*
|
|
26608
|
+
* Constructor must not be used: To load a library, please use the static method {@link #.load}.
|
|
26609
|
+
*
|
|
26610
|
+
* This class also provides other static methods which are related to a library, such as {@link #.getResourceBundleFor }
|
|
26611
|
+
* to retrieve the resource bundle of a library, {@link #.init} to provide information for a library and
|
|
26612
|
+
* so on.
|
|
26613
|
+
*/
|
|
26614
|
+
export default class Lib extends BaseObject {
|
|
26615
|
+
constructor();
|
|
26616
|
+
|
|
26617
|
+
/**
|
|
26618
|
+
* Creates a new subclass of class sap.ui.core.Lib with name `sClassName` and enriches it with the information
|
|
26619
|
+
* contained in `oClassInfo`.
|
|
26620
|
+
*
|
|
26621
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
26622
|
+
*
|
|
26623
|
+
* @returns Created class / constructor function
|
|
26624
|
+
*/
|
|
26625
|
+
static extend<T extends Record<string, unknown>>(
|
|
26626
|
+
/**
|
|
26627
|
+
* Name of the class being created
|
|
26628
|
+
*/
|
|
26629
|
+
sClassName: string,
|
|
26630
|
+
/**
|
|
26631
|
+
* Object literal with information about the class
|
|
26632
|
+
*/
|
|
26633
|
+
oClassInfo?: sap.ClassInfo<T, Lib>,
|
|
26634
|
+
/**
|
|
26635
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
26636
|
+
* used by this class
|
|
26637
|
+
*/
|
|
26638
|
+
FNMetaImpl?: Function
|
|
26639
|
+
): Function;
|
|
26640
|
+
/**
|
|
26641
|
+
* Returns a metadata object for class sap.ui.core.Lib.
|
|
26642
|
+
*
|
|
26643
|
+
* @returns Metadata object describing this class
|
|
26644
|
+
*/
|
|
26645
|
+
static getMetadata(): Metadata;
|
|
26646
|
+
/**
|
|
26647
|
+
* Retrieves a resource bundle for the given library and locale.
|
|
26648
|
+
*
|
|
26649
|
+
* This method returns the resource bundle directly. When the resource bundle for the given locale isn't
|
|
26650
|
+
* loaded yet, synchronous request will be used to load the resource bundle.
|
|
26651
|
+
*
|
|
26652
|
+
* If only one argument is given, it is assumed to be the library name. The locale then falls back to the
|
|
26653
|
+
* current {@link sap.ui.core.Configuration#getLanguage session locale}.
|
|
26654
|
+
*
|
|
26655
|
+
* Configuration via App Descriptor: When the App Descriptor for the library is available without further
|
|
26656
|
+
* request (manifest.json has been preloaded) and when the App Descriptor is at least of version 1.9.0 or
|
|
26657
|
+
* higher, then this method will evaluate the App Descriptor entry `"sap.ui5" / "library" / "i18n"`.
|
|
26658
|
+
*
|
|
26659
|
+
* - When the entry is `true`, a bundle with the default name "messagebundle.properties" will be loaded
|
|
26660
|
+
*
|
|
26661
|
+
* - If it is a string, then that string will be used as name of the bundle
|
|
26662
|
+
* - If it is `false`, no bundle will be loaded and the result will be `undefined`
|
|
26663
|
+
*
|
|
26664
|
+
* Caching: Once a resource bundle for a library has been loaded, it will be cached. Further calls for the
|
|
26665
|
+
* same locale won't create new requests, but return the already loaded bundle. There's therefore no need
|
|
26666
|
+
* for control code to cache the returned bundle for a longer period of time. Not further caching the result
|
|
26667
|
+
* also prevents stale texts after a locale change.
|
|
26668
|
+
*
|
|
26669
|
+
* @returns The best matching resource bundle for the given parameters or `undefined`
|
|
26670
|
+
*/
|
|
26671
|
+
static getResourceBundleFor(
|
|
26672
|
+
/**
|
|
26673
|
+
* Name of the library to retrieve the bundle for
|
|
26674
|
+
*/
|
|
26675
|
+
sLibrary: string,
|
|
26676
|
+
/**
|
|
26677
|
+
* Locale to retrieve the resource bundle for
|
|
26678
|
+
*/
|
|
26679
|
+
sLocale?: string
|
|
26680
|
+
): ResourceBundle | undefined;
|
|
26681
|
+
/**
|
|
26682
|
+
* Provides information about a library.
|
|
26683
|
+
*
|
|
26684
|
+
* This method is intended to be called exactly once while the main module of a library (its `library.js`
|
|
26685
|
+
* module) is executing, typically at its begin. The single parameter `oLibInfo` is an info object that
|
|
26686
|
+
* describes the content of the library.
|
|
26687
|
+
*
|
|
26688
|
+
* When the `mSettings` has been processed, a normalized version will be set on the library instance Finally,
|
|
26689
|
+
* this function fires {@link #event:LibraryChanged} event with operation 'add' for the newly loaded library.
|
|
26690
|
+
*
|
|
26691
|
+
* Side Effects:
|
|
26692
|
+
*
|
|
26693
|
+
* While analyzing the `mSettings`, the framework takes some additional actions:
|
|
26694
|
+
*
|
|
26695
|
+
*
|
|
26696
|
+
* - If the object contains a list of `interfaces`, they will be registered with the {@link sap.ui.base.DataType }
|
|
26697
|
+
* class to make them available as aggregation types in managed objects.
|
|
26698
|
+
*
|
|
26699
|
+
*
|
|
26700
|
+
* - If the object contains a list of `controls` or `elements`, {@link sap.ui.lazyRequire lazy stubs }
|
|
26701
|
+
* will be created for their constructor as well as for their static `extend` and `getMetadata` methods.
|
|
26702
|
+
* **Note:** Future versions might abandon the concept of lazy stubs as it requires synchronous XMLHttpRequests
|
|
26703
|
+
* which have been deprecated (see {@link http://xhr.spec.whatwg.org}). To be on the safe side, productive
|
|
26704
|
+
* applications should always require any modules that they directly depend on.
|
|
26705
|
+
*
|
|
26706
|
+
*
|
|
26707
|
+
* - With the `noLibraryCSS` property, the library can be marked as 'theming-free'. Otherwise, the framework
|
|
26708
|
+
* will add a <link> tag to the page's head, pointing to the library's theme-specific stylesheet.
|
|
26709
|
+
* The creation of such a <link> tag can be suppressed with the {@link sap.ui.core.Configuration global configuration option }
|
|
26710
|
+
* `preloadLibCss`. It can contain a list of library names for which no stylesheet should be included. This
|
|
26711
|
+
* is e.g. useful when an application merges the CSS for multiple libraries and already loaded the resulting
|
|
26712
|
+
* stylesheet.
|
|
26713
|
+
*
|
|
26714
|
+
*
|
|
26715
|
+
* - If a list of library `dependencies` is specified in the info object, those libraries will be loaded
|
|
26716
|
+
* synchronously.
|
|
26717
|
+
* **Note:** Dependencies between libraries don't have to be modeled as AMD dependencies. Only when enums
|
|
26718
|
+
* or types from an additional library are used in the coding of the `library.js` module, the library should
|
|
26719
|
+
* be additionally listed in the AMD dependencies.
|
|
26720
|
+
*
|
|
26721
|
+
* Last but not least, higher layer frameworks might want to include their own metadata for libraries. The
|
|
26722
|
+
* property `extensions` might contain such additional metadata. Its structure is not defined by the framework,
|
|
26723
|
+
* but it is strongly suggested that each extension only occupies a single property in the `extensions`
|
|
26724
|
+
* object and that the name of that property contains some namespace information (e.g. library name that
|
|
26725
|
+
* introduces the feature) to avoid conflicts with other extensions. The framework won't touch the content
|
|
26726
|
+
* of `extensions` but will make it available in the library info objects returned by {@link #.getInitializedLibraries}.
|
|
26727
|
+
*
|
|
26728
|
+
* Relationship to Descriptor for Libraries (manifest.json):
|
|
26729
|
+
*
|
|
26730
|
+
* The information contained in `mSettings` is partially redundant to the content of the descriptor for
|
|
26731
|
+
* the same library (its `manifest.json` file). Future versions of UI5 might ignore the information provided
|
|
26732
|
+
* in `oLibInfo` and might evaluate the descriptor file instead. Library developers therefore should keep
|
|
26733
|
+
* the information in both files in sync.
|
|
26734
|
+
*
|
|
26735
|
+
* When the `manifest.json` is generated from the `.library` file (which is the default for UI5 libraries
|
|
26736
|
+
* built with Maven), then the content of the `.library` and `library.js` files must be kept in sync.
|
|
26737
|
+
*
|
|
26738
|
+
* @returns As of version 1.101; returns the library namespace, based on the given library name.
|
|
26739
|
+
*/
|
|
26740
|
+
static init(
|
|
26741
|
+
/**
|
|
26742
|
+
* Info object for the library
|
|
26743
|
+
*/
|
|
26744
|
+
mSettings: {
|
|
26745
|
+
/**
|
|
26746
|
+
* Name of the library; It must match the name by which the library has been loaded
|
|
26747
|
+
*/
|
|
26748
|
+
name: string;
|
|
26749
|
+
/**
|
|
26750
|
+
* Version of the library
|
|
26751
|
+
*/
|
|
26752
|
+
version?: string;
|
|
26753
|
+
/**
|
|
26754
|
+
* List of libraries that this library depends on; names are in dot notation (e.g. "sap.ui.core")
|
|
26755
|
+
*/
|
|
26756
|
+
dependencies?: string[];
|
|
26757
|
+
/**
|
|
26758
|
+
* List of names of types that this library provides; names are in dot notation (e.g. "sap.ui.core.CSSSize")
|
|
26759
|
+
*/
|
|
26760
|
+
types?: string[];
|
|
26761
|
+
/**
|
|
26762
|
+
* List of names of interface types that this library provides; names are in dot notation (e.g. "sap.ui.core.PopupInterface")
|
|
26763
|
+
*/
|
|
26764
|
+
interfaces?: string[];
|
|
26765
|
+
/**
|
|
26766
|
+
* Names of control types that this library provides; names are in dot notation (e.g. "sap.ui.core.ComponentContainer")
|
|
26767
|
+
*/
|
|
26768
|
+
controls?: string[];
|
|
26769
|
+
/**
|
|
26770
|
+
* Names of element types that this library provides (excluding controls); names are in dot notation (e.g.
|
|
26771
|
+
* "sap.ui.core.Item")
|
|
26772
|
+
*/
|
|
26773
|
+
elements?: string[];
|
|
26774
|
+
/**
|
|
26775
|
+
* Indicates whether the library doesn't provide / use theming. When set to true, no library.css will be
|
|
26776
|
+
* loaded for this library
|
|
26777
|
+
*/
|
|
26778
|
+
noLibraryCSS?: boolean;
|
|
26779
|
+
/**
|
|
26780
|
+
* Potential extensions of the library metadata; structure not defined by the UI5 core framework.
|
|
26781
|
+
*/
|
|
26782
|
+
extensions?: object;
|
|
26783
|
+
}
|
|
26784
|
+
): object;
|
|
26785
|
+
/**
|
|
26786
|
+
* Checks whether the library for the given `sName` has been loaded or not.
|
|
26787
|
+
*
|
|
26788
|
+
* @returns Returns `true` if the library is loaded. Otherwise `false`.
|
|
26789
|
+
*/
|
|
26790
|
+
static isLoaded(
|
|
26791
|
+
/**
|
|
26792
|
+
* The name of the library
|
|
26793
|
+
*/
|
|
26794
|
+
sName: string
|
|
26795
|
+
): boolean;
|
|
26796
|
+
/**
|
|
26797
|
+
* Loads the given library and its dependencies and makes its content available to the application.
|
|
26798
|
+
*
|
|
26799
|
+
* What it does:
|
|
26800
|
+
*
|
|
26801
|
+
* When library preloads are not suppressed for the given library, then a library-preload bundle will be
|
|
26802
|
+
* loaded for it.
|
|
26803
|
+
*
|
|
26804
|
+
* After preloading the bundle, dependency information from the bundle is evaluated and any missing libraries
|
|
26805
|
+
* are also preloaded.
|
|
26806
|
+
*
|
|
26807
|
+
* Only then the library entry module (named `your/lib/library.js`) will be required and executed.
|
|
26808
|
+
* The module is supposed to call {@link #.init} providing the framework with additional metadata about
|
|
26809
|
+
* the library, e.g. its version, the set of contained enums, types, interfaces, controls and elements and
|
|
26810
|
+
* whether the library requires CSS. If the library requires CSS, a <link> will be added to the page
|
|
26811
|
+
* referring to the corresponding `library.css` stylesheet for the library and the current theme.
|
|
26812
|
+
*
|
|
26813
|
+
* When the optional parameter `mOptions.url` is given, then that URL will be registered for the namespace
|
|
26814
|
+
* of the library and all resources will be loaded from that location. This is convenience for a call like
|
|
26815
|
+
*
|
|
26816
|
+
* ```javascript
|
|
26817
|
+
*
|
|
26818
|
+
* sap.ui.loader.config({
|
|
26819
|
+
* paths: {
|
|
26820
|
+
* "lib/with/slashes": mOptions.url
|
|
26821
|
+
* }
|
|
26822
|
+
* });
|
|
26823
|
+
* ```
|
|
26824
|
+
*
|
|
26825
|
+
*
|
|
26826
|
+
* When the given library has been loaded already, no further action will be taken, especially, a given
|
|
26827
|
+
* URL will not be registered. A Promise will be returned, but will be resolved immediately.
|
|
26828
|
+
*
|
|
26829
|
+
* When to use:
|
|
26830
|
+
*
|
|
26831
|
+
* For applications that follow the best practices and use components with component descriptors (manifest.json),
|
|
26832
|
+
* the framework will load all declared mandatory libraries and their dependencies automatically before
|
|
26833
|
+
* instantiating the application component.
|
|
26834
|
+
*
|
|
26835
|
+
* The same is true for libraries that are listed in the bootstrap configuration (e.g. with the attribute
|
|
26836
|
+
* `data-sap-ui-libs`). They will be loaded before the `init` event of the UI5 Core is fired.
|
|
26837
|
+
*
|
|
26838
|
+
* Only when an app declares a library to be a lazy library dependency or when code does not use descriptors
|
|
26839
|
+
* at all, then an explicit call to `loadLibrary` becomes necessary. The call should be made before artifacts
|
|
26840
|
+
* (controls, elements, types, helpers, modules etc.) from the library are used or required. This allows
|
|
26841
|
+
* the framework to optimize access to those artifacts.
|
|
26842
|
+
*
|
|
26843
|
+
* For example, when an app uses a heavy-weight charting library that shouldn't be loaded during startup,
|
|
26844
|
+
* it can declare it as "lazy" and load it just before it loads and displays a view that uses the charting
|
|
26845
|
+
* library:
|
|
26846
|
+
* ```javascript
|
|
26847
|
+
*
|
|
26848
|
+
* Lib.load({name: "heavy.charting"})
|
|
26849
|
+
* .then(function() {
|
|
26850
|
+
* View.create({
|
|
26851
|
+
* name: "myapp.views.HeavyChartingView",
|
|
26852
|
+
* type: ViewType.XML
|
|
26853
|
+
* });
|
|
26854
|
+
* });
|
|
26855
|
+
* ```
|
|
26856
|
+
*
|
|
26857
|
+
*
|
|
26858
|
+
* @returns A promise that resolves with the library instance after the loading of the library is finished
|
|
26859
|
+
*/
|
|
26860
|
+
static load(
|
|
26861
|
+
/**
|
|
26862
|
+
* The options object that contains the following properties
|
|
26863
|
+
*/
|
|
26864
|
+
mOptions: {
|
|
26865
|
+
/**
|
|
26866
|
+
* The name of the library
|
|
26867
|
+
*/
|
|
26868
|
+
name: string;
|
|
26869
|
+
/**
|
|
26870
|
+
* URL to load the library from
|
|
26871
|
+
*/
|
|
26872
|
+
url?: string;
|
|
26873
|
+
}
|
|
26874
|
+
): Promise<Lib>;
|
|
26875
|
+
}
|
|
26876
|
+
}
|
|
26877
|
+
|
|
26142
26878
|
declare module "sap/ui/core/ListItem" {
|
|
26143
26879
|
import { default as Item, $ItemSettings } from "sap/ui/core/Item";
|
|
26144
26880
|
|
|
@@ -27864,7 +28600,7 @@ declare module "sap/ui/core/Message" {
|
|
|
27864
28600
|
*
|
|
27865
28601
|
* @returns Value of property `level`
|
|
27866
28602
|
*/
|
|
27867
|
-
getLevel(): MessageType
|
|
28603
|
+
getLevel(): MessageType;
|
|
27868
28604
|
/**
|
|
27869
28605
|
* @since 1.19.0
|
|
27870
28606
|
*
|
|
@@ -27925,7 +28661,7 @@ declare module "sap/ui/core/Message" {
|
|
|
27925
28661
|
/**
|
|
27926
28662
|
* New value for property `level`
|
|
27927
28663
|
*/
|
|
27928
|
-
sLevel?: MessageType
|
|
28664
|
+
sLevel?: MessageType
|
|
27929
28665
|
): this;
|
|
27930
28666
|
/**
|
|
27931
28667
|
* @since 1.19.0
|
|
@@ -28000,10 +28736,7 @@ declare module "sap/ui/core/Message" {
|
|
|
28000
28736
|
/**
|
|
28001
28737
|
* Setting the message's level.
|
|
28002
28738
|
*/
|
|
28003
|
-
level?:
|
|
28004
|
-
| (MessageType | keyof typeof MessageType)
|
|
28005
|
-
| PropertyBindingInfo
|
|
28006
|
-
| `{${string}}`;
|
|
28739
|
+
level?: MessageType | PropertyBindingInfo | `{${string}}`;
|
|
28007
28740
|
|
|
28008
28741
|
/**
|
|
28009
28742
|
* @since 1.19.0
|
|
@@ -28125,7 +28858,7 @@ declare module "sap/ui/core/message/Message" {
|
|
|
28125
28858
|
/**
|
|
28126
28859
|
* The message type
|
|
28127
28860
|
*/
|
|
28128
|
-
type?: MessageType
|
|
28861
|
+
type?: MessageType;
|
|
28129
28862
|
/**
|
|
28130
28863
|
* The message code
|
|
28131
28864
|
*/
|
|
@@ -28302,7 +29035,7 @@ declare module "sap/ui/core/message/Message" {
|
|
|
28302
29035
|
*
|
|
28303
29036
|
* @returns type
|
|
28304
29037
|
*/
|
|
28305
|
-
getType(): MessageType
|
|
29038
|
+
getType(): MessageType;
|
|
28306
29039
|
/**
|
|
28307
29040
|
* Sets the additionaltext for the message or merge different additionaltext strings
|
|
28308
29041
|
*/
|
|
@@ -28424,13 +29157,13 @@ declare module "sap/ui/core/message/Message" {
|
|
|
28424
29157
|
/**
|
|
28425
29158
|
* The Message type
|
|
28426
29159
|
*/
|
|
28427
|
-
sType: MessageType
|
|
29160
|
+
sType: MessageType
|
|
28428
29161
|
): void;
|
|
28429
29162
|
}
|
|
28430
29163
|
}
|
|
28431
29164
|
|
|
28432
29165
|
declare module "sap/ui/core/message/MessageManager" {
|
|
28433
|
-
import
|
|
29166
|
+
import BaseObject from "sap/ui/base/Object";
|
|
28434
29167
|
|
|
28435
29168
|
import Message from "sap/ui/core/message/Message";
|
|
28436
29169
|
|
|
@@ -28442,20 +29175,32 @@ declare module "sap/ui/core/message/MessageManager" {
|
|
|
28442
29175
|
|
|
28443
29176
|
import ManagedObject from "sap/ui/base/ManagedObject";
|
|
28444
29177
|
|
|
28445
|
-
|
|
29178
|
+
/**
|
|
29179
|
+
* @deprecated (since 1.118) - Please use {@link module:sap/ui/core/Messaging Messaging} instead.
|
|
29180
|
+
*/
|
|
29181
|
+
export default class MessageManager extends BaseObject {
|
|
28446
29182
|
/**
|
|
28447
29183
|
* Constructor for a new MessageManager.
|
|
28448
29184
|
*
|
|
28449
|
-
* Creating own instances of MessageManager is deprecated. Please require 'sap/ui/core/
|
|
29185
|
+
* Creating own instances of MessageManager is deprecated. Please require {@link module:sap/ui/core/Messaging 'sap/ui/core/Messaging' }
|
|
28450
29186
|
* instead and use the module export directly without using 'new'.
|
|
28451
29187
|
*/
|
|
28452
29188
|
constructor();
|
|
28453
29189
|
|
|
29190
|
+
/**
|
|
29191
|
+
* Add messages to Messaging
|
|
29192
|
+
*/
|
|
29193
|
+
static addMessages(
|
|
29194
|
+
/**
|
|
29195
|
+
* Array of sap.ui.core.message.Message or single sap.ui.core.message.Message
|
|
29196
|
+
*/
|
|
29197
|
+
vMessages: Message | Message[]
|
|
29198
|
+
): void;
|
|
28454
29199
|
/**
|
|
28455
29200
|
* Creates a new subclass of class sap.ui.core.message.MessageManager with name `sClassName` and enriches
|
|
28456
29201
|
* it with the information contained in `oClassInfo`.
|
|
28457
29202
|
*
|
|
28458
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.
|
|
29203
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
28459
29204
|
*
|
|
28460
29205
|
* @returns Created class / constructor function
|
|
28461
29206
|
*/
|
|
@@ -28475,36 +29220,21 @@ declare module "sap/ui/core/message/MessageManager" {
|
|
|
28475
29220
|
FNMetaImpl?: Function
|
|
28476
29221
|
): Function;
|
|
28477
29222
|
/**
|
|
28478
|
-
*
|
|
28479
|
-
*
|
|
28480
|
-
* @returns Metadata object describing this class
|
|
28481
|
-
*/
|
|
28482
|
-
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`.
|
|
29223
|
+
* Get the MessageModel
|
|
28494
29224
|
*
|
|
28495
|
-
*
|
|
29225
|
+
* @returns oMessageModel The Message Model
|
|
28496
29226
|
*/
|
|
28497
|
-
|
|
29227
|
+
static getMessageModel(): MessageModel;
|
|
28498
29228
|
/**
|
|
28499
|
-
*
|
|
29229
|
+
* Returns a metadata object for class sap.ui.core.message.MessageManager.
|
|
28500
29230
|
*
|
|
28501
|
-
* @returns
|
|
29231
|
+
* @returns Metadata object describing this class
|
|
28502
29232
|
*/
|
|
28503
|
-
|
|
29233
|
+
static getMetadata(): Metadata;
|
|
28504
29234
|
/**
|
|
28505
29235
|
* Register MessageProcessor
|
|
28506
29236
|
*/
|
|
28507
|
-
registerMessageProcessor(
|
|
29237
|
+
static registerMessageProcessor(
|
|
28508
29238
|
/**
|
|
28509
29239
|
* The MessageProcessor
|
|
28510
29240
|
*/
|
|
@@ -28513,28 +29243,28 @@ declare module "sap/ui/core/message/MessageManager" {
|
|
|
28513
29243
|
/**
|
|
28514
29244
|
* When using the databinding type system, the validation/parsing of a new property value could fail. In
|
|
28515
29245
|
* this case, a validationError/parseError event is fired. These events bubble up to the core. For registered
|
|
28516
|
-
* ManagedObjects, the
|
|
28517
|
-
*
|
|
29246
|
+
* ManagedObjects, the Messaging attaches to these events and creates a `sap.ui.core.message.Message` (bHandleValidation=true)
|
|
29247
|
+
* for each of these errors and cancels the event bubbling.
|
|
28518
29248
|
*/
|
|
28519
|
-
registerObject(
|
|
29249
|
+
static registerObject(
|
|
28520
29250
|
/**
|
|
28521
29251
|
* The sap.ui.base.ManagedObject
|
|
28522
29252
|
*/
|
|
28523
29253
|
oObject: ManagedObject,
|
|
28524
29254
|
/**
|
|
28525
|
-
* Handle validationError/parseError events for this object. If set to true, the
|
|
28526
|
-
*
|
|
29255
|
+
* Handle validationError/parseError events for this object. If set to true, the Messaging creates a Message
|
|
29256
|
+
* for each validation/parse error. The event bubbling is canceled in every case.
|
|
28527
29257
|
*/
|
|
28528
29258
|
bHandleValidation: boolean
|
|
28529
29259
|
): void;
|
|
28530
29260
|
/**
|
|
28531
29261
|
* Remove all messages
|
|
28532
29262
|
*/
|
|
28533
|
-
removeAllMessages(): void;
|
|
29263
|
+
static removeAllMessages(): void;
|
|
28534
29264
|
/**
|
|
28535
29265
|
* Remove given Messages
|
|
28536
29266
|
*/
|
|
28537
|
-
removeMessages(
|
|
29267
|
+
static removeMessages(
|
|
28538
29268
|
/**
|
|
28539
29269
|
* The message(s) to be removed.
|
|
28540
29270
|
*/
|
|
@@ -28543,7 +29273,7 @@ declare module "sap/ui/core/message/MessageManager" {
|
|
|
28543
29273
|
/**
|
|
28544
29274
|
* Deregister MessageProcessor
|
|
28545
29275
|
*/
|
|
28546
|
-
unregisterMessageProcessor(
|
|
29276
|
+
static unregisterMessageProcessor(
|
|
28547
29277
|
/**
|
|
28548
29278
|
* The MessageProcessor
|
|
28549
29279
|
*/
|
|
@@ -28552,28 +29282,26 @@ declare module "sap/ui/core/message/MessageManager" {
|
|
|
28552
29282
|
/**
|
|
28553
29283
|
* Unregister ManagedObject
|
|
28554
29284
|
*/
|
|
28555
|
-
unregisterObject(
|
|
29285
|
+
static unregisterObject(
|
|
28556
29286
|
/**
|
|
28557
29287
|
* The sap.ui.base.ManagedObject
|
|
28558
29288
|
*/
|
|
28559
29289
|
oObject: ManagedObject
|
|
28560
29290
|
): void;
|
|
28561
29291
|
/**
|
|
28562
|
-
* @since 1.115
|
|
28563
|
-
*
|
|
28564
29292
|
* Update Messages by providing two arrays of old and new messages.
|
|
28565
29293
|
*
|
|
28566
29294
|
* The old ones will be removed, the new ones will be added.
|
|
28567
29295
|
*/
|
|
28568
|
-
updateMessages(
|
|
29296
|
+
static updateMessages(
|
|
28569
29297
|
/**
|
|
28570
29298
|
* Array of old messages to be removed
|
|
28571
29299
|
*/
|
|
28572
|
-
aOldMessages:
|
|
29300
|
+
aOldMessages: Message[],
|
|
28573
29301
|
/**
|
|
28574
29302
|
* Array of new messages to be added
|
|
28575
29303
|
*/
|
|
28576
|
-
aNewMessages:
|
|
29304
|
+
aNewMessages: Message[]
|
|
28577
29305
|
): void;
|
|
28578
29306
|
}
|
|
28579
29307
|
}
|
|
@@ -28771,7 +29499,7 @@ declare module "sap/ui/core/message/MessageProcessor" {
|
|
|
28771
29499
|
oListener?: object
|
|
28772
29500
|
): this;
|
|
28773
29501
|
/**
|
|
28774
|
-
* @deprecated
|
|
29502
|
+
* @deprecated (since 1.115) - Use {@link module:sap/ui/core/Messaging.updateMessages} instead
|
|
28775
29503
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
28776
29504
|
*
|
|
28777
29505
|
* Fires event {@link #event:messageChange messageChange} to attached listeners.
|
|
@@ -30252,7 +30980,7 @@ declare module "sap/ui/core/mvc/View" {
|
|
|
30252
30980
|
* Returns an element by its ID in the context of this view.
|
|
30253
30981
|
*
|
|
30254
30982
|
* This method expects a view-local ID of an element (the same as e.g. defined in the *.view.xml of an XMLView).
|
|
30255
|
-
* For a search with a global ID (the value returned by `oElement.getId()`) you should rather use {@link sap.ui.core.
|
|
30983
|
+
* For a search with a global ID (the value returned by `oElement.getId()`) you should rather use {@link sap.ui.core.Element#getElementById Element.getElementById}.
|
|
30256
30984
|
*
|
|
30257
30985
|
* @returns Element by its ID or `undefined`
|
|
30258
30986
|
*/
|
|
@@ -32439,16 +33167,6 @@ declare module "sap/ui/core/RenderManager" {
|
|
|
32439
33167
|
* rendering optimization.
|
|
32440
33168
|
*/
|
|
32441
33169
|
export default class RenderManager extends Object {
|
|
32442
|
-
/**
|
|
32443
|
-
* Creates an instance of the RenderManager.
|
|
32444
|
-
*
|
|
32445
|
-
* Applications or controls must not call the `RenderManager` constructor on their own but should use the
|
|
32446
|
-
* {@link sap.ui.core.Core#createRenderManager sap.ui.getCore().createRenderManager()} method to create
|
|
32447
|
-
* an instance for their exclusive use.
|
|
32448
|
-
* See:
|
|
32449
|
-
* sap.ui.core.Core
|
|
32450
|
-
* sap.ui.getCore
|
|
32451
|
-
*/
|
|
32452
33170
|
constructor();
|
|
32453
33171
|
|
|
32454
33172
|
/**
|
|
@@ -33399,9 +34117,6 @@ declare module "sap/ui/core/ResizeHandler" {
|
|
|
33399
34117
|
/**
|
|
33400
34118
|
* Registers the given event handler for resize events on the given DOM element or control.
|
|
33401
34119
|
*
|
|
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
34120
|
* The resize handler periodically checks the dimensions of the registered reference. Whenever it detects
|
|
33406
34121
|
* changes, an event is fired. Be careful when changing dimensions within the event handler which might
|
|
33407
34122
|
* cause another resize event and so on.
|
|
@@ -40123,14 +40838,6 @@ declare module "sap/ui/core/UIArea" {
|
|
|
40123
40838
|
* @returns True if the control is still in the active DOM
|
|
40124
40839
|
*/
|
|
40125
40840
|
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
40841
|
/**
|
|
40135
40842
|
* Returns the locked state of the `sap.ui.core.UIArea`
|
|
40136
40843
|
*
|
|
@@ -42929,6 +43636,300 @@ declare module "sap/ui/core/VariantLayoutData" {
|
|
|
42929
43636
|
}
|
|
42930
43637
|
}
|
|
42931
43638
|
|
|
43639
|
+
declare module "sap/ui/core/webc/WebComponent" {
|
|
43640
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
43641
|
+
|
|
43642
|
+
import WebComponentMetadata from "sap/ui/core/webc/WebComponentMetadata";
|
|
43643
|
+
|
|
43644
|
+
import { MetadataOptions as MetadataOptions1 } from "sap/ui/core/Element";
|
|
43645
|
+
|
|
43646
|
+
import { MetadataOptions as MetadataOptions2 } from "sap/ui/base/ManagedObject";
|
|
43647
|
+
|
|
43648
|
+
/**
|
|
43649
|
+
* @since 1.118.0
|
|
43650
|
+
* @experimental (since 1.118.0) - The API might change. It is not intended for productive usage yet!
|
|
43651
|
+
*
|
|
43652
|
+
* Base Class for Web Components. Web Components are agnostic UI elements which can be integrated into the
|
|
43653
|
+
* UI5 programming model by using this wrapper control. This wrapper control takes care to propagate the
|
|
43654
|
+
* properties, the aggregations and the events. It also ensures to render the control and put the aggregated
|
|
43655
|
+
* controls in the dedicated slots of the Web Component.
|
|
43656
|
+
*/
|
|
43657
|
+
export default class WebComponent extends Control {
|
|
43658
|
+
/**
|
|
43659
|
+
* Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
|
|
43660
|
+
*
|
|
43661
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
43662
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
43663
|
+
* of the syntax of the settings object.
|
|
43664
|
+
*/
|
|
43665
|
+
constructor(
|
|
43666
|
+
/**
|
|
43667
|
+
* Object with initial settings for the new control
|
|
43668
|
+
*/
|
|
43669
|
+
mSettings?: $WebComponentSettings
|
|
43670
|
+
);
|
|
43671
|
+
/**
|
|
43672
|
+
* Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
|
|
43673
|
+
*
|
|
43674
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
43675
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
43676
|
+
* of the syntax of the settings object.
|
|
43677
|
+
*/
|
|
43678
|
+
constructor(
|
|
43679
|
+
/**
|
|
43680
|
+
* Optional ID for the new control; generated automatically if no non-empty ID is given Note: this can be
|
|
43681
|
+
* omitted, no matter whether `mSettings` will be given or not!
|
|
43682
|
+
*/
|
|
43683
|
+
sId?: string,
|
|
43684
|
+
/**
|
|
43685
|
+
* Object with initial settings for the new control
|
|
43686
|
+
*/
|
|
43687
|
+
mSettings?: $WebComponentSettings
|
|
43688
|
+
);
|
|
43689
|
+
|
|
43690
|
+
/**
|
|
43691
|
+
* Defines a new subclass of WebComponent with the name `sClassName` and enriches it with the information
|
|
43692
|
+
* contained in `oClassInfo`.
|
|
43693
|
+
*
|
|
43694
|
+
* `oClassInfo` can contain the same information that {@link sap.ui.base.ManagedObject.extend} already accepts,
|
|
43695
|
+
* plus the `dnd` property in the metadata object literal to configure drag-and-drop behavior (see {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions }
|
|
43696
|
+
* for details). Objects describing aggregations can also have a `dnd` property when used for a class extending
|
|
43697
|
+
* `WebComponent` (see {@link sap.ui.base.ManagedObject.MetadataOptions.AggregationDnD AggregationDnD}).
|
|
43698
|
+
*
|
|
43699
|
+
* Example:
|
|
43700
|
+
* ```javascript
|
|
43701
|
+
*
|
|
43702
|
+
* WebComponent.extend('sap.mylib.MyElement', {
|
|
43703
|
+
* metadata : {
|
|
43704
|
+
* library : 'sap.mylib',
|
|
43705
|
+
* tag : 'my-webcomponent',
|
|
43706
|
+
* properties : {
|
|
43707
|
+
* value : 'string',
|
|
43708
|
+
* width : {
|
|
43709
|
+
* type: 'sap.ui.core.CSSSize',
|
|
43710
|
+
* mapping: 'style'
|
|
43711
|
+
* }
|
|
43712
|
+
* },
|
|
43713
|
+
* defaultAggregation: "content",
|
|
43714
|
+
* aggregations : {
|
|
43715
|
+
* content : {
|
|
43716
|
+
* type: 'sap.ui.core.Control',
|
|
43717
|
+
* multiple : true
|
|
43718
|
+
* },
|
|
43719
|
+
* header : {
|
|
43720
|
+
* type : 'sap.ui.core.Control',
|
|
43721
|
+
* multiple : false,
|
|
43722
|
+
* slot: 'header'
|
|
43723
|
+
* }
|
|
43724
|
+
* }
|
|
43725
|
+
* }
|
|
43726
|
+
* });
|
|
43727
|
+
* ```
|
|
43728
|
+
*
|
|
43729
|
+
*
|
|
43730
|
+
* @returns Created class / constructor function
|
|
43731
|
+
*/
|
|
43732
|
+
static extend<T extends Record<string, unknown>>(
|
|
43733
|
+
/**
|
|
43734
|
+
* Name of the class to be created
|
|
43735
|
+
*/
|
|
43736
|
+
sClassName: string,
|
|
43737
|
+
/**
|
|
43738
|
+
* Object literal with information about the class
|
|
43739
|
+
*/
|
|
43740
|
+
oClassInfo?: sap.ClassInfo<T, WebComponent>,
|
|
43741
|
+
/**
|
|
43742
|
+
* Constructor function for the metadata object. If not given, it defaults to `sap.ui.core.ElementMetadata`.
|
|
43743
|
+
*/
|
|
43744
|
+
FNMetaImpl?: Function
|
|
43745
|
+
): Function;
|
|
43746
|
+
/**
|
|
43747
|
+
* Returns a metadata object for class sap.ui.core.webc.WebComponent.
|
|
43748
|
+
*
|
|
43749
|
+
* @returns Metadata object describing this class
|
|
43750
|
+
*/
|
|
43751
|
+
static getMetadata(): WebComponentMetadata;
|
|
43752
|
+
}
|
|
43753
|
+
/**
|
|
43754
|
+
* The structure of the "metadata" object which is passed when inheriting from sap.ui.core.Element using
|
|
43755
|
+
* its static "extend" method. See {@link sap.ui.core.Element.extend} for details on its usage.
|
|
43756
|
+
*/
|
|
43757
|
+
export type MetadataOptions = MetadataOptions1 & {
|
|
43758
|
+
/**
|
|
43759
|
+
* Tag name of the Web Component to be used in the renderer to render the HTML.
|
|
43760
|
+
*/
|
|
43761
|
+
tag: string;
|
|
43762
|
+
/**
|
|
43763
|
+
* An object literal whose properties each define a new managed property in the WebComponent subclass. See
|
|
43764
|
+
* {@link sap.ui.base.ManagedObject.MetadataOptions.Property Property} for more details.
|
|
43765
|
+
*/
|
|
43766
|
+
properties?: Record<string, string | MetadataOptions.Property>;
|
|
43767
|
+
/**
|
|
43768
|
+
* An object literal whose properties each define a new aggregation in the ManagedObject subclass. See {@link sap.ui.base.ManagedObject.MetadataOptions.Aggregation Aggregation }
|
|
43769
|
+
* for more details.
|
|
43770
|
+
*/
|
|
43771
|
+
aggregations?: Record<string, string | MetadataOptions.Aggregation>;
|
|
43772
|
+
/**
|
|
43773
|
+
* An object literal whose properties each define a new association in the ManagedObject subclass. See {@link sap.ui.base.ManagedObject.MetadataOptions.Association Association }
|
|
43774
|
+
* for more details.
|
|
43775
|
+
*/
|
|
43776
|
+
associations?: Record<string, string | MetadataOptions.Association>;
|
|
43777
|
+
/**
|
|
43778
|
+
* Proxied public getters of the Web Component which are directly accessible on the wrapper Control.
|
|
43779
|
+
*/
|
|
43780
|
+
getters?: string[];
|
|
43781
|
+
/**
|
|
43782
|
+
* Proxied public methods of the Web Component which are directly accessible on the wrapper Control.
|
|
43783
|
+
*/
|
|
43784
|
+
methods?: string[];
|
|
43785
|
+
};
|
|
43786
|
+
|
|
43787
|
+
/**
|
|
43788
|
+
* HACK! This mapping omits the `no-unnecessary-qualifier` error or we need to extend the `tslint.json`!
|
|
43789
|
+
*/
|
|
43790
|
+
export type MetadataOptionsAssociationMapping = MetadataOptions.Association.Mapping;
|
|
43791
|
+
|
|
43792
|
+
/**
|
|
43793
|
+
* HACK! This mapping omits the `no-unnecessary-qualifier` error or we need to extend the `tslint.json`!
|
|
43794
|
+
*/
|
|
43795
|
+
export type MetadataOptionsPropertyMapping = MetadataOptions.Property.Mapping;
|
|
43796
|
+
|
|
43797
|
+
export interface $WebComponentSettings extends $ControlSettings {}
|
|
43798
|
+
|
|
43799
|
+
export namespace MetadataOptions {
|
|
43800
|
+
namespace Association {
|
|
43801
|
+
/**
|
|
43802
|
+
* An object literal describing the mapping of an association as property of a class derived from `sap.ui.core.webc.WebComponent`.
|
|
43803
|
+
*/
|
|
43804
|
+
type Mapping = {
|
|
43805
|
+
/**
|
|
43806
|
+
* Defines the mapping of the association which defaults to "property". Associations are forwarded to the
|
|
43807
|
+
* corresponding mutator of the Web Component.
|
|
43808
|
+
*/
|
|
43809
|
+
type?: "property";
|
|
43810
|
+
/**
|
|
43811
|
+
* Defines the target of the mapping of the association to which property it will be mapped to.
|
|
43812
|
+
*/
|
|
43813
|
+
to?: string;
|
|
43814
|
+
/**
|
|
43815
|
+
* Defines the name of the formatter function at the WebComponent instance to format the value before its
|
|
43816
|
+
* being mapped.
|
|
43817
|
+
*/
|
|
43818
|
+
formatter?: string;
|
|
43819
|
+
};
|
|
43820
|
+
}
|
|
43821
|
+
|
|
43822
|
+
namespace Property {
|
|
43823
|
+
/**
|
|
43824
|
+
* An object literal describing the mapping of a property of a class derived from `sap.ui.core.webc.WebComponent`.
|
|
43825
|
+
*/
|
|
43826
|
+
type Mapping = {
|
|
43827
|
+
/**
|
|
43828
|
+
* Defines the mapping of the property to be either "property", "style", "textContent", "slot", or "none".
|
|
43829
|
+
* The default mapping of a property is "property" which either renders the value of the property into an
|
|
43830
|
+
* attribute of the custom tag or forwards object properties to the mutator in the onAfterRendering phase.
|
|
43831
|
+
*/
|
|
43832
|
+
type?: "property" | "style" | "textContent" | "slot" | "none";
|
|
43833
|
+
/**
|
|
43834
|
+
* Defines the target of the mapping of the property (e.g. the name of the attribute/property).
|
|
43835
|
+
*/
|
|
43836
|
+
to?: string;
|
|
43837
|
+
/**
|
|
43838
|
+
* Defines the name of the formatter function at the WebComponent instance to format the value before its
|
|
43839
|
+
* being mapped.
|
|
43840
|
+
*/
|
|
43841
|
+
formatter?: string;
|
|
43842
|
+
};
|
|
43843
|
+
}
|
|
43844
|
+
|
|
43845
|
+
/**
|
|
43846
|
+
* An object literal describing a property of a class derived from `sap.ui.core.webc.WebComponent`. See
|
|
43847
|
+
* {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions} for details on its usage.
|
|
43848
|
+
*/
|
|
43849
|
+
type Aggregation = MetadataOptions2.Aggregation & {
|
|
43850
|
+
/**
|
|
43851
|
+
* Flag that marks the property as deprecated (defaults to false). May lead to an additional warning log
|
|
43852
|
+
* message at runtime when the property is still used. For the documentation, also add a `@deprecated` tag
|
|
43853
|
+
* in the JSDoc, describing since when it is deprecated and what any alternatives are.
|
|
43854
|
+
*/
|
|
43855
|
+
slot?: string;
|
|
43856
|
+
};
|
|
43857
|
+
|
|
43858
|
+
/**
|
|
43859
|
+
* An object literal describing an association of a class derived from `sap.ui.core.webc.WebComponent`.
|
|
43860
|
+
* See {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions} for details on its usage.
|
|
43861
|
+
*/
|
|
43862
|
+
type Association = MetadataOptions2.Association & {
|
|
43863
|
+
/**
|
|
43864
|
+
* Defines the mapping of the association which defaults to "property". Associations are forwarded to the
|
|
43865
|
+
* corresponding mutator of the Web Component.
|
|
43866
|
+
*/
|
|
43867
|
+
mapping?: "property" | MetadataOptionsAssociationMapping;
|
|
43868
|
+
};
|
|
43869
|
+
|
|
43870
|
+
/**
|
|
43871
|
+
* An object literal describing a property of a class derived from `sap.ui.core.webc.WebComponent`. See
|
|
43872
|
+
* {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions} for details on its usage.
|
|
43873
|
+
*/
|
|
43874
|
+
type Property = MetadataOptions2.Property & {
|
|
43875
|
+
/**
|
|
43876
|
+
* Defines the mapping of the property to be either "property", "style", "textContent", "slot", or "none".
|
|
43877
|
+
* The default mapping of a property is "property" which either renders the value of the property into an
|
|
43878
|
+
* attribute of the custom tag or forwards object properties to the mutator in the onAfterRendering phase.
|
|
43879
|
+
*/
|
|
43880
|
+
mapping?:
|
|
43881
|
+
| "property"
|
|
43882
|
+
| "style"
|
|
43883
|
+
| "textContent"
|
|
43884
|
+
| "slot"
|
|
43885
|
+
| "none"
|
|
43886
|
+
| MetadataOptionsPropertyMapping;
|
|
43887
|
+
};
|
|
43888
|
+
}
|
|
43889
|
+
}
|
|
43890
|
+
|
|
43891
|
+
declare module "sap/ui/core/webc/WebComponentMetadata" {
|
|
43892
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
43893
|
+
|
|
43894
|
+
/**
|
|
43895
|
+
* @since 1.118.0
|
|
43896
|
+
* @experimental (since 1.118.0) - The API might change. It is not intended for productive usage yet!
|
|
43897
|
+
*/
|
|
43898
|
+
export default class WebComponentMetadata extends ElementMetadata {
|
|
43899
|
+
/**
|
|
43900
|
+
* Creates a new metadata object for a WebComponent Wrapper subclass.
|
|
43901
|
+
*/
|
|
43902
|
+
constructor(
|
|
43903
|
+
/**
|
|
43904
|
+
* fully qualified name of the class that is described by this metadata object
|
|
43905
|
+
*/
|
|
43906
|
+
sClassName: string,
|
|
43907
|
+
/**
|
|
43908
|
+
* static info to construct the metadata from
|
|
43909
|
+
*/
|
|
43910
|
+
oClassInfo: object
|
|
43911
|
+
);
|
|
43912
|
+
|
|
43913
|
+
/**
|
|
43914
|
+
* Returns the list of public getters, proxied by the Component Wrapper to the component itself
|
|
43915
|
+
*/
|
|
43916
|
+
getGetters(): any[];
|
|
43917
|
+
/**
|
|
43918
|
+
* Returns the list of public methods, proxied by the Component Wrapper to the component itself
|
|
43919
|
+
*/
|
|
43920
|
+
getMethods(): any[];
|
|
43921
|
+
/**
|
|
43922
|
+
* Retrieves the renderer for the described web component class. Note: this is always the default renderer
|
|
43923
|
+
* and Web Component wrappers should not define their own renderers.
|
|
43924
|
+
*/
|
|
43925
|
+
getRenderer(): void;
|
|
43926
|
+
/**
|
|
43927
|
+
* Returns the tag, used to render the Component Wrapper
|
|
43928
|
+
*/
|
|
43929
|
+
getTag(): string;
|
|
43930
|
+
}
|
|
43931
|
+
}
|
|
43932
|
+
|
|
42932
43933
|
declare module "sap/ui/core/ws/ReadyState" {
|
|
42933
43934
|
/**
|
|
42934
43935
|
* Defines the different ready states for a WebSocket connection.
|
|
@@ -48104,6 +49105,8 @@ declare module "sap/ui/model/ClientListBinding" {
|
|
|
48104
49105
|
declare module "sap/ui/model/ClientModel" {
|
|
48105
49106
|
import Model from "sap/ui/model/Model";
|
|
48106
49107
|
|
|
49108
|
+
import PropertyBinding from "sap/ui/model/PropertyBinding";
|
|
49109
|
+
|
|
48107
49110
|
import Metadata from "sap/ui/base/Metadata";
|
|
48108
49111
|
|
|
48109
49112
|
/**
|
|
@@ -48149,6 +49152,41 @@ declare module "sap/ui/model/ClientModel" {
|
|
|
48149
49152
|
* @returns Metadata object describing this class
|
|
48150
49153
|
*/
|
|
48151
49154
|
static getMetadata(): Metadata;
|
|
49155
|
+
/**
|
|
49156
|
+
* Creates a new property binding for this model.
|
|
49157
|
+
* See:
|
|
49158
|
+
* sap.ui.model.Model#bindProperty
|
|
49159
|
+
* #getProperty
|
|
49160
|
+
*
|
|
49161
|
+
* @returns The new property binding
|
|
49162
|
+
*/
|
|
49163
|
+
bindProperty(
|
|
49164
|
+
/**
|
|
49165
|
+
* The path pointing to the property that should be bound; either an absolute path or a path relative to
|
|
49166
|
+
* a given `oContext`
|
|
49167
|
+
*/
|
|
49168
|
+
sPath: string,
|
|
49169
|
+
/**
|
|
49170
|
+
* A context object for the new binding
|
|
49171
|
+
*/
|
|
49172
|
+
oContext?: object,
|
|
49173
|
+
/**
|
|
49174
|
+
* Map of optional parameters for the binding
|
|
49175
|
+
*/
|
|
49176
|
+
mParameters?: {
|
|
49177
|
+
/**
|
|
49178
|
+
* Whether this binding does not propagate model messages to the control; supported since 1.119.0. Some
|
|
49179
|
+
* composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages for some
|
|
49180
|
+
* of their parts depending on their format options; setting this parameter to `true` or `false` overrules
|
|
49181
|
+
* the automatism of the type.
|
|
49182
|
+
*
|
|
49183
|
+
* For example, a binding for a currency code is used in a composite binding for rendering the proper number
|
|
49184
|
+
* of decimals, but the currency code is not displayed in the attached control. In that case, messages for
|
|
49185
|
+
* the currency code shall not be displayed at that control, only messages for the amount.
|
|
49186
|
+
*/
|
|
49187
|
+
ignoreMessages?: boolean;
|
|
49188
|
+
}
|
|
49189
|
+
): PropertyBinding;
|
|
48152
49190
|
/**
|
|
48153
49191
|
* See:
|
|
48154
49192
|
* sap.ui.model.Model.prototype.destroy
|
|
@@ -48261,6 +49299,17 @@ declare module "sap/ui/model/ClientPropertyBinding" {
|
|
|
48261
49299
|
* @returns Metadata object describing this class
|
|
48262
49300
|
*/
|
|
48263
49301
|
static getMetadata(): Metadata;
|
|
49302
|
+
/**
|
|
49303
|
+
* @since 1.119.0
|
|
49304
|
+
*
|
|
49305
|
+
* Returns `true`, as this binding supports the feature of not propagating model messages to the control.
|
|
49306
|
+
* See:
|
|
49307
|
+
* sap.ui.model.Binding#getIgnoreMessages
|
|
49308
|
+
* sap.ui.model.Binding#setIgnoreMessages
|
|
49309
|
+
*
|
|
49310
|
+
* @returns `true`
|
|
49311
|
+
*/
|
|
49312
|
+
supportsIgnoreMessages(): boolean;
|
|
48264
49313
|
}
|
|
48265
49314
|
}
|
|
48266
49315
|
|
|
@@ -49141,7 +50190,7 @@ declare module "sap/ui/model/Context" {
|
|
|
49141
50190
|
*/
|
|
49142
50191
|
export default class Context extends BaseObject {
|
|
49143
50192
|
/**
|
|
49144
|
-
* Constructor for Context class.
|
|
50193
|
+
* Constructor for Context class. The constructor must only be called by model-internal methods.
|
|
49145
50194
|
*/
|
|
49146
50195
|
constructor(
|
|
49147
50196
|
/**
|
|
@@ -49662,7 +50711,8 @@ declare module "sap/ui/model/Filter" {
|
|
|
49662
50711
|
*/
|
|
49663
50712
|
vOperator?:
|
|
49664
50713
|
| (FilterOperator | keyof typeof FilterOperator)
|
|
49665
|
-
|
|
|
50714
|
+
| boolean
|
|
50715
|
+
| ((p1: any) => boolean),
|
|
49666
50716
|
/**
|
|
49667
50717
|
* First value to use with the given filter operator
|
|
49668
50718
|
*/
|
|
@@ -50809,8 +51859,6 @@ declare module "sap/ui/model/ListBinding" {
|
|
|
50809
51859
|
declare module "sap/ui/model/message/MessageModel" {
|
|
50810
51860
|
import ClientModel from "sap/ui/model/ClientModel";
|
|
50811
51861
|
|
|
50812
|
-
import MessageManager from "sap/ui/core/message/MessageManager";
|
|
50813
|
-
|
|
50814
51862
|
import Metadata from "sap/ui/base/Metadata";
|
|
50815
51863
|
|
|
50816
51864
|
import Context from "sap/ui/model/Context";
|
|
@@ -50824,12 +51872,7 @@ declare module "sap/ui/model/message/MessageModel" {
|
|
|
50824
51872
|
/**
|
|
50825
51873
|
* Constructor for a new JSONModel.
|
|
50826
51874
|
*/
|
|
50827
|
-
constructor(
|
|
50828
|
-
/**
|
|
50829
|
-
* The MessageManager instance
|
|
50830
|
-
*/
|
|
50831
|
-
oMessageManager: MessageManager
|
|
50832
|
-
);
|
|
51875
|
+
constructor();
|
|
50833
51876
|
|
|
50834
51877
|
/**
|
|
50835
51878
|
* Creates a new subclass of class sap.ui.model.message.MessageModel with name `sClassName` and enriches
|
|
@@ -52737,6 +53780,8 @@ declare module "sap/ui/model/odata/ODataListBinding" {
|
|
|
52737
53780
|
|
|
52738
53781
|
import FilterType from "sap/ui/model/FilterType";
|
|
52739
53782
|
|
|
53783
|
+
import Context1 from "sap/ui/model/odata/v2/Context";
|
|
53784
|
+
|
|
52740
53785
|
import Metadata from "sap/ui/base/Metadata";
|
|
52741
53786
|
|
|
52742
53787
|
import Sorter from "sap/ui/model/Sorter";
|
|
@@ -52844,6 +53889,17 @@ declare module "sap/ui/model/odata/ODataListBinding" {
|
|
|
52844
53889
|
*/
|
|
52845
53890
|
bReturnSuccess?: boolean
|
|
52846
53891
|
): this;
|
|
53892
|
+
/**
|
|
53893
|
+
* @since 1.98.0
|
|
53894
|
+
*
|
|
53895
|
+
* Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
|
|
53896
|
+
* this method does not request any data from a back end and does not change the binding's state. In contrast
|
|
53897
|
+
* to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
|
|
53898
|
+
* control, but all contexts that are currently available in the binding.
|
|
53899
|
+
*
|
|
53900
|
+
* @returns All current contexts of this list binding, in no special order
|
|
53901
|
+
*/
|
|
53902
|
+
getAllCurrentContexts(): Context1[];
|
|
52847
53903
|
/**
|
|
52848
53904
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
52849
53905
|
*
|
|
@@ -57171,8 +58227,6 @@ declare module "sap/ui/model/odata/type/DateTimeWithTimezone" {
|
|
|
57171
58227
|
*/
|
|
57172
58228
|
getPartsIgnoringMessages(): number[];
|
|
57173
58229
|
/**
|
|
57174
|
-
* @experimental (since 1.114.0)
|
|
57175
|
-
*
|
|
57176
58230
|
* Returns a language-dependent placeholder text such as "e.g. " where is formatted
|
|
57177
58231
|
* using this type.
|
|
57178
58232
|
*
|
|
@@ -58159,8 +59213,6 @@ declare module "sap/ui/model/odata/type/ODataType" {
|
|
|
58159
59213
|
*/
|
|
58160
59214
|
static getMetadata(): Metadata;
|
|
58161
59215
|
/**
|
|
58162
|
-
* @experimental (since 1.114.0)
|
|
58163
|
-
*
|
|
58164
59216
|
* Returns a language-dependent placeholder text such as "e.g. " where is formatted
|
|
58165
59217
|
* using this type.
|
|
58166
59218
|
*
|
|
@@ -60827,9 +61879,12 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
60827
61879
|
*/
|
|
60828
61880
|
serviceUrlParams?: Record<string, string>;
|
|
60829
61881
|
/**
|
|
60830
|
-
* Enable/disable security token handling
|
|
61882
|
+
* Enable/disable security token handling. If the "skipServerCache" string value is provided, the security
|
|
61883
|
+
* token is not cached with the server as key in order to avoid failing $batch requests when accessing services
|
|
61884
|
+
* running on different back-end systems behind a reverse proxy (since 1.119).
|
|
61885
|
+
* Use this option only if the system landscape is known.
|
|
60831
61886
|
*/
|
|
60832
|
-
tokenHandling?: boolean;
|
|
61887
|
+
tokenHandling?: boolean | "skipServerCache";
|
|
60833
61888
|
/**
|
|
60834
61889
|
* Send security token for GET requests in case read access logging is activated for the OData Service in
|
|
60835
61890
|
* the backend.
|
|
@@ -62481,13 +63536,14 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
62481
63536
|
*/
|
|
62482
63537
|
getRefreshAfterChange(): boolean;
|
|
62483
63538
|
/**
|
|
62484
|
-
*
|
|
63539
|
+
* @deprecated (since 1.119.0) - use {@link #securityTokenAvailable} instead
|
|
62485
63540
|
*
|
|
62486
|
-
*
|
|
63541
|
+
* Returns the current security token if available; triggers a request to fetch the security token if it
|
|
63542
|
+
* is not available.
|
|
62487
63543
|
*
|
|
62488
|
-
* @returns The security token
|
|
63544
|
+
* @returns The security token; `undefined` if it is not available
|
|
62489
63545
|
*/
|
|
62490
|
-
getSecurityToken(): string;
|
|
63546
|
+
getSecurityToken(): string | undefined;
|
|
62491
63547
|
/**
|
|
62492
63548
|
* Return the annotation object. Please note that the metadata is loaded asynchronously and this function
|
|
62493
63549
|
* might return undefined because the metadata has not been loaded yet. In this case attach to the `annotationsLoaded`
|
|
@@ -64325,6 +65381,11 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
64325
65381
|
|
|
64326
65382
|
import Metadata from "sap/ui/base/Metadata";
|
|
64327
65383
|
|
|
65384
|
+
import {
|
|
65385
|
+
NavigationPropertyPathExpression,
|
|
65386
|
+
PropertyPathExpression,
|
|
65387
|
+
} from "sap/ui/model/odata/v4/ts";
|
|
65388
|
+
|
|
64328
65389
|
/**
|
|
64329
65390
|
* @since 1.39.0
|
|
64330
65391
|
*
|
|
@@ -64429,6 +65490,11 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
64429
65490
|
* `delete`, and to possibly rebind it after reset or failure. The model itself ensures that all bindings
|
|
64430
65491
|
* depending on this context become unresolved, but no attempt is made to restore these bindings in case
|
|
64431
65492
|
* of reset or failure.
|
|
65493
|
+
*
|
|
65494
|
+
* Deleting a child node is supported (@experimental as of version 1.118.0) in a recursive hierarchy (see
|
|
65495
|
+
* {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}). As a precondition, `oAggregation.expandTo`
|
|
65496
|
+
* must be equal to one, and the context must not be {@link #setKeepAlive kept-alive} and hidden (for example
|
|
65497
|
+
* due to a filter).
|
|
64432
65498
|
* See:
|
|
64433
65499
|
* #hasPendingChanges
|
|
64434
65500
|
* #resetChanges
|
|
@@ -64678,6 +65744,31 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
64678
65744
|
* `undefined` if it is not created using {@link sap.ui.model.odata.v4.ODataListBinding#create}
|
|
64679
65745
|
*/
|
|
64680
65746
|
isTransient(): boolean | undefined;
|
|
65747
|
+
/**
|
|
65748
|
+
* @experimental (since 1.119.0)
|
|
65749
|
+
*
|
|
65750
|
+
* Moves this node to the given parent (in case of a recursive hierarchy, see {@link #setAggregation}, where
|
|
65751
|
+
* `oAggregation.expandTo` must be one). No other {@link sap.ui.model.odata.v4.ODataListBinding#create creation},
|
|
65752
|
+
* {@link #delete deletion}, or move must be pending, and no other modification (including collapse of some
|
|
65753
|
+
* ancestor node) must happen while this move is pending!
|
|
65754
|
+
*
|
|
65755
|
+
* This context's {@link #getIndex index} may change and it becomes "created persisted", with {@link #isTransient }
|
|
65756
|
+
* returning `false` etc.
|
|
65757
|
+
*
|
|
65758
|
+
* @returns A promise which is resolved without a defined result when the move is finished, or rejected
|
|
65759
|
+
* in case of an error
|
|
65760
|
+
*/
|
|
65761
|
+
move(
|
|
65762
|
+
/**
|
|
65763
|
+
* A parameter object
|
|
65764
|
+
*/
|
|
65765
|
+
oParameters: {
|
|
65766
|
+
/**
|
|
65767
|
+
* The new parent's context
|
|
65768
|
+
*/
|
|
65769
|
+
parent: Context;
|
|
65770
|
+
}
|
|
65771
|
+
): Promise<void>;
|
|
64681
65772
|
/**
|
|
64682
65773
|
* @since 1.53.0
|
|
64683
65774
|
*
|
|
@@ -64825,8 +65916,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
64825
65916
|
* ID has submit mode {@link sap.ui.model.odata.v4.SubmitMode.Auto} and there are currently running updates
|
|
64826
65917
|
* or creates this method first waits for them to be processed.
|
|
64827
65918
|
*
|
|
64828
|
-
* The
|
|
64829
|
-
* attached to...
|
|
65919
|
+
* The 'dataRequested' and 'dataReceived' events are not fired unless a binding is refreshed completely.
|
|
65920
|
+
* Whatever should happen in the event handler attached to...
|
|
64830
65921
|
* 'dataRequested', can instead be done before calling {@link #requestSideEffects}. 'dataReceived',
|
|
64831
65922
|
* can instead be done once the `oPromise` returned by {@link #requestSideEffects} fulfills or rejects (using
|
|
64832
65923
|
* `oPromise.then(function () {...}, function () {...})`).
|
|
@@ -64865,7 +65956,9 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
64865
65956
|
* if it has not yet been requested by that list binding. This way, exactly the messages for a single row
|
|
64866
65957
|
* can be updated. Same for a "*" segment or an empty navigation property path.
|
|
64867
65958
|
*/
|
|
64868
|
-
aPathExpressions:
|
|
65959
|
+
aPathExpressions: Array<
|
|
65960
|
+
NavigationPropertyPathExpression | PropertyPathExpression | string
|
|
65961
|
+
>,
|
|
64869
65962
|
/**
|
|
64870
65963
|
* The group ID to be used (since 1.69.0); if not specified, the update group ID for the context's binding
|
|
64871
65964
|
* is used, see {@link #getUpdateGroupId}. If a different group ID is specified, make sure that {@link #requestSideEffects }
|
|
@@ -64912,10 +66005,13 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
64912
66005
|
*/
|
|
64913
66006
|
bKeepAlive: boolean,
|
|
64914
66007
|
/**
|
|
64915
|
-
* Callback function that is executed once for a kept-alive context
|
|
64916
|
-
*
|
|
66008
|
+
* Callback function that is executed once for a kept-alive context without any argument just before the
|
|
66009
|
+
* context is destroyed; see {@link #destroy}. If a context has been replaced in a list binding (see {@link #replaceWith }
|
|
66010
|
+
* and {@link sap.ui.odata.v4.ODataContextBinding#execute}), the callback will later also be called just
|
|
66011
|
+
* before the replacing context is destroyed, but with that context as the only argument. Supported since
|
|
66012
|
+
* 1.84.0
|
|
64917
66013
|
*/
|
|
64918
|
-
fnOnBeforeDestroy?:
|
|
66014
|
+
fnOnBeforeDestroy?: (p1: Context | undefined) => void,
|
|
64919
66015
|
/**
|
|
64920
66016
|
* Whether to request messages for this entity. Only used if `bKeepAlive` is `true`. Determines the messages
|
|
64921
66017
|
* property from the annotation "com.sap.vocabularies.Common.v1.Messages" at the entity type. If found,
|
|
@@ -65015,6 +66111,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
65015
66111
|
declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
65016
66112
|
import ContextBinding from "sap/ui/model/ContextBinding";
|
|
65017
66113
|
|
|
66114
|
+
import Message from "sap/ui/core/message/Message";
|
|
66115
|
+
|
|
65018
66116
|
import Context from "sap/ui/model/odata/v4/Context";
|
|
65019
66117
|
|
|
65020
66118
|
import Metadata from "sap/ui/base/Metadata";
|
|
@@ -65239,13 +66337,21 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
65239
66337
|
* also rejected if `bReplaceWithRVC` is supplied, and there is no return value context at all or the existing
|
|
65240
66338
|
* context as described above is currently part of the list's collection (that is, has an index).
|
|
65241
66339
|
* A return value context is an {@link sap.ui.model.odata.v4.Context} which represents a bound operation
|
|
65242
|
-
* response. It is created only if the operation is bound and
|
|
65243
|
-
* same entity set as the operation's binding
|
|
65244
|
-
*
|
|
65245
|
-
*
|
|
66340
|
+
* response. It is created only if the operation is bound and these conditions apply:
|
|
66341
|
+
* The operation has a single entity return value from the same entity set as the operation's binding
|
|
66342
|
+
* parameter. It has a parent context which is an {@link sap.ui.model.odata.v4.Context} and points
|
|
66343
|
+
* to (an entity from) an entity set. The path of the parent context must not contain a navigation property
|
|
66344
|
+
* (but see last paragraph). **Note:** A return value context is destroyed the next time the operation
|
|
66345
|
+
* binding is executed again.
|
|
65246
66346
|
* If a return value context is created, it must be used instead of `this.getBoundContext()`. All bound
|
|
65247
66347
|
* messages will be related to the return value context only. Such a message can only be connected to a
|
|
65248
66348
|
* corresponding control if the control's property bindings use the return value context as binding context.
|
|
66349
|
+
*
|
|
66350
|
+
* A return value context may also be provided if the parent context's path contains a maximum of one navigation
|
|
66351
|
+
* property. In addition to the existing preconditions for a return value context, the metadata has to specify
|
|
66352
|
+
* a partner attribute for the navigation property and the partner relationship has to be bi-directional.
|
|
66353
|
+
* Also the navigation property binding has to be available in the entity set of the first segment in the
|
|
66354
|
+
* parent context's path (@experimental as of version 1.119.0).
|
|
65249
66355
|
*/
|
|
65250
66356
|
execute(
|
|
65251
66357
|
/**
|
|
@@ -65268,7 +66374,7 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
65268
66374
|
* the bound action should either be repeated **without** applying the preference or rejected with an `Error`
|
|
65269
66375
|
* instance `oError` where `oError.canceled === true`. Since 1.92.0.
|
|
65270
66376
|
*/
|
|
65271
|
-
fnOnStrictHandlingFailed?:
|
|
66377
|
+
fnOnStrictHandlingFailed?: (p1: Message[]) => Promise<boolean>,
|
|
65272
66378
|
/**
|
|
65273
66379
|
* Whether this operation binding's parent context, which must belong to a list binding, is replaced with
|
|
65274
66380
|
* the operation's return value context (see below) and that list context is returned instead. That list
|
|
@@ -65812,12 +66918,10 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
65812
66918
|
* `created` promises of all nested contexts are always rejected with an instance of `Error`, even if the
|
|
65813
66919
|
* deep create succeeds. This error always has the property `canceled` with the value `true`.
|
|
65814
66920
|
*
|
|
65815
|
-
* Since 1.
|
|
66921
|
+
* Since 1.118.0 deep create also supports single-valued navigation properties; no API call is required
|
|
65816
66922
|
* in this case. Simply bind properties of the related entity relative to a transient context. An update
|
|
65817
66923
|
* to the property adds it to the POST request of the parent entity, and by this the create becomes deep.
|
|
65818
66924
|
*
|
|
65819
|
-
* **Note**: Deep create for single-valued navigation properties is **experimental**.
|
|
65820
|
-
*
|
|
65821
66925
|
* Deep create requires the `autoExpandSelect` parameter at the {@link sap.ui.model.odata.v4.ODataModel#constructor model}.
|
|
65822
66926
|
* The refresh after a deep create is optimized. Only the (navigation) properties missing from the POST
|
|
65823
66927
|
* response are actually requested. If the POST response contains all required properties, no request is
|
|
@@ -65833,8 +66937,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
65833
66937
|
* (see {@link #setAggregation}). The parent node must be identified via a {@link sap.ui.model.odata.v4.Context }
|
|
65834
66938
|
* instance given as `oInitialData["@$ui5.node.parent"]`. `oAggregation.expandTo` (see {@link #setAggregation})
|
|
65835
66939
|
* must be one, `bSkipRefresh` must be set, but both `bAtEnd` and `bInactive` must not be set. No other
|
|
65836
|
-
* creation must be pending, and no other modification
|
|
65837
|
-
* while this creation is pending!
|
|
66940
|
+
* creation or {@link sap.ui.model.odata.v4.Context#move move} must be pending, and no other modification
|
|
66941
|
+
* (including collapse of some ancestor node) must happen while this creation is pending!
|
|
65838
66942
|
*
|
|
65839
66943
|
* @returns The context object for the created entity; its method {@link sap.ui.model.odata.v4.Context#created }
|
|
65840
66944
|
* returns a promise that is resolved when the creation is finished
|
|
@@ -65843,7 +66947,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
65843
66947
|
/**
|
|
65844
66948
|
* The initial data for the created entity
|
|
65845
66949
|
*/
|
|
65846
|
-
oInitialData?:
|
|
66950
|
+
oInitialData?: Record<string, any>,
|
|
65847
66951
|
/**
|
|
65848
66952
|
* Whether an automatic refresh of the created entity will be skipped.
|
|
65849
66953
|
* **Note:** Do not use this parameter for a deep create. It leads to multiple single row requests if the
|
|
@@ -65887,7 +66991,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
65887
66991
|
/**
|
|
65888
66992
|
* The function to call when the event occurs
|
|
65889
66993
|
*/
|
|
65890
|
-
fnFunction:
|
|
66994
|
+
fnFunction: (evt: ODataListBinding$CreateActivateEvent) => void,
|
|
65891
66995
|
/**
|
|
65892
66996
|
* Object on which to call the given function
|
|
65893
66997
|
*/
|
|
@@ -66023,8 +67127,10 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
66023
67127
|
* identified via the `hierarchyQualifier` given to {@link #setAggregation}.
|
|
66024
67128
|
* "$DistanceFromRootProperty" holds the path to the property which provides the raw value for "@$ui5.node.level"
|
|
66025
67129
|
* (minus one) and should be used only to interpret the response retrieved via {@link #getDownloadUrl}.
|
|
66026
|
-
* "$
|
|
66027
|
-
*
|
|
67130
|
+
* "$DrillStateProperty" holds the path to the property which provides the raw value for "@$ui5.node.isExpanded"
|
|
67131
|
+
* and should be used only to interpret the response retrieved via {@link #getDownloadUrl}. "$NodeProperty"
|
|
67132
|
+
* holds the path to the property which provides the hierarchy node value. That property is always $select'ed
|
|
67133
|
+
* automatically and can be accessed as usual.
|
|
66028
67134
|
*/
|
|
66029
67135
|
bVerbose?: boolean
|
|
66030
67136
|
): object | undefined;
|
|
@@ -66220,7 +67326,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
66220
67326
|
* Whether system query options should be returned as well. The parameter value `true` is not supported.
|
|
66221
67327
|
*/
|
|
66222
67328
|
bWithSystemQueryOptions?: boolean
|
|
66223
|
-
):
|
|
67329
|
+
): Record<string, any>;
|
|
66224
67330
|
/**
|
|
66225
67331
|
* @since 1.53.0
|
|
66226
67332
|
*
|
|
@@ -66672,7 +67778,20 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
66672
67778
|
*/
|
|
66673
67779
|
as?: string;
|
|
66674
67780
|
}>
|
|
66675
|
-
):
|
|
67781
|
+
):
|
|
67782
|
+
| {
|
|
67783
|
+
measureRangePromise: Promise<
|
|
67784
|
+
Record<
|
|
67785
|
+
string,
|
|
67786
|
+
{
|
|
67787
|
+
min: number;
|
|
67788
|
+
|
|
67789
|
+
max: number;
|
|
67790
|
+
}
|
|
67791
|
+
>
|
|
67792
|
+
>;
|
|
67793
|
+
}
|
|
67794
|
+
| undefined;
|
|
66676
67795
|
}
|
|
66677
67796
|
|
|
66678
67797
|
export interface ODataListBinding$ChangeEventParameters
|
|
@@ -66690,7 +67809,12 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
66690
67809
|
ODataListBinding
|
|
66691
67810
|
>;
|
|
66692
67811
|
|
|
66693
|
-
export interface ODataListBinding$CreateActivateEventParameters {
|
|
67812
|
+
export interface ODataListBinding$CreateActivateEventParameters {
|
|
67813
|
+
/**
|
|
67814
|
+
* The affected context
|
|
67815
|
+
*/
|
|
67816
|
+
context?: Context;
|
|
67817
|
+
}
|
|
66694
67818
|
|
|
66695
67819
|
export type ODataListBinding$CreateActivateEvent = Event<
|
|
66696
67820
|
ODataListBinding$CreateActivateEventParameters,
|
|
@@ -68185,7 +69309,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
68185
69309
|
/**
|
|
68186
69310
|
* Map of HTTP header names to their values
|
|
68187
69311
|
*/
|
|
68188
|
-
mHeaders?:
|
|
69312
|
+
mHeaders?: Record<string, string | undefined>
|
|
68189
69313
|
): void;
|
|
68190
69314
|
/**
|
|
68191
69315
|
* @since 1.37.0
|
|
@@ -68362,7 +69486,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
68362
69486
|
* Whether to include the "SAP-ContextId" header (@since 1.86.0)
|
|
68363
69487
|
*/
|
|
68364
69488
|
bIncludeContextId?: boolean
|
|
68365
|
-
):
|
|
69489
|
+
): Record<string, string>;
|
|
68366
69490
|
/**
|
|
68367
69491
|
* @since 1.99.0
|
|
68368
69492
|
*
|
|
@@ -69242,6 +70366,49 @@ declare module "sap/ui/model/odata/v4/SubmitMode" {
|
|
|
69242
70366
|
export default SubmitMode;
|
|
69243
70367
|
}
|
|
69244
70368
|
|
|
70369
|
+
declare module "sap/ui/model/odata/v4/ts" {
|
|
70370
|
+
/**
|
|
70371
|
+
* @since 1.118.0
|
|
70372
|
+
*
|
|
70373
|
+
* Namespace for TypeScript type definitions of the OData V4 model.
|
|
70374
|
+
*/
|
|
70375
|
+
interface ts {}
|
|
70376
|
+
const ts: ts;
|
|
70377
|
+
export default ts;
|
|
70378
|
+
|
|
70379
|
+
/**
|
|
70380
|
+
* @since 1.118.0
|
|
70381
|
+
*
|
|
70382
|
+
* An object representing a "14.5.11 Expression edm:NavigationPropertyPath". Its shape corresponds exactly
|
|
70383
|
+
* to the shape of such an expression in the {@link https://ui5.sap.com/#/topic/87aac894a40640f89920d7b2a414499b OData V4 Metadata JSON Format }
|
|
70384
|
+
* as returned by {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject}.
|
|
70385
|
+
* See:
|
|
70386
|
+
* {@link sap.ui.model.odata.v4.Context#requestSideEffects}
|
|
70387
|
+
*/
|
|
70388
|
+
export type NavigationPropertyPathExpression = {
|
|
70389
|
+
/**
|
|
70390
|
+
* A value of type `Edm.NavigationPropertyPath`.
|
|
70391
|
+
*/
|
|
70392
|
+
$NavigationPropertyPath: string;
|
|
70393
|
+
};
|
|
70394
|
+
|
|
70395
|
+
/**
|
|
70396
|
+
* @since 1.118.0
|
|
70397
|
+
*
|
|
70398
|
+
* An object representing a "14.5.13 Expression edm:PropertyPath". Its shape corresponds exactly to the
|
|
70399
|
+
* shape of such an expression in the {@link https://ui5.sap.com/#/topic/87aac894a40640f89920d7b2a414499b OData V4 Metadata JSON Format }
|
|
70400
|
+
* as returned by {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject}.
|
|
70401
|
+
* See:
|
|
70402
|
+
* {@link sap.ui.model.odata.v4.Context#requestSideEffects}
|
|
70403
|
+
*/
|
|
70404
|
+
export type PropertyPathExpression = {
|
|
70405
|
+
/**
|
|
70406
|
+
* A value of type `Edm.PropertyPath`.
|
|
70407
|
+
*/
|
|
70408
|
+
$PropertyPath: string;
|
|
70409
|
+
};
|
|
70410
|
+
}
|
|
70411
|
+
|
|
69245
70412
|
declare module "sap/ui/model/odata/v4/ValueListType" {
|
|
69246
70413
|
/**
|
|
69247
70414
|
* @since 1.45.0
|
|
@@ -71131,8 +72298,6 @@ declare module "sap/ui/model/type/Date" {
|
|
|
71131
72298
|
*/
|
|
71132
72299
|
getOutputPattern(): string;
|
|
71133
72300
|
/**
|
|
71134
|
-
* @experimental (since 1.114.0)
|
|
71135
|
-
*
|
|
71136
72301
|
* Returns a language-dependent placeholder text such as "e.g. " where is formatted
|
|
71137
72302
|
* using this type.
|
|
71138
72303
|
*
|
|
@@ -71268,8 +72433,6 @@ declare module "sap/ui/model/type/DateInterval" {
|
|
|
71268
72433
|
sTargetType: string
|
|
71269
72434
|
): string;
|
|
71270
72435
|
/**
|
|
71271
|
-
* @experimental (since 1.114.0)
|
|
71272
|
-
*
|
|
71273
72436
|
* Returns a language-dependent placeholder text such as "e.g. " where is formatted
|
|
71274
72437
|
* using this type.
|
|
71275
72438
|
*
|
|
@@ -71279,8 +72442,8 @@ declare module "sap/ui/model/type/DateInterval" {
|
|
|
71279
72442
|
/**
|
|
71280
72443
|
* Parses the given value to an array of two values representing the start date and the end date of the
|
|
71281
72444
|
* 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
|
-
*
|
|
72445
|
+
* (23:59:59). If the `singleIntervalValue` format option is used, the second entry is `null` if no end
|
|
72446
|
+
* date is given.
|
|
71284
72447
|
*
|
|
71285
72448
|
* @returns The start and the end date of the interval. The resulting values in the array are:
|
|
71286
72449
|
* - Two `Date` or `module:sap/ui/core/date/UI5Date` objects, or
|
|
@@ -78520,7 +79683,7 @@ declare namespace sap {
|
|
|
78520
79683
|
*/
|
|
78521
79684
|
manifestFirst?: boolean;
|
|
78522
79685
|
/**
|
|
78523
|
-
* If set to `true` validation of the component is handled by the `
|
|
79686
|
+
* If set to `true` validation of the component is handled by the `Messaging`
|
|
78524
79687
|
*/
|
|
78525
79688
|
handleValidation?: string;
|
|
78526
79689
|
}
|
|
@@ -79624,6 +80787,9 @@ declare namespace sap {
|
|
|
79624
80787
|
| import("sap/ui/core/Control").default
|
|
79625
80788
|
| Array<import("sap/ui/core/Control").default>;
|
|
79626
80789
|
/**
|
|
80790
|
+
* @deprecated (since 1.118) - Please require 'sap/ui/core/Core' instead and use the module export directly
|
|
80791
|
+
* without using 'new'."
|
|
80792
|
+
*
|
|
79627
80793
|
* Retrieve the {@link sap.ui.core.Core SAPUI5 Core} instance for the current window.
|
|
79628
80794
|
*
|
|
79629
80795
|
* @returns the API of the current SAPUI5 Core instance.
|
|
@@ -81409,6 +82575,8 @@ declare namespace sap {
|
|
|
81409
82575
|
|
|
81410
82576
|
"sap/ui/core/Fragment": undefined;
|
|
81411
82577
|
|
|
82578
|
+
"sap/ui/core/getCompatibilityVersion": undefined;
|
|
82579
|
+
|
|
81412
82580
|
"sap/ui/core/History": undefined;
|
|
81413
82581
|
|
|
81414
82582
|
"sap/ui/core/HTML": undefined;
|
|
@@ -81461,6 +82629,10 @@ declare namespace sap {
|
|
|
81461
82629
|
|
|
81462
82630
|
"sap/ui/core/message/MessageProcessor": undefined;
|
|
81463
82631
|
|
|
82632
|
+
"sap/ui/core/message/MessageType": undefined;
|
|
82633
|
+
|
|
82634
|
+
"sap/ui/core/Messaging": undefined;
|
|
82635
|
+
|
|
81464
82636
|
"sap/ui/core/mvc/Controller": undefined;
|
|
81465
82637
|
|
|
81466
82638
|
"sap/ui/core/mvc/ControllerExtension": undefined;
|
|
@@ -81609,6 +82781,10 @@ declare namespace sap {
|
|
|
81609
82781
|
|
|
81610
82782
|
"sap/ui/core/VariantLayoutData": undefined;
|
|
81611
82783
|
|
|
82784
|
+
"sap/ui/core/webc/WebComponent": undefined;
|
|
82785
|
+
|
|
82786
|
+
"sap/ui/core/webc/WebComponentMetadata": undefined;
|
|
82787
|
+
|
|
81612
82788
|
"sap/ui/core/ws/ReadyState": undefined;
|
|
81613
82789
|
|
|
81614
82790
|
"sap/ui/core/ws/SapPcpWebSocket": undefined;
|
|
@@ -81863,6 +83039,8 @@ declare namespace sap {
|
|
|
81863
83039
|
|
|
81864
83040
|
"sap/ui/model/odata/v4/SubmitMode": undefined;
|
|
81865
83041
|
|
|
83042
|
+
"sap/ui/model/odata/v4/ts": undefined;
|
|
83043
|
+
|
|
81866
83044
|
"sap/ui/model/odata/v4/ValueListType": undefined;
|
|
81867
83045
|
|
|
81868
83046
|
"sap/ui/model/ParseException": undefined;
|