@openui5/ts-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
@@ -2552,6 +3562,37 @@ declare module "sap/ui/util/XMLHelper" {
2552
3562
  export default XMLHelper;
2553
3563
  }
2554
3564
 
3565
+ declare module "sap/ui/core/AnimationMode" {
3566
+ /**
3567
+ * @since 1.120
3568
+ *
3569
+ * Enumerable list with available animation modes.
3570
+ *
3571
+ * This enumerable is used to validate the animation mode. Animation modes allow to specify different animation
3572
+ * scenarios or levels. The implementation of the Control (JavaScript or CSS) has to be done differently
3573
+ * for each animation mode.
3574
+ */
3575
+ enum AnimationMode {
3576
+ /**
3577
+ * `basic` can be used for a reduced, more light-weight set of animations.
3578
+ */
3579
+ basic = "basic",
3580
+ /**
3581
+ * `full` represents a mode with unrestricted animation capabilities.
3582
+ */
3583
+ full = "full",
3584
+ /**
3585
+ * `minimal` includes animations of fundamental functionality.
3586
+ */
3587
+ minimal = "minimal",
3588
+ /**
3589
+ * `none` deactivates the animation completely.
3590
+ */
3591
+ none = "none",
3592
+ }
3593
+ export default AnimationMode;
3594
+ }
3595
+
2555
3596
  declare module "sap/ui/core/ComponentSupport" {
2556
3597
  /**
2557
3598
  * @since 1.58.0
@@ -2637,6 +3678,52 @@ declare module "sap/ui/core/ComponentSupport" {
2637
3678
  export default ComponentSupport;
2638
3679
  }
2639
3680
 
3681
+ declare module "sap/ui/core/ControlBehavior" {
3682
+ import AnimationMode from "sap/ui/core/AnimationMode";
3683
+
3684
+ /**
3685
+ * @since 1.120
3686
+ *
3687
+ * Provides control behavior relevant configuration options
3688
+ */
3689
+ interface ControlBehavior {
3690
+ /**
3691
+ * @since 1.120
3692
+ *
3693
+ * Returns the current animation mode.
3694
+ *
3695
+ * @returns The current animationMode
3696
+ */
3697
+ getAnimationMode(): AnimationMode | keyof typeof AnimationMode;
3698
+ /**
3699
+ * @since 1.120
3700
+ *
3701
+ * Returns whether the accessibility mode is enabled or not.
3702
+ *
3703
+ * @returns whether the accessibility mode is enabled or not
3704
+ */
3705
+ isAccessibilityEnabled(): boolean;
3706
+ /**
3707
+ * @since 1.120
3708
+ *
3709
+ * Sets the current animation mode.
3710
+ *
3711
+ * Expects an animation mode as string and validates it. If a wrong animation mode was set, an error is
3712
+ * thrown. If the mode is valid it is set, then the attributes `data-sap-ui-animation` and `data-sap-ui-animation-mode`
3713
+ * of the HTML document root element are also updated. If the `animationMode` is `AnimationMode.none` the
3714
+ * old `animation` property is set to `false`, otherwise it is set to `true`.
3715
+ */
3716
+ setAnimationMode(
3717
+ /**
3718
+ * A valid animation mode
3719
+ */
3720
+ sAnimationMode: AnimationMode | keyof typeof AnimationMode
3721
+ ): void;
3722
+ }
3723
+ const ControlBehavior: ControlBehavior;
3724
+ export default ControlBehavior;
3725
+ }
3726
+
2640
3727
  declare module "sap/ui/core/date/CalendarUtils" {
2641
3728
  /**
2642
3729
  * @since 1.108.0
@@ -3554,6 +4641,8 @@ declare module "sap/ui/core/Theming" {
3554
4641
  */
3555
4642
  interface Theming {
3556
4643
  /**
4644
+ * @since 1.118.0
4645
+ *
3557
4646
  * Attaches event handler `fnFunction` to the {@link #event:applied applied} event.
3558
4647
  *
3559
4648
  * The given handler is called when the the applied event is fired. If the theme is already applied the
@@ -3564,9 +4653,11 @@ declare module "sap/ui/core/Theming" {
3564
4653
  /**
3565
4654
  * The function to be called, when the event occurs
3566
4655
  */
3567
- fnFunction: Function
4656
+ fnFunction: (p1: Theming$AppliedEvent) => void
3568
4657
  ): void;
3569
4658
  /**
4659
+ * @since 1.118.0
4660
+ *
3570
4661
  * Detaches event handler `fnFunction` from the {@link #event:applied applied} event
3571
4662
  *
3572
4663
  * The passed function must match the one used for event registration.
@@ -3575,32 +4666,48 @@ declare module "sap/ui/core/Theming" {
3575
4666
  /**
3576
4667
  * The function to be called, when the event occurs
3577
4668
  */
3578
- fnFunction: Function
4669
+ fnFunction: (p1: Theming$AppliedEvent) => void
3579
4670
  ): void;
3580
4671
  /**
4672
+ * @since 1.118
4673
+ *
3581
4674
  * Returns the theme name
3582
4675
  *
3583
4676
  * @returns the theme name
3584
4677
  */
3585
4678
  getTheme(): string;
3586
4679
  /**
4680
+ * @since 1.118.0
4681
+ *
3587
4682
  * Notify content density changes
3588
4683
  */
3589
4684
  notifyContentDensityChanged(): void;
3590
4685
  /**
3591
- * Allows setting the theme name
4686
+ * @since 1.118
3592
4687
  *
3593
- * @returns `this` to allow method chaining
4688
+ * Allows setting the theme name
3594
4689
  */
3595
4690
  setTheme(
3596
4691
  /**
3597
4692
  * the theme name
3598
4693
  */
3599
4694
  sTheme: string
3600
- ): this;
4695
+ ): void;
3601
4696
  }
3602
4697
  const Theming: Theming;
3603
4698
  export default Theming;
4699
+
4700
+ /**
4701
+ * @since 1.118.0
4702
+ *
4703
+ * The theme applied Event.
4704
+ */
4705
+ export type Theming$AppliedEvent = {
4706
+ /**
4707
+ * The newly set language.
4708
+ */
4709
+ theme: string;
4710
+ };
3604
4711
  }
3605
4712
 
3606
4713
  declare module "sap/ui/dom/containsOrEquals" {
@@ -4163,14 +5270,15 @@ declare module "sap/ui/model/FilterProcessor" {
4163
5270
  * Groups filters according to their path and combines filters on the same path using "OR" and filters on
4164
5271
  * different paths using "AND", all multi-filters contained are ANDed.
4165
5272
  *
4166
- * @returns Single Filter containing all filters of the array combined or undefined
5273
+ * @returns A single filter containing all filters of the array combined or `undefined` if no filters are
5274
+ * given
4167
5275
  */
4168
5276
  groupFilters(
4169
5277
  /**
4170
- * the filters to be grouped
5278
+ * The filters to be grouped
4171
5279
  */
4172
- aFilters: sap.ui.model.Filter[]
4173
- ): sap.ui.model.Filter;
5280
+ aFilters?: sap.ui.model.Filter[]
5281
+ ): sap.ui.model.Filter | undefined;
4174
5282
  }
4175
5283
  const FilterProcessor: FilterProcessor;
4176
5284
  export default FilterProcessor;
@@ -4689,6 +5797,57 @@ declare module "sap/ui/performance/trace/Interaction" {
4689
5797
  };
4690
5798
  }
4691
5799
 
