Link

The Link widget is used to initiate an operation, processor, or to invoke an action.

Implementation base

The Link widget is a Dojo-based widget:
  • com.ibm.btt.dijit.Anchor

Properties

The following properties can be configured for the Link widget.
Table 1. Properties that can be configured for the Link widget.
Property Description
styleClass The styleClass property specifies the class selector that is associated with the widget. If you do not configure the styleClass property, the default class selector is used instead.
visibility The visibility property defines how a widget is displayed on a GUI. The following values can be specified for this property:
visible
The widget is displayed on a GUI and users are able to interact with the widget.
hidden
The widget is not displayed on a GUI, but it occupies space on the GUI.
gone
The widget is not displayed on a GUI, and it does not occupy space on the GUI.
disabled The disabled property is an expert-level property, which means that it is available for use in the XUI editor only if the XUI editor is configured to display expert properties. If you select a value of true for the disabled property, the widget is displayed on a GUI but a user cannot interact with it. Data contained in a disabled widget is not processed when the form is submitted. The default value for the disabled property is false.
id The id is the identifier for the widget.
hint The hint is a description of the widget that is displayed as a tooltip for a user. The hint property has multilingual support.
action The action property specifies the action that is triggered on the server-side when the link is clicked.
text The text property specifies the text that is displayed on the widget.
extraParams The extraParams property specifies parameters that you want to add to the widget. The parameters that are specified in the extraParams property are included in the link address.
target The target property specifies where the link is opened.
shortcut The shortcut property specifies a keyboard shortcut for the widget. If a user enters the keyboard shortcut on a client, the widget receives focus on the GUI of the client. You can specify either a single character as the value of the shortcut property, or you can specify Ctrl and a character as the value of the shortcut property.

Data mapping

Data mapping is not applied to the Link widget.

ECA editor support

The following events, properties, and functions can be configured for the Link widget with the ECA editor.
Table 2. Events that can be added to the Link widget by using the ECA editor.
Event Description
onClick Is fired when the left mouse button is clicked.
onFocus Is fired when the widget receives focus because the user moves the mouse pointer over the widget.
onBlur Is fired when the widget does not receive focus, or when the user clicks outside the widget, or when the widget is hidden.
onKeyDown Is fired when a keyboard key is pressed.
onKeyUp Is fired when a keyboard key is released.
onKeyPress Is fired when a keyboard key is pressed or held down.
onMouseDown Is fired when a mouse button is clicked.
onMouseUp Is fired when a mouse button is released
onMouseEnter Is fired when the mouse pointer moves over the widget.
onMouseLeave Is fired when the mouse pointer moves out of the widget.
onMouseMove Is fired when the mouse pointer moves over nodes that are contained in the widget.
Table 3. Properties that can be configured for the Link widget by using the ECA editor.
Property Description
text The text property specifies the text that is displayed on the widget.
target The target property specifies where the link is opened.
Table 4. Functions that can be configured for the Link widget by using the ECA editor.
Function Description
isFocusable Returns a value of true if a widget can be focused and a value of false if it cannot be focused.
focus Specifies that the widget should be focused.