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
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(mParameters?)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.
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:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?Initial settings for the new 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.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.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:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated 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.MetadataMetadata 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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.commons.MessageToast itself
Returns:
sap.ui.commons.MessageToastReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.commons.MessageToastReference to this in order to allow method chaining
fireNext(mParameters?): sap.ui.commons.MessageToast
Fires event next to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.ui.commons.MessageToastReference 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:
stringValue 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:
stringsAnchorIdNew value for property anchorId
Returns:
sap.ui.commons.MessageToastReference 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.MessageoMessageThe Message to be toasted.
stringsAnchorIdDOM ID of the anchor against which the Toast Arrow should align for a given Toast.