Layout

Layout settings to adjust ResponsiveGridLayout.

Constructor Summary

new sap.ui.comp.smartform.Layout(sId?, mSettings?)Constructor for a new smartform/Layout.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.ui.comp.smartform.Layout.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.smartform.Layout with name sClassName and enriches it with the information contained in oClassInfo.

sap.ui.comp.smartform.Layout.getMetadata()Returns a metadata object for class sap.ui.comp.smartform.Layout.

getBreakpointL()Gets current value of property breakpointL.

getBreakpointM()Gets current value of property breakpointM.

getBreakpointXL()Gets current value of property breakpointXL.

getColumnsL()Gets current value of property columnsL.

getColumnsM()Gets current value of property columnsM.

getColumnsXL()Gets current value of property columnsXL.

getEmptySpanL()Gets current value of property emptySpanL.

getEmptySpanM()Gets current value of property emptySpanM.

getEmptySpanS()Gets current value of property emptySpanS.

getEmptySpanXL()Gets current value of property emptySpanXL.

getGridDataSpan()Gets current value of property gridDataSpan.

getLabelSpanL()Gets current value of property labelSpanL.

getLabelSpanM()Gets current value of property labelSpanM.

getLabelSpanS()Gets current value of property labelSpanS.

getLabelSpanXL()Gets current value of property labelSpanXL.

getSingleGroupFullSize()Gets current value of property singleGroupFullSize.

setBreakpointL(iBreakpointL)Sets a new value for property breakpointL.

setBreakpointM(iBreakpointM)Sets a new value for property breakpointM.

setBreakpointXL(iBreakpointXL)Sets a new value for property breakpointXL.

setColumnsL(iColumnsL)Sets a new value for property columnsL.

setColumnsM(iColumnsM)Sets a new value for property columnsM.

setColumnsXL(iColumnsXL)Sets a new value for property columnsXL.

setEmptySpanL(iEmptySpanL)Sets a new value for property emptySpanL.

setEmptySpanM(iEmptySpanM)Sets a new value for property emptySpanM.

setEmptySpanS(iEmptySpanS)Sets a new value for property emptySpanS.

setEmptySpanXL(iEmptySpanXL)Sets a new value for property emptySpanXL.

setGridDataSpan(sGridDataSpan)Sets a new value for property gridDataSpan.

setLabelSpanL(iLabelSpanL)Sets a new value for property labelSpanL.

setLabelSpanM(iLabelSpanM)Sets a new value for property labelSpanM.

setLabelSpanS(iLabelSpanS)Sets a new value for property labelSpanS.

setLabelSpanXL(iLabelSpanXL)Sets a new value for property labelSpanXL.

setSingleGroupFullSize(bSingleGroupFullSize)Sets a new value for property singleGroupFullSize.

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

Constructor Detail

new sap.ui.comp.smartform.Layout(sId?, mSettings?)

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 for a general description of the syntax of the settings object.

The supported settings are:

Properties
- labelSpanXL : int
- labelSpanL : int
- labelSpanM : int
- labelSpanS : int
- emptySpanXL : int
- emptySpanL : int
- emptySpanM : int
- emptySpanS : int
- columnsXL : int
- columnsL : int
- columnsM : int
- singleGroupFullSize : boolean (default: true)
- breakpointXL : int
- breakpointL : int
- breakpointM : int
- gridDataSpan : sap.ui.layout.GridSpan (default: )

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:

{string}	sId?	id for the new control, generated automatically if no id is given
{object}	mSettings?	initial settings for the new control

Method Detail

sap.ui.comp.smartform.Layout.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.ui.comp.smartform.Layout.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.ui.comp.smartform.Layout.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getBreakpointL(): int

Gets current value of property breakpointL.

Breakpoint (in pixel) between Medium size and Large size.

Returns:

{int} Value of property breakpointL

getBreakpointM(): int

Gets current value of property breakpointM.

reakpoint (in pixel) between Small size and Medium size.

Returns:

{int} Value of property breakpointM

getBreakpointXL(): int

Gets current value of property breakpointXL.

