Class sap.ui.commons.MessageListModule: sap/ui/commons/MessageList

extends Control

Instantiated by the "MessageBar" Control if the user requests to generate the corresponding "MessageList".
Deprecated API:
Since version 1.4.0. A new messaging concept will be created in future. Therefore this control might be removed in one of the next versions.
Constructor Summary
new sap.ui.commons.MessageList(sId?, mSettings?)Constructor for a new MessageList.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.commons.MessageList.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.MessageList with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.MessageList.getMetadata()Returns a metadata object for class sap.ui.commons.MessageList.
getAnchorId()Gets current value of property anchorId.
getMaxListed()Gets current value of property maxListed.
getVisible()Gets current value of property visible.
setAnchorId(sAnchorId)Sets a new value for property anchorId.
setMaxListed(sMaxListed)Sets a new value for property maxListed.
setMessages(aMessages)Sets the list of Messages to be displayed and re-renders this Control if it is visible.
setVisible(bVisible)Setter for property visible.
Constructor Detail
new sap.ui.commons.MessageList(sId?, mSettings?)

Constructor for a new MessageList.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?Initial settings for the new control
Method Detail
sap.ui.commons.MessageList.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.commons.MessageList with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.commons.MessageList.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.MessageList.
Returns:
sap.ui.base.MetadataMetadata object describing this class
getAnchorId(): string

Gets current value of property anchorId.

ID of the anchor under which the MessageList will render.

Returns:
stringValue of property anchorId
getMaxListed(): string

Gets current value of property maxListed.

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

Default value is 7.

Returns:
stringValue of property maxListed
getVisible(): boolean

Gets current value of property visible.

Specifies whether or not the MessageList is visible. Invisible controls are not rendered.

Default value is false.

Returns:
booleanValue of property visible
setAnchorId(sAnchorId): sap.ui.commons.MessageList

Sets a new value for property anchorId.

ID of the anchor under which the MessageList will render.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
stringsAnchorIdNew value for property anchorId
Returns:
sap.ui.commons.MessageListReference to this in order to allow method chaining
setMaxListed(sMaxListed): sap.ui.commons.MessageList

Sets a new value for property maxListed.

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

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 7.

Parameters:
stringsMaxListedNew value for property maxListed
Returns:
sap.ui.commons.MessageListReference to this in order to allow method chaining
setMessages(aMessages): void
Sets the list of Messages to be displayed and re-renders this Control if it is visible.
Parameters:
sap.ui.commons.Message[]aMessagesMessage list.
setVisible(bVisible): sap.ui.commons.MessageList

Setter for property visible.

Default value is true

The default implementation of function "setVisible()" is overwritten in order to invoke the open() and close() of the MessageList Popup.

Parameters:
booleanbVisibleNew value for property visible
Returns:
sap.ui.commons.MessageListthis to allow method chaining