Development tools : XUI editor : XUI widgets and containers : Widget descriptions : Button
  
Button
The Button widget is used to invoke an event or action when it is clicked.
See
Implementation base
Properties for the Button widget
See also
Widget descriptions
Implementation base
The Button widget is a Dojo-based widget:
com.ibm.btt.dijit.Button
See also
Button
Properties for the Button widget
 
Property
Description
id
The identifier for the widget.
buttonType
The following types of buttons can be specified for the button type property:
Button
Reset
Resets the content of the form to the initial values.
Invokes actions on the browser side.
Submit
Submits data from the form to the server side.
Submit with no data
Submits current form without any data. It may fire an event or call another operation, without data submitting to server side.
Submit without validation
Submits form data to server without server side validation.
text
Text that is displayed on the button for a user if a value has not been assigned for it.
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 Button is: focus and select button
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
hint
A description of the widget that is displayed as a tooltip for a user. This 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 UDTT 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 UDTT 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 UDTT 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.
See
ECA editor support
See also
Button
ECA editor support
The following events, properties, and functions can be configured for the Button widget with the ECA editor.
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.
Properties that can be configured for the Button widget using the ECA editor
 
Property
Description
id
This property can be used in the Condition part of ECA rule.
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.
This property can be used in the Action 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.
This property can be used in the Condition and Actions part of ECA rule.
text
The text property 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.
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
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.
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.
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.
Functions that can be configured for the Button widget 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 Condition part of ECA rule.
See also
Properties for the Button widget