5800
+ declare module "sap/ui/security/Security" {
5801
+ /**
5802
+ * @since 1.120.0
5803
+ *
5804
+ * Provides security related API
5805
+ */
5806
+ interface Security {
5807
+ /**
5808
+ * @since 1.120.0
5809
+ *
5810
+ * URL of the allowlist service.
5811
+ *
5812
+ * @returns allowlist service URL
5813
+ */
5814
+ getAllowlistService(): string;
5815
+ /**
5816
+ * @since 1.120.0
5817
+ *
5818
+ * frameOptions mode (allow/deny/trusted).
5819
+ *
5820
+ * @returns frameOptions mode
5821
+ */
5822
+ getFrameOptions(): string;
5823
+ /**
5824
+ * @since 1.120.0
5825
+ *
5826
+ * Returns the security token handlers of an OData V4 model.
5827
+ * See:
5828
+ * #setSecurityTokenHandlers
5829
+ *
5830
+ * @returns the security token handlers (an empty array if there are none)
5831
+ */
5832
+ getSecurityTokenHandlers(): Array<(p1: sap.ui.core.URI) => Promise<any>>;
5833
+ /**
5834
+ * @since 1.120.0
5835
+ *
5836
+ * Sets the security token handlers for an OData V4 model. See chapter {@link https://ui5.sap.com/#/topic/9613f1f2d88747cab21896f7216afdac/section_STH Security Token Handling}.
5837
+ * See:
5838
+ * #getSecurityTokenHandlers
5839
+ */
5840
+ setSecurityTokenHandlers(
5841
+ /**
5842
+ * The security token handlers
5843
+ */
5844
+ aSecurityTokenHandlers: Array<(p1: sap.ui.core.URI) => Promise<any>>
5845
+ ): void;
5846
+ }
5847
+ const Security: Security;
5848
+ export default Security;
5849
+ }
5850
+
4692
5851
  declare module "sap/ui/test/opaQunit" {
4693
5852
  /**
4694
5853
  * QUnit test adapter for OPA: add a test to be executed by QUnit Has the same signature as QUnit.test (QUnit
@@ -7913,6 +9072,11 @@ declare namespace sap {
7913
9072
  * (in dot notation, e.g. 'sap.m.Button').
7914
9073
  */
7915
9074
  type?: string;
9075
+ /**
9076
+ * The default class for the aggregation. If aggregation content is created from a plain object and no explicit
9077
+ * 'Type' is given (capital 'T'), the default class will be instantiated.
9078
+ */
9079
+ defaultClass?: Function;
7916
9080
  /**
7917
9081
  * Whether the aggregation is a 0..1 (false) or a 0..n aggregation (true), defaults to true
7918
9082
  */
@@ -8667,6 +9831,38 @@ declare namespace sap {
8667
9831
  }
8668
9832
 
8669
9833
  interface $ManagedObjectSettings {
9834
+ /**
9835
+ * Unique ID of this instance. If not given, a so called autoID will be generated by the framework. AutoIDs
9836
+ * use a unique prefix that must not be used for Ids that the application (or other code) creates. It can
9837
+ * be configured option 'autoIDPrefix', see {@link sap.ui.core.Configuration}.
9838
+ */
9839
+ id?: sap.ui.core.ID;
9840
+
9841
+ /**
9842
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9843
+ * name. For the default model, String(undefined) is expected.
9844
+ */
9845
+ models?: object;
9846
+
9847
+ /**
9848
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9849
+ * name. For the default model, String(undefined) is expected.
9850
+ */
9851
+ bindingContexts?: object;
9852
+
9853
+ /**
9854
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9855
+ * name. For the default model, String(undefined) is expected.
9856
+ */
9857
+ objectBindings?: object;
9858
+
9859
+ /**
9860
+ * A map of model instances to which the object should be attached. The models are keyed by their model
9861
+ * name. For the default model, String(undefined) is expected. The special setting is only for internal
9862
+ * use.
9863
+ */
9864
+ metadataContexts?: object;
9865
+
8670
9866
  /**
8671
9867
  * Fired after a new value for a bound property has been propagated to the model. Only fired, when the binding
8672
9868
  * uses a data type.
@@ -8944,6 +10140,33 @@ declare namespace sap {
8944
10140
  */
8945
10141
  sTypeName: string
8946
10142
  ): sap.ui.base.DataType | undefined;
10143
+ /**
10144
+ * @since 1.120.0
10145
+ *
10146
+ * Registers an enum under the given name. With version 2.0, registering an enum becomes mandatory when
10147
+ * said enum is to be used in properties of a {@link sap.ui.base.ManagedObject ManagedObject} subclass.
10148
+ *
10149
+ * Example:
10150
+ *
10151
+ * ```javascript
10152
+ *
10153
+ * DataType.registerEnum("my.enums.Sample", {
10154
+ * "A": "A",
10155
+ * "B": "B",
10156
+ * ...
10157
+ * });
10158
+ * ```
10159
+ */
10160
+ static registerEnum(
10161
+ /**
10162
+ * the type name in dot syntax, e.g. sap.ui.my.EnumType
10163
+ */
10164
+ sTypeName: string,
10165
+ /**
10166
+ * the enum content
10167
+ */
10168
+ mContent: object
10169
+ ): void;
8947
10170
  /**
8948
10171
  * The base type of this type or undefined if this is a primitive type.
8949
10172
  *
@@ -9583,9 +10806,11 @@ declare namespace sap {
9583
10806
  * The possible values for a setting depend on its kind:
9584
10807
  * - for simple properties, the value has to match the documented type of the property (no type conversion
9585
10808
  * occurs)
9586
- * - for 0..1 aggregations, the value has to be an instance of the aggregated type
9587
- * - for 0..n aggregations, the value has to be an array of instances of the aggregated type or a single
9588
- * instance
10809
+ * - for 0..1 aggregations, the value has to be an instance of the aggregated type, or an object literal
10810
+ * from which, the default class of the aggregation (or the corresponding aggregation type as fallback)
10811
+ * will be instantiated.
10812
+ * - for 0..n aggregations, the value has to be an array of instances of the aggregated type, a single
10813
+ * instance or an object literal from which the default class will be instantiated.
9589
10814
  * - for 0..1 associations, an instance of the associated type or an id (string) is accepted
9590
10815
  * - for 0..n associations, an array of instances of the associated type or of IDs is accepted
9591
10816
  * - for events, either a function (event handler) is accepted or an array of length 2 where the first
@@ -9632,6 +10857,12 @@ declare namespace sap {
9632
10857
  * Note that when setting string values, any curly braces in those values need to be escaped, so they are
9633
10858
  * not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
9634
10859
  *
10860
+ * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
10861
+ * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
10862
+ * of the aggregation. Additionally, as of version 1.120, a ManagedObject subclass can specify a `defaultClass`,
10863
+ * e.g. for cases where only a single class is valid. Please refer to the {@link sap.ui.base.ManagedObject.MetadataOptions.Aggregation Aggregation }
10864
+ * documentation for more details on the `defaultClass`.
10865
+ *
9635
10866
  * Besides the settings documented below, ManagedObject itself supports the following special settings:
9636
10867
  *
9637
10868
  * - `id : sap.ui.core.ID` an ID for the new instance. Some subclasses (Element, Component) require
@@ -9697,9 +10928,11 @@ declare namespace sap {
9697
10928
  * The possible values for a setting depend on its kind:
9698
10929
  * - for simple properties, the value has to match the documented type of the property (no type conversion
9699
10930
  * occurs)
9700
- * - for 0..1 aggregations, the value has to be an instance of the aggregated type
9701
- * - for 0..n aggregations, the value has to be an array of instances of the aggregated type or a single
9702
- * instance
10931
+ * - for 0..1 aggregations, the value has to be an instance of the aggregated type, or an object literal
10932
+ * from which, the default class of the aggregation (or the corresponding aggregation type as fallback)
10933
+ * will be instantiated.
10934
+ * - for 0..n aggregations, the value has to be an array of instances of the aggregated type, a single
10935
+ * instance or an object literal from which the default class will be instantiated.
9703
10936
  * - for 0..1 associations, an instance of the associated type or an id (string) is accepted
9704
10937
  * - for 0..n associations, an array of instances of the associated type or of IDs is accepted
9705
10938
  * - for events, either a function (event handler) is accepted or an array of length 2 where the first
@@ -9746,6 +10979,12 @@ declare namespace sap {
9746
10979
  * Note that when setting string values, any curly braces in those values need to be escaped, so they are
9747
10980
  * not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
9748
10981
  *
10982
+ * **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
10983
+ * case the object's type is given via the property 'Type' as a string, or is derived via the defined type
10984
+ * of the aggregation. Additionally, as of version 1.120, a ManagedObject subclass can specify a `defaultClass`,
10985
+ * e.g. for cases where only a single class is valid. Please refer to the {@link sap.ui.base.ManagedObject.MetadataOptions.Aggregation Aggregation }
10986
+ * documentation for more details on the `defaultClass`.
10987
+ *
9749
10988
  * Besides the settings documented below, ManagedObject itself supports the following special settings:
9750
10989
  *
9751
10990
  * - `id : sap.ui.core.ID` an ID for the new instance. Some subclasses (Element, Component) require
@@ -12274,12 +13513,12 @@ declare namespace sap {
12274
13513
  */
12275
13514
  getName(): string;
12276
13515
  /**
12277
- * Returns the metadata object of the base class of the described class or null if the class has no (documented)
12278
- * base class.
13516
+ * Returns the metadata object of the base class of the described class or undefined if the class has no
13517
+ * (documented) base class.
12279
13518
  *
12280
13519
  * @returns metadata of the base class
12281
13520
  */
12282
- getParent(): sap.ui.base.Metadata;
13521
+ getParent(): sap.ui.base.Metadata | undefined;
12283
13522
  /**
12284
13523
  * @deprecated (since 1.58) - this method should not be used for productive code. The accuracy of the returned
12285
13524
  * information highly depends on the concrete class and is not actively monitored. There might be more public
@@ -12458,6 +13697,7 @@ declare namespace sap {
12458
13697
  ): Function;
12459
13698
  /**
12460
13699
  * @since 1.56
13700
+ * @deprecated (since 1.120) - please use {@link sap.ui.base.Object.isObjectA}.
12461
13701
  *
12462
13702
  * Checks whether the given object is an instance of the named type. This function is a short-hand convenience
12463
13703
  * for {@link sap.ui.base.Object#isA}.
@@ -12476,6 +13716,26 @@ declare namespace sap {
12476
13716
  */
12477
13717
  vTypeName: string | string[]
12478
13718
  ): oObject is T;
13719
+ /**
13720
+ * @since 1.120
13721
+ *
13722
+ * Checks whether the given object is an instance of the named type. This function is a short-hand convenience
13723
+ * for {@link sap.ui.base.Object#isA}.
13724
+ *
13725
+ * Please see the API documentation of {@link sap.ui.base.Object#isA} for more details.
13726
+ *
13727
+ * @returns Whether the given object is an instance of the given type or of any of the given types
13728
+ */
13729
+ static isObjectA(
13730
+ /**
13731
+ * Object which will be checked whether it is an instance of the given type
13732
+ */
13733
+ oObject: any,
13734
+ /**
13735
+ * Type or types to check for
13736
+ */
13737
+ vTypeName: string | string[]
13738
+ ): boolean;
12479
13739
  /**
12480
13740
  * Destructor method for objects.
12481
13741
  */
