com.sap.ui.commons.client
Class MessageList

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

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

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

Instantiated by the "MessageBar" Control if the user ever requests to generate the corresponding "MessageList".

• Properties
  • visible : boolean
    To open or close the Control.
  • anchorId : String
    Id of the anchor under which the MessageList is to render.
  • maxListed : String
    Maximum number of messages being display in the List before a scrollbar appears. Value '0' means no limit.
• Aggregations
• Associations
• Events

Version:

0.18.0-SNAPSHOT

Author:

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

Constructor Summary

protected

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

Method Summary

static MessageList	create() creates a new instance of the class MessageList
static MessageList	create(String idOrConfig) creates a new instance of the class MessageList
static MessageList	create(String id, String config) creates a new instance of the class MessageList
String	getAnchorId() Getter for property anchorId Id of the anchor under which the MessageList is to render.
String	getMaxListed() Getter for property maxListed Maximum number of messages being display in the List before a scrollbar appears.
boolean	isVisible() Getter for property visible To open or close the Control.
MessageList	setAnchorId(String value) Setter for property anchorId
MessageList	setMaxListed(String value) Setter for property maxListed Default value is: 7
void	setMessages(com.sap.ui.core.client.js.JsArray<Message> messages) Sets the message list to be displayed.
MessageList	setVisible(boolean value) Setter for property visible Default value is: false

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

MessageList

protected MessageList()

constructs the class MessageList
hidden due to JavaScriptObject restriction

Method Detail

create

public static MessageList create()

creates a new instance of the class MessageList

create

public static MessageList create(String idOrConfig)

creates a new instance of the class MessageList

Parameters:

id - id of the MessageList or configuration JSON string

create

public static MessageList create(String id,
                                 String config)

creates a new instance of the class MessageList

Parameters:

id - id of the MessageList

config - configuration JSON string

isVisible

public final boolean isVisible()

Getter for property visible To open or close the Control.

Returns:

the value of property visible

setVisible

public final MessageList setVisible(boolean value)

Setter for property visible
Default value is: false

Parameters:

value - boolean

Returns:

this to allow method chaining

getAnchorId

public final String getAnchorId()

Getter for property anchorId Id of the anchor under which the MessageList is to render.

Returns:

the value of property anchorId

setAnchorId

public final MessageList setAnchorId(String value)

Setter for property anchorId

Parameters:

value - String

Returns:

this to allow method chaining

getMaxListed

public final String getMaxListed()

Getter for property maxListed Maximum number of messages being display in the List before a scrollbar appears. Value '0' means no limit.

Returns:

the value of property maxListed

setMaxListed

public final MessageList setMaxListed(String value)

Setter for property maxListed
Default value is: 7

Parameters:

value - String

Returns:

this to allow method chaining

setMessages

public final void setMessages(com.sap.ui.core.client.js.JsArray<Message> messages)

Sets the message list to be displayed.

Parameters:

messages - Message list.