|
Use the ui:radioButtonGroup tag to display two or more
radio buttons in a grid layout in the rendered HTML page. The
ui:radioButtonGroup tag attributes that
you specify determine how the radio buttons are displayed.
If the label attribute is specified a
com.sun.rave.web.ui.component.Label component
is rendered before the first radio button and
identifies the radio button group. The label component's
for attribute is
set to the id attribute of the first radio button in
the rendered HTML page.
The radio buttons are laid out in rows and columns in an HTML
<table>
element. The number of rows is defined by the length of the items
array. The number of columns is defined by the columns attribute. The
default layout is a single vertical column.
The items attribute must be a value binding expression.
The value binding expression assigned to the items
property evaluates to an Object array of
com.sun.rave.web.ui.model.Option instances.
Each
instance represents one radio button. The value property
of an Option instance represents the value of a
selected radio button.
If the items array is empty nothing is rendered.
At least one radio button should be selected by the application.
The selected attribute must also be a value binding
expression that is evaluated to read and write an Object.
When an Object value is read from the value binding
expression, it identifies the selected radio button.
The Object value must
be equal to the value property of at least one Option
instance specified in the array obtained from the value binding
expression assigned to the items attribute.
The write method of the selected attribute value
binding expression is called during the UPDATE_MODEL_PHASE
of the JSF lifecyle. If a radio button is selected
an Object value is passed as an argument to the
write method. The Object value is the
value of the selected radio button.
HTML Elements and Layout
A ui:radioButtonGroup renders one
com.sun.rave.web.ui.component.RadioButton component for
each element in the items array.
See ui:radioButton for
details on the HTML elements and components rendered for a
radio button.
The value of the name attribute of each
RadioButton component rendered is assigned the
clientId of the RadioButtonGroup
component instance associated with this tag. The id
attribute of each RadioButton component rendered
is formed as follows, where rbgrpid is the id of the
RadioButtonGroup instance and N is the nth
radio button.
See ui:radioButton for
details on how the id properties of the components that make up the
radio button are defined.
Client Side Javascript Functions
none.
Example
Example 1: Create a radio button group
<ui:radioButtonGroup items="#{rbcbGrp.selections}"
label="#{rbcbGrp.rbGrpLabel}"
toolTip="rbgrp-tooltip"
tabIndex="1"
columns="3"
labelLevel="2"
selected="#{rbcbGrp.selection}">
</ui:radioButtonGroup>
This example creates a radio button group with an identifying
label for the group before the first radio button. The
data for the radio buttons is obtained from the value binding
expression #{rbcbGrp.selections} where rbcbGrp
is an application defined managed bean. The bean provides the values for
other attributes such as selected to receive the
value of the selected radio button in the group.
Auto-generated component class.
Do NOT modify; all changes
will be lost!
| 