@openui5/types 1.125.0 → 1.126.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.125.0
282
+ // For Library Version: 1.126.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -3163,7 +3163,7 @@ declare module "sap/base/util/ObjectPath" {
3163
3163
  * is returned.
3164
3164
  *
3165
3165
  * The provided object path is used to navigate through the nested objects, starting with the root context.
3166
- * If no root context is provided, the object path begins with `window`.
3166
+ * If no root context is provided, the object path begins with `globalThis`.
3167
3167
  *
3168
3168
  *
3169
3169
  * @returns Returns the value located in the provided path, or `undefined` if the path does not exist completely.
@@ -13616,28 +13616,48 @@ declare module "sap/ui/core/library" {
13616
13616
  /**
13617
13617
  * Marker interface for controls that can serve as a menu for a table column header.
13618
13618
  *
13619
- * Implementation of this interface implements the `openBy` and `getAriaHasPopupType` methods.
13619
+ * Implementation of this interface should include the `openBy`, `close`, `isOpen` and `getAriaHasPopupType`
13620
+ * methods and fire the `beforeOpen` and `afterClose` events.
13621
+ *
13622
+ * Refer to the base class {@link sap.m.table.columnmenu.MenuBase} for a detailed API description.
13620
13623
  *
13621
13624
  * @since 1.98
13622
- * @experimental (since 1.98)
13623
13625
  */
13624
13626
  export interface IColumnHeaderMenu {
13625
13627
  __implements__sap_ui_core_IColumnHeaderMenu: boolean;
13626
13628
 
13627
13629
  /**
13628
- * Returns the sap.ui.core.aria.HasPopup<\code> type of the menu.
13630
+ * Closes the menu.
13631
+ *
13632
+ * @since 1.126
13633
+ */
13634
+ close(): void;
13635
+ /**
13636
+ * Returns the `sap.ui.core.aria.HasPopup` type of the menu.
13629
13637
  *
13630
13638
  * @since 1.98.0
13631
- * @experimental (since 1.98)
13632
13639
  *
13633
- * @returns sap.ui.core.aria.HasPopup<\code> type of the menu
13640
+ * @returns `sap.ui.core.aria.HasPopup` type of the menu
13634
13641
  */
13635
13642
  getAriaHasPopupType(): aria.HasPopup | keyof typeof aria.HasPopup;
13643
+ /**
13644
+ * Determines whether the menu is open.
13645
+ *
13646
+ * @since 1.126
13647
+ *
13648
+ * @returns `true` if the menu is open, `false` otherwise
13649
+ */
13650
+ isOpen(
13651
+ /**
13652
+ * The element for which the menu is opened. If it is an `HTMLElement`, the closest control is passed for
13653
+ * this event (if it exists).
13654
+ */
13655
+ openBy: UI5Element
13656
+ ): boolean;
13636
13657
  /**
13637
13658
  * Opens the menu using the column header.
13638
13659
  *
13639
13660
  * @since 1.98
13640
- * @experimental (since 1.98)
13641
13661
  */
13642
13662
  openBy(
13643
13663
  /**
@@ -22112,6 +22132,26 @@ declare module "sap/ui/core/dnd/DragDropBase" {
22112
22132
  * @returns Value of property `groupName`
22113
22133
  */
22114
22134
  getGroupName(): string;
22135
+ /**
22136
+ * Gets current value of property {@link #getKeyboardHandling keyboardHandling}.
22137
+ *
22138
+ * Indicates limited keyboard handling support for drag-and-drop configurations defined for aggregation
22139
+ * reordering.
22140
+ *
22141
+ * **Note:** If the drag-and-drop configuration is defined for the aggregation reordering of a control (only
22142
+ * if the `dropPosition` property is `Between`), the `Ctrl/Cmd + Left/Right` keys for horizontal move or
22143
+ * the `Ctrl/Cmd + Up/Down` keys for vertical move trigger a series of pseudo drag-and-drop events, such
22144
+ * as `dragstart, dragenter, drop, dragend`, to create an artificial drag-and-drop action. This keyboard
22145
+ * handling might not be suitable for every control where aggregation reordering is defined, and in such
22146
+ * cases, this property must not be set to `true`.
22147
+ *
22148
+ * Default value is `false`.
22149
+ *
22150
+ * @since 1.126
22151
+ *
22152
+ * @returns Value of property `keyboardHandling`
22153
+ */
22154
+ getKeyboardHandling(): boolean;
22115
22155
  /**
22116
22156
  * Sets a new value for property {@link #getEnabled enabled}.
22117
22157
  *
@@ -22148,6 +22188,33 @@ declare module "sap/ui/core/dnd/DragDropBase" {
22148
22188
  */
22149
22189
  sGroupName?: string
22150
22190
  ): this;
22191
+ /**
22192
+ * Sets a new value for property {@link #getKeyboardHandling keyboardHandling}.
22193
+ *
22194
+ * Indicates limited keyboard handling support for drag-and-drop configurations defined for aggregation
22195
+ * reordering.
22196
+ *
22197
+ * **Note:** If the drag-and-drop configuration is defined for the aggregation reordering of a control (only
22198
+ * if the `dropPosition` property is `Between`), the `Ctrl/Cmd + Left/Right` keys for horizontal move or
22199
+ * the `Ctrl/Cmd + Up/Down` keys for vertical move trigger a series of pseudo drag-and-drop events, such
22200
+ * as `dragstart, dragenter, drop, dragend`, to create an artificial drag-and-drop action. This keyboard
22201
+ * handling might not be suitable for every control where aggregation reordering is defined, and in such
22202
+ * cases, this property must not be set to `true`.
22203
+ *
22204
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
22205
+ *
22206
+ * Default value is `false`.
22207
+ *
22208
+ * @since 1.126
22209
+ *
22210
+ * @returns Reference to `this` in order to allow method chaining
22211
+ */
22212
+ setKeyboardHandling(
22213
+ /**
22214
+ * New value for property `keyboardHandling`
22215
+ */
22216
+ bKeyboardHandling?: boolean
22217
+ ): this;
22151
22218
  }
22152
22219
  /**
22153
22220
  * Describes the settings that can be provided to the DragDropBase constructor.
@@ -22165,6 +22232,21 @@ declare module "sap/ui/core/dnd/DragDropBase" {
22165
22232
  * @since 1.56
22166
22233
  */
22167
22234
  enabled?: boolean | PropertyBindingInfo | `{${string}}`;
22235
+
22236
+ /**
22237
+ * Indicates limited keyboard handling support for drag-and-drop configurations defined for aggregation
22238
+ * reordering.
22239
+ *
22240
+ * **Note:** If the drag-and-drop configuration is defined for the aggregation reordering of a control (only
22241
+ * if the `dropPosition` property is `Between`), the `Ctrl/Cmd + Left/Right` keys for horizontal move or
22242
+ * the `Ctrl/Cmd + Up/Down` keys for vertical move trigger a series of pseudo drag-and-drop events, such
22243
+ * as `dragstart, dragenter, drop, dragend`, to create an artificial drag-and-drop action. This keyboard
22244
+ * handling might not be suitable for every control where aggregation reordering is defined, and in such
22245
+ * cases, this property must not be set to `true`.
22246
+ *
22247
+ * @since 1.126
22248
+ */
22249
+ keyboardHandling?: boolean | PropertyBindingInfo | `{${string}}`;
22168
22250
  }
22169
22251
  }
22170
22252
 
