@sapui5/ts-types 1.84.47 → 1.84.50

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 (46) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -1
  3. package/types/sap.chart.d.ts +1 -1
  4. package/types/sap.f.d.ts +1 -1
  5. package/types/sap.fe.core.d.ts +1 -1
  6. package/types/sap.fe.macros.d.ts +1 -1
  7. package/types/{sap.fe.navigation.d.ts → sap.fe.navigation-1.84.17-d.ts} +1 -1
  8. package/types/sap.fe.plugins.d.ts +1 -1
  9. package/types/sap.fe.templates.d.ts +1 -1
  10. package/types/sap.fe.test.d.ts +1 -1
  11. package/types/sap.fe.tools.d.ts +1 -1
  12. package/types/sap.gantt.d.ts +1 -1
  13. package/types/sap.m.d.ts +1 -1
  14. package/types/sap.makit.d.ts +1 -1
  15. package/types/sap.me.d.ts +1 -1
  16. package/types/sap.ndc.d.ts +1 -1
  17. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  18. package/types/sap.suite.ui.microchart.d.ts +1 -1
  19. package/types/sap.tnt.d.ts +1 -1
  20. package/types/sap.ui.codeeditor.d.ts +1 -1
  21. package/types/sap.ui.commons.d.ts +1 -1
  22. package/types/sap.ui.comp.d.ts +1 -1
  23. package/types/sap.ui.core.d.ts +18 -13
  24. package/types/sap.ui.dt.d.ts +1 -1
  25. package/types/sap.ui.export.d.ts +3 -3
  26. package/types/sap.ui.fl.d.ts +1 -1
  27. package/types/sap.ui.generic.app.d.ts +1 -1
  28. package/types/sap.ui.generic.template.d.ts +1 -1
  29. package/types/sap.ui.integration.d.ts +1 -1
  30. package/types/sap.ui.layout.d.ts +1 -1
  31. package/types/sap.ui.mdc.d.ts +1 -1
  32. package/types/sap.ui.richtexteditor.d.ts +1 -1
  33. package/types/sap.ui.rta.d.ts +1 -1
  34. package/types/sap.ui.suite.d.ts +1 -1
  35. package/types/sap.ui.support.d.ts +6 -6
  36. package/types/sap.ui.table.d.ts +1 -1
  37. package/types/sap.ui.testrecorder.d.ts +1 -1
  38. package/types/sap.ui.unified.d.ts +1 -1
  39. package/types/sap.ui.ux3.d.ts +1 -1
  40. package/types/sap.uiext.inbox.d.ts +1 -1
  41. package/types/sap.ushell.d.ts +31 -1
  42. package/types/sap.uxap.d.ts +1 -1
  43. package/types/sap.viz.d.ts +1 -1
  44. package/types/sap.zen.commons.d.ts +2810 -2
  45. package/types/sap.zen.crosstab.d.ts +947 -2
  46. package/types/sap.zen.dsh.d.ts +2410 -15
@@ -1,5 +1,2813 @@
1
- // For Library Version: 1.84.33
1
+ // For Library Version: 1.84.46
2
2
 
