com.sap.ui.commons.client
Class Message

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

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

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: sap.ui.commons.Message)

Constructor Summary

protected

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

Method Summary

String	bindDetails() Registers a callback function to be invoked if long text Details are to be made available.
static Message	create() creates a new instance of the class Message
static Message	create(String idOrConfig) creates a new instance of the class Message
static Message	create(String id, String config) creates a new instance of the class Message
String	getAssociatedElementId() Getter for property associatedElementId Associated UI element ID.
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.
Message	setAssociatedElementId(String value) Setter for property associatedElementId
Message	setDesign(String value) Setter for property design
Message	setText(String value) Setter for property text
Message	setType(MessageType value) Setter for property type

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

Message

protected Message()

constructs the class Message
hidden due to JavaScriptObject restriction

Method Detail

create

public static Message create()

creates a new instance of the class Message

create

public static Message create(String idOrConfig)

creates a new instance of the class Message

Parameters:

id - id of the Message or configuration JSON string

create

public static Message create(String id,
                             String config)

creates a new instance of the class Message

Parameters:

id - id of the Message

config - configuration JSON string

getType

public final MessageType getType()

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

Returns:

the value of property type

setType

public final Message setType(MessageType value)

Setter for property type

Parameters:

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

Returns:

this to allow method chaining

getText

public final String getText()

Getter for property text Message short text. (Mandatory)

Returns:

the value of property text

setText

public final Message setText(String value)

Setter for property text

Parameters:

value - String

Returns:

this to allow method chaining

getAssociatedElementId

public final String getAssociatedElementId()

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

Returns:

the value of property associatedElementId

setAssociatedElementId

public final Message setAssociatedElementId(String value)

Setter for property associatedElementId

Parameters:

value - String

Returns:

this to allow method chaining

getDesign

public final 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 final Message setDesign(String value)

Setter for property design

Parameters:

value - String

Returns:

this to allow method chaining

bindDetails

public final 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;}