Class sap.m.MessagePopoverModule: sap/m/MessagePopover

extends Control

A summarized list of different types of messages.

Overview

A message popover is used to display a summarized list of different types of messages (errors, warnings, success and information). It provides a handy and systemized way to navigate and explore details for every message.

Notes:

  • Messages can have descriptions pre-formatted with HTML markup. In this case, the markupDescription has to be set to true.
  • If the message cannot be fully displayed or includes a long description, the message popover provides navigation to the detailed description.

Structure

The message popover stores all messages in an association of type sap.m.MessageItem named items.

A set of properties determines how the items are rendered:

  • counter - An integer that is used to indicate the number of errors for each type
  • type - The type of message
  • title/subtitle - The title and subtitle of the message
  • description - The long text description of the message

Usage

With the message concept, MessagePopover provides a way to centrally manage messages and show them to the user without additional work for the developer. The message popover 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.

Responsive Behavior

On mobile phones, the message popover is automatically shown in full screen mode.


Since: 1.28.
Constructor Summary
new sap.m.MessagePopover(sId?, mSettings?)Constructor for a new MessagePopover.
Event Summary
afterClose(oControlEvent)This event will be fired after the popover is closed
afterOpen(oControlEvent)This event will be fired after the popover is opened
beforeClose(oControlEvent)This event will be fired before the popover is closed
beforeOpen(oControlEvent)This event will be fired before the popover is opened
itemSelect(oControlEvent)This event will be fired when description is shown
listSelect(oControlEvent)This event will be fired when one of the lists is shown when (not) filtered by type
longtextLoaded(oControlEvent)This event will be fired when the long text description data from a remote URL is loaded
urlValidated(oControlEvent)This event will be fired when a validation of a URL from long text description is ready
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.MessagePopover.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.MessagePopover with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.MessagePopover.getMetadata()Returns a metadata object for class sap.m.MessagePopover.
sap.m.MessagePopover.setDefaultHandlers(mDefaultHandlers)Setter for default description and URL validation callbacks across all instances of MessagePopover
addItem(vItem)Adds some item to the aggregation items.
attachAfterClose(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterClose event of this sap.m.MessagePopover.
attachAfterOpen(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the afterOpen event of this sap.m.MessagePopover.
attachBeforeClose(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beforeClose event of this sap.m.MessagePopover.
attachBeforeOpen(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beforeOpen event of this sap.m.MessagePopover.
attachItemSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the itemSelect event of this sap.m.MessagePopover.
attachListSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the listSelect event of this sap.m.MessagePopover.
attachLongtextLoaded(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the longtextLoaded event of this sap.m.MessagePopover.
attachUrlValidated(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the urlValidated event of this sap.m.MessagePopover.
close()Closes the MessagePopover
destroyHeaderButton()Destroys the headerButton in the aggregation headerButton.
destroyItems()Destroys all the items in the aggregation items.
detachAfterClose(fnFunction, oListener)Detaches event handler fnFunction from the afterClose event of this sap.m.MessagePopover.
detachAfterOpen(fnFunction, oListener)Detaches event handler fnFunction from the afterOpen event of this sap.m.MessagePopover.
detachBeforeClose(fnFunction, oListener)Detaches event handler fnFunction from the beforeClose event of this sap.m.MessagePopover.
detachBeforeOpen(fnFunction, oListener)Detaches event handler fnFunction from the beforeOpen event of this sap.m.MessagePopover.
detachItemSelect(fnFunction, oListener)Detaches event handler fnFunction from the itemSelect event of this sap.m.MessagePopover.
detachListSelect(fnFunction, oListener)Detaches event handler fnFunction from the listSelect event of this sap.m.MessagePopover.
detachLongtextLoaded(fnFunction, oListener)Detaches event handler fnFunction from the longtextLoaded event of this sap.m.MessagePopover.
detachUrlValidated(fnFunction, oListener)Detaches event handler fnFunction from the urlValidated event of this sap.m.MessagePopover.
fireAfterClose(mParameters?)Fires event afterClose to attached listeners.
fireAfterOpen(mParameters?)Fires event afterOpen to attached listeners.
fireBeforeClose(mParameters?)Fires event beforeClose to attached listeners.
fireBeforeOpen(mParameters?)Fires event beforeOpen to attached listeners.
fireItemSelect(mParameters?)Fires event itemSelect to attached listeners.
fireListSelect(mParameters?)Fires event listSelect to attached listeners.
fireLongtextLoaded(mParameters?)Fires event longtextLoaded to attached listeners.
fireUrlValidated(mParameters?)Fires event urlValidated to attached listeners.
getAsyncDescriptionHandler()Gets current value of property asyncDescriptionHandler.
getAsyncURLHandler()Gets current value of property asyncURLHandler.
getHeaderButton()Gets content of aggregation headerButton.
getInitiallyExpanded()Gets current value of property initiallyExpanded.
getItems()Gets content of aggregation items.
getPlacement()Gets current value of property placement.
indexOfItem(vItem)Checks for the provided sap.m.MessageItem in the aggregation items.
insertItem(vItem, iIndex)Inserts a item into the aggregation items.
isOpen()The method checks if the MessagePopover is open.
openBy(oControl)Opens the MessagePopover
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setAsyncDescriptionHandler(oAsyncDescriptionHandler)Sets a new value for property asyncDescriptionHandler.
setAsyncURLHandler(oAsyncURLHandler)Sets a new value for property asyncURLHandler.
setHeaderButton(oHeaderButton)Sets the aggregated headerButton.
setInitiallyExpanded(bInitiallyExpanded)Sets a new value for property initiallyExpanded.
toggle(oControl)This method toggles between open and closed state of the MessagePopover instance.
Constructor Detail
new sap.m.MessagePopover(sId?, mSettings?)

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

The supported settings are:

  • Properties

  • Aggregations

    • items : (sap.m.MessageItem|sap.m.MessagePopoverItem)[] (default)
    • headerButton : sap.m.Button

  • Events

    • afterOpen : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • afterClose : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • beforeOpen : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • beforeClose : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • itemSelect : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • listSelect : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • longtextLoaded : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • urlValidated : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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
Event Detail
afterClose(oControlEvent)
This event will be fired after the popover is closed
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.ControloControlEvent.getParameters.openByRefers to the control which opens the popover
afterOpen(oControlEvent)
This event will be fired after the popover is opened
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.ControloControlEvent.getParameters.openByThis refers to the control which opens the popover
beforeClose(oControlEvent)
This event will be fired before the popover is closed
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.ControloControlEvent.getParameters.openByRefers to the control which opens the popover See sap.ui.core.MessageType enum values for types
beforeOpen(oControlEvent)
This event will be fired before the popover is opened
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.ControloControlEvent.getParameters.openByRefers to the control which opens the popover
itemSelect(oControlEvent)
This event will be fired when description is shown
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.m.MessagePopoverItemoControlEvent.getParameters.itemRefers to the message popover item that is being presented
sap.ui.core.MessageTypeoControlEvent.getParameters.messageTypeFilterRefers to the type of messages being shown See sap.ui.core.MessageType values for types
listSelect(oControlEvent)
This event will be fired when one of the lists is shown when (not) filtered by type
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.MessageTypeoControlEvent.getParameters.messageTypeFilterThis parameter refers to the type of messages being shown.
longtextLoaded(oControlEvent)
This event will be fired when the long text description data from a remote URL is loaded
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
urlValidated(oControlEvent)
This event will be fired when a validation of a URL from long text description is ready
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
Method Detail
sap.m.MessagePopover.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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.m.MessagePopover.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.MessagePopover.
Returns:
sap.ui.base.MetadataMetadata object describing this class
sap.m.MessagePopover.setDefaultHandlers(mDefaultHandlers)
Setter for default description and URL validation callbacks across all instances of MessagePopover
Parameters:
objectmDefaultHandlersAn object setting default callbacks
functionmDefaultHandlers.asyncDescriptionHandler
functionmDefaultHandlers.asyncURLHandler
addItem(vItem): sap.m.MessagePopover
Adds some item to the aggregation items.
Parameters:
sap.m.MessageItem|sap.m.MessagePopoverItemvItemthe item to add; if empty, nothing is inserted
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
attachAfterClose(oData?, fnFunction, oListener?): sap.m.MessagePopover

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.

This event will be fired after the popover is closed

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.MessagePopover itself
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
attachAfterOpen(oData?, fnFunction, oListener?): sap.m.MessagePopover

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.

This event will be fired after the popover is opened

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.MessagePopover itself
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
attachBeforeClose(oData?, fnFunction, oListener?): sap.m.MessagePopover

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.

This event will be fired before the popover is closed

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.MessagePopover itself
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
attachBeforeOpen(oData?, fnFunction, oListener?): sap.m.MessagePopover

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.

This event will be fired before the popover is opened

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.MessagePopover itself
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
attachItemSelect(oData?, fnFunction, oListener?): sap.m.MessagePopover

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.

This event will be fired when description is shown

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.MessagePopover itself
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
attachListSelect(oData?, fnFunction, oListener?): sap.m.MessagePopover

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.

This event will be fired when one of the lists is shown when (not) filtered by type

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.MessagePopover itself
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
attachLongtextLoaded(oData?, fnFunction, oListener?): sap.m.MessagePopover

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.

This event will be fired when the long text description data from a remote URL is loaded

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.MessagePopover itself
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
attachUrlValidated(oData?, fnFunction, oListener?): sap.m.MessagePopover

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.

This event will be fired when a validation of a URL from long text description is ready

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.MessagePopover itself
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
Closes the MessagePopover
Returns:
sap.m.MessagePopoverReference to the 'this' for chaining purposes
destroyHeaderButton(): sap.m.MessagePopover
Destroys the headerButton in the aggregation headerButton.
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
destroyItems(): sap.m.MessagePopover
Destroys all the items in the aggregation items.
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
detachAfterClose(fnFunction, oListener): sap.m.MessagePopover

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
detachAfterOpen(fnFunction, oListener): sap.m.MessagePopover

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
detachBeforeClose(fnFunction, oListener): sap.m.MessagePopover

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
detachBeforeOpen(fnFunction, oListener): sap.m.MessagePopover

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
detachItemSelect(fnFunction, oListener): sap.m.MessagePopover

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
detachListSelect(fnFunction, oListener): sap.m.MessagePopover

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
detachLongtextLoaded(fnFunction, oListener): sap.m.MessagePopover

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
detachUrlValidated(fnFunction, oListener): sap.m.MessagePopover

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.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
fireAfterClose(mParameters?): sap.m.MessagePopover
Fires event afterClose to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.ControlmParameters.openBy?Refers to the control which opens the popover
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
fireAfterOpen(mParameters?): sap.m.MessagePopover
Fires event afterOpen to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.ControlmParameters.openBy?This refers to the control which opens the popover
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
fireBeforeClose(mParameters?): sap.m.MessagePopover
Fires event beforeClose to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.ControlmParameters.openBy?Refers to the control which opens the popover See sap.ui.core.MessageType enum values for types
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
fireBeforeOpen(mParameters?): sap.m.MessagePopover
Fires event beforeOpen to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.ControlmParameters.openBy?Refers to the control which opens the popover
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
fireItemSelect(mParameters?): sap.m.MessagePopover
Fires event itemSelect to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.m.MessagePopoverItemmParameters.item?Refers to the message popover item that is being presented
sap.ui.core.MessageTypemParameters.messageTypeFilter?Refers to the type of messages being shown See sap.ui.core.MessageType values for types
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
fireListSelect(mParameters?): sap.m.MessagePopover
Fires event listSelect to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.MessageTypemParameters.messageTypeFilter?This parameter refers to the type of messages being shown.
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
fireLongtextLoaded(mParameters?): sap.m.MessagePopover
Fires event longtextLoaded to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
fireUrlValidated(mParameters?): sap.m.MessagePopover
Fires event urlValidated to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
getAsyncDescriptionHandler(): any

Gets current value of property asyncDescriptionHandler.

Callback function for resolving a promise after description has been asynchronously loaded inside this function

Returns:
anyValue of property asyncDescriptionHandler
getAsyncURLHandler(): any

Gets current value of property asyncURLHandler.

Callback function for resolving a promise after a link has been asynchronously validated inside this function

Returns:
anyValue of property asyncURLHandler
getHeaderButton(): sap.m.Button

Gets content of aggregation headerButton.

A custom header button

Returns:
sap.m.Button
getInitiallyExpanded(): boolean

Gets current value of property initiallyExpanded.

Sets the initial state of the control - expanded or collapsed. By default the control opens as expanded

Default value is true.

Returns:
booleanValue of property initiallyExpanded
getItems()

Gets content of aggregation items.

A list with message items

Gets current value of property placement.

Determines the position, where the control will appear on the screen. Possible values are: sap.m.VerticalPlacementType.Top, sap.m.VerticalPlacementType.Bottom and sap.m.VerticalPlacementType.Vertical. 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.

Returns:
sap.m.VerticalPlacementTypeValue of property placement
indexOfItem(vItem): int
Checks for the provided sap.m.MessageItem in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
sap.m.MessageItem|sap.m.MessagePopoverItemvItemThe item whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertItem(vItem, iIndex): sap.m.MessagePopover
Inserts a item into the aggregation items.
Parameters:
sap.m.MessageItem|sap.m.MessagePopoverItemvItemthe item to insert; if empty, nothing is inserted
intiIndexthe 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
isOpen(): boolean
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
Returns:
booleanWhether the MessagePopover is open
openBy(oControl): sap.m.MessagePopover
Opens the MessagePopover
Parameters:
sap.ui.core.ControloControlControl which opens the MessagePopover
Returns:
sap.m.MessagePopoverReference to the 'this' for chaining purposes
removeAllItems()

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Removes a item from the aggregation items.
Parameters:
int|string|sap.m.MessageItem|sap.m.MessagePopoverItemvItemThe item to remove or its index or id
Returns:
sap.m.MessageItem|sap.m.MessagePopoverItemThe removed item or null
setAsyncDescriptionHandler(oAsyncDescriptionHandler): sap.m.MessagePopover

Sets a new value for property asyncDescriptionHandler.

Callback function for resolving a promise after description has been asynchronously loaded inside this function

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

Parameters:
anyoAsyncDescriptionHandlerNew value for property asyncDescriptionHandler
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
setAsyncURLHandler(oAsyncURLHandler): sap.m.MessagePopover

Sets a new value for property asyncURLHandler.

Callback function for resolving a promise after a link has been asynchronously validated inside this function

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

Parameters:
anyoAsyncURLHandlerNew value for property asyncURLHandler
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
setHeaderButton(oHeaderButton): sap.m.MessagePopover
Sets the aggregated headerButton.
Parameters:
sap.m.ButtonoHeaderButtonThe headerButton to set
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
setInitiallyExpanded(bInitiallyExpanded): sap.m.MessagePopover

Sets a new value for property initiallyExpanded.

Sets the initial state of the control - expanded or collapsed. By default the control opens as expanded

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

Default value is true.

Parameters:
booleanbInitiallyExpandedNew value for property initiallyExpanded
Returns:
sap.m.MessagePopoverReference to this in order to allow method chaining
toggle(oControl): sap.m.MessagePopover
This method toggles between open and closed state of the MessagePopover instance. oControl parameter is mandatory in the same way as in 'openBy' method
Parameters:
sap.ui.core.ControloControlControl which opens the MessagePopover
Returns:
sap.m.MessagePopoverReference to the 'this' for chaining purposes