class sap.ui.layout.form.FormLayout

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/layout/form/FormLayout
Application Component: CA-UI5-CMP

Base layout to render a Form. Other layouts to render a Form must inherit from this one.

Note: This control must not be used to render a Form in productive applications as it does not fulfill any design guidelines and usability standards.


Constructor

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

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.layout.form.FormLayout(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


Properties

Name Type Default Value Description
backgroundDesign sap.ui.layout.BackgroundDesign Translucent

Specifies the background color of the Form content.

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

Since: 1.36.0.

Visibility: public

Methods Overview

Method Description
sap.ui.layout.form.FormLayout.extend

Creates a new subclass of class sap.ui.layout.form.FormLayout 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.

getBackgroundDesign

Gets current value of property backgroundDesign.

Specifies the background color of the Form content.

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

Default value is Translucent.

sap.ui.layout.form.FormLayout.getMetadata

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

setBackgroundDesign

Sets a new value for property backgroundDesign.

Specifies the background color of the Form content.

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

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

Default value is Translucent.

sap.ui.layout.form.FormLayout.extend

Creates a new subclass of class sap.ui.layout.form.FormLayout 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.

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

getBackgroundDesign

Gets current value of property backgroundDesign.

Specifies the background color of the Form content.

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

Default value is Translucent.

sap.ui.layout.form.FormLayout.getMetadata

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

setBackgroundDesign

Sets a new value for property backgroundDesign.

Specifies the background color of the Form content.

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

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

Default value is Translucent.

Param Type DefaultValue Description
sBackgroundDesign sap.ui.layout.BackgroundDesign Translucent

New value for property backgroundDesign