java.awt
Class CheckboxGroup

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.awt.CheckboxGroup
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class CheckboxGroup
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Serializable sample code for java.io.Serializable definition code for java.io.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.

Since:
JDK1.0
See Also:
Checkbox sample code for java.awt.Checkbox definition code for java.awt.Checkbox , Serialized Form

Constructor Summary
CheckboxGroup sample code for java.awt.CheckboxGroup.CheckboxGroup() definition code for java.awt.CheckboxGroup.CheckboxGroup() ()
          Creates a new instance of CheckboxGroup.
 
Method Summary
 Checkbox sample code for java.awt.Checkbox definition code for java.awt.Checkbox getCurrent sample code for java.awt.CheckboxGroup.getCurrent() definition code for java.awt.CheckboxGroup.getCurrent() ()
          Deprecated. As of JDK version 1.1, replaced by getSelectedCheckbox().
 Checkbox sample code for java.awt.Checkbox definition code for java.awt.Checkbox getSelectedCheckbox sample code for java.awt.CheckboxGroup.getSelectedCheckbox() definition code for java.awt.CheckboxGroup.getSelectedCheckbox() ()
          Gets the current choice from this check box group.
 void setCurrent sample code for java.awt.CheckboxGroup.setCurrent(java.awt.Checkbox) definition code for java.awt.CheckboxGroup.setCurrent(java.awt.Checkbox) (Checkbox sample code for java.awt.Checkbox definition code for java.awt.Checkbox  box)
          Deprecated. As of JDK version 1.1, replaced by setSelectedCheckbox(Checkbox).
 void setSelectedCheckbox sample code for java.awt.CheckboxGroup.setSelectedCheckbox(java.awt.Checkbox) definition code for java.awt.CheckboxGroup.setSelectedCheckbox(java.awt.Checkbox) (Checkbox sample code for java.awt.Checkbox definition code for java.awt.Checkbox  box)
          Sets the currently selected check box in this group to be the specified check box.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.awt.CheckboxGroup.toString() definition code for java.awt.CheckboxGroup.toString() ()
          Returns a string representation of this check box group, including the value of its current selection.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

CheckboxGroup sample code for java.awt.CheckboxGroup() definition code for java.awt.CheckboxGroup()

public CheckboxGroup()
Creates a new instance of CheckboxGroup.

Method Detail

getSelectedCheckbox sample code for java.awt.CheckboxGroup.getSelectedCheckbox() definition code for java.awt.CheckboxGroup.getSelectedCheckbox()

public Checkbox sample code for java.awt.Checkbox definition code for java.awt.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.
Since:
JDK1.1
See Also:
Checkbox sample code for java.awt.Checkbox definition code for java.awt.Checkbox , setSelectedCheckbox(java.awt.Checkbox) sample code for java.awt.CheckboxGroup.setSelectedCheckbox(java.awt.Checkbox) definition code for java.awt.CheckboxGroup.setSelectedCheckbox(java.awt.Checkbox)

getCurrent sample code for java.awt.CheckboxGroup.getCurrent() definition code for java.awt.CheckboxGroup.getCurrent()

@Deprecated
public Checkbox sample code for java.awt.Checkbox definition code for java.awt.Checkbox  getCurrent()
Deprecated. As of JDK version 1.1, replaced by getSelectedCheckbox().


setSelectedCheckbox sample code for java.awt.CheckboxGroup.setSelectedCheckbox(java.awt.Checkbox) definition code for java.awt.CheckboxGroup.setSelectedCheckbox(java.awt.Checkbox)

public void setSelectedCheckbox(Checkbox sample code for java.awt.Checkbox definition code for 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.

Parameters:
box - the Checkbox to set as the current selection.
Since:
JDK1.1
See Also:
Checkbox sample code for java.awt.Checkbox definition code for java.awt.Checkbox , getSelectedCheckbox() sample code for java.awt.CheckboxGroup.getSelectedCheckbox() definition code for java.awt.CheckboxGroup.getSelectedCheckbox()

setCurrent sample code for java.awt.CheckboxGroup.setCurrent(java.awt.Checkbox) definition code for java.awt.CheckboxGroup.setCurrent(java.awt.Checkbox)

@Deprecated
public void setCurrent(Checkbox sample code for java.awt.Checkbox definition code for java.awt.Checkbox  box)
Deprecated. As of JDK version 1.1, replaced by setSelectedCheckbox(Checkbox).


toString sample code for java.awt.CheckboxGroup.toString() definition code for java.awt.CheckboxGroup.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a string representation of this check box group, including the value of its current selection.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of this check box group.