@sapui5/ts-types 1.102.2 → 1.104.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.
Files changed (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +3 -0
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +11 -11
  5. package/types/sap.chart.d.ts +2 -2
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +1 -1
  8. package/types/sap.f.d.ts +320 -24
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +29 -1159
  11. package/types/sap.fe.macros.d.ts +52 -627
  12. package/types/sap.fe.navigation.d.ts +1 -1309
  13. package/types/sap.fe.templates.d.ts +2 -161
  14. package/types/sap.fe.test.d.ts +12 -244
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +343 -63
  17. package/types/sap.insights.d.ts +1 -1
  18. package/types/sap.landvisz.d.ts +15 -15
  19. package/types/sap.m.d.ts +2388 -334
  20. package/types/sap.makit.d.ts +5 -5
  21. package/types/sap.me.d.ts +2 -2
  22. package/types/sap.ndc.d.ts +75 -3
  23. package/types/sap.ovp.d.ts +6 -1
  24. package/types/sap.rules.ui.d.ts +1 -1
  25. package/types/sap.sac.df.d.ts +164 -2
  26. package/types/sap.sac.grid.d.ts +1 -1
  27. package/types/sap.suite.ui.commons.d.ts +556 -76
  28. package/types/sap.suite.ui.generic.template.d.ts +105 -12
  29. package/types/sap.suite.ui.microchart.d.ts +14 -14
  30. package/types/sap.tnt.d.ts +5 -5
  31. package/types/sap.ui.codeeditor.d.ts +1 -1
  32. package/types/sap.ui.commons.d.ts +36 -36
  33. package/types/sap.ui.comp.d.ts +1213 -270
  34. package/types/sap.ui.core.d.ts +384 -111
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +3 -3
  37. package/types/sap.ui.fl.d.ts +3 -1
  38. package/types/sap.ui.generic.app.d.ts +13 -6
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +43 -64
  41. package/types/sap.ui.layout.d.ts +33 -41
  42. package/types/sap.ui.mdc.d.ts +1 -1
  43. package/types/sap.ui.richtexteditor.d.ts +2 -2
  44. package/types/sap.ui.rta.d.ts +3 -1
  45. package/types/sap.ui.suite.d.ts +1 -1
  46. package/types/sap.ui.support.d.ts +1 -1
  47. package/types/sap.ui.table.d.ts +9 -9
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +115 -35
  50. package/types/sap.ui.ux3.d.ts +43 -43
  51. package/types/sap.ui.vbm.d.ts +28 -188
  52. package/types/sap.ui.vk.d.ts +83 -25
  53. package/types/sap.ui.vtm.d.ts +12 -12
  54. package/types/sap.ui.webc.common.d.ts +118 -0
  55. package/types/sap.ui.webc.fiori.d.ts +13298 -0
  56. package/types/sap.ui.webc.main.d.ts +39842 -0
  57. package/types/sap.uiext.inbox.d.ts +3 -3
  58. package/types/sap.ushell.d.ts +45 -31
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +13 -13
  61. package/types/sap.viz.d.ts +8 -8
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +4 -4
  64. package/types/sap.zen.crosstab.d.ts +1 -1
  65. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.102.2
1
+ // For Library Version: 1.104.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -2664,7 +2664,7 @@ declare namespace sap {
2664
2664
  | int
2665
2665
  | string
2666
2666
  | sap.ui.comp.filterbar.FilterGroupItem
2667
- ): sap.ui.comp.filterbar.FilterGroupItem;
2667
+ ): sap.ui.comp.filterbar.FilterGroupItem | null;
2668
2668
  /**
2669
2669
  * @deprecated (since 1.48.0) - Use aggregation `filterGroupItems` instead.
2670
2670
  *
@@ -2677,7 +2677,7 @@ declare namespace sap {
2677
2677
  * The filterItem to remove or its index or id
2678
2678
  */
2679
2679
  vFilterItem: int | string | sap.ui.comp.filterbar.FilterItem
2680
- ): sap.ui.comp.filterbar.FilterItem;
2680
+ ): sap.ui.comp.filterbar.FilterItem | null;
2681
2681
  /**
2682
2682
  * Adapts the visibility for all filter containers.
2683
2683
  */
@@ -5353,7 +5353,7 @@ declare namespace sap {
5353
5353
  * The availableAction to remove or its index or id
5354
5354
  */
5355
5355
  vAvailableAction: int | string | sap.ui.comp.navpopover.LinkData
5356
- ): sap.ui.comp.navpopover.LinkData;
5356
+ ): sap.ui.comp.navpopover.LinkData | null;
5357
5357
  /**
5358
5358
  * @deprecated (since 1.42.0) - Target determination is no longer done by NavigationPopover. Instead the
5359
5359
  * NavigationPopoverHandler is responsible for target determination.
@@ -10519,7 +10519,7 @@ declare namespace sap {
10519
10519
  * The selectionDetailsAction to remove or its index or id
10520
10520
  */
10521
10521
  vSelectionDetailsAction: int | string | sap.ui.core.Item
10522
- ): sap.ui.core.Item;
10522
+ ): sap.ui.core.Item | null;
10523
10523
  /**
10524
10524
  * @EXPERIMENTAL (since 1.48)
10525
10525
  *
@@ -10532,7 +10532,7 @@ declare namespace sap {
10532
10532
  * The selectionDetailsActionGroup to remove or its index or id
10533
10533
  */
10534
10534
  vSelectionDetailsActionGroup: int | string | sap.ui.core.Item
10535
- ): sap.ui.core.Item;
10535
+ ): sap.ui.core.Item | null;
10536
10536
  /**
10537
10537
  * @EXPERIMENTAL (since 1.48)
10538
10538
  *
@@ -10545,7 +10545,7 @@ declare namespace sap {
10545
10545
  * The selectionDetailsItemAction to remove or its index or id
10546
10546
  */
10547
10547
  vSelectionDetailsItemAction: int | string | sap.ui.core.Item
10548
- ): sap.ui.core.Item;
10548
+ ): sap.ui.core.Item | null;
10549
10549
  /**
10550
10550
  * @SINCE 1.84
10551
10551
  *
@@ -15405,6 +15405,16 @@ declare namespace sap {
15405
15405
  | sap.ui.base.ManagedObject.PropertyBindingInfo
15406
15406
  | `{${string}}`;
15407
15407
 
15408
+ /**
15409
+ * @SINCE 1.103
15410
+ *
15411
+ * Sets time zone for filter of type Edm.DateTimeOffset
15412
+ *
15413
+ * **Note:** The property is IANA timezone ID, e.g. "America/New_York". An invalid IANA timezone ID will
15414
+ * fall back to the UTC.
15415
+ */
15416
+ timezone?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
15417
+
15408
15418
  /**
15409
15419
  * Default value for a filter field. The aggregation expects {@link sap.ui.comp.smartfilterbar.SelectOption|SelectOption}
15410
15420
  * instances, where the values' format (properties `low` and `high`) match the type of the referneced property
@@ -16066,6 +16076,19 @@ declare namespace sap {
16066
16076
  * @returns Value of property `preventInitialDataFetchInValueHelpDialog`
16067
16077
  */
16068
16078
  getPreventInitialDataFetchInValueHelpDialog(): boolean;
16079
+ /**
16080
+ * @SINCE 1.103
16081
+ *
16082
+ * Gets current value of property {@link #getTimezone timezone}.
16083
+ *
16084
+ * Sets time zone for filter of type Edm.DateTimeOffset
16085
+ *
16086
+ * **Note:** The property is IANA timezone ID, e.g. "America/New_York". An invalid IANA timezone ID will
16087
+ * fall back to the UTC.
16088
+ *
16089
+ * @returns Value of property `timezone`
16090
+ */
16091
+ getTimezone(): string;
16069
16092
  /**
16070
16093
  * Gets current value of property {@link #getVisible visible}.
16071
16094
  *
@@ -16145,7 +16168,7 @@ declare namespace sap {
16145
16168
  | int
16146
16169
  | string
16147
16170
  | sap.ui.comp.smartfilterbar.SelectOption
16148
- ): sap.ui.comp.smartfilterbar.SelectOption;
16171
+ ): sap.ui.comp.smartfilterbar.SelectOption | null;
16149
16172
  /**
16150
16173
  * @SINCE 1.99
16151
16174
  *
@@ -16431,6 +16454,26 @@ declare namespace sap {
16431
16454
  */
16432
16455
  bPreventInitialDataFetchInValueHelpDialog?: boolean
16433
16456
  ): this;
