@openui5/ts-types-esm 1.101.0 → 1.102.2

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.101.0
1
+ // For Library Version: 1.102.2
2
2
 
3
3
  declare module "sap/ui/codeeditor/library" {}
4
4
 
@@ -57,6 +57,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
57
57
  * the information contained in `oClassInfo`.
58
58
  *
59
59
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
60
+ *
61
+ * @returns Created class / constructor function
60
62
  */
61
63
  static extend<T extends Record<string, unknown>>(
62
64
  /**
@@ -75,6 +77,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
75
77
  ): Function;
76
78
  /**
77
79
  * Returns a metadata object for class sap.ui.codeeditor.CodeEditor.
80
+ *
81
+ * @returns Metadata object describing this class
78
82
  */
79
83
  static getMetadata(): ElementMetadata;
80
84
  /**
@@ -97,6 +101,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
97
101
  * otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
98
102
  *
99
103
  * Fired when the value has changed and the focus leaves the code editor.
104
+ *
105
+ * @returns Reference to `this` in order to allow method chaining
100
106
  */
101
107
  attachChange(
102
108
  /**
@@ -120,6 +126,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
120
126
  * otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
121
127
  *
122
128
  * Fired when the value has changed and the focus leaves the code editor.
129
+ *
130
+ * @returns Reference to `this` in order to allow method chaining
123
131
  */
124
132
  attachChange(
125
133
  /**
@@ -138,6 +146,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
138
146
  * otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
139
147
  *
140
148
  * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
149
+ *
150
+ * @returns Reference to `this` in order to allow method chaining
141
151
  */
142
152
  attachLiveChange(
143
153
  /**
@@ -161,6 +171,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
161
171
  * otherwise it will be bound to this `sap.ui.codeeditor.CodeEditor` itself.
162
172
  *
163
173
  * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.
174
+ *
175
+ * @returns Reference to `this` in order to allow method chaining
164
176
  */
165
177
  attachLiveChange(
166
178
  /**
@@ -176,6 +188,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
176
188
  * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.codeeditor.CodeEditor`.
177
189
  *
178
190
  * The passed function and listener object must match the ones used for event registration.
191
+ *
192
+ * @returns Reference to `this` in order to allow method chaining
179
193
  */
180
194
  detachChange(
181
195
  /**
@@ -191,6 +205,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
191
205
  * Detaches event handler `fnFunction` from the {@link #event:liveChange liveChange} event of this `sap.ui.codeeditor.CodeEditor`.
192
206
  *
193
207
  * The passed function and listener object must match the ones used for event registration.
208
+ *
209
+ * @returns Reference to `this` in order to allow method chaining
194
210
  */
195
211
  detachLiveChange(
196
212
  /**
@@ -204,6 +220,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
204
220
  ): this;
205
221
  /**
206
222
  * Fires event {@link #event:change change} to attached listeners.
223
+ *
224
+ * @returns Reference to `this` in order to allow method chaining
207
225
  */
208
226
  fireChange(
209
227
  /**
@@ -222,6 +240,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
222
240
  ): this;
223
241
  /**
224
242
  * Fires event {@link #event:liveChange liveChange} to attached listeners.
243
+ *
244
+ * @returns Reference to `this` in order to allow method chaining
225
245
  */
226
246
  fireLiveChange(
227
247
  /**
@@ -240,6 +260,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
240
260
  ): this;
241
261
  /**
242
262
  * Sets the focus to the code editor
263
+ *
264
+ * @returns Returns `this` to allow method chaining
243
265
  */
244
266
  focus(): this;
245
267
  /**
@@ -252,10 +274,14 @@ declare module "sap/ui/codeeditor/CodeEditor" {
252
274
  * tomorrow_night_blue, tomorrow_night_bright, tomorrow_night_eighties, twilight, dracula vibrant_ink, xcode
253
275
  *
254
276
  * Default value is `"default"`.
277
+ *
278
+ * @returns Value of property `colorTheme`
255
279
  */
256
280
  getColorTheme(): string;
257
281
  /**
258
282
  * Returns the current value of the code editor
283
+ *
284
+ * @returns Returns the current value of the code editor
259
285
  */
260
286
  getCurrentValue(): string;
261
287
  /**
@@ -264,6 +290,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
264
290
  * Sets whether the code in the editor can be changed by the user.
265
291
  *
266
292
  * Default value is `true`.
293
+ *
294
+ * @returns Value of property `editable`
267
295
  */
268
296
  getEditable(): boolean;
269
297
  /**
@@ -273,12 +301,16 @@ declare module "sap/ui/codeeditor/CodeEditor" {
273
301
  * 20px.
274
302
  *
275
303
  * Default value is `"100%"`.
304
+ *
305
+ * @returns Value of property `height`
276
306
  */
277
307
  getHeight(): CSSSize;
278
308
  /**
279
309
  * Returns the DOMNode ID to be used for the "labelFor" attribute of the label.
280
310
  *
281
311
  * By default, this is the ID of the control itself.
312
+ *
313
+ * @returns ID to be used for the `labelFor`
282
314
  */
283
315
  getIdForLabel(): string;
284
316
  /**
@@ -287,6 +319,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
287
319
  * Sets whether line numbers should be shown.
288
320
  *
289
321
  * Default value is `true`.
322
+ *
323
+ * @returns Value of property `lineNumbers`
290
324
  */
291
325
  getLineNumbers(): boolean;
292
326
  /**
@@ -301,6 +335,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
301
335
  * set to `auto`.
302
336
  *
303
337
  * Default value is `0`.
338
+ *
339
+ * @returns Value of property `maxLines`
304
340
  */
305
341
  getMaxLines(): int;
306
342
  /**
@@ -309,6 +345,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
309
345
  * Sets whether to show syntax hints in the editor. This flag is only available if line numbers are shown.
310
346
  *
311
347
  * Default value is `true`.
348
+ *
349
+ * @returns Value of property `syntaxHints`
312
350
  */
313
351
  getSyntaxHints(): boolean;
314
352
  /**
@@ -329,6 +367,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
329
367
  * mixal, jssm, fsharp, edifact, csp, cssound_score, cssound_orchestra, cssound_document
330
368
  *
331
369
  * Default value is `"javascript"`.
370
+ *
371
+ * @returns Value of property `type`
332
372
  */
333
373
  getType(): string;
334
374
  /**
@@ -337,6 +377,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
337
377
  * The value displayed in the code editor.
338
378
  *
339
379
  * Default value is `empty string`.
380
+ *
381
+ * @returns Value of property `value`
340
382
  */
341
383
  getValue(): string;
342
384
  /**
@@ -345,6 +387,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
345
387
  * Sets whether the code is automatically selected if a value is set.
346
388
  *
347
389
  * Default value is `false`.
390
+ *
391
+ * @returns Value of property `valueSelection`
348
392
  */
349
393
  getValueSelection(): boolean;
350
394
  /**
@@ -353,6 +397,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
353
397
  * The width of the code editor.
354
398
  *
355
399
  * Default value is `"100%"`.
400
+ *
401
+ * @returns Value of property `width`
356
402
  */
357
403
  getWidth(): CSSSize;
358
404
  /**
@@ -363,6 +409,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
363
409
  prettyPrint(): void;
364
410
  /**
365
411
  * Sets the color theme of the code editor
412
+ *
413
+ * @returns Returns `this` to allow method chaining
366
414
  */
367
415
  setColorTheme(
368
416
  /**
@@ -378,6 +426,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
378
426
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
379
427
  *
380
428
  * Default value is `true`.
429
+ *
430
+ * @returns Reference to `this` in order to allow method chaining
381
431
  */
382
432
  setEditable(
383
433
  /**
@@ -394,6 +444,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
394
444
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
395
445
  *
396
446
  * Default value is `"100%"`.
447
+ *
448
+ * @returns Reference to `this` in order to allow method chaining
397
449
  */
398
450
  setHeight(
399
451
  /**
@@ -409,6 +461,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
409
461
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
410
462
  *
411
463
  * Default value is `true`.
464
+ *
465
+ * @returns Reference to `this` in order to allow method chaining
412
466
  */
413
467
  setLineNumbers(
414
468
  /**
@@ -430,6 +484,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
430
484
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
431
485
  *
432
486
  * Default value is `0`.
487
+ *
488
+ * @returns Reference to `this` in order to allow method chaining
433
489
  */
434
490
  setMaxLines(
435
491
  /**
@@ -445,6 +501,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
445
501
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
446
502
  *
447
503
  * Default value is `true`.
504
+ *
505
+ * @returns Reference to `this` in order to allow method chaining
448
506
  */
449
507
  setSyntaxHints(
450
508
  /**
@@ -472,6 +530,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
472
530
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
473
531
  *
474
532
  * Default value is `"javascript"`.
533
+ *
534
+ * @returns Reference to `this` in order to allow method chaining
475
535
  */
476
536
  setType(
477
537
  /**
@@ -487,6 +547,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
487
547
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
488
548
  *
489
549
  * Default value is `empty string`.
550
+ *
551
+ * @returns Reference to `this` in order to allow method chaining
490
552
  */
491
553
  setValue(
492
554
  /**
@@ -502,6 +564,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
502
564
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
503
565
  *
504
566
  * Default value is `false`.
567
+ *
568
+ * @returns Reference to `this` in order to allow method chaining
505
569
  */
506
570
  setValueSelection(
507
571
  /**
@@ -517,6 +581,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
517
581
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
518
582
  *
519
583
  * Default value is `"100%"`.
584
+ *
585
+ * @returns Reference to `this` in order to allow method chaining
520
586
  */
521
587
  setWidth(
522
588
  /**
@@ -552,28 +618,28 @@ declare module "sap/ui/codeeditor/CodeEditor" {
552
618
  /**
553
619
  * The width of the code editor.
554
620
  */
555
- width?: CSSSize | PropertyBindingInfo;
621
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
556
622
 
557
623
  /**
558
624
  * The height of the code editor. A minimal height of 3rem will be applied in case the height is less than
559
625
  * 20px.
560
626
  */
561
- height?: CSSSize | PropertyBindingInfo;
627
+ height?: CSSSize | PropertyBindingInfo | `{${string}}`;
562
628
 
563
629
  /**
564
630
  * Sets whether the code in the editor can be changed by the user.
565
631
  */
566
- editable?: boolean | PropertyBindingInfo;
632
+ editable?: boolean | PropertyBindingInfo | `{${string}}`;
567
633
 
568
634
  /**
569
635
  * Sets whether line numbers should be shown.
570
636
  */
571
- lineNumbers?: boolean | PropertyBindingInfo;
637
+ lineNumbers?: boolean | PropertyBindingInfo | `{${string}}`;
572
638
 
573
639
  /**
574
640
  * Sets whether the code is automatically selected if a value is set.
575
641
  */
576
- valueSelection?: boolean | PropertyBindingInfo;
642
+ valueSelection?: boolean | PropertyBindingInfo | `{${string}}`;
577
643
 
578
644
  /**
579
645
  * @SINCE 1.48.1
@@ -584,7 +650,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
584
650
  * **Note:** Keep in mind that the auto expand `CodeEditor` behavior requires the `height` property to be
585
651
  * set to `auto`.
586
652
  */
587
- maxLines?: int | PropertyBindingInfo;
653
+ maxLines?: int | PropertyBindingInfo | `{${string}}`;
588
654
 
589
655
  /**
590
656
  * Sets the editor color theme. Possible values are: default, hcb, hcb_bright, hcb_blue, theme-ambiance,
@@ -598,7 +664,7 @@ declare module "sap/ui/codeeditor/CodeEditor" {
598
664
  /**
599
665
  * Sets whether to show syntax hints in the editor. This flag is only available if line numbers are shown.
600
666
  */
601
- syntaxHints?: boolean | PropertyBindingInfo;
667
+ syntaxHints?: boolean | PropertyBindingInfo | `{${string}}`;
602
668
 
603
669
  /**
604
670
  * Fired when the value is changed by user interaction - each keystroke, delete, paste, etc.