class sap.ui.commons.form.Form

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

Form control. Holder for form control to be rendered in a specific form layout. A Form supports VariantLayoutData for it's conent to allow a simple switching of Layouts.


Constructor

Constructor for a new form/Form.

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.Form can be used.

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

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

sap.ui.commons.form.Form.getMetadata

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

getVisible

Getter for property visible. Invisible Forms are not rendered.

Default value is true

setVisible

Setter for property visible.

Default value is true

sap.ui.commons.form.Form.extend

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

sap.ui.commons.form.Form.getMetadata

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

getVisible

Getter for property visible. Invisible Forms are not rendered.

Default value is true

setVisible

Setter for property visible.

Default value is true

Param Type DefaultValue Description
bVisible boolean

new value for property visible