Class sap.m.QuickViewGroupModule: sap/m/QuickViewGroup

extends Element

QuickViewGroup consists of a title (optional) and an entity of group elements.


Since: 1.28.11.
Constructor Summary
new sap.m.QuickViewGroup(sId?, mSettings?)Constructor for a new QuickViewGroup.
Method Summary
sap.m.QuickViewGroup.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.QuickViewGroup with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.QuickViewGroup.getMetadata()Returns a metadata object for class sap.m.QuickViewGroup.
addElement(oElement)Adds some element to the aggregation elements.
bindElements(oBindingInfo)Binds aggregation elements to model data.
destroyElements()Destroys all the elements in the aggregation elements.
getElements()Gets content of aggregation elements.
getHeading()Gets current value of property heading.
getVisible()Gets current value of property visible.
indexOfElement(oElement)Checks for the provided sap.m.QuickViewGroupElement in the aggregation elements.
insertElement(oElement, iIndex)Inserts a element into the aggregation elements.
removeAllElements()Removes all the controls from the aggregation elements.
removeElement(vElement)Removes a element from the aggregation elements.
setHeading(sHeading)Sets a new value for property heading.
setVisible(bVisible)Sets a new value for property visible.
unbindElements()Unbinds aggregation elements from model data.
Constructor Detail
new sap.m.QuickViewGroup(sId?, mSettings?)
Constructor for a new QuickViewGroup.

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
    • elements : sap.m.QuickViewGroupElement[] (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.m.QuickViewGroup.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.QuickViewGroup 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.m.QuickViewGroup.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.QuickViewGroup.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addElement(oElement): sap.m.QuickViewGroup
Adds some element to the aggregation elements.
Parameters:
{sap.m.QuickViewGroupElement}oElement the element to add; if empty, nothing is inserted
Returns:
{sap.m.QuickViewGroup} Reference to this in order to allow method chaining
bindElements(oBindingInfo): sap.m.QuickViewGroup
Binds aggregation elements to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Parameters:
{object}oBindingInfo The binding information
Returns:
{sap.m.QuickViewGroup} Reference to this in order to allow method chaining
destroyElements(): sap.m.QuickViewGroup
Destroys all the elements in the aggregation elements.
Returns:
{sap.m.QuickViewGroup} Reference to this in order to allow method chaining
getElements(): sap.m.QuickViewGroupElement[]
Gets content of aggregation elements.

A combination of one label and another control (Link or Text) associated to this label.

Returns:
{sap.m.QuickViewGroupElement[]}
getHeading(): string
Gets current value of property heading.

The title of the group

Default value is .

Returns:
{string} Value of property heading
getVisible(): boolean
Gets current value of property visible.

Determines whether the group is visible on the screen.

Default value is true.

Returns:
{boolean} Value of property visible
indexOfElement(oElement): int
Checks for the provided sap.m.QuickViewGroupElement in the aggregation elements. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.QuickViewGroupElement}oElement The element whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertElement(oElement, iIndex): sap.m.QuickViewGroup
Inserts a element into the aggregation elements.
Parameters:
{sap.m.QuickViewGroupElement}oElement the element to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the element should be inserted at; for a negative value of iIndex, the element is inserted at position 0; for a value greater than the current size of the aggregation, the element is inserted at the last position
Returns:
{sap.m.QuickViewGroup} Reference to this in order to allow method chaining
removeAllElements(): sap.m.QuickViewGroupElement[]
Removes all the controls from the aggregation elements.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.m.QuickViewGroupElement[]} An array of the removed elements (might be empty)
removeElement(vElement): sap.m.QuickViewGroupElement
Removes a element from the aggregation elements.
Parameters:
{int|string|sap.m.QuickViewGroupElement}vElement The elementto remove or its index or id
Returns:
{sap.m.QuickViewGroupElement} The removed element or null
setHeading(sHeading): sap.m.QuickViewGroup
Sets a new value for property heading.

The title of the group

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

Default value is .

Parameters:
{string}sHeading New value for property heading
Returns:
{sap.m.QuickViewGroup} Reference to this in order to allow method chaining
setVisible(bVisible): sap.m.QuickViewGroup
Sets a new value for property visible.

Determines whether the group is visible on the screen.

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.m.QuickViewGroup} Reference to this in order to allow method chaining
unbindElements(): sap.m.QuickViewGroup
Unbinds aggregation elements from model data.
Returns:
{sap.m.QuickViewGroup} Reference to this in order to allow method chaining