Class sap.m.P13nGroupPanelModule: sap/m/P13nGroupPanel

extends P13nPanel

The P13nGroupPanel control is used to define group-specific settings for table personalization.

Constructor Summary
new sap.m.P13nGroupPanel(sId?, mSettings?)Constructor for a new P13nGroupPanel.
Event Summary
addGroupItem(oControlEvent)Event raised if a GroupItem has been added.
removeGroupItem(oControlEvent)Removes a group item.
updateGroupItem(oControlEvent)Updates a group item.
Events borrowed from class sap.m.P13nPanel
beforeNavigationTo
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.m.P13nGroupPanel.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.P13nGroupPanel with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.P13nGroupPanel.getMetadata()Returns a metadata object for class sap.m.P13nGroupPanel.
addGroupItem(oGroupItem)Adds some groupItem to the aggregation groupItems.
attachAddGroupItem(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the addGroupItem event of this sap.m.P13nGroupPanel.
attachRemoveGroupItem(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the removeGroupItem event of this sap.m.P13nGroupPanel.
attachUpdateGroupItem(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the updateGroupItem event of this sap.m.P13nGroupPanel.
bindGroupItems(oBindingInfo)Binds aggregation groupItems to model data.
destroyGroupItems()Destroys all the groupItems in the aggregation groupItems.
detachAddGroupItem(fnFunction, oListener)Detaches event handler fnFunction from the addGroupItem event of this sap.m.P13nGroupPanel.
detachRemoveGroupItem(fnFunction, oListener)Detaches event handler fnFunction from the removeGroupItem event of this sap.m.P13nGroupPanel.
detachUpdateGroupItem(fnFunction, oListener)Detaches event handler fnFunction from the updateGroupItem event of this sap.m.P13nGroupPanel.
fireAddGroupItem(mArguments?)Fires event addGroupItem to attached listeners.
fireRemoveGroupItem(mArguments?)Fires event removeGroupItem to attached listeners.
fireUpdateGroupItem(mArguments?)Fires event updateGroupItem to attached listeners.
getContainerQuery()Gets current value of property containerQuery.
getGroupItems()Gets content of aggregation groupItems.
getLayoutMode()Gets current value of property layoutMode.
getMaxGroups()Gets current value of property maxGroups.
indexOfGroupItem(oGroupItem)Checks for the provided sap.m.P13nGroupItem in the aggregation groupItems.
insertGroupItem(oGroupItem, iIndex)Inserts a groupItem into the aggregation groupItems.
removeAllGroupItems()Removes all the controls from the aggregation groupItems.
removeGroupItem(vGroupItem)Removes a groupItem from the aggregation groupItems.
removeInvalidConditions()Removes all invalid group conditions.
removeValidationErrors()Removes all errors/warning states from of all group conditions.
setContainerQuery(bContainerQuery)Sets a new value for property containerQuery.
setLayoutMode(sLayoutMode)Sets a new value for property layoutMode.
setMaxGroups(sMaxGroups)Sets a new value for property maxGroups.
setOperations(array)Setter for the supported operations array.
unbindGroupItems()Unbinds aggregation groupItems from model data.
validateConditions()Checks if the entered or modified conditions are correct, marks invalid fields yellow (Warning) and opens a popup message dialog to let the user know that some values are not correct or missing.
Methods borrowed from class sap.m.P13nPanel
addItem, attachBeforeNavigationTo, beforeNavigationTo, bindItems, destroyItems, detachBeforeNavigationTo, fireBeforeNavigationTo, getChangeNotifier, getItems, getOkPayload, getResetPayload, getTitle, getTitleLarge, getType, getValidationExecutor, getValidationListener, getVerticalScrolling, indexOfItem, insertItem, onAfterNavigationFrom, onBeforeNavigationFrom, removeAllItems, removeItem, setChangeNotifier, setTitle, setTitleLarge, setType, setValidationExecutor, setValidationListener, setVerticalScrolling, unbindItems
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, 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.m.P13nGroupPanel(sId?, mSettings?)
Constructor for a new P13nGroupPanel.

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
  • Events
    • addGroupItem : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • removeGroupItem : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • updateGroupItem : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.m.P13nPanel 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
Event Detail
addGroupItem(oControlEvent)
Event raised if a GroupItem has been added.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.26
removeGroupItem(oControlEvent)
Removes a group item.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.26
updateGroupItem(oControlEvent)
Updates a group item.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.26
Method Detail
sap.m.P13nGroupPanel.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.P13nGroupPanel with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.P13nPanel.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.P13nGroupPanel.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.P13nGroupPanel.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addGroupItem(oGroupItem): sap.m.P13nGroupPanel
Adds some groupItem to the aggregation groupItems.
Parameters:
{sap.m.P13nGroupItem}oGroupItem the groupItem to add; if empty, nothing is inserted
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
attachAddGroupItem(oData?, fnFunction, oListener?): sap.m.P13nGroupPanel
Attaches event handler fnFunction to the addGroupItem event of this sap.m.P13nGroupPanel.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.P13nGroupPanel itself.

Event raised if a GroupItem has been added.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.m.P13nGroupPanel itself
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
attachRemoveGroupItem(oData?, fnFunction, oListener?): sap.m.P13nGroupPanel
Attaches event handler fnFunction to the removeGroupItem event of this sap.m.P13nGroupPanel.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.P13nGroupPanel itself.

Removes a group item.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.m.P13nGroupPanel itself
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
attachUpdateGroupItem(oData?, fnFunction, oListener?): sap.m.P13nGroupPanel
Attaches event handler fnFunction to the updateGroupItem event of this sap.m.P13nGroupPanel.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.P13nGroupPanel itself.

Updates a group item.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.m.P13nGroupPanel itself
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
bindGroupItems(oBindingInfo): sap.m.P13nGroupPanel
Binds aggregation groupItems to model data.

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

Parameters:
{object}oBindingInfo The binding information
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
destroyGroupItems(): sap.m.P13nGroupPanel
Destroys all the groupItems in the aggregation groupItems.
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
detachAddGroupItem(fnFunction, oListener): sap.m.P13nGroupPanel
Detaches event handler fnFunction from the addGroupItem event of this sap.m.P13nGroupPanel.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
detachRemoveGroupItem(fnFunction, oListener): sap.m.P13nGroupPanel
Detaches event handler fnFunction from the removeGroupItem event of this sap.m.P13nGroupPanel.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
detachUpdateGroupItem(fnFunction, oListener): sap.m.P13nGroupPanel
Detaches event handler fnFunction from the updateGroupItem event of this sap.m.P13nGroupPanel.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
fireAddGroupItem(mArguments?): sap.m.P13nGroupPanel
Fires event addGroupItem to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
fireRemoveGroupItem(mArguments?): sap.m.P13nGroupPanel
Fires event removeGroupItem to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
fireUpdateGroupItem(mArguments?): sap.m.P13nGroupPanel
Fires event updateGroupItem to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
getContainerQuery(): boolean
Gets current value of property containerQuery.

Defines if mediaQuery or ContainerResize is used for a layout update. If ConditionPanel is used in a dialog, the property must be set to true.

Default value is false.

Since:
1.26
Returns:
{boolean} Value of property containerQuery
getGroupItems(): sap.m.P13nGroupItem[]
Gets content of aggregation groupItems.

Defined group items.

Since:
1.26
Returns:
{sap.m.P13nGroupItem[]}
getLayoutMode(): string
Gets current value of property layoutMode.

Can be used to control the layout behavior. Default is "" which will automatically change the layout. With "Desktop", "Table" or"Phone" you can set a fixed layout.

Since:
1.26
Returns:
{string} Value of property layoutMode
getMaxGroups(): string
Gets current value of property maxGroups.

Defines the maximum number of groups.

Default value is -1.

Since:
1.26
Returns:
{string} Value of property maxGroups
indexOfGroupItem(oGroupItem): int
Checks for the provided sap.m.P13nGroupItem in the aggregation groupItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.P13nGroupItem}oGroupItem The groupItem whose index is looked for
Since:
1.26
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertGroupItem(oGroupItem, iIndex): sap.m.P13nGroupPanel
Inserts a groupItem into the aggregation groupItems.
Parameters:
{sap.m.P13nGroupItem}oGroupItem the groupItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the groupItem should be inserted at; for a negative value of iIndex, the groupItem is inserted at position 0; for a value greater than the current size of the aggregation, the groupItem is inserted at the last position
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
removeAllGroupItems(): sap.m.P13nGroupItem[]
Removes all the controls from the aggregation groupItems.

Additionally, it unregisters them from the hosting UIArea.

Since:
1.26
Returns:
{sap.m.P13nGroupItem[]} An array of the removed elements (might be empty)
removeGroupItem(vGroupItem): sap.m.P13nGroupItem
Removes a groupItem from the aggregation groupItems.
Parameters:
{int|string|sap.m.P13nGroupItem}vGroupItem The groupItemto remove or its index or id
Since:
1.26
Returns:
{sap.m.P13nGroupItem} The removed groupItem or null
removeInvalidConditions()
Removes all invalid group conditions.
Since:
1.28
removeValidationErrors()
Removes all errors/warning states from of all group conditions.
Since:
1.28
setContainerQuery(bContainerQuery): sap.m.P13nGroupPanel
Sets a new value for property containerQuery.

Defines if mediaQuery or ContainerResize is used for a layout update. If ConditionPanel is used in a dialog, the property must be set to true.

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

Default value is false.

Parameters:
{boolean}bContainerQuery New value for property containerQuery
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
setLayoutMode(sLayoutMode): sap.m.P13nGroupPanel
Sets a new value for property layoutMode.

Can be used to control the layout behavior. Default is "" which will automatically change the layout. With "Desktop", "Table" or"Phone" you can set a fixed layout.

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

Parameters:
{string}sLayoutMode New value for property layoutMode
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
setMaxGroups(sMaxGroups): sap.m.P13nGroupPanel
Sets a new value for property maxGroups.

Defines the maximum number of groups.

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

Default value is -1.

Parameters:
{string}sMaxGroups New value for property maxGroups
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
setOperations(array)
Setter for the supported operations array.
Parameters:
{array}array of operations [sap.m.P13nConditionOperation.BT, sap.m.P13nConditionOperation.EQ]
Since:
1.26
unbindGroupItems(): sap.m.P13nGroupPanel
Unbinds aggregation groupItems from model data.
Since:
1.26
Returns:
{sap.m.P13nGroupPanel} Reference to this in order to allow method chaining
validateConditions()
Checks if the entered or modified conditions are correct, marks invalid fields yellow (Warning) and opens a popup message dialog to let the user know that some values are not correct or missing.
Since:
1.26