The responsive popover acts as a popover on desktop and tablet, while on phone it acts as a dialog with stretch
set to true.
Note: It is recommended that ResponsivePopover
is used in fragments otherwise there might be some implications on the user experience. For example, on desktop, open or close functions of the Popover
might not be called.
When you want to make sure that all content is visible on any device.
Constructor for a new ResponsivePopover.
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.ResponsivePopover(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 A popover-based control that behaves differently according to the device it is on. |
Name | Type | Default Value | Description |
---|---|---|---|
contentHeight | sap.ui.core.CSSSize | This property is supported by both variants. Please see the documentation on sap.m.Popover#contentHeight and sap.m.Dialog#contentHeight Visibility: public |
|
contentWidth | sap.ui.core.CSSSize | This property is supported by both variants. Please see the documentation on sap.m.Popover#contentWidth and sap.m.Dialog#contentWidth Visibility: public |
|
horizontalScrolling | boolean | true | This property is supported by both variants. Please see the documentation on sap.m.Popover#horizontalScrolling and sap.m.Dialog#horizontalScrolling Visibility: public |
icon | sap.ui.core.URI | This property only takes effect on phone. Please see the documentation sap.m.Dialog#icon. Visibility: public |
|
modal | boolean | This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#modal. Visibility: public |
|
offsetX | int | This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetX. Visibility: public |
|
offsetY | int | This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetY. Visibility: public |
|
placement | sap.m.PlacementType | Right | This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#placement. Visibility: public |
resizable | boolean | false | Whether resize option is enabled. |
showArrow | boolean | true | This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#showArrow. Visibility: public |
showCloseButton | boolean | true | Determines if a close button should be inserted into the dialog's header dynamically to close the dialog. This property only takes effect on phone. Note: The close button could be placed only in a sap.m.Bar if a sap.m.Toolbar is passed as a header - the property will not take effect. Visibility: public |
showHeader | boolean | true | This property is supported by both variants. Please see the documentation on sap.m.Popover#showHeader and sap.m.Dialog#showHeader Visibility: public |
title | string | This property is supported by both variants. Please see the documentation on sap.m.Popover#title and sap.m.Dialog#title Visibility: public |
|
titleAlignment | sap.m.TitleAlignment | Auto | Specifies the Title alignment (theme specific). If set to |
verticalScrolling | boolean | true | This property is supported by both variants. Please see the documentation on sap.m.Popover#verticalScrolling and sap.m.Dialog#verticalScrolling Visibility: public |
Default Aggregation: content
Name | Cardinality | Type | Description |
---|---|---|---|
_popup | 0..1 | sap.ui.core.Control |
The internal popup instance which is either a dialog on phone or a popover on the rest of platforms |
beginButton | 0..1 | sap.m.Button |
BeginButton is supported by both variants. It is always show in the left part (right part in RTL mode) of the footer which is located at the bottom of the ResponsivePopover. If buttons need to be displayed in header, please use customHeader instead. |
content (default) | 0..n | sap.ui.core.Control |
Content is supported by both variants. Please see the documentation on sap.m.Popover#content and sap.m.Dialog#content |
customHeader | 0..1 | sap.m.IBar |
CustomHeader is supported by both variants. Please see the documentation on sap.m.Popover#customHeader and sap.m.Dialog#customHeader |
endButton | 0..1 | sap.m.Button |
EndButton is supported by both variants. It is always show in the right part (left part in RTL mode) of the footer which is located at the bottom of the ResponsivePopover. If buttons need to be displayed in header, please use customHeader instead. |
subHeader | 0..1 | sap.m.IBar |
SubHeader is supported by both variants. Please see the documentation on sap.m.Popover#subHeader and sap.m.Dialog#subHeader |
Name | Cardinality | Type | Description |
---|---|---|---|
ariaDescribedBy | 0..n | sap.ui.core.Control |
Association to controls / IDs which describe this control (see WAI-ARIA attribute aria-describedby). |
ariaLabelledBy | 0..n | sap.ui.core.Control |
Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). |
initialFocus | 0..1 | sap.ui.core.Control |
InitialFocus is supported by both variants. Please see the documentation on sap.m.Popover#initialFocus and sap.m.Dialog#initialFocus |
Event | Description |
---|---|
afterClose |
Event is fired after popover or dialog is closed. |
afterOpen |
Event is fired after popover or dialog is open. |
beforeClose |
Event is fired before popover or dialog is closed. |
beforeOpen |
Event is fired before popover or dialog is open. |
Event is fired after popover or dialog is closed.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
openBy | sap.ui.core.Control |
This parameter contains the control which is passed as the parameter when calling openBy method. When runs on the phone, this parameter is undefined. |
origin | sap.m.Button |
This parameter contains the control which triggers the close of the ResponsivePopover. This parameter is undefined when runs on desktop or tablet. |
Event is fired after popover or dialog is open.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
openBy | sap.ui.core.Control |
This parameter contains the control which is passed as the parameter when calling openBy method. When runs on the phone, this parameter is undefined. |
Event is fired before popover or dialog is closed.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
openBy | sap.ui.core.Control |
This parameter contains the control which is passed as the parameter when calling openBy method. When runs on the phone, this parameter is undefined. |
origin | sap.m.Button |
This parameter contains the control which triggers the close of the ResponsivePopover. This parameter is undefined when runs on desktop or tablet. |
Event is fired before popover or dialog is open.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
openBy | sap.ui.core.Control |
This parameter contains the control which is passed as the parameter when calling openBy method. When runs on the phone, this parameter is undefined. |
Method | Description |
---|---|
addAriaDescribedBy |
Adds some ariaDescribedBy into the association ariaDescribedBy. |
addAriaLabelledBy |
Adds some ariaLabelledBy into the association ariaLabelledBy. |
addContent |
Adds content to the ResponsivePopover |
attachAfterClose |
Attaches event handler When called, the context of the event handler (its Event is fired after popover or dialog is closed. |
attachAfterOpen |
Attaches event handler When called, the context of the event handler (its Event is fired after popover or dialog is open. |
attachBeforeClose |
Attaches event handler When called, the context of the event handler (its Event is fired before popover or dialog is closed. |
attachBeforeOpen |
Attaches event handler When called, the context of the event handler (its Event is fired before popover or dialog is open. |
close |
Closes the ResponsivePopover. |
destroyBeginButton |
Destroys the beginButton in the aggregation beginButton. |
destroyContent |
Destroys all the content in the aggregation content. |
destroyCustomHeader |
Destroys the customHeader in the aggregation customHeader. |
destroyEndButton |
Destroys the endButton in the aggregation endButton. |
destroySubHeader |
Destroys the subHeader in the aggregation subHeader. |
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. |
sap.m.ResponsivePopover.extend |
Creates a new subclass of class sap.m.ResponsivePopover with name
|
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. |
getAriaDescribedBy |
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy. |
getAriaLabelledBy |
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy. |
getBeginButton |
Getter for beginButton aggregation |
getContent |
Gets content of aggregation content. Content is supported by both variants. Please see the documentation on sap.m.Popover#content and sap.m.Dialog#content |
getContentHeight |
Gets current value of property contentHeight. This property is supported by both variants. Please see the documentation on sap.m.Popover#contentHeight and sap.m.Dialog#contentHeight |
getContentWidth |
Gets current value of property contentWidth. This property is supported by both variants. Please see the documentation on sap.m.Popover#contentWidth and sap.m.Dialog#contentWidth |
getCustomHeader |
Gets content of aggregation customHeader. CustomHeader is supported by both variants. Please see the documentation on sap.m.Popover#customHeader and sap.m.Dialog#customHeader |
getEndButton |
Getter for endButton aggregation |
getHorizontalScrolling |
Gets current value of property horizontalScrolling. This property is supported by both variants. Please see the documentation on sap.m.Popover#horizontalScrolling and sap.m.Dialog#horizontalScrolling Default value is |
getIcon |
Gets current value of property icon. This property only takes effect on phone. Please see the documentation sap.m.Dialog#icon. |
getInitialFocus |
ID of the element which is the current target of the association initialFocus, or |
sap.m.ResponsivePopover.getMetadata |
Returns a metadata object for class sap.m.ResponsivePopover. |
getModal |
Gets current value of property modal. This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#modal. |
getOffsetX |
Gets current value of property offsetX. This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetX. |
getOffsetY |
Gets current value of property offsetY. This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetY. |
getPlacement |
Gets current value of property placement. This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#placement. Default value is |
getResizable |
Gets current value of property resizable. Whether resize option is enabled. Default value is |
getShowArrow |
Gets current value of property showArrow. This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#showArrow. Default value is |
getShowCloseButton |
Gets current value of property showCloseButton. Determines if a close button should be inserted into the dialog's header dynamically to close the dialog. This property only takes effect on phone. Note: The close button could be placed only in a sap.m.Bar if a sap.m.Toolbar is passed as a header - the property will not take effect. Default value is |
getShowHeader |
Gets current value of property showHeader. This property is supported by both variants. Please see the documentation on sap.m.Popover#showHeader and sap.m.Dialog#showHeader Default value is |
getSubHeader |
Gets content of aggregation subHeader. SubHeader is supported by both variants. Please see the documentation on sap.m.Popover#subHeader and sap.m.Dialog#subHeader |
getTitle |
Gets current value of property title. This property is supported by both variants. Please see the documentation on sap.m.Popover#title and sap.m.Dialog#title |
getTitleAlignment |
Gets current value of property titleAlignment. Specifies the Title alignment (theme specific). If set to Default value is |
getVerticalScrolling |
Gets current value of property verticalScrolling. This property is supported by both variants. Please see the documentation on sap.m.Popover#verticalScrolling and sap.m.Dialog#verticalScrolling Default value is |
indexOfContent |
Checks for the provided |
insertContent |
Inserts a content into the aggregation content. |
isOpen |
Checks whether the ResponsivePopover is currently open. |
openBy |
Opens the ResponsivePopover. The ResponsivePopover is positioned relatively to the control parameter on tablet or desktop and is full screen on phone. Therefore the control parameter is only used on tablet or desktop and is ignored on phone. |
removeAllAriaDescribedBy |
Removes all the controls in the association named ariaDescribedBy. |
removeAllAriaLabelledBy |
Removes all the controls in the association named ariaLabelledBy. |
removeAllContent |
Removes all the controls from the aggregation content. Additionally, it unregisters them from the hosting UIArea. |
removeAriaDescribedBy |
Removes an ariaDescribedBy from the association named ariaDescribedBy. |
removeAriaLabelledBy |
Removes an ariaLabelledBy from the association named ariaLabelledBy. |
removeContent |
Removes a content from the aggregation content. |
setBeginButton |
Setter for beginButton aggregation |
setContentHeight |
Sets a new value for property contentHeight. This property is supported by both variants. Please see the documentation on sap.m.Popover#contentHeight and sap.m.Dialog#contentHeight When called with a value of |
setContentWidth |
Sets a new value for property contentWidth. This property is supported by both variants. Please see the documentation on sap.m.Popover#contentWidth and sap.m.Dialog#contentWidth When called with a value of |
setCustomHeader |
Sets the aggregated customHeader. |
setEndButton |
Setter for endButton aggregation |
setHorizontalScrolling |
Sets a new value for property horizontalScrolling. This property is supported by both variants. Please see the documentation on sap.m.Popover#horizontalScrolling and sap.m.Dialog#horizontalScrolling When called with a value of Default value is |
setIcon |
Sets a new value for property icon. This property only takes effect on phone. Please see the documentation sap.m.Dialog#icon. When called with a value of |
setInitialFocus |
Sets the associated initialFocus. |
setModal |
Sets a new value for property modal. This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#modal. When called with a value of |
setOffsetX |
Sets a new value for property offsetX. This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetX. When called with a value of |
setOffsetY |
Sets a new value for property offsetY. This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetY. When called with a value of |
setPlacement |
Sets a new value for property placement. This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#placement. When called with a value of Default value is |
setResizable |
Sets a new value for property resizable. Whether resize option is enabled. When called with a value of Default value is |
setShowArrow |
Sets a new value for property showArrow. This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#showArrow. When called with a value of Default value is |
setShowCloseButton |
Determines if the close button to the ResponsivePopover is shown or not. Works only when ResponsivePopover is used as a dialog |
setShowHeader |
Sets a new value for property showHeader. This property is supported by both variants. Please see the documentation on sap.m.Popover#showHeader and sap.m.Dialog#showHeader When called with a value of Default value is |
setSubHeader |
Sets the aggregated subHeader. |
setTitle |
Sets a new value for property title. This property is supported by both variants. Please see the documentation on sap.m.Popover#title and sap.m.Dialog#title When called with a value of |
setTitleAlignment |
Sets a new value for property titleAlignment. Specifies the Title alignment (theme specific). If set to When called with a value of Default value is |
setVerticalScrolling |
Sets a new value for property verticalScrolling. This property is supported by both variants. Please see the documentation on sap.m.Popover#verticalScrolling and sap.m.Dialog#verticalScrolling When called with a value of Default value is |
Adds some ariaDescribedBy into the association ariaDescribedBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaDescribedBy | sap.ui.core.ID sap.ui.core.Control |
The ariaDescribedBy to add; if empty, nothing is inserted |
Adds some ariaLabelledBy into the association ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to add; if empty, nothing is inserted |
Adds content to the ResponsivePopover
Param | Type | DefaultValue | Description |
---|---|---|---|
oControl | sap.ui.core.Control |
The control to be added to the content |
Attaches event handler fnFunction
to the afterClose event of this sap.m.ResponsivePopover
.
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.ResponsivePopover
itself.
Event is fired after popover or dialog 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.ResponsivePopover
.
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.ResponsivePopover
itself.
Event is fired after popover or dialog is open.
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.ResponsivePopover
.
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.ResponsivePopover
itself.
Event is fired before popover or dialog 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.ResponsivePopover
.
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.ResponsivePopover
itself.
Event is fired before popover or dialog is open.
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 afterClose event of this sap.m.ResponsivePopover
.
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.ResponsivePopover
.
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.ResponsivePopover
.
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.ResponsivePopover
.
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.ResponsivePopover 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 afterClose to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
openBy | sap.ui.core.Control |
This parameter contains the control which is passed as the parameter when calling openBy method. When runs on the phone, this parameter is undefined. |
|
origin | sap.m.Button |
This parameter contains the control which triggers the close of the ResponsivePopover. This parameter is undefined when runs on desktop or tablet. |
Fires event afterOpen to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
openBy | sap.ui.core.Control |
This parameter contains the control which is passed as the parameter when calling openBy method. When runs on the phone, this parameter is undefined. |
Fires event beforeClose to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
openBy | sap.ui.core.Control |
This parameter contains the control which is passed as the parameter when calling openBy method. When runs on the phone, this parameter is undefined. |
|
origin | sap.m.Button |
This parameter contains the control which triggers the close of the ResponsivePopover. This parameter is undefined when runs on desktop or tablet. |
Fires event beforeOpen to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
openBy | sap.ui.core.Control |
This parameter contains the control which is passed as the parameter when calling openBy method. When runs on the phone, this parameter is undefined. |
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Gets content of aggregation content.
Content is supported by both variants. Please see the documentation on sap.m.Popover#content and sap.m.Dialog#content
Gets current value of property contentHeight.
This property is supported by both variants. Please see the documentation on sap.m.Popover#contentHeight and sap.m.Dialog#contentHeight
Gets current value of property contentWidth.
This property is supported by both variants. Please see the documentation on sap.m.Popover#contentWidth and sap.m.Dialog#contentWidth
Gets content of aggregation customHeader.
CustomHeader is supported by both variants. Please see the documentation on sap.m.Popover#customHeader and sap.m.Dialog#customHeader
Gets current value of property horizontalScrolling.
This property is supported by both variants. Please see the documentation on sap.m.Popover#horizontalScrolling and sap.m.Dialog#horizontalScrolling
Default value is true
.
Gets current value of property icon.
This property only takes effect on phone. Please see the documentation sap.m.Dialog#icon.
ID of the element which is the current target of the association initialFocus, or null
.
Gets current value of property modal.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#modal.
Gets current value of property offsetX.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetX.
Gets current value of property offsetY.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetY.
Gets current value of property placement.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#placement.
Default value is Right
.
Gets current value of property resizable.
Whether resize option is enabled.
Default value is false
.
Gets current value of property showArrow.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#showArrow.
Default value is true
.
Gets current value of property showCloseButton.
Determines if a close button should be inserted into the dialog's header dynamically to close the dialog. This property only takes effect on phone. Note: The close button could be placed only in a sap.m.Bar if a sap.m.Toolbar is passed as a header - the property will not take effect.
Default value is true
.
Gets current value of property showHeader.
This property is supported by both variants. Please see the documentation on sap.m.Popover#showHeader and sap.m.Dialog#showHeader
Default value is true
.
Gets content of aggregation subHeader.
SubHeader is supported by both variants. Please see the documentation on sap.m.Popover#subHeader and sap.m.Dialog#subHeader
Gets current value of property title.
This property is supported by both variants. Please see the documentation on sap.m.Popover#title and sap.m.Dialog#title
Gets current value of property titleAlignment.
Specifies the Title alignment (theme specific). If set to TitleAlignment.Auto
, the Title will be aligned as it is set in the theme (if not set, the default value is center
); Other possible values are TitleAlignment.Start
(left or right depending on LTR/RTL), and TitleAlignment.Center
(centered)
Default value is Auto
.
Gets current value of property verticalScrolling.
This property is supported by both variants. Please see the documentation on sap.m.Popover#verticalScrolling and sap.m.Dialog#verticalScrolling
Default value is true
.
Checks for the provided sap.ui.core.Control
in the aggregation content. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content whose index is looked for |
Inserts a content into the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Opens the ResponsivePopover. The ResponsivePopover is positioned relatively to the control parameter on tablet or desktop and is full screen on phone. Therefore the control parameter is only used on tablet or desktop and is ignored on phone.
Param | Type | DefaultValue | Description |
---|---|---|---|
oParent | object |
When this control is displayed on tablet or desktop, the ResponsivePopover is positioned relative to this control. |
Removes all the controls from the aggregation content.
Additionally, it unregisters them from the hosting UIArea.
Removes an ariaDescribedBy from the association named ariaDescribedBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaDescribedBy | int sap.ui.core.ID sap.ui.core.Control |
The ariaDescribedBy to be removed or its index or ID |
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | int sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to be removed or its index or ID |
Removes a content from the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
vContent | int string sap.ui.core.Control |
The content to remove or its index or id |
Setter for beginButton aggregation
Param | Type | DefaultValue | Description |
---|---|---|---|
oButton | sap.m.Button |
The button that will be set as an aggregation |
Sets a new value for property contentHeight.
This property is supported by both variants. Please see the documentation on sap.m.Popover#contentHeight and sap.m.Dialog#contentHeight
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sContentHeight | sap.ui.core.CSSSize |
New value for property |
Sets a new value for property contentWidth.
This property is supported by both variants. Please see the documentation on sap.m.Popover#contentWidth and sap.m.Dialog#contentWidth
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sContentWidth | sap.ui.core.CSSSize |
New value for property |
Sets the aggregated customHeader.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCustomHeader | sap.m.IBar |
The customHeader to set |
Setter for endButton aggregation
Param | Type | DefaultValue | Description |
---|---|---|---|
oButton | sap.m.Button |
The button that will be set as an aggregation |
Sets a new value for property horizontalScrolling.
This property is supported by both variants. Please see the documentation on sap.m.Popover#horizontalScrolling and sap.m.Dialog#horizontalScrolling
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 |
---|---|---|---|
bHorizontalScrolling | boolean | true |
New value for property |
Sets a new value for property icon.
This property only takes effect on phone. Please see the documentation sap.m.Dialog#icon.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIcon | sap.ui.core.URI |
New value for property |
Sets the associated initialFocus.
Param | Type | DefaultValue | Description |
---|---|---|---|
oInitialFocus | sap.ui.core.ID sap.ui.core.Control |
ID of an element which becomes the new target of this initialFocus association; alternatively, an element instance may be given |
Sets a new value for property modal.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#modal.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
bModal | boolean |
New value for property |
Sets a new value for property offsetX.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetX.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iOffsetX | int |
New value for property |
Sets a new value for property offsetY.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetY.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iOffsetY | int |
New value for property |
Sets a new value for property placement.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#placement.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Right
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sPlacement | sap.m.PlacementType | Right |
New value for property |
Sets a new value for property resizable.
Whether resize option is enabled.
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 |
---|---|---|---|
bResizable | boolean | false |
New value for property |
Sets a new value for property showArrow.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#showArrow.
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 |
---|---|---|---|
bShowArrow | boolean | true |
New value for property |
Determines if the close button to the ResponsivePopover is shown or not. Works only when ResponsivePopover is used as a dialog
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowCloseButton | boolean |
Defines whether the close button is shown |
Sets a new value for property showHeader.
This property is supported by both variants. Please see the documentation on sap.m.Popover#showHeader and sap.m.Dialog#showHeader
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 |
---|---|---|---|
bShowHeader | boolean | true |
New value for property |
Sets the aggregated subHeader.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSubHeader | sap.m.IBar |
The subHeader to set |
Sets a new value for property title.
This property is supported by both variants. Please see the documentation on sap.m.Popover#title and sap.m.Dialog#title
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitle | string |
New value for property |
Sets a new value for property titleAlignment.
Specifies the Title alignment (theme specific). If set to TitleAlignment.Auto
, the Title will be aligned as it is set in the theme (if not set, the default value is center
); Other possible values are TitleAlignment.Start
(left or right depending on LTR/RTL), and TitleAlignment.Center
(centered)
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Auto
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitleAlignment | sap.m.TitleAlignment | Auto |
New value for property |
Sets a new value for property verticalScrolling.
This property is supported by both variants. Please see the documentation on sap.m.Popover#verticalScrolling and sap.m.Dialog#verticalScrolling
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 |
---|---|---|---|
bVerticalScrolling | boolean | true |
New value for property |