@@ -22953,24 +23035,32 @@ declare module "sap/ui/core/dnd/DragAndDrop" {
22953
23035
  * Returns the dragged control, if available within the same UI5 application frame.
22954
23036
  *
22955
23037
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23038
+ *
23039
+ * @returns The dragged control
22956
23040
  */
22957
23041
  getDragControl(): UI5Element | null;
22958
23042
  /**
22959
23043
  * The valid drop target underneath the dragged control.
22960
23044
  *
22961
23045
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23046
+ *
23047
+ * @returns The drop target
22962
23048
  */
22963
23049
  getDropControl(): UI5Element | null;
22964
23050
  /**
22965
23051
  * Returns the drop configuration corresponding to the drop control.
22966
23052
  *
22967
23053
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23054
+ *
23055
+ * @returns The drop configuration
22968
23056
  */
22969
23057
  getDropInfo(): DropInfo | null;
22970
23058
  /**
22971
23059
  * Returns the calculated position of the drop action relative to the valid dropped control.
22972
23060
  *
22973
23061
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23062
+ *
23063
+ * @returns The calculated position
22974
23064
  */
22975
23065
  getDropPosition():
22976
23066
  | dnd.RelativeDropPosition
@@ -23026,11 +23116,16 @@ declare module "sap/ui/core/dnd/DragAndDrop" {
23026
23116
  sData: string
23027
23117
  ): void;
23028
23118
  /**
23029
- * Set the valid drop control.
23119
+ * Set the valid target.
23030
23120
  *
23031
23121
  * @ui5-protected Do not call from applications (only from related classes in the framework)
23032
23122
  */
23033
- setDropControl(): void;
23123
+ setDropControl(
23124
+ /**
23125
+ * The dropped target
23126
+ */
23127
+ oControl: UI5Element
23128
+ ): void;
23034
23129
  /**
23035
23130
  * Defines the visual configuration of the drop indicator for the current `DropInfo`.
23036
23131
  *
@@ -28102,55 +28197,6 @@ declare module "sap/ui/core/hyphenation/Hyphenation" {
28102
28197
  * @returns Metadata object describing this class
28103
28198
  */
28104
28199
  static getMetadata(): ManagedObjectMetadata;
28105
- /**
28106
- * Attaches event handler `fnFunction` to the {@link #event:error error} event of this `sap.ui.core.hyphenation.Hyphenation`.
28107
- *
28108
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
28109
- * otherwise it will be bound to this `sap.ui.core.hyphenation.Hyphenation` itself.
28110
- *
28111
- * Fired if an error with initialization or hyphenation occurs.
28112
- *
28113
- *
28114
- * @returns Reference to `this` in order to allow method chaining
28115
- */
28116
- attachError(
28117
- /**
28118
- * An application-specific payload object that will be passed to the event handler along with the event
28119
- * object when firing the event
28120
- */
28121
- oData: object,
28122
- /**
28123
- * The function to be called when the event occurs
28124
- */
28125
- fnFunction: (p1: Hyphenation$ErrorEvent) => void,
28126
- /**
28127
- * Context object to call the event handler with. Defaults to this `sap.ui.core.hyphenation.Hyphenation`
28128
- * itself
28129
- */
28130
- oListener?: object
28131
- ): this;
28132
- /**
28133
- * Attaches event handler `fnFunction` to the {@link #event:error error} event of this `sap.ui.core.hyphenation.Hyphenation`.
28134
- *
28135
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
28136
- * otherwise it will be bound to this `sap.ui.core.hyphenation.Hyphenation` itself.
28137
- *
28138
- * Fired if an error with initialization or hyphenation occurs.
28139
- *
28140
- *
28141
- * @returns Reference to `this` in order to allow method chaining
28142
- */
28143
- attachError(
28144
- /**
28145
- * The function to be called when the event occurs
28146
- */
28147
- fnFunction: (p1: Hyphenation$ErrorEvent) => void,
28148
- /**
28149
- * Context object to call the event handler with. Defaults to this `sap.ui.core.hyphenation.Hyphenation`
28150
- * itself
28151
- */
28152
- oListener?: object
28153
- ): this;
28154
28200
  /**
28155
28201
  * Checks if native hyphenation works in the current browser for the given language. This check is performed
28156
28202
  * against the value of the "lang" HTML attribute of the page.
@@ -28178,37 +28224,6 @@ declare module "sap/ui/core/hyphenation/Hyphenation" {
28178
28224
  */
28179
28225
  sLang?: string
28180
28226
  ): boolean | null;
28181
- /**
28182
- * Detaches event handler `fnFunction` from the {@link #event:error error} event of this `sap.ui.core.hyphenation.Hyphenation`.
28183
- *
28184
- * The passed function and listener object must match the ones used for event registration.
28185
- *
28186
- *
28187
- * @returns Reference to `this` in order to allow method chaining
28188
- */
28189
- detachError(
28190
- /**
28191
- * The function to be called, when the event occurs
28192
- */
28193
- fnFunction: (p1: Hyphenation$ErrorEvent) => void,
28194
- /**
28195
- * Context object on which the given function had to be called
28196
- */
28197
- oListener?: object
28198
- ): this;
28199
- /**
28200
- * Fires event {@link #event:error error} to attached listeners.
28201
- *
28202
- * @ui5-protected Do not call from applications (only from related classes in the framework)
28203
- *
28204
- * @returns Reference to `this` in order to allow method chaining
28205
- */
28206
- fireError(
28207
- /**
28208
- * Parameters to pass along with the event
28209
- */
28210
- mParameters?: Hyphenation$ErrorEventParameters
28211
- ): this;
28212
28227
  /**
28213
28228
  * What languages were initialized with {@link sap.ui.core.hyphenation.Hyphenation#initialize Hyphenation#initialize}
28214
28229
  *
@@ -28280,12 +28295,7 @@ declare module "sap/ui/core/hyphenation/Hyphenation" {
28280
28295
  /**
28281
28296
  * Describes the settings that can be provided to the Hyphenation constructor.
28282
28297
  */
28283
- export interface $HyphenationSettings extends $ManagedObjectSettings {
28284
- /**
28285
- * Fired if an error with initialization or hyphenation occurs.
28286
- */
28287
- error?: (oEvent: Hyphenation$ErrorEvent) => void;
28288
- }
28298
+ export interface $HyphenationSettings extends $ManagedObjectSettings {}
28289
28299
 
28290
28300
  /**
28291
28301
  * Parameters of the Hyphenation#error event.
@@ -30992,7 +31002,8 @@ declare module "sap/ui/core/LocaleData" {
30992
31002
  import Metadata from "sap/ui/base/Metadata";
30993
31003
 
30994
31004
  /**
30995
- * Provides access to locale-specific data, such as date formats, number formats, and currencies.
31005
+ * Provides access to locale-specific data, such as date formats, number formats, and currencies. For more
31006
+ * information on terminology, such as field names used in the methods of this class, see {@link https://cldr.unicode.org/ Unicode CLDR}.
30996
31007
  */
