Class sap.ui.ux3.NotifierModule: sap/ui/ux3/Notifier

extends Element

This element can be docked to a notification bar to show notification items

Deprecated API:Since version 1.38.

Constructor Summary
new sap.ui.ux3.Notifier(sId?, mSettings?)Constructor for a new Notifier.
Event Summary
messageSelected(oControlEvent)Event is fired when a message of the notifiers was selected.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.ux3.Notifier.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.Notifier with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.Notifier.getMetadata()Returns a metadata object for class sap.ui.ux3.Notifier.
addMessage(oMessage)Adds some message to the aggregation messages.
attachMessageSelected(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the messageSelected event of this sap.ui.ux3.Notifier.
destroyMessages()Destroys all the messages in the aggregation messages.
detachMessageSelected(fnFunction, oListener)Detaches event handler fnFunction from the messageSelected event of this sap.ui.ux3.Notifier.
fireMessageSelected(mArguments?)Fires event messageSelected to attached listeners.
getIcon()Gets current value of property icon.
getMessages()Gets content of aggregation messages.
getTitle()Gets current value of property title.
hasItems()This method checks if the notifier has any items.
indexOfMessage(oMessage)Checks for the provided sap.ui.core.Message in the aggregation messages.
insertMessage(oMessage, iIndex)Inserts a message into the aggregation messages.
removeAllMessages()Removes all the controls from the aggregation messages.
removeMessage(vMessage)Removes a message from the aggregation messages.
setIcon(sIcon)Sets a new value for property icon.
setTitle(sTitle)Sets a new value for property title.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, 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, rerender, 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, invalidate, 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.ux3.Notifier(sId?, mSettings?)
Constructor for a new Notifier.

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
    • messageSelected : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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
Deprecated:
Since version 1.38.
Event Detail
messageSelected(oControlEvent)
Event is fired when a message of the notifiers was selected.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.core.Message}oControlEvent.getParameters.message The message that was selected
{sap.ui.ux3.Notifier}oControlEvent.getParameters.notifier The notifier that contains the selected message
Method Detail
sap.ui.ux3.Notifier.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.ux3.Notifier 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.ui.ux3.Notifier.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.Notifier.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addMessage(oMessage): sap.ui.ux3.Notifier
Adds some message to the aggregation messages.
Parameters:
{sap.ui.core.Message}oMessage the message to add; if empty, nothing is inserted
Returns:
{sap.ui.ux3.Notifier} Reference to this in order to allow method chaining
attachMessageSelected(oData?, fnFunction, oListener?): sap.ui.ux3.Notifier
Attaches event handler fnFunction to the messageSelected event of this sap.ui.ux3.Notifier.

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.ux3.Notifier itself.

Event is fired when a message of the notifiers was selected.

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.ux3.Notifier itself
Returns:
{sap.ui.ux3.Notifier} Reference to this in order to allow method chaining
destroyMessages(): sap.ui.ux3.Notifier
Destroys all the messages in the aggregation messages.
Returns:
{sap.ui.ux3.Notifier} Reference to this in order to allow method chaining
detachMessageSelected(fnFunction, oListener): sap.ui.ux3.Notifier
Detaches event handler fnFunction from the messageSelected event of this sap.ui.ux3.Notifier.

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.ux3.Notifier} Reference to this in order to allow method chaining
fireMessageSelected(mArguments?): sap.ui.ux3.Notifier
Fires event messageSelected to attached listeners.

Expects the following event parameters:

  • message of type sap.ui.core.MessageThe message that was selected
  • notifier of type sap.ui.ux3.NotifierThe notifier that contains the selected message
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.ux3.Notifier} Reference to this in order to allow method chaining
getIcon(): sap.ui.core.URI
Gets current value of property icon.

Icon of the control that should be displayed within the corresponding bar

Returns:
{sap.ui.core.URI} Value of property icon
getMessages(): sap.ui.core.Message[]
Gets content of aggregation messages.

Messages of this notifier.

Returns:
{sap.ui.core.Message[]}
getTitle(): string
Gets current value of property title.

Defines the title that should be displayed within the opening popup

Returns:
{string} Value of property title
hasItems(): boolean
This method checks if the notifier has any items.
Returns:
{boolean}
indexOfMessage(oMessage): int
Checks for the provided sap.ui.core.Message in the aggregation messages. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Message}oMessage The message whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertMessage(oMessage, iIndex): sap.ui.ux3.Notifier
Inserts a message into the aggregation messages.
Parameters:
{sap.ui.core.Message}oMessage the message to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the message should be inserted at; for a negative value of iIndex, the message is inserted at position 0; for a value greater than the current size of the aggregation, the message is inserted at the last position
Returns:
{sap.ui.ux3.Notifier} Reference to this in order to allow method chaining
removeAllMessages(): sap.ui.core.Message[]
Removes all the controls from the aggregation messages.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Message[]} An array of the removed elements (might be empty)
removeMessage(vMessage): sap.ui.core.Message
Removes a message from the aggregation messages.
Parameters:
{int|string|sap.ui.core.Message}vMessage The messageto remove or its index or id
Returns:
{sap.ui.core.Message} The removed message or null
setIcon(sIcon): sap.ui.ux3.Notifier
Sets a new value for property icon.

Icon of the control that should be displayed within the corresponding bar

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

Parameters:
{sap.ui.core.URI}sIcon New value for property icon
Returns:
{sap.ui.ux3.Notifier} Reference to this in order to allow method chaining
setTitle(sTitle): sap.ui.ux3.Notifier
Sets a new value for property title.

Defines the title that should be displayed within the opening popup

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

Parameters:
{string}sTitle New value for property title
Returns:
{sap.ui.ux3.Notifier} Reference to this in order to allow method chaining