Development tools : XUI editor : XUI widgets and containers : Widget descriptions : Radio
  
Radio
A Radio widget is displayed as a circle with text beside it that indicates a fixed set of choices from which only one can be selected. All the radio buttons in a list share the same data, and the change in status of a Radio widget can be detected by the other widgets on the page.
See
Implementation base
Properties for the Radio widget
Grouping of radios
Data binding
See also
Widget descriptions
Implementation base
The Radio widget is a Dojo-based widget:
com.ibm.btt.dijit.RadioButton
See also
Radio
Properties for the Radio widget
 
Property
Description
id
The identifier for the widget.
dataName
The name of the data element to which the widget is bound. This property is not mandatory. When there is no data need to be sent to the server, this property can be left blank. Note: If you want to put multiple radios in one group, you need to bind the same dataName for all the radios.
value
The value property specifies the value of the group of radio buttons when a radio button is selected. For each radio in one group, you need to set the same dataName and a different value.
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.
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 Radio is : focus and select radio
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
readOnly
To prevent a user from changing the value, set readOnly to true. The default value is false.
hint
A description of the widget that is displayed as a tooltip for a user. This property has multilingual support.
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.
checkedValue
This is a required property. The checkValue property specifies the value of the checkbox field when it is selected. The default value is true.
uncheckedValue
This is a required property. The uncheckValue property specifies the value of the checkbox field when it is not selected. The default value is false.
See also
Radio
Grouping of radios
The radio group helps users to make an exclusive option among multiple alternatives. When you select one radio, all other radios in the same group are unselected.
To put multiple radios in one group, there are three requirements:
All the radios must be in the same form.
All the radios must bind to the same dataName.
Each radio must set a different value.
See also
Radio
Data binding
When the Radio widget is being loaded with data from a context, the radio button is selected if the value of the data field matches the value property of the Radio widget.
When data is sent from the Radio widget to a context, the value of the value property is sent.
See
ECA editor support
See also
Radio
ECA editor support
Events that can be added to the Radiowidget by using the ECA editor
 
Event
Description
onClick
Is fired when the left mouse button is clicked.
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.
onChange
Is fired when the value of the widget changes.
Properties that can be configured for the Radio widget by using the ECA editor
 
Property
Description
id
This property can be used in the Condition part of ECA rule.
isChecked
The isChecked property indicates whether the widget has been selected. Possible values are true and false..
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.
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.
readOnly
To prevent a user from changing the value, set readOnly to true. The default value is false.
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 Action part of ECA rule.
styleClass
This property can be used in the Action part of ECA rule.
Functions that can be configured for the Radio 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
Data binding