sap.m.ResponsivePopover.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.
Parameters:
{string} | sClassName | Name of the class being created |
{object} | oClassInfo? | Object literal with information about the class |
{function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
Returns:
{function} | Created class / constructor function |
Returns a metadata object for class sap.m.ResponsivePopover.
Returns:
Adds some ariaDescribedBy into the association ariaDescribedBy
.
Parameters:
{string|sap.ui.core.Control} | vAriaDescribedBy | the ariaDescribedBy to add; if empty, nothing is inserted |
Returns:
addContent(oControl)
Adds content to the ResponsivePopover
Parameters:
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.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover itself |
Returns:
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.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover itself |
Returns:
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.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover itself |
Returns:
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.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.m.ResponsivePopover itself |
Returns:
Creates a new instance of ResponsivePopover with the same settings as the ResponsivePopover on which the method is called
Returns:
Closes the ResponsivePopover.
Returns:
Destroys the beginButton in the aggregation beginButton
.
Returns:
Destroys all the content in the aggregation content
.
Returns:
Destroys the customHeader in the aggregation customHeader
.
Returns:
Destroys the endButton in the aggregation endButton
.
Returns:
Destroys the subHeader in the aggregation subHeader
.
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
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.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Fires event
afterClose
to attached listeners.
Expects the following event parameters:
openBy
of type 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
of type 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.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
afterOpen
to attached listeners.
Expects the following event parameters:
openBy
of type 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.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
beforeClose
to attached listeners.
Expects the following event parameters:
openBy
of type 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
of type 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.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
beforeOpen
to attached listeners.
Expects the following event parameters:
openBy
of type 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.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy
.
Returns:
Getter for beginButton aggregation
Returns:
{sap.m.Button} | The button that is set as a beginButton aggregation |
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
Returns:
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
Returns:
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
Returns:
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
Returns:
Getter for endButton aggregation
Returns:
{sap.m.Button} | The button that is set as a endButton aggregation |
getHorizontalScrolling(): boolean
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
.
Returns:
{boolean} | Value of property horizontalScrolling |
Gets current value of property
icon
.
This property only takes effect on phone. Please see the documentation sap.m.Dialog#icon.
Returns:
ID of the element which is the current target of the association initialFocus
, or null
.
Returns:
getModal(): boolean
Gets current value of property
modal
.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#modal.
Returns:
{boolean} | Value of property modal |
getOffsetX(): int
Gets current value of property
offsetX
.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetX.
Returns:
{int} | Value of property offsetX |
getOffsetY(): int
Gets current value of property
offsetY
.
This property only takes effect on desktop or tablet. Please see the documentation sap.m.Popover#offsetY.
Returns:
{int} | Value of property 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
.
Returns:
getResizable(): boolean
Gets current value of property
resizable
.
Whether resize option is enabled.
Default value is false
.
Experimental API:since 1.36.4 Do not use directly on ResponsivePopover while in experimental mode!
- Experimental:
- since 1.36.4 Do not use directly on ResponsivePopover while in experimental mode!
- Since:
- 1.36.4
Returns:
{boolean} | Value of property resizable |
getShowCloseButton(): boolean
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.
Default value is true
.
Returns:
{boolean} | Value of property showCloseButton |
getShowHeader(): boolean
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
.
Returns:
{boolean} | Value of property showHeader |
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
Returns:
getTitle(): string
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
Returns:
{string} | Value of property title |
getVerticalScrolling(): boolean
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
.
Returns:
{boolean} | Value of property verticalScrolling |
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control
in the aggregation content
. and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a content into the aggregation content
.
Parameters:
{sap.ui.core.Control} | oContent | the content to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the content should be inserted at; for a negative value of iIndex , the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position |
Returns:
Checks whether the ResponsivePopover is currently open.
Returns:
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.
Parameters:
{object} | oControl | When this control is displayed on tablet or desktop, the ResponsivePopover is positioned relatively to this control. |
Returns:
Removes all the controls in the association named ariaDescribedBy
.
Returns:
Removes all the controls from the aggregation
content
.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes an ariaDescribedBy from the association named ariaDescribedBy
.
Parameters:
{int|string|sap.ui.core.Control} | vAriaDescribedBy | The ariaDescribedByto be removed or its index or ID |
Returns:
Removes a content from the aggregation content
.
Parameters:
Returns:
Setter for beginButton aggregation
Parameters:
{sap.m.Button} | oButton | The button that will be set as an aggregation |
Returns:
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.
Parameters:
Returns:
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.
Parameters:
Returns:
Sets the aggregated customHeader
.
Parameters:
Returns:
Setter for endButton aggregation
Parameters:
{sap.m.Button} | oButton | The button that will be set as an aggregation |
Returns:
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
.
Parameters:
{boolean} | bHorizontalScrolling | New value for property horizontalScrolling |
Returns:
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.
Parameters:
Returns:
Sets the associated initialFocus
.
Parameters:
{sap.ui.core.Control} | oInitialFocus | Id of an element which becomes the new target of this initialFocus association; alternatively, an element instance may be given |
Returns:
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.
Parameters:
{boolean} | bModal | New value for property modal |
Returns:
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.
Parameters:
{int} | iOffsetX | New value for property offsetX |
Returns:
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.
Parameters:
{int} | iOffsetY | New value for property offsetY |
Returns:
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
.
Parameters:
Returns:
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
.
Experimental API:since 1.36.4 Do not use directly on ResponsivePopover while in experimental mode!
Parameters:
{boolean} | bResizable | New value for property resizable |
- Experimental:
- since 1.36.4 Do not use directly on ResponsivePopover while in experimental mode!
- Since:
- 1.36.4
Returns:
Determines if the close button to the ResponsivePopover is shown or not. Works only when ResponsivePopover is used as a dialog
Parameters:
{boolean} | bShowCloseButton | Defines whether the close button is shown |
Returns:
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
.
Parameters:
{boolean} | bShowHeader | New value for property showHeader |
Returns:
Sets the aggregated subHeader
.
Parameters:
Returns:
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.
Parameters:
{string} | sTitle | New value for property title |
Returns:
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
.
Parameters:
{boolean} | bVerticalScrolling | New value for property verticalScrolling |
Returns: