@openui5/ts-types 1.110.0 → 1.111.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.
@@ -266,7 +266,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
266
266
  ): jQuery;
267
267
  }
268
268
 
269
- // For Library Version: 1.110.0
269
+ // For Library Version: 1.111.1
270
270
 
271
271
  declare module "sap/base/assert" {
272
272
  /**
@@ -2351,6 +2351,581 @@ declare module "sap/ui/core/date/CalendarUtils" {
2351
2351
  export default CalendarUtils;
2352
2352
  }
2353
2353
 
2354
+ declare module "sap/ui/core/date/UI5Date" {
2355
+ /**
2356
+ * @SINCE 1.111.0
2357
+ *
2358
+ * A date implementation considering the configured time zone
2359
+ *
2360
+ * A subclass of JavaScript `Date` that considers the configured time zone, see {@link sap.ui.core.Configuration.getTimezone}.
2361
+ * All JavaScript `Date` functions that use the local browser time zone, like `getDate`, `setDate`, and
2362
+ * `toString`, are overwritten and use the configured time zone to compute the values.
2363
+ *
2364
+ * Use {@link module:sap/ui/core/date/UI5Date.getInstance} to create new date instances.
2365
+ */
2366
+ export default class UI5Date extends Date {
2367
+ constructor();
2368
+
2369
+ /**
2370
+ * Creates a date instance (either JavaScript Date or `UI5Date`) which considers the configured time zone
2371
+ * wherever JavaScript Date uses the local browser time zone, for example in `getDate`, `toString`, or `setHours`.
2372
+ * The supported parameters are the same as the ones supported by the JavaScript Date constructor.
2373
+ * See:
2374
+ * sap.ui.core.Configuration.getTimezone
2375
+ *
2376
+ * @returns The date instance that considers the configured time zone in all local getters and setters.
2377
+ */
2378
+ static getInstance(
2379
+ /**
2380
+ * Same meaning as in the JavaScript Date constructor
2381
+ */
2382
+ vYearOrValue?: int | string | Date | UI5Date | null,
2383
+ /**
2384
+ * Same meaning as in the JavaScript Date constructor
2385
+ */
2386
+ vMonthIndex?: int | string,
2387
+ /**
2388
+ * Same meaning as in the Date constructor
2389
+ */
2390
+ vDay?: int | string,
2391
+ /**
2392
+ * Same meaning as in the Date constructor
2393
+ */
2394
+ vHours?: int | string,
2395
+ /**
2396
+ * Same meaning as in the Date constructor
2397
+ */
2398
+ vMinutes?: int | string,
2399
+ /**
2400
+ * Same meaning as in the Date constructor
2401
+ */
2402
+ vSeconds?: int | string,
2403
+ /**
2404
+ * Same meaning as in the Date constructor
2405
+ */
2406
+ vMilliseconds?: int | string
2407
+ ): Date | UI5Date;
2408
+ /**
2409
+ * Returns the day of the month of this date instance according to the configured time zone, see `Date.prototype.getDate`.
2410
+ *
2411
+ * @returns A number between 1 and 31 representing the day of the month of this date instance according
2412
+ * to the configured time zone
2413
+ */
2414
+ getDate(): int;
2415
+ /**
2416
+ * Returns the day of the week of this date instance according to the configured time zone, see `Date.prototype.getDay`.
2417
+ *
2418
+ * @returns A number between 0 (Sunday) and 6 (Saturday) representing the day of the week of this date instance
2419
+ * according to the configured time zone
2420
+ */
2421
+ getDay(): int;
2422
+ /**
2423
+ * Returns the year of this date instance according to the configured time zone, see `Date.prototype.getFullYear`.
2424
+ *
2425
+ * @returns The year of this date instance according to the configured time zone
2426
+ */
2427
+ getFullYear(): int;
2428
+ /**
2429
+ * Returns the hours of this date instance according to the configured time zone, see `Date.prototype.getHours`.
2430
+ *
2431
+ * @returns A number between 0 and 23 representing the hours of this date instance according to the configured
2432
+ * time zone
2433
+ */
2434
+ getHours(): int;
2435
+ /**
2436
+ * Returns the milliseconds of this date instance according to the configured time zone, see `Date.prototype.getMilliseconds`.
2437
+ *
2438
+ * @returns A number between 0 and 999 representing the milliseconds of this date instance according to
2439
+ * the configured time zone
2440
+ */
2441
+ getMilliseconds(): int;
2442
+ /**
2443
+ * Returns the minutes of this date instance according to the configured time zone, see `Date.prototype.getMinutes`.
2444
+ *
2445
+ * @returns A number between 0 and 59 representing the minutes of this date instance according to the configured
2446
+ * time zone
2447
+ */
2448
+ getMinutes(): int;
2449
+ /**
2450
+ * Returns the month index of this date instance according to the configured time zone, see `Date.prototype.getMonth`.
2451
+ *
2452
+ * @returns The month index between 0 (January) and 11 (December) of this date instance according to the
2453
+ * configured time zone
2454
+ */
2455
+ getMonth(): int;
2456
+ /**
2457
+ * Returns the seconds of this date instance according to the configured time zone, see `Date.prototype.getSeconds`.
2458
+ *
2459
+ * @returns A number between 0 and 59 representing the seconds of this date instance according to the configured
2460
+ * time zone
2461
+ */
2462
+ getSeconds(): int;
2463
+ /**
2464
+ * Returns this date object to the given time represented by a number of milliseconds based on the UNIX
2465
+ * epoch, see `Date.prototype.getTime`.
2466
+ *
2467
+ * @returns The timestamp in milliseconds of this date based on the UNIX epoch, or `NaN` if the date is
2468
+ * an invalid date
2469
+ */
2470
+ getTime(): int;
2471
+ /**
2472
+ * Returns the difference in minutes between the UTC and the configured time zone for this date, see `Date.prototype.getTimezoneOffset`.
2473
+ *
2474
+ * @returns The difference in minutes between the UTC and the configured time zone for this date
2475
+ */
2476
+ getTimezoneOffset(): int;
2477
+ /**
2478
+ * Returns the day of the month of this date instance according to universal time, see `Date.prototype.getUTCDate`.
2479
+ *
2480
+ * @returns A number between 1 and 31 representing the day of the month of this date instance according
2481
+ * to universal time
2482
+ */
2483
+ getUTCDate(): int;
2484
+ /**
2485
+ * Returns the day of the week of this date instance according to universal time, see `Date.prototype.getUTCDay`.
2486
+ *
2487
+ * @returns A number between 0 (Sunday) and 6 (Saturday) representing the day of the week of this date instance
2488
+ * according to universal time
2489
+ */
2490
+ getUTCDay(): int;
2491
+ /**
2492
+ * Returns the year of this date instance according to universal time, see `Date.prototype.getUTCFullYear`.
2493
+ *
2494
+ * @returns The year of this date instance according to universal time
2495
+ */
2496
+ getUTCFullYear(): int;
2497
+ /**
2498
+ * Returns the hours of this date instance according to universal time, see `Date.prototype.getUTCHours`.
2499
+ *
2500
+ * @returns A number between 0 and 23 representing the hours of this date instance according to universal
2501
+ * time
2502
+ */
2503
+ getUTCHours(): int;
2504
+ /**
2505
+ * Returns the milliseconds of this date instance according to universal time, see `Date.prototype.getUTCMilliseconds`.
2506
+ *
2507
+ * @returns A number between 0 and 999 representing the milliseconds of this date instance according to
2508
+ * universal time
2509
+ */
2510
+ getUTCMilliseconds(): int;
2511
+ /**
2512
+ * Returns the minutes of this date instance according to universal time, see `Date.prototype.getUTCMinutes`.
2513
+ *
2514
+ * @returns A number between 0 and 59 representing the minutes of this date instance according to universal
2515
+ * time
2516
+ */
2517
+ getUTCMinutes(): int;
2518
+ /**
2519
+ * Returns the month index of this date instance according to universal time, see `Date.prototype.getUTCMonth`.
2520
+ *
2521
+ * @returns The month index between 0 (January) and 11 (December) of this date instance according to universal
2522
+ * time
2523
+ */
2524
+ getUTCMonth(): int;
2525
+ /**
2526
+ * Returns the seconds of this date instance according to universal time, see `Date.prototype.getUTCSeconds`.
2527
+ *
2528
+ * @returns A number between 0 and 59 representing the seconds of this date instance according to universal
2529
+ * time
2530
+ */
2531
+ getUTCSeconds(): int;
2532
+ /**
2533
+ * @deprecated (since 1.111.0) - as it is deprecated in JavaScript Date; use {@link #getFullYear} instead
2534
+ *
2535
+ * Returns the year of this date instance minus 1900 according to the configured time zone, see `Date.prototype.getYear`.
2536
+ *
2537
+ * @returns The year of this date instance minus 1900 according to the configured time zone
2538
+ */
2539
+ getYear(): int;
2540
+ /**
2541
+ * Sets the day of the month for this date instance considering the configured time zone, see `Date.prototype.setDate`.
2542
+ *
2543
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2544
+ * not be updated
2545
+ */
2546
+ setDate(
2547
+ /**
2548
+ * An integer representing the new day value, see `Date.prototype.setDate`
2549
+ */
2550
+ iDay: int
2551
+ ): int;
2552
+ /**
2553
+ * Sets the year, month and day for this date instance considering the configured time zone, see `Date.prototype.setFullYear`.
2554
+ *
2555
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2556
+ * not be updated
2557
+ */
2558
+ setFullYear(
2559
+ /**
2560
+ * An integer representing the new year value
2561
+ */
2562
+ iYear: int,
2563
+ /**
2564
+ * An integer representing the new month index
2565
+ */
2566
+ iMonth?: int,
2567
+ /**
2568
+ * An integer representing the new day value
2569
+ */
2570
+ iDay?: int
2571
+ ): int;
2572
+ /**
2573
+ * Sets the hours, minutes, seconds and milliseconds for this date instance considering the configured time
2574
+ * zone, see `Date.prototype.setHours`.
2575
+ *
2576
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2577
+ * not be updated
2578
+ */
2579
+ setHours(
2580
+ /**
2581
+ * An integer representing the new hour value
2582
+ */
2583
+ iHours: int,
2584
+ /**
2585
+ * An integer representing the new minutes value
2586
+ */
2587
+ iMinutes?: int,
2588
+ /**
2589
+ * An integer representing the new seconds value
2590
+ */
2591
+ iSeconds?: int,
2592
+ /**
2593
+ * An integer representing the new milliseconds value
2594
+ */
2595
+ iMilliseconds?: int
2596
+ ): int;
2597
+ /**
2598
+ * Sets the milliseconds for this date instance considering the configured time zone, see `Date.prototype.setMilliseconds`.
2599
+ *
2600
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2601
+ * not be updated
2602
+ */
2603
+ setMilliseconds(
2604
+ /**
2605
+ * An integer representing the new milliseconds value
2606
+ */
2607
+ iMilliseconds: int
2608
+ ): int;
2609
+ /**
2610
+ * Sets the minutes, seconds and milliseconds for this date instance considering the configured time zone,
2611
+ * see `Date.prototype.setMinutes`.
2612
+ *
2613
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2614
+ * not be updated
2615
+ */
2616
+ setMinutes(
2617
+ /**
2618
+ * An integer representing the new minutes value
2619
+ */
2620
+ iMinutes: int,
2621
+ /**
2622
+ * An integer representing the new seconds value
2623
+ */
2624
+ iSeconds?: int,
2625
+ /**
2626
+ * An integer representing the new milliseconds value
2627
+ */
2628
+ iMilliseconds?: int
2629
+ ): int;
2630
+ /**
2631
+ * Sets the month and day for this date instance considering the configured time zone, see `Date.prototype.setMonth`.
2632
+ *
2633
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2634
+ * not be updated
2635
+ */
2636
+ setMonth(
2637
+ /**
2638
+ * An integer representing the new month index
2639
+ */
2640
+ iMonth: int,
2641
+ /**
2642
+ * An integer representing the new day value
2643
+ */
2644
+ iDay?: int
2645
+ ): int;
2646
+ /**
2647
+ * Sets the seconds and milliseconds for this date instance considering the configured time zone, see `Date.prototype.setSeconds`.
2648
+ *
2649
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2650
+ * not be updated
2651
+ */
2652
+ setSeconds(
2653
+ /**
2654
+ * An integer representing the new seconds value
2655
+ */
2656
+ iSeconds: int,
2657
+ /**
2658
+ * An integer representing the new milliseconds value
2659
+ */
2660
+ iMilliseconds?: int
2661
+ ): int;
2662
+ /**
2663
+ * Sets this date object to the given time represented by a number of milliseconds based on the UNIX epoch
2664
+ * and resets the previously set date parts, see `Date.prototype.setTime`.
2665
+ *
2666
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2667
+ * not be updated
2668
+ */
2669
+ setTime(
2670
+ /**
2671
+ * The date time in milliseconds based in the UNIX epoch
2672
+ */
2673
+ iTime: int
2674
+ ): int;
2675
+ /**
2676
+ * Sets the day of the month for this date instance according to universal time, see `Date.prototype.setUTCDate`.
2677
+ *
2678
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2679
+ * not be updated
2680
+ */
2681
+ setUTCDate(
2682
+ /**
2683
+ * An integer representing the new day value, see `Date.prototype.setUTCDate`
2684
+ */
2685
+ iDay: int
2686
+ ): int;
2687
+ /**
2688
+ * Sets the year, month and day for this date instance according to universal time, see `Date.prototype.setUTCFullYear`.
2689
+ *
2690
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2691
+ * not be updated
2692
+ */
2693
+ setUTCFullYear(
2694
+ /**
2695
+ * An integer representing the new year value
2696
+ */
2697
+ iYear: int,
2698
+ /**
2699
+ * An integer representing the new month index
2700
+ */
2701
+ iMonth?: int,
2702
+ /**
2703
+ * An integer representing the new day value
2704
+ */
2705
+ iDay?: int
2706
+ ): int;
2707
+ /**
2708
+ * Sets the hours, minutes, seconds and milliseconds for this date instance according to universal time,
2709
+ * see `Date.prototype.setUTCHours`.
2710
+ *
2711
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2712
+ * not be updated
2713
+ */
2714
+ setUTCHours(
2715
+ /**
2716
+ * An integer representing the new hour value
2717
+ */
2718
+ iHours: int,
2719
+ /**
2720
+ * An integer representing the new minutes value
2721
+ */
2722
+ iMinutes?: int,
2723
+ /**
2724
+ * An integer representing the new seconds value
2725
+ */
2726
+ iSeconds?: int,
2727
+ /**
2728
+ * An integer representing the new milliseconds value
2729
+ */
2730
+ iMilliseconds?: int
2731
+ ): int;
2732
+ /**
2733
+ * Sets the milliseconds for this date instance according to universal time, see `Date.prototype.setUTCMilliseconds`.
2734
+ *
2735
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2736
+ * not be updated
2737
+ */
2738
+ setUTCMilliseconds(
2739
+ /**
2740
+ * An integer representing the new milliseconds value
2741
+ */
2742
+ iMilliseconds: int
2743
+ ): int;
2744
+ /**
2745
+ * Sets the minutes, seconds and milliseconds for this date instance according to universal time, see `Date.prototype.setUTCMinutes`.
2746
+ *
2747
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2748
+ * not be updated
2749
+ */
2750
+ setUTCMinutes(
2751
+ /**
2752
+ * An integer representing the new minutes value
2753
+ */
2754
+ iMinutes: int,
2755
+ /**
2756
+ * An integer representing the new seconds value
2757
+ */
2758
+ iSeconds?: int,
2759
+ /**
2760
+ * An integer representing the new milliseconds value
2761
+ */
2762
+ iMilliseconds?: int
2763
+ ): int;
2764
+ /**
2765
+ * Sets the month and day for this date instance according to universal time, see `Date.prototype.setUTCMonth`.
2766
+ *
2767
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2768
+ * not be updated
2769
+ */
2770
+ setUTCMonth(
2771
+ /**
2772
+ * An integer representing the new month index
2773
+ */
2774
+ iMonth: int,
2775
+ /**
2776
+ * An integer representing the new day value
2777
+ */
2778
+ iDay?: int
2779
+ ): int;
2780
+ /**
2781
+ * Sets the seconds and milliseconds for this date instance according to universal time, see `Date.prototype.setUTCSeconds`.
2782
+ *
2783
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2784
+ * not be updated
2785
+ */
2786
+ setUTCSeconds(
2787
+ /**
2788
+ * An integer representing the new seconds value
2789
+ */
2790
+ iSeconds: int,
2791
+ /**
2792
+ * An integer representing the new milliseconds value
2793
+ */
2794
+ iMilliseconds?: int
2795
+ ): int;
2796
+ /**
2797
+ * @deprecated (since 1.111.0) - as it is deprecated in JavaScript Date; use {@link #setFullYear} instead
2798
+ *
2799
+ * Sets the year for this date instance plus 1900 considering the configured time zone, see `Date.prototype.setYear`.
2800
+ *
2801
+ * @returns The milliseconds of the new timestamp based on the UNIX epoch, or `NaN` if the timestamp could
2802
+ * not be updated
2803
+ */
2804
+ setYear(
2805
+ /**
2806
+ * The year which is to be set for this date plus 1900
2807
+ */
2808
+ iYear: int
2809
+ ): int;
2810
+ /**
2811
+ * Returns the date portion of this date object interpreted in the configured time zone in English, see
2812
+ * `Date.prototype.toDateString`.
2813
+ *
2814
+ * @returns The date portion of this date object interpreted in the configured time zone in English
2815
+ */
2816
+ toDateString(): string;
2817
+ /**
2818
+ * Converts this date to a string, interpreting it in the UTC time zone, see `Date.prototype.toGMTString`.
2819
+ *
2820
+ * @returns The converted date as string in the UTC time zone
2821
+ */
2822
+ toGMTString(): string;
2823
+ /**
2824
+ * Converts this date to a string in ISO format in the UTC offset zero time zone, as denoted by the suffix
2825
+ * `Z`, see `Date.prototype.toISOString`.
2826
+ *
2827
+ * @returns The converted date as a string in ISO format, in the UTC offset zero time zone
2828
+ */
2829
+ toISOString(): string;
2830
+ /**
2831
+ * Returns a string representation of this date object, see `Date.prototype.toJSON`.
2832
+ *
2833
+ * @returns The date object representation as a string
2834
+ */
2835
+ toJSON(): string;
2836
+ /**
2837
+ * Returns a string with a language-dependent representation of the date part of this date object interpreted
2838
+ * by default in the configured time zone, see `Date.prototype.toLocaleDateString`.
2839
+ *
2840
+ * @returns The language-dependent representation of the date part of this date object
2841
+ */
2842
+ toLocaleDateString(
2843
+ /**
2844
+ * The locale used for formatting; the configured locale by default
2845
+ */
2846
+ sLocale?: string,
2847
+ /**
2848
+ * The options object used for formatting, corresponding to the options parameter of the `Intl.DateTimeFormat`
2849
+ * constructor
2850
+ */
2851
+ oOptions?: {
2852
+ /**
2853
+ * The IANA time zone ID; the configured time zone by default
2854
+ */
2855
+ timeZone?: string;
2856
+ }
2857
+ ): string;
2858
+ /**
2859
+ * Returns a string with a language-dependent representation of this date object interpreted by default
2860
+ * in the configured time zone, see `Date.prototype.toLocaleString`.
2861
+ *
2862
+ * @returns The language-dependent representation of this date object
2863
+ */
2864
+ toLocaleString(
2865
+ /**
2866
+ * The locale used for formatting; the configured locale by default
2867
+ */
2868
+ sLocale?: string,
2869
+ /**
2870
+ * The options object used for formatting, corresponding to the options parameter of the `Intl.DateTimeFormat`
2871
+ * constructor
2872
+ */
2873
+ oOptions?: {
2874
+ /**
2875
+ * The IANA time zone ID; the configured time zone by default
2876
+ */
2877
+ timeZone?: string;
2878
+ }
2879
+ ): string;
2880
+ /**
2881
+ * Returns a string with a language-dependent representation of the time part of this date object interpreted
2882
+ * by default in the configured time zone, see `Date.prototype.toLocaleTimeString`.
2883
+ *
2884
+ * @returns The language-dependent representation of the time part of this date object
2885
+ */
2886
+ toLocaleTimeString(
2887
+ /**
2888
+ * The locale used for formatting; the configured locale by default
2889
+ */
2890
+ sLocale?: string,
2891
+ /**
2892
+ * The options object used for formatting, corresponding to the options parameter of the `Intl.DateTimeFormat`
2893
+ * constructor
2894
+ */
2895
+ oOptions?: {
2896
+ /**
2897
+ * The IANA time zone ID; the configured time zone by default
2898
+ */
2899
+ timeZone?: string;
2900
+ }
2901
+ ): string;
2902
+ /**
2903
+ * Returns a string representing this date object interpreted in the configured time zone.
2904
+ *
2905
+ * @returns A string representing this date object interpreted in the configured time zone
2906
+ */
2907
+ toString(): string;
2908
+ /**
2909
+ * Returns the time portion of this date object interpreted in the configured time zone in English.
2910
+ *
2911
+ * @returns The time portion of this date object interpreted in the configured time zone in English
2912
+ */
2913
+ toTimeString(): string;
2914
+ /**
2915
+ * Converts this date to a string, interpreting it in the UTC time zone, see `Date.prototype.toUTCString`.
2916
+ *
2917
+ * @returns The converted date as a string in the UTC time zone
2918
+ */
2919
+ toUTCString(): string;
2920
+ /**
2921
+ * Returns the value of this date object in milliseconds based on the UNIX epoch, see `Date.prototype.valueOf`.
2922
+ *
2923
+ * @returns The primitive value of this date object in milliseconds based on the UNIX epoch
2924
+ */
2925
+ valueOf(): int;
2926
+ }
2927
+ }
2928
+
2354
2929
  declare module "sap/ui/core/InvisibleRenderer" {
2355
2930
  /**
2356
2931
  * @SINCE 1.66.0
@@ -13558,6 +14133,17 @@ declare namespace sap {
13558
14133
  */
13559
14134
  oLocale?: sap.ui.core.Locale
13560
14135
  ): sap.ui.core.format.DateFormat;
14136
+ /**
14137
+ * Get a date instance of the DateFormat, which can be used for formatting.
14138
+ *
14139
+ * @returns date instance of the DateFormat
14140
+ */
14141
+ static getDateInstance(
14142
+ /**
14143
+ * Locale to ask for locale specific texts/settings
14144
+ */
14145
+ oLocale?: sap.ui.core.Locale
14146
+ ): sap.ui.core.format.DateFormat;
13561
14147
  /**
13562
14148
  * Get a datetime instance of the DateFormat, which can be used for formatting.
13563
14149
  *
@@ -13653,6 +14239,17 @@ declare namespace sap {
13653
14239
  */
13654
14240
  oLocale?: sap.ui.core.Locale
13655
14241
  ): sap.ui.core.format.DateFormat;
14242
+ /**
14243
+ * Get a datetime instance of the DateFormat, which can be used for formatting.
14244
+ *
14245
+ * @returns datetime instance of the DateFormat
14246
+ */
14247
+ static getDateTimeInstance(
14248
+ /**
14249
+ * Locale to ask for locale specific texts/settings
14250
+ */
14251
+ oLocale?: sap.ui.core.Locale
14252
+ ): sap.ui.core.format.DateFormat;
13656
14253
  /**
13657
14254
  * @SINCE 1.99.0
13658
14255
  *
@@ -13749,6 +14346,19 @@ declare namespace sap {
13749
14346
  */
