All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.CheckboxGroup 

java.lang.Object
   |
   +----java.awt.CheckboxGroup
public class CheckboxGroup
extends Object
implements Serializable
The CheckboxGroup class is used to group together a set of Checkbox buttons.

Exactly one check box button in a CheckboxGroup can be in the "on" state at any given time. Pushing any button sets its state to "on" and forces any other button that is in the "on" state into the "off" state.

The following code example produces a new check box group, with three check boxes: 

 setLayout(new GridLayout(3, 1));
 CheckboxGroup cbg = new CheckboxGroup();
 add(new Checkbox("one", cbg, true));
 add(new Checkbox("two", cbg, false));
 add(new Checkbox("three", cbg, false));

This image depicts the check box group created by this example:

See Also:
Checkbox

Constructor Index

o CheckboxGroup()
Creates a new instance of CheckboxGroup.

Method Index

o getCurrent()
Deprecated.
o getSelectedCheckbox()
Gets the current choice from this check box group.
o setCurrent(Checkbox)
Deprecated.
o setSelectedCheckbox(Checkbox)
Sets the currently selected check box in this group to be the specified check box.
o toString()
Returns a string representation of this check box group, including the value of its current selection.

Constructors

o CheckboxGroup 
 public CheckboxGroup()
Creates a new instance of CheckboxGroup.

Methods

o getSelectedCheckbox 
 public Checkbox getSelectedCheckbox()
Gets the current choice from this check box group. The current choice is the check box in this group that is currently in the "on" state, or null if all check boxes in the group are off.

Returns:
the check box that is currently in the "on" state, or null.
See Also:
Checkbox, setSelectedCheckbox
o getCurrent 
 public Checkbox getCurrent()
Note: getCurrent() is deprecated. As of JDK version 1.1, replaced by getSelectedCheckbox().

o setSelectedCheckbox 
 public synchronized void setSelectedCheckbox(Checkbox box)
Sets the currently selected check box in this group to be the specified check box. This method sets the state of that check box to "on" and sets all other check boxes in the group to be off.

If the check box argument is null or belongs to a different check box group, then this method does nothing.

Parameters:
box - the Checkbox to set as the current selection.
See Also:
Checkbox, getSelectedCheckbox
o setCurrent 
 public synchronized void setCurrent(Checkbox box)
Note: setCurrent() is deprecated. As of JDK version 1.1, replaced by setSelectedCheckbox(Checkbox).

o toString 
 public String toString()
Returns a string representation of this check box group, including the value of its current selection.

Returns:
a string representation of this check box group.
Overrides:
toString in class Object 
All Packages  Class Hierarchy  This Package  Previous  Next  Index