A MessagePopover
is used to display a summarized list of different types of messages (error, warning, success, and information messages).
It provides a handy and systematized way to navigate and explore details for every message. It is adaptive and responsive. It renders as a dialog with a Close button in the header on phones, and as a popover on tablets and higher resolution devices. It also exposes an event sap.m.MessagePopover#event:activeTitlePress, which can be used for navigation from a message to the source of the issue.
MessagePopover
, this could lead to outdated messages being shown. To avoid this, you need to call navigateBack
when the model is updated.markupDescription
has to be set to true
.MessagePopover
provides navigation to the detailed description. The MessagePopover
stores all messages in an aggregation of type sap.m.MessageItem named items
.
A set of properties determines how the items are rendered:
MessagePopover
is triggered from a messaging button in the footer toolbar. If an error has occurred at any validation point, the total number of messages should be incremented, but the user's work shouldn't be interrupted. Navigation between the message item and the source of the error can be created, if needed by the application. This can be done by setting the activeTitle
property to true
and providing a handler for the activeTitlePress
event. In addition, you can achieve the same functionality inside a different container using the sap.m.MessageView control. On mobile phones, the MessagePopover
is automatically shown in full screen mode.
On desktop and tablet, the message popover opens in a popover.
On desktop the opened popover is resizable, if it is placed in a sap.m.Toolbar, sap.m.Bar, or used in sap.m.semantic.SemanticPage.
Constructor for a new MessagePopover.
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.m.MessagePopover(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 |
Name | Type | Default Value | Description |
---|---|---|---|
asyncDescriptionHandler | any | Callback function for resolving a promise after description has been asynchronously loaded inside this function. You can use this function in order to validate the description before displaying it. Visibility: public |
|
asyncURLHandler | any | Callback function for resolving a promise after a link has been asynchronously validated inside this function. You can use this function in order to validate URLs before displaying them inside the description. Visibility: public |
|
groupItems | boolean | false | Defines whether the MessageItems are grouped or not. Visibility: public |
initiallyExpanded | boolean | true | Sets the initial state of the control - expanded or collapsed. By default the control opens as expanded. Note: If there is only one message in the control, this state will be ignored and the details page of the message will be shown. Visibility: public |
placement | sap.m.VerticalPlacementType | Vertical | Determines the position, where the control will appear on the screen. The default value is |
Default Aggregation: items
Name | Cardinality | Type | Description |
---|---|---|---|
headerButton | 0..1 | sap.m.Button |
Sets a custom header button. |
items (default) | 0..n | sap.m.MessageItem |
A list with message items. |
Event | Description |
---|---|
activeTitlePress |
Event fired when an active title of a |
afterClose |
Event fired after the popover is closed. |
afterOpen |
Event fired after the popover is opened. |
beforeClose |
Event fired before the popover is closed. |
beforeOpen |
Event fired before the popover is opened. |
itemSelect |
Event fired when description is shown. |
listSelect |
Event fired when one of the lists is shown when (not) filtered by type. |
longtextLoaded |
Event fired when the long text description data from a remote URL is loaded. |
urlValidated |
Event fired when a validation of a URL from long text description is ready. |
Event fired when an active title of a MessageItem
is clicked.
Since: 1.58.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
item | sap.m.MessageItem |
Refers to the message item that contains the activeTitle. |
Event fired after the popover is closed.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
openBy | sap.ui.core.Control |
Refers to the control that opens the popover. |
Event fired after the popover is opened.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
openBy | sap.ui.core.Control |
Refers to the control that opens the popover. |
Event fired before the popover is closed.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
openBy | sap.ui.core.Control |
Refers to the control that opens the popover. See sap.ui.core.MessageType enum values for types. |
Event fired before the popover is opened.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
openBy | sap.ui.core.Control |
Refers to the control that opens the popover. |
Event fired when description is shown.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
item | sap.m.MessagePopoverItem |
Refers to the |
messageTypeFilter | sap.ui.core.MessageType |
Refers to the type of messages being shown. |
Event fired when one of the lists is shown when (not) filtered by type.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
messageTypeFilter | sap.ui.core.MessageType |
This parameter refers to the type of messages being shown. |
Method | Description |
---|---|
addItem |
Adds some item to the aggregation items. |
attachActiveTitlePress |
Attaches event handler When called, the context of the event handler (its Event fired when an active title of a |
attachAfterClose |
Attaches event handler When called, the context of the event handler (its Event fired after the popover is closed. |
attachAfterOpen |
Attaches event handler When called, the context of the event handler (its Event fired after the popover is opened. |
attachBeforeClose |
Attaches event handler When called, the context of the event handler (its Event fired before the popover is closed. |
attachBeforeOpen |
Attaches event handler When called, the context of the event handler (its Event fired before the popover is opened. |
attachItemSelect |
Attaches event handler When called, the context of the event handler (its Event fired when description is shown. |
attachListSelect |
Attaches event handler When called, the context of the event handler (its Event fired when one of the lists is shown when (not) filtered by type. |
attachLongtextLoaded |
Attaches event handler When called, the context of the event handler (its Event fired when the long text description data from a remote URL is loaded. |
attachUrlValidated |
Attaches event handler When called, the context of the event handler (its Event fired when a validation of a URL from long text description is ready. |
close |
Closes the MessagePopover |
destroyHeaderButton |
Destroys the headerButton in the aggregation headerButton. |
destroyItems |
Destroys all the items in the aggregation items. |
detachActiveTitlePress |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachAfterClose |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachAfterOpen |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachBeforeClose |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachBeforeOpen |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachItemSelect |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachListSelect |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachLongtextLoaded |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachUrlValidated |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.m.MessagePopover.extend |
Creates a new subclass of class sap.m.MessagePopover with name
|
fireActiveTitlePress |
Fires event activeTitlePress to attached listeners. |
fireAfterClose |
Fires event afterClose to attached listeners. |
fireAfterOpen |
Fires event afterOpen to attached listeners. |
fireBeforeClose |
Fires event beforeClose to attached listeners. |
fireBeforeOpen |
Fires event beforeOpen to attached listeners. |
fireItemSelect |
Fires event itemSelect to attached listeners. |
fireListSelect |
Fires event listSelect to attached listeners. |
fireLongtextLoaded |
Fires event longtextLoaded to attached listeners. |
fireUrlValidated |
Fires event urlValidated to attached listeners. |
getAsyncDescriptionHandler |
Gets current value of property asyncDescriptionHandler. Callback function for resolving a promise after description has been asynchronously loaded inside this function. You can use this function in order to validate the description before displaying it. |
getAsyncURLHandler |
Gets current value of property asyncURLHandler. Callback function for resolving a promise after a link has been asynchronously validated inside this function. You can use this function in order to validate URLs before displaying them inside the description. |
getGroupItems |
Gets current value of property groupItems. Defines whether the MessageItems are grouped or not. Default value is |
getHeaderButton |
Gets content of aggregation headerButton. Sets a custom header button. |
getInitiallyExpanded |
Gets current value of property initiallyExpanded. Sets the initial state of the control - expanded or collapsed. By default the control opens as expanded. Note: If there is only one message in the control, this state will be ignored and the details page of the message will be shown. Default value is |
getItems |
Gets content of aggregation items. A list with message items. |
sap.m.MessagePopover.getMetadata |
Returns a metadata object for class sap.m.MessagePopover. |
getPlacement |
Gets current value of property placement. Determines the position, where the control will appear on the screen. The default value is Default value is |
indexOfItem |
Checks for the provided |
insertItem |
Inserts a item into the aggregation items. |
isOpen |
The method checks if the MessagePopover is open. It returns true when the MessagePopover is currently open (this includes opening and closing animations), otherwise it returns false |
navigateBack |
Navigates back to the list page. |
openBy |
Opens the MessagePopover |
removeAllItems |
Removes all the controls from the aggregation items. Additionally, it unregisters them from the hosting UIArea. |
removeItem |
Removes a item from the aggregation items. |
setAsyncDescriptionHandler |
Sets a new value for property asyncDescriptionHandler. Callback function for resolving a promise after description has been asynchronously loaded inside this function. You can use this function in order to validate the description before displaying it. When called with a value of |
setAsyncURLHandler |
Sets a new value for property asyncURLHandler. Callback function for resolving a promise after a link has been asynchronously validated inside this function. You can use this function in order to validate URLs before displaying them inside the description. When called with a value of |
sap.m.MessagePopover.setDefaultHandlers |
Setter for default description and URL validation callbacks across all instances of MessagePopover |
setGroupItems |
Sets a new value for property groupItems. Defines whether the MessageItems are grouped or not. When called with a value of Default value is |
setHeaderButton |
Sets the aggregated headerButton. |
setInitiallyExpanded |
Sets a new value for property initiallyExpanded. Sets the initial state of the control - expanded or collapsed. By default the control opens as expanded. Note: If there is only one message in the control, this state will be ignored and the details page of the message will be shown. When called with a value of Default value is |
setPlacement |
Sets a new value for property placement. Determines the position, where the control will appear on the screen. The default value is When called with a value of Default value is |
toggle |
This method toggles between open and closed state of the MessagePopover instance. oControl parameter is mandatory in the same way as in 'openBy' method |
Adds some item to the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
vItem | sap.m.MessageItem sap.m.MessagePopoverItem |
The item to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the activeTitlePress event of this sap.m.MessagePopover
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.MessagePopover
itself.
Event fired when an active title of a MessageItem
is clicked.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the afterClose event of this sap.m.MessagePopover
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.MessagePopover
itself.
Event fired after the popover is closed.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the afterOpen event of this sap.m.MessagePopover
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.MessagePopover
itself.
Event fired after the popover is opened.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the beforeClose event of this sap.m.MessagePopover
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.MessagePopover
itself.
Event fired before the popover is closed.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the beforeOpen event of this sap.m.MessagePopover
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.MessagePopover
itself.
Event fired before the popover is opened.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the itemSelect event of this sap.m.MessagePopover
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.MessagePopover
itself.
Event fired when description is shown.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the listSelect event of this sap.m.MessagePopover
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.MessagePopover
itself.
Event fired when one of the lists is shown when (not) filtered by type.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the longtextLoaded event of this sap.m.MessagePopover
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.MessagePopover
itself.
Event fired when the long text description data from a remote URL is loaded.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Attaches event handler fnFunction
to the urlValidated event of this sap.m.MessagePopover
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.MessagePopover
itself.
Event fired when a validation of a URL from long text description is ready.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Detaches event handler fnFunction
from the activeTitlePress event of this sap.m.MessagePopover
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the afterClose event of this sap.m.MessagePopover
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the afterOpen event of this sap.m.MessagePopover
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the beforeClose event of this sap.m.MessagePopover
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the beforeOpen event of this sap.m.MessagePopover
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the itemSelect event of this sap.m.MessagePopover
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the listSelect event of this sap.m.MessagePopover
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the longtextLoaded event of this sap.m.MessagePopover
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Detaches event handler fnFunction
from the urlValidated event of this sap.m.MessagePopover
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Creates a new subclass of class sap.m.MessagePopover 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 |
Fires event activeTitlePress to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
item | sap.m.MessageItem |
Refers to the message item that contains the activeTitle. |
Fires event afterClose to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
openBy | sap.ui.core.Control |
Refers to the control that opens the popover. |
Fires event afterOpen to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
openBy | sap.ui.core.Control |
Refers to the control that opens the popover. |
Fires event beforeClose to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
openBy | sap.ui.core.Control |
Refers to the control that opens the popover. See sap.ui.core.MessageType enum values for types. |
Fires event beforeOpen to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
openBy | sap.ui.core.Control |
Refers to the control that opens the popover. |
Fires event itemSelect to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
item | sap.m.MessagePopoverItem |
Refers to the |
|
messageTypeFilter | sap.ui.core.MessageType |
Refers to the type of messages being shown. |
Fires event listSelect to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
messageTypeFilter | sap.ui.core.MessageType |
This parameter refers to the type of messages being shown. |
Fires event longtextLoaded to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event urlValidated to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Gets current value of property asyncDescriptionHandler.
Callback function for resolving a promise after description has been asynchronously loaded inside this function. You can use this function in order to validate the description before displaying it.
Gets current value of property asyncURLHandler.
Callback function for resolving a promise after a link has been asynchronously validated inside this function. You can use this function in order to validate URLs before displaying them inside the description.
Gets current value of property groupItems.
Defines whether the MessageItems are grouped or not.
Default value is false
.
Gets current value of property initiallyExpanded.
Sets the initial state of the control - expanded or collapsed. By default the control opens as expanded. Note: If there is only one message in the control, this state will be ignored and the details page of the message will be shown.
Default value is true
.
Gets current value of property placement.
Determines the position, where the control will appear on the screen. The default value is sap.m.VerticalPlacementType.Vertical
. Setting this property while the control is open, will not cause any re-rendering and changing of the position. Changes will only be applied with the next interaction.
Default value is "Vertical"
.
Checks for the provided sap.m.MessageItem
in the aggregation items. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
vItem | sap.m.MessageItem sap.m.MessagePopoverItem |
The item whose index is looked for |
Inserts a item into the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
vItem | sap.m.MessageItem sap.m.MessagePopoverItem |
The item to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
The method checks if the MessagePopover is open. It returns true when the MessagePopover is currently open (this includes opening and closing animations), otherwise it returns false
Opens the MessagePopover
Param | Type | DefaultValue | Description |
---|---|---|---|
oControl | sap.ui.core.Control |
Control which opens the MessagePopover |
Removes all the controls from the aggregation items.
Additionally, it unregisters them from the hosting UIArea.
Removes a item from the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
vItem | int string sap.m.MessageItem sap.m.MessagePopoverItem |
The item to remove or its index or id |
Sets a new value for property asyncDescriptionHandler.
Callback function for resolving a promise after description has been asynchronously loaded inside this function. You can use this function in order to validate the description before displaying it.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAsyncDescriptionHandler | any |
New value for property |
Sets a new value for property asyncURLHandler.
Callback function for resolving a promise after a link has been asynchronously validated inside this function. You can use this function in order to validate URLs before displaying them inside the description.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAsyncURLHandler | any |
New value for property |
Setter for default description and URL validation callbacks across all instances of MessagePopover
Param | Type | DefaultValue | Description |
---|---|---|---|
mDefaultHandlers | object |
An object setting default callbacks |
|
asyncDescriptionHandler | function |
The description handler |
|
asyncURLHandler | function |
The URL handler |
Sets a new value for property groupItems.
Defines whether the MessageItems are grouped or not.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bGroupItems | boolean | false |
New value for property |
Sets the aggregated headerButton.
Param | Type | DefaultValue | Description |
---|---|---|---|
oHeaderButton | sap.m.Button |
The headerButton to set |
Sets a new value for property initiallyExpanded.
Sets the initial state of the control - expanded or collapsed. By default the control opens as expanded. Note: If there is only one message in the control, this state will be ignored and the details page of the message will be shown.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bInitiallyExpanded | boolean | true |
New value for property |
Sets a new value for property placement.
Determines the position, where the control will appear on the screen. The default value is sap.m.VerticalPlacementType.Vertical
. Setting this property while the control is open, will not cause any re-rendering and changing of the position. Changes will only be applied with the next interaction.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "Vertical"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sPlacement | sap.m.VerticalPlacementType | "Vertical" |
New value for property |
This method toggles between open and closed state of the MessagePopover instance. oControl parameter is mandatory in the same way as in 'openBy' method
Param | Type | DefaultValue | Description |
---|---|---|---|
oControl | sap.ui.core.Control |
Control which opens the MessagePopover |