Breakpoint (in pixel) between large size and extra large (XL) size.

Since:: 1.38.0

Returns:

{int} Value of property breakpointXL

getColumnsL(): int

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.

Returns:

{int} Value of property columnsL

getColumnsM(): int

Gets current value of property columnsM.

Number of columns for medium size.

Returns:

{int} Value of property columnsM

getColumnsXL(): int

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.

Since:: 1.38.0

Returns:

{int} Value of property columnsXL

getEmptySpanL(): int

Gets current value of property emptySpanL.

Number of grid cells that are empty at the end of each line on large size.

Returns:

{int} Value of property emptySpanL

getEmptySpanM(): int

Gets current value of property emptySpanM.

Number of grid cells that are empty at the end of each line on medium size.

Returns:

{int} Value of property emptySpanM

getEmptySpanS(): int

Gets current value of property emptySpanS.

Number of grid cells that are empty at the end of each line on small size.

Returns:

{int} Value of property emptySpanS

getEmptySpanXL(): int

Gets current value of property emptySpanXL.

Number of grid cells that are empty at the end of each line on extra large size.

Since:: 1.38.0

Returns:

{int} Value of property emptySpanXL

getGridDataSpan(): sap.ui.layout.GridSpan

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 (smart form property useHorizontalLayout)

Default value is .

Returns:

{sap.ui.layout.GridSpan} Value of property gridDataSpan

getLabelSpanL(): int

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.

Returns:

{int} Value of property labelSpanL

getLabelSpanM(): int

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.

Returns:

{int} Value of property labelSpanM

getLabelSpanS(): int

Gets current value of property labelSpanS.

Default span for labels in small size.

Returns:

{int} Value of property labelSpanS

getLabelSpanXL(): int

Gets current value of property labelSpanXL.

Default span for labels in extra large size.

Since:: 1.38.0

Returns:

{int} Value of property labelSpanXL

getSingleGroupFullSize(): boolean

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.

Since:: 1.34.1

Returns:

{boolean} Value of property singleGroupFullSize

setBreakpointL(iBreakpointL): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iBreakpointL New value for property breakpointL

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setBreakpointM(iBreakpointM): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iBreakpointM New value for property breakpointM

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setBreakpointXL(iBreakpointXL): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iBreakpointXL New value for property breakpointXL

Since:: 1.38.0

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setColumnsL(iColumnsL): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iColumnsL New value for property columnsL

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setColumnsM(iColumnsM): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iColumnsM New value for property columnsM

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setColumnsXL(iColumnsXL): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iColumnsXL New value for property columnsXL

Since:: 1.38.0

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setEmptySpanL(iEmptySpanL): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iEmptySpanL New value for property emptySpanL

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setEmptySpanM(iEmptySpanM): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iEmptySpanM New value for property emptySpanM

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setEmptySpanS(iEmptySpanS): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iEmptySpanS New value for property emptySpanS

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setEmptySpanXL(iEmptySpanXL): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iEmptySpanXL New value for property emptySpanXL

Since:: 1.38.0

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setGridDataSpan(sGridDataSpan): sap.ui.comp.smartform.Layout

Sets a new value for property gridDataSpan.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is .

Parameters:

{sap.ui.layout.GridSpan} sGridDataSpan New value for property gridDataSpan

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setLabelSpanL(iLabelSpanL): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iLabelSpanL New value for property labelSpanL

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setLabelSpanM(iLabelSpanM): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iLabelSpanM New value for property labelSpanM

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setLabelSpanS(iLabelSpanS): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iLabelSpanS New value for property labelSpanS

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setLabelSpanXL(iLabelSpanXL): sap.ui.comp.smartform.Layout

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.

Parameters:

{int} iLabelSpanXL New value for property labelSpanXL

Since:: 1.38.0

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining

setSingleGroupFullSize(bSingleGroupFullSize): sap.ui.comp.smartform.Layout

Sets a new value for property singleGroupFullSize.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bSingleGroupFullSize New value for property singleGroupFullSize

Since:: 1.34.1

Returns:

{sap.ui.comp.smartform.Layout} Reference to this in order to allow method chaining