@sapui5/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 +1 -0
- 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 +159 -4
- 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 +471 -32
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +2616 -95
- 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 +79 -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/sap.m.d.ts +401 -55
- 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 -3737
- package/types/sap.suite.ui.commons.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +28 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +77 -9
- package/types/sap.ui.core.d.ts +1160 -639
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +63 -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/sap.ui.mdc.d.ts +1505 -167
- 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/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 +335 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.ui.dt.d.ts
CHANGED
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 module "sap/ui/export/library" {
|
|
4
4
|
import ListBinding from "sap/ui/model/ListBinding";
|
|
@@ -300,6 +300,66 @@ declare module "sap/ui/export/library" {
|
|
|
300
300
|
};
|
|
301
301
|
}
|
|
302
302
|
|
|
303
|
+
declare module "sap/ui/export/CommaSeparatedValues" {
|
|
304
|
+
import ExportBase from "sap/ui/export/ExportBase";
|
|
305
|
+
|
|
306
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
307
|
+
|
|
308
|
+
/**
|
|
309
|
+
* @since 1.142
|
|
310
|
+
*/
|
|
311
|
+
export default class CommaSeparatedValues extends ExportBase {
|
|
312
|
+
/**
|
|
313
|
+
* Provides functionality to export data in CSV format.
|
|
314
|
+
*
|
|
315
|
+
* The `CommaSeparatedValues` class extends the `ExportBase` class and provides the functionality to create
|
|
316
|
+
* CSV files. It supports appending data, validating data, escaping content, and building the final CSV
|
|
317
|
+
* file. Additionally, it provides methods to process data sources, apply default export settings, and manage
|
|
318
|
+
* the export process.
|
|
319
|
+
*
|
|
320
|
+
* There are the following key features:
|
|
321
|
+
* - Supports JSON arrays and ClientListBindings as data sources.
|
|
322
|
+
* - Escapes special characters and prevents CSV injection.
|
|
323
|
+
* - Adds a UTF-8 Byte Order Mark (BOM) for compatibility with spreadsheet software.
|
|
324
|
+
*
|
|
325
|
+
* Example Usage: ```javascript const oCSV = new sap.ui.export.CommaSeparatedValues(mSettings); oCSV.build(); ```
|
|
326
|
+
*/
|
|
327
|
+
constructor();
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* Creates a new subclass of class sap.ui.export.CommaSeparatedValues with name `sClassName` and enriches
|
|
331
|
+
* it with the information contained in `oClassInfo`.
|
|
332
|
+
*
|
|
333
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.export.ExportBase.extend}.
|
|
334
|
+
*
|
|
335
|
+
*
|
|
336
|
+
* @returns Created class / constructor function
|
|
337
|
+
*/
|
|
338
|
+
static extend<T extends Record<string, unknown>>(
|
|
339
|
+
/**
|
|
340
|
+
* Name of the class being created
|
|
341
|
+
*/
|
|
342
|
+
sClassName: string,
|
|
343
|
+
/**
|
|
344
|
+
* Object literal with information about the class
|
|
345
|
+
*/
|
|
346
|
+
oClassInfo?: sap.ClassInfo<T, CommaSeparatedValues>,
|
|
347
|
+
/**
|
|
348
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
349
|
+
* used by this class
|
|
350
|
+
*/
|
|
351
|
+
FNMetaImpl?: Function
|
|
352
|
+
): Function;
|
|
353
|
+
/**
|
|
354
|
+
* Returns a metadata object for class sap.ui.export.CommaSeparatedValues.
|
|
355
|
+
*
|
|
356
|
+
*
|
|
357
|
+
* @returns Metadata object describing this class
|
|
358
|
+
*/
|
|
359
|
+
static getMetadata(): Metadata;
|
|
360
|
+
}
|
|
361
|
+
}
|
|
362
|
+
|
|
303
363
|
declare module "sap/ui/export/ExportBase" {
|
|
304
364
|
import EventProvider from "sap/ui/base/EventProvider";
|
|
305
365
|
|
|
@@ -1144,6 +1204,8 @@ declare module "sap/ui/export/util/Filter" {
|
|
|
1144
1204
|
|
|
1145
1205
|
declare namespace sap {
|
|
1146
1206
|
interface IUI5DefineDependencyNames {
|
|
1207
|
+
"sap/ui/export/CommaSeparatedValues": undefined;
|
|
1208
|
+
|
|
1147
1209
|
"sap/ui/export/ExportBase": undefined;
|
|
1148
1210
|
|
|
1149
1211
|
"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 module "sap/ui/layout/library" {
|
|
4
4
|
import Control from "sap/ui/core/Control";
|
|
@@ -6212,11 +6212,11 @@ declare module "sap/ui/layout/form/ColumnLayout" {
|
|
|
6212
6212
|
* So the last row of the {@link sap.ui.layout.form.Form Form} control will not be fully used.
|
|
6213
6213
|
*
|
|
6214
6214
|
* The default size of the {@link sap.ui.layout.form.FormContainer FormContainer} element can be overwritten
|
|
6215
|
-
* by using {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData} as
|
|
6216
|
-
* element has {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData}
|
|
6217
|
-
* of the other {@link sap.ui.layout.form.FormContainer FormContainer} elements
|
|
6218
|
-
* result. In this case, use {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData}
|
|
6219
|
-
* the other {@link sap.ui.layout.form.FormContainer FormContainer} elements.
|
|
6215
|
+
* by using {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData} as {@link sap.ui.core.Element#setLayoutData LayoutData}.
|
|
6216
|
+
* If one {@link sap.ui.layout.form.FormContainer FormContainer} element has {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData }
|
|
6217
|
+
* set, the size calculation of the other {@link sap.ui.layout.form.FormContainer FormContainer} elements
|
|
6218
|
+
* might not lead to the expected result. In this case, use {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData }
|
|
6219
|
+
* also for the other {@link sap.ui.layout.form.FormContainer FormContainer} elements.
|
|
6220
6220
|
*
|
|
6221
6221
|
* The {@link sap.ui.layout.form.FormElement FormElement} elements are spread out to the columns of a {@link sap.ui.layout.form.FormContainer FormContainer }
|
|
6222
6222
|
* element arranged in a newspaper-like order. The position of the labels and fields depends on the size
|
|
@@ -6523,8 +6523,8 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6523
6523
|
* UI requirements without changing the `Form` itself.
|
|
6524
6524
|
*
|
|
6525
6525
|
* For the content of a `Form`, {@link sap.ui.core.VariantLayoutData VariantLayoutData} are supported to
|
|
6526
|
-
* allow simple switching of the
|
|
6527
|
-
* default layout of the `Form`.
|
|
6526
|
+
* allow simple switching of the {@link sap.ui.layout.form.FormLayout FormLayout}. {@link sap.ui.core.Element#setLayoutData LayoutData }
|
|
6527
|
+
* on the content can be used to overwrite the default layout of the `Form`.
|
|
6528
6528
|
*
|
|
6529
6529
|
* The `Form` (and its sub-controls) automatically add label and field assignment to enable screen reader
|
|
6530
6530
|
* support. It also adds keyboard support to navigate between the fields and groups inside the form.
|
|
@@ -6533,10 +6533,10 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6533
6533
|
* Views are also not supported. This could damage the visual layout, keyboard support and screen-reader
|
|
6534
6534
|
* support.
|
|
6535
6535
|
*
|
|
6536
|
-
* If editable controls are used as content, the
|
|
6537
|
-
* `false`. If the
|
|
6538
|
-
* alignment or wrong spacing between the controls. In addition to that,
|
|
6539
|
-
* might occur.
|
|
6536
|
+
* If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`,
|
|
6537
|
+
* otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be
|
|
6538
|
+
* visual issues like wrong label alignment or wrong spacing between the controls. In addition to that,
|
|
6539
|
+
* wrong screen reader announcements might occur.
|
|
6540
6540
|
*
|
|
6541
6541
|
* @since 1.16.0
|
|
6542
6542
|
*/
|
|
@@ -6672,7 +6672,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6672
6672
|
*
|
|
6673
6673
|
* The labels inside the form will be rendered by default in the according mode.
|
|
6674
6674
|
*
|
|
6675
|
-
* **Note:** The setting of this property does not change the content of the form. For example,
|
|
6675
|
+
* **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input }
|
|
6676
6676
|
* controls in a form with `editable` set to false are still editable.
|
|
6677
6677
|
*
|
|
6678
6678
|
* **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
|
|
@@ -6706,7 +6706,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6706
6706
|
* Title of the `Form`. Can either be a `Title` element or a string. If a `Title` element it used, the style
|
|
6707
6707
|
* of the title can be set.
|
|
6708
6708
|
*
|
|
6709
|
-
* **Note:** If a
|
|
6709
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
6710
6710
|
*
|
|
6711
6711
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
6712
6712
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -6719,9 +6719,9 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6719
6719
|
*
|
|
6720
6720
|
* Toolbar of the `Form`.
|
|
6721
6721
|
*
|
|
6722
|
-
* **Note:** If a `Toolbar` is used, the
|
|
6723
|
-
* must be added at content to the `Toolbar`. In this case, add the `Title` to the
|
|
6724
|
-
* Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
6722
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
6723
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
6724
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
6725
6725
|
*
|
|
6726
6726
|
* @since 1.36.0
|
|
6727
6727
|
*/
|
|
@@ -6817,7 +6817,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6817
6817
|
*
|
|
6818
6818
|
* The labels inside the form will be rendered by default in the according mode.
|
|
6819
6819
|
*
|
|
6820
|
-
* **Note:** The setting of this property does not change the content of the form. For example,
|
|
6820
|
+
* **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input }
|
|
6821
6821
|
* controls in a form with `editable` set to false are still editable.
|
|
6822
6822
|
*
|
|
6823
6823
|
* **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
|
|
@@ -6909,7 +6909,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6909
6909
|
*
|
|
6910
6910
|
* The labels inside the form will be rendered by default in the according mode.
|
|
6911
6911
|
*
|
|
6912
|
-
* **Note:** The setting of this property does not change the content of the form. For example,
|
|
6912
|
+
* **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input }
|
|
6913
6913
|
* controls in a form with `editable` set to false are still editable.
|
|
6914
6914
|
*
|
|
6915
6915
|
* **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
|
|
@@ -6934,7 +6934,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6934
6934
|
* Title of the `Form`. Can either be a `Title` element or a string. If a `Title` element it used, the style
|
|
6935
6935
|
* of the title can be set.
|
|
6936
6936
|
*
|
|
6937
|
-
* **Note:** If a
|
|
6937
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
6938
6938
|
*
|
|
6939
6939
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
6940
6940
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -6946,9 +6946,9 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6946
6946
|
/**
|
|
6947
6947
|
* Toolbar of the `Form`.
|
|
6948
6948
|
*
|
|
6949
|
-
* **Note:** If a `Toolbar` is used, the
|
|
6950
|
-
* must be added at content to the `Toolbar`. In this case, add the `Title` to the
|
|
6951
|
-
* Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
6949
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
6950
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
6951
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
6952
6952
|
*
|
|
6953
6953
|
* @since 1.36.0
|
|
6954
6954
|
*/
|
|
@@ -6964,7 +6964,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6964
6964
|
* Association to controls / IDs that label this control (see WAI-ARIA attribute `aria-labelledby`).
|
|
6965
6965
|
*
|
|
6966
6966
|
* **Note:** Every `Form` needs to have some title or label (at least for screen reader support). If no
|
|
6967
|
-
*
|
|
6967
|
+
* {@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 }
|
|
6968
6968
|
* or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using the `ariaLabelledBy` association.
|
|
6969
6969
|
*
|
|
6970
6970
|
* @since 1.28.0
|
|
@@ -6992,8 +6992,9 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
6992
6992
|
} from "sap/ui/base/ManagedObject";
|
|
6993
6993
|
|
|
6994
6994
|
/**
|
|
6995
|
-
* A `FormContainer` represents a group inside a
|
|
6996
|
-
* the `FormContainer` is done by the
|
|
6995
|
+
* A `FormContainer` represents a group inside a {@link sap.ui.layout.form.Form Form}. It consists of {@link sap.ui.layout.form.FormElement FormElements}.
|
|
6996
|
+
* The rendering of the `FormContainer` is done by the {@link sap.ui.layout.form.Form#getLayout FormLayout }
|
|
6997
|
+
* assigned to the {@link sap.ui.layout.form.Form Form}.
|
|
6997
6998
|
*
|
|
6998
6999
|
* @since 1.16.0
|
|
6999
7000
|
*/
|
|
@@ -7134,7 +7135,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7134
7135
|
*
|
|
7135
7136
|
* Defines if the `FormContainer` is expandable.
|
|
7136
7137
|
*
|
|
7137
|
-
* **Note:** The expander icon will only be shown if a
|
|
7138
|
+
* **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`.
|
|
7138
7139
|
*
|
|
7139
7140
|
* Default value is `false`.
|
|
7140
7141
|
*
|
|
@@ -7147,7 +7148,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7147
7148
|
*
|
|
7148
7149
|
* Container is expanded.
|
|
7149
7150
|
*
|
|
7150
|
-
* **Note:** This property only works if
|
|
7151
|
+
* **Note:** This property only works if {@link #getExpandable expandable} is set to `true`.
|
|
7151
7152
|
*
|
|
7152
7153
|
* Default value is `true`.
|
|
7153
7154
|
*
|
|
@@ -7167,7 +7168,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7167
7168
|
* Title of the `FormContainer`. Can either be a `Title` element or a string. If a `Title` element is used,
|
|
7168
7169
|
* the style of the title can be set.
|
|
7169
7170
|
*
|
|
7170
|
-
* **Note:** If a
|
|
7171
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
7171
7172
|
*
|
|
7172
7173
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
7173
7174
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -7180,9 +7181,9 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7180
7181
|
*
|
|
7181
7182
|
* Toolbar of the `FormContainer`.
|
|
7182
7183
|
*
|
|
7183
|
-
* **Note:** If a `Toolbar` is used, the
|
|
7184
|
-
* must be added at content to the `Toolbar`. In this case add the `Title` to the
|
|
7185
|
-
* Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
7184
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
7185
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
7186
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
7186
7187
|
*
|
|
7187
7188
|
* @since 1.36.0
|
|
7188
7189
|
*/
|
|
@@ -7286,7 +7287,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7286
7287
|
*
|
|
7287
7288
|
* Defines if the `FormContainer` is expandable.
|
|
7288
7289
|
*
|
|
7289
|
-
* **Note:** The expander icon will only be shown if a
|
|
7290
|
+
* **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`.
|
|
7290
7291
|
*
|
|
7291
7292
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7292
7293
|
*
|
|
@@ -7306,7 +7307,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7306
7307
|
*
|
|
7307
7308
|
* Container is expanded.
|
|
7308
7309
|
*
|
|
7309
|
-
* **Note:** This property only works if
|
|
7310
|
+
* **Note:** This property only works if {@link #getExpandable expandable} is set to `true`.
|
|
7310
7311
|
*
|
|
7311
7312
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7312
7313
|
*
|
|
@@ -7372,14 +7373,14 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7372
7373
|
/**
|
|
7373
7374
|
* Container is expanded.
|
|
7374
7375
|
*
|
|
7375
|
-
* **Note:** This property only works if
|
|
7376
|
+
* **Note:** This property only works if {@link #getExpandable expandable} is set to `true`.
|
|
7376
7377
|
*/
|
|
7377
7378
|
expanded?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
7378
7379
|
|
|
7379
7380
|
/**
|
|
7380
7381
|
* Defines if the `FormContainer` is expandable.
|
|
7381
7382
|
*
|
|
7382
|
-
* **Note:** The expander icon will only be shown if a
|
|
7383
|
+
* **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`.
|
|
7383
7384
|
*/
|
|
7384
7385
|
expandable?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
7385
7386
|
|
|
@@ -7401,7 +7402,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7401
7402
|
* Title of the `FormContainer`. Can either be a `Title` element or a string. If a `Title` element is used,
|
|
7402
7403
|
* the style of the title can be set.
|
|
7403
7404
|
*
|
|
7404
|
-
* **Note:** If a
|
|
7405
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
7405
7406
|
*
|
|
7406
7407
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
7407
7408
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -7413,9 +7414,9 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7413
7414
|
/**
|
|
7414
7415
|
* Toolbar of the `FormContainer`.
|
|
7415
7416
|
*
|
|
7416
|
-
* **Note:** If a `Toolbar` is used, the
|
|
7417
|
-
* must be added at content to the `Toolbar`. In this case add the `Title` to the
|
|
7418
|
-
* Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
7417
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
7418
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
7419
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
7419
7420
|
*
|
|
7420
7421
|
* @since 1.36.0
|
|
7421
7422
|
*/
|
|
@@ -7428,8 +7429,8 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7428
7429
|
* used `FormLayout`.
|
|
7429
7430
|
*
|
|
7430
7431
|
* **Note:** If there is more than one `FormContainers`, every `FormContainer` needs to have some title
|
|
7431
|
-
* or label (at least for screen reader support). If no
|
|
7432
|
-
* using the `ariaLabelledBy` association.
|
|
7432
|
+
* or label (at least for screen reader support). If no {@link #getTitle Title} is set, a label or title
|
|
7433
|
+
* needs to be assigned using the `ariaLabelledBy` association.
|
|
7433
7434
|
*
|
|
7434
7435
|
* @since 1.36.0
|
|
7435
7436
|
*/
|
|
@@ -7452,8 +7453,8 @@ declare module "sap/ui/layout/form/FormElement" {
|
|
|
7452
7453
|
} from "sap/ui/base/ManagedObject";
|
|
7453
7454
|
|
|
7454
7455
|
/**
|
|
7455
|
-
* A `FormElement` represents a row in a
|
|
7456
|
-
* and different controls associated to this label.
|
|
7456
|
+
* A `FormElement` represents a row in a {@link sap.ui.layout.form.FormContainer FormContainer}. A `FormElement`
|
|
7457
|
+
* is a combination of one label and different controls associated to this label.
|
|
7457
7458
|
*
|
|
7458
7459
|
* @since 1.16.0
|
|
7459
7460
|
*/
|
|
@@ -7553,7 +7554,7 @@ declare module "sap/ui/layout/form/FormElement" {
|
|
|
7553
7554
|
*
|
|
7554
7555
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
7555
7556
|
* layout, keyboard support and screen-reader support. Only form controls are allowed. Views are also not
|
|
7556
|
-
* supported. Allowed controls implement the interface
|
|
7557
|
+
* supported. Allowed controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
7557
7558
|
*/
|
|
7558
7559
|
getFields(): Control[];
|
|
7559
7560
|
/**
|
|
@@ -7705,7 +7706,7 @@ declare module "sap/ui/layout/form/FormElement" {
|
|
|
7705
7706
|
*
|
|
7706
7707
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
7707
7708
|
* layout, keyboard support and screen-reader support. Only form controls are allowed. Views are also not
|
|
7708
|
-
* supported. Allowed controls implement the interface
|
|
7709
|
+
* supported. Allowed controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
7709
7710
|
*/
|
|
7710
7711
|
fields?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
|
|
7711
7712
|
}
|
|
@@ -9540,8 +9541,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
9540
9541
|
* - A new `Label` control starts a new row (`{@link sap.ui.layout.form.FormElement FormElement}`) in
|
|
9541
9542
|
* the form.
|
|
9542
9543
|
* - All other controls will be assigned to the row (`{@link sap.ui.layout.form.FormElement FormElement}`)
|
|
9543
|
-
* that started with the last label. Use
|
|
9544
|
-
* the Input/Display controls.
|
|
9544
|
+
* that started with the last label. Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence
|
|
9545
|
+
* the layout for special cases in the Input/Display controls.
|
|
9545
9546
|
*
|
|
9546
9547
|
* **Note:** If a more complex form is needed, use the `{@link sap.ui.layout.form.Form Form}` control instead.
|
|
9547
9548
|
*
|
|
@@ -9793,18 +9794,19 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
9793
9794
|
* The content of the form is structured in the following way:
|
|
9794
9795
|
* - Add a {@link sap.ui.core.Title Title} element or `Toolbar` control to start a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`).
|
|
9795
9796
|
*
|
|
9796
|
-
* - Add a
|
|
9797
|
+
* - Add a {@link sap.m.Label Label} control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`).
|
|
9797
9798
|
*
|
|
9798
9799
|
* - Add controls as input fields, text fields or other as needed.
|
|
9799
|
-
* - Use
|
|
9800
|
-
*
|
|
9801
|
-
*
|
|
9802
|
-
*
|
|
9803
|
-
*
|
|
9804
|
-
* {@link sap.ui.
|
|
9805
|
-
*
|
|
9806
|
-
*
|
|
9807
|
-
*
|
|
9800
|
+
* - Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence the layout for special cases
|
|
9801
|
+
* in the single controls. For example, if a {@link sap.ui.layout.ColumnLayout ColumnLayout} is used as
|
|
9802
|
+
* a layout, the form content is weighted using 4 cells for the labels and 8 cells for the field part, for
|
|
9803
|
+
* large size. If there is only little space, the labels are above the fields and each field uses 12 cells.
|
|
9804
|
+
* If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
|
|
9805
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. Ensure that the sum of
|
|
9806
|
+
* the weights in the {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12,
|
|
9807
|
+
* as this is the total width of the input control part of each form row. Example for a row where
|
|
9808
|
+
* the {@link sap.m.Input Input} uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using
|
|
9809
|
+
* {@link sap.ui.layout.form.ColumnElementData ColumnElementData}):
|
|
9808
9810
|
* ```javascript
|
|
9809
9811
|
*
|
|
9810
9812
|
* new sap.m.Label({text:"Label"});
|
|
@@ -9817,10 +9819,10 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
9817
9819
|
* there are 12 cells in one row. Depending on the screen size the labels use the defined `labelSpan`. The
|
|
9818
9820
|
* remaining cells are used for the fields (and `emptySpan` if defined). The available cells are distributed
|
|
9819
9821
|
* 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 }
|
|
9820
|
-
* to them via the {@link #setLayoutData setLayoutData} method. If there are additional
|
|
9821
|
-
* they will get the remaining cells. Example for a row with two {@link sap.m.Input Input}
|
|
9822
|
-
* where one uses four cells on small screens, one cell on medium screens and 2 cells on larger
|
|
9823
|
-
* (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
|
|
9822
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. If there are additional
|
|
9823
|
+
* fields in the row they will get the remaining cells. Example for a row with two {@link sap.m.Input Input }
|
|
9824
|
+
* controls where one uses four cells on small screens, one cell on medium screens and 2 cells on larger
|
|
9825
|
+
* screens (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
|
|
9824
9826
|
* ```javascript
|
|
9825
9827
|
*
|
|
9826
9828
|
* new sap.m.Label({text:"Label"});
|
|
@@ -9831,12 +9833,12 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
9831
9833
|
*
|
|
9832
9834
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
9833
9835
|
* layout, keyboard support and screen-reader support. Only labels, titles, toolbars and form controls are
|
|
9834
|
-
* allowed. Views are also not supported. Allowed form controls implement the interface
|
|
9836
|
+
* allowed. Views are also not supported. Allowed form controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
9835
9837
|
*
|
|
9836
|
-
* If editable controls are used as content, the
|
|
9837
|
-
* `false`. If the
|
|
9838
|
-
* alignment or wrong spacing between the controls. In addition to that,
|
|
9839
|
-
* might occur.
|
|
9838
|
+
* If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`,
|
|
9839
|
+
* otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be
|
|
9840
|
+
* visual issues like wrong label alignment or wrong spacing between the controls. In addition to that,
|
|
9841
|
+
* wrong screen reader announcements might occur.
|
|
9840
9842
|
*/
|
|
9841
9843
|
getContent(): UI5Element[];
|
|
9842
9844
|
/**
|
|
@@ -10078,7 +10080,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
10078
10080
|
*
|
|
10079
10081
|
* Title element of the `SimpleForm`. Can either be a `Title` element, or a string.
|
|
10080
10082
|
*
|
|
10081
|
-
* **Note:** If a
|
|
10083
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
10082
10084
|
*
|
|
10083
10085
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
10084
10086
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -10093,8 +10095,9 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
10093
10095
|
*
|
|
10094
10096
|
* Toolbar of the `SimpleForm`.
|
|
10095
10097
|
*
|
|
10096
|
-
* **Note:** If a `Toolbar` is used, the
|
|
10097
|
-
* must be added at content to the `Toolbar`. In this case, add the `Title` to the
|
|
10098
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
10099
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
10100
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
10098
10101
|
*
|
|
10099
10102
|
* @since 1.36.0
|
|
10100
10103
|
*/
|
|
@@ -11002,18 +11005,19 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11002
11005
|
* The content of the form is structured in the following way:
|
|
11003
11006
|
* - Add a {@link sap.ui.core.Title Title} element or `Toolbar` control to start a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`).
|
|
11004
11007
|
*
|
|
11005
|
-
* - Add a
|
|
11008
|
+
* - Add a {@link sap.m.Label Label} control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`).
|
|
11006
11009
|
*
|
|
11007
11010
|
* - Add controls as input fields, text fields or other as needed.
|
|
11008
|
-
* - Use
|
|
11009
|
-
*
|
|
11010
|
-
*
|
|
11011
|
-
*
|
|
11012
|
-
*
|
|
11013
|
-
* {@link sap.ui.
|
|
11014
|
-
*
|
|
11015
|
-
*
|
|
11016
|
-
*
|
|
11011
|
+
* - Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence the layout for special cases
|
|
11012
|
+
* in the single controls. For example, if a {@link sap.ui.layout.ColumnLayout ColumnLayout} is used as
|
|
11013
|
+
* a layout, the form content is weighted using 4 cells for the labels and 8 cells for the field part, for
|
|
11014
|
+
* large size. If there is only little space, the labels are above the fields and each field uses 12 cells.
|
|
11015
|
+
* If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
|
|
11016
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. Ensure that the sum of
|
|
11017
|
+
* the weights in the {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12,
|
|
11018
|
+
* as this is the total width of the input control part of each form row. Example for a row where
|
|
11019
|
+
* the {@link sap.m.Input Input} uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using
|
|
11020
|
+
* {@link sap.ui.layout.form.ColumnElementData ColumnElementData}):
|
|
11017
11021
|
* ```javascript
|
|
11018
11022
|
*
|
|
11019
11023
|
* new sap.m.Label({text:"Label"});
|
|
@@ -11026,10 +11030,10 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11026
11030
|
* there are 12 cells in one row. Depending on the screen size the labels use the defined `labelSpan`. The
|
|
11027
11031
|
* remaining cells are used for the fields (and `emptySpan` if defined). The available cells are distributed
|
|
11028
11032
|
* 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 }
|
|
11029
|
-
* to them via the {@link #setLayoutData setLayoutData} method. If there are additional
|
|
11030
|
-
* they will get the remaining cells. Example for a row with two {@link sap.m.Input Input}
|
|
11031
|
-
* where one uses four cells on small screens, one cell on medium screens and 2 cells on larger
|
|
11032
|
-
* (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
|
|
11033
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. If there are additional
|
|
11034
|
+
* fields in the row they will get the remaining cells. Example for a row with two {@link sap.m.Input Input }
|
|
11035
|
+
* controls where one uses four cells on small screens, one cell on medium screens and 2 cells on larger
|
|
11036
|
+
* screens (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
|
|
11033
11037
|
* ```javascript
|
|
11034
11038
|
*
|
|
11035
11039
|
* new sap.m.Label({text:"Label"});
|
|
@@ -11040,12 +11044,12 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11040
11044
|
*
|
|
11041
11045
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
11042
11046
|
* layout, keyboard support and screen-reader support. Only labels, titles, toolbars and form controls are
|
|
11043
|
-
* allowed. Views are also not supported. Allowed form controls implement the interface
|
|
11047
|
+
* allowed. Views are also not supported. Allowed form controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
11044
11048
|
*
|
|
11045
|
-
* If editable controls are used as content, the
|
|
11046
|
-
* `false`. If the
|
|
11047
|
-
* alignment or wrong spacing between the controls. In addition to that,
|
|
11048
|
-
* might occur.
|
|
11049
|
+
* If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`,
|
|
11050
|
+
* otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be
|
|
11051
|
+
* visual issues like wrong label alignment or wrong spacing between the controls. In addition to that,
|
|
11052
|
+
* wrong screen reader announcements might occur.
|
|
11049
11053
|
*/
|
|
11050
11054
|
content?:
|
|
11051
11055
|
| UI5Element[]
|
|
@@ -11056,7 +11060,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11056
11060
|
/**
|
|
11057
11061
|
* Title element of the `SimpleForm`. Can either be a `Title` element, or a string.
|
|
11058
11062
|
*
|
|
11059
|
-
* **Note:** If a
|
|
11063
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
11060
11064
|
*
|
|
11061
11065
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
11062
11066
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -11070,8 +11074,9 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11070
11074
|
/**
|
|
11071
11075
|
* Toolbar of the `SimpleForm`.
|
|
11072
11076
|
*
|
|
11073
|
-
* **Note:** If a `Toolbar` is used, the
|
|
11074
|
-
* must be added at content to the `Toolbar`. In this case, add the `Title` to the
|
|
11077
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
11078
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
11079
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
11075
11080
|
*
|
|
11076
11081
|
* @since 1.36.0
|
|
11077
11082
|
*/
|
|
@@ -11081,8 +11086,9 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11081
11086
|
* Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
|
|
11082
11087
|
*
|
|
11083
11088
|
* **Note:** Every `Form` needs to have some title or label (at least for screen reader support). If no
|
|
11084
|
-
*
|
|
11085
|
-
* or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using
|
|
11089
|
+
* {@link #getTitle Title} is set, and the `SimpleForm` is not a child or a control with a title, such as
|
|
11090
|
+
* {@link sap.m.Panel Panel} or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using
|
|
11091
|
+
* the `ariaLabelledBy` association.
|
|
11086
11092
|
*
|
|
11087
11093
|
* @since 1.32.0
|
|
11088
11094
|
*/
|