Development tools : XUI editor : XUI widgets and containers : Widget descriptions : Link
  
Link
The Link widget is used to initiate an operation, processor, or to invoke an action.
See
Implementation base
Properties for the Link widget
See also
Widget descriptions
Implementation base
The Link widget is a Dojo-based widget:
com.ibm.btt.dijit.Anchor
See also
Link
Properties for the Link widget
 
Property
Description
id
The identifier for the widget.
text
The text property specifies the text that is displayed on the widget.
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
Disabled elements cannot have focus; do not receive or fire mouse events; and cannot receive user input. If you set this property to true, 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 is false.
shortcut
Shortcut is a single character from the document character set. Pressing a shortcut assigned to a widget together with hot key of browser gives focus to the widget. Different widget may have different action when it receives focus. For example, when user activates a TextBox, this TextBox is focused and all texts are selected; when user activates a button, this button is focused and selected. The toolkit supports a shortcut function based on standard HTML access key and browser capability. That's mean the shortcut character and the hot key may be different in different browsers. For more information about HTML access keys, see:
Action for Link is: focus and submit link
Shortcut character: a-z 0-9 , . / ; ’ [ ]  = -
Hot key
Firefox: Shift + Alt + shortcut
IE: Alt + shortcut
Sample
Input on UDTT tooling: a
Usage on IE: Pressing Alt + a
target
The target property specifies where the link is opened.
hint
A description of the widget that is displayed as a tooltip for a user. This property has multilingual support.
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.
action
The action property specifies the action that is triggered on the server-side when the link is clicked. This property is set in the Action tab of the Properties view.
styleClass
The styleClass property specifies the name of the CSS style ( also known as CSS style class) associated with the widget. This property is set by selecting a style from the CSS styles table in the Style tab of the Properties view. If you do not configure the styleClass property, the default style is used instead. For more detailed information, refer to Setting CSS style to widgets.
dataNameForLink
(Optional.) Points to a data field at context. The link acts as you defined in the data field when this field is set and the actions properties is empty.
It should be a well‑formatted URL, for example:
request?param1=p1&param2=p2
See
ECA editor support
See also
Link
ECA editor support
The following events, properties, and functions can be configured for the Link widget with the ECA editor.
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.
Properties that can be configured for the Link widget by using the ECA editor
 
Property
Description
id
This property can be used in the Condition part of ECA rule.
text
The text property specifies the text that is displayed on the widget.
This property can be used in the Condition and Actions part of ECA rule.
target
The target property specifies where the link is opened.
This property can be used in the Condition and Actions part of ECA rule.
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.
This property can be used in the Condition and Actions part of ECA rule.
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 taken into account during form submission. The default value for the disabled property is false.
This property can be used in the Condition and Actions part of ECA rule.
styleClass
This property can be used in the Action part of ECA rule.
hint
This property can be used in the Action part of ECA rule.
Functions that can be configured for the Link widget by using the ECA editor
 
Function
Description
isFocusable
This property can be used in the Condition part of ECA rule.
focus
This property can be used in the Action part of ECA rule.
See also
Properties for the Link widget