@openui5/ts-types 1.136.2 → 1.138.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.
package/types/sap.m.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.136.2
1
+ // For Library Version: 1.138.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -2489,7 +2489,16 @@ declare namespace sap {
2489
2489
  /**
2490
2490
  * Escape handler for sap.m.Dialog control.
2491
2491
  */
2492
- type EscapeHandler = (oHandlers: object) => void;
2492
+ type EscapeHandler = (oHandlers: {
2493
+ /**
2494
+ * Call this function if the dialog should be closed.
2495
+ */
2496
+ resolve: () => void;
2497
+ /**
2498
+ * Call this function if the dialog should not be closed.
2499
+ */
2500
+ reject: () => void;
2501
+ }) => void;
2493
2502
  }
2494
2503
 
2495
2504
  namespace MessageBox {
@@ -2548,27 +2557,27 @@ declare namespace sap {
2548
2557
  /**
2549
2558
  * Shows the error icon in the message box.
2550
2559
  */
2551
- ERROR = "undefined",
2560
+ ERROR = "ERROR",
2552
2561
  /**
2553
2562
  * Shows the information icon in the message box.
2554
2563
  */
2555
- INFORMATION = "undefined",
2564
+ INFORMATION = "INFORMATION",
2556
2565
  /**
2557
2566
  * Shows no icon in the message box.
2558
2567
  */
2559
- NONE = "undefined",
2568
+ NONE = "NONE",
2560
2569
  /**
2561
2570
  * Shows the question icon in the message box.
2562
2571
  */
2563
- QUESTION = "undefined",
2572
+ QUESTION = "QUESTION",
2564
2573
  /**
2565
2574
  * Shows the success icon in the message box.
2566
2575
  */
2567
- SUCCESS = "undefined",
2576
+ SUCCESS = "SUCCESS",
2568
2577
  /**
2569
2578
  * Shows the warning icon in the message box.
2570
2579
  */
2571
- WARNING = "undefined",
2580
+ WARNING = "WARNING",
2572
2581
  }
2573
2582
  }
2574
2583
 
@@ -14265,6 +14274,22 @@ declare namespace sap {
14265
14274
  >;
14266
14275
  }
14267
14276
 
