Class sap.ui.commons.MessageToastModule: sap/ui/commons/MessageToast

extends Control

Responsible for displaying the new incoming messages, one at the time, on top of the MessageBar.

Deprecated API:Since version 1.4.0. Instead, use the sap.m.MessageToast control.

Constructor Summary
new sap.ui.commons.MessageToast(sId?, mSettings?)Constructor for a new MessageToast.
Event Summary
next(oControlEvent)Fired once the toast() method is over, so that the MessageBar can "toast" another message if needed.
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.commons.MessageToast.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.MessageToast with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.MessageToast.getMetadata()Returns a metadata object for class sap.ui.commons.MessageToast.
attachNext(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the next event of this sap.ui.commons.MessageToast.
detachNext(fnFunction, oListener)Detaches event handler fnFunction from the next event of this sap.ui.commons.MessageToast.
fireNext(mArguments?)Fires event next to attached listeners.
getAnchorId()Gets current value of property anchorId.
isIdle()Returns the idle state of the control.
setAnchorId(sAnchorId)Sets a new value for property anchorId.
toast(oMessage, sAnchorId)Triggers the toasting of a message, on top of the MessageBar.
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, 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, 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.commons.MessageToast(sId?, mSettings?)
Constructor for a new MessageToast.

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
  • Events
    • next : 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.

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.4.0. Instead, use the sap.m.MessageToast control.
Event Detail
next(oControlEvent)
Fired once the toast() method is over, so that the MessageBar can "toast" another message if needed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.ui.commons.MessageToast.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.MessageToast 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.commons.MessageToast.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.MessageToast.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachNext(oData?, fnFunction, oListener?): sap.ui.commons.MessageToast
Attaches event handler fnFunction to the next event of this sap.ui.commons.MessageToast.

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.commons.MessageToast itself.

Fired once the toast() method is over, so that the MessageBar can "toast" another message if needed.

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.commons.MessageToast itself
Returns:
{sap.ui.commons.MessageToast} Reference to this in order to allow method chaining
detachNext(fnFunction, oListener): sap.ui.commons.MessageToast
Detaches event handler fnFunction from the next event of this sap.ui.commons.MessageToast.

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.commons.MessageToast} Reference to this in order to allow method chaining
fireNext(mArguments?): sap.ui.commons.MessageToast
Fires event next to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.commons.MessageToast} Reference to this in order to allow method chaining
getAnchorId(): string
Gets current value of property anchorId.

ID of the anchor on top of which the MessageToast is to render.

Returns:
{string} Value of property anchorId
isIdle(): boolean
Returns the idle state of the control. Returns true if no message is being toasted.
Returns:
{boolean}
setAnchorId(sAnchorId): sap.ui.commons.MessageToast
Sets a new value for property anchorId.

ID of the anchor on top of which the MessageToast is to render.

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

Parameters:
{string}sAnchorId New value for property anchorId
Returns:
{sap.ui.commons.MessageToast} Reference to this in order to allow method chaining
toast(oMessage, sAnchorId): void
Triggers the toasting of a message, on top of the MessageBar. If no message is supplied, displays the "Multiple new messages..." message.

Receives the list of Messages to be displayed, and re-renders this Control if it is visible.

Parameters:
{sap.ui.commons.Message}oMessage The Message to be toasted.
{string}sAnchorId DOM ID of the anchor against which the Toast Arrow should align for a given Toast.