Class sap.ui.commons.form.FormModule: sap/ui/commons/form/Form

extends Form

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.

Deprecated API:Since version 1.16.0. moved to sap.ui.layout library. Please use this one.


Since: 1.9.1.
Constructor Summary
new sap.ui.commons.form.Form(sId?, mSettings?)Constructor for a new form/Form.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.commons.form.Form.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.form.Form with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.form.Form.getMetadata()Returns a metadata object for class sap.ui.commons.form.Form.
getVisible()Getter for property visible.
setVisible(bVisible)Setter for property visible.
Methods borrowed from class sap.ui.layout.form.Form
addAriaLabelledBy, addFormContainer, destroyFormContainers, destroyLayout, destroyTitle, destroyToolbar, getAriaLabelledBy, getEditable, getFormContainers, getLayout, getTitle, getToolbar, getWidth, indexOfFormContainer, insertFormContainer, removeAllAriaLabelledBy, removeAllFormContainers, removeAriaLabelledBy, removeFormContainer, setEditable, setLayout, setTitle, setToolbar, setWidth
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, 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
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.commons.form.Form(sId?, mSettings?)
Constructor for a new form/Form.
Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Deprecated:
Since version 1.16.0. moved to sap.ui.layout library. Please use this one.
Method Detail
sap.ui.commons.form.Form.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

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.commons.form.Form.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.form.Form.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getVisible(): boolean
Getter for property visible. Invisible Forms are not rendered.

Default value is true

Since:
1.12.0
Returns:
{boolean} the value of property visible
setVisible(bVisible): sap.ui.commons.form.Form
Setter for property visible.

Default value is true

Parameters:
{boolean}bVisible new value for property visible
Since:
1.12.0
Returns:
{sap.ui.commons.form.Form}this to allow method chaining