30997
31008
  export default class LocaleData extends BaseObject {
30998
31009
  /**
@@ -31054,7 +31065,7 @@ declare module "sap/ui/core/LocaleData" {
31054
31065
  */
31055
31066
  firstDayStartsFirstWeek(): boolean;
31056
31067
  /**
31057
- * Returns the defined pattern for representing the calendar week number.
31068
+ * Returns the pattern for representing the calendar week number in the given style.
31058
31069
  *
31059
31070
  * @since 1.32.0
31060
31071
  *
@@ -31062,16 +31073,18 @@ declare module "sap/ui/core/LocaleData" {
31062
31073
  */
31063
31074
  getCalendarWeek(
31064
31075
  /**
31065
- * the style of the pattern. It can only be either "wide" or "narrow".
31076
+ * the style of the pattern
31066
31077
  */
31067
- sStyle: string,
31078
+ sStyle: "narrow" | "wide",
31068
31079
  /**
31069
31080
  * the week number
31070
31081
  */
31071
31082
  iWeekNumber: int
31072
31083
  ): string;
31073
31084
  /**
31074
- * Get combined datetime pattern with given date and time style.
31085
+ * Get combined datetime pattern with given date and time style. The combined datetime pattern is the datetime
31086
+ * pattern as returned by {@link #getDateTimePattern}, where date and time placeholder are replaced with
31087
+ * the corresponding patterns for the given styles.
31075
31088
  *
31076
31089
  *
31077
31090
  * @returns the combined datetime pattern
@@ -31080,11 +31093,11 @@ declare module "sap/ui/core/LocaleData" {
31080
31093
  /**
31081
31094
  * the required style for the date part
31082
31095
  */
31083
- sDateStyle: string,
31096
+ sDateStyle: "full" | "long" | "medium" | "short",
31084
31097
  /**
31085
31098
  * the required style for the time part
31086
31099
  */
31087
- sTimeStyle: string,
31100
+ sTimeStyle: "full" | "long" | "medium" | "short",
31088
31101
  /**
31089
31102
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31090
31103
  * or calculated from locale.
@@ -31140,28 +31153,29 @@ declare module "sap/ui/core/LocaleData" {
31140
31153
  sCurrency: string
31141
31154
  ): int;
31142
31155
  /**
31143
- * Returns the short currency formats (like 1K USD, 1M USD....).
31156
+ * Returns the short currency format (like 1K USD, 1M USD....) of the given number in the given style and
31157
+ * plural category.
31144
31158
  *
31145
31159
  * @since 1.51.0
31146
31160
  *
31147
- * @returns decimal format
31161
+ * @returns the short currency format
31148
31162
  */
31149
31163
  getCurrencyFormat(
31150
31164
  /**
31151
- * short
31165
+ * the style
31152
31166
  */
31153
- sStyle: string,
31167
+ sStyle: "short",
31154
31168
  /**
31155
- * 1000, 10000 ...
31169
+ * the number in string representation as power of ten, for example "1000" or "10000"
31156
31170
  */
31157
31171
  sNumber: string,
31158
31172
  /**
31159
- * one or other (if not exists other is used)
31173
+ * the plural category; defaults to "other" if the given plural category does not exist for this locale
31160
31174
  */
31161
- sPlural: string
31175
+ sPlural?: "few" | "many" | "one" | "other" | "two" | "zero"
31162
31176
  ): string;
31163
31177
  /**
31164
- * Get currency format pattern.
31178
+ * Get currency format pattern for the given context.
31165
31179
  *
31166
31180
  * CLDR format pattern:
31167
31181
  * See:
@@ -31172,9 +31186,9 @@ declare module "sap/ui/core/LocaleData" {
31172
31186
  */
31173
31187
  getCurrencyPattern(
31174
31188
  /**
31175
- * the context of the currency pattern (standard or accounting)
31189
+ * the context of the currency pattern
31176
31190
  */
31177
- sContext: string
31191
+ sContext: "accounting" | "standard"
31178
31192
  ): string;
31179
31193
  /**
31180
31194
  * Returns the currency symbol for the specified currency, if no symbol is found the ISO 4217 currency code
@@ -31259,7 +31273,7 @@ declare module "sap/ui/core/LocaleData" {
31259
31273
  sCalendarType?: CalendarType
31260
31274
  ): string | string[];
31261
31275
  /**
31262
- * Get date pattern in format "short", "medium", "long" or "full".
31276
+ * Get date pattern in the given style.
31263
31277
  *
31264
31278
  *
31265
31279
  * @returns the selected date pattern
@@ -31268,7 +31282,7 @@ declare module "sap/ui/core/LocaleData" {
31268
31282
  /**
31269
31283
  * the required style for the date pattern
31270
31284
  */
31271
- sStyle: string,
31285
+ sStyle: "full" | "long" | "medium" | "short",
31272
31286
  /**
31273
31287
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31274
31288
  * or calculated from locale.
@@ -31276,7 +31290,7 @@ declare module "sap/ui/core/LocaleData" {
31276
31290
  sCalendarType?: CalendarType
31277
31291
  ): string;
31278
31292
  /**
31279
- * Get datetime pattern in style "short", "medium", "long" or "full".
31293
+ * Get datetime pattern in the given style.
31280
31294
  *
31281
31295
  *
31282
31296
  * @returns the selected datetime pattern
@@ -31285,7 +31299,7 @@ declare module "sap/ui/core/LocaleData" {
31285
31299
  /**
31286
31300
  * the required style for the datetime pattern
31287
31301
  */
31288
- sStyle: string,
31302
+ sStyle: "full" | "long" | "medium" | "short",
31289
31303
  /**
31290
31304
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31291
31305
  * or calculated from locale.
@@ -31293,7 +31307,7 @@ declare module "sap/ui/core/LocaleData" {
31293
31307
  sCalendarType?: CalendarType
31294
31308
  ): string;
31295
31309
  /**
31296
- * Get day periods in width "narrow", "abbreviated" or "wide".
31310
+ * Get day periods in the given width.
31297
31311
  *
31298
31312
  *
31299
31313
  * @returns array of day periods (AM, PM)
@@ -31302,15 +31316,15 @@ declare module "sap/ui/core/LocaleData" {
31302
31316
  /**
31303
31317
  * the required width for the day period names
31304
31318
  */
31305
- sWidth: string,
31319
+ sWidth: "abbreviated" | "narrow" | "wide",
31306
31320
  /**
31307
31321
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31308
31322
  * or calculated from locale.
31309
31323
  */
31310
31324
  sCalendarType?: CalendarType
31311
- ): any[];
31325
+ ): string[];
31312
31326
  /**
31313
- * Get standalone day periods in width "narrow", "abbreviated" or "wide".
31327
+ * Get standalone day periods in the given width.
31314
31328
  *
31315
31329
  *
31316
31330
  * @returns array of day periods (AM, PM)
@@ -31319,15 +31333,15 @@ declare module "sap/ui/core/LocaleData" {
31319
31333
  /**
31320
31334
  * the required width for the day period names
31321
31335
  */
31322
- sWidth: string,
31336
+ sWidth: "abbreviated" | "narrow" | "wide",
31323
31337
  /**
31324
31338
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31325
31339
  * or calculated from locale.
31326
31340
  */
31327
31341
  sCalendarType?: CalendarType
31328
- ): any[];
31342
+ ): string[];
31329
31343
  /**
31330
- * Get day names in width "narrow", "abbreviated" or "wide".
31344
+ * Get day names in the given width.
31331
31345
  *
31332
31346
  *
31333
31347
  * @returns array of day names (starting with Sunday)
@@ -31336,15 +31350,15 @@ declare module "sap/ui/core/LocaleData" {
31336
31350
  /**
31337
31351
  * the required width for the day names
31338
31352
  */
31339
- sWidth: string,
31353
+ sWidth: "abbreviated" | "narrow" | "short" | "wide",
31340
31354
  /**
31341
31355
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31342
31356
  * or calculated from locale.
31343
31357
  */
31344
31358
  sCalendarType?: CalendarType
31345
- ): any[];
31359
+ ): string[];
31346
31360
  /**
31347
- * Get standalone day names in width "narrow", "abbreviated" or "wide".
31361
+ * Get standalone day names in the given width.
31348
31362
  *
31349
31363
  *
31350
31364
  * @returns array of day names (starting with Sunday)
@@ -31353,33 +31367,34 @@ declare module "sap/ui/core/LocaleData" {
31353
31367
  /**
31354
31368
  * the required width for the day names
31355
31369
  */
31356
- sWidth: string,
31370
+ sWidth: "abbreviated" | "narrow" | "short" | "wide",
31357
31371
  /**
31358
31372
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31359
31373
  * or calculated from locale.
31360
31374
  */
31361
31375
  sCalendarType?: CalendarType
31362
- ): any[];
31376
+ ): string[];
31363
31377
  /**
31364
- * Returns the short decimal formats (like 1K, 1M....).
31378
+ * Returns the short decimal format (like 1K, 1M....) of the given number in the given style and plural
31379
+ * category.
31365
31380
  *
31366
31381
  * @since 1.25.0
31367
31382
  *
31368
- * @returns decimal format
31383
+ * @returns the short decimal format
31369
31384
  */
