com.sap.ui.commons.client
Class MessageToastWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.MessageToastWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class MessageToastWidget
extends com.sap.ui.core.client.ControlWidget

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: )

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	MessageToastWidget() constructs the class MessageToastWidget
protected	MessageToastWidget(MessageToast control) constructs the class MessageToastWidget
	MessageToastWidget(String id) constructs the class MessageToastWidget

Method Summary

void	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.
void	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.
MessageToast	getControl() returns the reference to the Phoenix Control
boolean	isIdle() Returns TRUE if no message is being toasted.
void	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.ControlWidget

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageToastWidget

public MessageToastWidget()

constructs the class MessageToastWidget

MessageToastWidget

public MessageToastWidget(String id)

constructs the class MessageToastWidget

Parameters:

id - id of the MessageToastWidget

MessageToastWidget

protected MessageToastWidget(MessageToast control)

constructs the class MessageToastWidget

Parameters:

control - reference to an existing MessageToast

Method Detail

getControl

public MessageToast getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

getAnchorId

public 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 void setAnchorId(String value)

Setter for property anchorId

Parameters:

value - String

attachNextEvent

public void 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

detachNextEvent

public void 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

toast

public 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 boolean isIdle()

Returns TRUE if no message is being toasted.