14277
+ namespace SinglePlanningCalendar {
14278
+ /**
14279
+ * Object which contains the start and end dates in the currently visible range.
14280
+ */
14281
+ type VisibleDates = {
14282
+ /**
14283
+ * The start date in the currently visible range.
14284
+ */
14285
+ oStartDate?: Date | import("sap/ui/core/date/UI5Date").default;
14286
+ /**
14287
+ * The end date in the currently visible range.
14288
+ */
14289
+ oEndDate?: Date | import("sap/ui/core/date/UI5Date").default;
14290
+ };
14291
+ }
14292
+
14268
14293
  namespace table {
14269
14294
  namespace columnmenu {
14270
14295
  /**
@@ -14535,6 +14560,28 @@ declare namespace sap {
14535
14560
  | `{${string}}`;
14536
14561
  }
14537
14562
 
14563
+ /**
14564
+ * Describes the settings that can be provided to the QuickResize constructor.
14565
+ */
14566
+ interface $QuickResizeSettings
14567
+ extends sap.m.table.columnmenu.$QuickActionBaseSettings {
14568
+ /**
14569
+ * The width of the column.
14570
+ *
14571
+ * **Note**: This property is used to set the initial value of the input control. The `QuickResize` doesn't
14572
+ * have a built-in mechanism to automatically determine the value from the actual column width.
14573
+ */
14574
+ width?:
14575
+ | int
14576
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
14577
+ | `{${string}}`;
14578
+
14579
+ /**
14580
+ * Fires the change event.
14581
+ */
14582
+ change?: (oEvent: QuickResize$ChangeEvent) => void;
14583
+ }
14584
+
14538
14585
  /**
14539
14586
  * Describes the settings that can be provided to the QuickSort constructor.
14540
14587
  */
@@ -14659,6 +14706,16 @@ declare namespace sap {
14659
14706
  grouped?: boolean;
14660
14707
  }
14661
14708
 
14709
+ /**
14710
+ * Parameters of the QuickResize#change event.
14711
+ */
14712
+ interface QuickResize$ChangeEventParameters {
14713
+ /**
14714
+ * The new width.
14715
+ */
14716
+ width?: int;
14717
+ }
14718
+
14662
14719
  /**
14663
14720
  * Parameters of the QuickSort#change event.
14664
14721
  */
@@ -17070,6 +17127,191 @@ declare namespace sap {
17070
17127
  bGrouped?: boolean
17071
17128
  ): this;
17072
17129
  }
17130
+ /**
17131
+ * The `QuickResize` class is used for quick resizing of columns via the `sap.m.table.columnmenu.Menu`.
17132
+ * It can be used to specify quick actions for accessible column resizing.
17133
+ *
17134
+ * @since 1.137
17135
+ */
17136
+ class QuickResize extends sap.m.table.columnmenu.QuickActionBase {
17137
+ /**
17138
+ * Constructor for a new `QuickResize`.
17139
+ *
17140
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
17141
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
17142
+ * of the syntax of the settings object.
17143
+ */
17144
+ constructor(
17145
+ /**
17146
+ * Initial settings for the new `QuickResize`
17147
+ */
17148
+ mSettings?: sap.m.table.columnmenu.$QuickResizeSettings
17149
+ );
17150
+ /**
17151
+ * Constructor for a new `QuickResize`.
17152
+ *
17153
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
17154
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
17155
+ * of the syntax of the settings object.
17156
+ */
17157
+ constructor(
17158
+ /**
17159
+ * ID for the new `QuickResize`, generated automatically if no ID is given
17160
+ */
17161
+ sId?: string,
17162
+ /**
17163
+ * Initial settings for the new `QuickResize`
17164
+ */
17165
+ mSettings?: sap.m.table.columnmenu.$QuickResizeSettings
17166
+ );
17167
+
17168
+ /**
17169
+ * Creates a new subclass of class sap.m.table.columnmenu.QuickResize with name `sClassName` and enriches
17170
+ * it with the information contained in `oClassInfo`.
17171
+ *
17172
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.table.columnmenu.QuickActionBase.extend}.
17173
+ *
17174
+ *
17175
+ * @returns Created class / constructor function
17176
+ */
17177
+ static extend<T extends Record<string, unknown>>(
17178
+ /**
17179
+ * Name of the class being created
17180
+ */
17181
+ sClassName: string,
17182
+ /**
17183
+ * Object literal with information about the class
17184
+ */
17185
+ oClassInfo?: sap.ClassInfo<T, sap.m.table.columnmenu.QuickResize>,
17186
+ /**
17187
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
17188
+ * used by this class
17189
+ */
17190
+ FNMetaImpl?: Function
17191
+ ): Function;
17192
+ /**
17193
+ * Returns a metadata object for class sap.m.table.columnmenu.QuickResize.
17194
+ *
17195
+ *
17196
+ * @returns Metadata object describing this class
17197
+ */
17198
+ static getMetadata(): sap.ui.core.ElementMetadata;
17199
+ /**
17200
+ * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.m.table.columnmenu.QuickResize`.
17201
+ *
17202
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
17203
+ * otherwise it will be bound to this `sap.m.table.columnmenu.QuickResize` itself.
17204
+ *
17205
+ * Fires the change event.
17206
+ *
17207
+ *
17208
+ * @returns Reference to `this` in order to allow method chaining
17209
+ */
17210
+ attachChange(
17211
+ /**
17212
+ * An application-specific payload object that will be passed to the event handler along with the event
17213
+ * object when firing the event
17214
+ */
17215
+ oData: object,
17216
+ /**
17217
+ * The function to be called when the event occurs
17218
+ */
17219
+ fnFunction: (p1: QuickResize$ChangeEvent) => void,
17220
+ /**
17221
+ * Context object to call the event handler with. Defaults to this `sap.m.table.columnmenu.QuickResize`
17222
+ * itself
17223
+ */
17224
+ oListener?: object
17225
+ ): this;
17226
+ /**
17227
+ * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.m.table.columnmenu.QuickResize`.
17228
+ *
17229
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
17230
+ * otherwise it will be bound to this `sap.m.table.columnmenu.QuickResize` itself.
17231
+ *
17232
+ * Fires the change event.
17233
+ *
17234
+ *
17235
+ * @returns Reference to `this` in order to allow method chaining
17236
+ */
17237
+ attachChange(
17238
+ /**
17239
+ * The function to be called when the event occurs
17240
+ */
17241
+ fnFunction: (p1: QuickResize$ChangeEvent) => void,
17242
+ /**
17243
+ * Context object to call the event handler with. Defaults to this `sap.m.table.columnmenu.QuickResize`
17244
+ * itself
17245
+ */
17246
+ oListener?: object
17247
+ ): this;
17248
+ /**
17249
+ * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.m.table.columnmenu.QuickResize`.
17250
+ *
17251
+ * The passed function and listener object must match the ones used for event registration.
17252
+ *
17253
+ *
17254
+ * @returns Reference to `this` in order to allow method chaining
17255
+ */
17256
+ detachChange(
17257
+ /**
17258
+ * The function to be called, when the event occurs
17259
+ */
17260
+ fnFunction: (p1: QuickResize$ChangeEvent) => void,
17261
+ /**
17262
+ * Context object on which the given function had to be called
17263
+ */
17264
+ oListener?: object
17265
+ ): this;
17266
+ /**
17267
+ * Fires event {@link #event:change change} to attached listeners.
17268
+ *
17269
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
17270
+ *
17271
+ * @returns Reference to `this` in order to allow method chaining
17272
+ */
17273
+ fireChange(
17274
+ /**
17275
+ * Parameters to pass along with the event
17276
+ */
17277
+ mParameters?: sap.m.table.columnmenu.QuickResize$ChangeEventParameters
17278
+ ): this;
17279
+ /**
17280
+ * Gets current value of property {@link #getWidth width}.
17281
+ *
17282
+ * The width of the column.
17283
+ *
17284
+ * **Note**: This property is used to set the initial value of the input control. The `QuickResize` doesn't
17285
+ * have a built-in mechanism to automatically determine the value from the actual column width.
17286
+ *
17287
+ * Default value is `200`.
17288
+ *
17289
+ *
17290
+ * @returns Value of property `width`
17291
+ */
17292
+ getWidth(): int;
17293
+ /**
17294
+ * Sets a new value for property {@link #getWidth width}.
17295
+ *
17296
+ * The width of the column.
17297
+ *
17298
+ * **Note**: This property is used to set the initial value of the input control. The `QuickResize` doesn't
17299
+ * have a built-in mechanism to automatically determine the value from the actual column width.
17300
+ *
17301
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
17302
+ *
17303
+ * Default value is `200`.
17304
+ *
17305
+ *
17306
+ * @returns Reference to `this` in order to allow method chaining
17307
+ */
17308
+ setWidth(
17309
+ /**
17310
+ * New value for property `width`
17311
+ */
17312
+ iWidth?: int
17313
+ ): this;
17314
+ }
17073
17315
  /**
17074
17316
  * The `QuickSort` class is used for quick sorting for the `sap.m.table.columnmenu.Menu`. It can be used
17075
17317
  * to specify control- and application-specific quick actions for sorting.
@@ -17832,6 +18074,14 @@ declare namespace sap {
17832
18074
  QuickGroup
17833
18075
  >;
17834
18076
 
18077
+ /**
18078
+ * Event object of the QuickResize#change event.
18079
+ */
18080
+ type QuickResize$ChangeEvent = sap.ui.base.Event<
18081
+ QuickResize$ChangeEventParameters,
18082
+ QuickResize
18083
+ >;
18084
+
17835
18085
  /**
17836
18086
  * Event object of the QuickSort#change event.
17837
18087
  */
@@ -25645,11 +25895,11 @@ declare namespace sap {
25645
25895
  /**
25646
25896
  * HTTP request POST method.
25647
25897
  */
25648
- Post = "POST",
25898
+ Post = "Post",
25649
25899
  /**
25650
25900
  * HTTP request PUT method.
25651
25901
  */
25652
- Put = "PUT",
25902
+ Put = "Put",
25653
25903
  }
25654
25904
  /**
25655
25905
  * Event object of the Uploader#uploadAborted event.
@@ -25928,7 +26178,7 @@ declare namespace sap {
25928
26178
  }
25929
26179
 
25930
26180
  /**
25931
- * Interface for controls which are suitable to be added as items of sap.m.Menu.
26181
+ * Interface definition for controls suitable to be used as items of `sap.m.Menu`.
25932
26182
  *
25933
26183
  * @since 1.127.0
25934
26184
  */
@@ -25936,6 +26186,41 @@ declare namespace sap {
25936
26186
  __implements__sap_m_IMenuItem: boolean;
25937
26187
  }
25938
26188
 
26189
+ /**
26190
+ * Interface definition for controls suitable to be used as items of `sap.m.Menu`. This interface is used
26191
+ * to define the behavior of the menu item.
26192
+ *
26193
+ * @since 1.137.0
26194
+ */
26195
+ interface IMenuItemBehavior {
26196
+ __implements__sap_m_IMenuItemBehavior: boolean;
26197
+
26198
+ /**
26199
+ * Returns whether the item can be counted in total items count. **Note:** This method can be overridden
26200
+ * by subclasses to implement custom behavior.
26201
+ *
26202
+ *
26203
+ * @returns Whether the item is counted in total items count
26204
+ */
26205
+ isCountable(): boolean;
26206
+ /**
26207
+ * Returns whether the item can be focused. **Note:** This method can be overridden by subclasses to implement
26208
+ * custom behavior.
26209
+ *
26210
+ *
26211
+ * @returns Whether the item is enabled for focus
26212
+ */
26213
+ isFocusable(): boolean;
26214
+ /**
26215
+ * Returns whether the firing of `press` event is allowed. **Note:** This method can be overridden by subclasses
26216
+ * to implement custom behavior.
26217
+ *
26218
+ *
26219
+ * @returns Whether the item is enabled for click/press
26220
+ */
26221
+ isInteractive(): boolean;
26222
+ }
26223
+
25939
26224
  /**
25940
26225
  * Interface for controls which can have special behavior inside `sap.m.OverflowToolbar`. Controls that
25941
26226
  * implement this interface must provide a `getOverflowToolbarConfig` method that accepts no arguments and
@@ -29818,17 +30103,6 @@ declare namespace sap {
29818
30103
  | sap.ui.base.ManagedObject.PropertyBindingInfo
29819
30104
  | `{${string}}`;
29820
30105
 
29821
- /**
29822
- * Contains {@link sap.m.FeedListItemAction elements} that are displayed in the action sheet.
29823
- *
29824
- * @since 1.52.0
29825
- */
29826
- actions?:
29827
- | sap.m.FeedListItemAction[]
29828
- | sap.m.FeedListItemAction
29829
- | sap.ui.base.ManagedObject.AggregationBindingInfo
29830
- | `{${string}}`;
29831
-
29832
30106
  /**
29833
30107
  * Event is fired when name of the sender is pressed.
29834
30108
  */
@@ -29843,33 +30117,13 @@ declare namespace sap {
29843
30117
  /**
29844
30118
  * Describes the settings that can be provided to the FeedListItemAction constructor.
29845
30119
  */
29846
- interface $FeedListItemActionSettings extends sap.ui.core.$ElementSettings {
29847
- /**
29848
- * The icon of the action.
29849
- */
29850
- icon?:
29851
- | sap.ui.core.URI
29852
- | sap.ui.base.ManagedObject.PropertyBindingInfo
29853
- | `{${string}}`;
29854
-
29855
- /**
29856
- * The text of the item. It is used as a tooltip and for accessibility reasons.
29857
- */
29858
- text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
29859
-
30120
+ interface $FeedListItemActionSettings
30121
+ extends sap.m.$ListItemActionBaseSettings {
29860
30122
  /**
29861
30123
  * The key of the item.
29862
30124
  */
29863
30125
  key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
29864
30126
 
29865
- /**
29866
- * Hides or shows a button on the UI.
29867
- */
29868
- visible?:
29869
- | boolean
29870
- | sap.ui.base.ManagedObject.PropertyBindingInfo
29871
- | `{${string}}`;
29872
-
29873
30127
  /**
29874
30128
  * Enables or disables a button on the UI. All buttons are enabled by default. Disabled buttons are colored
29875
30129
  * differently as per the theme of the UI.
@@ -31481,6 +31735,19 @@ declare namespace sap {
31481
31735
  | sap.ui.base.ManagedObject.PropertyBindingInfo
31482
31736
  | `{${string}}`;
31483
31737
 
31738
+ /**
31739
+ * Defines whether the illustration is decorative.
31740
+ *
31741
+ * When set to true, the attributes `role="presentation"` and `aria-hidden="true"` are applied to the SVG
31742
+ * element.
31743
+ *
31744
+ * @experimental As of version 1.138.
31745
+ */
31746
+ decorative?:
31747
+ | boolean
31748
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
31749
+ | `{${string}}`;
31750
+
31484
31751
  /**
31485
31752
  * Defines the controls placed below the description as additional content.
31486
31753
  *
@@ -31534,6 +31801,16 @@ declare namespace sap {
31534
31801
  */
31535
31802
  type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
31536
31803
 
31804
+ /**
31805
+ * Defines whether the illustration is decorative.
31806
+ *
31807
+ * @experimental As of version 1.138.
31808
+ */
31809
+ decorative?:
31810
+ | boolean
31811
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
31812
+ | `{${string}}`;
31813
+
31537
31814
  /**
31538
31815
  * Association to controls / IDs which label those controls (see WAI-ARIA attribute aria-labelledBy).
31539
31816
  *
@@ -33056,6 +33333,23 @@ declare namespace sap {
33056
33333
  | sap.ui.base.ManagedObject.PropertyBindingInfo
33057
33334
  | `{${string}}`;
33058
33335
 
33336
+ /**
33337
+ * Defines the maximum number of item actions.
33338
+ *
33339
+ * If the number of item actions exceeds the `itemActionCount` property value, an overflow button will appear,
33340
+ * providing access to the additional actions.
33341
+ *
33342
+ * **Note:** Only values between `0-2` enables the use of the new `actions` aggregation. When enabled, the
33343
+ * {@link sap.m.ListMode Delete} mode and the {@link sap.m.ListType Detail} list item type have no effect.
33344
+ * Instead, dedicated actions of {@link sap.m.ListItemActionType type} `Delete` or `Edit` should be used.
33345
+ *
33346
+ * @since 1.137
33347
+ */
33348
+ itemActionCount?:
33349
+ | int
33350
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
33351
+ | `{${string}}`;
33352
+
33059
33353
  /**
33060
33354
  * Defines the items contained within this control.
33061
33355
  */
@@ -33192,6 +33486,39 @@ declare namespace sap {
33192
33486
  beforeOpenContextMenu?: (
33193
33487
  oEvent: ListBase$BeforeOpenContextMenuEvent
33194
33488
  ) => void;
33489
+
33490
+ /**
33491
+ * Fired when an item action is pressed.
33492
+ *
33493
+ * @since 1.137
33494
+ */
33495
+ itemActionPress?: (oEvent: ListBase$ItemActionPressEvent) => void;
33496
+ }
33497
+
33498
+ /**
33499
+ * Describes the settings that can be provided to the ListItemActionBase constructor.
33500
+ */
33501
+ interface $ListItemActionBaseSettings extends sap.ui.core.$ElementSettings {
33502
+ /**
33503
+ * Defines the icon of the action.
33504
+ */
33505
+ icon?:
33506
+ | sap.ui.core.URI
33507
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
33508
+ | `{${string}}`;
33509
+
33510
+ /**
33511
+ * Defines the text of the action.
33512
+ */
33513
+ text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
33514
+
33515
+ /**
33516
+ * Defines the visibility of the action.
33517
+ */
33518
+ visible?:
33519
+ | boolean
33520
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
33521
+ | `{${string}}`;
33195
33522
  }
33196
33523
 
33197
33524
  /**
@@ -33279,6 +33606,17 @@ declare namespace sap {
33279
33606
  | sap.ui.base.ManagedObject.PropertyBindingInfo
33280
33607
  | `{${string}}`;
33281
33608
 
33609
+ /**
33610
+ * Defines the actions contained within this control.
33611
+ *
33612
+ * @since 1.137
33613
+ */
33614
+ actions?:
33615
+ | sap.m.ListItemActionBase[]
33616
+ | sap.m.ListItemActionBase
33617
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
33618
+ | `{${string}}`;
33619
+
33282
33620
  /**
33283
33621
  * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby).
33284
33622
  *
@@ -33429,7 +33767,7 @@ declare namespace sap {
33429
33767
  *
33430
33768
  * @since 1.131
33431
33769
  */
33432
- beforeClose?: (oEvent: sap.ui.base.Event) => void;
33770
+ beforeClose?: (oEvent: Menu$BeforeCloseEvent) => void;
33433
33771
  }
33434
33772
 
33435
33773
  /**
@@ -33577,12 +33915,25 @@ declare namespace sap {
33577
33915
  /**
33578
33916
  * Describes the settings that can be provided to the MenuItem constructor.
33579
33917
  */
33580
- interface $MenuItemSettings extends sap.ui.core.$ItemSettings {
33918
+ interface $MenuItemSettings extends sap.ui.core.$ControlSettings {
33919
+ /**
33920
+ * The text to be displayed for the item.
33921
+ */
33922
+ text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
33923
+
33581
33924
  /**
33582
33925
  * Defines the icon, which belongs to the item. This can be a URI to an image or an icon font URI.
33583
33926
  */
33584
33927
  icon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
33585
33928
 
33929
+ /**
33930
+ * Enabled items can be selected.
33931
+ */
33932
+ enabled?:
33933
+ | boolean
33934
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
33935
+ | `{${string}}`;
33936
+
33586
33937
  /**
33587
33938
  * Defines whether the item should be visible on the screen. If set to `false`, a placeholder is rendered
33588
33939
  * instead of the real item.
@@ -33620,7 +33971,20 @@ declare namespace sap {
33620
33971
  | `{${string}}`;
33621
33972
 
33622
33973
  /**
33623
- * Defines the sub-items contained within this element.
33974
+ * Options are RTL and LTR. Alternatively, an item can inherit its text direction from its parent control.
33975
+ */
33976
+ textDirection?:
33977
+ | sap.ui.core.TextDirection
33978
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
33979
+ | `{${string}}`;
33980
+
33981
+ /**
33982
+ * Can be used as input for subsequent actions.
33983
+ */
33984
+ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
33985
+
33986
+ /**
33987
+ * Defines the subitems contained within this element.
33624
33988
  */
33625
33989
  items?:
33626
33990
  | sap.m.IMenuItem[]
@@ -33632,6 +33996,10 @@ declare namespace sap {
33632
33996
  * Defines the content that is displayed at the end of a menu item. This aggregation allows for the addition
33633
33997
  * of custom elements, such as icons and buttons.
33634
33998
  *
33999
+ * **Note:** Application developers are responsible for ensuring that interactive `endContent` controls
34000
+ * have the correct accessibility behaviour, including their enabled or disabled states. The Menu
34001
+ * does not manage these aspects when the menu item state changes.
34002
+ *
33635
34003
  * @since 1.131
33636
34004
  */
33637
34005
  endContent?:
@@ -33644,16 +34012,6 @@ declare namespace sap {
33644
34012
  * Fired after the item has been pressed.
33645
34013
  */
33646
34014
  press?: (oEvent: sap.ui.base.Event) => void;
33647
-
33648
- /**
33649
- * Fired when a property of the item changes.
33650
- */
33651
- propertyChanged?: (oEvent: MenuItem$PropertyChangedEvent) => void;
33652
-
33653
- /**
33654
- * Fired when aggregation of the item changes.
33655
- */
33656
- aggregationChanged?: (oEvent: MenuItem$AggregationChangedEvent) => void;
33657
34015
  }
33658
34016
 
33659
34017
  /**
@@ -46434,6 +46792,21 @@ declare namespace sap {
46434
46792
  total?: int;
46435
46793
  }
46436
46794
 
46795
+ /**
46796
+ * Parameters of the ListBase#itemActionPress event.
46797
+ */
46798
+ interface ListBase$ItemActionPressEventParameters {
46799
+ /**
46800
+ * The list item action that fired the event
46801
+ */
46802
+ itemAction?: sap.m.ListItemAction;
46803
+
46804
+ /**
46805
+ * The list item in which the action was performed
46806
+ */
46807
+ listItem?: sap.m.ListItemBase;
46808
+ }
46809
+
46437
46810
  /**
46438
46811
  * Parameters of the ListBase#itemPress event.
46439
46812
  */
@@ -46606,7 +46979,12 @@ declare namespace sap {
46606
46979
  /**
46607
46980
  * Parameters of the Menu#beforeClose event.
46608
46981
  */
46609
- interface Menu$BeforeCloseEventParameters {}
46982
+ interface Menu$BeforeCloseEventParameters {
46983
+ /**
46984
+ * The `MenuItem` which was selected (if any).
46985
+ */
46986
+ item?: sap.m.IMenuItem;
46987
+ }
46610
46988
 
46611
46989
  /**
46612
46990
  * Parameters of the Menu#closed event.
@@ -46620,7 +46998,7 @@ declare namespace sap {
46620
46998
  /**
46621
46999
  * The `MenuItem` which was selected.
46622
47000
  */
46623
- item?: sap.m.MenuItem;
47001
+ item?: sap.m.IMenuItem;
46624
47002
  }
46625
47003
 
46626
47004
  /**
@@ -46633,46 +47011,11 @@ declare namespace sap {
46633
47011
  */
46634
47012
  interface MenuButton$DefaultActionEventParameters {}
46635
47013
 
46636
- /**
46637
- * Parameters of the MenuItem#aggregationChanged event.
46638
- */
46639
- interface MenuItem$AggregationChangedEventParameters {
46640
- /**
46641
- * The aggregation name of the changed aggregation.
46642
- */
46643
- aggregationName?: string;
46644
-
46645
- /**
46646
- * Which method changed the aggregation.
46647
- */
46648
- methodName?: string;
46649
-
46650
- /**
46651
- * What parameters were used to change the aggregation.
46652
- */
46653
- methodParams?: object;
46654
- }
46655
-
46656
47014
  /**
46657
47015
  * Parameters of the MenuItem#press event.
46658
47016
  */
46659
47017
  interface MenuItem$PressEventParameters {}
46660
47018
 
46661
- /**
46662
- * Parameters of the MenuItem#propertyChanged event.
46663
- */
46664
- interface MenuItem$PropertyChangedEventParameters {
46665
- /**
46666
- * The property name to be changed.
46667
- */
46668
- propertyKey?: string;
46669
-
46670
- /**
46671
- * The new property value.
46672
- */
46673
- propertyValue?: any;
46674
- }
46675
-
46676
47019
  /**
46677
47020
  * Parameters of the MessagePage#navButtonPress event.
46678
47021
  */
@@ -51741,8 +52084,8 @@ declare namespace sap {
51741
52084
  * sap.m.MessageToast.show("This message should appear in the message toast", {
51742
52085
  * duration: 3000, // default
51743
52086
  * width: "15em", // default
51744
- * my: "center bottom", // default
51745
- * at: "center bottom", // default
52087
+ * my: "CenterBottom", // default
52088
+ * at: "CenterBottom", // default
51746
52089
  * of: window, // default
51747
52090
  * offset: "0 0", // default
51748
52091
  * collision: "fit fit", // default
@@ -51762,7 +52105,8 @@ declare namespace sap {
51762
52105
  * - You want to make sure that users read the message before they leave the page.
51763
52106
  * - You want users to be able to copy some part of the message text. (In this case, show a success {@link sap.m.Dialog Message Dialog}.)
51764
52107
  * Responsive Behavior: The message toast has the same behavior on all devices. However, you can adjust
51765
- * the width of the control, for example, for use on a desktop device.
52108
+ * the width of the control depending on the device you're using, for example desktop. Note that the width
52109
+ * can be customized up to a maximum of 15rem.
51766
52110
  * See:
51767
52111
  * {@link fiori:https://experience.sap.com/fiori-design-web/message-toast/ Message Toast}
51768
52112
  *
@@ -72304,7 +72648,9 @@ declare namespace sap {
72304
72648
  /**
72305
72649
  * The control provides a set of properties for text, sender information, time stamp. Beginning with release
72306
72650
  * 1.23 the new feature expand / collapse was introduced, which uses the property maxCharacters. Beginning
72307
- * with release 1.44, sap.m.FormattedText was introduced which allows html formatted text to be displayed
72651
+ * with release 1.44, sap.m.FormattedText was introduced which allows html formatted text to be displayed.
72652
+ * The `actions` aggregation must contain instances of {@link sap.m.FeedListItemAction} in order to display
72653
+ * them in the action sheet.
72308
72654
  *
72309
72655
  * @since 1.12
72310
72656
  */
@@ -72371,19 +72717,6 @@ declare namespace sap {
72371
72717
  * @returns Metadata object describing this class
72372
72718
  */
72373
72719
  static getMetadata(): sap.ui.core.ElementMetadata;
72374
- /**
72375
- * Adds some action to the aggregation {@link #getActions actions}.
72376
- *
72377
- * @since 1.52.0
72378
- *
72379
- * @returns Reference to `this` in order to allow method chaining
72380
- */
72381
- addAction(
72382
- /**
72383
- * The action to add; if empty, nothing is inserted
72384
- */
72385
- oAction: sap.m.FeedListItemAction
72386
- ): this;
72387
72720
  /**
72388
72721
  * Attaches event handler `fnFunction` to the {@link #event:iconPress iconPress} event of this `sap.m.FeedListItem`.
72389
72722
  *
@@ -72478,14 +72811,6 @@ declare namespace sap {
72478
72811
  */
72479
72812
  oListener?: object
72480
72813
  ): this;
72481
- /**
72482
- * Destroys all the actions in the aggregation {@link #getActions actions}.
72483
- *
72484
- * @since 1.52.0
72485
- *
72486
- * @returns Reference to `this` in order to allow method chaining
72487
- */
72488
- destroyActions(): this;
72489
72814
  /**
72490
72815
  * Detaches event handler `fnFunction` from the {@link #event:iconPress iconPress} event of this `sap.m.FeedListItem`.
72491
72816
  *
@@ -72548,14 +72873,6 @@ declare namespace sap {
72548
72873
  */
72549
72874
  mParameters?: sap.m.FeedListItem$SenderPressEventParameters
72550
72875
  ): this;
72551
- /**
72552
- * Gets content of aggregation {@link #getActions actions}.
72553
- *
72554
- * Contains {@link sap.m.FeedListItemAction elements} that are displayed in the action sheet.
72555
- *
72556
- * @since 1.52.0
72557
- */
72558
- getActions(): sap.m.FeedListItemAction[];
72559
72876
  /**
72560
72877
  * Gets current value of property {@link #getActiveIcon activeIcon}.
72561
72878
  *
@@ -72772,62 +73089,6 @@ declare namespace sap {
72772
73089
  * @returns Value of property `timestamp`
72773
73090
  */
72774
73091
  getTimestamp(): string;
72775
- /**
72776
- * Checks for the provided `sap.m.FeedListItemAction` in the aggregation {@link #getActions actions}. and
72777
- * returns its index if found or -1 otherwise.
72778
- *
72779
- * @since 1.52.0
72780
- *
72781
- * @returns The index of the provided control in the aggregation if found, or -1 otherwise
72782
- */
72783
- indexOfAction(
72784
- /**
72785
- * The action whose index is looked for
72786
- */
72787
- oAction: sap.m.FeedListItemAction
72788
- ): int;
72789
- /**
72790
- * Inserts a action into the aggregation {@link #getActions actions}.
72791
- *
72792
- * @since 1.52.0
72793
- *
72794
- * @returns Reference to `this` in order to allow method chaining
72795
- */
72796
- insertAction(
72797
- /**
72798
- * The action to insert; if empty, nothing is inserted
72799
- */
72800
- oAction: sap.m.FeedListItemAction,
72801
- /**
72802
- * The `0`-based index the action should be inserted at; for a negative value of `iIndex`, the action is
72803
- * inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
72804
- * at the last position
72805
- */
72806
- iIndex: int
72807
- ): this;
72808
- /**
72809
- * Removes a action from the aggregation {@link #getActions actions}.
72810
- *
72811
- * @since 1.52.0
72812
- *
72813
- * @returns The removed action or `null`
72814
- */
72815
- removeAction(
72816
- /**
72817
- * The action to remove or its index or id
72818
- */
72819
- vAction: int | string | sap.m.FeedListItemAction
72820
- ): sap.m.FeedListItemAction | null;
72821
- /**
72822
- * Removes all the controls from the aggregation {@link #getActions actions}.
72823
- *
72824
- * Additionally, it unregisters them from the hosting UIArea.
72825
- *
72826
- * @since 1.52.0
72827
- *
72828
- * @returns An array of the removed elements (might be empty)
72829
- */
72830
- removeAllActions(): sap.m.FeedListItemAction[];
72831
73092
  /**
72832
73093
  * Sets a new value for property {@link #getActiveIcon activeIcon}.
72833
73094
  *
@@ -73196,7 +73457,7 @@ declare namespace sap {
73196
73457
  *
73197
73458
  * @since 1.52.0
73198
73459
  */
73199
- class FeedListItemAction extends sap.ui.core.Element {
73460
+ class FeedListItemAction extends sap.m.ListItemActionBase {
73200
73461
  /**
73201
73462
  * Constructor for a new FeedListItemAction.
73202
73463
  *
@@ -73232,7 +73493,7 @@ declare namespace sap {
73232
73493
  * Creates a new subclass of class sap.m.FeedListItemAction with name `sClassName` and enriches it with
73233
73494
  * the information contained in `oClassInfo`.
73234
73495
  *
73235
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
73496
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.ListItemActionBase.extend}.
73236
73497
  *
73237
73498
  *
73238
73499
  * @returns Created class / constructor function
@@ -73349,15 +73610,6 @@ declare namespace sap {
73349
73610
  * @returns Value of property `enabled`
73350
73611
  */
73351
73612
  getEnabled(): boolean;
73352
- /**
73353
- * Gets current value of property {@link #getIcon icon}.
73354
- *
73355
- * The icon of the action.
73356
- *
73357
- *
73358
- * @returns Value of property `icon`
73359
- */
73360
- getIcon(): sap.ui.core.URI;
73361
73613
  /**
73362
73614
  * Gets current value of property {@link #getKey key}.
73363
73615
  *
@@ -73369,28 +73621,6 @@ declare namespace sap {
73369
73621
  * @returns Value of property `key`
73370
73622
  */
73371
73623
  getKey(): string;
73372
- /**
73373
- * Gets current value of property {@link #getText text}.
73374
- *
73375
- * The text of the item. It is used as a tooltip and for accessibility reasons.
73376
- *
73377
- * Default value is `empty string`.
73378
- *
73379
- *
73380
- * @returns Value of property `text`
73381
- */
73382
- getText(): string;
73383
- /**
73384
- * Gets current value of property {@link #getVisible visible}.
73385
- *
73386
- * Hides or shows a button on the UI.
73387
- *
73388
- * Default value is `true`.
73389
- *
73390
- *
73391
- * @returns Value of property `visible`
73392
- */
73393
- getVisible(): boolean;
73394
73624
  /**
73395
73625
  * Sets a new value for property {@link #getEnabled enabled}.
73396
73626
  *
@@ -73410,22 +73640,6 @@ declare namespace sap {
73410
73640
  */
73411
73641
  bEnabled?: boolean
73412
73642
  ): this;
73413
- /**
73414
- * Sets a new value for property {@link #getIcon icon}.
73415
- *
73416
- * The icon of the action.
73417
- *
73418
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
73419
- *
73420
- *
73421
- * @returns Reference to `this` in order to allow method chaining
73422
- */
73423
- setIcon(
73424
- /**
73425
- * New value for property `icon`
73426
- */
73427
- sIcon?: sap.ui.core.URI
73428
- ): this;
73429
73643
  /**
73430
73644
  * Sets a new value for property {@link #getKey key}.
73431
73645
  *
@@ -73444,42 +73658,6 @@ declare namespace sap {
73444
73658
  */
73445
73659
  sKey?: string
73446
73660
  ): this;
73447
- /**
73448
- * Sets a new value for property {@link #getText text}.
73449
- *
73450
- * The text of the item. It is used as a tooltip and for accessibility reasons.
73451
- *
73452
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
73453
- *
73454
- * Default value is `empty string`.
73455
- *
73456
- *
73457
- * @returns Reference to `this` in order to allow method chaining
73458
- */
73459
- setText(
73460
- /**
73461
- * New value for property `text`
73462
- */
73463
- sText?: string
73464
- ): this;
73465
- /**
73466
- * Sets a new value for property {@link #getVisible visible}.
73467
- *
73468
- * Hides or shows a button on the UI.
73469
- *
73470
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
73471
- *
73472
- * Default value is `true`.
73473
- *
73474
- *
73475
- * @returns Reference to `this` in order to allow method chaining
73476
- */
73477
- setVisible(
73478
- /**
73479
- * New value for property `visible`
73480
- */
73481
- bVisible?: boolean
73482
- ): this;
73483
73661
  }
73484
73662
  /**
73485
73663
  * The `sap.m.FlexBox` control builds the container for a flexible box layout.
@@ -76628,8 +76806,8 @@ declare namespace sap {
76628
76806
  }
76629
76807
  /**
76630
76808
  * `sap.m.GroupHeaderListItem` is used to display the title of a group and act as separator between groups
76631
- * in `sap.m.List` and `sap.m.Table`. **Note:** The inherited properties `unread`, `selected`, `counter`
76632
- * and `press` event from `sap.m.ListItemBase` are not supported.
76809
+ * in `sap.m.List` and `sap.m.Table`. **Note:** The inherited properties `unread`, `selected`, `counter`,
76810
+ * the `press` event, and the `actions` aggregation from `sap.m.ListItemBase` are not supported.
76633
76811
  *
76634
76812
  * There are the following known restrictions:
76635
76813
  * - When a list is manually populated with items and groups without using data binding, changes to the
@@ -80193,6 +80371,21 @@ declare namespace sap {
80193
80371
  * @returns Value of property `ariaTitleLevel`
80194
80372
  */
80195
80373
  getAriaTitleLevel(): sap.ui.core.TitleLevel;
80374
+ /**
80375
+ * Gets current value of property {@link #getDecorative decorative}.
80376
+ *
80377
+ * Defines whether the illustration is decorative.
80378
+ *
80379
+ * When set to true, the attributes `role="presentation"` and `aria-hidden="true"` are applied to the SVG
80380
+ * element.
80381
+ *
80382
+ * Default value is `false`.
80383
+ *
80384
+ * @experimental As of version 1.138.
80385
+ *
80386
+ * @returns Value of property `decorative`
80387
+ */
80388
+ getDecorative(): boolean;
80196
80389
  /**
80197
80390
  * Gets current value of property {@link #getDescription description}.
80198
80391
  *
@@ -80745,6 +80938,18 @@ declare namespace sap {
80745
80938
  * @since 1.106.0
80746
80939
  */
80747
80940
  getAriaLabelledBy(): sap.ui.core.ID[];
80941
+ /**
80942
+ * Gets current value of property {@link #getDecorative decorative}.
80943
+ *
80944
+ * Defines whether the illustration is decorative.
80945
+ *
80946
+ * Default value is `false`.
80947
+ *
80948
+ * @experimental As of version 1.138.
80949
+ *
80950
+ * @returns Value of property `decorative`
80951
+ */
80952
+ getDecorative(): boolean;
80748
80953
  /**
80749
80954
  * Gets current value of property {@link #getMedia media}.
80750
80955
  *
@@ -80817,6 +81022,25 @@ declare namespace sap {
80817
81022
  */
80818
81023
  vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
80819
81024
  ): sap.ui.core.ID | null;
81025
+ /**
81026
+ * Sets a new value for property {@link #getDecorative decorative}.
81027
+ *
81028
+ * Defines whether the illustration is decorative.
81029
+ *
81030
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
81031
+ *
81032
+ * Default value is `false`.
81033
+ *
81034
+ * @experimental As of version 1.138.
81035
+ *
81036
+ * @returns Reference to `this` in order to allow method chaining
81037
+ */
81038
+ setDecorative(
81039
+ /**
81040
+ * New value for property `decorative`
81041
+ */
81042
+ bDecorative?: boolean
81043
+ ): this;
80820
81044
  /**
80821
81045
  * Sets a new value for property {@link #getMedia media}.
80822
81046
  *
@@ -87895,6 +88119,57 @@ declare namespace sap {
87895
88119
  */
87896
88120
  oListener?: object
87897
88121
  ): this;
88122
+ /**
88123
+ * Attaches event handler `fnFunction` to the {@link #event:itemActionPress itemActionPress} event of this
88124
+ * `sap.m.ListBase`.
88125
+ *
88126
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
88127
+ * otherwise it will be bound to this `sap.m.ListBase` itself.
88128
+ *
88129
+ * Fired when an item action is pressed.
88130
+ *
88131
+ * @since 1.137
88132
+ *
88133
+ * @returns Reference to `this` in order to allow method chaining
88134
+ */
88135
+ attachItemActionPress(
88136
+ /**
88137
+ * An application-specific payload object that will be passed to the event handler along with the event
88138
+ * object when firing the event
88139
+ */
88140
+ oData: object,
88141
+ /**
88142
+ * The function to be called when the event occurs
88143
+ */
88144
+ fnFunction: (p1: ListBase$ItemActionPressEvent) => void,
88145
+ /**
88146
+ * Context object to call the event handler with. Defaults to this `sap.m.ListBase` itself
88147
+ */
88148
+ oListener?: object
88149
+ ): this;
88150
+ /**
88151
+ * Attaches event handler `fnFunction` to the {@link #event:itemActionPress itemActionPress} event of this
88152
+ * `sap.m.ListBase`.
88153
+ *
88154
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
88155
+ * otherwise it will be bound to this `sap.m.ListBase` itself.
88156
+ *
88157
+ * Fired when an item action is pressed.
88158
+ *
88159
+ * @since 1.137
88160
+ *
88161
+ * @returns Reference to `this` in order to allow method chaining
88162
+ */
88163
+ attachItemActionPress(
88164
+ /**
88165
+ * The function to be called when the event occurs
88166
+ */
88167
+ fnFunction: (p1: ListBase$ItemActionPressEvent) => void,
88168
+ /**
88169
+ * Context object to call the event handler with. Defaults to this `sap.m.ListBase` itself
88170
+ */
88171
+ oListener?: object
88172
+ ): this;
87898
88173
  /**
87899
88174
  * Attaches event handler `fnFunction` to the {@link #event:itemPress itemPress} event of this `sap.m.ListBase`.
87900
88175
  *
@@ -88348,6 +88623,26 @@ declare namespace sap {
88348
88623
  */
88349
88624
  oListener?: object
88350
88625
  ): this;
88626
+ /**
88627
+ * Detaches event handler `fnFunction` from the {@link #event:itemActionPress itemActionPress} event of
88628
+ * this `sap.m.ListBase`.
88629
+ *
88630
+ * The passed function and listener object must match the ones used for event registration.
88631
+ *
88632
+ * @since 1.137
88633
+ *
88634
+ * @returns Reference to `this` in order to allow method chaining
88635
+ */
88636
+ detachItemActionPress(
88637
+ /**
88638
+ * The function to be called, when the event occurs
88639
+ */
88640
+ fnFunction: (p1: ListBase$ItemActionPressEvent) => void,
88641
+ /**
88642
+ * Context object on which the given function had to be called
88643
+ */
88644
+ oListener?: object
88645
+ ): this;
88351
88646
  /**
88352
88647
  * Detaches event handler `fnFunction` from the {@link #event:itemPress itemPress} event of this `sap.m.ListBase`.
88353
88648
  *
@@ -88524,6 +88819,20 @@ declare namespace sap {
88524
88819
  */
88525
88820
  mParameters?: sap.m.ListBase$GrowingStartedEventParameters
88526
88821
  ): this;
88822
+ /**
88823
+ * Fires event {@link #event:itemActionPress itemActionPress} to attached listeners.
88824
+ *
88825
+ * @since 1.137
88826
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
88827
+ *
88828
+ * @returns Reference to `this` in order to allow method chaining
88829
+ */
88830
+ fireItemActionPress(
88831
+ /**
88832
+ * Parameters to pass along with the event
88833
+ */
88834
+ mParameters?: sap.m.ListBase$ItemActionPressEventParameters
88835
+ ): this;
88527
88836
  /**
88528
88837
  * Fires event {@link #event:itemPress itemPress} to attached listeners.
88529
88838
  *
@@ -88809,6 +89118,25 @@ declare namespace sap {
88809
89118
  * @returns Value of property `inset`
88810
89119
  */
88811
89120
  getInset(): boolean;
89121
+ /**
89122
+ * Gets current value of property {@link #getItemActionCount itemActionCount}.
89123
+ *
89124
+ * Defines the maximum number of item actions.
89125
+ *
89126
+ * If the number of item actions exceeds the `itemActionCount` property value, an overflow button will appear,
89127
+ * providing access to the additional actions.
89128
+ *
89129
+ * **Note:** Only values between `0-2` enables the use of the new `actions` aggregation. When enabled, the
89130
+ * {@link sap.m.ListMode Delete} mode and the {@link sap.m.ListType Detail} list item type have no effect.
89131
+ * Instead, dedicated actions of {@link sap.m.ListItemActionType type} `Delete` or `Edit` should be used.
89132
+ *
89133
+ * Default value is `-1`.
89134
+ *
89135
+ * @since 1.137
89136
+ *
89137
+ * @returns Value of property `itemActionCount`
89138
+ */
89139
+ getItemActionCount(): int;
88812
89140
  /**
88813
89141
  * Returns the ItemNavigation delegate of the list
88814
89142
  *
@@ -89466,6 +89794,32 @@ declare namespace sap {
89466
89794
  */
89467
89795
  bInset?: boolean
89468
89796
  ): this;
89797
+ /**
89798
+ * Sets a new value for property {@link #getItemActionCount itemActionCount}.
89799
+ *
89800
+ * Defines the maximum number of item actions.
89801
+ *
89802
+ * If the number of item actions exceeds the `itemActionCount` property value, an overflow button will appear,
89803
+ * providing access to the additional actions.
89804
+ *
89805
+ * **Note:** Only values between `0-2` enables the use of the new `actions` aggregation. When enabled, the
89806
+ * {@link sap.m.ListMode Delete} mode and the {@link sap.m.ListType Detail} list item type have no effect.
89807
+ * Instead, dedicated actions of {@link sap.m.ListItemActionType type} `Delete` or `Edit` should be used.
89808
+ *
89809
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
89810
+ *
89811
+ * Default value is `-1`.
89812
+ *
89813
+ * @since 1.137
89814
+ *
89815
+ * @returns Reference to `this` in order to allow method chaining
89816
+ */
89817
+ setItemActionCount(
89818
+ /**
89819
+ * New value for property `itemActionCount`
89820
+ */
89821
+ iItemActionCount?: int
89822
+ ): this;
89469
89823
  /**
89470
89824
  * Sets a new value for property {@link #getKeyboardMode keyboardMode}.
89471
89825
  *
@@ -89797,6 +90151,249 @@ declare namespace sap {
89797
90151
  */
89798
90152
  unbindItems(): this;
89799
90153
  }
90154
+ /**
90155
+ * The `sap.m.ListItemAction` control provides the option to define actions directly related to list items.
90156
+ *
90157
+ * @since 1.137
90158
+ */
90159
+ class ListItemAction
90160
+ extends /* was: sap.ui.core.ListItemActionBase */ Object
90161
+ {
90162
+ /**
90163
+ * Constructor for a new action for list items.
90164
+ *
90165
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
90166
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
90167
+ * of the syntax of the settings object.
90168
+ */
90169
+ constructor(
90170
+ /**
90171
+ * id for the new control, generated automatically if no id is given
90172
+ */
90173
+ sId?: string,
90174
+ /**
90175
+ * Initial settings for the new control
90176
+ */
90177
+ mSettings?: object
90178
+ );
90179
+
90180
+ /**
90181
+ * Creates a new subclass of class sap.m.ListItemAction with name `sClassName` and enriches it with the
90182
+ * information contained in `oClassInfo`.
90183
+ *
90184
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.ListItemActionBase.extend}.
90185
+ *
90186
+ *
90187
+ * @returns Created class / constructor function
90188
+ */
90189
+ static extend<T extends Record<string, unknown>>(
90190
+ /**
90191
+ * Name of the class being created
90192
+ */
90193
+ sClassName: string,
90194
+ /**
90195
+ * Object literal with information about the class
90196
+ */
90197
+ oClassInfo?: sap.ClassInfo<T, sap.m.ListItemAction>,
90198
+ /**
90199
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
90200
+ * used by this class
90201
+ */
90202
+ FNMetaImpl?: Function
90203
+ ): Function;
90204
+ /**
90205
+ * Returns a metadata object for class sap.m.ListItemAction.
90206
+ *
90207
+ *
90208
+ * @returns Metadata object describing this class
90209
+ */
90210
+ static getMetadata(): sap.ui.base.Metadata;
90211
+ /**
90212
+ * Gets current value of property {@link #getType type}.
90213
+ *
90214
+ * Defines the type of the action.
90215
+ *
90216
+ * Default value is `Custom`.
90217
+ *
90218
+ *
90219
+ * @returns Value of property `type`
90220
+ */
90221
+ getType(): sap.m.ListItemActionType;
90222
+ /**
90223
+ * Sets a new value for property {@link #getType type}.
90224
+ *
90225
+ * Defines the type of the action.
90226
+ *
90227
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
90228
+ *
90229
+ * Default value is `Custom`.
90230
+ *
90231
+ *
90232
+ * @returns Reference to `this` in order to allow method chaining
90233
+ */
90234
+ setType(
90235
+ /**
90236
+ * New value for property `type`
90237
+ */
90238
+ sType?: sap.m.ListItemActionType
90239
+ ): this;
90240
+ }
90241
+ /**
90242
+ * The `sap.m.ListItemActionBase` class serves as a foundation for list item actions.
90243
+ *
90244
+ * @since 1.137
90245
+ */
90246
+ abstract class ListItemActionBase extends sap.ui.core.Element {
90247
+ /**
90248
+ * Constructor for a new action for list items.
90249
+ *
90250
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
90251
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
90252
+ * of the syntax of the settings object.
90253
+ */
90254
+ constructor(
90255
+ /**
90256
+ * Initial settings for the new action
90257
+ */
90258
+ mSettings?: sap.m.$ListItemActionBaseSettings
90259
+ );
90260
+ /**
90261
+ * Constructor for a new action for list items.
90262
+ *
90263
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
90264
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
90265
+ * of the syntax of the settings object.
90266
+ */
90267
+ constructor(
90268
+ /**
90269
+ * id for the new control, generated automatically if no id is given
90270
+ */
90271
+ sId?: string,
90272
+ /**
90273
+ * Initial settings for the new action
90274
+ */
90275
+ mSettings?: sap.m.$ListItemActionBaseSettings
90276
+ );
90277
+
90278
+ /**
90279
+ * Creates a new subclass of class sap.m.ListItemActionBase with name `sClassName` and enriches it with
90280
+ * the information contained in `oClassInfo`.
90281
+ *
90282
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
90283
+ *
90284
+ *
90285
+ * @returns Created class / constructor function
90286
+ */
90287
+ static extend<T extends Record<string, unknown>>(
90288
+ /**
90289
+ * Name of the class being created
90290
+ */
90291
+ sClassName: string,
90292
+ /**
90293
+ * Object literal with information about the class
90294
+ */
90295
+ oClassInfo?: sap.ClassInfo<T, sap.m.ListItemActionBase>,
90296
+ /**
90297
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
90298
+ * used by this class
90299
+ */
90300
+ FNMetaImpl?: Function
90301
+ ): Function;
90302
+ /**
90303
+ * Returns a metadata object for class sap.m.ListItemActionBase.
90304
+ *
90305
+ *
90306
+ * @returns Metadata object describing this class
90307
+ */
90308
+ static getMetadata(): sap.ui.core.ElementMetadata;
90309
+ /**
90310
+ * Gets current value of property {@link #getIcon icon}.
90311
+ *
90312
+ * Defines the icon of the action.
90313
+ *
90314
+ * Default value is `empty string`.
90315
+ *
90316
+ *
90317
+ * @returns Value of property `icon`
90318
+ */
90319
+ getIcon(): sap.ui.core.URI;
90320
+ /**
90321
+ * Gets current value of property {@link #getText text}.
90322
+ *
90323
+ * Defines the text of the action.
90324
+ *
90325
+ * Default value is `empty string`.
90326
+ *
90327
+ *
90328
+ * @returns Value of property `text`
90329
+ */
90330
+ getText(): string;
90331
+ /**
90332
+ * Gets current value of property {@link #getVisible visible}.
90333
+ *
90334
+ * Defines the visibility of the action.
90335
+ *
90336
+ * Default value is `true`.
90337
+ *
90338
+ *
90339
+ * @returns Value of property `visible`
90340
+ */
90341
+ getVisible(): boolean;
90342
+ /**
90343
+ * Sets a new value for property {@link #getIcon icon}.
90344
+ *
90345
+ * Defines the icon of the action.
90346
+ *
90347
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
90348
+ *
90349
+ * Default value is `empty string`.
90350
+ *
90351
+ *
90352
+ * @returns Reference to `this` in order to allow method chaining
90353
+ */
90354
+ setIcon(
90355
+ /**
90356
+ * New value for property `icon`
90357
+ */
90358
+ sIcon?: sap.ui.core.URI
90359
+ ): this;
90360
+ /**
90361
+ * Sets a new value for property {@link #getText text}.
90362
+ *
90363
+ * Defines the text of the action.
90364
+ *
90365
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
90366
+ *
90367
+ * Default value is `empty string`.
90368
+ *
90369
+ *
90370
+ * @returns Reference to `this` in order to allow method chaining
90371
+ */
90372
+ setText(
90373
+ /**
90374
+ * New value for property `text`
90375
+ */
90376
+ sText?: string
90377
+ ): this;
90378
+ /**
90379
+ * Sets a new value for property {@link #getVisible visible}.
90380
+ *
90381
+ * Defines the visibility of the action.
90382
+ *
90383
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
90384
+ *
90385
+ * Default value is `true`.
90386
+ *
90387
+ *
90388
+ * @returns Reference to `this` in order to allow method chaining
90389
+ */
90390
+ setVisible(
90391
+ /**
90392
+ * New value for property `visible`
90393
+ */
90394
+ bVisible?: boolean
90395
+ ): this;
90396
+ }
89800
90397
  /**
89801
90398
  * ListItemBase contains the base features of all specific list items. **Note:** If not mentioned otherwise
89802
90399
  * in the individual subclasses, list items must only be used in the `items` aggregation of `sap.m.ListBase`
@@ -89865,6 +90462,19 @@ declare namespace sap {
89865
90462
  * @returns Metadata object describing this class
89866
90463
  */
89867
90464
  static getMetadata(): sap.ui.core.ElementMetadata;
90465
+ /**
90466
+ * Adds some action to the aggregation {@link #getActions actions}.
90467
+ *
90468
+ * @since 1.137
90469
+ *
90470
+ * @returns Reference to `this` in order to allow method chaining
90471
+ */
90472
+ addAction(
90473
+ /**
90474
+ * The action to add; if empty, nothing is inserted
90475
+ */
90476
+ oAction: sap.m.ListItemActionBase
90477
+ ): this;
89868
90478
  /**
89869
90479
  * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
89870
90480
  *
@@ -90076,6 +90686,14 @@ declare namespace sap {
90076
90686
  */
90077
90687
  oListener?: object
90078
90688
  ): this;
90689
+ /**
90690
+ * Destroys all the actions in the aggregation {@link #getActions actions}.
90691
+ *
90692
+ * @since 1.137
90693
+ *
90694
+ * @returns Reference to `this` in order to allow method chaining
90695
+ */
90696
+ destroyActions(): this;
90079
90697
  /**
90080
90698
  * Detaches event handler `fnFunction` from the {@link #event:detailPress detailPress} event of this `sap.m.ListItemBase`.
90081
90699
  *
@@ -90204,6 +90822,14 @@ declare namespace sap {
90204
90822
  */
90205
90823
  mParameters?: object
90206
90824
  ): this;
90825
+ /**
90826
+ * Gets content of aggregation {@link #getActions actions}.
90827
+ *
90828
+ * Defines the actions contained within this control.
90829
+ *
90830
+ * @since 1.137
90831
+ */
90832
+ getActions(): sap.m.ListItemActionBase[];
90207
90833
  /**
90208
90834
  * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
90209
90835
  *
@@ -90338,6 +90964,39 @@ declare namespace sap {
90338
90964
  * @returns Value of property `visible`
90339
90965
  */
90340
90966
  getVisible(): boolean;
90967
+ /**
90968
+ * Checks for the provided `sap.m.ListItemActionBase` in the aggregation {@link #getActions actions}. and
90969
+ * returns its index if found or -1 otherwise.
90970
+ *
90971
+ * @since 1.137
90972
+ *
90973
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
90974
+ */
90975
+ indexOfAction(
90976
+ /**
90977
+ * The action whose index is looked for
90978
+ */
90979
+ oAction: sap.m.ListItemActionBase
90980
+ ): int;
90981
+ /**
90982
+ * Inserts a action into the aggregation {@link #getActions actions}.
90983
+ *
90984
+ * @since 1.137
90985
+ *
90986
+ * @returns Reference to `this` in order to allow method chaining
90987
+ */
90988
+ insertAction(
90989
+ /**
90990
+ * The action to insert; if empty, nothing is inserted
90991
+ */
90992
+ oAction: sap.m.ListItemActionBase,
90993
+ /**
90994
+ * The `0`-based index the action should be inserted at; for a negative value of `iIndex`, the action is
90995
+ * inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted
90996
+ * at the last position
90997
+ */
90998
+ iIndex: int
90999
+ ): this;
90341
91000
  /**
90342
91001
  * Returns the state of the item selection as a boolean
90343
91002
  *
@@ -90345,6 +91004,29 @@ declare namespace sap {
90345
91004
  * method instead.
90346
91005
  */
90347
91006
  isSelected(): boolean;
91007
+ /**
91008
+ * Removes a action from the aggregation {@link #getActions actions}.
91009
+ *
91010
+ * @since 1.137
91011
+ *
91012
+ * @returns The removed action or `null`
91013
+ */
91014
+ removeAction(
91015
+ /**
91016
+ * The action to remove or its index or id
91017
+ */
91018
+ vAction: int | string | sap.m.ListItemActionBase
91019
+ ): sap.m.ListItemActionBase | null;
91020
+ /**
91021
+ * Removes all the controls from the aggregation {@link #getActions actions}.
91022
+ *
91023
+ * Additionally, it unregisters them from the hosting UIArea.
91024
+ *
91025
+ * @since 1.137
91026
+ *
91027
+ * @returns An array of the removed elements (might be empty)
91028
+ */
91029
+ removeAllActions(): sap.m.ListItemActionBase[];
90348
91030
  /**
90349
91031
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
90350
91032
  *
@@ -91102,11 +91784,6 @@ declare namespace sap {
91102
91784
  /**
91103
91785
  * The `sap.m.Menu` control represents a hierarchical menu. When opened on mobile devices it occupies the
91104
91786
  * whole screen.
91105
- *
91106
- * **Note:** The application developer should add dependency to `sap.ui.unified` library on application
91107
- * level to ensure that the library is loaded before the module dependencies will be required. If the `sap.ui.unified`
91108
- * library is not loaded in advance, this could lead to CSP compliance issues and adds an additional waiting
91109
- * time. To prevent this, ensure that the `sap.ui.unified` library is loaded in advance.
91110
91787
  */
91111
91788
  class Menu extends sap.ui.core.Control implements sap.ui.core.IContextMenu {
91112
91789
  __implements__sap_ui_core_IContextMenu: boolean;
@@ -91206,7 +91883,7 @@ declare namespace sap {
91206
91883
  /**
91207
91884
  * The function to be called when the event occurs
91208
91885
  */
91209
- fnFunction: (p1: sap.ui.base.Event) => void,
91886
+ fnFunction: (p1: Menu$BeforeCloseEvent) => void,
91210
91887
  /**
91211
91888
  * Context object to call the event handler with. Defaults to this `sap.m.Menu` itself
91212
91889
  */
@@ -91229,7 +91906,7 @@ declare namespace sap {
91229
91906
  /**
91230
91907
  * The function to be called when the event occurs
91231
91908
  */
91232
- fnFunction: (p1: sap.ui.base.Event) => void,
91909
+ fnFunction: (p1: Menu$BeforeCloseEvent) => void,
91233
91910
  /**
91234
91911
  * Context object to call the event handler with. Defaults to this `sap.m.Menu` itself
91235
91912
  */
@@ -91345,9 +92022,17 @@ declare namespace sap {
91345
92022
  oBindingInfo: sap.ui.base.ManagedObject.AggregationBindingInfo
91346
92023
  ): this;
91347
92024
  /**
91348
- * Closes the `Menu`.
92025
+ * Closes the `Menu` if the `beforeClose` event isn`t prevented.
92026
+ *
92027
+ *
92028
+ * @returns `this` to allow method chaining
91349
92029
  */
91350
- close(): void;
92030
+ close(
92031
+ /**
92032
+ * closePopover event
92033
+ */
92034
+ oEvent: sap.ui.base.Event
92035
+ ): this;
91351
92036
  /**
91352
92037
  * Destroys all the items in the aggregation {@link #getItems items}.
91353
92038
  *
@@ -91368,7 +92053,7 @@ declare namespace sap {
91368
92053
  /**
91369
92054
  * The function to be called, when the event occurs
91370
92055
  */
91371
- fnFunction: (p1: sap.ui.base.Event) => void,
92056
+ fnFunction: (p1: Menu$BeforeCloseEvent) => void,
91372
92057
  /**
91373
92058
  * Context object on which the given function had to be called
91374
92059
  */
@@ -91425,7 +92110,7 @@ declare namespace sap {
91425
92110
  /**
91426
92111
  * Parameters to pass along with the event
91427
92112
  */
91428
- mParameters?: object
92113
+ mParameters?: sap.m.Menu$BeforeCloseEventParameters
91429
92114
  ): boolean;
91430
92115
  /**
91431
92116
  * Fires event {@link #event:closed closed} to attached listeners.
@@ -91525,7 +92210,7 @@ declare namespace sap {
91525
92210
  */
91526
92211
  openAsContextMenu(
91527
92212
  /**
91528
- * The event object or an object containing offsetX, offsetY values and left, top values of the element's
92213
+ * The event object or an object containing offsetX, offsetY values and left, top values for the element's
91529
92214
  * position
91530
92215
  */
91531
92216
  oEvent: jQuery.Event | object,
@@ -91536,31 +92221,16 @@ declare namespace sap {
91536
92221
  ): void;
91537
92222
  /**
91538
92223
  * Opens the `Menu` next to the given control.
92224
+ *
92225
+ *
92226
+ * @returns `this` to allow method chaining
91539
92227
  */
91540
92228
  openBy(
91541
92229
  /**
91542
92230
  * The control that defines the position for the menu
91543
92231
  */
91544
- oControl: sap.ui.core.Control,
91545
- /**
91546
- * Whether the menu is opened with a shortcut or not
91547
- */
91548
- bWithKeyboard: boolean,
91549
- /**
91550
- * The reference docking location of the `Menu` for positioning the menu on the screen
91551
- */
91552
- sDockMy?: sap.ui.core.Popup.Dock,
91553
- /**
91554
- * The `oControl` reference docking location for positioning the menu on the screen
91555
- */
91556
- sDockAt?: sap.ui.core.Popup.Dock,
91557
- /**
91558
- * The offset relative to the docking point, specified as a string with space-separated pixel values (e.g.
91559
- * "0 10" to move the popup 10 pixels to the right). If the docking of both "my" and "at" is RTL-sensitive
91560
- * ("begin" or "end"), this offset is automatically mirrored in the RTL case as well.
91561
- */
91562
- sOffset?: string
91563
- ): void;
92232
+ oControl: sap.ui.core.Control
92233
+ ): this;
91564
92234
  /**
91565
92235
  * Removes all the controls from the aggregation {@link #getItems items}.
91566
92236
  *
@@ -91583,7 +92253,7 @@ declare namespace sap {
91583
92253
  vItem: int | string | sap.m.IMenuItem
91584
92254
  ): sap.m.IMenuItem | null;
91585
92255
  /**
91586
- * Sets the title of the `Menu`.
92256
+ * Sets the title of the `Menu` in mobile view.
91587
92257
  *
91588
92258
  *
91589
92259
  * @returns `this` to allow method chaining
@@ -92308,12 +92978,16 @@ declare namespace sap {
92308
92978
  ): this;
92309
92979
  }
92310
92980
  /**
92311
- * The `MenuItem` control is used for creating items for the `sap.m.Menu`. It is derived from a core `sap.ui.core.Item`.
92981
+ * The `MenuItem` control is used for creating items for the `sap.m.Menu`. It is derived from a core `sap.ui.core.Control`.
92312
92982
  *
92313
92983
  * @since 1.38
92314
92984
  */
92315
- class MenuItem extends sap.ui.core.Item implements sap.m.IMenuItem {
92985
+ class MenuItem
92986
+ extends sap.ui.core.Control
92987
+ implements sap.m.IMenuItem, sap.m.IMenuItemBehavior
92988
+ {
92316
92989
  __implements__sap_m_IMenuItem: boolean;
92990
+ __implements__sap_m_IMenuItemBehavior: boolean;
92317
92991
  /**
92318
92992
  * Constructor for a new `MenuItem`.
92319
92993
  *
@@ -92349,7 +93023,7 @@ declare namespace sap {
92349
93023
  * Creates a new subclass of class sap.m.MenuItem with name `sClassName` and enriches it with the information
92350
93024
  * contained in `oClassInfo`.
92351
93025
  *
92352
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
93026
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
92353
93027
  *
92354
93028
  *
92355
93029
  * @returns Created class / constructor function
@@ -92401,55 +93075,6 @@ declare namespace sap {
92401
93075
  */
92402
93076
  oItem: sap.m.IMenuItem
92403
93077
  ): this;
92404
- /**
92405
- * Attaches event handler `fnFunction` to the {@link #event:aggregationChanged aggregationChanged} event
92406
- * of this `sap.m.MenuItem`.
92407
- *
92408
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
92409
- * otherwise it will be bound to this `sap.m.MenuItem` itself.
92410
- *
92411
- * Fired when aggregation of the item changes.
92412
- *
92413
- *
92414
- * @returns Reference to `this` in order to allow method chaining
92415
- */
92416
- attachAggregationChanged(
92417
- /**
92418
- * An application-specific payload object that will be passed to the event handler along with the event
92419
- * object when firing the event
92420
- */
92421
- oData: object,
92422
- /**
92423
- * The function to be called when the event occurs
92424
- */
92425
- fnFunction: (p1: MenuItem$AggregationChangedEvent) => void,
92426
- /**
92427
- * Context object to call the event handler with. Defaults to this `sap.m.MenuItem` itself
92428
- */
92429
- oListener?: object
92430
- ): this;
92431
- /**
92432
- * Attaches event handler `fnFunction` to the {@link #event:aggregationChanged aggregationChanged} event
92433
- * of this `sap.m.MenuItem`.
92434
- *
92435
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
92436
- * otherwise it will be bound to this `sap.m.MenuItem` itself.
92437
- *
92438
- * Fired when aggregation of the item changes.
92439
- *
92440
- *
92441
- * @returns Reference to `this` in order to allow method chaining
92442
- */
92443
- attachAggregationChanged(
92444
- /**
92445
- * The function to be called when the event occurs
92446
- */
92447
- fnFunction: (p1: MenuItem$AggregationChangedEvent) => void,
92448
- /**
92449
- * Context object to call the event handler with. Defaults to this `sap.m.MenuItem` itself
92450
- */
92451
- oListener?: object
92452
- ): this;
92453
93078
  /**
92454
93079
  * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.m.MenuItem`.
92455
93080
  *
@@ -92497,55 +93122,6 @@ declare namespace sap {
92497
93122
  */
92498
93123
  oListener?: object
92499
93124
  ): this;
92500
- /**
92501
- * Attaches event handler `fnFunction` to the {@link #event:propertyChanged propertyChanged} event of this
92502
- * `sap.m.MenuItem`.
92503
- *
92504
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
92505
- * otherwise it will be bound to this `sap.m.MenuItem` itself.
92506
- *
92507
- * Fired when a property of the item changes.
92508
- *
92509
- *
92510
- * @returns Reference to `this` in order to allow method chaining
92511
- */
92512
- attachPropertyChanged(
92513
- /**
92514
- * An application-specific payload object that will be passed to the event handler along with the event
92515
- * object when firing the event
92516
- */
92517
- oData: object,
92518
- /**
92519
- * The function to be called when the event occurs
92520
- */
92521
- fnFunction: (p1: MenuItem$PropertyChangedEvent) => void,
92522
- /**
92523
- * Context object to call the event handler with. Defaults to this `sap.m.MenuItem` itself
92524
- */
92525
- oListener?: object
92526
- ): this;
92527
- /**
92528
- * Attaches event handler `fnFunction` to the {@link #event:propertyChanged propertyChanged} event of this
92529
- * `sap.m.MenuItem`.
92530
- *
92531
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
92532
- * otherwise it will be bound to this `sap.m.MenuItem` itself.
92533
- *
92534
- * Fired when a property of the item changes.
92535
- *
92536
- *
92537
- * @returns Reference to `this` in order to allow method chaining
92538
- */
92539
- attachPropertyChanged(
92540
- /**
92541
- * The function to be called when the event occurs
92542
- */
92543
- fnFunction: (p1: MenuItem$PropertyChangedEvent) => void,
92544
- /**
92545
- * Context object to call the event handler with. Defaults to this `sap.m.MenuItem` itself
92546
- */
92547
- oListener?: object
92548
- ): this;
92549
93125
  /**
92550
93126
  * Binds aggregation {@link #getItems items} to model data.
92551
93127
  *
@@ -92576,25 +93152,6 @@ declare namespace sap {
92576
93152
  * @returns Reference to `this` in order to allow method chaining
92577
93153
  */
92578
93154
  destroyItems(): this;
92579
- /**
92580
- * Detaches event handler `fnFunction` from the {@link #event:aggregationChanged aggregationChanged} event
92581
- * of this `sap.m.MenuItem`.
92582
- *
92583
- * The passed function and listener object must match the ones used for event registration.
92584
- *
92585
- *
92586
- * @returns Reference to `this` in order to allow method chaining
92587
- */
92588
- detachAggregationChanged(
92589
- /**
92590
- * The function to be called, when the event occurs
92591
- */
92592
- fnFunction: (p1: MenuItem$AggregationChangedEvent) => void,
92593
- /**
92594
- * Context object on which the given function had to be called
92595
- */
92596
- oListener?: object
92597
- ): this;
92598
93155
  /**
92599
93156
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.m.MenuItem`.
92600
93157
  *
@@ -92613,38 +93170,6 @@ declare namespace sap {
92613
93170
  */
92614
93171
  oListener?: object
92615
93172
  ): this;
92616
- /**
92617
- * Detaches event handler `fnFunction` from the {@link #event:propertyChanged propertyChanged} event of
92618
- * this `sap.m.MenuItem`.
92619
- *
92620
- * The passed function and listener object must match the ones used for event registration.
92621
- *
92622
- *
92623
- * @returns Reference to `this` in order to allow method chaining
92624
- */
92625
- detachPropertyChanged(
92626
- /**
92627
- * The function to be called, when the event occurs
92628
- */
92629
- fnFunction: (p1: MenuItem$PropertyChangedEvent) => void,
92630
- /**
92631
- * Context object on which the given function had to be called
92632
- */
92633
- oListener?: object
92634
- ): this;
92635
- /**
92636
- * Fires event {@link #event:aggregationChanged aggregationChanged} to attached listeners.
92637
- *
92638
- * @ui5-protected Do not call from applications (only from related classes in the framework)
92639
- *
92640
- * @returns Reference to `this` in order to allow method chaining
92641
- */
92642
- fireAggregationChanged(
92643
- /**
92644
- * Parameters to pass along with the event
92645
- */
92646
- mParameters?: sap.m.MenuItem$AggregationChangedEventParameters
92647
- ): this;
92648
93173
  /**
92649
93174
  * Fires event {@link #event:press press} to attached listeners.
92650
93175
  *
@@ -92659,24 +93184,26 @@ declare namespace sap {
92659
93184
  mParameters?: object
92660
93185
  ): this;
92661
93186
  /**
92662
- * Fires event {@link #event:propertyChanged propertyChanged} to attached listeners.
93187
+ * Gets current value of property {@link #getEnabled enabled}.
92663
93188
  *
92664
- * @ui5-protected Do not call from applications (only from related classes in the framework)
93189
+ * Enabled items can be selected.
92665
93190
  *
92666
- * @returns Reference to `this` in order to allow method chaining
93191
+ * Default value is `true`.
93192
+ *
93193
+ *
93194
+ * @returns Value of property `enabled`
92667
93195
  */
92668
- firePropertyChanged(
92669
- /**
92670
- * Parameters to pass along with the event
92671
- */
92672
- mParameters?: sap.m.MenuItem$PropertyChangedEventParameters
92673
- ): this;
93196
+ getEnabled(): boolean;
92674
93197
  /**
92675
93198
  * Gets content of aggregation {@link #getEndContent endContent}.
92676
93199
  *
92677
93200
  * Defines the content that is displayed at the end of a menu item. This aggregation allows for the addition
92678
93201
  * of custom elements, such as icons and buttons.
92679
93202
  *
93203
+ * **Note:** Application developers are responsible for ensuring that interactive `endContent` controls
93204
+ * have the correct accessibility behaviour, including their enabled or disabled states. The Menu
93205
+ * does not manage these aspects when the menu item state changes.
93206
+ *
92680
93207
  * @since 1.131
92681
93208
  */
92682
93209
  getEndContent(): sap.ui.core.Control[];
@@ -92692,9 +93219,18 @@ declare namespace sap {
92692
93219
  /**
92693
93220
  * Gets content of aggregation {@link #getItems items}.
92694
93221
  *
92695
- * Defines the sub-items contained within this element.
93222
+ * Defines the subitems contained within this element.
92696
93223
  */
92697
93224
  getItems(): sap.m.IMenuItem[];
93225
+ /**
93226
+ * Gets current value of property {@link #getKey key}.
93227
+ *
93228
+ * Can be used as input for subsequent actions.
93229
+ *
93230
+ *
93231
+ * @returns Value of property `key`
93232
+ */
93233
+ getKey(): string;
92698
93234
  /**
92699
93235
  * Gets current value of property {@link #getSelected selected}.
92700
93236
  *
@@ -92733,6 +93269,28 @@ declare namespace sap {
92733
93269
  * @returns Value of property `startsSection`
92734
93270
  */
92735
93271
  getStartsSection(): boolean;
93272
+ /**
93273
+ * Gets current value of property {@link #getText text}.
93274
+ *
93275
+ * The text to be displayed for the item.
93276
+ *
93277
+ * Default value is `empty string`.
93278
+ *
93279
+ *
93280
+ * @returns Value of property `text`
93281
+ */
93282
+ getText(): string;
93283
+ /**
93284
+ * Gets current value of property {@link #getTextDirection textDirection}.
93285
+ *
93286
+ * Options are RTL and LTR. Alternatively, an item can inherit its text direction from its parent control.
93287
+ *
93288
+ * Default value is `Inherit`.
93289
+ *
93290
+ *
93291
+ * @returns Value of property `textDirection`
93292
+ */
93293
+ getTextDirection(): sap.ui.core.TextDirection;
92736
93294
  /**
92737
93295
  * Gets current value of property {@link #getVisible visible}.
92738
93296
  *
@@ -92809,6 +93367,30 @@ declare namespace sap {
92809
93367
  */
92810
93368
  iIndex: int
92811
93369
  ): this;
93370
+ /**
93371
+ * Returns whether the item can be counted in total items count. **Note:** This method can be overridden
93372
+ * by subclasses to implement custom behavior.
93373
+ *
93374
+ *
93375
+ * @returns Whether the item is counted in total items count
93376
+ */
93377
+ isCountable(): boolean;
93378
+ /**
93379
+ * Returns whether the item can be focused. **Note:** This method can be overridden by subclasses to implement
93380
+ * custom behavior.
93381
+ *
93382
+ *
93383
+ * @returns Whether the item is enabled for focus
93384
+ */
93385
+ isFocusable(): boolean;
93386
+ /**
93387
+ * Returns whether the firing of press event is allowed. **Note:** This method can be overridden by subclasses
93388
+ * to implement custom behavior.
93389
+ *
93390
+ *
93391
+ * @returns Whether the item is enabled for click/press
93392
+ */
93393
+ isInteractive(): boolean;
92812
93394
  /**
92813
93395
  * Removes all the controls from the aggregation {@link #getEndContent endContent}.
92814
93396
  *
@@ -92853,6 +93435,24 @@ declare namespace sap {
92853
93435
  */
92854
93436
  vItem: int | string | sap.m.IMenuItem
92855
93437
  ): sap.m.IMenuItem | null;
93438
+ /**
93439
+ * Sets a new value for property {@link #getEnabled enabled}.
93440
+ *
93441
+ * Enabled items can be selected.
93442
+ *
93443
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
93444
+ *
93445
+ * Default value is `true`.
93446
+ *
93447
+ *
93448
+ * @returns Reference to `this` in order to allow method chaining
93449
+ */
93450
+ setEnabled(
93451
+ /**
93452
+ * New value for property `enabled`
93453
+ */
93454
+ bEnabled?: boolean
93455
+ ): this;
92856
93456
  /**
92857
93457
  * Sets a new value for property {@link #getIcon icon}.
92858
93458
  *
@@ -92869,6 +93469,22 @@ declare namespace sap {
92869
93469
  */
92870
93470
  sIcon?: string
92871
93471
  ): this;
93472
+ /**
93473
+ * Sets a new value for property {@link #getKey key}.
93474
+ *
93475
+ * Can be used as input for subsequent actions.
93476
+ *
93477
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
93478
+ *
93479
+ *
93480
+ * @returns Reference to `this` in order to allow method chaining
93481
+ */
93482
+ setKey(
93483
+ /**
93484
+ * New value for property `key`
93485
+ */
93486
+ sKey?: string
93487
+ ): this;
92872
93488
  /**
92873
93489
  * Sets a new value for property {@link #getShortcutText shortcutText}.
92874
93490
  *
@@ -92907,6 +93523,42 @@ declare namespace sap {
92907
93523
  */
92908
93524
  bStartsSection?: boolean
92909
93525
  ): this;
93526
+ /**
93527
+ * Sets a new value for property {@link #getText text}.
93528
+ *
93529
+ * The text to be displayed for the item.
93530
+ *
93531
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
93532
+ *
93533
+ * Default value is `empty string`.
93534
+ *
93535
+ *
93536
+ * @returns Reference to `this` in order to allow method chaining
93537
+ */
93538
+ setText(
93539
+ /**
93540
+ * New value for property `text`
93541
+ */
93542
+ sText?: string
93543
+ ): this;
93544
+ /**
93545
+ * Sets a new value for property {@link #getTextDirection textDirection}.
93546
+ *
93547
+ * Options are RTL and LTR. Alternatively, an item can inherit its text direction from its parent control.
93548
+ *
93549
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
93550
+ *
93551
+ * Default value is `Inherit`.
93552
+ *
93553
+ *
93554
+ * @returns Reference to `this` in order to allow method chaining
93555
+ */
93556
+ setTextDirection(
93557
+ /**
93558
+ * New value for property `textDirection`
93559
+ */
93560
+ sTextDirection?: sap.ui.core.TextDirection
93561
+ ): this;
92910
93562
  /**
92911
93563
  * Sets a new value for property {@link #getVisible visible}.
92912
93564
  *
@@ -92937,7 +93589,7 @@ declare namespace sap {
92937
93589
  /**
92938
93590
  * Group item to be used inside a menu. Represents a collection of menu items that can have the same selection
92939
93591
  * mode (e.g. {@link sap.ui.core.ItemSelectionMode.None}, {@link sap.ui.core.ItemSelectionMode.SingleSelect},
92940
- * or {@link sap.ui.unified.ItemSelectionMode.MultiSelect}).
93592
+ * or {@link sap.ui.core.ItemSelectionMode.MultiSelect}).
92941
93593
  *
92942
93594
  * @since 1.127.0
92943
93595
  */
@@ -93006,33 +93658,24 @@ declare namespace sap {
93006
93658
  */
93007
93659
  static getMetadata(): sap.ui.core.ElementMetadata;
93008
93660
  /**
93009
- * Adds an item to `items` aggregation.
93661
+ * Adds some item to the aggregation {@link #getItems items}.
93010
93662
  *
93011
93663
  *
93012
- * @returns `this` to allow method chaining
93664
+ * @returns Reference to `this` in order to allow method chaining
93013
93665
  */
93014
93666
  addItem(
93015
93667
  /**
93016
- * Menu item to be added
93017
- */
93018
- oItem: sap.m.IMenuItem,
93019
- /**
93020
- * Whether to suppress the invalidation of the control
93668
+ * The item to add; if empty, nothing is inserted
93021
93669
  */
93022
- bSuppressInvalidate: boolean
93670
+ oItem: sap.m.IMenuItem
93023
93671
  ): this;
93024
93672
  /**
93025
- * Destroys all items from `items` aggregation.
93673
+ * Destroys all the items in the aggregation {@link #getItems items}.
93026
93674
  *
93027
93675
  *
93028
- * @returns `this` to allow method chaining
93676
+ * @returns Reference to `this` in order to allow method chaining
93029
93677
  */
93030
- destroyItems(
93031
- /**
93032
- * Whether to suppress the invalidation of the control
93033
- */
93034
- bSuppressInvalidate: boolean
93035
- ): this;
93678
+ destroyItems(): this;
93036
93679
  /**
93037
93680
  * Gets content of aggregation {@link #getItems items}.
93038
93681
  *
@@ -93065,68 +93708,61 @@ declare namespace sap {
93065
93708
  oItem: sap.m.IMenuItem
93066
93709
  ): int;
93067
93710
  /**
93068
- * Inserts an item to the specified position in `items` aggregation.
93711
+ * Inserts a item into the aggregation {@link #getItems items}.
93069
93712
  *
93070
93713
  *
93071
- * @returns `this` to allow method chaining
93714
+ * @returns Reference to `this` in order to allow method chaining
93072
93715
  */
93073
93716
  insertItem(
93074
93717
  /**
93075
- * Menu item to be added
93718
+ * The item to insert; if empty, nothing is inserted
93076
93719
  */
93077
93720
  oItem: sap.m.IMenuItem,
93078
93721
  /**
93079
- * Index at which the item should be inserted
93080
- */
93081
- iIndex: int,
93082
- /**
93083
- * Whether to suppress the invalidation of the control
93722
+ * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
93723
+ * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
93724
+ * the last position
93084
93725
  */
93085
- bSuppressInvalidate: boolean
93726
+ iIndex: int
93086
93727
  ): this;
93087
93728
  /**
93088
- * Removes all items from `items` aggregation.
93729
+ * Removes all the controls from the aggregation {@link #getItems items}.
93089
93730
  *
93731
+ * Additionally, it unregisters them from the hosting UIArea.
93090
93732
  *
93091
- * @returns array containing the removed items, or `null` if there are no items to remove
93733
+ *
93734
+ * @returns An array of the removed elements (might be empty)
93092
93735
  */
93093
- removeAllItems(
93094
- /**
93095
- * Whether to suppress the invalidation of the control
93096
- */
93097
- bSuppressInvalidate: boolean
93098
- ): any[] | null;
93736
+ removeAllItems(): sap.m.IMenuItem[];
93099
93737
  /**
93100
- * Removes an item from `items` aggregation.
93738
+ * Removes a item from the aggregation {@link #getItems items}.
93101
93739
  *
93102
93740
  *
93103
- * @returns the removed object, or `null` if there are no items to remove
93741
+ * @returns The removed item or `null`
93104
93742
  */
93105
93743
  removeItem(
93106
93744
  /**
93107
- * Menu item to be removed (as index, ID or object)
93108
- */
93109
- vItem: int | string | sap.m.IMenuItem,
93110
- /**
93111
- * Whether to suppress the invalidation of the control
93745
+ * The item to remove or its index or id
93112
93746
  */
93113
- bSuppressInvalidate: boolean
93747
+ vItem: int | string | sap.m.IMenuItem
93114
93748
  ): sap.m.IMenuItem | null;
93115
93749
  /**
93116
- * Override of the default setter that also ensures single selection if necessary.
93750
+ * Sets a new value for property {@link #getItemSelectionMode itemSelectionMode}.
93117
93751
  *
93752
+ * Defines the selection mode of the child items (e.g. `None`, `SingleSelect`, `MultiSelect`)
93118
93753
  *
93119
- * @returns `this` to allow method chaining
93754
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
93755
+ *
93756
+ * Default value is `None`.
93757
+ *
93758
+ *
93759
+ * @returns Reference to `this` in order to allow method chaining
93120
93760
  */
93121
93761
  setItemSelectionMode(
93122
93762
  /**
93123
- * item selection mode to be set
93763
+ * New value for property `itemSelectionMode`
93124
93764
  */
93125
- sSelectionMode: string,
93126
- /**
93127
- * Whether to suppress the invalidation of the control
93128
- */
93129
- bSuppressInvalidate: boolean
93765
+ sItemSelectionMode?: sap.ui.core.ItemSelectionMode
93130
93766
  ): this;
93131
93767
  }
93132
93768
  /**
@@ -97185,7 +97821,10 @@ declare namespace sap {
97185
97821
  * - Provide meaningful labels for all input fields. Do not use the placeholder as a replacement for
97186
97822
  * the label.
97187
97823
  * - The `showValueHelp` property is overwritten and after initialization of the control, its value becomes
97188
- * `truthy`. Usage: When to use::
97824
+ * `truthy`.
97825
+ * - A mix of read-only and deletable tokens isn't supported.
97826
+ * - The read-only state of tokens should be controlled using the `editable` property of the MultiInput
97827
+ * control. Usage: When to use::
97189
97828
  * - You need to provide the value help option to help users select or search multiple business objects.
97190
97829
  *
97191
97830
  * - The dataset to choose from is expected to increase over time (for example, to more than 200 values).
@@ -136061,13 +136700,13 @@ declare namespace sap {
136061
136700
  */
136062
136701
  getEndHour(): int;
136063
136702
  /**
136064
- * Finds the start and end dates in the visible range.
136703
+ * Returns an object containing the start and end dates in the currently visible range.
136065
136704
  *
136066
136705
  * @since 1.133
136067
136706
  *
136068
- * @returns returns an object that stores both the start and end date within the currently visible range.
136707
+ * @returns An object containing the start and end date in the currently visible range.
136069
136708
  */
136070
- getFirstAndLastVisibleDates(): Object;
136709
+ getFirstAndLastVisibleDates(): sap.m.SinglePlanningCalendar.VisibleDates;
136071
136710
  /**
136072
136711
  * Gets current value of property {@link #getFirstDayOfWeek firstDayOfWeek}.
136073
136712
  *
@@ -138886,8 +139525,12 @@ declare namespace sap {
138886
139525
  * header tags to the HTML page which are considered useful for mobile applications and allows the configuration
138887
139526
  * of the application's home icon via the `homeIcon` property.
138888
139527
  *
138889
- * Usage: SplitApp should take the full width of the page and be used as the root of the application, not
138890
- * as child of another container.
139528
+ * Usage:
139529
+ * - Use SplitApp as the root control of your application. It should not be nested inside or alongside
139530
+ * other controls.
139531
+ * - SplitApp requires its parent elements (including `body` and `html`) to have a height set to 100%
139532
+ * for proper layout. If this is not set, `SplitApp` will attempt to set the height itself. SplitApp
139533
+ * requires 100% of the page width for proper layout.
138891
139534
  */
138892
139535
  class SplitApp extends sap.m.SplitContainer {
138893
139536
  /**
@@ -164118,11 +164761,11 @@ declare namespace sap {
164118
164761
  /**
164119
164762
  * Represents the ARIA role `alertdialog`.
164120
164763
  */
164121
- AlertDialog = "alertdialog",
164764
+ AlertDialog = "AlertDialog",
164122
164765
  /**
164123
164766
  * Represents the ARIA role `dialog`.
164124
164767
  */
164125
- Dialog = "dialog",
164768
+ Dialog = "Dialog",
164126
164769
  }
164127
164770
  /**
164128
164771
  * Enum for the type of {@link sap.m.Dialog} control.
@@ -165490,6 +166133,30 @@ declare namespace sap {
165490
166133
  */
165491
166134
  Standard = "Standard",
165492
166135
  }
