SimpleForm

known direct subclasses: SimpleForm

The SimpleForm provides an easy-to-use API to create simple forms. Inside a SimpleForm, a Form control is created along with its FormContainers and FormElements, but the complexity in the API is removed.

A new title starts a new group (FormContainer) in the form.
A new label starts a new row (FormElement) in the form.
All other controls will be assigned to the row (FormElement) started with the last label.

Use LayoutData to influence the layout for special cases in the Input/Display controls. Note: If a more complex form is needed, use Form instead.

Since: 1.16.0.

Constructor Summary

new sap.ui.layout.form.SimpleForm(sId?, mSettings?)Constructor for a new sap.ui.layout.form.SimpleForm.

Events borrowed from class sap.ui.core.Control

validateFieldGroup

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

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

sap.ui.layout.form.SimpleForm.getMetadata()Returns a metadata object for class sap.ui.layout.form.SimpleForm.

addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.

addContent(oContent)Adds some content to the aggregation content.

destroyContent()Destroys all the content in the aggregation content.

destroyTitle()Destroys the title in the aggregation title.

destroyToolbar()Destroys the toolbar in the aggregation toolbar.

getAdjustLabelSpan()Gets current value of property adjustLabelSpan.

getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.

getBackgroundDesign()Gets current value of property backgroundDesign.

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.

getContent()Gets content of aggregation content.

getEditable()Gets current value of property editable.

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.

getLabelMinWidth()Gets current value of property labelMinWidth.

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.

getLayout()Gets current value of property layout.

getMaxContainerCols()Gets current value of property maxContainerCols.

getMinWidth()Gets current value of property minWidth.

getSingleContainerFullSize()Gets current value of property singleContainerFullSize.

getTitle()Gets content of aggregation title.

getToolbar()Gets content of aggregation toolbar.

getWidth()Gets current value of property width.

indexOfContent(oContent)Checks for the provided sap.ui.core.Element in the aggregation content.

insertContent(oContent, iIndex)Inserts a content into the aggregation content.

removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.

removeAllContent()Removes all the controls from the aggregation content.

removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.

removeContent(vContent)Removes a content from the aggregation content.

setAdjustLabelSpan(bAdjustLabelSpan)Sets a new value for property adjustLabelSpan.

setBackgroundDesign(sBackgroundDesign)Sets a new value for property backgroundDesign.

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.

setEditable(bEditable)Sets a new value for property editable.

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.

setLabelMinWidth(iLabelMinWidth)Sets a new value for property labelMinWidth.

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.

setLayout(sLayout)Sets a new value for property layout.

setMaxContainerCols(iMaxContainerCols)Sets a new value for property maxContainerCols.

setMinWidth(iMinWidth)Sets a new value for property minWidth.

setSingleContainerFullSize(bSingleContainerFullSize)Sets a new value for property singleContainerFullSize.

setTitle(vTitle)Sets the aggregated title.

setToolbar(oToolbar)Sets the aggregated toolbar.

setWidth(sWidth)Sets a new value for property width.

Methods borrowed from class sap.ui.core.Control

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, 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.layout.form.SimpleForm(sId?, mSettings?)

Constructor for a new sap.ui.layout.form.SimpleForm.

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
- maxContainerCols : int (default: 2)
- minWidth : int (default: -1)
- width : sap.ui.core.CSSSize
- editable : boolean
- labelMinWidth : int (default: 192)
- layout : sap.ui.layout.form.SimpleFormLayout (default: ResponsiveLayout)
- labelSpanXL : int (default: -1)
- labelSpanL : int (default: 4)
- labelSpanM : int (default: 2)
- labelSpanS : int (default: 12)
- adjustLabelSpan : boolean (default: true)
- emptySpanXL : int (default: -1)
- emptySpanL : int (default: 0)
- emptySpanM : int (default: 0)
- emptySpanS : int (default: 0)
- columnsXL : int (default: -1)
- columnsL : int (default: 2)
- columnsM : int (default: 1)
- singleContainerFullSize : boolean (default: true)
- breakpointXL : int (default: 1440)
- breakpointL : int (default: 1024)
- breakpointM : int (default: 600)
- backgroundDesign : sap.ui.layout.BackgroundDesign (default: Translucent)
Aggregations
- content : sap.ui.core.Element[] (default)
- title : sap.ui.core.Title|string
- toolbar : sap.ui.core.Toolbar

