@openui5/types 1.120.10 → 1.121.1

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.10
1
+ // For Library Version: 1.121.1
2
2
 
3
3
  declare module "sap/ui/codeeditor/library" {}
4
4
 
@@ -255,12 +255,16 @@ declare module "sap/ui/codeeditor/CodeEditor" {
255
255
  mParameters?: CodeEditor$LiveChangeEventParameters
256
256
  ): this;
257
257
  /**
258
- * Sets the focus to the code editor
258
+ * Returns the internal instance of the third-party Ace code editor.
259
259
  *
260
+ * **Note:** This control is based on third-party open-source software, and there might be incompatible
261
+ * changes introduced by the code owner in their future releases.
260
262
  *
261
- * @returns Returns `this` to allow method chaining
263
+ * @since 1.121
264
+ *
265
+ * @returns the internal third-party Ace code editor instance
262
266
  */
263
- focus(): this;
267
+ getAceEditor(): object;
264
268
  /**
265
269
  * Gets current value of property {@link #getColorTheme colorTheme}.
266
270
  *
@@ -412,8 +416,8 @@ declare module "sap/ui/codeeditor/CodeEditor" {
412
416
  /**
413
417
  * Pretty-prints the content of the editor.
414
418
  *
415
- * **Note:** Works well only for PHP. For other programming languages, the content might not be formatted
416
- * well. In such cases it is recommended to use your own formatting.
419
+ * **Note:** Works well for PHP. For other editor types (modes), the content might not be formatted well.
420
+ * In such cases it is recommended to use your own formatting.
417
421
  *
418
422
  * @since 1.54.1
419
423
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.10
1
+ // For Library Version: 1.121.1
2
2
 
3
3
  declare module "sap/ui/commons/library" {
4
4
  import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library";
@@ -10,6 +10,9 @@ declare module "sap/ui/commons/library" {
10
10
  /**
11
11
  * different styles for a button.
12
12
  *
13
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
14
+ * 'ButtonStyle'.
15
+ *
13
16
  * @deprecated (since 1.38)
14
17
  */
