@openui5/ts-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,13 +1,13 @@
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
  /**
5
- * @since 1.83
6
- *
7
5
  * Starts UI adaptation, initiated for an application at the passed root control instance. With this API
8
6
  * you are also able to modify the UI adaptation plugins list and or add some event handler functions to
9
7
  * be called on start, failed and stop events.
10
8
  *
9
+ * @since 1.83
10
+ *
11
11
  * @returns Resolves when UI adaptation was successfully started
12
12
  */
13
13
  export default function startAdaptation(
@@ -55,11 +55,11 @@ declare module "sap/ui/rta/api/startAdaptation" {
55
55
 
56
56
  declare module "sap/ui/rta/api/startKeyUserAdaptation" {
57
57
  /**
58
- * @since 1.71
59
- *
60
58
  * Starts key user adaptation, initiated for an application at the passed root control instance. It subsequently
61
59
  * extends to all valid child controls.
62
60
  *
61
+ * @since 1.71
62
+ *
63
63
  * @returns Resolves when UI adaptation was successfully started
64
64
  */
65
65
  export default function startKeyUserAdaptation(
@@ -80,9 +80,9 @@ declare namespace sap {
80
80
  namespace rta {
81
81
  namespace enablement {
82
82
  /**
83
- * @since 1.77
84
- *
85
83
  * sap.ui.fl Delegate to be used in elementActionTests.
84
+ *
85
+ * @since 1.77
86
86
  */
87
87
  interface TestDelegate {}
88
88
  }
@@ -1,12 +1,12 @@
1
- // For Library Version: 1.120.7
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
5
5
  /**
6
+ * Suite controls library.
7
+ *
6
8
  * @since 1.1
7
9
  * @deprecated (since 1.108)
8
- *
9
- * Suite controls library.
10
10
  */
11
11
  namespace suite {
12
12
  interface $TaskCircleSettings extends sap.ui.core.$ControlSettings {
@@ -91,11 +91,11 @@ declare namespace sap {
91
91
  interface VerticalProgressIndicator$PressEventParameters {}
92
92
 
93
93
  /**
94
+ * This control shows a circle which radius and color depends on the given parameters
95
+ *
94
96
  * @deprecated (since 1.108) - there's no replacement for this functionality as no active use cases are
95
97
  * known
96
98
  * @experimental (since 1.2) - The API may change. Use with care.
97
- *
98
- * This control shows a circle which radius and color depends on the given parameters
99
99
  */
100
100
  class TaskCircle extends sap.ui.core.Control {
101
101
  /**
@@ -135,6 +135,7 @@ declare namespace sap {
135
135
  *
136
136
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
137
137
  *
138
+ *
138
139
  * @returns Created class / constructor function
139
140
  */
140
141
  static extend<T extends Record<string, unknown>>(
@@ -155,12 +156,14 @@ declare namespace sap {
155
156
  /**
156
157
  * Returns a metadata object for class sap.ui.suite.TaskCircle.
157
158
  *
159
+ *
158
160
  * @returns Metadata object describing this class
159
161
  */
160
162
  static getMetadata(): sap.ui.core.ElementMetadata;
161
163
  /**
162
164
  * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
163
165
  *
166
+ *
164
167
  * @returns Reference to `this` in order to allow method chaining
165
168
  */
166
169
  addAriaDescribedBy(
@@ -172,6 +175,7 @@ declare namespace sap {
172
175
  /**
173
176
  * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
174
177
  *
178
+ *
175
179
  * @returns Reference to `this` in order to allow method chaining
176
180
  */
177
181
  addAriaLabelledBy(
@@ -188,6 +192,7 @@ declare namespace sap {
188
192
  *
189
193
  * Event is fired when the user clicks the control.
190
194
  *
195
+ *
191
196
  * @returns Reference to `this` in order to allow method chaining
192
197
  */
193
198
  attachPress(
@@ -213,6 +218,7 @@ declare namespace sap {
213
218
  *
214
219
  * Event is fired when the user clicks the control.
215
220
  *
221
+ *
216
222
  * @returns Reference to `this` in order to allow method chaining
217
223
  */
218
224
  attachPress(
@@ -230,6 +236,7 @@ declare namespace sap {
230
236
  *
231
237
  * The passed function and listener object must match the ones used for event registration.
232
238
  *
239
+ *
233
240
  * @returns Reference to `this` in order to allow method chaining
234
241
  */
235
242
  detachPress(
@@ -243,10 +250,10 @@ declare namespace sap {
243
250
  oListener?: object
244
251
  ): this;
245
252
  /**
246
- * @ui5-protected Do not call from applications (only from related classes in the framework)
247
- *
248
253
  * Fires event {@link #event:press press} to attached listeners.
249
254
  *
255
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
256
+ *
250
257
  * @returns Reference to `this` in order to allow method chaining
251
258
  */
252
259
  firePress(
@@ -274,6 +281,7 @@ declare namespace sap {
274
281
  *
275
282
  * Default value is `Gray`.
276
283
  *
284
+ *
277
285
  * @returns Value of property `color`
278
286
  */
279
287
  getColor(): sap.ui.suite.TaskCircleColor;
@@ -284,6 +292,7 @@ declare namespace sap {
284
292
  *
285
293
  * Default value is `100`.
286
294
  *
295
+ *
287
296
  * @returns Value of property `maxValue`
288
297
  */
289
298
  getMaxValue(): int;
@@ -294,6 +303,7 @@ declare namespace sap {
294
303
  *
295
304
  * Default value is `0`.
296
305
  *
306
+ *
297
307
  * @returns Value of property `minValue`
298
308
  */
299
309
  getMinValue(): int;
@@ -305,24 +315,28 @@ declare namespace sap {
305
315
  *
306
316
  * Default value is `0`.
307
317
  *
318
+ *
308
319
  * @returns Value of property `value`
309
320
  */
310
321
  getValue(): int;
311
322
  /**
312
323
  * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
313
324
  *
325
+ *
314
326
  * @returns An array of the removed elements (might be empty)
315
327
  */
316
328
  removeAllAriaDescribedBy(): sap.ui.core.ID[];
317
329
  /**
318
330
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
319
331
  *
332
+ *
320
333
  * @returns An array of the removed elements (might be empty)
321
334
  */
322
335
  removeAllAriaLabelledBy(): sap.ui.core.ID[];
323
336
  /**
324
337
  * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
325
338
  *
339
+ *
326
340
  * @returns The removed ariaDescribedBy or `null`
327
341
  */
328
342
  removeAriaDescribedBy(
@@ -334,6 +348,7 @@ declare namespace sap {
334
348
  /**
335
349
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
336
350
  *
351
+ *
337
352
  * @returns The removed ariaLabelledBy or `null`
338
353
  */
339
354
  removeAriaLabelledBy(
@@ -351,6 +366,7 @@ declare namespace sap {
351
366
  *
352
367
  * Default value is `Gray`.
353
368
  *
369
+ *
354
370
  * @returns Reference to `this` in order to allow method chaining
355
371
  */
356
372
  setColor(
@@ -368,6 +384,7 @@ declare namespace sap {
368
384
  *
369
385
  * Default value is `100`.
370
386
  *
387
+ *
371
388
  * @returns Reference to `this` in order to allow method chaining
372
389
  */
373
390
  setMaxValue(
@@ -385,6 +402,7 @@ declare namespace sap {
385
402
  *
386
403
  * Default value is `0`.
387
404
  *
405
+ *
388
406
  * @returns Reference to `this` in order to allow method chaining
389
407
  */
390
408
  setMinValue(
@@ -403,6 +421,7 @@ declare namespace sap {
403
421
  *
404
422
  * Default value is `0`.
405
423
  *
424
+ *
406
425
  * @returns Reference to `this` in order to allow method chaining
407
426
  */
408
427
  setValue(
@@ -413,12 +432,12 @@ declare namespace sap {
413
432
  ): this;
414
433
  }
415
434
  /**
435
+ * This control shows a vertical progress bar in dependency of the given percentage. Only values between
436
+ * 0 and 100 are valid.
437
+ *
416
438
  * @deprecated (since 1.108) - there's no replacement for this functionality as no active use cases are
417
439
  * known
418
440
  * @experimental (since 1.2) - The API may change. Use with care.
419
- *
420
- * This control shows a vertical progress bar in dependency of the given percentage. Only values between
421
- * 0 and 100 are valid.
422
441
  */
423
442
  class VerticalProgressIndicator extends sap.ui.core.Control {
424
443
  /**
@@ -458,6 +477,7 @@ declare namespace sap {
458
477
  *
459
478
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
460
479
  *
480
+ *
461
481
  * @returns Created class / constructor function
462
482
  */
463
483
  static extend<T extends Record<string, unknown>>(
@@ -478,12 +498,14 @@ declare namespace sap {
478
498
  /**
479
499
  * Returns a metadata object for class sap.ui.suite.VerticalProgressIndicator.
480
500
  *
501
+ *
481
502
  * @returns Metadata object describing this class
482
503
  */
483
504
  static getMetadata(): sap.ui.core.ElementMetadata;
484
505
  /**
485
506
  * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
486
507
  *
508
+ *
487
509
  * @returns Reference to `this` in order to allow method chaining
488
510
  */
489
511
  addAriaDescribedBy(
@@ -495,6 +517,7 @@ declare namespace sap {
495
517
  /**
496
518
  * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
497
519
  *
520
+ *
498
521
  * @returns Reference to `this` in order to allow method chaining
499
522
  */
500
523
  addAriaLabelledBy(
@@ -511,6 +534,7 @@ declare namespace sap {
511
534
  *
512
535
  * Event is fired when the user clicks the control.
513
536
  *
537
+ *
514
538
  * @returns Reference to `this` in order to allow method chaining
515
539
  */
516
540
  attachPress(
@@ -537,6 +561,7 @@ declare namespace sap {
537
561
  *
538
562
  * Event is fired when the user clicks the control.
539
563
  *
564
+ *
540
565
  * @returns Reference to `this` in order to allow method chaining
541
566
  */
542
567
  attachPress(
@@ -555,6 +580,7 @@ declare namespace sap {
555
580
  *
556
581
  * The passed function and listener object must match the ones used for event registration.
557
582
  *
583
+ *
558
584
  * @returns Reference to `this` in order to allow method chaining
559
585
  */
560
586
  detachPress(
@@ -568,10 +594,10 @@ declare namespace sap {
568
594
  oListener?: object
569
595
  ): this;
570
596
  /**
571
- * @ui5-protected Do not call from applications (only from related classes in the framework)
572
- *
573
597
  * Fires event {@link #event:press press} to attached listeners.
574
598
  *
599
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
600
+ *
575
601
  * @returns Reference to `this` in order to allow method chaining
576
602
  */
577
603
  firePress(
@@ -598,24 +624,28 @@ declare namespace sap {
598
624
  * The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher
599
625
  * than 100 will be displayed as 100%, values lower than zero will be displayed as 0%.
600
626
  *
627
+ *
601
628
  * @returns Value of property `percentage`
602
629
  */
603
630
  getPercentage(): int;
604
631
  /**
605
632
  * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
606
633
  *
634
+ *
607
635
  * @returns An array of the removed elements (might be empty)
608
636
  */
609
637
  removeAllAriaDescribedBy(): sap.ui.core.ID[];
610
638
  /**
611
639
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
612
640
  *
641
+ *
613
642
  * @returns An array of the removed elements (might be empty)
614
643
  */
615
644
  removeAllAriaLabelledBy(): sap.ui.core.ID[];
616
645
  /**
617
646
  * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
618
647
  *
648
+ *
619
649
  * @returns The removed ariaDescribedBy or `null`
620
650
  */
621
651
  removeAriaDescribedBy(
@@ -627,6 +657,7 @@ declare namespace sap {
627
657
  /**
628
658
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
629
659
  *
660
+ *
630
661
  * @returns The removed ariaLabelledBy or `null`
631
662
  */
632
663
  removeAriaLabelledBy(
@@ -640,12 +671,15 @@ declare namespace sap {
640
671
  * 100 will be displayed as 100%, values lower than zero will be displayed as 0%. A new rendering is not
641
672
  * necessary, only the bar will be moved
642
673
  *
674
+ *
643
675
  * @returns `this` to allow method chaining
644
676
  */
645
677
  setPercentage(iPercentage: int): this;
646
678
  }
647
679
  /**
648
680
  * Defined color values for the Task Circle Control
681
+ *
682
+ * This enum is part of the 'sap/ui/suite/library' module export and must be accessed by the property 'TaskCircleColor'.
649
683
  */
650
684
  enum TaskCircleColor {
651
685
  /**
@@ -1,14 +1,14 @@
1
- // For Library Version: 1.120.7
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
5
5
  /**
6
- * @since 1.50
7
- *
8
6
  * UI5 library: sap.ui.support. A library for the Support Assistant tool. Overview: The library provides
9
7
  * the Support Assistant tool. It enables application developers to check whether their applications are
10
8
  * built according to the best practices for building SAPUI5 apps. The tool uses a set of pre-defined rules
11
9
  * to check all aspects of an application.
10
+ *
11
+ * @since 1.50
12
12
  */
13
13
  namespace support {
14
14
  /**
@@ -29,10 +29,10 @@ declare namespace sap {
29
29
  */
30
30
  interface RuleAnalyzer {
31
31
  /**
32
- * @since 1.60
33
- *
34
32
  * Adds new temporary rule when in silent mode
35
33
  *
34
+ * @since 1.60
35
+ *
36
36
  * @returns Rule creation status. Possible values are "success" or description of why adding failed.
37
37
  */
38
38
  addRule(
@@ -47,6 +47,7 @@ declare namespace sap {
47
47
  * Allows to choose a particular execution scope - desired part of the UI to be checked and a flexible way
48
48
  * to specify the list of rules to be used.
49
49
  *
50
+ *
50
51
  * @returns Notifies the finished state by starting the Analyzer
51
52
  */
52
53
  analyze(
@@ -83,6 +84,7 @@ declare namespace sap {
83
84
  /**
84
85
  * Returns the history of all executed analyses.
85
86
  *
87
+ *
86
88
  * @returns Array of history objects in the order of analyses performed. The results of the last analysis
87
89
  * are contained in the last element in the array.
88
90
  */
@@ -90,6 +92,7 @@ declare namespace sap {
90
92
  /**
91
93
  * Returns the history of all executed analyses into formatted output depending on the passed format.
92
94
  *
95
+ *
93
96
  * @returns All analysis history objects in the correct format.
94
97
  */
95
98
  getFormattedAnalysisHistory(
@@ -101,6 +104,7 @@ declare namespace sap {
101
104
  /**
102
105
  * Returns the result of the last analysis performed.
103
106
  *
107
+ *
104
108
  * @returns Last analysis history.
105
109
  */
106
110
  getLastAnalysisHistory(): sap.ui.support.AnalysisResult;
@@ -113,7 +117,10 @@ declare namespace sap {
113
117
  * Usage: The CoreFacade is passed as second argument to all rule check functions.
114
118
  */
115
119
  class CoreFacade {
116
- constructor();
120
+ /**
121
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
122
+ */
123
+ protected constructor();
117
124
 
118
125
  /**
119
126
  * Gets the Components from the Core object.
@@ -133,8 +140,6 @@ declare namespace sap {
133
140
  getUIAreas(): void;
134
141
  }
135
142
  /**
136
- * @since 1.48
137
- *
138
143
  * Allows to select the scope of analysis on an application.
139
144
  *
140
145
  * Overview:
@@ -147,9 +152,14 @@ declare namespace sap {
147
152
  *
148
153
  * When you analyze your application, available objects are collected depending on the settings passed to
149
154
  * the Support Assistant at the moment when you start it.
155
+ *
156
+ * @since 1.48
150
157
  */
151
158
  class ExecutionScope {
152
- constructor();
159
+ /**
160
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
161
+ */
162
+ protected constructor();
153
163
 
154
164
  /**
155
165
  *
@@ -177,6 +187,7 @@ declare namespace sap {
177
187
  /**
178
188
  * Gets elements by their type
179
189
  *
190
+ *
180
191
  * @returns Array of matched elements
181
192
  */
182
193
  getElementsByClassName(
@@ -188,6 +199,7 @@ declare namespace sap {
188
199
  /**
189
200
  * Gets the logged objects by object type
190
201
  *
202
+ *
191
203
  * @returns Array of logged objects
192
204
  */
193
205
  getLoggedObjects(
@@ -199,12 +211,14 @@ declare namespace sap {
199
211
  /**
200
212
  * Returns all public elements, i.e. elements that are part of public API aggregations
201
213
  *
214
+ *
202
215
  * @returns Array of matched elements
203
216
  */
204
217
  getPublicElements(): any[];
205
218
  /**
206
219
  * Gets the type of the execution scope
207
220
  *
221
+ *
208
222
  * @returns The type of the execution scope. Possible values are `global`, `subtree` or `components`.
209
223
  */
210
224
  getType(): string;
@@ -215,7 +229,10 @@ declare namespace sap {
215
229
  * Usage: The IssueManagerFacade is passed as first argument to all rule check functions.
216
230
  */
217
231
  class IssueManagerFacade {
218
- constructor();
232
+ /**
233
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
234
+ */
235
+ protected constructor();
219
236
 
220
237
  /**
221
238
  * Adds issue
@@ -236,9 +253,12 @@ declare namespace sap {
236
253
  ): void;
237
254
  }
238
255
  /**
239
- * @since 1.50
240
- *
241
256
  * Defines the Audiences.
257
+ *
258
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
259
+ * 'Audiences'.
260
+ *
261
+ * @since 1.50
242
262
  */
243
263
  enum Audiences {
244
264
  /**
@@ -255,9 +275,12 @@ declare namespace sap {
255
275
  Internal = "Internal",
256
276
  }
257
277
  /**
258
- * @since 1.50
259
- *
260
278
  * Issue Categories.
279
+ *
280
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
281
+ * 'Categories'.
282
+ *
283
+ * @since 1.50
261
284
  */
262
285
  enum Categories {
263
286
  /**
@@ -277,9 +300,9 @@ declare namespace sap {
277
300
  */
278
301
  DataModel = "DataModel",
279
302
  /**
280
- * @since 1.58
281
- *
282
303
  * Fiori Guidelines issue category.
304
+ *
305
+ * @since 1.58
283
306
  */
284
307
  FioriGuidelines = "FioriGuidelines",
285
308
  /**
@@ -291,9 +314,9 @@ declare namespace sap {
291
314
  */
292
315
  Memory = "Memory",
293
316
  /**
294
- * @since 1.60
295
- *
296
317
  * Modularization issue category.
318
+ *
319
+ * @since 1.60
297
320
  */
298
321
  Modularization = "Modularization",
299
322
  /**
@@ -314,9 +337,12 @@ declare namespace sap {
314
337
  Usage = "Usage",
315
338
  }
316
339
  /**
317
- * @since 1.58
318
- *
319
340
  * Analysis history formats.
341
+ *
342
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
343
+ * 'HistoryFormats'.
344
+ *
345
+ * @since 1.58
320
346
  */
321
347
  enum HistoryFormats {
322
348
  /**
@@ -329,9 +355,12 @@ declare namespace sap {
329
355
  String = "String",
330
356
  }
331
357
  /**
332
- * @since 1.50
333
- *
334
358
  * Defines severity types.
359
+ *
360
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
361
+ * 'Severity'.
362
+ *
363
+ * @since 1.50
335
364
  */
336
365
  enum Severity {
337
366
  /**
@@ -348,9 +377,12 @@ declare namespace sap {
348
377
  Medium = "Medium",
349
378
  }
350
379
  /**
351
- * @since 1.60
352
- *
353
380
  * Contains the available system presets.
381
+ *
382
+ * This enum is part of the 'sap/ui/support/library' module export and must be accessed by the property
383
+ * 'SystemPresets'.
384
+ *
385
+ * @since 1.60
354
386
  */
355
387
  enum SystemPresets {
356
388
  /**
@@ -358,9 +390,9 @@ declare namespace sap {
358
390
  */
359
391
  Accessibility = "undefined",
360
392
  /**
361
- * @experimental (since 1.120)
362
- *
363
393
  * Preset to find usages of deprecated controls, properties, aggregations and others.
394
+ *
395
+ * @experimental (since 1.120)
364
396
  */
365
397
  Deprecations = "undefined",
366
398
  }