IBM WebSphere Multichannel Bank Transformation Toolkit, Version 7.1

XUI widget descriptions

This section provides a description of the widgets that are provided by IBM® WebSphere® Multichannel Bank Transformation Toolkit.

Implementation base

All the widgets described in this section consists of the following components unless otherwise stated:

The implementation base of a widget is the technology or widget library on which a widget is implemented.

Properties

All the widgets provided by WebSphere Multichannel Bank Transformation Toolkit have the properties listed in Table 1 unless otherwise stated.
Table 1. Widget properties
Property Property description
dataName The dataName property is the name of the data element to which the widget is bound. This property is optional.
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.
readOnly The readOnly 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 readOnly property, the widget is displayed on a GUI but a user cannot interact with it. If a widget has the value of its readOnly property set to true and the value of its disabled property set to false, the data of the widget is taken into account during form submission. The default value for the readOnly 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.

Data mapping

The data mapping of a widget describes how a widget binds with data from the WebSphere Multichannel Bank Transformation Toolkit data model.

ECA tool support

The following events, properties, and functions can be configured with the ECA tool.

Table 2. Events that can be added to a widget by using the ECA tool
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.
onKeyPress Is fired when a keyboard key is pressed or held down.
onKeyUp Is fired when a keyboard key is released.
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 a widget by using the ECA tool.
Property Property description
styleClass The styleClass property specifies the class selector that is associated with a 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 taken into account during form submission. The default value for the disabled property is false.
hint The hint is a description of the widget that is displayed as a tooltip for a user. The hint property has multilingual support.
Table 4. Functions that can be configured for a widget by using the ECA tool.
Function 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.

For detailed information on the properties, functions, and events of each widget and container, refer to the following topics.



Feedback