@openui5/ts-types 1.119.0 → 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.
@@ -280,7 +280,7 @@ declare namespace sap {
280
280
  }
281
281
  }
282
282
 
283
- // For Library Version: 1.119.0
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
@@ -2552,6 +3553,37 @@ declare module "sap/ui/util/XMLHelper" {
2552
3553
  export default XMLHelper;
2553
3554
  }
2554
3555
 
3556
+ declare module "sap/ui/core/AnimationMode" {
3557
+ /**
3558
+ * @since 1.120
3559
+ *
3560
+ * Enumerable list with available animation modes.
3561
+ *
3562
+ * This enumerable is used to validate the animation mode. Animation modes allow to specify different animation
3563
+ * scenarios or levels. The implementation of the Control (JavaScript or CSS) has to be done differently
3564
+ * for each animation mode.
3565
+ */
3566
+ enum AnimationMode {
3567
+ /**
3568
+ * `basic` can be used for a reduced, more light-weight set of animations.
3569
+ */
3570
+ basic = "basic",
3571
+ /**
3572
+ * `full` represents a mode with unrestricted animation capabilities.
3573
+ */
3574
+ full = "full",
3575
+ /**
3576
+ * `minimal` includes animations of fundamental functionality.
3577
+ */
3578
+ minimal = "minimal",
3579
+ /**
3580
+ * `none` deactivates the animation completely.
3581
+ */
3582
+ none = "none",
3583
+ }
3584
+ export default AnimationMode;
3585
+ }
3586
+
2555
3587
  declare module "sap/ui/core/ComponentSupport" {
2556
3588
  /**
2557
3589
  * @since 1.58.0
@@ -2637,6 +3669,52 @@ declare module "sap/ui/core/ComponentSupport" {
2637
3669
  export default ComponentSupport;
2638
3670
  }
2639
3671
 
3672
+ declare module "sap/ui/core/ControlBehavior" {
3673
+ import AnimationMode from "sap/ui/core/AnimationMode";
3674
+
3675
+ /**
3676
+ * @since 1.120
3677
+ *
3678
+ * Provides control behavior relevant configuration options
3679
+ */
3680
+ interface ControlBehavior {
3681
+ /**
3682
+ * @since 1.120
3683
+ *
3684
+ * Returns the current animation mode.
3685
+ *
3686
+ * @returns The current animationMode
3687
+ */
3688
+ getAnimationMode(): AnimationMode | keyof typeof AnimationMode;
3689
+ /**
3690
+ * @since 1.120
3691
+ *
3692
+ * Returns whether the accessibility mode is enabled or not.
3693
+ *
3694
+ * @returns whether the accessibility mode is enabled or not
3695
+ */
3696
+ isAccessibilityEnabled(): boolean;
3697
+ /**
3698
+ * @since 1.120
3699
+ *
3700
+ * Sets the current animation mode.
3701
+ *
3702
+ * Expects an animation mode as string and validates it. If a wrong animation mode was set, an error is
3703
+ * thrown. If the mode is valid it is set, then the attributes `data-sap-ui-animation` and `data-sap-ui-animation-mode`
3704
+ * of the HTML document root element are also updated. If the `animationMode` is `AnimationMode.none` the
3705
+ * old `animation` property is set to `false`, otherwise it is set to `true`.
3706
+ */
3707
+ setAnimationMode(
3708
+ /**
3709
+ * A valid animation mode
3710
+ */
3711
+ sAnimationMode: AnimationMode | keyof typeof AnimationMode
3712
+ ): void;
3713
+ }
3714
+ const ControlBehavior: ControlBehavior;
3715
+ export default ControlBehavior;
3716
+ }
3717
+
2640
3718
  declare module "sap/ui/core/date/CalendarUtils" {
2641
3719
  /**
2642
3720
  * @since 1.108.0
@@ -3554,6 +4632,8 @@ declare module "sap/ui/core/Theming" {
3554
4632
  */
3555
4633
  interface Theming {
3556
4634
  /**
4635
+ * @since 1.118.0
4636
+ *
3557
4637
  * Attaches event handler `fnFunction` to the {@link #event:applied applied} event.
3558
4638
  *
3559
4639
  * The given handler is called when the the applied event is fired. If the theme is already applied the
@@ -3564,9 +4644,11 @@ declare module "sap/ui/core/Theming" {
3564
4644
  /**
3565
4645
  * The function to be called, when the event occurs
3566
4646
  */
3567
- fnFunction: Function
4647
+ fnFunction: (p1: Theming$AppliedEvent) => void
3568
4648
  ): void;
3569
4649
  /**
4650
+ * @since 1.118.0
4651
+ *
3570
4652
  * Detaches event handler `fnFunction` from the {@link #event:applied applied} event
3571
4653
  *
3572
4654
  * The passed function must match the one used for event registration.
@@ -3575,32 +4657,48 @@ declare module "sap/ui/core/Theming" {
3575
4657
  /**
3576
4658
  * The function to be called, when the event occurs
3577
4659
  */
3578
- fnFunction: Function
4660
+ fnFunction: (p1: Theming$AppliedEvent) => void
3579
4661
  ): void;
3580
4662
  /**
4663
+ * @since 1.118
4664
+ *
3581
4665
  * Returns the theme name
3582
4666
  *
3583
4667
  * @returns the theme name
3584
4668
  */
3585
4669
  getTheme(): string;
3586
4670
  /**
4671
+ * @since 1.118.0
4672
+ *
3587
4673
  * Notify content density changes
3588
4674
  */
3589
4675
  notifyContentDensityChanged(): void;
3590
4676
  /**
3591
- * Allows setting the theme name
4677
+ * @since 1.118
3592
4678
  *
3593
- * @returns `this` to allow method chaining
4679
+ * Allows setting the theme name
3594
4680
  */
3595
4681
  setTheme(
3596
4682
  /**
3597
4683
  * the theme name
3598
4684
  */
3599
4685
  sTheme: string
3600
- ): this;
4686
+ ): void;
3601
4687
  }
3602
4688
  const Theming: Theming;
3603
4689
  export default Theming;
4690
+
4691
+ /**
4692
+ * @since 1.118.0
4693
+ *
4694
+ * The theme applied Event.
4695
+ */
4696
+ export type Theming$AppliedEvent = {
4697
+ /**
4698
+ * The newly set language.
4699
+ */
4700
+ theme: string;
4701
+ };
3604
4702
  }
3605
4703
 
3606
4704
  declare module "sap/ui/dom/containsOrEquals" {
@@ -4689,6 +5787,57 @@ declare module "sap/ui/performance/trace/Interaction" {
4689
5787
  };
4690
5788
  }
4691
5789
 
