Skip to Content
Author's profile photo Jerry Wang

Smart Field with Smart Link

The hyperlink could easily be defined by Smart field with the help of corresponding annotation declared in OData Model metadata.

The hyperlink in this example looks like below in UI:

/wp-content/uploads/2016/03/clipboard1_908322.png

Once clicked, it will display an additional popup contained more information which is defined in the application code:

/wp-content/uploads/2016/03/clipboard2_908323.png

All the source code of this sample project could be found from this link.

Project resource overview

1. the label of Hyperlink field is defined in metadata via annotation “sap:label”

2. the hyperlink field itself is defined in XML view. Its value is bound to field Name in OData Model.

<form:content>
   <smartField:SmartLabel labelFor="idName" />
   <smartField:SmartField value="{Name}" id="idName" editable="false" />
  </form:content>

3. in OData model, the field Name has maintained annotation “com.sap.vocabularies.Common.v1.SemanticObject” so in runtime UI5 framework will render it as a SmartLink.

4. Once pressed, UI5 framework will raise a popup which contains additional three links which are available to click. The navigation target is defined by application as below.

/wp-content/uploads/2016/03/clipboard5_908334.png

How link related annotation is parsed and SmartLink instance is created

As discussed in previous two blogs, UI5 framework will try to scan all potential annotations in OData model metadata,

/wp-content/uploads/2016/03/clipboard6_908342.png

/wp-content/uploads/2016/03/clipboard7_908344.png

Since now semantic annotation is available, in line 55 there is a central _getCreator which will return the dedicated function name for control creation.

/wp-content/uploads/2016/03/clipboard8_908345.png

In our example, the function name is _createEdmSemantic because of the availability of semantic annotation:

/wp-content/uploads/2016/03/clipboard9_908346.png

Within this _createEdmSemantic, a new instance of SmartLink is created.

/wp-content/uploads/2016/03/clipboard10_908347.png

In its constructor, the Press event handler is registered and hyperlink CSS class is added.

/wp-content/uploads/2016/03/clipboard11_908351.png

How is the popup dialog rendered when hyperlink is pressed

In event handler _linkPressed, semantic Attributes are calculated and returned:

/wp-content/uploads/2016/03/clipboard12_908352.png

_linkPressed calls fOpen() for Popup creation and display logic:

/wp-content/uploads/2016/03/clipboard13_908353.png

As the first step, in fOpen() a new popup dialog is created via _createPopover().

/wp-content/uploads/2016/03/clipboard14_908354.png

The popup dialog is implemented by NavigationPopover. When the links within this popup dialog are clicked, _onInnerNavigate will be called.

/wp-content/uploads/2016/03/clipboard15_908355.png

In order to render the hyperlinks within the popup dialog, UI5 framework must know the navigation target url. This information is provided by application and retrieved by UI5 framework asynchronously:

/wp-content/uploads/2016/03/clipboard16_908356.png

The navigation target information from application is passed into UI5 framework callback and LinkData instance is created based on each of them, then added to popup dialog instance.

/wp-content/uploads/2016/03/clipboard17_908367.png

After that you could observe that the three navigation information are maintained in the popup dialog instance’s aggregation area:

/wp-content/uploads/2016/03/clipboard23_908368.png

Once all is done, TargetsObtained event is raised:

/wp-content/uploads/2016/03/clipboard24_908375.png

And the event handler for it will call show function of popup dialog, so you could see it in UI finally.

/wp-content/uploads/2016/03/clipboard25_908376.png

Assigned Tags

      4 Comments
      You must be Logged on to comment or reply to a post.
      Author's profile photo LINDSAY Wang
      LINDSAY Wang

      How do I add this annotation in backend using cds or abap?

      Author's profile photo Axel Mohnen
      Axel Mohnen

      Hi Lindsay,

      Good question, how did you finally manage your issue?

      "How do I add this annotation in backend using cds or abap?"

      Thanks,

      Kind regards

      Axel

      Author's profile photo LINDSAY Wang
      LINDSAY Wang

      I didn't use this semantic object finally. I use Link instead of smartfield.

      BR, Lindsay

      Author's profile photo Axel Mohnen
      Axel Mohnen

      Thanks for the answer. I will do it in a similar way. Smartfield with "press" event.

      Kr Axel