The NavigationPopoverHandler control determines navigation targets for a semantic object and shows them together with further information in a Popover.
Note: Navigation targets are determined using CrossApplicationNavigation of the unified shell service.
Constructor for a new navpopover/NavigationPopoverHandler.
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.NavigationPopoverHandler(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 |
---|---|---|---|
additionalSemanticObjects | string[] | Names of additional semantic objects which are used to determine target navigations. |
|
beforeNavigationCallback | function | Function that is called before the actual navigation happens. This function has to return a promise resolving into a Boolean value for which the navigation will wait. If the Boolean value is
Since: 1.75.0.Visibility: public |
|
contactAnnotationPath | string | undefined | Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact annotation is defined, for example, |
enableAvailableActionsPersonalization | boolean | true | Determines whether the personalization link is shown inside the NavigationPopover control. |
fieldName | string | The metadata field name for this NavigationPopoverHandler control. |
|
mapFieldToSemanticObject | boolean | true | If set to |
semanticObject | string | Name of semantic object which is used to determine target navigations. |
|
semanticObjectController | any | The semantic object controller controls events for several NavigationPopoverHandler controls. If the controller is not set manually, it tries to find a SemanticObjectController in its parent hierarchy. |
|
semanticObjectLabel | string | Shown title of semantic object. |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
_popover | 0..1 | sap.ui.comp.navpopover.NavigationPopover |
Stores the inner popover to influence design-time |
Name | Cardinality | Type | Description |
---|---|---|---|
control | 0..1 | sap.ui.core.Control |
The parent control. |
Event | Description |
---|---|
beforePopoverOpens |
Event is fired before the navigation popover opens and before navigation target links are getting retrieved. Event can be used to change the parameters used to retrieve the navigation targets. In case of NavigationPopoverHandler, the |
innerNavigate |
This event is fired after a navigation link on the navigation popover has been clicked. This event is only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window' etc. in the context menu does not fire the event. |
navigationTargetsObtained |
After the navigation targets are retrieved, |
Event is fired before the navigation popover opens and before navigation target links are getting retrieved. Event can be used to change the parameters used to retrieve the navigation targets. In case of NavigationPopoverHandler, the beforePopoverOpens
is fired after the link has been clicked.
Since: 1.36.0.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
semanticObject | string |
The semantic object for which the navigation targets will be retrieved. |
semanticAttributes | object |
Map containing the semantic attributes calculated from the binding that will be used to retrieve the navigation targets. |
semanticAttributesOfSemanticObjects | object |
A map of semantic objects for which the navigation targets will be retrieved and it's semantic attributes calculated from the binding context. The semantic attributes will be used as parameters in order to retrieve the navigation targets. |
setSemanticAttributes | function |
This callback function enables you to define a changed semantic attributes map. Signatures:
|
setAppStateKey | function |
This callback function sets an application state key that is used over the cross-application navigation. Signatures:
|
originalId | string |
The ID of the NavigationPopoverHandler. |
open | function |
This callback function triggers the retrieval of navigation targets and leads to the opening of the navigation popover. Signatures: |
Method | Description |
---|---|
attachBeforePopoverOpens |
Attaches event handler When called, the context of the event handler (its Event is fired before the navigation popover opens and before navigation target links are getting retrieved. Event can be used to change the parameters used to retrieve the navigation targets. In case of NavigationPopoverHandler, the |
attachInnerNavigate |
Attaches event handler When called, the context of the event handler (its This event is fired after a navigation link on the navigation popover has been clicked. This event is only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window' etc. in the context menu does not fire the event. |
attachNavigationTargetsObtained |
Attaches event handler When called, the context of the event handler (its After the navigation targets are retrieved, |
detachBeforePopoverOpens |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachInnerNavigate |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachNavigationTargetsObtained |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.comp.navpopover.NavigationPopoverHandler.extend |
Creates a new subclass of class sap.ui.comp.navpopover.NavigationPopoverHandler with name
|
fireBeforePopoverOpens |
Fires event beforePopoverOpens to attached listeners. |
fireInnerNavigate |
Fires event innerNavigate to attached listeners. |
fireNavigationTargetsObtained |
Fires event navigationTargetsObtained to attached listeners. |
getAdditionalSemanticObjects |
Gets current value of property additionalSemanticObjects. Names of additional semantic objects which are used to determine target navigations. Default value is |
getBeforeNavigationCallback |
Gets current value of property beforeNavigationCallback. Function that is called before the actual navigation happens. This function has to return a promise resolving into a Boolean value for which the navigation will wait. If the Boolean value is
|
getContactAnnotationPath |
Gets current value of property contactAnnotationPath. Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact annotation is defined, for example, Default value is |
getControl |
ID of the element which is the current target of the association control, or |
getEnableAvailableActionsPersonalization |
Gets current value of property enableAvailableActionsPersonalization. Determines whether the personalization link is shown inside the NavigationPopover control. Default value is |
getFieldName |
Gets current value of property fieldName. The metadata field name for this NavigationPopoverHandler control. |
getMapFieldToSemanticObject |
Gets current value of property mapFieldToSemanticObject. If set to Default value is |
sap.ui.comp.navpopover.NavigationPopoverHandler.getMetadata |
Returns a metadata object for class sap.ui.comp.navpopover.NavigationPopoverHandler. |
getSemanticObject |
Gets current value of property semanticObject. Name of semantic object which is used to determine target navigations. |
getSemanticObjectController |
Gets current value of property semanticObjectController. The semantic object controller controls events for several NavigationPopoverHandler controls. If the controller is not set manually, it tries to find a SemanticObjectController in its parent hierarchy. |
getSemanticObjectLabel |
Gets current value of property semanticObjectLabel. Shown title of semantic object.
Since 1.40.0 Title section with <code>semanticObjectLabel</code> has been removed due to new UI design
|
getSemanticObjectValue |
Gets the current value assigned to the field with the NavigationPopoverHandler's semantic object name. |
openPopover |
Opens the |
setAdditionalSemanticObjects |
Sets a new value for property additionalSemanticObjects. Names of additional semantic objects which are used to determine target navigations. When called with a value of Default value is |
setBeforeNavigationCallback |
Sets a new value for property beforeNavigationCallback. Function that is called before the actual navigation happens. This function has to return a promise resolving into a Boolean value for which the navigation will wait. If the Boolean value is
When called with a value of |
setContactAnnotationPath |
Sets a new value for property contactAnnotationPath. Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact annotation is defined, for example, When called with a value of Default value is |
setControl |
Sets the associated control. |
setEnableAvailableActionsPersonalization |
Sets a new value for property enableAvailableActionsPersonalization. Determines whether the personalization link is shown inside the NavigationPopover control. When called with a value of Default value is |
setFieldName |
Sets a new value for property fieldName. The metadata field name for this NavigationPopoverHandler control. When called with a value of |
setMapFieldToSemanticObject |
Sets a new value for property mapFieldToSemanticObject. If set to When called with a value of Default value is |
setSemanticObject |
Sets a new value for property semanticObject. Name of semantic object which is used to determine target navigations. When called with a value of |
setSemanticObjectController |
Sets a new value for property semanticObjectController. The semantic object controller controls events for several NavigationPopoverHandler controls. If the controller is not set manually, it tries to find a SemanticObjectController in its parent hierarchy. When called with a value of |
setSemanticObjectLabel |
Sets a new value for property semanticObjectLabel. Shown title of semantic object. When called with a value of
Since 1.40.0 Title section with <code>semanticObjectLabel</code> has been removed due to new UI design
|
Attaches event handler fnFunction
to the beforePopoverOpens event of this sap.ui.comp.navpopover.NavigationPopoverHandler
.
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.NavigationPopoverHandler
itself.
Event is fired before the navigation popover opens and before navigation target links are getting retrieved. Event can be used to change the parameters used to retrieve the navigation targets. In case of NavigationPopoverHandler, the beforePopoverOpens
is fired after the link has been clicked.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Detaches event handler fnFunction
from the beforePopoverOpens event of this sap.ui.comp.navpopover.NavigationPopoverHandler
.
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 beforePopoverOpens to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
semanticObject | string |
The semantic object for which the navigation targets will be retrieved. |
|
semanticAttributes | object |
Map containing the semantic attributes calculated from the binding that will be used to retrieve the navigation targets. |
|
semanticAttributesOfSemanticObjects | object |
A map of semantic objects for which the navigation targets will be retrieved and it's semantic attributes calculated from the binding context. The semantic attributes will be used as parameters in order to retrieve the navigation targets. |
|
setSemanticAttributes | function |
This callback function enables you to define a changed semantic attributes map. Signatures:
|
|
setAppStateKey | function |
This callback function sets an application state key that is used over the cross-application navigation. Signatures:
|
|
originalId | string |
The ID of the NavigationPopoverHandler. |
|
open | function |
This callback function triggers the retrieval of navigation targets and leads to the opening of the navigation popover. Signatures: |
Gets current value of property additionalSemanticObjects.
Names of additional semantic objects which are used to determine target navigations.
Default value is []
.
Gets current value of property contactAnnotationPath.
Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact annotation is defined, for example, 'to_Supplier'
. An empty string means that the related entity type is the current one.
Default value is undefined
.
Gets current value of property enableAvailableActionsPersonalization.
Determines whether the personalization link is shown inside the NavigationPopover control.
Default value is true
.
Gets current value of property fieldName.
The metadata field name for this NavigationPopoverHandler control.
Gets current value of property mapFieldToSemanticObject.
If set to false
, the NavigationPopoverHandler control will not replace its field name with the according semanticObject
property during the calculation of the semantic attributes. This enables the usage of several NavigationPopoverHandler on the same semantic object. *
Default value is true
.
Gets current value of property semanticObject.
Name of semantic object which is used to determine target navigations.
Gets current value of property semanticObjectController.
The semantic object controller controls events for several NavigationPopoverHandler controls. If the controller is not set manually, it tries to find a SemanticObjectController in its parent hierarchy.
Gets current value of property semanticObjectLabel.
Shown title of semantic object.
Gets the current value assigned to the field with the NavigationPopoverHandler's semantic object name.
Opens the sap.m.Popover
with navigation targets in an asynchronous manner.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDomRef | object |
Optional DOM reference to which the popover is attached. By default the |
Sets a new value for property additionalSemanticObjects.
Names of additional semantic objects which are used to determine target navigations.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is []
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sAdditionalSemanticObjects | string[] | [] |
New value for property |
Sets a new value for property contactAnnotationPath.
Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact annotation is defined, for example, 'to_Supplier'
. An empty string means that the related entity type is the current one.
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 |
---|---|---|---|
sContactAnnotationPath | string |
New value for property |
Sets the associated control.
Param | Type | DefaultValue | Description |
---|---|---|---|
oControl | sap.ui.core.ID sap.ui.core.Control |
ID of an element which becomes the new target of this control association; alternatively, an element instance may be given |
Sets a new value for property enableAvailableActionsPersonalization.
Determines whether the personalization link is shown inside the NavigationPopover control.
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 |
---|---|---|---|
bEnableAvailableActionsPersonalization | boolean | true |
New value for property |
Sets a new value for property fieldName.
The metadata field name for this NavigationPopoverHandler control.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sFieldName | string |
New value for property |
Sets a new value for property mapFieldToSemanticObject.
If set to false
, the NavigationPopoverHandler control will not replace its field name with the according semanticObject
property during the calculation of the semantic attributes. This enables the usage of several NavigationPopoverHandler on the same semantic object. *
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 |
---|---|---|---|
bMapFieldToSemanticObject | boolean | true |
New value for property |
Sets a new value for property semanticObject.
Name of semantic object which is used to determine target navigations.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSemanticObject | string |
New value for property |
Sets a new value for property semanticObjectController.
The semantic object controller controls events for several NavigationPopoverHandler controls. If the controller is not set manually, it tries to find a SemanticObjectController in its parent hierarchy.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSemanticObjectController | any |
New value for property |
Sets a new value for property semanticObjectLabel.
Shown title of semantic object.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSemanticObjectLabel | string |
New value for property |