31370
31385
  getDecimalFormat(
31371
31386
  /**
31372
- * short or long
31387
+ * the style
31373
31388
  */
31374
- sStyle: string,
31389
+ sStyle: "long" | "short",
31375
31390
  /**
31376
- * 1000, 10000 ...
31391
+ * the number in string representation as power of ten, for example "1000" or "10000"
31377
31392
  */
31378
31393
  sNumber: string,
31379
31394
  /**
31380
- * one or other (if not exists other is used)
31395
+ * the plural category; defaults to "other" if the given plural category does not exist for this locale
31381
31396
  */
31382
- sPlural: string
31397
+ sPlural?: "one" | "other"
31383
31398
  ): string;
31384
31399
  /**
31385
31400
  * Get decimal format pattern.
@@ -31389,7 +31404,7 @@ declare module "sap/ui/core/LocaleData" {
31389
31404
  */
31390
31405
  getDecimalPattern(): string;
31391
31406
  /**
31392
- * Returns the display name for a time unit (second, minute, hour, day, week, month, year).
31407
+ * Returns the display name for a time unit of the given type.
31393
31408
  *
31394
31409
  * @since 1.34.0
31395
31410
  *
@@ -31397,13 +31412,24 @@ declare module "sap/ui/core/LocaleData" {
31397
31412
  */
31398
31413
  getDisplayName(
31399
31414
  /**
31400
- * Type (second, minute, hour, day, week, month, year)
31415
+ * the type
31401
31416
  */
31402
- sType: string,
31417
+ sType:
31418
+ | "day"
31419
+ | "era"
31420
+ | "hour"
31421
+ | "minute"
31422
+ | "month"
31423
+ | "quarter"
31424
+ | "second"
31425
+ | "week"
31426
+ | "weekday"
31427
+ | "year"
31428
+ | "zone",
31403
31429
  /**
31404
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31430
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31405
31431
  */
31406
- sStyle?: string
31432
+ sStyle?: "narrow" | "short" | "wide"
31407
31433
  ): string;
31408
31434
  /**
31409
31435
  * Returns the map of era IDs to era dates.
@@ -31417,9 +31443,9 @@ declare module "sap/ui/core/LocaleData" {
31417
31443
  * the type of calendar
31418
31444
  */
31419
31445
  sCalendarType?: CalendarType
31420
- ): any[];
31446
+ ): object[];
31421
31447
  /**
31422
- * Returns array of eras.
31448
+ * Returns array of eras in the given width.
31423
31449
  *
31424
31450
  * @since 1.32.0
31425
31451
  *
@@ -31427,14 +31453,15 @@ declare module "sap/ui/core/LocaleData" {
31427
31453
  */
31428
31454
  getEras(
31429
31455
  /**
31430
- * the style of the era name. It can be 'wide', 'abbreviated' or 'narrow'
31456
+ * the width of the era name
31431
31457
  */
31432
- sWidth: string,
31458
+ sWidth: "abbreviated" | "narrow" | "wide",
31433
31459
  /**
31434
- * the type of calendar
31460
+ * The type of calendar; defaults to the calendar type either set in configuration or calculated from the
31461
+ * locale
31435
31462
  */
31436
31463
  sCalendarType?: CalendarType
31437
- ): any[];
31464
+ ): string[];
31438
31465
  /**
31439
31466
  * Returns the day that usually is regarded as the first day of a week in the current locale.
31440
31467
  *
@@ -31497,16 +31524,16 @@ declare module "sap/ui/core/LocaleData" {
31497
31524
  */
31498
31525
  getLanguages(): Record<string, string>;
31499
31526
  /**
31500
- * Get lenient number symbols for "plusSign" or "minusSign".
31527
+ * Get lenient symbols for the sign of a number for the given symbol type.
31501
31528
  *
31502
31529
  *
31503
- * @returns the selected lenient number symbols, e.g. "-‒⁻₋−➖﹣"
31530
+ * @returns the selected lenient symbols for the sign of a number, e.g. "-‒⁻₋−➖﹣"
31504
31531
  */
31505
31532
  getLenientNumberSymbols(
31506
31533
  /**
31507
31534
  * the required type of symbol
31508
31535
  */
31509
- sType: string
31536
+ sType: "minusSign" | "plusSign"
31510
31537
  ): string;
31511
31538
  /**
31512
31539
  * Returns the required minimal number of days for the first week of a year.
@@ -31524,19 +31551,19 @@ declare module "sap/ui/core/LocaleData" {
31524
31551
  */
31525
31552
  getMinimalDaysInFirstWeek(): int;
31526
31553
  /**
31527
- * Get miscellaneous pattern.
31554
+ * Get miscellaneous pattern for the given name.
31528
31555
  *
31529
31556
  *
31530
31557
  * @returns The pattern
31531
31558
  */
31532
31559
  getMiscPattern(
31533
31560
  /**
31534
- * the name of the misc pattern, can be "approximately", "atLeast", "atMost" or "range"
31561
+ * the name of the misc pattern
31535
31562
  */
31536
- sName: string
31563
+ sName: "approximately" | "atLeast" | "atMost" | "range"
31537
31564
  ): string;
31538
31565
  /**
31539
- * Get month names in width "narrow", "abbreviated" or "wide".
31566
+ * Get month names in the given width.
31540
31567
  *
31541
31568
  *
31542
31569
  * @returns The array of month names
@@ -31545,14 +31572,15 @@ declare module "sap/ui/core/LocaleData" {
31545
31572
  /**
31546
31573
  * The required width for the month names
31547
31574
  */
31548
- sWidth: "narrow" | "abbreviated" | "wide",
31575
+ sWidth: "abbreviated" | "narrow" | "wide",
31549
31576
  /**
31550
- * The type of calendar; defaults to the calendar type either set in configuration or calculated from locale
31577
+ * The type of calendar; defaults to the calendar type either set in configuration or calculated from the
31578
+ * locale
31551
31579
  */
31552
31580
  sCalendarType?: CalendarType
31553
31581
  ): string[];
31554
31582
  /**
31555
- * Get standalone month names in width "narrow", "abbreviated" or "wide".
31583
+ * Get standalone month names in the given width.
31556
31584
  *
31557
31585
  *
31558
31586
  * @returns The array of standalone month names
@@ -31561,14 +31589,15 @@ declare module "sap/ui/core/LocaleData" {
31561
31589
  /**
31562
31590
  * The required width for the month names
31563
31591
  */
31564
- sWidth: "narrow" | "abbreviated" | "wide",
31592
+ sWidth: "abbreviated" | "narrow" | "wide",
31565
31593
  /**
31566
- * The type of calendar; defaults to the calendar type either set in configuration or calculated from locale
31594
+ * The type of calendar; defaults to the calendar type either set in configuration or calculated from the
31595
+ * locale
31567
31596
  */
31568
31597
  sCalendarType?: CalendarType
31569
31598
  ): string[];
31570
31599
  /**
31571
- * Get number symbol "decimal", "group", "plusSign", "minusSign", "percentSign".
31600
+ * Get number symbol for the given type.
31572
31601
  *
31573
31602
  *
31574
31603
  * @returns the selected number symbol
@@ -31577,15 +31606,15 @@ declare module "sap/ui/core/LocaleData" {
31577
31606
  /**
31578
31607
  * the required type of symbol
31579
31608
  */
31580
- sType: string
31609
+ sType: "decimal" | "group" | "minusSign" | "percentSign" | "plusSign"
31581
31610
  ): string;
31582
31611
  /**
31583
- * Get orientation (left-to-right or right-to-left).
31612
+ * Gets the text orientation.
31584
31613
  *
31585
31614
  *
31586
- * @returns character orientation for this locale
31615
+ * @returns text orientation
31587
31616
  */
31588
- getOrientation(): string;
31617
+ getOrientation(): "left-to-right" | "right-to-left";
31589
31618
  /**
31590
31619
  * Get percent format pattern.
31591
31620
  *
@@ -31600,7 +31629,7 @@ declare module "sap/ui/core/LocaleData" {
31600
31629
  *
31601
31630
  * @returns The array of plural categories
31602
31631
  */
