Class sap.ui.comp.smartform.GroupModule: sap/ui/comp/smartform/Group

extends Control

Groups are used to group group elements.

Constructor Summary
new sap.ui.comp.smartform.Group(sId?, mSettings?)Constructor for a new smartform/Group.
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.comp.smartform.Group.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.smartform.Group with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.comp.smartform.Group.getMetadata()Returns a metadata object for class sap.ui.comp.smartform.Group.
addAggregation(sAggregationName, oObject)Adds some entity to the given aggregation.
addCustomData(oCustomData)Adds some CustomeData into the aggregation customData.
addGroupElement(oGroupElement)Adds some GroupElement into the aggregation groupElements
destroyGroupElements()Destroys all the group elements in the aggregation groupElements
destroyLayout()Destroys the layout in the aggregation layout.
getGroupElements()Gets content of aggregation groupElements.
getHorizontalLayoutGroupElementMinWidth()Gets current value of property horizontalLayoutGroupElementMinWidth.
getLabel()Gets current value of property label.
getLayout()Gets content of aggregation layout.
getUseHorizontalLayout()Gets current value of property useHorizontalLayout.
indexOfGroupElement(oGroupElement)Checks for the provided sap.ui.comp.smartform.GroupElement in the aggregation groupElements.
insertGroupElement(oGroupElement, iIndex)Inserts a GroupElement into the aggregation groupElements
removeAllGroupElements(the)Removes all group elements from the aggregation groupElements
removeGroupElement(vGroupElement)Removes a GroupElement from the aggregation groupElements
setAggregation(sAggregationName, oObject)Sets a new object in the named 0.
setEditMode(bEditMode)Setter for property editable of all smart fields in children hierarchy.
setHorizontalLayoutGroupElementMinWidth(iHorizontalLayoutGroupElementMinWidth)Sets a new value for property horizontalLayoutGroupElementMinWidth.
setLabel(sLabel)Sets a new value for property label.
setLayout(oLayout)Sets the aggregated layout.
setProperty(sPropertyName, oValue)Sets the given value for the given property
setUseHorizontalLayout(bUseHorizontalLayout)Sets a new value for property useHorizontalLayout.
setVisible(bVisible)Sets a new value for property visible.
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, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, 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, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
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, setAssociation, setBindingContext, setModel, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.comp.smartform.Group(sId?, mSettings?)
Constructor for a new smartform/Group.

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:

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.comp.smartform.Group.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.comp.smartform.Group 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.comp.smartform.Group.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.comp.smartform.Group.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addAggregation(sAggregationName, oObject): sap.ui.comp.smartform.Group
Adds some entity to the given aggregation.
Parameters:
{string}sAggregationName the strung identifying the aggregation that oObject should be added to.
{sap.ui.base.ManagedObject}oObject the object to add.
Returns:
{sap.ui.comp.smartform.Group}this to allow method chaining.
addCustomData(oCustomData): sap.ui.comp.smartform.Group
Adds some CustomeData into the aggregation customData. Additionally the customData is also added to the SmartFields in the children hierarchy
Parameters:
{sap.ui.core.CustomData}oCustomData the customData to add.
Returns:
{sap.ui.comp.smartform.Group}this to allow method chaining.
addGroupElement(oGroupElement): sap.ui.comp.smartform.Group
Adds some GroupElement into the aggregation groupElements
Parameters:
{sap.ui.comp.smartform.GroupElement}oGroupElement group element to add to aggregation named groupElements.
Returns:
{sap.ui.comp.smartform.Group}this to allow method chaining.
destroyGroupElements(): sap.ui.comp.smartform.Group
Destroys all the group elements in the aggregation groupElements
Returns:
{sap.ui.comp.smartform.Group}this to allow method chaining.
destroyLayout(): sap.ui.comp.smartform.Group
Destroys the layout in the aggregation layout.
Returns:
{sap.ui.comp.smartform.Group} Reference to this in order to allow method chaining
getGroupElements(): sap.ui.comp.smartform.GroupElement[]
Gets content of aggregation groupElements.

A GroupElement is a combination of one label and different controls associated to this label.

Returns:
{sap.ui.comp.smartform.GroupElement[]}
getHorizontalLayoutGroupElementMinWidth(): int
Gets current value of property horizontalLayoutGroupElementMinWidth.

Specifies the minimal size in pixels of all group elements of the form if horizontal Layout is used.

Returns:
{int} Value of property horizontalLayoutGroupElementMinWidth
getLabel(): string
Gets current value of property label.

