@openui5/types 1.119.1 → 1.120.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 +2 -2
- package/types/sap.m.d.ts +5723 -155
- package/types/sap.tnt.d.ts +45 -2
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +1744 -143
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +14 -4
- package/types/sap.ui.integration.d.ts +1 -1
- package/types/sap.ui.layout.d.ts +125 -102
- package/types/sap.ui.mdc.d.ts +2142 -1439
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +7 -1
- package/types/sap.ui.table.d.ts +121 -47
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +454 -136
- package/types/sap.ui.webc.main.d.ts +3737 -1084
- package/types/sap.uxap.d.ts +1 -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.120.0
|
|
284
284
|
|
|
285
285
|
declare module "sap/base/assert" {
|
|
286
286
|
/**
|
|
@@ -304,6 +304,1007 @@ declare module "sap/base/assert" {
|
|
|
304
304
|
): void;
|
|
305
305
|
}
|
|
306
306
|
|
|
307
|
+
declare module "sap/base/i18n/date/CalendarType" {
|
|
308
|
+
/**
|
|
309
|
+
* @since 1.120
|
|
310
|
+
*
|
|
311
|
+
* The types of `Calendar`.
|
|
312
|
+
*/
|
|
313
|
+
enum CalendarType {
|
|
314
|
+
/**
|
|
315
|
+
* The Thai buddhist calendar
|
|
316
|
+
*/
|
|
317
|
+
Buddhist = "Buddhist",
|
|
318
|
+
/**
|
|
319
|
+
* The Gregorian calendar
|
|
320
|
+
*/
|
|
321
|
+
Gregorian = "Gregorian",
|
|
322
|
+
/**
|
|
323
|
+
* The Islamic calendar
|
|
324
|
+
*/
|
|
325
|
+
Islamic = "Islamic",
|
|
326
|
+
/**
|
|
327
|
+
* The Japanese emperor calendar
|
|
328
|
+
*/
|
|
329
|
+
Japanese = "Japanese",
|
|
330
|
+
/**
|
|
331
|
+
* The Persian Jalali calendar
|
|
332
|
+
*/
|
|
333
|
+
Persian = "Persian",
|
|
334
|
+
}
|
|
335
|
+
export default CalendarType;
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
declare module "sap/base/i18n/date/CalendarWeekNumbering" {
|
|
339
|
+
/**
|
|
340
|
+
* @since 1.120
|
|
341
|
+
*
|
|
342
|
+
* The `CalendarWeekNumbering` enum defines how to calculate calendar weeks. Each value defines:
|
|
343
|
+
* - The first day of the week,
|
|
344
|
+
* - the first week of the year.
|
|
345
|
+
*/
|
|
346
|
+
enum CalendarWeekNumbering {
|
|
347
|
+
/**
|
|
348
|
+
* The default calendar week numbering:
|
|
349
|
+
*
|
|
350
|
+
* The framework determines the week numbering scheme; currently it is derived from the active format locale.
|
|
351
|
+
* Future versions of UI5 might select a different week numbering scheme.
|
|
352
|
+
*/
|
|
353
|
+
Default = "Default",
|
|
354
|
+
/**
|
|
355
|
+
* Official calendar week numbering in most of Europe (ISO 8601 standard):
|
|
356
|
+
* Monday is first day of the week, the week containing January 4th is first week of the year.
|
|
357
|
+
*/
|
|
358
|
+
ISO_8601 = "ISO_8601",
|
|
359
|
+
/**
|
|
360
|
+
* Official calendar week numbering in much of the Middle East (Middle Eastern calendar):
|
|
361
|
+
* Saturday is first day of the week, the week containing January 1st is first week of the year.
|
|
362
|
+
*/
|
|
363
|
+
MiddleEastern = "MiddleEastern",
|
|
364
|
+
/**
|
|
365
|
+
* Official calendar week numbering in the United States, Canada, Brazil, Israel, Japan, and other countries
|
|
366
|
+
* (Western traditional calendar):
|
|
367
|
+
* Sunday is first day of the week, the week containing January 1st is first week of the year.
|
|
368
|
+
*/
|
|
369
|
+
WesternTraditional = "WesternTraditional",
|
|
370
|
+
}
|
|
371
|
+
export default CalendarWeekNumbering;
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
declare module "sap/base/i18n/Formatting" {
|
|
375
|
+
import CalendarType from "sap/base/i18n/date/CalendarType";
|
|
376
|
+
|
|
377
|
+
import CalendarWeekNumbering from "sap/base/i18n/date/CalendarWeekNumbering";
|
|
378
|
+
|
|
379
|
+
import LanguageTag from "sap/base/i18n/LanguageTag";
|
|
380
|
+
|
|
381
|
+
/**
|
|
382
|
+
* @since 1.120
|
|
383
|
+
*
|
|
384
|
+
* Configuration for formatting specific parameters
|
|
385
|
+
*/
|
|
386
|
+
interface Formatting {
|
|
387
|
+
/**
|
|
388
|
+
* @since 1.120
|
|
389
|
+
*
|
|
390
|
+
* Adds custom currencies to the existing entries. E.g. ` { "KWD": {"digits": 3}, "TND" : {"digits": 3 }
|
|
391
|
+
* } `
|
|
392
|
+
* See:
|
|
393
|
+
* {@link module:sap/base/i18n/Formatting.setCustomCurrencies}
|
|
394
|
+
*/
|
|
395
|
+
addCustomCurrencies(
|
|
396
|
+
/**
|
|
397
|
+
* adds to the currency map
|
|
398
|
+
*/
|
|
399
|
+
mCurrencies: object
|
|
400
|
+
): void;
|
|
401
|
+
/**
|
|
402
|
+
* @since 1.120
|
|
403
|
+
*
|
|
404
|
+
* Attaches the `fnFunction` event handler to the {@link #event:change change} event of `module:sap/base/i18n/Formatting`.
|
|
405
|
+
*/
|
|
406
|
+
attachChange(
|
|
407
|
+
/**
|
|
408
|
+
* The function to be called when the event occurs
|
|
409
|
+
*/
|
|
410
|
+
fnFunction: (p1: Formatting$ChangeEvent) => void
|
|
411
|
+
): void;
|
|
412
|
+
/**
|
|
413
|
+
* @since 1.120
|
|
414
|
+
*
|
|
415
|
+
* Detaches event handler `fnFunction` from the {@link #event:change change} event of this `module:sap/base/i18n/Formatting`.
|
|
416
|
+
*/
|
|
417
|
+
detachChange(
|
|
418
|
+
/**
|
|
419
|
+
* Function to be called when the event occurs
|
|
420
|
+
*/
|
|
421
|
+
fnFunction: (p1: Formatting$ChangeEvent) => void
|
|
422
|
+
): void;
|
|
423
|
+
/**
|
|
424
|
+
* @since 1.120
|
|
425
|
+
*
|
|
426
|
+
* Returns the currently set ABAP date format (its id) or undefined if none has been set.
|
|
427
|
+
*
|
|
428
|
+
* @returns ID of the ABAP date format, if not set or set to `""`, `undefined` will be returned
|
|
429
|
+
*/
|
|
430
|
+
getABAPDateFormat():
|
|
431
|
+
| "1"
|
|
432
|
+
| "2"
|
|
433
|
+
| "3"
|
|
434
|
+
| "4"
|
|
435
|
+
| "5"
|
|
436
|
+
| "6"
|
|
437
|
+
| "7"
|
|
438
|
+
| "8"
|
|
439
|
+
| "9"
|
|
440
|
+
| "A"
|
|
441
|
+
| "B"
|
|
442
|
+
| "C"
|
|
443
|
+
| undefined;
|
|
444
|
+
/**
|
|
445
|
+
* @since 1.120
|
|
446
|
+
*
|
|
447
|
+
* Returns the currently set ABAP number format (its id) or undefined if none has been set.
|
|
448
|
+
*
|
|
449
|
+
* @returns ID of the ABAP number format, if not set or set to `""`, `undefined` will be returned
|
|
450
|
+
*/
|
|
451
|
+
getABAPNumberFormat(): " " | "X" | "Y" | undefined;
|
|
452
|
+
/**
|
|
453
|
+
* @since 1.120
|
|
454
|
+
*
|
|
455
|
+
* Returns the currently set ABAP time format (its id) or undefined if none has been set.
|
|
456
|
+
*
|
|
457
|
+
* @returns ID of the ABAP date format, if not set or set to `""`, `undefined` will be returned
|
|
458
|
+
*/
|
|
459
|
+
getABAPTimeFormat(): "0" | "1" | "2" | "3" | "4" | undefined;
|
|
460
|
+
/**
|
|
461
|
+
* @since 1.120
|
|
462
|
+
*
|
|
463
|
+
* Returns the calendar type which is being used in locale dependent functionality.
|
|
464
|
+
*
|
|
465
|
+
* When it's explicitly set by calling `setCalendarType`, the set calendar type is returned. Otherwise,
|
|
466
|
+
* the calendar type is determined by checking the format settings and current locale.
|
|
467
|
+
*
|
|
468
|
+
* @returns the current calendar type, e.g. `Gregorian`
|
|
469
|
+
*/
|
|
470
|
+
getCalendarType(): CalendarType | keyof typeof CalendarType;
|
|
471
|
+
/**
|
|
472
|
+
* @since 1.120
|
|
473
|
+
*
|
|
474
|
+
* Returns the calendar week numbering algorithm used to determine the first day of the week and the first
|
|
475
|
+
* calendar week of the year, see {@link module:sap/base/i18n/data/CalendarWeekNumbering}.
|
|
476
|
+
*
|
|
477
|
+
* @returns The calendar week numbering algorithm
|
|
478
|
+
*/
|
|
479
|
+
getCalendarWeekNumbering():
|
|
480
|
+
| CalendarWeekNumbering
|
|
481
|
+
| keyof typeof CalendarWeekNumbering;
|
|
482
|
+
/**
|
|
483
|
+
* @since 1.120
|
|
484
|
+
*
|
|
485
|
+
* Retrieves the custom currencies. E.g. ` { "KWD": {"digits": 3}, "TND" : {"digits": 3} } `
|
|
486
|
+
* See:
|
|
487
|
+
* {@link module:sap/base/i18n/Formatting.setCustomCurrencies}
|
|
488
|
+
* {@link module:sap/base/i18n/Formatting.addCustomCurrencies}
|
|
489
|
+
*
|
|
490
|
+
* @returns the mapping between custom currencies and its digits
|
|
491
|
+
*/
|
|
492
|
+
getCustomCurrencies(): object;
|
|
493
|
+
/**
|
|
494
|
+
* @since 1.120
|
|
495
|
+
*
|
|
496
|
+
* Returns the currently set date pattern or undefined if no pattern has been defined.
|
|
497
|
+
*
|
|
498
|
+
* @returns The resulting date pattern
|
|
499
|
+
*/
|
|
500
|
+
getDatePattern(
|
|
501
|
+
/**
|
|
502
|
+
* The date style (short, medium, long or full)
|
|
503
|
+
*/
|
|
504
|
+
sStyle: "short" | "medium" | "long" | "full"
|
|
505
|
+
): string;
|
|
506
|
+
/**
|
|
507
|
+
* @since 1.120
|
|
508
|
+
*
|
|
509
|
+
* Returns the LanguageTag to be used for formatting.
|
|
510
|
+
*
|
|
511
|
+
* If no such LanguageTag has been defined, this method falls back to the language, see {@link module:sap/base/i18n/Localization.getLanguage Localization.getLanguage()}.
|
|
512
|
+
*
|
|
513
|
+
* If any user preferences for date, time or number formatting have been set, and if no format LanguageTag
|
|
514
|
+
* has been specified, then a special private use subtag is added to the LanguageTag, indicating to the
|
|
515
|
+
* framework that these user preferences should be applied.
|
|
516
|
+
*
|
|
517
|
+
* @returns the format LanguageTag
|
|
518
|
+
*/
|
|
519
|
+
getLanguageTag(): LanguageTag;
|
|
520
|
+
/**
|
|
521
|
+
* @since 1.120
|
|
522
|
+
*
|
|
523
|
+
* Returns the currently set customizing data for Islamic calendar support
|
|
524
|
+
*
|
|
525
|
+
* @returns Returns an array contains the customizing data. Each element in the array has properties: dateFormat,
|
|
526
|
+
* islamicMonthStart, gregDate. For details, please see {@link #setLegacyDateCalendarCustomizing}
|
|
527
|
+
*/
|
|
528
|
+
getLegacyDateCalendarCustomizing(): object[] | undefined;
|
|
529
|
+
/**
|
|
530
|
+
* @since 1.120
|
|
531
|
+
*
|
|
532
|
+
* Returns the currently set number symbol of the given type or undefined if no symbol has been defined.
|
|
533
|
+
*
|
|
534
|
+
* @returns A non-numerical symbol used as part of a number for the given type, e.g. for locale de_DE:
|
|
535
|
+
*
|
|
536
|
+
* - "group": "." (grouping separator)
|
|
537
|
+
* - "decimal": "," (decimal separator)
|
|
538
|
+
* - "plusSign": "+" (plus sign)
|
|
539
|
+
* - "minusSign": "-" (minus sign)
|
|
540
|
+
*/
|
|
541
|
+
getNumberSymbol(
|
|
542
|
+
/**
|
|
543
|
+
* the type of symbol
|
|
544
|
+
*/
|
|
545
|
+
sType: "group" | "decimal" | "plusSign" | "minusSign"
|
|
546
|
+
): string;
|
|
547
|
+
/**
|
|
548
|
+
* @since 1.120
|
|
549
|
+
*
|
|
550
|
+
* Returns the currently set time pattern or undefined if no pattern has been defined.
|
|
551
|
+
*
|
|
552
|
+
* @returns The resulting time pattern
|
|
553
|
+
*/
|
|
554
|
+
getTimePattern(
|
|
555
|
+
/**
|
|
556
|
+
* The time style (short, medium, long or full)
|
|
557
|
+
*/
|
|
558
|
+
sStyle: "short" | "medium" | "long" | "full"
|
|
559
|
+
): string;
|
|
560
|
+
/**
|
|
561
|
+
* @since 1.120
|
|
562
|
+
*
|
|
563
|
+
* Returns current trailingCurrencyCode configuration for new NumberFormatter instances
|
|
564
|
+
*
|
|
565
|
+
* @returns Whether currency codes shall always be placed after the numeric value
|
|
566
|
+
*/
|
|
567
|
+
getTrailingCurrencyCode(): boolean;
|
|
568
|
+
/**
|
|
569
|
+
* @since 1.120
|
|
570
|
+
*
|
|
571
|
+
* Allows to specify one of the ABAP date formats.
|
|
572
|
+
*
|
|
573
|
+
* This method modifies the date patterns for 'short' and 'medium' style with the corresponding ABAP format.
|
|
574
|
+
* When called with a null or undefined format id, any previously applied format will be removed.
|
|
575
|
+
*
|
|
576
|
+
* After changing the date format, the framework tries to update localization specific parts of the UI.
|
|
577
|
+
* See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
|
|
578
|
+
* for details and restrictions.
|
|
579
|
+
*/
|
|
580
|
+
setABAPDateFormat(
|
|
581
|
+
/**
|
|
582
|
+
* ID of the ABAP date format, `""` will reset the date patterns for 'short' and 'medium' style to the locale-specific
|
|
583
|
+
* ones.
|
|
584
|
+
*/
|
|
585
|
+
sFormatId?:
|
|
586
|
+
| ""
|
|
587
|
+
| "1"
|
|
588
|
+
| "2"
|
|
589
|
+
| "3"
|
|
590
|
+
| "4"
|
|
591
|
+
| "5"
|
|
592
|
+
| "6"
|
|
593
|
+
| "7"
|
|
594
|
+
| "8"
|
|
595
|
+
| "9"
|
|
596
|
+
| "A"
|
|
597
|
+
| "B"
|
|
598
|
+
| "C"
|
|
599
|
+
): void;
|
|
600
|
+
/**
|
|
601
|
+
* @since 1.120
|
|
602
|
+
*
|
|
603
|
+
* Allows to specify one of the ABAP number format.
|
|
604
|
+
*
|
|
605
|
+
* This method will modify the 'group' and 'decimal' symbols. When called with a null or undefined format
|
|
606
|
+
* id, any previously applied format will be removed.
|
|
607
|
+
*
|
|
608
|
+
* After changing the number format, the framework tries to update localization specific parts of the UI.
|
|
609
|
+
* See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
|
|
610
|
+
* for details and restrictions.
|
|
611
|
+
*/
|
|
612
|
+
setABAPNumberFormat(
|
|
613
|
+
/**
|
|
614
|
+
* ID of the ABAP number format set, `""` will reset the 'group' and 'decimal' symbols to the locale-specific
|
|
615
|
+
* ones.
|
|
616
|
+
*/
|
|
617
|
+
sFormatId?: "" | " " | "X" | "Y"
|
|
618
|
+
): void;
|
|
619
|
+
/**
|
|
620
|
+
* @since 1.120
|
|
621
|
+
*
|
|
622
|
+
* Allows to specify one of the ABAP time formats.
|
|
623
|
+
*
|
|
624
|
+
* This method sets the time patterns for 'short' and 'medium' style to the corresponding ABAP formats and
|
|
625
|
+
* sets the day period texts to "AM"/"PM" or "am"/"pm" respectively. When called with a null or undefined
|
|
626
|
+
* format id, any previously applied format will be removed.
|
|
627
|
+
*
|
|
628
|
+
* After changing the time format, the framework tries to update localization specific parts of the UI.
|
|
629
|
+
* See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
|
|
630
|
+
* for details and restrictions.
|
|
631
|
+
*/
|
|
632
|
+
setABAPTimeFormat(
|
|
633
|
+
/**
|
|
634
|
+
* ID of the ABAP time format, `""` will reset the time patterns for 'short' and 'medium' style and the
|
|
635
|
+
* day period texts to the locale-specific ones.
|
|
636
|
+
*/
|
|
637
|
+
sFormatId?: "" | "0" | "1" | "2" | "3" | "4"
|
|
638
|
+
): void;
|
|
639
|
+
/**
|
|
640
|
+
* @since 1.120
|
|
641
|
+
*
|
|
642
|
+
* Sets the new calendar type to be used from now on in locale dependent functionality (for example, formatting,
|
|
643
|
+
* translation texts, etc.).
|
|
644
|
+
*/
|
|
645
|
+
setCalendarType(
|
|
646
|
+
/**
|
|
647
|
+
* the new calendar type. Set it with null to clear the calendar type and the calendar type is calculated
|
|
648
|
+
* based on the format settings and current locale.
|
|
649
|
+
*/
|
|
650
|
+
sCalendarType: (CalendarType | keyof typeof CalendarType) | null
|
|
651
|
+
): void;
|
|
652
|
+
/**
|
|
653
|
+
* @since 1.120
|
|
654
|
+
*
|
|
655
|
+
* Sets the calendar week numbering algorithm which is used to determine the first day of the week and the
|
|
656
|
+
* first calendar week of the year, see {@link module:sap/base/i18n/date/CalendarWeekNumbering}.
|
|
657
|
+
*/
|
|
658
|
+
setCalendarWeekNumbering(
|
|
659
|
+
/**
|
|
660
|
+
* The calendar week numbering algorithm
|
|
661
|
+
*/
|
|
662
|
+
sCalendarWeekNumbering:
|
|
663
|
+
| CalendarWeekNumbering
|
|
664
|
+
| keyof typeof CalendarWeekNumbering
|
|
665
|
+
): void;
|
|
666
|
+
/**
|
|
667
|
+
* @since 1.120
|
|
668
|
+
*
|
|
669
|
+
* Sets custom currencies and replaces existing entries.
|
|
670
|
+
*
|
|
671
|
+
* There is a special currency code named "DEFAULT" that is optional. In case it is set it will be used
|
|
672
|
+
* for all currencies not contained in the list, otherwise currency digits as defined by the CLDR will be
|
|
673
|
+
* used as a fallback.
|
|
674
|
+
*
|
|
675
|
+
* Example: To use CLDR, but override single currencies ` { "KWD": {"digits": 3}, "TND" : {"digits": 3 }
|
|
676
|
+
* } `
|
|
677
|
+
*
|
|
678
|
+
* To replace the CLDR currency digits completely ` { "DEFAULT": {"digits": 2}, "ADP": {"digits": 0}, ...
|
|
679
|
+
* "XPF": {"digits": 0} } `
|
|
680
|
+
*
|
|
681
|
+
* Note: To unset the custom currencies: call with `undefined` Custom currencies must not only consist of
|
|
682
|
+
* digits but contain at least one non-digit character, e.g. "a", so that the measure part can be distinguished
|
|
683
|
+
* from the number part.
|
|
684
|
+
* See:
|
|
685
|
+
* {@link module:sap/base/i18n/Formatting.addCustomCurrencies}
|
|
686
|
+
*/
|
|
687
|
+
setCustomCurrencies(
|
|
688
|
+
/**
|
|
689
|
+
* currency map which is set
|
|
690
|
+
*/
|
|
691
|
+
mCurrencies: object
|
|
692
|
+
): void;
|
|
693
|
+
/**
|
|
694
|
+
* @since 1.120
|
|
695
|
+
*
|
|
696
|
+
* Defines the preferred format pattern for the given date format style.
|
|
697
|
+
*
|
|
698
|
+
* Calling this method with a null or undefined pattern removes a previously set pattern.
|
|
699
|
+
*
|
|
700
|
+
* If a pattern is defined, it will be preferred over patterns derived from the current locale.
|
|
701
|
+
*
|
|
702
|
+
* See class {@link sap.ui.core.format.DateFormat} for details about the pattern syntax.
|
|
703
|
+
*
|
|
704
|
+
* After changing the date pattern, the framework tries to update localization specific parts of the UI.
|
|
705
|
+
* See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
|
|
706
|
+
* for details and restrictions.
|
|
707
|
+
*/
|
|
708
|
+
setDatePattern(
|
|
709
|
+
/**
|
|
710
|
+
* must be one of short, medium, long or full.
|
|
711
|
+
*/
|
|
712
|
+
sStyle: "short" | "medium" | "long" | "full",
|
|
713
|
+
/**
|
|
714
|
+
* the format pattern to be used in LDML syntax.
|
|
715
|
+
*/
|
|
716
|
+
sPattern: string
|
|
717
|
+
): void;
|
|
718
|
+
/**
|
|
719
|
+
* @since 1.120
|
|
720
|
+
*
|
|
721
|
+
* Sets a new language tag to be used from now on for retrieving language specific formatters. Modifying
|
|
722
|
+
* this setting does not have an impact on the retrieval of translated texts!
|
|
723
|
+
*
|
|
724
|
+
* Can either be set to a concrete value (a BCP47 or Java locale compliant language tag) or to `null`. When
|
|
725
|
+
* set to `null` (default value) then locale specific formatters are retrieved for the current language.
|
|
726
|
+
*
|
|
727
|
+
* After changing the format locale, the framework tries to update localization specific parts of the UI.
|
|
728
|
+
* See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
|
|
729
|
+
* for details and restrictions.
|
|
730
|
+
*
|
|
731
|
+
* **Note**: When a language tag is set, it has higher priority than a number, date or time format defined
|
|
732
|
+
* with a call to `setABAPNumberFormat`, `setABAPDateFormat` or `setABAPTimeFormat`.
|
|
733
|
+
*
|
|
734
|
+
* **Note**: See documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
|
|
735
|
+
* for restrictions.
|
|
736
|
+
*/
|
|
737
|
+
setLanguageTag(
|
|
738
|
+
/**
|
|
739
|
+
* the new BCP47 compliant language tag; case doesn't matter and underscores can be used instead of dashes
|
|
740
|
+
* to separate components (compatibility with Java Locale IDs)
|
|
741
|
+
*/
|
|
742
|
+
vLanguageTag: string | LanguageTag | null
|
|
743
|
+
): void;
|
|
744
|
+
/**
|
|
745
|
+
* @since 1.120
|
|
746
|
+
*
|
|
747
|
+
* Allows to specify the customizing data for Islamic calendar support
|
|
748
|
+
*/
|
|
749
|
+
setLegacyDateCalendarCustomizing(
|
|
750
|
+
/**
|
|
751
|
+
* contains the customizing data for the support of Islamic calendar.
|
|
752
|
+
*/
|
|
753
|
+
aMappings: Array<{
|
|
754
|
+
/**
|
|
755
|
+
* The date format
|
|
756
|
+
*/
|
|
757
|
+
dateFormat: string;
|
|
758
|
+
/**
|
|
759
|
+
* The Islamic date
|
|
760
|
+
*/
|
|
761
|
+
islamicMonthStart: string;
|
|
762
|
+
/**
|
|
763
|
+
* The corresponding Gregorian date
|
|
764
|
+
*/
|
|
765
|
+
gregDate: string;
|
|
766
|
+
}>
|
|
767
|
+
): void;
|
|
768
|
+
/**
|
|
769
|
+
* @since 1.120
|
|
770
|
+
*
|
|
771
|
+
* Defines the string to be used for the given number symbol.
|
|
772
|
+
*
|
|
773
|
+
* Calling this method with a null or undefined symbol removes a previously set symbol string. Note that
|
|
774
|
+
* an empty string is explicitly allowed.
|
|
775
|
+
*
|
|
776
|
+
* If a symbol is defined, it will be preferred over symbols derived from the current locale.
|
|
777
|
+
*
|
|
778
|
+
* See class {@link sap.ui.core.format.NumberFormat} for details about the symbols.
|
|
779
|
+
*
|
|
780
|
+
* After changing the number symbol, the framework tries to update localization specific parts of the UI.
|
|
781
|
+
* See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
|
|
782
|
+
* for details and restrictions.
|
|
783
|
+
*/
|
|
784
|
+
setNumberSymbol(
|
|
785
|
+
/**
|
|
786
|
+
* the type of symbol
|
|
787
|
+
*/
|
|
788
|
+
sType: "group" | "decimal" | "plusSign" | "minusSign",
|
|
789
|
+
/**
|
|
790
|
+
* will be used to represent the given symbol type
|
|
791
|
+
*/
|
|
792
|
+
sSymbol: string
|
|
793
|
+
): void;
|
|
794
|
+
/**
|
|
795
|
+
* @since 1.120
|
|
796
|
+
*
|
|
797
|
+
* Defines the preferred format pattern for the given time format style.
|
|
798
|
+
*
|
|
799
|
+
* Calling this method with a null or undefined pattern removes a previously set pattern.
|
|
800
|
+
*
|
|
801
|
+
* If a pattern is defined, it will be preferred over patterns derived from the current locale.
|
|
802
|
+
*
|
|
803
|
+
* See class {@link sap.ui.core.format.DateFormat} for details about the pattern syntax.
|
|
804
|
+
*
|
|
805
|
+
* After changing the time pattern, the framework tries to update localization specific parts of the UI.
|
|
806
|
+
* See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
|
|
807
|
+
* for details and restrictions.
|
|
808
|
+
*/
|
|
809
|
+
setTimePattern(
|
|
810
|
+
/**
|
|
811
|
+
* must be one of short, medium, long or full.
|
|
812
|
+
*/
|
|
813
|
+
sStyle: "short" | "medium" | "long" | "full",
|
|
814
|
+
/**
|
|
815
|
+
* the format pattern to be used in LDML syntax.
|
|
816
|
+
*/
|
|
817
|
+
sPattern: string
|
|
818
|
+
): void;
|
|
819
|
+
/**
|
|
820
|
+
* @since 1.120
|
|
821
|
+
*
|
|
822
|
+
* Define whether the NumberFormatter shall always place the currency code after the numeric value, with
|
|
823
|
+
* the only exception of right-to-left locales, where the currency code shall be placed before the numeric
|
|
824
|
+
* value. Default configuration setting is `true`.
|
|
825
|
+
*
|
|
826
|
+
* When set to `false` the placement of the currency code is done dynamically, depending on the configured
|
|
827
|
+
* locale using data provided by the Unicode Common Locale Data Repository (CLDR).
|
|
828
|
+
*
|
|
829
|
+
* Each currency instance ({@link sap.ui.core.format.NumberFormat.getCurrencyInstance}) will be created
|
|
830
|
+
* with this setting unless overwritten on instance level.
|
|
831
|
+
*/
|
|
832
|
+
setTrailingCurrencyCode(
|
|
833
|
+
/**
|
|
834
|
+
* Whether currency codes shall always be placed after the numeric value
|
|
835
|
+
*/
|
|
836
|
+
bTrailingCurrencyCode: boolean
|
|
837
|
+
): void;
|
|
838
|
+
}
|
|
839
|
+
const Formatting: Formatting;
|
|
840
|
+
export default Formatting;
|
|
841
|
+
|
|
842
|
+
/**
|
|
843
|
+
* @since 1.120
|
|
844
|
+
*
|
|
845
|
+
* The formatting change event. Contains only the parameters which were changed.
|
|
846
|
+
*
|
|
847
|
+
* The list below shows the possible combinations of parameters available as part of the change event.
|
|
848
|
+
*
|
|
849
|
+
*
|
|
850
|
+
* - {@link module:sap/base/i18n/Formatting.setLanguageTag Formatting.setLanguageTag}:
|
|
851
|
+
* `languageTag`
|
|
852
|
+
* - {@link module:sap/base/i18n/Formatting.setLegacyDateCalendarCustomizing Formatting.setLegacyDateCalendarCustomizing}:
|
|
853
|
+
*
|
|
854
|
+
* `legacyDateCalendarCustomizing`
|
|
855
|
+
* - {@link module:sap/base/i18n/Formatting.setCalendarWeekNumbering Formatting.setCalendarWeekNumbering}:
|
|
856
|
+
*
|
|
857
|
+
* `calendarWeekNumbering`
|
|
858
|
+
* - {@link module:sap/base/i18n/Formatting.setCalendarType Formatting.setCalendarType}:
|
|
859
|
+
* `calendarType`
|
|
860
|
+
* - {@link module:sap/base/i18n/Formatting.addCustomCurrencies Formatting.addCustomCurrencies} / {@link module:sap/base/i18n/Formatting.setCustomCurrencies Formatting.setCustomCurrencies}:
|
|
861
|
+
*
|
|
862
|
+
* `currency`
|
|
863
|
+
* - {@link module:sap/base/i18n/Formatting.setABAPDateFormat Formatting.setABAPDateFormat} (all parameters
|
|
864
|
+
* listed below):
|
|
865
|
+
* `ABAPDateFormat`
|
|
866
|
+
* - `"dateFormats-short"`
|
|
867
|
+
* - `"dateFormats-medium"`
|
|
868
|
+
* - {@link module:sap/base/i18n/Formatting.setABAPTimeFormat Formatting.setABAPTimeFormat} (all parameters
|
|
869
|
+
* listed below):
|
|
870
|
+
* `ABAPTimeFormat`
|
|
871
|
+
* - `"timeFormats-short"`
|
|
872
|
+
* - `"timeFormats-medium"`
|
|
873
|
+
* - `"dayPeriods-format-abbreviated"`
|
|
874
|
+
* - {@link module:sap/base/i18n/Formatting.setABAPNumberFormat Formatting.setABAPNumberFormat} (all parameters
|
|
875
|
+
* listed below):
|
|
876
|
+
* `ABAPNumberFormat`
|
|
877
|
+
* - `"symbols-latn-group"`
|
|
878
|
+
* - `"symbols-latn-decimal"`
|
|
879
|
+
* - {@link module:sap/base/i18n/Formatting.setDatePattern Formatting.setDatePattern} (one of the parameters
|
|
880
|
+
* listed below):
|
|
881
|
+
* `"dateFormats-short"`
|
|
882
|
+
* - `"dateFormats-medium"`
|
|
883
|
+
* - `"dateFormats-long"`
|
|
884
|
+
* - `"dateFormats-full"`
|
|
885
|
+
* - {@link module:sap/base/i18n/Formatting.setTimePattern Formatting.setTimePattern} (one of the parameters
|
|
886
|
+
* listed below):
|
|
887
|
+
* `"timeFormats-short"`
|
|
888
|
+
* - `"timeFormats-medium"`
|
|
889
|
+
* - `"timeFormats-long"`
|
|
890
|
+
* - `"timeFormats-full"`
|
|
891
|
+
* - {@link module:sap/base/i18n/Formatting.setNumberSymbol Formatting.setNumberSymbol} (one of the parameters
|
|
892
|
+
* listed below):
|
|
893
|
+
* `"symbols-latn-group"`
|
|
894
|
+
* - `"symbols-latn-decimal"`
|
|
895
|
+
* - `"symbols-latn-plusSign"`
|
|
896
|
+
* - `"symbols-latn-minusSign"`
|
|
897
|
+
*/
|
|
898
|
+
export type Formatting$ChangeEvent = {
|
|
899
|
+
/**
|
|
900
|
+
* The formatting language tag.
|
|
901
|
+
*/
|
|
902
|
+
languageTag?: string;
|
|
903
|
+
/**
|
|
904
|
+
* The ABAP date format.
|
|
905
|
+
*/
|
|
906
|
+
ABAPDateFormat?: string;
|
|
907
|
+
/**
|
|
908
|
+
* The ABAP time format.
|
|
909
|
+
*/
|
|
910
|
+
ABAPTimeFormat?: string;
|
|
911
|
+
/**
|
|
912
|
+
* The ABAP number format.
|
|
913
|
+
*/
|
|
914
|
+
ABAPNumberFormat?: string;
|
|
915
|
+
/**
|
|
916
|
+
* The legacy date calendar customizing.
|
|
917
|
+
*/
|
|
918
|
+
legacyDateCalendarCustomizing?: object[];
|
|
919
|
+
/**
|
|
920
|
+
* The calendar week numbering.
|
|
921
|
+
*/
|
|
922
|
+
calendarWeekNumbering?: object;
|
|
923
|
+
/**
|
|
924
|
+
* The calendar type.
|
|
925
|
+
*/
|
|
926
|
+
calendarType?: object;
|
|
927
|
+
/**
|
|
928
|
+
* The short date format.
|
|
929
|
+
*/
|
|
930
|
+
"dateFormats-short"?: string;
|
|
931
|
+
/**
|
|
932
|
+
* The medium date format.
|
|
933
|
+
*/
|
|
934
|
+
"dateFormats-medium"?: string;
|
|
935
|
+
/**
|
|
936
|
+
* The long date format.
|
|
937
|
+
*/
|
|
938
|
+
"dateFormats-long"?: string;
|
|
939
|
+
/**
|
|
940
|
+
* The full date format.
|
|
941
|
+
*/
|
|
942
|
+
"dateFormats-full"?: string;
|
|
943
|
+
/**
|
|
944
|
+
* The short time format.
|
|
945
|
+
*/
|
|
946
|
+
"timeFormats-short"?: string;
|
|
947
|
+
/**
|
|
948
|
+
* The medium time format.
|
|
949
|
+
*/
|
|
950
|
+
"timeFormats-medium"?: string;
|
|
951
|
+
/**
|
|
952
|
+
* The long time format.
|
|
953
|
+
*/
|
|
954
|
+
"timeFormats-long"?: string;
|
|
955
|
+
/**
|
|
956
|
+
* The full time format.
|
|
957
|
+
*/
|
|
958
|
+
"timeFormats-full"?: string;
|
|
959
|
+
/**
|
|
960
|
+
* The latin symbols group.
|
|
961
|
+
*/
|
|
962
|
+
"symbols-latn-group"?: string;
|
|
963
|
+
/**
|
|
964
|
+
* The latin symbols decimal.
|
|
965
|
+
*/
|
|
966
|
+
"symbols-latn-decimal"?: string;
|
|
967
|
+
/**
|
|
968
|
+
* The latin symbols plusSign.
|
|
969
|
+
*/
|
|
970
|
+
"symbols-latn-plusSign"?: string;
|
|
971
|
+
/**
|
|
972
|
+
* The latin symbols minusSign.
|
|
973
|
+
*/
|
|
974
|
+
"symbols-latn-minusSign"?: string;
|
|
975
|
+
/**
|
|
976
|
+
* The currency.
|
|
977
|
+
*/
|
|
978
|
+
currency?: Record<string, string>;
|
|
979
|
+
/**
|
|
980
|
+
* The abbreviated day periods format.
|
|
981
|
+
*/
|
|
982
|
+
"dayPeriods-format-abbreviated"?: string[];
|
|
983
|
+
};
|
|
984
|
+
}
|
|
985
|
+
|
|
986
|
+
declare module "sap/base/i18n/LanguageTag" {
|
|
987
|
+
/**
|
|
988
|
+
* Creates an LanguageTag instance. LanguageTag represents a BCP-47 language tag, consisting of a language,
|
|
989
|
+
* script, region, variants, extensions and private use section.
|
|
990
|
+
*/
|
|
991
|
+
export default class LanguageTag {
|
|
992
|
+
constructor(
|
|
993
|
+
/**
|
|
994
|
+
* the language tag identifier, in format en-US or en_US.
|
|
995
|
+
*/
|
|
996
|
+
sLanguageTag: string
|
|
997
|
+
);
|
|
998
|
+
/**
|
|
999
|
+
* Get the extension as a single string or `null`.
|
|
1000
|
+
*
|
|
1001
|
+
* The extension always consists of a singleton character (not 'x'), a dash '-' and one or more extension
|
|
1002
|
+
* token, each separated again with a dash.
|
|
1003
|
+
*/
|
|
1004
|
+
extension: string | null;
|
|
1005
|
+
|
|
1006
|
+
/**
|
|
1007
|
+
* Get the extensions as an array of tokens.
|
|
1008
|
+
*
|
|
1009
|
+
* The leading singleton and the separating dashes are not part of the result. If there is no extensions
|
|
1010
|
+
* section in the language tag, an empty array is returned.
|
|
1011
|
+
*/
|
|
1012
|
+
extensionSubtags: string[];
|
|
1013
|
+
|
|
1014
|
+
/**
|
|
1015
|
+
* Get the language.
|
|
1016
|
+
*
|
|
1017
|
+
* Note that the case might differ from the original script tag (Lower case is enforced as recommended by
|
|
1018
|
+
* BCP47/ISO639).
|
|
1019
|
+
*/
|
|
1020
|
+
language: string;
|
|
1021
|
+
|
|
1022
|
+
/**
|
|
1023
|
+
* Get the region or `null` if none was specified.
|
|
1024
|
+
*
|
|
1025
|
+
* Note that the case might differ from the original script tag (Upper case is enforced as recommended by
|
|
1026
|
+
* BCP47/ISO3166-1).
|
|
1027
|
+
*/
|
|
1028
|
+
region: string;
|
|
1029
|
+
|
|
1030
|
+
/**
|
|
1031
|
+
* Get the script or `null` if none was specified.
|
|
1032
|
+
*
|
|
1033
|
+
* Note that the case might differ from the original language tag (Upper case first letter and lower case
|
|
1034
|
+
* reminder enforced as recommended by BCP47/ISO15924)
|
|
1035
|
+
*/
|
|
1036
|
+
script: string | null;
|
|
1037
|
+
|
|
1038
|
+
/**
|
|
1039
|
+
* Get the variants as a single string or `null`.
|
|
1040
|
+
*
|
|
1041
|
+
* Multiple variants are separated by a dash '-'.
|
|
1042
|
+
*/
|
|
1043
|
+
variant: string | null;
|
|
1044
|
+
|
|
1045
|
+
/**
|
|
1046
|
+
* Get the variants as an array of individual variants.
|
|
1047
|
+
*
|
|
1048
|
+
* The separating dashes are not part of the result. If there is no variant section in the language tag,
|
|
1049
|
+
* an empty array is returned.
|
|
1050
|
+
*/
|
|
1051
|
+
variantSubtags: string[];
|
|
1052
|
+
}
|
|
1053
|
+
}
|
|
1054
|
+
|
|
1055
|
+
declare module "sap/base/i18n/Localization" {
|
|
1056
|
+
import LanguageTag from "sap/base/i18n/LanguageTag";
|
|
1057
|
+
|
|
1058
|
+
/**
|
|
1059
|
+
* @since 1.118
|
|
1060
|
+
*
|
|
1061
|
+
* Configuration for localization specific parameters
|
|
1062
|
+
*/
|
|
1063
|
+
interface Localization {
|
|
1064
|
+
/**
|
|
1065
|
+
* @since 1.120.0
|
|
1066
|
+
*
|
|
1067
|
+
* Attaches the `fnFunction` event handler to the {@link #event:change change} event of `module:sap/base/i18n/Localization`.
|
|
1068
|
+
*/
|
|
1069
|
+
attachChange(
|
|
1070
|
+
/**
|
|
1071
|
+
* The function to be called when the event occurs
|
|
1072
|
+
*/
|
|
1073
|
+
fnFunction: (p1: Localization$ChangeEvent) => void
|
|
1074
|
+
): void;
|
|
1075
|
+
/**
|
|
1076
|
+
* @since 1.120.0
|
|
1077
|
+
*
|
|
1078
|
+
* Detaches event handler `fnFunction` from the {@link #event:change change} event of this `module:sap/base/i18n/Localization`.
|
|
1079
|
+
*/
|
|
1080
|
+
detachChange(
|
|
1081
|
+
/**
|
|
1082
|
+
* Function to be called when the event occurs
|
|
1083
|
+
*/
|
|
1084
|
+
fnFunction: (p1: Localization$ChangeEvent) => void
|
|
1085
|
+
): void;
|
|
1086
|
+
/**
|
|
1087
|
+
* @since 1.119.0
|
|
1088
|
+
*
|
|
1089
|
+
* Returns the list of active terminologies defined via the Configuration.
|
|
1090
|
+
*
|
|
1091
|
+
* @returns if no active terminologies are set, the default value `undefined` is returned.
|
|
1092
|
+
*/
|
|
1093
|
+
getActiveTerminologies(): string[] | undefined;
|
|
1094
|
+
/**
|
|
1095
|
+
* @since 1.120.0
|
|
1096
|
+
*
|
|
1097
|
+
* Returns a string that identifies the current language.
|
|
1098
|
+
*
|
|
1099
|
+
* The value returned by config method in most cases corresponds to the exact value that has been configured
|
|
1100
|
+
* by the user or application or that has been determined from the user agent settings. It has not been
|
|
1101
|
+
* normalized, but has been validated against a relaxed version of {@link http://www.ietf.org/rfc/bcp/bcp47.txt BCP47},
|
|
1102
|
+
* allowing underscores ('_') instead of the suggested dashes ('-') and not taking the case of letters into
|
|
1103
|
+
* account.
|
|
1104
|
+
*
|
|
1105
|
+
* The exceptions mentioned above affect languages that have been specified via the URL parameter `sap-language`.
|
|
1106
|
+
* That parameter by definition represents an SAP logon language code ('ABAP language'). Most but not all
|
|
1107
|
+
* of these language codes are valid ISO639 two-letter languages and as such are valid BCP47 language tags.
|
|
1108
|
+
* For better BCP47 compliance, the framework maps the following non-BCP47 SAP logon codes to a BCP47 substitute:
|
|
1109
|
+
*
|
|
1110
|
+
* ```javascript
|
|
1111
|
+
*
|
|
1112
|
+
* "ZH" --> "zh-Hans" // script 'Hans' added to distinguish it from zh-Hant
|
|
1113
|
+
* "ZF" --> "zh-Hant" // ZF is not a valid ISO639 code, use the compliant language + script 'Hant'
|
|
1114
|
+
* "1Q" --> "en-US-x-saptrc" // special language code for supportability (tracing),
|
|
1115
|
+
* represented as en-US with a private extension
|
|
1116
|
+
* "2Q" --> "en-US-x-sappsd" // special language code for supportability (pseudo translation),
|
|
1117
|
+
* represented as en-US with a private extension
|
|
1118
|
+
* "3Q" --> "en-US-x-saprigi" // special language code for the Rigi pseudo language,
|
|
1119
|
+
* represented as en-US with a private extension
|
|
1120
|
+
* ```
|
|
1121
|
+
*
|
|
1122
|
+
*
|
|
1123
|
+
* Call {@link moduel:sap/base/i18n/Localization.getLanguageTag getLanguageTag} to get a {@link module:sap/base/i18n/LanguageTag LanguageTag }
|
|
1124
|
+
* object matching the language. For a normalized BCP47 tag, call {@link module:sap/base/i18n/LanguageTag.toString toString() }
|
|
1125
|
+
* on the returned `LanguageTag`
|
|
1126
|
+
*
|
|
1127
|
+
* @returns Language string as configured
|
|
1128
|
+
*/
|
|
1129
|
+
getLanguage(): string;
|
|
1130
|
+
/**
|
|
1131
|
+
* @since 1.120.0
|
|
1132
|
+
*
|
|
1133
|
+
* Returns a LanguageTag object for the current language.
|
|
1134
|
+
*
|
|
1135
|
+
* The LanguageTag is derived from {@link modue:sap/base/i18n/Localization.getLanguage Localization.getLanguage}.
|
|
1136
|
+
*
|
|
1137
|
+
* @returns The LanguageTag
|
|
1138
|
+
*/
|
|
1139
|
+
getLanguageTag(): LanguageTag;
|
|
1140
|
+
/**
|
|
1141
|
+
* @since 1.120.0
|
|
1142
|
+
*
|
|
1143
|
+
* Returns whether the page uses the RTL text direction.
|
|
1144
|
+
*
|
|
1145
|
+
* If no mode has been explicitly set (neither `true` nor `false`), the mode is derived from the current
|
|
1146
|
+
* language setting.
|
|
1147
|
+
*
|
|
1148
|
+
* @returns whether the page uses the RTL text direction
|
|
1149
|
+
*/
|
|
1150
|
+
getRTL(): boolean;
|
|
1151
|
+
/**
|
|
1152
|
+
* @since 1.120.0
|
|
1153
|
+
*
|
|
1154
|
+
* Returns an SAP logon language for the current language.
|
|
1155
|
+
*
|
|
1156
|
+
* It will be returned in uppercase. e.g. "EN", "DE"
|
|
1157
|
+
*
|
|
1158
|
+
* @returns The SAP logon language code for the current language
|
|
1159
|
+
*/
|
|
1160
|
+
getSAPLogonLanguage(): string;
|
|
1161
|
+
/**
|
|
1162
|
+
* @since 1.120.0
|
|
1163
|
+
*
|
|
1164
|
+
* Retrieves the configured IANA timezone ID.
|
|
1165
|
+
*
|
|
1166
|
+
* @returns The configured IANA timezone ID, e.g. "America/New_York"
|
|
1167
|
+
*/
|
|
1168
|
+
getTimezone(): string;
|
|
1169
|
+
/**
|
|
1170
|
+
* @since 1.120.0
|
|
1171
|
+
*
|
|
1172
|
+
* Sets a new language to be used from now on for language/region dependent functionality (e.g. formatting,
|
|
1173
|
+
* data types, translated texts, ...).
|
|
1174
|
+
*
|
|
1175
|
+
* When the language can't be interpreted as a BCP47 language (using the relaxed syntax described in {@link #getLanguage},
|
|
1176
|
+
* an error will be thrown.
|
|
1177
|
+
*
|
|
1178
|
+
* When the language has changed, the Localization will fire its {@link module:sap/base/i18n/Localization.change change }
|
|
1179
|
+
* event.
|
|
1180
|
+
*
|
|
1181
|
+
* Restrictions:
|
|
1182
|
+
*
|
|
1183
|
+
* The framework **does not** guarantee that already created, language dependent objects will be updated
|
|
1184
|
+
* by config call. It therefore remains best practice for applications to switch the language early, e.g.
|
|
1185
|
+
* before any language dependent objects are created. Applications that need to support more dynamic changes
|
|
1186
|
+
* of the language should listen to the `localizationChanged` event and adapt all language dependent objects
|
|
1187
|
+
* that they use (e.g. by rebuilding their UI).
|
|
1188
|
+
*
|
|
1189
|
+
* Currently, the framework notifies the following objects about a change of the localization settings before
|
|
1190
|
+
* it fires the `localizationChanged` event:
|
|
1191
|
+
*
|
|
1192
|
+
*
|
|
1193
|
+
* - date and number data types that are used in property bindings or composite bindings in existing Elements,
|
|
1194
|
+
* Controls, UIAreas or Components
|
|
1195
|
+
* - ResourceModels currently assigned to the Core, a UIArea, Component, Element or Control
|
|
1196
|
+
* - Elements or Controls that implement the `onlocalizationChanged` hook (note the lowercase 'l' in onlocalizationChanged)
|
|
1197
|
+
*
|
|
1198
|
+
*
|
|
1199
|
+
* It furthermore derives the RTL mode from the new language, if no explicit RTL mode has been set. If the
|
|
1200
|
+
* RTL mode changes, the following additional actions will be taken:
|
|
1201
|
+
*
|
|
1202
|
+
*
|
|
1203
|
+
* - the URLs of already loaded library theme files will be changed
|
|
1204
|
+
* - the `dir` attribute of the page will be changed to reflect the new mode.
|
|
1205
|
+
* - all UIAreas will be invalidated (which results in a rendering of the whole UI5 UI)
|
|
1206
|
+
*
|
|
1207
|
+
* config method does not accept SAP language codes for `sLanguage`. Instead, a second parameter `sSAPLogonLanguage`
|
|
1208
|
+
* can be provided with an SAP language code corresponding to the given language. A given value will be
|
|
1209
|
+
* returned by the {@link module:sap/base/i18n/Localization.getSAPLogonLanguage getSAPLogonLanguage} method.
|
|
1210
|
+
* It is up to the caller to provide a consistent pair of BCP47 language and SAP language code. The SAP
|
|
1211
|
+
* language code is only checked to be of length 2 and must consist of letters or digits only.
|
|
1212
|
+
*
|
|
1213
|
+
* **Note**: When using config method please take note of and respect the above mentioned restrictions.
|
|
1214
|
+
* See:
|
|
1215
|
+
* http://scn.sap.com/docs/DOC-14377
|
|
1216
|
+
*/
|
|
1217
|
+
setLanguage(
|
|
1218
|
+
/**
|
|
1219
|
+
* the new language as a BCP47 compliant language tag; case doesn't matter and underscores can be used instead
|
|
1220
|
+
* of dashes to separate components (compatibility with Java Locale IDs)
|
|
1221
|
+
*/
|
|
1222
|
+
sLanguage: string,
|
|
1223
|
+
/**
|
|
1224
|
+
* SAP language code that corresponds to the `sLanguage`; if a value is specified, future calls to `getSAPLogonLanguage`
|
|
1225
|
+
* will return that value; if no value is specified, the framework will use the ISO639 language part of
|
|
1226
|
+
* `sLanguage` as SAP Logon language.
|
|
1227
|
+
*/
|
|
1228
|
+
sSAPLogonLanguage?: string
|
|
1229
|
+
): void;
|
|
1230
|
+
/**
|
|
1231
|
+
* @since 1.120.0
|
|
1232
|
+
*
|
|
1233
|
+
* Sets the character orientation mode to be used from now on.
|
|
1234
|
+
*
|
|
1235
|
+
* Can either be set to a concrete value (true meaning right-to-left, false meaning left-to-right) or to
|
|
1236
|
+
* `null` which means that the character orientation mode should be derived from the current language (incl.
|
|
1237
|
+
* region) setting.
|
|
1238
|
+
*
|
|
1239
|
+
* After changing the character orientation mode, the framework tries to update localization specific parts
|
|
1240
|
+
* of the UI. See the documentation of {@link module:sap/base/i18n/Localization.setLanguage setLanguage }
|
|
1241
|
+
* for details and restrictions.
|
|
1242
|
+
*
|
|
1243
|
+
* **Note**: See documentation of {@link module:sap/base/i18n/Localization.setLanguage setLanguage} for
|
|
1244
|
+
* restrictions.
|
|
1245
|
+
*/
|
|
1246
|
+
setRTL(
|
|
1247
|
+
/**
|
|
1248
|
+
* new character orientation mode or `null`
|
|
1249
|
+
*/
|
|
1250
|
+
bRTL: boolean | null
|
|
1251
|
+
): void;
|
|
1252
|
+
/**
|
|
1253
|
+
* @since 1.120.0
|
|
1254
|
+
*
|
|
1255
|
+
* Sets the timezone such that all date and time based calculations use config timezone.
|
|
1256
|
+
*
|
|
1257
|
+
* **Important:** It is strongly recommended to only use config API at the earliest point of time while
|
|
1258
|
+
* initializing a UI5 app. A later adjustment of the time zone should be avoided. It can lead to unexpected
|
|
1259
|
+
* data inconsistencies in a running application, because date objects could still be related to a previously
|
|
1260
|
+
* configured time zone. Instead, the app should be completely restarted with the new time zone. For more
|
|
1261
|
+
* information, see {@link https://ui5.sap.com/#/topic/6c9e61dc157a40c19460660ece8368bc Dates, Times, Timestamps, and Time Zones}.
|
|
1262
|
+
*
|
|
1263
|
+
* When the timezone has changed, the Localization will fire its {@link #event:change change} event.
|
|
1264
|
+
*/
|
|
1265
|
+
setTimezone(
|
|
1266
|
+
/**
|
|
1267
|
+
* IANA timezone ID, e.g. "America/New_York". Use `null` to reset the timezone to the browser's local timezone.
|
|
1268
|
+
* An invalid IANA timezone ID will fall back to the browser's timezone.
|
|
1269
|
+
*/
|
|
1270
|
+
sTimezone?: string | null
|
|
1271
|
+
): void;
|
|
1272
|
+
}
|
|
1273
|
+
const Localization: Localization;
|
|
1274
|
+
export default Localization;
|
|
1275
|
+
|
|
1276
|
+
/**
|
|
1277
|
+
* @since 1.120.0
|
|
1278
|
+
*
|
|
1279
|
+
* The localization change event. Contains only the parameters which were changed.
|
|
1280
|
+
*
|
|
1281
|
+
* The list below shows the possible combinations of parameters available as part of the change event.
|
|
1282
|
+
*
|
|
1283
|
+
*
|
|
1284
|
+
* - {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage}:
|
|
1285
|
+
* `language`
|
|
1286
|
+
* - `rtl?` (only if language change also changed RTL)
|
|
1287
|
+
* - {@link module:sap/base/i18n/Localization.setRTL Localization.setRTL}:
|
|
1288
|
+
* `rtl`
|
|
1289
|
+
* - {@link module:sap/base/i18n/Localization.setTimezone Localization.setTimezone}:
|
|
1290
|
+
* `timezone`
|
|
1291
|
+
*/
|
|
1292
|
+
export type Localization$ChangeEvent = {
|
|
1293
|
+
/**
|
|
1294
|
+
* The newly set language.
|
|
1295
|
+
*/
|
|
1296
|
+
language?: string;
|
|
1297
|
+
/**
|
|
1298
|
+
* Whether the page uses the RTL text direction.
|
|
1299
|
+
*/
|
|
1300
|
+
rtl?: boolean;
|
|
1301
|
+
/**
|
|
1302
|
+
* The newly set timezone.
|
|
1303
|
+
*/
|
|
1304
|
+
timezone?: string;
|
|
1305
|
+
};
|
|
1306
|
+
}
|
|
1307
|
+
|
|
307
1308
|
declare module "sap/base/i18n/ResourceBundle" {
|
|
308
1309
|
/**
|
|
309
1310
|
* @since 1.58
|
|
@@ -2554,6 +3555,37 @@ declare module "sap/ui/util/XMLHelper" {
|
|
|
2554
3555
|
export default XMLHelper;
|
|
2555
3556
|
}
|
|
2556
3557
|
|
|
3558
|
+
declare module "sap/ui/core/AnimationMode" {
|
|
3559
|
+
/**
|
|
3560
|
+
* @since 1.120
|
|
3561
|
+
*
|
|
3562
|
+
* Enumerable list with available animation modes.
|
|
3563
|
+
*
|
|
3564
|
+
* This enumerable is used to validate the animation mode. Animation modes allow to specify different animation
|
|
3565
|
+
* scenarios or levels. The implementation of the Control (JavaScript or CSS) has to be done differently
|
|
3566
|
+
* for each animation mode.
|
|
3567
|
+
*/
|
|
3568
|
+
enum AnimationMode {
|
|
3569
|
+
/**
|
|
3570
|
+
* `basic` can be used for a reduced, more light-weight set of animations.
|
|
3571
|
+
*/
|
|
3572
|
+
basic = "basic",
|
|
3573
|
+
/**
|
|
3574
|
+
* `full` represents a mode with unrestricted animation capabilities.
|
|
3575
|
+
*/
|
|
3576
|
+
full = "full",
|
|
3577
|
+
/**
|
|
3578
|
+
* `minimal` includes animations of fundamental functionality.
|
|
3579
|
+
*/
|
|
3580
|
+
minimal = "minimal",
|
|
3581
|
+
/**
|
|
3582
|
+
* `none` deactivates the animation completely.
|
|
3583
|
+
*/
|
|
3584
|
+
none = "none",
|
|
3585
|
+
}
|
|
3586
|
+
export default AnimationMode;
|
|
3587
|
+
}
|
|
3588
|
+
|
|
2557
3589
|
declare module "sap/ui/core/ComponentSupport" {
|
|
2558
3590
|
/**
|
|
2559
3591
|
* @since 1.58.0
|
|
@@ -2639,6 +3671,52 @@ declare module "sap/ui/core/ComponentSupport" {
|
|
|
2639
3671
|
export default ComponentSupport;
|
|
2640
3672
|
}
|
|
2641
3673
|
|
|
3674
|
+
declare module "sap/ui/core/ControlBehavior" {
|
|
3675
|
+
import AnimationMode from "sap/ui/core/AnimationMode";
|
|
3676
|
+
|
|
3677
|
+
/**
|
|
3678
|
+
* @since 1.120
|
|
3679
|
+
*
|
|
3680
|
+
* Provides control behavior relevant configuration options
|
|
3681
|
+
*/
|
|
3682
|
+
interface ControlBehavior {
|
|
3683
|
+
/**
|
|
3684
|
+
* @since 1.120
|
|
3685
|
+
*
|
|
3686
|
+
* Returns the current animation mode.
|
|
3687
|
+
*
|
|
3688
|
+
* @returns The current animationMode
|
|
3689
|
+
*/
|
|
3690
|
+
getAnimationMode(): AnimationMode | keyof typeof AnimationMode;
|
|
3691
|
+
/**
|
|
3692
|
+
* @since 1.120
|
|
3693
|
+
*
|
|
3694
|
+
* Returns whether the accessibility mode is enabled or not.
|
|
3695
|
+
*
|
|
3696
|
+
* @returns whether the accessibility mode is enabled or not
|
|
3697
|
+
*/
|
|
3698
|
+
isAccessibilityEnabled(): boolean;
|
|
3699
|
+
/**
|
|
3700
|
+
* @since 1.120
|
|
3701
|
+
*
|
|
3702
|
+
* Sets the current animation mode.
|
|
3703
|
+
*
|
|
3704
|
+
* Expects an animation mode as string and validates it. If a wrong animation mode was set, an error is
|
|
3705
|
+
* thrown. If the mode is valid it is set, then the attributes `data-sap-ui-animation` and `data-sap-ui-animation-mode`
|
|
3706
|
+
* of the HTML document root element are also updated. If the `animationMode` is `AnimationMode.none` the
|
|
3707
|
+
* old `animation` property is set to `false`, otherwise it is set to `true`.
|
|
3708
|
+
*/
|
|
3709
|
+
setAnimationMode(
|
|
3710
|
+
/**
|
|
3711
|
+
* A valid animation mode
|
|
3712
|
+
*/
|
|
3713
|
+
sAnimationMode: AnimationMode | keyof typeof AnimationMode
|
|
3714
|
+
): void;
|
|
3715
|
+
}
|
|
3716
|
+
const ControlBehavior: ControlBehavior;
|
|
3717
|
+
export default ControlBehavior;
|
|
3718
|
+
}
|
|
3719
|
+
|
|
2642
3720
|
declare module "sap/ui/core/date/CalendarUtils" {
|
|
2643
3721
|
import CalendarWeekNumbering from "sap/ui/core/date/CalendarWeekNumbering";
|
|
2644
3722
|
|
|
@@ -3578,6 +4656,8 @@ declare module "sap/ui/core/Theming" {
|
|
|
3578
4656
|
*/
|
|
3579
4657
|
interface Theming {
|
|
3580
4658
|
/**
|
|
4659
|
+
* @since 1.118.0
|
|
4660
|
+
*
|
|
3581
4661
|
* Attaches event handler `fnFunction` to the {@link #event:applied applied} event.
|
|
3582
4662
|
*
|
|
3583
4663
|
* The given handler is called when the the applied event is fired. If the theme is already applied the
|
|
@@ -3588,9 +4668,11 @@ declare module "sap/ui/core/Theming" {
|
|
|
3588
4668
|
/**
|
|
3589
4669
|
* The function to be called, when the event occurs
|
|
3590
4670
|
*/
|
|
3591
|
-
fnFunction:
|
|
4671
|
+
fnFunction: (p1: Theming$AppliedEvent) => void
|
|
3592
4672
|
): void;
|
|
3593
4673
|
/**
|
|
4674
|
+
* @since 1.118.0
|
|
4675
|
+
*
|
|
3594
4676
|
* Detaches event handler `fnFunction` from the {@link #event:applied applied} event
|
|
3595
4677
|
*
|
|
3596
4678
|
* The passed function must match the one used for event registration.
|
|
@@ -3599,32 +4681,48 @@ declare module "sap/ui/core/Theming" {
|
|
|
3599
4681
|
/**
|
|
3600
4682
|
* The function to be called, when the event occurs
|
|
3601
4683
|
*/
|
|
3602
|
-
fnFunction:
|
|
4684
|
+
fnFunction: (p1: Theming$AppliedEvent) => void
|
|
3603
4685
|
): void;
|
|
3604
4686
|
/**
|
|
4687
|
+
* @since 1.118
|
|
4688
|
+
*
|
|
3605
4689
|
* Returns the theme name
|
|
3606
4690
|
*
|
|
3607
4691
|
* @returns the theme name
|
|
3608
4692
|
*/
|
|
3609
4693
|
getTheme(): string;
|
|
3610
4694
|
/**
|
|
4695
|
+
* @since 1.118.0
|
|
4696
|
+
*
|
|
3611
4697
|
* Notify content density changes
|
|
3612
4698
|
*/
|
|
3613
4699
|
notifyContentDensityChanged(): void;
|
|
3614
4700
|
/**
|
|
3615
|
-
*
|
|
4701
|
+
* @since 1.118
|
|
3616
4702
|
*
|
|
3617
|
-
*
|
|
4703
|
+
* Allows setting the theme name
|
|
3618
4704
|
*/
|
|
3619
4705
|
setTheme(
|
|
3620
4706
|
/**
|
|
3621
4707
|
* the theme name
|
|
3622
4708
|
*/
|
|
3623
4709
|
sTheme: string
|
|
3624
|
-
):
|
|
4710
|
+
): void;
|
|
3625
4711
|
}
|
|
3626
4712
|
const Theming: Theming;
|
|
3627
4713
|
export default Theming;
|
|
4714
|
+
|
|
4715
|
+
/**
|
|
4716
|
+
* @since 1.118.0
|
|
4717
|
+
*
|
|
4718
|
+
* The theme applied Event.
|
|
4719
|
+
*/
|
|
4720
|
+
export type Theming$AppliedEvent = {
|
|
4721
|
+
/**
|
|
4722
|
+
* The newly set language.
|
|
4723
|
+
*/
|
|
4724
|
+
theme: string;
|
|
4725
|
+
};
|
|
3628
4726
|
}
|
|
3629
4727
|
|
|
3630
4728
|
declare module "sap/ui/dom/containsOrEquals" {
|
|
@@ -4717,6 +5815,59 @@ declare module "sap/ui/performance/trace/Interaction" {
|
|
|
4717
5815
|
};
|
|
4718
5816
|
}
|
|
4719
5817
|
|
|
5818
|
+
declare module "sap/ui/security/Security" {
|
|
5819
|
+
import { URI } from "sap/ui/core/library";
|
|
5820
|
+
|
|
5821
|
+
/**
|
|
5822
|
+
* @since 1.120.0
|
|
5823
|
+
*
|
|
5824
|
+
* Provides security related API
|
|
5825
|
+
*/
|
|
5826
|
+
interface Security {
|
|
5827
|
+
/**
|
|
5828
|
+
* @since 1.120.0
|
|
5829
|
+
*
|
|
5830
|
+
* URL of the allowlist service.
|
|
5831
|
+
*
|
|
5832
|
+
* @returns allowlist service URL
|
|
5833
|
+
*/
|
|
5834
|
+
getAllowlistService(): string;
|
|
5835
|
+
/**
|
|
5836
|
+
* @since 1.120.0
|
|
5837
|
+
*
|
|
5838
|
+
* frameOptions mode (allow/deny/trusted).
|
|
5839
|
+
*
|
|
5840
|
+
* @returns frameOptions mode
|
|
5841
|
+
*/
|
|
5842
|
+
getFrameOptions(): string;
|
|
5843
|
+
/**
|
|
5844
|
+
* @since 1.120.0
|
|
5845
|
+
*
|
|
5846
|
+
* Returns the security token handlers of an OData V4 model.
|
|
5847
|
+
* See:
|
|
5848
|
+
* #setSecurityTokenHandlers
|
|
5849
|
+
*
|
|
5850
|
+
* @returns the security token handlers (an empty array if there are none)
|
|
5851
|
+
*/
|
|
5852
|
+
getSecurityTokenHandlers(): Array<(p1: URI) => Promise<any>>;
|
|
5853
|
+
/**
|
|
5854
|
+
* @since 1.120.0
|
|
5855
|
+
*
|
|
5856
|
+
* Sets the security token handlers for an OData V4 model. See chapter {@link https://ui5.sap.com/#/topic/9613f1f2d88747cab21896f7216afdac/section_STH Security Token Handling}.
|
|
5857
|
+
* See:
|
|
5858
|
+
* #getSecurityTokenHandlers
|
|
5859
|
+
*/
|
|
5860
|
+
setSecurityTokenHandlers(
|
|
5861
|
+
/**
|
|
5862
|
+
* The security token handlers
|
|
5863
|
+
*/
|
|
5864
|
+
aSecurityTokenHandlers: Array<(p1: URI) => Promise<any>>
|
|
5865
|
+
): void;
|
|
5866
|
+
}
|
|
5867
|
+
const Security: Security;
|
|
5868
|
+
export default Security;
|
|
5869
|
+
}
|
|
5870
|
+
|
|
4720
5871
|
declare module "sap/ui/test/opaQunit" {
|
|
4721
5872
|
/**
|
|
4722
5873
|
* QUnit test adapter for OPA: add a test to be executed by QUnit Has the same signature as QUnit.test (QUnit
|
|
@@ -5621,6 +6772,33 @@ declare module "sap/ui/base/DataType" {
|
|
|
5621
6772
|
*/
|
|
5622
6773
|
sTypeName: string
|
|
5623
6774
|
): DataType | undefined;
|
|
6775
|
+
/**
|
|
6776
|
+
* @since 1.120.0
|
|
6777
|
+
*
|
|
6778
|
+
* Registers an enum under the given name. With version 2.0, registering an enum becomes mandatory when
|
|
6779
|
+
* said enum is to be used in properties of a {@link sap.ui.base.ManagedObject ManagedObject} subclass.
|
|
6780
|
+
*
|
|
6781
|
+
* Example:
|
|
6782
|
+
*
|
|
6783
|
+
* ```javascript
|
|
6784
|
+
*
|
|
6785
|
+
* DataType.registerEnum("my.enums.Sample", {
|
|
6786
|
+
* "A": "A",
|
|
6787
|
+
* "B": "B",
|
|
6788
|
+
* ...
|
|
6789
|
+
* });
|
|
6790
|
+
* ```
|
|
6791
|
+
*/
|
|
6792
|
+
static registerEnum(
|
|
6793
|
+
/**
|
|
6794
|
+
* the type name in dot syntax, e.g. sap.ui.my.EnumType
|
|
6795
|
+
*/
|
|
6796
|
+
sTypeName: string,
|
|
6797
|
+
/**
|
|
6798
|
+
* the enum content
|
|
6799
|
+
*/
|
|
6800
|
+
mContent: object
|
|
6801
|
+
): void;
|
|
5624
6802
|
/**
|
|
5625
6803
|
* The base type of this type or undefined if this is a primitive type.
|
|
5626
6804
|
*
|
|
@@ -6192,6 +7370,8 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
6192
7370
|
|
|
6193
7371
|
import BindingMode from "sap/ui/model/BindingMode";
|
|
6194
7372
|
|
|
7373
|
+
import { ID } from "sap/ui/core/library";
|
|
7374
|
+
|
|
6195
7375
|
/**
|
|
6196
7376
|
* Base Class that introduces some basic concepts, such as, state management and data binding.
|
|
6197
7377
|
*
|
|
@@ -6312,9 +7492,11 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
6312
7492
|
* The possible values for a setting depend on its kind:
|
|
6313
7493
|
* - for simple properties, the value has to match the documented type of the property (no type conversion
|
|
6314
7494
|
* occurs)
|
|
6315
|
-
* - for 0..1 aggregations, the value has to be an instance of the aggregated type
|
|
6316
|
-
*
|
|
6317
|
-
*
|
|
7495
|
+
* - for 0..1 aggregations, the value has to be an instance of the aggregated type, or an object literal
|
|
7496
|
+
* from which, the default class of the aggregation (or the corresponding aggregation type as fallback)
|
|
7497
|
+
* will be instantiated.
|
|
7498
|
+
* - for 0..n aggregations, the value has to be an array of instances of the aggregated type, a single
|
|
7499
|
+
* instance or an object literal from which the default class will be instantiated.
|
|
6318
7500
|
* - for 0..1 associations, an instance of the associated type or an id (string) is accepted
|
|
6319
7501
|
* - for 0..n associations, an array of instances of the associated type or of IDs is accepted
|
|
6320
7502
|
* - for events, either a function (event handler) is accepted or an array of length 2 where the first
|
|
@@ -6361,6 +7543,12 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
6361
7543
|
* Note that when setting string values, any curly braces in those values need to be escaped, so they are
|
|
6362
7544
|
* not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
|
|
6363
7545
|
*
|
|
7546
|
+
* **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
|
|
7547
|
+
* case the object's type is given via the property 'Type' as a string, or is derived via the defined type
|
|
7548
|
+
* of the aggregation. Additionally, as of version 1.120, a ManagedObject subclass can specify a `defaultClass`,
|
|
7549
|
+
* e.g. for cases where only a single class is valid. Please refer to the {@link sap.ui.base.ManagedObject.MetadataOptions.Aggregation Aggregation }
|
|
7550
|
+
* documentation for more details on the `defaultClass`.
|
|
7551
|
+
*
|
|
6364
7552
|
* Besides the settings documented below, ManagedObject itself supports the following special settings:
|
|
6365
7553
|
*
|
|
6366
7554
|
* - `id : sap.ui.core.ID` an ID for the new instance. Some subclasses (Element, Component) require
|
|
@@ -6426,9 +7614,11 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
6426
7614
|
* The possible values for a setting depend on its kind:
|
|
6427
7615
|
* - for simple properties, the value has to match the documented type of the property (no type conversion
|
|
6428
7616
|
* occurs)
|
|
6429
|
-
* - for 0..1 aggregations, the value has to be an instance of the aggregated type
|
|
6430
|
-
*
|
|
6431
|
-
*
|
|
7617
|
+
* - for 0..1 aggregations, the value has to be an instance of the aggregated type, or an object literal
|
|
7618
|
+
* from which, the default class of the aggregation (or the corresponding aggregation type as fallback)
|
|
7619
|
+
* will be instantiated.
|
|
7620
|
+
* - for 0..n aggregations, the value has to be an array of instances of the aggregated type, a single
|
|
7621
|
+
* instance or an object literal from which the default class will be instantiated.
|
|
6432
7622
|
* - for 0..1 associations, an instance of the associated type or an id (string) is accepted
|
|
6433
7623
|
* - for 0..n associations, an array of instances of the associated type or of IDs is accepted
|
|
6434
7624
|
* - for events, either a function (event handler) is accepted or an array of length 2 where the first
|
|
@@ -6475,6 +7665,12 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
6475
7665
|
* Note that when setting string values, any curly braces in those values need to be escaped, so they are
|
|
6476
7666
|
* not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
|
|
6477
7667
|
*
|
|
7668
|
+
* **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
|
|
7669
|
+
* case the object's type is given via the property 'Type' as a string, or is derived via the defined type
|
|
7670
|
+
* of the aggregation. Additionally, as of version 1.120, a ManagedObject subclass can specify a `defaultClass`,
|
|
7671
|
+
* e.g. for cases where only a single class is valid. Please refer to the {@link sap.ui.base.ManagedObject.MetadataOptions.Aggregation Aggregation }
|
|
7672
|
+
* documentation for more details on the `defaultClass`.
|
|
7673
|
+
*
|
|
6478
7674
|
* Besides the settings documented below, ManagedObject itself supports the following special settings:
|
|
6479
7675
|
*
|
|
6480
7676
|
* - `id : sap.ui.core.ID` an ID for the new instance. Some subclasses (Element, Component) require
|
|
@@ -8718,6 +9914,38 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
8718
9914
|
};
|
|
8719
9915
|
|
|
8720
9916
|
export interface $ManagedObjectSettings {
|
|
9917
|
+
/**
|
|
9918
|
+
* Unique ID of this instance. If not given, a so called autoID will be generated by the framework. AutoIDs
|
|
9919
|
+
* use a unique prefix that must not be used for Ids that the application (or other code) creates. It can
|
|
9920
|
+
* be configured option 'autoIDPrefix', see {@link sap.ui.core.Configuration}.
|
|
9921
|
+
*/
|
|
9922
|
+
id?: ID;
|
|
9923
|
+
|
|
9924
|
+
/**
|
|
9925
|
+
* A map of model instances to which the object should be attached. The models are keyed by their model
|
|
9926
|
+
* name. For the default model, String(undefined) is expected.
|
|
9927
|
+
*/
|
|
9928
|
+
models?: object;
|
|
9929
|
+
|
|
9930
|
+
/**
|
|
9931
|
+
* A map of model instances to which the object should be attached. The models are keyed by their model
|
|
9932
|
+
* name. For the default model, String(undefined) is expected.
|
|
9933
|
+
*/
|
|
9934
|
+
bindingContexts?: object;
|
|
9935
|
+
|
|
9936
|
+
/**
|
|
9937
|
+
* A map of model instances to which the object should be attached. The models are keyed by their model
|
|
9938
|
+
* name. For the default model, String(undefined) is expected.
|
|
9939
|
+
*/
|
|
9940
|
+
objectBindings?: object;
|
|
9941
|
+
|
|
9942
|
+
/**
|
|
9943
|
+
* A map of model instances to which the object should be attached. The models are keyed by their model
|
|
9944
|
+
* name. For the default model, String(undefined) is expected. The special setting is only for internal
|
|
9945
|
+
* use.
|
|
9946
|
+
*/
|
|
9947
|
+
metadataContexts?: object;
|
|
9948
|
+
|
|
8721
9949
|
/**
|
|
8722
9950
|
* Fired after a new value for a bound property has been propagated to the model. Only fired, when the binding
|
|
8723
9951
|
* uses a data type.
|
|
@@ -8908,6 +10136,11 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
8908
10136
|
* (in dot notation, e.g. 'sap.m.Button').
|
|
8909
10137
|
*/
|
|
8910
10138
|
type?: string;
|
|
10139
|
+
/**
|
|
10140
|
+
* The default class for the aggregation. If aggregation content is created from a plain object and no explicit
|
|
10141
|
+
* 'Type' is given (capital 'T'), the default class will be instantiated.
|
|
10142
|
+
*/
|
|
10143
|
+
defaultClass?: Function;
|
|
8911
10144
|
/**
|
|
8912
10145
|
* Whether the aggregation is a 0..1 (false) or a 0..n aggregation (true), defaults to true
|
|
8913
10146
|
*/
|
|
@@ -9839,12 +11072,12 @@ declare module "sap/ui/base/Metadata" {
|
|
|
9839
11072
|
*/
|
|
9840
11073
|
getName(): string;
|
|
9841
11074
|
/**
|
|
9842
|
-
* Returns the metadata object of the base class of the described class or
|
|
9843
|
-
* base class.
|
|
11075
|
+
* Returns the metadata object of the base class of the described class or undefined if the class has no
|
|
11076
|
+
* (documented) base class.
|
|
9844
11077
|
*
|
|
9845
11078
|
* @returns metadata of the base class
|
|
9846
11079
|
*/
|
|
9847
|
-
getParent(): Metadata;
|
|
11080
|
+
getParent(): Metadata | undefined;
|
|
9848
11081
|
/**
|
|
9849
11082
|
* @deprecated (since 1.58) - this method should not be used for productive code. The accuracy of the returned
|
|
9850
11083
|
* information highly depends on the concrete class and is not actively monitored. There might be more public
|
|
@@ -10028,6 +11261,7 @@ declare module "sap/ui/base/Object" {
|
|
|
10028
11261
|
): Function;
|
|
10029
11262
|
/**
|
|
10030
11263
|
* @since 1.56
|
|
11264
|
+
* @deprecated (since 1.120) - please use {@link sap.ui.base.Object.isObjectA}.
|
|
10031
11265
|
*
|
|
10032
11266
|
* Checks whether the given object is an instance of the named type. This function is a short-hand convenience
|
|
10033
11267
|
* for {@link sap.ui.base.Object#isA}.
|
|
@@ -10046,6 +11280,26 @@ declare module "sap/ui/base/Object" {
|
|
|
10046
11280
|
*/
|
|
10047
11281
|
vTypeName: string | string[]
|
|
10048
11282
|
): oObject is T;
|
|
11283
|
+
/**
|
|
11284
|
+
* @since 1.120
|
|
11285
|
+
*
|
|
11286
|
+
* Checks whether the given object is an instance of the named type. This function is a short-hand convenience
|
|
11287
|
+
* for {@link sap.ui.base.Object#isA}.
|
|
11288
|
+
*
|
|
11289
|
+
* Please see the API documentation of {@link sap.ui.base.Object#isA} for more details.
|
|
11290
|
+
*
|
|
11291
|
+
* @returns Whether the given object is an instance of the given type or of any of the given types
|
|
11292
|
+
*/
|
|
11293
|
+
static isObjectA(
|
|
11294
|
+
/**
|
|
11295
|
+
* Object which will be checked whether it is an instance of the given type
|
|
11296
|
+
*/
|
|
11297
|
+
oObject: any,
|
|
11298
|
+
/**
|
|
11299
|
+
* Type or types to check for
|
|
11300
|
+
*/
|
|
11301
|
+
vTypeName: string | string[]
|
|
11302
|
+
): boolean;
|
|
10049
11303
|
/**
|
|
10050
11304
|
* Destructor method for objects.
|
|
10051
11305
|
*/
|
|
@@ -11200,6 +12454,78 @@ declare module "sap/ui/core/library" {
|
|
|
11200
12454
|
* Indication Color 8
|
|
11201
12455
|
*/
|
|
11202
12456
|
Indication08 = "Indication08",
|
|
12457
|
+
/**
|
|
12458
|
+
* @since 1.120
|
|
12459
|
+
*
|
|
12460
|
+
* Indication Color 9
|
|
12461
|
+
*/
|
|
12462
|
+
Indication09 = "Indication09",
|
|
12463
|
+
/**
|
|
12464
|
+
* @since 1.120
|
|
12465
|
+
*
|
|
12466
|
+
* Indication Color 10
|
|
12467
|
+
*/
|
|
12468
|
+
Indication10 = "Indication10",
|
|
12469
|
+
/**
|
|
12470
|
+
* @since 1.120
|
|
12471
|
+
*
|
|
12472
|
+
* Indication Color 11
|
|
12473
|
+
*/
|
|
12474
|
+
Indication11 = "Indication11",
|
|
12475
|
+
/**
|
|
12476
|
+
* @since 1.120
|
|
12477
|
+
*
|
|
12478
|
+
* Indication Color 12
|
|
12479
|
+
*/
|
|
12480
|
+
Indication12 = "Indication12",
|
|
12481
|
+
/**
|
|
12482
|
+
* @since 1.120
|
|
12483
|
+
*
|
|
12484
|
+
* Indication Color 13
|
|
12485
|
+
*/
|
|
12486
|
+
Indication13 = "Indication13",
|
|
12487
|
+
/**
|
|
12488
|
+
* @since 1.120
|
|
12489
|
+
*
|
|
12490
|
+
* Indication Color 14
|
|
12491
|
+
*/
|
|
12492
|
+
Indication14 = "Indication14",
|
|
12493
|
+
/**
|
|
12494
|
+
* @since 1.120
|
|
12495
|
+
*
|
|
12496
|
+
* Indication Color 15
|
|
12497
|
+
*/
|
|
12498
|
+
Indication15 = "Indication15",
|
|
12499
|
+
/**
|
|
12500
|
+
* @since 1.120
|
|
12501
|
+
*
|
|
12502
|
+
* Indication Color 16
|
|
12503
|
+
*/
|
|
12504
|
+
Indication16 = "Indication16",
|
|
12505
|
+
/**
|
|
12506
|
+
* @since 1.120
|
|
12507
|
+
*
|
|
12508
|
+
* Indication Color 17
|
|
12509
|
+
*/
|
|
12510
|
+
Indication17 = "Indication17",
|
|
12511
|
+
/**
|
|
12512
|
+
* @since 1.120
|
|
12513
|
+
*
|
|
12514
|
+
* Indication Color 18
|
|
12515
|
+
*/
|
|
12516
|
+
Indication18 = "Indication18",
|
|
12517
|
+
/**
|
|
12518
|
+
* @since 1.120
|
|
12519
|
+
*
|
|
12520
|
+
* Indication Color 19
|
|
12521
|
+
*/
|
|
12522
|
+
Indication19 = "Indication19",
|
|
12523
|
+
/**
|
|
12524
|
+
* @since 1.120
|
|
12525
|
+
*
|
|
12526
|
+
* Indication Color 20
|
|
12527
|
+
*/
|
|
12528
|
+
Indication20 = "Indication20",
|
|
11203
12529
|
}
|
|
11204
12530
|
/**
|
|
11205
12531
|
* @since 1.78
|
|
@@ -12050,6 +13376,8 @@ declare module "sap/ui/core/BusyIndicator" {
|
|
|
12050
13376
|
|
|
12051
13377
|
declare module "sap/ui/core/CalendarType" {
|
|
12052
13378
|
/**
|
|
13379
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/18n/date/CalendarType} instead.
|
|
13380
|
+
*
|
|
12053
13381
|
* The types of `Calendar`.
|
|
12054
13382
|
*/
|
|
12055
13383
|
enum CalendarType {
|
|
@@ -13192,7 +14520,9 @@ declare module "sap/ui/core/Component" {
|
|
|
13192
14520
|
}
|
|
13193
14521
|
export const registry: registry;
|
|
13194
14522
|
|
|
13195
|
-
export interface $ComponentSettings extends $ManagedObjectSettings {
|
|
14523
|
+
export interface $ComponentSettings extends $ManagedObjectSettings {
|
|
14524
|
+
componentData?: any;
|
|
14525
|
+
}
|
|
13196
14526
|
}
|
|
13197
14527
|
|
|
13198
14528
|
declare module "sap/ui/core/ComponentContainer" {
|
|
@@ -14222,6 +15552,8 @@ declare module "sap/ui/core/ComponentMetadata" {
|
|
|
14222
15552
|
}
|
|
14223
15553
|
|
|
14224
15554
|
declare module "sap/ui/core/Configuration" {
|
|
15555
|
+
import CalendarType from "sap/ui/core/CalendarType";
|
|
15556
|
+
|
|
14225
15557
|
import CalendarWeekNumbering from "sap/ui/core/date/CalendarWeekNumbering";
|
|
14226
15558
|
|
|
14227
15559
|
import Version from "sap/base/util/Version";
|
|
@@ -14232,11 +15564,11 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14232
15564
|
|
|
14233
15565
|
import { URI } from "sap/ui/core/library";
|
|
14234
15566
|
|
|
14235
|
-
import CalendarType from "sap/ui/core/CalendarType";
|
|
14236
|
-
|
|
14237
15567
|
import BaseObject from "sap/ui/base/Object";
|
|
14238
15568
|
|
|
14239
15569
|
/**
|
|
15570
|
+
* @deprecated (since 1.120)
|
|
15571
|
+
*
|
|
14240
15572
|
* Collects and stores the configuration of the current environment.
|
|
14241
15573
|
*
|
|
14242
15574
|
* The Configuration is initialized once when the {@link sap.ui.core.Core} is created. There are different
|
|
@@ -14263,6 +15595,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14263
15595
|
interface Configuration {
|
|
14264
15596
|
/**
|
|
14265
15597
|
* @since 1.50.0
|
|
15598
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/ui/core/AnimationMode} instead.
|
|
14266
15599
|
*
|
|
14267
15600
|
* Enumerable list with available animation modes.
|
|
14268
15601
|
*
|
|
@@ -14274,6 +15607,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14274
15607
|
|
|
14275
15608
|
/**
|
|
14276
15609
|
* @since 1.38.6
|
|
15610
|
+
* @deprecated (since 1.120)
|
|
14277
15611
|
*
|
|
14278
15612
|
* Applies multiple changes to the configuration at once.
|
|
14279
15613
|
*
|
|
@@ -14318,6 +15652,10 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14318
15652
|
FNMetaImpl?: Function
|
|
14319
15653
|
): Function;
|
|
14320
15654
|
/**
|
|
15655
|
+
* @since 1.20
|
|
15656
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.isAccessibilityEnabled }
|
|
15657
|
+
* instead.
|
|
15658
|
+
*
|
|
14321
15659
|
* Returns whether the accessibility mode is enabled or not.
|
|
14322
15660
|
*
|
|
14323
15661
|
* @returns whether the accessibility mode is enabled or not
|
|
@@ -14334,13 +15672,15 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14334
15672
|
*/
|
|
14335
15673
|
getActiveTerminologies(): string[] | undefined;
|
|
14336
15674
|
/**
|
|
15675
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getAllowlistService} instead.
|
|
15676
|
+
*
|
|
14337
15677
|
* URL of the allowlist service.
|
|
14338
15678
|
*
|
|
14339
15679
|
* @returns allowlist service URL
|
|
14340
15680
|
*/
|
|
14341
15681
|
getAllowlistService(): string;
|
|
14342
15682
|
/**
|
|
14343
|
-
* @deprecated (since 1.50
|
|
15683
|
+
* @deprecated (since 1.50) - Please use {@link sap.ui.core.Configuration#getAnimationMode} instead.
|
|
14344
15684
|
*
|
|
14345
15685
|
* Returns whether the animations are globally used.
|
|
14346
15686
|
*
|
|
@@ -14349,6 +15689,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14349
15689
|
getAnimation(): boolean;
|
|
14350
15690
|
/**
|
|
14351
15691
|
* @since 1.50.0
|
|
15692
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.getAnimationMode} instead.
|
|
14352
15693
|
*
|
|
14353
15694
|
* Returns the current animation mode.
|
|
14354
15695
|
*
|
|
@@ -14356,15 +15697,19 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14356
15697
|
*/
|
|
14357
15698
|
getAnimationMode(): AnimationMode;
|
|
14358
15699
|
/**
|
|
15700
|
+
* @deprecated (since 1.120)
|
|
15701
|
+
*
|
|
14359
15702
|
* Base URLs to AppCacheBuster ETag-Index files.
|
|
14360
15703
|
*
|
|
14361
15704
|
* @returns array of base URLs
|
|
14362
15705
|
*/
|
|
14363
15706
|
getAppCacheBuster(): string[];
|
|
14364
15707
|
/**
|
|
15708
|
+
* @deprecated (since 1.120)
|
|
15709
|
+
*
|
|
14365
15710
|
* The loading mode (sync|async|batch) of the AppCacheBuster (sync is default)
|
|
14366
15711
|
*
|
|
14367
|
-
* @returns "sync" | "async"
|
|
15712
|
+
* @returns "sync" | "async" | "batch"
|
|
14368
15713
|
*/
|
|
14369
15714
|
getAppCacheBusterMode(): string;
|
|
14370
15715
|
/**
|
|
@@ -14378,14 +15723,29 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14378
15723
|
getApplication(): string;
|
|
14379
15724
|
/**
|
|
14380
15725
|
* @since 1.27.0
|
|
15726
|
+
* @deprecated (since 1.120)
|
|
14381
15727
|
*
|
|
14382
15728
|
* Returns whether the framework automatically adds the ARIA role 'application' to the HTML body or not.
|
|
14383
15729
|
*
|
|
14384
15730
|
* @returns Wether the ARIA role 'application' should be added to the HTML body or not
|
|
14385
15731
|
*/
|
|
14386
15732
|
getAutoAriaBodyRole(): boolean;
|
|
15733
|
+
/**
|
|
15734
|
+
* @since 1.28.6
|
|
15735
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getCalendarType} instead.
|
|
15736
|
+
*
|
|
15737
|
+
* Returns the calendar type which is being used in locale dependent functionality.
|
|
15738
|
+
*
|
|
15739
|
+
* When it's explicitly set by calling `setCalendar`, the set calendar type is returned. Otherwise, the
|
|
15740
|
+
* calendar type is determined by checking the format settings and current locale.
|
|
15741
|
+
*
|
|
15742
|
+
* @returns the current calendar type, e.g. `Gregorian`
|
|
15743
|
+
*/
|
|
15744
|
+
getCalendarType(): CalendarType;
|
|
14387
15745
|
/**
|
|
14388
15746
|
* @since 1.113.0
|
|
15747
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getCalendarWeekNumbering }
|
|
15748
|
+
* instead.
|
|
14389
15749
|
*
|
|
14390
15750
|
* Returns the calendar week numbering algorithm used to determine the first day of the week and the first
|
|
14391
15751
|
* calendar week of the year, see {@link sap.ui.core.date.CalendarWeekNumbering}.
|
|
@@ -14407,6 +15767,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14407
15767
|
sFeature: string
|
|
14408
15768
|
): Version;
|
|
14409
15769
|
/**
|
|
15770
|
+
* @deprecated (since 1.120)
|
|
15771
|
+
*
|
|
14410
15772
|
* Returns whether the page runs in full debug mode.
|
|
14411
15773
|
*
|
|
14412
15774
|
* @returns Whether the page runs in full debug mode
|
|
@@ -14414,6 +15776,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14414
15776
|
getDebug(): boolean;
|
|
14415
15777
|
/**
|
|
14416
15778
|
* @since 1.102
|
|
15779
|
+
* @deprecated (since 1.120)
|
|
14417
15780
|
*
|
|
14418
15781
|
* Name (ID) of a UI5 module that implements file share support.
|
|
14419
15782
|
*
|
|
@@ -14425,6 +15788,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14425
15788
|
*/
|
|
14426
15789
|
getFileShareSupport(): string | undefined;
|
|
14427
15790
|
/**
|
|
15791
|
+
* @deprecated (since 1.120)
|
|
15792
|
+
*
|
|
14428
15793
|
* Returns whether the Fiori2Adaptation is on.
|
|
14429
15794
|
*
|
|
14430
15795
|
* @returns false - no adaptation, true - full adaptation, comma-separated list - partial adaptation Possible
|
|
@@ -14433,6 +15798,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14433
15798
|
getFiori2Adaptation(): boolean | string;
|
|
14434
15799
|
/**
|
|
14435
15800
|
* @since 1.60.0
|
|
15801
|
+
* @deprecated (since 1.120)
|
|
14436
15802
|
*
|
|
14437
15803
|
* Returns the URL from where the UI5 flexibility services are called; if empty, the flexibility services
|
|
14438
15804
|
* are not called.
|
|
@@ -14441,6 +15807,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14441
15807
|
*/
|
|
14442
15808
|
getFlexibilityServices(): object[];
|
|
14443
15809
|
/**
|
|
15810
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getLanguageTag} instead.
|
|
15811
|
+
*
|
|
14444
15812
|
* Returns the format locale string with language and region code. Falls back to language configuration,
|
|
14445
15813
|
* in case it has not been explicitly defined.
|
|
14446
15814
|
*
|
|
@@ -14448,18 +15816,24 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14448
15816
|
*/
|
|
14449
15817
|
getFormatLocale(): string;
|
|
14450
15818
|
/**
|
|
15819
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting} instead.
|
|
15820
|
+
*
|
|
14451
15821
|
* Returns a configuration object that bundles the format settings of UI5.
|
|
14452
15822
|
*
|
|
14453
15823
|
* @returns A FormatSettings object.
|
|
14454
15824
|
*/
|
|
14455
15825
|
getFormatSettings(): FormatSettings;
|
|
14456
15826
|
/**
|
|
15827
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getFrameOptions} instead.
|
|
15828
|
+
*
|
|
14457
15829
|
* frameOptions mode (allow/deny/trusted).
|
|
14458
15830
|
*
|
|
14459
15831
|
* @returns frameOptions mode
|
|
14460
15832
|
*/
|
|
14461
15833
|
getFrameOptions(): string;
|
|
14462
15834
|
/**
|
|
15835
|
+
* @deprecated (since 1.120)
|
|
15836
|
+
*
|
|
14463
15837
|
* Returns whether the UI5 control inspe ctor is displayed. Has only an effect when the sap-ui-debug module
|
|
14464
15838
|
* has been loaded
|
|
14465
15839
|
*
|
|
@@ -14467,6 +15841,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14467
15841
|
*/
|
|
14468
15842
|
getInspect(): boolean;
|
|
14469
15843
|
/**
|
|
15844
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguage} instead.
|
|
15845
|
+
*
|
|
14470
15846
|
* Returns a string that identifies the current language.
|
|
14471
15847
|
*
|
|
14472
15848
|
* The value returned by config method in most cases corresponds to the exact value that has been configured
|
|
@@ -14500,6 +15876,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14500
15876
|
*/
|
|
14501
15877
|
getLanguage(): string;
|
|
14502
15878
|
/**
|
|
15879
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguageTag} instead.
|
|
15880
|
+
*
|
|
14503
15881
|
* Returns a BCP47-compliant language tag for the current language.
|
|
14504
15882
|
*
|
|
14505
15883
|
* The return value of config method is especially useful for an HTTP `Accept-Language` header.
|
|
@@ -14510,6 +15888,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14510
15888
|
*/
|
|
14511
15889
|
getLanguageTag(): string;
|
|
14512
15890
|
/**
|
|
15891
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguageTag} instead.
|
|
15892
|
+
*
|
|
14513
15893
|
* Returns a Locale object for the current language.
|
|
14514
15894
|
*
|
|
14515
15895
|
* The Locale is derived from the {@link #getLanguage language} property.
|
|
@@ -14519,6 +15899,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14519
15899
|
getLocale(): Locale;
|
|
14520
15900
|
/**
|
|
14521
15901
|
* @since 1.33.0
|
|
15902
|
+
* @deprecated (since 1.120) - 'manifest-first' is the default for the {@link sap.ui.core.Component.create }
|
|
15903
|
+
* factory.
|
|
14522
15904
|
*
|
|
14523
15905
|
* Flag whether a Component should load the manifest first.
|
|
14524
15906
|
*
|
|
@@ -14532,12 +15914,16 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14532
15914
|
*/
|
|
14533
15915
|
getMetadata(): Metadata;
|
|
14534
15916
|
/**
|
|
15917
|
+
* @deprecated (since 1.120)
|
|
15918
|
+
*
|
|
14535
15919
|
* Returns whether there should be an exception on any duplicate element IDs.
|
|
14536
15920
|
*
|
|
14537
15921
|
* @returns whether there should be an exception on any duplicate element IDs
|
|
14538
15922
|
*/
|
|
14539
15923
|
getNoDuplicateIds(): boolean;
|
|
14540
15924
|
/**
|
|
15925
|
+
* @deprecated (since 1.120)
|
|
15926
|
+
*
|
|
14541
15927
|
* Returns whether the text origin information is collected.
|
|
14542
15928
|
*
|
|
14543
15929
|
* @returns whether the text info is collected
|
|
@@ -14552,6 +15938,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14552
15938
|
*/
|
|
14553
15939
|
getRootComponent(): string;
|
|
14554
15940
|
/**
|
|
15941
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getRTL} instead.
|
|
15942
|
+
*
|
|
14555
15943
|
* Returns whether the page uses the RTL text direction.
|
|
14556
15944
|
*
|
|
14557
15945
|
* If no mode has been explicitly set (neither `true` nor `false`), the mode is derived from the current
|
|
@@ -14561,6 +15949,9 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14561
15949
|
*/
|
|
14562
15950
|
getRTL(): boolean;
|
|
14563
15951
|
/**
|
|
15952
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getSAPLogonLanguage }
|
|
15953
|
+
* instead.
|
|
15954
|
+
*
|
|
14564
15955
|
* Returns an SAP logon language for the current language.
|
|
14565
15956
|
*
|
|
14566
15957
|
* It will be returned in uppercase. e.g. "EN", "DE"
|
|
@@ -14569,7 +15960,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14569
15960
|
*/
|
|
14570
15961
|
getSAPLogonLanguage(): string;
|
|
14571
15962
|
/**
|
|
14572
|
-
* @since 1.
|
|
15963
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getSecurityTokenHandlers }
|
|
15964
|
+
* instead.
|
|
14573
15965
|
*
|
|
14574
15966
|
* Returns the security token handlers of an OData V4 model.
|
|
14575
15967
|
* See:
|
|
@@ -14580,6 +15972,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14580
15972
|
getSecurityTokenHandlers(): Array<(p1: URI) => Promise<any>>;
|
|
14581
15973
|
/**
|
|
14582
15974
|
* @since 1.106.0
|
|
15975
|
+
* @deprecated (since 1.120)
|
|
14583
15976
|
*
|
|
14584
15977
|
* Flag if statistics are requested.
|
|
14585
15978
|
*
|
|
@@ -14590,19 +15983,23 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14590
15983
|
*/
|
|
14591
15984
|
getStatisticsEnabled(): boolean;
|
|
14592
15985
|
/**
|
|
15986
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.getTheme} instead.
|
|
15987
|
+
*
|
|
14593
15988
|
* Returns the theme name
|
|
14594
15989
|
*
|
|
14595
15990
|
* @returns the theme name
|
|
14596
15991
|
*/
|
|
14597
15992
|
getTheme(): string;
|
|
14598
15993
|
/**
|
|
15994
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getTimezone} instead.
|
|
15995
|
+
*
|
|
14599
15996
|
* Retrieves the configured IANA timezone ID.
|
|
14600
15997
|
*
|
|
14601
15998
|
* @returns The configured IANA timezone ID, e.g. "America/New_York"
|
|
14602
15999
|
*/
|
|
14603
16000
|
getTimezone(): string;
|
|
14604
16001
|
/**
|
|
14605
|
-
* @deprecated (since 1.119
|
|
16002
|
+
* @deprecated (since 1.119) - Please use {@link sap.ui.base.ManagedObjectMetadata.getUIDPrefix ManagedObjectMetadata.getUIDPrefix }
|
|
14606
16003
|
* instead.
|
|
14607
16004
|
*
|
|
14608
16005
|
* Prefix to be used for automatically generated control IDs. Default is a double underscore "__".
|
|
@@ -14611,6 +16008,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14611
16008
|
*/
|
|
14612
16009
|
getUIDPrefix(): string;
|
|
14613
16010
|
/**
|
|
16011
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/ui/VersionInfo.load} instead.
|
|
16012
|
+
*
|
|
14614
16013
|
* Returns the version of the framework.
|
|
14615
16014
|
*
|
|
14616
16015
|
* Similar to `sap.ui.version`.
|
|
@@ -14619,9 +16018,9 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14619
16018
|
*/
|
|
14620
16019
|
getVersion(): Version;
|
|
14621
16020
|
/**
|
|
14622
|
-
* @deprecated (since 1.85
|
|
14623
|
-
* to replace insensitive terms with inclusive language. Since APIs cannot be renamed or immediately
|
|
14624
|
-
* for compatibility reasons, this API has been deprecated.
|
|
16021
|
+
* @deprecated (since 1.85) - Use {@link module:sap/ui/security/Security.getAllowlistService} instead. SAP
|
|
16022
|
+
* strives to replace insensitive terms with inclusive language. Since APIs cannot be renamed or immediately
|
|
16023
|
+
* removed for compatibility reasons, this API has been deprecated.
|
|
14625
16024
|
*
|
|
14626
16025
|
* URL of the whitelist service.
|
|
14627
16026
|
*
|
|
@@ -14630,6 +16029,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14630
16029
|
getWhitelistService(): string;
|
|
14631
16030
|
/**
|
|
14632
16031
|
* @since 1.50.0
|
|
16032
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.setAnimationMode} instead.
|
|
14633
16033
|
*
|
|
14634
16034
|
* Sets the current animation mode.
|
|
14635
16035
|
*
|
|
@@ -14646,6 +16046,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14646
16046
|
): void;
|
|
14647
16047
|
/**
|
|
14648
16048
|
* @since 1.28.6
|
|
16049
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setCalendarType} instead.
|
|
14649
16050
|
*
|
|
14650
16051
|
* Sets the new calendar type to be used from now on in locale dependent functionality (for example, formatting,
|
|
14651
16052
|
* translation texts, etc.).
|
|
@@ -14661,6 +16062,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14661
16062
|
): this;
|
|
14662
16063
|
/**
|
|
14663
16064
|
* @since 1.113.0
|
|
16065
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setCalendarWeekNumbering }
|
|
16066
|
+
* instead.
|
|
14664
16067
|
*
|
|
14665
16068
|
* Sets the calendar week numbering algorithm which is used to determine the first day of the week and the
|
|
14666
16069
|
* first calendar week of the year, see {@link sap.ui.core.date.CalendarWeekNumbering}.
|
|
@@ -14674,6 +16077,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14674
16077
|
sCalendarWeekNumbering: CalendarWeekNumbering
|
|
14675
16078
|
): this;
|
|
14676
16079
|
/**
|
|
16080
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setLanguageTag} instead.
|
|
16081
|
+
*
|
|
14677
16082
|
* Sets a new format locale to be used from now on for retrieving locale specific formatters. Modifying
|
|
14678
16083
|
* this setting does not have an impact on the retrieval of translated texts!
|
|
14679
16084
|
*
|
|
@@ -14698,6 +16103,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14698
16103
|
sFormatLocale: string | null
|
|
14699
16104
|
): this;
|
|
14700
16105
|
/**
|
|
16106
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setLanguage} instead.
|
|
16107
|
+
*
|
|
14701
16108
|
* Sets a new language to be used from now on for language/region dependent functionality (e.g. formatting,
|
|
14702
16109
|
* data types, translated texts, ...).
|
|
14703
16110
|
*
|
|
@@ -14742,6 +16149,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14742
16149
|
* **Note**: When using config method please take note of and respect the above mentioned restrictions.
|
|
14743
16150
|
* See:
|
|
14744
16151
|
* http://scn.sap.com/docs/DOC-14377
|
|
16152
|
+
*
|
|
16153
|
+
* @returns `this` to allow method chaining
|
|
14745
16154
|
*/
|
|
14746
16155
|
setLanguage(
|
|
14747
16156
|
/**
|
|
@@ -14755,8 +16164,10 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14755
16164
|
* `sLanguage` as SAP Logon language.
|
|
14756
16165
|
*/
|
|
14757
16166
|
sSAPLogonLanguage?: string
|
|
14758
|
-
):
|
|
16167
|
+
): this;
|
|
14759
16168
|
/**
|
|
16169
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setRTL} instead.
|
|
16170
|
+
*
|
|
14760
16171
|
* Sets the character orientation mode to be used from now on.
|
|
14761
16172
|
*
|
|
14762
16173
|
* Can either be set to a concrete value (true meaning right-to-left, false meaning left-to-right) or to
|
|
@@ -14777,7 +16188,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14777
16188
|
bRTL: boolean | null
|
|
14778
16189
|
): this;
|
|
14779
16190
|
/**
|
|
14780
|
-
* @since 1.
|
|
16191
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.setSecurityTokenHandlers }
|
|
16192
|
+
* instead.
|
|
14781
16193
|
*
|
|
14782
16194
|
* Sets the security token handlers for an OData V4 model. See chapter {@link https://ui5.sap.com/#/topic/9613f1f2d88747cab21896f7216afdac/section_STH Security Token Handling}.
|
|
14783
16195
|
* See:
|
|
@@ -14790,6 +16202,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14790
16202
|
aSecurityTokenHandlers: Array<(p1: URI) => Promise<any>>
|
|
14791
16203
|
): void;
|
|
14792
16204
|
/**
|
|
16205
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.setTheme} instead.
|
|
16206
|
+
*
|
|
14793
16207
|
* Allows setting the theme name
|
|
14794
16208
|
*
|
|
14795
16209
|
* @returns `this` to allow method chaining
|
|
@@ -14802,6 +16216,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14802
16216
|
): this;
|
|
14803
16217
|
/**
|
|
14804
16218
|
* @since 1.99.0
|
|
16219
|
+
* @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setTimezone} instead.
|
|
14805
16220
|
*
|
|
14806
16221
|
* Sets the timezone such that all date and time based calculations use config timezone.
|
|
14807
16222
|
*
|
|
@@ -14829,6 +16244,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14829
16244
|
|
|
14830
16245
|
/**
|
|
14831
16246
|
* @since 1.50.0
|
|
16247
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/ui/core/AnimationMode} instead.
|
|
14832
16248
|
*
|
|
14833
16249
|
* Enumerable list with available animation modes.
|
|
14834
16250
|
*
|
|
@@ -14855,6 +16271,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14855
16271
|
none = "undefined",
|
|
14856
16272
|
}
|
|
14857
16273
|
/**
|
|
16274
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting} instead.
|
|
16275
|
+
*
|
|
14858
16276
|
* Encapsulates configuration settings that are related to data formatting/parsing.
|
|
14859
16277
|
*
|
|
14860
16278
|
* **Note:** When format configuration settings are modified through this class, UI5 only ensures that formatter
|
|
@@ -14894,26 +16312,33 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14894
16312
|
*/
|
|
14895
16313
|
static getMetadata(): Metadata;
|
|
14896
16314
|
/**
|
|
16315
|
+
* @since 1.120
|
|
16316
|
+
*
|
|
14897
16317
|
* Adds custom currencies to the existing entries. E.g. ` { "KWD": {"digits": 3}, "TND" : {"digits": 3 }
|
|
14898
16318
|
* } `
|
|
14899
16319
|
* See:
|
|
14900
|
-
*
|
|
14901
|
-
*
|
|
14902
|
-
* @returns Returns `this` to allow method chaining
|
|
16320
|
+
* {@link module:sap/base/i18n/Formatting.setCustomCurrencies}
|
|
14903
16321
|
*/
|
|
14904
16322
|
addCustomCurrencies(
|
|
14905
16323
|
/**
|
|
14906
16324
|
* adds to the currency map
|
|
14907
16325
|
*/
|
|
14908
16326
|
mCurrencies: object
|
|
14909
|
-
):
|
|
16327
|
+
): void;
|
|
14910
16328
|
/**
|
|
16329
|
+
* @since 1.120
|
|
16330
|
+
*
|
|
14911
16331
|
* Retrieves the custom currencies. E.g. ` { "KWD": {"digits": 3}, "TND" : {"digits": 3} } `
|
|
16332
|
+
* See:
|
|
16333
|
+
* {@link module:sap/base/i18n/Formatting.setCustomCurrencies}
|
|
16334
|
+
* {@link module:sap/base/i18n/Formatting.addCustomCurrencies}
|
|
14912
16335
|
*
|
|
14913
16336
|
* @returns the mapping between custom currencies and its digits
|
|
14914
16337
|
*/
|
|
14915
16338
|
getCustomCurrencies(): object;
|
|
14916
16339
|
/**
|
|
16340
|
+
* @since 1.120
|
|
16341
|
+
*
|
|
14917
16342
|
* Returns the currently set date pattern or undefined if no pattern has been defined.
|
|
14918
16343
|
*
|
|
14919
16344
|
* @returns The resulting date pattern
|
|
@@ -14925,6 +16350,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14925
16350
|
sStyle: "short" | "medium" | "long" | "full"
|
|
14926
16351
|
): string;
|
|
14927
16352
|
/**
|
|
16353
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getLanguageTag} instead.
|
|
16354
|
+
*
|
|
14928
16355
|
* Returns the locale to be used for formatting.
|
|
14929
16356
|
*
|
|
14930
16357
|
* If no such locale has been defined, this method falls back to the language, see {@link sap.ui.core.Configuration#getLanguage Configuration.getLanguage()}.
|
|
@@ -14937,44 +16364,17 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14937
16364
|
*/
|
|
14938
16365
|
getFormatLocale(): Locale;
|
|
14939
16366
|
/**
|
|
16367
|
+
* @since 1.120
|
|
16368
|
+
*
|
|
14940
16369
|
* Returns the currently set customizing data for Islamic calendar support
|
|
14941
16370
|
*
|
|
14942
16371
|
* @returns Returns an array contains the customizing data. Each element in the array has properties: dateFormat,
|
|
14943
16372
|
* islamicMonthStart, gregDate. For details, please see {@link #setLegacyDateCalendarCustomizing}
|
|
14944
16373
|
*/
|
|
14945
|
-
getLegacyDateCalendarCustomizing(): object[];
|
|
14946
|
-
/**
|
|
14947
|
-
* Returns the currently set legacy ABAP date format (its id) or undefined if none has been set.
|
|
14948
|
-
*
|
|
14949
|
-
* @returns ID of the ABAP date format, if not set or set to `""`, `undefined` will be returned
|
|
14950
|
-
*/
|
|
14951
|
-
getLegacyDateFormat():
|
|
14952
|
-
| "1"
|
|
14953
|
-
| "2"
|
|
14954
|
-
| "3"
|
|
14955
|
-
| "4"
|
|
14956
|
-
| "5"
|
|
14957
|
-
| "6"
|
|
14958
|
-
| "7"
|
|
14959
|
-
| "8"
|
|
14960
|
-
| "9"
|
|
14961
|
-
| "A"
|
|
14962
|
-
| "B"
|
|
14963
|
-
| "C"
|
|
14964
|
-
| undefined;
|
|
14965
|
-
/**
|
|
14966
|
-
* Returns the currently set legacy ABAP number format (its id) or undefined if none has been set.
|
|
14967
|
-
*
|
|
14968
|
-
* @returns ID of the ABAP number format, if not set or set to `""`, `undefined` will be returned
|
|
14969
|
-
*/
|
|
14970
|
-
getLegacyNumberFormat(): " " | "X" | "Y" | undefined;
|
|
16374
|
+
getLegacyDateCalendarCustomizing(): object[] | undefined;
|
|
14971
16375
|
/**
|
|
14972
|
-
*
|
|
16376
|
+
* @since 1.120
|
|
14973
16377
|
*
|
|
14974
|
-
* @returns ID of the ABAP date format, if not set or set to `""`, `undefined` will be returned
|
|
14975
|
-
*/
|
|
14976
|
-
getLegacyTimeFormat(): "0" | "1" | "2" | "3" | "4" | undefined;
|
|
14977
|
-
/**
|
|
14978
16378
|
* Returns the currently set number symbol of the given type or undefined if no symbol has been defined.
|
|
14979
16379
|
*
|
|
14980
16380
|
* @returns A non-numerical symbol used as part of a number for the given type, e.g. for locale de_DE:
|
|
@@ -14991,6 +16391,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
14991
16391
|
sType: "group" | "decimal" | "plusSign" | "minusSign"
|
|
14992
16392
|
): string;
|
|
14993
16393
|
/**
|
|
16394
|
+
* @since 1.120
|
|
16395
|
+
*
|
|
14994
16396
|
* Returns the currently set time pattern or undefined if no pattern has been defined.
|
|
14995
16397
|
*
|
|
14996
16398
|
* @returns The resulting time pattern
|
|
@@ -15002,7 +16404,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
15002
16404
|
sStyle: "short" | "medium" | "long" | "full"
|
|
15003
16405
|
): string;
|
|
15004
16406
|
/**
|
|
15005
|
-
* @since 1.
|
|
16407
|
+
* @since 1.120
|
|
15006
16408
|
*
|
|
15007
16409
|
* Returns current trailingCurrencyCode configuration for new NumberFormatter instances
|
|
15008
16410
|
*
|
|
@@ -15010,6 +16412,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
15010
16412
|
*/
|
|
15011
16413
|
getTrailingCurrencyCode(): boolean;
|
|
15012
16414
|
/**
|
|
16415
|
+
* @since 1.120
|
|
16416
|
+
*
|
|
15013
16417
|
* Sets custom currencies and replaces existing entries.
|
|
15014
16418
|
*
|
|
15015
16419
|
* There is a special currency code named "DEFAULT" that is optional. In case it is set it will be used
|
|
@@ -15025,15 +16429,15 @@ declare module "sap/ui/core/Configuration" {
|
|
|
15025
16429
|
* Note: To unset the custom currencies: call with `undefined` Custom currencies must not only consist of
|
|
15026
16430
|
* digits but contain at least one non-digit character, e.g. "a", so that the measure part can be distinguished
|
|
15027
16431
|
* from the number part.
|
|
15028
|
-
*
|
|
15029
|
-
*
|
|
16432
|
+
* See:
|
|
16433
|
+
* {@link module:sap/base/i18n/Formatting.addCustomCurrencies}
|
|
15030
16434
|
*/
|
|
15031
16435
|
setCustomCurrencies(
|
|
15032
16436
|
/**
|
|
15033
16437
|
* currency map which is set
|
|
15034
16438
|
*/
|
|
15035
16439
|
mCurrencies: object
|
|
15036
|
-
):
|
|
16440
|
+
): void;
|
|
15037
16441
|
/**
|
|
15038
16442
|
* Defines the preferred format pattern for the given date format style.
|
|
15039
16443
|
*
|
|
@@ -15059,7 +16463,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
15059
16463
|
sPattern: string
|
|
15060
16464
|
): this;
|
|
15061
16465
|
/**
|
|
15062
|
-
* @deprecated (since 1.113
|
|
16466
|
+
* @deprecated (since 1.113) - Use {@link sap.ui.core.Configuration.FormatSettings#setCalendarWeekNumbering }
|
|
15063
16467
|
* instead.
|
|
15064
16468
|
*
|
|
15065
16469
|
* Defines the day used as the first day of the week.
|
|
@@ -15084,9 +16488,9 @@ declare module "sap/ui/core/Configuration" {
|
|
|
15084
16488
|
iValue: int
|
|
15085
16489
|
): this;
|
|
15086
16490
|
/**
|
|
15087
|
-
*
|
|
16491
|
+
* @since 1.120
|
|
15088
16492
|
*
|
|
15089
|
-
*
|
|
16493
|
+
* Allows to specify the customizing data for Islamic calendar support
|
|
15090
16494
|
*/
|
|
15091
16495
|
setLegacyDateCalendarCustomizing(
|
|
15092
16496
|
/**
|
|
@@ -15106,7 +16510,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
15106
16510
|
*/
|
|
15107
16511
|
gregDate: string;
|
|
15108
16512
|
}>
|
|
15109
|
-
):
|
|
16513
|
+
): void;
|
|
15110
16514
|
/**
|
|
15111
16515
|
* Allows to specify one of the legacy ABAP date formats.
|
|
15112
16516
|
*
|
|
@@ -15225,7 +16629,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
15225
16629
|
sPattern: string
|
|
15226
16630
|
): this;
|
|
15227
16631
|
/**
|
|
15228
|
-
* @since 1.
|
|
16632
|
+
* @since 1.120
|
|
15229
16633
|
*
|
|
15230
16634
|
* Define whether the NumberFormatter shall always place the currency code after the numeric value, with
|
|
15231
16635
|
* the only exception of right-to-left locales, where the currency code shall be placed before the numeric
|
|
@@ -15236,15 +16640,13 @@ declare module "sap/ui/core/Configuration" {
|
|
|
15236
16640
|
*
|
|
15237
16641
|
* Each currency instance ({@link sap.ui.core.format.NumberFormat.getCurrencyInstance}) will be created
|
|
15238
16642
|
* with this setting unless overwritten on instance level.
|
|
15239
|
-
*
|
|
15240
|
-
* @returns Returns `this` to allow method chaining
|
|
15241
16643
|
*/
|
|
15242
16644
|
setTrailingCurrencyCode(
|
|
15243
16645
|
/**
|
|
15244
16646
|
* Whether currency codes shall always be placed after the numeric value
|
|
15245
16647
|
*/
|
|
15246
16648
|
bTrailingCurrencyCode: boolean
|
|
15247
|
-
):
|
|
16649
|
+
): void;
|
|
15248
16650
|
}
|
|
15249
16651
|
}
|
|
15250
16652
|
|
|
@@ -17089,6 +18491,9 @@ declare module "sap/ui/core/Core" {
|
|
|
17089
18491
|
*/
|
|
17090
18492
|
getComponent(sId: string): Component;
|
|
17091
18493
|
/**
|
|
18494
|
+
* @deprecated (since 1.120) - Please see {@link sap.ui.core.Configuration Configuration} for the corrsponding
|
|
18495
|
+
* replacements.
|
|
18496
|
+
*
|
|
17092
18497
|
* Returns the Configuration of the Core.
|
|
17093
18498
|
*
|
|
17094
18499
|
* @returns the Configuration of the current Core.
|
|
@@ -18120,6 +19525,7 @@ declare module "sap/ui/core/CustomData" {
|
|
|
18120
19525
|
declare module "sap/ui/core/date/CalendarWeekNumbering" {
|
|
18121
19526
|
/**
|
|
18122
19527
|
* @since 1.108.0
|
|
19528
|
+
* @deprecated (since 1.120) - Please use {@link module:sap/base/18n/date/CalendarWeekNumbering} instead.
|
|
18123
19529
|
*
|
|
18124
19530
|
* The `CalendarWeekNumbering` enum defines how to calculate calendar weeks. Each value defines:
|
|
18125
19531
|
* - The first day of the week,
|
|
@@ -18158,6 +19564,8 @@ declare module "sap/ui/core/DeclarativeSupport" {
|
|
|
18158
19564
|
|
|
18159
19565
|
/**
|
|
18160
19566
|
* @since 1.7.0
|
|
19567
|
+
* @deprecated (since 1.120) - Please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed Views }
|
|
19568
|
+
* instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
|
|
18161
19569
|
*
|
|
18162
19570
|
* Static class for enabling declarative UI support.
|
|
18163
19571
|
*/
|
|
@@ -23988,6 +25396,10 @@ declare module "sap/ui/core/Fragment" {
|
|
|
23988
25396
|
|
|
23989
25397
|
export interface $FragmentSettings extends $ManagedObjectSettings {
|
|
23990
25398
|
type?: string | PropertyBindingInfo;
|
|
25399
|
+
|
|
25400
|
+
fragmentName?: string;
|
|
25401
|
+
|
|
25402
|
+
fragmentContent?: any;
|
|
23991
25403
|
}
|
|
23992
25404
|
}
|
|
23993
25405
|
|
|
@@ -26682,7 +28094,7 @@ declare module "sap/ui/core/Lib" {
|
|
|
26682
28094
|
* Provides information about a library.
|
|
26683
28095
|
*
|
|
26684
28096
|
* 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 `
|
|
28097
|
+
* module) is executing, typically at its begin. The single parameter `mSettings` is an info object that
|
|
26686
28098
|
* describes the content of the library.
|
|
26687
28099
|
*
|
|
26688
28100
|
* When the `mSettings` has been processed, a normalized version will be set on the library instance Finally,
|
|
@@ -26696,10 +28108,10 @@ declare module "sap/ui/core/Lib" {
|
|
|
26696
28108
|
* - If the object contains a list of `interfaces`, they will be registered with the {@link sap.ui.base.DataType }
|
|
26697
28109
|
* class to make them available as aggregation types in managed objects.
|
|
26698
28110
|
*
|
|
28111
|
+
* If the object contains a list of `controls` or `elements`, {@link sap.ui.lazyRequire lazy stubs }
|
|
28112
|
+
* will be created for their constructor as well as for their static `extend` and `getMetadata` methods.
|
|
26699
28113
|
*
|
|
26700
|
-
*
|
|
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
|
|
28114
|
+
* **Note:** Future versions of UI5 will abandon the concept of lazy stubs as it requires synchronous XMLHttpRequests
|
|
26703
28115
|
* which have been deprecated (see {@link http://xhr.spec.whatwg.org}). To be on the safe side, productive
|
|
26704
28116
|
* applications should always require any modules that they directly depend on.
|
|
26705
28117
|
*
|
|
@@ -26711,31 +28123,36 @@ declare module "sap/ui/core/Lib" {
|
|
|
26711
28123
|
* is e.g. useful when an application merges the CSS for multiple libraries and already loaded the resulting
|
|
26712
28124
|
* stylesheet.
|
|
26713
28125
|
*
|
|
28126
|
+
* If a list of library `dependencies` is specified in the info object, those libraries will be loaded
|
|
28127
|
+
* synchronously if they haven't been loaded yet.
|
|
26714
28128
|
*
|
|
26715
|
-
*
|
|
26716
|
-
*
|
|
26717
|
-
*
|
|
26718
|
-
*
|
|
26719
|
-
*
|
|
28129
|
+
* **Note:** Dependencies between libraries have to be modeled consistently in several places:
|
|
28130
|
+
* - Both eager and lazy dependencies have to be modelled in the `.library` file.
|
|
28131
|
+
* - By default, UI5 Tooling generates a `manifest.json` file from the content of the `.library` file.
|
|
28132
|
+
* However, if the `manifest.json` file for the library is not generated but maintained manually, it must
|
|
28133
|
+
* be kept consistent with the `.library` file, especially regarding its listed library dependencies.
|
|
28134
|
+
* - All eager library dependencies must be declared as AMD dependencies of the `library.js` module by
|
|
28135
|
+
* referring to the corresponding `"some/lib/namespace/library"` module of each library dependency.
|
|
28136
|
+
*
|
|
28137
|
+
* - All eager dependencies must be listed in the `dependencies` property of the info object.
|
|
28138
|
+
* - All lazy dependencies **must not** be listed as AMD dependencies or in the `dependencies` property
|
|
28139
|
+
* of the info object.
|
|
26720
28140
|
*
|
|
26721
28141
|
* Last but not least, higher layer frameworks might want to include their own metadata for libraries. The
|
|
26722
28142
|
* property `extensions` might contain such additional metadata. Its structure is not defined by the framework,
|
|
26723
28143
|
* but it is strongly suggested that each extension only occupies a single property in the `extensions`
|
|
26724
28144
|
* object and that the name of that property contains some namespace information (e.g. library name that
|
|
26725
28145
|
* 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
|
|
28146
|
+
* of `extensions` but will make it available in the library info objects provided by {@link #.load}.
|
|
26727
28147
|
*
|
|
26728
28148
|
* Relationship to Descriptor for Libraries (manifest.json):
|
|
26729
28149
|
*
|
|
26730
28150
|
* 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
|
|
26732
|
-
* in `
|
|
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.
|
|
28151
|
+
* the same library (its `manifest.json` file). Future versions of UI5 will ignore the information provided
|
|
28152
|
+
* in `mSettings` and will evaluate the descriptor file instead. Library developers therefore must keep
|
|
28153
|
+
* the information in both files in sync if the `manifest.json` file is maintained manually.
|
|
26737
28154
|
*
|
|
26738
|
-
* @returns
|
|
28155
|
+
* @returns Returns the library namespace, based on the given library name.
|
|
26739
28156
|
*/
|
|
26740
28157
|
static init(
|
|
26741
28158
|
/**
|
|
@@ -26845,13 +28262,11 @@ declare module "sap/ui/core/Lib" {
|
|
|
26845
28262
|
* library:
|
|
26846
28263
|
* ```javascript
|
|
26847
28264
|
*
|
|
26848
|
-
*
|
|
26849
|
-
*
|
|
26850
|
-
*
|
|
26851
|
-
*
|
|
26852
|
-
*
|
|
26853
|
-
* });
|
|
26854
|
-
* });
|
|
28265
|
+
* await Library.load({name: "heavy.charting"});
|
|
28266
|
+
* await View.create({
|
|
28267
|
+
* name: "myapp.views.HeavyChartingView",
|
|
28268
|
+
* type: ViewType.XML
|
|
28269
|
+
* });
|
|
26855
28270
|
* ```
|
|
26856
28271
|
*
|
|
26857
28272
|
*
|
|
@@ -27784,9 +29199,28 @@ declare module "sap/ui/core/LocaleData" {
|
|
|
27784
29199
|
sCalendarType?: CalendarType
|
|
27785
29200
|
): string;
|
|
27786
29201
|
/**
|
|
27787
|
-
*
|
|
29202
|
+
* Gets the locale-specific language name for the given language tag.
|
|
29203
|
+
*
|
|
29204
|
+
* The languages returned by {@link #getLanguages} from the CLDR raw data do not contain the language names
|
|
29205
|
+
* if they can be derived from the language and the script or the territory. If the map of languages contains
|
|
29206
|
+
* no entry for the given language tag, derive the language name from the used script or region.
|
|
29207
|
+
*
|
|
29208
|
+
* @returns The language name, or `undefined` if the name cannot be determined
|
|
29209
|
+
*/
|
|
29210
|
+
getLanguageName(
|
|
29211
|
+
/**
|
|
29212
|
+
* The language tag, for example "en", "en-US", "en_US", "zh-Hant", or "zh_Hant"
|
|
29213
|
+
*/
|
|
29214
|
+
sLanguageTag: string
|
|
29215
|
+
): string | undefined;
|
|
29216
|
+
/**
|
|
29217
|
+
* Gets locale-specific language names, as available in the CLDR raw data.
|
|
29218
|
+
*
|
|
29219
|
+
* To avoid redundancies, with CLDR version 43 only language names are contained which cannot be derived
|
|
29220
|
+
* from the language and the script or the territory. If a language tag is not contained in the map, use
|
|
29221
|
+
* {@link #getLanguageName} to get the derived locale-specific language name for that language tag.
|
|
27788
29222
|
*
|
|
27789
|
-
* @returns
|
|
29223
|
+
* @returns Maps a language tag to the locale-specific language name
|
|
27790
29224
|
*/
|
|
27791
29225
|
getLanguages(): Record<string, string>;
|
|
27792
29226
|
/**
|
|
@@ -28169,15 +29603,22 @@ declare module "sap/ui/core/LocaleData" {
|
|
|
28169
29603
|
sUnit: string
|
|
28170
29604
|
): object;
|
|
28171
29605
|
/**
|
|
28172
|
-
*
|
|
29606
|
+
* Gets locale-specific script names, as available in the CLDR raw data.
|
|
28173
29607
|
*
|
|
28174
|
-
*
|
|
29608
|
+
* To avoid redundancies, with CLDR version 43 only scripts are contained for which the language-specific
|
|
29609
|
+
* name is different from the script key. If a script key is not contained in the map, use the script key
|
|
29610
|
+
* as script name.
|
|
29611
|
+
*
|
|
29612
|
+
* @returns Maps a script key to the locale-specific script name
|
|
28175
29613
|
*/
|
|
28176
29614
|
getScripts(): Record<string, string>;
|
|
28177
29615
|
/**
|
|
28178
|
-
*
|
|
29616
|
+
* Gets locale-specific territory names, as available in the CLDR raw data.
|
|
29617
|
+
*
|
|
29618
|
+
* To avoid redundancies, with CLDR version 43 only territories are contained for which the language-specific
|
|
29619
|
+
* name is different from the territory key.
|
|
28179
29620
|
*
|
|
28180
|
-
* @returns
|
|
29621
|
+
* @returns Maps a territory key to the locale-specific territory name
|
|
28181
29622
|
*/
|
|
28182
29623
|
getTerritories(): Record<string, string>;
|
|
28183
29624
|
/**
|
|
@@ -29984,7 +31425,7 @@ declare module "sap/ui/core/mvc/HTMLView" {
|
|
|
29984
31425
|
* as syntax does not bring any advantages over XML. The HTML necessary for the `HTMLView` is not re-used
|
|
29985
31426
|
* for the HTML of the controls, but is fully replaced.
|
|
29986
31427
|
*
|
|
29987
|
-
* Consider using {@link sap.ui.core.
|
|
31428
|
+
* Consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed views" (view classes written in JavaScript)
|
|
29988
31429
|
* instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
|
|
29989
31430
|
*
|
|
29990
31431
|
* A view defined/constructed by declarative HTML.
|
|
@@ -30116,6 +31557,9 @@ declare module "sap/ui/core/mvc/JSONView" {
|
|
|
30116
31557
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
30117
31558
|
|
|
30118
31559
|
/**
|
|
31560
|
+
* @deprecated (since 1.120) - please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed
|
|
31561
|
+
* views" (view classes written in JavaScript) instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
|
|
31562
|
+
*
|
|
30119
31563
|
* A View defined using JSON.
|
|
30120
31564
|
*/
|
|
30121
31565
|
export default class JSONView extends View {
|
|
@@ -30496,7 +31940,7 @@ declare module "sap/ui/core/mvc/View" {
|
|
|
30496
31940
|
|
|
30497
31941
|
import Controller from "sap/ui/core/mvc/Controller";
|
|
30498
31942
|
|
|
30499
|
-
import { CSSSize } from "sap/ui/core/library";
|
|
31943
|
+
import { CSSSize, URI } from "sap/ui/core/library";
|
|
30500
31944
|
|
|
30501
31945
|
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
30502
31946
|
|
|
@@ -31014,10 +32458,10 @@ declare module "sap/ui/core/mvc/View" {
|
|
|
31014
32458
|
/**
|
|
31015
32459
|
* A method to be implemented by typed `View`s, returning the view UI.
|
|
31016
32460
|
*
|
|
31017
|
-
* While for declarative view types like `XMLView` or `JSONView` the user interface definition
|
|
31018
|
-
* in a separate file, `View`s programmatically constructs the UI. This happens in the `createContent`
|
|
31019
|
-
* which every `View` needs to implement. The view implementation can construct the complete UI
|
|
31020
|
-
* method, or only return the root control and create the remainder of the UI lazily later on.
|
|
32461
|
+
* While for declarative view types like `XMLView` or `JSONView` (deprecated) the user interface definition
|
|
32462
|
+
* is declared in a separate file, `View`s programmatically constructs the UI. This happens in the `createContent`
|
|
32463
|
+
* method, which every `View` needs to implement. The view implementation can construct the complete UI
|
|
32464
|
+
* in this method, or only return the root control and create the remainder of the UI lazily later on.
|
|
31021
32465
|
*
|
|
31022
32466
|
* @returns A control or array of controls representing the view user interface or a Promise resolving with
|
|
31023
32467
|
* a control or an array of controls.
|
|
@@ -31538,6 +32982,70 @@ declare module "sap/ui/core/mvc/View" {
|
|
|
31538
32982
|
*/
|
|
31539
32983
|
displayBlock?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
31540
32984
|
|
|
32985
|
+
/**
|
|
32986
|
+
* Controller instance to use for this view.
|
|
32987
|
+
*/
|
|
32988
|
+
controller?: Controller;
|
|
32989
|
+
|
|
32990
|
+
/**
|
|
32991
|
+
* Name of the controller class to use for this view. If given, it overrides the same information in the
|
|
32992
|
+
* view definition (XML, HTML).
|
|
32993
|
+
*/
|
|
32994
|
+
controllerName?: string;
|
|
32995
|
+
|
|
32996
|
+
/**
|
|
32997
|
+
* Preprocessors that the view can use before constructing the view.
|
|
32998
|
+
*/
|
|
32999
|
+
preprocessors?: Object;
|
|
33000
|
+
|
|
33001
|
+
/**
|
|
33002
|
+
* (module) Name of a resource bundle that should be loaded for this view
|
|
33003
|
+
*/
|
|
33004
|
+
resourceBundleName?: string;
|
|
33005
|
+
|
|
33006
|
+
/**
|
|
33007
|
+
* URL of a resource bundle that should be loaded for this view
|
|
33008
|
+
*/
|
|
33009
|
+
resourceBundleUrl?: URI;
|
|
33010
|
+
|
|
33011
|
+
/**
|
|
33012
|
+
* Locale that should be used to load a resource bundle for this view
|
|
33013
|
+
*/
|
|
33014
|
+
resourceBundleLocale?: string;
|
|
33015
|
+
|
|
33016
|
+
/**
|
|
33017
|
+
* Model name under which the resource bundle should be stored.
|
|
33018
|
+
*/
|
|
33019
|
+
resourceBundleAlias?: string;
|
|
33020
|
+
|
|
33021
|
+
/**
|
|
33022
|
+
* Type of the view
|
|
33023
|
+
*/
|
|
33024
|
+
type?: string;
|
|
33025
|
+
|
|
33026
|
+
/**
|
|
33027
|
+
* A view definition
|
|
33028
|
+
*/
|
|
33029
|
+
definition?: any;
|
|
33030
|
+
|
|
33031
|
+
/**
|
|
33032
|
+
* Deprecated as of 1.56: Use `definition` instead.
|
|
33033
|
+
*/
|
|
33034
|
+
viewContent?: any;
|
|
33035
|
+
|
|
33036
|
+
/**
|
|
33037
|
+
* Additional configuration data that should be given to the view at construction time and which will be
|
|
33038
|
+
* available early, even before model data or other constructor settings are applied.
|
|
33039
|
+
*/
|
|
33040
|
+
viewData?: any;
|
|
33041
|
+
|
|
33042
|
+
/**
|
|
33043
|
+
* @since 1.30
|
|
33044
|
+
*
|
|
33045
|
+
* Determines initialization mode of the view
|
|
33046
|
+
*/
|
|
33047
|
+
async?: boolean;
|
|
33048
|
+
|
|
31541
33049
|
/**
|
|
31542
33050
|
* Child Controls of the view
|
|
31543
33051
|
*/
|
|
@@ -31638,6 +33146,9 @@ declare module "sap/ui/core/mvc/ViewType" {
|
|
|
31638
33146
|
*/
|
|
31639
33147
|
JS = "JS",
|
|
31640
33148
|
/**
|
|
33149
|
+
* @deprecated (since 1.120) - please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed
|
|
33150
|
+
* views" (view classes written in JavaScript) instead.
|
|
33151
|
+
*
|
|
31641
33152
|
* JSON View
|
|
31642
33153
|
*/
|
|
31643
33154
|
JSON = "JSON",
|
|
@@ -31965,7 +33476,23 @@ declare module "sap/ui/core/mvc/XMLView" {
|
|
|
31965
33476
|
XML = "xml",
|
|
31966
33477
|
}
|
|
31967
33478
|
|
|
31968
|
-
export interface $XMLViewSettings extends $ViewSettings {
|
|
33479
|
+
export interface $XMLViewSettings extends $ViewSettings {
|
|
33480
|
+
/**
|
|
33481
|
+
* Configuration for the XMLView caching.
|
|
33482
|
+
*/
|
|
33483
|
+
cache?: Object;
|
|
33484
|
+
|
|
33485
|
+
/**
|
|
33486
|
+
* legacy-relevant:
|
|
33487
|
+
*
|
|
33488
|
+
* A map containing references to modules loaded via a 'core:require' statement in an XMLView.
|
|
33489
|
+
*
|
|
33490
|
+
* Only used for HTML embedded in an XMLView. This kind of HTML is processed synchronously only and needs
|
|
33491
|
+
* access to 'core:require' modules from outside. Normally 'core:require' modules are NOT passed into nested
|
|
33492
|
+
* Views and Fragments.
|
|
33493
|
+
*/
|
|
33494
|
+
requireContext?: Object;
|
|
33495
|
+
}
|
|
31969
33496
|
}
|
|
31970
33497
|
|
|
31971
33498
|
declare module "sap/ui/core/Popup" {
|
|
@@ -35608,7 +37135,7 @@ declare module "sap/ui/core/routing/Router" {
|
|
|
35608
37135
|
/**
|
|
35609
37136
|
* The route data
|
|
35610
37137
|
*/
|
|
35611
|
-
arguments: Record<string, string
|
|
37138
|
+
arguments: Record<string, string | Record<string, string>>;
|
|
35612
37139
|
};
|
|
35613
37140
|
|
|
35614
37141
|
export default class Router extends EventProvider {
|
|
@@ -40896,9 +42423,6 @@ declare module "sap/ui/core/UIArea" {
|
|
|
40896
42423
|
* First, all old content controls (if any) will be detached from this UIArea (e.g. their parent relationship
|
|
40897
42424
|
* to this UIArea will be cut off). Then the parent relationship for the new content control (if not empty)
|
|
40898
42425
|
* will be set to this UIArea and finally, the UIArea will be marked for re-rendering.
|
|
40899
|
-
*
|
|
40900
|
-
* The real re-rendering happens whenever the re-rendering is called. Either implicitly at the end of any
|
|
40901
|
-
* control event or by calling sap.ui.getCore().applyChanges().
|
|
40902
42426
|
*/
|
|
40903
42427
|
setRootControl(
|
|
40904
42428
|
/**
|
|
@@ -50723,6 +52247,15 @@ declare module "sap/ui/model/Filter" {
|
|
|
50723
52247
|
*/
|
|
50724
52248
|
vValue2?: any
|
|
50725
52249
|
);
|
|
52250
|
+
/**
|
|
52251
|
+
* @since 1.120.0
|
|
52252
|
+
*
|
|
52253
|
+
* A filter instance that is never fulfilled. When used to filter a list, no back-end request is sent and
|
|
52254
|
+
* only transient entries remain.
|
|
52255
|
+
*
|
|
52256
|
+
* **Note:** Not all model implementations support this filter.
|
|
52257
|
+
*/
|
|
52258
|
+
static NONE: Filter;
|
|
50726
52259
|
|
|
50727
52260
|
/**
|
|
50728
52261
|
* Compares two values
|
|
@@ -53011,19 +54544,23 @@ declare module "sap/ui/model/odata/AnnotationHelper" {
|
|
|
53011
54544
|
* `"{@i18n>...}"` to the hard-coded model name "@i18n" with arbitrary path are not turned into a fixed
|
|
53012
54545
|
* text, but kept as a data binding expression; this allows local annotation files to refer to a resource
|
|
53013
54546
|
* bundle for internationalization. the dynamic "14.5.1 Comparison and Logical Operators": These are
|
|
53014
|
-
* turned into expression bindings to perform the operations at run-time.
|
|
53015
|
-
*
|
|
54547
|
+
* turned into expression bindings to perform the operations at run-time. It's strongly recommended to require
|
|
54548
|
+
* the `sap.ui.model.odata.v4.ODataUtils` module in advance to avoid synchronous loading of this module.
|
|
54549
|
+
* the dynamic "14.5.3 Expression edm:Apply":
|
|
53016
54550
|
* "14.5.3.1.1 Function odata.concat": This is turned into a data binding expression relative to an entity.
|
|
53017
54551
|
* "14.5.3.1.2 Function odata.fillUriTemplate": This is turned into an expression binding to fill the
|
|
53018
|
-
* template at run-time.
|
|
53019
|
-
* to
|
|
53020
|
-
*
|
|
53021
|
-
*
|
|
53022
|
-
* "14.5.
|
|
53023
|
-
*
|
|
53024
|
-
*
|
|
53025
|
-
*
|
|
53026
|
-
*
|
|
54552
|
+
* template at run-time. It's strongly recommended to require the `sap.ui.thirdparty.URITemplate` module
|
|
54553
|
+
* in advance to avoid synchronous loading of this module. "14.5.3.1.3 Function odata.uriEncode": This
|
|
54554
|
+
* is turned into an expression binding to encode the parameter at run-time. It's strongly recommended to
|
|
54555
|
+
* require the `sap.ui.model.odata.ODataUtils` module in advance to avoid synchronous loading of this module.
|
|
54556
|
+
* Apply functions may be nested arbitrarily. the dynamic "14.5.6 Expression edm:If": This
|
|
54557
|
+
* is turned into an expression binding to be evaluated at run-time. The expression is a conditional expression
|
|
54558
|
+
* like `"{=condition ? expression1 : expression2}"`. the dynamic "14.5.10 Expression edm:Null": This
|
|
54559
|
+
* is turned into a `null` value. In `odata.concat` it is ignored. the dynamic "14.5.12 Expression
|
|
54560
|
+
* edm:Path" and "14.5.13 Expression edm:PropertyPath": This is turned into a data binding relative to an
|
|
54561
|
+
* entity, including type information and constraints as available from metadata, e.g. `"{path : 'Name',
|
|
54562
|
+
* type : 'sap.ui.model.odata.type.String', constraints : {'maxLength':'255'}}"`. Depending on the used
|
|
54563
|
+
* type, some additional constraints of this type are set:
|
|
53027
54564
|
* Edm.DateTime: The "displayFormat" constraint is set to the value of the "sap:display-format" annotation
|
|
53028
54565
|
* of the referenced property. Edm.Decimal: The "precision" and "scale" constraints are set to the values
|
|
53029
54566
|
* of the corresponding attributes of the referenced property. The "minimum", "maximum", "minimumExclusive"
|
|
@@ -61562,14 +63099,14 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
61562
63099
|
*
|
|
61563
63100
|
* Get a download URL with the specified format considering the sort/filter/custom parameters.
|
|
61564
63101
|
*
|
|
61565
|
-
* @returns URL which can be used for downloading
|
|
63102
|
+
* @returns URL which can be used for downloading; `null` if this binding uses {@link sap.ui.model.Filter.NONE}
|
|
61566
63103
|
*/
|
|
61567
63104
|
getDownloadUrl(
|
|
61568
63105
|
/**
|
|
61569
63106
|
* Value for the $format Parameter
|
|
61570
63107
|
*/
|
|
61571
63108
|
sFormat: string
|
|
61572
|
-
): string;
|
|
63109
|
+
): string | null;
|
|
61573
63110
|
/**
|
|
61574
63111
|
* Return the length of the list.
|
|
61575
63112
|
*
|
|
@@ -61642,8 +63179,10 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
61642
63179
|
* in its constructor or in its {@link #filter} method; add filters which you want to keep with the "and"
|
|
61643
63180
|
* conjunction to the resulting filter before calling {@link #filter}.
|
|
61644
63181
|
*
|
|
61645
|
-
* @returns A Promise that resolves with
|
|
61646
|
-
*
|
|
63182
|
+
* @returns A Promise that resolves with an {@link sap.ui.model.Filter} representing the entries with messages,
|
|
63183
|
+
* except in the following cases:
|
|
63184
|
+
* If only transient entries have messages, it resolves with {@link sap.ui.model.Filter.NONE} If
|
|
63185
|
+
* the binding is not resolved or if there is no message for any entry, it resolves with `null`
|
|
61647
63186
|
*/
|
|
61648
63187
|
requestFilterForMessages(
|
|
61649
63188
|
/**
|
|
@@ -62492,6 +64031,13 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
62492
64031
|
* Map of binding parameters
|
|
62493
64032
|
*/
|
|
62494
64033
|
mParameters?: {
|
|
64034
|
+
/**
|
|
64035
|
+
* Whether the tree binding only requests transition messages from the back end. If messages for entities
|
|
64036
|
+
* of this collection need to be updated, use {@link sap.ui.model.odata.v2.ODataModel#read} on the parent
|
|
64037
|
+
* entity corresponding to the tree binding's context, with the parameter `updateAggregatedMessages` set
|
|
64038
|
+
* to `true`.
|
|
64039
|
+
*/
|
|
64040
|
+
transitionMessagesOnly?: boolean;
|
|
62495
64041
|
/**
|
|
62496
64042
|
* The mapping between data properties and the hierarchy used to visualize the tree, if not provided by
|
|
62497
64043
|
* the service's metadata. For the correct metadata annotations, check the "SAP Annotations for OData Version
|
|
@@ -65491,10 +67037,10 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
65491
67037
|
* depending on this context become unresolved, but no attempt is made to restore these bindings in case
|
|
65492
67038
|
* of reset or failure.
|
|
65493
67039
|
*
|
|
65494
|
-
* Deleting a
|
|
65495
|
-
*
|
|
65496
|
-
*
|
|
65497
|
-
*
|
|
67040
|
+
* Deleting a node in a recursive hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation})
|
|
67041
|
+
* is supported (@experimental as of version 1.118.0). As a precondition, the context must not be {@link #setKeepAlive kept-alive }
|
|
67042
|
+
* and hidden (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
|
|
67043
|
+
* Such a deletion is not a pending change.
|
|
65498
67044
|
* See:
|
|
65499
67045
|
* #hasPendingChanges
|
|
65500
67046
|
* #resetChanges
|
|
@@ -65619,6 +67165,17 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
65619
67165
|
*/
|
|
65620
67166
|
sPath?: string
|
|
65621
67167
|
): any;
|
|
67168
|
+
/**
|
|
67169
|
+
* @experimental (since 1.120.0)
|
|
67170
|
+
*
|
|
67171
|
+
* Returns the parent node (in case of a recursive hierarchy, see {@link #setAggregation}, where `oAggregation.expandTo`
|
|
67172
|
+
* must be equal to one).
|
|
67173
|
+
* See:
|
|
67174
|
+
* #requestParent
|
|
67175
|
+
*
|
|
67176
|
+
* @returns The parent node, or `null` if this node is a root node and thus has no parent
|
|
67177
|
+
*/
|
|
67178
|
+
getParent(): Context | null;
|
|
65622
67179
|
/**
|
|
65623
67180
|
* @since 1.39.0
|
|
65624
67181
|
*
|
|
@@ -65665,6 +67222,20 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
65665
67222
|
* @returns Whether there are pending changes
|
|
65666
67223
|
*/
|
|
65667
67224
|
hasPendingChanges(): boolean;
|
|
67225
|
+
/**
|
|
67226
|
+
* @since 1.120.0
|
|
67227
|
+
*
|
|
67228
|
+
* Tells whether this node is an ancestor of (or the same as) the given node (in case of a recursive hierarchy,
|
|
67229
|
+
* see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
|
|
67230
|
+
*
|
|
67231
|
+
* @returns Whether the assumed ancestor relation holds
|
|
67232
|
+
*/
|
|
67233
|
+
isAncestorOf(
|
|
67234
|
+
/**
|
|
67235
|
+
* Some node which may be a descendant
|
|
67236
|
+
*/
|
|
67237
|
+
oNode: Context
|
|
67238
|
+
): boolean;
|
|
65668
67239
|
/**
|
|
65669
67240
|
* @since 1.105.0
|
|
65670
67241
|
*
|
|
@@ -65747,8 +67318,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
65747
67318
|
/**
|
|
65748
67319
|
* @experimental (since 1.119.0)
|
|
65749
67320
|
*
|
|
65750
|
-
* Moves this node to the given parent (in case of a recursive hierarchy, see {@link #setAggregation},
|
|
65751
|
-
* `oAggregation.expandTo` must be one). No other {@link sap.ui.model.odata.v4.ODataListBinding#create creation},
|
|
67321
|
+
* Moves this node to the given parent (in case of a recursive hierarchy, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation},
|
|
67322
|
+
* where `oAggregation.expandTo` must be one). No other {@link sap.ui.model.odata.v4.ODataListBinding#create creation},
|
|
65752
67323
|
* {@link #delete deletion}, or move must be pending, and no other modification (including collapse of some
|
|
65753
67324
|
* ancestor node) must happen while this move is pending!
|
|
65754
67325
|
*
|
|
@@ -65845,6 +67416,20 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
65845
67416
|
*/
|
|
65846
67417
|
sPath?: string
|
|
65847
67418
|
): Promise<any>;
|
|
67419
|
+
/**
|
|
67420
|
+
* @experimental (since 1.120.0)
|
|
67421
|
+
*
|
|
67422
|
+
* Requests the parent node (in case of a recursive hierarchy, see {@link #setAggregation}, where `oAggregation.expandTo`
|
|
67423
|
+
* must be equal to one).
|
|
67424
|
+
* See:
|
|
67425
|
+
* #getParent
|
|
67426
|
+
*
|
|
67427
|
+
* @returns A promise which:
|
|
67428
|
+
* - Resolves if successful with either the parent node or `null` for a root node that has no parent
|
|
67429
|
+
*
|
|
67430
|
+
* - Rejects with an `Error` instance otherwise
|
|
67431
|
+
*/
|
|
67432
|
+
requestParent(): Promise<Context | null>;
|
|
65848
67433
|
/**
|
|
65849
67434
|
* @since 1.39.0
|
|
65850
67435
|
*
|
|
@@ -66934,11 +68519,12 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
66934
68519
|
*
|
|
66935
68520
|
* Creating a new child beneath an existing and visible parent node (which must either be a leaf or expanded,
|
|
66936
68521
|
* but not collapsed) is supported (@experimental as of version 1.117.0) in case of a recursive hierarchy
|
|
66937
|
-
* (see {@link #setAggregation}). The parent node must be identified via
|
|
66938
|
-
* instance given as `oInitialData["@$ui5.node.parent"]
|
|
66939
|
-
*
|
|
66940
|
-
* creation or {@link sap.ui.model.odata.v4.Context#move move}
|
|
66941
|
-
* (including collapse of some ancestor node) must happen while
|
|
68522
|
+
* (see {@link #setAggregation}). The parent node must be identified via an {@link sap.ui.model.odata.v4.Context }
|
|
68523
|
+
* instance given as `oInitialData["@$ui5.node.parent"]` (which is immediately removed from the new child's
|
|
68524
|
+
* data). It can be `null` or absent when creating a new root node (@experimental as of version 1.120.0).
|
|
68525
|
+
* `bSkipRefresh` must be set, but both `bAtEnd` and `bInactive` must not be set. No other creation or {@link sap.ui.model.odata.v4.Context#move move }
|
|
68526
|
+
* must be pending, and no other modification (including collapse of some ancestor node) must happen while
|
|
68527
|
+
* this creation is pending!
|
|
66942
68528
|
*
|
|
66943
68529
|
* @returns The context object for the created entity; its method {@link sap.ui.model.odata.v4.Context#created }
|
|
66944
68530
|
* returns a promise that is resolved when the creation is finished
|
|
@@ -67601,7 +69187,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
67601
69187
|
* The number (as a positive integer) of different levels initially available without calling {@link sap.ui.model.odata.v4.Context#expand }
|
|
67602
69188
|
* (@experimental as of version 1.105.0; available for read-only hierarchies since 1.117.0), supported only
|
|
67603
69189
|
* if a `hierarchyQualifier` is given. Root nodes are on the first level. By default, only root nodes are
|
|
67604
|
-
* available; they are not yet expanded.
|
|
69190
|
+
* available; they are not yet expanded. Since 1.120.0, `Number.MAX_SAFE_INTEGER` can be used to expand
|
|
69191
|
+
* all levels.
|
|
67605
69192
|
*/
|
|
67606
69193
|
expandTo?: number;
|
|
67607
69194
|
/**
|
|
@@ -68850,7 +70437,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
68850
70437
|
updateGroupId?: string;
|
|
68851
70438
|
/**
|
|
68852
70439
|
* Whether the XMLHttpRequest is called with `withCredentials`, so that user credentials are included in
|
|
68853
|
-
* cross-origin requests by the browser (
|
|
70440
|
+
* cross-origin requests by the browser (since 1.120.0)
|
|
68854
70441
|
*/
|
|
68855
70442
|
withCredentials?: boolean;
|
|
68856
70443
|
}
|
|
@@ -82365,8 +83952,12 @@ declare namespace sap {
|
|
|
82365
83952
|
|
|
82366
83953
|
"sap/base/assert": undefined;
|
|
82367
83954
|
|
|
83955
|
+
"sap/base/config": undefined;
|
|
83956
|
+
|
|
82368
83957
|
"sap/base/Event": undefined;
|
|
82369
83958
|
|
|
83959
|
+
"sap/base/Eventing": undefined;
|
|
83960
|
+
|
|
82370
83961
|
"sap/base/i18n/date/CalendarType": undefined;
|
|
82371
83962
|
|
|
82372
83963
|
"sap/base/i18n/date/CalendarWeekNumbering": undefined;
|
|
@@ -82471,6 +84062,8 @@ declare namespace sap {
|
|
|
82471
84062
|
|
|
82472
84063
|
"sap/ui/base/DataType": undefined;
|
|
82473
84064
|
|
|
84065
|
+
"sap/ui/base/DesignTime": undefined;
|
|
84066
|
+
|
|
82474
84067
|
"sap/ui/base/Event": undefined;
|
|
82475
84068
|
|
|
82476
84069
|
"sap/ui/base/EventProvider": undefined;
|
|
@@ -82665,6 +84258,8 @@ declare namespace sap {
|
|
|
82665
84258
|
|
|
82666
84259
|
"sap/ui/core/Renderer": undefined;
|
|
82667
84260
|
|
|
84261
|
+
"sap/ui/core/Rendering": undefined;
|
|
84262
|
+
|
|
82668
84263
|
"sap/ui/core/RenderManager": undefined;
|
|
82669
84264
|
|
|
82670
84265
|
"sap/ui/core/ResizeHandler": undefined;
|
|
@@ -82709,6 +84304,8 @@ declare namespace sap {
|
|
|
82709
84304
|
|
|
82710
84305
|
"sap/ui/core/support/usage/EventBroadcaster": undefined;
|
|
82711
84306
|
|
|
84307
|
+
"sap/ui/core/Supportability": undefined;
|
|
84308
|
+
|
|
82712
84309
|
"sap/ui/core/syncStyleClass": undefined;
|
|
82713
84310
|
|
|
82714
84311
|
"sap/ui/core/Theming": undefined;
|
|
@@ -83115,6 +84712,8 @@ declare namespace sap {
|
|
|
83115
84712
|
|
|
83116
84713
|
"sap/ui/security/FrameOptions": undefined;
|
|
83117
84714
|
|
|
84715
|
+
"sap/ui/security/Security": undefined;
|
|
84716
|
+
|
|
83118
84717
|
"sap/ui/test/actions/Action": undefined;
|
|
83119
84718
|
|
|
83120
84719
|
"sap/ui/test/actions/Drag": undefined;
|
|
@@ -83198,6 +84797,8 @@ declare namespace sap {
|
|
|
83198
84797
|
"sap/ui/util/XMLHelper": undefined;
|
|
83199
84798
|
|
|
83200
84799
|
"sap/ui/VersionInfo": undefined;
|
|
84800
|
+
|
|
84801
|
+
"ui5loader-autoconfig": undefined;
|
|
83201
84802
|
}
|
|
83202
84803
|
|
|
83203
84804
|
type ClassInfo<T, C> = T & Partial<C> & ThisType<T & C>;
|