Class sap.ui.comp.navpopover.SmartLinkModule: sap/ui/comp/navpopover/SmartLink

extends Link

The SmartLink control uses a semantic object to display NavigationPopover for further navigation steps.

A detailed description of the OData annotations handled by this control is available here.
Annotation Limitations: Qualifier support for entity types is limited for this control.

Constructor Summary
new sap.ui.comp.navpopover.SmartLink(sId?, mSettings?)Constructor for a new navpopover/SmartLink.
Event Summary
beforePopoverOpens(oControlEvent)Event is fired before the navigation popover opens and before navigation target links are getting retrieved.
innerNavigate(oControlEvent)This event is fired after a navigation link on the navigation popover has been clicked.
navigationTargetsObtained(oControlEvent)After the navigation targets are retrieved, navigationTargetsObtained is fired and provides the possibility to change the targets.
Events borrowed from class sap.m.Link
press
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.comp.navpopover.SmartLink.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.navpopover.SmartLink with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.comp.navpopover.SmartLink.getMetadata()Returns a metadata object for class sap.ui.comp.navpopover.SmartLink.
attachBeforePopoverOpens(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beforePopoverOpens event of this sap.ui.comp.navpopover.SmartLink.
attachInnerNavigate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the innerNavigate event of this sap.ui.comp.navpopover.SmartLink.
attachNavigationTargetsObtained(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the navigationTargetsObtained event of this sap.ui.comp.navpopover.SmartLink.
destroyInnerControl()Destroys the innerControl in the aggregation innerControl.
detachBeforePopoverOpens(fnFunction, oListener)Detaches event handler fnFunction from the beforePopoverOpens event of this sap.ui.comp.navpopover.SmartLink.
detachInnerNavigate(fnFunction, oListener)Detaches event handler fnFunction from the innerNavigate event of this sap.ui.comp.navpopover.SmartLink.
detachNavigationTargetsObtained(fnFunction, oListener)Detaches event handler fnFunction from the navigationTargetsObtained event of this sap.ui.comp.navpopover.SmartLink.
fireBeforePopoverOpens(mArguments?)Fires event beforePopoverOpens to attached listeners.
fireInnerNavigate(mArguments?)Fires event innerNavigate to attached listeners.
fireNavigationTargetsObtained(mArguments?)Fires event navigationTargetsObtained to attached listeners.
getCreateControlCallback()Gets current value of property createControlCallback.
getFieldName()Gets current value of property fieldName.
getIgnoreLinkRendering()Gets current value of property ignoreLinkRendering.
getInnerControl()Gets content of aggregation innerControl.
getInnerControlValue()Gets the inner control's value, if no inner control is available, the SmartLink's text will be returned
getMapFieldToSemanticObject()Gets current value of property mapFieldToSemanticObject.
getSemanticAttributes()Gets the semantic object calculated at the last Link press event
getSemanticObject()Gets current value of property semanticObject.
getSemanticObjectController()Gets current value of property semanticObjectController.
getSemanticObjectLabel()Gets current value of property semanticObjectLabel.
getSemanticObjectValue()Gets the current value assigned to the field with the SmartLink's semantic object name.
setCreateControlCallback(oCreateControlCallback)Sets a new value for property createControlCallback.
setFieldName(sFieldName)Sets a new value for property fieldName.
setIgnoreLinkRendering(bIgnoreLinkRendering)Sets a new value for property ignoreLinkRendering.
setInnerControl(oInnerControl)Sets the aggregated innerControl.
setMapFieldToSemanticObject(bMapFieldToSemanticObject)Sets a new value for property mapFieldToSemanticObject.
setSemanticObject(sSemanticObject)Sets a new value for property semanticObject.
setSemanticObjectController(oSemanticObjectController)Sets a new value for property semanticObjectController.
setSemanticObjectLabel(sSemanticObjectLabel)Sets a new value for property semanticObjectLabel.
Methods borrowed from class sap.m.Link
addAriaDescribedBy, addAriaLabelledBy, attachPress, detachPress, firePress, getAccessibilityInfo, getAriaDescribedBy, getAriaLabelledBy, getEmphasized, getEnabled, getHref, getRel, getSubtle, getTarget, getText, getTextAlign, getTextDirection, getWidth, getWrapping, removeAllAriaDescribedBy, removeAllAriaLabelledBy, removeAriaDescribedBy, removeAriaLabelledBy, setEmphasized, setEnabled, setHref, setRel, setSubtle, setTarget, setText, setTextAlign, setTextDirection, setWidth, setWrapping
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
OData Annotation Summary
SemanticObject(com.sap.vocabularies.Common.v1) on PropertyDefines a name of the SemanticObject that can be represented with a Property that is defined within an EntityType.
SemanticKey(com.sap.vocabularies.Common.v1) on EntityTypeDefines whether a property is a semantic key that allows a semantic object navigation.
TextArrangement(com.sap.vocabularies.UI.v1) on EntityTypeDescribes the arrangement of a code value and its text.
Constructor Detail
new sap.ui.comp.navpopover.SmartLink(sId?, mSettings?)
Constructor for a new navpopover/SmartLink.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.m.Link can be used as well.

Parameters:
{string}sId? ID for the new control, generated automatically if no ID is given
{object}mSettings? Initial settings for the new control
Event Detail
beforePopoverOpens(oControlEvent)
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 SmartLink, the beforePopoverOpens is fired after the link has been clicked.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.semanticObject The semantic object for which the navigation targets will be retrieved.
{object}oControlEvent.getParameters.semanticAttributes Map containing the semantic attributes calculated from the binding that will be used to retrieve the navigation targets. targets.
{function}oControlEvent.getParameters.setSemanticAttributes This callback function enables you to define a changed semantic attributes map. Signatures: setSemanticAttributes(oSemanticAttributesMap) Parameter:
  • {object} oSemanticAttributesMap New map containing the semantic attributes to be used.
{function}oControlEvent.getParameters.setAppStateKey This callback function sets an application state key that is used over the cross-application navigation. Signatures: setAppStateKey(sAppStateKey) Parameter:
  • {string} sAppStateKey
{string}oControlEvent.getParameters.originalId The ID of the SmartLink.
{function}oControlEvent.getParameters.open This callback function triggers the retrieval of navigation targets and leads to the opening of the navigation popover. Signatures: open() If the beforePopoverOpens has been registered, the open function has to be called manually in order to open the navigation popover.
Since:
1.28.0
innerNavigate(oControlEvent)
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.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.text The UI text shown in the clicked link.
{string}oControlEvent.getParameters.href The navigation target of the clicked link.
{string}oControlEvent.getParameters.semanticObject The semantic object used to retrieve this target.
{object}oControlEvent.getParameters.semanticAttributes Map containing the semantic attributes used to retrieve this target.
{string}oControlEvent.getParameters.originalId The ID of the SmartLink.
Since:
1.28.0
navigationTargetsObtained(oControlEvent)
After the navigation targets are retrieved, navigationTargetsObtained is fired and provides the possibility to change the targets.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.comp.navpopover.LinkData}oControlEvent.getParameters.mainNavigation The main navigation object.
{sap.ui.comp.navpopover.LinkData[]}oControlEvent.getParameters.actions Array of available navigation target objects.
{sap.ui.comp.navpopover.LinkData}oControlEvent.getParameters.ownNavigation The navigation object for the own application. This navigation option is by default not visible on the popover.
{string}oControlEvent.getParameters.semanticObject The semantic object for which the navigation targets have been retrieved.
{string}oControlEvent.getParameters.originalId The ID of the SmartLink.
{function}oControlEvent.getParameters.show This callback function shows the actual navigation popover. If the navigationTargetsObtained has been registered, the show function has to be called manually in order to open the navigation popover. Signatures: show()show(oMainNavigation, aAvailableActions, oExtraContent)show(sMainNavigationId, oMainNavigation, aAvailableActions, oExtraContent) Parameters:
  • {string} sMainNavigationId The visible text for the main navigation section. If empty, the main navigation ID is calculated using binding context of given source object (for example SmartLink).
  • {sap.ui.comp.navpopover.LinkData} oMainNavigation The main navigation object. If empty, property mainNavigation will be used.
  • {sap.ui.comp.navpopover.LinkData[]} aAvailableActions Array containing the cross application navigation links. If empty, property actions will be used.
  • {sap.ui.core.Control} oExtraContent Control that will be displayed in extra content section on the popover.
Since:
1.28.0
Method Detail
sap.ui.comp.navpopover.SmartLink.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.comp.navpopover.SmartLink with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.Link.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
sap.ui.comp.navpopover.SmartLink.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.comp.navpopover.SmartLink.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachBeforePopoverOpens(oData?, fnFunction, oListener?): sap.ui.comp.navpopover.SmartLink
Attaches event handler fnFunction to the beforePopoverOpens event of this sap.ui.comp.navpopover.SmartLink.

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.SmartLink 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 SmartLink, the beforePopoverOpens is fired after the link has been clicked.

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.ui.comp.navpopover.SmartLink itself
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
attachInnerNavigate(oData?, fnFunction, oListener?): sap.ui.comp.navpopover.SmartLink
Attaches event handler fnFunction to the innerNavigate event of this sap.ui.comp.navpopover.SmartLink.

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.SmartLink itself.

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.

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.ui.comp.navpopover.SmartLink itself
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
attachNavigationTargetsObtained(oData?, fnFunction, oListener?): sap.ui.comp.navpopover.SmartLink
Attaches event handler fnFunction to the navigationTargetsObtained event of this sap.ui.comp.navpopover.SmartLink.

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.SmartLink itself.

After the navigation targets are retrieved, navigationTargetsObtained is fired and provides the possibility to change the targets.

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.ui.comp.navpopover.SmartLink itself
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
destroyInnerControl(): sap.ui.comp.navpopover.SmartLink
Destroys the innerControl in the aggregation innerControl.
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
detachBeforePopoverOpens(fnFunction, oListener): sap.ui.comp.navpopover.SmartLink
Detaches event handler fnFunction from the beforePopoverOpens event of this sap.ui.comp.navpopover.SmartLink.

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
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
detachInnerNavigate(fnFunction, oListener): sap.ui.comp.navpopover.SmartLink
Detaches event handler fnFunction from the innerNavigate event of this sap.ui.comp.navpopover.SmartLink.

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
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
detachNavigationTargetsObtained(fnFunction, oListener): sap.ui.comp.navpopover.SmartLink
Detaches event handler fnFunction from the navigationTargetsObtained event of this sap.ui.comp.navpopover.SmartLink.

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
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
fireBeforePopoverOpens(mArguments?): sap.ui.comp.navpopover.SmartLink
Fires event beforePopoverOpens to attached listeners.

Expects the following event parameters:

  • semanticObject of type stringThe semantic object for which the navigation targets will be retrieved.
  • semanticAttributes of type objectMap containing the semantic attributes calculated from the binding that will be used to retrieve the navigation targets. targets.
  • setSemanticAttributes of type functionThis callback function enables you to define a changed semantic attributes map. Signatures: setSemanticAttributes(oSemanticAttributesMap) Parameter:
    • {object} oSemanticAttributesMap New map containing the semantic attributes to be used.
  • setAppStateKey of type functionThis callback function sets an application state key that is used over the cross-application navigation. Signatures: setAppStateKey(sAppStateKey) Parameter:
    • {string} sAppStateKey
  • originalId of type stringThe ID of the SmartLink.
  • open of type functionThis callback function triggers the retrieval of navigation targets and leads to the opening of the navigation popover. Signatures: open() If the beforePopoverOpens has been registered, the open function has to be called manually in order to open the navigation popover.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
fireInnerNavigate(mArguments?): sap.ui.comp.navpopover.SmartLink
Fires event innerNavigate to attached listeners.

Expects the following event parameters:

  • text of type stringThe UI text shown in the clicked link.
  • href of type stringThe navigation target of the clicked link.
  • semanticObject of type stringThe semantic object used to retrieve this target.
  • semanticAttributes of type objectMap containing the semantic attributes used to retrieve this target.
  • originalId of type stringThe ID of the SmartLink.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
fireNavigationTargetsObtained(mArguments?): sap.ui.comp.navpopover.SmartLink
Fires event navigationTargetsObtained to attached listeners.

Expects the following event parameters:

  • mainNavigation of type sap.ui.comp.navpopover.LinkDataThe main navigation object.
  • actions of type sap.ui.comp.navpopover.LinkData[]Array of available navigation target objects.
  • ownNavigation of type sap.ui.comp.navpopover.LinkDataThe navigation object for the own application. This navigation option is by default not visible on the popover.
  • semanticObject of type stringThe semantic object for which the navigation targets have been retrieved.
  • originalId of type stringThe ID of the SmartLink.
  • show of type functionThis callback function shows the actual navigation popover. If the navigationTargetsObtained has been registered, the show function has to be called manually in order to open the navigation popover. Signatures: show()show(oMainNavigation, aAvailableActions, oExtraContent)show(sMainNavigationId, oMainNavigation, aAvailableActions, oExtraContent) Parameters:
    • {string} sMainNavigationId The visible text for the main navigation section. If empty, the main navigation ID is calculated using binding context of given source object (for example SmartLink).
    • {sap.ui.comp.navpopover.LinkData} oMainNavigation The main navigation object. If empty, property mainNavigation will be used.
    • {sap.ui.comp.navpopover.LinkData[]} aAvailableActions Array containing the cross application navigation links. If empty, property actions will be used.
    • {sap.ui.core.Control} oExtraContent Control that will be displayed in extra content section on the popover.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
getCreateControlCallback(): object
Gets current value of property createControlCallback.

Function that enables the SmartLink control to create an alternative control, which is displayed if no navigation targets are available. The function has no parameters and has to return an instance of sap.ui.core.Control.

Since:
1.28.0
Returns:
{object} Value of property createControlCallback
getFieldName(): string
Gets current value of property fieldName.

The metadata field name for this SmartLink control. Note: Setting a value triggers an asynchronous determination, so the effect can be delayed.

Since:
1.28.0
Returns:
{string} Value of property fieldName
getIgnoreLinkRendering(): boolean
Gets current value of property ignoreLinkRendering.

If set to true, the SmartLink control will render the innerControl or the control provided by createControlCallback instead of the actual link. This is used for example by the SemanticObjectController if this SmartLink is listed in its ignoredFields or no navigation targets were found during prefetch. Note: Setting a value triggers an asynchronous determination, so the effect can be delayed.

Default value is false.

Since:
1.28.0
Returns:
{boolean} Value of property ignoreLinkRendering
getInnerControl(): sap.ui.core.Control
Gets content of aggregation innerControl.

Control that is displayed instead of SmartLink, if the SmartLink is disabled (for example, if no navigation targets are available). If innerControl is not provided, the SmartLink control tries to create one with property createControlCallback.

Since:
1.28.0
Returns:
{sap.ui.core.Control}
getInnerControlValue(): object
Gets the inner control's value, if no inner control is available, the SmartLink's text will be returned
Returns:
{object} the value
getMapFieldToSemanticObject(): boolean
Gets current value of property mapFieldToSemanticObject.

If set to false, the SmartLink 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 SmartLinks on the same semantic object.

Default value is true.

Returns:
{boolean} Value of property mapFieldToSemanticObject
getSemanticAttributes(): object
Gets the semantic object calculated at the last Link press event
Returns:
{object} Map containing the copy of the available binding context.
getSemanticObject(): string
Gets current value of property semanticObject.

Name of semantic object which is used to fill the navigation popover. Note: Setting a value triggers an asynchronous determination, so the effect can be delayed.

Since:
1.28.0
Returns:
{string} Value of property semanticObject
getSemanticObjectController(): any
Gets current value of property semanticObjectController.

The semantic object controller controls events for several SmartLink controls. If the controller is not set manually, it tries to find a SemanticObjectController in its parent hierarchy. Note: Setting a value triggers an asynchronous determination, so the effect can be delayed.

Since:
1.28.0
Returns:
{any} Value of property semanticObjectController
getSemanticObjectLabel(): string
Gets current value of property semanticObjectLabel.

Shown label of semantic object.

Since:
1.28.0
Returns:
{string} Value of property semanticObjectLabel
getSemanticObjectValue(): object
Gets the current value assigned to the field with the SmartLink's semantic object name.
Returns:
{object} The semantic object's value.
setCreateControlCallback(oCreateControlCallback): sap.ui.comp.navpopover.SmartLink
Sets a new value for property createControlCallback.

Function that enables the SmartLink control to create an alternative control, which is displayed if no navigation targets are available. The function has no parameters and has to return an instance of sap.ui.core.Control.

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

Parameters:
{object}oCreateControlCallback New value for property createControlCallback
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
setFieldName(sFieldName): sap.ui.comp.navpopover.SmartLink
Sets a new value for property fieldName.

The metadata field name for this SmartLink control. Note: Setting a value triggers an asynchronous determination, so the effect can be delayed.

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

Parameters:
{string}sFieldName New value for property fieldName
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
setIgnoreLinkRendering(bIgnoreLinkRendering): sap.ui.comp.navpopover.SmartLink
Sets a new value for property ignoreLinkRendering.

If set to true, the SmartLink control will render the innerControl or the control provided by createControlCallback instead of the actual link. This is used for example by the SemanticObjectController if this SmartLink is listed in its ignoredFields or no navigation targets were found during prefetch. Note: Setting a value triggers an asynchronous determination, so the effect can be delayed.

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

Default value is false.

Parameters:
{boolean}bIgnoreLinkRendering New value for property ignoreLinkRendering
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
setInnerControl(oInnerControl): sap.ui.comp.navpopover.SmartLink
Sets the aggregated innerControl.
Parameters:
{sap.ui.core.Control}oInnerControl The innerControl to set
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
setMapFieldToSemanticObject(bMapFieldToSemanticObject): sap.ui.comp.navpopover.SmartLink
Sets a new value for property mapFieldToSemanticObject.

If set to false, the SmartLink 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 SmartLinks 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.

Parameters:
{boolean}bMapFieldToSemanticObject New value for property mapFieldToSemanticObject
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
setSemanticObject(sSemanticObject): sap.ui.comp.navpopover.SmartLink
Sets a new value for property semanticObject.

Name of semantic object which is used to fill the navigation popover. Note: Setting a value triggers an asynchronous determination, so the effect can be delayed.

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

Parameters:
{string}sSemanticObject New value for property semanticObject
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
setSemanticObjectController(oSemanticObjectController): sap.ui.comp.navpopover.SmartLink
Sets a new value for property semanticObjectController.

The semantic object controller controls events for several SmartLink controls. If the controller is not set manually, it tries to find a SemanticObjectController in its parent hierarchy. Note: Setting a value triggers an asynchronous determination, so the effect can be delayed.

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

Parameters:
{any}oSemanticObjectController New value for property semanticObjectController
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
setSemanticObjectLabel(sSemanticObjectLabel): sap.ui.comp.navpopover.SmartLink
Sets a new value for property semanticObjectLabel.

Shown label of semantic object.

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

Parameters:
{string}sSemanticObjectLabel New value for property semanticObjectLabel
Since:
1.28.0
Returns:
{sap.ui.comp.navpopover.SmartLink} Reference to this in order to allow method chaining
OData Annotation Detail
SemanticObject(com.sap.vocabularies.Common.v1)
Defines a name of the SemanticObject that can be represented with a Property that is defined within an EntityType. The SmartLink control can be created from the XML view or from the OData metadata. With this annotation in place, the SemanticObjectController will provide all the available features for the SmartLink control.

XML Example of OData V4 with SemanticObject on Product/Name

  <Annotations Target="ProductCollection.Product/Name" xmlns="http://docs.oasis-open.org/odata/ns/edm">
     <Annotation Term="com.sap.vocabularies.Common.v1.SemanticObject" String="SemanticObjectName" />
  </Annotations>

Refer OData v4 annotations for details about annotations.
Target Type:
Property
Applies to Aggregation/Property:
text
label
value
Since:
1.28.1
SemanticKey(com.sap.vocabularies.Common.v1)
Defines whether a property is a semantic key that allows a semantic object navigation.

XML Example of OData V4 with SemanticKey Annotation

   <Annotations Target="SalesOrderType" xmlns="http://docs.oasis-open.org/odata/ns/edm">
     <Annotation Term="com.sap.vocabularies.Common.v1.SemanticKey">
       <Collection>
         <PropertyPath>SalesOrderID</PropertyPath>
         <PropertyPath>SalesOrderItemID</PropertyPath>
       </Collection>
     </Annotation>
   </Annotations>

Refer OData v4 annotations for details about annotations.
Target Type:
EntityType
Applies to Aggregation/Property:
text
label
value
Since:
1.28.1
TextArrangement(com.sap.vocabularies.UI.v1)
Describes the arrangement of a code value and its text. A fixed or dynamic value can be provided as an enumeration by referencing to another Property within the same EntityType.
  • com.sap.vocabularies.UI.v1.TextArrangementType/TextFirst
    The underlying control is represented with the specified description followed by its ID.
  • com.sap.vocabularies.UI.v1.TextArrangementType/TextLast
    The underlying control is represented with the specified ID followed by its description.
  • com.sap.vocabularies.UI.v1.TextArrangementType/TextOnly
    The underlying control is represented with the specified description.
  • com.sap.vocabularies.UI.v1.TextArrangementType/TextSeparate
    The underlying control is represented with the specified ID.

XML Example of OData V4 with TextArrangement on ProductType

   <Annotations Target="ProductType">
     <Annotation Term="com.sap.vocabularies.UI.v1.TextArrangement" EnumMember="UI.TextArrangementType/TextFirst"/>
   </Annotations>

Refer OData v4 annotations for details about annotations.
Target Type:
EntityType
Applies to Aggregation/Property:
text
Since:
1.32.1