@@ -17599,6 +18859,70 @@ declare namespace sap {
17599
18859
  | sap.ui.base.ManagedObject.PropertyBindingInfo
17600
18860
  | `{${string}}`;
17601
18861
 
18862
+ /**
18863
+ * Controller instance to use for this view.
18864
+ */
18865
+ controller?: sap.ui.core.mvc.Controller;
18866
+
18867
+ /**
18868
+ * Name of the controller class to use for this view. If given, it overrides the same information in the
18869
+ * view definition (XML, HTML).
18870
+ */
18871
+ controllerName?: string;
18872
+
18873
+ /**
18874
+ * Preprocessors that the view can use before constructing the view.
18875
+ */
18876
+ preprocessors?: Object;
18877
+
18878
+ /**
18879
+ * (module) Name of a resource bundle that should be loaded for this view
18880
+ */
18881
+ resourceBundleName?: string;
18882
+
18883
+ /**
18884
+ * URL of a resource bundle that should be loaded for this view
18885
+ */
18886
+ resourceBundleUrl?: sap.ui.core.URI;
18887
+
18888
+ /**
18889
+ * Locale that should be used to load a resource bundle for this view
18890
+ */
18891
+ resourceBundleLocale?: string;
18892
+
18893
+ /**
18894
+ * Model name under which the resource bundle should be stored.
18895
+ */
18896
+ resourceBundleAlias?: string;
18897
+
18898
+ /**
18899
+ * Type of the view
18900
+ */
18901
+ type?: string;
18902
+
18903
+ /**
18904
+ * A view definition
18905
+ */
18906
+ definition?: any;
18907
+
18908
+ /**
18909
+ * Deprecated as of 1.56: Use `definition` instead.
18910
+ */
18911
+ viewContent?: any;
18912
+
18913
+ /**
18914
+ * Additional configuration data that should be given to the view at construction time and which will be
18915
+ * available early, even before model data or other constructor settings are applied.
18916
+ */
18917
+ viewData?: any;
18918
+
18919
+ /**
18920
+ * @since 1.30
18921
+ *
18922
+ * Determines initialization mode of the view
18923
+ */
18924
+ async?: boolean;
18925
+
17602
18926
  /**
17603
18927
  * Child Controls of the view
17604
18928
  */
@@ -17629,7 +18953,23 @@ declare namespace sap {
17629
18953
  beforeRendering?: (oEvent: sap.ui.base.Event) => void;
17630
18954
  }
17631
18955
 
17632
- interface $XMLViewSettings extends sap.ui.core.mvc.$ViewSettings {}
18956
+ interface $XMLViewSettings extends sap.ui.core.mvc.$ViewSettings {
18957
+ /**
18958
+ * Configuration for the XMLView caching.
18959
+ */
18960
+ cache?: Object;
18961
+
18962
+ /**
18963
+ * legacy-relevant:
18964
+ *
18965
+ * A map containing references to modules loaded via a 'core:require' statement in an XMLView.
18966
+ *
18967
+ * Only used for HTML embedded in an XMLView. This kind of HTML is processed synchronously only and needs
18968
+ * access to 'core:require' modules from outside. Normally 'core:require' modules are NOT passed into nested
18969
+ * Views and Fragments.
18970
+ */
18971
+ requireContext?: Object;
18972
+ }
17633
18973
 
17634
18974
  interface View$AfterInitEventParameters {}
17635
18975
 
@@ -18043,7 +19383,7 @@ declare namespace sap {
18043
19383
  * as syntax does not bring any advantages over XML. The HTML necessary for the `HTMLView` is not re-used
18044
19384
  * for the HTML of the controls, but is fully replaced.
18045
19385
  *
18046
- * Consider using {@link sap.ui.core.mvx.XMLView XMLViews} or "typed views" (view classes written in JavaScript)
19386
+ * Consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed views" (view classes written in JavaScript)
18047
19387
  * instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
18048
19388
  *
18049
19389
  * A view defined/constructed by declarative HTML.
@@ -18164,6 +19504,9 @@ declare namespace sap {
18164
19504
  static getMetadata(): sap.ui.core.ElementMetadata;
18165
19505
  }
18166
19506
  /**
19507
+ * @deprecated (since 1.120) - please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed
19508
+ * views" (view classes written in JavaScript) instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
19509
+ *
18167
19510
  * A View defined using JSON.
18168
19511
  */
18169
19512
  class JSONView extends sap.ui.core.mvc.View {
@@ -18995,10 +20338,10 @@ declare namespace sap {
18995
20338
  /**
18996
20339
  * A method to be implemented by typed `View`s, returning the view UI.
18997
20340
  *
18998
- * While for declarative view types like `XMLView` or `JSONView` the user interface definition is declared
18999
- * in a separate file, `View`s programmatically constructs the UI. This happens in the `createContent` method,
19000
- * which every `View` needs to implement. The view implementation can construct the complete UI in this
19001
- * method, or only return the root control and create the remainder of the UI lazily later on.
20341
+ * While for declarative view types like `XMLView` or `JSONView` (deprecated) the user interface definition
20342
+ * is declared in a separate file, `View`s programmatically constructs the UI. This happens in the `createContent`
20343
+ * method, which every `View` needs to implement. The view implementation can construct the complete UI
20344
+ * in this method, or only return the root control and create the remainder of the UI lazily later on.
19002
20345
  *
19003
20346
  * @returns A control or array of controls representing the view user interface or a Promise resolving with
19004
20347
  * a control or an array of controls.
@@ -19744,6 +21087,9 @@ declare namespace sap {
19744
21087
  */
19745
21088
  JS = "JS",
19746
21089
  /**
21090
+ * @deprecated (since 1.120) - please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or "typed
21091
+ * views" (view classes written in JavaScript) instead.
21092
+ *
19747
21093
  * JSON View
19748
21094
  */
19749
21095
  JSON = "JSON",
@@ -19780,85 +21126,6 @@ declare namespace sap {
19780
21126
  >;
19781
21127
  }
19782
21128
 
19783
- namespace theming {
19784
- namespace Parameters {
19785
- /**
19786
- * Theming Parameter Value
19787
- */
19788
- type Value = string | Record<string, string> | undefined;
19789
- }
19790
- /**
19791
- * A helper used for (read-only) access to CSS parameters at runtime.
19792
- */
19793
- interface Parameters {
19794
- /**
19795
- * Returns the current value for one or more theming parameters, depending on the given arguments. The
19796
- * synchronous usage of this API has been deprecated and only the asynchronous usage should still be used
19797
- * (see the 4th bullet point and the code examples below).
19798
- *
19799
- * The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
19800
- * API calls for the same parameter name will always result in the same parameter value.
19801
- *
19802
- * The following API variants are available (see also the below examples):
19803
- * - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
19804
- * returned
19805
- * - **(deprecated since 1.94)** If a `string` is given as first parameter the value is returned as a
19806
- * `string`
19807
- * - **(deprecated since 1.94)** If an `array` is given as first parameter a key-value map containing
19808
- * all parameters from the `array` is returned
19809
- * - If an `object` is given as first parameter the result is returned immediately in case all parameters
19810
- * are loaded and available or within the callback in case not all CSS files are already loaded. This is
19811
- * the **only asynchronous** API variant. This variant is the preferred way to retrieve theming parameters.
19812
- * The structure of the return value is the same as listed above depending on the type of the name property
19813
- * within the `object`.
19814
- *
19815
- * The returned key-value maps are a copy so changing values in the map does not have any effect
19816
- *
19817
- * Please see the examples below for a detailed guide on how to use the **asynchronous variant** of
19818
- * the API.
19819
- *
19820
- * @returns the CSS parameter value(s) or `undefined` if the parameters could not be retrieved.
19821
- */
19822
- get(
19823
- /**
19824
- * the (array with) CSS parameter name(s) or an object containing the (array with) CSS parameter name(s),
19825
- * the scopeElement and a callback for async retrieval of parameters.
19826
- */
19827
- vName:
19828
- | string
19829
- | string[]
19830
- | {
19831
- /**
19832
- * the (array with) CSS parameter name(s)
19833
- */
19834
- name: string | string[];
19835
- /**
19836
- * Element / control instance to take into account when looking for a parameter value. This can make a difference
19837
- * when a parameter value is overridden in a theme scope set via a CSS class.
19838
- */
19839
- scopeElement?: sap.ui.core.Element;
19840
- /**
19841
- * If given, the callback is only executed in case there are still parameters pending and one or more of
19842
- * the requested parameters is missing.
19843
- */
19844
- callback?: (p1: sap.ui.core.theming.Parameters.Value) => void;
19845
- },
19846
- /**
19847
- * Element / control instance to take into account when looking for a parameter value. This can make a difference
19848
- * when a parameter value is overridden in a theme scope set via a CSS class.
19849
- */
19850
- oElement?: sap.ui.core.Element
19851
- ): sap.ui.core.theming.Parameters.Value;
19852
- /**
19853
- * @deprecated (since 1.92)
19854
- *
19855
- * Resets the CSS parameters which finally will reload the parameters the next time they are queried via
19856
- * the method `get`.
19857
- */
19858
- reset(): void;
19859
- }
19860
- }
19861
-
19862
21129
  namespace aria {
19863
21130
  /**
19864
21131
  * @since 1.84
@@ -20027,6 +21294,8 @@ declare namespace sap {
20027
21294
 
20028
21295
  namespace Configuration {
20029
21296
  /**
21297
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting} instead.
21298
+ *
20030
21299
  * Encapsulates configuration settings that are related to data formatting/parsing.
20031
21300
  *
20032
21301
  * **Note:** When format configuration settings are modified through this class, UI5 only ensures that formatter
@@ -20069,26 +21338,33 @@ declare namespace sap {
20069
21338
  */
20070
21339
  static getMetadata(): sap.ui.base.Metadata;
20071
21340
  /**
21341
+ * @since 1.120
21342
+ *
20072
21343
  * Adds custom currencies to the existing entries. E.g. ` { "KWD": {"digits": 3}, "TND" : {"digits": 3 }
20073
21344
  * } `
20074
21345
  * See:
20075
- * #setCustomCurrencies
20076
- *
20077
- * @returns Returns `this` to allow method chaining
21346
+ * {@link module:sap/base/i18n/Formatting.setCustomCurrencies}
20078
21347
  */
20079
21348
  addCustomCurrencies(
20080
21349
  /**
20081
21350
  * adds to the currency map
20082
21351
  */
20083
21352
  mCurrencies: object
20084
- ): this;
21353
+ ): void;
20085
21354
  /**
21355
+ * @since 1.120
21356
+ *
20086
21357
  * Retrieves the custom currencies. E.g. ` { "KWD": {"digits": 3}, "TND" : {"digits": 3} } `
21358
+ * See:
21359
+ * {@link module:sap/base/i18n/Formatting.setCustomCurrencies}
21360
+ * {@link module:sap/base/i18n/Formatting.addCustomCurrencies}
20087
21361
  *
20088
21362
  * @returns the mapping between custom currencies and its digits
20089
21363
  */
20090
21364
  getCustomCurrencies(): object;
20091
21365
  /**
21366
+ * @since 1.120
21367
+ *
20092
21368
  * Returns the currently set date pattern or undefined if no pattern has been defined.
20093
21369
  *
20094
21370
  * @returns The resulting date pattern
@@ -20100,6 +21376,8 @@ declare namespace sap {
20100
21376
  sStyle: "short" | "medium" | "long" | "full"
20101
21377
  ): string;
20102
21378
  /**
21379
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getLanguageTag} instead.
21380
+ *
20103
21381
  * Returns the locale to be used for formatting.
20104
21382
  *
20105
21383
  * If no such locale has been defined, this method falls back to the language, see {@link sap.ui.core.Configuration#getLanguage Configuration.getLanguage()}.
@@ -20112,44 +21390,23 @@ declare namespace sap {
20112
21390
  */
20113
21391
  getFormatLocale(): sap.ui.core.Locale;
20114
21392
  /**
20115
- * Returns the currently set customizing data for Islamic calendar support
21393
+ * @since 1.120
20116
21394
  *
20117
- * @returns Returns an array contains the customizing data. Each element in the array has properties: dateFormat,
20118
- * islamicMonthStart, gregDate. For details, please see {@link #setLegacyDateCalendarCustomizing}
20119
- */
20120
- getLegacyDateCalendarCustomizing(): object[];
20121
- /**
20122
- * Returns the currently set legacy ABAP date format (its id) or undefined if none has been set.
21395
+ * Returns the currently set customizing data for Islamic calendar support.
20123
21396
  *
20124
- * @returns ID of the ABAP date format, if not set or set to `""`, `undefined` will be returned
20125
- */
20126
- getLegacyDateFormat():
20127
- | "1"
20128
- | "2"
20129
- | "3"
20130
- | "4"
20131
- | "5"
20132
- | "6"
20133
- | "7"
20134
- | "8"
20135
- | "9"
20136
- | "A"
20137
- | "B"
20138
- | "C"
20139
- | undefined;
20140
- /**
20141
- * Returns the currently set legacy ABAP number format (its id) or undefined if none has been set.
21397
+ * See: {@link module:sap/base/i18n/Formatting.CustomIslamicCalendarData}
20142
21398
  *
20143
- * @returns ID of the ABAP number format, if not set or set to `""`, `undefined` will be returned
21399
+ * @returns Returns an array that contains the customizing data. Each element in the array has properties:
21400
+ * dateFormat, islamicMonthStart, gregDate. For details, please see {@link #.setCustomIslamicCalendarData}
20144
21401
  */
20145
- getLegacyNumberFormat(): " " | "X" | "Y" | undefined;
21402
+ getLegacyDateCalendarCustomizing():
21403
+ | Array<
21404
+ import("sap/base/i18n/Formatting").CustomIslamicCalendarData
21405
+ >
21406
+ | undefined;
20146
21407
  /**
20147
- * Returns the currently set legacy ABAP time format (its id) or undefined if none has been set.
21408
+ * @since 1.120
20148
21409
  *
20149
- * @returns ID of the ABAP date format, if not set or set to `""`, `undefined` will be returned
20150
- */
20151
- getLegacyTimeFormat(): "0" | "1" | "2" | "3" | "4" | undefined;
20152
- /**
20153
21410
  * Returns the currently set number symbol of the given type or undefined if no symbol has been defined.
20154
21411
  *
20155
21412
  * @returns A non-numerical symbol used as part of a number for the given type, e.g. for locale de_DE:
@@ -20166,6 +21423,8 @@ declare namespace sap {
20166
21423
  sType: "group" | "decimal" | "plusSign" | "minusSign"
20167
21424
  ): string;
20168
21425
  /**
21426
+ * @since 1.120
21427
+ *
20169
21428
  * Returns the currently set time pattern or undefined if no pattern has been defined.
20170
21429
  *
20171
21430
  * @returns The resulting time pattern
@@ -20177,7 +21436,7 @@ declare namespace sap {
20177
21436
  sStyle: "short" | "medium" | "long" | "full"
20178
21437
  ): string;
20179
21438
  /**
20180
- * @since 1.75.0
21439
+ * @since 1.120
20181
21440
  *
20182
21441
  * Returns current trailingCurrencyCode configuration for new NumberFormatter instances
20183
21442
  *
@@ -20185,6 +21444,8 @@ declare namespace sap {
20185
21444
  */
20186
21445
  getTrailingCurrencyCode(): boolean;
20187
21446
  /**
21447
+ * @since 1.120
21448
+ *
20188
21449
  * Sets custom currencies and replaces existing entries.
20189
21450
  *
20190
21451
  * There is a special currency code named "DEFAULT" that is optional. In case it is set it will be used
@@ -20200,15 +21461,15 @@ declare namespace sap {
20200
21461
  * Note: To unset the custom currencies: call with `undefined` Custom currencies must not only consist of
20201
21462
  * digits but contain at least one non-digit character, e.g. "a", so that the measure part can be distinguished
20202
21463
  * from the number part.
20203
- *
20204
- * @returns Returns `this` to allow method chaining
21464
+ * See:
21465
+ * {@link module:sap/base/i18n/Formatting.addCustomCurrencies}
20205
21466
  */
20206
21467
  setCustomCurrencies(
20207
21468
  /**
20208
21469
  * currency map which is set
20209
21470
  */
20210
21471
  mCurrencies: object
20211
- ): this;
21472
+ ): void;
20212
21473
  /**
20213
21474
  * Defines the preferred format pattern for the given date format style.
20214
21475
  *
@@ -20234,7 +21495,7 @@ declare namespace sap {
20234
21495
  sPattern: string
20235
21496
  ): this;
20236
21497
  /**
20237
- * @deprecated (since 1.113.0) - Use {@link sap.ui.core.Configuration.FormatSettings#setCalendarWeekNumbering }
21498
+ * @deprecated (since 1.113) - Use {@link sap.ui.core.Configuration.FormatSettings#setCalendarWeekNumbering }
20238
21499
  * instead.
20239
21500
  *
20240
21501
  * Defines the day used as the first day of the week.
@@ -20259,29 +21520,21 @@ declare namespace sap {
20259
21520
  iValue: int
20260
21521
  ): this;
20261
21522
  /**
21523
+ * @since 1.120
21524
+ *
20262
21525
  * Allows to specify the customizing data for Islamic calendar support
20263
21526
  *
20264
- * @returns Returns `this` to allow method chaining
21527
+ * See: {@link module:sap/base/i18n/Formatting.CustomIslamicCalendarData}
20265
21528
  */
20266
21529
  setLegacyDateCalendarCustomizing(
20267
21530
  /**
20268
- * contains the customizing data for the support of Islamic calendar.
21531
+ * Contains the customizing data for the support of Islamic calendar. One JSON object in the array represents
21532
+ * one row of data from Table TISLCAL
20269
21533
  */
20270
- aMappings: Array<{
20271
- /**
20272
- * The date format
20273
- */
20274
- dateFormat: string;
20275
- /**
20276
- * The Islamic date
20277
- */
20278
- islamicMonthStart: string;
20279
- /**
20280
- * The corresponding Gregorian date
20281
- */
20282
- gregDate: string;
20283
- }>
20284
- ): this;
21534
+ aCustomCalendarData: Array<
21535
+ import("sap/base/i18n/Formatting").CustomIslamicCalendarData
21536
+ >
21537
+ ): void;
20285
21538
  /**
20286
21539
  * Allows to specify one of the legacy ABAP date formats.
20287
21540
  *
@@ -20400,7 +21653,7 @@ declare namespace sap {
20400
21653
  sPattern: string
20401
21654
  ): this;
20402
21655
  /**
20403
- * @since 1.75.0
21656
+ * @since 1.120
20404
21657
  *
20405
21658
  * Define whether the NumberFormatter shall always place the currency code after the numeric value, with
20406
21659
  * the only exception of right-to-left locales, where the currency code shall be placed before the numeric
@@ -20411,18 +21664,17 @@ declare namespace sap {
20411
21664
  *
20412
21665
  * Each currency instance ({@link sap.ui.core.format.NumberFormat.getCurrencyInstance}) will be created
20413
21666
  * with this setting unless overwritten on instance level.
20414
- *
20415
- * @returns Returns `this` to allow method chaining
20416
21667
  */
20417
21668
  setTrailingCurrencyCode(
20418
21669
  /**
20419
21670
  * Whether currency codes shall always be placed after the numeric value
20420
21671
  */
20421
21672
  bTrailingCurrencyCode: boolean
20422
- ): this;
21673
+ ): void;
20423
21674
  }
