CheckboxGroup (Java 2 Platform SE v1.4.1_"07")

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## java.awt
Class CheckboxGroup

    java.lang.Object
      |
      +--java.awt.CheckboxGroup

All Implemented Interfaces:
  Serializable

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:

Since:
  JDK1.0
See Also:
  `Checkbox`, Serialized Form

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

Method Summary
`Checkbox` | `getCurrent()` Deprecated. As of JDK version 1.1, replaced by `getSelectedCheckbox()`.
`Checkbox` | `getSelectedCheckbox()` Gets the current choice from this check box group.
`void` | `setCurrent(Checkbox box)` Deprecated. As of JDK version 1.1, replaced by `setSelectedCheckbox(Checkbox)`.
`void` | `setSelectedCheckbox(Checkbox box)` Sets the currently selected check box in this group to be the specified check box.
`String` | `toString()` Returns a string representation of this check box group, including the value of its current selection.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### CheckboxGroup

    public CheckboxGroup()

  Creates a new instance of `CheckboxGroup`.

Method Detail

### 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`.
  Since:
    JDK1.1
  See Also:
    `Checkbox`, `setSelectedCheckbox(java.awt.Checkbox)`

### getCurrent

    public Checkbox getCurrent()

  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`, 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`, `getSelectedCheckbox()`

### setCurrent

    public void setCurrent(Checkbox box)

  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.

  Overrides:
    `toString` in class `Object`
  Returns:
    a string representation of this check box group.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.