13750
14347
  oLocale?: sap.ui.core.Locale
13751
14348
  ): sap.ui.core.format.DateFormat.DateTimeWithTimezone;
14349
+ /**
14350
+ * @SINCE 1.99.0
14351
+ *
14352
+ * Get a datetimeWithTimezone instance of the DateFormat, which can be used for formatting.
14353
+ *
14354
+ * @returns dateTimeWithTimezone instance of the DateFormat
14355
+ */
14356
+ static getDateTimeWithTimezoneInstance(
14357
+ /**
14358
+ * Locale to ask for locale-specific texts/settings
14359
+ */
14360
+ oLocale?: sap.ui.core.Locale
14361
+ ): sap.ui.core.format.DateFormat.DateTimeWithTimezone;
13752
14362
  /**
13753
14363
  * Get a time instance of the DateFormat, which can be used for formatting.
13754
14364
  *
@@ -13842,6 +14452,17 @@ declare namespace sap {
13842
14452
  */
13843
14453
  oLocale?: sap.ui.core.Locale
13844
14454
  ): sap.ui.core.format.DateFormat;
14455
+ /**
14456
+ * Get a time instance of the DateFormat, which can be used for formatting.
14457
+ *
14458
+ * @returns time instance of the DateFormat
14459
+ */
14460
+ static getTimeInstance(
14461
+ /**
14462
+ * Locale to ask for locale specific texts/settings
14463
+ */
14464
+ oLocale?: sap.ui.core.Locale
14465
+ ): sap.ui.core.format.DateFormat;
13845
14466
  /**
13846
14467
  * Format a date according to the given format options.
13847
14468
  *
@@ -13882,12 +14503,16 @@ declare namespace sap {
13882
14503
  /**
13883
14504
  * whether to use UTC
13884
14505
  */
13885
- bUTC: boolean,
14506
+ bUTC?: boolean,
13886
14507
  /**
13887
14508
  * whether to use strict value check
13888
14509
  */
13889
- bStrict: boolean
13890
- ): Date | Date[];
14510
+ bStrict?: boolean
14511
+ ):
14512
+ | Date
14513
+ | Date[]
14514
+ | import("sap/ui/core/date/UI5Date").default
14515
+ | Array<import("sap/ui/core/date/UI5Date").default>;
13891
14516
  }
13892
14517
  /**
13893
14518
  * The FileSizeFormat is a static class for formatting and parsing numeric file size values according to
@@ -13950,6 +14575,20 @@ declare namespace sap {
13950
14575
  */
13951
14576
  oLocale?: sap.ui.core.Locale
13952
14577
  ): sap.ui.core.format.FileSizeFormat;
14578
+ /**
14579
+ * Get an instance of the FileSizeFormat, which can be used for formatting.
14580
+ *
14581
+ * If no locale is given, the currently configured {@link sap.ui.core.Configuration.FormatSettings#getFormatLocale
14582
+ * formatLocale} will be used.
14583
+ *
14584
+ * @returns instance of the FileSizeFormat
14585
+ */
14586
+ static getInstance(
14587
+ /**
14588
+ * The locale to get the formatter for
14589
+ */
14590
+ oLocale?: sap.ui.core.Locale
14591
+ ): sap.ui.core.format.FileSizeFormat;
13953
14592
  /**
13954
14593
  * Returns a metadata object for class sap.ui.core.format.FileSizeFormat.
13955
14594
  *
@@ -14001,6 +14640,17 @@ declare namespace sap {
14001
14640
  */
14002
14641
  oLocale?: sap.ui.core.Locale
14003
14642
  ): sap.ui.core.format.ListFormat;
14643
+ /**
14644
+ * Get an instance of the ListFormat which can be used for formatting.
14645
+ *
14646
+ * @returns Instance of the ListFormat
14647
+ */
14648
+ static getInstance(
14649
+ /**
14650
+ * Locale to get the formatter for
14651
+ */
14652
+ oLocale?: sap.ui.core.Locale
14653
+ ): sap.ui.core.format.ListFormat;
14004
14654
  /**
14005
14655
  * Formats a list according to the given format options.
14006
14656
  *
@@ -20677,6 +21327,56 @@ declare namespace sap {
20677
21327
  */
20678
21328
  bReplace?: boolean
20679
21329
  ): this;
21330
+ /**
21331
+ * Navigates to a specific route defining a set of parameters.
21332
+ *
21333
+ * The parameters will be URI encoded - the characters ; , / ? : @ & = + $ are reserved and will not be
21334
+ * encoded. If you want to use special characters in your `oParameters`, you have to encode them (encodeURIComponent).
21335
+ *
21336
+ * If the given route name can't be found, an error message is logged to the console and the hash will be
21337
+ * changed to the empty string.
21338
+ *
21339
+ * This method excecutes following steps: 1. Interpolates the pattern with the given parameters 2. Sets
21340
+ * the interpolated pattern to the browser's hash 3. Reacts to the browser's `hashchange` event to find
21341
+ * out the route which matches the hash
21342
+ *
21343
+ * If there are multiple routes that have the same pattern, the call of navTo with a specific route won't
21344
+ * necessarily trigger the matching process of this route. In the end, the first route in the router configuration
21345
+ * list that matches the browser hash will be chosen.
21346
+ *
21347
+ * If the browser hash is already set with the interpolated pattern from the navTo call, nothing will happen
21348
+ * because the browser won't fire `hashchange` event in this case.
21349
+ *
21350
+ * @returns this for chaining.
21351
+ */
21352
+ navTo(
21353
+ /**
21354
+ * The name of the route
21355
+ */
21356
+ sName: string,
21357
+ /**
21358
+ * The parameters for the route. As of Version 1.75 the recommendation is naming the query parameter with
21359
+ * a leading "?" character, which is identical to the definition in the route's pattern. The old syntax
21360
+ * without a leading "?" character is deprecated. e.g. **Route:** `{parameterName1}/:parameterName2:/{?queryParameterName}`
21361
+ * **Parameter:**
21362
+ * ```javascript
21363
+ *
21364
+ * {
21365
+ * parameterName1: "parameterValue1",
21366
+ * parameterName2: "parameterValue2",
21367
+ * "?queryParameterName": {
21368
+ * queryParameterName1: "queryParameterValue1"
21369
+ * }
21370
+ * }
21371
+ * ```
21372
+ */
21373
+ oParameters?: object,
21374
+ /**
21375
+ * If set to `true`, the hash is replaced, and there will be no entry in the browser history. If set to
21376
+ * `false`, the hash is set and the entry is stored in the browser history.
21377
+ */
21378
+ bReplace?: boolean
21379
+ ): this;
20680
21380
  /**
20681
21381
  * Will trigger routing events + place targets for routes matching the string.
20682
21382
  */
@@ -23994,6 +24694,43 @@ declare namespace sap {
23994
24694
  */
23995
24695
  sPath?: string
23996
24696
  ): sap.ui.core.util.XMLPreprocessor.IContext;
24697
+ /**
24698
+ * @SINCE 1.31.0
24699
+ *
24700
+ * Returns a context interface for the indicated part in case of the root formatter of a composite binding.
24701
+ * The new interface provides access to the original settings, but only to the model and path of the indicated
24702
+ * part:
24703
+ * ```javascript
24704
+ *
24705
+ * this.getInterface(i).getSetting(sName) === this.getSetting(sName);
24706
+ * this.getInterface(i).getModel() === this.getModel(i);
24707
+ * this.getInterface(i).getPath() === this.getPath(i);
24708
+ * ```
24709
+ *
24710
+ *
24711
+ * If a path is given, the new interface points to the resolved path as follows:
24712
+ * ```javascript
24713
+ *
24714
+ * this.getInterface(i, "foo/bar").getPath() === this.getPath(i) + "/foo/bar";
24715
+ * this.getInterface(i, "/absolute/path").getPath() === "/absolute/path";
24716
+ * ```
24717
+ * A formatter which is not at the root level of a composite binding can also provide a path, but must
24718
+ * not provide an index:
24719
+ * ```javascript
24720
+ *
24721
+ * this.getInterface("foo/bar").getPath() === this.getPath() + "/foo/bar";
24722
+ * this.getInterface("/absolute/path").getPath() === "/absolute/path";
24723
+ * ```
24724
+ * Note that at least one argument must be present.
24725
+ *
24726
+ * @returns the context interface related to the indicated part
24727
+ */
24728
+ getInterface(
24729
+ /**
24730
+ * a path, interpreted relative to `this.getPath(iPart)`
24731
+ */
24732
+ sPath?: string
24733
+ ): sap.ui.core.util.XMLPreprocessor.IContext;
23997
24734
  /**
23998
24735
  * Returns the model related to the current formatter call.
23999
24736
  *
@@ -25854,6 +26591,17 @@ declare namespace sap {
25854
26591
  */
25855
26592
  sReason?: string
25856
26593
  ): this;
26594
+ /**
26595
+ * Closes the connection.
26596
+ *
26597
+ * @returns Reference to `this` in order to allow method chaining
26598
+ */
26599
+ close(
26600
+ /**
26601
+ * Closing reason as a string
26602
+ */
26603
+ sReason?: string
26604
+ ): this;
25857
26605
  /**
25858
26606
  * Detaches event handler `fnFunction` from the {@link #event:close close} event of this `sap.ui.core.ws.WebSocket`.
25859
26607
  *
@@ -28802,6 +29550,52 @@ declare namespace sap {
28802
29550
  | import("sap/base/i18n/ResourceBundle").default
28803
29551
  | undefined
28804
29552
  | Promise<import("sap/base/i18n/ResourceBundle").default | undefined>;
29553
+ /**
29554
+ * Retrieves a resource bundle for the given library and locale.
29555
+ *
29556
+ * If only one argument is given, it is assumed to be the libraryName. The locale then falls back to the
29557
+ * current {@link sap.ui.core.Configuration#getLanguage session locale}. If no argument is given, the library
29558
+ * also falls back to a default: "sap.ui.core".
29559
+ *
29560
+ * Configuration via App Descriptor: When the App Descriptor for the library is available without further
29561
+ * request (manifest.json has been preloaded) and when the App Descriptor is at least of version 1.9.0 or
29562
+ * higher, then this method will evaluate the App Descriptor entry `"sap.ui5" / "library" / "i18n"`.
29563
+ *
29564
+ * - When the entry is `true`, a bundle with the default name "messagebundle.properties" will be loaded
29565
+ *
29566
+ * - If it is a string, then that string will be used as name of the bundle
29567
+ * - If it is `false`, no bundle will be loaded and the result will be `undefined`
29568
+ *
29569
+ * Caching: Once a resource bundle for a library has been loaded, it will be cached by this method. Further
29570
+ * calls for the same library and locale won't create new requests, but return the already loaded bundle.
29571
+ * There's therefore no need for control code to cache the returned bundle for a longer period of time.
29572
+ * Not further caching the result also prevents stale texts after a locale change.
29573
+ *
29574
+ * Asynchronous Loading: The asynchronous variant of {@link #loadLibrary} will evaluate the same descriptor
29575
+ * entry as described above. If it is not `false`, loading the main resource bundle of the library will
29576
+ * become a subtask of the asynchronous loading of the library.
29577
+ *
29578
+ * Due to this preload of the main bundle and the caching behavior of this method, controls in such a library
29579
+ * still can use the synchronous variant of `getLibraryResourceBundle` in their API, behavior and rendering
29580
+ * code. Only when the bundle is needed at module execution time (by top level code in a control module),
29581
+ * then the asynchronous variant of this method should be preferred.
29582
+ *
29583
+ * @returns The best matching resource bundle for the given parameters or `undefined`; in asynchronous case
29584
+ * a Promise on that bundle is returned
29585
+ */
29586
+ getLibraryResourceBundle(
29587
+ /**
29588
+ * Name of the library to retrieve the bundle for
29589
+ */
29590
+ sLibraryName?: string,
29591
+ /**
29592
+ * Whether the resource bundle is loaded asynchronously
29593
+ */
29594
+ bAsync?: boolean
29595
+ ):
29596
+ | import("sap/base/i18n/ResourceBundle").default
29597
+ | undefined
29598
+ | Promise<import("sap/base/i18n/ResourceBundle").default | undefined>;
28805
29599
  /**
28806
29600
  * Returns a map of library info objects for all currently loaded libraries, keyed by their names.
28807
29601
  *
@@ -31999,11 +32793,11 @@ declare namespace sap {
31999
32793
  /**
32000
32794
  * A string containing one or more JavaScript event types, such as "click" or "blur".
32001
32795
  */