20424
21675
  /**
20425
21676
  * @since 1.50.0
21677
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/AnimationMode} instead.
20426
21678
  *
20427
21679
  * Enumerable list with available animation modes.
20428
21680
  *
@@ -20453,6 +21705,7 @@ declare namespace sap {
20453
21705
  namespace date {
20454
21706
  /**
20455
21707
  * @since 1.108.0
21708
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/18n/date/CalendarWeekNumbering} instead.
20456
21709
  *
20457
21710
  * The `CalendarWeekNumbering` enum defines how to calculate calendar weeks. Each value defines:
20458
21711
  * - The first day of the week,
@@ -24186,7 +25439,7 @@ declare namespace sap {
24186
25439
  /**
24187
25440
  * The route data
24188
25441
  */
24189
- arguments: Record<string, string>;
25442
+ arguments: Record<string, string | Record<string, string>>;
24190
25443
  };
24191
25444
 
24192
25445
  /**
@@ -24341,6 +25594,8 @@ declare namespace sap {
24341
25594
  }
24342
25595
 
24343
25596
  /**
25597
+ * @deprecated (since 1.120)
25598
+ *
24344
25599
  * A SearchProvider which uses the OpenSearch protocol (either JSON or XML).
24345
25600
  */
24346
25601
  class OpenSearchProvider extends sap.ui.core.search.SearchProvider {
@@ -24476,6 +25731,8 @@ declare namespace sap {
24476
25731
  ): void;
24477
25732
  }
