@sapui5/types 1.113.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +35 -0
- package/README.md +35 -0
- package/package.json +23 -0
- package/types/index.d.ts +67 -0
- package/types/sap.apf.d.ts +1026 -0
- package/types/sap.ca.ui.d.ts +14005 -0
- package/types/sap.chart.d.ts +4815 -0
- package/types/sap.collaboration.d.ts +2704 -0
- package/types/sap.esh.search.ui.d.ts +1595 -0
- package/types/sap.f.d.ts +20085 -0
- package/types/sap.fe.core.d.ts +1508 -0
- package/types/sap.fe.macros.d.ts +975 -0
- package/types/sap.fe.navigation.d.ts +917 -0
- package/types/sap.fe.templates.d.ts +522 -0
- package/types/sap.fe.test.d.ts +3533 -0
- package/types/sap.feedback.ui.d.ts +3 -0
- package/types/sap.gantt.d.ts +51684 -0
- package/types/sap.insights.d.ts +23 -0
- package/types/sap.landvisz.d.ts +7952 -0
- package/types/sap.m.d.ts +147796 -0
- package/types/sap.makit.d.ts +4533 -0
- package/types/sap.me.d.ts +3665 -0
- package/types/sap.ndc.d.ts +774 -0
- package/types/sap.ovp.d.ts +176 -0
- package/types/sap.rules.ui.d.ts +1471 -0
- package/types/sap.sac.df.d.ts +2292 -0
- package/types/sap.sac.grid.d.ts +774 -0
- package/types/sap.suite.ui.commons.d.ts +46971 -0
- package/types/sap.suite.ui.generic.template.d.ts +3431 -0
- package/types/sap.suite.ui.microchart.d.ts +12652 -0
- package/types/sap.tnt.d.ts +2227 -0
- package/types/sap.ui.codeeditor.d.ts +693 -0
- package/types/sap.ui.commons.d.ts +30235 -0
- package/types/sap.ui.comp.d.ts +37411 -0
- package/types/sap.ui.core.d.ts +78872 -0
- package/types/sap.ui.dt.d.ts +3 -0
- package/types/sap.ui.export.d.ts +843 -0
- package/types/sap.ui.fl.d.ts +1663 -0
- package/types/sap.ui.generic.app.d.ts +2683 -0
- package/types/sap.ui.generic.template.d.ts +3 -0
- package/types/sap.ui.integration.d.ts +4032 -0
- package/types/sap.ui.layout.d.ts +14472 -0
- package/types/sap.ui.mdc.d.ts +476 -0
- package/types/sap.ui.richtexteditor.d.ts +1666 -0
- package/types/sap.ui.rta.d.ts +124 -0
- package/types/sap.ui.suite.d.ts +685 -0
- package/types/sap.ui.support.d.ts +453 -0
- package/types/sap.ui.table.d.ts +9325 -0
- package/types/sap.ui.testrecorder.d.ts +9 -0
- package/types/sap.ui.unified.d.ts +20640 -0
- package/types/sap.ui.ux3.d.ts +18288 -0
- package/types/sap.ui.vbm.d.ts +17251 -0
- package/types/sap.ui.vk.d.ts +42381 -0
- package/types/sap.ui.vtm.d.ts +10547 -0
- package/types/sap.ui.webc.common.d.ts +113 -0
- package/types/sap.ui.webc.fiori.d.ts +13850 -0
- package/types/sap.ui.webc.main.d.ts +40833 -0
- package/types/sap.uiext.inbox.d.ts +4079 -0
- package/types/sap.ushell.d.ts +10255 -0
- package/types/sap.ushell_abap.d.ts +9 -0
- package/types/sap.uxap.d.ts +7636 -0
- package/types/sap.viz.d.ts +51209 -0
- package/types/sap.webanalytics.core.d.ts +3 -0
- package/types/sap.zen.commons.d.ts +1542 -0
- package/types/sap.zen.crosstab.d.ts +1159 -0
- package/types/sap.zen.dsh.d.ts +2132 -0
|
@@ -0,0 +1,1542 @@
|
|
|
1
|
+
// For Library Version: 1.113.0
|
|
2
|
+
|
|
3
|
+
declare module "sap/zen/commons/library" {}
|
|
4
|
+
|
|
5
|
+
declare module "sap/zen/commons/HAlign" {
|
|
6
|
+
/**
|
|
7
|
+
* @deprecated (since 1.89.0)
|
|
8
|
+
*
|
|
9
|
+
* Horizontal alignment, e.g. of a layout cell's content within the cell's borders. Note that some values
|
|
10
|
+
* depend on the current locale's writing direction while others do not.
|
|
11
|
+
*/
|
|
12
|
+
enum HAlign {
|
|
13
|
+
/**
|
|
14
|
+
* Aligned towards the beginning of a line, in the current locale's writing direction.
|
|
15
|
+
*/
|
|
16
|
+
Begin = "Begin",
|
|
17
|
+
/**
|
|
18
|
+
* Horizontally centered.
|
|
19
|
+
*/
|
|
20
|
+
Center = "Center",
|
|
21
|
+
/**
|
|
22
|
+
* Aligned towards the end of a line, in the current locale's writing direction.
|
|
23
|
+
*/
|
|
24
|
+
End = "End",
|
|
25
|
+
/**
|
|
26
|
+
* Left aligned, regardless of the current locale's writing direction.
|
|
27
|
+
*/
|
|
28
|
+
Left = "Left",
|
|
29
|
+
/**
|
|
30
|
+
* Right aligned, regardless of the current locale's writing direction.
|
|
31
|
+
*/
|
|
32
|
+
Right = "Right",
|
|
33
|
+
}
|
|
34
|
+
export default HAlign;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
declare module "sap/zen/commons/layout/AbsoluteLayout" {
|
|
38
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
39
|
+
|
|
40
|
+
import PositionContainer from "sap/zen/commons/layout/PositionContainer";
|
|
41
|
+
|
|
42
|
+
import { CSSSize, Scrolling } from "sap/ui/core/library";
|
|
43
|
+
|
|
44
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
45
|
+
|
|
46
|
+
import {
|
|
47
|
+
PropertyBindingInfo,
|
|
48
|
+
AggregationBindingInfo,
|
|
49
|
+
} from "sap/ui/base/ManagedObject";
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* @deprecated (since 1.38)
|
|
53
|
+
*
|
|
54
|
+
* The Absolute Layout positions its child controls absolutely
|
|
55
|
+
*/
|
|
56
|
+
export default class AbsoluteLayout extends Control {
|
|
57
|
+
/**
|
|
58
|
+
* Constructor for a new layout/AbsoluteLayout.
|
|
59
|
+
*
|
|
60
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
61
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
62
|
+
* of the syntax of the settings object.
|
|
63
|
+
*/
|
|
64
|
+
constructor(
|
|
65
|
+
/**
|
|
66
|
+
* initial settings for the new control
|
|
67
|
+
*/
|
|
68
|
+
mSettings?: $AbsoluteLayoutSettings
|
|
69
|
+
);
|
|
70
|
+
/**
|
|
71
|
+
* Constructor for a new layout/AbsoluteLayout.
|
|
72
|
+
*
|
|
73
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
74
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
75
|
+
* of the syntax of the settings object.
|
|
76
|
+
*/
|
|
77
|
+
constructor(
|
|
78
|
+
/**
|
|
79
|
+
* id for the new control, generated automatically if no id is given
|
|
80
|
+
*/
|
|
81
|
+
sId?: string,
|
|
82
|
+
/**
|
|
83
|
+
* initial settings for the new control
|
|
84
|
+
*/
|
|
85
|
+
mSettings?: $AbsoluteLayoutSettings
|
|
86
|
+
);
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* Creates a new subclass of class sap.zen.commons.layout.AbsoluteLayout with name `sClassName` and enriches
|
|
90
|
+
* it with the information contained in `oClassInfo`.
|
|
91
|
+
*
|
|
92
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
93
|
+
*
|
|
94
|
+
* @returns Created class / constructor function
|
|
95
|
+
*/
|
|
96
|
+
static extend<T extends Record<string, unknown>>(
|
|
97
|
+
/**
|
|
98
|
+
* Name of the class being created
|
|
99
|
+
*/
|
|
100
|
+
sClassName: string,
|
|
101
|
+
/**
|
|
102
|
+
* Object literal with information about the class
|
|
103
|
+
*/
|
|
104
|
+
oClassInfo?: sap.ClassInfo<T, AbsoluteLayout>,
|
|
105
|
+
/**
|
|
106
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
107
|
+
* used by this class
|
|
108
|
+
*/
|
|
109
|
+
FNMetaImpl?: Function
|
|
110
|
+
): Function;
|
|
111
|
+
/**
|
|
112
|
+
* Returns a metadata object for class sap.zen.commons.layout.AbsoluteLayout.
|
|
113
|
+
*
|
|
114
|
+
* @returns Metadata object describing this class
|
|
115
|
+
*/
|
|
116
|
+
static getMetadata(): ElementMetadata;
|
|
117
|
+
/**
|
|
118
|
+
* Adds the given control and a corresponding position container into the aggregation named 'positions'.
|
|
119
|
+
* Returns 'this' to allow method chaining.
|
|
120
|
+
*/
|
|
121
|
+
addContent(
|
|
122
|
+
/**
|
|
123
|
+
* The content to add; if empty, nothing is inserted.
|
|
124
|
+
*/
|
|
125
|
+
oContent: Control,
|
|
126
|
+
/**
|
|
127
|
+
* JSON-like object which defines the position of the child control in the layout. The object is expected
|
|
128
|
+
* to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize.
|
|
129
|
+
* If no object is given, the default is left=0px,right=0px
|
|
130
|
+
*/
|
|
131
|
+
oPos: object
|
|
132
|
+
): AbsoluteLayout;
|
|
133
|
+
/**
|
|
134
|
+
* Adds some position to the aggregation {@link #getPositions positions}.
|
|
135
|
+
*
|
|
136
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
137
|
+
*/
|
|
138
|
+
addPosition(
|
|
139
|
+
/**
|
|
140
|
+
* The position to add; if empty, nothing is inserted
|
|
141
|
+
*/
|
|
142
|
+
oPosition: PositionContainer
|
|
143
|
+
): this;
|
|
144
|
+
/**
|
|
145
|
+
* Destroys all aggregated position containers and their child controls. Returns 'this' to allow method
|
|
146
|
+
* chaining.
|
|
147
|
+
*/
|
|
148
|
+
destroyContent(): AbsoluteLayout;
|
|
149
|
+
/**
|
|
150
|
+
* Destroys all the positions in the aggregation {@link #getPositions positions}.
|
|
151
|
+
*
|
|
152
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
153
|
+
*/
|
|
154
|
+
destroyPositions(): this;
|
|
155
|
+
/**
|
|
156
|
+
* Returns an array of the controls contained in the aggregated position containers (might be empty).
|
|
157
|
+
*/
|
|
158
|
+
getContent(): Control[];
|
|
159
|
+
/**
|
|
160
|
+
* Gets current value of property {@link #getHeight height}.
|
|
161
|
+
*
|
|
162
|
+
* The overall height of the control. When not set, 100% is automatically set.
|
|
163
|
+
*
|
|
164
|
+
* Default value is `"100%"`.
|
|
165
|
+
*
|
|
166
|
+
* @returns Value of property `height`
|
|
167
|
+
*/
|
|
168
|
+
getHeight(): CSSSize;
|
|
169
|
+
/**
|
|
170
|
+
* Gets current value of property {@link #getHorizontalScrolling horizontalScrolling}.
|
|
171
|
+
*
|
|
172
|
+
* 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
|
|
173
|
+
*
|
|
174
|
+
* Default value is `Hidden`.
|
|
175
|
+
*
|
|
176
|
+
* @returns Value of property `horizontalScrolling`
|
|
177
|
+
*/
|
|
178
|
+
getHorizontalScrolling(): Scrolling | keyof typeof Scrolling;
|
|
179
|
+
/**
|
|
180
|
+
* Gets content of aggregation {@link #getPositions positions}.
|
|
181
|
+
*
|
|
182
|
+
* Positioned child controls within the layout
|
|
183
|
+
*/
|
|
184
|
+
getPositions(): PositionContainer[];
|
|
185
|
+
/**
|
|
186
|
+
* Gets current value of property {@link #getVerticalScrolling verticalScrolling}.
|
|
187
|
+
*
|
|
188
|
+
* 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
|
|
189
|
+
*
|
|
190
|
+
* Default value is `Hidden`.
|
|
191
|
+
*
|
|
192
|
+
* @returns Value of property `verticalScrolling`
|
|
193
|
+
*/
|
|
194
|
+
getVerticalScrolling(): Scrolling | keyof typeof Scrolling;
|
|
195
|
+
/**
|
|
196
|
+
* Gets current value of property {@link #getWidth width}.
|
|
197
|
+
*
|
|
198
|
+
* The overall width of the control. When not set, 100% is automatically set.
|
|
199
|
+
*
|
|
200
|
+
* Default value is `'100%'`.
|
|
201
|
+
*
|
|
202
|
+
* @returns Value of property `width`
|
|
203
|
+
*/
|
|
204
|
+
getWidth(): CSSSize;
|
|
205
|
+
/**
|
|
206
|
+
* Checks for the provided sap.ui.core.Control in the aggregated position containers, and returns the index
|
|
207
|
+
* of the container in the positions aggregation if found, or '-1' otherwise.
|
|
208
|
+
*/
|
|
209
|
+
indexOfContent(
|
|
210
|
+
/**
|
|
211
|
+
* The content of which the index is looked for
|
|
212
|
+
*/
|
|
213
|
+
oContent: Control
|
|
214
|
+
): int;
|
|
215
|
+
/**
|
|
216
|
+
* Checks for the provided `sap.zen.commons.layout.PositionContainer` in the aggregation {@link #getPositions
|
|
217
|
+
* positions}. and returns its index if found or -1 otherwise.
|
|
218
|
+
*
|
|
219
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
220
|
+
*/
|
|
221
|
+
indexOfPosition(
|
|
222
|
+
/**
|
|
223
|
+
* The position whose index is looked for
|
|
224
|
+
*/
|
|
225
|
+
oPosition: PositionContainer
|
|
226
|
+
): int;
|
|
227
|
+
/**
|
|
228
|
+
* Inserts the given control and a corresponding position container into the aggregation named 'positions'.
|
|
229
|
+
* Returns 'this' to allow method chaining.
|
|
230
|
+
*/
|
|
231
|
+
insertContent(
|
|
232
|
+
/**
|
|
233
|
+
* The content to insert; if empty, nothing is inserted
|
|
234
|
+
*/
|
|
235
|
+
oContent: Control,
|
|
236
|
+
/**
|
|
237
|
+
* The '0'-based index where the content shall be inserted at. For a negative value of iIndex, the content
|
|
238
|
+
* is inserted at position '0'; for a value greater than the current size of the aggregation, the content
|
|
239
|
+
* is inserted at the last position.
|
|
240
|
+
*/
|
|
241
|
+
iIndex: int,
|
|
242
|
+
/**
|
|
243
|
+
* JSON-like object which defines the position of the child control within the layout. The object is expected
|
|
244
|
+
* to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize.
|
|
245
|
+
* If no object is given, the default is left=0px,right=0px.
|
|
246
|
+
*/
|
|
247
|
+
oPos: object
|
|
248
|
+
): AbsoluteLayout;
|
|
249
|
+
/**
|
|
250
|
+
* Inserts a position into the aggregation {@link #getPositions positions}.
|
|
251
|
+
*
|
|
252
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
253
|
+
*/
|
|
254
|
+
insertPosition(
|
|
255
|
+
/**
|
|
256
|
+
* The position to insert; if empty, nothing is inserted
|
|
257
|
+
*/
|
|
258
|
+
oPosition: PositionContainer,
|
|
259
|
+
/**
|
|
260
|
+
* The `0`-based index the position should be inserted at; for a negative value of `iIndex`, the position
|
|
261
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the position
|
|
262
|
+
* is inserted at the last position
|
|
263
|
+
*/
|
|
264
|
+
iIndex: int
|
|
265
|
+
): this;
|
|
266
|
+
/**
|
|
267
|
+
* Removes all aggregated position containers. Returns an array of the controls contained in the removed
|
|
268
|
+
* position containers (might be empty).
|
|
269
|
+
*/
|
|
270
|
+
removeAllContent(): Control[];
|
|
271
|
+
/**
|
|
272
|
+
* Removes all the controls from the aggregation {@link #getPositions positions}.
|
|
273
|
+
*
|
|
274
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
275
|
+
*
|
|
276
|
+
* @returns An array of the removed elements (might be empty)
|
|
277
|
+
*/
|
|
278
|
+
removeAllPositions(): PositionContainer[];
|
|
279
|
+
/**
|
|
280
|
+
* Removes the given control and its corresponding position container from the aggregation named 'positions'.
|
|
281
|
+
*/
|
|
282
|
+
removeContent(
|
|
283
|
+
/**
|
|
284
|
+
* The content control to remove, its ID, or the index of the corresponding position container in the 'positions'
|
|
285
|
+
* aggregation.
|
|
286
|
+
*/
|
|
287
|
+
oContent: object
|
|
288
|
+
): Control;
|
|
289
|
+
/**
|
|
290
|
+
* Removes a position from the aggregation {@link #getPositions positions}.
|
|
291
|
+
*
|
|
292
|
+
* @returns The removed position or `null`
|
|
293
|
+
*/
|
|
294
|
+
removePosition(
|
|
295
|
+
/**
|
|
296
|
+
* The position to remove or its index or id
|
|
297
|
+
*/
|
|
298
|
+
vPosition: int | string | PositionContainer
|
|
299
|
+
): PositionContainer | null;
|
|
300
|
+
/**
|
|
301
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
302
|
+
*
|
|
303
|
+
* The overall height of the control. When not set, 100% is automatically set.
|
|
304
|
+
*
|
|
305
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
306
|
+
*
|
|
307
|
+
* Default value is `"100%"`.
|
|
308
|
+
*
|
|
309
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
310
|
+
*/
|
|
311
|
+
setHeight(
|
|
312
|
+
/**
|
|
313
|
+
* New value for property `height`
|
|
314
|
+
*/
|
|
315
|
+
sHeight?: CSSSize
|
|
316
|
+
): this;
|
|
317
|
+
/**
|
|
318
|
+
* Sets a new value for property {@link #getHorizontalScrolling horizontalScrolling}.
|
|
319
|
+
*
|
|
320
|
+
* 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
|
|
321
|
+
*
|
|
322
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
323
|
+
*
|
|
324
|
+
* Default value is `Hidden`.
|
|
325
|
+
*
|
|
326
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
327
|
+
*/
|
|
328
|
+
setHorizontalScrolling(
|
|
329
|
+
/**
|
|
330
|
+
* New value for property `horizontalScrolling`
|
|
331
|
+
*/
|
|
332
|
+
sHorizontalScrolling?: Scrolling | keyof typeof Scrolling
|
|
333
|
+
): this;
|
|
334
|
+
/**
|
|
335
|
+
* Allows to set or change the position information of the given child control
|
|
336
|
+
*/
|
|
337
|
+
setPositionOfChild(
|
|
338
|
+
/**
|
|
339
|
+
* The child control for which to change the position information; if empty or not aggregated, nothing is
|
|
340
|
+
* changed
|
|
341
|
+
*/
|
|
342
|
+
oControl: Control,
|
|
343
|
+
/**
|
|
344
|
+
* JSON-like object which defines the position of the child control. The object is expected to have one
|
|
345
|
+
* or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize.
|
|
346
|
+
* If no object is given, the default is used which is left=0px,right=0px.
|
|
347
|
+
*/
|
|
348
|
+
oPos: object
|
|
349
|
+
): boolean;
|
|
350
|
+
/**
|
|
351
|
+
* Sets a new value for property {@link #getVerticalScrolling verticalScrolling}.
|
|
352
|
+
*
|
|
353
|
+
* 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
|
|
354
|
+
*
|
|
355
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
356
|
+
*
|
|
357
|
+
* Default value is `Hidden`.
|
|
358
|
+
*
|
|
359
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
360
|
+
*/
|
|
361
|
+
setVerticalScrolling(
|
|
362
|
+
/**
|
|
363
|
+
* New value for property `verticalScrolling`
|
|
364
|
+
*/
|
|
365
|
+
sVerticalScrolling?: Scrolling | keyof typeof Scrolling
|
|
366
|
+
): this;
|
|
367
|
+
/**
|
|
368
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
369
|
+
*
|
|
370
|
+
* The overall width of the control. When not set, 100% is automatically set.
|
|
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 `'100%'`.
|
|
375
|
+
*
|
|
376
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
377
|
+
*/
|
|
378
|
+
setWidth(
|
|
379
|
+
/**
|
|
380
|
+
* New value for property `width`
|
|
381
|
+
*/
|
|
382
|
+
sWidth?: CSSSize
|
|
383
|
+
): this;
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
export interface $AbsoluteLayoutSettings extends $ControlSettings {
|
|
387
|
+
/**
|
|
388
|
+
* The overall width of the control. When not set, 100% is automatically set.
|
|
389
|
+
*/
|
|
390
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
391
|
+
|
|
392
|
+
/**
|
|
393
|
+
* The overall height of the control. When not set, 100% is automatically set.
|
|
394
|
+
*/
|
|
395
|
+
height?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
396
|
+
|
|
397
|
+
/**
|
|
398
|
+
* 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
|
|
399
|
+
*/
|
|
400
|
+
verticalScrolling?:
|
|
401
|
+
| (Scrolling | keyof typeof Scrolling)
|
|
402
|
+
| PropertyBindingInfo
|
|
403
|
+
| `{${string}}`;
|
|
404
|
+
|
|
405
|
+
/**
|
|
406
|
+
* 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode.
|
|
407
|
+
*/
|
|
408
|
+
horizontalScrolling?:
|
|
409
|
+
| (Scrolling | keyof typeof Scrolling)
|
|
410
|
+
| PropertyBindingInfo
|
|
411
|
+
| `{${string}}`;
|
|
412
|
+
|
|
413
|
+
/**
|
|
414
|
+
* Positioned child controls within the layout
|
|
415
|
+
*/
|
|
416
|
+
positions?:
|
|
417
|
+
| PositionContainer[]
|
|
418
|
+
| PositionContainer
|
|
419
|
+
| AggregationBindingInfo
|
|
420
|
+
| `{${string}}`;
|
|
421
|
+
}
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
declare module "sap/zen/commons/layout/MatrixLayout" {
|
|
425
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
426
|
+
|
|
427
|
+
import MatrixLayoutRow from "sap/zen/commons/layout/MatrixLayoutRow";
|
|
428
|
+
|
|
429
|
+
import MatrixLayoutCell from "sap/zen/commons/layout/MatrixLayoutCell";
|
|
430
|
+
|
|
431
|
+
import { CSSSize } from "sap/ui/core/library";
|
|
432
|
+
|
|
433
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
434
|
+
|
|
435
|
+
import {
|
|
436
|
+
PropertyBindingInfo,
|
|
437
|
+
AggregationBindingInfo,
|
|
438
|
+
} from "sap/ui/base/ManagedObject";
|
|
439
|
+
|
|
440
|
+
/**
|
|
441
|
+
* @deprecated (since 1.38) - Instead, use the `sap.ui.layout.Grid` control.
|
|
442
|
+
*/
|
|
443
|
+
export default class MatrixLayout extends Control {
|
|
444
|
+
/**
|
|
445
|
+
* Constructor for a new layout/MatrixLayout.
|
|
446
|
+
*
|
|
447
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
448
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
449
|
+
* of the syntax of the settings object.
|
|
450
|
+
*/
|
|
451
|
+
constructor(
|
|
452
|
+
/**
|
|
453
|
+
* initial settings for the new control
|
|
454
|
+
*/
|
|
455
|
+
mSettings?: $MatrixLayoutSettings
|
|
456
|
+
);
|
|
457
|
+
/**
|
|
458
|
+
* Constructor for a new layout/MatrixLayout.
|
|
459
|
+
*
|
|
460
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
461
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
462
|
+
* of the syntax of the settings object.
|
|
463
|
+
*/
|
|
464
|
+
constructor(
|
|
465
|
+
/**
|
|
466
|
+
* id for the new control, generated automatically if no id is given
|
|
467
|
+
*/
|
|
468
|
+
sId?: string,
|
|
469
|
+
/**
|
|
470
|
+
* initial settings for the new control
|
|
471
|
+
*/
|
|
472
|
+
mSettings?: $MatrixLayoutSettings
|
|
473
|
+
);
|
|
474
|
+
|
|
475
|
+
/**
|
|
476
|
+
* Creates a new subclass of class sap.zen.commons.layout.MatrixLayout with name `sClassName` and enriches
|
|
477
|
+
* it with the information contained in `oClassInfo`.
|
|
478
|
+
*
|
|
479
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
480
|
+
*
|
|
481
|
+
* @returns Created class / constructor function
|
|
482
|
+
*/
|
|
483
|
+
static extend<T extends Record<string, unknown>>(
|
|
484
|
+
/**
|
|
485
|
+
* Name of the class being created
|
|
486
|
+
*/
|
|
487
|
+
sClassName: string,
|
|
488
|
+
/**
|
|
489
|
+
* Object literal with information about the class
|
|
490
|
+
*/
|
|
491
|
+
oClassInfo?: sap.ClassInfo<T, MatrixLayout>,
|
|
492
|
+
/**
|
|
493
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
494
|
+
* used by this class
|
|
495
|
+
*/
|
|
496
|
+
FNMetaImpl?: Function
|
|
497
|
+
): Function;
|
|
498
|
+
/**
|
|
499
|
+
* Returns a metadata object for class sap.zen.commons.layout.MatrixLayout.
|
|
500
|
+
*
|
|
501
|
+
* @returns Metadata object describing this class
|
|
502
|
+
*/
|
|
503
|
+
static getMetadata(): ElementMetadata;
|
|
504
|
+
/**
|
|
505
|
+
* Adds some row to the aggregation {@link #getRows rows}.
|
|
506
|
+
*
|
|
507
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
508
|
+
*/
|
|
509
|
+
addRow(
|
|
510
|
+
/**
|
|
511
|
+
* The row to add; if empty, nothing is inserted
|
|
512
|
+
*/
|
|
513
|
+
oRow: MatrixLayoutRow
|
|
514
|
+
): this;
|
|
515
|
+
/**
|
|
516
|
+
* Creates a new matrix layout row and appends it to this matrix layout.
|
|
517
|
+
*
|
|
518
|
+
* Each argument must be either a matrix layout cell, which is added to the row "as is", or an arbitrary
|
|
519
|
+
* content control, which is wrapped with a new (default) matrix layout cell first and then added to the
|
|
520
|
+
* row.
|
|
521
|
+
*
|
|
522
|
+
* @returns `this` to allow method chaining
|
|
523
|
+
*/
|
|
524
|
+
createRow(
|
|
525
|
+
/**
|
|
526
|
+
* to add
|
|
527
|
+
*/
|
|
528
|
+
rowContent: Control | MatrixLayoutCell | string
|
|
529
|
+
): MatrixLayout;
|
|
530
|
+
/**
|
|
531
|
+
* Destroys all the rows in the aggregation {@link #getRows rows}.
|
|
532
|
+
*
|
|
533
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
534
|
+
*/
|
|
535
|
+
destroyRows(): this;
|
|
536
|
+
/**
|
|
537
|
+
* Gets current value of property {@link #getColumns columns}.
|
|
538
|
+
*
|
|
539
|
+
* Number of columns. If not specified, the number of columns will be determined from the given cells.
|
|
540
|
+
*
|
|
541
|
+
* @returns Value of property `columns`
|
|
542
|
+
*/
|
|
543
|
+
getColumns(): int;
|
|
544
|
+
/**
|
|
545
|
+
* Gets current value of property {@link #getHeight height}.
|
|
546
|
+
*
|
|
547
|
+
* CSS height of the matrix layout.
|
|
548
|
+
*
|
|
549
|
+
* @returns Value of property `height`
|
|
550
|
+
*/
|
|
551
|
+
getHeight(): CSSSize;
|
|
552
|
+
/**
|
|
553
|
+
* Gets current value of property {@link #getLayoutFixed layoutFixed}.
|
|
554
|
+
*
|
|
555
|
+
* Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the
|
|
556
|
+
* content of the colums has priority. The default is "fixed". If the fixed layout is used a adequate width
|
|
557
|
+
* of the MatrixLayout should be provided. Otherwise the column width displayed could be different than
|
|
558
|
+
* the given ones because of browser dependend optimazations.
|
|
559
|
+
*
|
|
560
|
+
* Default value is `true`.
|
|
561
|
+
*
|
|
562
|
+
* @returns Value of property `layoutFixed`
|
|
563
|
+
*/
|
|
564
|
+
getLayoutFixed(): boolean;
|
|
565
|
+
/**
|
|
566
|
+
* Gets content of aggregation {@link #getRows rows}.
|
|
567
|
+
*
|
|
568
|
+
* The matrix layout's individual rows.
|
|
569
|
+
*/
|
|
570
|
+
getRows(): MatrixLayoutRow[];
|
|
571
|
+
/**
|
|
572
|
+
* Gets current value of property {@link #getWidth width}.
|
|
573
|
+
*
|
|
574
|
+
* CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided.
|
|
575
|
+
*
|
|
576
|
+
* @returns Value of property `width`
|
|
577
|
+
*/
|
|
578
|
+
getWidth(): CSSSize;
|
|
579
|
+
/**
|
|
580
|
+
* Gets current value of property {@link #getWidths widths}.
|
|
581
|
+
*
|
|
582
|
+
* Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical
|
|
583
|
+
* sizing enter "auto" for this column width.
|
|
584
|
+
*
|
|
585
|
+
* @returns Value of property `widths`
|
|
586
|
+
*/
|
|
587
|
+
getWidths(): CSSSize[];
|
|
588
|
+
/**
|
|
589
|
+
* Checks for the provided `sap.zen.commons.layout.MatrixLayoutRow` in the aggregation {@link #getRows rows}.
|
|
590
|
+
* and returns its index if found or -1 otherwise.
|
|
591
|
+
*
|
|
592
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
593
|
+
*/
|
|
594
|
+
indexOfRow(
|
|
595
|
+
/**
|
|
596
|
+
* The row whose index is looked for
|
|
597
|
+
*/
|
|
598
|
+
oRow: MatrixLayoutRow
|
|
599
|
+
): int;
|
|
600
|
+
/**
|
|
601
|
+
* Inserts a row into the aggregation {@link #getRows rows}.
|
|
602
|
+
*
|
|
603
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
604
|
+
*/
|
|
605
|
+
insertRow(
|
|
606
|
+
/**
|
|
607
|
+
* The row to insert; if empty, nothing is inserted
|
|
608
|
+
*/
|
|
609
|
+
oRow: MatrixLayoutRow,
|
|
610
|
+
/**
|
|
611
|
+
* The `0`-based index the row should be inserted at; for a negative value of `iIndex`, the row is inserted
|
|
612
|
+
* at position 0; for a value greater than the current size of the aggregation, the row is inserted at the
|
|
613
|
+
* last position
|
|
614
|
+
*/
|
|
615
|
+
iIndex: int
|
|
616
|
+
): this;
|
|
617
|
+
/**
|
|
618
|
+
* Removes all the controls from the aggregation {@link #getRows rows}.
|
|
619
|
+
*
|
|
620
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
621
|
+
*
|
|
622
|
+
* @returns An array of the removed elements (might be empty)
|
|
623
|
+
*/
|
|
624
|
+
removeAllRows(): MatrixLayoutRow[];
|
|
625
|
+
/**
|
|
626
|
+
* Removes a row from the aggregation {@link #getRows rows}.
|
|
627
|
+
*
|
|
628
|
+
* @returns The removed row or `null`
|
|
629
|
+
*/
|
|
630
|
+
removeRow(
|
|
631
|
+
/**
|
|
632
|
+
* The row to remove or its index or id
|
|
633
|
+
*/
|
|
634
|
+
vRow: int | string | MatrixLayoutRow
|
|
635
|
+
): MatrixLayoutRow | null;
|
|
636
|
+
/**
|
|
637
|
+
* Sets a new value for property {@link #getColumns columns}.
|
|
638
|
+
*
|
|
639
|
+
* Number of columns. If not specified, the number of columns will be determined from the given cells.
|
|
640
|
+
*
|
|
641
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
642
|
+
*
|
|
643
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
644
|
+
*/
|
|
645
|
+
setColumns(
|
|
646
|
+
/**
|
|
647
|
+
* New value for property `columns`
|
|
648
|
+
*/
|
|
649
|
+
iColumns?: int
|
|
650
|
+
): this;
|
|
651
|
+
/**
|
|
652
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
653
|
+
*
|
|
654
|
+
* CSS height of the matrix layout.
|
|
655
|
+
*
|
|
656
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
657
|
+
*
|
|
658
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
659
|
+
*/
|
|
660
|
+
setHeight(
|
|
661
|
+
/**
|
|
662
|
+
* New value for property `height`
|
|
663
|
+
*/
|
|
664
|
+
sHeight?: CSSSize
|
|
665
|
+
): this;
|
|
666
|
+
/**
|
|
667
|
+
* Sets a new value for property {@link #getLayoutFixed layoutFixed}.
|
|
668
|
+
*
|
|
669
|
+
* Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the
|
|
670
|
+
* content of the colums has priority. The default is "fixed". If the fixed layout is used a adequate width
|
|
671
|
+
* of the MatrixLayout should be provided. Otherwise the column width displayed could be different than
|
|
672
|
+
* the given ones because of browser dependend optimazations.
|
|
673
|
+
*
|
|
674
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
675
|
+
*
|
|
676
|
+
* Default value is `true`.
|
|
677
|
+
*
|
|
678
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
679
|
+
*/
|
|
680
|
+
setLayoutFixed(
|
|
681
|
+
/**
|
|
682
|
+
* New value for property `layoutFixed`
|
|
683
|
+
*/
|
|
684
|
+
bLayoutFixed?: boolean
|
|
685
|
+
): this;
|
|
686
|
+
/**
|
|
687
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
688
|
+
*
|
|
689
|
+
* CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided.
|
|
690
|
+
*
|
|
691
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
692
|
+
*
|
|
693
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
694
|
+
*/
|
|
695
|
+
setWidth(
|
|
696
|
+
/**
|
|
697
|
+
* New value for property `width`
|
|
698
|
+
*/
|
|
699
|
+
sWidth?: CSSSize
|
|
700
|
+
): this;
|
|
701
|
+
/**
|
|
702
|
+
* Sets a new value for property {@link #getWidths widths}.
|
|
703
|
+
*
|
|
704
|
+
* Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical
|
|
705
|
+
* sizing enter "auto" for this column width.
|
|
706
|
+
*
|
|
707
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
708
|
+
*
|
|
709
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
710
|
+
*/
|
|
711
|
+
setWidths(
|
|
712
|
+
/**
|
|
713
|
+
* New value for property `widths`
|
|
714
|
+
*/
|
|
715
|
+
sWidths?: CSSSize[]
|
|
716
|
+
): this;
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
export interface $MatrixLayoutSettings extends $ControlSettings {
|
|
720
|
+
/**
|
|
721
|
+
* CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided.
|
|
722
|
+
*/
|
|
723
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
724
|
+
|
|
725
|
+
/**
|
|
726
|
+
* CSS height of the matrix layout.
|
|
727
|
+
*/
|
|
728
|
+
height?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
729
|
+
|
|
730
|
+
/**
|
|
731
|
+
* Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the
|
|
732
|
+
* content of the colums has priority. The default is "fixed". If the fixed layout is used a adequate width
|
|
733
|
+
* of the MatrixLayout should be provided. Otherwise the column width displayed could be different than
|
|
734
|
+
* the given ones because of browser dependend optimazations.
|
|
735
|
+
*/
|
|
736
|
+
layoutFixed?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
737
|
+
|
|
738
|
+
/**
|
|
739
|
+
* Number of columns. If not specified, the number of columns will be determined from the given cells.
|
|
740
|
+
*/
|
|
741
|
+
columns?: int | PropertyBindingInfo | `{${string}}`;
|
|
742
|
+
|
|
743
|
+
/**
|
|
744
|
+
* Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical
|
|
745
|
+
* sizing enter "auto" for this column width.
|
|
746
|
+
*/
|
|
747
|
+
widths?: CSSSize[] | PropertyBindingInfo | `{${string}}`;
|
|
748
|
+
|
|
749
|
+
/**
|
|
750
|
+
* The matrix layout's individual rows.
|
|
751
|
+
*/
|
|
752
|
+
rows?:
|
|
753
|
+
| MatrixLayoutRow[]
|
|
754
|
+
| MatrixLayoutRow
|
|
755
|
+
| AggregationBindingInfo
|
|
756
|
+
| `{${string}}`;
|
|
757
|
+
}
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
declare module "sap/zen/commons/layout/MatrixLayoutCell" {
|
|
761
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
762
|
+
|
|
763
|
+
/**
|
|
764
|
+
* @deprecated (since 1.38) - Instead, use the `sap.ui.layout.Grid` control.
|
|
765
|
+
*
|
|
766
|
+
* Non-control element used as part of a matrix layout's inner structure.
|
|
767
|
+
*/
|
|
768
|
+
export default class MatrixLayoutCell extends UI5Element {
|
|
769
|
+
/**
|
|
770
|
+
* Constructor for a new layout/MatrixLayoutCell.
|
|
771
|
+
*
|
|
772
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
773
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
774
|
+
* of the syntax of the settings object.
|
|
775
|
+
*/
|
|
776
|
+
constructor(
|
|
777
|
+
/**
|
|
778
|
+
* initial settings for the new control
|
|
779
|
+
*/
|
|
780
|
+
mSettings?: $MatrixLayoutCellSettings
|
|
781
|
+
);
|
|
782
|
+
/**
|
|
783
|
+
* Constructor for a new layout/MatrixLayoutCell.
|
|
784
|
+
*
|
|
785
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
786
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
787
|
+
* of the syntax of the settings object.
|
|
788
|
+
*/
|
|
789
|
+
constructor(
|
|
790
|
+
/**
|
|
791
|
+
* id for the new control, generated automatically if no id is given
|
|
792
|
+
*/
|
|
793
|
+
sId?: string,
|
|
794
|
+
/**
|
|
795
|
+
* initial settings for the new control
|
|
796
|
+
*/
|
|
797
|
+
mSettings?: $MatrixLayoutCellSettings
|
|
798
|
+
);
|
|
799
|
+
|
|
800
|
+
/**
|
|
801
|
+
* The string given as "sStyleClass" will be added to the "class" attribute of this element's root HTML
|
|
802
|
+
* element.
|
|
803
|
+
*
|
|
804
|
+
* This method is intended to be used to mark controls as being of a special type for which special styling
|
|
805
|
+
* can be provided using CSS selectors that reference this style class name.
|
|
806
|
+
*
|
|
807
|
+
*
|
|
808
|
+
* ```javascript
|
|
809
|
+
*
|
|
810
|
+
* Example:
|
|
811
|
+
* myButton.addStyleClass("myRedTextButton"); // add a CSS class to one button instance
|
|
812
|
+
*
|
|
813
|
+
* ...and in CSS:
|
|
814
|
+
* .myRedTextButton {
|
|
815
|
+
* color: red;
|
|
816
|
+
* }
|
|
817
|
+
* ```
|
|
818
|
+
*
|
|
819
|
+
*
|
|
820
|
+
* This will add the CSS class "myRedTextButton" to the Button HTML and the CSS code above will then make
|
|
821
|
+
* the text in this particular button red.
|
|
822
|
+
*
|
|
823
|
+
* Only characters allowed inside HTML attributes are allowed. Quotes are not allowed and this method will
|
|
824
|
+
* ignore any strings containing quotes. Strings containing spaces are interpreted as ONE custom style class
|
|
825
|
+
* (even though CSS selectors interpret them as different classes) and can only removed later by calling
|
|
826
|
+
* removeStyleClass() with exactly the same (space-containing) string as parameter. Multiple calls with
|
|
827
|
+
* the same sStyleClass will have no different effect than calling once. If sStyleClass is null, the call
|
|
828
|
+
* is ignored.
|
|
829
|
+
*
|
|
830
|
+
* Returns `this` to allow method chaining
|
|
831
|
+
*/
|
|
832
|
+
addStyleClass(
|
|
833
|
+
/**
|
|
834
|
+
* the CSS class name to be added
|
|
835
|
+
*/
|
|
836
|
+
sStyleClass: string
|
|
837
|
+
): MatrixLayoutCell;
|
|
838
|
+
/**
|
|
839
|
+
* Returns true if the given style class string is valid and if this Element has this style class set via
|
|
840
|
+
* a previous call to addStyleClass().
|
|
841
|
+
*/
|
|
842
|
+
hasStyleClass(
|
|
843
|
+
/**
|
|
844
|
+
* the style to check for
|
|
845
|
+
*/
|
|
846
|
+
sStyleClass: string
|
|
847
|
+
): boolean;
|
|
848
|
+
/**
|
|
849
|
+
* Removes the given string from the list of custom style classes that have been set previously. Regular
|
|
850
|
+
* style classes like "sapUiBtn" cannot be removed.
|
|
851
|
+
*
|
|
852
|
+
* Returns `this` to allow method chaining
|
|
853
|
+
*/
|
|
854
|
+
removeStyleClass(
|
|
855
|
+
/**
|
|
856
|
+
* the style to be removed
|
|
857
|
+
*/
|
|
858
|
+
sStyleClass: string
|
|
859
|
+
): MatrixLayoutCell;
|
|
860
|
+
}
|
|
861
|
+
|
|
862
|
+
export interface $MatrixLayoutCellSettings extends $ElementSettings {}
|
|
863
|
+
}
|
|
864
|
+
|
|
865
|
+
declare module "sap/zen/commons/layout/MatrixLayoutRow" {
|
|
866
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
867
|
+
|
|
868
|
+
import MatrixLayoutCell from "sap/zen/commons/layout/MatrixLayoutCell";
|
|
869
|
+
|
|
870
|
+
import { CSSSize } from "sap/ui/core/library";
|
|
871
|
+
|
|
872
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
873
|
+
|
|
874
|
+
import {
|
|
875
|
+
PropertyBindingInfo,
|
|
876
|
+
AggregationBindingInfo,
|
|
877
|
+
} from "sap/ui/base/ManagedObject";
|
|
878
|
+
|
|
879
|
+
/**
|
|
880
|
+
* @deprecated (since 1.89.0)
|
|
881
|
+
*
|
|
882
|
+
* Non-control element used as part of a matrix layout's inner structure.
|
|
883
|
+
*/
|
|
884
|
+
export default class MatrixLayoutRow extends UI5Element {
|
|
885
|
+
/**
|
|
886
|
+
* Constructor for a new layout/MatrixLayoutRow.
|
|
887
|
+
*
|
|
888
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
889
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
890
|
+
* of the syntax of the settings object.
|
|
891
|
+
*/
|
|
892
|
+
constructor(
|
|
893
|
+
/**
|
|
894
|
+
* initial settings for the new control
|
|
895
|
+
*/
|
|
896
|
+
mSettings?: $MatrixLayoutRowSettings
|
|
897
|
+
);
|
|
898
|
+
/**
|
|
899
|
+
* Constructor for a new layout/MatrixLayoutRow.
|
|
900
|
+
*
|
|
901
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
902
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
903
|
+
* of the syntax of the settings object.
|
|
904
|
+
*/
|
|
905
|
+
constructor(
|
|
906
|
+
/**
|
|
907
|
+
* id for the new control, generated automatically if no id is given
|
|
908
|
+
*/
|
|
909
|
+
sId?: string,
|
|
910
|
+
/**
|
|
911
|
+
* initial settings for the new control
|
|
912
|
+
*/
|
|
913
|
+
mSettings?: $MatrixLayoutRowSettings
|
|
914
|
+
);
|
|
915
|
+
|
|
916
|
+
/**
|
|
917
|
+
* Creates a new subclass of class sap.zen.commons.layout.MatrixLayoutRow with name `sClassName` and enriches
|
|
918
|
+
* it with the information contained in `oClassInfo`.
|
|
919
|
+
*
|
|
920
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
921
|
+
*
|
|
922
|
+
* @returns Created class / constructor function
|
|
923
|
+
*/
|
|
924
|
+
static extend<T extends Record<string, unknown>>(
|
|
925
|
+
/**
|
|
926
|
+
* Name of the class being created
|
|
927
|
+
*/
|
|
928
|
+
sClassName: string,
|
|
929
|
+
/**
|
|
930
|
+
* Object literal with information about the class
|
|
931
|
+
*/
|
|
932
|
+
oClassInfo?: sap.ClassInfo<T, MatrixLayoutRow>,
|
|
933
|
+
/**
|
|
934
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
935
|
+
* used by this class
|
|
936
|
+
*/
|
|
937
|
+
FNMetaImpl?: Function
|
|
938
|
+
): Function;
|
|
939
|
+
/**
|
|
940
|
+
* Returns a metadata object for class sap.zen.commons.layout.MatrixLayoutRow.
|
|
941
|
+
*
|
|
942
|
+
* @returns Metadata object describing this class
|
|
943
|
+
*/
|
|
944
|
+
static getMetadata(): ElementMetadata;
|
|
945
|
+
/**
|
|
946
|
+
* Adds some cell to the aggregation {@link #getCells cells}.
|
|
947
|
+
*
|
|
948
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
949
|
+
*/
|
|
950
|
+
addCell(
|
|
951
|
+
/**
|
|
952
|
+
* The cell to add; if empty, nothing is inserted
|
|
953
|
+
*/
|
|
954
|
+
oCell: MatrixLayoutCell
|
|
955
|
+
): this;
|
|
956
|
+
/**
|
|
957
|
+
* The string given as "sStyleClass" will be added to the "class" attribute of this element's root HTML
|
|
958
|
+
* element.
|
|
959
|
+
*
|
|
960
|
+
* This method is intended to be used to mark controls as being of a special type for which special styling
|
|
961
|
+
* can be provided using CSS selectors that reference this style class name.
|
|
962
|
+
*
|
|
963
|
+
*
|
|
964
|
+
* ```javascript
|
|
965
|
+
*
|
|
966
|
+
* Example:
|
|
967
|
+
* myButton.addStyleClass("myRedTextButton"); // add a CSS class to one button instance
|
|
968
|
+
*
|
|
969
|
+
* ...and in CSS:
|
|
970
|
+
* .myRedTextButton {
|
|
971
|
+
* color: red;
|
|
972
|
+
* }
|
|
973
|
+
* ```
|
|
974
|
+
*
|
|
975
|
+
*
|
|
976
|
+
* This will add the CSS class "myRedTextButton" to the Button HTML and the CSS code above will then make
|
|
977
|
+
* the text in this particular button red.
|
|
978
|
+
*
|
|
979
|
+
* Only characters allowed inside HTML attributes are allowed. Quotes are not allowed and this method will
|
|
980
|
+
* ignore any strings containing quotes. Strings containing spaces are interpreted as ONE custom style class
|
|
981
|
+
* (even though CSS selectors interpret them as different classes) and can only removed later by calling
|
|
982
|
+
* removeStyleClass() with exactly the same (space-containing) string as parameter. Multiple calls with
|
|
983
|
+
* the same sStyleClass will have no different effect than calling once. If sStyleClass is null, the call
|
|
984
|
+
* is ignored.
|
|
985
|
+
*
|
|
986
|
+
* Returns `this` to allow method chaining
|
|
987
|
+
*/
|
|
988
|
+
addStyleClass(
|
|
989
|
+
/**
|
|
990
|
+
* the CSS class name to be added
|
|
991
|
+
*/
|
|
992
|
+
sStyleClass: string
|
|
993
|
+
): MatrixLayoutRow;
|
|
994
|
+
/**
|
|
995
|
+
* Destroys all the cells in the aggregation {@link #getCells cells}.
|
|
996
|
+
*
|
|
997
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
998
|
+
*/
|
|
999
|
+
destroyCells(): this;
|
|
1000
|
+
/**
|
|
1001
|
+
* Gets content of aggregation {@link #getCells cells}.
|
|
1002
|
+
*
|
|
1003
|
+
* The matrix layout row's individual cells.
|
|
1004
|
+
*/
|
|
1005
|
+
getCells(): MatrixLayoutCell[];
|
|
1006
|
+
/**
|
|
1007
|
+
* Gets current value of property {@link #getHeight height}.
|
|
1008
|
+
*
|
|
1009
|
+
* Height of the row.
|
|
1010
|
+
*
|
|
1011
|
+
* @returns Value of property `height`
|
|
1012
|
+
*/
|
|
1013
|
+
getHeight(): CSSSize;
|
|
1014
|
+
/**
|
|
1015
|
+
* Returns true if the given style class string is valid and if this Element has this style class set via
|
|
1016
|
+
* a previous call to addStyleClass().
|
|
1017
|
+
*/
|
|
1018
|
+
hasStyleClass(
|
|
1019
|
+
/**
|
|
1020
|
+
* the style to check for
|
|
1021
|
+
*/
|
|
1022
|
+
sStyleClass: string
|
|
1023
|
+
): boolean;
|
|
1024
|
+
/**
|
|
1025
|
+
* Checks for the provided `sap.zen.commons.layout.MatrixLayoutCell` in the aggregation {@link #getCells
|
|
1026
|
+
* cells}. and returns its index if found or -1 otherwise.
|
|
1027
|
+
*
|
|
1028
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1029
|
+
*/
|
|
1030
|
+
indexOfCell(
|
|
1031
|
+
/**
|
|
1032
|
+
* The cell whose index is looked for
|
|
1033
|
+
*/
|
|
1034
|
+
oCell: MatrixLayoutCell
|
|
1035
|
+
): int;
|
|
1036
|
+
/**
|
|
1037
|
+
* Inserts a cell into the aggregation {@link #getCells cells}.
|
|
1038
|
+
*
|
|
1039
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1040
|
+
*/
|
|
1041
|
+
insertCell(
|
|
1042
|
+
/**
|
|
1043
|
+
* The cell to insert; if empty, nothing is inserted
|
|
1044
|
+
*/
|
|
1045
|
+
oCell: MatrixLayoutCell,
|
|
1046
|
+
/**
|
|
1047
|
+
* The `0`-based index the cell should be inserted at; for a negative value of `iIndex`, the cell is inserted
|
|
1048
|
+
* at position 0; for a value greater than the current size of the aggregation, the cell is inserted at
|
|
1049
|
+
* the last position
|
|
1050
|
+
*/
|
|
1051
|
+
iIndex: int
|
|
1052
|
+
): this;
|
|
1053
|
+
/**
|
|
1054
|
+
* Removes all the controls from the aggregation {@link #getCells cells}.
|
|
1055
|
+
*
|
|
1056
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
1057
|
+
*
|
|
1058
|
+
* @returns An array of the removed elements (might be empty)
|
|
1059
|
+
*/
|
|
1060
|
+
removeAllCells(): MatrixLayoutCell[];
|
|
1061
|
+
/**
|
|
1062
|
+
* Removes a cell from the aggregation {@link #getCells cells}.
|
|
1063
|
+
*
|
|
1064
|
+
* @returns The removed cell or `null`
|
|
1065
|
+
*/
|
|
1066
|
+
removeCell(
|
|
1067
|
+
/**
|
|
1068
|
+
* The cell to remove or its index or id
|
|
1069
|
+
*/
|
|
1070
|
+
vCell: int | string | MatrixLayoutCell
|
|
1071
|
+
): MatrixLayoutCell | null;
|
|
1072
|
+
/**
|
|
1073
|
+
* Removes the given string from the list of custom style classes that have been set previously. Regular
|
|
1074
|
+
* style classes like "sapUiBtn" cannot be removed.
|
|
1075
|
+
*
|
|
1076
|
+
* Returns `this` to allow method chaining
|
|
1077
|
+
*/
|
|
1078
|
+
removeStyleClass(
|
|
1079
|
+
/**
|
|
1080
|
+
* the style to be removed
|
|
1081
|
+
*/
|
|
1082
|
+
sStyleClass: string
|
|
1083
|
+
): MatrixLayoutRow;
|
|
1084
|
+
/**
|
|
1085
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
1086
|
+
*
|
|
1087
|
+
* Height of the row.
|
|
1088
|
+
*
|
|
1089
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1090
|
+
*
|
|
1091
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1092
|
+
*/
|
|
1093
|
+
setHeight(
|
|
1094
|
+
/**
|
|
1095
|
+
* New value for property `height`
|
|
1096
|
+
*/
|
|
1097
|
+
sHeight?: CSSSize
|
|
1098
|
+
): this;
|
|
1099
|
+
}
|
|
1100
|
+
|
|
1101
|
+
export interface $MatrixLayoutRowSettings extends $ElementSettings {
|
|
1102
|
+
/**
|
|
1103
|
+
* Height of the row.
|
|
1104
|
+
*/
|
|
1105
|
+
height?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
1106
|
+
|
|
1107
|
+
/**
|
|
1108
|
+
* The matrix layout row's individual cells.
|
|
1109
|
+
*/
|
|
1110
|
+
cells?:
|
|
1111
|
+
| MatrixLayoutCell[]
|
|
1112
|
+
| MatrixLayoutCell
|
|
1113
|
+
| AggregationBindingInfo
|
|
1114
|
+
| `{${string}}`;
|
|
1115
|
+
}
|
|
1116
|
+
}
|
|
1117
|
+
|
|
1118
|
+
declare module "sap/zen/commons/layout/PositionContainer" {
|
|
1119
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
1120
|
+
|
|
1121
|
+
import { CSSSize } from "sap/ui/core/library";
|
|
1122
|
+
|
|
1123
|
+
import Control from "sap/ui/core/Control";
|
|
1124
|
+
|
|
1125
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1126
|
+
|
|
1127
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1128
|
+
|
|
1129
|
+
/**
|
|
1130
|
+
* @deprecated (since 1.89)
|
|
1131
|
+
*
|
|
1132
|
+
* Is used to specify the position of a control in the AbsoluteLayout
|
|
1133
|
+
*/
|
|
1134
|
+
export default class PositionContainer extends UI5Element {
|
|
1135
|
+
/**
|
|
1136
|
+
* Constructor for a new layout/PositionContainer.
|
|
1137
|
+
*
|
|
1138
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1139
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1140
|
+
* of the syntax of the settings object.
|
|
1141
|
+
*/
|
|
1142
|
+
constructor(
|
|
1143
|
+
/**
|
|
1144
|
+
* initial settings for the new control
|
|
1145
|
+
*/
|
|
1146
|
+
mSettings?: $PositionContainerSettings
|
|
1147
|
+
);
|
|
1148
|
+
/**
|
|
1149
|
+
* Constructor for a new layout/PositionContainer.
|
|
1150
|
+
*
|
|
1151
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1152
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1153
|
+
* of the syntax of the settings object.
|
|
1154
|
+
*/
|
|
1155
|
+
constructor(
|
|
1156
|
+
/**
|
|
1157
|
+
* id for the new control, generated automatically if no id is given
|
|
1158
|
+
*/
|
|
1159
|
+
sId?: string,
|
|
1160
|
+
/**
|
|
1161
|
+
* initial settings for the new control
|
|
1162
|
+
*/
|
|
1163
|
+
mSettings?: $PositionContainerSettings
|
|
1164
|
+
);
|
|
1165
|
+
|
|
1166
|
+
/**
|
|
1167
|
+
* Creates a new subclass of class sap.zen.commons.layout.PositionContainer with name `sClassName` and enriches
|
|
1168
|
+
* it with the information contained in `oClassInfo`.
|
|
1169
|
+
*
|
|
1170
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
1171
|
+
*
|
|
1172
|
+
* @returns Created class / constructor function
|
|
1173
|
+
*/
|
|
1174
|
+
static extend<T extends Record<string, unknown>>(
|
|
1175
|
+
/**
|
|
1176
|
+
* Name of the class being created
|
|
1177
|
+
*/
|
|
1178
|
+
sClassName: string,
|
|
1179
|
+
/**
|
|
1180
|
+
* Object literal with information about the class
|
|
1181
|
+
*/
|
|
1182
|
+
oClassInfo?: sap.ClassInfo<T, PositionContainer>,
|
|
1183
|
+
/**
|
|
1184
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1185
|
+
* used by this class
|
|
1186
|
+
*/
|
|
1187
|
+
FNMetaImpl?: Function
|
|
1188
|
+
): Function;
|
|
1189
|
+
/**
|
|
1190
|
+
* Returns a metadata object for class sap.zen.commons.layout.PositionContainer.
|
|
1191
|
+
*
|
|
1192
|
+
* @returns Metadata object describing this class
|
|
1193
|
+
*/
|
|
1194
|
+
static getMetadata(): ElementMetadata;
|
|
1195
|
+
/**
|
|
1196
|
+
* Destroys the control in the aggregation {@link #getControl control}.
|
|
1197
|
+
*
|
|
1198
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1199
|
+
*/
|
|
1200
|
+
destroyControl(): this;
|
|
1201
|
+
/**
|
|
1202
|
+
* Gets current value of property {@link #getBottom bottom}.
|
|
1203
|
+
*
|
|
1204
|
+
* Defines the distance to the bottom of the layout (as specified in HTML)
|
|
1205
|
+
*
|
|
1206
|
+
* @returns Value of property `bottom`
|
|
1207
|
+
*/
|
|
1208
|
+
getBottom(): CSSSize;
|
|
1209
|
+
/**
|
|
1210
|
+
* Gets current value of property {@link #getCenterHorizontally centerHorizontally}.
|
|
1211
|
+
*
|
|
1212
|
+
* Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values
|
|
1213
|
+
* of the attributes left and right are ignored when this feature is activated.
|
|
1214
|
+
*
|
|
1215
|
+
* Default value is `false`.
|
|
1216
|
+
*
|
|
1217
|
+
* @returns Value of property `centerHorizontally`
|
|
1218
|
+
*/
|
|
1219
|
+
getCenterHorizontally(): boolean;
|
|
1220
|
+
/**
|
|
1221
|
+
* Gets current value of property {@link #getCenterVertically centerVertically}.
|
|
1222
|
+
*
|
|
1223
|
+
* Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values
|
|
1224
|
+
* of the attributes top and bottom are ignored when this feature is activated.
|
|
1225
|
+
*
|
|
1226
|
+
* Default value is `false`.
|
|
1227
|
+
*
|
|
1228
|
+
* @returns Value of property `centerVertically`
|
|
1229
|
+
*/
|
|
1230
|
+
getCenterVertically(): boolean;
|
|
1231
|
+
/**
|
|
1232
|
+
* Gets content of aggregation {@link #getControl control}.
|
|
1233
|
+
*
|
|
1234
|
+
* Child control of the position container
|
|
1235
|
+
*/
|
|
1236
|
+
getControl(): Control;
|
|
1237
|
+
/**
|
|
1238
|
+
* Gets current value of property {@link #getLeft left}.
|
|
1239
|
+
*
|
|
1240
|
+
* Defines the distance to the left of the layout (as specified in HTML)
|
|
1241
|
+
*
|
|
1242
|
+
* @returns Value of property `left`
|
|
1243
|
+
*/
|
|
1244
|
+
getLeft(): CSSSize;
|
|
1245
|
+
/**
|
|
1246
|
+
* Gets current value of property {@link #getRight right}.
|
|
1247
|
+
*
|
|
1248
|
+
* Defines the distance to the right of the layout (as specified in HTML)
|
|
1249
|
+
*
|
|
1250
|
+
* @returns Value of property `right`
|
|
1251
|
+
*/
|
|
1252
|
+
getRight(): CSSSize;
|
|
1253
|
+
/**
|
|
1254
|
+
* Gets current value of property {@link #getTop top}.
|
|
1255
|
+
*
|
|
1256
|
+
* Defines the distance to the top of the layout (as specified in HTML)
|
|
1257
|
+
*
|
|
1258
|
+
* @returns Value of property `top`
|
|
1259
|
+
*/
|
|
1260
|
+
getTop(): CSSSize;
|
|
1261
|
+
/**
|
|
1262
|
+
* Sets a new value for property {@link #getBottom bottom}.
|
|
1263
|
+
*
|
|
1264
|
+
* Defines the distance to the bottom of the layout (as specified in HTML)
|
|
1265
|
+
*
|
|
1266
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1267
|
+
*
|
|
1268
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1269
|
+
*/
|
|
1270
|
+
setBottom(
|
|
1271
|
+
/**
|
|
1272
|
+
* New value for property `bottom`
|
|
1273
|
+
*/
|
|
1274
|
+
sBottom?: CSSSize
|
|
1275
|
+
): this;
|
|
1276
|
+
/**
|
|
1277
|
+
* Sets a new value for property {@link #getCenterHorizontally centerHorizontally}.
|
|
1278
|
+
*
|
|
1279
|
+
* Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values
|
|
1280
|
+
* of the attributes left and right are ignored when this feature is activated.
|
|
1281
|
+
*
|
|
1282
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1283
|
+
*
|
|
1284
|
+
* Default value is `false`.
|
|
1285
|
+
*
|
|
1286
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1287
|
+
*/
|
|
1288
|
+
setCenterHorizontally(
|
|
1289
|
+
/**
|
|
1290
|
+
* New value for property `centerHorizontally`
|
|
1291
|
+
*/
|
|
1292
|
+
bCenterHorizontally?: boolean
|
|
1293
|
+
): this;
|
|
1294
|
+
/**
|
|
1295
|
+
* Sets a new value for property {@link #getCenterVertically centerVertically}.
|
|
1296
|
+
*
|
|
1297
|
+
* Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values
|
|
1298
|
+
* of the attributes top and bottom are ignored when this feature is activated.
|
|
1299
|
+
*
|
|
1300
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1301
|
+
*
|
|
1302
|
+
* Default value is `false`.
|
|
1303
|
+
*
|
|
1304
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1305
|
+
*/
|
|
1306
|
+
setCenterVertically(
|
|
1307
|
+
/**
|
|
1308
|
+
* New value for property `centerVertically`
|
|
1309
|
+
*/
|
|
1310
|
+
bCenterVertically?: boolean
|
|
1311
|
+
): this;
|
|
1312
|
+
/**
|
|
1313
|
+
* Sets the aggregated {@link #getControl control}.
|
|
1314
|
+
*
|
|
1315
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1316
|
+
*/
|
|
1317
|
+
setControl(
|
|
1318
|
+
/**
|
|
1319
|
+
* The control to set
|
|
1320
|
+
*/
|
|
1321
|
+
oControl: Control
|
|
1322
|
+
): this;
|
|
1323
|
+
/**
|
|
1324
|
+
* Sets a new value for property {@link #getLeft left}.
|
|
1325
|
+
*
|
|
1326
|
+
* Defines the distance to the left of the layout (as specified in HTML)
|
|
1327
|
+
*
|
|
1328
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1329
|
+
*
|
|
1330
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1331
|
+
*/
|
|
1332
|
+
setLeft(
|
|
1333
|
+
/**
|
|
1334
|
+
* New value for property `left`
|
|
1335
|
+
*/
|
|
1336
|
+
sLeft?: CSSSize
|
|
1337
|
+
): this;
|
|
1338
|
+
/**
|
|
1339
|
+
* Sets a new value for property {@link #getRight right}.
|
|
1340
|
+
*
|
|
1341
|
+
* Defines the distance to the right of the layout (as specified in HTML)
|
|
1342
|
+
*
|
|
1343
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1344
|
+
*
|
|
1345
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1346
|
+
*/
|
|
1347
|
+
setRight(
|
|
1348
|
+
/**
|
|
1349
|
+
* New value for property `right`
|
|
1350
|
+
*/
|
|
1351
|
+
sRight?: CSSSize
|
|
1352
|
+
): this;
|
|
1353
|
+
/**
|
|
1354
|
+
* Sets a new value for property {@link #getTop top}.
|
|
1355
|
+
*
|
|
1356
|
+
* Defines the distance to the top of the layout (as specified in HTML)
|
|
1357
|
+
*
|
|
1358
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1359
|
+
*
|
|
1360
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1361
|
+
*/
|
|
1362
|
+
setTop(
|
|
1363
|
+
/**
|
|
1364
|
+
* New value for property `top`
|
|
1365
|
+
*/
|
|
1366
|
+
sTop?: CSSSize
|
|
1367
|
+
): this;
|
|
1368
|
+
/**
|
|
1369
|
+
* Updates the position properties of the container according to the given position in JSON style.
|
|
1370
|
+
*/
|
|
1371
|
+
updatePosition(
|
|
1372
|
+
/**
|
|
1373
|
+
* JSON-like object which defines the position of the child control in the absolute layout. The object is
|
|
1374
|
+
* expected to have one or more out of the attributes top, bottom, left, right (each with a value of type
|
|
1375
|
+
* sap.ui.core.CSSSize). If no object is given, nothing is updated.
|
|
1376
|
+
*/
|
|
1377
|
+
oPos: object
|
|
1378
|
+
): void;
|
|
1379
|
+
}
|
|
1380
|
+
|
|
1381
|
+
export interface $PositionContainerSettings extends $ElementSettings {
|
|
1382
|
+
/**
|
|
1383
|
+
* Defines the distance to the top of the layout (as specified in HTML)
|
|
1384
|
+
*/
|
|
1385
|
+
top?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
1386
|
+
|
|
1387
|
+
/**
|
|
1388
|
+
* Defines the distance to the bottom of the layout (as specified in HTML)
|
|
1389
|
+
*/
|
|
1390
|
+
bottom?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
1391
|
+
|
|
1392
|
+
/**
|
|
1393
|
+
* Defines the distance to the left of the layout (as specified in HTML)
|
|
1394
|
+
*/
|
|
1395
|
+
left?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
1396
|
+
|
|
1397
|
+
/**
|
|
1398
|
+
* Defines the distance to the right of the layout (as specified in HTML)
|
|
1399
|
+
*/
|
|
1400
|
+
right?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
1401
|
+
|
|
1402
|
+
/**
|
|
1403
|
+
* Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values
|
|
1404
|
+
* of the attributes left and right are ignored when this feature is activated.
|
|
1405
|
+
*/
|
|
1406
|
+
centerHorizontally?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1407
|
+
|
|
1408
|
+
/**
|
|
1409
|
+
* Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values
|
|
1410
|
+
* of the attributes top and bottom are ignored when this feature is activated.
|
|
1411
|
+
*/
|
|
1412
|
+
centerVertically?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1413
|
+
|
|
1414
|
+
/**
|
|
1415
|
+
* Child control of the position container
|
|
1416
|
+
*/
|
|
1417
|
+
control?: Control;
|
|
1418
|
+
}
|
|
1419
|
+
}
|
|
1420
|
+
|
|
1421
|
+
declare module "sap/zen/commons/Padding" {
|
|
1422
|
+
/**
|
|
1423
|
+
* @deprecated (since 1.89)
|
|
1424
|
+
* @EXPERIMENTAL
|
|
1425
|
+
*
|
|
1426
|
+
* Padding, e.g. of a layout cell's content within the cell's borders. Note that all options except "None"
|
|
1427
|
+
* include a padding of 2px at the top and bottom, and differ only in the presence of a 4px padding towards
|
|
1428
|
+
* the beginning or end of a line, in the current locale's writing direction.
|
|
1429
|
+
*/
|
|
1430
|
+
enum Padding {
|
|
1431
|
+
/**
|
|
1432
|
+
* Top and bottom padding of 2px. Padding of 4px towards the beginning of a line, in the current locale's
|
|
1433
|
+
* writing direction, but none towards its end.
|
|
1434
|
+
*/
|
|
1435
|
+
Begin = "Begin",
|
|
1436
|
+
/**
|
|
1437
|
+
* Top and bottom padding of 2px. Padding of 4px towards both the beginning and end of a line.
|
|
1438
|
+
*/
|
|
1439
|
+
Both = "Both",
|
|
1440
|
+
/**
|
|
1441
|
+
* Top and bottom padding of 2px. Padding of 4px towards the end of a line, in the current locale's writing
|
|
1442
|
+
* direction, but none towards its beginning.
|
|
1443
|
+
*/
|
|
1444
|
+
End = "End",
|
|
1445
|
+
/**
|
|
1446
|
+
* Top and bottom padding of 2px. No padding towards neither the beginning nor end of a line.
|
|
1447
|
+
*/
|
|
1448
|
+
Neither = "Neither",
|
|
1449
|
+
/**
|
|
1450
|
+
* No padding at all.
|
|
1451
|
+
*/
|
|
1452
|
+
None = "None",
|
|
1453
|
+
}
|
|
1454
|
+
export default Padding;
|
|
1455
|
+
}
|
|
1456
|
+
|
|
1457
|
+
declare module "sap/zen/commons/Separation" {
|
|
1458
|
+
/**
|
|
1459
|
+
* @deprecated (since 1.89.0)
|
|
1460
|
+
*
|
|
1461
|
+
* Separation, e.g. of a layout cell from its neighbor, via a vertical gutter of defined width, with or
|
|
1462
|
+
* without a vertical line in its middle.
|
|
1463
|
+
*/
|
|
1464
|
+
enum Separation {
|
|
1465
|
+
/**
|
|
1466
|
+
* A large (63px) vertical gutter without a vertical line.
|
|
1467
|
+
*/
|
|
1468
|
+
Large = "Large",
|
|
1469
|
+
/**
|
|
1470
|
+
* A large (63px) vertical gutter with a vertical line in its middle.
|
|
1471
|
+
*/
|
|
1472
|
+
LargeWithLine = "LargeWithLine",
|
|
1473
|
+
/**
|
|
1474
|
+
* A medium (31px) vertical gutter without a vertical line.
|
|
1475
|
+
*/
|
|
1476
|
+
Medium = "Medium",
|
|
1477
|
+
/**
|
|
1478
|
+
* A medium (31px) vertical gutter with a vertical line in its middle.
|
|
1479
|
+
*/
|
|
1480
|
+
MediumWithLine = "MediumWithLine",
|
|
1481
|
+
/**
|
|
1482
|
+
* No gutter at all (0px), and without a vertical line, of course.
|
|
1483
|
+
*/
|
|
1484
|
+
None = "None",
|
|
1485
|
+
/**
|
|
1486
|
+
* A small (17px) vertical gutter without a vertical line.
|
|
1487
|
+
*/
|
|
1488
|
+
Small = "Small",
|
|
1489
|
+
/**
|
|
1490
|
+
* A small (17px) vertical gutter with a vertical line in its middle.
|
|
1491
|
+
*/
|
|
1492
|
+
SmallWithLine = "SmallWithLine",
|
|
1493
|
+
}
|
|
1494
|
+
export default Separation;
|
|
1495
|
+
}
|
|
1496
|
+
|
|
1497
|
+
declare module "sap/zen/commons/VAlign" {
|
|
1498
|
+
/**
|
|
1499
|
+
* @deprecated (since 1.89.0)
|
|
1500
|
+
*
|
|
1501
|
+
* Vertical alignment, e.g. of a layout cell's content within the cell's borders.
|
|
1502
|
+
*/
|
|
1503
|
+
enum VAlign {
|
|
1504
|
+
/**
|
|
1505
|
+
* Aligned at the bottom.
|
|
1506
|
+
*/
|
|
1507
|
+
Bottom = "Bottom",
|
|
1508
|
+
/**
|
|
1509
|
+
* Vertically centered.
|
|
1510
|
+
*/
|
|
1511
|
+
Middle = "Middle",
|
|
1512
|
+
/**
|
|
1513
|
+
* Aligned at the top.
|
|
1514
|
+
*/
|
|
1515
|
+
Top = "Top",
|
|
1516
|
+
}
|
|
1517
|
+
export default VAlign;
|
|
1518
|
+
}
|
|
1519
|
+
|
|
1520
|
+
declare namespace sap {
|
|
1521
|
+
interface IUI5DefineDependencyNames {
|
|
1522
|
+
"sap/zen/commons/HAlign": undefined;
|
|
1523
|
+
|
|
1524
|
+
"sap/zen/commons/layout/AbsoluteLayout": undefined;
|
|
1525
|
+
|
|
1526
|
+
"sap/zen/commons/layout/MatrixLayout": undefined;
|
|
1527
|
+
|
|
1528
|
+
"sap/zen/commons/layout/MatrixLayoutCell": undefined;
|
|
1529
|
+
|
|
1530
|
+
"sap/zen/commons/layout/MatrixLayoutRow": undefined;
|
|
1531
|
+
|
|
1532
|
+
"sap/zen/commons/layout/PositionContainer": undefined;
|
|
1533
|
+
|
|
1534
|
+
"sap/zen/commons/library": undefined;
|
|
1535
|
+
|
|
1536
|
+
"sap/zen/commons/Padding": undefined;
|
|
1537
|
+
|
|
1538
|
+
"sap/zen/commons/Separation": undefined;
|
|
1539
|
+
|
|
1540
|
+
"sap/zen/commons/VAlign": undefined;
|
|
1541
|
+
}
|
|
1542
|
+
}
|