@openui5/types 1.119.1 → 1.120.1

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.1
283
+ // For Library Version: 1.120.1
284
284
 
285
285
  declare module "sap/base/assert" {
286
286
  /**
@@ -304,6 +304,1016 @@ 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 customizing data for Islamic calendar support.
497
+ *
498
+ * See: {@link module:sap/base/i18n/Formatting.CustomIslamicCalendarData}
499
+ *
500
+ * @returns Returns an array that contains the customizing data. Each element in the array has properties:
501
+ * dateFormat, islamicMonthStart, gregDate. For details, please see {@link #.setCustomIslamicCalendarData}
502
+ */
503
+ getCustomIslamicCalendarData(): CustomIslamicCalendarData[] | undefined;
504
+ /**
505
+ * @since 1.120
506
+ *
507
+ * Returns the currently set date pattern or undefined if no pattern has been defined.
508
+ *
509
+ * @returns The resulting date pattern
510
+ */
511
+ getDatePattern(
512
+ /**
513
+ * The date style (short, medium, long or full)
514
+ */
515
+ sStyle: "short" | "medium" | "long" | "full"
516
+ ): string;
517
+ /**
518
+ * @since 1.120
519
+ *
520
+ * Returns the LanguageTag to be used for formatting.
521
+ *
522
+ * If no such LanguageTag has been defined, this method falls back to the language, see {@link module:sap/base/i18n/Localization.getLanguage Localization.getLanguage()}.
523
+ *
524
+ * If any user preferences for date, time or number formatting have been set, and if no format LanguageTag
525
+ * has been specified, then a special private use subtag is added to the LanguageTag, indicating to the
526
+ * framework that these user preferences should be applied.
527
+ *
528
+ * @returns the format LanguageTag
529
+ */
530
+ getLanguageTag(): LanguageTag;
531
+ /**
532
+ * @since 1.120
533
+ *
534
+ * Returns the currently set number symbol of the given type or undefined if no symbol has been defined.
535
+ *
536
+ * @returns A non-numerical symbol used as part of a number for the given type, e.g. for locale de_DE:
537
+ *
538
+ * - "group": "." (grouping separator)
539
+ * - "decimal": "," (decimal separator)
540
+ * - "plusSign": "+" (plus sign)
541
+ * - "minusSign": "-" (minus sign)
542
+ */
543
+ getNumberSymbol(
544
+ /**
545
+ * the type of symbol
546
+ */
547
+ sType: "group" | "decimal" | "plusSign" | "minusSign"
548
+ ): string;
549
+ /**
550
+ * @since 1.120
551
+ *
552
+ * Returns the currently set time pattern or undefined if no pattern has been defined.
553
+ *
554
+ * @returns The resulting time pattern
555
+ */
556
+ getTimePattern(
557
+ /**
558
+ * The time style (short, medium, long or full)
559
+ */
560
+ sStyle: "short" | "medium" | "long" | "full"
561
+ ): string;
562
+ /**
563
+ * @since 1.120
564
+ *
565
+ * Returns current trailingCurrencyCode configuration for new NumberFormatter instances
566
+ *
567
+ * @returns Whether currency codes shall always be placed after the numeric value
568
+ */
569
+ getTrailingCurrencyCode(): boolean;
570
+ /**
571
+ * @since 1.120
572
+ *
573
+ * Allows to specify one of the ABAP date formats.
574
+ *
575
+ * This method modifies the date patterns for 'short' and 'medium' style with the corresponding ABAP format.
576
+ * When called with a null or undefined format id, any previously applied format will be removed.
577
+ *
578
+ * After changing the date format, the framework tries to update localization specific parts of the UI.
579
+ * See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
580
+ * for details and restrictions.
581
+ */
582
+ setABAPDateFormat(
583
+ /**
584
+ * ID of the ABAP date format, `""` will reset the date patterns for 'short' and 'medium' style to the locale-specific
585
+ * ones.
586
+ */
587
+ sFormatId?:
588
+ | ""
589
+ | "1"
590
+ | "2"
591
+ | "3"
592
+ | "4"
593
+ | "5"
594
+ | "6"
595
+ | "7"
596
+ | "8"
597
+ | "9"
598
+ | "A"
599
+ | "B"
600
+ | "C"
601
+ ): void;
602
+ /**
603
+ * @since 1.120
604
+ *
605
+ * Allows to specify one of the ABAP number format.
606
+ *
607
+ * This method will modify the 'group' and 'decimal' symbols. When called with a null or undefined format
608
+ * id, any previously applied format will be removed.
609
+ *
610
+ * After changing the number format, the framework tries to update localization specific parts of the UI.
611
+ * See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
612
+ * for details and restrictions.
613
+ */
614
+ setABAPNumberFormat(
615
+ /**
616
+ * ID of the ABAP number format set, `""` will reset the 'group' and 'decimal' symbols to the locale-specific
617
+ * ones.
618
+ */
619
+ sFormatId?: "" | " " | "X" | "Y"
620
+ ): void;
621
+ /**
622
+ * @since 1.120
623
+ *
624
+ * Allows to specify one of the ABAP time formats.
625
+ *
626
+ * This method sets the time patterns for 'short' and 'medium' style to the corresponding ABAP formats and
627
+ * sets the day period texts to "AM"/"PM" or "am"/"pm" respectively. When called with a null or undefined
628
+ * format id, any previously applied format will be removed.
629
+ *
630
+ * After changing the time format, the framework tries to update localization specific parts of the UI.
631
+ * See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
632
+ * for details and restrictions.
633
+ */
634
+ setABAPTimeFormat(
635
+ /**
636
+ * ID of the ABAP time format, `""` will reset the time patterns for 'short' and 'medium' style and the
637
+ * day period texts to the locale-specific ones.
638
+ */
639
+ sFormatId?: "" | "0" | "1" | "2" | "3" | "4"
640
+ ): void;
641
+ /**
642
+ * @since 1.120
643
+ *
644
+ * Sets the new calendar type to be used from now on in locale dependent functionality (for example, formatting,
645
+ * translation texts, etc.).
646
+ */
647
+ setCalendarType(
648
+ /**
649
+ * the new calendar type. Set it with null to clear the calendar type and the calendar type is calculated
650
+ * based on the format settings and current locale.
651
+ */
652
+ sCalendarType: (CalendarType | keyof typeof CalendarType) | null
653
+ ): void;
654
+ /**
655
+ * @since 1.120
656
+ *
657
+ * Sets the calendar week numbering algorithm which is used to determine the first day of the week and the
658
+ * first calendar week of the year, see {@link module:sap/base/i18n/date/CalendarWeekNumbering}.
659
+ */
660
+ setCalendarWeekNumbering(
661
+ /**
662
+ * The calendar week numbering algorithm
663
+ */
664
+ sCalendarWeekNumbering:
665
+ | CalendarWeekNumbering
666
+ | keyof typeof CalendarWeekNumbering
667
+ ): void;
668
+ /**
669
+ * @since 1.120
670
+ *
671
+ * Sets custom currencies and replaces existing entries.
672
+ *
673
+ * There is a special currency code named "DEFAULT" that is optional. In case it is set it will be used
674
+ * for all currencies not contained in the list, otherwise currency digits as defined by the CLDR will be
675
+ * used as a fallback.
676
+ *
677
+ * Example: To use CLDR, but override single currencies ` { "KWD": {"digits": 3}, "TND" : {"digits": 3 }
678
+ * } `
679
+ *
680
+ * To replace the CLDR currency digits completely ` { "DEFAULT": {"digits": 2}, "ADP": {"digits": 0}, ...
681
+ * "XPF": {"digits": 0} } `
682
+ *
683
+ * Note: To unset the custom currencies: call with `undefined` Custom currencies must not only consist of
684
+ * digits but contain at least one non-digit character, e.g. "a", so that the measure part can be distinguished
685
+ * from the number part.
686
+ * See:
687
+ * {@link module:sap/base/i18n/Formatting.addCustomCurrencies}
688
+ */
689
+ setCustomCurrencies(
690
+ /**
691
+ * currency map which is set
692
+ */
693
+ mCurrencies: object
694
+ ): void;
695
+ /**
696
+ * @since 1.120
697
+ *
698
+ * Allows to specify the customizing data for Islamic calendar support
699
+ *
700
+ * See: {@link module:sap/base/i18n/Formatting.CustomIslamicCalendarData}
701
+ */
702
+ setCustomIslamicCalendarData(
703
+ /**
704
+ * Contains the customizing data for the support of Islamic calendar. One JSON object in the array represents
705
+ * one row of data from Table TISLCAL
706
+ */
707
+ aCustomCalendarData: CustomIslamicCalendarData[]
708
+ ): void;
709
+ /**
710
+ * @since 1.120
711
+ *
712
+ * Defines the preferred format pattern for the given date format style.
713
+ *
714
+ * Calling this method with a null or undefined pattern removes a previously set pattern.
715
+ *
716
+ * If a pattern is defined, it will be preferred over patterns derived from the current locale.
717
+ *
718
+ * See class {@link sap.ui.core.format.DateFormat} for details about the pattern syntax.
719
+ *
720
+ * After changing the date pattern, the framework tries to update localization specific parts of the UI.
721
+ * See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
722
+ * for details and restrictions.
723
+ */
724
+ setDatePattern(
725
+ /**
726
+ * must be one of short, medium, long or full.
727
+ */
728
+ sStyle: "short" | "medium" | "long" | "full",
729
+ /**
730
+ * the format pattern to be used in LDML syntax.
731
+ */
732
+ sPattern: string
733
+ ): void;
734
+ /**
735
+ * @since 1.120
736
+ *
737
+ * Sets a new language tag to be used from now on for retrieving language specific formatters. Modifying
738
+ * this setting does not have an impact on the retrieval of translated texts!
739
+ *
740
+ * Can either be set to a concrete value (a BCP47 or Java locale compliant language tag) or to `null`. When
741
+ * set to `null` (default value) then locale specific formatters are retrieved for the current language.
742
+ *
743
+ * After changing the format locale, the framework tries to update localization specific parts of the UI.
744
+ * See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
745
+ * for details and restrictions.
746
+ *
747
+ * **Note**: When a language tag is set, it has higher priority than a number, date or time format defined
748
+ * with a call to `setABAPNumberFormat`, `setABAPDateFormat` or `setABAPTimeFormat`.
749
+ *
750
+ * **Note**: See documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
751
+ * for restrictions.
752
+ */
753
+ setLanguageTag(
754
+ /**
755
+ * the new BCP47 compliant language tag; case doesn't matter and underscores can be used instead of dashes
756
+ * to separate components (compatibility with Java Locale IDs)
757
+ */
758
+ vLanguageTag: string | LanguageTag | null
759
+ ): void;
760
+ /**
761
+ * @since 1.120
762
+ *
763
+ * Defines the string to be used for the given number symbol.
764
+ *
765
+ * Calling this method with a null or undefined symbol removes a previously set symbol string. Note that
766
+ * an empty string is explicitly allowed.
767
+ *
768
+ * If a symbol is defined, it will be preferred over symbols derived from the current locale.
769
+ *
770
+ * See class {@link sap.ui.core.format.NumberFormat} for details about the symbols.
771
+ *
772
+ * After changing the number symbol, the framework tries to update localization specific parts of the UI.
773
+ * See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
774
+ * for details and restrictions.
775
+ */
776
+ setNumberSymbol(
777
+ /**
778
+ * the type of symbol
779
+ */
780
+ sType: "group" | "decimal" | "plusSign" | "minusSign",
781
+ /**
782
+ * will be used to represent the given symbol type
783
+ */
784
+ sSymbol: string
785
+ ): void;
786
+ /**
787
+ * @since 1.120
788
+ *
789
+ * Defines the preferred format pattern for the given time format style.
790
+ *
791
+ * Calling this method with a null or undefined pattern removes a previously set pattern.
792
+ *
793
+ * If a pattern is defined, it will be preferred over patterns derived from the current locale.
794
+ *
795
+ * See class {@link sap.ui.core.format.DateFormat} for details about the pattern syntax.
796
+ *
797
+ * After changing the time pattern, the framework tries to update localization specific parts of the UI.
798
+ * See the documentation of {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage() }
799
+ * for details and restrictions.
800
+ */
801
+ setTimePattern(
802
+ /**
803
+ * must be one of short, medium, long or full.
804
+ */
805
+ sStyle: "short" | "medium" | "long" | "full",
806
+ /**
807
+ * the format pattern to be used in LDML syntax.
808
+ */
809
+ sPattern: string
810
+ ): void;
811
+ /**
812
+ * @since 1.120
813
+ *
814
+ * Define whether the NumberFormatter shall always place the currency code after the numeric value, with
815
+ * the only exception of right-to-left locales, where the currency code shall be placed before the numeric
816
+ * value. Default configuration setting is `true`.
817
+ *
818
+ * When set to `false` the placement of the currency code is done dynamically, depending on the configured
819
+ * locale using data provided by the Unicode Common Locale Data Repository (CLDR).
820
+ *
821
+ * Each currency instance ({@link sap.ui.core.format.NumberFormat.getCurrencyInstance}) will be created
822
+ * with this setting unless overwritten on instance level.
823
+ */
824
+ setTrailingCurrencyCode(
825
+ /**
826
+ * Whether currency codes shall always be placed after the numeric value
827
+ */
828
+ bTrailingCurrencyCode: boolean
829
+ ): void;
830
+ }
831
+ const Formatting: Formatting;
832
+ export default Formatting;
833
+
834
+ /**
835
+ * Customizing data for the support of Islamic calendar. Represents one row of data from Table TISLCAL.
836
+ */
837
+ export type CustomIslamicCalendarData = {
838
+ /**
839
+ * The date format. Column DATFM in TISLCAL.
840
+ */
841
+ dateFormat: "A" | "B";
842
+ /**
843
+ * The Islamic date in format: 'yyyyMMdd'. Column ISLMONTHSTART in TISLCAL.
844
+ */
845
+ islamicMonthStart: string;
846
+ /**
847
+ * The corresponding Gregorian date format: 'yyyyMMdd'. Column GREGDATE in TISLCAL.
848
+ */
849
+ gregDate: string;
850
+ };
851
+
852
+ /**
853
+ * @since 1.120
854
+ *
855
+ * The formatting change event. Contains only the parameters which were changed.
856
+ *
857
+ * The list below shows the possible combinations of parameters available as part of the change event.
858
+ *
859
+ *
860
+ * - {@link module:sap/base/i18n/Formatting.setLanguageTag Formatting.setLanguageTag}:
861
+ * `languageTag`
862
+ * - {@link module:sap/base/i18n/Formatting.setCustomIslamicCalendarData Formatting.setCustomIslamicCalendarData}:
863
+ *
864
+ * `customIslamicCalendarData`
865
+ * - {@link module:sap/base/i18n/Formatting.setCalendarWeekNumbering Formatting.setCalendarWeekNumbering}:
866
+ *
867
+ * `calendarWeekNumbering`
868
+ * - {@link module:sap/base/i18n/Formatting.setCalendarType Formatting.setCalendarType}:
869
+ * `calendarType`
870
+ * - {@link module:sap/base/i18n/Formatting.addCustomCurrencies Formatting.addCustomCurrencies} / {@link module:sap/base/i18n/Formatting.setCustomCurrencies Formatting.setCustomCurrencies}:
871
+ *
872
+ * `currency`
873
+ * - {@link module:sap/base/i18n/Formatting.setABAPDateFormat Formatting.setABAPDateFormat} (all parameters
874
+ * listed below):
875
+ * `ABAPDateFormat`
876
+ * - `"dateFormats-short"`
877
+ * - `"dateFormats-medium"`
878
+ * - {@link module:sap/base/i18n/Formatting.setABAPTimeFormat Formatting.setABAPTimeFormat} (all parameters
879
+ * listed below):
880
+ * `ABAPTimeFormat`
881
+ * - `"timeFormats-short"`
882
+ * - `"timeFormats-medium"`
883
+ * - `"dayPeriods-format-abbreviated"`
884
+ * - {@link module:sap/base/i18n/Formatting.setABAPNumberFormat Formatting.setABAPNumberFormat} (all parameters
885
+ * listed below):
886
+ * `ABAPNumberFormat`
887
+ * - `"symbols-latn-group"`
888
+ * - `"symbols-latn-decimal"`
889
+ * - {@link module:sap/base/i18n/Formatting.setDatePattern Formatting.setDatePattern} (one of the parameters
890
+ * listed below):
891
+ * `"dateFormats-short"`
892
+ * - `"dateFormats-medium"`
893
+ * - `"dateFormats-long"`
894
+ * - `"dateFormats-full"`
895
+ * - {@link module:sap/base/i18n/Formatting.setTimePattern Formatting.setTimePattern} (one of the parameters
896
+ * listed below):
897
+ * `"timeFormats-short"`
898
+ * - `"timeFormats-medium"`
899
+ * - `"timeFormats-long"`
900
+ * - `"timeFormats-full"`
901
+ * - {@link module:sap/base/i18n/Formatting.setNumberSymbol Formatting.setNumberSymbol} (one of the parameters
902
+ * listed below):
903
+ * `"symbols-latn-group"`
904
+ * - `"symbols-latn-decimal"`
905
+ * - `"symbols-latn-plusSign"`
906
+ * - `"symbols-latn-minusSign"`
907
+ */
908
+ export type Formatting$ChangeEvent = {
909
+ /**
910
+ * The formatting language tag.
911
+ */
912
+ languageTag?: string;
913
+ /**
914
+ * The ABAP date format.
915
+ */
916
+ ABAPDateFormat?: string;
917
+ /**
918
+ * The ABAP time format.
919
+ */
920
+ ABAPTimeFormat?: string;
921
+ /**
922
+ * The ABAP number format.
923
+ */
924
+ ABAPNumberFormat?: string;
925
+ /**
926
+ * The legacy date calendar customizing.
927
+ */
928
+ legacyDateCalendarCustomizing?: object[];
929
+ /**
930
+ * The calendar week numbering.
931
+ */
932
+ calendarWeekNumbering?: object;
933
+ /**
934
+ * The calendar type.
935
+ */
936
+ calendarType?: object;
937
+ /**
938
+ * The short date format.
939
+ */
940
+ "dateFormats-short"?: string;
941
+ /**
942
+ * The medium date format.
943
+ */
944
+ "dateFormats-medium"?: string;
945
+ /**
946
+ * The long date format.
947
+ */
948
+ "dateFormats-long"?: string;
949
+ /**
950
+ * The full date format.
951
+ */
952
+ "dateFormats-full"?: string;
953
+ /**
954
+ * The short time format.
955
+ */
956
+ "timeFormats-short"?: string;
957
+ /**
958
+ * The medium time format.
959
+ */
960
+ "timeFormats-medium"?: string;
961
+ /**
962
+ * The long time format.
963
+ */
964
+ "timeFormats-long"?: string;
965
+ /**
966
+ * The full time format.
967
+ */
968
+ "timeFormats-full"?: string;
969
+ /**
970
+ * The latin symbols group.
971
+ */
972
+ "symbols-latn-group"?: string;
973
+ /**
974
+ * The latin symbols decimal.
975
+ */
976
+ "symbols-latn-decimal"?: string;
977
+ /**
978
+ * The latin symbols plusSign.
979
+ */
980
+ "symbols-latn-plusSign"?: string;
981
+ /**
982
+ * The latin symbols minusSign.
983
+ */
984
+ "symbols-latn-minusSign"?: string;
985
+ /**
986
+ * The currency.
987
+ */
988
+ currency?: Record<string, string>;
989
+ /**
990
+ * The abbreviated day periods format.
991
+ */
992
+ "dayPeriods-format-abbreviated"?: string[];
993
+ };
994
+ }
995
+
996
+ declare module "sap/base/i18n/LanguageTag" {
997
+ /**
998
+ * Creates an LanguageTag instance. LanguageTag represents a BCP-47 language tag, consisting of a language,
999
+ * script, region, variants, extensions and private use section.
1000
+ */
1001
+ export default class LanguageTag {
1002
+ constructor(
1003
+ /**
1004
+ * the language tag identifier, in format en-US or en_US.
1005
+ */
1006
+ sLanguageTag: string
1007
+ );
1008
+ /**
1009
+ * Get the extension as a single string or `null`.
1010
+ *
1011
+ * The extension always consists of a singleton character (not 'x'), a dash '-' and one or more extension
1012
+ * token, each separated again with a dash.
1013
+ */
1014
+ extension: string | null;
1015
+
1016
+ /**
1017
+ * Get the extensions as an array of tokens.
1018
+ *
1019
+ * The leading singleton and the separating dashes are not part of the result. If there is no extensions
1020
+ * section in the language tag, an empty array is returned.
1021
+ */
1022
+ extensionSubtags: string[];
1023
+
1024
+ /**
1025
+ * Get the language.
1026
+ *
1027
+ * Note that the case might differ from the original script tag (Lower case is enforced as recommended by
1028
+ * BCP47/ISO639).
1029
+ */
1030
+ language: string;
1031
+
1032
+ /**
1033
+ * Get the region or `null` if none was specified.
1034
+ *
1035
+ * Note that the case might differ from the original script tag (Upper case is enforced as recommended by
1036
+ * BCP47/ISO3166-1).
1037
+ */
1038
+ region: string;
1039
+
1040
+ /**
1041
+ * Get the script or `null` if none was specified.
1042
+ *
1043
+ * Note that the case might differ from the original language tag (Upper case first letter and lower case
1044
+ * reminder enforced as recommended by BCP47/ISO15924)
1045
+ */
1046
+ script: string | null;
1047
+
1048
+ /**
1049
+ * Get the variants as a single string or `null`.
1050
+ *
1051
+ * Multiple variants are separated by a dash '-'.
1052
+ */
1053
+ variant: string | null;
1054
+
1055
+ /**
1056
+ * Get the variants as an array of individual variants.
1057
+ *
1058
+ * The separating dashes are not part of the result. If there is no variant section in the language tag,
1059
+ * an empty array is returned.
1060
+ */
1061
+ variantSubtags: string[];
1062
+ }
1063
+ }
1064
+
1065
+ declare module "sap/base/i18n/Localization" {
1066
+ import LanguageTag from "sap/base/i18n/LanguageTag";
1067
+
1068
+ /**
1069
+ * @since 1.118
1070
+ *
1071
+ * Configuration for localization specific parameters
1072
+ */
1073
+ interface Localization {
1074
+ /**
1075
+ * @since 1.120.0
1076
+ *
1077
+ * Attaches the `fnFunction` event handler to the {@link #event:change change} event of `module:sap/base/i18n/Localization`.
1078
+ */
1079
+ attachChange(
1080
+ /**
1081
+ * The function to be called when the event occurs
1082
+ */
1083
+ fnFunction: (p1: Localization$ChangeEvent) => void
1084
+ ): void;
1085
+ /**
1086
+ * @since 1.120.0
1087
+ *
1088
+ * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `module:sap/base/i18n/Localization`.
1089
+ */
1090
+ detachChange(
1091
+ /**
1092
+ * Function to be called when the event occurs
1093
+ */
1094
+ fnFunction: (p1: Localization$ChangeEvent) => void
1095
+ ): void;
1096
+ /**
1097
+ * @since 1.119.0
1098
+ *
1099
+ * Returns the list of active terminologies defined via the Configuration.
1100
+ *
1101
+ * @returns if no active terminologies are set, the default value `undefined` is returned.
1102
+ */
1103
+ getActiveTerminologies(): string[] | undefined;
1104
+ /**
1105
+ * @since 1.120.0
1106
+ *
1107
+ * Returns a string that identifies the current language.
1108
+ *
1109
+ * The value returned by config method in most cases corresponds to the exact value that has been configured
1110
+ * by the user or application or that has been determined from the user agent settings. It has not been
1111
+ * normalized, but has been validated against a relaxed version of {@link http://www.ietf.org/rfc/bcp/bcp47.txt BCP47},
1112
+ * allowing underscores ('_') instead of the suggested dashes ('-') and not taking the case of letters into
1113
+ * account.
1114
+ *
1115
+ * The exceptions mentioned above affect languages that have been specified via the URL parameter `sap-language`.
1116
+ * That parameter by definition represents an SAP logon language code ('ABAP language'). Most but not all
1117
+ * of these language codes are valid ISO639 two-letter languages and as such are valid BCP47 language tags.
1118
+ * For better BCP47 compliance, the framework maps the following non-BCP47 SAP logon codes to a BCP47 substitute:
1119
+ *
1120
+ * ```javascript
1121
+ *
1122
+ * "ZH" --> "zh-Hans" // script 'Hans' added to distinguish it from zh-Hant
1123
+ * "ZF" --> "zh-Hant" // ZF is not a valid ISO639 code, use the compliant language + script 'Hant'
1124
+ * "1Q" --> "en-US-x-saptrc" // special language code for supportability (tracing),
1125
+ * represented as en-US with a private extension
1126
+ * "2Q" --> "en-US-x-sappsd" // special language code for supportability (pseudo translation),
1127
+ * represented as en-US with a private extension
1128
+ * "3Q" --> "en-US-x-saprigi" // special language code for the Rigi pseudo language,
1129
+ * represented as en-US with a private extension
1130
+ * ```
1131
+ *
1132
+ *
1133
+ * Call {@link moduel:sap/base/i18n/Localization.getLanguageTag getLanguageTag} to get a {@link module:sap/base/i18n/LanguageTag LanguageTag }
1134
+ * object matching the language. For a normalized BCP47 tag, call {@link module:sap/base/i18n/LanguageTag.toString toString() }
1135
+ * on the returned `LanguageTag`
1136
+ *
1137
+ * @returns Language string as configured
1138
+ */
1139
+ getLanguage(): string;
1140
+ /**
1141
+ * @since 1.120.0
1142
+ *
1143
+ * Returns a LanguageTag object for the current language.
1144
+ *
1145
+ * The LanguageTag is derived from {@link modue:sap/base/i18n/Localization.getLanguage Localization.getLanguage}.
1146
+ *
1147
+ * @returns The LanguageTag
1148
+ */
1149
+ getLanguageTag(): LanguageTag;
1150
+ /**
1151
+ * @since 1.120.0
1152
+ *
1153
+ * Returns whether the page uses the RTL text direction.
1154
+ *
1155
+ * If no mode has been explicitly set (neither `true` nor `false`), the mode is derived from the current
1156
+ * language setting.
1157
+ *
1158
+ * @returns whether the page uses the RTL text direction
1159
+ */
1160
+ getRTL(): boolean;
1161
+ /**
1162
+ * @since 1.120.0
1163
+ *
1164
+ * Returns an SAP logon language for the current language.
1165
+ *
1166
+ * It will be returned in uppercase. e.g. "EN", "DE"
1167
+ *
1168
+ * @returns The SAP logon language code for the current language
1169
+ */
1170
+ getSAPLogonLanguage(): string;
1171
+ /**
1172
+ * @since 1.120.0
1173
+ *
1174
+ * Retrieves the configured IANA timezone ID.
1175
+ *
1176
+ * @returns The configured IANA timezone ID, e.g. "America/New_York"
1177
+ */
1178
+ getTimezone(): string;
1179
+ /**
1180
+ * @since 1.120.0
1181
+ *
1182
+ * Sets a new language to be used from now on for language/region dependent functionality (e.g. formatting,
1183
+ * data types, translated texts, ...).
1184
+ *
1185
+ * When the language can't be interpreted as a BCP47 language (using the relaxed syntax described in {@link #getLanguage},
1186
+ * an error will be thrown.
1187
+ *
1188
+ * When the language has changed, the Localization will fire its {@link module:sap/base/i18n/Localization.change change }
1189
+ * event.
1190
+ *
1191
+ * Restrictions:
1192
+ *
1193
+ * The framework **does not** guarantee that already created, language dependent objects will be updated
1194
+ * by config call. It therefore remains best practice for applications to switch the language early, e.g.
1195
+ * before any language dependent objects are created. Applications that need to support more dynamic changes
1196
+ * of the language should listen to the `localizationChanged` event and adapt all language dependent objects
1197
+ * that they use (e.g. by rebuilding their UI).
1198
+ *
1199
+ * Currently, the framework notifies the following objects about a change of the localization settings before
1200
+ * it fires the `localizationChanged` event:
1201
+ *
1202
+ *
1203
+ * - date and number data types that are used in property bindings or composite bindings in existing Elements,
1204
+ * Controls, UIAreas or Components
1205
+ * - ResourceModels currently assigned to the Core, a UIArea, Component, Element or Control
1206
+ * - Elements or Controls that implement the `onLocalizationChanged` hook
1207
+ *
1208
+ * It furthermore derives the RTL mode from the new language, if no explicit RTL mode has been set. If the
1209
+ * RTL mode changes, the following additional actions will be taken:
1210
+ *
1211
+ *
1212
+ * - the URLs of already loaded library theme files will be changed
1213
+ * - the `dir` attribute of the page will be changed to reflect the new mode.
1214
+ * - all UIAreas will be invalidated (which results in a rendering of the whole UI5 UI)
1215
+ *
1216
+ * config method does not accept SAP language codes for `sLanguage`. Instead, a second parameter `sSAPLogonLanguage`
1217
+ * can be provided with an SAP language code corresponding to the given language. A given value will be
1218
+ * returned by the {@link module:sap/base/i18n/Localization.getSAPLogonLanguage getSAPLogonLanguage} method.
1219
+ * It is up to the caller to provide a consistent pair of BCP47 language and SAP language code. The SAP
1220
+ * language code is only checked to be of length 2 and must consist of letters or digits only.
1221
+ *
1222
+ * **Note**: When using config method please take note of and respect the above mentioned restrictions.
1223
+ * See:
1224
+ * http://scn.sap.com/docs/DOC-14377
1225
+ */
1226
+ setLanguage(
1227
+ /**
1228
+ * the new language as a BCP47 compliant language tag; case doesn't matter and underscores can be used instead
1229
+ * of dashes to separate components (compatibility with Java Locale IDs)
1230
+ */
1231
+ sLanguage: string,
1232
+ /**
1233
+ * SAP language code that corresponds to the `sLanguage`; if a value is specified, future calls to `getSAPLogonLanguage`
1234
+ * will return that value; if no value is specified, the framework will use the ISO639 language part of
1235
+ * `sLanguage` as SAP Logon language.
1236
+ */
1237
+ sSAPLogonLanguage?: string
1238
+ ): void;
1239
+ /**
1240
+ * @since 1.120.0
1241
+ *
1242
+ * Sets the character orientation mode to be used from now on.
1243
+ *
1244
+ * Can either be set to a concrete value (true meaning right-to-left, false meaning left-to-right) or to
1245
+ * `null` which means that the character orientation mode should be derived from the current language (incl.
1246
+ * region) setting.
1247
+ *
1248
+ * After changing the character orientation mode, the framework tries to update localization specific parts
1249
+ * of the UI. See the documentation of {@link module:sap/base/i18n/Localization.setLanguage setLanguage }
1250
+ * for details and restrictions.
1251
+ *
1252
+ * **Note**: See documentation of {@link module:sap/base/i18n/Localization.setLanguage setLanguage} for
1253
+ * restrictions.
1254
+ */
1255
+ setRTL(
1256
+ /**
1257
+ * new character orientation mode or `null`
1258
+ */
1259
+ bRTL: boolean | null
1260
+ ): void;
1261
+ /**
1262
+ * @since 1.120.0
1263
+ *
1264
+ * Sets the timezone such that all date and time based calculations use config timezone.
1265
+ *
1266
+ * **Important:** It is strongly recommended to only use config API at the earliest point of time while
1267
+ * initializing a UI5 app. A later adjustment of the time zone should be avoided. It can lead to unexpected
1268
+ * data inconsistencies in a running application, because date objects could still be related to a previously
1269
+ * configured time zone. Instead, the app should be completely restarted with the new time zone. For more
1270
+ * information, see {@link https://ui5.sap.com/#/topic/6c9e61dc157a40c19460660ece8368bc Dates, Times, Timestamps, and Time Zones}.
1271
+ *
1272
+ * When the timezone has changed, the Localization will fire its {@link #event:change change} event.
1273
+ */
1274
+ setTimezone(
1275
+ /**
1276
+ * IANA timezone ID, e.g. "America/New_York". Use `null` to reset the timezone to the browser's local timezone.
1277
+ * An invalid IANA timezone ID will fall back to the browser's timezone.
1278
+ */
1279
+ sTimezone?: string | null
1280
+ ): void;
1281
+ }
1282
+ const Localization: Localization;
1283
+ export default Localization;
1284
+
1285
+ /**
1286
+ * @since 1.120.0
1287
+ *
1288
+ * The localization change event. Contains only the parameters which were changed.
1289
+ *
1290
+ * The list below shows the possible combinations of parameters available as part of the change event.
1291
+ *
1292
+ *
1293
+ * - {@link module:sap/base/i18n/Localization.setLanguage Localization.setLanguage}:
1294
+ * `language`
1295
+ * - `rtl?` (only if language change also changed RTL)
1296
+ * - {@link module:sap/base/i18n/Localization.setRTL Localization.setRTL}:
1297
+ * `rtl`
1298
+ * - {@link module:sap/base/i18n/Localization.setTimezone Localization.setTimezone}:
1299
+ * `timezone`
1300
+ */
1301
+ export type Localization$ChangeEvent = {
1302
+ /**
1303
+ * The newly set language.
1304
+ */
1305
+ language?: string;
1306
+ /**
1307
+ * Whether the page uses the RTL text direction.
1308
+ */
1309
+ rtl?: boolean;
1310
+ /**
1311
+ * The newly set timezone.
1312
+ */
1313
+ timezone?: string;
1314
+ };
1315
+ }
1316
+
307
1317
  declare module "sap/base/i18n/ResourceBundle" {
308
1318
  /**
309
1319
  * @since 1.58
@@ -2554,6 +3564,37 @@ declare module "sap/ui/util/XMLHelper" {
2554
3564
  export default XMLHelper;
2555
3565
  }
2556
3566
 
3567
+ declare module "sap/ui/core/AnimationMode" {
3568
+ /**
3569
+ * @since 1.120
3570
+ *
3571
+ * Enumerable list with available animation modes.
3572
+ *
3573
+ * This enumerable is used to validate the animation mode. Animation modes allow to specify different animation
3574
+ * scenarios or levels. The implementation of the Control (JavaScript or CSS) has to be done differently
3575
+ * for each animation mode.
3576
+ */
3577
+ enum AnimationMode {
3578
+ /**
3579
+ * `basic` can be used for a reduced, more light-weight set of animations.
3580
+ */
3581
+ basic = "basic",
3582
+ /**
3583
+ * `full` represents a mode with unrestricted animation capabilities.
3584
+ */
3585
+ full = "full",
3586
+ /**
3587
+ * `minimal` includes animations of fundamental functionality.
3588
+ */
3589
+ minimal = "minimal",
3590
+ /**
3591
+ * `none` deactivates the animation completely.
3592
+ */
3593
+ none = "none",
3594
+ }
3595
+ export default AnimationMode;
3596
+ }
3597
+
2557
3598
  declare module "sap/ui/core/ComponentSupport" {
2558
3599
  /**
2559
3600
  * @since 1.58.0
@@ -2639,6 +3680,52 @@ declare module "sap/ui/core/ComponentSupport" {
2639
3680
  export default ComponentSupport;
2640
3681
  }
2641
3682
 
3683
+ declare module "sap/ui/core/ControlBehavior" {
3684
+ import AnimationMode from "sap/ui/core/AnimationMode";
3685
+
3686
+ /**
3687
+ * @since 1.120
3688
+ *
3689
+ * Provides control behavior relevant configuration options
3690
+ */
3691
+ interface ControlBehavior {
3692
+ /**
3693
+ * @since 1.120
3694
+ *
3695
+ * Returns the current animation mode.
3696
+ *
3697
+ * @returns The current animationMode
3698
+ */
3699
+ getAnimationMode(): AnimationMode | keyof typeof AnimationMode;
3700
+ /**
3701
+ * @since 1.120
3702
+ *
3703
+ * Returns whether the accessibility mode is enabled or not.
3704
+ *
3705
+ * @returns whether the accessibility mode is enabled or not
3706
+ */
3707
+ isAccessibilityEnabled(): boolean;
3708
+ /**
3709
+ * @since 1.120
3710
+ *
3711
+ * Sets the current animation mode.
3712
+ *
3713
+ * Expects an animation mode as string and validates it. If a wrong animation mode was set, an error is
3714
+ * thrown. If the mode is valid it is set, then the attributes `data-sap-ui-animation` and `data-sap-ui-animation-mode`
3715
+ * of the HTML document root element are also updated. If the `animationMode` is `AnimationMode.none` the
3716
+ * old `animation` property is set to `false`, otherwise it is set to `true`.
3717
+ */
3718
+ setAnimationMode(
3719
+ /**
3720
+ * A valid animation mode
3721
+ */
3722
+ sAnimationMode: AnimationMode | keyof typeof AnimationMode
3723
+ ): void;
3724
+ }
3725
+ const ControlBehavior: ControlBehavior;
3726
+ export default ControlBehavior;
3727
+ }
3728
+
2642
3729
  declare module "sap/ui/core/date/CalendarUtils" {
2643
3730
  import CalendarWeekNumbering from "sap/ui/core/date/CalendarWeekNumbering";
2644
3731
 
@@ -3578,6 +4665,8 @@ declare module "sap/ui/core/Theming" {
3578
4665
  */
3579
4666
  interface Theming {
3580
4667
  /**
4668
+ * @since 1.118.0
4669
+ *
3581
4670
  * Attaches event handler `fnFunction` to the {@link #event:applied applied} event.
3582
4671
  *
3583
4672
  * The given handler is called when the the applied event is fired. If the theme is already applied the
@@ -3588,9 +4677,11 @@ declare module "sap/ui/core/Theming" {
3588
4677
  /**
3589
4678
  * The function to be called, when the event occurs
3590
4679
  */
3591
- fnFunction: Function
4680
+ fnFunction: (p1: Theming$AppliedEvent) => void
3592
4681
  ): void;
3593
4682
  /**
4683
+ * @since 1.118.0
4684
+ *
3594
4685
  * Detaches event handler `fnFunction` from the {@link #event:applied applied} event
3595
4686
  *
3596
4687
  * The passed function must match the one used for event registration.
@@ -3599,32 +4690,48 @@ declare module "sap/ui/core/Theming" {
3599
4690
  /**
3600
4691
  * The function to be called, when the event occurs
3601
4692
  */
3602
- fnFunction: Function
4693
+ fnFunction: (p1: Theming$AppliedEvent) => void
3603
4694
  ): void;
3604
4695
  /**
4696
+ * @since 1.118
4697
+ *
3605
4698
  * Returns the theme name
3606
4699
  *
3607
4700
  * @returns the theme name
3608
4701
  */
3609
4702
  getTheme(): string;
3610
4703
  /**
4704
+ * @since 1.118.0
4705
+ *
3611
4706
  * Notify content density changes
3612
4707
  */
3613
4708
  notifyContentDensityChanged(): void;
3614
4709
  /**
3615
- * Allows setting the theme name
4710
+ * @since 1.118
3616
4711
  *
3617
- * @returns `this` to allow method chaining
4712
+ * Allows setting the theme name
3618
4713
  */
3619
4714
  setTheme(
3620
4715
  /**
3621
4716
  * the theme name
3622
4717
  */
3623
4718
  sTheme: string
3624
- ): this;
4719
+ ): void;
3625
4720
  }
