Layout settings to adjust the ResponsiveGridLayout
used inside the Form
.
Constructor for a new smartform/Layout.
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.Layout(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 |
---|---|---|---|
breakpointL | int | Breakpoint (in pixel) between Medium size and Large size. Visibility: public |
|
breakpointM | int | reakpoint (in pixel) between Small size and Medium size. Visibility: public |
|
breakpointXL | int | Breakpoint (in pixel) between large size and extra large (XL) size. |
|
columnsL | int | Number of columns for large size. |
|
columnsM | int | Number of columns for medium size. Visibility: public |
|
columnsXL | int | Number of columns for extra large size. |
|
emptySpanL | int | Number of grid cells that are empty at the end of each line on large size. Visibility: public |
|
emptySpanM | int | Number of grid cells that are empty at the end of each line on medium size. Visibility: public |
|
emptySpanS | int | Number of grid cells that are empty at the end of each line on small size. Visibility: public |
|
emptySpanXL | int | Number of grid cells that are empty at the end of each line on extra large size. |
|
gridDataSpan | sap.ui.layout.GridSpan | empty string | A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small. |
labelSpanL | int | Default span for labels in large size. This span is only used if more than 1 container is in one line, if only 1 container is in the line the |
|
labelSpanM | int | Default span for labels in medium size. This property is used for full size containers. If more than one Container is in one line, |
|
labelSpanS | int | Default span for labels in small size. Visibility: public |
|
labelSpanXL | int | Default span for labels in extra large size. |
|
singleGroupFullSize | boolean | true | If the |
Method | Description |
---|---|
sap.ui.comp.smartform.Layout.extend |
Creates a new subclass of class sap.ui.comp.smartform.Layout with name
|
getBreakpointL |
Gets current value of property breakpointL. Breakpoint (in pixel) between Medium size and Large size. |
getBreakpointM |
Gets current value of property breakpointM. reakpoint (in pixel) between Small size and Medium size. |
getBreakpointXL |
Gets current value of property breakpointXL. Breakpoint (in pixel) between large size and extra large (XL) size. |
getColumnsL |
Gets current value of property columnsL. Number of columns for large size. |
getColumnsM |
Gets current value of property columnsM. Number of columns for medium size. |
getColumnsXL |
Gets current value of property columnsXL. Number of columns for extra large size. |
getEmptySpanL |
Gets current value of property emptySpanL. Number of grid cells that are empty at the end of each line on large size. |
getEmptySpanM |
Gets current value of property emptySpanM. Number of grid cells that are empty at the end of each line on medium size. |
getEmptySpanS |
Gets current value of property emptySpanS. Number of grid cells that are empty at the end of each line on small size. |
getEmptySpanXL |
Gets current value of property emptySpanXL. Number of grid cells that are empty at the end of each line on extra large size. |
getGridDataSpan |
Gets current value of property gridDataSpan. A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small. Default value is |
getLabelSpanL |
Gets current value of property labelSpanL. Default span for labels in large size. This span is only used if more than 1 container is in one line, if only 1 container is in the line the |
getLabelSpanM |
Gets current value of property labelSpanM. Default span for labels in medium size. This property is used for full size containers. If more than one Container is in one line, |
getLabelSpanS |
Gets current value of property labelSpanS. Default span for labels in small size. |
getLabelSpanXL |
Gets current value of property labelSpanXL. Default span for labels in extra large size. |
sap.ui.comp.smartform.Layout.getMetadata |
Returns a metadata object for class sap.ui.comp.smartform.Layout. |
getSingleGroupFullSize |
Gets current value of property singleGroupFullSize. If the Default value is |
setBreakpointL |
Sets a new value for property breakpointL. Breakpoint (in pixel) between Medium size and Large size. When called with a value of |
setBreakpointM |
Sets a new value for property breakpointM. reakpoint (in pixel) between Small size and Medium size. When called with a value of |
setBreakpointXL |
Sets a new value for property breakpointXL. Breakpoint (in pixel) between large size and extra large (XL) size. When called with a value of |
setColumnsL |
Sets a new value for property columnsL. Number of columns for large size. When called with a value of |
setColumnsM |
Sets a new value for property columnsM. Number of columns for medium size. When called with a value of |
setColumnsXL |
Sets a new value for property columnsXL. Number of columns for extra large size. When called with a value of |
setEmptySpanL |
Sets a new value for property emptySpanL. Number of grid cells that are empty at the end of each line on large size. When called with a value of |
setEmptySpanM |
Sets a new value for property emptySpanM. Number of grid cells that are empty at the end of each line on medium size. When called with a value of |
setEmptySpanS |
Sets a new value for property emptySpanS. Number of grid cells that are empty at the end of each line on small size. When called with a value of |
setEmptySpanXL |
Sets a new value for property emptySpanXL. Number of grid cells that are empty at the end of each line on extra large size. When called with a value of |
setGridDataSpan |
Sets a new value for property gridDataSpan. A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small. When called with a value of Default value is |
setLabelSpanL |
Sets a new value for property labelSpanL. Default span for labels in large size. This span is only used if more than 1 container is in one line, if only 1 container is in the line the When called with a value of |
setLabelSpanM |
Sets a new value for property labelSpanM. Default span for labels in medium size. This property is used for full size containers. If more than one Container is in one line, When called with a value of |
setLabelSpanS |
Sets a new value for property labelSpanS. Default span for labels in small size. When called with a value of |
setLabelSpanXL |
Sets a new value for property labelSpanXL. Default span for labels in extra large size. When called with a value of |
setSingleGroupFullSize |
Sets a new value for property singleGroupFullSize. If the When called with a value of Default value is |
Creates a new subclass of class sap.ui.comp.smartform.Layout 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 breakpointL.
Breakpoint (in pixel) between Medium size and Large size.
Gets current value of property breakpointM.
reakpoint (in pixel) between Small size and Medium size.
Gets current value of property breakpointXL.
Breakpoint (in pixel) between large size and extra large (XL) size.
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.
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.
Gets current value of property emptySpanL.
Number of grid cells that are empty at the end of each line on large size.
Gets current value of property emptySpanM.
Number of grid cells that are empty at the end of each line on medium size.
Gets current value of property emptySpanS.
Number of grid cells that are empty at the end of each line on small size.
Gets current value of property emptySpanXL.
Number of grid cells that are empty at the end of each line on extra large size.
Gets current value of property gridDataSpan.
A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
The value set here will be set to all group elements when used with horizontal layout (SmartForm
property useHorizontalLayout
)
Default value is empty string
.
Gets current value of property labelSpanL.
Default span for labels in large size. This span is only used if more than 1 container is in one line, if only 1 container is in the line the labelSpanM
value is used.
Gets current value of property labelSpanM.
Default span for labels in medium size. This property is used for full size containers. If more than one Container is in one line, labelSpanL
is used.
Gets current value of property labelSpanXL.
Default span for labels in extra large size.
Returns a metadata object for class sap.ui.comp.smartform.Layout.
Gets current value of property singleGroupFullSize.
If the SmartForm
contains only one single Group and this property is set, the Group is displayed using the full size of the SmartForm
. In this case the properties columnsL
and columnsM
are ignored.
In all other cases the Group is displayed in the size of one column.
Default value is true
.
Sets a new value for property breakpointL.
Breakpoint (in pixel) between Medium size and Large size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iBreakpointL | int |
New value for property |
Sets a new value for property breakpointM.
reakpoint (in pixel) between Small size and Medium size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iBreakpointM | int |
New value for property |
Sets a new value for property breakpointXL.
Breakpoint (in pixel) between large size and extra large (XL) size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iBreakpointXL | int |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
iColumnsL | int |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
iColumnsM | int |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
iColumnsXL | int |
New value for property |
Sets a new value for property emptySpanL.
Number of grid cells that are empty at the end of each line on large size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iEmptySpanL | int |
New value for property |
Sets a new value for property emptySpanM.
Number of grid cells that are empty at the end of each line on medium size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iEmptySpanM | int |
New value for property |
Sets a new value for property emptySpanS.
Number of grid cells that are empty at the end of each line on small size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iEmptySpanS | int |
New value for property |
Sets a new value for property emptySpanXL.
Number of grid cells that are empty at the end of each line on extra large size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iEmptySpanXL | int |
New value for property |
Sets a new value for property gridDataSpan.
A string type that represents Grid's span values for large, medium and small screens. Allowed values are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided in the order large medium small.
The value set here will be set to all group elements when used with horizontal layout (SmartForm
property useHorizontalLayout
)
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is empty string
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sGridDataSpan | sap.ui.layout.GridSpan | "" |
New value for property |
Sets a new value for property labelSpanL.
Default span for labels in large size. This span is only used if more than 1 container is in one line, if only 1 container is in the line the labelSpanM
value is used.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iLabelSpanL | int |
New value for property |
Sets a new value for property labelSpanM.
Default span for labels in medium size. This property is used for full size containers. If more than one Container is in one line, labelSpanL
is used.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iLabelSpanM | int |
New value for property |
Sets a new value for property labelSpanS.
Default span for labels in small size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iLabelSpanS | int |
New value for property |
Sets a new value for property labelSpanXL.
Default span for labels in extra large size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iLabelSpanXL | int |
New value for property |
Sets a new value for property singleGroupFullSize.
If the SmartForm
contains only one single Group and this property is set, the Group is displayed using the full size of the SmartForm
. In this case the properties columnsL
and columnsM
are ignored.
In all other cases the Group is displayed in the size of one column.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bSingleGroupFullSize | boolean | true |
New value for property |