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
Events borrowed from class sap.ui.base.ManagedObject
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.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
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
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
- backgroundDesign : sap.ui.layout.BackgroundDesign (default: Translucent)
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.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:
| {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.FormLayout.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.layout.form.FormLayout.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
getBackgroundDesign(): sap.ui.layout.BackgroundDesign
Gets current value of property
backgroundDesign. Specifies the background color of the Form 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 |
setBackgroundDesign(sBackgroundDesign): sap.ui.layout.form.FormLayout
Sets a new value for property
backgroundDesign. Specifies the background color of the Form 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.FormLayout} | Reference to this in order to allow method chaining |