FileDocCategorySizeDatePackage
CheckboxGroup.javaAPI DocJava SE 5 API4158Fri Aug 26 14:56:44 BST 2005java.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:

Shows three checkboxes, arranged vertically, labeled one, two, and three. Checkbox one is in the on state.

version
1.36 05/18/04
author
Sami Shaio
see
java.awt.Checkbox
since
JDK1.0

Fields Summary
Checkbox
selectedCheckbox
The current choice.
private static final long
serialVersionUID
Constructors Summary
public CheckboxGroup()
Creates a new instance of CheckboxGroup.
Methods Summary
public java.awt.CheckboxgetCurrent()

deprecated
As of JDK version 1.1, replaced by getSelectedCheckbox().

	return selectedCheckbox;
public java.awt.CheckboxgetSelectedCheckbox()
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.

return
the check box that is currently in the "on" state, or null.
see
java.awt.Checkbox
see
java.awt.CheckboxGroup#setSelectedCheckbox
since
JDK1.1

	return getCurrent();
public synchronized voidsetCurrent(java.awt.Checkbox box)

deprecated
As of JDK version 1.1, replaced by setSelectedCheckbox(Checkbox).

	if (box != null && box.group != this) {
	    return;
	}
	Checkbox oldChoice = this.selectedCheckbox;
	this.selectedCheckbox = box;
	if (oldChoice != null && oldChoice != box && oldChoice.group == this) {
	    oldChoice.setState(false);
	}
	if (box != null && oldChoice != box && !box.getState()) {
	    box.setStateInternal(true);
	}
public voidsetSelectedCheckbox(java.awt.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, all check boxes in this check box group are deselected. If the check box argument belongs to a different check box group, this method does nothing.

param
box the Checkbox to set as the current selection.
see
java.awt.Checkbox
see
java.awt.CheckboxGroup#getSelectedCheckbox
since
JDK1.1

    	setCurrent(box);
public java.lang.StringtoString()
Returns a string representation of this check box group, including the value of its current selection.

return
a string representation of this check box group.

	return getClass().getName() + "[selectedCheckbox=" + selectedCheckbox + "]";