5790
+ declare module "sap/ui/security/Security" {
5791
+ /**
5792
+ * @since 1.120.0
5793
+ *
5794
+ * Provides security related API
5795
+ */
5796
+ interface Security {
5797
+ /**
5798
+ * @since 1.120.0
5799
+ *
5800
+ * URL of the allowlist service.
5801
+ *
5802
+ * @returns allowlist service URL
5803
+ */
5804
+ getAllowlistService(): string;
5805
+ /**
5806
+ * @since 1.120.0
5807
+ *
5808
+ * frameOptions mode (allow/deny/trusted).
5809
+ *
5810
+ * @returns frameOptions mode
5811
+ */
5812
+ getFrameOptions(): string;
5813
+ /**
5814
+ * @since 1.120.0
5815
+ *
5816
+ * Returns the security token handlers of an OData V4 model.
5817
+ * See:
5818
+ * #setSecurityTokenHandlers
5819
+ *
5820
+ * @returns the security token handlers (an empty array if there are none)
5821
+ */
5822
+ getSecurityTokenHandlers(): Array<(p1: sap.ui.core.URI) => Promise<any>>;
5823
+ /**
5824
+ * @since 1.120.0
5825
+ *
5826
+ * Sets the security token handlers for an OData V4 model. See chapter {@link https://ui5.sap.com/#/topic/9613f1f2d88747cab21896f7216afdac/section_STH Security Token Handling}.
5827
+ * See:
5828
+ * #getSecurityTokenHandlers
5829
+ */
5830
+ setSecurityTokenHandlers(
5831
+ /**
5832
+ * The security token handlers
5833
+ */
5834
+ aSecurityTokenHandlers: Array<(p1: sap.ui.core.URI) => Promise<any>>
5835
+ ): void;
5836
+ }
5837
+ const Security: Security;
5838
+ export default Security;
5839
+ }
5840
+
4692
5841
  declare module "sap/ui/test/opaQunit" {
4693
5842
  /**
4694
5843
  * QUnit test adapter for OPA: add a test to be executed by QUnit Has the same signature as QUnit.test (QUnit
@@ -7913,6 +9062,11 @@ declare namespace sap {
7913
9062
  * (in dot notation, e.g. 'sap.m.Button').
7914
9063
  */
7915
9064
  type?: string;
9065
+ /**
9066
+ * The default class for the aggregation. If aggregation content is created from a plain object and no explicit
9067
+ * 'Type' is given (capital 'T'), the default class will be instantiated.
9068
+ */
9069
+ defaultClass?: Function;
7916
9070
  /**
7917
9071
  * Whether the aggregation is a 0..1 (false) or a 0..n aggregation (true), defaults to true
7918
9072
  */
@@ -8667,6 +9821,38 @@ declare namespace sap {
8667
9821
  }
8668
9822
 
8669
9823
  interface $ManagedObjectSettings {
9824
+ /**
9825
+ * Unique ID of this instance. If not given, a so called autoID will be generated by the framework. AutoIDs
9826
+ * use a unique prefix that must not be used for Ids that the application (or other code) creates. It can
9827
+ * be configured option 'autoIDPrefix', see {@link sap.ui.core.Configuration}.
9828
+ */
9829
+ id?: sap.ui.core.ID;
9830
+
9831
+ /**
9832
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9833
+ * name. For the default model, String(undefined) is expected.
9834
+ */
9835
+ models?: object;
9836
+
9837
+ /**
9838
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9839
+ * name. For the default model, String(undefined) is expected.
9840
+ */
9841
+ bindingContexts?: object;
9842
+
9843
+ /**
9844
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9845
+ * name. For the default model, String(undefined) is expected.
9846
+ */
9847
+ objectBindings?: object;
9848
+
9849
+ /**
9850
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9851
+ * name. For the default model, String(undefined) is expected. The special setting is only for internal
9852
+ * use.
9853
+ */
9854
+ metadataContexts?: object;
9855
+
8670
9856
  /**
8671
9857
  * Fired after a new value for a bound property has been propagated to the model. Only fired, when the binding
8672
9858
  * uses a data type.
@@ -8944,6 +10130,33 @@ declare namespace sap {
8944
10130
  */
8945
10131
  sTypeName: string
8946
10132
  ): sap.ui.base.DataType | undefined;
10133
+ /**
10134
+ * @since 1.120.0
10135
+ *
10136
+ * Registers an enum under the given name. With version 2.0, registering an enum becomes mandatory when
10137
+ * said enum is to be used in properties of a {@link sap.ui.base.ManagedObject ManagedObject} subclass.
10138
+ *
10139
+ * Example:
10140
+ *
10141
+ * ```javascript
10142
+ *
10143
+ * DataType.registerEnum("my.enums.Sample", {
10144
+ * "A": "A",
10145
+ * "B": "B",
10146
+ * ...
10147
+ * });
10148
+ * ```
10149
+ */
10150
+ static registerEnum(
10151
+ /**
10152
+ * the type name in dot syntax, e.g. sap.ui.my.EnumType
10153
+ */
10154
+ sTypeName: string,
10155
+ /**
10156
+ * the enum content
10157
+ */
10158
+ mContent: object
10159
+ ): void;
8947
10160
  /**
8948
10161
  * The base type of this type or undefined if this is a primitive type.
8949
10162
  *
@@ -9583,9 +10796,133 @@ declare namespace sap {
9583
10796
  * The possible values for a setting depend on its kind:
9584
10797
  * - for simple properties, the value has to match the documented type of the property (no type conversion
9585
10798
  * occurs)
9586
- * - for 0..1 aggregations, the value has to be an instance of the aggregated type
9587
- * - for 0..n aggregations, the value has to be an array of instances of the aggregated type or a single
9588
- * instance
10799
+ * - for 0..1 aggregations, the value has to be an instance of the aggregated type, or an object literal
10800
+ * from which, the default class of the aggregation (or the corresponding aggregation type as fallback)
10801
+ * will be instantiated.
10802
+ * - for 0..n aggregations, the value has to be an array of instances of the aggregated type, a single
10803
+ * instance or an object literal from which the default class will be instantiated.
10804
+ * - for 0..1 associations, an instance of the associated type or an id (string) is accepted
10805
+ * - for 0..n associations, an array of instances of the associated type or of IDs is accepted
10806
+ * - for events, either a function (event handler) is accepted or an array of length 2 where the first
10807
+ * element is a function and the 2nd element is an object to invoke the method on; or an array of length
10808
+ * 3, where the first element is an arbitrary payload object, the second one is a function and the 3rd one
10809
+ * is an object to invoke the method on; or an array of arrays where each nested array has the 2 or 3 element
10810
+ * structure described before (multiple listeners).
10811
+ *
10812
+ * Each subclass should document the name and type of its supported settings in its constructor documentation.
10813
+ *
10814
+ * Example usage:
10815
+ * ```javascript
10816
+ *
10817
+ * new Dialog({
10818
+ * title: "Some title text", // property of type "string"
10819
+ * showHeader: true, // property of type "boolean"
10820
+ * endButton: new Button(...), // 0..1 aggregation
10821
+ * content: [ // 0..n aggregation
10822
+ * new Input(...),
10823
+ * new Input(...)
10824
+ * ],
10825
+ * afterClose: function(oEvent) { ... } // event handler function
10826
+ * });
10827
+ * ```
10828
+ *
10829
+ *
10830
+ * Instead of static values and object instances, data binding expressions can be used, either embedded
10831
+ * in a string or as a binding info object as described in {@link #bindProperty} or {@link #bindAggregation}.
10832
+ *
10833
+ * Example usage:
10834
+ * ```javascript
10835
+ *
10836
+ * new Dialog({
10837
+ * title: "{/title}", // embedded binding expression, points to a string property in the data model
10838
+ * ...
10839
+ * content: { // binding info object
10840
+ * path : "/inputItems", // points to a collection in the data model
10841
+ * template : new Input(...)
10842
+ * }
10843
+ * });
10844
+ * ```
10845
+ *
10846
+ *
10847
+ * Note that when setting string values, any curly braces in those values need to be escaped, so they are
10848
+ * not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
10849
+ *
10850
+ * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
10851
+ * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
10852
+ * of the aggregation. Additionally, as of version 1.120, a ManagedObject subclass can specify a `defaultClass`,
10853
+ * e.g. for cases where only a single class is valid. Please refer to the {@link sap.ui.base.ManagedObject.MetadataOptions.Aggregation Aggregation }
10854
+ * documentation for more details on the `defaultClass`.
10855
+ *
10856
+ * Besides the settings documented below, ManagedObject itself supports the following special settings:
10857
+ *
10858
+ * - `id : sap.ui.core.ID` an ID for the new instance. Some subclasses (Element, Component) require
10859
+ * the id to be unique in a specific scope (e.g. an Element Id must be unique across all Elements, a Component
10860
+ * id must be unique across all Components). `models : object` a map of {@link sap.ui.model.Model }
10861
+ * instances keyed by their model name (alias). Each entry with key k in this object has the same
10862
+ * effect as a call `this.setModel(models[k], k);`.
10863
+ * - `bindingContexts : object` a map of {@link sap.ui.model.Context} instances keyed by their
10864
+ * model name. Each entry with key k in this object has the same effect as a call `this.setBindingContext(bindingContexts[k],
10865
+ * k);`
10866
+ * - `objectBindings : object` a map of binding paths keyed by the corresponding model name. Each
10867
+ * entry with key k in this object has the same effect as a call `this.bindObject(objectBindings[k],
10868
+ * k);` `metadataContexts : object` an array of single binding contexts keyed by the corresponding
10869
+ * model or context name. The purpose of the `metadataContexts` special setting is to deduce as much information
10870
+ * as possible from the binding context of the control in order to be able to predefine certain standard
10871
+ * properties like e.g. visible, enabled, tooltip,...
10872
+ *
10873
+ * The structure is an array of single contexts, where a single context is a map containing the following
10874
+ * keys:
10875
+ * - `path: string (mandatory)` The path to the corresponding model property or object, e.g. '/Customers/Name'.
10876
+ * A path can also be relative, e.g. 'Name'
10877
+ * - `model: string (optional)` The name of the model, in case there is no name then the undefined
10878
+ * model is taken
10879
+ * - `name: string (optional)` A name for the context to used in templating phase
10880
+ * - `kind: string (optional)` The kind of the adapter, either `field` for single properties or
10881
+ * `object` for structured contexts. `adapter: string (optional)` The path to an interpretion
10882
+ * class that dilivers control relevant data depending on the context, e.g. enabled, visible. If not supplied
10883
+ * the OData meta data is interpreted. The syntax for providing the `metadataContexts` is as follows:
10884
+ * `{SINGLE_CONTEXT1},...,{SINGLE_CONTEXTn}` or for simplicity in case there is only one context `{SINGLE_CONTEXT}`.
10885
+ *
10886
+ * Examples for such metadataContexts are:
10887
+ * - `{/Customers/Name}` a single part with an absolute path to the property Name of the Customers
10888
+ * entity set in the default model
10889
+ * - `{path: 'Customers/Name', model:'json'}` a single part with an absolute path to the property Name
10890
+ * of the Customers entity set in a named model
10891
+ * - `{parts: [{path: 'Customers/Name'},{path: 'editable', model: 'viewModel'}]}` a combination of single
10892
+ * binding contexts, one context from the default model and one from the viewModel
10893
+ */
10894
+ constructor(
10895
+ /**
10896
+ * Optional map/JSON-object with initial property values, aggregated objects etc. for the new object
10897
+ */
10898
+ mSettings?: sap.ui.base.$ManagedObjectSettings,
10899
+ /**
10900
+ * Scope object for resolving string based type and formatter references in bindings. When a scope object
10901
+ * is given, `mSettings` cannot be omitted, at least `null` or an empty object literal must be given.
10902
+ */
10903
+ oScope?: object
10904
+ );
10905
+ /**
10906
+ * Constructs and initializes a managed object with the given `sId` and settings.
10907
+ *
10908
+ * If the optional `mSettings` are given, they must be a simple object that defines values for properties,
10909
+ * aggregations, associations or events keyed by their name.
10910
+ *
10911
+ * **Valid Names and Value Ranges:**
10912
+ *
10913
+ * The property (key) names supported in the object literal are exactly the (case sensitive) names documented
10914
+ * in the JSDoc for the properties, aggregations, associations and events of the current class and its base
10915
+ * classes. Note that for 0..n aggregations and associations this name usually is the plural name, whereas
10916
+ * it is the singular name in case of 0..1 relations.
10917
+ *
10918
+ * The possible values for a setting depend on its kind:
10919
+ * - for simple properties, the value has to match the documented type of the property (no type conversion
10920
+ * occurs)
10921
+ * - for 0..1 aggregations, the value has to be an instance of the aggregated type, or an object literal
10922
+ * from which, the default class of the aggregation (or the corresponding aggregation type as fallback)
10923
+ * will be instantiated.
10924
+ * - for 0..n aggregations, the value has to be an array of instances of the aggregated type, a single
10925
+ * instance or an object literal from which the default class will be instantiated.
9589
10926
  * - for 0..1 associations, an instance of the associated type or an id (string) is accepted
9590
10927
  * - for 0..n associations, an array of instances of the associated type or of IDs is accepted
9591
10928
  * - for events, either a function (event handler) is accepted or an array of length 2 where the first
@@ -9632,119 +10969,11 @@ declare namespace sap {
9632
10969
  * Note that when setting string values, any curly braces in those values need to be escaped, so they are
9633
10970
  * not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
9634
10971
  *
9635
- * Besides the settings documented below, ManagedObject itself supports the following special settings:
9636
- *
9637
- * - `id : sap.ui.core.ID` an ID for the new instance. Some subclasses (Element, Component) require
9638
- * the id to be unique in a specific scope (e.g. an Element Id must be unique across all Elements, a Component
9639
- * id must be unique across all Components). `models : object` a map of {@link sap.ui.model.Model }
9640
- * instances keyed by their model name (alias). Each entry with key k in this object has the same
9641
- * effect as a call `this.setModel(models[k], k);`.
9642
- * - `bindingContexts : object` a map of {@link sap.ui.model.Context} instances keyed by their
9643
- * model name. Each entry with key k in this object has the same effect as a call `this.setBindingContext(bindingContexts[k],
9644
- * k);`
9645
- * - `objectBindings : object` a map of binding paths keyed by the corresponding model name. Each
9646
- * entry with key k in this object has the same effect as a call `this.bindObject(objectBindings[k],
9647
- * k);` `metadataContexts : object` an array of single binding contexts keyed by the corresponding
9648
- * model or context name. The purpose of the `metadataContexts` special setting is to deduce as much information
9649
- * as possible from the binding context of the control in order to be able to predefine certain standard
9650
- * properties like e.g. visible, enabled, tooltip,...
9651
- *
9652
- * The structure is an array of single contexts, where a single context is a map containing the following
9653
- * keys:
9654
- * - `path: string (mandatory)` The path to the corresponding model property or object, e.g. '/Customers/Name'.
9655
- * A path can also be relative, e.g. 'Name'
9656
- * - `model: string (optional)` The name of the model, in case there is no name then the undefined
9657
- * model is taken
9658
- * - `name: string (optional)` A name for the context to used in templating phase
9659
- * - `kind: string (optional)` The kind of the adapter, either `field` for single properties or
9660
- * `object` for structured contexts. `adapter: string (optional)` The path to an interpretion
9661
- * class that dilivers control relevant data depending on the context, e.g. enabled, visible. If not supplied
9662
- * the OData meta data is interpreted. The syntax for providing the `metadataContexts` is as follows:
9663
- * `{SINGLE_CONTEXT1},...,{SINGLE_CONTEXTn}` or for simplicity in case there is only one context `{SINGLE_CONTEXT}`.
9664
- *
9665
- * Examples for such metadataContexts are:
9666
- * - `{/Customers/Name}` a single part with an absolute path to the property Name of the Customers
9667
- * entity set in the default model
9668
- * - `{path: 'Customers/Name', model:'json'}` a single part with an absolute path to the property Name
9669
- * of the Customers entity set in a named model
9670
- * - `{parts: [{path: 'Customers/Name'},{path: 'editable', model: 'viewModel'}]}` a combination of single
9671
- * binding contexts, one context from the default model and one from the viewModel
9672
- */
9673
- constructor(
9674
- /**
9675
- * Optional map/JSON-object with initial property values, aggregated objects etc. for the new object
9676
- */
9677
- mSettings?: sap.ui.base.$ManagedObjectSettings,
9678
- /**
9679
- * Scope object for resolving string based type and formatter references in bindings. When a scope object
9680
- * is given, `mSettings` cannot be omitted, at least `null` or an empty object literal must be given.
9681
- */
9682
- oScope?: object
9683
- );
9684
- /**
9685
- * Constructs and initializes a managed object with the given `sId` and settings.
9686
- *
9687
- * If the optional `mSettings` are given, they must be a simple object that defines values for properties,
9688
- * aggregations, associations or events keyed by their name.
9689
- *
9690
- * **Valid Names and Value Ranges:**
9691
- *
9692
- * The property (key) names supported in the object literal are exactly the (case sensitive) names documented
9693
- * in the JSDoc for the properties, aggregations, associations and events of the current class and its base
9694
- * classes. Note that for 0..n aggregations and associations this name usually is the plural name, whereas
9695
- * it is the singular name in case of 0..1 relations.
9696
- *
9697
- * The possible values for a setting depend on its kind:
9698
- * - for simple properties, the value has to match the documented type of the property (no type conversion
9699
- * occurs)
9700
- * - for 0..1 aggregations, the value has to be an instance of the aggregated type
9701
- * - for 0..n aggregations, the value has to be an array of instances of the aggregated type or a single
9702
- * instance
9703
- * - for 0..1 associations, an instance of the associated type or an id (string) is accepted
9704
- * - for 0..n associations, an array of instances of the associated type or of IDs is accepted
9705
- * - for events, either a function (event handler) is accepted or an array of length 2 where the first
9706
- * element is a function and the 2nd element is an object to invoke the method on; or an array of length
9707
- * 3, where the first element is an arbitrary payload object, the second one is a function and the 3rd one
9708
- * is an object to invoke the method on; or an array of arrays where each nested array has the 2 or 3 element
9709
- * structure described before (multiple listeners).
9710
- *
9711
- * Each subclass should document the name and type of its supported settings in its constructor documentation.
9712
- *
9713
- * Example usage:
9714
- * ```javascript
9715
- *
9716
- * new Dialog({
9717
- * title: "Some title text", // property of type "string"
9718
- * showHeader: true, // property of type "boolean"
9719
- * endButton: new Button(...), // 0..1 aggregation
9720
- * content: [ // 0..n aggregation
9721
- * new Input(...),
9722
- * new Input(...)
9723
- * ],
9724
- * afterClose: function(oEvent) { ... } // event handler function
9725
- * });
9726
- * ```
9727
- *
9728
- *
9729
- * Instead of static values and object instances, data binding expressions can be used, either embedded
9730
- * in a string or as a binding info object as described in {@link #bindProperty} or {@link #bindAggregation}.
9731
- *
9732
- * Example usage:
9733
- * ```javascript
9734
- *
9735
- * new Dialog({
9736
- * title: "{/title}", // embedded binding expression, points to a string property in the data model
9737
- * ...
9738
- * content: { // binding info object
9739
- * path : "/inputItems", // points to a collection in the data model
9740
- * template : new Input(...)
9741
- * }
9742
- * });
9743
- * ```
9744
- *
9745
- *
9746
- * Note that when setting string values, any curly braces in those values need to be escaped, so they are
9747
- * not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
10972
+ * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
10973
+ * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
10974
+ * of the aggregation. Additionally, as of version 1.120, a ManagedObject subclass can specify a `defaultClass`,
10975
+ * e.g. for cases where only a single class is valid. Please refer to the {@link sap.ui.base.ManagedObject.MetadataOptions.Aggregation Aggregation }
10976
+ * documentation for more details on the `defaultClass`.
9748
10977
  *
9749
10978
  * Besides the settings documented below, ManagedObject itself supports the following special settings:
9750
10979
  *
@@ -12274,12 +13503,12 @@ declare namespace sap {
12274
13503
  */
12275
13504
  getName(): string;
12276
13505
  /**
12277
- * Returns the metadata object of the base class of the described class or null if the class has no (documented)
12278
- * base class.
13506
+ * Returns the metadata object of the base class of the described class or undefined if the class has no
13507
+ * (documented) base class.
12279
13508
  *
12280
13509
  * @returns metadata of the base class
12281
13510
  */
12282
- getParent(): sap.ui.base.Metadata;
13511
+ getParent(): sap.ui.base.Metadata | undefined;
12283
13512
  /**
12284
13513
  * @deprecated (since 1.58) - this method should not be used for productive code. The accuracy of the returned
12285
13514
  * information highly depends on the concrete class and is not actively monitored. There might be more public
@@ -12458,6 +13687,7 @@ declare namespace sap {
12458
13687
  ): Function;
12459
13688
  /**
12460
13689
  * @since 1.56
13690
+ * @deprecated (since 1.120) - please use {@link sap.ui.base.Object.isObjectA}.
12461
13691
  *
12462
13692
  * Checks whether the given object is an instance of the named type. This function is a short-hand convenience
12463
13693
  * for {@link sap.ui.base.Object#isA}.
@@ -12476,6 +13706,26 @@ declare namespace sap {
12476
13706
  */
12477
13707
  vTypeName: string | string[]
12478
13708
  ): oObject is T;
