Radio Button

Definition

A button that a user clicks to set an option. Unlike checkboxes, radio buttons are mutually exclusive - selecting one radio button menu item deselects all others in that group. That is also the reason why you cannot define a radioButton by itself - it always has to be defined within a radioButtonGroup. The radioButton control can be for client side eventing. See the EventValidationComponent description for more details.

  • enabled - inherited from the EventValidationComponent .

    A boolean value that defines if the radioButton is click able. If the radioButton is disabled (enabled = false) it is not selectable. A disabled radioButton has a different background color for the radioButton graphic and if the radioButton is checked the a different color for the button mark.

  • encode

    A boolean value that defines how the radioButton text is interpreted. HTML text formatting commands (for example, <h1>, <i> etc.) can be used to change the display of the radioButton text. If there are no formatting commands in the radioButton text string, the encode attribute has no effect.

    For example: text="<h1><i>Walldorf</i></h1>"

    If encode="false" , browser output is the text string rendered by interpreting the formatting commands.

    If encode="true" , browser output is text="<h1><i>Walldorf</i></h1>" , because the formatting commands are displayed and not interpreted

  • id

    Identification name of the radioButton.

  • jsObjectNeeded - inherited from Component .

    A boolean value that defines if a JavaScript object has to be generated for the radioButton component.

  • key

    A string which is assigned to the radioButton when the form is sent to the server. A key string must be defined and must not be empty.

  • labeled

    Enables or disables the notification when the control has a label assigned to it.

  • selected

    Sets the status of the radio button. Is selected set to "true", a filled circle is displayed inside the radio button.

  • text

    Defines the string of text placed right of the radiobutton graphic. If no text should be displayed an empty string (null) can be used. See 'encode' for a formatting example with embedded HTML commands.

  • tooltip

    Defines the hint of the radioButton which is displayed as the mouse cursor passes over the radioButton, or as the mouse button is pressed but not released.

Attributes

M

Values

Usage

enabled*

FALSE

TRUE (d)

Taglib

disabled="TRUE"

Classlib

setEnabled (false)

encode*

FALSE

TRUE (d)

Taglib

encode="FALSE"

Classlib

setEncode(false)

id

*

String

Taglib

id="GenderInfo"

Classlib

setId("GenderInfo")

jsObjectNeeded

FALSE (d)

TRUE

Taglib

jsObjectNeeded="TRUE"

Classlib

setJsObjectNeeded(true)

key

String

Taglib

key="rb_k1"

Classlib

setKey("rb_k1")

labeled

FALSE (d)

TRUE

Taglib

No tag available

Classlib

setLabeled(true)

selected

FALSE (d)

TRUE

Taglib

No tag available

Classlib

setSelected(true)

text

String

Taglib

text="female"

Classlib

setText("female")

tooltip

String

Taglib

tooltip="I am female"

Classlib

setTooltip("I am female")

* Method is inherited from the EventValidationComponent component. Therefore the attribute is different between the taglib and the classlib.

** Method is inherited from the Component component.

See the JavaScript API description for details how to access the component in JavaScript.

Example

A radioButton has to be used together with a radioButtonGroup . Refer to the radioButtonGroup documentation for the example.