Class sap.ui.vk.NotificationsModule: sap/ui/vk/Notifications

extends Control

Provides the ability to display logged console messages within your application.

Experimental API:Since 1.38.0 This class is experimental and might be modified or removed in future versions.

Constructor Summary
new sap.ui.vk.Notifications()Constructor for a new Notifications.
Event Summary
allMessagesCleared(oControlEvent)
messageAdded(oControlEvent)
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.vk.Notifications.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vk.Notifications with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vk.Notifications.getMetadata()Returns a metadata object for class sap.ui.vk.Notifications.
attachAllMessagesCleared(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the allMessagesCleared event of this sap.ui.vk.Notifications.
attachMessageAdded(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the messageAdded event of this sap.ui.vk.Notifications.
clearAllMessages(messagePopover, messagePopoverToggleButton).Clears the items in the Message Popover list.
detachAllMessagesCleared(fnFunction, oListener)Detaches event handler fnFunction from the allMessagesCleared event of this sap.ui.vk.Notifications.
detachMessageAdded(fnFunction, oListener)Detaches event handler fnFunction from the messageAdded event of this sap.ui.vk.Notifications.
fireAllMessagesCleared(mArguments?)Fires event allMessagesCleared to attached listeners.
fireMessageAdded(mArguments?)Fires event messageAdded to attached listeners.
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, 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.ui.vk.Notifications()
Constructor for a new Notifications.

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:

  • Aggregations
    • Events
      • allMessagesCleared : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
      • messageAdded : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

    In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

    Event Detail
    allMessagesCleared(oControlEvent)
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    messageAdded(oControlEvent)
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.ui.vk.Notifications.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.ui.vk.Notifications 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.vk.Notifications.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.ui.vk.Notifications.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    attachAllMessagesCleared(oData?, fnFunction, oListener?): sap.ui.vk.Notifications
    Attaches event handler fnFunction to the allMessagesCleared event of this sap.ui.vk.Notifications.

    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.ui.vk.Notifications itself.

    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.ui.vk.Notifications itself
    Returns:
    {sap.ui.vk.Notifications} Reference to this in order to allow method chaining
    attachMessageAdded(oData?, fnFunction, oListener?): sap.ui.vk.Notifications
    Attaches event handler fnFunction to the messageAdded event of this sap.ui.vk.Notifications.

    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.ui.vk.Notifications itself.

    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.ui.vk.Notifications itself
    Returns:
    {sap.ui.vk.Notifications} Reference to this in order to allow method chaining
    clearAllMessages(messagePopover, messagePopoverToggleButton): sap.ui.vk.Notifications
    .Clears the items in the Message Popover list.
    Parameters:
    {sap.m.MessagePopover}messagePopover The Message Popover that we are removing the items from.
    {sap.m.ToggleButton}messagePopoverToggleButton The toggle button displaying the number of items listed.
    Returns:
    {sap.ui.vk.Notifications}this to allow method chaining.
    detachAllMessagesCleared(fnFunction, oListener): sap.ui.vk.Notifications
    Detaches event handler fnFunction from the allMessagesCleared event of this sap.ui.vk.Notifications.

    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
    Returns:
    {sap.ui.vk.Notifications} Reference to this in order to allow method chaining
    detachMessageAdded(fnFunction, oListener): sap.ui.vk.Notifications
    Detaches event handler fnFunction from the messageAdded event of this sap.ui.vk.Notifications.

    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
    Returns:
    {sap.ui.vk.Notifications} Reference to this in order to allow method chaining
    fireAllMessagesCleared(mArguments?): sap.ui.vk.Notifications
    Fires event allMessagesCleared to attached listeners.
    Parameters:
    {Map}mArguments? The arguments to pass along with the event
    Returns:
    {sap.ui.vk.Notifications} Reference to this in order to allow method chaining
    fireMessageAdded(mArguments?): sap.ui.vk.Notifications
    Fires event messageAdded to attached listeners.
    Parameters:
    {Map}mArguments? The arguments to pass along with the event
    Returns:
    {sap.ui.vk.Notifications} Reference to this in order to allow method chaining