The P13nGroupPanel control is used to define group-specific settings for table personalization.
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#constructor for a general description of the syntax of the settings object.
new sap.m.P13nGroupPanel(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control, generated automatically if no ID is given |
|
mSettings? | object | initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
containerQuery | boolean | false | Defines if |
layoutMode | string | 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. Visibility: public |
|
maxGroups | string | -1 | Defines the maximum number of groups. Visibility: public |
Name | Type | Default Value | Description |
---|---|---|---|
changeNotifier | object | Callback which notifies a change on this panel. Visibility: public |
|
title | string | Title text appears in the panel. Visibility: public |
|
titleLarge | string | Large title text appears e.g. in dialog header in case that only one panel is shown. |
|
type | string | Panel type for generic use. Due to extensibility reason the type of |
|
validationExecutor | object | Callback method which is called in order to validate end user entry. Visibility: public |
|
validationListener | object | Callback method which is called in order to register for validation result. Visibility: public |
|
verticalScrolling | boolean | true | Enables the vertical Scrolling on the |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
content | 0..n | sap.ui.core.Control |
Contains content for include and exclude panels. |
groupItems | 0..n | sap.m.P13nGroupItem |
Defined group items. |
Name | Cardinality | Type | Description |
---|---|---|---|
items | 0..n | sap.m.P13nItem |
Defines personalization items (e.g. columns in the |
Event | Description |
---|---|
addGroupItem |
Event raised if a |
removeGroupItem |
Event raised if a |
updateGroupItem |
Event raised if a |
Event raised if a GroupItem
has been added.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
Method | Description |
---|---|
addGroupItem |
Adds some groupItem to the aggregation groupItems. |
attachAddGroupItem |
Attaches event handler When called, the context of the event handler (its Event raised if a |
attachRemoveGroupItem |
Attaches event handler When called, the context of the event handler (its Event raised if a |
attachUpdateGroupItem |
Attaches event handler When called, the context of the event handler (its Event raised if a |
bindGroupItems |
Binds aggregation groupItems to model data. See ManagedObject.bindAggregation for a detailed description of the possible properties of |
destroyGroupItems |
Destroys all the groupItems in the aggregation groupItems. |
detachAddGroupItem |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachRemoveGroupItem |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachUpdateGroupItem |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.m.P13nGroupPanel.extend |
Creates a new subclass of class sap.m.P13nGroupPanel with name
|
fireAddGroupItem |
Fires event addGroupItem to attached listeners. |
fireRemoveGroupItem |
Fires event removeGroupItem to attached listeners. |
fireUpdateGroupItem |
Fires event updateGroupItem to attached listeners. |
getContainerQuery |
Gets current value of property containerQuery. Defines if Default value is |
getGroupItems |
Gets content of aggregation groupItems. Defined group items. |
getLayoutMode |
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. |
getMaxGroups |
Gets current value of property maxGroups. Defines the maximum number of groups. Default value is |
sap.m.P13nGroupPanel.getMetadata |
Returns a metadata object for class sap.m.P13nGroupPanel. |
indexOfGroupItem |
Checks for the provided |
insertGroupItem |
Inserts a groupItem into the aggregation groupItems. |
removeAllGroupItems |
Removes all the controls from the aggregation groupItems. Additionally, it unregisters them from the hosting UIArea. |
removeGroupItem |
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 |
Sets a new value for property containerQuery. Defines if When called with a value of Default value is |
setLayoutMode |
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 |
setMaxGroups |
Sets a new value for property maxGroups. Defines the maximum number of groups. When called with a value of Default value is |
setOperations |
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. |
Adds some groupItem to the aggregation groupItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
oGroupItem | sap.m.P13nGroupItem |
The groupItem to add; if empty, nothing is inserted |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Event raised if a GroupItem
has been removed.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Event raised if a GroupItem
has been updated.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Binds aggregation groupItems to model data.
See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo
.
Param | Type | DefaultValue | Description |
---|---|---|---|
oBindingInfo | sap.ui.base.ManagedObject.AggregationBindingInfo |
The binding information |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Fires event addGroupItem to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event removeGroupItem to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event updateGroupItem to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
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
.
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.
Gets current value of property maxGroups.
Defines the maximum number of groups.
Default value is '-1'
.
Checks for the provided sap.m.P13nGroupItem
in the aggregation groupItems. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oGroupItem | sap.m.P13nGroupItem |
The groupItem whose index is looked for |
Inserts a groupItem into the aggregation groupItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
oGroupItem | sap.m.P13nGroupItem |
The groupItem to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation groupItems.
Additionally, it unregisters them from the hosting UIArea.
Removes a groupItem from the aggregation groupItems.
Param | Type | DefaultValue | Description |
---|---|---|---|
vGroupItem | int string sap.m.P13nGroupItem |
The groupItem to remove or its index or id |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bContainerQuery | boolean | false |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sLayoutMode | string |
New value for property |
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'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sMaxGroups | string | '-1' |
New value for property |