166136
+ /**
166137
+ * Defines the action types available for list items.
166138
+ *
166139
+ * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ListItemActionType'.
166140
+ *
166141
+ * @since 1.137
166142
+ */
166143
+ enum ListItemActionType {
166144
+ /**
166145
+ * Defines a custom action for a list item. **Note:** The `icon` and `text` properties in the `sap.m.ListItemAction`
166146
+ * are required for this action type.
166147
+ */
166148
+ Custom = "Custom",
166149
+ /**
166150
+ * Indicates that the list item is deletable. **Note:** The `icon` and `text` properties must not be set
166151
+ * in `sap.m.ListItemAction` for this action type.
166152
+ */
166153
+ Delete = "Delete",
166154
+ /**
166155
+ * Indicates that the list item is editable. **Note:** The `icon` and `text` properties must not be set
166156
+ * in `sap.m.ListItemAction` for this action type.
166157
+ */
166158
+ Edit = "Edit",
166159
+ }
165493
166160
  /**
165494
166161
  * Defines the keyboard handling behavior of the `sap.m.List` or `sap.m.Table`.
165495
166162
  *
@@ -166425,11 +167092,11 @@ declare namespace sap {
166425
167092
  /**
166426
167093
  * Private mode of the `VariantItem`.
166427
167094
  */
