Class sap.ui.layout.form.FormLayoutModule: sap/ui/layout/form/FormLayout

extends Control

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.


Since: 1.16.0.
Constructor Summary
new sap.ui.layout.form.FormLayout(sId?, mSettings?)Constructor for a new sap.ui.layout.form.FormLayout.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.layout.form.FormLayout.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.layout.form.FormLayout with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.layout.form.FormLayout.getMetadata()Returns a metadata object for class sap.ui.layout.form.FormLayout.
getBackgroundDesign()Gets current value of property backgroundDesign.
setBackgroundDesign(sBackgroundDesign)Sets a new value for property backgroundDesign.
Constructor Detail
new sap.ui.layout.form.FormLayout(sId?, mSettings?)

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

The supported settings are:

  • Properties

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

Parameters:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?initial settings for the new control
Method Detail
sap.ui.layout.form.FormLayout.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.layout.form.FormLayout.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.layout.form.FormLayout.
Returns:
sap.ui.base.MetadataMetadata object describing this class
getBackgroundDesign(): sap.ui.layout.BackgroundDesign

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.

Returns:
sap.ui.layout.BackgroundDesignValue of property backgroundDesign
Since:
1.36.0
setBackgroundDesign(sBackgroundDesign): sap.ui.layout.form.FormLayout

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.

Parameters:
sap.ui.layout.BackgroundDesignsBackgroundDesignNew value for property backgroundDesign
Returns:
sap.ui.layout.form.FormLayoutReference to this in order to allow method chaining
Since:
1.36.0