@sapui5/ts-types 1.100.2 → 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.
Files changed (62) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +2 -0
  3. package/types/sap.apf.d.ts +89 -1
  4. package/types/sap.ca.ui.d.ts +1747 -124
  5. package/types/sap.chart.d.ts +376 -30
  6. package/types/sap.collaboration.d.ts +320 -40
  7. package/types/sap.esh.search.ui.d.ts +6 -2
  8. package/types/sap.f.d.ts +2015 -119
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +77 -64
  11. package/types/sap.fe.macros.d.ts +92 -40
  12. package/types/sap.fe.navigation.d.ts +148 -74
  13. package/types/sap.fe.templates.d.ts +115 -187
  14. package/types/sap.fe.test.d.ts +539 -25
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +7242 -516
  17. package/types/sap.insights.d.ts +80 -0
  18. package/types/sap.landvisz.d.ts +1015 -66
  19. package/types/sap.m.d.ts +16699 -1186
  20. package/types/sap.makit.d.ts +575 -54
  21. package/types/sap.me.d.ts +578 -51
  22. package/types/sap.ndc.d.ts +63 -5
  23. package/types/sap.ovp.d.ts +5 -6
  24. package/types/sap.rules.ui.d.ts +209 -18
  25. package/types/sap.sac.df.d.ts +2196 -0
  26. package/types/sap.sac.grid.d.ts +115 -8
  27. package/types/sap.suite.ui.commons.d.ts +5532 -396
  28. package/types/sap.suite.ui.generic.template.d.ts +226 -31
  29. package/types/sap.suite.ui.microchart.d.ts +1801 -160
  30. package/types/sap.tnt.d.ts +279 -19
  31. package/types/sap.ui.codeeditor.d.ts +89 -8
  32. package/types/sap.ui.commons.d.ts +3784 -313
  33. package/types/sap.ui.comp.d.ts +4005 -289
  34. package/types/sap.ui.core.d.ts +6317 -336
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +61 -6
  37. package/types/sap.ui.fl.d.ts +1 -1
  38. package/types/sap.ui.generic.app.d.ts +247 -73
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +316 -23
  41. package/types/sap.ui.layout.d.ts +1851 -199
  42. package/types/sap.ui.mdc.d.ts +9 -1
  43. package/types/sap.ui.richtexteditor.d.ts +340 -49
  44. package/types/sap.ui.rta.d.ts +5 -1
  45. package/types/sap.ui.suite.d.ts +87 -6
  46. package/types/sap.ui.support.d.ts +39 -6
  47. package/types/sap.ui.table.d.ts +1060 -113
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +2704 -202
  50. package/types/sap.ui.ux3.d.ts +2379 -181
  51. package/types/sap.ui.vbm.d.ts +2002 -197
  52. package/types/sap.ui.vk.d.ts +6027 -327
  53. package/types/sap.ui.vtm.d.ts +1130 -41
  54. package/types/sap.uiext.inbox.d.ts +423 -22
  55. package/types/sap.ushell.d.ts +2036 -161
  56. package/types/sap.ushell_abap.d.ts +4 -1
  57. package/types/sap.uxap.d.ts +903 -88
  58. package/types/sap.viz.d.ts +5514 -380
  59. package/types/sap.webanalytics.core.d.ts +1 -1
  60. package/types/sap.zen.commons.d.ts +249 -1688
  61. package/types/sap.zen.crosstab.d.ts +217 -21
  62. package/types/sap.zen.dsh.d.ts +1505 -4036
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.100.0
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -13,28 +13,32 @@ declare namespace sap {
13
13
  */
14
14
  width?:
15
15
  | sap.ui.core.CSSSize
16
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
16
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
17
+ | `{${string}}`;
17
18
 
18
19
  /**
19
20
  * The overall height of the control. When not set, 100% is automatically set.
20
21
  */
21
22
  height?:
22
23
  | sap.ui.core.CSSSize
23
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
24
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
25
+ | `{${string}}`;
24
26
 
25
27
  /**
26
28
  * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
27
29
  */
28
30
  verticalScrolling?:
29
31
  | sap.ui.core.Scrolling
30
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
32
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
33
+ | `{${string}}`;
31
34
 
32
35
  /**
33
36
  * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
34
37
  */
35
38
  horizontalScrolling?:
36
39
  | sap.ui.core.Scrolling
37
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
40
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
41
+ | `{${string}}`;
38
42
 
39
43
  /**
40
44
  * Positioned child controls within the layout
@@ -42,7 +46,8 @@ declare namespace sap {
42
46
  positions?:
43
47
  | sap.zen.commons.layout.PositionContainer[]
44
48
  | sap.zen.commons.layout.PositionContainer
45
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
49
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
50
+ | `{${string}}`;
46
51
  }
47
52
 
48
53
  interface $MatrixLayoutSettings extends sap.ui.core.$ControlSettings {
@@ -51,14 +56,16 @@ declare namespace sap {
51
56
  */
52
57
  width?:
53
58
  | sap.ui.core.CSSSize
54
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
59
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
60
+ | `{${string}}`;
55
61
 
56
62
  /**
57
63
  * CSS height of the matrix layout.
58
64
  */
59
65
  height?:
60
66
  | sap.ui.core.CSSSize
61
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
67
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
68
+ | `{${string}}`;
62
69
 
63
70
  /**
64
71
  * Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the
@@ -66,12 +73,18 @@ declare namespace sap {
66
73
  * of the MatrixLayout should be provided. Otherwise the column width displayed could be different than
67
74
  * the given ones because of browser dependend optimazations.
68
75
  */
69
- layoutFixed?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
76
+ layoutFixed?:
77
+ | boolean
78
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
79
+ | `{${string}}`;
70
80
 
71
81
  /**
72
82
  * Number of columns. If not specified, the number of columns will be determined from the given cells.
73
83
  */
74
- columns?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
84
+ columns?:
85
+ | int
86
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
87
+ | `{${string}}`;
75
88
 
76
89
  /**
77
90
  * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical
@@ -79,7 +92,8 @@ declare namespace sap {
79
92
  */
80
93
  widths?:
81
94
  | sap.ui.core.CSSSize[]
82
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
95
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
96
+ | `{${string}}`;
83
97
 
84
98
  /**
85
99
  * The matrix layout's individual rows.
@@ -87,7 +101,8 @@ declare namespace sap {
87
101
  rows?:
88
102
  | sap.zen.commons.layout.MatrixLayoutRow[]
89
103
  | sap.zen.commons.layout.MatrixLayoutRow
90
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
104
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
105
+ | `{${string}}`;
91
106
  }
92
107
 
93
108
  interface $MatrixLayoutCellSettings
@@ -100,7 +115,8 @@ declare namespace sap {
100
115
  */
101
116
  height?:
102
117
  | sap.ui.core.CSSSize
103
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
118
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
119
+ | `{${string}}`;
104
120
 
105
121
  /**
106
122
  * The matrix layout row's individual cells.
@@ -108,7 +124,8 @@ declare namespace sap {
108
124
  cells?:
109
125
  | sap.zen.commons.layout.MatrixLayoutCell[]
110
126
  | sap.zen.commons.layout.MatrixLayoutCell
111
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
127
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
128
+ | `{${string}}`;
112
129
  }
113
130
 
114
131
  interface $PositionContainerSettings
@@ -118,28 +135,32 @@ declare namespace sap {
118
135
  */
119
136
  top?:
120
137
  | sap.ui.core.CSSSize
121
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
138
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
139
+ | `{${string}}`;
122
140
 
123
141
  /**
124
142
  * Defines the distance to the bottom of the layout (as specified in HTML)
125
143
  */
126
144
  bottom?:
127
145
  | sap.ui.core.CSSSize
128
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
146
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
147
+ | `{${string}}`;
129
148
 
130
149
  /**
131
150
  * Defines the distance to the left of the layout (as specified in HTML)
132
151
  */
133
152
  left?:
134
153
  | sap.ui.core.CSSSize
135
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
154
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
155
+ | `{${string}}`;
136
156
 
137
157
  /**
138
158
  * Defines the distance to the right of the layout (as specified in HTML)
139
159
  */
140
160
  right?:
141
161
  | sap.ui.core.CSSSize
142
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
162
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
163
+ | `{${string}}`;
143
164
 
144
165
  /**
145
166
  * Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values
@@ -147,7 +168,8 @@ declare namespace sap {
147
168
  */
148
169
  centerHorizontally?:
149
170
  | boolean
150
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
171
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
172
+ | `{${string}}`;
151
173
 
152
174
  /**
153
175
  * Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values
@@ -155,7 +177,8 @@ declare namespace sap {
155
177
  */
156
178
  centerVertically?:
157
179
  | boolean
158
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
180
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
181
+ | `{${string}}`;
159
182
 
160
183
  /**
161
184
  * Child control of the position container
@@ -205,6 +228,8 @@ declare namespace sap {
205
228
  * it with the information contained in `oClassInfo`.
206
229
  *
207
230
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
231
+ *
232
+ * @returns Created class / constructor function
208
233
  */
209
234
  static extend<T extends Record<string, unknown>>(
210
235
  /**
@@ -226,6 +251,8 @@ declare namespace sap {
226
251
  ): Function;
227
252
  /**
228
253
  * Returns a metadata object for class sap.zen.commons.layout.AbsoluteLayout.
254
+ *
255
+ * @returns Metadata object describing this class
229
256
  */
230
257
  static getMetadata(): sap.ui.core.ElementMetadata;
231
258
  /**
@@ -246,6 +273,8 @@ declare namespace sap {
246
273
  ): sap.zen.commons.layout.AbsoluteLayout;
247
274
  /**
248
275
  * Adds some position to the aggregation {@link #getPositions positions}.
276
+ *
277
+ * @returns Reference to `this` in order to allow method chaining
249
278
  */
250
279
  addPosition(
251
280
  /**
@@ -260,6 +289,8 @@ declare namespace sap {
260
289
  destroyContent(): sap.zen.commons.layout.AbsoluteLayout;
261
290
  /**
262
291
  * Destroys all the positions in the aggregation {@link #getPositions positions}.
292
+ *
293
+ * @returns Reference to `this` in order to allow method chaining
263
294
  */
264
295
  destroyPositions(): this;
265
296
  /**
@@ -272,6 +303,8 @@ declare namespace sap {
272
303
  * The overall height of the control. When not set, 100% is automatically set.
273
304
  *
274
305
  * Default value is `"100%"`.
306
+ *
307
+ * @returns Value of property `height`
275
308
  */
276
309
  getHeight(): sap.ui.core.CSSSize;
277
310
  /**
@@ -280,6 +313,8 @@ declare namespace sap {
280
313
  * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
281
314
  *
282
315
  * Default value is `Hidden`.
316
+ *
317
+ * @returns Value of property `horizontalScrolling`
283
318
  */
284
319
  getHorizontalScrolling(): sap.ui.core.Scrolling;
285
320
  /**
@@ -294,6 +329,8 @@ declare namespace sap {
294
329
  * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
295
330
  *
296
331
  * Default value is `Hidden`.
332
+ *
333
+ * @returns Value of property `verticalScrolling`
297
334
  */
298
335
  getVerticalScrolling(): sap.ui.core.Scrolling;
299
336
  /**
@@ -302,6 +339,8 @@ declare namespace sap {
302
339
  * The overall width of the control. When not set, 100% is automatically set.
303
340
  *
304
341
  * Default value is `'100%'`.
342
+ *
343
+ * @returns Value of property `width`
305
344
  */
306
345
  getWidth(): sap.ui.core.CSSSize;
307
346
  /**
@@ -317,6 +356,8 @@ declare namespace sap {
317
356
  /**
318
357
  * Checks for the provided `sap.zen.commons.layout.PositionContainer` in the aggregation {@link #getPositions
319
358
  * positions}. and returns its index if found or -1 otherwise.
359
+ *
360
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
320
361
  */
321
362
  indexOfPosition(
322
363
  /**
@@ -348,6 +389,8 @@ declare namespace sap {
348
389
  ): sap.zen.commons.layout.AbsoluteLayout;
349
390
  /**
350
391
  * Inserts a position into the aggregation {@link #getPositions positions}.
392
+ *
393
+ * @returns Reference to `this` in order to allow method chaining
351
394
  */
352
395
  insertPosition(
353
396
  /**
@@ -370,6 +413,8 @@ declare namespace sap {
370
413
  * Removes all the controls from the aggregation {@link #getPositions positions}.
371
414
  *
372
415
  * Additionally, it unregisters them from the hosting UIArea.
416
+ *
417
+ * @returns An array of the removed elements (might be empty)
373
418
  */
374
419
  removeAllPositions(): sap.zen.commons.layout.PositionContainer[];
375
420
  /**
@@ -384,6 +429,8 @@ declare namespace sap {
384
429
  ): sap.ui.core.Control;
385
430
  /**
386
431
  * Removes a position from the aggregation {@link #getPositions positions}.
432
+ *
433
+ * @returns The removed position or `null`
387
434
  */
388
435
  removePosition(
389
436
  /**
@@ -399,6 +446,8 @@ declare namespace sap {
399
446
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
400
447
  *
401
448
  * Default value is `"100%"`.
449
+ *
450
+ * @returns Reference to `this` in order to allow method chaining
402
451
  */
403
452
  setHeight(
404
453
  /**
@@ -414,6 +463,8 @@ declare namespace sap {
414
463
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
415
464
  *
416
465
  * Default value is `Hidden`.
466
+ *
467
+ * @returns Reference to `this` in order to allow method chaining
417
468
  */
418
469
  setHorizontalScrolling(
419
470
  /**
@@ -445,6 +496,8 @@ declare namespace sap {
445
496
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
446
497
  *
447
498
  * Default value is `Hidden`.
499
+ *
500
+ * @returns Reference to `this` in order to allow method chaining
448
501
  */
449
502
  setVerticalScrolling(
450
503
  /**
@@ -460,6 +513,8 @@ declare namespace sap {
460
513
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
461
514
  *
462
515
  * Default value is `'100%'`.
516
+ *
517
+ * @returns Reference to `this` in order to allow method chaining
463
518
  */
464
519
  setWidth(
465
520
  /**
@@ -508,6 +563,8 @@ declare namespace sap {
508
563
  * it with the information contained in `oClassInfo`.
509
564
  *
510
565
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
566
+ *
567
+ * @returns Created class / constructor function
511
568
  */
512
569
  static extend<T extends Record<string, unknown>>(
513
570
  /**
@@ -526,10 +583,14 @@ declare namespace sap {
526
583
  ): Function;
527
584
  /**
528
585
  * Returns a metadata object for class sap.zen.commons.layout.MatrixLayout.
586
+ *
587
+ * @returns Metadata object describing this class
529
588
  */
530
589
  static getMetadata(): sap.ui.core.ElementMetadata;
531
590
  /**
532
591
  * Adds some row to the aggregation {@link #getRows rows}.
592
+ *
593
+ * @returns Reference to `this` in order to allow method chaining
533
594
  */
534
595
  addRow(
535
596
  /**
@@ -543,6 +604,8 @@ declare namespace sap {
543
604
  * Each argument must be either a matrix layout cell, which is added to the row "as is", or an arbitrary
544
605
  * content control, which is wrapped with a new (default) matrix layout cell first and then added to the
545
606
  * row.
607
+ *
608
+ * @returns `this` to allow method chaining
546
609
  */
547
610
  createRow(
548
611
  /**
@@ -555,18 +618,24 @@ declare namespace sap {
555
618
  ): sap.zen.commons.layout.MatrixLayout;
556
619
  /**
557
620
  * Destroys all the rows in the aggregation {@link #getRows rows}.
621
+ *
622
+ * @returns Reference to `this` in order to allow method chaining
558
623
  */
559
624
  destroyRows(): this;
560
625
  /**
561
626
  * Gets current value of property {@link #getColumns columns}.
562
627
  *
563
628
  * Number of columns. If not specified, the number of columns will be determined from the given cells.
629
+ *
630
+ * @returns Value of property `columns`
564
631
  */
565
632
  getColumns(): int;
566
633
  /**
567
634
  * Gets current value of property {@link #getHeight height}.
568
635
  *
569
636
  * CSS height of the matrix layout.
637
+ *
638
+ * @returns Value of property `height`
570
639
  */
571
640
  getHeight(): sap.ui.core.CSSSize;
572
641
  /**
@@ -578,6 +647,8 @@ declare namespace sap {
578
647
  * the given ones because of browser dependend optimazations.
579
648
  *
580
649
  * Default value is `true`.
650
+ *
651
+ * @returns Value of property `layoutFixed`
581
652
  */
582
653
  getLayoutFixed(): boolean;
583
654
  /**
@@ -590,6 +661,8 @@ declare namespace sap {
590
661
  * Gets current value of property {@link #getWidth width}.
591
662
  *
592
663
  * CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided.
664
+ *
665
+ * @returns Value of property `width`
593
666
  */
594
667
  getWidth(): sap.ui.core.CSSSize;
595
668
  /**
@@ -597,11 +670,15 @@ declare namespace sap {
597
670
  *
598
671
  * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical
599
672
  * sizing enter "auto" for this column width.
673
+ *
674
+ * @returns Value of property `widths`
600
675
  */
601
676
  getWidths(): sap.ui.core.CSSSize[];
602
677
  /**
603
678
  * Checks for the provided `sap.zen.commons.layout.MatrixLayoutRow` in the aggregation {@link #getRows rows}.
604
679
  * and returns its index if found or -1 otherwise.
680
+ *
681
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
605
682
  */
606
683
  indexOfRow(
607
684
  /**
@@ -611,6 +688,8 @@ declare namespace sap {
611
688
  ): int;
612
689
  /**
613
690
  * Inserts a row into the aggregation {@link #getRows rows}.
691
+ *
692
+ * @returns Reference to `this` in order to allow method chaining
614
693
  */
615
694
  insertRow(
616
695
  /**
@@ -628,10 +707,14 @@ declare namespace sap {
628
707
  * Removes all the controls from the aggregation {@link #getRows rows}.
629
708
  *
630
709
  * Additionally, it unregisters them from the hosting UIArea.
710
+ *
711
+ * @returns An array of the removed elements (might be empty)
631
712
  */
632
713
  removeAllRows(): sap.zen.commons.layout.MatrixLayoutRow[];
633
714
  /**
634
715
  * Removes a row from the aggregation {@link #getRows rows}.
716
+ *
717
+ * @returns The removed row or `null`
635
718
  */
636
719
  removeRow(
637
720
  /**
@@ -645,6 +728,8 @@ declare namespace sap {
645
728
  * Number of columns. If not specified, the number of columns will be determined from the given cells.
646
729
  *
647
730
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
731
+ *
732
+ * @returns Reference to `this` in order to allow method chaining
648
733
  */
649
734
  setColumns(
650
735
  /**
@@ -658,6 +743,8 @@ declare namespace sap {
658
743
  * CSS height of the matrix layout.
659
744
  *
660
745
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
746
+ *
747
+ * @returns Reference to `this` in order to allow method chaining
661
748
  */
662
749
  setHeight(
663
750
  /**
@@ -676,6 +763,8 @@ declare namespace sap {
676
763
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
677
764
  *
678
765
  * Default value is `true`.
766
+ *
767
+ * @returns Reference to `this` in order to allow method chaining
679
768
  */
680
769
  setLayoutFixed(
681
770
  /**
@@ -689,6 +778,8 @@ declare namespace sap {
689
778
  * CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided.
690
779
  *
691
780
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
781
+ *
782
+ * @returns Reference to `this` in order to allow method chaining
692
783
  */
693
784
  setWidth(
694
785
  /**
@@ -703,6 +794,8 @@ declare namespace sap {
703
794
  * sizing enter "auto" for this column width.
704
795
  *
705
796
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
797
+ *
798
+ * @returns Reference to `this` in order to allow method chaining
706
799
  */
707
800
  setWidths(
708
801
  /**
@@ -851,6 +944,8 @@ declare namespace sap {
851
944
  * it with the information contained in `oClassInfo`.
852
945
  *
853
946
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
947
+ *
948
+ * @returns Created class / constructor function
854
949
  */
855
950
  static extend<T extends Record<string, unknown>>(
856
951
  /**
@@ -872,10 +967,14 @@ declare namespace sap {
872
967
  ): Function;
873
968
  /**
874
969
  * Returns a metadata object for class sap.zen.commons.layout.MatrixLayoutRow.
970
+ *
971
+ * @returns Metadata object describing this class
875
972
  */
876
973
  static getMetadata(): sap.ui.core.ElementMetadata;
877
974
  /**
878
975
  * Adds some cell to the aggregation {@link #getCells cells}.
976
+ *
977
+ * @returns Reference to `this` in order to allow method chaining
879
978
  */
880
979
  addCell(
881
980
  /**
@@ -923,6 +1022,8 @@ declare namespace sap {
923
1022
  ): sap.zen.commons.layout.MatrixLayoutRow;
924
1023
  /**
925
1024
  * Destroys all the cells in the aggregation {@link #getCells cells}.
1025
+ *
1026
+ * @returns Reference to `this` in order to allow method chaining
926
1027
  */
927
1028
  destroyCells(): this;
928
1029
  /**
@@ -935,6 +1036,8 @@ declare namespace sap {
935
1036
  * Gets current value of property {@link #getHeight height}.
936
1037
  *
937
1038
  * Height of the row.
1039
+ *
1040
+ * @returns Value of property `height`
938
1041
  */
939
1042
  getHeight(): sap.ui.core.CSSSize;
940
1043
  /**
@@ -950,6 +1053,8 @@ declare namespace sap {
950
1053
  /**
951
1054
  * Checks for the provided `sap.zen.commons.layout.MatrixLayoutCell` in the aggregation {@link #getCells
952
1055
  * cells}. and returns its index if found or -1 otherwise.
1056
+ *
1057
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
953
1058
  */
954
1059
  indexOfCell(
955
1060
  /**
@@ -959,6 +1064,8 @@ declare namespace sap {
959
1064
  ): int;
960
1065
  /**
961
1066
  * Inserts a cell into the aggregation {@link #getCells cells}.
1067
+ *
1068
+ * @returns Reference to `this` in order to allow method chaining
962
1069
  */
963
1070
  insertCell(
964
1071
  /**
@@ -976,10 +1083,14 @@ declare namespace sap {
976
1083
  * Removes all the controls from the aggregation {@link #getCells cells}.
977
1084
  *
978
1085
  * Additionally, it unregisters them from the hosting UIArea.
1086
+ *
1087
+ * @returns An array of the removed elements (might be empty)
979
1088
  */
980
1089
  removeAllCells(): sap.zen.commons.layout.MatrixLayoutCell[];
981
1090
  /**
982
1091
  * Removes a cell from the aggregation {@link #getCells cells}.
1092
+ *
1093
+ * @returns The removed cell or `null`
983
1094
  */
984
1095
  removeCell(
985
1096
  /**
@@ -1005,6 +1116,8 @@ declare namespace sap {
1005
1116
  * Height of the row.
1006
1117
  *
1007
1118
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1119
+ *
1120
+ * @returns Reference to `this` in order to allow method chaining
1008
1121
  */
1009
1122
  setHeight(
1010
1123
  /**
@@ -1055,6 +1168,8 @@ declare namespace sap {
1055
1168
  * it with the information contained in `oClassInfo`.
1056
1169
  *
1057
1170
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
1171
+ *
1172
+ * @returns Created class / constructor function
1058
1173
  */
1059
1174
  static extend<T extends Record<string, unknown>>(
1060
1175
  /**
@@ -1076,16 +1191,22 @@ declare namespace sap {
1076
1191
  ): Function;
1077
1192
  /**
1078
1193
  * Returns a metadata object for class sap.zen.commons.layout.PositionContainer.
1194
+ *
1195
+ * @returns Metadata object describing this class
1079
1196
  */
1080
1197
  static getMetadata(): sap.ui.core.ElementMetadata;
1081
1198
  /**
1082
1199
  * Destroys the control in the aggregation {@link #getControl control}.
1200
+ *
1201
+ * @returns Reference to `this` in order to allow method chaining
1083
1202
  */
1084
1203
  destroyControl(): this;
1085
1204
  /**
1086
1205
  * Gets current value of property {@link #getBottom bottom}.
1087
1206
  *
1088
1207
  * Defines the distance to the bottom of the layout (as specified in HTML)
1208
+ *
1209
+ * @returns Value of property `bottom`
1089
1210
  */
1090
1211
  getBottom(): sap.ui.core.CSSSize;
1091
1212
  /**
@@ -1095,6 +1216,8 @@ declare namespace sap {
1095
1216
  * of the attributes left and right are ignored when this feature is activated.
1096
1217
  *
1097
1218
  * Default value is `false`.
1219
+ *
1220
+ * @returns Value of property `centerHorizontally`
1098
1221
  */
1099
1222
  getCenterHorizontally(): boolean;
1100
1223
  /**
@@ -1104,6 +1227,8 @@ declare namespace sap {
1104
1227
  * of the attributes top and bottom are ignored when this feature is activated.
1105
1228
  *
1106
1229
  * Default value is `false`.
1230
+ *
1231
+ * @returns Value of property `centerVertically`
1107
1232
  */
1108
1233
  getCenterVertically(): boolean;
1109
1234
  /**
@@ -1116,18 +1241,24 @@ declare namespace sap {
1116
1241
  * Gets current value of property {@link #getLeft left}.
1117
1242
  *
1118
1243
  * Defines the distance to the left of the layout (as specified in HTML)
1244
+ *
1245
+ * @returns Value of property `left`
1119
1246
  */
1120
1247
  getLeft(): sap.ui.core.CSSSize;
1121
1248
  /**
1122
1249
  * Gets current value of property {@link #getRight right}.
1123
1250
  *
1124
1251
  * Defines the distance to the right of the layout (as specified in HTML)
1252
+ *
1253
+ * @returns Value of property `right`
1125
1254
  */
1126
1255
  getRight(): sap.ui.core.CSSSize;
1127
1256
  /**
1128
1257
  * Gets current value of property {@link #getTop top}.
1129
1258
  *
1130
1259
  * Defines the distance to the top of the layout (as specified in HTML)
1260
+ *
1261
+ * @returns Value of property `top`
1131
1262
  */
1132
1263
  getTop(): sap.ui.core.CSSSize;
1133
1264
  /**
@@ -1136,6 +1267,8 @@ declare namespace sap {
1136
1267
  * Defines the distance to the bottom of the layout (as specified in HTML)
1137
1268
  *
1138
1269
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1270
+ *
1271
+ * @returns Reference to `this` in order to allow method chaining
1139
1272
  */
1140
1273
  setBottom(
1141
1274
  /**
@@ -1152,6 +1285,8 @@ declare namespace sap {
1152
1285
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1153
1286
  *
1154
1287
  * Default value is `false`.
1288
+ *
1289
+ * @returns Reference to `this` in order to allow method chaining
1155
1290
  */
1156
1291
  setCenterHorizontally(
1157
1292
  /**
@@ -1168,6 +1303,8 @@ declare namespace sap {
1168
1303
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1169
1304
  *
1170
1305
  * Default value is `false`.
1306
+ *
1307
+ * @returns Reference to `this` in order to allow method chaining
1171
1308
  */
1172
1309
  setCenterVertically(
1173
1310
  /**
@@ -1177,6 +1314,8 @@ declare namespace sap {
1177
1314
  ): this;
1178
1315
  /**
1179
1316
  * Sets the aggregated {@link #getControl control}.
1317
+ *
1318
+ * @returns Reference to `this` in order to allow method chaining
1180
1319
  */
1181
1320
  setControl(
1182
1321
  /**
@@ -1190,6 +1329,8 @@ declare namespace sap {
1190
1329
  * Defines the distance to the left of the layout (as specified in HTML)
1191
1330
  *
1192
1331
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1332
+ *
1333
+ * @returns Reference to `this` in order to allow method chaining
1193
1334
  */
1194
1335
  setLeft(
1195
1336
  /**
@@ -1203,6 +1344,8 @@ declare namespace sap {
1203
1344
  * Defines the distance to the right of the layout (as specified in HTML)
1204
1345
  *
1205
1346
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1347
+ *
1348
+ * @returns Reference to `this` in order to allow method chaining
1206
1349
  */
1207
1350
  setRight(
1208
1351
  /**
@@ -1216,6 +1359,8 @@ declare namespace sap {
1216
1359
  * Defines the distance to the top of the layout (as specified in HTML)
1217
1360
  *
1218
1361
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1362
+ *
1363
+ * @returns Reference to `this` in order to allow method chaining
1219
1364
  */
1220
1365
  setTop(
1221
1366
  /**
@@ -1237,1725 +1382,141 @@ declare namespace sap {
1237
1382
  }
1238
1383
  }
1239
1384
 
1240
- interface $CellSettings extends sap.ui.core.$ElementSettings {
1241
- /**
1242
- * The value that is displayed in the cell
1243
- */
1244
- displayValue?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1245
-
1246
- /**
1247
- * The celltype of the cell. (HEADER, TITLE, RESULT, ...)
1248
- */
1249
- cellType?:
1250
- | sap.zen.commons.CellType
1251
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1252
-
1253
- /**
1254
- * The Column of the `Cell`
1255
- */
1256
- column?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1257
-
1258
- /**
1259
- * The Icon to be displayed in the `Cell`
1260
- */
1261
- icon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1262
-
1263
- /**
1264
- * The Help Id of the `Cell`. Intended to be used by WebAssist/Enable Now.
1265
- */
1266
- helpId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1267
-
1268
- /**
1269
- * The value state of the `Cell`. This property is used for entry ready cells.
1270
- */
1271
- valueState?:
1272
- | sap.ui.core.ValueState
1273
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1274
-
1385
+ /**
1386
+ * @deprecated (since 1.89.0)
1387
+ *
1388
+ * Horizontal alignment, e.g. of a layout cell's content within the cell's borders. Note that some values
1389
+ * depend on the current locale's writing direction while others do not.
1390
+ */
1391
+ enum HAlign {
1275
1392
  /**
1276
- * The row of the `Cell`.
1393
+ * Aligned towards the beginning of a line, in the current locale's writing direction.
1277
1394
  */
1278
- row?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1279
-
1395
+ Begin = "Begin",
1280
1396
  /**
1281
- * The indent level of the `Cell`.
1397
+ * Horizontally centered.
1282
1398
  */
1283
- displayLevel?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1284
-
1399
+ Center = "Center",
1285
1400
  /**
1286
- * Indicates whether the `Cell` is input enabled.
1401
+ * Aligned towards the end of a line, in the current locale's writing direction.
1287
1402
  */
1288
- inputEnabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1289
-
1403
+ End = "End",
1290
1404
  /**
1291
- * The semantic class of the Cell. The css class associated to the class is put into the cells td.
1405
+ * Left aligned, regardless of the current locale's writing direction.
1292
1406
  */
1293
- semanticClass?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1294
-
1407
+ Left = "Left",
1295
1408
  /**
1296
- * The Alert Level of the cell for exeptional reporting
1409
+ * Right aligned, regardless of the current locale's writing direction.
1297
1410
  */
1298
- alertLevel?:
1299
- | sap.zen.commons.AlertLevel
1300
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1411
+ Right = "Right",
1301
1412
  }
1302
-
1303
- interface $GridSettings extends sap.ui.core.$ControlSettings {
1304
- /**
1305
- * Maximum of rows to be displayed in the Grid
1306
- */
1307
- maxRows?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1308
-
1413
+ /**
1414
+ * @deprecated (since 1.89)
1415
+ * @EXPERIMENTAL
1416
+ *
1417
+ * Padding, e.g. of a layout cell's content within the cell's borders. Note that all options except "None"
1418
+ * include a padding of 2px at the top and bottom, and differ only in the presence of a 4px padding towards
1419
+ * the beginning or end of a line, in the current locale's writing direction.
1420
+ */
1421
+ enum Padding {
1309
1422
  /**
1310
- * Available rows in which the user can scroll
1423
+ * Top and bottom padding of 2px. Padding of 4px towards the beginning of a line, in the current locale's
1424
+ * writing direction, but none towards its end.
1311
1425
  */
1312
- virtualRows?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1313
-
1426
+ Begin = "Begin",
1314
1427
  /**
1315
- * Uniform height of a row in the Grid.
1428
+ * Top and bottom padding of 2px. Padding of 4px towards both the beginning and end of a line.
1316
1429
  */
1317
- rowHeight?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1318
-
1430
+ Both = "Both",
1319
1431
  /**
1320
- * Maximum of columns to be displayed in the Grid.
1432
+ * Top and bottom padding of 2px. Padding of 4px towards the end of a line, in the current locale's writing
1433
+ * direction, but none towards its beginning.
1321
1434
  */
1322
- maxColumns?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1323
-
1435
+ End = "End",
1324
1436
  /**
1325
- * Available columns in which the user can scroll
1437
+ * Top and bottom padding of 2px. No padding towards neither the beginning nor end of a line.
1326
1438
  */
1327
- virtualColumns?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1328
-
1439
+ Neither = "Neither",
1329
1440
  /**
1330
- * The limit of columns transported to the fronted
1441
+ * No padding at all.
1331
1442
  */
1332
- columnLimit?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1333
-
1443
+ None = "None",
1444
+ }
1445
+ /**
1446
+ * @deprecated (since 1.89.0)
1447
+ *
1448
+ * Separation, e.g. of a layout cell from its neighbor, via a vertical gutter of defined width, with or
1449
+ * without a vertical line in its middle.
1450
+ */
1451
+ enum Separation {
1334
1452
  /**
1335
- * The limit of rows transported to the fronted
1453
+ * A large (63px) vertical gutter without a vertical line.
1336
1454
  */
1337
- rowLimit?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1338
-
1455
+ Large = "Large",
1339
1456
  /**
1340
- * Indicator whether the grid should support data entry
1457
+ * A large (63px) vertical gutter with a vertical line in its middle.
1341
1458
  */
1342
- input?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1343
-
1459
+ LargeWithLine = "LargeWithLine",
1344
1460
  /**
1345
- * Number of fixed header rows
1461
+ * A medium (31px) vertical gutter without a vertical line.
1346
1462
  */
1347
- fixedRows?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1348
-
1463
+ Medium = "Medium",
1349
1464
  /**
1350
- * Number of fixed header columns
1465
+ * A medium (31px) vertical gutter with a vertical line in its middle.
1351
1466
  */
1352
- fixedColumns?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1353
-
1467
+ MediumWithLine = "MediumWithLine",
1354
1468
  /**
1355
- * offset column
1469
+ * No gutter at all (0px), and without a vertical line, of course.
1356
1470
  */
1357
- offsetColumn?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1358
-
1471
+ None = "None",
1359
1472
  /**
1360
- * offset row
1473
+ * A small (17px) vertical gutter without a vertical line.
1361
1474
  */
1362
- offsetRow?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
1363
-
1475
+ Small = "Small",
1364
1476
  /**
1365
- * Property for different table formats
1477
+ * A small (17px) vertical gutter with a vertical line in its middle.
1366
1478
  */
1367
- format?:
1368
- | sap.zen.commons.Format
1369
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1370
-
1479
+ SmallWithLine = "SmallWithLine",
1480
+ }
1481
+ /**
1482
+ * @deprecated (since 1.89.0)
1483
+ *
1484
+ * Vertical alignment, e.g. of a layout cell's content within the cell's borders.
1485
+ */
1486
+ enum VAlign {
1371
1487
  /**
1372
- * Cells to be displayed
1488
+ * Aligned at the bottom.
1373
1489
  */
1374
- cells?:
1375
- | sap.zen.commons.Cell[]
1376
- | sap.zen.commons.Cell
1377
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
1378
-
1490
+ Bottom = "Bottom",
1379
1491
  /**
1380
- * Fired when the user scrolls out of the area between available rows and virtual rows
1492
+ * Vertically centered.
1381
1493
  */
1382
- requestMoreRows?: (oEvent: sap.ui.base.Event) => void;
1383
-
1494
+ Middle = "Middle",
1384
1495
  /**
1385
- * Fired when the user scrolls out of the area between available columns and virtual columns
1496
+ * Aligned at the top.
1386
1497
  */
1387
- requestMoreColumns?: (oEvent: sap.ui.base.Event) => void;
1498
+ Top = "Top",
1499
+ }
1500
+ }
1501
+ }
1388
1502
 
1389
- /**
1390
- * Is fired on click, the Pivot table displays the context menu
1391
- */
1392
- rightClick?: (oEvent: sap.ui.base.Event) => void;
1503
+ interface IUI5DefineDependencyNames {
1504
+ "sap/zen/commons/HAlign": undefined;
1393
1505
 
1394
- /**
1395
- * Is fired on hover, when the user enters the cell
1396
- */
1397
- cellEnter?: (oEvent: sap.ui.base.Event) => void;
1506
+ "sap/zen/commons/layout/AbsoluteLayout": undefined;
1398
1507
 
1399
- /**
1400
- * Is fired on hover, when the user leaves the cell
1401
- */
1402
- cellLeave?: (oEvent: sap.ui.base.Event) => void;
1508
+ "sap/zen/commons/layout/MatrixLayout": undefined;
1403
1509
 
1404
- /**
1405
- * Is fired on click on an icon (typically a collapse or expand) symbol
1406
- */
1407
- drill?: (oEvent: sap.ui.base.Event) => void;
1408
- }
1510
+ "sap/zen/commons/layout/MatrixLayoutCell": undefined;
1409
1511
 
1410
- interface $SemanticStyleSettings extends sap.ui.core.$ElementSettings {
1411
- /**
1412
- * The semantic class
1413
- */
1414
- semanticClass?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1512
+ "sap/zen/commons/layout/MatrixLayoutRow": undefined;
1415
1513
 
1416
- /**
1417
- * The associated css class
1418
- */
1419
- cssClass?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1420
- }
1514
+ "sap/zen/commons/layout/PositionContainer": undefined;
1421
1515
 
1422
- /**
1423
- * @SINCE 1.0.0
1424
- * @EXPERIMENTAL
1425
- *
1426
- * Cell of a Grid.
1427
- */
1428
- class Cell extends sap.ui.core.Element {
1429
- /**
1430
- * Creates and initializes a new Cell. settings.
1431
- *
1432
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1433
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1434
- * of the syntax of the settings object.
1435
- */
1436
- constructor(
1437
- /**
1438
- * Initial settings for the new element
1439
- */
1440
- mSettings?: sap.zen.commons.$CellSettings
1441
- );
1442
- /**
1443
- * Creates and initializes a new Cell. settings.
1444
- *
1445
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1446
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1447
- * of the syntax of the settings object.
1448
- */
1449
- constructor(
1450
- /**
1451
- * ID for the new control, generated automatically if no ID is given
1452
- */
1453
- sId?: string,
1454
- /**
1455
- * Initial settings for the new element
1456
- */
1457
- mSettings?: sap.zen.commons.$CellSettings
1458
- );
1459
-
1460
- /**
1461
- * Creates a new subclass of class sap.zen.commons.Cell with name `sClassName` and enriches it with the
1462
- * information contained in `oClassInfo`.
1463
- *
1464
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
1465
- */
1466
- static extend<T extends Record<string, unknown>>(
1467
- /**
1468
- * Name of the class being created
1469
- */
1470
- sClassName: string,
1471
- /**
1472
- * Object literal with information about the class
1473
- */
1474
- oClassInfo?: sap.ClassInfo<T, sap.zen.commons.Cell>,
1475
- /**
1476
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1477
- * used by this class
1478
- */
1479
- FNMetaImpl?: Function
1480
- ): Function;
1481
- /**
1482
- * Returns a metadata object for class sap.zen.commons.Cell.
1483
- */
1484
- static getMetadata(): sap.ui.core.ElementMetadata;
1485
- /**
1486
- * Gets current value of property {@link #getAlertLevel alertLevel}.
1487
- *
1488
- * The Alert Level of the cell for exeptional reporting
1489
- */
1490
- getAlertLevel(): sap.zen.commons.AlertLevel;
1491
- /**
1492
- * Gets current value of property {@link #getCellType cellType}.
1493
- *
1494
- * The celltype of the cell. (HEADER, TITLE, RESULT, ...)
1495
- *
1496
- * Default value is `STANDARD`.
1497
- */
1498
- getCellType(): sap.zen.commons.CellType;
1499
- /**
1500
- * Gets current value of property {@link #getColumn column}.
1501
- *
1502
- * The Column of the `Cell`
1503
- *
1504
- * Default value is `0`.
1505
- */
1506
- getColumn(): int;
1507
- /**
1508
- * Gets current value of property {@link #getDisplayLevel displayLevel}.
1509
- *
1510
- * The indent level of the `Cell`.
1511
- */
1512
- getDisplayLevel(): int;
1513
- /**
1514
- * Gets current value of property {@link #getDisplayValue displayValue}.
1515
- *
1516
- * The value that is displayed in the cell
1517
- */
1518
- getDisplayValue(): string;
1519
- /**
1520
- * Gets current value of property {@link #getHelpId helpId}.
1521
- *
1522
- * The Help Id of the `Cell`. Intended to be used by WebAssist/Enable Now.
1523
- */
1524
- getHelpId(): string;
1525
- /**
1526
- * Gets current value of property {@link #getIcon icon}.
1527
- *
1528
- * The Icon to be displayed in the `Cell`
1529
- */
1530
- getIcon(): string;
1531
- /**
1532
- * Gets current value of property {@link #getInputEnabled inputEnabled}.
1533
- *
1534
- * Indicates whether the `Cell` is input enabled.
1535
- */
1536
- getInputEnabled(): boolean;
1537
- /**
1538
- * Gets current value of property {@link #getRow row}.
1539
- *
1540
- * The row of the `Cell`.
1541
- *
1542
- * Default value is `0`.
1543
- */
1544
- getRow(): int;
1545
- /**
1546
- * Gets current value of property {@link #getSemanticClass semanticClass}.
1547
- *
1548
- * The semantic class of the Cell. The css class associated to the class is put into the cells td.
1549
- */
1550
- getSemanticClass(): string;
1551
- /**
1552
- * Gets current value of property {@link #getValueState valueState}.
1553
- *
1554
- * The value state of the `Cell`. This property is used for entry ready cells.
1555
- */
1556
- getValueState(): sap.ui.core.ValueState;
1557
- /**
1558
- * Sets a new value for property {@link #getAlertLevel alertLevel}.
1559
- *
1560
- * The Alert Level of the cell for exeptional reporting
1561
- *
1562
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1563
- */
1564
- setAlertLevel(
1565
- /**
1566
- * New value for property `alertLevel`
1567
- */
1568
- sAlertLevel: sap.zen.commons.AlertLevel
1569
- ): this;
1570
- /**
1571
- * Sets a new value for property {@link #getCellType cellType}.
1572
- *
1573
- * The celltype of the cell. (HEADER, TITLE, RESULT, ...)
1574
- *
1575
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1576
- *
1577
- * Default value is `STANDARD`.
1578
- */
1579
- setCellType(
1580
- /**
1581
- * New value for property `cellType`
1582
- */
1583
- sCellType?: sap.zen.commons.CellType
1584
- ): this;
1585
- /**
1586
- * Sets a new value for property {@link #getColumn column}.
1587
- *
1588
- * The Column of the `Cell`
1589
- *
1590
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1591
- *
1592
- * Default value is `0`.
1593
- */
1594
- setColumn(
1595
- /**
1596
- * New value for property `column`
1597
- */
1598
- iColumn?: int
1599
- ): this;
1600
- /**
1601
- * Sets a new value for property {@link #getDisplayLevel displayLevel}.
1602
- *
1603
- * The indent level of the `Cell`.
1604
- *
1605
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1606
- */
1607
- setDisplayLevel(
1608
- /**
1609
- * New value for property `displayLevel`
1610
- */
1611
- iDisplayLevel: int
1612
- ): this;
1613
- /**
1614
- * Sets a new value for property {@link #getDisplayValue displayValue}.
1615
- *
1616
- * The value that is displayed in the cell
1617
- *
1618
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1619
- */
1620
- setDisplayValue(
1621
- /**
1622
- * New value for property `displayValue`
1623
- */
1624
- sDisplayValue: string
1625
- ): this;
1626
- /**
1627
- * Sets a new value for property {@link #getHelpId helpId}.
1628
- *
1629
- * The Help Id of the `Cell`. Intended to be used by WebAssist/Enable Now.
1630
- *
1631
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1632
- */
1633
- setHelpId(
1634
- /**
1635
- * New value for property `helpId`
1636
- */
1637
- sHelpId: string
1638
- ): this;
1639
- /**
1640
- * Sets a new value for property {@link #getIcon icon}.
1641
- *
1642
- * The Icon to be displayed in the `Cell`
1643
- *
1644
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1645
- */
1646
- setIcon(
1647
- /**
1648
- * New value for property `icon`
1649
- */
1650
- sIcon: string
1651
- ): this;
1652
- /**
1653
- * Sets a new value for property {@link #getInputEnabled inputEnabled}.
1654
- *
1655
- * Indicates whether the `Cell` is input enabled.
1656
- *
1657
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1658
- */
1659
- setInputEnabled(
1660
- /**
1661
- * New value for property `inputEnabled`
1662
- */
1663
- bInputEnabled: boolean
1664
- ): this;
1665
- /**
1666
- * Sets a new value for property {@link #getRow row}.
1667
- *
1668
- * The row of the `Cell`.
1669
- *
1670
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1671
- *
1672
- * Default value is `0`.
1673
- */
1674
- setRow(
1675
- /**
1676
- * New value for property `row`
1677
- */
1678
- iRow?: int
1679
- ): this;
1680
- /**
1681
- * Sets a new value for property {@link #getSemanticClass semanticClass}.
1682
- *
1683
- * The semantic class of the Cell. The css class associated to the class is put into the cells td.
1684
- *
1685
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1686
- */
1687
- setSemanticClass(
1688
- /**
1689
- * New value for property `semanticClass`
1690
- */
1691
- sSemanticClass: string
1692
- ): this;
1693
- /**
1694
- * Sets a new value for property {@link #getValueState valueState}.
1695
- *
1696
- * The value state of the `Cell`. This property is used for entry ready cells.
1697
- *
1698
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1699
- */
1700
- setValueState(
1701
- /**
1702
- * New value for property `valueState`
1703
- */
1704
- sValueState: sap.ui.core.ValueState
1705
- ): this;
1706
- }
1707
- /**
1708
- * @EXPERIMENTAL
1709
- *
1710
- * Enables users to view and edit data in a grid. The grid is mimicking the familiar display of spreadsheets.
1711
- *
1712
- * Overview:
1713
- *
1714
- * The user can view the data in the grid, trigger actions via a context menu, enter data into input ready
1715
- * cells.
1716
- *
1717
- * Usage:
1718
- *
1719
- * The `Grid` is mainly intended as a helper control for the `PivotTable`.
1720
- */
1721
- class Grid extends sap.ui.core.Control {
1722
- /**
1723
- * Constructor for a new `Grid`.
1724
- *
1725
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1726
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1727
- * of the syntax of the settings object.
1728
- */
1729
- constructor(
1730
- /**
1731
- * Initial settings for the new control
1732
- */
1733
- mSettings?: sap.zen.commons.$GridSettings
1734
- );
1735
- /**
1736
- * Constructor for a new `Grid`.
1737
- *
1738
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1739
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1740
- * of the syntax of the settings object.
1741
- */
1742
- constructor(
1743
- /**
1744
- * ID for the new control, generated automatically if no ID is given
1745
- */
1746
- sId?: string,
1747
- /**
1748
- * Initial settings for the new control
1749
- */
1750
- mSettings?: sap.zen.commons.$GridSettings
1751
- );
1752
-
1753
- /**
1754
- * Creates a new subclass of class sap.zen.commons.Grid with name `sClassName` and enriches it with the
1755
- * information contained in `oClassInfo`.
1756
- *
1757
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1758
- */
1759
- static extend<T extends Record<string, unknown>>(
1760
- /**
1761
- * Name of the class being created
1762
- */
1763
- sClassName: string,
1764
- /**
1765
- * Object literal with information about the class
1766
- */
1767
- oClassInfo?: sap.ClassInfo<T, sap.zen.commons.Grid>,
1768
- /**
1769
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1770
- * used by this class
1771
- */
1772
- FNMetaImpl?: Function
1773
- ): Function;
1774
- /**
1775
- * Returns a metadata object for class sap.zen.commons.Grid.
1776
- */
1777
- static getMetadata(): sap.ui.core.ElementMetadata;
1778
- /**
1779
- * Adds some cell to the aggregation {@link #getCells cells}.
1780
- */
1781
- addCell(
1782
- /**
1783
- * The cell to add; if empty, nothing is inserted
1784
- */
1785
- oCell: sap.zen.commons.Cell
1786
- ): this;
1787
- /**
1788
- * Attaches event handler `fnFunction` to the {@link #event:cellEnter cellEnter} event of this `sap.zen.commons.Grid`.
1789
- *
1790
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1791
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1792
- *
1793
- * Is fired on hover, when the user enters the cell
1794
- */
1795
- attachCellEnter(
1796
- /**
1797
- * An application-specific payload object that will be passed to the event handler along with the event
1798
- * object when firing the event
1799
- */
1800
- oData: object,
1801
- /**
1802
- * The function to be called when the event occurs
1803
- */
1804
- fnFunction: (p1: sap.ui.base.Event) => void,
1805
- /**
1806
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1807
- */
1808
- oListener?: object
1809
- ): this;
1810
- /**
1811
- * Attaches event handler `fnFunction` to the {@link #event:cellEnter cellEnter} event of this `sap.zen.commons.Grid`.
1812
- *
1813
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1814
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1815
- *
1816
- * Is fired on hover, when the user enters the cell
1817
- */
1818
- attachCellEnter(
1819
- /**
1820
- * The function to be called when the event occurs
1821
- */
1822
- fnFunction: (p1: sap.ui.base.Event) => void,
1823
- /**
1824
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1825
- */
1826
- oListener?: object
1827
- ): this;
1828
- /**
1829
- * Attaches event handler `fnFunction` to the {@link #event:cellLeave cellLeave} event of this `sap.zen.commons.Grid`.
1830
- *
1831
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1832
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1833
- *
1834
- * Is fired on hover, when the user leaves the cell
1835
- */
1836
- attachCellLeave(
1837
- /**
1838
- * An application-specific payload object that will be passed to the event handler along with the event
1839
- * object when firing the event
1840
- */
1841
- oData: object,
1842
- /**
1843
- * The function to be called when the event occurs
1844
- */
1845
- fnFunction: (p1: sap.ui.base.Event) => void,
1846
- /**
1847
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1848
- */
1849
- oListener?: object
1850
- ): this;
1851
- /**
1852
- * Attaches event handler `fnFunction` to the {@link #event:cellLeave cellLeave} event of this `sap.zen.commons.Grid`.
1853
- *
1854
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1855
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1856
- *
1857
- * Is fired on hover, when the user leaves the cell
1858
- */
1859
- attachCellLeave(
1860
- /**
1861
- * The function to be called when the event occurs
1862
- */
1863
- fnFunction: (p1: sap.ui.base.Event) => void,
1864
- /**
1865
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1866
- */
1867
- oListener?: object
1868
- ): this;
1869
- /**
1870
- * Attaches event handler `fnFunction` to the {@link #event:drill drill} event of this `sap.zen.commons.Grid`.
1871
- *
1872
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1873
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1874
- *
1875
- * Is fired on click on an icon (typically a collapse or expand) symbol
1876
- */
1877
- attachDrill(
1878
- /**
1879
- * An application-specific payload object that will be passed to the event handler along with the event
1880
- * object when firing the event
1881
- */
1882
- oData: object,
1883
- /**
1884
- * The function to be called when the event occurs
1885
- */
1886
- fnFunction: (p1: sap.ui.base.Event) => void,
1887
- /**
1888
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1889
- */
1890
- oListener?: object
1891
- ): this;
1892
- /**
1893
- * Attaches event handler `fnFunction` to the {@link #event:drill drill} event of this `sap.zen.commons.Grid`.
1894
- *
1895
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1896
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1897
- *
1898
- * Is fired on click on an icon (typically a collapse or expand) symbol
1899
- */
1900
- attachDrill(
1901
- /**
1902
- * The function to be called when the event occurs
1903
- */
1904
- fnFunction: (p1: sap.ui.base.Event) => void,
1905
- /**
1906
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1907
- */
1908
- oListener?: object
1909
- ): this;
1910
- /**
1911
- * Attaches event handler `fnFunction` to the {@link #event:requestMoreColumns requestMoreColumns} event
1912
- * of this `sap.zen.commons.Grid`.
1913
- *
1914
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1915
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1916
- *
1917
- * Fired when the user scrolls out of the area between available columns and virtual columns
1918
- */
1919
- attachRequestMoreColumns(
1920
- /**
1921
- * An application-specific payload object that will be passed to the event handler along with the event
1922
- * object when firing the event
1923
- */
1924
- oData: object,
1925
- /**
1926
- * The function to be called when the event occurs
1927
- */
1928
- fnFunction: (p1: sap.ui.base.Event) => void,
1929
- /**
1930
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1931
- */
1932
- oListener?: object
1933
- ): this;
1934
- /**
1935
- * Attaches event handler `fnFunction` to the {@link #event:requestMoreColumns requestMoreColumns} event
1936
- * of this `sap.zen.commons.Grid`.
1937
- *
1938
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1939
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1940
- *
1941
- * Fired when the user scrolls out of the area between available columns and virtual columns
1942
- */
1943
- attachRequestMoreColumns(
1944
- /**
1945
- * The function to be called when the event occurs
1946
- */
1947
- fnFunction: (p1: sap.ui.base.Event) => void,
1948
- /**
1949
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1950
- */
1951
- oListener?: object
1952
- ): this;
1953
- /**
1954
- * Attaches event handler `fnFunction` to the {@link #event:requestMoreRows requestMoreRows} event of this
1955
- * `sap.zen.commons.Grid`.
1956
- *
1957
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1958
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1959
- *
1960
- * Fired when the user scrolls out of the area between available rows and virtual rows
1961
- */
1962
- attachRequestMoreRows(
1963
- /**
1964
- * An application-specific payload object that will be passed to the event handler along with the event
1965
- * object when firing the event
1966
- */
1967
- oData: object,
1968
- /**
1969
- * The function to be called when the event occurs
1970
- */
1971
- fnFunction: (p1: sap.ui.base.Event) => void,
1972
- /**
1973
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1974
- */
1975
- oListener?: object
1976
- ): this;
1977
- /**
1978
- * Attaches event handler `fnFunction` to the {@link #event:requestMoreRows requestMoreRows} event of this
1979
- * `sap.zen.commons.Grid`.
1980
- *
1981
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1982
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1983
- *
1984
- * Fired when the user scrolls out of the area between available rows and virtual rows
1985
- */
1986
- attachRequestMoreRows(
1987
- /**
1988
- * The function to be called when the event occurs
1989
- */
1990
- fnFunction: (p1: sap.ui.base.Event) => void,
1991
- /**
1992
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1993
- */
1994
- oListener?: object
1995
- ): this;
1996
- /**
1997
- * Attaches event handler `fnFunction` to the {@link #event:rightClick rightClick} event of this `sap.zen.commons.Grid`.
1998
- *
1999
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2000
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
2001
- *
2002
- * Is fired on click, the Pivot table displays the context menu
2003
- */
2004
- attachRightClick(
2005
- /**
2006
- * An application-specific payload object that will be passed to the event handler along with the event
2007
- * object when firing the event
2008
- */
2009
- oData: object,
2010
- /**
2011
- * The function to be called when the event occurs
2012
- */
2013
- fnFunction: (p1: sap.ui.base.Event) => void,
2014
- /**
2015
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
2016
- */
2017
- oListener?: object
2018
- ): this;
2019
- /**
2020
- * Attaches event handler `fnFunction` to the {@link #event:rightClick rightClick} event of this `sap.zen.commons.Grid`.
2021
- *
2022
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2023
- * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
2024
- *
2025
- * Is fired on click, the Pivot table displays the context menu
2026
- */
2027
- attachRightClick(
2028
- /**
2029
- * The function to be called when the event occurs
2030
- */
2031
- fnFunction: (p1: sap.ui.base.Event) => void,
2032
- /**
2033
- * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
2034
- */
2035
- oListener?: object
2036
- ): this;
2037
- /**
2038
- * Binds aggregation {@link #getCells cells} to model data.
2039
- *
2040
- * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
2041
- * of the possible properties of `oBindingInfo`.
2042
- */
2043
- bindCells(
2044
- /**
2045
- * The binding information
2046
- */
2047
- oBindingInfo: sap.ui.base.ManagedObject.AggregationBindingInfo
2048
- ): this;
2049
- /**
2050
- * Destroys all the cells in the aggregation {@link #getCells cells}.
2051
- */
2052
- destroyCells(): this;
2053
- /**
2054
- * Detaches event handler `fnFunction` from the {@link #event:cellEnter cellEnter} event of this `sap.zen.commons.Grid`.
2055
- *
2056
- * The passed function and listener object must match the ones used for event registration.
2057
- */
2058
- detachCellEnter(
2059
- /**
2060
- * The function to be called, when the event occurs
2061
- */
2062
- fnFunction: (p1: sap.ui.base.Event) => void,
2063
- /**
2064
- * Context object on which the given function had to be called
2065
- */
2066
- oListener?: object
2067
- ): this;
2068
- /**
2069
- * Detaches event handler `fnFunction` from the {@link #event:cellLeave cellLeave} event of this `sap.zen.commons.Grid`.
2070
- *
2071
- * The passed function and listener object must match the ones used for event registration.
2072
- */
2073
- detachCellLeave(
2074
- /**
2075
- * The function to be called, when the event occurs
2076
- */
2077
- fnFunction: (p1: sap.ui.base.Event) => void,
2078
- /**
2079
- * Context object on which the given function had to be called
2080
- */
2081
- oListener?: object
2082
- ): this;
2083
- /**
2084
- * Detaches event handler `fnFunction` from the {@link #event:drill drill} event of this `sap.zen.commons.Grid`.
2085
- *
2086
- * The passed function and listener object must match the ones used for event registration.
2087
- */
2088
- detachDrill(
2089
- /**
2090
- * The function to be called, when the event occurs
2091
- */
2092
- fnFunction: (p1: sap.ui.base.Event) => void,
2093
- /**
2094
- * Context object on which the given function had to be called
2095
- */
2096
- oListener?: object
2097
- ): this;
2098
- /**
2099
- * Detaches event handler `fnFunction` from the {@link #event:requestMoreColumns requestMoreColumns} event
2100
- * of this `sap.zen.commons.Grid`.
2101
- *
2102
- * The passed function and listener object must match the ones used for event registration.
2103
- */
2104
- detachRequestMoreColumns(
2105
- /**
2106
- * The function to be called, when the event occurs
2107
- */
2108
- fnFunction: (p1: sap.ui.base.Event) => void,
2109
- /**
2110
- * Context object on which the given function had to be called
2111
- */
2112
- oListener?: object
2113
- ): this;
2114
- /**
2115
- * Detaches event handler `fnFunction` from the {@link #event:requestMoreRows requestMoreRows} event of
2116
- * this `sap.zen.commons.Grid`.
2117
- *
2118
- * The passed function and listener object must match the ones used for event registration.
2119
- */
2120
- detachRequestMoreRows(
2121
- /**
2122
- * The function to be called, when the event occurs
2123
- */
2124
- fnFunction: (p1: sap.ui.base.Event) => void,
2125
- /**
2126
- * Context object on which the given function had to be called
2127
- */
2128
- oListener?: object
2129
- ): this;
2130
- /**
2131
- * Detaches event handler `fnFunction` from the {@link #event:rightClick rightClick} event of this `sap.zen.commons.Grid`.
2132
- *
2133
- * The passed function and listener object must match the ones used for event registration.
2134
- */
2135
- detachRightClick(
2136
- /**
2137
- * The function to be called, when the event occurs
2138
- */
2139
- fnFunction: (p1: sap.ui.base.Event) => void,
2140
- /**
2141
- * Context object on which the given function had to be called
2142
- */
2143
- oListener?: object
2144
- ): this;
2145
- /**
2146
- * Fires event {@link #event:cellEnter cellEnter} to attached listeners.
2147
- */
2148
- fireCellEnter(
2149
- /**
2150
- * Parameters to pass along with the event
2151
- */
2152
- mParameters?: {
2153
- /**
2154
- * The cell which the user entered
2155
- */
2156
- cell?: sap.zen.commons.Cell;
2157
- /**
2158
- * The dom element which the user entered
2159
- */
2160
- element?: object;
2161
- }
2162
- ): this;
2163
- /**
2164
- * Fires event {@link #event:cellLeave cellLeave} to attached listeners.
2165
- */
2166
- fireCellLeave(
2167
- /**
2168
- * Parameters to pass along with the event
2169
- */
2170
- mParameters?: {
2171
- /**
2172
- * The cell which the user left
2173
- */
2174
- cell?: sap.zen.commons.Cell;
2175
- }
2176
- ): this;
2177
- /**
2178
- * Fires event {@link #event:drill drill} to attached listeners.
2179
- */
2180
- fireDrill(
2181
- /**
2182
- * Parameters to pass along with the event
2183
- */
2184
- mParameters?: {
2185
- /**
2186
- * The cell with the icon
2187
- */
2188
- cell?: sap.zen.commons.Cell;
2189
- }
2190
- ): this;
2191
- /**
2192
- * Fires event {@link #event:requestMoreColumns requestMoreColumns} to attached listeners.
2193
- */
2194
- fireRequestMoreColumns(
2195
- /**
2196
- * Parameters to pass along with the event
2197
- */
2198
- mParameters?: {
2199
- /**
2200
- * Number of current column
2201
- */
2202
- currentColumn?: int;
2203
- /**
2204
- * Promise Resolver to be resolved or rejected when data was fetched
2205
- */
2206
- defered?: object;
2207
- }
2208
- ): this;
2209
- /**
2210
- * Fires event {@link #event:requestMoreRows requestMoreRows} to attached listeners.
2211
- */
2212
- fireRequestMoreRows(
2213
- /**
2214
- * Parameters to pass along with the event
2215
- */
2216
- mParameters?: {
2217
- /**
2218
- * Number of current row
2219
- */
2220
- currentRow?: int;
2221
- /**
2222
- * Promise Resolver to be resolved or rejected when data was fetched
2223
- */
2224
- defered?: object;
2225
- }
2226
- ): this;
2227
- /**
2228
- * Fires event {@link #event:rightClick rightClick} to attached listeners.
2229
- */
2230
- fireRightClick(
2231
- /**
2232
- * Parameters to pass along with the event
2233
- */
2234
- mParameters?: {
2235
- /**
2236
- * The cell on which the user clicked
2237
- */
2238
- cell?: sap.zen.commons.Cell;
2239
- /**
2240
- * The link which renders the clicked cell
2241
- */
2242
- link?: sap.m.Link;
2243
- }
2244
- ): this;
2245
- /**
2246
- * Gets content of aggregation {@link #getCells cells}.
2247
- *
2248
- * Cells to be displayed
2249
- */
2250
- getCells(): sap.zen.commons.Cell[];
2251
- /**
2252
- * Gets current value of property {@link #getColumnLimit columnLimit}.
2253
- *
2254
- * The limit of columns transported to the fronted
2255
- *
2256
- * Default value is `20`.
2257
- */
2258
- getColumnLimit(): int;
2259
- /**
2260
- * Gets current value of property {@link #getFixedColumns fixedColumns}.
2261
- *
2262
- * Number of fixed header columns
2263
- *
2264
- * Default value is `0`.
2265
- */
2266
- getFixedColumns(): int;
2267
- /**
2268
- * Gets current value of property {@link #getFixedRows fixedRows}.
2269
- *
2270
- * Number of fixed header rows
2271
- *
2272
- * Default value is `0`.
2273
- */
2274
- getFixedRows(): int;
2275
- /**
2276
- * Gets current value of property {@link #getFormat format}.
2277
- *
2278
- * Property for different table formats
2279
- *
2280
- * Default value is `ExcelStyle`.
2281
- */
2282
- getFormat(): sap.zen.commons.Format;
2283
- /**
2284
- * Gets current value of property {@link #getInput input}.
2285
- *
2286
- * Indicator whether the grid should support data entry
2287
- *
2288
- * Default value is `false`.
2289
- */
2290
- getInput(): boolean;
2291
- /**
2292
- * Gets current value of property {@link #getMaxColumns maxColumns}.
2293
- *
2294
- * Maximum of columns to be displayed in the Grid.
2295
- *
2296
- * Default value is `20`.
2297
- */
2298
- getMaxColumns(): int;
2299
- /**
2300
- * Gets current value of property {@link #getMaxRows maxRows}.
2301
- *
2302
- * Maximum of rows to be displayed in the Grid
2303
- *
2304
- * Default value is `15`.
2305
- */
2306
- getMaxRows(): int;
2307
- /**
2308
- * Gets current value of property {@link #getOffsetColumn offsetColumn}.
2309
- *
2310
- * offset column
2311
- *
2312
- * Default value is `0`.
2313
- */
2314
- getOffsetColumn(): int;
2315
- /**
2316
- * Gets current value of property {@link #getOffsetRow offsetRow}.
2317
- *
2318
- * offset row
2319
- *
2320
- * Default value is `0`.
2321
- */
2322
- getOffsetRow(): int;
2323
- /**
2324
- * Gets current value of property {@link #getRowHeight rowHeight}.
2325
- *
2326
- * Uniform height of a row in the Grid.
2327
- *
2328
- * Default value is `25`.
2329
- */
2330
- getRowHeight(): int;
2331
- /**
2332
- * Gets current value of property {@link #getRowLimit rowLimit}.
2333
- *
2334
- * The limit of rows transported to the fronted
2335
- *
2336
- * Default value is `125`.
2337
- */
2338
- getRowLimit(): int;
2339
- /**
2340
- * Gets current value of property {@link #getVirtualColumns virtualColumns}.
2341
- *
2342
- * Available columns in which the user can scroll
2343
- */
2344
- getVirtualColumns(): int;
2345
- /**
2346
- * Gets current value of property {@link #getVirtualRows virtualRows}.
2347
- *
2348
- * Available rows in which the user can scroll
2349
- */
2350
- getVirtualRows(): int;
2351
- /**
2352
- * Checks for the provided `sap.zen.commons.Cell` in the aggregation {@link #getCells cells}. and returns
2353
- * its index if found or -1 otherwise.
2354
- */
2355
- indexOfCell(
2356
- /**
2357
- * The cell whose index is looked for
2358
- */
2359
- oCell: sap.zen.commons.Cell
2360
- ): int;
2361
- /**
2362
- * Inserts a cell into the aggregation {@link #getCells cells}.
2363
- */
2364
- insertCell(
2365
- /**
2366
- * The cell to insert; if empty, nothing is inserted
2367
- */
2368
- oCell: sap.zen.commons.Cell,
2369
- /**
2370
- * The `0`-based index the cell should be inserted at; for a negative value of `iIndex`, the cell is inserted
2371
- * at position 0; for a value greater than the current size of the aggregation, the cell is inserted at
2372
- * the last position
2373
- */
2374
- iIndex: int
2375
- ): this;
2376
- /**
2377
- * Removes all the controls from the aggregation {@link #getCells cells}.
2378
- *
2379
- * Additionally, it unregisters them from the hosting UIArea.
2380
- */
2381
- removeAllCells(): sap.zen.commons.Cell[];
2382
- /**
2383
- * Removes a cell from the aggregation {@link #getCells cells}.
2384
- */
2385
- removeCell(
2386
- /**
2387
- * The cell to remove or its index or id
2388
- */
2389
- vCell: int | string | sap.zen.commons.Cell
2390
- ): sap.zen.commons.Cell;
2391
- /**
2392
- * Sets a new value for property {@link #getColumnLimit columnLimit}.
2393
- *
2394
- * The limit of columns transported to the fronted
2395
- *
2396
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2397
- *
2398
- * Default value is `20`.
2399
- */
2400
- setColumnLimit(
2401
- /**
2402
- * New value for property `columnLimit`
2403
- */
2404
- iColumnLimit?: int
2405
- ): this;
2406
- /**
2407
- * Sets a new value for property {@link #getFixedColumns fixedColumns}.
2408
- *
2409
- * Number of fixed header columns
2410
- *
2411
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2412
- *
2413
- * Default value is `0`.
2414
- */
2415
- setFixedColumns(
2416
- /**
2417
- * New value for property `fixedColumns`
2418
- */
2419
- iFixedColumns?: int
2420
- ): this;
2421
- /**
2422
- * Sets a new value for property {@link #getFixedRows fixedRows}.
2423
- *
2424
- * Number of fixed header rows
2425
- *
2426
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2427
- *
2428
- * Default value is `0`.
2429
- */
2430
- setFixedRows(
2431
- /**
2432
- * New value for property `fixedRows`
2433
- */
2434
- iFixedRows?: int
2435
- ): this;
2436
- /**
2437
- * Sets a new value for property {@link #getFormat format}.
2438
- *
2439
- * Property for different table formats
2440
- *
2441
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2442
- *
2443
- * Default value is `ExcelStyle`.
2444
- */
2445
- setFormat(
2446
- /**
2447
- * New value for property `format`
2448
- */
2449
- sFormat?: sap.zen.commons.Format
2450
- ): this;
2451
- /**
2452
- * Sets a new value for property {@link #getInput input}.
2453
- *
2454
- * Indicator whether the grid should support data entry
2455
- *
2456
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2457
- *
2458
- * Default value is `false`.
2459
- */
2460
- setInput(
2461
- /**
2462
- * New value for property `input`
2463
- */
2464
- bInput?: boolean
2465
- ): this;
2466
- /**
2467
- * Sets a new value for property {@link #getMaxColumns maxColumns}.
2468
- *
2469
- * Maximum of columns to be displayed in the Grid.
2470
- *
2471
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2472
- *
2473
- * Default value is `20`.
2474
- */
2475
- setMaxColumns(
2476
- /**
2477
- * New value for property `maxColumns`
2478
- */
2479
- iMaxColumns?: int
2480
- ): this;
2481
- /**
2482
- * Sets a new value for property {@link #getMaxRows maxRows}.
2483
- *
2484
- * Maximum of rows to be displayed in the Grid
2485
- *
2486
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2487
- *
2488
- * Default value is `15`.
2489
- */
2490
- setMaxRows(
2491
- /**
2492
- * New value for property `maxRows`
2493
- */
2494
- iMaxRows?: int
2495
- ): this;
2496
- /**
2497
- * Sets a new value for property {@link #getOffsetColumn offsetColumn}.
2498
- *
2499
- * offset column
2500
- *
2501
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2502
- *
2503
- * Default value is `0`.
2504
- */
2505
- setOffsetColumn(
2506
- /**
2507
- * New value for property `offsetColumn`
2508
- */
2509
- iOffsetColumn?: int
2510
- ): this;
2511
- /**
2512
- * Sets a new value for property {@link #getOffsetRow offsetRow}.
2513
- *
2514
- * offset row
2515
- *
2516
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2517
- *
2518
- * Default value is `0`.
2519
- */
2520
- setOffsetRow(
2521
- /**
2522
- * New value for property `offsetRow`
2523
- */
2524
- iOffsetRow?: int
2525
- ): this;
2526
- /**
2527
- * Sets a new value for property {@link #getRowHeight rowHeight}.
2528
- *
2529
- * Uniform height of a row in the Grid.
2530
- *
2531
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2532
- *
2533
- * Default value is `25`.
2534
- */
2535
- setRowHeight(
2536
- /**
2537
- * New value for property `rowHeight`
2538
- */
2539
- iRowHeight?: int
2540
- ): this;
2541
- /**
2542
- * Sets a new value for property {@link #getRowLimit rowLimit}.
2543
- *
2544
- * The limit of rows transported to the fronted
2545
- *
2546
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2547
- *
2548
- * Default value is `125`.
2549
- */
2550
- setRowLimit(
2551
- /**
2552
- * New value for property `rowLimit`
2553
- */
2554
- iRowLimit?: int
2555
- ): this;
2556
- /**
2557
- * Sets a new value for property {@link #getVirtualColumns virtualColumns}.
2558
- *
2559
- * Available columns in which the user can scroll
2560
- *
2561
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2562
- */
2563
- setVirtualColumns(
2564
- /**
2565
- * New value for property `virtualColumns`
2566
- */
2567
- iVirtualColumns: int
2568
- ): this;
2569
- /**
2570
- * Sets a new value for property {@link #getVirtualRows virtualRows}.
2571
- *
2572
- * Available rows in which the user can scroll
2573
- *
2574
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2575
- */
2576
- setVirtualRows(
2577
- /**
2578
- * New value for property `virtualRows`
2579
- */
2580
- iVirtualRows: int
2581
- ): this;
2582
- /**
2583
- * Unbinds aggregation {@link #getCells cells} from model data.
2584
- */
2585
- unbindCells(): this;
2586
- }
2587
- /**
2588
- * @SINCE 1.89
2589
- * @EXPERIMENTAL (since 1.89)
2590
- *
2591
- * Semantic Style of a Grid.
2592
- */
2593
- class SemanticStyle extends sap.ui.core.Element {
2594
- /**
2595
- * Creates and initializes a new Semantic Style. settings.
2596
- *
2597
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2598
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2599
- * of the syntax of the settings object.
2600
- */
2601
- constructor(
2602
- /**
2603
- * Initial settings for the new element
2604
- */
2605
- mSettings?: sap.zen.commons.$SemanticStyleSettings
2606
- );
2607
- /**
2608
- * Creates and initializes a new Semantic Style. settings.
2609
- *
2610
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2611
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2612
- * of the syntax of the settings object.
2613
- */
2614
- constructor(
2615
- /**
2616
- * ID for the new element, generated automatically if no ID is given
2617
- */
2618
- sId?: string,
2619
- /**
2620
- * Initial settings for the new element
2621
- */
2622
- mSettings?: sap.zen.commons.$SemanticStyleSettings
2623
- );
2624
-
2625
- /**
2626
- * Creates a new subclass of class sap.zen.commons.SemanticStyle with name `sClassName` and enriches it
2627
- * with the information contained in `oClassInfo`.
2628
- *
2629
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
2630
- */
2631
- static extend<T extends Record<string, unknown>>(
2632
- /**
2633
- * Name of the class being created
2634
- */
2635
- sClassName: string,
2636
- /**
2637
- * Object literal with information about the class
2638
- */
2639
- oClassInfo?: sap.ClassInfo<T, sap.zen.commons.SemanticStyle>,
2640
- /**
2641
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2642
- * used by this class
2643
- */
2644
- FNMetaImpl?: Function
2645
- ): Function;
2646
- /**
2647
- * Returns a metadata object for class sap.zen.commons.SemanticStyle.
2648
- */
2649
- static getMetadata(): sap.ui.core.ElementMetadata;
2650
- /**
2651
- * Gets current value of property {@link #getCssClass cssClass}.
2652
- *
2653
- * The associated css class
2654
- */
2655
- getCssClass(): string;
2656
- /**
2657
- * Gets current value of property {@link #getSemanticClass semanticClass}.
2658
- *
2659
- * The semantic class
2660
- */
2661
- getSemanticClass(): string;
2662
- /**
2663
- * Sets a new value for property {@link #getCssClass cssClass}.
2664
- *
2665
- * The associated css class
2666
- *
2667
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2668
- */
2669
- setCssClass(
2670
- /**
2671
- * New value for property `cssClass`
2672
- */
2673
- sCssClass: string
2674
- ): this;
2675
- /**
2676
- * Sets a new value for property {@link #getSemanticClass semanticClass}.
2677
- *
2678
- * The semantic class
2679
- *
2680
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2681
- */
2682
- setSemanticClass(
2683
- /**
2684
- * New value for property `semanticClass`
2685
- */
2686
- sSemanticClass: string
2687
- ): this;
2688
- }
2689
- /**
2690
- * Alert Level.
2691
- */
2692
- enum AlertLevel {
2693
- /**
2694
- * Bad 1
2695
- */
2696
- BAD_1 = "7",
2697
- /**
2698
- * Bad 2
2699
- */
2700
- BAD_2 = "8",
2701
- /**
2702
- * Bad 3
2703
- */
2704
- BAD_3 = "9",
2705
- /**
2706
- * Critical 1
2707
- */
2708
- CRITICAL_1 = "4",
2709
- /**
2710
- * Critical 2
2711
- */
2712
- CRITICAL_2 = "5",
2713
- /**
2714
- * Critical 3
2715
- */
2716
- CRITICAL_3 = "6",
2717
- /**
2718
- * Good 1
2719
- */
2720
- GOOD_1 = "1",
2721
- /**
2722
- * Good 2
2723
- */
2724
- GOOD_2 = "2",
2725
- /**
2726
- * Good 3
2727
- */
2728
- GOOD_3 = "3",
2729
- /**
2730
- * Normal
2731
- */
2732
- NORMAL = "0",
2733
- }
2734
- /**
2735
- * Types of a grid cell.
2736
- */
2737
- enum CellType {
2738
- /**
2739
- * A data cell, representing value with a critical flavour
2740
- */
2741
- CRITICAL = "Critical",
2742
- /**
2743
- * An empty data cell
2744
- */
2745
- EMPTY = "Empty",
2746
- /**
2747
- * A header cell, representing a member of a (virtual) dimension
2748
- */
2749
- HEADER = "Header",
2750
- /**
2751
- * A data cell, representing value with a negative flavour
2752
- */
2753
- NEGATIVE = "Negative",
2754
- /**
2755
- * A data cell, representing value with a positive flavour
2756
- */
2757
- POSITIVE = "Positive",
2758
- /**
2759
- * A result cell, representing an aggregated value
2760
- */
2761
- RESULT = "Result",
2762
- /**
2763
- * A result cell, representing an aggregated value with a critical flavour
2764
- */
2765
- RESULT_CRITICAL = "ResultCritical",
2766
- /**
2767
- * A virtual member of a dimension indicating an aggregation of members
2768
- */
2769
- RESULT_HEADER = "ResultHeader",
2770
- /**
2771
- * A result cell, representing an aggregated value with a negative flavour
2772
- */
2773
- RESULT_NEGATIVE = "ResultNegative",
2774
- /**
2775
- * A result cell, representing an aggregated value with a positive flavour
2776
- */
2777
- RESULT_POSITIVE = "ResultPositive",
2778
- /**
2779
- * A data cell, representing value
2780
- */
2781
- STANDARD = "Standard",
2782
- /**
2783
- * A title cell, representing a dimension
2784
- */
2785
- TITLE = "Title",
2786
- }
2787
- /**
2788
- * Format to be applied to a `Grid`
2789
- */
2790
- enum Format {
2791
- /**
2792
- * Basic grid format
2793
- */
2794
- Basic = "Basic",
2795
- /**
2796
- * business style
2797
- */
2798
- BusinessStyle = "BusinessStyle",
2799
- /**
2800
- * busines formular style
2801
- */
2802
- BusinessStyleFormular = "BusinessStyleFormular",
2803
- /**
2804
- * custom style
2805
- */
2806
- CustomStyle = "CustomStyle",
2807
- /**
2808
- * mimicking spreadsheet
2809
- */
2810
- ExcelStyle = "ExcelStyle",
2811
- }
2812
- /**
2813
- * @deprecated (since 1.89.0)
2814
- *
2815
- * Horizontal alignment, e.g. of a layout cell's content within the cell's borders. Note that some values
2816
- * depend on the current locale's writing direction while others do not.
2817
- */
2818
- enum HAlign {
2819
- /**
2820
- * Aligned towards the beginning of a line, in the current locale's writing direction.
2821
- */
2822
- Begin = "Begin",
2823
- /**
2824
- * Horizontally centered.
2825
- */
2826
- Center = "Center",
2827
- /**
2828
- * Aligned towards the end of a line, in the current locale's writing direction.
2829
- */
2830
- End = "End",
2831
- /**
2832
- * Left aligned, regardless of the current locale's writing direction.
2833
- */
2834
- Left = "Left",
2835
- /**
2836
- * Right aligned, regardless of the current locale's writing direction.
2837
- */
2838
- Right = "Right",
2839
- }
2840
- /**
2841
- * @deprecated (since 1.89)
2842
- * @EXPERIMENTAL
2843
- *
2844
- * Padding, e.g. of a layout cell's content within the cell's borders. Note that all options except "None"
2845
- * include a padding of 2px at the top and bottom, and differ only in the presence of a 4px padding towards
2846
- * the beginning or end of a line, in the current locale's writing direction.
2847
- */
2848
- enum Padding {
2849
- /**
2850
- * Top and bottom padding of 2px. Padding of 4px towards the beginning of a line, in the current locale's
2851
- * writing direction, but none towards its end.
2852
- */
2853
- Begin = "Begin",
2854
- /**
2855
- * Top and bottom padding of 2px. Padding of 4px towards both the beginning and end of a line.
2856
- */
2857
- Both = "Both",
2858
- /**
2859
- * Top and bottom padding of 2px. Padding of 4px towards the end of a line, in the current locale's writing
2860
- * direction, but none towards its beginning.
2861
- */
2862
- End = "End",
2863
- /**
2864
- * Top and bottom padding of 2px. No padding towards neither the beginning nor end of a line.
2865
- */
2866
- Neither = "Neither",
2867
- /**
2868
- * No padding at all.
2869
- */
2870
- None = "None",
2871
- }
2872
- /**
2873
- * @deprecated (since 1.89.0)
2874
- *
2875
- * Separation, e.g. of a layout cell from its neighbor, via a vertical gutter of defined width, with or
2876
- * without a vertical line in its middle.
2877
- */
2878
- enum Separation {
2879
- /**
2880
- * A large (63px) vertical gutter without a vertical line.
2881
- */
2882
- Large = "Large",
2883
- /**
2884
- * A large (63px) vertical gutter with a vertical line in its middle.
2885
- */
2886
- LargeWithLine = "LargeWithLine",
2887
- /**
2888
- * A medium (31px) vertical gutter without a vertical line.
2889
- */
2890
- Medium = "Medium",
2891
- /**
2892
- * A medium (31px) vertical gutter with a vertical line in its middle.
2893
- */
2894
- MediumWithLine = "MediumWithLine",
2895
- /**
2896
- * No gutter at all (0px), and without a vertical line, of course.
2897
- */
2898
- None = "None",
2899
- /**
2900
- * A small (17px) vertical gutter without a vertical line.
2901
- */
2902
- Small = "Small",
2903
- /**
2904
- * A small (17px) vertical gutter with a vertical line in its middle.
2905
- */
2906
- SmallWithLine = "SmallWithLine",
2907
- }
2908
- /**
2909
- * @deprecated (since 1.89.0)
2910
- *
2911
- * Vertical alignment, e.g. of a layout cell's content within the cell's borders.
2912
- */
2913
- enum VAlign {
2914
- /**
2915
- * Aligned at the bottom.
2916
- */
2917
- Bottom = "Bottom",
2918
- /**
2919
- * Vertically centered.
2920
- */
2921
- Middle = "Middle",
2922
- /**
2923
- * Aligned at the top.
2924
- */
2925
- Top = "Top",
2926
- }
2927
- }
2928
- }
2929
-
2930
- interface IUI5DefineDependencyNames {
2931
- "sap/zen/commons/AlertLevel": undefined;
2932
-
2933
- "sap/zen/commons/Cell": undefined;
2934
-
2935
- "sap/zen/commons/CellType": undefined;
2936
-
2937
- "sap/zen/commons/Format": undefined;
2938
-
2939
- "sap/zen/commons/Grid": undefined;
2940
-
2941
- "sap/zen/commons/HAlign": undefined;
2942
-
2943
- "sap/zen/commons/layout/AbsoluteLayout": undefined;
2944
-
2945
- "sap/zen/commons/layout/MatrixLayout": undefined;
2946
-
2947
- "sap/zen/commons/layout/MatrixLayoutCell": undefined;
2948
-
2949
- "sap/zen/commons/layout/MatrixLayoutRow": undefined;
2950
-
2951
- "sap/zen/commons/layout/PositionContainer": undefined;
2952
-
2953
- "sap/zen/commons/library": undefined;
1516
+ "sap/zen/commons/library": undefined;
2954
1517
 
2955
1518
  "sap/zen/commons/Padding": undefined;
2956
1519
 
2957
- "sap/zen/commons/SemanticStyle": undefined;
2958
-
2959
1520
  "sap/zen/commons/Separation": undefined;
2960
1521
 
2961
1522
  "sap/zen/commons/VAlign": undefined;