15
18
  export enum ButtonStyle {
@@ -52,6 +55,9 @@ declare module "sap/ui/commons/library" {
52
55
  /**
53
56
  * Enumeration of possible HorizontalDivider height settings.
54
57
  *
58
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
59
+ * 'HorizontalDividerHeight'.
60
+ *
55
61
  * @deprecated (since 1.38)
56
62
  */
57
63
  export enum HorizontalDividerHeight {
@@ -75,6 +81,9 @@ declare module "sap/ui/commons/library" {
75
81
  /**
76
82
  * Enumeration of possible HorizontalDivider types.
77
83
  *
84
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
85
+ * 'HorizontalDividerType'.
86
+ *
78
87
  * @deprecated (since 1.38)
79
88
  */
80
89
  export enum HorizontalDividerType {
@@ -90,6 +99,9 @@ declare module "sap/ui/commons/library" {
90
99
  /**
91
100
  * Available label display modes.
92
101
  *
102
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
103
+ * 'LabelDesign'.
104
+ *
93
105
  * @deprecated (since 1.38)
94
106
  */
95
107
  export enum LabelDesign {
@@ -105,6 +117,9 @@ declare module "sap/ui/commons/library" {
105
117
  /**
106
118
  * Determines the visual design of a MenuBar. The feature might be not supported by all themes.
107
119
  *
120
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
121
+ * 'MenuBarDesign'.
122
+ *
108
123
  * @deprecated (since 1.38)
109
124
  */
110
125
  export enum MenuBarDesign {
@@ -120,6 +135,9 @@ declare module "sap/ui/commons/library" {
120
135
  /**
121
136
  * [Enter description for MessageType]
122
137
  *
138
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
139
+ * 'MessageType'.
140
+ *
123
141
  * @deprecated (since 1.38)
124
142
  */
125
143
  export enum MessageType {
@@ -139,6 +157,9 @@ declare module "sap/ui/commons/library" {
139
157
  /**
140
158
  * Distinct paginator event types
141
159
  *
160
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
161
+ * 'PaginatorEvent'.
162
+ *
142
163
  * @deprecated (since 1.38)
143
164
  */
144
165
  export enum PaginatorEvent {
@@ -166,6 +187,9 @@ declare module "sap/ui/commons/library" {
166
187
  /**
167
188
  * Possible values for the visualization of float values in the RatingIndicator Control.
168
189
  *
190
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
191
+ * 'RatingIndicatorVisualMode'.
192
+ *
169
193
  * @deprecated (since 1.38)
170
194
  */
171
195
  export enum RatingIndicatorVisualMode {
@@ -185,6 +209,9 @@ declare module "sap/ui/commons/library" {
185
209
  /**
186
210
  * Determines the visual design of a RowRepeater.
187
211
  *
212
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
213
+ * 'RowRepeaterDesign'.
214
+ *
188
215
  * @deprecated (since 1.38)
189
216
  */
190
217
  export enum RowRepeaterDesign {
@@ -211,6 +238,9 @@ declare module "sap/ui/commons/library" {
211
238
  /**
212
239
  * Semantic Colors of a text.
213
240
  *
241
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
242
+ * 'TextViewColor'.
243
+ *
214
244
  * @deprecated (since 1.38)
215
245
  */
216
246
  export enum TextViewColor {
@@ -234,6 +264,9 @@ declare module "sap/ui/commons/library" {
234
264
  /**
235
265
  * Designs for TextView.
236
266
  *
267
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
268
+ * 'TextViewDesign'.
269
+ *
237
270
  * @deprecated (since 1.38)
238
271
  */
239
272
  export enum TextViewDesign {
@@ -299,6 +332,9 @@ declare module "sap/ui/commons/library" {
299
332
  /**
300
333
  * Determines the visual design of a Toolbar.
301
334
  *
335
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
336
+ * 'ToolbarDesign'.
337
+ *
302
338
  * @deprecated (since 1.38)
303
339
  */
304
340
  export enum ToolbarDesign {
@@ -333,6 +369,9 @@ declare module "sap/ui/commons/library" {
333
369
  /**
334
370
  * Design of the Toolbar Separator.
335
371
  *
372
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
373
+ * 'ToolbarSeparatorDesign'.
374
+ *
336
375
  * @deprecated (since 1.38)
337
376
  */
338
377
  export enum ToolbarSeparatorDesign {
@@ -348,6 +387,9 @@ declare module "sap/ui/commons/library" {
348
387
  /**
349
388
  * Selection mode of the tree
350
389
  *
390
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
391
+ * 'TreeSelectionMode'.
392
+ *
351
393
  * @deprecated (since 1.38)
352
394
  */
353
395
  export enum TreeSelectionMode {
@@ -371,6 +413,9 @@ declare module "sap/ui/commons/library" {
371
413
  /**
372
414
  * States for TriStateCheckBox
373
415
  *
416
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
417
+ * 'TriStateCheckBoxState'.
418
+ *
374
419
  * @since 1.7.2
375
420
  * @deprecated (since 1.38)
376
421
  */
@@ -393,6 +438,9 @@ declare module "sap/ui/commons/library" {
393
438
  /**
394
439
  * Value set for the background design of areas
395
440
  *
441
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
442
+ * 'enums.AreaDesign'.
443
+ *
396
444
  * @deprecated (since 1.38)
397
445
  */
398
446
  enum AreaDesign {
@@ -412,6 +460,9 @@ declare module "sap/ui/commons/library" {
412
460
  /**
413
461
  * Value set for the border design of areas
414
462
  *
463
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
464
+ * 'enums.BorderDesign'.
465
+ *
415
466
  * @deprecated (since 1.38)
416
467
  */
417
468
  enum BorderDesign {
@@ -427,6 +478,9 @@ declare module "sap/ui/commons/library" {
427
478
  /**
428
479
  * Orientation of a UI element
429
480
  *
481
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
482
+ * 'enums.Orientation'.
483
+ *
430
484
  * @deprecated (since 1.38)
431
485
  */
432
486
  enum Orientation {
@@ -456,6 +510,9 @@ declare module "sap/ui/commons/library" {
456
510
  /**
457
511
  * Background design (i.e. color), e.g. of a layout cell.
458
512
  *
513
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
514
+ * 'layout.BackgroundDesign'.
515
+ *
459
516
  * @deprecated (since 1.38)
460
517
  */
461
518
  enum BackgroundDesign {
@@ -491,6 +548,9 @@ declare module "sap/ui/commons/library" {
491
548
  /**
492
549
  * The type (=position) of a BorderLayoutArea
493
550
  *
551
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
552
+ * 'layout.BorderLayoutAreaTypes'.
553
+ *
494
554
  * @deprecated (since 1.38)
495
555
  */
496
556
  enum BorderLayoutAreaTypes {
@@ -519,6 +579,9 @@ declare module "sap/ui/commons/library" {
519
579
  * Horizontal alignment, e.g. of a layout cell's content within the cell's borders. Note that some values
520
580
  * depend on the current locale's writing direction while others do not.
521
581
  *
582
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
583
+ * 'layout.HAlign'.
584
+ *
522
585
  * @deprecated (since 1.38)
523
586
  */
524
587
  enum HAlign {
@@ -548,6 +611,9 @@ declare module "sap/ui/commons/library" {
548
611
  * include a padding of 2px at the top and bottom, and differ only in the presence of a 4px padding towards
549
612
  * the beginning or end of a line, in the current locale's writing direction.
550
613
  *
614
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
615
+ * 'layout.Padding'.
616
+ *
551
617
  * @deprecated (since 1.38)
552
618
  */
553
619
  enum Padding {
@@ -578,6 +644,9 @@ declare module "sap/ui/commons/library" {
578
644
  * Separation, e.g. of a layout cell from its neighbor, via a vertical gutter of defined width, with or
579
645
  * without a vertical line in its middle.
580
646
  *
647
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
648
+ * 'layout.Separation'.
649
+ *
581
650
  * @deprecated (since 1.38)
582
651
  */
583
652
  enum Separation {
@@ -613,6 +682,9 @@ declare module "sap/ui/commons/library" {
613
682
  /**
614
683
  * Vertical alignment, e.g. of a layout cell's content within the cell's borders.
615
684
  *
685
+ * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property
686
+ * 'layout.VAlign'.
687
+ *
616
688
  * @deprecated (since 1.38)
617
689
  */
618
690
  enum VAlign {
@@ -5709,7 +5781,7 @@ declare module "sap/ui/commons/ComboBox" {
5709
5781
  /**
5710
5782
  * ID of the element which is the current target of the association {@link #getListBox listBox}, or `null`.
5711
5783
  */
5712
- getListBox(): ID;
5784
+ getListBox(): ID | null;
5713
5785
  /**
5714
5786
  * Gets current value of property {@link #getMaxPopupItems maxPopupItems}.
5715
5787
  *
@@ -6493,7 +6565,7 @@ declare module "sap/ui/commons/Dialog" {
6493
6565
  * ID of the element which is the current target of the association {@link #getDefaultButton defaultButton},
6494
6566
  * or `null`.
6495
6567
  */
6496
- getDefaultButton(): ID;
6568
+ getDefaultButton(): ID | null;
6497
6569
  /**
6498
6570
  * Determines whether the dialog is currently enabled or not.
6499
6571
  *
@@ -6530,7 +6602,7 @@ declare module "sap/ui/commons/Dialog" {
6530
6602
  * ID of the element which is the current target of the association {@link #getInitialFocus initialFocus},
6531
6603
  * or `null`.
6532
6604
  */
6533
- getInitialFocus(): ID;
6605
+ getInitialFocus(): ID | null;
6534
6606
  /**
6535
6607
  * Gets current value of property {@link #getKeepInWindow keepInWindow}.
6536
6608
  *
@@ -11716,7 +11788,7 @@ declare module "sap/ui/commons/Label" {
11716
11788
  /**
11717
11789
  * ID of the element which is the current target of the association {@link #getLabelFor labelFor}, or `null`.
11718
11790
  */
11719
- getLabelFor(): ID;
11791
+ getLabelFor(): ID | null;
11720
11792
  /**
11721
11793
  * Gets current value of property {@link #getRequired required}.
11722
11794
  *
@@ -17640,6 +17712,9 @@ declare module "sap/ui/commons/MessageBox" {
17640
17712
  * Each action is represented as a button in the message box. The values of this enumeration are used for
17641
17713
  * both, specifying the set of allowed actions as well as reporting back the user choice.
17642
17714
  *
17715
+ * This enum is part of the 'sap/ui/commons/MessageBox' module export and must be accessed by the property
17716
+ * 'Action'.
17717
+ *
17643
17718
  * @deprecated (since 1.38)
17644
17719
  */
17645
17720
  Action: typeof Action;
@@ -17647,6 +17722,9 @@ declare module "sap/ui/commons/MessageBox" {
17647
17722
  /**
17648
17723
  * Enumeration of the pre-defined icons that can be used in a MessageBox.
17649
17724
  *
17725
+ * This enum is part of the 'sap/ui/commons/MessageBox' module export and must be accessed by the property
17726
+ * 'Icon'.
17727
+ *
17650
17728
  * @deprecated (since 1.38)
17651
17729
  */
17652
17730
  Icon: typeof Icon;
@@ -17784,6 +17862,9 @@ declare module "sap/ui/commons/MessageBox" {
17784
17862
  * Each action is represented as a button in the message box. The values of this enumeration are used for
17785
17863
  * both, specifying the set of allowed actions as well as reporting back the user choice.
17786
17864
  *
17865
+ * This enum is part of the 'sap/ui/commons/MessageBox' module export and must be accessed by the property
17866
+ * 'Action'.
17867
+ *
17787
17868
  * @deprecated (since 1.38)
17788
17869
  */
17789
17870
  enum Action {
@@ -17823,6 +17904,9 @@ declare module "sap/ui/commons/MessageBox" {
17823
17904
  /**
17824
17905
  * Enumeration of the pre-defined icons that can be used in a MessageBox.
17825
17906
  *
17907
+ * This enum is part of the 'sap/ui/commons/MessageBox' module export and must be accessed by the property
17908
+ * 'Icon'.
17909
+ *
17826
17910
  * @deprecated (since 1.38)
17827
17911
  */
17828
17912
  enum Icon {
@@ -21658,7 +21742,7 @@ declare module "sap/ui/commons/ResponsiveContainer" {
21658
21742
  * ID of the element which is the current target of the association {@link #getDefaultContent defaultContent},
21659
21743
  * or `null`.
21660
21744
  */
21661
- getDefaultContent(): ID;
21745
+ getDefaultContent(): ID | null;
21662
21746
  /**
21663
21747
  * Gets current value of property {@link #getHeight height}.
21664
21748
  *
@@ -21916,7 +22000,7 @@ declare module "sap/ui/commons/ResponsiveContainerRange" {
21916
22000
  /**
21917
22001
  * ID of the element which is the current target of the association {@link #getContent content}, or `null`.
21918
22002
  */
21919
- getContent(): ID;
22003
+ getContent(): ID | null;
21920
22004
  /**
21921
22005
  * Gets current value of property {@link #getHeight height}.
21922
22006
  *
@@ -25844,7 +25928,7 @@ declare module "sap/ui/commons/SegmentedButton" {
25844
25928
  * ID of the element which is the current target of the association {@link #getSelectedButton selectedButton},
25845
25929
  * or `null`.
25846
25930
  */
25847
- getSelectedButton(): ID;
25931
+ getSelectedButton(): ID | null;
25848
25932
  /**
25849
25933
  * Checks for the provided `sap.ui.commons.Button` in the aggregation {@link #getButtons buttons}. and returns
25850
25934
  * its index if found or -1 otherwise.