16457
+ /**
16458
+ * @SINCE 1.103
16459
+ *
16460
+ * Sets a new value for property {@link #getTimezone timezone}.
16461
+ *
16462
+ * Sets time zone for filter of type Edm.DateTimeOffset
16463
+ *
16464
+ * **Note:** The property is IANA timezone ID, e.g. "America/New_York". An invalid IANA timezone ID will
16465
+ * fall back to the UTC.
16466
+ *
16467
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
16468
+ *
16469
+ * @returns Reference to `this` in order to allow method chaining
16470
+ */
16471
+ setTimezone(
16472
+ /**
16473
+ * New value for property `timezone`
16474
+ */
16475
+ sTimezone?: string
16476
+ ): this;
16434
16477
  /**
16435
16478
  * Sets a new value for property {@link #getVisible visible}.
16436
16479
  *
@@ -17616,7 +17659,7 @@ declare namespace sap {
17616
17659
  | int
17617
17660
  | string
17618
17661
  | sap.ui.comp.smartfilterbar.ControlConfiguration
17619
- ): sap.ui.comp.smartfilterbar.ControlConfiguration;
17662
+ ): sap.ui.comp.smartfilterbar.ControlConfiguration | null;
17620
17663
  /**
17621
17664
  * Removes a groupConfiguration from the aggregation {@link #getGroupConfiguration groupConfiguration}.
17622
17665
  *
@@ -17630,7 +17673,7 @@ declare namespace sap {
17630
17673
  | int
17631
17674
  | string
17632
17675
  | sap.ui.comp.smartfilterbar.GroupConfiguration
17633
- ): sap.ui.comp.smartfilterbar.GroupConfiguration;
17676
+ ): sap.ui.comp.smartfilterbar.GroupConfiguration | null;
17634
17677
  /**
17635
17678
  * Resumes calls to the `search` method. If it was called during the suspension, the search will be triggered
17636
17679
  * once regardless of how many times it was called during suspension.
@@ -19230,7 +19273,7 @@ declare namespace sap {
19230
19273
  * The groupElement to remove or its index or id
19231
19274
  */
19232
19275
  vGroupElement: int | string | sap.ui.comp.IFormGroupElement
19233
- ): sap.ui.comp.IFormGroupElement;
19276
+ ): sap.ui.comp.IFormGroupElement | null;
19234
19277
  /**
19235
19278
  * @deprecated (since 1.74.0) - please do not change the edit mode on group level, let the SmartForm inheritance
19236
19279
  * do it
@@ -19670,7 +19713,7 @@ declare namespace sap {
19670
19713
  * The element to remove or its index or id
19671
19714
  */
19672
19715
  vElement: int | string | sap.ui.core.Control
19673
- ): sap.ui.core.Control;
19716
+ ): sap.ui.core.Control | null;
19674
19717
  /**
19675
19718
  * @deprecated (since 1.74.0) - please do not change the edit mode on groupElement level, let the SmartForm
19676
19719
  * inheritance do it
@@ -20525,7 +20568,7 @@ declare namespace sap {
20525
20568
  * The element to remove or its index or id
20526
20569
  */
20527
20570
  vElement: int | string | sap.ui.core.Control
20528
- ): sap.ui.core.Control;
20571
+ ): sap.ui.core.Control | null;
20529
20572
  /**
20530
20573
  * Sets a new value for property {@link #getElementForLabel elementForLabel}.
20531
20574
  *
@@ -21223,7 +21266,7 @@ declare namespace sap {
21223
21266
  * The group to remove or its index or id
21224
21267
  */
21225
21268
  vGroup: int | string | sap.ui.comp.smartform.Group
21226
- ): sap.ui.comp.smartform.Group;
21269
+ ): sap.ui.comp.smartform.Group | null;
21227
21270
  /**
21228
21271
  * Sets a new value for property {@link #getCheckButton checkButton}.
21229
21272
  *
@@ -26346,20 +26389,25 @@ declare namespace sap {
26346
26389
  /**
26347
26390
  * @SINCE 1.97.0
26348
26391
  *
26349
- * Provides customization to the columns/cell templates generated by the `SmartTable` control. Examples
26350
- * for the `customizeConfig` property to change the `textInEditModeSource` for the default `smartField`
26392
+ * Provides customization to the columns/cell templates generated by the `SmartTable` control.
26393
+ *
26394
+ * List of supported settings for the `customizeConfig` property:
26395
+ * - `textInEditModeSource`: For more information, see {@link sap.ui.comp.smartfield.SmartField#setTextInEditModeSource}
26351
26396
  *
26397
+ * - `insertIgnoreRestrictions`: The `customData` setting for the `sap.ui.comp.smartfield.SmartField`
26398
+ * control. Supported as of version 1.103. Examples for the `customizeConfig` property to
26399
+ * change the `textInEditModeSource` for the default `smartField`
26352
26400
  * ```javascript
26353
26401
  *
26354
26402
  * <!-- Sets the `textInEditModeSource` property of all the `SmartField` controls to ValueList -->
26355
- * <SmartTable customizeConfig='\{"textInEditModeSource": {"*": "ValueList"}}' >
26403
+ * <SmartTable customizeConfig="{'textInEditModeSource': {'*': 'ValueList'}}" >
26356
26404
  * ```
26357
26405
  *
26358
26406
  * ```javascript
26359
26407
  *
26360
26408
  * <!-- Sets the `textInEditModeSource` property of the `smartField` with path "Bukrs" to `NavigationProperty` and
26361
26409
  * others to ValueList -->
26362
- * <SmartTable customizeConfig='\{"textInEditModeSource": {"*": "ValueList","Bukrs":"NavigationProperty"}}' >
26410
+ * <SmartTable customizeConfig="{'textInEditModeSource': {'*': 'ValueList','Bukrs':'NavigationProperty'}}" >
26363
26411
  * ```
26364
26412
  */
26365
26413
  customizeConfig?:
@@ -28335,20 +28383,25 @@ declare namespace sap {
28335
28383
  *
28336
28384
  * Gets current value of property {@link #getCustomizeConfig customizeConfig}.
28337
28385
  *
28338
- * Provides customization to the columns/cell templates generated by the `SmartTable` control. Examples
28339
- * for the `customizeConfig` property to change the `textInEditModeSource` for the default `smartField`
28386
+ * Provides customization to the columns/cell templates generated by the `SmartTable` control.
28387
+ *
28388
+ * List of supported settings for the `customizeConfig` property:
28389
+ * - `textInEditModeSource`: For more information, see {@link sap.ui.comp.smartfield.SmartField#setTextInEditModeSource}
28340
28390
  *
28391
+ * - `insertIgnoreRestrictions`: The `customData` setting for the `sap.ui.comp.smartfield.SmartField`
28392
+ * control. Supported as of version 1.103. Examples for the `customizeConfig` property to
28393
+ * change the `textInEditModeSource` for the default `smartField`
28341
28394
  * ```javascript
28342
28395
  *
28343
28396
  * <!-- Sets the `textInEditModeSource` property of all the `SmartField` controls to ValueList -->
28344
- * <SmartTable customizeConfig='\{"textInEditModeSource": {"*": "ValueList"}}' >
28397
+ * <SmartTable customizeConfig="{'textInEditModeSource': {'*': 'ValueList'}}" >
28345
28398
  * ```
28346
28399
  *
28347
28400
  * ```javascript
28348
28401
  *
28349
28402
  * <!-- Sets the `textInEditModeSource` property of the `smartField` with path "Bukrs" to `NavigationProperty` and
28350
28403
  * others to ValueList -->
28351
- * <SmartTable customizeConfig='\{"textInEditModeSource": {"*": "ValueList","Bukrs":"NavigationProperty"}}' >
28404
+ * <SmartTable customizeConfig="{'textInEditModeSource': {'*': 'ValueList','Bukrs':'NavigationProperty'}}" >
28352
28405
  * ```
28353
28406
  *
28354
28407
  *
@@ -29091,20 +29144,25 @@ declare namespace sap {
29091
29144
  *
29092
29145
  * Sets a new value for property {@link #getCustomizeConfig customizeConfig}.
29093
29146
  *
29094
- * Provides customization to the columns/cell templates generated by the `SmartTable` control. Examples
29095
- * for the `customizeConfig` property to change the `textInEditModeSource` for the default `smartField`
29147
+ * Provides customization to the columns/cell templates generated by the `SmartTable` control.
29096
29148
  *
29149
+ * List of supported settings for the `customizeConfig` property:
29150
+ * - `textInEditModeSource`: For more information, see {@link sap.ui.comp.smartfield.SmartField#setTextInEditModeSource}
29151
+ *
29152
+ * - `insertIgnoreRestrictions`: The `customData` setting for the `sap.ui.comp.smartfield.SmartField`
29153
+ * control. Supported as of version 1.103. Examples for the `customizeConfig` property to
29154
+ * change the `textInEditModeSource` for the default `smartField`
29097
29155
  * ```javascript
29098
29156
  *
29099
29157
  * <!-- Sets the `textInEditModeSource` property of all the `SmartField` controls to ValueList -->
29100
- * <SmartTable customizeConfig='\{"textInEditModeSource": {"*": "ValueList"}}' >
29158
+ * <SmartTable customizeConfig="{'textInEditModeSource': {'*': 'ValueList'}}" >
29101
29159
  * ```
29102
29160
  *
29103
29161
  * ```javascript
29104
29162
  *
29105
29163
  * <!-- Sets the `textInEditModeSource` property of the `smartField` with path "Bukrs" to `NavigationProperty` and
29106
29164
  * others to ValueList -->
29107
- * <SmartTable customizeConfig='\{"textInEditModeSource": {"*": "ValueList","Bukrs":"NavigationProperty"}}' >
29165
+ * <SmartTable customizeConfig="{'textInEditModeSource': {'*': 'ValueList','Bukrs':'NavigationProperty'}}" >
29108
29166
  * ```
29109
29167
  *
29110
29168
  *
@@ -30092,19 +30150,6 @@ declare namespace sap {
30092
30150
  */
30093
30151
  entitySet?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
30094
30152
 
30095
- /**
30096
- * @SINCE 1.85
30097
- *
30098
- * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
30099
- * controls this behavior.
30100
- *
30101
- *
30102
- * **Note:** the usage of this property is restricted to `sap.ui.generic.template` components only.
30103
- */
30104
- displayTextForExecuteOnSelectionForStandardVariant?:
30105
- | string
30106
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
30107
-
30108
30153
  /**
30109
30154
  * All controls that rely on variant handling have to be added to this aggregation.
30110
30155
  */
@@ -30145,7 +30190,168 @@ declare namespace sap {
30145
30190
  }
30146
30191
 
30147
30192
  interface $SmartVariantManagementBaseSettings
30148
- extends sap.ui.comp.variants.$VariantManagementSettings {}
30193
+ extends sap.ui.core.$ControlSettings {
30194
+ /**
30195
+ * Can be set to true or false depending on whether you want to enable or disable the control.
30196
+ */
30197
+ enabled?:
30198
+ | boolean
30199
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
30200
+ | `{${string}}`;
30201
+
30202
+ /**
30203
+ * Provides a string value to set the default variant. Used for the save dialog. Has no effect on the selected
30204
+ * variant.
30205
+ */
30206
+ defaultVariantKey?:
30207
+ | string
30208
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
30209
+
30210
+ /**
30211
+ * The key of the currently selected item.
30212
+ */
30213
+ selectionKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
30214
+
30215
+ /**
30216
+ * Indicates that a Create Tile is visible in the Save As dialog.
30217
+ */
30218
+ showCreateTile?:
30219
+ | boolean
30220
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
30221
+ | `{${string}}`;
30222
+
30223
+ /**
30224
+ * Indicates that Execute on Selection is visible in the Save As and the Manage Views dialogs.
30225
+ */
30226
+ showExecuteOnSelection?:
30227
+ | boolean
30228
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
30229
+ | `{${string}}`;
30230
+
30231
+ /**
30232
+ * Indicates that the Public checkbox is visible in the Save As and the Manage Views dialogs. Selecting
30233
+ * this checkbox allows you to share variants with other users.
30234
+ */
30235
+ showShare?:
30236
+ | boolean
30237
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
30238
+ | `{${string}}`;
30239
+
30240
+ /**
30241
+ * Indicates that set as default is visible in the Save As and the Manage Views dialogs.
30242
+ */
30243
+ showSetAsDefault?:
30244
+ | boolean
30245
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
30246
+ | `{${string}}`;
30247
+
30248
+ /**
30249
+ * Overwrites the default Standard variant title.
30250
+ * **Note:** This property has to be set during the `applySettings` method; it will be ignored otherwise.
30251
+ */
30252
+ standardItemText?:
30253
+ | string
30254
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
30255
+
30256
+ /**
30257
+ * Indicates that the 'Favorites' feature is used. Only variants marked as favorites will be displayed in
30258
+ * the variant list.
30259
+ */
30260
+ useFavorites?:
30261
+ | boolean
30262
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
30263
+ | `{${string}}`;
30264
+
30265
+ /**
30266
+ * Indicates that the control is in error state. If set to `true` error message will be displayed whenever
30267
+ * the variant is opened.
30268
+ */
30269
+ inErrorState?:
30270
+ | boolean
30271
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
30272
+ | `{${string}}`;
30273
+
30274
+ /**
30275
+ * Indicates that end users are allowed to create variants
30276
+ * **Note:** this property is controlled by the flexibility service.
30277
+ */
30278
+ variantCreationByUserAllowed?:
30279
+ | boolean
30280
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
30281
+ | `{${string}}`;
30282
+
30283
+ /**
30284
+ * Defines the author of the standard variant, for example, the name of the own company.
30285
+ */
30286
+ standardItemAuthor?:
30287
+ | string
30288
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
30289
+
30290
+ /**
30291
+ * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
30292
+ * controls this behavior.
30293
+ *
30294
+ *
30295
+ * **Note:** the usage of this property is restricted to `sap.ui.generic.template` components only.
30296
+ */
30297
+ displayTextForExecuteOnSelectionForStandardVariant?:
30298
+ | string
30299
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
30300
+
30301
+ /**
30302
+ * @SINCE 1.104
30303
+ *
30304
+ * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
30305
+ */
30306
+ headerLevel?:
30307
+ | sap.ui.core.TitleLevel
30308
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
30309
+ | `{${string}}`;
30310
+
30311
+ /**
30312
+ * @deprecated (since 1.103)
30313
+ *
30314
+ * Enables the setting of the initially selected variant.
30315
+ */
30316
+ initialSelectionKey?:
30317
+ | string
30318
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
30319
+
30320
+ /**
30321
+ * @deprecated (since 1.103)
30322
+ *
30323
+ * Enables the lifecycle support. If set to true, the VariantManagement control handles the transport information
30324
+ * for shared variants.
30325
+ */
30326
+ lifecycleSupport?:
30327
+ | boolean
30328
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
30329
+ | `{${string}}`;
30330
+
30331
+ /**
30332
+ * Variant items displayed by the `SmartVariantManagement` control.
30333
+ */
30334
+ variantItems?:
30335
+ | sap.ui.comp.variants.VariantItem[]
30336
+ | sap.ui.comp.variants.VariantItem
30337
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
30338
+ | `{${string}}`;
30339
+
30340
+ /**
30341
+ * This event is fired when the Save Variant dialog is closed with OK for a variant.
30342
+ */
30343
+ save?: (oEvent: sap.ui.base.Event) => void;
30344
+
30345
+ /**
30346
+ * This event is fired when users apply changes to variants in the Manage Variants dialog.
30347
+ */
30348
+ manage?: (oEvent: sap.ui.base.Event) => void;
30349
+
30350
+ /**
30351
+ * This event is fired when a new variant is selected.
30352
+ */
30353
+ select?: (oEvent: sap.ui.base.Event) => void;
30354
+ }
30149
30355
 
30150
30356
  interface $SmartVariantManagementUi2Settings
30151
30357
  extends sap.ui.comp.variants.$VariantManagementSettings {
@@ -30574,6 +30780,12 @@ declare namespace sap {
30574
30780
  */
30575
30781
  oListener?: object
30576
30782
  ): this;
30783
+ /**
30784
+ * @SINCE 1.22.0
30785
+ *
30786
+ * Removes the current variant selection and resets to default value.
30787
+ */
30788
+ clearVariantSelection(): void;
30577
30789
  /**
30578
30790
  * Sets the dirty flag of the current variant.
30579
30791
  */
@@ -30676,22 +30888,6 @@ declare namespace sap {
30676
30888
  * @returns Current variant ID
30677
30889
  */
30678
30890
  getCurrentVariantId(): string;
30679
- /**
30680
- * @SINCE 1.85
30681
- *
30682
- * Gets current value of property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}.
30683
- *
30684
- * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
30685
- * controls this behavior.
30686
- *
30687
- *
30688
- * **Note:** the usage of this property is restricted to `sap.ui.generic.template` components only.
30689
- *
30690
- * Default value is `empty string`.
30691
- *
30692
- * @returns Value of property `displayTextForExecuteOnSelectionForStandardVariant`
30693
- */
30694
- getDisplayTextForExecuteOnSelectionForStandardVariant(): string;
30695
30891
  /**
30696
30892
  * Gets current value of property {@link #getEntitySet entitySet}.
30697
30893
  *
@@ -30830,8 +31026,783 @@ declare namespace sap {
30830
31026
  bDoNotApplyVariant: boolean
30831
31027
  ): void;
30832
31028
  /**
30833
- * @SINCE 1.85
31029
+ * The entity set name from OData metadata, with which the smart variant control must be bound.
31030
+ *
31031
+ * @returns the control instance
31032
+ */
31033
+ setEntitySet(
31034
+ /**
31035
+ * The entity set
31036
+ */
31037
+ sEntitySetName: string
31038
+ ): Object;
31039
+ /**
31040
+ * Sets a new value for property {@link #getPersistencyKey persistencyKey}.
31041
+ *
31042
+ * Key used to access personalization data.
31043
+ *
31044
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
31045
+ *
31046
+ * @returns Reference to `this` in order to allow method chaining
31047
+ */
31048
+ setPersistencyKey(
31049
+ /**
31050
+ * New value for property `persistencyKey`
31051
+ */
31052
+ sPersistencyKey?: string
31053
+ ): this;
31054
+ }
31055
+ /**
31056
+ * Handles the odata metadata based information. An instance of this class will be created and used by the
31057
+ * {@link sap.ui.comp.smartvariants.SmartVariantManagement SmartVariantManagement} control. The adapter
31058
+ * transforms odata metadata based SelectionPresentationVariant information to UIState object. For each
31059
+ * SelectionPresentationVariant annotation an entry will be added to the VariantManagement control. It will
31060
+ * be called by the SmartVariantManagement whenever the user selects the corresponding entry and will provide
31061
+ * a valid {@link sap.ui.comp.state.UIState UIState} object.
31062
+ */
31063
+ class SmartVariantManagementAdapter extends sap.ui.core.Element {
31064
+ /**
31065
+ * Constructor for new instance of a SmartVariantManagementAdapter control.
31066
+ *
31067
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
31068
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
31069
+ * of the syntax of the settings object.
31070
+ */
31071
+ constructor(
31072
+ /**
31073
+ * initial settings for the new control
31074
+ */
31075
+ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementAdapterSettings
31076
+ );
31077
+ /**
31078
+ * Constructor for new instance of a SmartVariantManagementAdapter control.
31079
+ *
31080
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
31081
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
31082
+ * of the syntax of the settings object.
31083
+ */
31084
+ constructor(
31085
+ /**
31086
+ * ID for the new control, generated automatically if no ID is given
31087
+ */
31088
+ sId?: string,
31089
+ /**
31090
+ * initial settings for the new control
31091
+ */
31092
+ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementAdapterSettings
31093
+ );
31094
+
31095
+ /**
31096
+ * Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementAdapter with name `sClassName`
31097
+ * and enriches it with the information contained in `oClassInfo`.
31098
+ *
31099
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
31100
+ *
31101
+ * @returns Created class / constructor function
31102
+ */
31103
+ static extend<T extends Record<string, unknown>>(
31104
+ /**
31105
+ * Name of the class being created
31106
+ */
31107
+ sClassName: string,
31108
+ /**
31109
+ * Object literal with information about the class
31110
+ */
31111
+ oClassInfo?: sap.ClassInfo<
31112
+ T,
31113
+ sap.ui.comp.smartvariants.SmartVariantManagementAdapter
31114
+ >,
31115
+ /**
31116
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
31117
+ * used by this class
31118
+ */
31119
+ FNMetaImpl?: Function
31120
+ ): Function;
31121
+ /**
31122
+ * Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagementAdapter.
31123
+ *
31124
+ * @returns Metadata object describing this class
31125
+ */
31126
+ static getMetadata(): sap.ui.core.ElementMetadata;
31127
+ /**
31128
+ * Gets current value of property {@link #getSelectionPresentationVariants selectionPresentationVariants}.
30834
31129
  *
31130
+ * assign an array of selectionPresentationVariants annotations.
31131
+ *
31132
+ * Default value is `false`.
31133
+ *
31134
+ * @returns Value of property `selectionPresentationVariants`
31135
+ */
31136
+ getSelectionPresentationVariants(): object;
31137
+ /**
31138
+ * Sets a new value for property {@link #getSelectionPresentationVariants selectionPresentationVariants}.
31139
+ *
31140
+ * assign an array of selectionPresentationVariants annotations.
31141
+ *
31142
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
31143
+ *
31144
+ * Default value is `false`.
31145
+ *
31146
+ * @returns Reference to `this` in order to allow method chaining
31147
+ */
31148
+ setSelectionPresentationVariants(
31149
+ /**
31150
+ * New value for property `selectionPresentationVariants`
31151
+ */
31152
+ oSelectionPresentationVariants?: object
31153
+ ): this;
31154
+ }
31155
+ /**
31156
+ * @SINCE 1.56
31157
+ *
31158
+ * Overview: The `SmartVariantManagementBase` control embeds {@link sap.m.VariantManagement VariantManagement}
31159
+ * control and communicates with the flexibility library that offers SAPUI5 flexibility to manage the variants
31160
+ * for the UI Adaptation scenarios.
31161
+ */
31162
+ class SmartVariantManagementBase
31163
+ extends sap.ui.core.Control
31164
+ implements sap.m.IOverflowToolbarContent {
31165
+ __implements__sap_m_IOverflowToolbarContent: boolean;
31166
+ /**
31167
+ * Constructor for a new `SmartVariantManagementBase`.
31168
+ *
31169
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
31170
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
31171
+ * of the syntax of the settings object.
31172
+ * See:
31173
+ * {@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
31174
+ */
31175
+ constructor(
31176
+ /**
31177
+ * Initial settings for the new control
31178
+ */
31179
+ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementBaseSettings
31180
+ );
31181
+ /**
31182
+ * Constructor for a new `SmartVariantManagementBase`.
31183
+ *
31184
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
31185
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
31186
+ * of the syntax of the settings object.
31187
+ * See:
31188
+ * {@link topic:f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App}
31189
+ */
31190
+ constructor(
31191
+ /**
31192
+ * ID for the new control, generated automatically if no ID is given
31193
+ */
31194
+ sId?: string,
31195
+ /**
31196
+ * Initial settings for the new control
31197
+ */
31198
+ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementBaseSettings
31199
+ );
31200
+
31201
+ /**
31202
+ * Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementBase with name `sClassName`
31203
+ * and enriches it with the information contained in `oClassInfo`.
31204
+ *
31205
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
31206
+ *
31207
+ * @returns Created class / constructor function
31208
+ */
31209
+ static extend<T extends Record<string, unknown>>(
31210
+ /**
31211
+ * Name of the class being created
31212
+ */
31213
+ sClassName: string,
31214
+ /**
31215
+ * Object literal with information about the class
31216
+ */
31217
+ oClassInfo?: sap.ClassInfo<
31218
+ T,
31219
+ sap.ui.comp.smartvariants.SmartVariantManagementBase
31220
+ >,
31221
+ /**
31222
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
31223
+ * used by this class
31224
+ */
31225
+ FNMetaImpl?: Function
31226
+ ): Function;
31227
+ /**
31228
+ * Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagementBase.
31229
+ *
31230
+ * @returns Metadata object describing this class
31231
+ */
31232
+ static getMetadata(): sap.ui.core.ElementMetadata;
31233
+ /**
31234
+ * Adds some variantItem to the aggregation {@link #getVariantItems variantItems}.
31235
+ *
31236
+ * @returns Reference to `this` in order to allow method chaining
31237
+ */
31238
+ addVariantItem(
31239
+ /**
31240
+ * The variantItem to add; if empty, nothing is inserted
31241
+ */
31242
+ oVariantItem: sap.ui.comp.variants.VariantItem
31243
+ ): this;
31244
+ /**
31245
+ * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.comp.smartvariants.SmartVariantManagementBase`.
31246
+ *
31247
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
31248
+ * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementBase` itself.
31249
+ *
31250
+ * This event is fired when users apply changes to variants in the Manage Variants dialog.
31251
+ *
31252
+ * @returns Reference to `this` in order to allow method chaining
31253
+ */
31254
+ attachManage(
31255
+ /**
31256
+ * An application-specific payload object that will be passed to the event handler along with the event
31257
+ * object when firing the event
31258
+ */
31259
+ oData: object,
31260
+ /**
31261
+ * The function to be called when the event occurs
31262
+ */
31263
+ fnFunction: (p1: sap.ui.base.Event) => void,
31264
+ /**
31265
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementBase`
31266
+ * itself
31267
+ */
31268
+ oListener?: object
31269
+ ): this;
31270
+ /**
31271
+ * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.comp.smartvariants.SmartVariantManagementBase`.
31272
+ *
31273
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
31274
+ * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementBase` itself.
31275
+ *
31276
+ * This event is fired when users apply changes to variants in the Manage Variants dialog.
31277
+ *
31278
+ * @returns Reference to `this` in order to allow method chaining
31279
+ */
31280
+ attachManage(
31281
+ /**
31282
+ * The function to be called when the event occurs
31283
+ */
31284
+ fnFunction: (p1: sap.ui.base.Event) => void,
31285
+ /**
31286
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementBase`
31287
+ * itself
31288
+ */
31289
+ oListener?: object
31290
+ ): this;
31291
+ /**
31292
+ * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagementBase`.
31293
+ *
31294
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
31295
+ * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementBase` itself.
31296
+ *
31297
+ * This event is fired when the Save Variant dialog is closed with OK for a variant.
31298
+ *
31299
+ * @returns Reference to `this` in order to allow method chaining
31300
+ */
31301
+ attachSave(
31302
+ /**
31303
+ * An application-specific payload object that will be passed to the event handler along with the event
31304
+ * object when firing the event
31305
+ */
31306
+ oData: object,
31307
+ /**
31308
+ * The function to be called when the event occurs
31309
+ */
31310
+ fnFunction: (p1: sap.ui.base.Event) => void,
31311
+ /**
31312
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementBase`
31313
+ * itself
31314
+ */
31315
+ oListener?: object
31316
+ ): this;
31317
+ /**
31318
+ * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagementBase`.
31319
+ *
31320
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
31321
+ * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementBase` itself.
31322
+ *
31323
+ * This event is fired when the Save Variant dialog is closed with OK for a variant.
31324
+ *
31325
+ * @returns Reference to `this` in order to allow method chaining
31326
+ */
31327
+ attachSave(
31328
+ /**
31329
+ * The function to be called when the event occurs
31330
+ */
31331
+ fnFunction: (p1: sap.ui.base.Event) => void,
31332
+ /**
31333
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementBase`
31334
+ * itself
31335
+ */
31336
+ oListener?: object
31337
+ ): this;
31338
+ /**
31339
+ * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.comp.smartvariants.SmartVariantManagementBase`.
31340
+ *
31341
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
31342
+ * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementBase` itself.
31343
+ *
31344
+ * This event is fired when a new variant is selected.
31345
+ *
31346
+ * @returns Reference to `this` in order to allow method chaining
31347
+ */
31348
+ attachSelect(
31349
+ /**
31350
+ * An application-specific payload object that will be passed to the event handler along with the event
31351
+ * object when firing the event
31352
+ */
31353
+ oData: object,
31354
+ /**
31355
+ * The function to be called when the event occurs
31356
+ */
31357
+ fnFunction: (p1: sap.ui.base.Event) => void,
31358
+ /**
31359
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementBase`
31360
+ * itself
31361
+ */
31362
+ oListener?: object
31363
+ ): this;
31364
+ /**
31365
+ * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.comp.smartvariants.SmartVariantManagementBase`.
31366
+ *
31367
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
31368
+ * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementBase` itself.
31369
+ *
31370
+ * This event is fired when a new variant is selected.
31371
+ *
31372
+ * @returns Reference to `this` in order to allow method chaining
31373
+ */
31374
+ attachSelect(
31375
+ /**
31376
+ * The function to be called when the event occurs
31377
+ */
31378
+ fnFunction: (p1: sap.ui.base.Event) => void,
31379
+ /**
31380
+ * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementBase`
31381
+ * itself
31382
+ */
31383
+ oListener?: object
31384
+ ): this;
31385
+ /**
31386
+ * Gets the dirty flag of the current variant.
31387
+ *
31388
+ * @returns The dirty state of the current variant
31389
+ */
31390
+ currentVariantGetModified(): boolean;
31391
+ /**
31392
+ * Sets the dirty flag of the current variant.
31393
+ */
31394
+ currentVariantSetModified(
31395
+ /**
31396
+ * The value indicating the dirty state of the current variant
31397
+ */
31398
+ bFlag: boolean
31399
+ ): void;
31400
+ /**
31401
+ * Destroys all the variantItems in the aggregation {@link #getVariantItems variantItems}.
31402
+ *
31403
+ * @returns Reference to `this` in order to allow method chaining
31404
+ */
31405
+ destroyVariantItems(): this;
31406
+ /**
31407
+ * Detaches event handler `fnFunction` from the {@link #event:manage manage} event of this `sap.ui.comp.smartvariants.SmartVariantManagementBase`.
31408
+ *
31409
+ * The passed function and listener object must match the ones used for event registration.
31410
+ *
31411
+ * @returns Reference to `this` in order to allow method chaining
31412
+ */
31413
+ detachManage(
31414
+ /**
31415
+ * The function to be called, when the event occurs
31416
+ */
31417
+ fnFunction: (p1: sap.ui.base.Event) => void,
31418
+ /**
31419
+ * Context object on which the given function had to be called
31420
+ */
31421
+ oListener?: object
31422
+ ): this;
31423
+ /**
31424
+ * Detaches event handler `fnFunction` from the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagementBase`.
31425
+ *
31426
+ * The passed function and listener object must match the ones used for event registration.
31427
+ *
31428
+ * @returns Reference to `this` in order to allow method chaining
31429
+ */
31430
+ detachSave(
31431
+ /**
31432
+ * The function to be called, when the event occurs
31433
+ */
31434
+ fnFunction: (p1: sap.ui.base.Event) => void,
31435
+ /**
31436
+ * Context object on which the given function had to be called
31437
+ */
31438
+ oListener?: object
31439
+ ): this;
31440
+ /**
31441
+ * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.comp.smartvariants.SmartVariantManagementBase`.
31442
+ *
31443
+ * The passed function and listener object must match the ones used for event registration.
31444
+ *
31445
+ * @returns Reference to `this` in order to allow method chaining
31446
+ */
31447
+ detachSelect(
31448
+ /**
31449
+ * The function to be called, when the event occurs
31450
+ */
31451
+ fnFunction: (p1: sap.ui.base.Event) => void,
31452
+ /**
31453
+ * Context object on which the given function had to be called
31454
+ */
31455
+ oListener?: object
31456
+ ): this;
31457
+ /**
31458
+ * Fires event {@link #event:manage manage} to attached listeners.
31459
+ *
31460
+ * @returns Reference to `this` in order to allow method chaining
31461
+ */
31462
+ fireManage(
31463
+ /**
31464
+ * Parameters to pass along with the event
31465
+ */
31466
+ mParameters?: {
31467
+ /**
31468
+ * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title
31469
+ * of the variant
31470
+ */
31471
+ renamed?: object[];
31472
+ /**
31473
+ * List of deleted variant keys
31474
+ */
31475
+ deleted?: string[];
31476
+ /**
31477
+ * List of variant keys and the associated Execute on Selection indicator
31478
+ */
31479
+ exe?: object[];
31480
+ /**
31481
+ * The default variant key
31482
+ */
31483
+ def?: string;
31484
+ }
31485
+ ): this;
31486
+ /**
31487
+ * Fires event {@link #event:save save} to attached listeners.
31488
+ *
31489
+ * @returns Reference to `this` in order to allow method chaining
31490
+ */
31491
+ fireSave(
31492
+ /**
31493
+ * Parameters to pass along with the event
31494
+ */
31495
+ mParameters?: {
31496
+ /**
31497
+ * The variant title
31498
+ */
31499
+ name?: string;
31500
+ /**
31501
+ * Indicates if an existing variant is overwritten or if a new variant is created
31502
+ */
31503
+ overwrite?: boolean;
31504
+ /**
31505
+ * The variant key
31506
+ */
31507
+ key?: string;
31508
+ /**
31509
+ * The Execute on Selection indicator
31510
+ */
31511
+ exe?: boolean;
31512
+ /**
31513
+ * The default variant indicator
31514
+ */
31515
+ def?: boolean;
31516
+ /**
31517
+ * The shared variant indicator
31518
+ */
31519
+ global?: boolean;
31520
+ }
31521
+ ): this;
31522
+ /**
31523
+ * Fires event {@link #event:select select} to attached listeners.
31524
+ *
31525
+ * @returns Reference to `this` in order to allow method chaining
31526
+ */
31527
+ fireSelect(
31528
+ /**
31529
+ * Parameters to pass along with the event
31530
+ */
31531
+ mParameters?: {
31532
+ /**
31533
+ * The variant key
31534
+ */
31535
+ key?: string;
31536
+ }
31537
+ ): this;
31538
+ /**
31539
+ * Gets the currently selected variant key.
31540
+ *
31541
+ * @returns Key of the currently selected variant. In case the model is not yet set `null` will be returned.
31542
+ */
31543
+ getCurrentVariantKey(): string;
31544
+ /**
31545
+ * Gets current value of property {@link #getDefaultVariantKey defaultVariantKey}.
31546
+ *
31547
+ * Provides a string value to set the default variant. Used for the save dialog. Has no effect on the selected
31548
+ * variant.
31549
+ *
31550
+ * @returns Value of property `defaultVariantKey`
31551
+ */
31552
+ getDefaultVariantKey(): string;
31553
+ /**
31554
+ * Gets current value of property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}.
31555
+ *
31556
+ * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
31557
+ * controls this behavior.
31558
+ *
31559
+ *
31560
+ * **Note:** the usage of this property is restricted to `sap.ui.generic.template` components only.
31561
+ *
31562
+ * Default value is `empty string`.
31563
+ *
31564
+ * @returns Value of property `displayTextForExecuteOnSelectionForStandardVariant`
31565
+ */
31566
+ getDisplayTextForExecuteOnSelectionForStandardVariant(): string;
31567
+ /**
31568
+ * Gets current value of property {@link #getEnabled enabled}.
31569
+ *
31570
+ * Can be set to true or false depending on whether you want to enable or disable the control.
31571
+ *
31572
+ * Default value is `true`.
31573
+ *
31574
+ * @returns Value of property `enabled`
31575
+ */
31576
+ getEnabled(): boolean;
31577
+ /**
31578
+ * @SINCE 1.104
31579
+ *
31580
+ * Gets current value of property {@link #getHeaderLevel headerLevel}.
31581
+ *
31582
+ * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
31583
+ *
31584
+ * Default value is `Auto`.
31585
+ *
31586
+ * @returns Value of property `headerLevel`
31587
+ */
31588
+ getHeaderLevel(): sap.ui.core.TitleLevel;
31589
+ /**
31590
+ * Gets current value of property {@link #getInErrorState inErrorState}.
31591
+ *
31592
+ * Indicates that the control is in error state. If set to `true` error message will be displayed whenever
31593
+ * the variant is opened.
31594
+ *
31595
+ * Default value is `false`.
31596
+ *
31597
+ * @returns Value of property `inErrorState`
31598
+ */
31599
+ getInErrorState(): boolean;
31600
+ /**
31601
+ * @deprecated (since 1.103)
31602
+ *
31603
+ * Gets current value of property {@link #getInitialSelectionKey initialSelectionKey}.
31604
+ *
31605
+ * Enables the setting of the initially selected variant.
31606
+ *
31607
+ * @returns Value of property `initialSelectionKey`
31608
+ */
31609
+ getInitialSelectionKey(): string;
31610
+ /**
31611
+ * @deprecated (since 1.103)
31612
+ *
31613
+ * Gets current value of property {@link #getLifecycleSupport lifecycleSupport}.
31614
+ *
31615
+ * Enables the lifecycle support. If set to true, the VariantManagement control handles the transport information
31616
+ * for shared variants.
31617
+ *
31618
+ * Default value is `false`.
31619
+ *
31620
+ * @returns Value of property `lifecycleSupport`
31621
+ */
31622
+ getLifecycleSupport(): boolean;
31623
+ /**
31624
+ * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which
31625
+ * is fired when width of the control is changed.
31626
+ *
31627
+ * @returns Configuration information for the `sap.m.IOverflowToolbarContent` interface.
31628
+ */
31629
+ getOverflowToolbarConfig(): object;
31630
+ /**
31631
+ * Gets current value of property {@link #getSelectionKey selectionKey}.
31632
+ *
31633
+ * The key of the currently selected item.
31634
+ *
31635
+ * @returns Value of property `selectionKey`
31636
+ */
31637
+ getSelectionKey(): string;
31638
+ /**
31639
+ * Gets current value of property {@link #getShowCreateTile showCreateTile}.
31640
+ *
31641
+ * Indicates that a Create Tile is visible in the Save As dialog.
31642
+ *
31643
+ * Default value is `false`.
31644
+ *
31645
+ * @returns Value of property `showCreateTile`
31646
+ */
31647
+ getShowCreateTile(): boolean;
31648
+ /**
31649
+ * Gets current value of property {@link #getShowExecuteOnSelection showExecuteOnSelection}.
31650
+ *
31651
+ * Indicates that Execute on Selection is visible in the Save As and the Manage Views dialogs.
31652
+ *
31653
+ * Default value is `false`.
31654
+ *
31655
+ * @returns Value of property `showExecuteOnSelection`
31656
+ */
31657
+ getShowExecuteOnSelection(): boolean;
31658
+ /**
31659
+ * Gets current value of property {@link #getShowSetAsDefault showSetAsDefault}.
31660
+ *
31661
+ * Indicates that set as default is visible in the Save As and the Manage Views dialogs.
31662
+ *
31663
+ * Default value is `true`.
31664
+ *
31665
+ * @returns Value of property `showSetAsDefault`
31666
+ */
31667
+ getShowSetAsDefault(): boolean;
31668
+ /**
31669
+ * Gets current value of property {@link #getShowShare showShare}.
31670
+ *
31671
+ * Indicates that the Public checkbox is visible in the Save As and the Manage Views dialogs. Selecting
31672
+ * this checkbox allows you to share variants with other users.
31673
+ *
31674
+ * Default value is `false`.
31675
+ *
31676
+ * @returns Value of property `showShare`
31677
+ */
31678
+ getShowShare(): boolean;
31679
+ /**
31680
+ * Gets current value of property {@link #getStandardItemAuthor standardItemAuthor}.
31681
+ *
31682
+ * Defines the author of the standard variant, for example, the name of the own company.
31683
+ *
31684
+ * Default value is `"SAP"`.
31685
+ *
31686
+ * @returns Value of property `standardItemAuthor`
31687
+ */
31688
+ getStandardItemAuthor(): string;
31689
+ /**
31690
+ * Gets current value of property {@link #getStandardItemText standardItemText}.
31691
+ *
31692
+ * Overwrites the default Standard variant title.
31693
+ * **Note:** This property has to be set during the `applySettings` method; it will be ignored otherwise.
31694
+ *
31695
+ * @returns Value of property `standardItemText`
31696
+ */
31697
+ getStandardItemText(): string;
31698
+ /**
31699
+ * Gets current value of property {@link #getUseFavorites useFavorites}.
31700
+ *
31701
+ * Indicates that the 'Favorites' feature is used. Only variants marked as favorites will be displayed in
31702
+ * the variant list.
31703
+ *
31704
+ * Default value is `false`.
31705
+ *
31706
+ * @returns Value of property `useFavorites`
31707
+ */
31708
+ getUseFavorites(): boolean;
31709
+ /**
31710
+ * Gets current value of property {@link #getVariantCreationByUserAllowed variantCreationByUserAllowed}.
31711
+ *
31712
+ * Indicates that end users are allowed to create variants
31713
+ * **Note:** this property is controlled by the flexibility service.
31714
+ *
31715
+ * Default value is `true`.
31716
+ *
31717
+ * @returns Value of property `variantCreationByUserAllowed`
31718
+ */
31719
+ getVariantCreationByUserAllowed(): boolean;
31720
+ /**
31721
+ * Gets content of aggregation {@link #getVariantItems variantItems}.
31722
+ *
31723
+ * Variant items displayed by the `SmartVariantManagement` control.
31724
+ */
31725
+ getVariantItems(): sap.ui.comp.variants.VariantItem[];
31726
+ /**
31727
+ * Retrieves all variants.
31728
+ *
31729
+ * @returns All variants. In case the model is not yet set, an empty array will be returned.
31730
+ */
31731
+ getVariants(): any[];
31732
+ /**
31733
+ * Checks for the provided `sap.ui.comp.variants.VariantItem` in the aggregation {@link #getVariantItems
31734
+ * variantItems}. and returns its index if found or -1 otherwise.
31735
+ *
31736
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
31737
+ */
31738
+ indexOfVariantItem(
31739
+ /**
31740
+ * The variantItem whose index is looked for
31741
+ */
31742
+ oVariantItem: sap.ui.comp.variants.VariantItem
31743
+ ): int;
31744
+ /**
31745
+ * Inserts a variantItem into the aggregation {@link #getVariantItems variantItems}.
31746
+ *
31747
+ * @returns Reference to `this` in order to allow method chaining
31748
+ */
31749
+ insertVariantItem(
31750
+ /**
31751
+ * The variantItem to insert; if empty, nothing is inserted
31752
+ */
31753
+ oVariantItem: sap.ui.comp.variants.VariantItem,
31754
+ /**
31755
+ * The `0`-based index the variantItem should be inserted at; for a negative value of `iIndex`, the variantItem
31756
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the variantItem
31757
+ * is inserted at the last position
31758
+ */
31759
+ iIndex: int
31760
+ ): this;
31761
+ /**
31762
+ * Removes all the controls from the aggregation {@link #getVariantItems variantItems}.
31763
+ *
31764
+ * Additionally, it unregisters them from the hosting UIArea.
31765
+ *
31766
+ * @returns An array of the removed elements (might be empty)
31767
+ */
31768
+ removeAllVariantItems(): sap.ui.comp.variants.VariantItem[];
31769
+ /**
31770
+ * Removes a variantItem from the aggregation {@link #getVariantItems variantItems}.
31771
+ *
31772
+ * @returns The removed variantItem or `null`
31773
+ */
31774
+ removeVariantItem(
31775
+ /**
31776
+ * The variantItem to remove or its index or id
31777
+ */
31778
+ vVariantItem: int | string | sap.ui.comp.variants.VariantItem
31779
+ ): sap.ui.comp.variants.VariantItem | null;
31780
+ /**
31781
+ * Sets the new selected variant.
31782
+ */
31783
+ setCurrentVariantKey(
31784
+ /**
31785
+ * Key of the variant that should be selected.
31786
+ */
31787
+ sKey: string
31788
+ ): void;
31789
+ /**
31790
+ * Sets a new value for property {@link #getDefaultVariantKey defaultVariantKey}.
31791
+ *
31792
+ * Provides a string value to set the default variant. Used for the save dialog. Has no effect on the selected
31793
+ * variant.
31794
+ *
31795
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
31796
+ *
31797
+ * @returns Reference to `this` in order to allow method chaining
31798
+ */
31799
+ setDefaultVariantKey(
31800
+ /**
31801
+ * New value for property `defaultVariantKey`
31802
+ */
31803
+ sDefaultVariantKey?: string
31804
+ ): this;
31805
+ /**
30835
31806
  * Sets a new value for property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}.
30836
31807
  *
30837
31808
  * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application
@@ -30853,118 +31824,132 @@ declare namespace sap {
30853
31824
  sDisplayTextForExecuteOnSelectionForStandardVariant?: string
30854
31825
  ): this;
30855
31826
  /**
30856
- * The entity set name from OData metadata, with which the smart variant control must be bound.
31827
+ * Sets a new value for property {@link #getEnabled enabled}.
30857
31828
  *
30858
- * @returns the control instance
31829
+ * Can be set to true or false depending on whether you want to enable or disable the control.
31830
+ *
31831
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
31832
+ *
31833
+ * Default value is `true`.
31834
+ *
31835
+ * @returns Reference to `this` in order to allow method chaining
30859
31836
  */
30860
- setEntitySet(
31837
+ setEnabled(
30861
31838
  /**
30862
- * The entity set
31839
+ * New value for property `enabled`
30863
31840
  */
30864
- sEntitySetName: string
30865
- ): Object;
31841
+ bEnabled?: boolean
31842
+ ): this;
30866
31843
  /**
30867
- * Sets a new value for property {@link #getPersistencyKey persistencyKey}.
31844
+ * @SINCE 1.104
30868
31845
  *
30869
- * Key used to access personalization data.
31846
+ * Sets a new value for property {@link #getHeaderLevel headerLevel}.
31847
+ *
31848
+ * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}.
30870
31849
  *
30871
31850
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
30872
31851
  *
31852
+ * Default value is `Auto`.
31853
+ *
30873
31854
  * @returns Reference to `this` in order to allow method chaining
30874
31855
  */
30875
- setPersistencyKey(
31856
+ setHeaderLevel(
30876
31857
  /**
30877
- * New value for property `persistencyKey`
31858
+ * New value for property `headerLevel`
30878
31859
  */
30879
- sPersistencyKey?: string
31860
+ sHeaderLevel?: sap.ui.core.TitleLevel
30880
31861
  ): this;
30881
- }
30882
- /**
30883
- * Handles the odata metadata based information. An instance of this class will be created and used by the
30884
- * {@link sap.ui.comp.smartvariants.SmartVariantManagement SmartVariantManagement} control. The adapter
30885
- * transforms odata metadata based SelectionPresentationVariant information to UIState object. For each
30886
- * SelectionPresentationVariant annotation an entry will be added to the VariantManagement control. It will
30887
- * be called by the SmartVariantManagement whenever the user selects the corresponding entry and will provide
30888
- * a valid {@link sap.ui.comp.state.UIState UIState} object.
30889
- */
30890
- class SmartVariantManagementAdapter extends sap.ui.core.Element {
30891
31862
  /**
30892
- * Constructor for new instance of a SmartVariantManagementAdapter control.
31863
+ * Sets a new value for property {@link #getInErrorState inErrorState}.
30893
31864
  *
30894
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
30895
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
30896
- * of the syntax of the settings object.
31865
+ * Indicates that the control is in error state. If set to `true` error message will be displayed whenever
31866
+ * the variant is opened.
31867
+ *
31868
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
31869
+ *
31870
+ * Default value is `false`.
31871
+ *
31872
+ * @returns Reference to `this` in order to allow method chaining
30897
31873
  */
30898
- constructor(
31874
+ setInErrorState(
30899
31875
  /**
30900
- * initial settings for the new control
31876
+ * New value for property `inErrorState`
30901
31877
  */
30902
- mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementAdapterSettings
30903
- );
31878
+ bInErrorState?: boolean
31879
+ ): this;
30904
31880
  /**
30905
- * Constructor for new instance of a SmartVariantManagementAdapter control.
31881
+ * @deprecated (since 1.103)
30906
31882
  *
30907
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
30908
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
30909
- * of the syntax of the settings object.
31883
+ * Sets a new value for property {@link #getInitialSelectionKey initialSelectionKey}.
31884
+ *
31885
+ * Enables the setting of the initially selected variant.
31886
+ *
31887
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
31888
+ *
31889
+ * @returns Reference to `this` in order to allow method chaining
30910
31890
  */
30911
- constructor(
30912
- /**
30913
- * ID for the new control, generated automatically if no ID is given
30914
- */
30915
- sId?: string,
31891
+ setInitialSelectionKey(
30916
31892
  /**
30917
- * initial settings for the new control
31893
+ * New value for property `initialSelectionKey`
30918
31894
  */
30919
- mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementAdapterSettings
30920
- );
30921
-
31895
+ sInitialSelectionKey?: string
31896
+ ): this;
30922
31897
  /**
30923
- * Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementAdapter with name `sClassName`
30924
- * and enriches it with the information contained in `oClassInfo`.
31898
+ * @deprecated (since 1.103)
30925
31899
  *
30926
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
31900
+ * Sets a new value for property {@link #getLifecycleSupport lifecycleSupport}.
30927
31901
  *
30928
- * @returns Created class / constructor function
31902
+ * Enables the lifecycle support. If set to true, the VariantManagement control handles the transport information
31903
+ * for shared variants.
31904
+ *
31905
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
31906
+ *
31907
+ * Default value is `false`.
31908
+ *
31909
+ * @returns Reference to `this` in order to allow method chaining
30929
31910
  */
30930
- static extend<T extends Record<string, unknown>>(
30931
- /**
30932
- * Name of the class being created
30933
- */
30934
- sClassName: string,
30935
- /**
30936
- * Object literal with information about the class
30937
- */
30938
- oClassInfo?: sap.ClassInfo<
30939
- T,
30940
- sap.ui.comp.smartvariants.SmartVariantManagementAdapter
30941
- >,
31911
+ setLifecycleSupport(
30942
31912
  /**
30943
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
30944
- * used by this class
31913
+ * New value for property `lifecycleSupport`
30945
31914
  */
30946
- FNMetaImpl?: Function
30947
- ): Function;
31915
+ bLifecycleSupport?: boolean
31916
+ ): this;
30948
31917
  /**
30949
- * Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagementAdapter.
31918
+ * Sets a new value for property {@link #getSelectionKey selectionKey}.
30950
31919
  *
30951
- * @returns Metadata object describing this class
31920
+ * The key of the currently selected item.
31921
+ *
31922
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
31923
+ *
31924
+ * @returns Reference to `this` in order to allow method chaining
30952
31925
  */
30953
- static getMetadata(): sap.ui.core.ElementMetadata;
31926
+ setSelectionKey(
31927
+ /**
31928
+ * New value for property `selectionKey`
31929
+ */
31930
+ sSelectionKey?: string
31931
+ ): this;
30954
31932
  /**
30955
- * Gets current value of property {@link #getSelectionPresentationVariants selectionPresentationVariants}.
31933
+ * Sets a new value for property {@link #getShowCreateTile showCreateTile}.
30956
31934
  *
30957
- * assign an array of selectionPresentationVariants annotations.
31935
+ * Indicates that a Create Tile is visible in the Save As dialog.
31936
+ *
31937
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
30958
31938
  *
30959
31939
  * Default value is `false`.
30960
31940
  *
30961
- * @returns Value of property `selectionPresentationVariants`
31941
+ * @returns Reference to `this` in order to allow method chaining
30962
31942
  */
30963
- getSelectionPresentationVariants(): object;
31943
+ setShowCreateTile(
31944
+ /**
31945
+ * New value for property `showCreateTile`
31946
+ */
31947
+ bShowCreateTile?: boolean
31948
+ ): this;
30964
31949
  /**
30965
- * Sets a new value for property {@link #getSelectionPresentationVariants selectionPresentationVariants}.
31950
+ * Sets a new value for property {@link #getShowExecuteOnSelection showExecuteOnSelection}.
30966
31951
  *
30967
- * assign an array of selectionPresentationVariants annotations.
31952
+ * Indicates that Execute on Selection is visible in the Save As and the Manage Views dialogs.
30968
31953
  *
30969
31954
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
30970
31955
  *
@@ -30972,95 +31957,116 @@ declare namespace sap {
30972
31957
  *
30973
31958
  * @returns Reference to `this` in order to allow method chaining
30974
31959
  */
30975
- setSelectionPresentationVariants(
31960
+ setShowExecuteOnSelection(
30976
31961
  /**
30977
- * New value for property `selectionPresentationVariants`
31962
+ * New value for property `showExecuteOnSelection`
30978
31963
  */
30979
- oSelectionPresentationVariants?: object
31964
+ bShowExecuteOnSelection?: boolean
30980
31965
  ): this;
30981
- }
30982
- /**
30983
- * @SINCE 1.86
30984
- *
30985
- * Overview: The `SmartVariantManagementBase` control is a specialization of the {@link sap.ui.comp.variants.VariantManagement
30986
- * VariantManagement} control and communicates with the flexibility library that offers SAPUI5 flexibility
30987
- * to manage the variants for the UI Adaptation scenarios.
30988
- */
30989
- class SmartVariantManagementBase extends sap.ui.comp.variants
30990
- .VariantManagement {
30991
31966
  /**
30992
- * Constructor for a new SmartVariantManagementBase.
30993
- * This class handles the UI Adaptation for the SmartVariantManagement control. It provides RTA enabled
30994
- * dialogs and the corresponding functionality for beeing able to create changes as key user.
31967
+ * Sets a new value for property {@link #getShowSetAsDefault showSetAsDefault}.
30995
31968
  *
30996
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
30997
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
30998
- * of the syntax of the settings object.
31969
+ * Indicates that set as default is visible in the Save As and the Manage Views dialogs.
31970
+ *
31971
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
30999
31972
  *
31000
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.comp.variants.VariantManagement#constructor
31001
- * sap.ui.comp.variants.VariantManagement} can be used.
31973
+ * Default value is `true`.
31974
+ *
31975
+ * @returns Reference to `this` in order to allow method chaining
31002
31976
  */
31003
- constructor(
31977
+ setShowSetAsDefault(
31004
31978
  /**
31005
- * initial settings for the new control
31979
+ * New value for property `showSetAsDefault`
31006
31980
  */
31007
- mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementBaseSettings
31008
- );
31981
+ bShowSetAsDefault?: boolean
31982
+ ): this;
31009
31983
  /**
31010
- * Constructor for a new SmartVariantManagementBase.
31011
- * This class handles the UI Adaptation for the SmartVariantManagement control. It provides RTA enabled
31012
- * dialogs and the corresponding functionality for beeing able to create changes as key user.
31984
+ * Sets a new value for property {@link #getShowShare showShare}.
31013
31985
  *
31014
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
31015
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
31016
- * of the syntax of the settings object.
31986
+ * Indicates that the Public checkbox is visible in the Save As and the Manage Views dialogs. Selecting
31987
+ * this checkbox allows you to share variants with other users.
31017
31988
  *
31018
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.comp.variants.VariantManagement#constructor
31019
- * sap.ui.comp.variants.VariantManagement} can be used.
31989
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
31990
+ *
31991
+ * Default value is `false`.
31992
+ *
31993
+ * @returns Reference to `this` in order to allow method chaining
31020
31994
  */
31021
- constructor(
31022
- /**
31023
- * ID for the new control, generated automatically if no ID is given
31024
- */
31025
- sId?: string,
31995
+ setShowShare(
31026
31996
  /**
31027
- * initial settings for the new control
31997
+ * New value for property `showShare`
31028
31998
  */
31029
- mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementBaseSettings
31030
- );
31031
-
31999
+ bShowShare?: boolean
32000
+ ): this;
31032
32001
  /**
31033
- * Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementBase with name `sClassName`
31034
- * and enriches it with the information contained in `oClassInfo`.
32002
+ * Sets a new value for property {@link #getStandardItemAuthor standardItemAuthor}.
31035
32003
  *
31036
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.comp.variants.VariantManagement.extend}.
32004
+ * Defines the author of the standard variant, for example, the name of the own company.
31037
32005
  *
31038
- * @returns Created class / constructor function
32006
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
32007
+ *
32008
+ * Default value is `"SAP"`.
32009
+ *
32010
+ * @returns Reference to `this` in order to allow method chaining
31039
32011
  */
31040
- static extend<T extends Record<string, unknown>>(
32012
+ setStandardItemAuthor(
31041
32013
  /**
31042
- * Name of the class being created
32014
+ * New value for property `standardItemAuthor`
31043
32015
  */
31044
- sClassName: string,
32016
+ sStandardItemAuthor?: string
32017
+ ): this;
32018
+ /**
32019
+ * Sets a new value for property {@link #getStandardItemText standardItemText}.
32020
+ *
32021
+ * Overwrites the default Standard variant title.
32022
+ * **Note:** This property has to be set during the `applySettings` method; it will be ignored otherwise.
32023
+ *
32024
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
32025
+ *
32026
+ * @returns Reference to `this` in order to allow method chaining
32027
+ */
32028
+ setStandardItemText(
31045
32029
  /**
31046
- * Object literal with information about the class
32030
+ * New value for property `standardItemText`
31047
32031
  */
31048
- oClassInfo?: sap.ClassInfo<
31049
- T,
31050
- sap.ui.comp.smartvariants.SmartVariantManagementBase
31051
- >,
32032
+ sStandardItemText?: string
32033
+ ): this;
32034
+ /**
32035
+ * Sets a new value for property {@link #getUseFavorites useFavorites}.
32036
+ *
32037
+ * Indicates that the 'Favorites' feature is used. Only variants marked as favorites will be displayed in
32038
+ * the variant list.
32039
+ *
32040
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
32041
+ *
32042
+ * Default value is `false`.
32043
+ *
32044
+ * @returns Reference to `this` in order to allow method chaining
32045
+ */
32046
+ setUseFavorites(
31052
32047
  /**
31053
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
31054
- * used by this class
32048
+ * New value for property `useFavorites`
31055
32049
  */
31056
- FNMetaImpl?: Function
31057
- ): Function;
32050
+ bUseFavorites?: boolean
32051
+ ): this;
31058
32052
  /**
31059
- * Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagementBase.
32053
+ * Sets a new value for property {@link #getVariantCreationByUserAllowed variantCreationByUserAllowed}.
31060
32054
  *
31061
- * @returns Metadata object describing this class
32055
+ * Indicates that end users are allowed to create variants
32056
+ * **Note:** this property is controlled by the flexibility service.
32057
+ *
32058
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
32059
+ *
32060
+ * Default value is `true`.
32061
+ *
32062
+ * @returns Reference to `this` in order to allow method chaining
31062
32063
  */
31063
- static getMetadata(): sap.ui.core.ElementMetadata;
32064
+ setVariantCreationByUserAllowed(
32065
+ /**
32066
+ * New value for property `variantCreationByUserAllowed`
32067
+ */
32068
+ bVariantCreationByUserAllowed?: boolean
32069
+ ): this;
31064
32070
  }
31065
32071
  /**
31066
32072
  * The SmartVariantManagementUi2 control is a specialization of the {@link sap.ui.comp.variants.VariantManagement
@@ -32141,7 +33147,19 @@ declare namespace sap {
32141
33147
  }
32142
33148
 
32143
33149
  /**
32144
- * The ValueHelpDialog control can be used to implement a value help for an input field.
33150
+ * Overview: The ValueHelpDialog helps the user to find and select single and multiple
33151
+ * values. The user can also define and select multiple conditions. The control is generally called from
33152
+ * an input field or a multi-input field by clicking the selection icon (value help icon) of the input field.
33153
+ *
33154
+ * This control only supports OData V2 model (see {@link sap.ui.model.odata.v2.ODataModel})
33155
+ *
33156
+ * Usage: When to use::
33157
+ * - The user is searching within a very large dataset
33158
+ * - The user needs to use different attributes to find an object (such as city, company name, and so
33159
+ * on).
33160
+ * - The user needs to define conditions, such as ranges and exclusions. When not to use::
33161
+ * - There is a simpler control that fits the use case. Always start with the least complex control. For
33162
+ * example, use the select control if the user needs to select only one item from a short list.
32145
33163
  */
32146
33164
  class ValueHelpDialog extends sap.m.Dialog {
32147
33165
  /**
@@ -33374,7 +34392,7 @@ declare namespace sap {
33374
34392
  | `{${string}}`;
33375
34393
  }
33376
34394
 
33377
- interface $VariantItemSettings extends sap.ui.core.$ItemSettings {
34395
+ interface $VariantItemSettings extends sap.m.$VariantItemSettings {
33378
34396
  /**
33379
34397
  * @SINCE 1.26.0
33380
34398
  *
@@ -33450,23 +34468,6 @@ declare namespace sap {
33450
34468
  | sap.ui.base.ManagedObject.PropertyBindingInfo
33451
34469
  | `{${string}}`;
33452
34470
 
33453
- /**
33454
- * @SINCE 1.38.0
33455
- *
33456
- * Author of the variant
33457
- */
33458
- author?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
33459
-
33460
- /**
33461
- * @SINCE 1.50.0
33462
- *
33463
- * Indicates if favorites can be created.
33464
- */
33465
- favorite?:
33466
- | boolean
33467
- | sap.ui.base.ManagedObject.PropertyBindingInfo
33468
- | `{${string}}`;
33469
-
33470
34471
  /**
33471
34472
  * This event is fired when one of the properties is changed.
33472
34473
  */
@@ -34015,7 +35016,7 @@ declare namespace sap {
34015
35016
  /**
34016
35017
  * The VariantItem class describes a variant item.
34017
35018
  */
34018
- class VariantItem extends sap.ui.core.Item {
35019
+ class VariantItem extends sap.m.VariantItem {
34019
35020
  /**
34020
35021
  * Constructor for a new variants/VariantItem.
34021
35022
  *
@@ -34051,7 +35052,7 @@ declare namespace sap {
34051
35052
  * Creates a new subclass of class sap.ui.comp.variants.VariantItem with name `sClassName` and enriches
34052
35053
  * it with the information contained in `oClassInfo`.
34053
35054
  *
34054
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
35055
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.m.VariantItem.extend}.
34055
35056
  *
34056
35057
  * @returns Created class / constructor function
34057
35058
  */
@@ -34165,16 +35166,6 @@ declare namespace sap {
34165
35166
  * @returns Value of property `accessOptions`
34166
35167
  */
34167
35168
  getAccessOptions(): string;
34168
- /**
34169
- * @SINCE 1.38.0
34170
- *
34171
- * Gets current value of property {@link #getAuthor author}.
34172
- *
34173
- * Author of the variant
34174
- *
34175
- * @returns Value of property `author`
34176
- */
34177
- getAuthor(): string;
34178
35169
  /**
34179
35170
  * @SINCE 1.26.0
34180
35171
  *
@@ -34187,18 +35178,6 @@ declare namespace sap {
34187
35178
  * @returns Value of property `executeOnSelection`
34188
35179
  */
34189
35180
  getExecuteOnSelection(): boolean;
34190
- /**
34191
- * @SINCE 1.50.0
34192
- *
34193
- * Gets current value of property {@link #getFavorite favorite}.
34194
- *
34195
- * Indicates if favorites can be created.
34196
- *
34197
- * Default value is `false`.
34198
- *
34199
- * @returns Value of property `favorite`
34200
- */
34201
- getFavorite(): boolean;
34202
35181
  /**
34203
35182
  * @SINCE 1.26.0
34204
35183
  *
@@ -34281,23 +35260,6 @@ declare namespace sap {
34281
35260
  */
34282
35261
  sAccessOptions?: string
34283
35262
  ): this;
34284
- /**
34285
- * @SINCE 1.38.0
34286
- *
34287
- * Sets a new value for property {@link #getAuthor author}.
34288
- *
34289
- * Author of the variant
34290
- *
34291
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
34292
- *
34293
- * @returns Reference to `this` in order to allow method chaining
34294
- */
34295
- setAuthor(
34296
- /**
34297
- * New value for property `author`
34298
- */
34299
- sAuthor?: string
34300
- ): this;
34301
35263
  /**
34302
35264
  * @SINCE 1.26.0
34303
35265
  *
@@ -34317,25 +35279,6 @@ declare namespace sap {
34317
35279
  */
34318
35280
  bExecuteOnSelection?: boolean
34319
35281
  ): this;
34320
- /**
34321
- * @SINCE 1.50.0
34322
- *
34323
- * Sets a new value for property {@link #getFavorite favorite}.
34324
- *
34325
- * Indicates if favorites can be created.
34326
- *
34327
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
34328
- *
34329
- * Default value is `false`.
34330
- *
34331
- * @returns Reference to `this` in order to allow method chaining
34332
- */
34333
- setFavorite(
34334
- /**
34335
- * New value for property `favorite`
34336
- */
34337
- bFavorite?: boolean
34338
- ): this;
34339
35282
  /**
34340
35283
  * @SINCE 1.26.0
34341
35284
  *
@@ -35187,7 +36130,7 @@ declare namespace sap {
35187
36130
  * The item to remove or its index or id
35188
36131
  */
35189
36132
  vItem: int | string | sap.ui.core.Item
35190
- ): sap.ui.core.Item;
36133
+ ): sap.ui.core.Item | null;
35191
36134
  /**
35192
36135
  * @SINCE 1.26.0
35193
36136
  *
@@ -35200,7 +36143,7 @@ declare namespace sap {
35200
36143
  * The variantItem to remove or its index or id
35201
36144
  */
35202
36145
  vVariantItem: int | string | sap.ui.comp.variants.VariantItem
35203
- ): sap.ui.comp.variants.VariantItem;
36146
+ ): sap.ui.comp.variants.VariantItem | null;
35204
36147
  /**
35205
36148
  * @SINCE 1.48.0
35206
36149
  *