In addition, all settings applicable to the base type sap.ui.core.Control 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.layout.form.SimpleForm.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.layout.form.SimpleForm 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.Control.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.layout.form.SimpleForm.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.ui.layout.form.SimpleForm.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addAriaLabelledBy(vAriaLabelledBy): sap.ui.layout.form.SimpleForm

Adds some ariaLabelledBy into the association ariaLabelledBy.

Parameters:

{string|sap.ui.core.Control}

vAriaLabelledBy

the ariaLabelledBy to add; if empty, nothing is inserted

Since:: 1.32.0

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

addContent(oContent): sap.ui.layout.form.SimpleForm

Adds some content to the aggregation content.

Parameters:

{sap.ui.core.Element}

oContent

the content to add; if empty, nothing is inserted

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

destroyContent(): sap.ui.layout.form.SimpleForm

Destroys all the content in the aggregation content.

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

destroyTitle(): sap.ui.layout.form.SimpleForm

Destroys the title in the aggregation title.

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

destroyToolbar(): sap.ui.layout.form.SimpleForm

Destroys the toolbar in the aggregation toolbar.

Since:: 1.36.0

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

getAdjustLabelSpan(): boolean

Gets current value of property adjustLabelSpan.

If set, the usage of labelSpanL and labelSpanM are dependent on the number of FormContainers in one row. If only one FormContainer is displayed in one row, labelSpanM is used to define the size of the label. This is the same for medium and large Forms. This is done to align the labels on forms where full-size FormContainers and multiple-column rows are used in the same Form (because every FormContainer has its own grid inside).

If not set, the usage of labelSpanL and labelSpanM are dependent on the Form size. The number of FormContainers doesn't matter in this case.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is true.

Since:: 1.34.0

Returns:

{boolean} Value of property adjustLabelSpan

getAriaLabelledBy(): sap.ui.core.Control[]

Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.

Since:: 1.32.0

Returns:

{sap.ui.core.Control[]}

getBackgroundDesign(): sap.ui.layout.BackgroundDesign

Gets current value of property backgroundDesign.

Specifies the background color of the SimpleForm content.

The visualization of the different options depends on the used theme.

Default value is Translucent.

Since:: 1.36.0

Returns:

{sap.ui.layout.BackgroundDesign} Value of property backgroundDesign

getBreakpointL(): int

Gets current value of property breakpointL.

Breakpoint between Medium size and Large size.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is 1024.

Since:: 1.16.3

Returns:

{int} Value of property breakpointL

getBreakpointM(): int

Gets current value of property breakpointM.

Breakpoint between Small size and Medium size.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is 600.

Since:: 1.16.3

Returns:

{int} Value of property breakpointM

getBreakpointXL(): int

Gets current value of property breakpointXL.

Breakpoint between Medium size and Large size.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is 1440.

Since:: 1.34.0

Returns:

{int} Value of property breakpointXL

getColumnsL(): int

Gets current value of property columnsL.

Form columns for large size. The number of columns for large size must not be smaller than the number of columns for medium size.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is 2.

Since:: 1.16.3

Returns:

{int} Value of property columnsL

getColumnsM(): int

Gets current value of property columnsM.

Form columns for medium size.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is 1.

Since:: 1.16.3

Returns:

{int} Value of property columnsM

getColumnsXL(): int

Gets current value of property columnsXL.

Form 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.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.If the default value -1 is not overwritten with the meaningful one then the columnsL value is used (from the backward compatibility reasons).

Default value is -1.

Since:: 1.34.0

Returns:

{int} Value of property columnsXL

getContent(): sap.ui.core.Element[]

Gets content of aggregation content.

The content of the form is structured in the following way:

Add a Title or Toolbar control to start a new group (FormContainer).
Add a Label control to start a new row (FormElement).
Add controls as input fields, text fields or other as needed.
Use LayoutData to influence the layout for special cases in the single controls. For example, if a ResponsiveLayout is used as a layout, the form content is weighted using weight 3 for the labels and weight 5 for the fields part. By default the label column is 192 pixels wide. If your input controls should influence their width, you can add sap.ui.layout.ResponsiveFlowLayoutData to them via setLayoutData method. Ensure that the sum of the weights in the ResponsiveFlowLayoutData is not more than 5, as this is the total width of the input control part of each form row.

Example for a row where the TextField takes 4 and the TextView takes 1 weight (using ResponsiveLayout):

