@openui5/types 1.120.7 → 1.121.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.120.7
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  import Control from "sap/ui/core/Control";
@@ -6,12 +6,12 @@ declare module "sap/ui/rta/api/startAdaptation" {
6
6
  import UIComponent from "sap/ui/core/UIComponent";
7
7
 
8
8
  /**
9
- * @since 1.83
10
- *
11
9
  * Starts UI adaptation, initiated for an application at the passed root control instance. With this API
12
10
  * you are also able to modify the UI adaptation plugins list and or add some event handler functions to
13
11
  * be called on start, failed and stop events.
14
12
  *
13
+ * @since 1.83
14
+ *
15
15
  * @returns Resolves when UI adaptation was successfully started
16
16
  */
17
17
  export default function startAdaptation(
@@ -63,11 +63,11 @@ declare module "sap/ui/rta/api/startKeyUserAdaptation" {
63
63
  import UIComponent from "sap/ui/core/UIComponent";
64
64
 
65
65
  /**
66
- * @since 1.71
67
- *
68
66
  * Starts key user adaptation, initiated for an application at the passed root control instance. It subsequently
69
67
  * extends to all valid child controls.
70
68
  *
69
+ * @since 1.71
70
+ *
71
71
  * @returns Resolves when UI adaptation was successfully started
72
72
  */
73
73
  export default function startKeyUserAdaptation(
@@ -85,9 +85,9 @@ declare module "sap/ui/rta/api/startKeyUserAdaptation" {
85
85
 
86
86
  declare module "sap/ui/rta/enablement/TestDelegate" {
87
87
  /**
88
- * @since 1.77
89
- *
90
88
  * sap.ui.fl Delegate to be used in elementActionTests.
89
+ *
90
+ * @since 1.77
91
91
  */
92
92
  interface TestDelegate {}
93
93
  const TestDelegate: TestDelegate;
@@ -1,8 +1,10 @@
1
- // For Library Version: 1.120.7
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare module "sap/ui/suite/library" {
4
4
  /**
5
5
  * Defined color values for the Task Circle Control
6
+ *
7
+ * This enum is part of the 'sap/ui/suite/library' module export and must be accessed by the property 'TaskCircleColor'.
6
8
  */
7
9
  export enum TaskCircleColor {
8
10
  /**
@@ -38,11 +40,11 @@ declare module "sap/ui/suite/TaskCircle" {
38
40
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
39
41
 
40
42
  /**
43
+ * This control shows a circle which radius and color depends on the given parameters
44
+ *
41
45
  * @deprecated (since 1.108) - there's no replacement for this functionality as no active use cases are
42
46
  * known
43
47
  * @experimental (since 1.2) - The API may change. Use with care.
44
- *
45
- * This control shows a circle which radius and color depends on the given parameters
46
48
  */
47
49
  export default class TaskCircle extends Control {
48
50
  /**
@@ -82,6 +84,7 @@ declare module "sap/ui/suite/TaskCircle" {
82
84
  *
83
85
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
84
86
  *
87
+ *
85
88
  * @returns Created class / constructor function
86
89
  */
87
90
  static extend<T extends Record<string, unknown>>(
@@ -102,12 +105,14 @@ declare module "sap/ui/suite/TaskCircle" {
102
105
  /**
103
106
  * Returns a metadata object for class sap.ui.suite.TaskCircle.
104
107
  *
108
+ *
105
109
  * @returns Metadata object describing this class
106
110
  */
107
111
  static getMetadata(): ElementMetadata;
108
112
  /**
109
113
  * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
110
114
  *
115
+ *
111
116
  * @returns Reference to `this` in order to allow method chaining
112
117
  */
113
118
  addAriaDescribedBy(
@@ -119,6 +124,7 @@ declare module "sap/ui/suite/TaskCircle" {
119
124
  /**
120
125
  * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
121
126
  *
127
+ *
122
128
  * @returns Reference to `this` in order to allow method chaining
123
129
  */
124
130
  addAriaLabelledBy(
@@ -135,6 +141,7 @@ declare module "sap/ui/suite/TaskCircle" {
135
141
  *
136
142
  * Event is fired when the user clicks the control.
137
143
  *
144
+ *
138
145
  * @returns Reference to `this` in order to allow method chaining
139
146
  */
140
147
  attachPress(
@@ -160,6 +167,7 @@ declare module "sap/ui/suite/TaskCircle" {
160
167
  *
161
168
  * Event is fired when the user clicks the control.
162
169
  *
170
+ *
163
171
  * @returns Reference to `this` in order to allow method chaining
164
172
  */
165
173
  attachPress(
@@ -177,6 +185,7 @@ declare module "sap/ui/suite/TaskCircle" {
177
185
  *
178
186
  * The passed function and listener object must match the ones used for event registration.
179
187
  *
188
+ *
180
189
  * @returns Reference to `this` in order to allow method chaining
181
190
  */
182
191
  detachPress(
@@ -190,10 +199,10 @@ declare module "sap/ui/suite/TaskCircle" {
190
199
  oListener?: object
191
200
  ): this;
192
201
  /**
193
- * @ui5-protected Do not call from applications (only from related classes in the framework)
194
- *
195
202
  * Fires event {@link #event:press press} to attached listeners.
196
203
  *
204
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
205
+ *
197
206
  * @returns Reference to `this` in order to allow method chaining
198
207
  */
199
208
  firePress(
@@ -221,6 +230,7 @@ declare module "sap/ui/suite/TaskCircle" {
221
230
  *
222
231
  * Default value is `Gray`.
223
232
  *
233
+ *
224
234
  * @returns Value of property `color`
225
235
  */
226
236
  getColor(): TaskCircleColor | keyof typeof TaskCircleColor;
@@ -231,6 +241,7 @@ declare module "sap/ui/suite/TaskCircle" {
231
241
  *
232
242
  * Default value is `100`.
233
243
  *
244
+ *
234
245
  * @returns Value of property `maxValue`
235
246
  */
236
247
  getMaxValue(): int;
@@ -241,6 +252,7 @@ declare module "sap/ui/suite/TaskCircle" {
241
252
  *
242
253
  * Default value is `0`.
243
254
  *
255
+ *
244
256
  * @returns Value of property `minValue`
245
257
  */
246
258
  getMinValue(): int;
@@ -252,24 +264,28 @@ declare module "sap/ui/suite/TaskCircle" {
252
264
  *
253
265
  * Default value is `0`.
254
266
  *
267
+ *
255
268
  * @returns Value of property `value`
256
269
  */
257
270
  getValue(): int;
258
271
  /**
259
272
  * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
260
273
  *
274
+ *
261
275
  * @returns An array of the removed elements (might be empty)
262
276
  */
263
277
  removeAllAriaDescribedBy(): ID[];
264
278
  /**
265
279
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
266
280
  *
281
+ *
267
282
  * @returns An array of the removed elements (might be empty)
268
283
  */
269
284
  removeAllAriaLabelledBy(): ID[];
270
285
  /**
271
286
  * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
272
287
  *
288
+ *
273
289
  * @returns The removed ariaDescribedBy or `null`
274
290
  */
275
291
  removeAriaDescribedBy(
@@ -281,6 +297,7 @@ declare module "sap/ui/suite/TaskCircle" {
281
297
  /**
282
298
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
283
299
  *
300
+ *
284
301
  * @returns The removed ariaLabelledBy or `null`
285
302
  */
286
303
  removeAriaLabelledBy(
@@ -298,6 +315,7 @@ declare module "sap/ui/suite/TaskCircle" {
298
315
  *
299
316
  * Default value is `Gray`.
300
317
  *
318
+ *
301
319
  * @returns Reference to `this` in order to allow method chaining
302
320
  */
303
321
  setColor(
@@ -315,6 +333,7 @@ declare module "sap/ui/suite/TaskCircle" {
315
333
  *
316
334
  * Default value is `100`.
317
335
  *
336
+ *
318
337
  * @returns Reference to `this` in order to allow method chaining
319
338
  */
320
339
  setMaxValue(
@@ -332,6 +351,7 @@ declare module "sap/ui/suite/TaskCircle" {
332
351
  *
333
352
  * Default value is `0`.
334
353
  *
354
+ *
335
355
  * @returns Reference to `this` in order to allow method chaining
336
356
  */
337
357
  setMinValue(
@@ -350,6 +370,7 @@ declare module "sap/ui/suite/TaskCircle" {
350
370
  *
351
371
  * Default value is `0`.
352
372
  *
373
+ *
353
374
  * @returns Reference to `this` in order to allow method chaining
354
375
  */
355
376
  setValue(
@@ -421,12 +442,12 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
421
442
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
422
443
 
423
444
  /**
445
+ * This control shows a vertical progress bar in dependency of the given percentage. Only values between
446
+ * 0 and 100 are valid.
447
+ *
424
448
  * @deprecated (since 1.108) - there's no replacement for this functionality as no active use cases are
425
449
  * known
426
450
  * @experimental (since 1.2) - The API may change. Use with care.
427
- *
428
- * This control shows a vertical progress bar in dependency of the given percentage. Only values between
429
- * 0 and 100 are valid.
430
451
  */
431
452
  export default class VerticalProgressIndicator extends Control {
432
453
  /**
@@ -466,6 +487,7 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
466
487
  *
467
488
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
468
489
  *
490
+ *
469
491
  * @returns Created class / constructor function
470
492
  */
471
493
  static extend<T extends Record<string, unknown>>(
@@ -486,12 +508,14 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
486
508
  /**
487
509
  * Returns a metadata object for class sap.ui.suite.VerticalProgressIndicator.
488
510
  *
511
+ *
489
512
  * @returns Metadata object describing this class
490
513
  */
491
514
  static getMetadata(): ElementMetadata;
492
515
  /**
493
516
  * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
494
517
  *
518
+ *
495
519
  * @returns Reference to `this` in order to allow method chaining
496
520
  */
497
521
  addAriaDescribedBy(
@@ -503,6 +527,7 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
503
527
  /**
504
528
  * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
505
529
  *
530
+ *
506
531
  * @returns Reference to `this` in order to allow method chaining
507
532
  */
508
533
  addAriaLabelledBy(
@@ -519,6 +544,7 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
519
544
  *
520
545
  * Event is fired when the user clicks the control.
521
546
  *
547
+ *
522
548
  * @returns Reference to `this` in order to allow method chaining
523
549
  */
524
550
  attachPress(
@@ -545,6 +571,7 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
545
571
  *
546
572
  * Event is fired when the user clicks the control.
547
573
  *
574
+ *
548
575
  * @returns Reference to `this` in order to allow method chaining
549
576
  */
550
577
  attachPress(
@@ -563,6 +590,7 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
563
590
  *
564
591
  * The passed function and listener object must match the ones used for event registration.
565
592
  *
593
+ *
566
594
  * @returns Reference to `this` in order to allow method chaining
567
595
  */
568
596
  detachPress(
@@ -576,10 +604,10 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
576
604
  oListener?: object
577
605
  ): this;
578
606
  /**
579
- * @ui5-protected Do not call from applications (only from related classes in the framework)
580
- *
581
607
  * Fires event {@link #event:press press} to attached listeners.
582
608
  *
609
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
610
+ *
583
611
  * @returns Reference to `this` in order to allow method chaining
584
612
  */
585
613
  firePress(
@@ -606,24 +634,28 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
606
634
  * The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher
607
635
  * than 100 will be displayed as 100%, values lower than zero will be displayed as 0%.
608
636
  *
637
+ *
609
638
  * @returns Value of property `percentage`
610
639
  */
611
640
  getPercentage(): int;
612
641
  /**
613
642
  * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
614
643
  *
644
+ *
615
645
  * @returns An array of the removed elements (might be empty)
616
646
  */
617
647
  removeAllAriaDescribedBy(): ID[];
618
648
  /**
619
649
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
620
650
  *
651
+ *
621
652
  * @returns An array of the removed elements (might be empty)
622
653
  */
623
654
  removeAllAriaLabelledBy(): ID[];
624
655
  /**
625
656
  * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
626
657
  *
658
+ *
627
659
  * @returns The removed ariaDescribedBy or `null`
628
660
  */
629
661
  removeAriaDescribedBy(
@@ -635,6 +667,7 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
635
667
  /**
636
668
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
637
669
  *
670
+ *
638
671
  * @returns The removed ariaLabelledBy or `null`
639
672
  */
640
673
  removeAriaLabelledBy(
@@ -648,6 +681,7 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
648
681
  * 100 will be displayed as 100%, values lower than zero will be displayed as 0%. A new rendering is not
649
682
  * necessary, only the bar will be moved
650
683
  *
684
+ *
651
685
  * @returns `this` to allow method chaining
652
686
  */
653
687
  setPercentage(iPercentage: int): this;
@@ -1,10 +1,13 @@
1
- // For Library Version: 1.120.7
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare module "sap/ui/support/library" {
4
4
  /**
5
- * @since 1.50
6
- *
7
5
  * Defines the Audiences.
6
+ *
7
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
8
+ * 'Audiences'.
9
+ *
10
+ * @since 1.50
8
11
  */
9
12
  export enum Audiences {
10
13
  /**
@@ -21,9 +24,12 @@ declare module "sap/ui/support/library" {
21
24
  Internal = "Internal",
22
25
  }
23
26
  /**
24
- * @since 1.50
25
- *
26
27
  * Issue Categories.
28
+ *
29
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
30
+ * 'Categories'.
31
+ *
32
+ * @since 1.50
27
33
  */
28
34
  export enum Categories {
29
35
  /**
@@ -43,9 +49,9 @@ declare module "sap/ui/support/library" {
43
49
  */
44
50
  DataModel = "DataModel",
45
51
  /**
46
- * @since 1.58
47
- *
48
52
  * Fiori Guidelines issue category.
53
+ *
54
+ * @since 1.58
49
55
  */
50
56
  FioriGuidelines = "FioriGuidelines",
51
57
  /**
@@ -57,9 +63,9 @@ declare module "sap/ui/support/library" {
57
63
  */
58
64
  Memory = "Memory",
59
65
  /**
60
- * @since 1.60
61
- *
62
66
  * Modularization issue category.
67
+ *
68
+ * @since 1.60
63
69
  */
64
70
  Modularization = "Modularization",
65
71
  /**
@@ -80,9 +86,12 @@ declare module "sap/ui/support/library" {
80
86
  Usage = "Usage",
81
87
  }
82
88
  /**
83
- * @since 1.58
84
- *
85
89
  * Analysis history formats.
90
+ *
91
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
92
+ * 'HistoryFormats'.
93
+ *
94
+ * @since 1.58
86
95
  */
87
96
  export enum HistoryFormats {
88
97
  /**
@@ -120,9 +129,12 @@ declare module "sap/ui/support/library" {
120
129
  };
121
130
 
122
131
  /**
123
- * @since 1.50
124
- *
125
132
  * Defines severity types.
133
+ *
134
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
135
+ * 'Severity'.
136
+ *
137
+ * @since 1.50
126
138
  */
127
139
  export enum Severity {
128
140
  /**
@@ -139,9 +151,12 @@ declare module "sap/ui/support/library" {
139
151
  Medium = "Medium",
140
152
  }
141
153
  /**
142
- * @since 1.60
143
- *
144
154
  * Contains the available system presets.
155
+ *
156
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
157
+ * 'SystemPresets'.
158
+ *
159
+ * @since 1.60
145
160
  */
146
161
  export enum SystemPresets {
147
162
  /**
@@ -149,9 +164,9 @@ declare module "sap/ui/support/library" {
149
164
  */
150
165
  Accessibility = "undefined",
151
166
  /**
152
- * @experimental (since 1.120)
153
- *
154
167
  * Preset to find usages of deprecated controls, properties, aggregations and others.
168
+ *
169
+ * @experimental (since 1.120)
155
170
  */
156
171
  Deprecations = "undefined",
157
172
  }
@@ -195,8 +210,6 @@ declare module "sap/ui/support/supportRules/History" {
195
210
 
196
211
  declare module "sap/ui/support/supportRules/ExecutionScope" {
197
212
  /**
198
- * @since 1.48
199
- *
200
213
  * Allows to select the scope of analysis on an application.
201
214
  *
202
215
  * Overview:
@@ -209,9 +222,14 @@ declare module "sap/ui/support/supportRules/ExecutionScope" {
209
222
  *
210
223
  * When you analyze your application, available objects are collected depending on the settings passed to
211
224
  * the Support Assistant at the moment when you start it.
225
+ *
226
+ * @since 1.48
212
227
  */
213
228
  export default class ExecutionScope {
214
- constructor();
229
+ /**
230
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
231
+ */
232
+ protected constructor();
215
233
 
216
234
  /**
217
235
  *
@@ -239,6 +257,7 @@ declare module "sap/ui/support/supportRules/ExecutionScope" {
239
257
  /**
240
258
  * Gets elements by their type
241
259
  *
260
+ *
242
261
  * @returns Array of matched elements
243
262
  */
244
263
  getElementsByClassName(
@@ -250,6 +269,7 @@ declare module "sap/ui/support/supportRules/ExecutionScope" {
250
269
  /**
251
270
  * Gets the logged objects by object type
252
271
  *
272
+ *
253
273
  * @returns Array of logged objects
254
274
  */
255
275
  getLoggedObjects(
@@ -261,12 +281,14 @@ declare module "sap/ui/support/supportRules/ExecutionScope" {
261
281
  /**
262
282
  * Returns all public elements, i.e. elements that are part of public API aggregations
263
283
  *
284
+ *
264
285
  * @returns Array of matched elements
265
286
  */
266
287
  getPublicElements(): any[];
267
288
  /**
268
289
  * Gets the type of the execution scope
269
290
  *
291
+ *
270
292
  * @returns The type of the execution scope. Possible values are `global`, `subtree` or `components`.
271
293
  */
272
294
  getType(): string;
@@ -296,10 +318,10 @@ declare module "sap/ui/support/RuleAnalyzer" {
296
318
  */
297
319
  interface RuleAnalyzer {
298
320
  /**
299
- * @since 1.60
300
- *
301
321
  * Adds new temporary rule when in silent mode
302
322
  *
323
+ * @since 1.60
324
+ *
303
325
  * @returns Rule creation status. Possible values are "success" or description of why adding failed.
304
326
  */
305
327
  addRule(
@@ -314,6 +336,7 @@ declare module "sap/ui/support/RuleAnalyzer" {
314
336
  * Allows to choose a particular execution scope - desired part of the UI to be checked and a flexible way
315
337
  * to specify the list of rules to be used.
316
338
  *
339
+ *
317
340
  * @returns Notifies the finished state by starting the Analyzer
318
341
  */
319
342
  analyze(
@@ -350,6 +373,7 @@ declare module "sap/ui/support/RuleAnalyzer" {
350
373
  /**
351
374
  * Returns the history of all executed analyses.
352
375
  *
376
+ *
353
377
  * @returns Array of history objects in the order of analyses performed. The results of the last analysis
354
378
  * are contained in the last element in the array.
355
379
  */
@@ -357,6 +381,7 @@ declare module "sap/ui/support/RuleAnalyzer" {
357
381
  /**
358
382
  * Returns the history of all executed analyses into formatted output depending on the passed format.
359
383
  *
384
+ *
360
385
  * @returns All analysis history objects in the correct format.
361
386
  */
362
387
  getFormattedAnalysisHistory(
@@ -368,6 +393,7 @@ declare module "sap/ui/support/RuleAnalyzer" {
368
393
  /**
369
394
  * Returns the result of the last analysis performed.
370
395
  *
396
+ *
371
397
  * @returns Last analysis history.
372
398
  */
373
399
  getLastAnalysisHistory(): AnalysisResult;
@@ -379,12 +405,12 @@ declare module "sap/ui/support/RuleAnalyzer" {
379
405
  declare namespace sap {
380
406
  namespace ui {
381
407
  /**
382
- * @since 1.50
383
- *
384
408
  * UI5 library: sap.ui.support. A library for the Support Assistant tool. Overview: The library provides
385
409
  * the Support Assistant tool. It enables application developers to check whether their applications are
386
410
  * built according to the best practices for building SAPUI5 apps. The tool uses a set of pre-defined rules
387
411
  * to check all aspects of an application.
412
+ *
413
+ * @since 1.50
388
414
  */
389
415
  namespace support {
390
416
  /**
@@ -394,7 +420,10 @@ declare namespace sap {
394
420
  * Usage: The CoreFacade is passed as second argument to all rule check functions.
395
421
  */
396
422
  class CoreFacade {
397
- constructor();
423
+ /**
424
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
425
+ */
426
+ protected constructor();
398
427
 
399
428
  /**
400
429
  * Gets the Components from the Core object.
@@ -419,7 +448,10 @@ declare namespace sap {
419
448
  * Usage: The IssueManagerFacade is passed as first argument to all rule check functions.
420
449
  */
421
450
  class IssueManagerFacade {
422
- constructor();
451
+ /**
452
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
453
+ */
454
+ protected constructor();
423
455
 
424
456
  /**
425
457
  * Adds issue