3626
4721
  const Theming: Theming;
3627
4722
  export default Theming;
4723
+
4724
+ /**
4725
+ * @since 1.118.0
4726
+ *
4727
+ * The theme applied Event.
4728
+ */
4729
+ export type Theming$AppliedEvent = {
4730
+ /**
4731
+ * The newly set language.
4732
+ */
4733
+ theme: string;
4734
+ };
3628
4735
  }
3629
4736
 
3630
4737
  declare module "sap/ui/dom/containsOrEquals" {
@@ -4189,14 +5296,15 @@ declare module "sap/ui/model/FilterProcessor" {
4189
5296
  * Groups filters according to their path and combines filters on the same path using "OR" and filters on
4190
5297
  * different paths using "AND", all multi-filters contained are ANDed.
4191
5298
  *
4192
- * @returns Single Filter containing all filters of the array combined or undefined
5299
+ * @returns A single filter containing all filters of the array combined or `undefined` if no filters are
5300
+ * given
4193
5301
  */
4194
5302
  groupFilters(
4195
5303
  /**
4196
- * the filters to be grouped
5304
+ * The filters to be grouped
4197
5305
  */
4198
- aFilters: Filter[]
4199
- ): Filter;
5306
+ aFilters?: Filter[]
5307
+ ): Filter | undefined;
4200
5308
  }
