class sap.ui.comp.navpopover.LinkData

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/comp/navpopover/LinkData
Application Component: CA-UI5-CMP

Stores display text together with a navigation target hyperlink.
The LinkData class is used by SmartLink and SemanticObjectController to define the visible links on NavigationPopover.


Constructor

Constructor for a new navpopover/LinkData.

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.LinkData(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


Properties

Name Type Default Value Description
description string undefined

Description of the link.

Since: 1.42.0.

Visibility: public
href string

Destination link for a navigation operation in internal format. Note: The link will be encoded before it is shown in external format using the hrefForExternal method of the CrossApplicationNavigation service.

Visibility: public
isSuperiorAction boolean

Marker for superior action.

Since: 1.48.0.

Visibility: public
key string undefined

Key of link.

Since: 1.44.0.

Visibility: public
press object

Callback for press event.

Since: 1.46.0.

Visibility: public
target string

The standard values for the target property are: _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered. This property is only used if the href property is set.

Visibility: public
text string

Text which can be displayed on the UI

Visibility: public
visible boolean true

Describes whether the link should be visible on the screen.

Since: 1.44.0.

Visibility: public
visibleChangedByUser boolean

Describes whether the visibility is changed by end user or not.

Since: 1.58.0.

Visibility: public

Methods Overview

Method Description
sap.ui.comp.navpopover.LinkData.extend

Creates a new subclass of class sap.ui.comp.navpopover.LinkData 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.Element.extend.

getDescription

Gets current value of property description.

Description of the link.

Default value is undefined.

getHref

Gets current value of property href.

Destination link for a navigation operation in internal format. Note: The link will be encoded before it is shown in external format using the hrefForExternal method of the CrossApplicationNavigation service.

getIsSuperiorAction

Gets current value of property isSuperiorAction.

Marker for superior action.

getKey

Gets current value of property key.

Key of link.

Default value is undefined.

sap.ui.comp.navpopover.LinkData.getMetadata

Returns a metadata object for class sap.ui.comp.navpopover.LinkData.

getPress

Gets current value of property press.

Callback for press event.

getTarget

Gets current value of property target.

The standard values for the target property are: _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered. This property is only used if the href property is set.

getText

Gets current value of property text.

Text which can be displayed on the UI

getVisible

Gets current value of property visible.

Describes whether the link should be visible on the screen.

Default value is true.

getVisibleChangedByUser

Gets current value of property visibleChangedByUser.

Describes whether the visibility is changed by end user or not.

setDescription

Sets a new value for property description.

Description of the link.

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

Default value is undefined.

setHref

Sets a new value for property href.

Destination link for a navigation operation in internal format. Note: The link will be encoded before it is shown in external format using the hrefForExternal method of the CrossApplicationNavigation service.

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

setIsSuperiorAction

Sets a new value for property isSuperiorAction.

Marker for superior action.

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

setKey

Sets a new value for property key.

Key of link.

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

Default value is undefined.

setPress

Sets a new value for property press.

Callback for press event.

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

setTarget

Sets a new value for property target.

The standard values for the target property are: _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered. This property is only used if the href property is set.

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

setText

Sets a new value for property text.

Text which can be displayed on the UI

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

setVisible

Sets a new value for property visible.

Describes whether the link should be visible on the screen.

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

Default value is true.

setVisibleChangedByUser

Sets a new value for property visibleChangedByUser.

Describes whether the visibility is changed by end user or not.

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

sap.ui.comp.navpopover.LinkData.extend

Creates a new subclass of class sap.ui.comp.navpopover.LinkData 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.Element.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

getDescription

Gets current value of property description.

Description of the link.

Default value is undefined.

getHref

Gets current value of property href.

Destination link for a navigation operation in internal format. Note: The link will be encoded before it is shown in external format using the hrefForExternal method of the CrossApplicationNavigation service.

getIsSuperiorAction

Gets current value of property isSuperiorAction.

Marker for superior action.

getKey

Gets current value of property key.

Key of link.

Default value is undefined.

sap.ui.comp.navpopover.LinkData.getMetadata

Returns a metadata object for class sap.ui.comp.navpopover.LinkData.

getPress

Gets current value of property press.

Callback for press event.

getTarget

Gets current value of property target.

The standard values for the target property are: _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered. This property is only used if the href property is set.

getText

Gets current value of property text.

Text which can be displayed on the UI

getVisible

Gets current value of property visible.

Describes whether the link should be visible on the screen.

Default value is true.

getVisibleChangedByUser

Gets current value of property visibleChangedByUser.

Describes whether the visibility is changed by end user or not.

setDescription

Sets a new value for property description.

Description of the link.

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
sDescription string

New value for property description

setHref

Sets a new value for property href.

Destination link for a navigation operation in internal format. Note: The link will be encoded before it is shown in external format using the hrefForExternal method of the CrossApplicationNavigation service.

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

Param Type DefaultValue Description
sHref string

New value for property href

setIsSuperiorAction

Sets a new value for property isSuperiorAction.

Marker for superior action.

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

Param Type DefaultValue Description
bIsSuperiorAction boolean

New value for property isSuperiorAction

setKey

Sets a new value for property key.

Key of link.

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
sKey string

New value for property key

setPress

Sets a new value for property press.

Callback for press event.

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

Param Type DefaultValue Description
oPress object

New value for property press

setTarget

Sets a new value for property target.

The standard values for the target property are: _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered. This property is only used if the href property is set.

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

Param Type DefaultValue Description
sTarget string

New value for property target

setText

Sets a new value for property text.

Text which can be displayed on the UI

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

Param Type DefaultValue Description
sText string

New value for property text

setVisible

Sets a new value for property visible.

Describes whether the link should be visible on the screen.

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
bVisible boolean true

New value for property visible

setVisibleChangedByUser

Sets a new value for property visibleChangedByUser.

Describes whether the visibility is changed by end user or not.

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

Param Type DefaultValue Description
bVisibleChangedByUser boolean

New value for property visibleChangedByUser