@openui5/types 1.133.1 → 1.135.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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.1
1
+ // For Library Version: 1.135.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  import Control from "sap/ui/core/Control";
@@ -96,6 +96,107 @@ declare module "sap/ui/rta/enablement/TestDelegate" {
96
96
  export default TestDelegate;
97
97
  }
98
98
 
99
+ declare module "sap/ui/rta/plugin/annotations/AnnotationChangeDialog" {
100
+ /**
101
+ * Annotation change definition
102
+ */
103
+ export type AnnotationChangeDefinition = {
104
+ /**
105
+ * Change type
106
+ */
107
+ annotationChangeType: string;
108
+ /**
109
+ * Url of the OData service
110
+ */
111
+ serviceUrl: string;
112
+ /**
113
+ * Change content
114
+ */
115
+ content: {
116
+ /**
117
+ * Path of the property
118
+ */
119
+ annotationPath: string;
120
+ /**
121
+ * New value
122
+ */
123
+ value: string;
124
+ /**
125
+ * New value as translatable text. If given, the value is ignored
126
+ */
127
+ text: string;
128
+ /**
129
+ * Object template to construct a return object. If given the applyChange function will return an object
130
+ * as value, which is parsed from the template string.
131
+ */
132
+ objectTemplateInfo?: {
133
+ /**
134
+ * Stringified template to be used for constructing the return object
135
+ */
136
+ templateAsString?: string;
137
+ /**
138
+ * Placeholder in the template string. Will be replaced by the new value
139
+ */
140
+ placeholder?: string;
141
+ };
142
+ };
143
+ };
144
+
145
+ /**
146
+ * Annotation change info
147
+ */
148
+ export type AnnotationChangeInfo = {
149
+ /**
150
+ * Url of the OData service
151
+ */
152
+ serviceUrl: string;
153
+ /**
154
+ * Array of properties
155
+ */
156
+ properties: Array<{
157
+ /**
158
+ * Path of the property
159
+ */
160
+ annotationPath: string;
161
+ /**
162
+ * Name of the property
163
+ */
164
+ propertyName: string;
165
+ /**
166
+ * Current value of the property
167
+ */
168
+ currentValue: string;
169
+ /**
170
+ * Label of the property. If not given, the property name is used
171
+ */
172
+ label?: string;
173
+ /**
174
+ * Tooltip of the property
175
+ */
176
+ tooltip?: string;
177
+ }>;
178
+ /**
179
+ * Array of possible values for value list type properties
180
+ */
181
+ possibleValues: Array<{
182
+ /**
183
+ * Key of the option
184
+ */
185
+ key: string;
186
+ /**
187
+ * Text of the option
188
+ */
189
+ text: string;
190
+ }>;
191
+ /**
192
+ * Name of the property that should be filtered for initially
193
+ */
194
+ preSelectedProperty?: string;
195
+ };
196
+
197
+ export type getAnnotationChangeInfo = () => AnnotationChangeInfo;
198
+ }
199
+
99
200
  declare namespace sap {
100
201
  interface IUI5DefineDependencyNames {
101
202
  "sap/ui/rta/api/startAdaptation": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.1
1
+ // For Library Version: 1.135.0
2
2
 
3
3
  declare module "sap/ui/suite/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.1
1
+ // For Library Version: 1.135.0
2
2
 
3
3
  declare module "sap/ui/support/library" {
4
4
  /**
@@ -413,12 +413,6 @@ declare namespace sap {
413
413
  * @since 1.50
414
414
  */
415
415
  namespace support {
416
- /**
417
- * The CoreFacade interface allows rule developers to access the metadata, models, UI areas and components
418
- * of the Core.
419
- *
420
- * Usage: The CoreFacade is passed as second argument to all rule check functions.
421
- */
422
416
  class CoreFacade {
423
417
  /**
424
418
  * @ui5-protected Do not call from applications (only from related classes in the framework)
@@ -427,26 +421,46 @@ declare namespace sap {
427
421
 
428
422
  /**
429
423
  * Gets the Components from the Core object.
424
+ *
425
+ *
426
+ * @returns Object with all components, keyed by their ID
430
427
  */
431
- getComponents(): void;
428
+ getComponents(): Record<
429
+ import("sap/ui/core/library").ID,
430
+ import("sap/ui/core/Component").default
431
+ >;
432
432
  /**
433
433
  * Gets the Metadata from the Core object.
434
+ *
435
+ * @deprecated As of version 1.119. without replacement. In future major versions, the Core no longer has
436
+ * a class nature and no longer inherits from sap.ui.base.Object and therefore no longer has metadata.
437
+ *
438
+ * @returns Metadata object describing the Core object
434
439
  */
435
- getMetadata(): void;
440
+ getMetadata(): import("sap/ui/base/Metadata").default;
436
441
  /**
437
442
  * Gets the Models from the Core object.
443
+ *
444
+ * @deprecated As of version 1.118.0. without replacement. In future major versions, the Core no longer
445
+ * has global models.
446
+ *
447
+ * @returns Object with all models, keyed by their name
438
448
  */
439
- getModels(): void;
449
+ getModels():
450
+ | Record<string, import("sap/ui/model/Model").default>
451
+ | undefined;
440
452
  /**
441
453
  * Gets the UI areas from the Core object.
454
+ *
455
+ *
456
+ * @returns Object with all UIAreas, keyed by their ID
442
457
  */
443
- getUIAreas(): void;
458
+ getUIAreas(): Record<
459
+ import("sap/ui/core/library").ID,
460
+ import("sap/ui/core/UIArea").default
461
+ >;
444
462
  }
445
- /**
446
- * The IssueManagerFacade allows rule developers to add new issues.
447
- *
448
- * Usage: The IssueManagerFacade is passed as first argument to all rule check functions.
449
- */
463
+
450
464
  class IssueManagerFacade {
451
465
  /**
452
466
  * @ui5-protected Do not call from applications (only from related classes in the framework)
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.1
1
+ // For Library Version: 1.135.0
2
2
 
3
3
  declare module "sap/ui/table/library" {
4
4
  import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -619,9 +619,9 @@ declare module "sap/ui/table/AnalyticalTable" {
619
619
  import Event from "sap/ui/base/Event";
620
620
 
621
621
  /**
622
- * Table which handles analytical OData backends. The AnalyticalTable only works with an AnalyticalBinding
623
- * and correctly annotated OData services. Please check on the SAP Annotations for OData Version 2.0 documentation
624
- * for further details.
622
+ * Table that handles analytical OData back-end scenarios. The `AnalyticalTable` only works with {@link sap.ui.model.analytics.AnalyticalBinding AnalyticalBinding }
623
+ * and correctly annotated OData services. Please check out the functionality of analytical binding and
624
+ * the SAP Annotations for OData Version 2.0 documentation for further details.
625
625
  */
626
626
  export default class AnalyticalTable extends Table {
627
627
  /**
@@ -3071,7 +3071,7 @@ declare module "sap/ui/table/plugins/MultiSelectionPlugin" {
3071
3071
  */
3072
3072
  export default class MultiSelectionPlugin extends SelectionPlugin {
3073
3073
  /**
3074
- * Constructs an instance of sap.ui.table.plugins.MultiSelectionPlugin
3074
+ * Constructs an instance of sap.ui.table.plugins.MultiSelectionPlugin.
3075
3075
  *
3076
3076
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3077
3077
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -3570,20 +3570,16 @@ declare module "sap/ui/table/plugins/SelectionPlugin" {
3570
3570
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3571
3571
 
3572
3572
  /**
3573
- * Implements the selection methods for a table.
3573
+ * Base class for the selection plugins. A selection plugin is responsible for the selection behavior of
3574
+ * the table. It handles the selection state and provides information about the selection state to the table.
3575
+ * The subclass is also responsible for firing the `selectionChange` event when the selection is changed.
3576
+ *
3577
+ * Do not add more than one selection plugin to a table.
3574
3578
  *
3575
3579
  * @since 1.64
3576
- * @experimental As of version 1.64.
3577
3580
  */
3578
3581
  export default abstract class SelectionPlugin extends UI5Element {
3579
3582
  /**
3580
- * Constructs an instance of sap.ui.table.plugins.SelectionPlugin
3581
- *
3582
- * The following restrictions apply:
3583
- * - Do not create subclasses of the `SelectionPlugin`. The API is subject to change. **Note:** Subclasses
3584
- * provided by the UI5 framework that are not explicitly marked as experimental or restricted in any other
3585
- * way can be used on a regular basis.
3586
- *
3587
3583
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3588
3584
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3589
3585
  * of the syntax of the settings object.
@@ -3749,8 +3745,6 @@ declare module "sap/ui/table/plugins/SelectionPlugin" {
3749
3745
  }
3750
3746
  /**
3751
3747
  * Describes the settings that can be provided to the SelectionPlugin constructor.
3752
- *
3753
- * @experimental As of version 1.64.
3754
3748
  */
3755
3749
  export interface $SelectionPluginSettings extends $ElementSettings {
3756
3750
  /**
@@ -11437,8 +11431,6 @@ declare namespace sap {
11437
11431
 
11438
11432
  "sap/ui/table/plugins/SelectionPlugin": undefined;
11439
11433
 
11440
- "sap/ui/table/plugins/V4Aggregation": undefined;
11441
-
11442
11434
  "sap/ui/table/Row": undefined;
11443
11435
 
11444
11436
  "sap/ui/table/RowAction": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.1
1
+ // For Library Version: 1.135.0
2
2
 
3
3
  declare module "sap/ui/testrecorder/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.1
1
+ // For Library Version: 1.135.0
2
2
 
3
3
  declare module "sap/ui/unified/library" {
4
4
  /**
@@ -948,7 +948,10 @@ declare module "sap/ui/unified/Calendar" {
948
948
  /**
949
949
  * Gets current value of property {@link #getIntervalSelection intervalSelection}.
950
950
  *
951
- * If set, interval selection is allowed
951
+ * Determines if an interval of dates can be selected.
952
+ *
953
+ * **Note:** This property should be set to `false` if `singleSelection` is set to `false`, as selecting
954
+ * multiple intervals is not supported.
952
955
  *
953
956
  * Default value is `false`.
954
957
  *
@@ -1095,7 +1098,10 @@ declare module "sap/ui/unified/Calendar" {
1095
1098
  /**
1096
1099
  * Gets current value of property {@link #getSingleSelection singleSelection}.
1097
1100
  *
1098
- * If set, only a single date or interval, if intervalSelection is enabled, can be selected
1101
+ * Determines if a single date or single interval, when `intervalSelection` is set to `true`, can be selected.
1102
+ *
1103
+ * **Note:** This property should be set to `true` if `intervalSelection` is set to `true`, as selecting
1104
+ * multiple intervals is not supported.
1099
1105
  *
1100
1106
  * Default value is `true`.
1101
1107
  *
@@ -1370,22 +1376,19 @@ declare module "sap/ui/unified/Calendar" {
1370
1376
  oInitialFocusedDate?: object
1371
1377
  ): this;
1372
1378
  /**
1373
- * Sets a new value for property {@link #getIntervalSelection intervalSelection}.
1379
+ * Setter for the property `intervalSelection`. If set to `true`, an interval of dates can be selected.
1374
1380
  *
1375
- * If set, interval selection is allowed
1376
- *
1377
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1378
- *
1379
- * Default value is `false`.
1381
+ * **Note:** This property should be set to `false` if `singleSelection` is set to `false`, as selecting
1382
+ * multiple intervals is not supported.
1380
1383
  *
1381
1384
  *
1382
- * @returns Reference to `this` in order to allow method chaining
1385
+ * @returns Reference to `this` for method chaining
1383
1386
  */
1384
1387
  setIntervalSelection(
1385
1388
  /**
1386
- * New value for property `intervalSelection`
1389
+ * Indicates if `intervalSelection` should be enabled
1387
1390
  */
1388
- bIntervalSelection?: boolean
1391
+ bEnabled: boolean
1389
1392
  ): this;
1390
1393
  /**
1391
1394
  * Sets the associated {@link #getLegend legend}.
@@ -1547,22 +1550,20 @@ declare module "sap/ui/unified/Calendar" {
1547
1550
  bShowWeekNumbers?: boolean
1548
1551
  ): this;
1549
1552
  /**
1550
- * Sets a new value for property {@link #getSingleSelection singleSelection}.
1553
+ * Setter for the property `singleSelection`. If set to `true` only a single date or single interval, when
1554
+ * `intervalSelection` is set to `true`, can be selected.
1551
1555
  *
1552
- * If set, only a single date or interval, if intervalSelection is enabled, can be selected
1553
- *
1554
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1555
- *
1556
- * Default value is `true`.
1556
+ * **Note:** This property should be set to `true` if `intervalSelection` is set to `true`, as selecting
1557
+ * multiple intervals is not supported.
1557
1558
  *
1558
1559
  *
1559
- * @returns Reference to `this` in order to allow method chaining
1560
+ * @returns Reference to `this` for method chaining
1560
1561
  */
1561
1562
  setSingleSelection(
1562
1563
  /**
1563
- * New value for property `singleSelection`
1564
+ * Indicates if `singleSelection` should be enabled
1564
1565
  */
1565
- bSingleSelection?: boolean
1566
+ bEnabled: boolean
1566
1567
  ): this;
1567
1568
  /**
1568
1569
  * Sets a new value for property {@link #getWidth width}.
@@ -1589,12 +1590,18 @@ declare module "sap/ui/unified/Calendar" {
1589
1590
  */
1590
1591
  export interface $CalendarSettings extends $ControlSettings {
1591
1592
  /**
1592
- * If set, interval selection is allowed
1593
+ * Determines if an interval of dates can be selected.
1594
+ *
1595
+ * **Note:** This property should be set to `false` if `singleSelection` is set to `false`, as selecting
1596
+ * multiple intervals is not supported.
1593
1597
  */
1594
1598
  intervalSelection?: boolean | PropertyBindingInfo | `{${string}}`;
1595
1599
 
1596
1600
  /**
1597
- * If set, only a single date or interval, if intervalSelection is enabled, can be selected
1601
+ * Determines if a single date or single interval, when `intervalSelection` is set to `true`, can be selected.
1602
+ *
1603
+ * **Note:** This property should be set to `true` if `intervalSelection` is set to `true`, as selecting
1604
+ * multiple intervals is not supported.
1598
1605
  */
1599
1606
  singleSelection?: boolean | PropertyBindingInfo | `{${string}}`;
1600
1607
 
@@ -4974,7 +4981,10 @@ declare module "sap/ui/unified/calendar/MonthPicker" {
4974
4981
  /**
4975
4982
  * Gets current value of property {@link #getIntervalSelection intervalSelection}.
4976
4983
  *
4977
- * If set, interval selection is allowed
4984
+ * Determines if an interval of dates can be selected.
4985
+ *
4986
+ * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
4987
+ * multiple intervals is not supported.
4978
4988
  *
4979
4989
  * Default value is `false`.
4980
4990
  *
@@ -5150,7 +5160,10 @@ declare module "sap/ui/unified/calendar/MonthPicker" {
5150
5160
  /**
5151
5161
  * Sets a new value for property {@link #getIntervalSelection intervalSelection}.
5152
5162
  *
5153
- * If set, interval selection is allowed
5163
+ * Determines if an interval of dates can be selected.
5164
+ *
5165
+ * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
5166
+ * multiple intervals is not supported.
5154
5167
  *
5155
5168
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5156
5169
  *
@@ -5273,7 +5286,10 @@ declare module "sap/ui/unified/calendar/MonthPicker" {
5273
5286
  months?: int | PropertyBindingInfo | `{${string}}`;
5274
5287
 
5275
5288
  /**
5276
- * If set, interval selection is allowed
5289
+ * Determines if an interval of dates can be selected.
5290
+ *
5291
+ * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
5292
+ * multiple intervals is not supported.
5277
5293
  *
5278
5294
  * @since 1.74
5279
5295
  */
@@ -7294,7 +7310,10 @@ declare module "sap/ui/unified/calendar/YearPicker" {
7294
7310
  /**
7295
7311
  * Gets current value of property {@link #getIntervalSelection intervalSelection}.
7296
7312
  *
7297
- * If set, interval selection is allowed
7313
+ * Determines if an interval of dates can be selected.
7314
+ *
7315
+ * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
7316
+ * multiple intervals is not supported.
7298
7317
  *
7299
7318
  * Default value is `false`.
7300
7319
  *
@@ -7461,7 +7480,10 @@ declare module "sap/ui/unified/calendar/YearPicker" {
7461
7480
  /**
7462
7481
  * Sets a new value for property {@link #getIntervalSelection intervalSelection}.
7463
7482
  *
7464
- * If set, interval selection is allowed
7483
+ * Determines if an interval of dates can be selected.
7484
+ *
7485
+ * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
7486
+ * multiple intervals is not supported.
7465
7487
  *
7466
7488
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7467
7489
  *
@@ -7552,7 +7574,10 @@ declare module "sap/ui/unified/calendar/YearPicker" {
7552
7574
  years?: int | PropertyBindingInfo | `{${string}}`;
7553
7575
 
7554
7576
  /**
7555
- * If set, interval selection is allowed
7577
+ * Determines if an interval of dates can be selected.
7578
+ *
7579
+ * **Note:** This property should be set to `false` if `_singleSelection` is set to `false`, as selecting
7580
+ * multiple intervals is not supported.
7556
7581
  *
7557
7582
  * @since 1.74
7558
7583
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.1
1
+ // For Library Version: 1.135.0
2
2
 
3
3
  declare module "sap/ui/ux3/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.1
1
+ // For Library Version: 1.135.0
2
2
 
3
3
  declare module "sap/ui/webc/common/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.1
1
+ // For Library Version: 1.135.0
2
2
 
3
3
  declare module "sap/ui/webc/fiori/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.1
1
+ // For Library Version: 1.135.0
2
2
 
3
3
  declare module "sap/ui/webc/main/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.1
1
+ // For Library Version: 1.135.0
2
2
 
3
3
  declare module "sap/uxap/library" {
4
4
  /**
@@ -7144,6 +7144,9 @@ declare module "sap/uxap/ObjectPageSection" {
7144
7144
  * Gets content of aggregation {@link #getSubSections subSections}.
7145
7145
  *
7146
7146
  * The list of Subsections.
7147
+ *
7148
+ * Note: If multiple subsections are used, it is highly recommended to set a title for the section for accessibility
7149
+ * reasons.
7147
7150
  */
7148
7151
  getSubSections(): ObjectPageSubSection[];
7149
7152
  /**
@@ -7355,6 +7358,9 @@ declare module "sap/uxap/ObjectPageSection" {
7355
7358
 
7356
7359
  /**
7357
7360
  * The list of Subsections.
7361
+ *
7362
+ * Note: If multiple subsections are used, it is highly recommended to set a title for the section for accessibility
7363
+ * reasons.
7358
7364
  */
7359
7365
  subSections?:
7360
7366
  | ObjectPageSubSection[]
@@ -7481,6 +7487,15 @@ declare module "sap/uxap/ObjectPageSectionBase" {
7481
7487
  * If you want to change some of the button properties, you would need to bind them to a model.
7482
7488
  */
7483
7489
  getCustomAnchorBarButton(): Button;
7490
+ /**
7491
+ * Returns the effectively applied title level. Could be different than "titleLevel" property, according
7492
+ * to internal UX rules.
7493
+ *
7494
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7495
+ *
7496
+ * @returns the effective title level
7497
+ */
7498
+ getEffectiveTitleLevel(): string;
7484
7499
  /**
7485
7500
  * Gets current value of property {@link #getImportance importance}.
7486
7501
  *