24478
25733
  /**
25734
+ * @deprecated (since 1.120)
25735
+ *
24479
25736
  * Abstract base class for all SearchProviders which can be e.g. attached to a SearchField.
24480
25737
  *
24481
25738
  * Do not create instances of this class, but use a concrete subclass instead.
@@ -24770,6 +26027,85 @@ declare namespace sap {
24770
26027
  }
24771
26028
  }
24772
26029
 
26030
+ namespace theming {
26031
+ namespace Parameters {
26032
+ /**
26033
+ * Theming Parameter Value
26034
+ */
26035
+ type Value = string | Record<string, string> | undefined;
26036
+ }
26037
+ /**
26038
+ * A helper used for (read-only) access to CSS parameters at runtime.
26039
+ */
26040
+ interface Parameters {
26041
+ /**
26042
+ * Returns the current value for one or more theming parameters, depending on the given arguments. The
26043
+ * synchronous usage of this API has been deprecated and only the asynchronous usage should still be used
26044
+ * (see the 4th bullet point and the code examples below).
26045
+ *
26046
+ * The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
26047
+ * API calls for the same parameter name will always result in the same parameter value.
26048
+ *
26049
+ * The following API variants are available (see also the below examples):
26050
+ * - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
26051
+ * returned
26052
+ * - **(deprecated since 1.94)** If a `string` is given as first parameter the value is returned as a
26053
+ * `string`
26054
+ * - **(deprecated since 1.94)** If an `array` is given as first parameter a key-value map containing
26055
+ * all parameters from the `array` is returned
26056
+ * - If an `object` is given as first parameter the result is returned immediately in case all parameters
26057
+ * are loaded and available or within the callback in case not all CSS files are already loaded. This is
26058
+ * the **only asynchronous** API variant. This variant is the preferred way to retrieve theming parameters.
26059
+ * The structure of the return value is the same as listed above depending on the type of the name property
26060
+ * within the `object`.
26061
+ *
26062
+ * The returned key-value maps are a copy so changing values in the map does not have any effect
26063
+ *
26064
+ * Please see the examples below for a detailed guide on how to use the **asynchronous variant** of
26065
+ * the API.
26066
+ *
26067
+ * @returns the CSS parameter value(s) or `undefined` if the parameters could not be retrieved.
26068
+ */
26069
+ get(
26070
+ /**
26071
+ * the (array with) CSS parameter name(s) or an object containing the (array with) CSS parameter name(s),
26072
+ * the scopeElement and a callback for async retrieval of parameters.
26073
+ */
26074
+ vName:
26075
+ | string
26076
+ | string[]
26077
+ | {
26078
+ /**
26079
+ * the (array with) CSS parameter name(s)
26080
+ */
26081
+ name: string | string[];
26082
+ /**
26083
+ * Element / control instance to take into account when looking for a parameter value. This can make a difference
26084
+ * when a parameter value is overridden in a theme scope set via a CSS class.
26085
+ */
26086
+ scopeElement?: sap.ui.core.Element;
26087
+ /**
26088
+ * If given, the callback is only executed in case there are still parameters pending and one or more of
26089
+ * the requested parameters is missing.
26090
+ */
26091
+ callback?: (p1: sap.ui.core.theming.Parameters.Value) => void;
26092
+ },
26093
+ /**
26094
+ * Element / control instance to take into account when looking for a parameter value. This can make a difference
26095
+ * when a parameter value is overridden in a theme scope set via a CSS class.
26096
+ */
26097
+ oElement?: sap.ui.core.Element
26098
+ ): sap.ui.core.theming.Parameters.Value;
26099
+ /**
26100
+ * @deprecated (since 1.92)
26101
+ *
26102
+ * Resets the CSS parameters which finally will reload the parameters the next time they are queried via
26103
+ * the method `get`.
26104
+ */
26105
+ reset(): void;
26106
+ }
26107
+ }
26108
+
24773
26109
  namespace tmpl {
24774
26110
  interface $DOMAttributeSettings extends sap.ui.core.$ElementSettings {
24775
26111
  /**
@@ -29274,7 +30610,9 @@ declare namespace sap {
29274
30610
  execute?: (oEvent: sap.ui.base.Event) => void;
29275
30611
  }
29276
30612
 
29277
- interface $ComponentSettings extends sap.ui.base.$ManagedObjectSettings {}
30613
+ interface $ComponentSettings extends sap.ui.base.$ManagedObjectSettings {
30614
+ componentData?: any;
30615
+ }
29278
30616
 
29279
30617
  interface $ComponentContainerSettings
29280
30618
  extends sap.ui.core.$ControlSettings {
@@ -29622,6 +30960,10 @@ declare namespace sap {
29622
30960
 
29623
30961
  interface $FragmentSettings extends sap.ui.base.$ManagedObjectSettings {
29624
30962
  type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
30963
+
30964
+ fragmentName?: string;
30965
+
30966
+ fragmentContent?: any;
29625
30967
  }
29626
30968
 
29627
30969
  interface $HTMLSettings extends sap.ui.core.$ControlSettings {
@@ -30400,6 +31742,8 @@ declare namespace sap {
30400
31742
  }
30401
31743
 
30402
31744
  /**
31745
+ * @deprecated (since 1.120)
31746
+ *
30403
31747
  * Collects and stores the configuration of the current environment.
30404
31748
  *
30405
31749
  * The Configuration is initialized once when the {@link sap.ui.core.Core} is created. There are different
@@ -30426,6 +31770,7 @@ declare namespace sap {
30426
31770
  interface Configuration {
30427
31771
  /**
30428
31772
  * @since 1.38.6
31773
+ * @deprecated (since 1.120)
30429
31774
  *
30430
31775
  * Applies multiple changes to the configuration at once.
30431
31776
  *
@@ -30470,6 +31815,10 @@ declare namespace sap {
30470
31815
  FNMetaImpl?: Function
30471
31816
  ): Function;
30472
31817
  /**
31818
+ * @since 1.20
31819
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.isAccessibilityEnabled }
31820
+ * instead.
31821
+ *
30473
31822
  * Returns whether the accessibility mode is enabled or not.
30474
31823
  *
30475
31824
  * @returns whether the accessibility mode is enabled or not
@@ -30486,13 +31835,15 @@ declare namespace sap {
30486
31835
  */
30487
31836
  getActiveTerminologies(): string[] | undefined;
30488
31837
  /**
31838
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getAllowlistService} instead.
31839
+ *
30489
31840
  * URL of the allowlist service.
30490
31841
  *
30491
31842
  * @returns allowlist service URL
30492
31843
  */
30493
31844
  getAllowlistService(): string;
30494
31845
  /**
30495
- * @deprecated (since 1.50.0) - replaced by {@link sap.ui.core.Configuration#getAnimationMode}
31846
+ * @deprecated (since 1.50) - Please use {@link sap.ui.core.Configuration#getAnimationMode} instead.
30496
31847
  *
30497
31848
  * Returns whether the animations are globally used.
30498
31849
  *
@@ -30501,6 +31852,7 @@ declare namespace sap {
30501
31852
  getAnimation(): boolean;
30502
31853
  /**
30503
31854
  * @since 1.50.0
31855
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.getAnimationMode} instead.
30504
31856
  *
30505
31857
  * Returns the current animation mode.
30506
31858
  *
@@ -30508,15 +31860,19 @@ declare namespace sap {
30508
31860
  */
30509
31861
  getAnimationMode(): sap.ui.core.Configuration.AnimationMode;
30510
31862
  /**
31863
+ * @deprecated (since 1.120)
31864
+ *
30511
31865
  * Base URLs to AppCacheBuster ETag-Index files.
30512
31866
  *
30513
31867
  * @returns array of base URLs
30514
31868
  */
30515
31869
  getAppCacheBuster(): string[];
30516
31870
  /**
31871
+ * @deprecated (since 1.120)
31872
+ *
30517
31873
  * The loading mode (sync|async|batch) of the AppCacheBuster (sync is default)
30518
31874
  *
30519
- * @returns "sync" | "async"
31875
+ * @returns "sync" | "async" | "batch"
30520
31876
  */
30521
31877
  getAppCacheBusterMode(): string;
30522
31878
  /**
@@ -30530,14 +31886,29 @@ declare namespace sap {
30530
31886
  getApplication(): string;
30531
31887
  /**
30532
31888
  * @since 1.27.0
31889
+ * @deprecated (since 1.120)
30533
31890
  *
30534
31891
  * Returns whether the framework automatically adds the ARIA role 'application' to the HTML body or not.
30535
31892
  *
30536
31893
  * @returns Wether the ARIA role 'application' should be added to the HTML body or not
30537
31894
  */
30538
31895
  getAutoAriaBodyRole(): boolean;
31896
+ /**
31897
+ * @since 1.28.6
31898
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getCalendarType} instead.
31899
+ *
31900
+ * Returns the calendar type which is being used in locale dependent functionality.
31901
+ *
31902
+ * When it's explicitly set by calling `setCalendar`, the set calendar type is returned. Otherwise, the
31903
+ * calendar type is determined by checking the format settings and current locale.
31904
+ *
31905
+ * @returns the current calendar type, e.g. `Gregorian`
31906
+ */
31907
+ getCalendarType(): sap.ui.core.CalendarType;
30539
31908
  /**
30540
31909
  * @since 1.113.0
31910
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getCalendarWeekNumbering }
31911
+ * instead.
30541
31912
  *
30542
31913
  * Returns the calendar week numbering algorithm used to determine the first day of the week and the first
30543
31914
  * calendar week of the year, see {@link sap.ui.core.date.CalendarWeekNumbering}.
@@ -30559,6 +31930,8 @@ declare namespace sap {
30559
31930
  sFeature: string
30560
31931
  ): import("sap/base/util/Version").default;
30561
31932
  /**
31933
+ * @deprecated (since 1.120)
31934
+ *
30562
31935
  * Returns whether the page runs in full debug mode.
30563
31936
  *
30564
31937
  * @returns Whether the page runs in full debug mode
@@ -30566,6 +31939,7 @@ declare namespace sap {
30566
31939
  getDebug(): boolean;
30567
31940
  /**
30568
31941
  * @since 1.102
31942
+ * @deprecated (since 1.120)
30569
31943
  *
30570
31944
  * Name (ID) of a UI5 module that implements file share support.
30571
31945
  *
@@ -30577,6 +31951,8 @@ declare namespace sap {
30577
31951
  */
30578
31952
  getFileShareSupport(): string | undefined;
30579
31953
  /**
31954
+ * @deprecated (since 1.120)
31955
+ *
30580
31956
  * Returns whether the Fiori2Adaptation is on.
30581
31957
  *
30582
31958
  * @returns false - no adaptation, true - full adaptation, comma-separated list - partial adaptation Possible
@@ -30585,6 +31961,7 @@ declare namespace sap {
30585
31961
  getFiori2Adaptation(): boolean | string;
30586
31962
  /**
30587
31963
  * @since 1.60.0
31964
+ * @deprecated (since 1.120)
30588
31965
  *
30589
31966
  * Returns the URL from where the UI5 flexibility services are called; if empty, the flexibility services
30590
31967
  * are not called.
@@ -30593,6 +31970,8 @@ declare namespace sap {
30593
31970
  */
30594
31971
  getFlexibilityServices(): object[];
30595
31972
  /**
31973
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.getLanguageTag} instead.
31974
+ *
30596
31975
  * Returns the format locale string with language and region code. Falls back to language configuration,
30597
31976
  * in case it has not been explicitly defined.
30598
31977
  *
@@ -30600,18 +31979,24 @@ declare namespace sap {
30600
31979
  */
30601
31980
  getFormatLocale(): string;
30602
31981
  /**
31982
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting} instead.
31983
+ *
30603
31984
  * Returns a configuration object that bundles the format settings of UI5.
30604
31985
  *
30605
31986
  * @returns A FormatSettings object.
30606
31987
  */
30607
31988
  getFormatSettings(): sap.ui.core.Configuration.FormatSettings;
30608
31989
  /**
31990
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getFrameOptions} instead.
31991
+ *
30609
31992
  * frameOptions mode (allow/deny/trusted).
30610
31993
  *
30611
31994
  * @returns frameOptions mode
30612
31995
  */
30613
31996
  getFrameOptions(): string;
30614
31997
  /**
31998
+ * @deprecated (since 1.120)
31999
+ *
30615
32000
  * Returns whether the UI5 control inspe ctor is displayed. Has only an effect when the sap-ui-debug module
30616
32001
  * has been loaded
30617
32002
  *
@@ -30619,6 +32004,8 @@ declare namespace sap {
30619
32004
  */
30620
32005
  getInspect(): boolean;
30621
32006
  /**
32007
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguage} instead.
32008
+ *
30622
32009
  * Returns a string that identifies the current language.
30623
32010
  *
30624
32011
  * The value returned by config method in most cases corresponds to the exact value that has been configured
@@ -30652,6 +32039,8 @@ declare namespace sap {
30652
32039
  */
30653
32040
  getLanguage(): string;
30654
32041
  /**
32042
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguageTag} instead.
32043
+ *
30655
32044
  * Returns a BCP47-compliant language tag for the current language.
30656
32045
  *
30657
32046
  * The return value of config method is especially useful for an HTTP `Accept-Language` header.
@@ -30662,6 +32051,8 @@ declare namespace sap {
30662
32051
  */
30663
32052
  getLanguageTag(): string;
30664
32053
  /**
32054
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getLanguageTag} instead.
32055
+ *
30665
32056
  * Returns a Locale object for the current language.
30666
32057
  *
30667
32058
  * The Locale is derived from the {@link #getLanguage language} property.
@@ -30671,6 +32062,8 @@ declare namespace sap {
30671
32062
  getLocale(): sap.ui.core.Locale;
30672
32063
  /**
30673
32064
  * @since 1.33.0
32065
+ * @deprecated (since 1.120) - 'manifest-first' is the default for the {@link sap.ui.core.Component.create }
32066
+ * factory.
30674
32067
  *
30675
32068
  * Flag whether a Component should load the manifest first.
30676
32069
  *
@@ -30684,12 +32077,16 @@ declare namespace sap {
30684
32077
  */
30685
32078
  getMetadata(): sap.ui.base.Metadata;
30686
32079
  /**
32080
+ * @deprecated (since 1.120)
32081
+ *
30687
32082
  * Returns whether there should be an exception on any duplicate element IDs.
30688
32083
  *
30689
32084
  * @returns whether there should be an exception on any duplicate element IDs
30690
32085
  */
30691
32086
  getNoDuplicateIds(): boolean;
30692
32087
  /**
32088
+ * @deprecated (since 1.120)
32089
+ *
30693
32090
  * Returns whether the text origin information is collected.
30694
32091
  *
30695
32092
  * @returns whether the text info is collected
@@ -30704,6 +32101,8 @@ declare namespace sap {
30704
32101
  */
30705
32102
  getRootComponent(): string;
30706
32103
  /**
32104
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getRTL} instead.
32105
+ *
30707
32106
  * Returns whether the page uses the RTL text direction.
30708
32107
  *
30709
32108
  * If no mode has been explicitly set (neither `true` nor `false`), the mode is derived from the current
@@ -30713,6 +32112,9 @@ declare namespace sap {
30713
32112
  */
30714
32113
  getRTL(): boolean;
30715
32114
  /**
32115
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getSAPLogonLanguage }
32116
+ * instead.
32117
+ *
30716
32118
  * Returns an SAP logon language for the current language.
30717
32119
  *
30718
32120
  * It will be returned in uppercase. e.g. "EN", "DE"
@@ -30721,7 +32123,8 @@ declare namespace sap {
30721
32123
  */
30722
32124
  getSAPLogonLanguage(): string;
30723
32125
  /**
30724
- * @since 1.95.0
32126
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.getSecurityTokenHandlers }
32127
+ * instead.
30725
32128
  *
30726
32129
  * Returns the security token handlers of an OData V4 model.
30727
32130
  * See:
@@ -30734,6 +32137,7 @@ declare namespace sap {
30734
32137
  >;
30735
32138
  /**
30736
32139
  * @since 1.106.0
32140
+ * @deprecated (since 1.120)
30737
32141
  *
30738
32142
  * Flag if statistics are requested.
30739
32143
  *
@@ -30744,19 +32148,23 @@ declare namespace sap {
30744
32148
  */
30745
32149
  getStatisticsEnabled(): boolean;
30746
32150
  /**
32151
+ * @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.getTheme} instead.
32152
+ *
30747
32153
  * Returns the theme name
30748
32154
  *
30749
32155
  * @returns the theme name
30750
32156
  */
30751
32157
  getTheme(): string;
30752
32158
  /**
32159
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.getTimezone} instead.
32160
+ *
30753
32161
  * Retrieves the configured IANA timezone ID.
30754
32162
  *
30755
32163
  * @returns The configured IANA timezone ID, e.g. "America/New_York"
30756
32164
  */
30757
32165
  getTimezone(): string;
30758
32166
  /**
30759
- * @deprecated (since 1.119.0) - Please use {@link sap.ui.base.ManagedObjectMetadata.getUIDPrefix ManagedObjectMetadata.getUIDPrefix }
32167
+ * @deprecated (since 1.119) - Please use {@link sap.ui.base.ManagedObjectMetadata.getUIDPrefix ManagedObjectMetadata.getUIDPrefix }
30760
32168
  * instead.
30761
32169
  *
30762
32170
  * Prefix to be used for automatically generated control IDs. Default is a double underscore "__".
@@ -30765,6 +32173,8 @@ declare namespace sap {
30765
32173
  */
30766
32174
  getUIDPrefix(): string;
30767
32175
  /**
32176
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/VersionInfo.load} instead.
32177
+ *
30768
32178
  * Returns the version of the framework.
30769
32179
  *
30770
32180
  * Similar to `sap.ui.version`.
@@ -30773,9 +32183,9 @@ declare namespace sap {
30773
32183
  */
30774
32184
  getVersion(): import("sap/base/util/Version").default;
30775
32185
  /**
30776
- * @deprecated (since 1.85.0) - Use {@link sap.ui.core.Configuration#getAllowlistService} instead. SAP strives
30777
- * to replace insensitive terms with inclusive language. Since APIs cannot be renamed or immediately removed
30778
- * for compatibility reasons, this API has been deprecated.
32186
+ * @deprecated (since 1.85) - Use {@link module:sap/ui/security/Security.getAllowlistService} instead. SAP
32187
+ * strives to replace insensitive terms with inclusive language. Since APIs cannot be renamed or immediately
32188
+ * removed for compatibility reasons, this API has been deprecated.
30779
32189
  *
30780
32190
  * URL of the whitelist service.
30781
32191
  *
@@ -30784,6 +32194,7 @@ declare namespace sap {
30784
32194
  getWhitelistService(): string;
30785
32195
  /**
30786
32196
  * @since 1.50.0
32197
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/ControlBehavior.setAnimationMode} instead.
30787
32198
  *
30788
32199
  * Sets the current animation mode.
30789
32200
  *
@@ -30800,6 +32211,7 @@ declare namespace sap {
30800
32211
  ): void;
30801
32212
  /**
30802
32213
  * @since 1.28.6
32214
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setCalendarType} instead.
30803
32215
  *
30804
32216
  * Sets the new calendar type to be used from now on in locale dependent functionality (for example, formatting,
30805
32217
  * translation texts, etc.).
@@ -30815,6 +32227,8 @@ declare namespace sap {
30815
32227
  ): this;
30816
32228
  /**
30817
32229
  * @since 1.113.0
32230
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setCalendarWeekNumbering }
32231
+ * instead.
30818
32232
  *
30819
32233
  * Sets the calendar week numbering algorithm which is used to determine the first day of the week and the
30820
32234
  * first calendar week of the year, see {@link sap.ui.core.date.CalendarWeekNumbering}.
@@ -30828,6 +32242,8 @@ declare namespace sap {
30828
32242
  sCalendarWeekNumbering: sap.ui.core.date.CalendarWeekNumbering
30829
32243
  ): this;
30830
32244
  /**
32245
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/Formatting.setLanguageTag} instead.
32246
+ *
30831
32247
  * Sets a new format locale to be used from now on for retrieving locale specific formatters. Modifying
30832
32248
  * this setting does not have an impact on the retrieval of translated texts!
30833
32249
  *
@@ -30852,6 +32268,8 @@ declare namespace sap {
30852
32268
  sFormatLocale: string | null
30853
32269
  ): this;
30854
32270
  /**
32271
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setLanguage} instead.
32272
+ *
30855
32273
  * Sets a new language to be used from now on for language/region dependent functionality (e.g. formatting,
30856
32274
  * data types, translated texts, ...).
30857
32275
  *
@@ -30876,8 +32294,7 @@ declare namespace sap {
30876
32294
  * - date and number data types that are used in property bindings or composite bindings in existing Elements,
30877
32295
  * Controls, UIAreas or Components
30878
32296
  * - ResourceModels currently assigned to the Core, a UIArea, Component, Element or Control
30879
- * - Elements or Controls that implement the `onlocalizationChanged` hook (note the lowercase 'l' in onlocalizationChanged)
30880
- *
32297
+ * - Elements or Controls that implement the `onLocalizationChanged` hook
30881
32298
  *
30882
32299
  * It furthermore derives the RTL mode from the new language, if no explicit RTL mode has been set. If the
30883
32300
  * RTL mode changes, the following additional actions will be taken:
@@ -30896,6 +32313,8 @@ declare namespace sap {
30896
32313
  * **Note**: When using config method please take note of and respect the above mentioned restrictions.
30897
32314
  * See:
30898
32315
  * http://scn.sap.com/docs/DOC-14377
32316
+ *
32317
+ * @returns `this` to allow method chaining
30899
32318
  */
30900
32319
  setLanguage(
30901
32320
  /**
@@ -30909,8 +32328,10 @@ declare namespace sap {
30909
32328
  * `sLanguage` as SAP Logon language.
30910
32329
  */
30911
32330
  sSAPLogonLanguage?: string
30912
- ): void;
32331
+ ): this;
30913
32332
  /**
32333
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setRTL} instead.
32334
+ *
30914
32335
  * Sets the character orientation mode to be used from now on.
30915
32336
  *
30916
32337
  * Can either be set to a concrete value (true meaning right-to-left, false meaning left-to-right) or to
@@ -30931,7 +32352,8 @@ declare namespace sap {
30931
32352
  bRTL: boolean | null
30932
32353
  ): this;
30933
32354
  /**
30934
- * @since 1.95.0
32355
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/security/Security.setSecurityTokenHandlers }
32356
+ * instead.
30935
32357
  *
30936
32358
  * Sets the security token handlers for an OData V4 model. See chapter {@link https://ui5.sap.com/#/topic/9613f1f2d88747cab21896f7216afdac/section_STH Security Token Handling}.
30937
32359
  * See:
@@ -30944,6 +32366,8 @@ declare namespace sap {
30944
32366
  aSecurityTokenHandlers: Array<(p1: sap.ui.core.URI) => Promise<any>>
30945
32367
  ): void;
30946
32368
  /**
32369
+ * @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.setTheme} instead.
32370
+ *
30947
32371
  * Allows setting the theme name
30948
32372
  *
30949
32373
  * @returns `this` to allow method chaining
@@ -30956,6 +32380,7 @@ declare namespace sap {
30956
32380
  ): this;
30957
32381
  /**
30958
32382
  * @since 1.99.0
32383
+ * @deprecated (since 1.119) - Please use {@link module:sap/base/i18n/Localization.setTimezone} instead.
30959
32384
  *
30960
32385
  * Sets the timezone such that all date and time based calculations use config timezone.
30961
32386
  *
@@ -31819,6 +33244,9 @@ declare namespace sap {
31819
33244
  */
31820
33245
  getComponent(sId: string): sap.ui.core.Component;
31821
33246
  /**
33247
+ * @deprecated (since 1.120) - Please see {@link sap.ui.core.Configuration Configuration} for the corrsponding
33248
+ * replacements.
33249
+ *
31822
33250
  * Returns the Configuration of the Core.
31823
33251
  *
31824
33252
  * @returns the Configuration of the current Core.
@@ -33611,6 +35039,8 @@ declare namespace sap {
33611
35039
  ): Function;
33612
35040
  /**
33613
35041
  * @since 1.56.0
35042
+ * @deprecated (since 1.120) - please use the static {@link sap.ui.core.Component.getComponentById getComponentById }
35043
+ * instead.
33614
35044
  *
33615
35045
  * Returns an existing component instance, identified by its ID.
33616
35046
  *
@@ -33622,6 +35052,19 @@ declare namespace sap {
33622
35052
  */
33623
35053
  sId: string
33624
35054
  ): sap.ui.core.Component | undefined;
