BiRadioGroup

This class is used in conjunction with radio buttons to ensure only one buttons is checked.

This class extends BiEventTarget and therefore all methods and fields available for BiEventTarget are also available for BiRadioGroup .

Constructor

new BiRadioGroup ( )

Parameters

No parameters.

Properties

Name Type get set Descripton
command BiCommand checked checked When the radio group has a command the enabled and userValue are synchronized with the command.
enabled Boolean checked checked Whether the radio group is enabled or not. Setting this also sets the enabled property on the radio buttons.
items BiRadioButton[] checked This is the items that are part of the radio group
selected BiRadioButton checked checked This is the radio button that is checked
userValue Object checked checked This is the user value of the checked radio button in this radio group. Setting this checks the first item that has this value. If no item has this value the setting will have no effect.

Methods

Name Description
add Adds a radio button to the group
remove Removes a radio button from the group
selectNext Selects (checks and sets focus) the next valid radio button coming after the provided radio button.
selectPrevious Selects (checks and sets focus) the previous valid radio button coming before the provided radio button.

Events

Name Type Bubbles Descripton
change BiEvent This is fired when the selected radio button is changed

Static Methods

None.

Static Fields

None.

Remarks

Method Details

add

Adds a radio button to the group

Syntax

object.add
 (
 oRadioButton
 )
 

Parameters

Name Type Optional Default Descripton
oRadioButton BiRadioButton The radio button to add to the group

Return Type

void

remove

Removes a radio button from the group

Syntax

object.remove
 (
 oRadioButton
 )
 

Parameters

Name Type Optional Default Descripton
oRadioButton BiRadioButton The radio button to remove

Return Type

void

selectNext

Selects (checks and sets focus) the next valid radio button coming after the provided radio button.

Syntax

object.selectNext
 (
 oRadioButton
 )
 

Parameters

Name Type Optional Default Descripton
oRadioButton BiRadioButton The radio button to find the next relative to

Return Type

void

selectPrevious

Selects (checks and sets focus) the previous valid radio button coming before the provided radio button.

Syntax

object.selectPrevious
 (
 oRadioButton
 )
 

Parameters

Name Type Optional Default Descripton
oRadioButton BiRadioButton The radio button to find the previous relative to

Return Type

void