4201
5309
  const FilterProcessor: FilterProcessor;
4202
5310
  export default FilterProcessor;
@@ -4717,6 +5825,59 @@ declare module "sap/ui/performance/trace/Interaction" {
4717
5825
  };
4718
5826
  }
4719
5827
 
5828
+ declare module "sap/ui/security/Security" {
5829
+ import { URI } from "sap/ui/core/library";
5830
+
5831
+ /**
5832
+ * @since 1.120.0
5833
+ *
5834
+ * Provides security related API
5835
+ */
5836
+ interface Security {
5837
+ /**
5838
+ * @since 1.120.0
5839
+ *
5840
+ * URL of the allowlist service.
5841
+ *
5842
+ * @returns allowlist service URL
5843
+ */
5844
+ getAllowlistService(): string;
5845
+ /**
5846
+ * @since 1.120.0
5847
+ *
5848
+ * frameOptions mode (allow/deny/trusted).
5849
+ *
5850
+ * @returns frameOptions mode
5851
+ */
5852
+ getFrameOptions(): string;
5853
+ /**
5854
+ * @since 1.120.0
5855
+ *
5856
+ * Returns the security token handlers of an OData V4 model.
5857
+ * See:
5858
+ * #setSecurityTokenHandlers
5859
+ *
5860
+ * @returns the security token handlers (an empty array if there are none)
5861
+ */
5862
+ getSecurityTokenHandlers(): Array<(p1: URI) => Promise<any>>;
5863
+ /**
5864
+ * @since 1.120.0
5865
+ *
5866
+ * Sets the security token handlers for an OData V4 model. See chapter {@link https://ui5.sap.com/#/topic/9613f1f2d88747cab21896f7216afdac/section_STH Security Token Handling}.
5867
+ * See:
5868
+ * #getSecurityTokenHandlers
5869
+ */
5870
+ setSecurityTokenHandlers(
5871
+ /**
5872
+ * The security token handlers
5873
+ */
5874
+ aSecurityTokenHandlers: Array<(p1: URI) => Promise<any>>
5875
+ ): void;
5876
+ }
5877
+ const Security: Security;
5878
+ export default Security;
5879
+ }
5880
+
4720
5881
  declare module "sap/ui/test/opaQunit" {
4721
5882
  /**
4722
5883
  * QUnit test adapter for OPA: add a test to be executed by QUnit Has the same signature as QUnit.test (QUnit
@@ -5621,6 +6782,33 @@ declare module "sap/ui/base/DataType" {
5621
6782
  */
5622
6783
  sTypeName: string
5623
6784
  ): DataType | undefined;