32002
- sEventType?: string,
32796
+ sEventType: string,
32003
32797
  /**
32004
32798
  * A function to execute each time the event is triggered.
32005
32799
  */
32006
- fnHandler?: Function,
32800
+ fnHandler: Function,
32007
32801
  /**
32008
32802
  * The object, that wants to be notified, when the event occurs
32009
32803
  */
@@ -32104,11 +32898,11 @@ declare namespace sap {
32104
32898
  /**
32105
32899
  * A string containing one or more JavaScript event types, such as "click" or "blur".
32106
32900
  */
32107
- sEventType?: string,
32901
+ sEventType: string,
32108
32902
  /**
32109
32903
  * The function that is to be no longer executed.
32110
32904
  */
32111
- fnHandler?: Function,
32905
+ fnHandler: Function,
32112
32906
  /**
32113
32907
  * The context object that was given in the call to `attachBrowserEvent`.
32114
32908
  */
@@ -33074,6 +33868,11 @@ declare namespace sap {
33074
33868
  * See {@link topic:bdf3e9818cd84d37a18ee5680e97e1c1 Event Handler Methods} for a general explanation of
33075
33869
  * event handling in controls.
33076
33870
  *
33871
+ * **Note:** Setting the special `canSkipRendering` property to `true` for the event delegate object itself
33872
+ * lets the framework know that the `onBeforeRendering` and `onAfterRendering` event handlers of the delegate
33873
+ * are compatible with the contract of {@link sap.ui.core.RenderManager Renderer.apiVersion 4}. See example
33874
+ * "Adding a rendering delegate...".
33875
+ *
33077
33876
  * @returns Returns `this` to allow method chaining
33078
33877
  */
33079
33878
  addEventDelegate(
@@ -33280,6 +34079,10 @@ declare namespace sap {
33280
34079
  * This function is called by the RenderManager's {@link sap.ui.core.RenderManager#accessibilityState accessibilityState}
33281
34080
  * and {@link sap.ui.core.RenderManager#writeAccessibilityState writeAccessibilityState} methods for the
33282
34081
  * parent of the currently rendered control - if the parent implements it.
34082
+ *
34083
+ * **Note:** Setting the special `canSkipRendering` property of the `mAriaProps` parameter to `true` lets
34084
+ * the `RenderManager` know that the accessibility enhancement is static and does not interfere with the
34085
+ * child control's {@link sap.ui.core.RenderManager Renderer.apiVersion 4} rendering optimization.
33283
34086
  */
33284
34087
  enhanceAccessibilityState(
33285
34088
  /**
@@ -38194,6 +38997,57 @@ declare namespace sap {
38194
38997
  */
38195
38998
  followOf?: boolean | Function | null
38196
38999
  ): void;
39000
+ /**
39001
+ * Opens the popup's content at the position either specified here or beforehand via {@link #setPosition}.
39002
+ * Content must be capable of being positioned via "position:absolute;" All parameters are optional (open()
39003
+ * may be called without any parameters). iDuration may just be omitted, but if any of "at", "of", "offset",
39004
+ * "collision" is given, also the preceding positional parameters ("my", at",...) must be given.
39005
+ *
39006
+ * If the Popup's OpenState is different from "CLOSED" (i.e. if the Popup is already open, opening or closing),
39007
+ * the call is ignored.
39008
+ */
39009
+ open(
39010
+ /**
39011
+ * the popup content's reference position for docking
39012
+ */
39013
+ my?: sap.ui.core.Popup.Dock,
39014
+ /**
39015
+ * the "of" element's reference point for docking to
39016
+ */
39017
+ at?: sap.ui.core.Popup.Dock,
39018
+ /**
39019
+ * specifies the reference element to which the given content should dock to
39020
+ */
39021
+ of?:
39022
+ | string
39023
+ | sap.ui.core.Element
39024
+ | /* was Element */ global_Element
39025
+ | jQuery
39026
+ | jQuery.Event,
39027
+ /**
39028
+ * the offset relative to the docking point, specified as a string with space-separated pixel values (e.g.
39029
+ * "10 0" to move the popup 10 pixels to the right). If the docking of both "my" and "at" are both RTL-sensitive
39030
+ * ("begin" or "end"), this offset is automatically mirrored in the RTL case as well.
39031
+ */
39032
+ offset?: string,
39033
+ /**
39034
+ * defines how the position of an element should be adjusted in case it overflows the within area in some
39035
+ * direction.
39036
+ */
39037
+ collision?: sap.ui.core.Collision,
39038
+ /**
39039
+ * defines the area the popup should be placed in. This affects the collision detection.
39040
+ */
39041
+ within?:
39042
+ | string
39043
+ | sap.ui.core.Element
39044
+ | /* was Element */ global_Element
39045
+ | Window,
39046
+ /**
39047
+ * defines whether the popup should follow the dock reference when the reference changes its position.
39048
+ */
39049
+ followOf?: boolean | Function | null
39050
+ ): void;
38197
39051
  /**
38198
39052
  * Sets the animation functions to use for opening and closing the Popup. Any null value will be ignored
38199
39053
  * and not change the respective animation function. When called, the animation functions receive three
@@ -38427,7 +39281,7 @@ declare namespace sap {
38427
39281
  *
38428
39282
  *
38429
39283
  * By default, when the control is invalidated (e.g. a property is changed, an aggregation is removed, or
38430
- * an association is added), it will be registered for re-rendering. During the (re)rendering, the `render`
39284
+ * an association is added), it will be registered for rerendering. During the (re)rendering, the `render`
38431
39285
  * method of the control renderer is executed via a specified `RenderManager` interface and the control
38432
39286
  * instance.
38433
39287
  *
@@ -38492,7 +39346,53 @@ declare namespace sap {
38492
39346
  * elements, e.g. use `rm.openStart("div", oControl.getId() + "-suffix");` instead of `rm.openStart("div").attr("id",
38493
39347
  * oControl.getId() + "-suffix");`
38494
39348
  * - Controls that listen to the `focusin` event must double check their focus handling. Since DOM nodes
38495
- * are not removed and only reused, the `focusin` event might not be fired during re-rendering.
39349
+ * are not removed and only reused, the `focusin` event might not be fired during rerendering.
39350
+ *
39351
+ * Contract for Renderer.apiVersion 4: The `apiVersion 4` marker of the control renderer lets the `RenderManager`
39352
+ * know if a control's output is not affected by changes in the parent control. By default, if a property,
39353
+ * an aggregation, or an association of a control is changed, then the control gets invalidated, and the
39354
+ * rerendering process for that control and all of its children starts. That means child controls rerender
39355
+ * together with their parent even though there is no DOM update necessary. If a control's output is only
39356
+ * affected by its own properties, aggregations, or associations, then the `apiVersion 4` marker can help
39357
+ * to reuse the control's DOM output and prevent child controls from rerendering unnecessarily while they
39358
+ * are getting rendered by their parent. This can help to improve performance by reducing the number of
39359
+ * re-renderings.
39360
+ * For example: A control called "ParentControl" has a child control called "ChildControl". ChildControl
39361
+ * has its own properties, aggregations, and associations, and its output is only affected by them. The
39362
+ * `apiVersion 4` marker is set in the renderer of ChildControl. Whenever a property of the ParentControl
39363
+ * is changed during the re-rendering process, the `RenderManager` will check the `apiVersion` marker of
39364
+ * the ChildControl's renderer, and if it's 4, the `RenderManager` will skip rendering of the ChildControl.
39365
+ *
39366
+ *
39367
+ * To allow a more efficient rerendering with an `apiVersion 4` marker, the following prerequisites must
39368
+ * be fulfilled for the control to ensure compatibility:
39369
+ *
39370
+ *
39371
+ * - All the prerequisites of the `apiVersion 2` marker must be fulfilled by the control.
39372
+ * - The behavior and rendering logic of the control must not rely on the assumption that it will always
39373
+ * be re-rendered at the same time as its parent.
39374
+ * - The `onBeforeRendering` and `onAfterRendering` hooks of the control must not be used to manipulate
39375
+ * or access any elements outside of the control's own DOM structure.
39376
+ * - The control renderer must maintain a proper rendering encapsulation and render only the properties,
39377
+ * aggregations, and associations that are specific to the control. The renderer should not reference or
39378
+ * depend on any state of the parent control or any other external element.
39379
+ * - If certain aggregations are dependent on the state of the parent control, they must always be rendered
39380
+ * together with their parent. To accomplish this, the parent control must use the {@link sap.ui.core.Control#invalidate
39381
+ * invalidate} method to signal to the child controls that they need to re-render whenever the dependent
39382
+ * state of the parent control changes. This guarantees that the child controls are always in sync with
39383
+ * the parent control, regardless of the `apiVersion` definition of their renderer.
39384
+ *
39385
+ *
39386
+ * **Note:** The rendering can only be skipped if the renderer of each descendant control has the `apiVersion
39387
+ * 4` marker, and no `onBeforeRendering` or `onAfterRendering` event delegates are registered. However,
39388
+ * while {@link sap.ui.core.Element#addEventDelegate adding the event delegate}, setting the `canSkipRendering`
39389
+ * property to `true` on the event delegate object can be done to indicate that those delegate handlers
39390
+ * are compliant with the `apiVersion:4` prerequisites and still allows for rendering optimization.
39391
+ * The `canSkipRendering` property can also be used for the controls that enhance the accessibility state
39392
+ * of child controls with implementing the {@link sap.ui.core.Element#enhanceAccessibilityState enhanceAccessibilityState}
39393
+ * method. In this case, setting the `canSkipRendering` property to `true` lets the `RenderManager` know
39394
+ * that the parent control's accessibility enhancement is static and does not interfere with the child control's
39395
+ * rendering optimization.
38496
39396
  */
38497
39397
  class RenderManager extends Object {
38498
39398
  /**
@@ -38643,6 +39543,72 @@ declare namespace sap {
38643
39543
  */
38644
39544
  mProps?: object
38645
39545
  ): this;
39546
+ /**
39547
+ * Collects accessibility related attributes for an `Element` and renders them as part of the currently
39548
+ * rendered DOM element.
39549
+ *
39550
+ * See the WAI-ARIA specification for a general description of the accessibility related attributes. Attributes
39551
+ * are only rendered when the accessibility feature is activated in the UI5 runtime configuration.
39552
+ *
39553
+ * The values for the attributes are collected from the following sources (last one wins):
39554
+ * - from the properties and associations of the given `oElement`, using a heuristic mapping (described
39555
+ * below)
39556
+ * - from the `mProps` parameter, as provided by the caller
39557
+ * - from the parent of the given `oElement`, if it has a parent and if the parent implements the method
39558
+ * {@link sap.ui.core.Element#enhanceAccessibilityState enhanceAccessibilityState} If no `oElement`
39559
+ * is given, only `mProps` will be taken into account.
39560
+ *
39561
+ * Heuristic Mapping: The following mapping from properties/values to ARIA attributes is used (if the element
39562
+ * does have such properties):
39563
+ * - `editable===false` => `aria-readonly="true"`
39564
+ * - `enabled===false` => `aria-disabled="true"`
39565
+ * - `visible===false` => `aria-hidden="true"`
39566
+ * - `required===true` => `aria-required="true"`
39567
+ * - `selected===true` => `aria-selected="true"`
39568
+ * - `checked===true` => `aria-checked="true"`
39569
+ *
39570
+ * In case of the `required` property, all label controls which reference the given element in their `labelFor`
39571
+ * relation are additionally taken into account when determining the value for the `aria-required` attribute.
39572
+ *
39573
+ * Additionally, the associations `ariaDescribedBy` and `ariaLabelledBy` are used to determine the lists
39574
+ * of IDs for the ARIA attributes `aria-describedby` and `aria-labelledby`.
39575
+ *
39576
+ * Label controls that reference the given element in their `labelFor` relation are automatically added
39577
+ * to the `aria-labelledby` attribute.
39578
+ *
39579
+ * Note: This function is only a heuristic of a control property to ARIA attribute mapping. Control developers
39580
+ * have to check whether it fulfills their requirements. In case of problems (for example the `RadioButton`
39581
+ * has a `selected` property but must provide an `aria-checked` attribute) the auto-generated result of
39582
+ * this function can be influenced via the parameter `mProps` as described below.
39583
+ *
39584
+ * The parameter `mProps` can be used to either provide additional attributes which should be rendered and/or
39585
+ * to avoid the automatic generation of single ARIA attributes. The 'aria-' prefix will be prepended automatically
39586
+ * to the keys (Exception: Attribute `role` does not get the prefix 'aria-').
39587
+ *
39588
+ * Examples:
39589
+ * `{hidden : true}` results in `aria-hidden="true"` independent of the presence or absence of the visibility
39590
+ * property.
39591
+ * `{hidden : null}` ensures that no `aria-hidden` attribute is written independent of the presence or
39592
+ * absence of the visibility property.
39593
+ *
39594
+ *
39595
+ * The function behaves in the same way for the associations `ariaDescribedBy` and `ariaLabelledBy`. To
39596
+ * append additional values to the auto-generated `aria-describedby` and `aria-labelledby` attributes, the
39597
+ * following format can be used:
39598
+ * ```javascript
39599
+ *
39600
+ * {describedby : {value: "id1 id2", append: true}} => aria-describedby = "ida idb id1 id2"
39601
+ * ```
39602
+ * (assuming that "ida idb" is the auto-generated part based on the association `ariaDescribedBy`).
39603
+ *
39604
+ * @returns Reference to `this` in order to allow method chaining
39605
+ */
39606
+ accessibilityState(
39607
+ /**
39608
+ * A map of additional properties that should be added or changed.
39609
+ */
39610
+ mProps?: object
39611
+ ): this;
38646
39612
  /**
38647
39613
  * @deprecated (since 1.92) - Instead use {@link sap.ui.core.RenderManager#class} of the {@link sap.ui.core.RenderManager
38648
39614
  * Semantic Rendering API}.
@@ -38770,7 +39736,7 @@ declare namespace sap {
38770
39736
  *
38771
39737
  * **Note:**: the functionality of this method is different from the default handling for invisible controls
38772
39738
  * (controls with `visible == false`). The standard rendering for invisible controls still renders a placeholder
38773
- * DOM. This allows re-rendering of the invisible control once it becomes visible again without a need to
39739
+ * DOM. This allows rerendering of the invisible control once it becomes visible again without a need to
38774
39740
  * render its parent, too. Children that are cleaned up with this method here, are supposed to have no more
38775
39741
  * DOM at all. Rendering them later on therefore requires an involvement (typically: a rendering) of their
38776
39742
  * parent.
@@ -39381,7 +40347,7 @@ declare namespace sap {
39381
40347
  *
39382
40348
  * @returns Metadata object describing this class
39383
40349
  */
39384
- static getMetadata(): /* was: sap.ui.core.Metadata */ any;
40350
+ static getMetadata(): sap.ui.base.Metadata;
39385
40351
  /**
39386
40352
  * Registers the given event handler for resize events on the given DOM element or control.
39387
40353
  *
@@ -42474,6 +43440,34 @@ declare namespace sap {
42474
43440
  */
42475
43441
  type Dock = string;
42476
43442
 
43443
+ /**
43444
+ * @SINCE 1.111
43445
+ *
43446
+ * The object contains focus information for input controls.
43447
+ */
43448
+ type FocusInfo = {
43449
+ /**
43450
+ * The ID of the focused control.
43451
+ */
43452
+ id?: string;
43453
+ /**
43454
+ * The position of the cursor.
43455
+ */
43456
+ cursorPos?: int;
43457
+ /**
43458
+ * The start position of selection.
43459
+ */
43460
+ selectionStart?: int;
43461
+ /**
43462
+ * The end position of selection.
43463
+ */
43464
+ selectionEnd?: int;
43465
+ /**
43466
+ * Prevents scrolling.
43467
+ */
43468
+ preventScroll?: boolean | undefined;
43469
+ };
43470
+
42477
43471
  /**
42478
43472
  * A string type representing an ID or a name.
42479
43473
  *
@@ -46108,7 +47102,7 @@ declare namespace sap {
46108
47102
  *
46109
47103
  * @returns the formatted output value in the target type; `undefined` or `null` are formatted to `null`;
46110
47104
  * `Date` objects are returned for target type "object" and represent the given date with time "00:00:00"
46111
- * in local time
47105
+ * in the configured time zone
46112
47106
  */
46113
47107
  formatValue(
46114
47108
  /**
@@ -46122,7 +47116,21 @@ declare namespace sap {
46122
47116
  * for more information.
46123
47117
  */
46124
47118
  sTargetType: string
46125
- ): string | Date;
47119
+ ): string | Date | import("sap/ui/core/date/UI5Date").default;
47120
+ /**
47121
+ * @SINCE 1.111.0
47122
+ *
47123
+ * Gets the model value according to this type's constraints and format options for the given date object
47124
+ * representing a date. Validates the resulting value against the constraints of this type instance.
47125
+ *
47126
+ * @returns The model representation of the date
47127
+ */
47128
+ getModelValue(
47129
+ /**
47130
+ * The date object considering the configured time zone. Must be created via {@link module:sap/ui/core/date/UI5Date.getInstance}
47131
+ */
47132
+ oDate: Date | import("sap/ui/core/date/UI5Date").default | null
47133
+ ): string | null;
46126
47134
  /**
46127
47135
  * Returns the type's name.
46128
47136
  *
@@ -46170,8 +47178,8 @@ declare namespace sap {
46170
47178
  * "Date"`) to display only a date.
46171
47179
  *
46172
47180
  * In {@link sap.ui.model.odata.v2.ODataModel} this type is represented as a `Date`. With the constraint
46173
- * `displayFormat: "Date"`, the time zone is UTC and the time part is ignored, otherwise it is a date/time
46174
- * value in local time.
47181
+ * `displayFormat: "Date"`, the time zone is UTC, and all time related parts (hours, minutes, etc.) are
47182
+ * set to zero; otherwise it is a date/time value in local time.
46175
47183
  */
46176
47184
  class DateTime extends sap.ui.model.odata.type.DateTimeBase {
46177
47185
  /**
@@ -46228,6 +47236,23 @@ declare namespace sap {
46228
47236
  * @returns Metadata object describing this class
46229
47237
  */
46230
47238
  static getMetadata(): sap.ui.base.Metadata;
47239
+ /**
47240
+ * @SINCE 1.111.0
47241
+ *
47242
+ * Gets the model value according to this type's constraints and format options for the given date object
47243
+ * which represents a timestamp in the configured time zone. Validates the resulting value against the constraints
47244
+ * of this type instance.
47245
+ * See:
47246
+ * {@link sap.ui.core.Configuration.getTimezone}
47247
+ *
47248
+ * @returns The model representation for the given Date
47249
+ */
47250
+ getModelValue(
47251
+ /**
47252
+ * The date object considering the configured time zone. Must be created via {@link module:sap/ui/core/date/UI5Date.getInstance}
47253
+ */
47254
+ oDate: Date | import("sap/ui/core/date/UI5Date").default | null
47255
+ ): Date | import("sap/ui/core/date/UI5Date").default | null;
46231
47256
  /**
46232
47257
  * Returns the type's name.
46233
47258
  *
@@ -46320,7 +47345,7 @@ declare namespace sap {
46320
47345
  * for more information.
46321
47346
  */
46322
47347
  sTargetType: string
46323
- ): Date | string;
47348
+ ): Date | import("sap/ui/core/date/UI5Date").default | string;
46324
47349
  /**
46325
47350
  * @SINCE 1.27.0
46326
47351
  *
@@ -46339,7 +47364,7 @@ declare namespace sap {
46339
47364
  * sap.ui.model.odata.type} for more information.
46340
47365
  */
46341
47366
  sSourceType: string
46342
- ): Date | string;
47367
+ ): Date | import("sap/ui/core/date/UI5Date").default | string;
46343
47368
  /**
46344
47369
  * @SINCE 1.27.0
46345
47370
  *
@@ -46446,7 +47471,7 @@ declare namespace sap {
46446
47471
  * for more information.
46447
47472
  */
46448
47473
  sTargetType: string
46449
- ): Date | string;
47474
+ ): Date | import("sap/ui/core/date/UI5Date").default | string;
46450
47475
  /**
46451
47476
  * @SINCE 1.27.0
46452
47477
  *
@@ -46461,7 +47486,26 @@ declare namespace sap {
46461
47486
  * for more information.
46462
47487
  */