35055
+ /**
35056
+ * @since 1.120
35057
+ *
35058
+ * Returns an existing component instance, identified by its ID.
35059
+ *
35060
+ * @returns Component instance or `undefined` when no component with the given ID exists.
35061
+ */
35062
+ static getComponentById(
35063
+ /**
35064
+ * ID of the component.
35065
+ */
35066
+ sId: string
35067
+ ): sap.ui.core.Component | undefined;
33625
35068
  /**
33626
35069
  * Returns the metadata for the Component class.
33627
35070
  *
@@ -35939,6 +37382,8 @@ declare namespace sap {
35939
37382
  }
35940
37383
  /**
35941
37384
  * @since 1.7.0
37385
+ * @deprecated (since 1.120) - Please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed Views }
37386
+ * instead. For more information, see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.
35942
37387
  *
35943
37388
  * Static class for enabling declarative UI support.
35944
37389
  */
@@ -39229,7 +40674,7 @@ declare namespace sap {
39229
40674
  * Provides information about a library.
39230
40675
  *
39231
40676
  * This method is intended to be called exactly once while the main module of a library (its `library.js`
39232
- * module) is executing, typically at its begin. The single parameter `oLibInfo` is an info object that
40677
+ * module) is executing, typically at its begin. The single parameter `mSettings` is an info object that
39233
40678
  * describes the content of the library.
39234
40679
  *
39235
40680
  * When the `mSettings` has been processed, a normalized version will be set on the library instance Finally,