6785
+ /**
6786
+ * @since 1.120.0
6787
+ *
6788
+ * Registers an enum under the given name. With version 2.0, registering an enum becomes mandatory when
6789
+ * said enum is to be used in properties of a {@link sap.ui.base.ManagedObject ManagedObject} subclass.
6790
+ *
6791
+ * Example:
6792
+ *
6793
+ * ```javascript
6794
+ *
6795
+ * DataType.registerEnum("my.enums.Sample", {
6796
+ * "A": "A",
6797
+ * "B": "B",
6798
+ * ...
6799
+ * });
6800
+ * ```
6801
+ */
6802
+ static registerEnum(
6803
+ /**
6804
+ * the type name in dot syntax, e.g. sap.ui.my.EnumType
6805
+ */
6806
+ sTypeName: string,
6807
+ /**
6808
+ * the enum content
6809
+ */
6810
+ mContent: object
6811
+ ): void;
5624
6812
  /**
5625
6813
  * The base type of this type or undefined if this is a primitive type.
5626
6814
  *
@@ -6192,6 +7380,8 @@ declare module "sap/ui/base/ManagedObject" {
6192
7380
 
6193
7381
  import BindingMode from "sap/ui/model/BindingMode";
6194
7382
 
7383
+ import { ID } from "sap/ui/core/library";
7384
+
6195
7385
  /**
6196
7386
  * Base Class that introduces some basic concepts, such as, state management and data binding.
6197
7387
  *
@@ -6312,9 +7502,11 @@ declare module "sap/ui/base/ManagedObject" {
6312
7502
  * The possible values for a setting depend on its kind:
6313
7503
  * - for simple properties, the value has to match the documented type of the property (no type conversion
6314
7504
  * occurs)
6315
- * - for 0..1 aggregations, the value has to be an instance of the aggregated type
6316
- * - for 0..n aggregations, the value has to be an array of instances of the aggregated type or a single
6317
- * instance
7505
+ * - for 0..1 aggregations, the value has to be an instance of the aggregated type, or an object literal
7506
+ * from which, the default class of the aggregation (or the corresponding aggregation type as fallback)
7507
+ * will be instantiated.
7508
+ * - for 0..n aggregations, the value has to be an array of instances of the aggregated type, a single
7509
+ * instance or an object literal from which the default class will be instantiated.
6318
7510
  * - for 0..1 associations, an instance of the associated type or an id (string) is accepted
6319
7511
  * - for 0..n associations, an array of instances of the associated type or of IDs is accepted
6320
7512
  * - for events, either a function (event handler) is accepted or an array of length 2 where the first
@@ -6361,6 +7553,12 @@ declare module "sap/ui/base/ManagedObject" {
6361
7553
  * Note that when setting string values, any curly braces in those values need to be escaped, so they are
6362
7554
  * not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
6363
7555
  *
7556
+ * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
7557
+ * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
7558
+ * of the aggregation. Additionally, as of version 1.120, a ManagedObject subclass can specify a `defaultClass`,
7559
+ * e.g. for cases where only a single class is valid. Please refer to the {@link sap.ui.base.ManagedObject.MetadataOptions.Aggregation Aggregation }
7560
+ * documentation for more details on the `defaultClass`.
7561
+ *
6364
7562
  * Besides the settings documented below, ManagedObject itself supports the following special settings:
6365
7563
  *
6366
7564
  * - `id : sap.ui.core.ID` an ID for the new instance. Some subclasses (Element, Component) require
@@ -6426,9 +7624,11 @@ declare module "sap/ui/base/ManagedObject" {
6426
7624
  * The possible values for a setting depend on its kind:
6427
7625
  * - for simple properties, the value has to match the documented type of the property (no type conversion
6428
7626
  * occurs)
6429
- * - for 0..1 aggregations, the value has to be an instance of the aggregated type
6430
- * - for 0..n aggregations, the value has to be an array of instances of the aggregated type or a single
6431
- * instance
7627
+ * - for 0..1 aggregations, the value has to be an instance of the aggregated type, or an object literal
7628
+ * from which, the default class of the aggregation (or the corresponding aggregation type as fallback)
7629
+ * will be instantiated.
7630
+ * - for 0..n aggregations, the value has to be an array of instances of the aggregated type, a single
7631
+ * instance or an object literal from which the default class will be instantiated.
6432
7632
  * - for 0..1 associations, an instance of the associated type or an id (string) is accepted
6433
7633
  * - for 0..n associations, an array of instances of the associated type or of IDs is accepted
6434
7634
  * - for events, either a function (event handler) is accepted or an array of length 2 where the first
@@ -6475,6 +7675,12 @@ declare module "sap/ui/base/ManagedObject" {
6475
7675
  * Note that when setting string values, any curly braces in those values need to be escaped, so they are
6476
7676
  * not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
6477
7677
  *
7678
+ * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
7679
+ * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
7680
+ * of the aggregation. Additionally, as of version 1.120, a ManagedObject subclass can specify a `defaultClass`,
7681
+ * e.g. for cases where only a single class is valid. Please refer to the {@link sap.ui.base.ManagedObject.MetadataOptions.Aggregation Aggregation }
7682
+ * documentation for more details on the `defaultClass`.
7683
+ *
6478
7684
  * Besides the settings documented below, ManagedObject itself supports the following special settings:
6479
7685
  *
6480
7686
  * - `id : sap.ui.core.ID` an ID for the new instance. Some subclasses (Element, Component) require
@@ -8718,6 +9924,38 @@ declare module "sap/ui/base/ManagedObject" {
8718
9924
  };
8719
9925
 
8720
9926
  export interface $ManagedObjectSettings {
9927
+ /**
9928
+ * Unique ID of this instance. If not given, a so called autoID will be generated by the framework. AutoIDs
9929
+ * use a unique prefix that must not be used for Ids that the application (or other code) creates. It can
9930
+ * be configured option 'autoIDPrefix', see {@link sap.ui.core.Configuration}.
9931
+ */
9932
+ id?: ID;
9933
+
9934
+ /**
9935
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9936
+ * name. For the default model, String(undefined) is expected.
9937
+ */
9938
+ models?: object;
9939
+
9940
+ /**
9941
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9942
+ * name. For the default model, String(undefined) is expected.
9943
+ */
9944
+ bindingContexts?: object;
9945
+
9946
+ /**
9947
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9948
+ * name. For the default model, String(undefined) is expected.
9949
+ */
9950
+ objectBindings?: object;
9951
+
9952
+ /**
9953
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9954
+ * name. For the default model, String(undefined) is expected. The special setting is only for internal
9955
+ * use.
9956
+ */
9957
+ metadataContexts?: object;
9958
+
8721
9959
  /**
8722
9960
  * Fired after a new value for a bound property has been propagated to the model. Only fired, when the binding
8723
9961
  * uses a data type.
@@ -8908,6 +10146,11 @@ declare module "sap/ui/base/ManagedObject" {
8908
10146
  * (in dot notation, e.g. 'sap.m.Button').
8909
10147
  */
8910
10148
  type?: string;
10149
+ /**
10150
+ * The default class for the aggregation. If aggregation content is created from a plain object and no explicit
10151
+ * 'Type' is given (capital 'T'), the default class will be instantiated.
10152
+ */
10153
+ defaultClass?: Function;
8911
10154
  /**
8912
10155
  * Whether the aggregation is a 0..1 (false) or a 0..n aggregation (true), defaults to true
8913
10156
  */
@@ -9839,12 +11082,12 @@ declare module "sap/ui/base/Metadata" {
9839
11082
  */
9840
11083
  getName(): string;
9841
11084
  /**
9842
- * Returns the metadata object of the base class of the described class or null if the class has no (documented)
9843
- * base class.
11085
+ * Returns the metadata object of the base class of the described class or undefined if the class has no
11086
+ * (documented) base class.
9844
11087
  *
9845
11088
  * @returns metadata of the base class
9846
11089
  */
9847
- getParent(): Metadata;
11090
+ getParent(): Metadata | undefined;
9848
11091
  /**
9849
11092
  * @deprecated (since 1.58) - this method should not be used for productive code. The accuracy of the returned
9850
11093
  * information highly depends on the concrete class and is not actively monitored. There might be more public
@@ -10028,6 +11271,7 @@ declare module "sap/ui/base/Object" {
10028
11271
  ): Function;
10029
11272
  /**
10030
11273
  * @since 1.56
11274
+ * @deprecated (since 1.120) - please use {@link sap.ui.base.Object.isObjectA}.
10031
11275
  *
10032
11276
  * Checks whether the given object is an instance of the named type. This function is a short-hand convenience
10033
11277
  * for {@link sap.ui.base.Object#isA}.
@@ -10046,6 +11290,26 @@ declare module "sap/ui/base/Object" {
10046
11290
  */
10047
11291
  vTypeName: string | string[]
10048
11292
  ): oObject is T;
11293
+ /**
11294
+ * @since 1.120
11295
+ *
11296
+ * Checks whether the given object is an instance of the named type. This function is a short-hand convenience
11297
+ * for {@link sap.ui.base.Object#isA}.
11298
+ *
11299
+ * Please see the API documentation of {@link sap.ui.base.Object#isA} for more details.
11300
+ *
11301
+ * @returns Whether the given object is an instance of the given type or of any of the given types
11302
+ */
11303
+ static isObjectA(
11304
+ /**
11305
+ * Object which will be checked whether it is an instance of the given type
11306
+ */
11307
+ oObject: any,
11308
+ /**
11309
+ * Type or types to check for
11310
+ */
11311
+ vTypeName: string | string[]
11312
+ ): boolean;
10049
11313
  /**
10050
11314
  * Destructor method for objects.
10051
11315
  */
@@ -11200,6 +12464,78 @@ declare module "sap/ui/core/library" {
11200
12464
  * Indication Color 8
11201
12465
  */
11202
12466
  Indication08 = "Indication08",
12467
+ /**
12468
+ * @since 1.120
12469
+ *
12470
+ * Indication Color 9
12471
+ */
12472
+ Indication09 = "Indication09",
12473
+ /**
12474
+ * @since 1.120
12475
+ *
12476
+ * Indication Color 10
12477
+ */
12478
+ Indication10 = "Indication10",
12479
+ /**
12480
+ * @since 1.120
12481
+ *
12482
+ * Indication Color 11
12483
+ */
12484
+ Indication11 = "Indication11",
12485
+ /**
12486
+ * @since 1.120
12487
+ *
12488
+ * Indication Color 12
12489
+ */
12490
+ Indication12 = "Indication12",
12491
+ /**
12492
+ * @since 1.120
12493
+ *
12494
+ * Indication Color 13
12495
+ */
12496
+ Indication13 = "Indication13",
12497
+ /**
12498
+ * @since 1.120
12499
+ *
12500
+ * Indication Color 14
12501
+ */
12502
+ Indication14 = "Indication14",
12503
+ /**
12504
+ * @since 1.120
12505
+ *
12506
+ * Indication Color 15
12507
+ */
12508
+ Indication15 = "Indication15",
12509
+ /**
12510
+ * @since 1.120
12511
+ *
12512
+ * Indication Color 16
12513
+ */
12514
+ Indication16 = "Indication16",
12515
+ /**
12516
+ * @since 1.120
12517
+ *
12518
+ * Indication Color 17
12519
+ */
12520
+ Indication17 = "Indication17",
12521
+ /**
12522
+ * @since 1.120
12523
+ *
12524
+ * Indication Color 18
12525
+ */
12526
+ Indication18 = "Indication18",
12527
+ /**
12528
+ * @since 1.120
12529
+ *
12530
+ * Indication Color 19
12531
+ */
12532
+ Indication19 = "Indication19",
12533
+ /**
12534
+ * @since 1.120
12535
+ *
12536
+ * Indication Color 20
12537
+ */
12538
+ Indication20 = "Indication20",
11203
12539
  }
11204
12540
  /**
11205
12541
  * @since 1.78
@@ -12050,6 +13386,8 @@ declare module "sap/ui/core/BusyIndicator" {
12050
13386
 
12051
13387
  declare module "sap/ui/core/CalendarType" {
12052
13388
  /**
13389
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/18n/date/CalendarType} instead.
13390
+ *
12053
13391
  * The types of `Calendar`.
12054
13392
  */
12055
13393
  enum CalendarType {
@@ -12564,6 +13902,8 @@ declare module "sap/ui/core/Component" {
12564
13902
  ): Function;
12565
13903
  /**
12566
13904
  * @since 1.56.0
13905
+ * @deprecated (since 1.120) - please use the static {@link sap.ui.core.Component.getComponentById getComponentById }
13906
+ * instead.
12567
13907
  *
12568
13908
  * Returns an existing component instance, identified by its ID.
12569
13909
  *
@@ -12575,6 +13915,19 @@ declare module "sap/ui/core/Component" {
12575
13915
  */
12576
13916
  sId: string
12577
13917
  ): Component | undefined;
13918
+ /**
13919
+ * @since 1.120
13920
+ *
13921
+ * Returns an existing component instance, identified by its ID.
13922
+ *
13923
+ * @returns Component instance or `undefined` when no component with the given ID exists.
13924
+ */
13925
+ static getComponentById(
13926
+ /**
13927
+ * ID of the component.
13928
+ */
13929
+ sId: string
13930
+ ): Component | undefined;
12578
13931
  /**
12579
13932
  * Returns the metadata for the Component class.
12580
13933
  *
@@ -13192,7 +14545,9 @@ declare module "sap/ui/core/Component" {
13192
14545
  }
13193
14546
  export const registry: registry;
13194
14547
 
13195
- export interface $ComponentSettings extends $ManagedObjectSettings {}
14548
+ export interface $ComponentSettings extends $ManagedObjectSettings {
14549
+ componentData?: any;
14550
+ }
13196
14551
  }
13197
14552
 
13198
14553
  declare module "sap/ui/core/ComponentContainer" {
@@ -14222,6 +15577,8 @@ declare module "sap/ui/core/ComponentMetadata" {
14222
15577
  }
14223
15578
 
14224
15579
  declare module "sap/ui/core/Configuration" {
15580
+ import CalendarType from "sap/ui/core/CalendarType";
15581
+
14225
15582
  import CalendarWeekNumbering from "sap/ui/core/date/CalendarWeekNumbering";
14226
15583
 
14227
15584
  import Version from "sap/base/util/Version";
@@ -14232,11 +15589,13 @@ declare module "sap/ui/core/Configuration" {
14232
15589
 
14233
15590
  import { URI } from "sap/ui/core/library";
14234
15591
 
14235
- import CalendarType from "sap/ui/core/CalendarType";
14236
-
14237
15592
  import BaseObject from "sap/ui/base/Object";
14238
15593
 
15594
+ import { CustomIslamicCalendarData } from "sap/base/i18n/Formatting";
15595
+
14239
15596
  /**
15597
+ * @deprecated (since 1.120)
15598
+ *
14240
15599
  * Collects and stores the configuration of the current environment.
14241
15600
  *
14242
15601
  * The Configuration is initialized once when the {@link sap.ui.core.Core} is created. There are different
@@ -14263,6 +15622,7 @@ declare module "sap/ui/core/Configuration" {
14263
15622
  interface Configuration {
14264
15623
  /**
14265
15624
  * @since 1.50.0
15625
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/AnimationMode} instead.
14266
15626
  *
14267
15627
  * Enumerable list with available animation modes.
14268
15628
  *
@@ -14274,6 +15634,7 @@ declare module "sap/ui/core/Configuration" {
14274
15634
 
14275
15635
  /**
14276
15636
  * @since 1.38.6
15637
+ * @deprecated (since 1.120)
14277
15638
  *
14278
15639
  * Applies multiple changes to the configuration at once.
14279
15640
  *
@@ -14318,6 +15679,10 @@ declare module "sap/ui/core/Configuration" {
14318
15679
  FNMetaImpl?: Function
14319
15680
  ): Function;
14320
15681
  /**
15682
+ * @since 1.20
15683
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.isAccessibilityEnabled }
15684
+ * instead.
15685
+ *
14321
15686
  * Returns whether the accessibility mode is enabled or not.
14322
15687
  *
14323
15688
  * @returns whether the accessibility mode is enabled or not
@@ -14334,13 +15699,15 @@ declare module "sap/ui/core/Configuration" {
14334
15699
  */
14335
15700
  getActiveTerminologies(): string[] | undefined;
14336
15701
  /**
15702
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getAllowlistService} instead.
15703
+ *
14337
15704
  * URL of the allowlist service.
14338
15705
  *
14339
15706
  * @returns allowlist service URL
14340
15707
  */
14341
15708
  getAllowlistService(): string;
14342
15709
  /**
14343
- * @deprecated (since 1.50.0) - replaced by {@link sap.ui.core.Configuration#getAnimationMode}
15710
+ * @deprecated (since 1.50) - Please use {@link sap.ui.core.Configuration#getAnimationMode} instead.
14344
15711
  *
14345
15712
  * Returns whether the animations are globally used.
14346
15713
  *
@@ -14349,6 +15716,7 @@ declare module "sap/ui/core/Configuration" {
14349
15716
  getAnimation(): boolean;
14350
15717
  /**
14351
15718
  * @since 1.50.0
15719
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.getAnimationMode} instead.
14352
15720
  *
14353
15721
  * Returns the current animation mode.
14354
15722
  *
@@ -14356,15 +15724,19 @@ declare module "sap/ui/core/Configuration" {
14356
15724
  */
14357
15725
  getAnimationMode(): AnimationMode;
14358
15726
  /**
15727
+ * @deprecated (since 1.120)
15728
+ *
14359
15729
  * Base URLs to AppCacheBuster ETag-Index files.
14360
15730
  *
14361
15731
  * @returns array of base URLs
14362
15732
  */
14363
15733
  getAppCacheBuster(): string[];
14364
15734
  /**
15735
+ * @deprecated (since 1.120)
15736
+ *
14365
15737
  * The loading mode (sync|async|batch) of the AppCacheBuster (sync is default)
14366
15738
  *
14367
- * @returns "sync" | "async"
15739
+ * @returns "sync" | "async" | "batch"
14368
15740
  */
14369
15741
  getAppCacheBusterMode(): string;
