@openui5/ts-types 1.99.1 → 1.102.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.99.1
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -36,7 +36,8 @@ declare namespace sap {
36
36
  */
37
37
  width?:
38
38
  | sap.ui.core.CSSSize
39
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
39
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
40
+ | `{${string}}`;
40
41
 
41
42
  /**
42
43
  * The height of the code editor. A minimal height of 3rem will be applied in case the height is less than
@@ -44,24 +45,32 @@ declare namespace sap {
44
45
  */
45
46
  height?:
46
47
  | sap.ui.core.CSSSize
47
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
48
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
49
+ | `{${string}}`;
48
50
 
49
51
  /**
50
52
  * Sets whether the code in the editor can be changed by the user.
51
53
  */
52
- editable?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
54
+ editable?:
55
+ | boolean
56
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
57
+ | `{${string}}`;
53
58
 
54
59
  /**
55
60
  * Sets whether line numbers should be shown.
56
61
  */
57
- lineNumbers?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
62
+ lineNumbers?:
63
+ | boolean
64
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
65
+ | `{${string}}`;
58
66
 
59
67
  /**
60
68
  * Sets whether the code is automatically selected if a value is set.
61
69
  */
62
70
  valueSelection?:
63
71
  | boolean
64
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
72
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
73
+ | `{${string}}`;
65
74
 
66
75
  /**
67
76
  * @SINCE 1.48.1
@@ -72,7 +81,10 @@ declare namespace sap {
72
81
  * **Note:** Keep in mind that the auto expand `CodeEditor` behavior requires the `height` property to be
73
82
  * set to `auto`.
74
83
  */
75
- maxLines?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
84
+ maxLines?:
85
+ | int
86
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
87
+ | `{${string}}`;
76
88
 
77
89
  /**
78
90
  * Sets the editor color theme. Possible values are: default, hcb, hcb_bright, hcb_blue, theme-ambiance,
@@ -86,7 +98,10 @@ declare namespace sap {
86
98
  /**
87
99
  * Sets whether to show syntax hints in the editor. This flag is only available if line numbers are shown.
88
100
  */
89
- syntaxHints?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
101
+ syntaxHints?:
102
+ | boolean
103
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
104
+ | `{${string}}`;
90
105
 
91
106
  /**
92
107
  * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
@@ -143,6 +158,8 @@ declare namespace sap {
143
158
  * the information contained in `oClassInfo`.
144
159
  *
145
160
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
161
+ *
162
+ * @returns Created class / constructor function
146
163
  */
147
164
  static extend<T extends Record<string, unknown>>(
148
165
  /**
@@ -161,6 +178,8 @@ declare namespace sap {
161
178
  ): Function;
162
179
  /**
163
180
  * Returns a metadata object for class sap.ui.codeeditor.CodeEditor.
181
+ *
182
+ * @returns Metadata object describing this class
164
183
  */
165
184
  static getMetadata(): sap.ui.core.ElementMetadata;
166
185
  /**
@@ -183,6 +202,8 @@ declare namespace sap {
183
202
  * otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
184
203
  *
185
204
  * Fired when the value has changed and the focus leaves the code editor.
205
+ *
206
+ * @returns Reference to `this` in order to allow method chaining
186
207
  */
187
208
  attachChange(
188
209
  /**
@@ -206,6 +227,8 @@ declare namespace sap {
206
227
  * otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
207
228
  *
208
229
  * Fired when the value has changed and the focus leaves the code editor.
230
+ *
231
+ * @returns Reference to `this` in order to allow method chaining
209
232
  */
210
233
  attachChange(
211
234
  /**
@@ -224,6 +247,8 @@ declare namespace sap {
224
247
  * otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
225
248
  *
226
249
  * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
250
+ *
251
+ * @returns Reference to `this` in order to allow method chaining
227
252
  */
228
253
  attachLiveChange(
229
254
  /**
@@ -247,6 +272,8 @@ declare namespace sap {
247
272
  * otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
248
273
  *
249
274
  * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
275
+ *
276
+ * @returns Reference to `this` in order to allow method chaining
250
277
  */
251
278
  attachLiveChange(
252
279
  /**
@@ -262,6 +289,8 @@ declare namespace sap {
262
289
  * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.codeeditor.CodeEditor`.
263
290
  *
264
291
  * The passed function and listener object must match the ones used for event registration.
292
+ *
293
+ * @returns Reference to `this` in order to allow method chaining
265
294
  */
266
295
  detachChange(
267
296
  /**
@@ -277,6 +306,8 @@ declare namespace sap {
277
306
  * Detaches event handler `fnFunction` from the {@link #event:liveChange liveChange} event of this `sap.ui.codeeditor.CodeEditor`.
278
307
  *
279
308
  * The passed function and listener object must match the ones used for event registration.
309
+ *
310
+ * @returns Reference to `this` in order to allow method chaining
280
311
  */
281
312
  detachLiveChange(
282
313
  /**
@@ -290,6 +321,8 @@ declare namespace sap {
290
321
  ): this;
291
322
  /**
292
323
  * Fires event {@link #event:change change} to attached listeners.
324
+ *
325
+ * @returns Reference to `this` in order to allow method chaining
293
326
  */
294
327
  fireChange(
295
328
  /**
@@ -308,6 +341,8 @@ declare namespace sap {
308
341
  ): this;
309
342
  /**
310
343
  * Fires event {@link #event:liveChange liveChange} to attached listeners.
344
+ *
345
+ * @returns Reference to `this` in order to allow method chaining
311
346
  */
312
347
  fireLiveChange(
313
348
  /**
@@ -326,6 +361,8 @@ declare namespace sap {
326
361
  ): this;
327
362
  /**
328
363
  * Sets the focus to the code editor
364
+ *
365
+ * @returns Returns `this` to allow method chaining
329
366
  */
330
367
  focus(): this;
331
368
  /**
@@ -338,10 +375,14 @@ declare namespace sap {
338
375
  * tomorrow_night_blue, tomorrow_night_bright, tomorrow_night_eighties, twilight, dracula vibrant_ink, xcode
339
376
  *
340
377
  * Default value is `"default"`.
378
+ *
379
+ * @returns Value of property `colorTheme`
341
380
  */
342
381
  getColorTheme(): string;
343
382
  /**
344
383
  * Returns the current value of the code editor
384
+ *
385
+ * @returns Returns the current value of the code editor
345
386
  */
346
387
  getCurrentValue(): string;
347
388
  /**
@@ -350,6 +391,8 @@ declare namespace sap {
350
391
  * Sets whether the code in the editor can be changed by the user.
351
392
  *
352
393
  * Default value is `true`.
394
+ *
395
+ * @returns Value of property `editable`
353
396
  */
354
397
  getEditable(): boolean;
355
398
  /**
@@ -359,12 +402,16 @@ declare namespace sap {
359
402
  * 20px.
360
403
  *
361
404
  * Default value is `"100%"`.
405
+ *
406
+ * @returns Value of property `height`
362
407
  */
363
408
  getHeight(): sap.ui.core.CSSSize;
364
409
  /**
365
410
  * Returns the DOMNode ID to be used for the "labelFor" attribute of the label.
366
411
  *
367
412
  * By default, this is the ID of the control itself.
413
+ *
414
+ * @returns ID to be used for the `labelFor`
368
415
  */
369
416
  getIdForLabel(): string;
370
417
  /**
@@ -373,6 +420,8 @@ declare namespace sap {
373
420
  * Sets whether line numbers should be shown.
374
421
  *
375
422
  * Default value is `true`.
423
+ *
424
+ * @returns Value of property `lineNumbers`
376
425
  */
377
426
  getLineNumbers(): boolean;
378
427
  /**
@@ -387,6 +436,8 @@ declare namespace sap {
387
436
  * set to `auto`.
388
437
  *
389
438
  * Default value is `0`.
439
+ *
440
+ * @returns Value of property `maxLines`
390
441
  */
391
442
  getMaxLines(): int;
392
443
  /**
@@ -395,6 +446,8 @@ declare namespace sap {
395
446
  * Sets whether to show syntax hints in the editor. This flag is only available if line numbers are shown.
396
447
  *
397
448
  * Default value is `true`.
449
+ *
450
+ * @returns Value of property `syntaxHints`
398
451
  */
399
452
  getSyntaxHints(): boolean;
400
453
  /**
@@ -415,6 +468,8 @@ declare namespace sap {
415
468
  * mixal, jssm, fsharp, edifact, csp, cssound_score, cssound_orchestra, cssound_document
416
469
  *
417
470
  * Default value is `"javascript"`.
471
+ *
472
+ * @returns Value of property `type`
418
473
  */
419
474
  getType(): string;
420
475
  /**
@@ -423,6 +478,8 @@ declare namespace sap {
423
478
  * The value displayed in the code editor.
424
479
  *
425
480
  * Default value is `empty string`.
481
+ *
482
+ * @returns Value of property `value`
426
483
  */
427
484
  getValue(): string;
428
485
  /**
@@ -431,6 +488,8 @@ declare namespace sap {
431
488
  * Sets whether the code is automatically selected if a value is set.
432
489
  *
433
490
  * Default value is `false`.
491
+ *
492
+ * @returns Value of property `valueSelection`
434
493
  */
435
494
  getValueSelection(): boolean;
436
495
  /**
@@ -439,6 +498,8 @@ declare namespace sap {
439
498
  * The width of the code editor.
440
499
  *
441
500
  * Default value is `"100%"`.
501
+ *
502
+ * @returns Value of property `width`
442
503
  */
443
504
  getWidth(): sap.ui.core.CSSSize;
444
505
  /**
@@ -449,6 +510,8 @@ declare namespace sap {
449
510
  prettyPrint(): void;
450
511
  /**
451
512
  * Sets the color theme of the code editor
513
+ *
514
+ * @returns Returns `this` to allow method chaining
452
515
  */
453
516
  setColorTheme(
454
517
  /**
@@ -464,6 +527,8 @@ declare namespace sap {
464
527
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
465
528
  *
466
529
  * Default value is `true`.
530
+ *
531
+ * @returns Reference to `this` in order to allow method chaining
467
532
  */
468
533
  setEditable(
469
534
  /**
@@ -480,6 +545,8 @@ declare namespace sap {
480
545
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
481
546
  *
482
547
  * Default value is `"100%"`.
548
+ *
549
+ * @returns Reference to `this` in order to allow method chaining
483
550
  */
484
551
  setHeight(
485
552
  /**
@@ -495,6 +562,8 @@ declare namespace sap {
495
562
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
496
563
  *
497
564
  * Default value is `true`.
565
+ *
566
+ * @returns Reference to `this` in order to allow method chaining
498
567
  */
499
568
  setLineNumbers(
500
569
  /**
@@ -516,6 +585,8 @@ declare namespace sap {
516
585
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
517
586
  *
518
587
  * Default value is `0`.
588
+ *
589
+ * @returns Reference to `this` in order to allow method chaining
519
590
  */
520
591
  setMaxLines(
521
592
  /**
@@ -531,6 +602,8 @@ declare namespace sap {
531
602
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
532
603
  *
533
604
  * Default value is `true`.
605
+ *
606
+ * @returns Reference to `this` in order to allow method chaining
534
607
  */
535
608
  setSyntaxHints(
536
609
  /**
@@ -558,6 +631,8 @@ declare namespace sap {
558
631
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
559
632
  *
560
633
  * Default value is `"javascript"`.
634
+ *
635
+ * @returns Reference to `this` in order to allow method chaining
561
636
  */
562
637
  setType(
563
638
  /**
@@ -573,6 +648,8 @@ declare namespace sap {
573
648
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
574
649
  *
575
650
  * Default value is `empty string`.
651
+ *
652
+ * @returns Reference to `this` in order to allow method chaining
576
653
  */
577
654
  setValue(
578
655
  /**
@@ -588,6 +665,8 @@ declare namespace sap {
588
665
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
589
666
  *
590
667
  * Default value is `false`.
668
+ *
669
+ * @returns Reference to `this` in order to allow method chaining
591
670
  */
592
671
  setValueSelection(
593
672
  /**
@@ -603,6 +682,8 @@ declare namespace sap {
603
682
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
604
683
  *
605
684
  * Default value is `"100%"`.
685
+ *
686
+ * @returns Reference to `this` in order to allow method chaining
606
687
  */
607
688
  setWidth(
608
689
  /**