class sap.ui.commons.form.SimpleForm

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/commons/form/SimpleForm
Application Component: CA-UI5-CTR

Use the SimpleForm to create a form based on title, label and fields that are stacked in the content aggregation. Add Title to start a new FormContainer(Group). Add Label to start a new row in the container. Add Input/Display controls as needed. Use LayoutData to influence the layout for special cases in the Input/Display controls.


Constructor

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

This class does not have its own settings, but all settings applicable to the base type sap.ui.layout.form.SimpleForm can be used.

new sap.ui.commons.form.SimpleForm(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


Methods Overview

Method Description
sap.ui.commons.form.SimpleForm.extend

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

getLayout

Getter for property layout. The FormLayout that is used to render the SimpleForm

Default value is ResponsiveLayout

sap.ui.commons.form.SimpleForm.getMetadata

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

setLayout

Setter for property layout.

Default value is ResponsiveLayout

sap.ui.commons.form.SimpleForm.extend

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

getLayout

Getter for property layout. The FormLayout that is used to render the SimpleForm

Default value is ResponsiveLayout

sap.ui.commons.form.SimpleForm.getMetadata

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

setLayout

Setter for property layout.

Default value is ResponsiveLayout

Param Type DefaultValue Description
oLayout sap.ui.commons.form.SimpleFormLayout

new value for property layout