14370
15742
  /**
@@ -14378,14 +15750,29 @@ declare module "sap/ui/core/Configuration" {
14378
15750
  getApplication(): string;
14379
15751
  /**
14380
15752
  * @since 1.27.0
15753
+ * @deprecated (since 1.120)
14381
15754
  *
14382
15755
  * Returns whether the framework automatically adds the ARIA role 'application' to the HTML body or not.
14383
15756
  *
14384
15757
  * @returns Wether the ARIA role 'application' should be added to the HTML body or not
14385
15758
  */
14386
15759
  getAutoAriaBodyRole(): boolean;
15760
+ /**
15761
+ * @since 1.28.6
15762
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getCalendarType} instead.
15763
+ *
15764
+ * Returns the calendar type which is being used in locale dependent functionality.
15765
+ *
15766
+ * When it's explicitly set by calling `setCalendar`, the set calendar type is returned. Otherwise, the
15767
+ * calendar type is determined by checking the format settings and current locale.
15768
+ *
15769
+ * @returns the current calendar type, e.g. `Gregorian`
15770
+ */
15771
+ getCalendarType(): CalendarType;
14387
15772
  /**
14388
15773
  * @since 1.113.0
15774
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getCalendarWeekNumbering }
15775
+ * instead.
14389
15776
  *
14390
15777
  * Returns the calendar week numbering algorithm used to determine the first day of the week and the first
14391
15778
  * calendar week of the year, see {@link sap.ui.core.date.CalendarWeekNumbering}.
@@ -14407,6 +15794,8 @@ declare module "sap/ui/core/Configuration" {
14407
15794
  sFeature: string
14408
15795
  ): Version;
14409
15796
  /**
15797
+ * @deprecated (since 1.120)
15798
+ *
14410
15799
  * Returns whether the page runs in full debug mode.
14411
15800
  *
14412
15801
  * @returns Whether the page runs in full debug mode
@@ -14414,6 +15803,7 @@ declare module "sap/ui/core/Configuration" {
14414
15803
  getDebug(): boolean;
14415
15804
  /**
14416
15805
  * @since 1.102
15806
+ * @deprecated (since 1.120)
14417
15807
  *
14418
15808
  * Name (ID) of a UI5 module that implements file share support.
14419
15809
  *
@@ -14425,6 +15815,8 @@ declare module "sap/ui/core/Configuration" {
14425
15815
  */
14426
15816
  getFileShareSupport(): string | undefined;
14427
15817
  /**
15818
+ * @deprecated (since 1.120)
15819
+ *
14428
15820
  * Returns whether the Fiori2Adaptation is on.
14429
15821
  *
14430
15822
  * @returns false - no adaptation, true - full adaptation, comma-separated list - partial adaptation Possible
@@ -14433,6 +15825,7 @@ declare module "sap/ui/core/Configuration" {
14433
15825
  getFiori2Adaptation(): boolean | string;
14434
15826
  /**
14435
15827
  * @since 1.60.0
15828
+ * @deprecated (since 1.120)
14436
15829
  *
14437
15830
  * Returns the URL from where the UI5 flexibility services are called; if empty, the flexibility services
14438
15831
  * are not called.
@@ -14441,6 +15834,8 @@ declare module "sap/ui/core/Configuration" {
14441
15834
  */
14442
15835
  getFlexibilityServices(): object[];
14443
15836
  /**
15837
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getLanguageTag} instead.
15838
+ *
14444
15839
  * Returns the format locale string with language and region code. Falls back to language configuration,
14445
15840
  * in case it has not been explicitly defined.
14446
15841
  *
@@ -14448,18 +15843,24 @@ declare module "sap/ui/core/Configuration" {
14448
15843
  */
14449
15844
  getFormatLocale(): string;
14450
15845
  /**
15846
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting} instead.
15847
+ *
14451
15848
  * Returns a configuration object that bundles the format settings of UI5.
14452
15849
  *
14453
15850
  * @returns A FormatSettings object.
14454
15851
  */
14455
15852
  getFormatSettings(): FormatSettings;
14456
15853
  /**
15854
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getFrameOptions} instead.
15855
+ *
14457
15856
  * frameOptions mode (allow/deny/trusted).
14458
15857
  *
14459
15858
  * @returns frameOptions mode
14460
15859
  */
14461
15860
  getFrameOptions(): string;
14462
15861
  /**
15862
+ * @deprecated (since 1.120)
15863
+ *
14463
15864
  * Returns whether the UI5 control inspe ctor is displayed. Has only an effect when the sap-ui-debug module
14464
15865
  * has been loaded
14465
15866
  *
@@ -14467,6 +15868,8 @@ declare module "sap/ui/core/Configuration" {
14467
15868
  */
14468
15869
  getInspect(): boolean;
14469
15870
  /**
15871
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguage} instead.
15872
+ *
14470
15873
  * Returns a string that identifies the current language.
14471
15874
  *
14472
15875
  * The value returned by config method in most cases corresponds to the exact value that has been configured
@@ -14500,6 +15903,8 @@ declare module "sap/ui/core/Configuration" {
14500
15903
  */
14501
15904
  getLanguage(): string;
14502
15905
  /**
15906
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguageTag} instead.
15907
+ *
14503
15908
  * Returns a BCP47-compliant language tag for the current language.
14504
15909
  *
14505
15910
  * The return value of config method is especially useful for an HTTP `Accept-Language` header.
@@ -14510,6 +15915,8 @@ declare module "sap/ui/core/Configuration" {
14510
15915
  */
14511
15916
  getLanguageTag(): string;
14512
15917
  /**
15918
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguageTag} instead.
15919
+ *
14513
15920
  * Returns a Locale object for the current language.
14514
15921
  *
14515
15922
  * The Locale is derived from the {@link #getLanguage language} property.
@@ -14519,6 +15926,8 @@ declare module "sap/ui/core/Configuration" {
14519
15926
  getLocale(): Locale;
14520
15927
  /**
14521
15928
  * @since 1.33.0
15929
+ * @deprecated (since 1.120) - 'manifest-first' is the default for the {@link sap.ui.core.Component.create }
15930
+ * factory.
14522
15931
  *
14523
15932
  * Flag whether a Component should load the manifest first.
14524
15933
  *
@@ -14532,12 +15941,16 @@ declare module "sap/ui/core/Configuration" {
14532
15941
  */
14533
15942
  getMetadata(): Metadata;
14534
15943
  /**
15944
+ * @deprecated (since 1.120)
15945
+ *
14535
15946
  * Returns whether there should be an exception on any duplicate element IDs.
14536
15947
  *
14537
15948
  * @returns whether there should be an exception on any duplicate element IDs
14538
15949
  */
14539
15950
  getNoDuplicateIds(): boolean;
14540
15951
  /**
15952
+ * @deprecated (since 1.120)
15953
+ *
14541
15954
  * Returns whether the text origin information is collected.
14542
15955
  *
14543
15956
  * @returns whether the text info is collected
@@ -14552,6 +15965,8 @@ declare module "sap/ui/core/Configuration" {
14552
15965
  */
14553
15966
  getRootComponent(): string;
14554
15967
  /**
15968
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getRTL} instead.
15969
+ *
14555
15970
  * Returns whether the page uses the RTL text direction.
14556
15971
  *
14557
15972
  * If no mode has been explicitly set (neither `true` nor `false`), the mode is derived from the current
@@ -14561,6 +15976,9 @@ declare module "sap/ui/core/Configuration" {
14561
15976
  */
14562
15977
  getRTL(): boolean;
14563
15978
  /**
15979
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getSAPLogonLanguage }
15980
+ * instead.
15981
+ *
14564
15982
  * Returns an SAP logon language for the current language.
14565
15983
  *
14566
15984
  * It will be returned in uppercase. e.g. "EN", "DE"
@@ -14569,7 +15987,8 @@ declare module "sap/ui/core/Configuration" {
14569
15987
  */
14570
15988
  getSAPLogonLanguage(): string;
14571
15989
  /**
14572
- * @since 1.95.0
15990
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getSecurityTokenHandlers }
15991
+ * instead.
14573
15992
  *
14574
15993
  * Returns the security token handlers of an OData V4 model.
14575
15994
  * See:
@@ -14580,6 +15999,7 @@ declare module "sap/ui/core/Configuration" {
14580
15999
  getSecurityTokenHandlers(): Array<(p1: URI) => Promise<any>>;
14581
16000
  /**
14582
16001
  * @since 1.106.0
16002
+ * @deprecated (since 1.120)
14583
16003
  *
14584
16004
  * Flag if statistics are requested.
14585
16005
  *
@@ -14590,19 +16010,23 @@ declare module "sap/ui/core/Configuration" {
14590
16010
  */
14591
16011
  getStatisticsEnabled(): boolean;
14592
16012
  /**
16013
+ * @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.getTheme} instead.
16014
+ *
14593
16015
  * Returns the theme name
14594
16016
  *
14595
16017
  * @returns the theme name
14596
16018
  */
14597
16019
  getTheme(): string;
14598
16020
  /**
16021
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getTimezone} instead.
16022
+ *
14599
16023
  * Retrieves the configured IANA timezone ID.
14600
16024
  *
14601
16025
  * @returns The configured IANA timezone ID, e.g. "America/New_York"
14602
16026
  */
14603
16027
  getTimezone(): string;
14604
16028
  /**
14605
- * @deprecated (since 1.119.0) - Please use {@link sap.ui.base.ManagedObjectMetadata.getUIDPrefix ManagedObjectMetadata.getUIDPrefix }
16029
+ * @deprecated (since 1.119) - Please use {@link sap.ui.base.ManagedObjectMetadata.getUIDPrefix ManagedObjectMetadata.getUIDPrefix }
14606
16030
  * instead.
14607
16031
  *
14608
16032
  * Prefix to be used for automatically generated control IDs. Default is a double underscore "__".
@@ -14611,6 +16035,8 @@ declare module "sap/ui/core/Configuration" {
14611
16035
  */
14612
16036
  getUIDPrefix(): string;
14613
16037
  /**
16038
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/VersionInfo.load} instead.
16039
+ *
14614
16040
  * Returns the version of the framework.
14615
16041
  *
14616
16042
  * Similar to `sap.ui.version`.
@@ -14619,9 +16045,9 @@ declare module "sap/ui/core/Configuration" {
14619
16045
  */
14620
16046
  getVersion(): Version;
14621
16047
  /**
14622
- * @deprecated (since 1.85.0) - Use {@link sap.ui.core.Configuration#getAllowlistService} instead. SAP strives
14623
- * to replace insensitive terms with inclusive language. Since APIs cannot be renamed or immediately removed
14624
- * for compatibility reasons, this API has been deprecated.
16048
+ * @deprecated (since 1.85) - Use {@link module:sap/ui/security/Security.getAllowlistService} instead. SAP
16049
+ * strives to replace insensitive terms with inclusive language. Since APIs cannot be renamed or immediately
16050
+ * removed for compatibility reasons, this API has been deprecated.
14625
16051
  *
14626
16052
  * URL of the whitelist service.
14627
16053
  *
@@ -14630,6 +16056,7 @@ declare module "sap/ui/core/Configuration" {
14630
16056
  getWhitelistService(): string;
14631
16057
  /**
14632
16058
  * @since 1.50.0
16059
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.setAnimationMode} instead.
14633
16060
  *
14634
16061
  * Sets the current animation mode.
14635
16062
  *
@@ -14646,6 +16073,7 @@ declare module "sap/ui/core/Configuration" {
14646
16073
  ): void;
14647
16074
  /**
14648
16075
  * @since 1.28.6
16076
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setCalendarType} instead.
14649
16077
  *
14650
16078
  * Sets the new calendar type to be used from now on in locale dependent functionality (for example, formatting,
14651
16079
  * translation texts, etc.).
@@ -14661,6 +16089,8 @@ declare module "sap/ui/core/Configuration" {
14661
16089
  ): this;
14662
16090
  /**
14663
16091
  * @since 1.113.0
16092
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setCalendarWeekNumbering }
16093
+ * instead.
14664
16094
  *
14665
16095
  * Sets the calendar week numbering algorithm which is used to determine the first day of the week and the
14666
16096
  * first calendar week of the year, see {@link sap.ui.core.date.CalendarWeekNumbering}.
@@ -14674,6 +16104,8 @@ declare module "sap/ui/core/Configuration" {
14674
16104
  sCalendarWeekNumbering: CalendarWeekNumbering
14675
16105
  ): this;
14676
16106
  /**
16107
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setLanguageTag} instead.
16108
+ *
14677
16109
  * Sets a new format locale to be used from now on for retrieving locale specific formatters. Modifying
14678
16110
  * this setting does not have an impact on the retrieval of translated texts!
14679
16111
  *
@@ -14698,6 +16130,8 @@ declare module "sap/ui/core/Configuration" {
14698
16130
  sFormatLocale: string | null
14699
16131
  ): this;
14700
16132
  /**
16133
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setLanguage} instead.
16134
+ *
14701
16135
  * Sets a new language to be used from now on for language/region dependent functionality (e.g. formatting,
14702
16136
  * data types, translated texts, ...).
14703
16137
  *
@@ -14722,8 +16156,7 @@ declare module "sap/ui/core/Configuration" {
14722
16156
  * - date and number data types that are used in property bindings or composite bindings in existing Elements,
14723
16157
  * Controls, UIAreas or Components
14724
16158
  * - ResourceModels currently assigned to the Core, a UIArea, Component, Element or Control
14725
- * - Elements or Controls that implement the `onlocalizationChanged` hook (note the lowercase 'l' in onlocalizationChanged)
14726
- *
16159
+ * - Elements or Controls that implement the `onLocalizationChanged` hook
14727
16160
  *
14728
16161
  * It furthermore derives the RTL mode from the new language, if no explicit RTL mode has been set. If the
14729
16162
  * RTL mode changes, the following additional actions will be taken:
@@ -14742,6 +16175,8 @@ declare module "sap/ui/core/Configuration" {
14742
16175
  * **Note**: When using config method please take note of and respect the above mentioned restrictions.
14743
16176
  * See:
14744
16177
  * http://scn.sap.com/docs/DOC-14377
16178
+ *
16179
+ * @returns `this` to allow method chaining
14745
16180
  */