new sap.ui.commons.Label({text:"Label"});
new sap.ui.commons.TextField({value:"Weight 4",
layoutData:new sap.ui.layout.ResponsiveFlowLayoutData({weight:4})}),
new sap.ui.commons.TextView({text:"Weight 1",
layoutData: new sap.ui.layout.ResponsiveFlowLayoutData({weight:1})}),

Note: Do not put any layout controls in here. This could destroy the visual layout, keyboard support and screen-reader support.

Returns:

{sap.ui.core.Element[]}

getEditable(): boolean

Gets current value of property editable.

Applies a device-specific and theme-specific line-height to the form rows if the form has editable content. If set, all (not only the editable) rows of the form will get the line height of editable fields. The accessibility aria-readonly attribute is set according to this property. Note: The setting of the property has no influence on the editable functionality of the form's content.

Returns:

{boolean} Value of property editable

getEmptySpanL(): int

Gets current value of property emptySpanL.

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

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is 0.

Since:: 1.16.3

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.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is 0.

Since:: 1.16.3

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.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is 0.

Since:: 1.16.3

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.

Note: This property is only used if a ResponsiveGridLayout is used as a layout. If the default value -1 is not overwritten with the meaningful one then the emptySpanL value is used (from the backward compatibility reasons).

Default value is -1.

Since:: 1.34.0

Returns:

{int} Value of property emptySpanXL

getLabelMinWidth(): int

Gets current value of property labelMinWidth.

Specifies the min-width in pixels of the label in all form containers. Note: This property is only used if a ResponsiveLayout is used as a layout.

Default value is 192.

Returns:

{int} Value of property labelMinWidth

getLabelSpanL(): int

Gets current value of property labelSpanL.

Default span for labels in large size.

Note: If adjustLabelSpanThis is set, this property is only used if more than 1 FormContainer is in one line. If only 1 FormContainer is in the line, then the labelSpanM value is used.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is 4.

Since:: 1.16.3

Returns:

{int} Value of property labelSpanL

getLabelSpanM(): int

Gets current value of property labelSpanM.

Default span for labels in medium size.

Note: If adjustLabelSpanThis is set, this property is used for full-size FormContainers. If more than one FormContainer is in one line, labelSpanL is used.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is 2.

Since:: 1.16.3

Returns:

{int} Value of property labelSpanM

getLabelSpanS(): int

Gets current value of property labelSpanS.

Default span for labels in small size. Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is 12.

Since:: 1.16.3

Returns:

{int} Value of property labelSpanS

getLabelSpanXL(): int

Gets current value of property labelSpanXL.

Default span for labels in extra large size.

Note: This property is only used if a ResponsiveGridLayout is used as a layout. If the default value -1 is not overwritten with the meaningful one then the labelSpanL value is used (from the backward compatibility reasons).

Default value is -1.

Since:: 1.34.0

Returns:

{int} Value of property labelSpanXL

getLayout(): sap.ui.layout.form.SimpleFormLayout

Gets current value of property layout.

The FormLayout that is used to render the SimpleForm. We suggest using the ResponsiveGridLayout for rendering a SimpleForm, as its responsiveness uses the space available in the best way possible.

Default value is ResponsiveLayout.

Returns:

{sap.ui.layout.form.SimpleFormLayout} Value of property layout

getMaxContainerCols(): int

Gets current value of property maxContainerCols.

The maximum amount of groups (FormContainers) per row that is used before a new row is started. Note: If a ResponsiveGridLayout is used as a layout, this property is not used. Please use the properties ColumnsL and ColumnsM in this case.

Default value is 2.

Returns:

{int} Value of property maxContainerCols

getMinWidth(): int

Gets current value of property minWidth.

The overall minimum width in pixels that is used for the SimpleForm. If the available width is below the given minWidth the SimpleForm will create a new row for the next group (FormContainer). The default value is -1, meaning that inner groups (FormContainers) will be stacked until maxCols is reached, irrespective of whether a maxWidth is reached or the available parents width is reached. Note: This property is only used if a ResponsiveLayout is used as a layout.

Default value is -1.

Returns:

{int} Value of property minWidth

getSingleContainerFullSize(): boolean

Gets current value of property singleContainerFullSize.

If the Form contains only one single FormContainer and this property is set, the FormContainer is displayed using the full size of the Form. In this case the properties columnsL and columnsM are ignored.

In all other cases the FormContainer is displayed in the size of one column.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

Default value is true.

Since:: 1.34.0

Returns:

{boolean} Value of property singleContainerFullSize

getTitle(): sap.ui.core.Title|string

Gets content of aggregation title.

