com.sap.ui.commons.client
Class MessageToast

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.MessageToast

public class MessageToast
extends com.sap.ui.core.client.Control

The class MessageToast is the GWT wrapper for the Phoenix control: sap.ui.commons.MessageToast.

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

• Properties
  • anchorId : String
    Id of the anchor on top of which the MessageToast is to render.
• Aggregations
• Associations
• Events
  • next Fired once the "toast()" method is over, so that the MessageBar can toast() another message if needed.

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.MessageToast)

Constructor Summary

protected

MessageToast() constructs the class MessageToast hidden due to JavaScriptObject restriction

Method Summary

MessageToast	attachNextEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Fired once the "toast()" method is over, so that the MessageBar can toast() another message if needed.
static MessageToast	create() creates a new instance of the class MessageToast
static MessageToast	create(String idOrConfig) creates a new instance of the class MessageToast
static MessageToast	create(String id, String config) creates a new instance of the class MessageToast
MessageToast	detachNextEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Fired once the "toast()" method is over, so that the MessageBar can toast() another message if needed.
String	getAnchorId() Getter for property anchorId Id of the anchor on top of which the MessageToast is to render.
boolean	isIdle() Returns TRUE if no message is being toasted.
MessageToast	setAnchorId(String value) Setter for property anchorId
void	toast(Message message, String anchorId) Triggers the toasting of a message, on top of the MessageBar.

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageToast

protected MessageToast()

constructs the class MessageToast
hidden due to JavaScriptObject restriction

Method Detail

create

public static MessageToast create()

creates a new instance of the class MessageToast

create

public static MessageToast create(String idOrConfig)

creates a new instance of the class MessageToast

Parameters:

id - id of the MessageToast or configuration JSON string

create

public static MessageToast create(String id,
                                  String config)

creates a new instance of the class MessageToast

Parameters:

id - id of the MessageToast

config - configuration JSON string

getAnchorId

public final String getAnchorId()

Getter for property anchorId Id of the anchor on top of which the MessageToast is to render.

Returns:

the value of property anchorId

setAnchorId

public final MessageToast setAnchorId(String value)

Setter for property anchorId

Parameters:

value - String

Returns:

this to allow method chaining

attachNextEvent

public final MessageToast attachNextEvent(com.sap.ui.core.client.event.EventListener listener)

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

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachNextEvent

public final MessageToast detachNextEvent(com.sap.ui.core.client.event.EventListener listener)

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

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

toast

public final void toast(Message message,
                        String anchorId)

Triggers the toasting of a message, on top of the MessageBar. If no message is supplied, displayes the "Multiple new messages..." message.

Parameters:

message - The Message to be toasted.

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

isIdle

public final boolean isIdle()

Returns TRUE if no message is being toasted.