Class sap.ui.layout.form.FormElementModule: sap/ui/layout/form/FormElement

extends Element
known direct subclasses: FormElement

A FormElement represents a row in a FormContainer. A FormElement is a combination of one label and different controls associated to this label.


Since: 1.16.0.
Constructor Summary
new sap.ui.layout.form.FormElement(sId?, mSettings?)Constructor for a new sap.ui.layout.form.FormElement.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.layout.form.FormElement.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.layout.form.FormElement with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.layout.form.FormElement.getMetadata()Returns a metadata object for class sap.ui.layout.form.FormElement.
addField(oField)Adds some field to the aggregation fields.
destroyFields()Destroys all the fields in the aggregation fields.
destroyLabel()Destroys the label in the aggregation label.
getFields()Gets content of aggregation fields.
getLabel()Gets content of aggregation label.
getLabelControl()Returns the Label of the FormElement, even if the Label is assigned as string.
getVisible()Gets current value of property visible.
indexOfField(oField)Checks for the provided sap.ui.core.Control in the aggregation fields.
insertField(oField, iIndex)Inserts a field into the aggregation fields.
removeAllFields()Removes all the controls from the aggregation fields.
removeField(vField)Removes a field from the aggregation fields.
setLabel(vLabel)Sets the aggregated label.
setVisible(bVisible)Sets a new value for property visible.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, 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, rerender, 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, invalidate, 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.layout.form.FormElement(sId?, mSettings?)
Constructor for a new sap.ui.layout.form.FormElement.

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
  • Aggregations
    • label : sap.ui.core.Label|string
    • fields : sap.ui.core.Control[] (default)

In addition, all settings applicable to the base type sap.ui.core.Element 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.FormElement.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.layout.form.FormElement 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.Element.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.FormElement.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.layout.form.FormElement.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addField(oField): sap.ui.layout.form.FormElement
Adds some field to the aggregation fields.
Parameters:
{sap.ui.core.Control}oField the field to add; if empty, nothing is inserted
Returns:
{sap.ui.layout.form.FormElement} Reference to this in order to allow method chaining
destroyFields(): sap.ui.layout.form.FormElement
Destroys all the fields in the aggregation fields.
Returns:
{sap.ui.layout.form.FormElement} Reference to this in order to allow method chaining
destroyLabel(): sap.ui.layout.form.FormElement
Destroys the label in the aggregation label.
Returns:
{sap.ui.layout.form.FormElement} Reference to this in order to allow method chaining
getFields(): sap.ui.core.Control[]
Gets content of aggregation fields.

Formular controls that belong together to be displayed in one row of a Form.

Note: Do not put any layout controls in here. This could destroy the visual layout, keyboard support and screen-reader support.

Returns:
{sap.ui.core.Control[]}
getLabel(): sap.ui.core.Label|string
Gets content of aggregation label.

Label of the fields. Can either be a Label object, or a string. If a Label object is used, the properties of the Label can be set. If no assignment between Label and the fields is set, it will be done automatically by the FormElement. In this case the Label is assigned to the fields of the FormElement.

Returns:
{sap.ui.core.Label|string}
getLabelControl(): sap.ui.core.Label
Returns the Label of the FormElement, even if the Label is assigned as string. The FormLayout needs the information of the label to render the Form.
Returns:
{sap.ui.core.Label}Label control used to render the label
getVisible(): boolean
Gets current value of property visible.

If set to false, the FormElement is not rendered.

Default value is true.

Returns:
{boolean} Value of property visible
indexOfField(oField): int
Checks for the provided sap.ui.core.Control in the aggregation fields. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oField The field whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertField(oField, iIndex): sap.ui.layout.form.FormElement
Inserts a field into the aggregation fields.
Parameters:
{sap.ui.core.Control}oField the field to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the field should be inserted at; for a negative value of iIndex, the field is inserted at position 0; for a value greater than the current size of the aggregation, the field is inserted at the last position
Returns:
{sap.ui.layout.form.FormElement} Reference to this in order to allow method chaining
removeAllFields(): sap.ui.core.Control[]
Removes all the controls from the aggregation fields.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeField(vField): sap.ui.core.Control
Removes a field from the aggregation fields.
Parameters:
{int|string|sap.ui.core.Control}vField The fieldto remove or its index or id
Returns:
{sap.ui.core.Control} The removed field or null
setLabel(vLabel): sap.ui.layout.form.FormElement
Sets the aggregated label.
Parameters:
{sap.ui.core.Label|string}vLabel The label to set
Returns:
{sap.ui.layout.form.FormElement} Reference to this in order to allow method chaining
setVisible(bVisible): sap.ui.layout.form.FormElement
Sets a new value for property visible.

If set to false, the FormElement is not rendered.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bVisible New value for property visible
Returns:
{sap.ui.layout.form.FormElement} Reference to this in order to allow method chaining