13709
+ /**
13710
+ * @since 1.120
13711
+ *
13712
+ * Checks whether the given object is an instance of the named type. This function is a short-hand convenience
13713
+ * for {@link sap.ui.base.Object#isA}.
13714
+ *
13715
+ * Please see the API documentation of {@link sap.ui.base.Object#isA} for more details.
13716
+ *
13717
+ * @returns Whether the given object is an instance of the given type or of any of the given types
13718
+ */
13719
+ static isObjectA(
13720
+ /**
13721
+ * Object which will be checked whether it is an instance of the given type
13722
+ */
13723
+ oObject: any,
13724
+ /**
13725
+ * Type or types to check for
13726
+ */
13727
+ vTypeName: string | string[]
13728
+ ): boolean;
12479
13729
  /**
12480
13730
  * Destructor method for objects.
12481
13731
  */
@@ -17599,6 +18849,70 @@ declare namespace sap {
17599
18849
  | sap.ui.base.ManagedObject.PropertyBindingInfo
17600
18850
  | `{${string}}`;
17601
18851
 
18852
+ /**
18853
+ * Controller instance to use for this view.
18854
+ */
18855
+ controller?: sap.ui.core.mvc.Controller;
18856
+
18857
+ /**
18858
+ * Name of the controller class to use for this view. If given, it overrides the same information in the
18859
+ * view definition (XML, HTML).
18860
+ */
18861
+ controllerName?: string;
18862
+
18863
+ /**
18864
+ * Preprocessors that the view can use before constructing the view.
18865
+ */
18866
+ preprocessors?: Object;
18867
+
18868
+ /**
18869
+ * (module) Name of a resource bundle that should be loaded for this view
18870
+ */
18871
+ resourceBundleName?: string;
18872
+
18873
+ /**
18874
+ * URL of a resource bundle that should be loaded for this view
18875
+ */
18876
+ resourceBundleUrl?: sap.ui.core.URI;
18877
+
18878
+ /**
18879
+ * Locale that should be used to load a resource bundle for this view
18880
+ */
18881
+ resourceBundleLocale?: string;
18882
+
18883
+ /**
18884
+ * Model name under which the resource bundle should be stored.
18885
+ */
18886
+ resourceBundleAlias?: string;
18887
+
18888
+ /**
18889
+ * Type of the view
18890
+ */
18891
+ type?: string;
18892
+
18893
+ /**
18894
+ * A view definition
18895
+ */
18896
+ definition?: any;
18897
+
18898
+ /**
18899
+ * Deprecated as of 1.56: Use `definition` instead.
18900
+ */
18901
+ viewContent?: any;
18902
+
18903
+ /**
18904
+ * Additional configuration data that should be given to the view at construction time and which will be
18905
+ * available early, even before model data or other constructor settings are applied.
18906
+ */
18907
+ viewData?: any;
18908
+
18909
+ /**
18910
+ * @since 1.30
18911
+ *
18912
+ * Determines initialization mode of the view
18913
+ */
18914
+ async?: boolean;
18915
+
17602
18916
  /**
17603
18917
  * Child Controls of the view
17604
18918
  */
@@ -17629,7 +18943,23 @@ declare namespace sap {
17629
18943
  beforeRendering?: (oEvent: sap.ui.base.Event) => void;
17630
18944
  }
17631
18945
 
17632
- interface $XMLViewSettings extends sap.ui.core.mvc.$ViewSettings {}
18946
+ interface $XMLViewSettings extends sap.ui.core.mvc.$ViewSettings {
18947
+ /**
18948
+ * Configuration for the XMLView caching.
18949
+ */
18950
+ cache?: Object;
18951
+
18952
+ /**
18953
+ * legacy-relevant:
18954
+ *
18955
+ * A map containing references to modules loaded via a 'core:require' statement in an XMLView.
18956
+ *
18957
+ * Only used for HTML embedded in an XMLView. This kind of HTML is processed synchronously only and needs
18958
+ * access to 'core:require' modules from outside. Normally 'core:require' modules are NOT passed into nested
18959
+ * Views and Fragments.
18960
+ */
18961
+ requireContext?: Object;
18962
+ }
17633
18963
 
17634
18964
  interface View$AfterInitEventParameters {}
17635
18965
 
@@ -18043,7 +19373,7 @@ declare namespace sap {
18043
19373
  * as syntax does not bring any advantages over XML. The HTML necessary for the `HTMLView` is not re-used
18044
19374
  * for the HTML of the controls, but is fully replaced.
18045
19375
  *
18046
- * Consider using {@link sap.ui.core.mvx.XMLView XMLViews} or "typed views" (view classes written in JavaScript)
19376
+ * Consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed views" (view classes written in JavaScript)
18047
19377
  * instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
18048
19378
  *
18049
19379
  * A view defined/constructed by declarative HTML.
@@ -18164,6 +19494,9 @@ declare namespace sap {
18164
19494
  static getMetadata(): sap.ui.core.ElementMetadata;
18165
19495
  }
18166
19496
  /**
19497
+ * @deprecated (since 1.120) - please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed
19498
+ * views" (view classes written in JavaScript) instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
19499
+ *
18167
19500
  * A View defined using JSON.
18168
19501
  */
18169
19502
  class JSONView extends sap.ui.core.mvc.View {
@@ -18995,10 +20328,10 @@ declare namespace sap {
18995
20328
  /**
18996
20329
  * A method to be implemented by typed `View`s, returning the view UI.
18997
20330
  *
18998
- * While for declarative view types like `XMLView` or `JSONView` the user interface definition is declared
18999
- * in a separate file, `View`s programmatically constructs the UI. This happens in the `createContent` method,
19000
- * which every `View` needs to implement. The view implementation can construct the complete UI in this
19001
- * method, or only return the root control and create the remainder of the UI lazily later on.
20331
+ * While for declarative view types like `XMLView` or `JSONView` (deprecated) the user interface definition
20332
+ * is declared in a separate file, `View`s programmatically constructs the UI. This happens in the `createContent`
20333
+ * method, which every `View` needs to implement. The view implementation can construct the complete UI
20334
+ * in this method, or only return the root control and create the remainder of the UI lazily later on.
19002
20335
  *
19003
20336
  * @returns A control or array of controls representing the view user interface or a Promise resolving with
19004
20337
  * a control or an array of controls.
@@ -19744,6 +21077,9 @@ declare namespace sap {
19744
21077
  */
19745
21078
  JS = "JS",
19746
21079
  /**
21080
+ * @deprecated (since 1.120) - please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed
21081
+ * views" (view classes written in JavaScript) instead.
21082
+ *
19747
21083
  * JSON View
19748
21084
  */
19749
21085
  JSON = "JSON",
@@ -19780,85 +21116,6 @@ declare namespace sap {
19780
21116
  >;
19781
21117
  }
19782
21118
 
19783
- namespace theming {
19784
- namespace Parameters {
19785
- /**
19786
- * Theming Parameter Value
19787
- */
19788
- type Value = string | Record<string, string> | undefined;
19789
- }
19790
- /**
19791
- * A helper used for (read-only) access to CSS parameters at runtime.
19792
- */
19793
- interface Parameters {
19794
- /**
19795
- * Returns the current value for one or more theming parameters, depending on the given arguments. The
19796
- * synchronous usage of this API has been deprecated and only the asynchronous usage should still be used
19797
- * (see the 4th bullet point and the code examples below).
19798
- *
19799
- * The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
19800
- * API calls for the same parameter name will always result in the same parameter value.
19801
- *
19802
- * The following API variants are available (see also the below examples):
19803
- * - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
19804
- * returned
19805
- * - **(deprecated since 1.94)** If a `string` is given as first parameter the value is returned as a
19806
- * `string`
19807
- * - **(deprecated since 1.94)** If an `array` is given as first parameter a key-value map containing
19808
- * all parameters from the `array` is returned
19809
- * - If an `object` is given as first parameter the result is returned immediately in case all parameters
19810
- * are loaded and available or within the callback in case not all CSS files are already loaded. This is
19811
- * the **only asynchronous** API variant. This variant is the preferred way to retrieve theming parameters.
19812
- * The structure of the return value is the same as listed above depending on the type of the name property
19813
- * within the `object`.
19814
- *
19815
- * The returned key-value maps are a copy so changing values in the map does not have any effect
19816
- *
19817
- * Please see the examples below for a detailed guide on how to use the **asynchronous variant** of
19818
- * the API.
19819
- *
19820
- * @returns the CSS parameter value(s) or `undefined` if the parameters could not be retrieved.
19821
- */
19822
- get(
19823
- /**
19824
- * the (array with) CSS parameter name(s) or an object containing the (array with) CSS parameter name(s),
19825
- * the scopeElement and a callback for async retrieval of parameters.
19826
- */
19827
- vName:
19828
- | string
19829
- | string[]
19830
- | {
19831
- /**
19832
- * the (array with) CSS parameter name(s)
19833
- */
19834
- name: string | string[];
19835
- /**
19836
- * Element / control instance to take into account when looking for a parameter value. This can make a difference
19837
- * when a parameter value is overridden in a theme scope set via a CSS class.
19838
- */
19839
- scopeElement?: sap.ui.core.Element;
19840
- /**
19841
- * If given, the callback is only executed in case there are still parameters pending and one or more of
19842
- * the requested parameters is missing.
19843
- */
19844
- callback?: (p1: sap.ui.core.theming.Parameters.Value) => void;
19845
- },
19846
- /**
19847
- * Element / control instance to take into account when looking for a parameter value. This can make a difference
19848
- * when a parameter value is overridden in a theme scope set via a CSS class.
19849
- */
19850
- oElement?: sap.ui.core.Element
19851
- ): sap.ui.core.theming.Parameters.Value;
19852
- /**
19853
- * @deprecated (since 1.92)
19854
- *
19855
- * Resets the CSS parameters which finally will reload the parameters the next time they are queried via
19856
- * the method `get`.
19857
- */
19858
- reset(): void;
19859
- }
19860
- }
19861
-
19862
21119
  namespace aria {
19863
21120
  /**
19864
21121
  * @since 1.84
@@ -20027,6 +21284,8 @@ declare namespace sap {
20027
21284
 
20028
21285
  namespace Configuration {
20029
21286
  /**
21287
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting} instead.
21288
+ *
20030
21289
  * Encapsulates configuration settings that are related to data formatting/parsing.
20031
21290
  *
20032
21291
  * **Note:** When format configuration settings are modified through this class, UI5 only ensures that formatter
@@ -20069,26 +21328,33 @@ declare namespace sap {
20069
21328
  */
20070
21329
  static getMetadata(): sap.ui.base.Metadata;
20071
21330
  /**
21331
+ * @since 1.120
21332
+ *
20072
21333
  * Adds custom currencies to the existing entries. E.g. ` { "KWD": {"digits": 3}, "TND" : {"digits": 3 }
20073
21334
  * } `
20074
21335
  * See:
20075
- * #setCustomCurrencies
20076
- *
20077
- * @returns Returns `this` to allow method chaining
21336
+ * {@link module:sap/base/i18n/Formatting.setCustomCurrencies}
20078
21337
  */
20079
21338
  addCustomCurrencies(
20080
21339
  /**
20081
21340
  * adds to the currency map
20082
21341
  */
20083
21342
  mCurrencies: object
20084
- ): this;
21343
+ ): void;
20085
21344
  /**
21345
+ * @since 1.120
21346
+ *
20086
21347
  * Retrieves the custom currencies. E.g. ` { "KWD": {"digits": 3}, "TND" : {"digits": 3} } `
21348
+ * See:
21349
+ * {@link module:sap/base/i18n/Formatting.setCustomCurrencies}
21350
+ * {@link module:sap/base/i18n/Formatting.addCustomCurrencies}
20087
21351
  *
20088
21352
  * @returns the mapping between custom currencies and its digits
20089
21353
  */
20090
21354
  getCustomCurrencies(): object;
20091
21355
  /**
21356
+ * @since 1.120
21357
+ *
20092
21358
  * Returns the currently set date pattern or undefined if no pattern has been defined.
20093
21359
  *
20094
21360
  * @returns The resulting date pattern
@@ -20100,6 +21366,8 @@ declare namespace sap {
20100
21366
  sStyle: "short" | "medium" | "long" | "full"
20101
21367
  ): string;
20102
21368
  /**
21369
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getLanguageTag} instead.
21370
+ *
20103
21371
  * Returns the locale to be used for formatting.
20104
21372
  *
20105
21373
  * If no such locale has been defined, this method falls back to the language, see {@link sap.ui.core.Configuration#getLanguage Configuration.getLanguage()}.
@@ -20112,44 +21380,17 @@ declare namespace sap {
20112
21380
  */
20113
21381
  getFormatLocale(): sap.ui.core.Locale;
20114
21382
  /**
21383
+ * @since 1.120
21384
+ *
20115
21385
  * Returns the currently set customizing data for Islamic calendar support
20116
21386
  *
20117
21387
  * @returns Returns an array contains the customizing data. Each element in the array has properties: dateFormat,
20118
21388
  * islamicMonthStart, gregDate. For details, please see {@link #setLegacyDateCalendarCustomizing}
20119
21389
  */
20120
- getLegacyDateCalendarCustomizing(): object[];
20121
- /**
20122
- * Returns the currently set legacy ABAP date format (its id) or undefined if none has been set.
20123
- *
20124
- * @returns ID of the ABAP date format, if not set or set to `""`, `undefined` will be returned
20125
- */
20126
- getLegacyDateFormat():
20127
- | "1"
20128
- | "2"
20129
- | "3"
20130
- | "4"
20131
- | "5"
20132
- | "6"
20133
- | "7"
20134
- | "8"
20135
- | "9"
20136
- | "A"
20137
- | "B"
20138
- | "C"
20139
- | undefined;
21390
+ getLegacyDateCalendarCustomizing(): object[] | undefined;
20140
21391
  /**
20141
- * Returns the currently set legacy ABAP number format (its id) or undefined if none has been set.
21392
+ * @since 1.120
20142
21393
  *
20143
- * @returns ID of the ABAP number format, if not set or set to `""`, `undefined` will be returned
20144
- */
20145
- getLegacyNumberFormat(): " " | "X" | "Y" | undefined;
20146
- /**
20147
- * Returns the currently set legacy ABAP time format (its id) or undefined if none has been set.
20148
- *
20149
- * @returns ID of the ABAP date format, if not set or set to `""`, `undefined` will be returned
20150
- */
20151
- getLegacyTimeFormat(): "0" | "1" | "2" | "3" | "4" | undefined;
20152
- /**
20153
21394
  * Returns the currently set number symbol of the given type or undefined if no symbol has been defined.
20154
21395
  *
20155
21396
  * @returns A non-numerical symbol used as part of a number for the given type, e.g. for locale de_DE:
@@ -20166,6 +21407,8 @@ declare namespace sap {
20166
21407
  sType: "group" | "decimal" | "plusSign" | "minusSign"
20167
21408
  ): string;
20168
21409
  /**
21410
+ * @since 1.120
21411
+ *
20169
21412
  * Returns the currently set time pattern or undefined if no pattern has been defined.
20170
21413
  *
20171
21414
  * @returns The resulting time pattern
@@ -20177,7 +21420,7 @@ declare namespace sap {
20177
21420
  sStyle: "short" | "medium" | "long" | "full"
20178
21421
  ): string;
20179
21422
  /**
20180
- * @since 1.75.0
21423
+ * @since 1.120
20181
21424
  *
20182
21425
  * Returns current trailingCurrencyCode configuration for new NumberFormatter instances
20183
21426
  *
@@ -20185,6 +21428,8 @@ declare namespace sap {
20185
21428
  */
20186
21429
  getTrailingCurrencyCode(): boolean;
20187
21430
  /**
21431
+ * @since 1.120
21432
+ *
20188
21433
  * Sets custom currencies and replaces existing entries.
20189
21434
  *
20190
21435
  * There is a special currency code named "DEFAULT" that is optional. In case it is set it will be used
@@ -20200,15 +21445,15 @@ declare namespace sap {
20200
21445
  * Note: To unset the custom currencies: call with `undefined` Custom currencies must not only consist of
20201
21446
  * digits but contain at least one non-digit character, e.g. "a", so that the measure part can be distinguished
20202
21447
  * from the number part.
20203
- *
20204
- * @returns Returns `this` to allow method chaining
21448
+ * See:
21449
+ * {@link module:sap/base/i18n/Formatting.addCustomCurrencies}
20205
21450
  */
20206
21451
  setCustomCurrencies(
20207
21452
  /**
20208
21453
  * currency map which is set
20209
21454
  */
20210
21455
  mCurrencies: object
20211
- ): this;
21456
+ ): void;
20212
21457
  /**
20213
21458
  * Defines the preferred format pattern for the given date format style.
20214
21459
  *
@@ -20234,7 +21479,7 @@ declare namespace sap {
20234
21479
  sPattern: string
20235
21480
  ): this;
20236
21481
  /**
20237
- * @deprecated (since 1.113.0) - Use {@link sap.ui.core.Configuration.FormatSettings#setCalendarWeekNumbering }
21482
+ * @deprecated (since 1.113) - Use {@link sap.ui.core.Configuration.FormatSettings#setCalendarWeekNumbering }
20238
21483
  * instead.
20239
21484
  *
20240
21485
  * Defines the day used as the first day of the week.
@@ -20259,9 +21504,9 @@ declare namespace sap {
20259
21504
  iValue: int
20260
21505
  ): this;
20261
21506
  /**
20262
- * Allows to specify the customizing data for Islamic calendar support
21507
+ * @since 1.120
20263
21508
  *
20264
- * @returns Returns `this` to allow method chaining
21509
+ * Allows to specify the customizing data for Islamic calendar support
20265
21510
  */
20266
21511
  setLegacyDateCalendarCustomizing(
20267
21512
  /**
@@ -20281,7 +21526,7 @@ declare namespace sap {
20281
21526
  */
20282
21527
  gregDate: string;
20283
21528
  }>
20284
- ): this;
21529
+ ): void;
20285
21530
  /**
20286
21531
  * Allows to specify one of the legacy ABAP date formats.
20287
21532
  *
@@ -20400,7 +21645,7 @@ declare namespace sap {
20400
21645
  sPattern: string
20401
21646
  ): this;
20402
21647
  /**
20403
- * @since 1.75.0
21648
+ * @since 1.120
20404
21649
  *
20405
21650
  * Define whether the NumberFormatter shall always place the currency code after the numeric value, with
20406
21651
  * the only exception of right-to-left locales, where the currency code shall be placed before the numeric
@@ -20411,18 +21656,17 @@ declare namespace sap {
20411
21656
  *
20412
21657
  * Each currency instance ({@link sap.ui.core.format.NumberFormat.getCurrencyInstance}) will be created
20413
21658
  * with this setting unless overwritten on instance level.
20414
- *
20415
- * @returns Returns `this` to allow method chaining
20416
21659
  */
20417
21660
  setTrailingCurrencyCode(
20418
21661
  /**
20419
21662
  * Whether currency codes shall always be placed after the numeric value
20420
21663
  */
20421
21664
  bTrailingCurrencyCode: boolean
20422
- ): this;
21665
+ ): void;
20423
21666
  }
