class sap.ui.commons.MessageList

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/commons/MessageList
Application Component: CA-UI5-CTR

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


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.commons.MessageList(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
anchorId string

ID of the anchor under which the MessageList will render.

Visibility: public
maxListed string 7

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

Visibility: public
visible boolean false

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

Visibility: public

Methods Overview

Method Description
sap.ui.commons.MessageList.extend

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.

getAnchorId

Gets current value of property anchorId.

ID of the anchor under which the MessageList will render.

getMaxListed

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

sap.ui.commons.MessageList.getMetadata

Returns a metadata object for class sap.ui.commons.MessageList.

getVisible

Gets current value of property visible.

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

Default value is false.

setAnchorId

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.

setMaxListed

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

setMessages

Sets the list of Messages to be displayed and re-renders this Control if it is visible.

setVisible

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.

sap.ui.commons.MessageList.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getAnchorId

Gets current value of property anchorId.

ID of the anchor under which the MessageList will render.

getMaxListed

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

sap.ui.commons.MessageList.getMetadata

Returns a metadata object for class sap.ui.commons.MessageList.

getVisible

Gets current value of property visible.

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

Default value is false.

setAnchorId

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.

Param Type DefaultValue Description
sAnchorId string

New value for property anchorId

setMaxListed

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

Param Type DefaultValue Description
sMaxListed string '7'

New value for property maxListed

setMessages

Sets the list of Messages to be displayed and re-renders this Control if it is visible.

Param Type DefaultValue Description
aMessages sap.ui.commons.Message[]

Message list.

setVisible

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.

Param Type DefaultValue Description
bVisible boolean

New value for property visible