com.sap.ui.commons.client
Class MessageWidget

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.MessageWidget

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 MessageWidget
extends com.sap.ui.core.client.ControlWidget

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

Creates the "Message"s to be supplied to the "MessageBar" Control.

• Properties
  • type : com.sap.ui.commons.client.MessageType
    "Success", or "Warning", or "Error" messages. (Mandatory)
  • text : String
    Message short text. (Mandatory)
  • associatedElementId : String
    Associated UI element ID. (Optional) For navigation to error field.
  • design : String
    Internal attribute, used to force the display of the "short" or the "long" text only.
• Aggregations
• Associations
• Events

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

	MessageWidget() constructs the class MessageWidget
protected	MessageWidget(Message control) constructs the class MessageWidget
	MessageWidget(String id) constructs the class MessageWidget

Method Summary

String	bindDetails() Registers a callback function to be invoked if long text Details are to be made available.
String	getAssociatedElementId() Getter for property associatedElementId Associated UI element ID.
Message	getControl() returns the reference to the Phoenix Control
String	getDesign() Getter for property design Internal attribute, used to force the display of the "short" or the "long" text only.
String	getText() Getter for property text Message short text.
MessageType	getType() Getter for property type "Success", or "Warning", or "Error" messages.
void	setAssociatedElementId(String value) Setter for property associatedElementId
void	setDesign(String value) Setter for property design
void	setText(String value) Setter for property text
void	setType(MessageType value) Setter for property type

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

MessageWidget

public MessageWidget()

constructs the class MessageWidget

MessageWidget

public MessageWidget(String id)

constructs the class MessageWidget

Parameters:

id - id of the MessageWidget

MessageWidget

protected MessageWidget(Message control)

constructs the class MessageWidget

Parameters:

control - reference to an existing Message

Method Detail

getControl

public Message getControl()

returns the reference to the Phoenix Control

Overrides:

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

Returns:

reference to the Phoenix Control

getType

public MessageType getType()

Getter for property type "Success", or "Warning", or "Error" messages. (Mandatory)

Returns:

the value of property type

setType

public void setType(MessageType value)

Setter for property type

Parameters:

value - com.sap.ui.commons.client.MessageType

getText

public String getText()

Getter for property text Message short text. (Mandatory)

Returns:

the value of property text

setText

public void setText(String value)

Setter for property text

Parameters:

value - String

getAssociatedElementId

public String getAssociatedElementId()

Getter for property associatedElementId Associated UI element ID. (Optional) For navigation to error field.

Returns:

the value of property associatedElementId

setAssociatedElementId

public void setAssociatedElementId(String value)

Setter for property associatedElementId

Parameters:

value - String

getDesign

public String getDesign()

Getter for property design Internal attribute, used to force the display of the "short" or the "long" text only.

Returns:

the value of property design

setDesign

public void setDesign(String value)

Setter for property design

Parameters:

value - String

bindDetails

public String bindDetails()

Registers a callback function to be invoked if long text Details are to be made available. This callback function will be supplied the corresponding Message "id", and should return the HTML string to be displayed within the Message Details Dialog. E.g.: myMessage.bindDetails(getDetails); where function getDetails(sId) {... return htmlString;}