@sapui5/ts-types 1.141.2 → 1.142.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/package.json +1 -1
- package/types/index.d.ts +8 -7
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.cux.base.d.ts +3 -0
- package/types/sap.esh.search.ui.d.ts +152 -3
- package/types/sap.f.d.ts +1 -1
- package/types/sap.fe.ariba.d.ts +1 -1
- package/types/sap.fe.base.d.ts +1 -1
- package/types/sap.fe.controls.d.ts +1 -1
- package/types/sap.fe.core.d.ts +50 -32
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +2646 -125
- package/types/sap.fe.navigation.d.ts +2 -2
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +23 -11
- package/types/sap.fe.test.d.ts +8 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +4 -1
- package/types/sap.insights.d.ts +1 -1
- package/types/{mobile-1.141.0-d.ts → sap.m.d.ts} +401 -54
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +106 -2
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +13 -3587
- package/types/sap.suite.ui.commons.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +30 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/{tnt-1.141.0-d.ts → sap.tnt.d.ts} +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/{commons-1.141.0-d.ts → sap.ui.commons.d.ts} +1 -1
- package/types/sap.ui.comp.d.ts +78 -9
- package/types/{core-1.141.0-d.ts → sap.ui.core.d.ts} +712 -187
- package/types/{dt-1.141.0-d.ts → sap.ui.dt.d.ts} +1 -1
- package/types/sap.ui.export.d.ts +56 -1
- package/types/sap.ui.fl.d.ts +1 -1
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +1 -1
- package/types/sap.ui.layout.d.ts +100 -94
- package/types/{mdc-1.141.0-d.ts → sap.ui.mdc.d.ts} +1600 -260
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +13 -41
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +34 -78
- package/types/{ux3-1.141.0-d.ts → sap.ui.ux3.d.ts} +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +1 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +1 -1
- package/types/sap.ui.webc.main.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +13 -1
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +326 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.ui.export.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.142.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
@@ -192,6 +192,59 @@ declare namespace sap {
|
|
|
192
192
|
*/
|
|
193
193
|
interface Spreadsheet$BeforeSaveEventParameters {}
|
|
194
194
|
|
|
195
|
+
/**
|
|
196
|
+
* @since 1.142
|
|
197
|
+
*/
|
|
198
|
+
class CommaSeparatedValues extends sap.ui.export.ExportBase {
|
|
199
|
+
/**
|
|
200
|
+
* Provides functionality to export data in CSV format.
|
|
201
|
+
*
|
|
202
|
+
* The `CommaSeparatedValues` class extends the `ExportBase` class and provides the functionality to create
|
|
203
|
+
* CSV files. It supports appending data, validating data, escaping content, and building the final CSV
|
|
204
|
+
* file. Additionally, it provides methods to process data sources, apply default export settings, and manage
|
|
205
|
+
* the export process.
|
|
206
|
+
*
|
|
207
|
+
* There are the following key features:
|
|
208
|
+
* - Supports JSON arrays and ClientListBindings as data sources.
|
|
209
|
+
* - Escapes special characters and prevents CSV injection.
|
|
210
|
+
* - Adds a UTF-8 Byte Order Mark (BOM) for compatibility with spreadsheet software.
|
|
211
|
+
*
|
|
212
|
+
* Example Usage: ```javascript const oCSV = new sap.ui.export.CommaSeparatedValues(mSettings); oCSV.build(); ```
|
|
213
|
+
*/
|
|
214
|
+
constructor();
|
|
215
|
+
|
|
216
|
+
/**
|
|
217
|
+
* Creates a new subclass of class sap.ui.export.CommaSeparatedValues with name `sClassName` and enriches
|
|
218
|
+
* it with the information contained in `oClassInfo`.
|
|
219
|
+
*
|
|
220
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.export.ExportBase.extend}.
|
|
221
|
+
*
|
|
222
|
+
*
|
|
223
|
+
* @returns Created class / constructor function
|
|
224
|
+
*/
|
|
225
|
+
static extend<T extends Record<string, unknown>>(
|
|
226
|
+
/**
|
|
227
|
+
* Name of the class being created
|
|
228
|
+
*/
|
|
229
|
+
sClassName: string,
|
|
230
|
+
/**
|
|
231
|
+
* Object literal with information about the class
|
|
232
|
+
*/
|
|
233
|
+
oClassInfo?: sap.ClassInfo<T, sap.ui.export.CommaSeparatedValues>,
|
|
234
|
+
/**
|
|
235
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
236
|
+
* used by this class
|
|
237
|
+
*/
|
|
238
|
+
FNMetaImpl?: Function
|
|
239
|
+
): Function;
|
|
240
|
+
/**
|
|
241
|
+
* Returns a metadata object for class sap.ui.export.CommaSeparatedValues.
|
|
242
|
+
*
|
|
243
|
+
*
|
|
244
|
+
* @returns Metadata object describing this class
|
|
245
|
+
*/
|
|
246
|
+
static getMetadata(): sap.ui.base.Metadata;
|
|
247
|
+
}
|
|
195
248
|
/**
|
|
196
249
|
* The `sap.ui.export.ExportBase` class allows you to export table data from a UI5 application to certain
|
|
197
250
|
* formats. This class is an abstract class that requires specific implementations for each file format.
|
|
@@ -1111,6 +1164,8 @@ declare namespace sap {
|
|
|
1111
1164
|
}
|
|
1112
1165
|
|
|
1113
1166
|
interface IUI5DefineDependencyNames {
|
|
1167
|
+
"sap/ui/export/CommaSeparatedValues": undefined;
|
|
1168
|
+
|
|
1114
1169
|
"sap/ui/export/ExportBase": undefined;
|
|
1115
1170
|
|
|
1116
1171
|
"sap/ui/export/ExportHandler": undefined;
|
package/types/sap.ui.fl.d.ts
CHANGED
package/types/sap.ui.layout.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.142.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
@@ -165,7 +165,7 @@ declare namespace sap {
|
|
|
165
165
|
*
|
|
166
166
|
* The labels inside the form will be rendered by default in the according mode.
|
|
167
167
|
*
|
|
168
|
-
* **Note:** The setting of this property does not change the content of the form. For example,
|
|
168
|
+
* **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input }
|
|
169
169
|
* controls in a form with `editable` set to false are still editable.
|
|
170
170
|
*
|
|
171
171
|
* **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
|
|
@@ -193,7 +193,7 @@ declare namespace sap {
|
|
|
193
193
|
* Title of the `Form`. Can either be a `Title` element or a string. If a `Title` element it used, the style
|
|
194
194
|
* of the title can be set.
|
|
195
195
|
*
|
|
196
|
-
* **Note:** If a
|
|
196
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
197
197
|
*
|
|
198
198
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
199
199
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -208,9 +208,9 @@ declare namespace sap {
|
|
|
208
208
|
/**
|
|
209
209
|
* Toolbar of the `Form`.
|
|
210
210
|
*
|
|
211
|
-
* **Note:** If a `Toolbar` is used, the
|
|
212
|
-
* must be added at content to the `Toolbar`. In this case, add the `Title` to the
|
|
213
|
-
* Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
211
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
212
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
213
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
214
214
|
*
|
|
215
215
|
* @since 1.36.0
|
|
216
216
|
*/
|
|
@@ -226,7 +226,7 @@ declare namespace sap {
|
|
|
226
226
|
* Association to controls / IDs that label this control (see WAI-ARIA attribute `aria-labelledby`).
|
|
227
227
|
*
|
|
228
228
|
* **Note:** Every `Form` needs to have some title or label (at least for screen reader support). If no
|
|
229
|
-
*
|
|
229
|
+
* {@link #getTitle Title} is set, and the `Form` is not a child or a control with a title, such as {@link sap.m.Panel Panel }
|
|
230
230
|
* or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using the `ariaLabelledBy` association.
|
|
231
231
|
*
|
|
232
232
|
* @since 1.28.0
|
|
@@ -241,7 +241,7 @@ declare namespace sap {
|
|
|
241
241
|
/**
|
|
242
242
|
* Container is expanded.
|
|
243
243
|
*
|
|
244
|
-
* **Note:** This property only works if
|
|
244
|
+
* **Note:** This property only works if {@link #getExpandable expandable} is set to `true`.
|
|
245
245
|
*/
|
|
246
246
|
expanded?:
|
|
247
247
|
| boolean
|
|
@@ -251,7 +251,7 @@ declare namespace sap {
|
|
|
251
251
|
/**
|
|
252
252
|
* Defines if the `FormContainer` is expandable.
|
|
253
253
|
*
|
|
254
|
-
* **Note:** The expander icon will only be shown if a
|
|
254
|
+
* **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`.
|
|
255
255
|
*/
|
|
256
256
|
expandable?:
|
|
257
257
|
| boolean
|
|
@@ -279,7 +279,7 @@ declare namespace sap {
|
|
|
279
279
|
* Title of the `FormContainer`. Can either be a `Title` element or a string. If a `Title` element is used,
|
|
280
280
|
* the style of the title can be set.
|
|
281
281
|
*
|
|
282
|
-
* **Note:** If a
|
|
282
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
283
283
|
*
|
|
284
284
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
285
285
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -294,9 +294,9 @@ declare namespace sap {
|
|
|
294
294
|
/**
|
|
295
295
|
* Toolbar of the `FormContainer`.
|
|
296
296
|
*
|
|
297
|
-
* **Note:** If a `Toolbar` is used, the
|
|
298
|
-
* must be added at content to the `Toolbar`. In this case add the `Title` to the
|
|
299
|
-
* Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
297
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
298
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
299
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
300
300
|
*
|
|
301
301
|
* @since 1.36.0
|
|
302
302
|
*/
|
|
@@ -309,8 +309,8 @@ declare namespace sap {
|
|
|
309
309
|
* used `FormLayout`.
|
|
310
310
|
*
|
|
311
311
|
* **Note:** If there is more than one `FormContainers`, every `FormContainer` needs to have some title
|
|
312
|
-
* or label (at least for screen reader support). If no
|
|
313
|
-
* using the `ariaLabelledBy` association.
|
|
312
|
+
* or label (at least for screen reader support). If no {@link #getTitle Title} is set, a label or title
|
|
313
|
+
* needs to be assigned using the `ariaLabelledBy` association.
|
|
314
314
|
*
|
|
315
315
|
* @since 1.36.0
|
|
316
316
|
*/
|
|
@@ -345,7 +345,7 @@ declare namespace sap {
|
|
|
345
345
|
*
|
|
346
346
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
347
347
|
* layout, keyboard support and screen-reader support. Only form controls are allowed. Views are also not
|
|
348
|
-
* supported. Allowed controls implement the interface
|
|
348
|
+
* supported. Allowed controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
349
349
|
*/
|
|
350
350
|
fields?:
|
|
351
351
|
| sap.ui.core.Control[]
|
|
@@ -1009,18 +1009,19 @@ declare namespace sap {
|
|
|
1009
1009
|
* The content of the form is structured in the following way:
|
|
1010
1010
|
* - Add a {@link sap.ui.core.Title Title} element or `Toolbar` control to start a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`).
|
|
1011
1011
|
*
|
|
1012
|
-
* - Add a
|
|
1012
|
+
* - Add a {@link sap.m.Label Label} control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`).
|
|
1013
1013
|
*
|
|
1014
1014
|
* - Add controls as input fields, text fields or other as needed.
|
|
1015
|
-
* - Use
|
|
1016
|
-
*
|
|
1017
|
-
*
|
|
1018
|
-
*
|
|
1019
|
-
*
|
|
1020
|
-
* {@link sap.ui.
|
|
1021
|
-
*
|
|
1022
|
-
*
|
|
1023
|
-
*
|
|
1015
|
+
* - Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence the layout for special cases
|
|
1016
|
+
* in the single controls. For example, if a {@link sap.ui.layout.ColumnLayout ColumnLayout} is used as
|
|
1017
|
+
* a layout, the form content is weighted using 4 cells for the labels and 8 cells for the field part, for
|
|
1018
|
+
* large size. If there is only little space, the labels are above the fields and each field uses 12 cells.
|
|
1019
|
+
* If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
|
|
1020
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. Ensure that the sum of
|
|
1021
|
+
* the weights in the {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12,
|
|
1022
|
+
* as this is the total width of the input control part of each form row. Example for a row where
|
|
1023
|
+
* the {@link sap.m.Input Input} uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using
|
|
1024
|
+
* {@link sap.ui.layout.form.ColumnElementData ColumnElementData}):
|
|
1024
1025
|
* ```javascript
|
|
1025
1026
|
*
|
|
1026
1027
|
* new sap.m.Label({text:"Label"});
|
|
@@ -1033,10 +1034,10 @@ declare namespace sap {
|
|
|
1033
1034
|
* there are 12 cells in one row. Depending on the screen size the labels use the defined `labelSpan`. The
|
|
1034
1035
|
* remaining cells are used for the fields (and `emptySpan` if defined). The available cells are distributed
|
|
1035
1036
|
* to all fields in the row. If one field should use a fixed number of cells you can add {@link sap.ui.layout.GridData GridData }
|
|
1036
|
-
* to them via the {@link #setLayoutData setLayoutData} method. If there are additional
|
|
1037
|
-
* they will get the remaining cells. Example for a row with two {@link sap.m.Input Input}
|
|
1038
|
-
* where one uses four cells on small screens, one cell on medium screens and 2 cells on larger
|
|
1039
|
-
* (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
|
|
1037
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. If there are additional
|
|
1038
|
+
* fields in the row they will get the remaining cells. Example for a row with two {@link sap.m.Input Input }
|
|
1039
|
+
* controls where one uses four cells on small screens, one cell on medium screens and 2 cells on larger
|
|
1040
|
+
* screens (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
|
|
1040
1041
|
* ```javascript
|
|
1041
1042
|
*
|
|
1042
1043
|
* new sap.m.Label({text:"Label"});
|
|
@@ -1047,12 +1048,12 @@ declare namespace sap {
|
|
|
1047
1048
|
*
|
|
1048
1049
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
1049
1050
|
* layout, keyboard support and screen-reader support. Only labels, titles, toolbars and form controls are
|
|
1050
|
-
* allowed. Views are also not supported. Allowed form controls implement the interface
|
|
1051
|
+
* allowed. Views are also not supported. Allowed form controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
1051
1052
|
*
|
|
1052
|
-
* If editable controls are used as content, the
|
|
1053
|
-
* `false`. If the
|
|
1054
|
-
* alignment or wrong spacing between the controls. In addition to that,
|
|
1055
|
-
* might occur.
|
|
1053
|
+
* If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`,
|
|
1054
|
+
* otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be
|
|
1055
|
+
* visual issues like wrong label alignment or wrong spacing between the controls. In addition to that,
|
|
1056
|
+
* wrong screen reader announcements might occur.
|
|
1056
1057
|
*/
|
|
1057
1058
|
content?:
|
|
1058
1059
|
| sap.ui.core.Element[]
|
|
@@ -1063,7 +1064,7 @@ declare namespace sap {
|
|
|
1063
1064
|
/**
|
|
1064
1065
|
* Title element of the `SimpleForm`. Can either be a `Title` element, or a string.
|
|
1065
1066
|
*
|
|
1066
|
-
* **Note:** If a
|
|
1067
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
1067
1068
|
*
|
|
1068
1069
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
1069
1070
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -1080,8 +1081,9 @@ declare namespace sap {
|
|
|
1080
1081
|
/**
|
|
1081
1082
|
* Toolbar of the `SimpleForm`.
|
|
1082
1083
|
*
|
|
1083
|
-
* **Note:** If a `Toolbar` is used, the
|
|
1084
|
-
* must be added at content to the `Toolbar`. In this case, add the `Title` to the
|
|
1084
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
1085
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
1086
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
1085
1087
|
*
|
|
1086
1088
|
* @since 1.36.0
|
|
1087
1089
|
*/
|
|
@@ -1091,8 +1093,9 @@ declare namespace sap {
|
|
|
1091
1093
|
* Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
|
|
1092
1094
|
*
|
|
1093
1095
|
* **Note:** Every `Form` needs to have some title or label (at least for screen reader support). If no
|
|
1094
|
-
*
|
|
1095
|
-
* or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using
|
|
1096
|
+
* {@link #getTitle Title} is set, and the `SimpleForm` is not a child or a control with a title, such as
|
|
1097
|
+
* {@link sap.m.Panel Panel} or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using
|
|
1098
|
+
* the `ariaLabelledBy` association.
|
|
1096
1099
|
*
|
|
1097
1100
|
* @since 1.32.0
|
|
1098
1101
|
*/
|
|
@@ -1428,11 +1431,11 @@ declare namespace sap {
|
|
|
1428
1431
|
* So the last row of the {@link sap.ui.layout.form.Form Form} control will not be fully used.
|
|
1429
1432
|
*
|
|
1430
1433
|
* The default size of the {@link sap.ui.layout.form.FormContainer FormContainer} element can be overwritten
|
|
1431
|
-
* by using {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData} as
|
|
1432
|
-
* element has {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData}
|
|
1433
|
-
* of the other {@link sap.ui.layout.form.FormContainer FormContainer} elements
|
|
1434
|
-
* result. In this case, use {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData}
|
|
1435
|
-
* the other {@link sap.ui.layout.form.FormContainer FormContainer} elements.
|
|
1434
|
+
* by using {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData} as {@link sap.ui.core.Element#setLayoutData LayoutData}.
|
|
1435
|
+
* If one {@link sap.ui.layout.form.FormContainer FormContainer} element has {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData }
|
|
1436
|
+
* set, the size calculation of the other {@link sap.ui.layout.form.FormContainer FormContainer} elements
|
|
1437
|
+
* might not lead to the expected result. In this case, use {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData }
|
|
1438
|
+
* also for the other {@link sap.ui.layout.form.FormContainer FormContainer} elements.
|
|
1436
1439
|
*
|
|
1437
1440
|
* The {@link sap.ui.layout.form.FormElement FormElement} elements are spread out to the columns of a {@link sap.ui.layout.form.FormContainer FormContainer }
|
|
1438
1441
|
* element arranged in a newspaper-like order. The position of the labels and fields depends on the size
|
|
@@ -1685,8 +1688,8 @@ declare namespace sap {
|
|
|
1685
1688
|
* UI requirements without changing the `Form` itself.
|
|
1686
1689
|
*
|
|
1687
1690
|
* For the content of a `Form`, {@link sap.ui.core.VariantLayoutData VariantLayoutData} are supported to
|
|
1688
|
-
* allow simple switching of the
|
|
1689
|
-
* default layout of the `Form`.
|
|
1691
|
+
* allow simple switching of the {@link sap.ui.layout.form.FormLayout FormLayout}. {@link sap.ui.core.Element#setLayoutData LayoutData }
|
|
1692
|
+
* on the content can be used to overwrite the default layout of the `Form`.
|
|
1690
1693
|
*
|
|
1691
1694
|
* The `Form` (and its sub-controls) automatically add label and field assignment to enable screen reader
|
|
1692
1695
|
* support. It also adds keyboard support to navigate between the fields and groups inside the form.
|
|
@@ -1695,10 +1698,10 @@ declare namespace sap {
|
|
|
1695
1698
|
* Views are also not supported. This could damage the visual layout, keyboard support and screen-reader
|
|
1696
1699
|
* support.
|
|
1697
1700
|
*
|
|
1698
|
-
* If editable controls are used as content, the
|
|
1699
|
-
* `false`. If the
|
|
1700
|
-
* alignment or wrong spacing between the controls. In addition to that,
|
|
1701
|
-
* might occur.
|
|
1701
|
+
* If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`,
|
|
1702
|
+
* otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be
|
|
1703
|
+
* visual issues like wrong label alignment or wrong spacing between the controls. In addition to that,
|
|
1704
|
+
* wrong screen reader announcements might occur.
|
|
1702
1705
|
*
|
|
1703
1706
|
* @since 1.16.0
|
|
1704
1707
|
*/
|
|
@@ -1834,7 +1837,7 @@ declare namespace sap {
|
|
|
1834
1837
|
*
|
|
1835
1838
|
* The labels inside the form will be rendered by default in the according mode.
|
|
1836
1839
|
*
|
|
1837
|
-
* **Note:** The setting of this property does not change the content of the form. For example,
|
|
1840
|
+
* **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input }
|
|
1838
1841
|
* controls in a form with `editable` set to false are still editable.
|
|
1839
1842
|
*
|
|
1840
1843
|
* **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
|
|
@@ -1868,7 +1871,7 @@ declare namespace sap {
|
|
|
1868
1871
|
* Title of the `Form`. Can either be a `Title` element or a string. If a `Title` element it used, the style
|
|
1869
1872
|
* of the title can be set.
|
|
1870
1873
|
*
|
|
1871
|
-
* **Note:** If a
|
|
1874
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
1872
1875
|
*
|
|
1873
1876
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
1874
1877
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -1881,9 +1884,9 @@ declare namespace sap {
|
|
|
1881
1884
|
*
|
|
1882
1885
|
* Toolbar of the `Form`.
|
|
1883
1886
|
*
|
|
1884
|
-
* **Note:** If a `Toolbar` is used, the
|
|
1885
|
-
* must be added at content to the `Toolbar`. In this case, add the `Title` to the
|
|
1886
|
-
* Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
1887
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
1888
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
1889
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
1887
1890
|
*
|
|
1888
1891
|
* @since 1.36.0
|
|
1889
1892
|
*/
|
|
@@ -1979,7 +1982,7 @@ declare namespace sap {
|
|
|
1979
1982
|
*
|
|
1980
1983
|
* The labels inside the form will be rendered by default in the according mode.
|
|
1981
1984
|
*
|
|
1982
|
-
* **Note:** The setting of this property does not change the content of the form. For example,
|
|
1985
|
+
* **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input }
|
|
1983
1986
|
* controls in a form with `editable` set to false are still editable.
|
|
1984
1987
|
*
|
|
1985
1988
|
* **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
|
|
@@ -2056,8 +2059,9 @@ declare namespace sap {
|
|
|
2056
2059
|
): this;
|
|
2057
2060
|
}
|
|
2058
2061
|
/**
|
|
2059
|
-
* A `FormContainer` represents a group inside a
|
|
2060
|
-
* the `FormContainer` is done by the
|
|
2062
|
+
* A `FormContainer` represents a group inside a {@link sap.ui.layout.form.Form Form}. It consists of {@link sap.ui.layout.form.FormElement FormElements}.
|
|
2063
|
+
* The rendering of the `FormContainer` is done by the {@link sap.ui.layout.form.Form#getLayout FormLayout }
|
|
2064
|
+
* assigned to the {@link sap.ui.layout.form.Form Form}.
|
|
2061
2065
|
*
|
|
2062
2066
|
* @since 1.16.0
|
|
2063
2067
|
*/
|
|
@@ -2198,7 +2202,7 @@ declare namespace sap {
|
|
|
2198
2202
|
*
|
|
2199
2203
|
* Defines if the `FormContainer` is expandable.
|
|
2200
2204
|
*
|
|
2201
|
-
* **Note:** The expander icon will only be shown if a
|
|
2205
|
+
* **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`.
|
|
2202
2206
|
*
|
|
2203
2207
|
* Default value is `false`.
|
|
2204
2208
|
*
|
|
@@ -2211,7 +2215,7 @@ declare namespace sap {
|
|
|
2211
2215
|
*
|
|
2212
2216
|
* Container is expanded.
|
|
2213
2217
|
*
|
|
2214
|
-
* **Note:** This property only works if
|
|
2218
|
+
* **Note:** This property only works if {@link #getExpandable expandable} is set to `true`.
|
|
2215
2219
|
*
|
|
2216
2220
|
* Default value is `true`.
|
|
2217
2221
|
*
|
|
@@ -2231,7 +2235,7 @@ declare namespace sap {
|
|
|
2231
2235
|
* Title of the `FormContainer`. Can either be a `Title` element or a string. If a `Title` element is used,
|
|
2232
2236
|
* the style of the title can be set.
|
|
2233
2237
|
*
|
|
2234
|
-
* **Note:** If a
|
|
2238
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
2235
2239
|
*
|
|
2236
2240
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
2237
2241
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -2244,9 +2248,9 @@ declare namespace sap {
|
|
|
2244
2248
|
*
|
|
2245
2249
|
* Toolbar of the `FormContainer`.
|
|
2246
2250
|
*
|
|
2247
|
-
* **Note:** If a `Toolbar` is used, the
|
|
2248
|
-
* must be added at content to the `Toolbar`. In this case add the `Title` to the
|
|
2249
|
-
* Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
2251
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
2252
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
2253
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
2250
2254
|
*
|
|
2251
2255
|
* @since 1.36.0
|
|
2252
2256
|
*/
|
|
@@ -2350,7 +2354,7 @@ declare namespace sap {
|
|
|
2350
2354
|
*
|
|
2351
2355
|
* Defines if the `FormContainer` is expandable.
|
|
2352
2356
|
*
|
|
2353
|
-
* **Note:** The expander icon will only be shown if a
|
|
2357
|
+
* **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`.
|
|
2354
2358
|
*
|
|
2355
2359
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2356
2360
|
*
|
|
@@ -2370,7 +2374,7 @@ declare namespace sap {
|
|
|
2370
2374
|
*
|
|
2371
2375
|
* Container is expanded.
|
|
2372
2376
|
*
|
|
2373
|
-
* **Note:** This property only works if
|
|
2377
|
+
* **Note:** This property only works if {@link #getExpandable expandable} is set to `true`.
|
|
2374
2378
|
*
|
|
2375
2379
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2376
2380
|
*
|
|
@@ -2430,8 +2434,8 @@ declare namespace sap {
|
|
|
2430
2434
|
): this;
|
|
2431
2435
|
}
|
|
2432
2436
|
/**
|
|
2433
|
-
* A `FormElement` represents a row in a
|
|
2434
|
-
* and different controls associated to this label.
|
|
2437
|
+
* A `FormElement` represents a row in a {@link sap.ui.layout.form.FormContainer FormContainer}. A `FormElement`
|
|
2438
|
+
* is a combination of one label and different controls associated to this label.
|
|
2435
2439
|
*
|
|
2436
2440
|
* @since 1.16.0
|
|
2437
2441
|
*/
|
|
@@ -2531,7 +2535,7 @@ declare namespace sap {
|
|
|
2531
2535
|
*
|
|
2532
2536
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
2533
2537
|
* layout, keyboard support and screen-reader support. Only form controls are allowed. Views are also not
|
|
2534
|
-
* supported. Allowed controls implement the interface
|
|
2538
|
+
* supported. Allowed controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
2535
2539
|
*/
|
|
2536
2540
|
getFields(): sap.ui.core.Control[];
|
|
2537
2541
|
/**
|
|
@@ -4138,8 +4142,8 @@ declare namespace sap {
|
|
|
4138
4142
|
* - A new `Label` control starts a new row (`{@link sap.ui.layout.form.FormElement FormElement}`) in
|
|
4139
4143
|
* the form.
|
|
4140
4144
|
* - All other controls will be assigned to the row (`{@link sap.ui.layout.form.FormElement FormElement}`)
|
|
4141
|
-
* that started with the last label. Use
|
|
4142
|
-
* the Input/Display controls.
|
|
4145
|
+
* that started with the last label. Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence
|
|
4146
|
+
* the layout for special cases in the Input/Display controls.
|
|
4143
4147
|
*
|
|
4144
4148
|
* **Note:** If a more complex form is needed, use the `{@link sap.ui.layout.form.Form Form}` control instead.
|
|
4145
4149
|
*
|
|
@@ -4391,18 +4395,19 @@ declare namespace sap {
|
|
|
4391
4395
|
* The content of the form is structured in the following way:
|
|
4392
4396
|
* - Add a {@link sap.ui.core.Title Title} element or `Toolbar` control to start a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`).
|
|
4393
4397
|
*
|
|
4394
|
-
* - Add a
|
|
4398
|
+
* - Add a {@link sap.m.Label Label} control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`).
|
|
4395
4399
|
*
|
|
4396
4400
|
* - Add controls as input fields, text fields or other as needed.
|
|
4397
|
-
* - Use
|
|
4398
|
-
*
|
|
4399
|
-
*
|
|
4400
|
-
*
|
|
4401
|
-
*
|
|
4402
|
-
* {@link sap.ui.
|
|
4403
|
-
*
|
|
4404
|
-
*
|
|
4405
|
-
*
|
|
4401
|
+
* - Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence the layout for special cases
|
|
4402
|
+
* in the single controls. For example, if a {@link sap.ui.layout.ColumnLayout ColumnLayout} is used as
|
|
4403
|
+
* a layout, the form content is weighted using 4 cells for the labels and 8 cells for the field part, for
|
|
4404
|
+
* large size. If there is only little space, the labels are above the fields and each field uses 12 cells.
|
|
4405
|
+
* If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
|
|
4406
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. Ensure that the sum of
|
|
4407
|
+
* the weights in the {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12,
|
|
4408
|
+
* as this is the total width of the input control part of each form row. Example for a row where
|
|
4409
|
+
* the {@link sap.m.Input Input} uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using
|
|
4410
|
+
* {@link sap.ui.layout.form.ColumnElementData ColumnElementData}):
|
|
4406
4411
|
* ```javascript
|
|
4407
4412
|
*
|
|
4408
4413
|
* new sap.m.Label({text:"Label"});
|
|
@@ -4415,10 +4420,10 @@ declare namespace sap {
|
|
|
4415
4420
|
* there are 12 cells in one row. Depending on the screen size the labels use the defined `labelSpan`. The
|
|
4416
4421
|
* remaining cells are used for the fields (and `emptySpan` if defined). The available cells are distributed
|
|
4417
4422
|
* to all fields in the row. If one field should use a fixed number of cells you can add {@link sap.ui.layout.GridData GridData }
|
|
4418
|
-
* to them via the {@link #setLayoutData setLayoutData} method. If there are additional
|
|
4419
|
-
* they will get the remaining cells. Example for a row with two {@link sap.m.Input Input}
|
|
4420
|
-
* where one uses four cells on small screens, one cell on medium screens and 2 cells on larger
|
|
4421
|
-
* (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
|
|
4423
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. If there are additional
|
|
4424
|
+
* fields in the row they will get the remaining cells. Example for a row with two {@link sap.m.Input Input }
|
|
4425
|
+
* controls where one uses four cells on small screens, one cell on medium screens and 2 cells on larger
|
|
4426
|
+
* screens (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
|
|
4422
4427
|
* ```javascript
|
|
4423
4428
|
*
|
|
4424
4429
|
* new sap.m.Label({text:"Label"});
|
|
@@ -4429,12 +4434,12 @@ declare namespace sap {
|
|
|
4429
4434
|
*
|
|
4430
4435
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
4431
4436
|
* layout, keyboard support and screen-reader support. Only labels, titles, toolbars and form controls are
|
|
4432
|
-
* allowed. Views are also not supported. Allowed form controls implement the interface
|
|
4437
|
+
* allowed. Views are also not supported. Allowed form controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
4433
4438
|
*
|
|
4434
|
-
* If editable controls are used as content, the
|
|
4435
|
-
* `false`. If the
|
|
4436
|
-
* alignment or wrong spacing between the controls. In addition to that,
|
|
4437
|
-
* might occur.
|
|
4439
|
+
* If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`,
|
|
4440
|
+
* otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be
|
|
4441
|
+
* visual issues like wrong label alignment or wrong spacing between the controls. In addition to that,
|
|
4442
|
+
* wrong screen reader announcements might occur.
|
|
4438
4443
|
*/
|
|
4439
4444
|
getContent(): sap.ui.core.Element[];
|
|
4440
4445
|
/**
|
|
@@ -4676,7 +4681,7 @@ declare namespace sap {
|
|
|
4676
4681
|
*
|
|
4677
4682
|
* Title element of the `SimpleForm`. Can either be a `Title` element, or a string.
|
|
4678
4683
|
*
|
|
4679
|
-
* **Note:** If a
|
|
4684
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
4680
4685
|
*
|
|
4681
4686
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
4682
4687
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -4691,8 +4696,9 @@ declare namespace sap {
|
|
|
4691
4696
|
*
|
|
4692
4697
|
* Toolbar of the `SimpleForm`.
|
|
4693
4698
|
*
|
|
4694
|
-
* **Note:** If a `Toolbar` is used, the
|
|
4695
|
-
* must be added at content to the `Toolbar`. In this case, add the `Title` to the
|
|
4699
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
4700
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
4701
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
4696
4702
|
*
|
|
4697
4703
|
* @since 1.36.0
|
|
4698
4704
|
*/
|