46463
47488
  sTargetType: string
46464
- ): Date | string;
47489
+ ): Date | import("sap/ui/core/date/UI5Date").default | string;
47490
+ /**
47491
+ * @SINCE 1.111.0
47492
+ *
47493
+ * Gets the model value according to this type's constraints and format options for the given date object
47494
+ * which represents a timestamp in the configured time zone. Validates the resulting value against the constraints
47495
+ * of this type instance.
47496
+ *
47497
+ * @returns The model representation for the given Date
47498
+ */
47499
+ getModelValue(
47500
+ /**
47501
+ * The date object considering the configured time zone. Must be created via {@link module:sap/ui/core/date/UI5Date.getInstance}
47502
+ */
47503
+ oDate: Date | import("sap/ui/core/date/UI5Date").default | null
47504
+ ):
47505
+ | Date
47506
+ | import("sap/ui/core/date/UI5Date").default
47507
+ | string
47508
+ | null;
46465
47509
  /**
46466
47510
  * Returns the type's name.
46467
47511
  *
@@ -46488,7 +47532,7 @@ declare namespace sap {
46488
47532
  * sap.ui.model.odata.type} for more information.
46489
47533
  */
46490
47534
  sSourceType: string
46491
- ): Date | string;
47535
+ ): Date | import("sap/ui/core/date/UI5Date").default | string;
46492
47536
  /**
46493
47537
  * @SINCE 1.27.0
46494
47538
  *
@@ -48067,6 +49111,24 @@ declare namespace sap {
48067
49111
  */
48068
49112
  sTargetType: string
48069
49113
  ): string;
49114
+ /**
49115
+ * @SINCE 1.111.0
49116
+ *
49117
+ * Gets the model value according to this type's constraints and format options for the given date object
49118
+ * representing a time. Validates the resulting value against the constraints of this type instance.
49119
+ *
49120
+ * @returns The model representation of the time
49121
+ */
49122
+ getModelValue(
49123
+ /**
49124
+ * The date object considering the configured time zone. Must be created via {@link module:sap/ui/core/date/UI5Date.getInstance}
49125
+ */
49126
+ oDate: Date | import("sap/ui/core/date/UI5Date").default | null
49127
+ ): {
49128
+ __edmType: string;
49129
+
49130
+ ms: int;
49131
+ } | null;
48070
49132
  /**
48071
49133
  * Returns the type's name.
48072
49134
  *
@@ -48177,7 +49239,21 @@ declare namespace sap {
48177
49239
  * for more information
48178
49240
  */
48179
49241
  sTargetType: string
48180
- ): Date | string;
49242
+ ): Date | import("sap/ui/core/date/UI5Date").default | string;
49243
+ /**
49244
+ * @SINCE 1.111.0
49245
+ *
49246
+ * Gets the model value according to this type's constraints and format options for the given date object
49247
+ * representing a time. Validates the resulting value against the constraints of this type instance.
49248
+ *
49249
+ * @returns The model representation of the time
49250
+ */
49251
+ getModelValue(
49252
+ /**
49253
+ * The date object considering the configured time zone. Must be created via {@link module:sap/ui/core/date/UI5Date.getInstance}
49254
+ */
49255
+ oDate: Date | import("sap/ui/core/date/UI5Date").default | null
49256
+ ): string | null;
48181
49257
  /**
48182
49258
  * @SINCE 1.37.0
48183
49259
  *
@@ -49272,6 +50348,16 @@ declare namespace sap {
49272
50348
  */
49273
50349
  sGroupId?: string
49274
50350
  ): void;
50351
+ /**
50352
+ * See:
50353
+ * sap.ui.model.ContextBinding.prototype.refresh
50354
+ */
50355
+ refresh(
50356
+ /**
50357
+ * The group Id for the refresh
50358
+ */
50359
+ sGroupId?: string
50360
+ ): void;
49275
50361
  }
49276
50362
  /**
49277
50363
  * List binding for an OData V2 model.
@@ -49510,7 +50596,7 @@ declare namespace sap {
49510
50596
  /**
49511
50597
  * Single filter or array of filter objects
49512
50598
  */
49513
- aFilters: sap.ui.model.Filter | sap.ui.model.Filter[],
50599
+ aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
49514
50600
  /**
49515
50601
  * Type of the filter which should be adjusted. If it is not given, type `Control` is assumed
49516
50602
  */
@@ -49629,6 +50715,20 @@ declare namespace sap {
49629
50715
  */
49630
50716
  sGroupId?: string
49631
50717
  ): void;
50718
+ /**
50719
+ * Refreshes the binding, check whether the model data has been changed and fire change event if this is
50720
+ * the case. For server side models this should refetch the data from the server. To update a control, even
50721
+ * if no data has been changed, e.g. to reset a control after failed validation, use the parameter `bForceUpdate`.
50722
+ *
50723
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
50724
+ * rows area and inserted at the right position based on the current filters and sorters.
50725
+ */
50726
+ refresh(
50727
+ /**
50728
+ * The group Id for the refresh
50729
+ */
50730
+ sGroupId?: string
50731
+ ): void;
49632
50732
  /**
49633
50733
  * @SINCE 1.77.0
49634
50734
  *
@@ -51467,6 +52567,59 @@ declare namespace sap {
51467
52567
  expand?: string;
51468
52568
  }
51469
52569
  ): any | undefined;
52570
+ /**
52571
+ * Returns a JSON object that is a copy of the entity data referenced by the given `sPath` and `oContext`.
52572
+ * It does not load any data and may not return all requested data if it is not available.
52573
+ *
52574
+ * With the `mParameters.select` parameter it is possible to specify comma-separated property or navigation
52575
+ * property names which should be included in the result object. This works like the OData `$select` URL
52576
+ * parameter. With the `mParameters.expand` parameter it is possible to specify comma-separated navigation
52577
+ * property names which should be included inline in the result object. This works like the OData `$expand`
52578
+ * parameter.
52579
+ *
52580
+ * **Note:** `mParameters.expand` can only be used if the corresponding navigation properties have been
52581
+ * read via {@link sap.ui.model.odata.v2.ODataModel#read} using the OData `$expand` URL parameter. If a
52582
+ * navigation property has not been read via the OData `$expand` URL parameter, it is left out in the result.
52583
+ * Keep in mind that navigation properties referencing a collection are usually not loaded via the OData
52584
+ * `$expand` URL parameter but directly via its navigation property.
52585
+ *
52586
+ * **Note:** If `mParameters.select` is not specified, the returned object may contain model-internal attributes.
52587
+ * This may lead to problems when submitting this data to the service for an update or create operation.
52588
+ * To get a copy of the entity without internal attributes, use `{select: "*"}` instead.
52589
+ *
52590
+ * **Note:** If `mParameters.select` is given and not all selected properties are available, this method
52591
+ * returns `undefined` instead of incomplete data.
52592
+ *
52593
+ * **Note:** If `mParameters.select` is not given, all properties and navigation properties available on
52594
+ * the client are returned.
52595
+ *
52596
+ * Example:
52597
+ * With `mParameters` given as `{select: "Products/ProductName, Products", expand:"Products"}` no properties
52598
+ * of the entity itself are returned, but only the `ProductName` property of the `Products` navigation property.
52599
+ * If `Products/ProductName` has not been loaded before, `undefined` is returned.
52600
+ *
52601
+ * @returns The value for the given path and context or `undefined` if data or entity type cannot be found
52602
+ * or if not all selected properties are available
52603
+ */
52604
+ getObject(
52605
+ /**
52606
+ * The path referencing the object
52607
+ */
52608
+ sPath: string,
52609
+ /**
52610
+ * Map of parameters
52611
+ */
52612
+ mParameters?: {
52613
+ /**
52614
+ * Comma-separated list of properties or paths to properties to select
52615
+ */
52616
+ select?: string;
52617
+ /**
52618
+ * Comma-separated list of navigation properties or paths to navigation properties to expand
52619
+ */
52620
+ expand?: string;
52621
+ }
52622
+ ): any | undefined;
51470
52623
  /**
51471
52624
  * Returns the original value for the property with the given path and context. The original value is the
51472
52625
  * value that was last responded by the server.
@@ -52505,7 +53658,7 @@ declare namespace sap {
52505
53658
  /**
52506
53659
  * @SINCE 1.43.0
52507
53660
  *
52508
- * A collection of methods which help to consume OData V4 annotations in XML template views. Every context argument must belong to a {@link sap.ui.model.odata.v4.ODataMetaModel}
53661
+ * A collection of methods which help to consume OData V4 annotations in XML template views. Every context argument must belong to an {@link sap.ui.model.odata.v4.ODataMetaModel}
52509
53662
  * instance.
52510
53663
  */