Label for the group.

Returns:
{string} Value of property label
getLayout(): sap.ui.layout.GridData
Gets content of aggregation layout.

Layout to specify how the group shall be rendered (e.g. span and line-break)

Returns:
{sap.ui.layout.GridData}
getUseHorizontalLayout(): boolean
Gets current value of property useHorizontalLayout.

Specifies whether the groups shall be rendered in a ResponsiveLayout with label on top of the group element. Each group will be rendered in a new line.

Returns:
{boolean} Value of property useHorizontalLayout
indexOfGroupElement(oGroupElement): int
Checks for the provided sap.ui.comp.smartform.GroupElement in the aggregation groupElements. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.comp.smartform.GroupElement}oGroupElement The groupElement whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertGroupElement(oGroupElement, iIndex): sap.ui.comp.smartform.Group
Inserts a GroupElement into the aggregation groupElements
Parameters:
{sap.ui.comp.smartform.GroupElement}oGroupElement group element to insert into aggregation named groupElements.
{int}iIndex the 0-based index the GroupElement should be inserted at.
Returns:
{sap.ui.comp.smartform.Group}this to allow method chaining.
removeAllGroupElements(the): sap.ui.comp.smartform.GroupElement[]
Removes all group elements from the aggregation groupElements
Parameters:
{int|string|sap.ui.comp.smartform.GroupElement}the GroupElement to remove or its index or id.
Returns:
{sap.ui.comp.smartform.GroupElement[]} an array of the removed elements.
removeGroupElement(vGroupElement): sap.ui.comp.smartform.GroupElement
Removes a GroupElement from the aggregation groupElements
Parameters:
{int|string|sap.ui.comp.smartform.GroupElement}vGroupElement the GroupElement to remove or its index or id.
Returns:
{sap.ui.comp.smartform.GroupElement} the removed GroupElement or null.
setAggregation(sAggregationName, oObject): sap.ui.comp.smartform.Group
Sets a new object in the named 0..1 aggregation.
Parameters:
{string}sAggregationName name of an 0..1 aggregation.
{sap.ui.base.ManagedObject}oObject the managed object that is set as aggregated object.
Returns:
{sap.ui.comp.smartform.Group}this to allow method chaining.
setEditMode(bEditMode): sap.ui.comp.smartform.Group
Setter for property editable of all smart fields in children hierarchy.
Parameters:
{boolean}bEditMode new value for editable property of smart fields.
Returns:
{sap.ui.comp.smartform.Group}this to allow method chaining.
setHorizontalLayoutGroupElementMinWidth(iHorizontalLayoutGroupElementMinWidth): sap.ui.comp.smartform.Group
Sets a new value for property horizontalLayoutGroupElementMinWidth.

Specifies the minimal size in pixels of all group elements of the form if horizontal Layout is used.

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

Parameters:
{int}iHorizontalLayoutGroupElementMinWidth New value for property horizontalLayoutGroupElementMinWidth
Returns:
{sap.ui.comp.smartform.Group} Reference to this in order to allow method chaining
setLabel(sLabel): sap.ui.comp.smartform.Group
Sets a new value for property label.

Label for the group.

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

Parameters:
{string}sLabel New value for property label
Returns:
{sap.ui.comp.smartform.Group} Reference to this in order to allow method chaining
setLayout(oLayout): sap.ui.comp.smartform.Group
Sets the aggregated layout.
Parameters:
{sap.ui.layout.GridData}oLayout The layout to set
Returns:
{sap.ui.comp.smartform.Group} Reference to this in order to allow method chaining
setProperty(sPropertyName, oValue)
Sets the given value for the given property
Parameters:
{string}sPropertyName name of the property to set
{any}oValue value to set the property to
setUseHorizontalLayout(bUseHorizontalLayout): sap.ui.comp.smartform.Group
Sets a new value for property useHorizontalLayout.

Specifies whether the groups shall be rendered in a ResponsiveLayout with label on top of the group element. Each group will be rendered in a new line.

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

Parameters:
{boolean}bUseHorizontalLayout New value for property useHorizontalLayout
Returns:
{sap.ui.comp.smartform.Group} Reference to this in order to allow method chaining
setVisible(bVisible): sap.ui.comp.smartform.Group
Sets a new value for property visible. Whether the control should be visible on the screen. If set to false, a placeholder is rendered instead of the real control 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.comp.smartform.Group}this to allow method chaining.