166428
- Private = "private",
167095
+ Private = "Private",
166429
167096
  /**
166430
167097
  * Public mode of the `VariantItem`.
166431
167098
  */
166432
- Public = "public",
167099
+ Public = "Public",
166433
167100
  }
166434
167101
  /**
166435
167102
  * Available selection modes for the {@link sap.m.SinglePlanningCalendar}
@@ -168185,6 +168852,14 @@ declare namespace sap {
168185
168852
  ListBase
168186
168853
  >;
168187
168854
 
168855
+ /**
168856
+ * Event object of the ListBase#itemActionPress event.
168857
+ */
168858
+ type ListBase$ItemActionPressEvent = sap.ui.base.Event<
168859
+ ListBase$ItemActionPressEventParameters,
168860
+ ListBase
168861
+ >;
168862
+
168188
168863
  /**
168189
168864
  * Event object of the ListBase#itemPress event.
168190
168865
  */
@@ -168324,14 +168999,6 @@ declare namespace sap {
168324
168999
  MenuButton
168325
169000
  >;
168326
169001
 
168327
- /**
168328
- * Event object of the MenuItem#aggregationChanged event.
168329
- */
168330
- type MenuItem$AggregationChangedEvent = sap.ui.base.Event<
168331
- MenuItem$AggregationChangedEventParameters,
168332
- MenuItem
168333
- >;
168334
-
168335
169002
  /**
168336
169003
  * Event object of the MenuItem#press event.
168337
169004
  */
@@ -168340,14 +169007,6 @@ declare namespace sap {
168340
169007
  MenuItem
168341
169008
  >;
168342
169009
 
168343
- /**
168344
- * Event object of the MenuItem#propertyChanged event.
168345
- */
168346
- type MenuItem$PropertyChangedEvent = sap.ui.base.Event<
168347
- MenuItem$PropertyChangedEventParameters,
168348
- MenuItem
168349
- >;
168350
-
168351
169010
  /**
168352
169011
  * Event object of the MessagePage#navButtonPress event.
168353
169012
  */
@@ -170268,6 +170927,10 @@ declare namespace sap {
170268
170927
 
170269
170928
  "sap/m/ListBase": undefined;
170270
170929
 
170930
+ "sap/m/ListItemAction": undefined;
170931
+
170932
+ "sap/m/ListItemActionBase": undefined;
170933
+
170271
170934
  "sap/m/ListItemBase": undefined;
170272
170935
 
170273
170936
  "sap/m/MaskInput": undefined;
@@ -170642,6 +171305,8 @@ declare namespace sap {
170642
171305
 
170643
171306
  "sap/m/table/columnmenu/QuickGroupItem": undefined;
170644
171307
 
171308
+ "sap/m/table/columnmenu/QuickResize": undefined;
171309
+
170645
171310
  "sap/m/table/columnmenu/QuickSort": undefined;
170646
171311
 
170647
171312
  "sap/m/table/columnmenu/QuickSortItem": undefined;