52511
53664
  interface AnnotationHelper {
@@ -53150,8 +54303,8 @@ declare namespace sap {
53150
54303
  *
53151
54304
  * Implementation of an OData V4 model's context.
53152
54305
  *
53153
- * The context is a pointer to model data as returned by a query from a {@link sap.ui.model.odata.v4.ODataContextBinding}
53154
- * or a {@link sap.ui.model.odata.v4.ODataListBinding}. Contexts are always and only created by such bindings.
54306
+ * The context is a pointer to model data as returned by a query from an {@link sap.ui.model.odata.v4.ODataContextBinding}
54307
+ * or an {@link sap.ui.model.odata.v4.ODataListBinding}. Contexts are always and only created by such bindings.
53155
54308
  * A context for a context binding points to the complete query result. A context for a list binding points
53156
54309
  * to one specific entry in the binding's collection. A property binding does not have a context, you can
53157
54310
  * access its value via {@link sap.ui.model.odata.v4.ODataPropertyBinding#getValue}.
@@ -53473,6 +54626,16 @@ declare namespace sap {
53473
54626
  * @returns `true` if this context is kept alive
53474
54627
  */
53475
54628
  isKeepAlive(): boolean;
54629
+ /**
54630
+ * @EXPERIMENTAL (since 1.111.0)
54631
+ *
54632
+ * Tells whether this context is currently selected.
54633
+ * See:
54634
+ * #setSelected
54635
+ *
54636
+ * @returns Whether this context is currently selected
54637
+ */
54638
+ isSelected(): boolean;
53476
54639
  /**
53477
54640
  * @SINCE 1.43.0
53478
54641
  *
@@ -53670,6 +54833,11 @@ declare namespace sap {
53670
54833
  * "/com.sap.gateway.default.iwbep.tea_busi.v0001.Container/TEAMS") of the service. All (navigation) properties
53671
54834
  * in the complete model matching such an absolute path are updated. Since 1.85.0, "14.4.11 Expression edm:String"
53672
54835
  * is accepted as well.
54836
+ *
54837
+ * Since 1.108.8, a property path matching the "com.sap.vocabularies.Common.v1.Messages" annotation of a
54838
+ * list binding's entity type is treated specially for a row context of a list binding: It is loaded even
54839
+ * if it has not yet been requested by that list binding. This way, exactly the messages for a single row
54840
+ * can be updated. Same for a "*" segment or an empty navigation property path.
53673
54841
  */
53674
54842
  aPathExpressions: object[] | string[],
53675
54843
  /**
@@ -53683,15 +54851,19 @@ declare namespace sap {
53683
54851
  /**
53684
54852
  * @EXPERIMENTAL (since 1.109.0)
53685
54853
  *
53686
- * Resets all pending changes of this context, see {@link #hasPendingChanges}. Resets also invalid user
53687
- * input. If this context is currently {@link #delete deleted} on the client, but not yet on the server,
53688
- * this method cancels the deletion and restores the context.
54854
+ * Resets all property changes, created entities, and entity deletions of this context. Resets also invalid
54855
+ * user input and inactive contexts which had their activation prevented (see {@link sap.ui.model.odata.v4.Context#isInactive}).
54856
+ * This function does not reset the execution of OData operations (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}).
54857
+ * For a context which is currently {@link #delete deleted} on the client, but not yet on the server, this
54858
+ * method cancels the deletion and restores the context.
53689
54859
  *
53690
- * Note: This is an experimental API. Currently only PATCH and DELETE changes for row contexts of an absolute
53691
- * {@link sap.ui.model.odata.v4.ODataListBinding} are supported.
54860
+ * Note: This is an experimental API. Currently only row contexts of an {@link sap.ui.model.odata.v4.ODataListBinding}
54861
+ * are supported.
54862
+ * See:
54863
+ * #hasPendingChanges
53692
54864
  *
53693
- * @returns A promise which is resolved without a defined result as soon as all changes in the context itself
53694
- * are canceled
54865
+ * @returns A promise which is resolved without a defined result as soon as all changes in the context and
54866
+ * its current dependent bindings are canceled
53695
54867
  */
53696
54868
  resetChanges(): Promise<any>;
53697
54869
  /**
@@ -53781,12 +54953,26 @@ declare namespace sap {
53781
54953
  */
53782
54954
  bRetry?: boolean
53783
54955
  ): Promise<any>;
54956
+ /**
54957
+ * @EXPERIMENTAL (since 1.111.0)
54958
+ *
54959
+ * Determines whether this context is currently selected.
54960
+ * See:
54961
+ * #isSelected
54962
+ */
54963
+ setSelected(
54964
+ /**
54965
+ * Whether this context is currently selected
54966
+ */
54967
+ bSelected: boolean
54968
+ ): void;
53784
54969
  /**
53785
54970
  * @SINCE 1.39.0
53786
54971
  *
53787
- * Returns a string representation of this object including the {@link #getPath binding path}, {@link #getIndex
53788
- * index}, and state (see also "Context states" of {@link topic:c9723f8265f644af91c0ed941e114d46 Creating
53789
- * an Entity}).
54972
+ * Returns a string representation of this object including the following information:
54973
+ * {@link #getPath Binding path}, {@link #getIndex Index}, State (see also "Context states"
54974
+ * of {@link topic:c9723f8265f644af91c0ed941e114d46 Creating an Entity}), including whether this context
54975
+ * is {@link #isSelected selected}.
53790
54976
  * See:
53791
54977
  * #destroy
53792
54978
  * #isDeleted
@@ -53921,7 +55107,8 @@ declare namespace sap {
53921
55107
  /**
53922
55108
  * @SINCE 1.45.0
53923
55109
  *
53924
- * Changes this binding's parameters and refreshes the binding.
55110
+ * Changes this binding's parameters and refreshes the binding. Since 1.111.0, a list binding's header context
55111
+ * is deselected.
53925
55112
  *
53926
55113
  * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
53927
55114
  * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
@@ -54006,9 +55193,9 @@ declare namespace sap {
54006
55193
  * returns a `Promise` that resolves with `false`. In this case `oError.canceled === true`. It is
54007
55194
  * also rejected if `bReplaceWithRVC` is supplied, and there is no return value context at all or the existing
54008
55195
  * context as described above is currently part of the list's collection (that is, has an index).
54009
- * A return value context is a {@link sap.ui.model.odata.v4.Context} which represents a bound operation
55196
+ * A return value context is an {@link sap.ui.model.odata.v4.Context} which represents a bound operation
54010
55197
  * response. It is created only if the operation is bound and has a single entity return value from the
54011
- * same entity set as the operation's binding parameter and has a parent context which is a {@link sap.ui.model.odata.v4.Context}
55198
+ * same entity set as the operation's binding parameter and has a parent context which is an {@link sap.ui.model.odata.v4.Context}
54012
55199
  * and points to an entity from an entity set. It is destroyed the next time this operation binding is executed
54013
55200
  * again!
54014
55201
  * If a return value context is created, it must be used instead of `this.getBoundContext()`. All bound
@@ -54110,7 +55297,9 @@ declare namespace sap {
54110
55297
  * Returns `true` if this binding or its dependent bindings have property changes, created entities, or
54111
55298
  * entity deletions which have not been sent successfully to the server. This function does not take the
54112
55299
  * execution of OData operations (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}) into account.
54113
- * Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive inactive} contexts are ignored.
55300
+ * Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive inactive} contexts are ignored, unless
55301
+ * (since 1.100.0) their {@link sap.ui.model.odata.v4.ODataListBinding#event:createActivate activation}
55302
+ * has been prevented and {@link sap.ui.model.odata.v4.Context#isInactive} therefore returns `1`.
54114
55303
  *
54115
55304
  * Note: If this binding is relative, its data is cached separately for each parent context path. This method
54116
55305
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
@@ -54152,7 +55341,7 @@ declare namespace sap {
54152
55341
  * Refreshes the binding. Prompts the model to retrieve data from the server using the given group ID and
54153
55342
  * notifies the control that new data is available.
54154
55343
  *
54155
- * Refresh is supported for bindings which are not relative to a {@link sap.ui.model.odata.v4.Context}.
55344
+ * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context}.
54156
55345
  *
54157
55346
  * Note: When calling {@link #refresh} multiple times, the result of the request triggered by the last call
54158
55347
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
@@ -54434,7 +55623,8 @@ declare namespace sap {
54434
55623
  /**
54435
55624
  * @SINCE 1.45.0
54436
55625
  *
54437
- * Changes this binding's parameters and refreshes the binding.
55626
+ * Changes this binding's parameters and refreshes the binding. Since 1.111.0, a list binding's header context
55627
+ * is deselected.
54438
55628
  *
54439
55629
  * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
54440
55630
  * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
@@ -54621,7 +55811,7 @@ declare namespace sap {
54621
55811
  * @SINCE 1.39.0
54622
55812
  *
54623
55813
  * Filters the list with the given filters. Since 1.97.0, if filters are unchanged, no request is sent,
54624
- * regardless of pending changes.
55814
+ * regardless of pending changes. Since 1.111.0, the header context is deselected.
54625
55815
  *
54626
55816
  * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
54627
55817
  * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
@@ -54670,7 +55860,19 @@ declare namespace sap {
54670
55860
  *
54671
55861
  * @returns The current data aggregation object, incl. some default values
54672
55862
  */
54673
- getAggregation(): object;
55863
+ getAggregation(
55864
+ /**
55865
+ * Whether to additionally return the "$"-prefixed values described below which obviously cannot be given
55866
+ * back to the setter (@experimental as of version 1.111.0). They are retrieved from the pair of "Org.OData.Aggregation.V1.RecursiveHierarchy"
55867
+ * and "com.sap.vocabularies.Hierarchy.v1.RecursiveHierarchy" annotations at this binding's entity type,
55868
+ * identified via the `hierarchyQualifier` given to {@link #setAggregation}.
55869
+ * "$DistanceFromRootProperty" holds the path to the property which provides the raw value for "@$ui5.node.level"
55870
+ * (minus one) and should be used only to interpret the response retrieved via {@link #getDownloadUrl}.
55871
+ * "$NodeProperty" holds the path to the property which provides the hierarchy node value. That property
55872
+ * is always $select'ed automatically and can be accessed as usual.
55873
+ */
55874
+ bVerbose?: boolean
55875
+ ): object;
54674
55876
  /**
54675
55877
  * @SINCE 1.98.0
54676
55878
  *
@@ -54893,7 +56095,9 @@ declare namespace sap {
54893
56095
  * Returns `true` if this binding or its dependent bindings have property changes, created entities, or
54894
56096
  * entity deletions which have not been sent successfully to the server. This function does not take the
54895
56097
  * execution of OData operations (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}) into account.
54896
- * Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive inactive} contexts are ignored.
56098
+ * Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive inactive} contexts are ignored, unless
56099
+ * (since 1.100.0) their {@link sap.ui.model.odata.v4.ODataListBinding#event:createActivate activation}
56100
+ * has been prevented and {@link sap.ui.model.odata.v4.Context#isInactive} therefore returns `1`.
54897
56101
  *
54898
56102
  * Note: If this binding is relative, its data is cached separately for each parent context path. This method
54899
56103
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
@@ -54957,7 +56161,7 @@ declare namespace sap {
54957
56161
  * Refreshes the binding. Prompts the model to retrieve data from the server using the given group ID and
54958
56162
  * notifies the control that new data is available.
54959
56163
  *
54960
- * Refresh is supported for bindings which are not relative to a {@link sap.ui.model.odata.v4.Context}.
56164
+ * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context}.
54961
56165
  *
54962
56166
  * Note: When calling {@link #refresh} multiple times, the result of the request triggered by the last call
54963
56167
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
@@ -55034,7 +56238,7 @@ declare namespace sap {
55034
56238
  /**
55035
56239
  * @SINCE 1.86.0
55036
56240
  *
55037
- * Requests a {@link sap.ui.model.Filter} object which can be used to filter the list binding by entries
56241
+ * Requests an {@link sap.ui.model.Filter} object which can be used to filter the list binding by entries
55038
56242
  * with model messages. With the filter callback, you can define if a message is considered when creating
55039
56243
  * the filter for entries with messages.
55040
56244
  *
@@ -55044,7 +56248,7 @@ declare namespace sap {
55044
56248
  * See:
55045
56249
  * sap.ui.model.ListBinding#requestFilterForMessages
55046
56250
  *
55047
- * @returns A Promise that resolves with a {@link sap.ui.model.Filter} representing the entries with messages;
56251
+ * @returns A Promise that resolves with an {@link sap.ui.model.Filter} representing the entries with messages;
55048
56252
  * it resolves with `null` if the binding is not resolved or if there is no message for any entry
55049
56253
  */
55050
56254
  requestFilterForMessages(
@@ -56125,6 +57329,12 @@ declare namespace sap {
56125
57329
  * Map of HTTP header names to their values, see {@link #changeHttpHeaders}
56126
57330
  */
56127
57331
  httpHeaders?: object;
57332
+ /**
57333
+ * Whether to ignore all annotations from service metadata and "cross-service references"; only the value
57334
+ * `true` is allowed. Only annotations from annotation files (see parameter "annotationURI") are loaded.
57335
+ * This parameter is not inherited by value list models. @experimental as of version 1.111.0
57336
+ */
57337
+ ignoreAnnotationsFromMetadata?: boolean;
56128
57338
  /**
56129
57339
  * Additional map of URL parameters used specifically for $metadata requests. Note that "sap-context-token"
56130
57340
  * applies only to the service's root $metadata, but not to "cross-service references". Supported since
@@ -56326,7 +57536,7 @@ declare namespace sap {
56326
57536
  */
56327
57537
  $select?: string | string[];
56328
57538
  /**
56329
- * Whether a binding relative to a {@link sap.ui.model.odata.v4.Context} uses the canonical path computed
57539
+ * Whether a binding relative to an {@link sap.ui.model.odata.v4.Context} uses the canonical path computed
56330
57540
  * from its context's path for data service requests; only the value `true` is allowed.
56331
57541
  */
56332
57542
  $$canonicalPath?: boolean;
@@ -56447,7 +57657,7 @@ declare namespace sap {
56447
57657
  */
56448
57658
  $$aggregation?: object;
56449
57659
  /**
56450
- * Whether a binding relative to a {@link sap.ui.model.odata.v4.Context} uses the canonical path computed
57660
+ * Whether a binding relative to an {@link sap.ui.model.odata.v4.Context} uses the canonical path computed
56451
57661
  * from its context's path for data service requests; only the value `true` is allowed.
56452
57662
  */
56453
57663
  $$canonicalPath?: boolean;
@@ -57043,7 +58253,9 @@ declare namespace sap {
57043
58253
  *
57044
58254
  * Resets all property changes, created entities, and entity deletions associated with the given group ID
57045
58255
  * which have not been successfully submitted via {@link #submitBatch}. Resets also invalid user input for
57046
- * the same group ID. This function does not reset the execution of OData operations (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}).
58256
+ * the same group ID and (since 1.111.0) inactive contexts which had their activation prevented (see {@link
58257
+ * sap.ui.model.odata.v4.Context#isInactive}). This function does not reset the execution of OData operations
58258
+ * (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}).
57047
58259
  * See:
57048
58260
  * sap.ui.model.odata.v4.ODataModel#constructor
57049
58261
  * #hasPendingChanges
@@ -57224,7 +58436,9 @@ declare namespace sap {
57224
58436
  * Returns `true` if this binding or its dependent bindings have property changes, created entities, or
57225
58437
  * entity deletions which have not been sent successfully to the server. This function does not take the
57226
58438
  * execution of OData operations (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}) into account.
57227
- * Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive inactive} contexts are ignored.
58439
+ * Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive inactive} contexts are ignored, unless
58440
+ * (since 1.100.0) their {@link sap.ui.model.odata.v4.ODataListBinding#event:createActivate activation}
58441
+ * has been prevented and {@link sap.ui.model.odata.v4.Context#isInactive} therefore returns `1`.
57228
58442
  *
57229
58443
  * Note: If this binding is relative, its data is cached separately for each parent context path. This method
57230
58444
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
@@ -57257,7 +58471,7 @@ declare namespace sap {
57257
58471
  * Refreshes the binding. Prompts the model to retrieve data from the server using the given group ID and
57258
58472
  * notifies the control that new data is available.
57259
58473
  *
57260
- * Refresh is supported for bindings which are not relative to a {@link sap.ui.model.odata.v4.Context}.
58474
+ * Refresh is supported for bindings which are not relative to an {@link sap.ui.model.odata.v4.Context}.
57261
58475
  *
57262
58476
  * Note: When calling {@link #refresh} multiple times, the result of the request triggered by the last call
57263
58477
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
@@ -61619,43 +62833,66 @@ declare namespace sap {
61619
62833
  getOutputPattern(): string;
61620
62834
  }
61621
62835
  /**
61622
- * This class represents the Date interval composite type.
62836
+ * This class represents the date interval composite type.
61623
62837
  */
61624
62838
  class DateInterval extends sap.ui.model.CompositeType {
61625
62839
  /**
61626
- * Constructor for a Date interval type.
62840
+ * Constructor for a date interval type.
61627
62841
  */
61628
62842
  constructor(
61629
62843
  /**
61630
- * Formatting options. For a list of all available options, see {@link sap.ui.core.format.DateFormat.getDateInstance
61631
- * DateFormat}.
62844
+ * Format options as defined in {@link sap.ui.core.format.DateFormat.getDateInstance}
61632
62845
  */
61633
62846
  oFormatOptions?: {
62847
+ /**
62848
+ * This format option cannot be overwritten and is always `true`
62849
+ */
62850
+ interval?: boolean;
62851
+ /**
62852
+ * Whether the end value of the interval can be omitted
62853
+ */
62854
+ singleIntervalValue?: boolean;
61634
62855
  /**
61635
62856
  * Additional set of options used to create a second `DateFormat` object for conversions between string
61636
62857
  * values in the data source (e.g. model) and `Date`. This second format object is used to convert both
61637
- * of the interval parts from a model `string` to `Date` before converting both of the `Date`(s) to `string`
61638
- * with the primary format object. Vice versa, this 'source' format is also used to format the already parsed
62858
+ * interval parts from a model `string` to `Date` before converting both of the `Date`(s) to `string` with
62859
+ * the primary format object. Vice versa, this 'source' format is also used to format the already parsed
61639
62860
  * external value (e.g. user input) into the string format that is expected by the data source. For a list
61640
- * of all available options, see {@link sap.ui.core.format.DateFormat.getDateInstance DateFormat}. In case
61641
- * an empty object is given, the default is the ISO date notation (yyyy-MM-dd).
62861
+ * of all available options, see {@link sap.ui.core.format.DateFormat.getDateInstance}. If an empty object
62862
+ * is given, the default is the ISO date notation (yyyy-MM-dd).
61642
62863
  */
61643
- source?: object;
62864
+ source?: {
62865
+ /**
62866
+ * A data pattern in LDML format; additionally, `"timestamp"` is supported, which means that the source
62867
+ * values are timestamps in milliseconds based on the UNIX epoch.
62868
+ */
62869
+ pattern?: string;
62870
+ };
62871
+ /**
62872
+ * Whether the date is formatted and parsed as UTC instead of the configured time zone
62873
+ */
62874
+ UTC?: boolean;
61644
62875
  },
61645
62876
  /**
61646
- * Value constraints
62877
+ * Value constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
61647
62878
  */
61648
62879
  oConstraints?: {
61649
62880
  /**
61650
- * Smallest value allowed for this type. Values for constraints must use the same type as configured via
61651
- * `oFormatOptions.source`.
62881
+ * Smallest value allowed for this type; values for constraints must use the same type as configured via
62882
+ * `oFormatOptions.source`. Use {@link module:sap/ui/core/date/UI5Date.getInstance} to create new date instances
61652
62883
  */
61653
- minimum?: Date | string;
62884
+ minimum?:
62885
+ | Date
62886
+ | import("sap/ui/core/date/UI5Date").default
62887
+ | string;
61654
62888
  /**
61655
- * Largest value allowed for this type. Values for constraints must use the same type as configured via
61656
- * `oFormatOptions.source`.
62889
+ * Largest value allowed for this type; values for constraints must use the same type as configured via
62890
+ * `oFormatOptions.source`. Use {@link module:sap/ui/core/date/UI5Date.getInstance} to create new date instances
61657
62891
  */
61658
- maximum?: Date | string;
62892
+ maximum?:
62893
+ | Date
62894
+ | import("sap/ui/core/date/UI5Date").default
62895
+ | string;
61659
62896
  }
61660
62897
  );
61661
62898
 
@@ -61689,48 +62926,81 @@ declare namespace sap {
61689
62926
  */
61690
62927
  static getMetadata(): sap.ui.base.Metadata;
61691
62928
  /**
61692
- * Format the given array containing two values to an output value of type string. Other internal types
61693
- * than 'string' and 'any' are not supported by the date interval type. If a source format has been defined
61694
- * for this type, the formatValue does also accept an array with string values as input. This will be parsed
61695
- * into an array of Dates using the source format.
61696
- *
61697
- * If `aValues` isn't an array, a format exception is thrown. If one of the elements in `aValues` is not
61698
- * defined or null, empty string will be returned.
62929
+ * Formats the given array containing the start and the end date of the interval to a string. If a source
62930
+ * format has been defined, an array with string values as input is also accepted. These strings are parsed
62931
+ * into an array of `Date`s using the source format.
61699
62932
  *
61700
- * @returns The formatted output value
62933
+ * @returns The formatted date interval, or an empty string if the start date is falsy or if the end date
62934
+ * is falsy and `singleIntervalValue` is not set to `false`
61701
62935
  */
61702
62936
  formatValue(
61703
62937
  /**
61704
- * The array of values
61705
- */
61706
- aValues: any[],
62938
+ * The start and the end date of the interval. It contains:
62939
+ * - Two `Date` or `module:sap/ui/core/date/UI5Date` objects, or
62940
+ * - Two strings as formatted start and end dates based on the `source` format option, or
62941
+ * - Two numbers, representing the milliseconds of the timestamps based on the UNIX epoch if the `source`
62942
+ * format option is used and `source.pattern` is `"timestamp"`. If the `singleIntervalValue` format
62943
+ * option is used, either an array with only one entry or an array with two entries, the second of which
62944
+ * is `null`, are allowed.
62945
+ */
62946
+ aValues: Array<
62947
+ | Date
62948
+ | import("sap/ui/core/date/UI5Date").default
62949
+ | int
62950
+ | string
62951
+ | null
62952
+ >,
61707
62953
  /**
61708
- * The target type
62954
+ * The target type; may be "any" or "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType
62955
+ * primitive type}; see {@link sap.ui.model.odata.type} for more information.
61709
62956
  */
61710
- sInternalType: string
61711
- ): any;
62957
+ sTargetType: string
62958
+ ): string;
61712
62959
  /**
61713
- * Parse a string value to an array containing two values. Parsing of other internal types than 'string'
61714
- * is not supported by the DateInterval type. In case a source format has been defined, the two values are
61715
- * formatted using the source format after parsing the inteval string and an array which contains two string
61716
- * values is returned.
62960
+ * Parses the given value to an array of two values representing the start date and the end date of the
62961
+ * interval, where the time part of the start date is 0 and the time part of end date is the end of day
62962
+ * (23:59:59.999). If the `singleIntervalValue` format option is used, the second entry is `null` if no
62963
+ * end date is given.
61717
62964
  *
61718
- * @returns The parsed result array
62965
+ * @returns The start and the end date of the interval. The resulting values in the array are:
62966
+ * - Two `Date` or `module:sap/ui/core/date/UI5Date` objects, or
62967
+ * - Two strings as formatted start and end dates based on the `source` format option, or
62968
+ * - Two numbers, representing the milliseconds of the timestamps based on the UNIX epoch if the `source`
62969
+ * format option is used and `source.pattern` is `"timestamp"`.
61719
62970
  */
61720
62971
  parseValue(
61721
62972
  /**
61722
- * The value to be parsed
62973
+ * The value to be parsed; the empty string is parsed to `[null, null]`
61723
62974
  */
61724
- sValue: any,
62975
+ sValue: string,
61725
62976
  /**
61726
- * The source type
62977
+ * The source type (the expected type of `sValue`); it must be either "string" or a type with "string" as
62978
+ * its {@link sap.ui.base.DataType#getPrimitiveType primitive type}. See {@link sap.ui.model.odata.type}
62979
+ * for more information.
61727
62980
  */
61728
- sInternalType: string,
62981
+ sSourceType: string
62982
+ ): Array<
62983
+ | Date
62984
+ | import("sap/ui/core/date/UI5Date").default
62985
+ | int
62986
+ | string
62987
+ | null
62988
+ >;
62989
+ /**
62990
+ * Validates whether the given date interval values are valid and meet the given constraints.
62991
+ */
62992
+ validateValue(
61729
62993
  /**
61730
- * The current values of all binding parts
62994
+ * The start and the end date of the interval to be validated as retrieved by {@link #parseValue}
61731
62995
  */
61732
- aCurrentValues: any[]
61733
- ): any[];
62996
+ aValues: Array<
62997
+ | Date
62998
+ | import("sap/ui/core/date/UI5Date").default
62999
+ | int
63000
+ | string
63001
+ | null
63002
+ >
63003
+ ): void;
61734
63004
  }
61735
63005
  /**
61736
63006
  * This class represents datetime simple types.
@@ -64480,8 +65750,7 @@ declare namespace sap {
64480
65750
  */
64481
65751
  vOperator?:
64482
65752
  | sap.ui.model.FilterOperator
64483
- | ((p1: any) => boolean)
64484
- | boolean,
65753
+ | ((p1: any) => boolean | boolean),
64485
65754
  /**
64486
65755
  * First value to use with the given filter operator
64487
65756
  */
@@ -64551,7 +65820,7 @@ declare namespace sap {
64551
65820
  *
64552
65821
  * @returns The comparator function
64553
65822
  */
64554
- getComparator(): ((p1: any) => boolean) | undefined;
65823
+ getComparator(): (p1: any) => boolean | undefined;
64555
65824
  /**
64556
65825
  * @SINCE 1.96.0
64557
65826
  *
@@ -64596,7 +65865,7 @@ declare namespace sap {
64596
65865
  *
64597
65866
  * @returns The test function
64598
65867
  */
64599
- getTest(): ((p1: any, p2: any) => boolean) | undefined;
65868
+ getTest(): (p1: any, p2: any) => boolean | undefined;
64600
65869
  /**
64601
65870
  * @SINCE 1.96.0
64602
65871
  *
@@ -73985,6 +75254,8 @@ declare namespace sap {
73985
75254
 
73986
75255
  "sap/ui/core/date/CalendarWeekNumbering": undefined;
73987
75256
 
75257
+ "sap/ui/core/date/UI5Date": undefined;
75258
+
73988
75259
  "sap/ui/core/date/UniversalDate": undefined;
73989
75260
 
73990
75261
  "sap/ui/core/date/UniversalDateUtils": undefined;