31603
- getPluralCategories(): any[];
31632
+ getPluralCategories(): string[];
31604
31633
  /**
31605
31634
  * Returns the plural category (zero, one, two, few, many or other) for the given number value. The number
31606
31635
  * must be passed as an unformatted number string with dot as decimal separator (for example "12345.67").
@@ -31634,15 +31663,15 @@ declare module "sap/ui/core/LocaleData" {
31634
31663
  */
31635
31664
  getPreferredCalendarType(): CalendarType;
31636
31665
  /**
31637
- * Returns the preferred hour pattern symbol (h for 12, H for 24 hours) for the current locale.
31666
+ * Returns the preferred hour pattern symbol ("h" for 12, "H" for 24 hours) for the current locale.
31638
31667
  *
31639
31668
  * @since 1.34
31640
31669
  *
31641
31670
  * @returns the preferred hour symbol
31642
31671
  */
31643
- getPreferredHourSymbol(): string;
31672
+ getPreferredHourSymbol(): "h" | "H";
31644
31673
  /**
31645
- * Get quarter names in width "narrow", "abbreviated" or "wide".
31674
+ * Get quarter names in the given width.
31646
31675
  *
31647
31676
  *
31648
31677
  * @returns array of quarters
@@ -31651,15 +31680,15 @@ declare module "sap/ui/core/LocaleData" {
31651
31680
  /**
31652
31681
  * the required width for the quarter names
31653
31682
  */
31654
- sWidth: string,
31683
+ sWidth: "abbreviated" | "narrow" | "wide",
31655
31684
  /**
31656
31685
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31657
31686
  * or calculated from locale.
31658
31687
  */
31659
31688
  sCalendarType?: CalendarType
31660
- ): any[];
31689
+ ): string[];
31661
31690
  /**
31662
- * Get standalone quarter names in width "narrow", "abbreviated" or "wide".
31691
+ * Get standalone quarter names in the given width.
31663
31692
  *
31664
31693
  *
31665
31694
  * @returns array of quarters
@@ -31668,13 +31697,13 @@ declare module "sap/ui/core/LocaleData" {
31668
31697
  /**
31669
31698
  * the required width for the quarter names
31670
31699
  */
31671
- sWidth: string,
31700
+ sWidth: "abbreviated" | "narrow" | "wide",
31672
31701
  /**
31673
31702
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31674
31703
  * or calculated from locale.
31675
31704
  */
31676
31705
  sCalendarType?: CalendarType
31677
- ): any[];
31706
+ ): string[];
31678
31707
  /**
31679
31708
  * Returns the relative day resource pattern (like "Today", "Yesterday", "{0} days ago") based on the given
31680
31709
  * difference of days (0 means today, 1 means tomorrow, -1 means yesterday, ...).
@@ -31689,9 +31718,9 @@ declare module "sap/ui/core/LocaleData" {
31689
31718
  */
31690
31719
  iDiff: int,
31691
31720
  /**
31692
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31721
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31693
31722
  */
31694
- sStyle?: string
31723
+ sStyle?: "narrow" | "short" | "wide"
31695
31724
  ): string;
31696
31725
  /**
31697
31726
  * Returns the relative resource pattern with unit 'hour' (like "in {0} hour(s)", "{0} hour(s) ago" under
@@ -31712,9 +31741,9 @@ declare module "sap/ui/core/LocaleData" {
31712
31741
  */
31713
31742
  iDiff: int,
31714
31743
  /**
31715
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31744
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31716
31745
  */
31717
- sStyle?: string
31746
+ sStyle?: "narrow" | "short" | "wide"
31718
31747
  ): string | null;
31719
31748
  /**
31720
31749
  * Returns the relative resource pattern with unit 'minute' (like "in {0} minute(s)", "{0} minute(s) ago"
@@ -31734,9 +31763,9 @@ declare module "sap/ui/core/LocaleData" {
31734
31763
  */
31735
31764
  iDiff: int,
31736
31765
  /**
31737
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31766
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31738
31767
  */
31739
- sStyle?: string
31768
+ sStyle?: "narrow" | "short" | "wide"
31740
31769
  ): string | null;
31741
31770
  /**
31742
31771
  * Returns the relative month resource pattern (like "This month", "Last month", "{0} months ago") based
@@ -31752,9 +31781,9 @@ declare module "sap/ui/core/LocaleData" {
31752
31781
  */
31753
31782
  iDiff: int,
31754
31783
  /**
31755
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31784
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31756
31785
  */
31757
- sStyle?: string
31786
+ sStyle?: "narrow" | "short" | "wide"
31758
31787
  ): string;
31759
31788
  /**
31760
31789
  * Returns the relative format pattern with given scale (year, month, week, ...) and difference value.
@@ -31767,7 +31796,7 @@ declare module "sap/ui/core/LocaleData" {
31767
31796
  /**
31768
31797
  * the scale the relative pattern is needed for
31769
31798
  */
31770
- sScale: string,
31799
+ sScale: "day" | "hour" | "minute" | "month" | "second" | "week" | "year",
31771
31800
  /**
31772
31801
  * the difference in the given scale unit
31773
31802
  */
@@ -31777,9 +31806,9 @@ declare module "sap/ui/core/LocaleData" {
31777
31806
  */
31778
31807
  bFuture?: boolean,
31779
31808
  /**
31780
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31809
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31781
31810
  */
31782
- sStyle?: string
31811
+ sStyle?: "narrow" | "short" | "wide"
31783
31812
  ): string;
31784
31813
  /**
31785
31814
  * Returns relative time patterns for the given scales as an array of objects containing scale, value and
@@ -31807,12 +31836,14 @@ declare module "sap/ui/core/LocaleData" {
31807
31836
  /**
31808
31837
  * The scales for which the available patterns should be returned
31809
31838
  */
31810
- aScales: string[],
31839
+ aScales: Array<
31840
+ "day" | "hour" | "minute" | "month" | "second" | "week" | "year"
31841
+ >,
31811
31842
  /**
31812
- * Since 1.32.10 and 1.34.4, the style of the scale patterns; valid values are "wide", "short" and "narrow"
31843
+ * Since 1.32.10 and 1.34.4, the style of the scale patterns
31813
31844
  */
31814
- sStyle?: string
31815
- ): object[];
31845
+ sStyle?: "narrow" | "short" | "wide"
31846
+ ): RelativeTimePattern[];
31816
31847
  /**
31817
31848
  * Returns the relative resource pattern with unit 'second' (like now, "in {0} seconds", "{0} seconds ago"
31818
31849
  * under locale 'en') based on the given difference value (0 means now, positive value means in the future
@@ -31828,9 +31859,9 @@ declare module "sap/ui/core/LocaleData" {
31828
31859
  */
31829
31860
  iDiff: int,
31830
31861
  /**
31831
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31862
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31832
31863
  */
31833
- sStyle?: string
31864
+ sStyle?: "narrow" | "short" | "wide"
31834
31865
  ): string;
31835
31866
  /**
31836
31867
  * Returns the relative week resource pattern (like "This week", "Last week", "{0} weeks ago") based on
@@ -31846,9 +31877,9 @@ declare module "sap/ui/core/LocaleData" {
31846
31877
  */
31847
31878
  iDiff: int,
31848
31879
  /**
31849
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31880
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31850
31881
  */
31851
- sStyle?: string
31882
+ sStyle?: "narrow" | "short" | "wide"
31852
31883
  ): string;
31853
31884
  /**
31854
31885
  * Returns the relative year resource pattern (like "This year", "Last year", "{0} year ago") based on the
@@ -31864,9 +31895,9 @@ declare module "sap/ui/core/LocaleData" {
31864
31895
  */
31865
31896
  iDiff: int,
31866
31897
  /**
31867
- * Since 1.32.10 and 1.34.4, the style of the pattern; valid values are "wide", "short" and "narrow"
31898
+ * Since 1.32.10 and 1.34.4, the style of the pattern
31868
31899
  */
