    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

##

CheckboxGroup()
  Creates a new instance of `CheckboxGroup`.

##

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

##

CheckboxGroup

     public CheckboxGroup()

  Creates a new instance of `CheckboxGroup`.

##

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

getCurrent

     public Checkbox getCurrent()

  Note: getCurrent() is deprecated. As of JDK version 1.1, replaced by `getSelectedCheckbox()`.

setSelectedCheckbox

     public 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

setCurrent

     public synchronized void setCurrent(Checkbox box)

  Note: setCurrent() is deprecated. As of JDK version 1.1, replaced by `setSelectedCheckbox(Checkbox)`.

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

Submit a bug or feature - Version 1.1.8 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1995-1999 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.