@@ -39243,10 +40688,10 @@ declare namespace sap {
39243
40688
  * - If the object contains a list of `interfaces`, they will be registered with the {@link sap.ui.base.DataType }
39244
40689
  * class to make them available as aggregation types in managed objects.
39245
40690
  *
40691
+ * If the object contains a list of `controls` or `elements`, {@link sap.ui.lazyRequire lazy stubs }
40692
+ * will be created for their constructor as well as for their static `extend` and `getMetadata` methods.
39246
40693
  *
39247
- * - If the object contains a list of `controls` or `elements`, {@link sap.ui.lazyRequire lazy stubs }
39248
- * will be created for their constructor as well as for their static `extend` and `getMetadata` methods.
39249
- * **Note:** Future versions might abandon the concept of lazy stubs as it requires synchronous XMLHttpRequests
40694
+ * **Note:** Future versions of UI5 will abandon the concept of lazy stubs as it requires synchronous XMLHttpRequests
39250
40695
  * which have been deprecated (see {@link http://xhr.spec.whatwg.org}). To be on the safe side, productive
39251
40696
  * applications should always require any modules that they directly depend on.
39252
40697
  *
@@ -39258,31 +40703,36 @@ declare namespace sap {
39258
40703
  * is e.g. useful when an application merges the CSS for multiple libraries and already loaded the resulting
39259
40704
  * stylesheet.
39260
40705
  *
40706
+ * If a list of library `dependencies` is specified in the info object, those libraries will be loaded
40707
+ * synchronously if they haven't been loaded yet.
39261
40708
  *
39262
- * - If a list of library `dependencies` is specified in the info object, those libraries will be loaded
39263
- * synchronously.
39264
- * **Note:** Dependencies between libraries don't have to be modeled as AMD dependencies. Only when enums
39265
- * or types from an additional library are used in the coding of the `library.js` module, the library should
39266
- * be additionally listed in the AMD dependencies.
40709
+ * **Note:** Dependencies between libraries have to be modeled consistently in several places:
40710
+ * - Both eager and lazy dependencies have to be modelled in the `.library` file.
40711
+ * - By default, UI5 Tooling generates a `manifest.json` file from the content of the `.library` file.
40712
+ * However, if the `manifest.json` file for the library is not generated but maintained manually, it must
40713
+ * be kept consistent with the `.library` file, especially regarding its listed library dependencies.
40714
+ * - All eager library dependencies must be declared as AMD dependencies of the `library.js` module by
40715
+ * referring to the corresponding `"some/lib/namespace/library"` module of each library dependency.
40716
+ *
40717
+ * - All eager dependencies must be listed in the `dependencies` property of the info object.
40718
+ * - All lazy dependencies **must not** be listed as AMD dependencies or in the `dependencies` property
40719
+ * of the info object.
39267
40720
  *
39268
40721
  * Last but not least, higher layer frameworks might want to include their own metadata for libraries. The
39269
40722
  * property `extensions` might contain such additional metadata. Its structure is not defined by the framework,
39270
40723
  * but it is strongly suggested that each extension only occupies a single property in the `extensions`
39271
40724
  * object and that the name of that property contains some namespace information (e.g. library name that
39272
40725
  * introduces the feature) to avoid conflicts with other extensions. The framework won't touch the content
39273
- * of `extensions` but will make it available in the library info objects returned by {@link #.getInitializedLibraries}.
40726
+ * of `extensions` but will make it available in the library info objects provided by {@link #.load}.
39274
40727
  *
39275
40728
  * Relationship to Descriptor for Libraries (manifest.json):
39276
40729
  *
39277
40730
  * The information contained in `mSettings` is partially redundant to the content of the descriptor for
39278
- * the same library (its `manifest.json` file). Future versions of UI5 might ignore the information provided
39279
- * in `oLibInfo` and might evaluate the descriptor file instead. Library developers therefore should keep
39280
- * the information in both files in sync.
39281
- *
39282
- * When the `manifest.json` is generated from the `.library` file (which is the default for UI5 libraries
39283
- * built with Maven), then the content of the `.library` and `library.js` files must be kept in sync.
40731
+ * the same library (its `manifest.json` file). Future versions of UI5 will ignore the information provided
40732
+ * in `mSettings` and will evaluate the descriptor file instead. Library developers therefore must keep
40733
+ * the information in both files in sync if the `manifest.json` file is maintained manually.
39284
40734
  *
39285
- * @returns As of version 1.101; returns the library namespace, based on the given library name.
40735
+ * @returns Returns the library namespace, based on the given library name.
39286
40736
  */
39287
40737
  static init(
39288
40738
  /**
@@ -39392,13 +40842,11 @@ declare namespace sap {
39392
40842
  * library:
39393
40843
  * ```javascript
39394
40844
  *
39395
- * Lib.load({name: "heavy.charting"})
39396
- * .then(function() {
39397
- * View.create({
39398
- * name: "myapp.views.HeavyChartingView",
39399
- * type: ViewType.XML
39400
- * });
39401
- * });
40845
+ * await Library.load({name: "heavy.charting"});
40846
+ * await View.create({
40847
+ * name: "myapp.views.HeavyChartingView",
40848
+ * type: ViewType.XML
40849
+ * });
39402
40850
  * ```
39403
40851
  *
39404
40852
  *
@@ -40267,9 +41715,28 @@ declare namespace sap {
40267
41715
  sCalendarType?: sap.ui.core.CalendarType
40268
41716
  ): string;
40269
41717
  /**
40270
- * Get locale specific language names.
41718
+ * Gets the locale-specific language name for the given language tag.
41719
+ *
41720
+ * The languages returned by {@link #getLanguages} from the CLDR raw data do not contain the language names
41721
+ * if they can be derived from the language and the script or the territory. If the map of languages contains
41722
+ * no entry for the given language tag, derive the language name from the used script or region.
41723
+ *
41724
+ * @returns The language name, or `undefined` if the name cannot be determined
41725
+ */
41726
+ getLanguageName(
41727
+ /**
41728
+ * The language tag, for example "en", "en-US", "en_US", "zh-Hant", or "zh_Hant"
41729
+ */
41730
+ sLanguageTag: string
41731
+ ): string | undefined;
41732
+ /**
41733
+ * Gets locale-specific language names, as available in the CLDR raw data.
40271
41734
  *
40272
- * @returns map of locale specific language names
41735
+ * To avoid redundancies, with CLDR version 43 only language names are contained which cannot be derived
41736
+ * from the language and the script or the territory. If a language tag is not contained in the map, use
41737
+ * {@link #getLanguageName} to get the derived locale-specific language name for that language tag.
41738
+ *
41739
+ * @returns Maps a language tag to the locale-specific language name
40273
41740
  */
40274
41741
  getLanguages(): Record<string, string>;
40275
41742
  /**
@@ -40652,15 +42119,22 @@ declare namespace sap {
40652
42119
  sUnit: string
40653
42120
  ): object;
40654
42121
  /**
40655
- * Get locale specific script names.
42122
+ * Gets locale-specific script names, as available in the CLDR raw data.
42123
+ *
42124
+ * To avoid redundancies, with CLDR version 43 only scripts are contained for which the language-specific
42125
+ * name is different from the script key. If a script key is not contained in the map, use the script key
42126
+ * as script name.
40656
42127
  *
40657
- * @returns map of locale specific script names
42128
+ * @returns Maps a script key to the locale-specific script name
40658
42129
  */
40659
42130
  getScripts(): Record<string, string>;
40660
42131
  /**
40661
- * Get locale specific territory names.
42132
+ * Gets locale-specific territory names, as available in the CLDR raw data.
40662
42133
  *
40663
- * @returns map of locale specific territory names
42134
+ * To avoid redundancies, with CLDR version 43 only territories are contained for which the language-specific
42135
+ * name is different from the territory key.
42136
+ *
42137
+ * @returns Maps a territory key to the locale-specific territory name
40664
42138
  */
40665
42139
  getTerritories(): Record<string, string>;
40666
42140
  /**
@@ -44365,9 +45839,6 @@ declare namespace sap {
44365
45839
  * First, all old content controls (if any) will be detached from this UIArea (e.g. their parent relationship
44366
45840
  * to this UIArea will be cut off). Then the parent relationship for the new content control (if not empty)
44367
45841
  * will be set to this UIArea and finally, the UIArea will be marked for re-rendering.
44368
- *
44369
- * The real re-rendering happens whenever the re-rendering is called. Either implicitly at the end of any
44370
- * control event or by calling sap.ui.getCore().applyChanges().
44371
45842
  */
44372
45843
  setRootControl(
44373
45844
  /**
@@ -45501,6 +46972,8 @@ declare namespace sap {
45501
46972
  Small = "Small",
45502
46973
  }
45503
46974
  /**
46975
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/18n/date/CalendarType} instead.
46976
+ *
45504
46977
  * The types of `Calendar`.
45505
46978
  */
45506
46979
  enum CalendarType {
@@ -45703,6 +47176,78 @@ declare namespace sap {
45703
47176
  * Indication Color 8
45704
47177
  */
45705
47178
  Indication08 = "Indication08",
47179
+ /**
47180
+ * @since 1.120
47181
+ *
47182
+ * Indication Color 9
47183
+ */
47184
+ Indication09 = "Indication09",
47185
+ /**
47186
+ * @since 1.120
47187
+ *
47188
+ * Indication Color 10
47189
+ */
47190
+ Indication10 = "Indication10",
47191
+ /**
47192
+ * @since 1.120
47193
+ *
47194
+ * Indication Color 11
47195
+ */
47196
+ Indication11 = "Indication11",
47197
+ /**
47198
+ * @since 1.120
47199
+ *
47200
+ * Indication Color 12
47201
+ */
47202
+ Indication12 = "Indication12",
47203
+ /**
47204
+ * @since 1.120
47205
+ *
47206
+ * Indication Color 13
47207
+ */
47208
+ Indication13 = "Indication13",
47209
+ /**
47210
+ * @since 1.120
47211
+ *
47212
+ * Indication Color 14
47213
+ */
47214
+ Indication14 = "Indication14",
47215
+ /**
47216
+ * @since 1.120
47217
+ *
47218
+ * Indication Color 15
47219
+ */
47220
+ Indication15 = "Indication15",
47221
+ /**
47222
+ * @since 1.120
47223
+ *
47224
+ * Indication Color 16
47225
+ */
47226
+ Indication16 = "Indication16",
47227
+ /**
47228
+ * @since 1.120
47229
+ *
47230
+ * Indication Color 17
47231
+ */
47232
+ Indication17 = "Indication17",
47233
+ /**
47234
+ * @since 1.120
47235
+ *
47236
+ * Indication Color 18
47237
+ */
47238
+ Indication18 = "Indication18",
47239
+ /**
47240
+ * @since 1.120
47241
+ *
47242
+ * Indication Color 19
47243
+ */
47244
+ Indication19 = "Indication19",
47245
+ /**
47246
+ * @since 1.120
47247
+ *
47248
+ * Indication Color 20
47249
+ */
47250
+ Indication20 = "Indication20",
45706
47251
  }
45707
47252
  /**
45708
47253
  * @since 1.78
@@ -53927,14 +55472,14 @@ declare namespace sap {
53927
55472
  *
53928
55473
  * Get a download URL with the specified format considering the sort/filter/custom parameters.
53929
55474
  *
53930
- * @returns URL which can be used for downloading
55475
+ * @returns URL which can be used for downloading; `null` if this binding uses {@link sap.ui.model.Filter.NONE}
53931
55476
  */
53932
55477
  getDownloadUrl(
53933
55478
  /**
53934
55479
  * Value for the $format Parameter
53935
55480
  */
53936
55481
  sFormat: string
53937
- ): string;
55482
+ ): string | null;
53938
55483
  /**
53939
55484
  * Return the length of the list.
53940
55485
  *
@@ -54007,8 +55552,10 @@ declare namespace sap {
54007
55552
  * in its constructor or in its {@link #filter} method; add filters which you want to keep with the "and"
54008
55553
  * conjunction to the resulting filter before calling {@link #filter}.
54009
55554
  *
54010
- * @returns A Promise that resolves with a {@link sap.ui.model.Filter} representing the entries with messages;
54011
- * it resolves with `null` if the binding is not resolved or if there is no message for any entry
55555
+ * @returns A Promise that resolves with an {@link sap.ui.model.Filter} representing the entries with messages,
55556
+ * except in the following cases:
55557
+ * If only transient entries have messages, it resolves with {@link sap.ui.model.Filter.NONE} If
55558
+ * the binding is not resolved or if there is no message for any entry, it resolves with `null`
54012
55559
  */
54013
55560
  requestFilterForMessages(
54014
55561
  /**
@@ -54806,6 +56353,13 @@ declare namespace sap {
54806
56353
  * Map of binding parameters
54807
56354
  */
54808
56355
  mParameters?: {
56356
+ /**
56357
+ * Whether the tree binding only requests transition messages from the back end. If messages for entities
56358
+ * of this collection need to be updated, use {@link sap.ui.model.odata.v2.ODataModel#read} on the parent
56359
+ * entity corresponding to the tree binding's context, with the parameter `updateAggregatedMessages` set
56360
+ * to `true`.
56361
+ */
56362
+ transitionMessagesOnly?: boolean;
54809
56363
  /**
54810
56364
  * The mapping between data properties and the hierarchy used to visualize the tree, if not provided by
54811
56365
  * the service's metadata. For the correct metadata annotations, check the "SAP Annotations for OData Version
@@ -55271,9 +56825,11 @@ declare namespace sap {
55271
56825
  */
55272
56826
  inactive?: boolean;
55273
56827
  /**
55274
- * An array that specifies a set of properties or the entry
56828
+ * The initial values of the entry, or an array that specifies a list of property names to be initialized
56829
+ * with `undefined`; **Note:** Passing a list of property names is deprecated since 1.120; pass the initial
56830
+ * values as an object instead
55275
56831
  */
55276
- properties?: any[] | object;
56832
+ properties?: object | string[];
55277
56833
  /**
55278
56834
  * Whether to update all bindings after submitting this change operation, see {@link #setRefreshAfterChange};
55279
56835
  * if given, this overrules the model-wide `refreshAfterChange` flag for this operation only; since 1.46
@@ -57851,10 +59407,10 @@ declare namespace sap {
57851
59407
  * depending on this context become unresolved, but no attempt is made to restore these bindings in case
57852
59408
  * of reset or failure.
57853
59409
  *
57854
- * Deleting a child node is supported (@experimental as of version 1.118.0) in a recursive hierarchy (see
57855
- * {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}). As a precondition, `oAggregation.expandTo`
57856
- * must be equal to one, and the context must not be {@link #setKeepAlive kept-alive} and hidden (for example
57857
- * due to a filter).
59410
+ * Deleting a node in a recursive hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation})
59411
+ * is supported (@experimental as of version 1.118.0). As a precondition, the context must not be {@link #setKeepAlive kept-alive }
59412
+ * and hidden (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
59413
+ * Such a deletion is not a pending change.
57858
59414
  * See:
57859
59415
  * #hasPendingChanges
57860
59416
  * #resetChanges
@@ -57981,6 +59537,17 @@ declare namespace sap {
57981
59537
  */
57982
59538
  sPath?: string
57983
59539
  ): any;
59540
+ /**
59541
+ * @experimental (since 1.120.0)
59542
+ *
59543
+ * Returns the parent node (in case of a recursive hierarchy, see {@link #setAggregation}, where `oAggregation.expandTo`
59544
+ * must be equal to one).
59545
+ * See:
59546
+ * #requestParent
59547
+ *
59548
+ * @returns The parent node, or `null` if this node is a root node and thus has no parent
59549
+ */
59550
+ getParent(): sap.ui.model.odata.v4.Context | null;
57984
59551
  /**
57985
59552
  * @since 1.39.0
57986
59553
  *
@@ -58027,6 +59594,20 @@ declare namespace sap {
58027
59594
  * @returns Whether there are pending changes
58028
59595
  */
58029
59596
  hasPendingChanges(): boolean;
59597
+ /**
59598
+ * @since 1.120.0
59599
+ *
59600
+ * Tells whether this node is an ancestor of (or the same as) the given node (in case of a recursive hierarchy,
59601
+ * see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
59602
+ *
59603
+ * @returns Whether the assumed ancestor relation holds
59604
+ */
59605
+ isAncestorOf(
59606
+ /**
59607
+ * Some node which may be a descendant
59608
+ */
59609
+ oNode: sap.ui.model.odata.v4.Context
59610
+ ): boolean;
58030
59611
  /**
58031
59612
  * @since 1.105.0
58032
59613
  *
@@ -58109,8 +59690,8 @@ declare namespace sap {
58109
59690
  /**
58110
59691
  * @experimental (since 1.119.0)
58111
59692
  *
58112
- * Moves this node to the given parent (in case of a recursive hierarchy, see {@link #setAggregation}, where
58113
- * `oAggregation.expandTo` must be one). No other {@link sap.ui.model.odata.v4.ODataListBinding#create creation},
59693
+ * Moves this node to the given parent (in case of a recursive hierarchy, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation},
59694
+ * where `oAggregation.expandTo` must be one). No other {@link sap.ui.model.odata.v4.ODataListBinding#create creation},
58114
59695
  * {@link #delete deletion}, or move must be pending, and no other modification (including collapse of some
58115
59696
  * ancestor node) must happen while this move is pending!
58116
59697
  *
@@ -58207,6 +59788,20 @@ declare namespace sap {
58207
59788
  */
58208
59789
  sPath?: string
58209
59790
  ): Promise<any>;
59791
+ /**
59792
+ * @experimental (since 1.120.0)
59793
+ *
59794
+ * Requests the parent node (in case of a recursive hierarchy, see {@link #setAggregation}, where `oAggregation.expandTo`
59795
+ * must be equal to one).
59796
+ * See:
59797
+ * #getParent
59798
+ *
59799
+ * @returns A promise which:
59800
+ * - Resolves if successful with either the parent node or `null` for a root node that has no parent
59801
+ *
59802
+ * - Rejects with an `Error` instance otherwise
59803
+ */
59804
+ requestParent(): Promise<sap.ui.model.odata.v4.Context | null>;
58210
59805
  /**
58211
59806
  * @since 1.39.0
58212
59807
  *
@@ -59207,11 +60802,12 @@ declare namespace sap {
59207
60802
  *
59208
60803
  * Creating a new child beneath an existing and visible parent node (which must either be a leaf or expanded,
59209
60804
  * but not collapsed) is supported (@experimental as of version 1.117.0) in case of a recursive hierarchy
59210
- * (see {@link #setAggregation}). The parent node must be identified via a {@link sap.ui.model.odata.v4.Context }
59211
- * instance given as `oInitialData["@$ui5.node.parent"]`. `oAggregation.expandTo` (see {@link #setAggregation})
59212
- * must be one, `bSkipRefresh` must be set, but both `bAtEnd` and `bInactive` must not be set. No other
59213
- * creation or {@link sap.ui.model.odata.v4.Context#move move} must be pending, and no other modification
59214
- * (including collapse of some ancestor node) must happen while this creation is pending!
60805
+ * (see {@link #setAggregation}). The parent node must be identified via an {@link sap.ui.model.odata.v4.Context }
60806
+ * instance given as `oInitialData["@$ui5.node.parent"]` (which is immediately removed from the new child's
60807
+ * data). It can be `null` or absent when creating a new root node (@experimental as of version 1.120.0).
60808
+ * `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 }
60809
+ * must be pending, and no other modification (including collapse of some ancestor node) must happen while
60810
+ * this creation is pending!
59215
60811
  *
59216
60812
  * @returns The context object for the created entity; its method {@link sap.ui.model.odata.v4.Context#created }
59217
60813
  * returns a promise that is resolved when the creation is finished
@@ -59874,7 +61470,8 @@ declare namespace sap {
59874
61470
  * The number (as a positive integer) of different levels initially available without calling {@link sap.ui.model.odata.v4.Context#expand }
59875
61471
  * (@experimental as of version 1.105.0; available for read-only hierarchies since 1.117.0), supported only
59876
61472
  * if a `hierarchyQualifier` is given. Root nodes are on the first level. By default, only root nodes are
59877
- * available; they are not yet expanded.
61473
+ * available; they are not yet expanded. Since 1.120.0, `Number.MAX_SAFE_INTEGER` can be used to expand
61474
+ * all levels.
59878
61475
  */
59879
61476
  expandTo?: number;
59880
61477
  /**
@@ -60939,7 +62536,7 @@ declare namespace sap {
60939
62536
  updateGroupId?: string;
60940
62537
  /**
60941
62538
  * Whether the XMLHttpRequest is called with `withCredentials`, so that user credentials are included in
60942
- * cross-origin requests by the browser (@experimental as of Version 1.117.0)
62539
+ * cross-origin requests by the browser (since 1.120.0)
60943
62540
  */
60944
62541
  withCredentials?: boolean;
60945
62542
  }
@@ -63200,19 +64797,23 @@ declare namespace sap {
63200
64797
  * `"{@i18n>...}"` to the hard-coded model name "@i18n" with arbitrary path are not turned into a fixed
63201
64798
  * text, but kept as a data binding expression; this allows local annotation files to refer to a resource
63202
64799
  * bundle for internationalization. the dynamic "14.5.1 Comparison and Logical Operators": These are
63203
- * turned into expression bindings to perform the operations at run-time. the dynamic "14.5.3 Expression
63204
- * edm:Apply":
64800
+ * turned into expression bindings to perform the operations at run-time. It's strongly recommended to require
64801
+ * the `sap.ui.model.odata.v4.ODataUtils` module in advance to avoid synchronous loading of this module.
64802
+ * the dynamic "14.5.3 Expression edm:Apply":
63205
64803
  * "14.5.3.1.1 Function odata.concat": This is turned into a data binding expression relative to an entity.
63206
64804
  * "14.5.3.1.2 Function odata.fillUriTemplate": This is turned into an expression binding to fill the
63207
- * template at run-time. "14.5.3.1.3 Function odata.uriEncode": This is turned into an expression binding
63208
- * to encode the parameter at run-time. Apply functions may be nested arbitrarily. the dynamic
63209
- * "14.5.6 Expression edm:If": This is turned into an expression binding to be evaluated at run-time. The
63210
- * expression is a conditional expression like `"{=condition ? expression1 : expression2}"`. the dynamic
63211
- * "14.5.10 Expression edm:Null": This is turned into a `null` value. In `odata.concat` it is ignored.
63212
- * the dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression edm:PropertyPath": This is turned into
63213
- * a data binding relative to an entity, including type information and constraints as available from metadata,
63214
- * e.g. `"{path : 'Name', type : 'sap.ui.model.odata.type.String', constraints : {'maxLength':'255'}}"`.
63215
- * Depending on the used type, some additional constraints of this type are set:
64805
+ * template at run-time. It's strongly recommended to require the `sap.ui.thirdparty.URITemplate` module
64806
+ * in advance to avoid synchronous loading of this module. "14.5.3.1.3 Function odata.uriEncode": This
64807
+ * is turned into an expression binding to encode the parameter at run-time. It's strongly recommended to
64808
+ * require the `sap.ui.model.odata.ODataUtils` module in advance to avoid synchronous loading of this module.
64809
+ * Apply functions may be nested arbitrarily. the dynamic "14.5.6 Expression edm:If": This
64810
+ * is turned into an expression binding to be evaluated at run-time. The expression is a conditional expression
64811
+ * like `"{=condition ? expression1 : expression2}"`. the dynamic "14.5.10 Expression edm:Null": This
64812
+ * is turned into a `null` value. In `odata.concat` it is ignored. the dynamic "14.5.12 Expression
64813
+ * edm:Path" and "14.5.13 Expression edm:PropertyPath": This is turned into a data binding relative to an
64814
+ * entity, including type information and constraints as available from metadata, e.g. `"{path : 'Name',
64815
+ * type : 'sap.ui.model.odata.type.String', constraints : {'maxLength':'255'}}"`. Depending on the used
64816
+ * type, some additional constraints of this type are set:
63216
64817
  * Edm.DateTime: The "displayFormat" constraint is set to the value of the "sap:display-format" annotation
63217
64818
  * of the referenced property. Edm.Decimal: The "precision" and "scale" constraints are set to the values
63218
64819
  * of the corresponding attributes of the referenced property. The "minimum", "maximum", "minimumExclusive"
@@ -70642,6 +72243,15 @@ declare namespace sap {
70642
72243
  */
70643
72244
  vValue2?: any
70644
72245
  );
72246
+ /**
72247
+ * @since 1.120.0
72248
+ *
72249
+ * A filter instance that is never fulfilled. When used to filter a list, no back-end request is sent and
72250
+ * only transient entries remain.
72251
+ *
72252
+ * **Note:** Not all model implementations support this filter.
72253
+ */
72254
+ static NONE: sap.ui.model.Filter;
70645
72255
 
70646
72256
  /**
70647
72257
  * Compares two values
@@ -80207,8 +81817,12 @@ declare namespace sap {
80207
81817
 
80208
81818
  "sap/base/assert": undefined;
80209
81819
 
81820
+ "sap/base/config": undefined;
81821
+
80210
81822
  "sap/base/Event": undefined;
80211
81823
 
81824
+ "sap/base/Eventing": undefined;
81825
+
80212
81826
  "sap/base/i18n/date/CalendarType": undefined;
80213
81827
 
80214
81828
  "sap/base/i18n/date/CalendarWeekNumbering": undefined;
@@ -80313,6 +81927,8 @@ declare namespace sap {
80313
81927
 
80314
81928
  "sap/ui/base/DataType": undefined;
80315
81929
 
81930
+ "sap/ui/base/DesignTime": undefined;
81931
+
80316
81932
  "sap/ui/base/Event": undefined;
80317
81933
 
80318
81934
  "sap/ui/base/EventProvider": undefined;
@@ -80507,6 +82123,8 @@ declare namespace sap {
80507
82123
 
80508
82124
  "sap/ui/core/Renderer": undefined;
80509
82125
 
82126
+ "sap/ui/core/Rendering": undefined;
82127
+
80510
82128
  "sap/ui/core/RenderManager": undefined;
80511
82129
 
80512
82130
  "sap/ui/core/ResizeHandler": undefined;
@@ -80551,6 +82169,8 @@ declare namespace sap {
80551
82169
 
80552
82170
  "sap/ui/core/support/usage/EventBroadcaster": undefined;
80553
82171
 
82172
+ "sap/ui/core/Supportability": undefined;
82173
+
80554
82174
  "sap/ui/core/syncStyleClass": undefined;
80555
82175
 
80556
82176
  "sap/ui/core/Theming": undefined;
@@ -80957,6 +82577,8 @@ declare namespace sap {
80957
82577
 
80958
82578
  "sap/ui/security/FrameOptions": undefined;
80959
82579
 
82580
+ "sap/ui/security/Security": undefined;
82581
+
80960
82582
  "sap/ui/test/actions/Action": undefined;
80961
82583
 
80962
82584
  "sap/ui/test/actions/Drag": undefined;
@@ -81040,6 +82662,8 @@ declare namespace sap {
81040
82662
  "sap/ui/util/XMLHelper": undefined;
81041
82663
 
81042
82664
  "sap/ui/VersionInfo": undefined;
82665
+
82666
+ "ui5loader-autoconfig": undefined;
81043
82667
  }
81044
82668
 
81045
82669
  type ClassInfo<T, C> = T & Partial<C> & ThisType<T & C>;