20424
21667
  /**
20425
21668
  * @since 1.50.0
21669
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/AnimationMode} instead.
20426
21670
  *
20427
21671
  * Enumerable list with available animation modes.
20428
21672
  *
@@ -20453,6 +21697,7 @@ declare namespace sap {
20453
21697
  namespace date {
20454
21698
  /**
20455
21699
  * @since 1.108.0
21700
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/18n/date/CalendarWeekNumbering} instead.
20456
21701
  *
20457
21702
  * The `CalendarWeekNumbering` enum defines how to calculate calendar weeks. Each value defines:
20458
21703
  * - The first day of the week,
@@ -24186,7 +25431,7 @@ declare namespace sap {
24186
25431
  /**
24187
25432
  * The route data
24188
25433
  */
24189
- arguments: Record<string, string>;
25434
+ arguments: Record<string, string | Record<string, string>>;
24190
25435
  };
24191
25436
 
24192
25437
  /**
@@ -24770,6 +26015,85 @@ declare namespace sap {
24770
26015
  }
24771
26016
  }
24772
26017
 
26018
+ namespace theming {
26019
+ namespace Parameters {
26020
+ /**
26021
+ * Theming Parameter Value
26022
+ */
26023
+ type Value = string | Record<string, string> | undefined;
26024
+ }
26025
+ /**
26026
+ * A helper used for (read-only) access to CSS parameters at runtime.
26027
+ */
26028
+ interface Parameters {
26029
+ /**
26030
+ * Returns the current value for one or more theming parameters, depending on the given arguments. The
26031
+ * synchronous usage of this API has been deprecated and only the asynchronous usage should still be used
26032
+ * (see the 4th bullet point and the code examples below).
26033
+ *
26034
+ * The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
26035
+ * API calls for the same parameter name will always result in the same parameter value.
26036
+ *
26037
+ * The following API variants are available (see also the below examples):
26038
+ * - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
26039
+ * returned
26040
+ * - **(deprecated since 1.94)** If a `string` is given as first parameter the value is returned as a
26041
+ * `string`
26042
+ * - **(deprecated since 1.94)** If an `array` is given as first parameter a key-value map containing
26043
+ * all parameters from the `array` is returned
26044
+ * - If an `object` is given as first parameter the result is returned immediately in case all parameters
26045
+ * are loaded and available or within the callback in case not all CSS files are already loaded. This is
26046
+ * the **only asynchronous** API variant. This variant is the preferred way to retrieve theming parameters.
26047
+ * The structure of the return value is the same as listed above depending on the type of the name property
26048
+ * within the `object`.
26049
+ *
26050
+ * The returned key-value maps are a copy so changing values in the map does not have any effect
26051
+ *
26052
+ * Please see the examples below for a detailed guide on how to use the **asynchronous variant** of
26053
+ * the API.
26054
+ *
26055
+ * @returns the CSS parameter value(s) or `undefined` if the parameters could not be retrieved.
26056
+ */
26057
+ get(
26058
+ /**
26059
+ * the (array with) CSS parameter name(s) or an object containing the (array with) CSS parameter name(s),
26060
+ * the scopeElement and a callback for async retrieval of parameters.
26061
+ */
26062
+ vName:
26063
+ | string
26064
+ | string[]
26065
+ | {
26066
+ /**
26067
+ * the (array with) CSS parameter name(s)
26068
+ */
26069
+ name: string | string[];
26070
+ /**
26071
+ * Element / control instance to take into account when looking for a parameter value. This can make a difference
26072
+ * when a parameter value is overridden in a theme scope set via a CSS class.
26073
+ */
26074
+ scopeElement?: sap.ui.core.Element;
26075
+ /**
26076
+ * If given, the callback is only executed in case there are still parameters pending and one or more of
26077
+ * the requested parameters is missing.
26078
+ */
26079
+ callback?: (p1: sap.ui.core.theming.Parameters.Value) => void;
26080
+ },
26081
+ /**
26082
+ * Element / control instance to take into account when looking for a parameter value. This can make a difference
26083
+ * when a parameter value is overridden in a theme scope set via a CSS class.
26084
+ */
26085
+ oElement?: sap.ui.core.Element
26086
+ ): sap.ui.core.theming.Parameters.Value;
26087
+ /**
26088
+ * @deprecated (since 1.92)
26089
+ *
26090
+ * Resets the CSS parameters which finally will reload the parameters the next time they are queried via
26091
+ * the method `get`.
26092
+ */
26093
+ reset(): void;
26094
+ }
26095
+ }
26096
+
24773
26097
  namespace tmpl {
24774
26098
  interface $DOMAttributeSettings extends sap.ui.core.$ElementSettings {
24775
26099
  /**
@@ -29274,7 +30598,9 @@ declare namespace sap {
29274
30598
  execute?: (oEvent: sap.ui.base.Event) => void;
29275
30599
  }
29276
30600
 
29277
- interface $ComponentSettings extends sap.ui.base.$ManagedObjectSettings {}
30601
+ interface $ComponentSettings extends sap.ui.base.$ManagedObjectSettings {
30602
+ componentData?: any;
30603
+ }
29278
30604
 
29279
30605
  interface $ComponentContainerSettings
29280
30606
  extends sap.ui.core.$ControlSettings {
@@ -29622,6 +30948,10 @@ declare namespace sap {
29622
30948
 
29623
30949
  interface $FragmentSettings extends sap.ui.base.$ManagedObjectSettings {
29624
30950
  type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
30951
+
30952
+ fragmentName?: string;
30953
+
30954
+ fragmentContent?: any;
29625
30955
  }
29626
30956
 
29627
30957
  interface $HTMLSettings extends sap.ui.core.$ControlSettings {
@@ -30400,6 +31730,8 @@ declare namespace sap {
30400
31730
  }
30401
31731
 
30402
31732
  /**
31733
+ * @deprecated (since 1.120)
31734
+ *
30403
31735
  * Collects and stores the configuration of the current environment.
30404
31736
  *
30405
31737
  * The Configuration is initialized once when the {@link sap.ui.core.Core} is created. There are different
@@ -30426,6 +31758,7 @@ declare namespace sap {
30426
31758
  interface Configuration {
30427
31759
  /**
30428
31760
  * @since 1.38.6
31761
+ * @deprecated (since 1.120)
30429
31762
  *
30430
31763
  * Applies multiple changes to the configuration at once.
30431
31764
  *
@@ -30470,6 +31803,10 @@ declare namespace sap {
30470
31803
  FNMetaImpl?: Function
30471
31804
  ): Function;
30472
31805
  /**
31806
+ * @since 1.20
31807
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.isAccessibilityEnabled }
31808
+ * instead.
31809
+ *
30473
31810
  * Returns whether the accessibility mode is enabled or not.
30474
31811
  *
30475
31812
  * @returns whether the accessibility mode is enabled or not
@@ -30486,13 +31823,15 @@ declare namespace sap {
30486
31823
  */
30487
31824
  getActiveTerminologies(): string[] | undefined;
30488
31825
  /**
31826
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getAllowlistService} instead.
31827
+ *
30489
31828
  * URL of the allowlist service.
30490
31829
  *
30491
31830
  * @returns allowlist service URL
30492
31831
  */
30493
31832
  getAllowlistService(): string;
30494
31833
  /**
30495
- * @deprecated (since 1.50.0) - replaced by {@link sap.ui.core.Configuration#getAnimationMode}
31834
+ * @deprecated (since 1.50) - Please use {@link sap.ui.core.Configuration#getAnimationMode} instead.
30496
31835
  *
30497
31836
  * Returns whether the animations are globally used.
30498
31837
  *
@@ -30501,6 +31840,7 @@ declare namespace sap {
30501
31840
  getAnimation(): boolean;
30502
31841
  /**
30503
31842
  * @since 1.50.0
31843
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.getAnimationMode} instead.
30504
31844
  *
30505
31845
  * Returns the current animation mode.
30506
31846
  *
@@ -30508,15 +31848,19 @@ declare namespace sap {
30508
31848
  */
30509
31849
  getAnimationMode(): sap.ui.core.Configuration.AnimationMode;
30510
31850
  /**
31851
+ * @deprecated (since 1.120)
31852
+ *
30511
31853
  * Base URLs to AppCacheBuster ETag-Index files.
30512
31854
  *
30513
31855
  * @returns array of base URLs
30514
31856
  */
30515
31857
  getAppCacheBuster(): string[];
30516
31858
  /**
31859
+ * @deprecated (since 1.120)
31860
+ *
30517
31861
  * The loading mode (sync|async|batch) of the AppCacheBuster (sync is default)
30518
31862
  *
30519
- * @returns "sync" | "async"
31863
+ * @returns "sync" | "async" | "batch"
30520
31864
  */
30521
31865
  getAppCacheBusterMode(): string;
30522
31866
  /**
@@ -30530,14 +31874,29 @@ declare namespace sap {
30530
31874
  getApplication(): string;
30531
31875
  /**
30532
31876
  * @since 1.27.0
31877
+ * @deprecated (since 1.120)
30533
31878
  *
30534
31879
  * Returns whether the framework automatically adds the ARIA role 'application' to the HTML body or not.
30535
31880
  *
30536
31881
  * @returns Wether the ARIA role 'application' should be added to the HTML body or not
30537
31882
  */
30538
31883
  getAutoAriaBodyRole(): boolean;
31884
+ /**
31885
+ * @since 1.28.6
31886
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getCalendarType} instead.
31887
+ *
31888
+ * Returns the calendar type which is being used in locale dependent functionality.
31889
+ *
31890
+ * When it's explicitly set by calling `setCalendar`, the set calendar type is returned. Otherwise, the
31891
+ * calendar type is determined by checking the format settings and current locale.
31892
+ *
31893
+ * @returns the current calendar type, e.g. `Gregorian`
31894
+ */
31895
+ getCalendarType(): sap.ui.core.CalendarType;
30539
31896
  /**
30540
31897
  * @since 1.113.0
31898
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getCalendarWeekNumbering }
31899
+ * instead.
30541
31900
  *
30542
31901
  * Returns the calendar week numbering algorithm used to determine the first day of the week and the first
30543
31902
  * calendar week of the year, see {@link sap.ui.core.date.CalendarWeekNumbering}.
@@ -30559,6 +31918,8 @@ declare namespace sap {
30559
31918
  sFeature: string
30560
31919
  ): import("sap/base/util/Version").default;
30561
31920
  /**
31921
+ * @deprecated (since 1.120)
31922
+ *
30562
31923
  * Returns whether the page runs in full debug mode.
30563
31924
  *
30564
31925
  * @returns Whether the page runs in full debug mode
@@ -30566,6 +31927,7 @@ declare namespace sap {
30566
31927
  getDebug(): boolean;
30567
31928
  /**
30568
31929
  * @since 1.102
31930
+ * @deprecated (since 1.120)
30569
31931
  *
30570
31932
  * Name (ID) of a UI5 module that implements file share support.
30571
31933
  *
@@ -30577,6 +31939,8 @@ declare namespace sap {
30577
31939
  */
30578
31940
  getFileShareSupport(): string | undefined;
30579
31941
  /**
31942
+ * @deprecated (since 1.120)
31943
+ *
30580
31944
  * Returns whether the Fiori2Adaptation is on.
30581
31945
  *
30582
31946
  * @returns false - no adaptation, true - full adaptation, comma-separated list - partial adaptation Possible
@@ -30585,6 +31949,7 @@ declare namespace sap {
30585
31949
  getFiori2Adaptation(): boolean | string;
30586
31950
  /**
30587
31951
  * @since 1.60.0
31952
+ * @deprecated (since 1.120)
30588
31953
  *
30589
31954
  * Returns the URL from where the UI5 flexibility services are called; if empty, the flexibility services
30590
31955
  * are not called.
@@ -30593,6 +31958,8 @@ declare namespace sap {
30593
31958
  */
30594
31959
  getFlexibilityServices(): object[];
30595
31960
  /**
31961
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getLanguageTag} instead.
31962
+ *
30596
31963
  * Returns the format locale string with language and region code. Falls back to language configuration,
30597
31964
  * in case it has not been explicitly defined.
30598
31965
  *
@@ -30600,18 +31967,24 @@ declare namespace sap {
30600
31967
  */
30601
31968
  getFormatLocale(): string;
30602
31969
  /**
31970
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting} instead.
31971
+ *
30603
31972
  * Returns a configuration object that bundles the format settings of UI5.
30604
31973
  *
30605
31974
  * @returns A FormatSettings object.
30606
31975
  */
30607
31976
  getFormatSettings(): sap.ui.core.Configuration.FormatSettings;
30608
31977
  /**
31978
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getFrameOptions} instead.
31979
+ *
30609
31980
  * frameOptions mode (allow/deny/trusted).
30610
31981
  *
30611
31982
  * @returns frameOptions mode
30612
31983
  */
30613
31984
  getFrameOptions(): string;
30614
31985
  /**
31986
+ * @deprecated (since 1.120)
31987
+ *
30615
31988
  * Returns whether the UI5 control inspe ctor is displayed. Has only an effect when the sap-ui-debug module
30616
31989
  * has been loaded
30617
31990
  *
@@ -30619,6 +31992,8 @@ declare namespace sap {
30619
31992
  */
30620
31993
  getInspect(): boolean;
30621
31994
  /**
31995
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguage} instead.
31996
+ *
30622
31997
  * Returns a string that identifies the current language.
30623
31998
  *
30624
31999
  * The value returned by config method in most cases corresponds to the exact value that has been configured
@@ -30652,6 +32027,8 @@ declare namespace sap {
30652
32027
  */
30653
32028
  getLanguage(): string;
30654
32029
  /**
32030
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguageTag} instead.
32031
+ *
30655
32032
  * Returns a BCP47-compliant language tag for the current language.
30656
32033
  *
30657
32034
  * The return value of config method is especially useful for an HTTP `Accept-Language` header.
@@ -30662,6 +32039,8 @@ declare namespace sap {
30662
32039
  */
30663
32040
  getLanguageTag(): string;
30664
32041
  /**
32042
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguageTag} instead.
32043
+ *
30665
32044
  * Returns a Locale object for the current language.
30666
32045
  *
30667
32046
  * The Locale is derived from the {@link #getLanguage language} property.
@@ -30671,6 +32050,8 @@ declare namespace sap {
30671
32050
  getLocale(): sap.ui.core.Locale;
30672
32051
  /**
30673
32052
  * @since 1.33.0
32053
+ * @deprecated (since 1.120) - 'manifest-first' is the default for the {@link sap.ui.core.Component.create }
32054
+ * factory.
30674
32055
  *
30675
32056
  * Flag whether a Component should load the manifest first.
30676
32057
  *
@@ -30684,12 +32065,16 @@ declare namespace sap {
30684
32065
  */
30685
32066
  getMetadata(): sap.ui.base.Metadata;
30686
32067
  /**
32068
+ * @deprecated (since 1.120)
32069
+ *
30687
32070
  * Returns whether there should be an exception on any duplicate element IDs.
30688
32071
  *
30689
32072
  * @returns whether there should be an exception on any duplicate element IDs
30690
32073
  */
30691
32074
  getNoDuplicateIds(): boolean;
30692
32075
  /**
32076
+ * @deprecated (since 1.120)
32077
+ *
30693
32078
  * Returns whether the text origin information is collected.
30694
32079
  *
30695
32080
  * @returns whether the text info is collected
@@ -30704,6 +32089,8 @@ declare namespace sap {
30704
32089
  */
30705
32090
  getRootComponent(): string;
30706
32091
  /**
32092
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getRTL} instead.
32093
+ *
30707
32094
  * Returns whether the page uses the RTL text direction.
30708
32095
  *
30709
32096
  * If no mode has been explicitly set (neither `true` nor `false`), the mode is derived from the current
@@ -30713,6 +32100,9 @@ declare namespace sap {
30713
32100
  */
30714
32101
  getRTL(): boolean;
30715
32102
  /**
32103
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getSAPLogonLanguage }
32104
+ * instead.
32105
+ *
30716
32106
  * Returns an SAP logon language for the current language.
30717
32107
  *
30718
32108
  * It will be returned in uppercase. e.g. "EN", "DE"
@@ -30721,7 +32111,8 @@ declare namespace sap {
30721
32111
  */
30722
32112
  getSAPLogonLanguage(): string;
30723
32113
  /**
30724
- * @since 1.95.0
32114
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getSecurityTokenHandlers }
32115
+ * instead.
30725
32116
  *
30726
32117
  * Returns the security token handlers of an OData V4 model.
30727
32118
  * See:
@@ -30734,6 +32125,7 @@ declare namespace sap {
30734
32125
  >;
30735
32126
  /**
30736
32127
  * @since 1.106.0
32128
+ * @deprecated (since 1.120)
30737
32129
  *
30738
32130
  * Flag if statistics are requested.
30739
32131
  *
@@ -30744,19 +32136,23 @@ declare namespace sap {
30744
32136
  */
30745
32137
  getStatisticsEnabled(): boolean;
30746
32138
  /**
32139
+ * @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.getTheme} instead.
32140
+ *
30747
32141
  * Returns the theme name
30748
32142
  *
30749
32143
  * @returns the theme name
30750
32144
  */
30751
32145
  getTheme(): string;
30752
32146
  /**
32147
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getTimezone} instead.
32148
+ *
30753
32149
  * Retrieves the configured IANA timezone ID.
30754
32150
  *
30755
32151
  * @returns The configured IANA timezone ID, e.g. "America/New_York"
30756
32152
  */
30757
32153
  getTimezone(): string;
30758
32154
  /**
30759
- * @deprecated (since 1.119.0) - Please use {@link sap.ui.base.ManagedObjectMetadata.getUIDPrefix ManagedObjectMetadata.getUIDPrefix }
32155
+ * @deprecated (since 1.119) - Please use {@link sap.ui.base.ManagedObjectMetadata.getUIDPrefix ManagedObjectMetadata.getUIDPrefix }
30760
32156
  * instead.
30761
32157
  *
30762
32158
  * Prefix to be used for automatically generated control IDs. Default is a double underscore "__".
@@ -30765,6 +32161,8 @@ declare namespace sap {
30765
32161
  */
30766
32162
  getUIDPrefix(): string;
30767
32163
  /**
32164
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/VersionInfo.load} instead.
32165
+ *
30768
32166
  * Returns the version of the framework.
30769
32167
  *
30770
32168
  * Similar to `sap.ui.version`.
@@ -30773,9 +32171,9 @@ declare namespace sap {
30773
32171
  */
30774
32172
  getVersion(): import("sap/base/util/Version").default;
30775
32173
  /**
30776
- * @deprecated (since 1.85.0) - Use {@link sap.ui.core.Configuration#getAllowlistService} instead. SAP strives
30777
- * to replace insensitive terms with inclusive language. Since APIs cannot be renamed or immediately removed
30778
- * for compatibility reasons, this API has been deprecated.
32174
+ * @deprecated (since 1.85) - Use {@link module:sap/ui/security/Security.getAllowlistService} instead. SAP
32175
+ * strives to replace insensitive terms with inclusive language. Since APIs cannot be renamed or immediately
32176
+ * removed for compatibility reasons, this API has been deprecated.
30779
32177
  *
30780
32178
  * URL of the whitelist service.
30781
32179
  *
@@ -30784,6 +32182,7 @@ declare namespace sap {
30784
32182
  getWhitelistService(): string;
30785
32183
  /**
30786
32184
  * @since 1.50.0
32185
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.setAnimationMode} instead.
30787
32186
  *
30788
32187
  * Sets the current animation mode.
30789
32188
  *
@@ -30800,6 +32199,7 @@ declare namespace sap {
30800
32199
  ): void;
30801
32200
  /**
30802
32201
  * @since 1.28.6
32202
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setCalendarType} instead.
30803
32203
  *
30804
32204
  * Sets the new calendar type to be used from now on in locale dependent functionality (for example, formatting,
30805
32205
  * translation texts, etc.).
@@ -30815,6 +32215,8 @@ declare namespace sap {
30815
32215
  ): this;
30816
32216
  /**
30817
32217
  * @since 1.113.0
32218
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setCalendarWeekNumbering }
32219
+ * instead.
30818
32220
  *
30819
32221
  * Sets the calendar week numbering algorithm which is used to determine the first day of the week and the
30820
32222
  * first calendar week of the year, see {@link sap.ui.core.date.CalendarWeekNumbering}.
@@ -30828,6 +32230,8 @@ declare namespace sap {
30828
32230
  sCalendarWeekNumbering: sap.ui.core.date.CalendarWeekNumbering
30829
32231
  ): this;
30830
32232
  /**
32233
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setLanguageTag} instead.
32234
+ *
30831
32235
  * Sets a new format locale to be used from now on for retrieving locale specific formatters. Modifying
30832
32236
  * this setting does not have an impact on the retrieval of translated texts!
30833
32237
  *
@@ -30852,6 +32256,8 @@ declare namespace sap {
30852
32256
  sFormatLocale: string | null
30853
32257
  ): this;
30854
32258
  /**
32259
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setLanguage} instead.
32260
+ *
30855
32261
  * Sets a new language to be used from now on for language/region dependent functionality (e.g. formatting,
30856
32262
  * data types, translated texts, ...).
30857
32263
  *
@@ -30896,6 +32302,8 @@ declare namespace sap {
30896
32302
  * **Note**: When using config method please take note of and respect the above mentioned restrictions.
30897
32303
  * See:
30898
32304
  * http://scn.sap.com/docs/DOC-14377
32305
+ *
32306
+ * @returns `this` to allow method chaining
30899
32307
  */
30900
32308
  setLanguage(
30901
32309
  /**
@@ -30909,8 +32317,10 @@ declare namespace sap {
30909
32317
  * `sLanguage` as SAP Logon language.
30910
32318
  */
30911
32319
  sSAPLogonLanguage?: string
30912
- ): void;
32320
+ ): this;
30913
32321
  /**
32322
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setRTL} instead.
32323
+ *
30914
32324
  * Sets the character orientation mode to be used from now on.
30915
32325
  *
30916
32326
  * Can either be set to a concrete value (true meaning right-to-left, false meaning left-to-right) or to
@@ -30931,7 +32341,8 @@ declare namespace sap {
30931
32341
  bRTL: boolean | null
30932
32342
  ): this;
30933
32343
  /**
30934
- * @since 1.95.0
32344
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.setSecurityTokenHandlers }
32345
+ * instead.
30935
32346
  *
30936
32347
  * Sets the security token handlers for an OData V4 model. See chapter {@link https://ui5.sap.com/#/topic/9613f1f2d88747cab21896f7216afdac/section_STH Security Token Handling}.
30937
32348
  * See:
@@ -30944,6 +32355,8 @@ declare namespace sap {
30944
32355
  aSecurityTokenHandlers: Array<(p1: sap.ui.core.URI) => Promise<any>>
30945
32356
  ): void;
30946
32357
  /**
32358
+ * @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.setTheme} instead.
32359
+ *
30947
32360
  * Allows setting the theme name
30948
32361
  *
30949
32362
  * @returns `this` to allow method chaining
@@ -30956,6 +32369,7 @@ declare namespace sap {
30956
32369
  ): this;
30957
32370
  /**
30958
32371
  * @since 1.99.0
32372
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setTimezone} instead.
30959
32373
  *
30960
32374
  * Sets the timezone such that all date and time based calculations use config timezone.
30961
32375
  *
@@ -31819,6 +33233,9 @@ declare namespace sap {
31819
33233
  */
31820
33234
  getComponent(sId: string): sap.ui.core.Component;
31821
33235
  /**
33236
+ * @deprecated (since 1.120) - Please see {@link sap.ui.core.Configuration Configuration} for the corrsponding
33237
+ * replacements.
33238
+ *
31822
33239
  * Returns the Configuration of the Core.
31823
33240
  *
31824
33241
  * @returns the Configuration of the current Core.
@@ -35939,6 +37356,8 @@ declare namespace sap {
35939
37356
  }
35940
37357
  /**
35941
37358
  * @since 1.7.0
37359
+ * @deprecated (since 1.120) - Please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed Views }
37360
+ * instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
35942
37361
  *
35943
37362
  * Static class for enabling declarative UI support.
35944
37363
  */
@@ -39229,7 +40648,7 @@ declare namespace sap {
39229
40648
  * Provides information about a library.
39230
40649
  *
39231
40650
  * This method is intended to be called exactly once while the main module of a library (its `library.js`
39232
- * module) is executing, typically at its begin. The single parameter `oLibInfo` is an info object that
40651
+ * module) is executing, typically at its begin. The single parameter `mSettings` is an info object that
39233
40652
  * describes the content of the library.
39234
40653
  *
39235
40654
  * When the `mSettings` has been processed, a normalized version will be set on the library instance Finally,
@@ -39243,10 +40662,10 @@ declare namespace sap {
39243
40662
  * - If the object contains a list of `interfaces`, they will be registered with the {@link sap.ui.base.DataType }
39244
40663
  * class to make them available as aggregation types in managed objects.
39245
40664
  *
40665
+ * If the object contains a list of `controls` or `elements`, {@link sap.ui.lazyRequire lazy stubs }
40666
+ * will be created for their constructor as well as for their static `extend` and `getMetadata` methods.
39246
40667
  *
39247
- * - If the object contains a list of `controls` or `elements`, {@link sap.ui.lazyRequire lazy stubs }
39248
- * will be created for their constructor as well as for their static `extend` and `getMetadata` methods.
39249
- * **Note:** Future versions might abandon the concept of lazy stubs as it requires synchronous XMLHttpRequests
40668
+ * **Note:** Future versions of UI5 will abandon the concept of lazy stubs as it requires synchronous XMLHttpRequests
39250
40669
  * which have been deprecated (see {@link http://xhr.spec.whatwg.org}). To be on the safe side, productive
39251
40670
  * applications should always require any modules that they directly depend on.
39252
40671
  *
@@ -39258,31 +40677,36 @@ declare namespace sap {
39258
40677
  * is e.g. useful when an application merges the CSS for multiple libraries and already loaded the resulting
39259
40678
  * stylesheet.
39260
40679
  *
40680
+ * If a list of library `dependencies` is specified in the info object, those libraries will be loaded
40681
+ * synchronously if they haven't been loaded yet.
39261
40682
  *
39262
- * - If a list of library `dependencies` is specified in the info object, those libraries will be loaded
39263
- * synchronously.
39264
- * **Note:** Dependencies between libraries don't have to be modeled as AMD dependencies. Only when enums
39265
- * or types from an additional library are used in the coding of the `library.js` module, the library should
39266
- * be additionally listed in the AMD dependencies.
40683
+ * **Note:** Dependencies between libraries have to be modeled consistently in several places:
40684
+ * - Both eager and lazy dependencies have to be modelled in the `.library` file.
40685
+ * - By default, UI5 Tooling generates a `manifest.json` file from the content of the `.library` file.
40686
+ * However, if the `manifest.json` file for the library is not generated but maintained manually, it must
40687
+ * be kept consistent with the `.library` file, especially regarding its listed library dependencies.
40688
+ * - All eager library dependencies must be declared as AMD dependencies of the `library.js` module by
40689
+ * referring to the corresponding `"some/lib/namespace/library"` module of each library dependency.
40690
+ *
40691
+ * - All eager dependencies must be listed in the `dependencies` property of the info object.
40692
+ * - All lazy dependencies **must not** be listed as AMD dependencies or in the `dependencies` property
40693
+ * of the info object.
39267
40694
  *
39268
40695
  * Last but not least, higher layer frameworks might want to include their own metadata for libraries. The
39269
40696
  * property `extensions` might contain such additional metadata. Its structure is not defined by the framework,
39270
40697
  * but it is strongly suggested that each extension only occupies a single property in the `extensions`
39271
40698
  * object and that the name of that property contains some namespace information (e.g. library name that
39272
40699
  * introduces the feature) to avoid conflicts with other extensions. The framework won't touch the content
39273
- * of `extensions` but will make it available in the library info objects returned by {@link #.getInitializedLibraries}.
40700
+ * of `extensions` but will make it available in the library info objects provided by {@link #.load}.
39274
40701
  *
39275
40702
  * Relationship to Descriptor for Libraries (manifest.json):
39276
40703
  *
39277
40704
  * The information contained in `mSettings` is partially redundant to the content of the descriptor for
39278
- * the same library (its `manifest.json` file). Future versions of UI5 might ignore the information provided
39279
- * in `oLibInfo` and might evaluate the descriptor file instead. Library developers therefore should keep
39280
- * the information in both files in sync.
40705
+ * the same library (its `manifest.json` file). Future versions of UI5 will ignore the information provided
40706
+ * in `mSettings` and will evaluate the descriptor file instead. Library developers therefore must keep
40707
+ * the information in both files in sync if the `manifest.json` file is maintained manually.
39281
40708
  *
39282
- * When the `manifest.json` is generated from the `.library` file (which is the default for UI5 libraries
39283
- * built with Maven), then the content of the `.library` and `library.js` files must be kept in sync.
39284
- *
39285
- * @returns As of version 1.101; returns the library namespace, based on the given library name.
40709
+ * @returns Returns the library namespace, based on the given library name.
39286
40710
  */
39287
40711
  static init(
39288
40712
  /**
@@ -39392,13 +40816,11 @@ declare namespace sap {
39392
40816
  * library:
39393
40817
  * ```javascript
39394
40818
  *
39395
- * Lib.load({name: "heavy.charting"})
39396
- * .then(function() {
39397
- * View.create({
39398
- * name: "myapp.views.HeavyChartingView",
39399
- * type: ViewType.XML
39400
- * });
39401
- * });
40819
+ * await Library.load({name: "heavy.charting"});
40820
+ * await View.create({
40821
+ * name: "myapp.views.HeavyChartingView",
40822
+ * type: ViewType.XML
40823
+ * });
39402
40824
  * ```
39403
40825
  *
39404
40826
  *
@@ -40267,9 +41689,28 @@ declare namespace sap {
40267
41689
  sCalendarType?: sap.ui.core.CalendarType
40268
41690
  ): string;
40269
41691
  /**
40270
- * Get locale specific language names.
41692
+ * Gets the locale-specific language name for the given language tag.
40271
41693
  *
40272
- * @returns map of locale specific language names
41694
+ * The languages returned by {@link #getLanguages} from the CLDR raw data do not contain the language names
41695
+ * if they can be derived from the language and the script or the territory. If the map of languages contains
41696
+ * no entry for the given language tag, derive the language name from the used script or region.
41697
+ *
41698
+ * @returns The language name, or `undefined` if the name cannot be determined
41699
+ */
41700
+ getLanguageName(
41701
+ /**
41702
+ * The language tag, for example "en", "en-US", "en_US", "zh-Hant", or "zh_Hant"
41703
+ */
41704
+ sLanguageTag: string
41705
+ ): string | undefined;
41706
+ /**
41707
+ * Gets locale-specific language names, as available in the CLDR raw data.
41708
+ *
41709
+ * To avoid redundancies, with CLDR version 43 only language names are contained which cannot be derived
41710
+ * from the language and the script or the territory. If a language tag is not contained in the map, use
41711
+ * {@link #getLanguageName} to get the derived locale-specific language name for that language tag.
41712
+ *
41713
+ * @returns Maps a language tag to the locale-specific language name
40273
41714
  */
40274
41715
  getLanguages(): Record<string, string>;
40275
41716
  /**
@@ -40652,15 +42093,22 @@ declare namespace sap {
40652
42093
  sUnit: string
40653
42094
  ): object;
40654
42095
  /**
40655
- * Get locale specific script names.
42096
+ * Gets locale-specific script names, as available in the CLDR raw data.
40656
42097
  *
40657
- * @returns map of locale specific script names
42098
+ * To avoid redundancies, with CLDR version 43 only scripts are contained for which the language-specific
42099
+ * name is different from the script key. If a script key is not contained in the map, use the script key
42100
+ * as script name.
42101
+ *
42102
+ * @returns Maps a script key to the locale-specific script name
40658
42103
  */
40659
42104
  getScripts(): Record<string, string>;
40660
42105
  /**
40661
- * Get locale specific territory names.
42106
+ * Gets locale-specific territory names, as available in the CLDR raw data.
42107
+ *
42108
+ * To avoid redundancies, with CLDR version 43 only territories are contained for which the language-specific
42109
+ * name is different from the territory key.
40662
42110
  *
40663
- * @returns map of locale specific territory names
42111
+ * @returns Maps a territory key to the locale-specific territory name
40664
42112
  */
40665
42113
  getTerritories(): Record<string, string>;
40666
42114
  /**
@@ -44365,9 +45813,6 @@ declare namespace sap {
44365
45813
  * First, all old content controls (if any) will be detached from this UIArea (e.g. their parent relationship
44366
45814
  * to this UIArea will be cut off). Then the parent relationship for the new content control (if not empty)
44367
45815
  * will be set to this UIArea and finally, the UIArea will be marked for re-rendering.
44368
- *
44369
- * The real re-rendering happens whenever the re-rendering is called. Either implicitly at the end of any
44370
- * control event or by calling sap.ui.getCore().applyChanges().
44371
45816
  */
44372
45817
  setRootControl(
44373
45818
  /**
@@ -45501,6 +46946,8 @@ declare namespace sap {
45501
46946
  Small = "Small",
45502
46947
  }
45503
46948
  /**
46949
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/18n/date/CalendarType} instead.
46950
+ *
45504
46951
  * The types of `Calendar`.
45505
46952
  */
45506
46953
  enum CalendarType {
@@ -45703,6 +47150,78 @@ declare namespace sap {
45703
47150
  * Indication Color 8
45704
47151
  */
45705
47152
  Indication08 = "Indication08",
47153
+ /**
47154
+ * @since 1.120
47155
+ *
47156
+ * Indication Color 9
47157
+ */
47158
+ Indication09 = "Indication09",
47159
+ /**
47160
+ * @since 1.120
47161
+ *
47162
+ * Indication Color 10
47163
+ */
47164
+ Indication10 = "Indication10",
47165
+ /**
47166
+ * @since 1.120
47167
+ *
47168
+ * Indication Color 11
47169
+ */
47170
+ Indication11 = "Indication11",
47171
+ /**
47172
+ * @since 1.120
47173
+ *
47174
+ * Indication Color 12
47175
+ */
47176
+ Indication12 = "Indication12",
47177
+ /**
47178
+ * @since 1.120
47179
+ *
47180
+ * Indication Color 13
47181
+ */
47182
+ Indication13 = "Indication13",
47183
+ /**
47184
+ * @since 1.120
47185
+ *
47186
+ * Indication Color 14
47187
+ */
47188
+ Indication14 = "Indication14",
47189
+ /**
47190
+ * @since 1.120
47191
+ *
47192
+ * Indication Color 15
47193
+ */
47194
+ Indication15 = "Indication15",
47195
+ /**
47196
+ * @since 1.120
47197
+ *
47198
+ * Indication Color 16
47199
+ */
47200
+ Indication16 = "Indication16",
47201
+ /**
47202
+ * @since 1.120
47203
+ *
47204
+ * Indication Color 17
47205
+ */
47206
+ Indication17 = "Indication17",
47207
+ /**
47208
+ * @since 1.120
47209
+ *
47210
+ * Indication Color 18
47211
+ */
47212
+ Indication18 = "Indication18",
47213
+ /**
47214
+ * @since 1.120
47215
+ *
47216
+ * Indication Color 19
47217
+ */
47218
+ Indication19 = "Indication19",
47219
+ /**
47220
+ * @since 1.120
47221
+ *
47222
+ * Indication Color 20
47223
+ */
47224
+ Indication20 = "Indication20",
45706
47225
  }
45707
47226
  /**
45708
47227
  * @since 1.78
@@ -53927,14 +55446,14 @@ declare namespace sap {
53927
55446
  *
53928
55447
  * Get a download URL with the specified format considering the sort/filter/custom parameters.
53929
55448
  *
53930
- * @returns URL which can be used for downloading
55449
+ * @returns URL which can be used for downloading; `null` if this binding uses {@link sap.ui.model.Filter.NONE}
53931
55450
  */
53932
55451
  getDownloadUrl(
53933
55452
  /**
53934
55453
  * Value for the $format Parameter
53935
55454
  */
53936
55455
  sFormat: string
53937
- ): string;
55456
+ ): string | null;
53938
55457
  /**
53939
55458
  * Return the length of the list.
53940
55459
  *
@@ -54007,8 +55526,10 @@ declare namespace sap {
54007
55526
  * in its constructor or in its {@link #filter} method; add filters which you want to keep with the "and"
54008
55527
  * conjunction to the resulting filter before calling {@link #filter}.
54009
55528
  *
54010
- * @returns A Promise that resolves with a {@link sap.ui.model.Filter} representing the entries with messages;
54011
- * it resolves with `null` if the binding is not resolved or if there is no message for any entry
55529
+ * @returns A Promise that resolves with an {@link sap.ui.model.Filter} representing the entries with messages,
55530
+ * except in the following cases:
55531
+ * If only transient entries have messages, it resolves with {@link sap.ui.model.Filter.NONE} If
55532
+ * the binding is not resolved or if there is no message for any entry, it resolves with `null`
54012
55533
  */
54013
55534
  requestFilterForMessages(
54014
55535
  /**
@@ -54806,6 +56327,13 @@ declare namespace sap {
54806
56327
  * Map of binding parameters
54807
56328
  */
54808
56329
  mParameters?: {
56330
+ /**
56331
+ * Whether the tree binding only requests transition messages from the back end. If messages for entities
56332
+ * of this collection need to be updated, use {@link sap.ui.model.odata.v2.ODataModel#read} on the parent
56333
+ * entity corresponding to the tree binding's context, with the parameter `updateAggregatedMessages` set
56334
+ * to `true`.
56335
+ */
56336
+ transitionMessagesOnly?: boolean;
54809
56337
  /**
54810
56338
  * The mapping between data properties and the hierarchy used to visualize the tree, if not provided by
54811
56339
  * the service's metadata. For the correct metadata annotations, check the "SAP Annotations for OData Version
@@ -57851,10 +59379,10 @@ declare namespace sap {
57851
59379
  * depending on this context become unresolved, but no attempt is made to restore these bindings in case
57852
59380
  * of reset or failure.
57853
59381
  *
57854
- * Deleting a child node is supported (@experimental as of version 1.118.0) in a recursive hierarchy (see
57855
- * {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}). As a precondition, `oAggregation.expandTo`
57856
- * must be equal to one, and the context must not be {@link #setKeepAlive kept-alive} and hidden (for example
57857
- * due to a filter).
59382
+ * Deleting a node in a recursive hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation})
59383
+ * is supported (@experimental as of version 1.118.0). As a precondition, the context must not be {@link #setKeepAlive kept-alive }
59384
+ * and hidden (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
59385
+ * Such a deletion is not a pending change.
57858
59386
  * See:
57859
59387
  * #hasPendingChanges
57860
59388
  * #resetChanges
@@ -57981,6 +59509,17 @@ declare namespace sap {
57981
59509
  */
57982
59510
  sPath?: string
57983
59511
  ): any;
59512
+ /**
59513
+ * @experimental (since 1.120.0)
59514
+ *
59515
+ * Returns the parent node (in case of a recursive hierarchy, see {@link #setAggregation}, where `oAggregation.expandTo`
59516
+ * must be equal to one).
59517
+ * See:
59518
+ * #requestParent
59519
+ *
59520
+ * @returns The parent node, or `null` if this node is a root node and thus has no parent
59521
+ */
59522
+ getParent(): sap.ui.model.odata.v4.Context | null;
57984
59523
  /**
57985
59524
  * @since 1.39.0
57986
59525
  *
@@ -58027,6 +59566,20 @@ declare namespace sap {
58027
59566
  * @returns Whether there are pending changes
58028
59567
  */
58029
59568
  hasPendingChanges(): boolean;
59569
+ /**
59570
+ * @since 1.120.0
59571
+ *
59572
+ * Tells whether this node is an ancestor of (or the same as) the given node (in case of a recursive hierarchy,
59573
+ * see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
59574
+ *
59575
+ * @returns Whether the assumed ancestor relation holds
59576
+ */
59577
+ isAncestorOf(
59578
+ /**
59579
+ * Some node which may be a descendant
59580
+ */
59581
+ oNode: sap.ui.model.odata.v4.Context
59582
+ ): boolean;
58030
59583
  /**
58031
59584
  * @since 1.105.0
58032
59585
  *
@@ -58109,8 +59662,8 @@ declare namespace sap {
58109
59662
  /**
58110
59663
  * @experimental (since 1.119.0)
58111
59664
  *
58112
- * Moves this node to the given parent (in case of a recursive hierarchy, see {@link #setAggregation}, where
58113
- * `oAggregation.expandTo` must be one). No other {@link sap.ui.model.odata.v4.ODataListBinding#create creation},
59665
+ * Moves this node to the given parent (in case of a recursive hierarchy, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation},
59666
+ * where `oAggregation.expandTo` must be one). No other {@link sap.ui.model.odata.v4.ODataListBinding#create creation},
58114
59667
  * {@link #delete deletion}, or move must be pending, and no other modification (including collapse of some
58115
59668
  * ancestor node) must happen while this move is pending!
58116
59669
  *
@@ -58207,6 +59760,20 @@ declare namespace sap {
58207
59760
  */
58208
59761
  sPath?: string
58209
59762
  ): Promise<any>;
59763
+ /**
59764
+ * @experimental (since 1.120.0)
59765
+ *
59766
+ * Requests the parent node (in case of a recursive hierarchy, see {@link #setAggregation}, where `oAggregation.expandTo`
59767
+ * must be equal to one).
59768
+ * See:
59769
+ * #getParent
59770
+ *
59771
+ * @returns A promise which:
59772
+ * - Resolves if successful with either the parent node or `null` for a root node that has no parent
59773
+ *
59774
+ * - Rejects with an `Error` instance otherwise
59775
+ */
59776
+ requestParent(): Promise<sap.ui.model.odata.v4.Context | null>;
58210
59777
  /**
58211
59778
  * @since 1.39.0
58212
59779
  *
@@ -59207,11 +60774,12 @@ declare namespace sap {
59207
60774
  *
59208
60775
  * Creating a new child beneath an existing and visible parent node (which must either be a leaf or expanded,
59209
60776
  * but not collapsed) is supported (@experimental as of version 1.117.0) in case of a recursive hierarchy
59210
- * (see {@link #setAggregation}). The parent node must be identified via a {@link sap.ui.model.odata.v4.Context }
59211
- * instance given as `oInitialData["@$ui5.node.parent"]`. `oAggregation.expandTo` (see {@link #setAggregation})
59212
- * must be one, `bSkipRefresh` must be set, but both `bAtEnd` and `bInactive` must not be set. No other
59213
- * creation or {@link sap.ui.model.odata.v4.Context#move move} must be pending, and no other modification
59214
- * (including collapse of some ancestor node) must happen while this creation is pending!
60777
+ * (see {@link #setAggregation}). The parent node must be identified via an {@link sap.ui.model.odata.v4.Context }
60778
+ * instance given as `oInitialData["@$ui5.node.parent"]` (which is immediately removed from the new child's
60779
+ * data). It can be `null` or absent when creating a new root node (@experimental as of version 1.120.0).
60780
+ * `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 }
60781
+ * must be pending, and no other modification (including collapse of some ancestor node) must happen while
60782
+ * this creation is pending!
59215
60783
  *
59216
60784
  * @returns The context object for the created entity; its method {@link sap.ui.model.odata.v4.Context#created }
59217
60785
  * returns a promise that is resolved when the creation is finished
@@ -59874,7 +61442,8 @@ declare namespace sap {
59874
61442
  * The number (as a positive integer) of different levels initially available without calling {@link sap.ui.model.odata.v4.Context#expand }
59875
61443
  * (@experimental as of version 1.105.0; available for read-only hierarchies since 1.117.0), supported only
59876
61444
  * if a `hierarchyQualifier` is given. Root nodes are on the first level. By default, only root nodes are
59877
- * available; they are not yet expanded.
61445
+ * available; they are not yet expanded. Since 1.120.0, `Number.MAX_SAFE_INTEGER` can be used to expand
61446
+ * all levels.
59878
61447
  */
59879
61448
  expandTo?: number;
59880
61449
  /**
@@ -60939,7 +62508,7 @@ declare namespace sap {
60939
62508
  updateGroupId?: string;
60940
62509
  /**
60941
62510
  * Whether the XMLHttpRequest is called with `withCredentials`, so that user credentials are included in
60942
- * cross-origin requests by the browser (@experimental as of Version 1.117.0)
62511
+ * cross-origin requests by the browser (since 1.120.0)
60943
62512
  */
60944
62513
  withCredentials?: boolean;
60945
62514
  }
@@ -63200,19 +64769,23 @@ declare namespace sap {
63200
64769
  * `"{@i18n>...}"` to the hard-coded model name "@i18n" with arbitrary path are not turned into a fixed
63201
64770
  * text, but kept as a data binding expression; this allows local annotation files to refer to a resource
63202
64771
  * bundle for internationalization. the dynamic "14.5.1 Comparison and Logical Operators": These are
63203
- * turned into expression bindings to perform the operations at run-time. the dynamic "14.5.3 Expression
63204
- * edm:Apply":
64772
+ * turned into expression bindings to perform the operations at run-time. It's strongly recommended to require
64773
+ * the `sap.ui.model.odata.v4.ODataUtils` module in advance to avoid synchronous loading of this module.
64774
+ * the dynamic "14.5.3 Expression edm:Apply":
63205
64775
  * "14.5.3.1.1 Function odata.concat": This is turned into a data binding expression relative to an entity.
63206
64776
  * "14.5.3.1.2 Function odata.fillUriTemplate": This is turned into an expression binding to fill the
63207
- * template at run-time. "14.5.3.1.3 Function odata.uriEncode": This is turned into an expression binding
63208
- * to encode the parameter at run-time. Apply functions may be nested arbitrarily. the dynamic
63209
- * "14.5.6 Expression edm:If": This is turned into an expression binding to be evaluated at run-time. The
63210
- * expression is a conditional expression like `"{=condition ? expression1 : expression2}"`. the dynamic
63211
- * "14.5.10 Expression edm:Null": This is turned into a `null` value. In `odata.concat` it is ignored.
63212
- * the dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression edm:PropertyPath": This is turned into
63213
- * a data binding relative to an entity, including type information and constraints as available from metadata,
63214
- * e.g. `"{path : 'Name', type : 'sap.ui.model.odata.type.String', constraints : {'maxLength':'255'}}"`.
63215
- * Depending on the used type, some additional constraints of this type are set:
64777
+ * template at run-time. It's strongly recommended to require the `sap.ui.thirdparty.URITemplate` module
64778
+ * in advance to avoid synchronous loading of this module. "14.5.3.1.3 Function odata.uriEncode": This
64779
+ * is turned into an expression binding to encode the parameter at run-time. It's strongly recommended to
64780
+ * require the `sap.ui.model.odata.ODataUtils` module in advance to avoid synchronous loading of this module.
64781
+ * Apply functions may be nested arbitrarily. the dynamic "14.5.6 Expression edm:If": This
64782
+ * is turned into an expression binding to be evaluated at run-time. The expression is a conditional expression
64783
+ * like `"{=condition ? expression1 : expression2}"`. the dynamic "14.5.10 Expression edm:Null": This
64784
+ * is turned into a `null` value. In `odata.concat` it is ignored. the dynamic "14.5.12 Expression
64785
+ * edm:Path" and "14.5.13 Expression edm:PropertyPath": This is turned into a data binding relative to an
64786
+ * entity, including type information and constraints as available from metadata, e.g. `"{path : 'Name',
64787
+ * type : 'sap.ui.model.odata.type.String', constraints : {'maxLength':'255'}}"`. Depending on the used
64788
+ * type, some additional constraints of this type are set:
63216
64789
  * Edm.DateTime: The "displayFormat" constraint is set to the value of the "sap:display-format" annotation
63217
64790
  * of the referenced property. Edm.Decimal: The "precision" and "scale" constraints are set to the values
63218
64791
  * of the corresponding attributes of the referenced property. The "minimum", "maximum", "minimumExclusive"
@@ -70642,6 +72215,15 @@ declare namespace sap {
70642
72215
  */
70643
72216
  vValue2?: any
70644
72217
  );
72218
+ /**
72219
+ * @since 1.120.0
72220
+ *
72221
+ * A filter instance that is never fulfilled. When used to filter a list, no back-end request is sent and
72222
+ * only transient entries remain.
72223
+ *
72224
+ * **Note:** Not all model implementations support this filter.
72225
+ */
72226
+ static NONE: sap.ui.model.Filter;
70645
72227
 
70646
72228
  /**
70647
72229
  * Compares two values
@@ -80207,8 +81789,12 @@ declare namespace sap {
80207
81789
 
80208
81790
  "sap/base/assert": undefined;
80209
81791
 
81792
+ "sap/base/config": undefined;
81793
+
80210
81794
  "sap/base/Event": undefined;
80211
81795
 
81796
+ "sap/base/Eventing": undefined;
81797
+
80212
81798
  "sap/base/i18n/date/CalendarType": undefined;
80213
81799
 
80214
81800
  "sap/base/i18n/date/CalendarWeekNumbering": undefined;
@@ -80313,6 +81899,8 @@ declare namespace sap {
80313
81899
 
80314
81900
  "sap/ui/base/DataType": undefined;
80315
81901
 
81902
+ "sap/ui/base/DesignTime": undefined;
81903
+
80316
81904
  "sap/ui/base/Event": undefined;
80317
81905
 
80318
81906
  "sap/ui/base/EventProvider": undefined;
@@ -80507,6 +82095,8 @@ declare namespace sap {
80507
82095
 
80508
82096
  "sap/ui/core/Renderer": undefined;
80509
82097
 
82098
+ "sap/ui/core/Rendering": undefined;
82099
+
80510
82100
  "sap/ui/core/RenderManager": undefined;
80511
82101
 
80512
82102
  "sap/ui/core/ResizeHandler": undefined;
@@ -80551,6 +82141,8 @@ declare namespace sap {
80551
82141
 
80552
82142
  "sap/ui/core/support/usage/EventBroadcaster": undefined;
80553
82143
 
82144
+ "sap/ui/core/Supportability": undefined;
82145
+
80554
82146
  "sap/ui/core/syncStyleClass": undefined;
80555
82147
 
80556
82148
  "sap/ui/core/Theming": undefined;
@@ -80957,6 +82549,8 @@ declare namespace sap {
80957
82549
 
80958
82550
  "sap/ui/security/FrameOptions": undefined;
80959
82551
 
82552
+ "sap/ui/security/Security": undefined;
82553
+
80960
82554
  "sap/ui/test/actions/Action": undefined;
80961
82555
 
80962
82556
  "sap/ui/test/actions/Drag": undefined;
@@ -81040,6 +82634,8 @@ declare namespace sap {
81040
82634
  "sap/ui/util/XMLHelper": undefined;
81041
82635
 
81042
82636
  "sap/ui/VersionInfo": undefined;
82637
+
82638
+ "ui5loader-autoconfig": undefined;
81043
82639
  }
81044
82640
 
81045
82641
  type ClassInfo<T, C> = T & Partial<C> & ThisType<T & C>;