Class sap.m.NotificationListGroupModule: sap/m/NotificationListGroup

extends NotificationListBase

The NotificationListItemGroup control is used for grouping NotificationListItems of the same type.


Since: 1.34.
Constructor Summary
new sap.m.NotificationListGroup(sId?, mSettings?)Constructor for a new NotificationListGroup.
Fields borrowed from class sap.m.ListItemBase
isSelected
Events borrowed from class sap.m.NotificationListBase
close
Events borrowed from class sap.m.ListItemBase
detailPress, detailTap, press, tap
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.NotificationListGroup.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.NotificationListGroup with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.NotificationListGroup.getMetadata()Returns a metadata object for class sap.m.NotificationListGroup.
addItem(oItem)Adds some item to the aggregation items.
destroyItems()Destroys all the items in the aggregation items.
getAutoPriority()Gets current value of property autoPriority.
getCollapsed()Gets current value of property collapsed.
getItems()Gets content of aggregation items.
indexOfItem(oItem)Checks for the provided sap.m.NotificationListItem in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setAutoPriority(bAutoPriority)Sets a new value for property autoPriority.
setCollapsed(bCollapsed)Sets a new value for property collapsed.
Methods borrowed from class sap.m.NotificationListBase
_getAuthorImage, _getAuthorName, _getToolbar, addButton, attachClose, destroyButtons, detachClose, fireClose, getAuthorName, getAuthorPicture, getButtons, getDatetime, getPriority, getShowButtons, getShowCloseButton, getTitle, indexOfButton, insertButton, removeAllButtons, removeButton, setAuthorName, setAuthorPicture, setDatetime, setPriority, setShowButtons, setShowCloseButton, setTitle
Methods borrowed from class sap.m.ListItemBase
addAriaLabelledBy, attachDetailPress, attachDetailTap, attachPress, attachTap, detachDetailPress, detachDetailTap, detachPress, detachTap, fireDetailPress, fireDetailTap, firePress, fireTap, getAriaLabelledBy, getCounter, getSelected, getTabbables, getType, getUnread, getVisible, removeAllAriaLabelledBy, removeAriaLabelledBy, setCounter, setSelected, setType, setUnread, setVisible
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, 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, init, 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.NotificationListGroup(sId?, mSettings?)
Constructor for a new NotificationListGroup.

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
    • items : sap.m.NotificationListItem[]

In addition, all settings applicable to the base type sap.m.NotificationListBase 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.NotificationListGroup.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.NotificationListGroup 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.NotificationListBase.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.NotificationListGroup.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.NotificationListGroup.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.m.NotificationListGroup
Adds some item to the aggregation items.
Parameters:
{sap.m.NotificationListItem}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.m.NotificationListGroup} Reference to this in order to allow method chaining
destroyItems(): sap.m.NotificationListGroup
Destroys all the items in the aggregation items.
Returns:
{sap.m.NotificationListGroup} Reference to this in order to allow method chaining
getAutoPriority(): boolean
Gets current value of property autoPriority.

Determines if the group will automatically set the priority based on the highest priority of its notifications or get its priority from the developer.

Default value is true.

Returns:
{boolean} Value of property autoPriority
getCollapsed(): boolean
Gets current value of property collapsed.

Determines if the group is collapsed or expanded.

Default value is false.

Returns:
{boolean} Value of property collapsed
getItems(): sap.m.NotificationListItem[]
Gets content of aggregation items.

The NotificationListItems inside the group.

Returns:
{sap.m.NotificationListItem[]}
indexOfItem(oItem): int
Checks for the provided sap.m.NotificationListItem in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.NotificationListItem}oItem The item whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.m.NotificationListGroup
Inserts a item into the aggregation items.
Parameters:
{sap.m.NotificationListItem}oItem the item to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
{sap.m.NotificationListGroup} Reference to this in order to allow method chaining
removeAllItems(): sap.m.NotificationListItem[]
Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.m.NotificationListItem[]} An array of the removed elements (might be empty)
removeItem(vItem): sap.m.NotificationListItem
Removes a item from the aggregation items.
Parameters:
{int|string|sap.m.NotificationListItem}vItem The itemto remove or its index or id
Returns:
{sap.m.NotificationListItem} The removed item or null
setAutoPriority(bAutoPriority): sap.m.NotificationListGroup
Sets a new value for property autoPriority.

Determines if the group will automatically set the priority based on the highest priority of its notifications or get its priority from the developer.

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

Default value is true.

Parameters:
{boolean}bAutoPriority New value for property autoPriority
Returns:
{sap.m.NotificationListGroup} Reference to this in order to allow method chaining
setCollapsed(bCollapsed): sap.m.NotificationListGroup
Sets a new value for property collapsed.

Determines if the group is collapsed or expanded.

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

Default value is false.

Parameters:
{boolean}bCollapsed New value for property collapsed
Returns:
{sap.m.NotificationListGroup} Reference to this in order to allow method chaining