14746
16181
  setLanguage(
14747
16182
  /**
@@ -14755,8 +16190,10 @@ declare module "sap/ui/core/Configuration" {
14755
16190
  * `sLanguage` as SAP Logon language.
14756
16191
  */
14757
16192
  sSAPLogonLanguage?: string
14758
- ): void;
16193
+ ): this;
14759
16194
  /**
16195
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setRTL} instead.
16196
+ *
14760
16197
  * Sets the character orientation mode to be used from now on.
14761
16198
  *
14762
16199
  * Can either be set to a concrete value (true meaning right-to-left, false meaning left-to-right) or to
@@ -14777,7 +16214,8 @@ declare module "sap/ui/core/Configuration" {
14777
16214
  bRTL: boolean | null
14778
16215
  ): this;
14779
16216
  /**
14780
- * @since 1.95.0
16217
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.setSecurityTokenHandlers }
16218
+ * instead.
14781
16219
  *
14782
16220
  * Sets the security token handlers for an OData V4 model. See chapter {@link https://ui5.sap.com/#/topic/9613f1f2d88747cab21896f7216afdac/section_STH Security Token Handling}.
14783
16221
  * See:
@@ -14790,6 +16228,8 @@ declare module "sap/ui/core/Configuration" {
14790
16228
  aSecurityTokenHandlers: Array<(p1: URI) => Promise<any>>
14791
16229
  ): void;
14792
16230
  /**
16231
+ * @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.setTheme} instead.
16232
+ *
14793
16233
  * Allows setting the theme name
14794
16234
  *
14795
16235
  * @returns `this` to allow method chaining
@@ -14802,6 +16242,7 @@ declare module "sap/ui/core/Configuration" {
14802
16242
  ): this;
14803
16243
  /**
14804
16244
  * @since 1.99.0
16245
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setTimezone} instead.
14805
16246
  *
14806
16247
  * Sets the timezone such that all date and time based calculations use config timezone.
14807
16248
  *
@@ -14829,6 +16270,7 @@ declare module "sap/ui/core/Configuration" {
14829
16270
 
14830
16271
  /**
14831
16272
  * @since 1.50.0
16273
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/AnimationMode} instead.
14832
16274
  *
14833
16275
  * Enumerable list with available animation modes.
14834
16276
  *
@@ -14855,6 +16297,8 @@ declare module "sap/ui/core/Configuration" {
14855
16297
  none = "undefined",
14856
16298
  }
14857
16299
  /**
16300
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting} instead.
16301
+ *
14858
16302
  * Encapsulates configuration settings that are related to data formatting/parsing.
14859
16303
  *
14860
16304
  * **Note:** When format configuration settings are modified through this class, UI5 only ensures that formatter
@@ -14894,26 +16338,33 @@ declare module "sap/ui/core/Configuration" {
14894
16338
  */
14895
16339
  static getMetadata(): Metadata;
14896
16340
  /**
16341
+ * @since 1.120
16342
+ *
14897
16343
  * Adds custom currencies to the existing entries. E.g. ` { "KWD": {"digits": 3}, "TND" : {"digits": 3 }
14898
16344
  * } `
14899
16345
  * See:
14900
- * #setCustomCurrencies
14901
- *
14902
- * @returns Returns `this` to allow method chaining
16346
+ * {@link module:sap/base/i18n/Formatting.setCustomCurrencies}
14903
16347
  */
14904
16348
  addCustomCurrencies(
14905
16349
  /**
14906
16350
  * adds to the currency map
14907
16351
  */
14908
16352
  mCurrencies: object
14909
- ): this;
16353
+ ): void;
14910
16354
  /**
16355
+ * @since 1.120
16356
+ *
14911
16357
  * Retrieves the custom currencies. E.g. ` { "KWD": {"digits": 3}, "TND" : {"digits": 3} } `
16358
+ * See:
16359
+ * {@link module:sap/base/i18n/Formatting.setCustomCurrencies}
16360
+ * {@link module:sap/base/i18n/Formatting.addCustomCurrencies}
14912
16361
  *
14913
16362
  * @returns the mapping between custom currencies and its digits
14914
16363
  */
14915
16364
  getCustomCurrencies(): object;
14916
16365
  /**
16366
+ * @since 1.120
16367
+ *
14917
16368
  * Returns the currently set date pattern or undefined if no pattern has been defined.
14918
16369
  *
14919
16370
  * @returns The resulting date pattern
@@ -14925,6 +16376,8 @@ declare module "sap/ui/core/Configuration" {
14925
16376
  sStyle: "short" | "medium" | "long" | "full"
14926
16377
  ): string;
14927
16378
  /**
16379
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getLanguageTag} instead.
16380
+ *
14928
16381
  * Returns the locale to be used for formatting.
14929
16382
  *
14930
16383
  * If no such locale has been defined, this method falls back to the language, see {@link sap.ui.core.Configuration#getLanguage Configuration.getLanguage()}.
@@ -14937,44 +16390,19 @@ declare module "sap/ui/core/Configuration" {
14937
16390
  */
14938
16391
  getFormatLocale(): Locale;
14939
16392
  /**
14940
- * Returns the currently set customizing data for Islamic calendar support
16393
+ * @since 1.120
14941
16394
  *
14942
- * @returns Returns an array contains the customizing data. Each element in the array has properties: dateFormat,
14943
- * islamicMonthStart, gregDate. For details, please see {@link #setLegacyDateCalendarCustomizing}
14944
- */
14945
- getLegacyDateCalendarCustomizing(): object[];
14946
- /**
14947
- * Returns the currently set legacy ABAP date format (its id) or undefined if none has been set.
16395
+ * Returns the currently set customizing data for Islamic calendar support.
14948
16396
  *
14949
- * @returns ID of the ABAP date format, if not set or set to `""`, `undefined` will be returned
14950
- */
14951
- getLegacyDateFormat():
14952
- | "1"
14953
- | "2"
14954
- | "3"
14955
- | "4"
14956
- | "5"
14957
- | "6"
14958
- | "7"
14959
- | "8"
14960
- | "9"
14961
- | "A"
14962
- | "B"
14963
- | "C"
14964
- | undefined;
14965
- /**
14966
- * Returns the currently set legacy ABAP number format (its id) or undefined if none has been set.
16397
+ * See: {@link module:sap/base/i18n/Formatting.CustomIslamicCalendarData}
14967
16398
  *
14968
- * @returns ID of the ABAP number format, if not set or set to `""`, `undefined` will be returned
16399
+ * @returns Returns an array that contains the customizing data. Each element in the array has properties:
16400
+ * dateFormat, islamicMonthStart, gregDate. For details, please see {@link #.setCustomIslamicCalendarData}
14969
16401
  */
14970
- getLegacyNumberFormat(): " " | "X" | "Y" | undefined;
16402
+ getLegacyDateCalendarCustomizing(): CustomIslamicCalendarData[] | undefined;
14971
16403
  /**
14972
- * Returns the currently set legacy ABAP time format (its id) or undefined if none has been set.
16404
+ * @since 1.120
14973
16405
  *
14974
- * @returns ID of the ABAP date format, if not set or set to `""`, `undefined` will be returned
14975
- */
14976
- getLegacyTimeFormat(): "0" | "1" | "2" | "3" | "4" | undefined;
14977
- /**
14978
16406
  * Returns the currently set number symbol of the given type or undefined if no symbol has been defined.
14979
16407
  *
14980
16408
  * @returns A non-numerical symbol used as part of a number for the given type, e.g. for locale de_DE:
@@ -14991,6 +16419,8 @@ declare module "sap/ui/core/Configuration" {
14991
16419
  sType: "group" | "decimal" | "plusSign" | "minusSign"
14992
16420
  ): string;
14993
16421
  /**
16422
+ * @since 1.120
16423
+ *
14994
16424
  * Returns the currently set time pattern or undefined if no pattern has been defined.
14995
16425
  *
14996
16426
  * @returns The resulting time pattern
@@ -15002,7 +16432,7 @@ declare module "sap/ui/core/Configuration" {
15002
16432
  sStyle: "short" | "medium" | "long" | "full"
15003
16433
  ): string;
15004
16434
  /**
15005
- * @since 1.75.0
16435
+ * @since 1.120
15006
16436
  *
15007
16437
  * Returns current trailingCurrencyCode configuration for new NumberFormatter instances
15008
16438
  *
@@ -15010,6 +16440,8 @@ declare module "sap/ui/core/Configuration" {
15010
16440
  */
15011
16441
  getTrailingCurrencyCode(): boolean;
15012
16442
  /**
16443
+ * @since 1.120
16444
+ *
15013
16445
  * Sets custom currencies and replaces existing entries.
15014
16446
  *
15015
16447
  * There is a special currency code named "DEFAULT" that is optional. In case it is set it will be used
@@ -15025,15 +16457,15 @@ declare module "sap/ui/core/Configuration" {
15025
16457
  * Note: To unset the custom currencies: call with `undefined` Custom currencies must not only consist of
15026
16458
  * digits but contain at least one non-digit character, e.g. "a", so that the measure part can be distinguished
15027
16459
  * from the number part.
15028
- *
15029
- * @returns Returns `this` to allow method chaining
16460
+ * See:
16461
+ * {@link module:sap/base/i18n/Formatting.addCustomCurrencies}
15030
16462
  */
15031
16463
  setCustomCurrencies(
15032
16464
  /**
15033
16465
  * currency map which is set
15034
16466
  */
15035
16467
  mCurrencies: object
15036
- ): this;
16468
+ ): void;
15037
16469
  /**
15038
16470
  * Defines the preferred format pattern for the given date format style.
15039
16471
  *
@@ -15059,7 +16491,7 @@ declare module "sap/ui/core/Configuration" {
15059
16491
  sPattern: string
15060
16492
  ): this;
15061
16493
  /**
15062
- * @deprecated (since 1.113.0) - Use {@link sap.ui.core.Configuration.FormatSettings#setCalendarWeekNumbering }
16494
+ * @deprecated (since 1.113) - Use {@link sap.ui.core.Configuration.FormatSettings#setCalendarWeekNumbering }
15063
16495
  * instead.
15064
16496
  *
15065
16497
  * Defines the day used as the first day of the week.
@@ -15084,29 +16516,19 @@ declare module "sap/ui/core/Configuration" {
15084
16516
  iValue: int
15085
16517
  ): this;
15086
16518
  /**
16519
+ * @since 1.120
16520
+ *
15087
16521
  * Allows to specify the customizing data for Islamic calendar support
15088
16522
  *
15089
- * @returns Returns `this` to allow method chaining
16523
+ * See: {@link module:sap/base/i18n/Formatting.CustomIslamicCalendarData}
15090
16524
  */
15091
16525
  setLegacyDateCalendarCustomizing(
15092
16526
  /**
15093
- * contains the customizing data for the support of Islamic calendar.
16527
+ * Contains the customizing data for the support of Islamic calendar. One JSON object in the array represents
16528
+ * one row of data from Table TISLCAL
15094
16529
  */
15095
- aMappings: Array<{
15096
- /**
15097
- * The date format
15098
- */
15099
- dateFormat: string;
15100
- /**
15101
- * The Islamic date
15102
- */
15103
- islamicMonthStart: string;
15104
- /**
15105
- * The corresponding Gregorian date
15106
- */
15107
- gregDate: string;
15108
- }>
15109
- ): this;
16530
+ aCustomCalendarData: CustomIslamicCalendarData[]
16531
+ ): void;
15110
16532
  /**
15111
16533
  * Allows to specify one of the legacy ABAP date formats.
15112
16534
  *
@@ -15225,7 +16647,7 @@ declare module "sap/ui/core/Configuration" {
15225
16647
  sPattern: string
15226
16648
  ): this;
15227
16649
  /**
15228
- * @since 1.75.0
16650
+ * @since 1.120
15229
16651
  *
15230
16652
  * Define whether the NumberFormatter shall always place the currency code after the numeric value, with
15231
16653
  * the only exception of right-to-left locales, where the currency code shall be placed before the numeric
@@ -15236,15 +16658,13 @@ declare module "sap/ui/core/Configuration" {
15236
16658
  *
15237
16659
  * Each currency instance ({@link sap.ui.core.format.NumberFormat.getCurrencyInstance}) will be created
15238
16660
  * with this setting unless overwritten on instance level.
15239
- *
15240
- * @returns Returns `this` to allow method chaining
15241
16661
  */
15242
16662
  setTrailingCurrencyCode(
15243
16663
  /**
15244
16664
  * Whether currency codes shall always be placed after the numeric value
15245
16665
  */
15246
16666
  bTrailingCurrencyCode: boolean
15247
- ): this;
16667
+ ): void;
15248
16668
  }
15249
16669
  }
15250
16670
 
