Button

The Button widget is used to invoke an event or action when it is clicked.

Implementation base

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

Property

The following properties can be configured for the Button widget.
Table 1. Properties that can be configured for the Button 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 server-side action that is triggered when the Button widget is clicked. The action property consists of the following sub-properties:
flowEvent
The flowEvent is the event that is sent to the WebSphere® Multichannel Bank Transformation Toolkit navigation flow and causes the processor to proceed to the next state when the Button widget is clicked.
flowId
The flowId is the ID of the WebSphere Multichannel Bank Transformation Toolkit flow that is launched when the Button widget is clicked. If a flowId is specified, a new flow instance is created and initiated on the server.
operationId
The operationId is the ID of the WebSphere Multichannel Bank Transformation Toolkit operation that is launched when the Button widget is clicked.
This is an optional property. If a value is not specified for the action property of the Button widget, the value specified for the action property of the Form widget is used instead.
icon The icon property specifies the relative path of the icon that is displayed on the button. This is an optional property.
button type The following three types of buttons can be specified for the button type property:
Button
Is used to invoke actions on the browser side.
Submit
Is used to submit data from the form to the server side.
Reset
Is used to reset the content of the form to the initial values.
width The width property specifies the width of the widget.
height The height property specifies the height of the widget.
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 Button widget.

ECA editor support

The following events, properties, and functions can be configured for the Button widget with the ECA editor.
Table 2. Events that can be added to the Button widget 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 Button widget using the ECA editor.
Property Description
icon The icon property specifies the relative path of the icon that is displayed on the button. This is an optional property.
text Is the text that is displayed on the label for a user if a value has not been assigned for the dataName property. This is an optional property.
Table 4. Functions that can be configured for the Button widget 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.