3
3
  declare namespace sap {
4
- interface IUI5DefineDependencyNames {}
4
+ namespace zen {
5
+ /**
6
+ * Design Studio Commons Library. Intended only to be used within S/4 HANA Fiori applications.
7
+ */
8
+ namespace commons {
9
+ namespace layout {
10
+ interface $AbsoluteLayoutSettings extends sap.ui.core.$ControlSettings {
11
+ /**
12
+ * The overall width of the control. When not set, 100% is automatically set.
13
+ */
14
+ width?: sap.ui.core.CSSSize;
15
+
16
+ /**
17
+ * The overall height of the control. When not set, 100% is automatically set.
18
+ */
19
+ height?: sap.ui.core.CSSSize;
20
+
21
+ /**
22
+ * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
23
+ */
24
+ verticalScrolling?: sap.ui.core.Scrolling;
25
+
26
+ /**
27
+ * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
28
+ */
29
+ horizontalScrolling?: sap.ui.core.Scrolling;
30
+
31
+ /**
32
+ * Positioned child controls within the layout
33
+ */
34
+ positions?:
35
+ | sap.zen.commons.layout.PositionContainer[]
36
+ | sap.zen.commons.layout.PositionContainer;
37
+ }
38
+
39
+ interface $MatrixLayoutSettings extends sap.ui.core.$ControlSettings {
40
+ /**
41
+ * CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided.
42
+ */
43
+ width?: sap.ui.core.CSSSize;
44
+
45
+ /**
46
+ * CSS height of the matrix layout.
47
+ */
48
+ height?: sap.ui.core.CSSSize;
49
+
50
+ /**
51
+ * Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the
52
+ * content of the colums has priority. The default is "fixed". If the fixed layout is used a adequate width
53
+ * of the MatrixLayout should be provided. Otherwise the column width displayed could be different than
54
+ * the given ones because of browser dependend optimazations.
55
+ */
56
+ layoutFixed?: boolean;
57
+
58
+ /**
59
+ * Number of columns. If not specified, the number of columns will be determined from the given cells.
60
+ */
61
+ columns?: number;
62
+
63
+ /**
64
+ * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical
65
+ * sizing enter "auto" for this column width.
66
+ */
67
+ widths?: sap.ui.core.CSSSize[];
68
+
69
+ /**
70
+ * The matrix layout's individual rows.
71
+ */
72
+ rows?:
73
+ | sap.zen.commons.layout.MatrixLayoutRow[]
74
+ | sap.zen.commons.layout.MatrixLayoutRow;
75
+ }
76
+
77
+ interface $MatrixLayoutCellSettings
78
+ extends sap.ui.core.$ElementSettings {}
79
+
80
+ interface $MatrixLayoutRowSettings
81
+ extends sap.ui.core.$ElementSettings {
82
+ /**
83
+ * Height of the row.
84
+ */
85
+ height?: sap.ui.core.CSSSize;
86
+
87
+ /**
88
+ * The matrix layout row's individual cells.
89
+ */
90
+ cells?:
91
+ | sap.zen.commons.layout.MatrixLayoutCell[]
92
+ | sap.zen.commons.layout.MatrixLayoutCell;
93
+ }
94
+
95
+ interface $PositionContainerSettings
96
+ extends sap.ui.core.$ElementSettings {
97
+ /**
98
+ * Defines the distance to the top of the layout (as specified in HTML)
99
+ */
100
+ top?: sap.ui.core.CSSSize;
101
+
102
+ /**
103
+ * Defines the distance to the bottom of the layout (as specified in HTML)
104
+ */
105
+ bottom?: sap.ui.core.CSSSize;
106
+
107
+ /**
108
+ * Defines the distance to the left of the layout (as specified in HTML)
109
+ */
110
+ left?: sap.ui.core.CSSSize;
111
+
112
+ /**
113
+ * Defines the distance to the right of the layout (as specified in HTML)
114
+ */
115
+ right?: sap.ui.core.CSSSize;
116
+
117
+ /**
118
+ * Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values
119
+ * of the attributes left and right are ignored when this feature is activated.
120
+ */
121
+ centerHorizontally?: boolean;
122
+
123
+ /**
124
+ * Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values
125
+ * of the attributes top and bottom are ignored when this feature is activated.
126
+ */
127
+ centerVertically?: boolean;
128
+
129
+ /**
130
+ * Child control of the position container
131
+ */
132
+ control?: sap.ui.core.Control;
133
+ }
134
+ /**
135
+ * @deprecated (since 1.38)
136
+ *
137
+ * The Absolute Layout positions its child controls absolutely
138
+ */
139
+ class AbsoluteLayout extends sap.ui.core.Control {
140
+ /**
141
+ * Constructor for a new layout/AbsoluteLayout.
142
+ *
143
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
144
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
145
+ * of the syntax of the settings object.
146
+ */
147
+ constructor(
148
+ /**
149
+ * id for the new control, generated automatically if no id is given
150
+ */
151
+ sId?: string,
152
+ /**
153
+ * initial settings for the new control
154
+ */
155
+ mSettings?: $AbsoluteLayoutSettings
156
+ );
157
+
158
+ /**
159
+ * Adds the given control and a corresponding position container into the aggregation named 'positions'.
160
+ * Returns 'this' to allow method chaining.
161
+ */
162
+ addContent(
163
+ /**
164
+ * The content to add; if empty, nothing is inserted.
165
+ */
166
+ oContent: sap.ui.core.Control,
167
+ /**
168
+ * JSON-like object which defines the position of the child control in the layout. The object is expected
169
+ * to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize.
170
+ * If no object is given, the default is left=0px,right=0px
171
+ */
172
+ oPos: object
173
+ ): sap.zen.commons.layout.AbsoluteLayout;
174
+ /**
175
+ * Adds some position to the aggregation {@link #getPositions positions}.
176
+ */
177
+ addPosition(
178
+ /**
179
+ * The position to add; if empty, nothing is inserted
180
+ */
181
+ oPosition: sap.zen.commons.layout.PositionContainer
182
+ ): sap.zen.commons.layout.AbsoluteLayout;
183
+ /**
184
+ * Destroys all aggregated position containers and their child controls. Returns 'this' to allow method
185
+ * chaining.
186
+ */
187
+ destroyContent(): sap.zen.commons.layout.AbsoluteLayout;
188
+ /**
189
+ * Destroys all the positions in the aggregation {@link #getPositions positions}.
190
+ */
191
+ destroyPositions(): sap.zen.commons.layout.AbsoluteLayout;
192
+ /**
193
+ * Creates a new subclass of class sap.zen.commons.layout.AbsoluteLayout with name `sClassName` and enriches
194
+ * it with the information contained in `oClassInfo`.
195
+ *
196
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
197
+ */
198
+ // @ts-ignore
199
+ static extend<T extends Record<string, unknown>>(
200
+ /**
201
+ * Name of the class being created
202
+ */
203
+ sClassName: string,
204
+ /**
205
+ * Object literal with information about the class
206
+ */
207
+ oClassInfo?: T &
208
+ ThisType<T & sap.zen.commons.layout.AbsoluteLayout>,
209
+ /**
210
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
211
+ * used by this class
212
+ */
213
+ FNMetaImpl?: Function
214
+ ): Function;
215
+ /**
216
+ * Returns an array of the controls contained in the aggregated position containers (might be empty).
217
+ */
218
+ getContent(): sap.ui.core.Control[];
219
+ /**
220
+ * Gets current value of property {@link #getHeight height}.
221
+ *
222
+ * The overall height of the control. When not set, 100% is automatically set.
223
+ *
224
+ * Default value is `"100%"`.
225
+ */
226
+ getHeight(): sap.ui.core.CSSSize;
227
+ /**
228
+ * Gets current value of property {@link #getHorizontalScrolling horizontalScrolling}.
229
+ *
230
+ * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
231
+ *
232
+ * Default value is `Hidden`.
233
+ */
234
+ getHorizontalScrolling(): sap.ui.core.Scrolling;
235
+ /**
236
+ * Returns a metadata object for class sap.zen.commons.layout.AbsoluteLayout.
237
+ */
238
+ // @ts-ignore
239
+ static getMetadata(): sap.ui.core.ElementMetadata;
240
+ /**
241
+ * Gets content of aggregation {@link #getPositions positions}.
242
+ *
243
+ * Positioned child controls within the layout
244
+ */
245
+ getPositions(): sap.zen.commons.layout.PositionContainer[];
246
+ /**
247
+ * Gets current value of property {@link #getVerticalScrolling verticalScrolling}.
248
+ *
249
+ * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
250
+ *
251
+ * Default value is `Hidden`.
252
+ */
253
+ getVerticalScrolling(): sap.ui.core.Scrolling;
254
+ /**
255
+ * Gets current value of property {@link #getWidth width}.
256
+ *
257
+ * The overall width of the control. When not set, 100% is automatically set.
258
+ *
259
+ * Default value is `'100%'`.
260
+ */
261
+ getWidth(): sap.ui.core.CSSSize;
262
+ /**
263
+ * Checks for the provided sap.ui.core.Control in the aggregated position containers, and returns the index
264
+ * of the container in the positions aggregation if found, or '-1' otherwise.
265
+ */
266
+ indexOfContent(
267
+ /**
268
+ * The content of which the index is looked for
269
+ */
270
+ oContent: sap.ui.core.Control
271
+ ): number;
272
+ /**
273
+ * Checks for the provided `sap.zen.commons.layout.PositionContainer` in the aggregation {@link #getPositions
274
+ * positions}. and returns its index if found or -1 otherwise.
275
+ */
276
+ indexOfPosition(
277
+ /**
278
+ * The position whose index is looked for
279
+ */
280
+ oPosition: sap.zen.commons.layout.PositionContainer
281
+ ): number;
282
+ /**
283
+ * Inserts the given control and a corresponding position container into the aggregation named 'positions'.
284
+ * Returns 'this' to allow method chaining.
285
+ */
286
+ insertContent(
287
+ /**
288
+ * The content to insert; if empty, nothing is inserted
289
+ */
290
+ oContent: sap.ui.core.Control,
291
+ /**
292
+ * The '0'-based index where the content shall be inserted at. For a negative value of iIndex, the content
293
+ * is inserted at position '0'; for a value greater than the current size of the aggregation, the content
294
+ * is inserted at the last position.
295
+ */
296
+ iIndex: number,
297
+ /**
298
+ * JSON-like object which defines the position of the child control within the layout. The object is expected
299
+ * to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize.
300
+ * If no object is given, the default is left=0px,right=0px.
301
+ */
302
+ oPos: object
303
+ ): sap.zen.commons.layout.AbsoluteLayout;
304
+ /**
305
+ * Inserts a position into the aggregation {@link #getPositions positions}.
306
+ */
307
+ insertPosition(
308
+ /**
309
+ * The position to insert; if empty, nothing is inserted
310
+ */
311
+ oPosition: sap.zen.commons.layout.PositionContainer,
312
+ /**
313
+ * The `0`-based index the position should be inserted at; for a negative value of `iIndex`, the position
314
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the position
315
+ * is inserted at the last position
316
+ */
317
+ iIndex: number
318
+ ): sap.zen.commons.layout.AbsoluteLayout;
319
+ /**
320
+ * Removes all aggregated position containers. Returns an array of the controls contained in the removed
321
+ * position containers (might be empty).
322
+ */
323
+ removeAllContent(): sap.ui.core.Control[];
324
+ /**
325
+ * Removes all the controls from the aggregation {@link #getPositions positions}.
326
+ *
327
+ * Additionally, it unregisters them from the hosting UIArea.
328
+ */
329
+ removeAllPositions(): sap.zen.commons.layout.PositionContainer[];
330
+ /**
331
+ * Removes the given control and its corresponding position container from the aggregation named 'positions'.
332
+ */
333
+ removeContent(
334
+ /**
335
+ * The content control to remove, its ID, or the index of the corresponding position container in the 'positions'
336
+ * aggregation.
337
+ */
338
+ oContent: object
339
+ ): sap.ui.core.Control;
340
+ /**
341
+ * Removes a position from the aggregation {@link #getPositions positions}.
342
+ */
343
+ removePosition(
344
+ /**
345
+ * The position to remove or its index or id
346
+ */
347
+ vPosition:
348
+ | number
349
+ | string
350
+ | sap.zen.commons.layout.PositionContainer
351
+ ): sap.zen.commons.layout.PositionContainer;
352
+ /**
353
+ * Sets a new value for property {@link #getHeight height}.
354
+ *
355
+ * The overall height of the control. When not set, 100% is automatically set.
356
+ *
357
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
358
+ *
359
+ * Default value is `"100%"`.
360
+ */
361
+ setHeight(
362
+ /**
363
+ * New value for property `height`
364
+ */
365
+ sHeight?: sap.ui.core.CSSSize
366
+ ): sap.zen.commons.layout.AbsoluteLayout;
367
+ /**
368
+ * Sets a new value for property {@link #getHorizontalScrolling horizontalScrolling}.
369
+ *
370
+ * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
371
+ *
372
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
373
+ *
374
+ * Default value is `Hidden`.
375
+ */
376
+ setHorizontalScrolling(
377
+ /**
378
+ * New value for property `horizontalScrolling`
379
+ */
380
+ sHorizontalScrolling?: sap.ui.core.Scrolling
381
+ ): sap.zen.commons.layout.AbsoluteLayout;
382
+ /**
383
+ * Allows to set or change the position information of the given child control
384
+ */
385
+ setPositionOfChild(
386
+ /**
387
+ * The child control for which to change the position information; if empty or not aggregated, nothing is
388
+ * changed
389
+ */
390
+ oControl: sap.ui.core.Control,
391
+ /**
392
+ * JSON-like object which defines the position of the child control. The object is expected to have one
393
+ * or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize.
394
+ * If no object is given, the default is used which is left=0px,right=0px.
395
+ */
396
+ oPos: object
397
+ ): boolean;
398
+ /**
399
+ * Sets a new value for property {@link #getVerticalScrolling verticalScrolling}.
400
+ *
401
+ * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
402
+ *
403
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
404
+ *
405
+ * Default value is `Hidden`.
406
+ */
407
+ setVerticalScrolling(
408
+ /**
409
+ * New value for property `verticalScrolling`
410
+ */
411
+ sVerticalScrolling?: sap.ui.core.Scrolling
412
+ ): sap.zen.commons.layout.AbsoluteLayout;
413
+ /**
414
+ * Sets a new value for property {@link #getWidth width}.
415
+ *
416
+ * The overall width of the control. When not set, 100% is automatically set.
417
+ *
418
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
419
+ *
420
+ * Default value is `'100%'`.
421
+ */
422
+ setWidth(
423
+ /**
424
+ * New value for property `width`
425
+ */
426
+ sWidth?: sap.ui.core.CSSSize
427
+ ): sap.zen.commons.layout.AbsoluteLayout;
428
+ }
429
+ /**
430
+ * @deprecated (since 1.38) - Instead, use the `sap.ui.layout.Grid` control.
431
+ *
432
+ * A matrix layout arranges controls in a grid structure, using rows which need not have the same number
433
+ * of cells.
434
+ *
435
+ * It uses predefined cell classes that guarantee appropriate distances between cells in the grid. The
436
+ * cell's `vGutter` property lets you specify additional horizontal distances easily. You can set these
437
+ * additional distances (known as gutters) with or without separators. The distance for each cell is specified
438
+ * by assigning a specific enumeration value of the class `LayoutCellSeparator` of the matrix data object.
439
+ *
440
+ *
441
+ * You should **avoid nesting** matrix layouts. You should only use a matrix layout if you need to align
442
+ * controls horizontally across rows.
443
+ */
444
+ class MatrixLayout extends sap.ui.core.Control {
445
+ /**
446
+ * Constructor for a new layout/MatrixLayout.
447
+ *
448
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
449
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
450
+ * of the syntax of the settings object.
451
+ */
452
+ constructor(
453
+ /**
454
+ * id for the new control, generated automatically if no id is given
455
+ */
456
+ sId?: string,
457
+ /**
458
+ * initial settings for the new control
459
+ */
460
+ mSettings?: $MatrixLayoutSettings
461
+ );
462
+
463
+ /**
464
+ * Adds some row to the aggregation {@link #getRows rows}.
465
+ */
466
+ addRow(
467
+ /**
468
+ * The row to add; if empty, nothing is inserted
469
+ */
470
+ oRow: sap.zen.commons.layout.MatrixLayoutRow
471
+ ): sap.zen.commons.layout.MatrixLayout;
472
+ /**
473
+ * Creates a new matrix layout row and appends it to this matrix layout.
474
+ *
475
+ * Each argument must be either a matrix layout cell, which is added to the row "as is", or an arbitrary
476
+ * content control, which is wrapped with a new (default) matrix layout cell first and then added to the
477
+ * row.
478
+ */
479
+ createRow(
480
+ /**
481
+ * to add
482
+ */
483
+ rowContent:
484
+ | sap.ui.core.Control
485
+ | sap.zen.commons.layout.MatrixLayoutCell
486
+ | string
487
+ ): sap.zen.commons.layout.MatrixLayout;
488
+ /**
489
+ * Destroys all the rows in the aggregation {@link #getRows rows}.
490
+ */
491
+ destroyRows(): sap.zen.commons.layout.MatrixLayout;
492
+ /**
493
+ * Creates a new subclass of class sap.zen.commons.layout.MatrixLayout with name `sClassName` and enriches
494
+ * it with the information contained in `oClassInfo`.
495
+ *
496
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
497
+ */
498
+ // @ts-ignore
499
+ static extend<T extends Record<string, unknown>>(
500
+ /**
501
+ * Name of the class being created
502
+ */
503
+ sClassName: string,
504
+ /**
505
+ * Object literal with information about the class
506
+ */
507
+ oClassInfo?: T & ThisType<T & sap.zen.commons.layout.MatrixLayout>,
508
+ /**
509
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
510
+ * used by this class
511
+ */
512
+ FNMetaImpl?: Function
513
+ ): Function;
514
+ /**
515
+ * Gets current value of property {@link #getColumns columns}.
516
+ *
517
+ * Number of columns. If not specified, the number of columns will be determined from the given cells.
518
+ */
519
+ getColumns(): number;
520
+ /**
521
+ * Gets current value of property {@link #getHeight height}.
522
+ *
523
+ * CSS height of the matrix layout.
524
+ */
525
+ getHeight(): sap.ui.core.CSSSize;
526
+ /**
527
+ * Gets current value of property {@link #getLayoutFixed layoutFixed}.
528
+ *
529
+ * Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the
530
+ * content of the colums has priority. The default is "fixed". If the fixed layout is used a adequate width
531
+ * of the MatrixLayout should be provided. Otherwise the column width displayed could be different than
532
+ * the given ones because of browser dependend optimazations.
533
+ *
534
+ * Default value is `true`.
535
+ */
536
+ getLayoutFixed(): boolean;
537
+ /**
538
+ * Returns a metadata object for class sap.zen.commons.layout.MatrixLayout.
539
+ */
540
+ // @ts-ignore
541
+ static getMetadata(): sap.ui.core.ElementMetadata;
542
+ /**
543
+ * Gets content of aggregation {@link #getRows rows}.
544
+ *
545
+ * The matrix layout's individual rows.
546
+ */
547
+ getRows(): sap.zen.commons.layout.MatrixLayoutRow[];
548
+ /**
549
+ * Gets current value of property {@link #getWidth width}.
550
+ *
551
+ * CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided.
552
+ */
553
+ getWidth(): sap.ui.core.CSSSize;
554
+ /**
555
+ * Gets current value of property {@link #getWidths widths}.
556
+ *
557
+ * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical
558
+ * sizing enter "auto" for this column width.
559
+ */
560
+ getWidths(): sap.ui.core.CSSSize[];
561
+ /**
562
+ * Checks for the provided `sap.zen.commons.layout.MatrixLayoutRow` in the aggregation {@link #getRows rows}.
563
+ * and returns its index if found or -1 otherwise.
564
+ */
565
+ indexOfRow(
566
+ /**
567
+ * The row whose index is looked for
568
+ */
569
+ oRow: sap.zen.commons.layout.MatrixLayoutRow
570
+ ): number;
571
+ /**
572
+ * Inserts a row into the aggregation {@link #getRows rows}.
573
+ */
574
+ insertRow(
575
+ /**
576
+ * The row to insert; if empty, nothing is inserted
577
+ */
578
+ oRow: sap.zen.commons.layout.MatrixLayoutRow,
579
+ /**
580
+ * The `0`-based index the row should be inserted at; for a negative value of `iIndex`, the row is inserted
581
+ * at position 0; for a value greater than the current size of the aggregation, the row is inserted at the
582
+ * last position
583
+ */
584
+ iIndex: number
585
+ ): sap.zen.commons.layout.MatrixLayout;
586
+ /**
587
+ * Removes all the controls from the aggregation {@link #getRows rows}.
588
+ *
589
+ * Additionally, it unregisters them from the hosting UIArea.
590
+ */
591
+ removeAllRows(): sap.zen.commons.layout.MatrixLayoutRow[];
592
+ /**
593
+ * Removes a row from the aggregation {@link #getRows rows}.
594
+ */
595
+ removeRow(
596
+ /**
597
+ * The row to remove or its index or id
598
+ */
599
+ vRow: number | string | sap.zen.commons.layout.MatrixLayoutRow
600
+ ): sap.zen.commons.layout.MatrixLayoutRow;
601
+ /**
602
+ * Sets a new value for property {@link #getColumns columns}.
603
+ *
604
+ * Number of columns. If not specified, the number of columns will be determined from the given cells.
605
+ *
606
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
607
+ */
608
+ setColumns(
609
+ /**
610
+ * New value for property `columns`
611
+ */
612
+ iColumns?: number
613
+ ): sap.zen.commons.layout.MatrixLayout;
614
+ /**
615
+ * Sets a new value for property {@link #getHeight height}.
616
+ *
617
+ * CSS height of the matrix layout.
618
+ *
619
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
620
+ */
621
+ setHeight(
622
+ /**
623
+ * New value for property `height`
624
+ */
625
+ sHeight?: sap.ui.core.CSSSize
626
+ ): sap.zen.commons.layout.MatrixLayout;
627
+ /**
628
+ * Sets a new value for property {@link #getLayoutFixed layoutFixed}.
629
+ *
630
+ * Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the
631
+ * content of the colums has priority. The default is "fixed". If the fixed layout is used a adequate width
632
+ * of the MatrixLayout should be provided. Otherwise the column width displayed could be different than
633
+ * the given ones because of browser dependend optimazations.
634
+ *
635
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
636
+ *
637
+ * Default value is `true`.
638
+ */
639
+ setLayoutFixed(
640
+ /**
641
+ * New value for property `layoutFixed`
642
+ */
643
+ bLayoutFixed?: boolean
644
+ ): sap.zen.commons.layout.MatrixLayout;
645
+ /**
646
+ * Sets a new value for property {@link #getWidth width}.
647
+ *
648
+ * CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided.
649
+ *
650
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
651
+ */
652
+ setWidth(
653
+ /**
654
+ * New value for property `width`
655
+ */
656
+ sWidth?: sap.ui.core.CSSSize
657
+ ): sap.zen.commons.layout.MatrixLayout;
658
+ /**
659
+ * Sets a new value for property {@link #getWidths widths}.
660
+ *
661
+ * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical
662
+ * sizing enter "auto" for this column width.
663
+ *
664
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
665
+ */
666
+ setWidths(
667
+ /**
668
+ * New value for property `widths`
669
+ */
670
+ sWidths?: sap.ui.core.CSSSize[]
671
+ ): sap.zen.commons.layout.MatrixLayout;
672
+ }
673
+ /**
674
+ * @deprecated (since 1.38) - Instead, use the `sap.ui.layout.Grid` control.
675
+ *
676
+ * Non-control element used as part of a matrix layout's inner structure.
677
+ */
678
+ class MatrixLayoutCell extends sap.ui.core.Element {
679
+ /**
680
+ * Constructor for a new layout/MatrixLayoutCell.
681
+ *
682
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
683
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
684
+ * of the syntax of the settings object.
685
+ */
686
+ constructor(
687
+ /**
688
+ * id for the new control, generated automatically if no id is given
689
+ */
690
+ sId?: string,
691
+ /**
692
+ * initial settings for the new control
693
+ */
694
+ mSettings?: $MatrixLayoutCellSettings
695
+ );
696
+
697
+ /**
698
+ * The string given as "sStyleClass" will be added to the "class" attribute of this element's root HTML
699
+ * element.
700
+ *
701
+ * This method is intended to be used to mark controls as being of a special type for which special styling
702
+ * can be provided using CSS selectors that reference this style class name.
703
+ *
704
+ *
705
+ * ```javascript
706
+ *
707
+ * Example:
708
+ * myButton.addStyleClass("myRedTextButton"); // add a CSS class to one button instance
709
+ *
710
+ * ...and in CSS:
711
+ * .myRedTextButton {
712
+ * color: red;
713
+ * }
714
+ * ```
715
+ *
716
+ *
717
+ * This will add the CSS class "myRedTextButton" to the Button HTML and the CSS code above will then make
718
+ * the text in this particular button red.
719
+ *
720
+ * Only characters allowed inside HTML attributes are allowed. Quotes are not allowed and this method will
721
+ * ignore any strings containing quotes. Strings containing spaces are interpreted as ONE custom style class
722
+ * (even though CSS selectors interpret them as different classes) and can only removed later by calling
723
+ * removeStyleClass() with exactly the same (space-containing) string as parameter. Multiple calls with
724
+ * the same sStyleClass will have no different effect than calling once. If sStyleClass is null, the call
725
+ * is ignored.
726
+ *
727
+ * Returns `this` to allow method chaining
728
+ */
729
+ addStyleClass(
730
+ /**
731
+ * the CSS class name to be added
732
+ */
733
+ sStyleClass: string
734
+ ): sap.zen.commons.layout.MatrixLayoutCell;
735
+ /**
736
+ * Returns true if the given style class string is valid and if this Element has this style class set via
737
+ * a previous call to addStyleClass().
738
+ */
739
+ hasStyleClass(
740
+ /**
741
+ * the style to check for
742
+ */
743
+ sStyleClass: string
744
+ ): boolean;
745
+ /**
746
+ * Removes the given string from the list of custom style classes that have been set previously. Regular
747
+ * style classes like "sapUiBtn" cannot be removed.
748
+ *
749
+ * Returns `this` to allow method chaining
750
+ */
751
+ removeStyleClass(
752
+ /**
753
+ * the style to be removed
754
+ */
755
+ sStyleClass: string
756
+ ): sap.zen.commons.layout.MatrixLayoutCell;
757
+ }
758
+ /**
759
+ * @deprecated (since 1.38) - Instead, use the `sap.ui.layout.Grid` control.
760
+ *
761
+ * Non-control element used as part of a matrix layout's inner structure.
762
+ */
763
+ class MatrixLayoutRow extends sap.ui.core.Element {
764
+ /**
765
+ * Constructor for a new layout/MatrixLayoutRow.
766
+ *
767
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
768
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
769
+ * of the syntax of the settings object.
770
+ */
771
+ constructor(
772
+ /**
773
+ * id for the new control, generated automatically if no id is given
774
+ */
775
+ sId?: string,
776
+ /**
777
+ * initial settings for the new control
778
+ */
779
+ mSettings?: $MatrixLayoutRowSettings
780
+ );
781
+
782
+ /**
783
+ * Adds some cell to the aggregation {@link #getCells cells}.
784
+ */
785
+ addCell(
786
+ /**
787
+ * The cell to add; if empty, nothing is inserted
788
+ */
789
+ oCell: sap.zen.commons.layout.MatrixLayoutCell
790
+ ): sap.zen.commons.layout.MatrixLayoutRow;
791
+ /**
792
+ * The string given as "sStyleClass" will be added to the "class" attribute of this element's root HTML
793
+ * element.
794
+ *
795
+ * This method is intended to be used to mark controls as being of a special type for which special styling
796
+ * can be provided using CSS selectors that reference this style class name.
797
+ *
798
+ *
799
+ * ```javascript
800
+ *
801
+ * Example:
802
+ * myButton.addStyleClass("myRedTextButton"); // add a CSS class to one button instance
803
+ *
804
+ * ...and in CSS:
805
+ * .myRedTextButton {
806
+ * color: red;
807
+ * }
808
+ * ```
809
+ *
810
+ *
811
+ * This will add the CSS class "myRedTextButton" to the Button HTML and the CSS code above will then make
812
+ * the text in this particular button red.
813
+ *
814
+ * Only characters allowed inside HTML attributes are allowed. Quotes are not allowed and this method will
815
+ * ignore any strings containing quotes. Strings containing spaces are interpreted as ONE custom style class
816
+ * (even though CSS selectors interpret them as different classes) and can only removed later by calling
817
+ * removeStyleClass() with exactly the same (space-containing) string as parameter. Multiple calls with
818
+ * the same sStyleClass will have no different effect than calling once. If sStyleClass is null, the call
819
+ * is ignored.
820
+ *
821
+ * Returns `this` to allow method chaining
822
+ */
823
+ addStyleClass(
824
+ /**
825
+ * the CSS class name to be added
826
+ */
827
+ sStyleClass: string
828
+ ): sap.zen.commons.layout.MatrixLayoutRow;
829
+ /**
830
+ * Destroys all the cells in the aggregation {@link #getCells cells}.
831
+ */
832
+ destroyCells(): sap.zen.commons.layout.MatrixLayoutRow;
833
+ /**
834
+ * Creates a new subclass of class sap.zen.commons.layout.MatrixLayoutRow with name `sClassName` and enriches
835
+ * it with the information contained in `oClassInfo`.
836
+ *
837
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
838
+ */
839
+ // @ts-ignore
840
+ static extend<T extends Record<string, unknown>>(
841
+ /**
842
+ * Name of the class being created
843
+ */
844
+ sClassName: string,
845
+ /**
846
+ * Object literal with information about the class
847
+ */
848
+ oClassInfo?: T &
849
+ ThisType<T & sap.zen.commons.layout.MatrixLayoutRow>,
850
+ /**
851
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
852
+ * used by this class
853
+ */
854
+ FNMetaImpl?: Function
855
+ ): Function;
856
+ /**
857
+ * Gets content of aggregation {@link #getCells cells}.
858
+ *
859
+ * The matrix layout row's individual cells.
860
+ */
861
+ getCells(): sap.zen.commons.layout.MatrixLayoutCell[];
862
+ /**
863
+ * Gets current value of property {@link #getHeight height}.
864
+ *
865
+ * Height of the row.
866
+ */
867
+ getHeight(): sap.ui.core.CSSSize;
868
+ /**
869
+ * Returns a metadata object for class sap.zen.commons.layout.MatrixLayoutRow.
870
+ */
871
+ // @ts-ignore
872
+ static getMetadata(): sap.ui.core.ElementMetadata;
873
+ /**
874
+ * Returns true if the given style class string is valid and if this Element has this style class set via
875
+ * a previous call to addStyleClass().
876
+ */
877
+ hasStyleClass(
878
+ /**
879
+ * the style to check for
880
+ */
881
+ sStyleClass: string
882
+ ): boolean;
883
+ /**
884
+ * Checks for the provided `sap.zen.commons.layout.MatrixLayoutCell` in the aggregation {@link #getCells
885
+ * cells}. and returns its index if found or -1 otherwise.
886
+ */
887
+ indexOfCell(
888
+ /**
889
+ * The cell whose index is looked for
890
+ */
891
+ oCell: sap.zen.commons.layout.MatrixLayoutCell
892
+ ): number;
893
+ /**
894
+ * Inserts a cell into the aggregation {@link #getCells cells}.
895
+ */
896
+ insertCell(
897
+ /**
898
+ * The cell to insert; if empty, nothing is inserted
899
+ */
900
+ oCell: sap.zen.commons.layout.MatrixLayoutCell,
901
+ /**
902
+ * The `0`-based index the cell should be inserted at; for a negative value of `iIndex`, the cell is inserted
903
+ * at position 0; for a value greater than the current size of the aggregation, the cell is inserted at
904
+ * the last position
905
+ */
906
+ iIndex: number
907
+ ): sap.zen.commons.layout.MatrixLayoutRow;
908
+ /**
909
+ * Removes all the controls from the aggregation {@link #getCells cells}.
910
+ *
911
+ * Additionally, it unregisters them from the hosting UIArea.
912
+ */
913
+ removeAllCells(): sap.zen.commons.layout.MatrixLayoutCell[];
914
+ /**
915
+ * Removes a cell from the aggregation {@link #getCells cells}.
916
+ */
917
+ removeCell(
918
+ /**
919
+ * The cell to remove or its index or id
920
+ */
921
+ vCell: number | string | sap.zen.commons.layout.MatrixLayoutCell
922
+ ): sap.zen.commons.layout.MatrixLayoutCell;
923
+ /**
924
+ * Removes the given string from the list of custom style classes that have been set previously. Regular
925
+ * style classes like "sapUiBtn" cannot be removed.
926
+ *
927
+ * Returns `this` to allow method chaining
928
+ */
929
+ removeStyleClass(
930
+ /**
931
+ * the style to be removed
932
+ */
933
+ sStyleClass: string
934
+ ): sap.zen.commons.layout.MatrixLayoutRow;
935
+ /**
936
+ * Sets a new value for property {@link #getHeight height}.
937
+ *
938
+ * Height of the row.
939
+ *
940
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
941
+ */
942
+ setHeight(
943
+ /**
944
+ * New value for property `height`
945
+ */
946
+ sHeight?: sap.ui.core.CSSSize
947
+ ): sap.zen.commons.layout.MatrixLayoutRow;
948
+ }
949
+ /**
950
+ * Is used to specify the position of a control in the AbsoluteLayout
951
+ */
952
+ class PositionContainer extends sap.ui.core.Element {
953
+ /**
954
+ * Constructor for a new layout/PositionContainer.
955
+ *
956
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
957
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
958
+ * of the syntax of the settings object.
959
+ */
960
+ constructor(
961
+ /**
962
+ * id for the new control, generated automatically if no id is given
963
+ */
964
+ sId?: string,
965
+ /**
966
+ * initial settings for the new control
967
+ */
968
+ mSettings?: $PositionContainerSettings
969
+ );
970
+
971
+ /**
972
+ * Destroys the control in the aggregation {@link #getControl control}.
973
+ */
974
+ destroyControl(): sap.zen.commons.layout.PositionContainer;
975
+ /**
976
+ * Creates a new subclass of class sap.zen.commons.layout.PositionContainer with name `sClassName` and enriches
977
+ * it with the information contained in `oClassInfo`.
978
+ *
979
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
980
+ */
981
+ // @ts-ignore
982
+ static extend<T extends Record<string, unknown>>(
983
+ /**
984
+ * Name of the class being created
985
+ */
986
+ sClassName: string,
987
+ /**
988
+ * Object literal with information about the class
989
+ */
990
+ oClassInfo?: T &
991
+ ThisType<T & sap.zen.commons.layout.PositionContainer>,
992
+ /**
993
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
994
+ * used by this class
995
+ */
996
+ FNMetaImpl?: Function
997
+ ): Function;
998
+ /**
999
+ * Gets current value of property {@link #getBottom bottom}.
1000
+ *
1001
+ * Defines the distance to the bottom of the layout (as specified in HTML)
1002
+ */
1003
+ getBottom(): sap.ui.core.CSSSize;
1004
+ /**
1005
+ * Gets current value of property {@link #getCenterHorizontally centerHorizontally}.
1006
+ *
1007
+ * Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values
1008
+ * of the attributes left and right are ignored when this feature is activated.
1009
+ *
1010
+ * Default value is `false`.
1011
+ */
1012
+ getCenterHorizontally(): boolean;
1013
+ /**
1014
+ * Gets current value of property {@link #getCenterVertically centerVertically}.
1015
+ *
1016
+ * Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values
1017
+ * of the attributes top and bottom are ignored when this feature is activated.
1018
+ *
1019
+ * Default value is `false`.
1020
+ */
1021
+ getCenterVertically(): boolean;
1022
+ /**
1023
+ * Gets content of aggregation {@link #getControl control}.
1024
+ *
1025
+ * Child control of the position container
1026
+ */
1027
+ getControl(): sap.ui.core.Control;
1028
+ /**
1029
+ * Gets current value of property {@link #getLeft left}.
1030
+ *
1031
+ * Defines the distance to the left of the layout (as specified in HTML)
1032
+ */
1033
+ getLeft(): sap.ui.core.CSSSize;
1034
+ /**
1035
+ * Returns a metadata object for class sap.zen.commons.layout.PositionContainer.
1036
+ */
1037
+ // @ts-ignore
1038
+ static getMetadata(): sap.ui.core.ElementMetadata;
1039
+ /**
1040
+ * Gets current value of property {@link #getRight right}.
1041
+ *
1042
+ * Defines the distance to the right of the layout (as specified in HTML)
1043
+ */
1044
+ getRight(): sap.ui.core.CSSSize;
1045
+ /**
1046
+ * Gets current value of property {@link #getTop top}.
1047
+ *
1048
+ * Defines the distance to the top of the layout (as specified in HTML)
1049
+ */
1050
+ getTop(): sap.ui.core.CSSSize;
1051
+ /**
1052
+ * Sets a new value for property {@link #getBottom bottom}.
1053
+ *
1054
+ * Defines the distance to the bottom of the layout (as specified in HTML)
1055
+ *
1056
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1057
+ */
1058
+ setBottom(
1059
+ /**
1060
+ * New value for property `bottom`
1061
+ */
1062
+ sBottom?: sap.ui.core.CSSSize
1063
+ ): sap.zen.commons.layout.PositionContainer;
1064
+ /**
1065
+ * Sets a new value for property {@link #getCenterHorizontally centerHorizontally}.
1066
+ *
1067
+ * Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values
1068
+ * of the attributes left and right are ignored when this feature is activated.
1069
+ *
1070
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1071
+ *
1072
+ * Default value is `false`.
1073
+ */
1074
+ setCenterHorizontally(
1075
+ /**
1076
+ * New value for property `centerHorizontally`
1077
+ */
1078
+ bCenterHorizontally?: boolean
1079
+ ): sap.zen.commons.layout.PositionContainer;
1080
+ /**
1081
+ * Sets a new value for property {@link #getCenterVertically centerVertically}.
1082
+ *
1083
+ * Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values
1084
+ * of the attributes top and bottom are ignored when this feature is activated.
1085
+ *
1086
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1087
+ *
1088
+ * Default value is `false`.
1089
+ */
1090
+ setCenterVertically(
1091
+ /**
1092
+ * New value for property `centerVertically`
1093
+ */
1094
+ bCenterVertically?: boolean
1095
+ ): sap.zen.commons.layout.PositionContainer;
1096
+ /**
1097
+ * Sets the aggregated {@link #getControl control}.
1098
+ */
1099
+ setControl(
1100
+ /**
1101
+ * The control to set
1102
+ */
1103
+ oControl: sap.ui.core.Control
1104
+ ): sap.zen.commons.layout.PositionContainer;
1105
+ /**
1106
+ * Sets a new value for property {@link #getLeft left}.
1107
+ *
1108
+ * Defines the distance to the left of the layout (as specified in HTML)
1109
+ *
1110
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1111
+ */
1112
+ setLeft(
1113
+ /**
1114
+ * New value for property `left`
1115
+ */
1116
+ sLeft?: sap.ui.core.CSSSize
1117
+ ): sap.zen.commons.layout.PositionContainer;
1118
+ /**
1119
+ * Sets a new value for property {@link #getRight right}.
1120
+ *
1121
+ * Defines the distance to the right of the layout (as specified in HTML)
1122
+ *
1123
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1124
+ */
1125
+ setRight(
1126
+ /**
1127
+ * New value for property `right`
1128
+ */
1129
+ sRight?: sap.ui.core.CSSSize
1130
+ ): sap.zen.commons.layout.PositionContainer;
1131
+ /**
1132
+ * Sets a new value for property {@link #getTop top}.
1133
+ *
1134
+ * Defines the distance to the top of the layout (as specified in HTML)
1135
+ *
1136
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1137
+ */
1138
+ setTop(
1139
+ /**
1140
+ * New value for property `top`
1141
+ */
1142
+ sTop?: sap.ui.core.CSSSize
1143
+ ): sap.zen.commons.layout.PositionContainer;
1144
+ /**
1145
+ * Updates the position properties of the container according to the given position in JSON style.
1146
+ */
1147
+ updatePosition(
1148
+ /**
1149
+ * JSON-like object which defines the position of the child control in the absolute layout. The object is
1150
+ * expected to have one or more out of the attributes top, bottom, left, right (each with a value of type
1151
+ * sap.ui.core.CSSSize). If no object is given, nothing is updated.
1152
+ */
1153
+ oPos: object
1154
+ ): void;
1155
+ }
1156
+ }
1157
+
1158
+ interface $CellSettings extends sap.ui.core.$ElementSettings {
1159
+ /**
1160
+ * The value that is displayed in the cell
1161
+ */
1162
+ displayValue?: string;
1163
+
1164
+ /**
1165
+ * The celltype of the cell. (HEADER, TITLE, RESULT, ...)
1166
+ */
1167
+ cellType?: sap.zen.commons.CellType;
1168
+
1169
+ /**
1170
+ * The Column of the `Cell`
1171
+ */
1172
+ column?: number;
1173
+
1174
+ /**
1175
+ * The Icon to be displayed in the `Cell`
1176
+ */
1177
+ icon?: string;
1178
+
1179
+ /**
1180
+ * The Help Id of the `Cell`. Intended to be used by WebAssist/Enable Now.
1181
+ */
1182
+ helpId?: string;
1183
+
1184
+ /**
1185
+ * The value state of the `Cell`. This property is used for entry ready cells.
1186
+ */
1187
+ valueState?: sap.ui.core.ValueState;
1188
+
1189
+ /**
1190
+ * The row of the `Cell`.
1191
+ */
1192
+ row?: number;
1193
+
1194
+ /**
1195
+ * The indent level of the `Cell`.
1196
+ */
1197
+ displayLevel?: number;
1198
+
1199
+ /**
1200
+ * Indicates whether the `Cell` is input enabled.
1201
+ */
1202
+ inputEnabled?: boolean;
1203
+
1204
+ /**
1205
+ * The semantic class of the Cell. The css class associated to the class is put into the cells td.
1206
+ */
1207
+ semanticClass?: string;
1208
+
1209
+ /**
1210
+ * The Alert Level of the cell for exeptional reporting
1211
+ */
1212
+ alertLevel?: sap.zen.commons.AlertLevel;
1213
+ }
1214
+
1215
+ interface $GridSettings extends sap.ui.core.$ControlSettings {
1216
+ /**
1217
+ * Maximum of rows to be displayed in the Grid
1218
+ */
1219
+ maxRows?: number;
1220
+
1221
+ /**
1222
+ * Available rows in which the user can scroll
1223
+ */
1224
+ virtualRows?: number;
1225
+
1226
+ /**
1227
+ * Uniform height of a row in the Grid.
1228
+ */
1229
+ rowHeight?: number;
1230
+
1231
+ /**
1232
+ * Maximum of columns to be displayed in the Grid.
1233
+ */
1234
+ maxColumns?: number;
1235
+
1236
+ /**
1237
+ * Available columns in which the user can scroll
1238
+ */
1239
+ virtualColumns?: number;
1240
+
1241
+ /**
1242
+ * The limit of columns transported to the fronted
1243
+ */
1244
+ columnLimit?: number;
1245
+
1246
+ /**
1247
+ * The limit of rows transported to the fronted
1248
+ */
1249
+ rowLimit?: number;
1250
+
1251
+ /**
1252
+ * Indicator whether the grid should support data entry
1253
+ */
1254
+ input?: boolean;
1255
+
1256
+ /**
1257
+ * Number of fixed header rows
1258
+ */
1259
+ fixedRows?: number;
1260
+
1261
+ /**
1262
+ * Number of fixed header columns
1263
+ */
1264
+ fixedColumns?: number;
1265
+
1266
+ /**
1267
+ * offset column
1268
+ */
1269
+ offsetColumn?: number;
1270
+
1271
+ /**
1272
+ * offset row
1273
+ */
1274
+ offsetRow?: number;
1275
+
1276
+ /**
1277
+ * Property for different table formats
1278
+ */
1279
+ format?: sap.zen.commons.Format;
1280
+
1281
+ /**
1282
+ * Fired when the user scrolls out of the area between available rows and virtual rows
1283
+ */
1284
+ requestMoreRows?: Function;
1285
+
1286
+ /**
1287
+ * Fired when the user scrolls out of the area between available columns and virtual columns
1288
+ */
1289
+ requestMoreColumns?: Function;
1290
+
1291
+ /**
1292
+ * Is fired on click, the Pivot table displays the context menu
1293
+ */
1294
+ rightClick?: Function;
1295
+
1296
+ /**
1297
+ * Is fired on hover, when the user enters the cell
1298
+ */
1299
+ cellEnter?: Function;
1300
+
1301
+ /**
1302
+ * Is fired on hover, when the user leaves the cell
1303
+ */
1304
+ cellLeave?: Function;
1305
+
1306
+ /**
1307
+ * Is fired on click on an icon (typically a collapse or expand) symbol
1308
+ */
1309
+ drill?: Function;
1310
+
1311
+ /**
1312
+ * Cells to be displayed
1313
+ */
1314
+ cells?: sap.zen.commons.Cell[] | sap.zen.commons.Cell;
1315
+ }
1316
+
1317
+ interface $SemanticStyleSettings extends sap.ui.core.$ElementSettings {
1318
+ /**
1319
+ * The semantic class
1320
+ */
1321
+ semanticClass?: string;
1322
+
1323
+ /**
1324
+ * The associated css class
1325
+ */
1326
+ cssClass?: string;
1327
+ }
1328
+ /**
1329
+ * @SINCE 1.0.0
1330
+ * @EXPERIMENTAL
1331
+ *
1332
+ * Cell of a Grid.
1333
+ */
1334
+ class Cell extends sap.ui.core.Element {
1335
+ /**
1336
+ * Creates and initializes a new Cell. settings.
1337
+ *
1338
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1339
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1340
+ * of the syntax of the settings object.
1341
+ */
1342
+ constructor(
1343
+ /**
1344
+ * ID for the new control, generated automatically if no ID is given
1345
+ */
1346
+ sId?: string,
1347
+ /**
1348
+ * Initial settings for the new element
1349
+ */
1350
+ mSettings?: $CellSettings
1351
+ );
1352
+
1353
+ /**
1354
+ * Creates a new subclass of class sap.zen.commons.Cell with name `sClassName` and enriches it with the
1355
+ * information contained in `oClassInfo`.
1356
+ *
1357
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
1358
+ */
1359
+ // @ts-ignore
1360
+ static extend<T extends Record<string, unknown>>(
1361
+ /**
1362
+ * Name of the class being created
1363
+ */
1364
+ sClassName: string,
1365
+ /**
1366
+ * Object literal with information about the class
1367
+ */
1368
+ oClassInfo?: T & ThisType<T & sap.zen.commons.Cell>,
1369
+ /**
1370
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1371
+ * used by this class
1372
+ */
1373
+ FNMetaImpl?: Function
1374
+ ): Function;
1375
+ /**
1376
+ * Gets current value of property {@link #getAlertLevel alertLevel}.
1377
+ *
1378
+ * The Alert Level of the cell for exeptional reporting
1379
+ */
1380
+ getAlertLevel(): sap.zen.commons.AlertLevel;
1381
+ /**
1382
+ * Gets current value of property {@link #getCellType cellType}.
1383
+ *
1384
+ * The celltype of the cell. (HEADER, TITLE, RESULT, ...)
1385
+ *
1386
+ * Default value is `STANDARD`.
1387
+ */
1388
+ getCellType(): sap.zen.commons.CellType;
1389
+ /**
1390
+ * Gets current value of property {@link #getColumn column}.
1391
+ *
1392
+ * The Column of the `Cell`
1393
+ *
1394
+ * Default value is `0`.
1395
+ */
1396
+ getColumn(): number;
1397
+ /**
1398
+ * Gets current value of property {@link #getDisplayLevel displayLevel}.
1399
+ *
1400
+ * The indent level of the `Cell`.
1401
+ */
1402
+ getDisplayLevel(): number;
1403
+ /**
1404
+ * Gets current value of property {@link #getDisplayValue displayValue}.
1405
+ *
1406
+ * The value that is displayed in the cell
1407
+ */
1408
+ getDisplayValue(): string;
1409
+ /**
1410
+ * Gets current value of property {@link #getHelpId helpId}.
1411
+ *
1412
+ * The Help Id of the `Cell`. Intended to be used by WebAssist/Enable Now.
1413
+ */
1414
+ getHelpId(): string;
1415
+ /**
1416
+ * Gets current value of property {@link #getIcon icon}.
1417
+ *
1418
+ * The Icon to be displayed in the `Cell`
1419
+ */
1420
+ getIcon(): string;
1421
+ /**
1422
+ * Gets current value of property {@link #getInputEnabled inputEnabled}.
1423
+ *
1424
+ * Indicates whether the `Cell` is input enabled.
1425
+ */
1426
+ getInputEnabled(): boolean;
1427
+ /**
1428
+ * Returns a metadata object for class sap.zen.commons.Cell.
1429
+ */
1430
+ // @ts-ignore
1431
+ static getMetadata(): sap.ui.core.ElementMetadata;
1432
+ /**
1433
+ * Gets current value of property {@link #getRow row}.
1434
+ *
1435
+ * The row of the `Cell`.
1436
+ *
1437
+ * Default value is `0`.
1438
+ */
1439
+ getRow(): number;
1440
+ /**
1441
+ * Gets current value of property {@link #getSemanticClass semanticClass}.
1442
+ *
1443
+ * The semantic class of the Cell. The css class associated to the class is put into the cells td.
1444
+ */
1445
+ getSemanticClass(): string;
1446
+ /**
1447
+ * Gets current value of property {@link #getValueState valueState}.
1448
+ *
1449
+ * The value state of the `Cell`. This property is used for entry ready cells.
1450
+ */
1451
+ getValueState(): sap.ui.core.ValueState;
1452
+ /**
1453
+ * Sets a new value for property {@link #getAlertLevel alertLevel}.
1454
+ *
1455
+ * The Alert Level of the cell for exeptional reporting
1456
+ *
1457
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1458
+ */
1459
+ setAlertLevel(
1460
+ /**
1461
+ * New value for property `alertLevel`
1462
+ */
1463
+ sAlertLevel: sap.zen.commons.AlertLevel
1464
+ ): sap.zen.commons.Cell;
1465
+ /**
1466
+ * Sets a new value for property {@link #getCellType cellType}.
1467
+ *
1468
+ * The celltype of the cell. (HEADER, TITLE, RESULT, ...)
1469
+ *
1470
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1471
+ *
1472
+ * Default value is `STANDARD`.
1473
+ */
1474
+ setCellType(
1475
+ /**
1476
+ * New value for property `cellType`
1477
+ */
1478
+ sCellType?: sap.zen.commons.CellType
1479
+ ): sap.zen.commons.Cell;
1480
+ /**
1481
+ * Sets a new value for property {@link #getColumn column}.
1482
+ *
1483
+ * The Column of the `Cell`
1484
+ *
1485
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1486
+ *
1487
+ * Default value is `0`.
1488
+ */
1489
+ setColumn(
1490
+ /**
1491
+ * New value for property `column`
1492
+ */
1493
+ iColumn?: number
1494
+ ): sap.zen.commons.Cell;
1495
+ /**
1496
+ * Sets a new value for property {@link #getDisplayLevel displayLevel}.
1497
+ *
1498
+ * The indent level of the `Cell`.
1499
+ *
1500
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1501
+ */
1502
+ setDisplayLevel(
1503
+ /**
1504
+ * New value for property `displayLevel`
1505
+ */
1506
+ iDisplayLevel: number
1507
+ ): sap.zen.commons.Cell;
1508
+ /**
1509
+ * Sets a new value for property {@link #getDisplayValue displayValue}.
1510
+ *
1511
+ * The value that is displayed in the cell
1512
+ *
1513
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1514
+ */
1515
+ setDisplayValue(
1516
+ /**
1517
+ * New value for property `displayValue`
1518
+ */
1519
+ sDisplayValue: string
1520
+ ): sap.zen.commons.Cell;
1521
+ /**
1522
+ * Sets a new value for property {@link #getHelpId helpId}.
1523
+ *
1524
+ * The Help Id of the `Cell`. Intended to be used by WebAssist/Enable Now.
1525
+ *
1526
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1527
+ */
1528
+ setHelpId(
1529
+ /**
1530
+ * New value for property `helpId`
1531
+ */
1532
+ sHelpId: string
1533
+ ): sap.zen.commons.Cell;
1534
+ /**
1535
+ * Sets a new value for property {@link #getIcon icon}.
1536
+ *
1537
+ * The Icon to be displayed in the `Cell`
1538
+ *
1539
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1540
+ */
1541
+ setIcon(
1542
+ /**
1543
+ * New value for property `icon`
1544
+ */
1545
+ sIcon: string
1546
+ ): sap.zen.commons.Cell;
1547
+ /**
1548
+ * Sets a new value for property {@link #getInputEnabled inputEnabled}.
1549
+ *
1550
+ * Indicates whether the `Cell` is input enabled.
1551
+ *
1552
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1553
+ */
1554
+ setInputEnabled(
1555
+ /**
1556
+ * New value for property `inputEnabled`
1557
+ */
1558
+ bInputEnabled: boolean
1559
+ ): sap.zen.commons.Cell;
1560
+ /**
1561
+ * Sets a new value for property {@link #getRow row}.
1562
+ *
1563
+ * The row of the `Cell`.
1564
+ *
1565
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1566
+ *
1567
+ * Default value is `0`.
1568
+ */
1569
+ setRow(
1570
+ /**
1571
+ * New value for property `row`
1572
+ */
1573
+ iRow?: number
1574
+ ): sap.zen.commons.Cell;
1575
+ /**
1576
+ * Sets a new value for property {@link #getSemanticClass semanticClass}.
1577
+ *
1578
+ * The semantic class of the Cell. The css class associated to the class is put into the cells td.
1579
+ *
1580
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1581
+ */
1582
+ setSemanticClass(
1583
+ /**
1584
+ * New value for property `semanticClass`
1585
+ */
1586
+ sSemanticClass: string
1587
+ ): sap.zen.commons.Cell;
1588
+ /**
1589
+ * Sets a new value for property {@link #getValueState valueState}.
1590
+ *
1591
+ * The value state of the `Cell`. This property is used for entry ready cells.
1592
+ *
1593
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1594
+ */
1595
+ setValueState(
1596
+ /**
1597
+ * New value for property `valueState`
1598
+ */
1599
+ sValueState: sap.ui.core.ValueState
1600
+ ): sap.zen.commons.Cell;
1601
+ }
1602
+ /**
1603
+ * @EXPERIMENTAL
1604
+ *
1605
+ * Enables users to view and edit data in a grid. The grid is mimicking the familiar display of spreadsheets.
1606
+ *
1607
+ * Overview:
1608
+ *
1609
+ * The user can view the data in the grid, trigger actions via a context menu, enter data into input ready
1610
+ * cells.
1611
+ *
1612
+ * Usage:
1613
+ *
1614
+ * The `Grid` is mainly intended as a helper control for the `PivotTable`.
1615
+ */
1616
+ class Grid extends sap.ui.core.Control {
1617
+ /**
1618
+ * Constructor for a new `Grid`.
1619
+ *
1620
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1621
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1622
+ * of the syntax of the settings object.
1623
+ */
1624
+ constructor(
1625
+ /**
1626
+ * ID for the new control, generated automatically if no ID is given
1627
+ */
1628
+ sId?: string,
1629
+ /**
1630
+ * Initial settings for the new control
1631
+ */
1632
+ mSettings?: $GridSettings
1633
+ );
1634
+
1635
+ /**
1636
+ * Adds some cell to the aggregation {@link #getCells cells}.
1637
+ */
1638
+ addCell(
1639
+ /**
1640
+ * The cell to add; if empty, nothing is inserted
1641
+ */
1642
+ oCell: sap.zen.commons.Cell
1643
+ ): sap.zen.commons.Grid;
1644
+ /**
1645
+ * Attaches event handler `fnFunction` to the {@link #event:cellEnter cellEnter} event of this `sap.zen.commons.Grid`.
1646
+ *
1647
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1648
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1649
+ *
1650
+ * Is fired on hover, when the user enters the cell
1651
+ */
1652
+ attachCellEnter(
1653
+ /**
1654
+ * An application-specific payload object that will be passed to the event handler along with the event
1655
+ * object when firing the event
1656
+ */
1657
+ oData: object,
1658
+ /**
1659
+ * The function to be called when the event occurs
1660
+ */
1661
+ fnFunction: Function,
1662
+ /**
1663
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1664
+ */
1665
+ oListener?: object
1666
+ ): sap.zen.commons.Grid;
1667
+ /**
1668
+ * Attaches event handler `fnFunction` to the {@link #event:cellLeave cellLeave} event of this `sap.zen.commons.Grid`.
1669
+ *
1670
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1671
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1672
+ *
1673
+ * Is fired on hover, when the user leaves the cell
1674
+ */
1675
+ attachCellLeave(
1676
+ /**
1677
+ * An application-specific payload object that will be passed to the event handler along with the event
1678
+ * object when firing the event
1679
+ */
1680
+ oData: object,
1681
+ /**
1682
+ * The function to be called when the event occurs
1683
+ */
1684
+ fnFunction: Function,
1685
+ /**
1686
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1687
+ */
1688
+ oListener?: object
1689
+ ): sap.zen.commons.Grid;
1690
+ /**
1691
+ * Attaches event handler `fnFunction` to the {@link #event:drill drill} event of this `sap.zen.commons.Grid`.
1692
+ *
1693
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1694
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1695
+ *
1696
+ * Is fired on click on an icon (typically a collapse or expand) symbol
1697
+ */
1698
+ attachDrill(
1699
+ /**
1700
+ * An application-specific payload object that will be passed to the event handler along with the event
1701
+ * object when firing the event
1702
+ */
1703
+ oData: object,
1704
+ /**
1705
+ * The function to be called when the event occurs
1706
+ */
1707
+ fnFunction: Function,
1708
+ /**
1709
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1710
+ */
1711
+ oListener?: object
1712
+ ): sap.zen.commons.Grid;
1713
+ /**
1714
+ * Attaches event handler `fnFunction` to the {@link #event:requestMoreColumns requestMoreColumns} event
1715
+ * of this `sap.zen.commons.Grid`.
1716
+ *
1717
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1718
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1719
+ *
1720
+ * Fired when the user scrolls out of the area between available columns and virtual columns
1721
+ */
1722
+ attachRequestMoreColumns(
1723
+ /**
1724
+ * An application-specific payload object that will be passed to the event handler along with the event
1725
+ * object when firing the event
1726
+ */
1727
+ oData: object,
1728
+ /**
1729
+ * The function to be called when the event occurs
1730
+ */
1731
+ fnFunction: Function,
1732
+ /**
1733
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1734
+ */
1735
+ oListener?: object
1736
+ ): sap.zen.commons.Grid;
1737
+ /**
1738
+ * Attaches event handler `fnFunction` to the {@link #event:requestMoreRows requestMoreRows} event of this
1739
+ * `sap.zen.commons.Grid`.
1740
+ *
1741
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1742
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1743
+ *
1744
+ * Fired when the user scrolls out of the area between available rows and virtual rows
1745
+ */
1746
+ attachRequestMoreRows(
1747
+ /**
1748
+ * An application-specific payload object that will be passed to the event handler along with the event
1749
+ * object when firing the event
1750
+ */
1751
+ oData: object,
1752
+ /**
1753
+ * The function to be called when the event occurs
1754
+ */
1755
+ fnFunction: Function,
1756
+ /**
1757
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1758
+ */
1759
+ oListener?: object
1760
+ ): sap.zen.commons.Grid;
1761
+ /**
1762
+ * Attaches event handler `fnFunction` to the {@link #event:rightClick rightClick} event of this `sap.zen.commons.Grid`.
1763
+ *
1764
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1765
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
1766
+ *
1767
+ * Is fired on click, the Pivot table displays the context menu
1768
+ */
1769
+ attachRightClick(
1770
+ /**
1771
+ * An application-specific payload object that will be passed to the event handler along with the event
1772
+ * object when firing the event
1773
+ */
1774
+ oData: object,
1775
+ /**
1776
+ * The function to be called when the event occurs
1777
+ */
1778
+ fnFunction: Function,
1779
+ /**
1780
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
1781
+ */
1782
+ oListener?: object
1783
+ ): sap.zen.commons.Grid;
1784
+ /**
1785
+ * Binds aggregation {@link #getCells cells} to model data.
1786
+ *
1787
+ * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
1788
+ * of the possible properties of `oBindingInfo`.
1789
+ */
1790
+ bindCells(
1791
+ /**
1792
+ * The binding information
1793
+ */
1794
+ oBindingInfo: object
1795
+ ): sap.zen.commons.Grid;
1796
+ /**
1797
+ * Destroys all the cells in the aggregation {@link #getCells cells}.
1798
+ */
1799
+ destroyCells(): sap.zen.commons.Grid;
1800
+ /**
1801
+ * Detaches event handler `fnFunction` from the {@link #event:cellEnter cellEnter} event of this `sap.zen.commons.Grid`.
1802
+ *
1803
+ * The passed function and listener object must match the ones used for event registration.
1804
+ */
1805
+ detachCellEnter(
1806
+ /**
1807
+ * The function to be called, when the event occurs
1808
+ */
1809
+ fnFunction: Function,
1810
+ /**
1811
+ * Context object on which the given function had to be called
1812
+ */
1813
+ oListener?: object
1814
+ ): sap.zen.commons.Grid;
1815
+ /**
1816
+ * Detaches event handler `fnFunction` from the {@link #event:cellLeave cellLeave} event of this `sap.zen.commons.Grid`.
1817
+ *
1818
+ * The passed function and listener object must match the ones used for event registration.
1819
+ */
1820
+ detachCellLeave(
1821
+ /**
1822
+ * The function to be called, when the event occurs
1823
+ */
1824
+ fnFunction: Function,
1825
+ /**
1826
+ * Context object on which the given function had to be called
1827
+ */
1828
+ oListener?: object
1829
+ ): sap.zen.commons.Grid;
1830
+ /**
1831
+ * Detaches event handler `fnFunction` from the {@link #event:drill drill} event of this `sap.zen.commons.Grid`.
1832
+ *
1833
+ * The passed function and listener object must match the ones used for event registration.
1834
+ */
1835
+ detachDrill(
1836
+ /**
1837
+ * The function to be called, when the event occurs
1838
+ */
1839
+ fnFunction: Function,
1840
+ /**
1841
+ * Context object on which the given function had to be called
1842
+ */
1843
+ oListener?: object
1844
+ ): sap.zen.commons.Grid;
1845
+ /**
1846
+ * Detaches event handler `fnFunction` from the {@link #event:requestMoreColumns requestMoreColumns} event
1847
+ * of this `sap.zen.commons.Grid`.
1848
+ *
1849
+ * The passed function and listener object must match the ones used for event registration.
1850
+ */
1851
+ detachRequestMoreColumns(
1852
+ /**
1853
+ * The function to be called, when the event occurs
1854
+ */
1855
+ fnFunction: Function,
1856
+ /**
1857
+ * Context object on which the given function had to be called
1858
+ */
1859
+ oListener?: object
1860
+ ): sap.zen.commons.Grid;
1861
+ /**
1862
+ * Detaches event handler `fnFunction` from the {@link #event:requestMoreRows requestMoreRows} event of
1863
+ * this `sap.zen.commons.Grid`.
1864
+ *
1865
+ * The passed function and listener object must match the ones used for event registration.
1866
+ */
1867
+ detachRequestMoreRows(
1868
+ /**
1869
+ * The function to be called, when the event occurs
1870
+ */
1871
+ fnFunction: Function,
1872
+ /**
1873
+ * Context object on which the given function had to be called
1874
+ */
1875
+ oListener?: object
1876
+ ): sap.zen.commons.Grid;
1877
+ /**
1878
+ * Detaches event handler `fnFunction` from the {@link #event:rightClick rightClick} event of this `sap.zen.commons.Grid`.
1879
+ *
1880
+ * The passed function and listener object must match the ones used for event registration.
1881
+ */
1882
+ detachRightClick(
1883
+ /**
1884
+ * The function to be called, when the event occurs
1885
+ */
1886
+ fnFunction: Function,
1887
+ /**
1888
+ * Context object on which the given function had to be called
1889
+ */
1890
+ oListener?: object
1891
+ ): sap.zen.commons.Grid;
1892
+ /**
1893
+ * Creates a new subclass of class sap.zen.commons.Grid with name `sClassName` and enriches it with the
1894
+ * information contained in `oClassInfo`.
1895
+ *
1896
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1897
+ */
1898
+ // @ts-ignore
1899
+ static extend<T extends Record<string, unknown>>(
1900
+ /**
1901
+ * Name of the class being created
1902
+ */
1903
+ sClassName: string,
1904
+ /**
1905
+ * Object literal with information about the class
1906
+ */
1907
+ oClassInfo?: T & ThisType<T & sap.zen.commons.Grid>,
1908
+ /**
1909
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1910
+ * used by this class
1911
+ */
1912
+ FNMetaImpl?: Function
1913
+ ): Function;
1914
+ /**
1915
+ * Fires event {@link #event:cellEnter cellEnter} to attached listeners.
1916
+ */
1917
+ fireCellEnter(
1918
+ /**
1919
+ * Parameters to pass along with the event
1920
+ */
1921
+ mParameters?: {
1922
+ /**
1923
+ * The cell which the user entered
1924
+ */
1925
+ cell?: sap.zen.commons.Cell;
1926
+ /**
1927
+ * The dom element which the user entered
1928
+ */
1929
+ element?: object;
1930
+ }
1931
+ ): sap.zen.commons.Grid;
1932
+ /**
1933
+ * Fires event {@link #event:cellLeave cellLeave} to attached listeners.
1934
+ */
1935
+ fireCellLeave(
1936
+ /**
1937
+ * Parameters to pass along with the event
1938
+ */
1939
+ mParameters?: {
1940
+ /**
1941
+ * The cell which the user left
1942
+ */
1943
+ cell?: sap.zen.commons.Cell;
1944
+ }
1945
+ ): sap.zen.commons.Grid;
1946
+ /**
1947
+ * Fires event {@link #event:drill drill} to attached listeners.
1948
+ */
1949
+ fireDrill(
1950
+ /**
1951
+ * Parameters to pass along with the event
1952
+ */
1953
+ mParameters?: {
1954
+ /**
1955
+ * The cell with the icon
1956
+ */
1957
+ cell?: sap.zen.commons.Cell;
1958
+ }
1959
+ ): sap.zen.commons.Grid;
1960
+ /**
1961
+ * Fires event {@link #event:requestMoreColumns requestMoreColumns} to attached listeners.
1962
+ */
1963
+ fireRequestMoreColumns(
1964
+ /**
1965
+ * Parameters to pass along with the event
1966
+ */
1967
+ mParameters?: {
1968
+ /**
1969
+ * Number of current column
1970
+ */
1971
+ currentColumn?: number;
1972
+ /**
1973
+ * Promise Resolver to be resolved or rejected when data was fetched
1974
+ */
1975
+ defered?: object;
1976
+ }
1977
+ ): sap.zen.commons.Grid;
1978
+ /**
1979
+ * Fires event {@link #event:requestMoreRows requestMoreRows} to attached listeners.
1980
+ */
1981
+ fireRequestMoreRows(
1982
+ /**
1983
+ * Parameters to pass along with the event
1984
+ */
1985
+ mParameters?: {
1986
+ /**
1987
+ * Number of current row
1988
+ */
1989
+ currentRow?: number;
1990
+ /**
1991
+ * Promise Resolver to be resolved or rejected when data was fetched
1992
+ */
1993
+ defered?: object;
1994
+ }
1995
+ ): sap.zen.commons.Grid;
1996
+ /**
1997
+ * Fires event {@link #event:rightClick rightClick} to attached listeners.
1998
+ */
1999
+ fireRightClick(
2000
+ /**
2001
+ * Parameters to pass along with the event
2002
+ */
2003
+ mParameters?: {
2004
+ /**
2005
+ * The cell on which the user clicked
2006
+ */
2007
+ cell?: sap.zen.commons.Cell;
2008
+ /**
2009
+ * The link which renders the clicked cell
2010
+ */
2011
+ link?: sap.m.Link;
2012
+ }
2013
+ ): sap.zen.commons.Grid;
2014
+ /**
2015
+ * Gets content of aggregation {@link #getCells cells}.
2016
+ *
2017
+ * Cells to be displayed
2018
+ */
2019
+ getCells(): sap.zen.commons.Cell[];
2020
+ /**
2021
+ * Gets current value of property {@link #getColumnLimit columnLimit}.
2022
+ *
2023
+ * The limit of columns transported to the fronted
2024
+ *
2025
+ * Default value is `20`.
2026
+ */
2027
+ getColumnLimit(): number;
2028
+ /**
2029
+ * Gets current value of property {@link #getFixedColumns fixedColumns}.
2030
+ *
2031
+ * Number of fixed header columns
2032
+ *
2033
+ * Default value is `0`.
2034
+ */
2035
+ getFixedColumns(): number;
2036
+ /**
2037
+ * Gets current value of property {@link #getFixedRows fixedRows}.
2038
+ *
2039
+ * Number of fixed header rows
2040
+ *
2041
+ * Default value is `0`.
2042
+ */
2043
+ getFixedRows(): number;
2044
+ /**
2045
+ * Gets current value of property {@link #getFormat format}.
2046
+ *
2047
+ * Property for different table formats
2048
+ *
2049
+ * Default value is `ExcelStyle`.
2050
+ */
2051
+ getFormat(): sap.zen.commons.Format;
2052
+ /**
2053
+ * Gets current value of property {@link #getInput input}.
2054
+ *
2055
+ * Indicator whether the grid should support data entry
2056
+ *
2057
+ * Default value is `false`.
2058
+ */
2059
+ getInput(): boolean;
2060
+ /**
2061
+ * Gets current value of property {@link #getMaxColumns maxColumns}.
2062
+ *
2063
+ * Maximum of columns to be displayed in the Grid.
2064
+ *
2065
+ * Default value is `20`.
2066
+ */
2067
+ getMaxColumns(): number;
2068
+ /**
2069
+ * Gets current value of property {@link #getMaxRows maxRows}.
2070
+ *
2071
+ * Maximum of rows to be displayed in the Grid
2072
+ *
2073
+ * Default value is `15`.
2074
+ */
2075
+ getMaxRows(): number;
2076
+ /**
2077
+ * Returns a metadata object for class sap.zen.commons.Grid.
2078
+ */
2079
+ // @ts-ignore
2080
+ static getMetadata(): sap.ui.core.ElementMetadata;
2081
+ /**
2082
+ * Gets current value of property {@link #getOffsetColumn offsetColumn}.
2083
+ *
2084
+ * offset column
2085
+ *
2086
+ * Default value is `0`.
2087
+ */
2088
+ getOffsetColumn(): number;
2089
+ /**
2090
+ * Gets current value of property {@link #getOffsetRow offsetRow}.
2091
+ *
2092
+ * offset row
2093
+ *
2094
+ * Default value is `0`.
2095
+ */
2096
+ getOffsetRow(): number;
2097
+ /**
2098
+ * Gets current value of property {@link #getRowHeight rowHeight}.
2099
+ *
2100
+ * Uniform height of a row in the Grid.
2101
+ *
2102
+ * Default value is `25`.
2103
+ */
2104
+ getRowHeight(): number;
2105
+ /**
2106
+ * Gets current value of property {@link #getRowLimit rowLimit}.
2107
+ *
2108
+ * The limit of rows transported to the fronted
2109
+ *
2110
+ * Default value is `125`.
2111
+ */
2112
+ getRowLimit(): number;
2113
+ /**
2114
+ * Gets current value of property {@link #getVirtualColumns virtualColumns}.
2115
+ *
2116
+ * Available columns in which the user can scroll
2117
+ */
2118
+ getVirtualColumns(): number;
2119
+ /**
2120
+ * Gets current value of property {@link #getVirtualRows virtualRows}.
2121
+ *
2122
+ * Available rows in which the user can scroll
2123
+ */
2124
+ getVirtualRows(): number;
2125
+ /**
2126
+ * Checks for the provided `sap.zen.commons.Cell` in the aggregation {@link #getCells cells}. and returns
2127
+ * its index if found or -1 otherwise.
2128
+ */
2129
+ indexOfCell(
2130
+ /**
2131
+ * The cell whose index is looked for
2132
+ */
2133
+ oCell: sap.zen.commons.Cell
2134
+ ): number;
2135
+ /**
2136
+ * Inserts a cell into the aggregation {@link #getCells cells}.
2137
+ */
2138
+ insertCell(
2139
+ /**
2140
+ * The cell to insert; if empty, nothing is inserted
2141
+ */
2142
+ oCell: sap.zen.commons.Cell,
2143
+ /**
2144
+ * The `0`-based index the cell should be inserted at; for a negative value of `iIndex`, the cell is inserted
2145
+ * at position 0; for a value greater than the current size of the aggregation, the cell is inserted at
2146
+ * the last position
2147
+ */
2148
+ iIndex: number
2149
+ ): sap.zen.commons.Grid;
2150
+ /**
2151
+ * Removes all the controls from the aggregation {@link #getCells cells}.
2152
+ *
2153
+ * Additionally, it unregisters them from the hosting UIArea.
2154
+ */
2155
+ removeAllCells(): sap.zen.commons.Cell[];
2156
+ /**
2157
+ * Removes a cell from the aggregation {@link #getCells cells}.
2158
+ */
2159
+ removeCell(
2160
+ /**
2161
+ * The cell to remove or its index or id
2162
+ */
2163
+ vCell: number | string | sap.zen.commons.Cell
2164
+ ): sap.zen.commons.Cell;
2165
+ /**
2166
+ * Sets a new value for property {@link #getColumnLimit columnLimit}.
2167
+ *
2168
+ * The limit of columns transported to the fronted
2169
+ *
2170
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2171
+ *
2172
+ * Default value is `20`.
2173
+ */
2174
+ setColumnLimit(
2175
+ /**
2176
+ * New value for property `columnLimit`
2177
+ */
2178
+ iColumnLimit?: number
2179
+ ): sap.zen.commons.Grid;
2180
+ /**
2181
+ * Sets a new value for property {@link #getFixedColumns fixedColumns}.
2182
+ *
2183
+ * Number of fixed header columns
2184
+ *
2185
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2186
+ *
2187
+ * Default value is `0`.
2188
+ */
2189
+ setFixedColumns(
2190
+ /**
2191
+ * New value for property `fixedColumns`
2192
+ */
2193
+ iFixedColumns?: number
2194
+ ): sap.zen.commons.Grid;
2195
+ /**
2196
+ * Sets a new value for property {@link #getFixedRows fixedRows}.
2197
+ *
2198
+ * Number of fixed header rows
2199
+ *
2200
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2201
+ *
2202
+ * Default value is `0`.
2203
+ */
2204
+ setFixedRows(
2205
+ /**
2206
+ * New value for property `fixedRows`
2207
+ */
2208
+ iFixedRows?: number
2209
+ ): sap.zen.commons.Grid;
2210
+ /**
2211
+ * Sets a new value for property {@link #getFormat format}.
2212
+ *
2213
+ * Property for different table formats
2214
+ *
2215
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2216
+ *
2217
+ * Default value is `ExcelStyle`.
2218
+ */
2219
+ setFormat(
2220
+ /**
2221
+ * New value for property `format`
2222
+ */
2223
+ sFormat?: sap.zen.commons.Format
2224
+ ): sap.zen.commons.Grid;
2225
+ /**
2226
+ * Sets a new value for property {@link #getInput input}.
2227
+ *
2228
+ * Indicator whether the grid should support data entry
2229
+ *
2230
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2231
+ *
2232
+ * Default value is `false`.
2233
+ */
2234
+ setInput(
2235
+ /**
2236
+ * New value for property `input`
2237
+ */
2238
+ bInput?: boolean
2239
+ ): sap.zen.commons.Grid;
2240
+ /**
2241
+ * Sets a new value for property {@link #getMaxColumns maxColumns}.
2242
+ *
2243
+ * Maximum of columns to be displayed in the Grid.
2244
+ *
2245
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2246
+ *
2247
+ * Default value is `20`.
2248
+ */
2249
+ setMaxColumns(
2250
+ /**
2251
+ * New value for property `maxColumns`
2252
+ */
2253
+ iMaxColumns?: number
2254
+ ): sap.zen.commons.Grid;
2255
+ /**
2256
+ * Sets a new value for property {@link #getMaxRows maxRows}.
2257
+ *
2258
+ * Maximum of rows to be displayed in the Grid
2259
+ *
2260
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2261
+ *
2262
+ * Default value is `15`.
2263
+ */
2264
+ setMaxRows(
2265
+ /**
2266
+ * New value for property `maxRows`
2267
+ */
2268
+ iMaxRows?: number
2269
+ ): sap.zen.commons.Grid;
2270
+ /**
2271
+ * Sets a new value for property {@link #getOffsetColumn offsetColumn}.
2272
+ *
2273
+ * offset column
2274
+ *
2275
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2276
+ *
2277
+ * Default value is `0`.
2278
+ */
2279
+ setOffsetColumn(
2280
+ /**
2281
+ * New value for property `offsetColumn`
2282
+ */
2283
+ iOffsetColumn?: number
2284
+ ): sap.zen.commons.Grid;
2285
+ /**
2286
+ * Sets a new value for property {@link #getOffsetRow offsetRow}.
2287
+ *
2288
+ * offset row
2289
+ *
2290
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2291
+ *
2292
+ * Default value is `0`.
2293
+ */
2294
+ setOffsetRow(
2295
+ /**
2296
+ * New value for property `offsetRow`
2297
+ */
2298
+ iOffsetRow?: number
2299
+ ): sap.zen.commons.Grid;
2300
+ /**
2301
+ * Sets a new value for property {@link #getRowHeight rowHeight}.
2302
+ *
2303
+ * Uniform height of a row in the Grid.
2304
+ *
2305
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2306
+ *
2307
+ * Default value is `25`.
2308
+ */
2309
+ setRowHeight(
2310
+ /**
2311
+ * New value for property `rowHeight`
2312
+ */
2313
+ iRowHeight?: number
2314
+ ): sap.zen.commons.Grid;
2315
+ /**
2316
+ * Sets a new value for property {@link #getRowLimit rowLimit}.
2317
+ *
2318
+ * The limit of rows transported to the fronted
2319
+ *
2320
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2321
+ *
2322
+ * Default value is `125`.
2323
+ */
2324
+ setRowLimit(
2325
+ /**
2326
+ * New value for property `rowLimit`
2327
+ */
2328
+ iRowLimit?: number
2329
+ ): sap.zen.commons.Grid;
2330
+ /**
2331
+ * Sets a new value for property {@link #getVirtualColumns virtualColumns}.
2332
+ *
2333
+ * Available columns in which the user can scroll
2334
+ *
2335
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2336
+ */
2337
+ setVirtualColumns(
2338
+ /**
2339
+ * New value for property `virtualColumns`
2340
+ */
2341
+ iVirtualColumns: number
2342
+ ): sap.zen.commons.Grid;
2343
+ /**
2344
+ * Sets a new value for property {@link #getVirtualRows virtualRows}.
2345
+ *
2346
+ * Available rows in which the user can scroll
2347
+ *
2348
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2349
+ */
2350
+ setVirtualRows(
2351
+ /**
2352
+ * New value for property `virtualRows`
2353
+ */
2354
+ iVirtualRows: number
2355
+ ): sap.zen.commons.Grid;
2356
+ /**
2357
+ * Unbinds aggregation {@link #getCells cells} from model data.
2358
+ */
2359
+ unbindCells(): sap.zen.commons.Grid;
2360
+ /**
2361
+ * Attaches event handler `fnFunction` to the {@link #event:cellEnter cellEnter} event of this `sap.zen.commons.Grid`.
2362
+ *
2363
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2364
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
2365
+ *
2366
+ * Is fired on hover, when the user enters the cell
2367
+ */
2368
+ attachCellEnter(
2369
+ /**
2370
+ * The function to be called when the event occurs
2371
+ */
2372
+ fnFunction: Function,
2373
+ /**
2374
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
2375
+ */
2376
+ oListener?: object
2377
+ ): sap.zen.commons.Grid;
2378
+ /**
2379
+ * Attaches event handler `fnFunction` to the {@link #event:cellLeave cellLeave} event of this `sap.zen.commons.Grid`.
2380
+ *
2381
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2382
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
2383
+ *
2384
+ * Is fired on hover, when the user leaves the cell
2385
+ */
2386
+ attachCellLeave(
2387
+ /**
2388
+ * The function to be called when the event occurs
2389
+ */
2390
+ fnFunction: Function,
2391
+ /**
2392
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
2393
+ */
2394
+ oListener?: object
2395
+ ): sap.zen.commons.Grid;
2396
+ /**
2397
+ * Attaches event handler `fnFunction` to the {@link #event:drill drill} event of this `sap.zen.commons.Grid`.
2398
+ *
2399
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2400
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
2401
+ *
2402
+ * Is fired on click on an icon (typically a collapse or expand) symbol
2403
+ */
2404
+ attachDrill(
2405
+ /**
2406
+ * The function to be called when the event occurs
2407
+ */
2408
+ fnFunction: Function,
2409
+ /**
2410
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
2411
+ */
2412
+ oListener?: object
2413
+ ): sap.zen.commons.Grid;
2414
+ /**
2415
+ * Attaches event handler `fnFunction` to the {@link #event:requestMoreColumns requestMoreColumns} event
2416
+ * of this `sap.zen.commons.Grid`.
2417
+ *
2418
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2419
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
2420
+ *
2421
+ * Fired when the user scrolls out of the area between available columns and virtual columns
2422
+ */
2423
+ attachRequestMoreColumns(
2424
+ /**
2425
+ * The function to be called when the event occurs
2426
+ */
2427
+ fnFunction: Function,
2428
+ /**
2429
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
2430
+ */
2431
+ oListener?: object
2432
+ ): sap.zen.commons.Grid;
2433
+ /**
2434
+ * Attaches event handler `fnFunction` to the {@link #event:requestMoreRows requestMoreRows} event of this
2435
+ * `sap.zen.commons.Grid`.
2436
+ *
2437
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2438
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
2439
+ *
2440
+ * Fired when the user scrolls out of the area between available rows and virtual rows
2441
+ */
2442
+ attachRequestMoreRows(
2443
+ /**
2444
+ * The function to be called when the event occurs
2445
+ */
2446
+ fnFunction: Function,
2447
+ /**
2448
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
2449
+ */
2450
+ oListener?: object
2451
+ ): sap.zen.commons.Grid;
2452
+ /**
2453
+ * Attaches event handler `fnFunction` to the {@link #event:rightClick rightClick} event of this `sap.zen.commons.Grid`.
2454
+ *
2455
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2456
+ * otherwise it will be bound to this `sap.zen.commons.Grid` itself.
2457
+ *
2458
+ * Is fired on click, the Pivot table displays the context menu
2459
+ */
2460
+ attachRightClick(
2461
+ /**
2462
+ * The function to be called when the event occurs
2463
+ */
2464
+ fnFunction: Function,
2465
+ /**
2466
+ * Context object to call the event handler with. Defaults to this `sap.zen.commons.Grid` itself
2467
+ */
2468
+ oListener?: object
2469
+ ): sap.zen.commons.Grid;
2470
+ }
2471
+ /**
2472
+ * @SINCE 1.89
2473
+ * @EXPERIMENTAL (since 1.89)
2474
+ *
2475
+ * Semantic Style of a Grid.
2476
+ */
2477
+ class SemanticStyle extends sap.ui.core.Element {
2478
+ /**
2479
+ * Creates and initializes a new Semantic Style. settings.
2480
+ *
2481
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2482
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2483
+ * of the syntax of the settings object.
2484
+ */
2485
+ constructor(
2486
+ /**
2487
+ * ID for the new element, generated automatically if no ID is given
2488
+ */
2489
+ sId?: string,
2490
+ /**
2491
+ * Initial settings for the new element
2492
+ */
2493
+ mSettings?: $SemanticStyleSettings
2494
+ );
2495
+
2496
+ /**
2497
+ * Creates a new subclass of class sap.zen.commons.SemanticStyle with name `sClassName` and enriches it
2498
+ * with the information contained in `oClassInfo`.
2499
+ *
2500
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
2501
+ */
2502
+ // @ts-ignore
2503
+ static extend<T extends Record<string, unknown>>(
2504
+ /**
2505
+ * Name of the class being created
2506
+ */
2507
+ sClassName: string,
2508
+ /**
2509
+ * Object literal with information about the class
2510
+ */
2511
+ oClassInfo?: T & ThisType<T & sap.zen.commons.SemanticStyle>,
2512
+ /**
2513
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2514
+ * used by this class
2515
+ */
2516
+ FNMetaImpl?: Function
2517
+ ): Function;
2518
+ /**
2519
+ * Gets current value of property {@link #getCssClass cssClass}.
2520
+ *
2521
+ * The associated css class
2522
+ */
2523
+ getCssClass(): string;
2524
+ /**
2525
+ * Returns a metadata object for class sap.zen.commons.SemanticStyle.
2526
+ */
2527
+ // @ts-ignore
2528
+ static getMetadata(): sap.ui.core.ElementMetadata;
2529
+ /**
2530
+ * Gets current value of property {@link #getSemanticClass semanticClass}.
2531
+ *
2532
+ * The semantic class
2533
+ */
2534
+ getSemanticClass(): string;
2535
+ /**
2536
+ * Sets a new value for property {@link #getCssClass cssClass}.
2537
+ *
2538
+ * The associated css class
2539
+ *
2540
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2541
+ */
2542
+ setCssClass(
2543
+ /**
2544
+ * New value for property `cssClass`
2545
+ */
2546
+ sCssClass: string
2547
+ ): sap.zen.commons.SemanticStyle;
2548
+ /**
2549
+ * Sets a new value for property {@link #getSemanticClass semanticClass}.
2550
+ *
2551
+ * The semantic class
2552
+ *
2553
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2554
+ */
2555
+ setSemanticClass(
2556
+ /**
2557
+ * New value for property `semanticClass`
2558
+ */
2559
+ sSemanticClass: string
2560
+ ): sap.zen.commons.SemanticStyle;
2561
+ }
2562
+ /**
2563
+ * Alert Level.
2564
+ */
2565
+ enum AlertLevel {
2566
+ /**
2567
+ * Bad 1
2568
+ */
2569
+ BAD_1,
2570
+ /**
2571
+ * Bad 2
2572
+ */
2573
+ BAD_2,
2574
+ /**
2575
+ * Bad 3
2576
+ */
2577
+ BAD_3,
2578
+ /**
2579
+ * Critical 1
2580
+ */
2581
+ CRITICAL_1,
2582
+ /**
2583
+ * Critical 2
2584
+ */
2585
+ CRITICAL_2,
2586
+ /**
2587
+ * Critical 3
2588
+ */
2589
+ CRITICAL_3,
2590
+ /**
2591
+ * Good 1
2592
+ */
2593
+ GOOD_1,
2594
+ /**
2595
+ * Good 2
2596
+ */
2597
+ GOOD_2,
2598
+ /**
2599
+ * Good 3
2600
+ */
2601
+ GOOD_3,
2602
+ /**
2603
+ * Normal
2604
+ */
2605
+ NORMAL,
2606
+ }
2607
+ /**
2608
+ * Types of a grid cell.
2609
+ */
2610
+ enum CellType {
2611
+ /**
2612
+ * A data cell, representing value with a critical flavour
2613
+ */
2614
+ CRITICAL,
2615
+ /**
2616
+ * An empty data cell
2617
+ */
2618
+ EMPTY,
2619
+ /**
2620
+ * A header cell, representing a member of a (virtual) dimension
2621
+ */
2622
+ HEADER,
2623
+ /**
2624
+ * A data cell, representing value with a negative flavour
2625
+ */
2626
+ NEGATIVE,
2627
+ /**
2628
+ * A data cell, representing value with a positive flavour
2629
+ */
2630
+ POSITIVE,
2631
+ /**
2632
+ * A result cell, representing an aggregated value
2633
+ */
2634
+ RESULT,
2635
+ /**
2636
+ * A result cell, representing an aggregated value with a critical flavour
2637
+ */
2638
+ RESULT_CRITICAL,
2639
+ /**
2640
+ * A virtual member of a dimension indicating an aggregation of members
2641
+ */
2642
+ RESULT_HEADER,
2643
+ /**
2644
+ * A result cell, representing an aggregated value with a negative flavour
2645
+ */
2646
+ RESULT_NEGATIVE,
2647
+ /**
2648
+ * A result cell, representing an aggregated value with a positive flavour
2649
+ */
2650
+ RESULT_POSITIVE,
2651
+ /**
2652
+ * A data cell, representing value
2653
+ */
2654
+ STANDARD,
2655
+ /**
2656
+ * A title cell, representing a dimension
2657
+ */
2658
+ TITLE,
2659
+ }
2660
+ /**
2661
+ * Format to be applied to a `Grid`
2662
+ */
2663
+ enum Format {
2664
+ /**
2665
+ * Basic grid format
2666
+ */
2667
+ Basic,
2668
+ /**
2669
+ * business style
2670
+ */
2671
+ BusinessStyle,
2672
+ /**
2673
+ * busines formular style
2674
+ */
2675
+ BusinessStyleFormular,
2676
+ /**
2677
+ * custom style
2678
+ */
2679
+ CustomStyle,
2680
+ /**
2681
+ * mimicking spreadsheet
2682
+ */
2683
+ ExcelStyle,
2684
+ }
2685
+ /**
2686
+ * Horizontal alignment, e.g. of a layout cell's content within the cell's borders. Note that some values
2687
+ * depend on the current locale's writing direction while others do not.
2688
+ */
2689
+ enum HAlign {
2690
+ /**
2691
+ * Aligned towards the beginning of a line, in the current locale's writing direction.
2692
+ */
2693
+ Begin,
2694
+ /**
2695
+ * Horizontally centered.
2696
+ */
2697
+ Center,
2698
+ /**
2699
+ * Aligned towards the end of a line, in the current locale's writing direction.
2700
+ */
2701
+ End,
2702
+ /**
2703
+ * Left aligned, regardless of the current locale's writing direction.
2704
+ */
2705
+ Left,
2706
+ /**
2707
+ * Right aligned, regardless of the current locale's writing direction.
2708
+ */
2709
+ Right,
2710
+ }
2711
+ /**
2712
+ * @EXPERIMENTAL
2713
+ *
2714
+ * Padding, e.g. of a layout cell's content within the cell's borders. Note that all options except "None"
2715
+ * include a padding of 2px at the top and bottom, and differ only in the presence of a 4px padding towards
2716
+ * the beginning or end of a line, in the current locale's writing direction.
2717
+ */
2718
+ enum Padding {
2719
+ /**
2720
+ * Top and bottom padding of 2px. Padding of 4px towards the beginning of a line, in the current locale's
2721
+ * writing direction, but none towards its end.
2722
+ */
2723
+ Begin,
2724
+ /**
2725
+ * Top and bottom padding of 2px. Padding of 4px towards both the beginning and end of a line.
2726
+ */
2727
+ Both,
2728
+ /**
2729
+ * Top and bottom padding of 2px. Padding of 4px towards the end of a line, in the current locale's writing
2730
+ * direction, but none towards its beginning.
2731
+ */
2732
+ End,
2733
+ /**
2734
+ * Top and bottom padding of 2px. No padding towards neither the beginning nor end of a line.
2735
+ */
2736
+ Neither,
2737
+ /**
2738
+ * No padding at all.
2739
+ */
2740
+ None,
2741
+ }
2742
+ /**
2743
+ * Separation, e.g. of a layout cell from its neighbor, via a vertical gutter of defined width, with or
2744
+ * without a vertical line in its middle.
2745
+ */
2746
+ enum Separation {
2747
+ /**
2748
+ * A large (63px) vertical gutter without a vertical line.
2749
+ */
2750
+ Large,
2751
+ /**
2752
+ * A large (63px) vertical gutter with a vertical line in its middle.
2753
+ */
2754
+ LargeWithLine,
2755
+ /**
2756
+ * A medium (31px) vertical gutter without a vertical line.
2757
+ */
2758
+ Medium,
2759
+ /**
2760
+ * A medium (31px) vertical gutter with a vertical line in its middle.
2761
+ */
2762
+ MediumWithLine,
2763
+ /**
2764
+ * No gutter at all (0px), and without a vertical line, of course.
2765
+ */
2766
+ None,
2767
+ /**
2768
+ * A small (17px) vertical gutter without a vertical line.
2769
+ */
2770
+ Small,
2771
+ /**
2772
+ * A small (17px) vertical gutter with a vertical line in its middle.
2773
+ */
2774
+ SmallWithLine,
2775
+ }
2776
+ /**
2777
+ * Vertical alignment, e.g. of a layout cell's content within the cell's borders.
2778
+ */
2779
+ enum VAlign {
2780
+ /**
2781
+ * Aligned at the bottom.
2782
+ */
2783
+ Bottom,
2784
+ /**
2785
+ * Vertically centered.
2786
+ */
2787
+ Middle,
2788
+ /**
2789
+ * Aligned at the top.
2790
+ */
2791
+ Top,
2792
+ }
2793
+ }
2794
+ }
2795
+
2796
+ interface IUI5DefineDependencyNames {
2797
+ "sap/zen/commons/layout/AbsoluteLayout": undefined;
2798
+
2799
+ "sap/zen/commons/layout/MatrixLayout": undefined;
2800
+
2801
+ "sap/zen/commons/layout/MatrixLayoutCell": undefined;
2802
+
2803
+ "sap/zen/commons/layout/MatrixLayoutRow": undefined;
2804
+
2805
+ "sap/zen/commons/layout/PositionContainer": undefined;
2806
+
2807
+ "sap/zen/commons/Cell": undefined;
2808
+
2809
+ "sap/zen/commons/Grid": undefined;
2810
+
2811
+ "sap/zen/commons/SemanticStyle": undefined;
2812
+ }
5
2813
  }