@@ -17089,6 +18509,9 @@ declare module "sap/ui/core/Core" {
17089
18509
  */
17090
18510
  getComponent(sId: string): Component;
17091
18511
  /**
18512
+ * @deprecated (since 1.120) - Please see {@link sap.ui.core.Configuration Configuration} for the corrsponding
18513
+ * replacements.
18514
+ *
17092
18515
  * Returns the Configuration of the Core.
17093
18516
  *
17094
18517
  * @returns the Configuration of the current Core.
@@ -18120,6 +19543,7 @@ declare module "sap/ui/core/CustomData" {
18120
19543
  declare module "sap/ui/core/date/CalendarWeekNumbering" {
18121
19544
  /**
18122
19545
  * @since 1.108.0
19546
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/18n/date/CalendarWeekNumbering} instead.
18123
19547
  *
18124
19548
  * The `CalendarWeekNumbering` enum defines how to calculate calendar weeks. Each value defines:
18125
19549
  * - The first day of the week,
@@ -18158,6 +19582,8 @@ declare module "sap/ui/core/DeclarativeSupport" {
18158
19582
 
18159
19583
  /**
18160
19584
  * @since 1.7.0
19585
+ * @deprecated (since 1.120) - Please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed Views }
19586
+ * instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
18161
19587
  *
18162
19588
  * Static class for enabling declarative UI support.
18163
19589
  */
@@ -23988,6 +25414,10 @@ declare module "sap/ui/core/Fragment" {
23988
25414
 
23989
25415
  export interface $FragmentSettings extends $ManagedObjectSettings {
23990
25416
  type?: string | PropertyBindingInfo;
25417
+
25418
+ fragmentName?: string;
25419
+
25420
+ fragmentContent?: any;
23991
25421
  }
23992
25422
  }
23993
25423
 
@@ -26682,7 +28112,7 @@ declare module "sap/ui/core/Lib" {
26682
28112
  * Provides information about a library.
26683
28113
  *
26684
28114
  * This method is intended to be called exactly once while the main module of a library (its `library.js`
26685
- * module) is executing, typically at its begin. The single parameter `oLibInfo` is an info object that
28115
+ * module) is executing, typically at its begin. The single parameter `mSettings` is an info object that
26686
28116
  * describes the content of the library.
26687
28117
  *
26688
28118
  * When the `mSettings` has been processed, a normalized version will be set on the library instance Finally,
@@ -26696,10 +28126,10 @@ declare module "sap/ui/core/Lib" {
26696
28126
  * - If the object contains a list of `interfaces`, they will be registered with the {@link sap.ui.base.DataType }
26697
28127
  * class to make them available as aggregation types in managed objects.
26698
28128
  *
28129
+ * If the object contains a list of `controls` or `elements`, {@link sap.ui.lazyRequire lazy stubs }
28130
+ * will be created for their constructor as well as for their static `extend` and `getMetadata` methods.
26699
28131
  *
26700
- * - If the object contains a list of `controls` or `elements`, {@link sap.ui.lazyRequire lazy stubs }
26701
- * will be created for their constructor as well as for their static `extend` and `getMetadata` methods.
26702
- * **Note:** Future versions might abandon the concept of lazy stubs as it requires synchronous XMLHttpRequests
28132
+ * **Note:** Future versions of UI5 will abandon the concept of lazy stubs as it requires synchronous XMLHttpRequests
26703
28133
  * which have been deprecated (see {@link http://xhr.spec.whatwg.org}). To be on the safe side, productive
26704
28134
  * applications should always require any modules that they directly depend on.
26705
28135
  *
@@ -26711,31 +28141,36 @@ declare module "sap/ui/core/Lib" {
26711
28141
  * is e.g. useful when an application merges the CSS for multiple libraries and already loaded the resulting
26712
28142
  * stylesheet.
26713
28143
  *
28144
+ * If a list of library `dependencies` is specified in the info object, those libraries will be loaded
28145
+ * synchronously if they haven't been loaded yet.
26714
28146
  *
26715
- * - If a list of library `dependencies` is specified in the info object, those libraries will be loaded
26716
- * synchronously.
26717
- * **Note:** Dependencies between libraries don't have to be modeled as AMD dependencies. Only when enums
26718
- * or types from an additional library are used in the coding of the `library.js` module, the library should
26719
- * be additionally listed in the AMD dependencies.
28147
+ * **Note:** Dependencies between libraries have to be modeled consistently in several places:
28148
+ * - Both eager and lazy dependencies have to be modelled in the `.library` file.
28149
+ * - By default, UI5 Tooling generates a `manifest.json` file from the content of the `.library` file.
28150
+ * However, if the `manifest.json` file for the library is not generated but maintained manually, it must
28151
+ * be kept consistent with the `.library` file, especially regarding its listed library dependencies.
28152
+ * - All eager library dependencies must be declared as AMD dependencies of the `library.js` module by
28153
+ * referring to the corresponding `"some/lib/namespace/library"` module of each library dependency.
28154
+ *
28155
+ * - All eager dependencies must be listed in the `dependencies` property of the info object.
28156
+ * - All lazy dependencies **must not** be listed as AMD dependencies or in the `dependencies` property
28157
+ * of the info object.
26720
28158
  *
26721
28159
  * Last but not least, higher layer frameworks might want to include their own metadata for libraries. The
26722
28160
  * property `extensions` might contain such additional metadata. Its structure is not defined by the framework,
26723
28161
  * but it is strongly suggested that each extension only occupies a single property in the `extensions`
26724
28162
  * object and that the name of that property contains some namespace information (e.g. library name that
26725
28163
  * introduces the feature) to avoid conflicts with other extensions. The framework won't touch the content
26726
- * of `extensions` but will make it available in the library info objects returned by {@link #.getInitializedLibraries}.
28164
+ * of `extensions` but will make it available in the library info objects provided by {@link #.load}.
26727
28165
  *
26728
28166
  * Relationship to Descriptor for Libraries (manifest.json):
26729
28167
  *
26730
28168
  * The information contained in `mSettings` is partially redundant to the content of the descriptor for
26731
- * the same library (its `manifest.json` file). Future versions of UI5 might ignore the information provided
26732
- * in `oLibInfo` and might evaluate the descriptor file instead. Library developers therefore should keep
26733
- * the information in both files in sync.
26734
- *
26735
- * When the `manifest.json` is generated from the `.library` file (which is the default for UI5 libraries
26736
- * built with Maven), then the content of the `.library` and `library.js` files must be kept in sync.
28169
+ * the same library (its `manifest.json` file). Future versions of UI5 will ignore the information provided
28170
+ * in `mSettings` and will evaluate the descriptor file instead. Library developers therefore must keep
28171
+ * the information in both files in sync if the `manifest.json` file is maintained manually.
26737
28172
  *
26738
- * @returns As of version 1.101; returns the library namespace, based on the given library name.
28173
+ * @returns Returns the library namespace, based on the given library name.
26739
28174
  */
26740
28175
  static init(
26741
28176
  /**
@@ -26845,13 +28280,11 @@ declare module "sap/ui/core/Lib" {
26845
28280
  * library:
26846
28281
  * ```javascript
26847
28282
  *
26848
- * Lib.load({name: "heavy.charting"})
26849
- * .then(function() {
26850
- * View.create({
26851
- * name: "myapp.views.HeavyChartingView",
26852
- * type: ViewType.XML
26853
- * });
26854
- * });
28283
+ * await Library.load({name: "heavy.charting"});
28284
+ * await View.create({
28285
+ * name: "myapp.views.HeavyChartingView",
28286
+ * type: ViewType.XML
28287
+ * });
26855
28288
  * ```
26856
28289
  *
26857
28290
  *
@@ -27784,9 +29217,28 @@ declare module "sap/ui/core/LocaleData" {
27784
29217
  sCalendarType?: CalendarType
27785
29218
  ): string;
27786
29219
  /**
27787
- * Get locale specific language names.
29220
+ * Gets the locale-specific language name for the given language tag.
27788
29221
  *
27789
- * @returns map of locale specific language names
29222
+ * The languages returned by {@link #getLanguages} from the CLDR raw data do not contain the language names
29223
+ * if they can be derived from the language and the script or the territory. If the map of languages contains
29224
+ * no entry for the given language tag, derive the language name from the used script or region.
29225
+ *
29226
+ * @returns The language name, or `undefined` if the name cannot be determined
29227
+ */
29228
+ getLanguageName(
29229
+ /**
29230
+ * The language tag, for example "en", "en-US", "en_US", "zh-Hant", or "zh_Hant"
29231
+ */
29232
+ sLanguageTag: string
29233
+ ): string | undefined;
29234
+ /**
29235
+ * Gets locale-specific language names, as available in the CLDR raw data.
29236
+ *
29237
+ * To avoid redundancies, with CLDR version 43 only language names are contained which cannot be derived
29238
+ * from the language and the script or the territory. If a language tag is not contained in the map, use
29239
+ * {@link #getLanguageName} to get the derived locale-specific language name for that language tag.
29240
+ *
29241
+ * @returns Maps a language tag to the locale-specific language name
27790
29242
  */
27791
29243
  getLanguages(): Record<string, string>;
27792
29244
  /**
@@ -28169,15 +29621,22 @@ declare module "sap/ui/core/LocaleData" {
28169
29621
  sUnit: string
28170
29622
  ): object;
28171
29623
  /**
28172
- * Get locale specific script names.
29624
+ * Gets locale-specific script names, as available in the CLDR raw data.
29625
+ *
29626
+ * To avoid redundancies, with CLDR version 43 only scripts are contained for which the language-specific
29627
+ * name is different from the script key. If a script key is not contained in the map, use the script key
29628
+ * as script name.
28173
29629
  *
28174
- * @returns map of locale specific script names
29630
+ * @returns Maps a script key to the locale-specific script name
28175
29631
  */
28176
29632
  getScripts(): Record<string, string>;
28177
29633
  /**
28178
- * Get locale specific territory names.
29634
+ * Gets locale-specific territory names, as available in the CLDR raw data.
28179
29635
  *
28180
- * @returns map of locale specific territory names
29636
+ * To avoid redundancies, with CLDR version 43 only territories are contained for which the language-specific
29637
+ * name is different from the territory key.
29638
+ *
29639
+ * @returns Maps a territory key to the locale-specific territory name
28181
29640
  */
28182
29641
  getTerritories(): Record<string, string>;
28183
29642
  /**
@@ -29984,7 +31443,7 @@ declare module "sap/ui/core/mvc/HTMLView" {
29984
31443
  * as syntax does not bring any advantages over XML. The HTML necessary for the `HTMLView` is not re-used
29985
31444
  * for the HTML of the controls, but is fully replaced.
29986
31445
  *
29987
- * Consider using {@link sap.ui.core.mvx.XMLView XMLViews} or "typed views" (view classes written in JavaScript)
31446
+ * Consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed views" (view classes written in JavaScript)
29988
31447
  * instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
29989
31448
  *
29990
31449
  * A view defined/constructed by declarative HTML.
@@ -30116,6 +31575,9 @@ declare module "sap/ui/core/mvc/JSONView" {
30116
31575
  import ElementMetadata from "sap/ui/core/ElementMetadata";
30117
31576
 
30118
31577
  /**
31578
+ * @deprecated (since 1.120) - please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed
31579
+ * views" (view classes written in JavaScript) instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
31580
+ *
30119
31581
  * A View defined using JSON.
30120
31582
  */
30121
31583
  export default class JSONView extends View {
@@ -30496,7 +31958,7 @@ declare module "sap/ui/core/mvc/View" {
30496
31958
 
30497
31959
  import Controller from "sap/ui/core/mvc/Controller";
30498
31960
 
30499
- import { CSSSize } from "sap/ui/core/library";
31961
+ import { CSSSize, URI } from "sap/ui/core/library";
30500
31962
 
30501
31963
  import ElementMetadata from "sap/ui/core/ElementMetadata";
30502
31964
 
@@ -31014,10 +32476,10 @@ declare module "sap/ui/core/mvc/View" {
31014
32476
  /**
31015
32477
  * A method to be implemented by typed `View`s, returning the view UI.
31016
32478
  *
31017
- * While for declarative view types like `XMLView` or `JSONView` the user interface definition is declared
31018
- * in a separate file, `View`s programmatically constructs the UI. This happens in the `createContent` method,
31019
- * which every `View` needs to implement. The view implementation can construct the complete UI in this
31020
- * method, or only return the root control and create the remainder of the UI lazily later on.
32479
+ * While for declarative view types like `XMLView` or `JSONView` (deprecated) the user interface definition
32480
+ * is declared in a separate file, `View`s programmatically constructs the UI. This happens in the `createContent`
32481
+ * method, which every `View` needs to implement. The view implementation can construct the complete UI
32482
+ * in this method, or only return the root control and create the remainder of the UI lazily later on.
31021
32483
  *
31022
32484
  * @returns A control or array of controls representing the view user interface or a Promise resolving with
31023
32485
  * a control or an array of controls.
@@ -31538,6 +33000,70 @@ declare module "sap/ui/core/mvc/View" {
31538
33000
  */
31539
33001
  displayBlock?: boolean | PropertyBindingInfo | `{${string}}`;
31540
33002
 
33003
+ /**
33004
+ * Controller instance to use for this view.
33005
+ */
33006
+ controller?: Controller;
33007
+
33008
+ /**
33009
+ * Name of the controller class to use for this view. If given, it overrides the same information in the
33010
+ * view definition (XML, HTML).
33011
+ */
33012
+ controllerName?: string;
33013
+
33014
+ /**
33015
+ * Preprocessors that the view can use before constructing the view.
33016
+ */
33017
+ preprocessors?: Object;
33018
+
33019
+ /**
33020
+ * (module) Name of a resource bundle that should be loaded for this view
33021
+ */
33022
+ resourceBundleName?: string;
33023
+
33024
+ /**
33025
+ * URL of a resource bundle that should be loaded for this view
33026
+ */
33027
+ resourceBundleUrl?: URI;
33028
+
33029
+ /**
33030
+ * Locale that should be used to load a resource bundle for this view
33031
+ */
33032
+ resourceBundleLocale?: string;
33033
+
33034
+ /**
33035
+ * Model name under which the resource bundle should be stored.
33036
+ */
33037
+ resourceBundleAlias?: string;
33038
+
33039
+ /**
33040
+ * Type of the view
33041
+ */
33042
+ type?: string;
33043
+
33044
+ /**
33045
+ * A view definition
33046
+ */
33047
+ definition?: any;
33048
+
33049
+ /**
33050
+ * Deprecated as of 1.56: Use `definition` instead.
33051
+ */
33052
+ viewContent?: any;
33053
+
33054
+ /**
33055
+ * Additional configuration data that should be given to the view at construction time and which will be
33056
+ * available early, even before model data or other constructor settings are applied.
33057
+ */
33058
+ viewData?: any;
33059
+
33060
+ /**
33061
+ * @since 1.30
33062
+ *
33063
+ * Determines initialization mode of the view
33064
+ */
33065
+ async?: boolean;
33066
+
31541
33067
  /**
31542
33068
  * Child Controls of the view
31543
33069
  */
@@ -31638,6 +33164,9 @@ declare module "sap/ui/core/mvc/ViewType" {
31638
33164
  */
31639
33165
  JS = "JS",
31640
33166
  /**
33167
+ * @deprecated (since 1.120) - please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed
33168
+ * views" (view classes written in JavaScript) instead.
33169
+ *
31641
33170
  * JSON View
31642
33171
  */
31643
33172
  JSON = "JSON",
@@ -31965,7 +33494,23 @@ declare module "sap/ui/core/mvc/XMLView" {
31965
33494
  XML = "xml",
31966
33495
  }
31967
33496
 
31968
- export interface $XMLViewSettings extends $ViewSettings {}
33497
+ export interface $XMLViewSettings extends $ViewSettings {
33498
+ /**
33499
+ * Configuration for the XMLView caching.
33500
+ */
33501
+ cache?: Object;
33502
+
33503
+ /**
33504
+ * legacy-relevant:
33505
+ *
33506
+ * A map containing references to modules loaded via a 'core:require' statement in an XMLView.
33507
+ *
33508
+ * Only used for HTML embedded in an XMLView. This kind of HTML is processed synchronously only and needs
33509
+ * access to 'core:require' modules from outside. Normally 'core:require' modules are NOT passed into nested
33510
+ * Views and Fragments.
33511
+ */
33512
+ requireContext?: Object;
33513
+ }
31969
33514
  }
31970
33515
 
31971
33516
  declare module "sap/ui/core/Popup" {
@@ -35608,7 +37153,7 @@ declare module "sap/ui/core/routing/Router" {
35608
37153
  /**
35609
37154
  * The route data
35610
37155
  */
35611
- arguments: Record<string, string>;
37156
+ arguments: Record<string, string | Record<string, string>>;
35612
37157
  };
35613
37158
 
35614
37159
  export default class Router extends EventProvider {
@@ -37969,6 +39514,8 @@ declare module "sap/ui/core/search/OpenSearchProvider" {
37969
39514
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
37970
39515
 
37971
39516
  /**
39517
+ * @deprecated (since 1.120)
39518
+ *
37972
39519
  * A SearchProvider which uses the OpenSearch protocol (either JSON or XML).
37973
39520
  */
37974
39521
  export default class OpenSearchProvider extends SearchProvider {
@@ -38123,6 +39670,8 @@ declare module "sap/ui/core/search/SearchProvider" {
38123
39670
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
38124
39671
 
38125
39672
  /**
39673
+ * @deprecated (since 1.120)
39674
+ *
38126
39675
  * Abstract base class for all SearchProviders which can be e.g. attached to a SearchField.
38127
39676
  *
38128
39677
  * Do not create instances of this class, but use a concrete subclass instead.
@@ -40896,9 +42445,6 @@ declare module "sap/ui/core/UIArea" {
40896
42445
  * First, all old content controls (if any) will be detached from this UIArea (e.g. their parent relationship
40897
42446
  * to this UIArea will be cut off). Then the parent relationship for the new content control (if not empty)
40898
42447
  * will be set to this UIArea and finally, the UIArea will be marked for re-rendering.
40899
- *
40900
- * The real re-rendering happens whenever the re-rendering is called. Either implicitly at the end of any
40901
- * control event or by calling sap.ui.getCore().applyChanges().
40902
42448
  */
40903
42449
  setRootControl(
40904
42450
  /**
@@ -50723,6 +52269,15 @@ declare module "sap/ui/model/Filter" {
50723
52269
  */
50724
52270
  vValue2?: any
50725
52271
  );
52272
+ /**
52273
+ * @since 1.120.0
52274
+ *
52275
+ * A filter instance that is never fulfilled. When used to filter a list, no back-end request is sent and
52276
+ * only transient entries remain.
52277
+ *
52278
+ * **Note:** Not all model implementations support this filter.
52279
+ */
52280
+ static NONE: Filter;
50726
52281
 
50727
52282
  /**
50728
52283
  * Compares two values
@@ -53011,19 +54566,23 @@ declare module "sap/ui/model/odata/AnnotationHelper" {
53011
54566
  * `"{@i18n>...}"` to the hard-coded model name "@i18n" with arbitrary path are not turned into a fixed
53012
54567
  * text, but kept as a data binding expression; this allows local annotation files to refer to a resource
53013
54568
  * bundle for internationalization. the dynamic "14.5.1 Comparison and Logical Operators": These are
53014
- * turned into expression bindings to perform the operations at run-time. the dynamic "14.5.3 Expression
53015
- * edm:Apply":
54569
+ * turned into expression bindings to perform the operations at run-time. It's strongly recommended to require
54570
+ * the `sap.ui.model.odata.v4.ODataUtils` module in advance to avoid synchronous loading of this module.
54571
+ * the dynamic "14.5.3 Expression edm:Apply":
53016
54572
  * "14.5.3.1.1 Function odata.concat": This is turned into a data binding expression relative to an entity.
53017
54573
  * "14.5.3.1.2 Function odata.fillUriTemplate": This is turned into an expression binding to fill the
53018
- * template at run-time. "14.5.3.1.3 Function odata.uriEncode": This is turned into an expression binding
53019
- * to encode the parameter at run-time. Apply functions may be nested arbitrarily. the dynamic
53020
- * "14.5.6 Expression edm:If": This is turned into an expression binding to be evaluated at run-time. The
53021
- * expression is a conditional expression like `"{=condition ? expression1 : expression2}"`. the dynamic
53022
- * "14.5.10 Expression edm:Null": This is turned into a `null` value. In `odata.concat` it is ignored.
53023
- * the dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression edm:PropertyPath": This is turned into
53024
- * a data binding relative to an entity, including type information and constraints as available from metadata,
53025
- * e.g. `"{path : 'Name', type : 'sap.ui.model.odata.type.String', constraints : {'maxLength':'255'}}"`.
53026
- * Depending on the used type, some additional constraints of this type are set:
54574
+ * template at run-time. It's strongly recommended to require the `sap.ui.thirdparty.URITemplate` module
54575
+ * in advance to avoid synchronous loading of this module. "14.5.3.1.3 Function odata.uriEncode": This
54576
+ * is turned into an expression binding to encode the parameter at run-time. It's strongly recommended to
54577
+ * require the `sap.ui.model.odata.ODataUtils` module in advance to avoid synchronous loading of this module.
54578
+ * Apply functions may be nested arbitrarily. the dynamic "14.5.6 Expression edm:If": This
54579
+ * is turned into an expression binding to be evaluated at run-time. The expression is a conditional expression
54580
+ * like `"{=condition ? expression1 : expression2}"`. the dynamic "14.5.10 Expression edm:Null": This
54581
+ * is turned into a `null` value. In `odata.concat` it is ignored. the dynamic "14.5.12 Expression
54582
+ * edm:Path" and "14.5.13 Expression edm:PropertyPath": This is turned into a data binding relative to an
54583
+ * entity, including type information and constraints as available from metadata, e.g. `"{path : 'Name',
54584
+ * type : 'sap.ui.model.odata.type.String', constraints : {'maxLength':'255'}}"`. Depending on the used
54585
+ * type, some additional constraints of this type are set:
53027
54586
  * Edm.DateTime: The "displayFormat" constraint is set to the value of the "sap:display-format" annotation
53028
54587
  * of the referenced property. Edm.Decimal: The "precision" and "scale" constraints are set to the values
53029
54588
  * of the corresponding attributes of the referenced property. The "minimum", "maximum", "minimumExclusive"
@@ -61562,14 +63121,14 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
61562
63121
  *
61563
63122
  * Get a download URL with the specified format considering the sort/filter/custom parameters.
61564
63123
  *
61565
- * @returns URL which can be used for downloading
63124
+ * @returns URL which can be used for downloading; `null` if this binding uses {@link sap.ui.model.Filter.NONE}
61566
63125
  */
61567
63126
  getDownloadUrl(
61568
63127
  /**
61569
63128
  * Value for the $format Parameter
61570
63129
  */
61571
63130
  sFormat: string
61572
- ): string;
63131
+ ): string | null;
61573
63132
  /**
61574
63133
  * Return the length of the list.
61575
63134
  *
@@ -61642,8 +63201,10 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
61642
63201
  * in its constructor or in its {@link #filter} method; add filters which you want to keep with the "and"
61643
63202
  * conjunction to the resulting filter before calling {@link #filter}.
61644
63203
  *
61645
- * @returns A Promise that resolves with a {@link sap.ui.model.Filter} representing the entries with messages;
61646
- * it resolves with `null` if the binding is not resolved or if there is no message for any entry
63204
+ * @returns A Promise that resolves with an {@link sap.ui.model.Filter} representing the entries with messages,
63205
+ * except in the following cases:
63206
+ * If only transient entries have messages, it resolves with {@link sap.ui.model.Filter.NONE} If
63207
+ * the binding is not resolved or if there is no message for any entry, it resolves with `null`
61647
63208
  */
61648
63209
  requestFilterForMessages(
61649
63210
  /**
@@ -62492,6 +64053,13 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
62492
64053
  * Map of binding parameters
62493
64054
  */
62494
64055
  mParameters?: {
64056
+ /**
64057
+ * Whether the tree binding only requests transition messages from the back end. If messages for entities
64058
+ * of this collection need to be updated, use {@link sap.ui.model.odata.v2.ODataModel#read} on the parent
64059
+ * entity corresponding to the tree binding's context, with the parameter `updateAggregatedMessages` set
64060
+ * to `true`.
64061
+ */
64062
+ transitionMessagesOnly?: boolean;
62495
64063
  /**
62496
64064
  * The mapping between data properties and the hierarchy used to visualize the tree, if not provided by
62497
64065
  * the service's metadata. For the correct metadata annotations, check the "SAP Annotations for OData Version
@@ -62957,9 +64525,11 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
62957
64525
  */
62958
64526
  inactive?: boolean;
62959
64527
  /**
62960
- * An array that specifies a set of properties or the entry
64528
+ * The initial values of the entry, or an array that specifies a list of property names to be initialized
64529
+ * with `undefined`; **Note:** Passing a list of property names is deprecated since 1.120; pass the initial
64530
+ * values as an object instead
62961
64531
  */
62962
- properties?: any[] | object;
64532
+ properties?: object | string[];
62963
64533
  /**
62964
64534
  * Whether to update all bindings after submitting this change operation, see {@link #setRefreshAfterChange};
62965
64535
  * if given, this overrules the model-wide `refreshAfterChange` flag for this operation only; since 1.46
@@ -65491,10 +67061,10 @@ declare module "sap/ui/model/odata/v4/Context" {
65491
67061
  * depending on this context become unresolved, but no attempt is made to restore these bindings in case
65492
67062
  * of reset or failure.
65493
67063
  *
65494
- * Deleting a child node is supported (@experimental as of version 1.118.0) in a recursive hierarchy (see
65495
- * {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}). As a precondition, `oAggregation.expandTo`
65496
- * must be equal to one, and the context must not be {@link #setKeepAlive kept-alive} and hidden (for example
65497
- * due to a filter).
67064
+ * Deleting a node in a recursive hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation})
67065
+ * is supported (@experimental as of version 1.118.0). As a precondition, the context must not be {@link #setKeepAlive kept-alive }
67066
+ * and hidden (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
67067
+ * Such a deletion is not a pending change.
65498
67068
  * See:
65499
67069
  * #hasPendingChanges
65500
67070
  * #resetChanges
@@ -65619,6 +67189,17 @@ declare module "sap/ui/model/odata/v4/Context" {
65619
67189
  */
65620
67190
  sPath?: string
65621
67191
  ): any;
67192
+ /**
67193
+ * @experimental (since 1.120.0)
67194
+ *
67195
+ * Returns the parent node (in case of a recursive hierarchy, see {@link #setAggregation}, where `oAggregation.expandTo`
67196
+ * must be equal to one).
67197
+ * See:
67198
+ * #requestParent
67199
+ *
67200
+ * @returns The parent node, or `null` if this node is a root node and thus has no parent
67201
+ */
67202
+ getParent(): Context | null;
65622
67203
  /**
65623
67204
  * @since 1.39.0
65624
67205
  *
@@ -65665,6 +67246,20 @@ declare module "sap/ui/model/odata/v4/Context" {
65665
67246
  * @returns Whether there are pending changes
65666
67247
  */
65667
67248
  hasPendingChanges(): boolean;
67249
+ /**
67250
+ * @since 1.120.0
67251
+ *
67252
+ * Tells whether this node is an ancestor of (or the same as) the given node (in case of a recursive hierarchy,
67253
+ * see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
67254
+ *
67255
+ * @returns Whether the assumed ancestor relation holds
67256
+ */
67257
+ isAncestorOf(
67258
+ /**
67259
+ * Some node which may be a descendant
67260
+ */
67261
+ oNode: Context
67262
+ ): boolean;
65668
67263
  /**
65669
67264
  * @since 1.105.0
65670
67265
  *
@@ -65747,8 +67342,8 @@ declare module "sap/ui/model/odata/v4/Context" {
65747
67342
  /**
65748
67343
  * @experimental (since 1.119.0)
65749
67344
  *
65750
- * Moves this node to the given parent (in case of a recursive hierarchy, see {@link #setAggregation}, where
65751
- * `oAggregation.expandTo` must be one). No other {@link sap.ui.model.odata.v4.ODataListBinding#create creation},
67345
+ * Moves this node to the given parent (in case of a recursive hierarchy, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation},
67346
+ * where `oAggregation.expandTo` must be one). No other {@link sap.ui.model.odata.v4.ODataListBinding#create creation},
65752
67347
  * {@link #delete deletion}, or move must be pending, and no other modification (including collapse of some
65753
67348
  * ancestor node) must happen while this move is pending!
65754
67349
  *
@@ -65845,6 +67440,20 @@ declare module "sap/ui/model/odata/v4/Context" {
65845
67440
  */
65846
67441
  sPath?: string
65847
67442
  ): Promise<any>;
67443
+ /**
67444
+ * @experimental (since 1.120.0)
67445
+ *
67446
+ * Requests the parent node (in case of a recursive hierarchy, see {@link #setAggregation}, where `oAggregation.expandTo`
67447
+ * must be equal to one).
67448
+ * See:
67449
+ * #getParent
67450
+ *
67451
+ * @returns A promise which:
67452
+ * - Resolves if successful with either the parent node or `null` for a root node that has no parent
67453
+ *
67454
+ * - Rejects with an `Error` instance otherwise
67455
+ */
67456
+ requestParent(): Promise<Context | null>;
65848
67457
  /**
65849
67458
  * @since 1.39.0
65850
67459
  *
@@ -66934,11 +68543,12 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
66934
68543
  *
66935
68544
  * Creating a new child beneath an existing and visible parent node (which must either be a leaf or expanded,
66936
68545
  * but not collapsed) is supported (@experimental as of version 1.117.0) in case of a recursive hierarchy
66937
- * (see {@link #setAggregation}). The parent node must be identified via a {@link sap.ui.model.odata.v4.Context }
66938
- * instance given as `oInitialData["@$ui5.node.parent"]`. `oAggregation.expandTo` (see {@link #setAggregation})
66939
- * must be one, `bSkipRefresh` must be set, but both `bAtEnd` and `bInactive` must not be set. No other
66940
- * creation or {@link sap.ui.model.odata.v4.Context#move move} must be pending, and no other modification
66941
- * (including collapse of some ancestor node) must happen while this creation is pending!
68546
+ * (see {@link #setAggregation}). The parent node must be identified via an {@link sap.ui.model.odata.v4.Context }
68547
+ * instance given as `oInitialData["@$ui5.node.parent"]` (which is immediately removed from the new child's
68548
+ * data). It can be `null` or absent when creating a new root node (@experimental as of version 1.120.0).
68549
+ * `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 }
68550
+ * must be pending, and no other modification (including collapse of some ancestor node) must happen while
68551
+ * this creation is pending!
66942
68552
  *
66943
68553
  * @returns The context object for the created entity; its method {@link sap.ui.model.odata.v4.Context#created }
66944
68554
  * returns a promise that is resolved when the creation is finished
@@ -67601,7 +69211,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
67601
69211
  * The number (as a positive integer) of different levels initially available without calling {@link sap.ui.model.odata.v4.Context#expand }
67602
69212
  * (@experimental as of version 1.105.0; available for read-only hierarchies since 1.117.0), supported only
67603
69213
  * if a `hierarchyQualifier` is given. Root nodes are on the first level. By default, only root nodes are
67604
- * available; they are not yet expanded.
69214
+ * available; they are not yet expanded. Since 1.120.0, `Number.MAX_SAFE_INTEGER` can be used to expand
69215
+ * all levels.
67605
69216
  */
67606
69217
  expandTo?: number;
67607
69218
  /**
@@ -68850,7 +70461,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
68850
70461
  updateGroupId?: string;
68851
70462
  /**
68852
70463
  * Whether the XMLHttpRequest is called with `withCredentials`, so that user credentials are included in
68853
- * cross-origin requests by the browser (@experimental as of Version 1.117.0)
70464
+ * cross-origin requests by the browser (since 1.120.0)
68854
70465
  */
68855
70466
  withCredentials?: boolean;
68856
70467
  }
@@ -82365,8 +83976,12 @@ declare namespace sap {
82365
83976
 
82366
83977
  "sap/base/assert": undefined;
82367
83978
 
83979
+ "sap/base/config": undefined;
83980
+
82368
83981
  "sap/base/Event": undefined;
82369
83982
 
83983
+ "sap/base/Eventing": undefined;
83984
+
82370
83985
  "sap/base/i18n/date/CalendarType": undefined;
82371
83986
 
82372
83987
  "sap/base/i18n/date/CalendarWeekNumbering": undefined;
@@ -82471,6 +84086,8 @@ declare namespace sap {
82471
84086
 
82472
84087
  "sap/ui/base/DataType": undefined;
82473
84088
 
84089
+ "sap/ui/base/DesignTime": undefined;
84090
+
82474
84091
  "sap/ui/base/Event": undefined;
82475
84092
 
82476
84093
  "sap/ui/base/EventProvider": undefined;
@@ -82665,6 +84282,8 @@ declare namespace sap {
82665
84282
 
82666
84283
  "sap/ui/core/Renderer": undefined;
82667
84284
 
84285
+ "sap/ui/core/Rendering": undefined;
84286
+
82668
84287
  "sap/ui/core/RenderManager": undefined;
82669
84288
 
82670
84289
  "sap/ui/core/ResizeHandler": undefined;
@@ -82709,6 +84328,8 @@ declare namespace sap {
82709
84328
 
82710
84329
  "sap/ui/core/support/usage/EventBroadcaster": undefined;
82711
84330
 
84331
+ "sap/ui/core/Supportability": undefined;
84332
+
82712
84333
  "sap/ui/core/syncStyleClass": undefined;
82713
84334
 
82714
84335
  "sap/ui/core/Theming": undefined;
@@ -83115,6 +84736,8 @@ declare namespace sap {
83115
84736
 
83116
84737
  "sap/ui/security/FrameOptions": undefined;
83117
84738
 
84739
+ "sap/ui/security/Security": undefined;
84740
+
83118
84741
  "sap/ui/test/actions/Action": undefined;
83119
84742
 
83120
84743
  "sap/ui/test/actions/Drag": undefined;
@@ -83198,6 +84821,8 @@ declare namespace sap {
83198
84821
  "sap/ui/util/XMLHelper": undefined;
83199
84822
 
83200
84823
  "sap/ui/VersionInfo": undefined;
84824
+
84825
+ "ui5loader-autoconfig": undefined;
83201
84826
  }
83202
84827
 
83203
84828
  type ClassInfo<T, C> = T & Partial<C> & ThisType<T & C>;