class sap.ui.commons.MessageToast

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/commons/MessageToast
Application Component: CA-UI5-CTR

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


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.commons.MessageToast(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
anchorId string

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

Visibility: public

Events Overview

Event Description
next

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

next

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

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
attachNext

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.

detachNext

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.

sap.ui.commons.MessageToast.extend

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.

fireNext

Fires event next to attached listeners.

getAnchorId

Gets current value of property anchorId.

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

sap.ui.commons.MessageToast.getMetadata

Returns a metadata object for class sap.ui.commons.MessageToast.

isIdle

Returns the idle state of the control. Returns true if no message is being toasted.

setAnchorId

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.

toast

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.

attachNext

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.commons.MessageToast itself

detachNext

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.commons.MessageToast.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireNext

Fires event next to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getAnchorId

Gets current value of property anchorId.

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

sap.ui.commons.MessageToast.getMetadata

Returns a metadata object for class sap.ui.commons.MessageToast.

isIdle

Returns the idle state of the control. Returns true if no message is being toasted.

setAnchorId

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.

Param Type DefaultValue Description
sAnchorId string

New value for property anchorId

toast

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.

Param Type DefaultValue Description
oMessage sap.ui.commons.Message

The Message to be toasted.

sAnchorId string

DOM ID of the anchor against which the Toast Arrow should align for a given Toast.