The NavigationPopover control is used to present information in a specific format. Note: This control is used by the NavigationPopoverHandler and must not be used manually.
Constructor for a new navpopover/NavigationPopover.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.comp.navpopover.NavigationPopover(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 |
---|---|---|---|
appStateKey | string | The application state key passed to retrieve the navigation targets. |
|
availableActionsPersonalizationText | string | undefined | Determines the text of personalization link. If this property is set to some string, choosing the personalization link will trigger the |
mainNavigationId | string | Sets the description of the main navigation link. If |
|
semanticAttributes | object | Describes the semantic attributes. The attribute has to be a map. |
|
semanticObjectName | string | The name of the semantic object. |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
availableActions | 0..n | sap.ui.comp.navpopover.LinkData |
A list of available actions shown as links. |
mainNavigation | 0..1 | sap.ui.comp.navpopover.LinkData |
The main navigation link. If |
ownNavigation | 0..1 | sap.ui.comp.navpopover.LinkData |
The navigation taking the user back to the source application. |
Name | Cardinality | Type | Description |
---|---|---|---|
component | 0..1 | sap.ui.core.Element |
The parent component. |
extraContent | 0..1 | sap.ui.core.Control |
In addition to main navigation link and available links some additional content can be displayed in the popover. |
source | 0..1 | sap.ui.core.Control |
Source control for which the popover is displayed. |
Event | Description |
---|---|
availableActionsPersonalizationPress |
This event is fired when personalization of |
navigate |
This event is fired when a link is chosen. |
targetsObtained |
The navigation targets that are shown. |
This event is fired when personalization of availableActions
is chosen.
Since: 1.44.0.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
The navigation targets that are shown.
Since: 1.28.0.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
Method | Description |
---|---|
addAvailableAction |
Adds some availableAction to the aggregation availableActions. |
attachAvailableActionsPersonalizationPress |
Attaches event handler When called, the context of the event handler (its This event is fired when personalization of |
attachNavigate |
Attaches event handler When called, the context of the event handler (its This event is fired when a link is chosen. |
attachTargetsObtained |
Attaches event handler When called, the context of the event handler (its The navigation targets that are shown.
Since 1.40.0 The event <code>navigationTargetsObtained</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination. The event <code>navigationTargetsObtained</code> is fired from NavigationPopoverHandler after navigation targets are determined.
|
destroyAvailableActions |
Destroys all the availableActions in the aggregation availableActions. |
destroyMainNavigation |
Destroys the mainNavigation in the aggregation mainNavigation. |
destroyOwnNavigation |
Destroys the ownNavigation in the aggregation ownNavigation.
Since 1.40.0 The property <code>ownNavigation</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination.
|
detachAvailableActionsPersonalizationPress |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachNavigate |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachTargetsObtained |
Detaches event handler The passed function and listener object must match the ones used for event registration.
Since 1.40.0 The event <code>navigationTargetsObtained</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination. The event <code>navigationTargetsObtained</code> is fired from NavigationPopoverHandler after navigation targets are determined.
|
sap.ui.comp.navpopover.NavigationPopover.extend |
Creates a new subclass of class sap.ui.comp.navpopover.NavigationPopover with name
|
fireAvailableActionsPersonalizationPress |
Fires event availableActionsPersonalizationPress to attached listeners. |
fireNavigate |
Fires event navigate to attached listeners. |
fireTargetsObtained |
Fires event targetsObtained to attached listeners.
Since 1.40.0 The event <code>navigationTargetsObtained</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination. The event <code>navigationTargetsObtained</code> is fired from NavigationPopoverHandler after navigation targets are determined.
|
getAppStateKey |
Gets current value of property appStateKey. The application state key passed to retrieve the navigation targets.
Since 1.40.0 The property <code>appStateKey</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination.
|
getAvailableActions |
Gets content of aggregation availableActions. A list of available actions shown as links. |
getAvailableActionsPersonalizationText |
Gets current value of property availableActionsPersonalizationText. Determines the text of personalization link. If this property is set to some string, choosing the personalization link will trigger the Default value is |
getComponent |
ID of the element which is the current target of the association component, or |
getDirectLink |
Returns link for direct navigation if the NavigationPopover has only |
getExtraContent |
ID of the element which is the current target of the association extraContent, or |
getMainNavigation |
Gets content of aggregation mainNavigation. The main navigation link. If |
getMainNavigationId |
Gets current value of property mainNavigationId. Sets the description of the main navigation link. If |
sap.ui.comp.navpopover.NavigationPopover.getMetadata |
Returns a metadata object for class sap.ui.comp.navpopover.NavigationPopover. |
getOwnNavigation |
Gets content of aggregation ownNavigation. The navigation taking the user back to the source application.
Since 1.40.0 The property <code>ownNavigation</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination.
|
getSemanticAttributes |
Gets current value of property semanticAttributes. Describes the semantic attributes. The attribute has to be a map.
Since 1.40.0 The property <code>semanticAttributes</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination.
|
getSemanticObjectName |
Gets current value of property semanticObjectName. The name of the semantic object.
Since 1.40.0 The property <code>semanticObjectName</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination.
|
getSource |
ID of the element which is the current target of the association source, or |
indexOfAvailableAction |
Checks for the provided |
insertAvailableAction |
Inserts a availableAction into the aggregation availableActions. |
removeAllAvailableActions |
Removes all the controls from the aggregation availableActions. Additionally, it unregisters them from the hosting UIArea. |
removeAvailableAction |
Removes a availableAction from the aggregation availableActions. |
retrieveNavTargets |
Determines the potential navigation targets for the semantical object and visualize the popover.
Since 1.42.0 Target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination.
|
setAppStateKey |
Sets a new value for property appStateKey. The application state key passed to retrieve the navigation targets. When called with a value of
Since 1.40.0 The property <code>appStateKey</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination.
|
setAvailableActionsPersonalizationText |
Sets a new value for property availableActionsPersonalizationText. Determines the text of personalization link. If this property is set to some string, choosing the personalization link will trigger the When called with a value of Default value is |
setComponent |
Sets the associated component. |
setExtraContent |
Sets the associated extraContent. |
setMainNavigation |
Sets the aggregated mainNavigation. |
setMainNavigationId |
Sets a new value for property mainNavigationId. Sets the description of the main navigation link. If When called with a value of |
setOwnNavigation |
Sets the aggregated ownNavigation.
Since 1.40.0 The property <code>ownNavigation</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination.
|
setSemanticAttributes |
Sets a new value for property semanticAttributes. Describes the semantic attributes. The attribute has to be a map. When called with a value of
Since 1.40.0 The property <code>semanticAttributes</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination.
|
setSemanticObjectName |
Sets a new value for property semanticObjectName. The name of the semantic object. When called with a value of
Since 1.40.0 The property <code>semanticObjectName</code> is obsolete as target determination is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination.
|
setSource |
Sets the associated source. |
show |
Displays the popover. This method should be called, once all navigation targets are adapted by the application. |
Adds some availableAction to the aggregation availableActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAvailableAction | sap.ui.comp.navpopover.LinkData |
The availableAction to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the availableActionsPersonalizationPress event of this sap.ui.comp.navpopover.NavigationPopover
.
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.ui.comp.navpopover.NavigationPopover
itself.
This event is fired when personalization of availableActions
is chosen.
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 targetsObtained event of this sap.ui.comp.navpopover.NavigationPopover
.
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.ui.comp.navpopover.NavigationPopover
itself.
The navigation targets that are 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 |
Detaches event handler fnFunction
from the availableActionsPersonalizationPress event of this sap.ui.comp.navpopover.NavigationPopover
.
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 targetsObtained event of this sap.ui.comp.navpopover.NavigationPopover
.
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 |
Fires event availableActionsPersonalizationPress to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event targetsObtained to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Gets current value of property appStateKey.
The application state key passed to retrieve the navigation targets.
Gets content of aggregation availableActions.
A list of available actions shown as links.
Gets current value of property availableActionsPersonalizationText.
Determines the text of personalization link. If this property is set to some string, choosing the personalization link will trigger the availableActionsPersonalizationPress
event. If this property is not set, the personalization link is not shown.
Default value is undefined
.
Returns link for direct navigation if the NavigationPopover has only mainNavigation
or one availableAction
and no extraContent
.
ID of the element which is the current target of the association extraContent, or null
.
Gets current value of property semanticAttributes.
Describes the semantic attributes. The attribute has to be a map.
Gets current value of property semanticObjectName.
The name of the semantic object.
Checks for the provided sap.ui.comp.navpopover.LinkData
in the aggregation availableActions. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAvailableAction | sap.ui.comp.navpopover.LinkData |
The availableAction whose index is looked for |
Inserts a availableAction into the aggregation availableActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAvailableAction | sap.ui.comp.navpopover.LinkData |
The availableAction to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation availableActions.
Additionally, it unregisters them from the hosting UIArea.
Removes a availableAction from the aggregation availableActions.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAvailableAction | int string sap.ui.comp.navpopover.LinkData |
The availableAction to remove or its index or id |
Sets a new value for property appStateKey.
The application state key passed to retrieve the navigation targets.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sAppStateKey | string |
New value for property |
Sets a new value for property availableActionsPersonalizationText.
Determines the text of personalization link. If this property is set to some string, choosing the personalization link will trigger the availableActionsPersonalizationPress
event. If this property is not set, the personalization link is not shown.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is undefined
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sAvailableActionsPersonalizationText | string |
New value for property |
Sets the associated component.
Param | Type | DefaultValue | Description |
---|---|---|---|
oComponent | sap.ui.core.ID sap.ui.core.Element |
ID of an element which becomes the new target of this component association; alternatively, an element instance may be given |
Sets the associated extraContent.
Param | Type | DefaultValue | Description |
---|---|---|---|
oExtraContent | sap.ui.core.ID sap.ui.core.Control |
ID of an element which becomes the new target of this extraContent association; alternatively, an element instance may be given |
Sets a new value for property semanticAttributes.
Describes the semantic attributes. The attribute has to be a map.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSemanticAttributes | object |
New value for property |
Sets a new value for property semanticObjectName.
The name of the semantic object.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSemanticObjectName | string |
New value for property |
Sets the associated source.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSource | sap.ui.core.ID sap.ui.core.Control |
ID of an element which becomes the new target of this source association; alternatively, an element instance may be given |