Title element of the SimpleForm. Can either be a Title control, or a string.

Since:: 1.16.3

Returns:

{sap.ui.core.Title|string}

getToolbar(): sap.ui.core.Toolbar

Gets content of aggregation toolbar.

Toolbar of the SimpleForm.

Note: If a Toolbar is used, the Title is ignored. If a title is needed inside the Toolbar it must be added at content to the Toolbar. In this case add the Title to the ariaLabelledBy association.

Since:: 1.36.0

Returns:

{sap.ui.core.Toolbar}

getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Width of the form.

Since:: 1.28.0

Returns:

{sap.ui.core.CSSSize} Value of property width

indexOfContent(oContent): int

Checks for the provided sap.ui.core.Element in the aggregation content. and returns its index if found or -1 otherwise.

Parameters:

{sap.ui.core.Element}

oContent

The content whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

insertContent(oContent, iIndex): sap.ui.layout.form.SimpleForm

Inserts a content into the aggregation content.

Parameters:

{sap.ui.core.Element}	oContent	the content to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

removeAllAriaLabelledBy(): sap.ui.core.Control[]

Removes all the controls in the association named ariaLabelledBy.

Since:: 1.32.0

Returns:

{sap.ui.core.Control[]}

An array of the removed elements (might be empty)

removeAllContent(): sap.ui.core.Element[]

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.ui.core.Element[]}

An array of the removed elements (might be empty)

removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.Control

Removes an ariaLabelledBy from the association named ariaLabelledBy.

Parameters:

{int|string|sap.ui.core.Control}

vAriaLabelledBy

The ariaLabelledByto be removed or its index or ID

Since:: 1.32.0

Returns:

{sap.ui.core.Control} the removed ariaLabelledBy or null

removeContent(vContent): sap.ui.core.Element

Removes a content from the aggregation content.

Parameters:

{int|string|sap.ui.core.Element}

vContent

The contentto remove or its index or id

Returns:

{sap.ui.core.Element} The removed content or null

setAdjustLabelSpan(bAdjustLabelSpan): sap.ui.layout.form.SimpleForm

Sets a new value for property adjustLabelSpan.

If not set, the usage of labelSpanL and labelSpanM are dependent on the Form size. The number of FormContainers doesn't matter in this case.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is true.

Parameters:

{boolean} bAdjustLabelSpan New value for property adjustLabelSpan

Since:: 1.34.0

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setBackgroundDesign(sBackgroundDesign): sap.ui.layout.form.SimpleForm

Sets a new value for property backgroundDesign.

Specifies the background color of the SimpleForm content.

The visualization of the different options depends on the used theme.

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

Default value is Translucent.

Parameters:

{sap.ui.layout.BackgroundDesign} sBackgroundDesign New value for property backgroundDesign

Since:: 1.36.0

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setBreakpointL(iBreakpointL): sap.ui.layout.form.SimpleForm

Sets a new value for property breakpointL.

Breakpoint between Medium size and Large size.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is 1024.

Parameters:

{int} iBreakpointL New value for property breakpointL

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setBreakpointM(iBreakpointM): sap.ui.layout.form.SimpleForm

Sets a new value for property breakpointM.

Breakpoint between Small size and Medium size.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is 600.

Parameters:

{int} iBreakpointM New value for property breakpointM

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setBreakpointXL(iBreakpointXL): sap.ui.layout.form.SimpleForm

Sets a new value for property breakpointXL.

Breakpoint between Medium size and Large size.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is 1440.

Parameters:

{int} iBreakpointXL New value for property breakpointXL

Since:: 1.34.0

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setColumnsL(iColumnsL): sap.ui.layout.form.SimpleForm

Sets a new value for property columnsL.

Form columns for large size. The number of columns for large size must not be smaller than the number of columns for medium size.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is 2.

Parameters:

{int} iColumnsL New value for property columnsL

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setColumnsM(iColumnsM): sap.ui.layout.form.SimpleForm

Sets a new value for property columnsM.

Form columns for medium size.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is 1.

Parameters:

{int} iColumnsM New value for property columnsM

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setColumnsXL(iColumnsXL): sap.ui.layout.form.SimpleForm

Sets a new value for property columnsXL.

Form 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 -1.

Parameters:

{int} iColumnsXL New value for property columnsXL

Since:: 1.34.0

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setEditable(bEditable): sap.ui.layout.form.SimpleForm

Sets a new value for property editable.

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

Parameters:

{boolean} bEditable New value for property editable

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setEmptySpanL(iEmptySpanL): sap.ui.layout.form.SimpleForm

Sets a new value for property emptySpanL.

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

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is 0.

Parameters:

{int} iEmptySpanL New value for property emptySpanL

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setEmptySpanM(iEmptySpanM): sap.ui.layout.form.SimpleForm

Sets a new value for property emptySpanM.

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

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is 0.

Parameters:

{int} iEmptySpanM New value for property emptySpanM

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setEmptySpanS(iEmptySpanS): sap.ui.layout.form.SimpleForm

Sets a new value for property emptySpanS.

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

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is 0.

Parameters:

{int} iEmptySpanS New value for property emptySpanS

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setEmptySpanXL(iEmptySpanXL): sap.ui.layout.form.SimpleForm

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.

Default value is -1.

Parameters:

{int} iEmptySpanXL New value for property emptySpanXL

Since:: 1.34.0

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setLabelMinWidth(iLabelMinWidth): sap.ui.layout.form.SimpleForm

Sets a new value for property labelMinWidth.

Specifies the min-width in pixels of the label in all form containers. Note: This property is only used if a ResponsiveLayout is used as a layout.

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

Default value is 192.

Parameters:

{int} iLabelMinWidth New value for property labelMinWidth

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setLabelSpanL(iLabelSpanL): sap.ui.layout.form.SimpleForm

Sets a new value for property labelSpanL.

Default span for labels in large size.

Note: If adjustLabelSpanThis is set, this property is only used if more than 1 FormContainer is in one line. If only 1 FormContainer is in the line, then the labelSpanM value is used.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is 4.

Parameters:

{int} iLabelSpanL New value for property labelSpanL

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setLabelSpanM(iLabelSpanM): sap.ui.layout.form.SimpleForm

Sets a new value for property labelSpanM.

Default span for labels in medium size.

Note: If adjustLabelSpanThis is set, this property is used for full-size FormContainers. If more than one FormContainer is in one line, labelSpanL is used.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is 2.

Parameters:

{int} iLabelSpanM New value for property labelSpanM

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setLabelSpanS(iLabelSpanS): sap.ui.layout.form.SimpleForm

Sets a new value for property labelSpanS.

Default span for labels in small size. Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is 12.

Parameters:

{int} iLabelSpanS New value for property labelSpanS

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setLabelSpanXL(iLabelSpanXL): sap.ui.layout.form.SimpleForm

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.

Default value is -1.

Parameters:

{int} iLabelSpanXL New value for property labelSpanXL

Since:: 1.34.0

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setLayout(sLayout): sap.ui.layout.form.SimpleForm

Sets a new value for property layout.

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

Default value is ResponsiveLayout.

Parameters:

{sap.ui.layout.form.SimpleFormLayout} sLayout New value for property layout

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setMaxContainerCols(iMaxContainerCols): sap.ui.layout.form.SimpleForm

Sets a new value for property maxContainerCols.

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

Default value is 2.

Parameters:

{int} iMaxContainerCols New value for property maxContainerCols

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setMinWidth(iMinWidth): sap.ui.layout.form.SimpleForm

Sets a new value for property minWidth.

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

Default value is -1.

Parameters:

{int} iMinWidth New value for property minWidth

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setSingleContainerFullSize(bSingleContainerFullSize): sap.ui.layout.form.SimpleForm

Sets a new value for property singleContainerFullSize.

In all other cases the FormContainer is displayed in the size of one column.

Note: This property is only used if a ResponsiveGridLayout is used as a layout.

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

Default value is true.

Parameters:

{boolean} bSingleContainerFullSize New value for property singleContainerFullSize

Since:: 1.34.0

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setTitle(vTitle): sap.ui.layout.form.SimpleForm

Sets the aggregated title.

Parameters:

{sap.ui.core.Title|string}

vTitle

The title to set

Since:: 1.16.3

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setToolbar(oToolbar): sap.ui.layout.form.SimpleForm

Sets the aggregated toolbar.

Parameters:

{sap.ui.core.Toolbar}

oToolbar

The toolbar to set

Since:: 1.36.0

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining

setWidth(sWidth): sap.ui.layout.form.SimpleForm

Sets a new value for property width.

Width of the form.

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

Parameters:

{sap.ui.core.CSSSize} sWidth New value for property width

Since:: 1.28.0

Returns:

{sap.ui.layout.form.SimpleForm} Reference to this in order to allow method chaining