31869
- sStyle?: string
31900
+ sStyle?: "narrow" | "short" | "wide"
31870
31901
  ): string;
31871
31902
  /**
31872
31903
  * Retrieves the unit format pattern for a specific unit name considering the unit mappings.
@@ -31875,14 +31906,15 @@ declare module "sap/ui/core/LocaleData" {
31875
31906
  *
31876
31907
  * @since 1.54
31877
31908
  *
31878
- * @returns The unit format configuration for the given unit name
31909
+ * @returns The unit format pattern for the given unit name as a map from a pattern key like `"unitPattern-count-other"`
31910
+ * to the corresponding pattern
31879
31911
  */
31880
31912
  getResolvedUnitFormat(
31881
31913
  /**
31882
31914
  * unit name, e.g. "duration-hour" or "my"
31883
31915
  */
31884
31916
  sUnit: string
31885
- ): object;
31917
+ ): Record<string, string>;
31886
31918
  /**
31887
31919
  * Gets locale-specific script names, as available in the CLDR raw data.
31888
31920
  *
@@ -31905,16 +31937,16 @@ declare module "sap/ui/core/LocaleData" {
31905
31937
  */
31906
31938
  getTerritories(): Record<string, string>;
31907
31939
  /**
31908
- * Get time pattern in style "short", "medium", "long" or "full".
31940
+ * Get time pattern in the given style.
31909
31941
  *
31910
31942
  *
31911
31943
  * @returns the selected time pattern
31912
31944
  */
31913
31945
  getTimePattern(
31914
31946
  /**
31915
- * the required style for the date pattern
31947
+ * the required style for the time pattern
31916
31948
  */
31917
- sStyle: string,
31949
+ sStyle: "full" | "long" | "medium" | "short",
31918
31950
  /**
31919
31951
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
31920
31952
  * or calculated from locale.
@@ -31936,30 +31968,34 @@ declare module "sap/ui/core/LocaleData" {
31936
31968
  sUnit: string
31937
31969
  ): string;
31938
31970
  /**
31939
- * Retrieves the unit format pattern for a specific unit name.
31971
+ * Retrieves the unit format pattern for a specific unit name, see {@link #getResolvedUnitFormat} for an
31972
+ * example of a unit format pattern.
31940
31973
  *
31941
31974
  * Note: Does not take unit mapping into consideration.
31942
31975
  *
31943
31976
  * @since 1.54
31944
31977
  *
31945
- * @returns The unit format configuration for the given unit name
31978
+ * @returns The unit format pattern for the given unit name as a map from a pattern key like `"unitPattern-count-other"`
31979
+ * to the corresponding pattern
31946
31980
  */
31947
31981
  getUnitFormat(
31948
31982
  /**
31949
31983
  * unit name, e.g. "duration-hour"
31950
31984
  */
31951
31985
  sUnit: string
31952
- ): object;
31986
+ ): Record<string, string>;
31953
31987
  /**
31954
- * Retrieves all unit format patterns merged.
31988
+ * Retrieves unit format patterns for all units see {@link #getResolvedUnitFormat} for an example of a unit
31989
+ * format pattern.
31955
31990
  *
31956
31991
  * Note: Does not take unit mapping into consideration.
31957
31992
  *
31958
31993
  * @since 1.54
31959
31994
  *
31960
- * @returns The unit format patterns
31995
+ * @returns The unit format patterns as a map from a unit key to a map from a pattern key like `"unitPattern-count-other"`
31996
+ * to the corresponding pattern
31961
31997
  */
31962
- getUnitFormats(): object;
31998
+ getUnitFormats(): Record<string, Record<string, string>>;
31963
31999
  /**
31964
32000
  * Looks up the unit from defined unit mapping. E.g. for defined unit mapping ` { "my": "my-custom-unit",
31965
32001
  * "cm": "length-centimeter" } `
@@ -32003,6 +32039,23 @@ declare module "sap/ui/core/LocaleData" {
32003
32039
  */
32004
32040
  getWeekendStart(): int;
32005
32041
  }
32042
+ /**
32043
+ * A relative time pattern.
32044
+ */
32045
+ export type RelativeTimePattern = {
32046
+ /**
32047
+ * The string with the locale-specific representation of the relative time pattern
32048
+ */
32049
+ pattern: string;
32050
+ /**
32051
+ * The scale of the pattern
32052
+ */
32053
+ scale: "day" | "hour" | "minute" | "month" | "second" | "week" | "year";
32054
+ /**
32055
+ * `-1`, if the pattern is for the past; `1` otherwise
32056
+ */
32057
+ sign: number;
32058
+ };
32006
32059
  }
32007
32060
 
