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
id The id is the identifier for the widget.
buttonType The following types of buttons can be specified for the button type property:
Button
Reset
Is used to reset the content of the form to the initial values.
Is used to invoke actions on the browser side.
Submit
Is used to submit data from the form to the server side.
Submit with no data
Is used to submit current form without any data. It may fire an event or call another operation, without data submitting to server side.
Submit without validation
Is used to submit form data to server without server side validation.
text Is the text that is displayed on the button for a user if a value has not been assigned for the
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, cannot receive user input. 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.
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.
hint The hint is a description of the widget that is displayed as a tooltip for a user. The hint property has multilingual support.
icon The icon property specifies the relative path of the icon that is displayed on the button. This is an optional property.
action The action property specifies the server-side action that is triggered when the Button widget is clicked. This property is set in the Action tab of the Properties view. 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.
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
width The width property specifies the width of the widget. This property is set in the Appearance tab of the Properties view.
height The height property specifies the height of the widget. This property is set in the Appearance tab of the Properties view.

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
isValid Submit button will only be enabled when the isValid property is true and the form containing the button has passed all the validations (field and cross validations). The default value is true.
Note: This property can be used in the Actions part of ECA rule.
icon The icon property specifies the relative path of the icon that is displayed on the button. This is an optional property.
Note: This property can be used in the Condition and Actions part of ECA rule.
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.
Note: 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.
Note: This property can be used in the Condition and Actions part of ECA rule.
disabled Disabled elements cannot have focus, do not receive or fire mouse events, cannot receive user input. 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.
Note: This property can be used in the Condition and Actions part of ECA rule.
hint The hint is a description of the widget that is displayed as a tooltip for a user. The hint property has multilingual support.
Note: This property can be used in the Actions part of ECA rule.
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
Note: This property can be used in the Actions part of ECA rule.
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.
Note: The function can be used in the Condition part of ECA rule.
focus Specifies that the widget should be focused.
Note: The function can be used in the Actions part of ECA rule.