@openui5/types 1.141.2 → 1.143.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/sap.f.d.ts +8 -1
- package/types/sap.m.d.ts +562 -60
- 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.core.d.ts +1220 -684
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +3 -6
- package/types/sap.ui.integration.d.ts +45 -9
- package/types/sap.ui.layout.d.ts +163 -139
- package/types/sap.ui.mdc.d.ts +1921 -179
- 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 -7
- 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.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.uxap.d.ts +1 -1
package/types/sap.ui.layout.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.143.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/layout/library" {
|
|
4
4
|
import Control from "sap/ui/core/Control";
|
|
@@ -445,8 +445,9 @@ declare module "sap/ui/layout/library" {
|
|
|
445
445
|
ResponsiveLayout = "ResponsiveLayout",
|
|
446
446
|
}
|
|
447
447
|
/**
|
|
448
|
-
* An `int` type that defines how many cells a control inside of a column of a
|
|
449
|
-
*
|
|
448
|
+
* An `int` type that defines how many cells a control inside of a column of a {@link sap.ui.layout.form.Form Form }
|
|
449
|
+
* control using the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} control as {@link sap.ui.layout.form.FormE#setLayout layout }
|
|
450
|
+
* can use.
|
|
450
451
|
*
|
|
451
452
|
* Allowed values are numbers from 1 to 12 and -1. -1 means the value is calculated.
|
|
452
453
|
*
|
|
@@ -455,8 +456,9 @@ declare module "sap/ui/layout/library" {
|
|
|
455
456
|
type ColumnCells = int;
|
|
456
457
|
|
|
457
458
|
/**
|
|
458
|
-
* An `int` type that defines how many columns a
|
|
459
|
-
*
|
|
459
|
+
* An `int` type that defines how many columns a {@link sap.ui.layout.form.Form Form} control using the
|
|
460
|
+
* {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.FormE#setLayout layout }
|
|
461
|
+
* can have if it has large size
|
|
460
462
|
*
|
|
461
463
|
* Allowed values are numbers from 1 to 4. **Note:** In versions lower than 1.122 only 3 columns are allowed.
|
|
462
464
|
*
|
|
@@ -465,8 +467,9 @@ declare module "sap/ui/layout/library" {
|
|
|
465
467
|
type ColumnsL = int;
|
|
466
468
|
|
|
467
469
|
/**
|
|
468
|
-
* An `int` type that defines how many columns a
|
|
469
|
-
*
|
|
470
|
+
* An `int` type that defines how many columns a {@link sap.ui.layout.form.Form Form} control using the
|
|
471
|
+
* {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.FormE#setLayout layout }
|
|
472
|
+
* can have if it has medium size
|
|
470
473
|
*
|
|
471
474
|
* Allowed values are numbers from 1 to 3. **Note:** In versions lower than 1.122 only 2 columns are allowed.
|
|
472
475
|
*
|
|
@@ -475,8 +478,9 @@ declare module "sap/ui/layout/library" {
|
|
|
475
478
|
type ColumnsM = int;
|
|
476
479
|
|
|
477
480
|
/**
|
|
478
|
-
* An `int` type that defines how many columns a
|
|
479
|
-
*
|
|
481
|
+
* An `int` type that defines how many columns a {@link sap.ui.layout.form.Form Form} control using the
|
|
482
|
+
* {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.FormE#setLayout layout }
|
|
483
|
+
* can have if it has extra-large size
|
|
480
484
|
*
|
|
481
485
|
* Allowed values are numbers from 1 to 6. **Note:** In versions lower than 1.89 only 4 columns are allowed.
|
|
482
486
|
*
|
|
@@ -485,8 +489,9 @@ declare module "sap/ui/layout/library" {
|
|
|
485
489
|
type ColumnsXL = int;
|
|
486
490
|
|
|
487
491
|
/**
|
|
488
|
-
* An `int` type that defines how many cells beside the controls inside of a column of a
|
|
489
|
-
* using the
|
|
492
|
+
* An `int` type that defines how many cells beside the controls inside of a column of a {@link sap.ui.layout.form.Form Form }
|
|
493
|
+
* control using the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} control as {@link sap.ui.layout.form.FormE#setLayout layout }
|
|
494
|
+
* are empty.
|
|
490
495
|
*
|
|
491
496
|
* Allowed values are numbers from 0 to 11.
|
|
492
497
|
*
|
|
@@ -5816,10 +5821,12 @@ declare module "sap/ui/layout/form/ColumnContainerData" {
|
|
|
5816
5821
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
5817
5822
|
|
|
5818
5823
|
/**
|
|
5819
|
-
* The
|
|
5824
|
+
* The {@link sap.ui.layout.form.ColumnLayout ColumnLayout}-specific layout data for the {@link sap.ui.layout.form.FormContainer FormContainer }
|
|
5825
|
+
* element.
|
|
5820
5826
|
*
|
|
5821
|
-
* Depending on its size, the
|
|
5822
|
-
*
|
|
5827
|
+
* Depending on its size, the {@link sap.ui.layout.form.Form Form} control is divided into 1, 2, 3 or 4
|
|
5828
|
+
* columns by the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} control. Using `ColumnContainerData`,
|
|
5829
|
+
* the size of the {@link sap.ui.layout.form.FormContainer FormContainer} element can be influenced.
|
|
5823
5830
|
*
|
|
5824
5831
|
* @since 1.56.0
|
|
5825
5832
|
*/
|
|
@@ -5889,7 +5896,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" {
|
|
|
5889
5896
|
/**
|
|
5890
5897
|
* Gets current value of property {@link #getColumnsL columnsL}.
|
|
5891
5898
|
*
|
|
5892
|
-
* Number of columns the
|
|
5899
|
+
* Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
|
|
5900
|
+
* control has large size.
|
|
5893
5901
|
*
|
|
5894
5902
|
* The number of columns for large size must not be smaller than the number of columns for medium size.
|
|
5895
5903
|
*
|
|
@@ -5902,7 +5910,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" {
|
|
|
5902
5910
|
/**
|
|
5903
5911
|
* Gets current value of property {@link #getColumnsM columnsM}.
|
|
5904
5912
|
*
|
|
5905
|
-
* Number of columns the
|
|
5913
|
+
* Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
|
|
5914
|
+
* control has medium size.
|
|
5906
5915
|
*
|
|
5907
5916
|
* Default value is `1`.
|
|
5908
5917
|
*
|
|
@@ -5913,7 +5922,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" {
|
|
|
5913
5922
|
/**
|
|
5914
5923
|
* Gets current value of property {@link #getColumnsXL columnsXL}.
|
|
5915
5924
|
*
|
|
5916
|
-
* Number of columns the
|
|
5925
|
+
* Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
|
|
5926
|
+
* control has extra-large size.
|
|
5917
5927
|
*
|
|
5918
5928
|
* The number of columns for extra-large size must not be smaller than the number of columns for large size.
|
|
5919
5929
|
*
|
|
@@ -5926,7 +5936,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" {
|
|
|
5926
5936
|
/**
|
|
5927
5937
|
* Sets a new value for property {@link #getColumnsL columnsL}.
|
|
5928
5938
|
*
|
|
5929
|
-
* Number of columns the
|
|
5939
|
+
* Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
|
|
5940
|
+
* control has large size.
|
|
5930
5941
|
*
|
|
5931
5942
|
* The number of columns for large size must not be smaller than the number of columns for medium size.
|
|
5932
5943
|
*
|
|
@@ -5946,7 +5957,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" {
|
|
|
5946
5957
|
/**
|
|
5947
5958
|
* Sets a new value for property {@link #getColumnsM columnsM}.
|
|
5948
5959
|
*
|
|
5949
|
-
* Number of columns the
|
|
5960
|
+
* Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
|
|
5961
|
+
* control has medium size.
|
|
5950
5962
|
*
|
|
5951
5963
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
5952
5964
|
*
|
|
@@ -5964,7 +5976,8 @@ declare module "sap/ui/layout/form/ColumnContainerData" {
|
|
|
5964
5976
|
/**
|
|
5965
5977
|
* Sets a new value for property {@link #getColumnsXL columnsXL}.
|
|
5966
5978
|
*
|
|
5967
|
-
* Number of columns the
|
|
5979
|
+
* Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
|
|
5980
|
+
* control has extra-large size.
|
|
5968
5981
|
*
|
|
5969
5982
|
* The number of columns for extra-large size must not be smaller than the number of columns for large size.
|
|
5970
5983
|
*
|
|
@@ -5987,21 +6000,24 @@ declare module "sap/ui/layout/form/ColumnContainerData" {
|
|
|
5987
6000
|
*/
|
|
5988
6001
|
export interface $ColumnContainerDataSettings extends $LayoutDataSettings {
|
|
5989
6002
|
/**
|
|
5990
|
-
* Number of columns the
|
|
6003
|
+
* Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
|
|
6004
|
+
* control has extra-large size.
|
|
5991
6005
|
*
|
|
5992
6006
|
* The number of columns for extra-large size must not be smaller than the number of columns for large size.
|
|
5993
6007
|
*/
|
|
5994
6008
|
columnsXL?: form.ColumnsXL | PropertyBindingInfo | `{${string}}`;
|
|
5995
6009
|
|
|
5996
6010
|
/**
|
|
5997
|
-
* Number of columns the
|
|
6011
|
+
* Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
|
|
6012
|
+
* control has large size.
|
|
5998
6013
|
*
|
|
5999
6014
|
* The number of columns for large size must not be smaller than the number of columns for medium size.
|
|
6000
6015
|
*/
|
|
6001
6016
|
columnsL?: form.ColumnsL | PropertyBindingInfo | `{${string}}`;
|
|
6002
6017
|
|
|
6003
6018
|
/**
|
|
6004
|
-
* Number of columns the
|
|
6019
|
+
* Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
|
|
6020
|
+
* control has medium size.
|
|
6005
6021
|
*/
|
|
6006
6022
|
columnsM?: form.ColumnsM | PropertyBindingInfo | `{${string}}`;
|
|
6007
6023
|
}
|
|
@@ -6020,10 +6036,12 @@ declare module "sap/ui/layout/form/ColumnElementData" {
|
|
|
6020
6036
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
6021
6037
|
|
|
6022
6038
|
/**
|
|
6023
|
-
* The
|
|
6039
|
+
* The {@link sap.ui.layout.form.ColumnLayout ColumnLayout}-specific layout data for the {@link sap.ui.layout.form.Form Form }
|
|
6040
|
+
* content fields.
|
|
6024
6041
|
*
|
|
6025
|
-
* One
|
|
6026
|
-
* the default calculation of the cells used for a field or label
|
|
6042
|
+
* One {@link sap.ui.layout.form.FormElement FormElement} element contains 12 cells and has two sizes, small
|
|
6043
|
+
* and large. Using `ColumnElementData`, the default calculation of the cells used for a field or label
|
|
6044
|
+
* can be overwritten.
|
|
6027
6045
|
*
|
|
6028
6046
|
* @since 1.56.0
|
|
6029
6047
|
*/
|
|
@@ -6093,10 +6111,10 @@ declare module "sap/ui/layout/form/ColumnElementData" {
|
|
|
6093
6111
|
/**
|
|
6094
6112
|
* Gets current value of property {@link #getCellsLarge cellsLarge}.
|
|
6095
6113
|
*
|
|
6096
|
-
* Number of cells used by a field if the
|
|
6097
|
-
* per default.
|
|
6114
|
+
* Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
|
|
6115
|
+
* large. The label is then beside the fields per default.
|
|
6098
6116
|
*
|
|
6099
|
-
* If set to `12`, the full size of the
|
|
6117
|
+
* If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} element is used.
|
|
6100
6118
|
*
|
|
6101
6119
|
* Default value is `8`.
|
|
6102
6120
|
*
|
|
@@ -6107,10 +6125,10 @@ declare module "sap/ui/layout/form/ColumnElementData" {
|
|
|
6107
6125
|
/**
|
|
6108
6126
|
* Gets current value of property {@link #getCellsSmall cellsSmall}.
|
|
6109
6127
|
*
|
|
6110
|
-
* Number of cells used by a field if the
|
|
6111
|
-
* per default.
|
|
6128
|
+
* Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
|
|
6129
|
+
* small. The label is then above the fields per default.
|
|
6112
6130
|
*
|
|
6113
|
-
* If set to `12`, the full size of the
|
|
6131
|
+
* If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} is used.
|
|
6114
6132
|
*
|
|
6115
6133
|
* Default value is `12`.
|
|
6116
6134
|
*
|
|
@@ -6121,10 +6139,10 @@ declare module "sap/ui/layout/form/ColumnElementData" {
|
|
|
6121
6139
|
/**
|
|
6122
6140
|
* Sets a new value for property {@link #getCellsLarge cellsLarge}.
|
|
6123
6141
|
*
|
|
6124
|
-
* Number of cells used by a field if the
|
|
6125
|
-
* per default.
|
|
6142
|
+
* Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
|
|
6143
|
+
* large. The label is then beside the fields per default.
|
|
6126
6144
|
*
|
|
6127
|
-
* If set to `12`, the full size of the
|
|
6145
|
+
* If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} element is used.
|
|
6128
6146
|
*
|
|
6129
6147
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
6130
6148
|
*
|
|
@@ -6142,10 +6160,10 @@ declare module "sap/ui/layout/form/ColumnElementData" {
|
|
|
6142
6160
|
/**
|
|
6143
6161
|
* Sets a new value for property {@link #getCellsSmall cellsSmall}.
|
|
6144
6162
|
*
|
|
6145
|
-
* Number of cells used by a field if the
|
|
6146
|
-
* per default.
|
|
6163
|
+
* Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
|
|
6164
|
+
* small. The label is then above the fields per default.
|
|
6147
6165
|
*
|
|
6148
|
-
* If set to `12`, the full size of the
|
|
6166
|
+
* If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} is used.
|
|
6149
6167
|
*
|
|
6150
6168
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
6151
6169
|
*
|
|
@@ -6166,18 +6184,18 @@ declare module "sap/ui/layout/form/ColumnElementData" {
|
|
|
6166
6184
|
*/
|
|
6167
6185
|
export interface $ColumnElementDataSettings extends $LayoutDataSettings {
|
|
6168
6186
|
/**
|
|
6169
|
-
* Number of cells used by a field if the
|
|
6170
|
-
* per default.
|
|
6187
|
+
* Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
|
|
6188
|
+
* large. The label is then beside the fields per default.
|
|
6171
6189
|
*
|
|
6172
|
-
* If set to `12`, the full size of the
|
|
6190
|
+
* If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} element is used.
|
|
6173
6191
|
*/
|
|
6174
6192
|
cellsLarge?: form.ColumnCells | PropertyBindingInfo | `{${string}}`;
|
|
6175
6193
|
|
|
6176
6194
|
/**
|
|
6177
|
-
* Number of cells used by a field if the
|
|
6178
|
-
* per default.
|
|
6195
|
+
* Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
|
|
6196
|
+
* small. The label is then above the fields per default.
|
|
6179
6197
|
*
|
|
6180
|
-
* If set to `12`, the full size of the
|
|
6198
|
+
* If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} is used.
|
|
6181
6199
|
*/
|
|
6182
6200
|
cellsSmall?: form.ColumnCells | PropertyBindingInfo | `{${string}}`;
|
|
6183
6201
|
}
|
|
@@ -6212,18 +6230,18 @@ declare module "sap/ui/layout/form/ColumnLayout" {
|
|
|
6212
6230
|
* So the last row of the {@link sap.ui.layout.form.Form Form} control will not be fully used.
|
|
6213
6231
|
*
|
|
6214
6232
|
* 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.
|
|
6233
|
+
* by using {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData} as {@link sap.ui.core.Element#setLayoutData LayoutData}.
|
|
6234
|
+
* If one {@link sap.ui.layout.form.FormContainer FormContainer} element has {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData }
|
|
6235
|
+
* set, the size calculation of the other {@link sap.ui.layout.form.FormContainer FormContainer} elements
|
|
6236
|
+
* might not lead to the expected result. In this case, use {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData }
|
|
6237
|
+
* also for the other {@link sap.ui.layout.form.FormContainer FormContainer} elements.
|
|
6220
6238
|
*
|
|
6221
6239
|
* 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
6240
|
* element arranged in a newspaper-like order. The position of the labels and fields depends on the size
|
|
6223
6241
|
* of the used column. If there is enough space, the labels are beside the fields, otherwise above the fields.
|
|
6224
6242
|
*
|
|
6225
6243
|
* The default size of a content control of a {@link sap.ui.layout.form.FormElement FormElement} element
|
|
6226
|
-
* can be overwritten using {@link sap.ui.layout.form.ColumnElementData ColumnElementData} as
|
|
6244
|
+
* can be overwritten using {@link sap.ui.layout.form.ColumnElementData ColumnElementData} as {@link sap.ui.core.Element#setLayoutData LayoutData}.
|
|
6227
6245
|
* If one control assigned to a {@link sap.ui.layout.form.FormElement FormElement} element has {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
|
|
6228
6246
|
* set, the size calculation of the other controls assigned to the {@link sap.ui.layout.form.FormElement FormElement }
|
|
6229
6247
|
* element might not lead to the expected result. In this case, use {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
|
|
@@ -6234,7 +6252,7 @@ declare module "sap/ui/layout/form/ColumnLayout" {
|
|
|
6234
6252
|
* results than might be expected.
|
|
6235
6253
|
*
|
|
6236
6254
|
* **Note:** This control cannot be used stand-alone, it just renders a {@link sap.ui.layout.form.Form Form }
|
|
6237
|
-
* control, so it must be assigned to a {@link sap.ui.layout.form.Form Form} control using the
|
|
6255
|
+
* control, so it must be assigned to a {@link sap.ui.layout.form.Form Form} control using the {@link sap.ui.layout.form.Form#setLayout layout }
|
|
6238
6256
|
* aggregation.
|
|
6239
6257
|
*
|
|
6240
6258
|
* @since 1.56.0
|
|
@@ -6523,8 +6541,8 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6523
6541
|
* UI requirements without changing the `Form` itself.
|
|
6524
6542
|
*
|
|
6525
6543
|
* 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`.
|
|
6544
|
+
* allow simple switching of the {@link sap.ui.layout.form.FormLayout FormLayout}. {@link sap.ui.core.Element#setLayoutData LayoutData }
|
|
6545
|
+
* on the content can be used to overwrite the default layout of the `Form`.
|
|
6528
6546
|
*
|
|
6529
6547
|
* The `Form` (and its sub-controls) automatically add label and field assignment to enable screen reader
|
|
6530
6548
|
* support. It also adds keyboard support to navigate between the fields and groups inside the form.
|
|
@@ -6533,10 +6551,10 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6533
6551
|
* Views are also not supported. This could damage the visual layout, keyboard support and screen-reader
|
|
6534
6552
|
* support.
|
|
6535
6553
|
*
|
|
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.
|
|
6554
|
+
* If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`,
|
|
6555
|
+
* otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be
|
|
6556
|
+
* visual issues like wrong label alignment or wrong spacing between the controls. In addition to that,
|
|
6557
|
+
* wrong screen reader announcements might occur.
|
|
6540
6558
|
*
|
|
6541
6559
|
* @since 1.16.0
|
|
6542
6560
|
*/
|
|
@@ -6672,7 +6690,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6672
6690
|
*
|
|
6673
6691
|
* The labels inside the form will be rendered by default in the according mode.
|
|
6674
6692
|
*
|
|
6675
|
-
* **Note:** The setting of this property does not change the content of the form. For example,
|
|
6693
|
+
* **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input }
|
|
6676
6694
|
* controls in a form with `editable` set to false are still editable.
|
|
6677
6695
|
*
|
|
6678
6696
|
* **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
|
|
@@ -6706,7 +6724,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6706
6724
|
* Title of the `Form`. Can either be a `Title` element or a string. If a `Title` element it used, the style
|
|
6707
6725
|
* of the title can be set.
|
|
6708
6726
|
*
|
|
6709
|
-
* **Note:** If a
|
|
6727
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
6710
6728
|
*
|
|
6711
6729
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
6712
6730
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -6719,9 +6737,9 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6719
6737
|
*
|
|
6720
6738
|
* Toolbar of the `Form`.
|
|
6721
6739
|
*
|
|
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.
|
|
6740
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
6741
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
6742
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
6725
6743
|
*
|
|
6726
6744
|
* @since 1.36.0
|
|
6727
6745
|
*/
|
|
@@ -6817,7 +6835,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6817
6835
|
*
|
|
6818
6836
|
* The labels inside the form will be rendered by default in the according mode.
|
|
6819
6837
|
*
|
|
6820
|
-
* **Note:** The setting of this property does not change the content of the form. For example,
|
|
6838
|
+
* **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input }
|
|
6821
6839
|
* controls in a form with `editable` set to false are still editable.
|
|
6822
6840
|
*
|
|
6823
6841
|
* **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
|
|
@@ -6909,7 +6927,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6909
6927
|
*
|
|
6910
6928
|
* The labels inside the form will be rendered by default in the according mode.
|
|
6911
6929
|
*
|
|
6912
|
-
* **Note:** The setting of this property does not change the content of the form. For example,
|
|
6930
|
+
* **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input }
|
|
6913
6931
|
* controls in a form with `editable` set to false are still editable.
|
|
6914
6932
|
*
|
|
6915
6933
|
* **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields
|
|
@@ -6934,7 +6952,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6934
6952
|
* Title of the `Form`. Can either be a `Title` element or a string. If a `Title` element it used, the style
|
|
6935
6953
|
* of the title can be set.
|
|
6936
6954
|
*
|
|
6937
|
-
* **Note:** If a
|
|
6955
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
6938
6956
|
*
|
|
6939
6957
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
6940
6958
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -6946,9 +6964,9 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6946
6964
|
/**
|
|
6947
6965
|
* Toolbar of the `Form`.
|
|
6948
6966
|
*
|
|
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.
|
|
6967
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
6968
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
6969
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
6952
6970
|
*
|
|
6953
6971
|
* @since 1.36.0
|
|
6954
6972
|
*/
|
|
@@ -6964,7 +6982,7 @@ declare module "sap/ui/layout/form/Form" {
|
|
|
6964
6982
|
* Association to controls / IDs that label this control (see WAI-ARIA attribute `aria-labelledby`).
|
|
6965
6983
|
*
|
|
6966
6984
|
* **Note:** Every `Form` needs to have some title or label (at least for screen reader support). If no
|
|
6967
|
-
*
|
|
6985
|
+
* {@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
6986
|
* or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using the `ariaLabelledBy` association.
|
|
6969
6987
|
*
|
|
6970
6988
|
* @since 1.28.0
|
|
@@ -6992,8 +7010,9 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
6992
7010
|
} from "sap/ui/base/ManagedObject";
|
|
6993
7011
|
|
|
6994
7012
|
/**
|
|
6995
|
-
* A `FormContainer` represents a group inside a
|
|
6996
|
-
* the `FormContainer` is done by the
|
|
7013
|
+
* A `FormContainer` represents a group inside a {@link sap.ui.layout.form.Form Form}. It consists of {@link sap.ui.layout.form.FormElement FormElements}.
|
|
7014
|
+
* The rendering of the `FormContainer` is done by the {@link sap.ui.layout.form.Form#getLayout FormLayout }
|
|
7015
|
+
* assigned to the {@link sap.ui.layout.form.Form Form}.
|
|
6997
7016
|
*
|
|
6998
7017
|
* @since 1.16.0
|
|
6999
7018
|
*/
|
|
@@ -7134,7 +7153,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7134
7153
|
*
|
|
7135
7154
|
* Defines if the `FormContainer` is expandable.
|
|
7136
7155
|
*
|
|
7137
|
-
* **Note:** The expander icon will only be shown if a
|
|
7156
|
+
* **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`.
|
|
7138
7157
|
*
|
|
7139
7158
|
* Default value is `false`.
|
|
7140
7159
|
*
|
|
@@ -7147,7 +7166,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7147
7166
|
*
|
|
7148
7167
|
* Container is expanded.
|
|
7149
7168
|
*
|
|
7150
|
-
* **Note:** This property only works if
|
|
7169
|
+
* **Note:** This property only works if {@link #getExpandable expandable} is set to `true`.
|
|
7151
7170
|
*
|
|
7152
7171
|
* Default value is `true`.
|
|
7153
7172
|
*
|
|
@@ -7167,7 +7186,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7167
7186
|
* Title of the `FormContainer`. Can either be a `Title` element or a string. If a `Title` element is used,
|
|
7168
7187
|
* the style of the title can be set.
|
|
7169
7188
|
*
|
|
7170
|
-
* **Note:** If a
|
|
7189
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
7171
7190
|
*
|
|
7172
7191
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
7173
7192
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -7180,9 +7199,9 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7180
7199
|
*
|
|
7181
7200
|
* Toolbar of the `FormContainer`.
|
|
7182
7201
|
*
|
|
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.
|
|
7202
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
7203
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
7204
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
7186
7205
|
*
|
|
7187
7206
|
* @since 1.36.0
|
|
7188
7207
|
*/
|
|
@@ -7286,7 +7305,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7286
7305
|
*
|
|
7287
7306
|
* Defines if the `FormContainer` is expandable.
|
|
7288
7307
|
*
|
|
7289
|
-
* **Note:** The expander icon will only be shown if a
|
|
7308
|
+
* **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`.
|
|
7290
7309
|
*
|
|
7291
7310
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7292
7311
|
*
|
|
@@ -7306,7 +7325,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7306
7325
|
*
|
|
7307
7326
|
* Container is expanded.
|
|
7308
7327
|
*
|
|
7309
|
-
* **Note:** This property only works if
|
|
7328
|
+
* **Note:** This property only works if {@link #getExpandable expandable} is set to `true`.
|
|
7310
7329
|
*
|
|
7311
7330
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7312
7331
|
*
|
|
@@ -7372,14 +7391,14 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7372
7391
|
/**
|
|
7373
7392
|
* Container is expanded.
|
|
7374
7393
|
*
|
|
7375
|
-
* **Note:** This property only works if
|
|
7394
|
+
* **Note:** This property only works if {@link #getExpandable expandable} is set to `true`.
|
|
7376
7395
|
*/
|
|
7377
7396
|
expanded?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
7378
7397
|
|
|
7379
7398
|
/**
|
|
7380
7399
|
* Defines if the `FormContainer` is expandable.
|
|
7381
7400
|
*
|
|
7382
|
-
* **Note:** The expander icon will only be shown if a
|
|
7401
|
+
* **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`.
|
|
7383
7402
|
*/
|
|
7384
7403
|
expandable?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
7385
7404
|
|
|
@@ -7401,7 +7420,7 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7401
7420
|
* Title of the `FormContainer`. Can either be a `Title` element or a string. If a `Title` element is used,
|
|
7402
7421
|
* the style of the title can be set.
|
|
7403
7422
|
*
|
|
7404
|
-
* **Note:** If a
|
|
7423
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
7405
7424
|
*
|
|
7406
7425
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
7407
7426
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -7413,9 +7432,9 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7413
7432
|
/**
|
|
7414
7433
|
* Toolbar of the `FormContainer`.
|
|
7415
7434
|
*
|
|
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.
|
|
7435
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
7436
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
7437
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
7419
7438
|
*
|
|
7420
7439
|
* @since 1.36.0
|
|
7421
7440
|
*/
|
|
@@ -7428,8 +7447,8 @@ declare module "sap/ui/layout/form/FormContainer" {
|
|
|
7428
7447
|
* used `FormLayout`.
|
|
7429
7448
|
*
|
|
7430
7449
|
* **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.
|
|
7450
|
+
* or label (at least for screen reader support). If no {@link #getTitle Title} is set, a label or title
|
|
7451
|
+
* needs to be assigned using the `ariaLabelledBy` association.
|
|
7433
7452
|
*
|
|
7434
7453
|
* @since 1.36.0
|
|
7435
7454
|
*/
|
|
@@ -7452,8 +7471,8 @@ declare module "sap/ui/layout/form/FormElement" {
|
|
|
7452
7471
|
} from "sap/ui/base/ManagedObject";
|
|
7453
7472
|
|
|
7454
7473
|
/**
|
|
7455
|
-
* A `FormElement` represents a row in a
|
|
7456
|
-
* and different controls associated to this label.
|
|
7474
|
+
* A `FormElement` represents a row in a {@link sap.ui.layout.form.FormContainer FormContainer}. A `FormElement`
|
|
7475
|
+
* is a combination of one label and different controls associated to this label.
|
|
7457
7476
|
*
|
|
7458
7477
|
* @since 1.16.0
|
|
7459
7478
|
*/
|
|
@@ -7553,7 +7572,7 @@ declare module "sap/ui/layout/form/FormElement" {
|
|
|
7553
7572
|
*
|
|
7554
7573
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
7555
7574
|
* layout, keyboard support and screen-reader support. Only form controls are allowed. Views are also not
|
|
7556
|
-
* supported. Allowed controls implement the interface
|
|
7575
|
+
* supported. Allowed controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
7557
7576
|
*/
|
|
7558
7577
|
getFields(): Control[];
|
|
7559
7578
|
/**
|
|
@@ -7705,7 +7724,7 @@ declare module "sap/ui/layout/form/FormElement" {
|
|
|
7705
7724
|
*
|
|
7706
7725
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
7707
7726
|
* layout, keyboard support and screen-reader support. Only form controls are allowed. Views are also not
|
|
7708
|
-
* supported. Allowed controls implement the interface
|
|
7727
|
+
* supported. Allowed controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
7709
7728
|
*/
|
|
7710
7729
|
fields?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
|
|
7711
7730
|
}
|
|
@@ -9540,8 +9559,8 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
9540
9559
|
* - A new `Label` control starts a new row (`{@link sap.ui.layout.form.FormElement FormElement}`) in
|
|
9541
9560
|
* the form.
|
|
9542
9561
|
* - 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.
|
|
9562
|
+
* that started with the last label. Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence
|
|
9563
|
+
* the layout for special cases in the Input/Display controls.
|
|
9545
9564
|
*
|
|
9546
9565
|
* **Note:** If a more complex form is needed, use the `{@link sap.ui.layout.form.Form Form}` control instead.
|
|
9547
9566
|
*
|
|
@@ -9793,18 +9812,19 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
9793
9812
|
* The content of the form is structured in the following way:
|
|
9794
9813
|
* - 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
9814
|
*
|
|
9796
|
-
* - Add a
|
|
9815
|
+
* - Add a {@link sap.m.Label Label} control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`).
|
|
9797
9816
|
*
|
|
9798
9817
|
* - Add controls as input fields, text fields or other as needed.
|
|
9799
|
-
* - Use
|
|
9800
|
-
*
|
|
9801
|
-
*
|
|
9802
|
-
*
|
|
9803
|
-
*
|
|
9804
|
-
* {@link sap.ui.
|
|
9805
|
-
*
|
|
9806
|
-
*
|
|
9807
|
-
*
|
|
9818
|
+
* - Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence the layout for special cases
|
|
9819
|
+
* in the single controls. For example, if a {@link sap.ui.layout.ColumnLayout ColumnLayout} is used as
|
|
9820
|
+
* a layout, the form content is weighted using 4 cells for the labels and 8 cells for the field part, for
|
|
9821
|
+
* large size. If there is only little space, the labels are above the fields and each field uses 12 cells.
|
|
9822
|
+
* If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
|
|
9823
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. Ensure that the sum of
|
|
9824
|
+
* the weights in the {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12,
|
|
9825
|
+
* as this is the total width of the input control part of each form row. Example for a row where
|
|
9826
|
+
* the {@link sap.m.Input Input} uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using
|
|
9827
|
+
* {@link sap.ui.layout.form.ColumnElementData ColumnElementData}):
|
|
9808
9828
|
* ```javascript
|
|
9809
9829
|
*
|
|
9810
9830
|
* new sap.m.Label({text:"Label"});
|
|
@@ -9817,10 +9837,10 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
9817
9837
|
* there are 12 cells in one row. Depending on the screen size the labels use the defined `labelSpan`. The
|
|
9818
9838
|
* remaining cells are used for the fields (and `emptySpan` if defined). The available cells are distributed
|
|
9819
9839
|
* 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}):
|
|
9840
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. If there are additional
|
|
9841
|
+
* fields in the row they will get the remaining cells. Example for a row with two {@link sap.m.Input Input }
|
|
9842
|
+
* controls where one uses four cells on small screens, one cell on medium screens and 2 cells on larger
|
|
9843
|
+
* screens (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
|
|
9824
9844
|
* ```javascript
|
|
9825
9845
|
*
|
|
9826
9846
|
* new sap.m.Label({text:"Label"});
|
|
@@ -9831,12 +9851,12 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
9831
9851
|
*
|
|
9832
9852
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
9833
9853
|
* 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
|
|
9854
|
+
* allowed. Views are also not supported. Allowed form controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
9835
9855
|
*
|
|
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.
|
|
9856
|
+
* If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`,
|
|
9857
|
+
* otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be
|
|
9858
|
+
* visual issues like wrong label alignment or wrong spacing between the controls. In addition to that,
|
|
9859
|
+
* wrong screen reader announcements might occur.
|
|
9840
9860
|
*/
|
|
9841
9861
|
getContent(): UI5Element[];
|
|
9842
9862
|
/**
|
|
@@ -10078,7 +10098,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
10078
10098
|
*
|
|
10079
10099
|
* Title element of the `SimpleForm`. Can either be a `Title` element, or a string.
|
|
10080
10100
|
*
|
|
10081
|
-
* **Note:** If a
|
|
10101
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
10082
10102
|
*
|
|
10083
10103
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
10084
10104
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -10093,8 +10113,9 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
10093
10113
|
*
|
|
10094
10114
|
* Toolbar of the `SimpleForm`.
|
|
10095
10115
|
*
|
|
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
|
|
10116
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
10117
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
10118
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
10098
10119
|
*
|
|
10099
10120
|
* @since 1.36.0
|
|
10100
10121
|
*/
|
|
@@ -11002,18 +11023,19 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11002
11023
|
* The content of the form is structured in the following way:
|
|
11003
11024
|
* - 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
11025
|
*
|
|
11005
|
-
* - Add a
|
|
11026
|
+
* - Add a {@link sap.m.Label Label} control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`).
|
|
11006
11027
|
*
|
|
11007
11028
|
* - Add controls as input fields, text fields or other as needed.
|
|
11008
|
-
* - Use
|
|
11009
|
-
*
|
|
11010
|
-
*
|
|
11011
|
-
*
|
|
11012
|
-
*
|
|
11013
|
-
* {@link sap.ui.
|
|
11014
|
-
*
|
|
11015
|
-
*
|
|
11016
|
-
*
|
|
11029
|
+
* - Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence the layout for special cases
|
|
11030
|
+
* in the single controls. For example, if a {@link sap.ui.layout.ColumnLayout ColumnLayout} is used as
|
|
11031
|
+
* a layout, the form content is weighted using 4 cells for the labels and 8 cells for the field part, for
|
|
11032
|
+
* large size. If there is only little space, the labels are above the fields and each field uses 12 cells.
|
|
11033
|
+
* If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
|
|
11034
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. Ensure that the sum of
|
|
11035
|
+
* the weights in the {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12,
|
|
11036
|
+
* as this is the total width of the input control part of each form row. Example for a row where
|
|
11037
|
+
* the {@link sap.m.Input Input} uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using
|
|
11038
|
+
* {@link sap.ui.layout.form.ColumnElementData ColumnElementData}):
|
|
11017
11039
|
* ```javascript
|
|
11018
11040
|
*
|
|
11019
11041
|
* new sap.m.Label({text:"Label"});
|
|
@@ -11026,10 +11048,10 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11026
11048
|
* there are 12 cells in one row. Depending on the screen size the labels use the defined `labelSpan`. The
|
|
11027
11049
|
* remaining cells are used for the fields (and `emptySpan` if defined). The available cells are distributed
|
|
11028
11050
|
* 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}):
|
|
11051
|
+
* to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. If there are additional
|
|
11052
|
+
* fields in the row they will get the remaining cells. Example for a row with two {@link sap.m.Input Input }
|
|
11053
|
+
* controls where one uses four cells on small screens, one cell on medium screens and 2 cells on larger
|
|
11054
|
+
* screens (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}):
|
|
11033
11055
|
* ```javascript
|
|
11034
11056
|
*
|
|
11035
11057
|
* new sap.m.Label({text:"Label"});
|
|
@@ -11040,12 +11062,12 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11040
11062
|
*
|
|
11041
11063
|
* **Warning:** Do not put any layout or other container controls in here. This could damage the visual
|
|
11042
11064
|
* 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
|
|
11065
|
+
* allowed. Views are also not supported. Allowed form controls implement the interface {@link sap.ui.core.IFormContent}.
|
|
11044
11066
|
*
|
|
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.
|
|
11067
|
+
* If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`,
|
|
11068
|
+
* otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be
|
|
11069
|
+
* visual issues like wrong label alignment or wrong spacing between the controls. In addition to that,
|
|
11070
|
+
* wrong screen reader announcements might occur.
|
|
11049
11071
|
*/
|
|
11050
11072
|
content?:
|
|
11051
11073
|
| UI5Element[]
|
|
@@ -11056,7 +11078,7 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11056
11078
|
/**
|
|
11057
11079
|
* Title element of the `SimpleForm`. Can either be a `Title` element, or a string.
|
|
11058
11080
|
*
|
|
11059
|
-
* **Note:** If a
|
|
11081
|
+
* **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored.
|
|
11060
11082
|
*
|
|
11061
11083
|
* **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default
|
|
11062
11084
|
* level. As the `Form` control cannot know the structure of the page, this might not fit the page structure.
|
|
@@ -11070,8 +11092,9 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11070
11092
|
/**
|
|
11071
11093
|
* Toolbar of the `SimpleForm`.
|
|
11072
11094
|
*
|
|
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
|
|
11095
|
+
* **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside
|
|
11096
|
+
* the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy }
|
|
11097
|
+
* association. Use the right title level to meet the visual requirements. This might be theme-dependent.
|
|
11075
11098
|
*
|
|
11076
11099
|
* @since 1.36.0
|
|
11077
11100
|
*/
|
|
@@ -11081,8 +11104,9 @@ declare module "sap/ui/layout/form/SimpleForm" {
|
|
|
11081
11104
|
* Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`).
|
|
11082
11105
|
*
|
|
11083
11106
|
* **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
|
|
11107
|
+
* {@link #getTitle Title} is set, and the `SimpleForm` is not a child or a control with a title, such as
|
|
11108
|
+
* {@link sap.m.Panel Panel} or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using
|
|
11109
|
+
* the `ariaLabelledBy` association.
|
|
11086
11110
|
*
|
|
11087
11111
|
* @since 1.32.0
|
|
11088
11112
|
*/
|