com.sun.dtv.lwuit
Class ButtonGroup

java.lang.Object
  com.sun.dtv.lwuit.ButtonGroup

public class ButtonGroup
extends Object

This class is used to create a multiple-exclusion scope for a set of RadioButtons. Creating a set of RadioButtons with the same ButtonGroup object means that only one RadioButton can be selected among the ButtonGroup. Initially all RadioButtons are unselected.

Constructor Summary

ButtonGroup()
Creates a new instance of ButtonsGroup.

Method Summary

void	add(RadioButton rb) Adds a RadioButton to the group.
void	clearSelection() Clears the selection such that none of the buttons in the ButtonGroup are selected.
int	getButtonCount() Returns the number of buttons in the group.
RadioButton	getRadioButton(int index) Returns the radio button at the given group index.
int	getSelectedIndex() Return the index of the selected button within the group.
boolean	isSelected() Returns whether a radio button in the group is selected.
void	remove(RadioButton rb) Removes a RadioButton from the group.
void	setSelected(int index) Sets the selected Radio button by index.
void	setSelected(RadioButton rb) Selects the given radio button.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ButtonGroup

public ButtonGroup()

Creates a new instance of ButtonsGroup.

Method Detail

add

public void add(RadioButton rb)

Adds a RadioButton to the group.

Parameters:

rb - a RadioButton to add

remove

public void remove(RadioButton rb)

Removes a RadioButton from the group.

Parameters:

rb - a RadioButton to remove

clearSelection

public void clearSelection()

Clears the selection such that none of the buttons in the ButtonGroup are selected.

getButtonCount

public int getButtonCount()

Returns the number of buttons in the group.

Returns:

number of radio buttons in the group

isSelected

public boolean isSelected()

Returns whether a radio button in the group is selected.

Returns:

true if a selection was made in the radio button group

getSelectedIndex

public int getSelectedIndex()

Return the index of the selected button within the group.

Returns:

the index of the selected button within the group

getRadioButton

public RadioButton getRadioButton(int index)

Returns the radio button at the given group index.

Parameters:

index - offset within the group starting with 0 and no larger than getButtonCount()

Returns:

the radio button instance

setSelected

public void setSelected(RadioButton rb)

Selects the given radio button.

Parameters:

rb - the radio button to set as selected

setSelected

public void setSelected(int index)

Sets the selected Radio button by index.

Parameters:

index - the index of the radio button to mark as selected