32008
32061
  declare module "sap/ui/core/Manifest" {
@@ -47284,7 +47337,7 @@ declare module "sap/ui/core/util/MockServer" {
47284
47337
  /**
47285
47338
  * Class to mock http requests made to a remote server supporting the OData V2 REST protocol.
47286
47339
  */
47287
- export default abstract class MockServer extends ManagedObject {
47340
+ export default class MockServer extends ManagedObject {
47288
47341
  /**
47289
47342
  * Creates a mocked server. This helps to mock some back-end calls, e.g. for OData V2/JSON Models or simple
47290
47343
  * XHR calls, without changing the application code. This class can also be used for qunit tests.
@@ -53313,24 +53366,6 @@ declare module "sap/ui/model/Binding" {
53313
53366
  */
53314
53367
  oEvents: Record<string, Function>
53315
53368
  ): Binding;
53316
- /**
53317
- * Attaches event handler `fnFunction` to the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
53318
- *
53319
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
53320
- * otherwise it will be bound to this `sap.ui.model.Binding` itself.
53321
- *
53322
- * @ui5-protected Do not call from applications (only from related classes in the framework)
53323
- */
53324
- attachRefresh(
53325
- /**
53326
- * The function to be called when the event occurs
53327
- */
53328
- fnFunction: Function,
53329
- /**
53330
- * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
53331
- */
53332
- oListener?: object
53333
- ): void;
53334
53369
  /**
53335
53370
  * Removes all control messages for this binding from {@link module:sap/ui/core/Messaging} in addition to
53336
53371
  * the standard clean-up tasks.
@@ -53423,21 +53458,6 @@ declare module "sap/ui/model/Binding" {
53423
53458
  */
53424
53459
  oEvents: Record<string, Function>
53425
53460
  ): Binding;
53426
- /**
53427
- * Detaches event handler `fnFunction` from the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
53428
- *
53429
- * @ui5-protected Do not call from applications (only from related classes in the framework)
53430
- */
53431
- detachRefresh(
53432
- /**
53433
- * The function to be called when the event occurs
53434
- */
53435
- fnFunction: Function,
53436
- /**
53437
- * Object on which to call the given function.
53438
- */
53439
- oListener?: object
53440
- ): void;
53441
53461
  /**
53442
53462
  * Fires event {@link #event:dataReceived dataReceived} to attached listeners.
53443
53463
  *
@@ -53708,6 +53728,25 @@ declare module "sap/ui/model/Binding" {
53708
53728
  Binding$DataStateChangeEventParameters,
53709
53729
  Binding
53710
53730
  >;
53731
+
53732
+ /**
53733
+ * Parameters of the Binding#refresh event.
53734
+ */
53735
+ export interface Binding$RefreshEventParameters {
53736
+ /**
53737
+ * A string stating the reason for the data change; some change reasons can be found in {@link sap.ui.model.ChangeReason},
53738
+ * but there may be additional reasons specified by a specific model implementation
53739
+ */
53740
+ reason?: string;
53741
+ }
53742
+
53743
+ /**
53744
+ * Event object of the Binding#refresh event.
53745
+ */
53746
+ export type Binding$RefreshEvent = Event<
53747
+ Binding$RefreshEventParameters,
53748
+ Binding
53749
+ >;
53711
53750
  }
53712
53751
 
53713
53752
  declare module "sap/ui/model/BindingMode" {
@@ -56169,9 +56208,13 @@ declare module "sap/ui/model/json/JSONModel" {
56169
56208
  oContext?: Context
56170
56209
  ): any | null | undefined;
56171
56210
  /**
56172
- * Load JSON-encoded data from the server using a GET HTTP request and store the resulting JSON data in
56173
- * the model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
56174
- * policy, the request can not successfully retrieve data from a different domain, subdomain, or protocol.
56211
+ * Loads JSON-encoded data from the server and stores the resulting JSON data in the model. Note: Due to
56212
+ * browser security restrictions, most "Ajax" requests are subject to the same origin policy, the request
56213
+ * can not successfully retrieve data from a different domain, subdomain, or protocol.
56214
+ *
56215
+ * Note: To send a JSON object in the body of a "POST" request to load the model data, `oParameters` has
56216
+ * to be the JSON-stringified value of the object to be sent, and `mHeaders` has to contain a `"Content-Type"`
56217
+ * property with the value `"application/json;charset=utf-8"`.
56175
56218
  *
56176
56219
  *
56177
56220
  * @returns in case bAsync is set to true a Promise is returned; this promise resolves/rejects based on
@@ -56179,15 +56222,16 @@ declare module "sap/ui/model/json/JSONModel" {
56179
56222
  */
56180
56223
  loadData(
56181
56224
  /**
56182
- * A string containing the URL to which the request is sent.
56225
+ * A string containing the URL to which the request is sent
56183
56226
  */
56184
56227
  sURL: string,
56185
56228
  /**
56186
- * A map or string that is sent to the server with the request. If the value of this parameter is a string,
56187
- * it must already be url-encoded. If the value of this parameter is an object (map), it is converted to
56188
- * a string and then url-encoded. The resulting string is appended to the URL if the HTTP request method
56189
- * cannot have a request body, e.g. for a GET request. Otherwise, the resulting string is added to the request
56190
- * body.
56229
+ * The data to be sent to the server with the data-loading request. If `oParameters` is a string, it has
56230
+ * to be encoded based on the used content type. The default encoding is `'application/x-www-form-urlencoded;
56231
+ * charset=UTF-8'` but it may be overwritten via the `"Content-Type"` property given in `mHeaders`. If `oParameters`
56232
+ * is an object, a string is generated and the keys and values are URL-encoded. The resulting string is
56233
+ * appended to the URL if the HTTP request method cannot have a request body, e.g. for a "GET" request.
56234
+ * Otherwise, the resulting string is added to the request body.
56191
56235
  */
56192
56236
  oParameters?: object | string,
56193
56237
  /**
@@ -56197,8 +56241,7 @@ declare module "sap/ui/model/json/JSONModel" {
56197
56241
  */
56198
56242
  bAsync?: boolean,
56199
56243
  /**
56200
- * The type of request to make ("POST" or "GET"), default is "GET". Note: Other HTTP request methods, such
56201
- * as PUT and DELETE, can also be used here, but they are not supported by all browsers.
56244
+ * The HTTP verb to use for the request ("GET" or "POST")
56202
56245
  */
56203
56246
  sType?: string,
56204
56247
  /**
@@ -71050,8 +71093,9 @@ declare module "sap/ui/model/odata/v4/Context" {
71050
71093
  ): Promise<void>;
71051
71094
  /**
71052
71095
  * Destroys this context, that is, it removes this context from all dependent bindings and drops references
71053
- * to binding and model, so that the context cannot be used anymore; it keeps path and index for debugging
71054
- * purposes.
71096
+ * to {@link #getBinding binding} and {@link #getModel model}, so that the context cannot be used anymore;
71097
+ * it keeps path and index for debugging purposes. A destroyed context can be recognized by calling {@link #getBinding},
71098
+ * which returns `undefined`.
71055
71099
  *
71056
71100
  * **BEWARE:** Do not call this function! The lifetime of an OData V4 context is completely controlled by
71057
71101
  * its binding.
@@ -71297,7 +71341,11 @@ declare module "sap/ui/model/odata/v4/Context" {
71297
71341
  *
71298
71342
  * The move potentially changes the {@link #getIndex index} of this context, of all of its descendants,
71299
71343
  * and of all other nodes affected by the move. Any index change can, however, only be observed reliably
71300
- * for this context itself.
71344
+ * for this context itself or (since 1.126.0) the next sibling's context if that is {@link #isKeepAlive kept alive }
71345
+ * or {@link #isSelected selected} (and the preconditions of {@link #setKeepAlive} hold). For a kept-alive
71346
+ * or selected next sibling, the index must be retrieved as soon as the returned promise resolves. If such
71347
+ * a next sibling is not one of the binding's {@link sap.ui.model.odata.v4.ODataListBinding#getCurrentContexts current contexts }
71348
+ * after the move, it is not in the collection anymore and thus loses its index pretty soon.
71301
71349
  *
71302
71350
  * The move changes the {@link https://ui5.sap.com/#/topic/c9723f8265f644af91c0ed941e114d46/section_CST context states }
71303
71351
  * of the nodes as follows:
@@ -71663,16 +71711,20 @@ declare module "sap/ui/model/odata/v4/Context" {
71663
71711
  bRetry?: boolean
71664
71712
  ): Promise<void>;
71665
71713
  /**
71666
- * Sets whether this context is currently selected. While a context is currently {@link #delete deleted }
71714
+ * Sets whether this context is currently selected. If the selection state changes, a {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged' }
71715
+ * event is fired on the list binding which this context belongs to. While a context is currently {@link #delete deleted }
71667
71716
  * on the client, it does not appear as {@link #isSelected selected}. If the preconditions of {@link #setKeepAlive }
71668
71717
  * hold, a best effort is made to implicitly keep a selected context alive in order to preserve the selection
71669
71718
  * state. Once the selection is no longer needed, for example because you perform an operation on this context
71670
71719
  * which logically removes it from its list, you need to reset the selection.
71671
71720
  *
71672
71721
  * If this context is a header context of a list binding, the new selection state is propagated to all row
71673
- * contexts. This method can be called repeatedly with the same value to again select all row contexts.
71674
- * For example, if a row context was deselected explicitly, it is selected again by selecting the header
71675
- * context (even if the header context is already selected).
71722
+ * contexts. If the selection state of this header context changes, a {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged' }
71723
+ * event is fired for this header context. This method can be called repeatedly with the same value to again
71724
+ * select all row contexts. For example, if a row context was deselected explicitly, it is selected again
71725
+ * by selecting the header context (even if the header context is already selected). If the selection state
71726
+ * of any row context changes in this way, then a {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged' }
71727
+ * event is nevertheless fired for this header context, but not for the row context.
71676
71728
  *
71677
71729
  * **Note:** It is unsafe to keep a reference to a context instance which is not {@link #isKeepAlive kept alive}.
71678
71730
  * See:
@@ -72360,17 +72412,16 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
72360
72412
  Binding$ChangeEventParameters,
72361
72413
  Binding$DataReceivedEventParameters,
72362
72414
  Binding$DataRequestedEventParameters,
72415
+ Binding$RefreshEventParameters,
72363
72416
  } from "sap/ui/model/Binding";
72364
72417
 
72365
72418
  import Event from "sap/ui/base/Event";
72366
72419
 
72367
- import ChangeReason from "sap/ui/model/ChangeReason";
72368
-
72369
72420
  /**
72370
72421
  * List binding for an OData V4 model. An event handler can only be attached to this binding for the following
72371
72422
  * events: 'AggregatedDataStateChange', 'change', 'createActivate', 'createCompleted', 'createSent', 'dataReceived',
72372
- * 'dataRequested', 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an
72373
- * error is thrown.
72423
+ * 'dataRequested', 'DataStateChange', 'selectionChanged', 'patchCompleted', 'patchSent', and 'refresh'.
72424
+ * For other events, an error is thrown.
72374
72425
  *
72375
72426
  * @since 1.37.0
72376
72427
  */
@@ -72607,13 +72658,18 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
72607
72658
  * (which is immediately removed from the new child's data). It can be `null` or absent when creating a
72608
72659
  * new root node. `bSkipRefresh` must be set, but both `bAtEnd` and `bInactive` must not be set. No other
72609
72660
  * creation or {@link sap.ui.model.odata.v4.Context#move move} must be pending, and no other modification
72610
- * (including collapse of some ancestor node) must happen while this creation is pending! When using the
72611
- * `createInPlace` parameter (see {@link #setAggregation}, @experimental as of version 1.125.0), the new
72612
- * {@link sap.ui.model.odata.v4.Context#isTransient transient} child is hidden until it becomes {@link sap.ui.model.odata.v4.Context#created created},
72613
- * and then it is shown at a position determined by the back end and the current sort order. The position
72614
- * of the new child can be retrieved by using its {@link sap.ui.model.odata.v4.Context#getIndex index}.
72661
+ * (including collapse of some ancestor node) must happen while this creation is pending!
72662
+ *
72663
+ * When using the `createInPlace` parameter (see {@link #setAggregation}, @experimental as of version 1.125.0),
72664
+ * the new {@link sap.ui.model.odata.v4.Context#isTransient transient} child is hidden until its {@link sap.ui.model.odata.v4.Context#created created promise }
72665
+ * resolves, and then it is shown at a position determined by the back end and the current sort order. Note
72666
+ * that the returned context is not always part of this list binding's collection and can only be used for
72667
+ * the following scenarios:
72668
+ * The position of the new child can be retrieved by using its {@link sap.ui.model.odata.v4.Context#getIndex index}.
72615
72669
  * If the created child does not become part of the hierarchy due to the search or filter criteria, the
72616
- * context will be destroyed and its {@link sap.ui.model.odata.v4.Context#getIndex index} is set to `undefined`.
72670
+ * context will be {@link sap.ui.model.odata.v4.Context#destroy destroyed} and its {@link sap.ui.model.odata.v4.Context#getIndex index }
72671
+ * is set to `undefined`. The created context always knows its {@link sap.ui.model.odata.v4.Context#getPath path},
72672
+ * which can be used for {@link #getKeepAliveContext}.
72617
72673
  *
72618
72674
  * @since 1.43.0
72619
72675
  *
@@ -72957,7 +73013,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
72957
73013
  * it. Since 1.100.0 the function always returns such a context. If none exists yet, it is created without
72958
73014
  * data and a request for its entity is sent.
72959
73015
  * See:
72960
- * sap.ui.model.odata.v4.Model#getKeepAliveContext
73016
+ * sap.ui.model.odata.v4.ODataModel#getKeepAliveContext
72961
73017
  *
72962
73018
  * @since 1.99.0
72963
73019
  *
@@ -73630,22 +73686,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
73630
73686
  /**
73631
73687
  * Parameters of the ODataListBinding#refresh event.
73632
73688
  */
73633
- export interface ODataListBinding$RefreshEventParameters {
73634
- /**
73635
- * The reason for the 'refresh' event could be
73636
- * {@link sap.ui.model.ChangeReason.Context Context} when the binding's parent context is changed,
73637
- * {@link sap.ui.model.ChangeReason.Filter Filter} on {@link #filter} and {@link #setAggregation},
73638
- * {@link sap.ui.model.ChangeReason.Refresh Refresh} on {@link #refresh}, or when the binding is initialized,
73639
- * {@link sap.ui.model.ChangeReason.Sort Sort} on {@link #sort}. {@link #changeParameters} leads
73640
- * to {@link sap.ui.model.ChangeReason.Filter Filter} if one of the parameters '$filter' and '$search' is
73641
- * changed, otherwise it leads to {@link sap.ui.model.ChangeReason.Sort Sort} if the parameter '$orderby'
73642
- * is changed; in other cases, it leads to {@link sap.ui.model.ChangeReason.Change Change}.
73643
- * If APIs that would normally fire change events have been called while the binding is suspended, {@link #resume }
73644
- * leads to the "strongest" change reason in the order {@link sap.ui.model.ChangeReason.Filter Filter},
73645
- * {@link sap.ui.model.ChangeReason.Sort Sort}, {@link sap.ui.model.ChangeReason.Refresh Refresh}, {@link sap.ui.model.ChangeReason.Change Change}.
73646
- */
73647
- reason?: ChangeReason;
73648
- }
73689
+ export interface ODataListBinding$RefreshEventParameters
73690
+ extends Binding$RefreshEventParameters {}
73649
73691
 
73650
73692
  /**
73651
73693
  * Event object of the ODataListBinding#refresh event.
@@ -73654,6 +73696,28 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
73654
73696
  ODataListBinding$RefreshEventParameters,
73655
73697
  ODataListBinding
73656
73698
  >;
73699
+
73700
+ /**
73701
+ * Parameters of the ODataListBinding#selectionChanged event.
73702
+ *
73703
+ * @experimental (since 1.126.0)
73704
+ */
73705
+ export interface ODataListBinding$SelectionChangedEventParameters {
73706
+ /**
73707
+ * The context for which {@link sap.ui.model.odata.v4.Context#setSelected} was called
73708
+ */
73709
+ context?: boolean;
73710
+ }
73711
+
73712
+ /**
73713
+ * Event object of the ODataListBinding#selectionChanged event.
73714
+ *
73715
+ * @experimental (since 1.126.0)
73716
+ */
73717
+ export type ODataListBinding$SelectionChangedEvent = Event<
73718
+ ODataListBinding$SelectionChangedEventParameters,
73719
+ ODataListBinding
73720
+ >;
73657
73721
  }
73658
73722
 
73659
73723
  declare module "sap/ui/model/odata/v4/ODataMetaModel" {
@@ -74959,6 +75023,9 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
74959
75023
  * If the target type specified in the corresponding control property's binding info is "any" and the binding
74960
75024
  * is relative or points to metadata, the binding may have an object value; in this case and unless the
74961
75025
  * binding refers to an action advertisement the binding's mode must be {@link sap.ui.model.BindingMode.OneTime}.
75026
+ * {@link sap.ui.model.BindingMode.OneWay OneWay} is also supported (@experimental as of version 1.126.0),
75027
+ * but client-side updates of the object are not supported and `$$patchWithoutSideEffects` should be used
75028
+ * for the parent entity.
74962
75029
  * See:
74963
75030
  * sap.ui.base.ManagedObject#bindProperty
74964
75031
  * sap.ui.model.Model#bindProperty
@@ -86226,7 +86293,7 @@ declare namespace sap {
86226
86293
  sNamespace: string
86227
86294
  ): void;
86228
86295
  /**
86229
- * Ensures that a given a namespace or hierarchy of nested namespaces exists in the current `window`.
86296
+ * Ensures that a given a namespace or hierarchy of nested namespaces exists in the current `globalThis`.
86230
86297
  *
86231
86298
  * @deprecated (since 1.1) - see {@link topic:c78c07c094e04ccfaab659378a1707c7 Creating Control and Class Modules}.
86232
86299
  *
@@ -87426,6 +87493,10 @@ declare namespace sap {
87426
87493
 
87427
87494
  "sap/ui/core/ExtensionPoint": undefined;
87428
87495
 
87496
+ "sap/ui/core/fieldhelp/FieldHelp": undefined;
87497
+
87498
+ "sap/ui/core/fieldhelp/FieldHelpUtil": undefined;
87499
+
87429
87500
  "sap/ui/core/format/DateFormat": undefined;
87430
87501
 
87431
87502
  "sap/ui/core/format/DateFormatTimezoneDisplay": undefined;
@@ -87774,8 +87845,6 @@ declare namespace sap {
87774
87845
 
87775
87846
  "sap/ui/model/DataState": undefined;
87776
87847
 
87777
- "sap/ui/model/FieldHelp": undefined;
87778
-
87779
87848
  "sap/ui/model/Filter": undefined;
87780
87849
 
87781
87850
  "sap/ui/model/FilterOperator": undefined;