If this layout is used in a SmartForm
control, a ColumnLayout
control is used to render the Form
control.
Note: If this layout is used, the useHorizontalLayout
property of the SmartForm
control must not be set.
Constructor for a new smartform/ColumnLayout.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.comp.smartform.ColumnLayout(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control, generated automatically if no ID is given |
|
mSettings? | object | Initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
columnsL | sap.ui.layout.form.ColumnsL | 2 | Number of columns for large size. The number of columns for large size must not be smaller than the number of columns for medium size. Visibility: public |
columnsM | sap.ui.layout.form.ColumnsM | 1 | Number of columns for medium size. Visibility: public |
columnsXL | sap.ui.layout.form.ColumnsXL | 2 | Number of columns for extra-large size. The number of columns for extra-large size must not be smaller than the number of columns for large size. Visibility: public |
emptyCellsLarge | sap.ui.layout.form.EmptyCells | 0 | Defines how many cells are empty at the end of a row. This could be used to keep the fields small on large screens. Visibility: public |
labelCellsLarge | sap.ui.layout.form.ColumnCells | 4 | Defines how many cells a label uses if the column is large. Visibility: public |
Method | Description |
---|---|
sap.ui.comp.smartform.ColumnLayout.extend |
Creates a new subclass of class sap.ui.comp.smartform.ColumnLayout with name
|
getColumnsL |
Gets current value of property columnsL. Number of columns for large size. The number of columns for large size must not be smaller than the number of columns for medium size. Default value is |
getColumnsM |
Gets current value of property columnsM. Number of columns for medium size. Default value is |
getColumnsXL |
Gets current value of property columnsXL. Number of columns for extra-large size. The number of columns for extra-large size must not be smaller than the number of columns for large size. Default value is |
getEmptyCellsLarge |
Gets current value of property emptyCellsLarge. Defines how many cells are empty at the end of a row. This could be used to keep the fields small on large screens. Default value is |
getLabelCellsLarge |
Gets current value of property labelCellsLarge. Defines how many cells a label uses if the column is large. Default value is |
sap.ui.comp.smartform.ColumnLayout.getMetadata |
Returns a metadata object for class sap.ui.comp.smartform.ColumnLayout. |
setColumnsL |
Sets a new value for property columnsL. Number of columns for large size. The number of columns for large size must not be smaller than the number of columns for medium size. When called with a value of Default value is |
setColumnsM |
Sets a new value for property columnsM. Number of columns for medium size. When called with a value of Default value is |
setColumnsXL |
Sets a new value for property columnsXL. Number of columns for extra-large size. The number of columns for extra-large size must not be smaller than the number of columns for large size. When called with a value of Default value is |
setEmptyCellsLarge |
Sets a new value for property emptyCellsLarge. Defines how many cells are empty at the end of a row. This could be used to keep the fields small on large screens. When called with a value of Default value is |
setLabelCellsLarge |
Sets a new value for property labelCellsLarge. Defines how many cells a label uses if the column is large. When called with a value of Default value is |
Creates a new subclass of class sap.ui.comp.smartform.ColumnLayout with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.ui.core.Element.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Gets current value of property columnsL.
Number of columns for large size.
The number of columns for large size must not be smaller than the number of columns for medium size.
Default value is 2
.
Gets current value of property columnsM.
Number of columns for medium size.
Default value is 1
.
Gets current value of property columnsXL.
Number of columns for extra-large size.
The number of columns for extra-large size must not be smaller than the number of columns for large size.
Default value is 2
.
Gets current value of property emptyCellsLarge.
Defines how many cells are empty at the end of a row. This could be used to keep the fields small on large screens.
Default value is 0
.
Gets current value of property labelCellsLarge.
Defines how many cells a label uses if the column is large.
Default value is 4
.
Returns a metadata object for class sap.ui.comp.smartform.ColumnLayout.
Sets a new value for property columnsL.
Number of columns for large size.
The number of columns for large size must not be smaller than the number of columns for medium size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 2
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sColumnsL | sap.ui.layout.form.ColumnsL | 2 |
New value for property |
Sets a new value for property columnsM.
Number of columns for medium size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 1
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sColumnsM | sap.ui.layout.form.ColumnsM | 1 |
New value for property |
Sets a new value for property columnsXL.
Number of columns for extra-large size.
The number of columns for extra-large size must not be smaller than the number of columns for large size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 2
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sColumnsXL | sap.ui.layout.form.ColumnsXL | 2 |
New value for property |
Sets a new value for property emptyCellsLarge.
Defines how many cells are empty at the end of a row. This could be used to keep the fields small on large screens.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 0
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sEmptyCellsLarge | sap.ui.layout.form.EmptyCells | 0 |
New value for property |
Sets a new value for property labelCellsLarge.
Defines how many cells a label uses if the column is large.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 4
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sLabelCellsLarge | sap.ui.layout.form.ColumnCells | 4 |
New value for property |