@openui5/types 1.120.6 → 1.120.8

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