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 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 |
Name | Type | Default Value | Description |
---|---|---|---|
description | string | undefined | Description of the link. |
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 |
|
isSuperiorAction | boolean | Marker for superior action. |
|
key | string | undefined | Key of link. |
press | object | Callback for |
|
target | string | The standard values for the |
|
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. |
visibleChangedByUser | boolean | Describes whether the visibility is changed by end user or not. |
Method | Description |
---|---|
sap.ui.comp.navpopover.LinkData.extend |
Creates a new subclass of class sap.ui.comp.navpopover.LinkData with name
|
getDescription |
Gets current value of property description. Description of the link. Default value is |
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 |
getIsSuperiorAction |
Gets current value of property isSuperiorAction. Marker for superior action. |
getKey |
Gets current value of property key. Key of link. Default value is |
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 |
getTarget |
Gets current value of property target. The standard values for the |
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 |
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 Default value is |
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 When called with a value of |
setIsSuperiorAction |
Sets a new value for property isSuperiorAction. Marker for superior action. When called with a value of |
setKey |
Sets a new value for property key. Key of link. When called with a value of Default value is |
setPress |
Sets a new value for property press. Callback for When called with a value of |
setTarget |
Sets a new value for property target. The standard values for the When called with a value of |
setText |
Sets a new value for property text. Text which can be displayed on the UI When called with a value of |
setVisible |
Sets a new value for property visible. Describes whether the link should be visible on the screen. When called with a value of Default value is |
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 |
Gets current value of property description.
Description of the link.
Default value is undefined
.
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.
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.
Gets current value of property visible.
Describes whether the link should be visible on the screen.
Default value is true
.
Gets current value of property visibleChangedByUser.
Describes whether the visibility is changed by end user or not.
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |