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:

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

Since:
1.0
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    CheckboxGroup()
    Creates a new instance of CheckboxGroup.

  • Method Summary

    Modifier and Type
    Method
    Description
    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 declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • CheckboxGroup

      public CheckboxGroup()
      Creates a new instance of CheckboxGroup.

  • Method Details

    • 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:
      1.1
      See Also:

    • getCurrent

      @Deprecated public Checkbox getCurrent()
      Deprecated.
      As of JDK version 1.1, replaced by getSelectedCheckbox().
      Returns the current choice from this check box group or null if none of checkboxes are selected.
      Returns:
      the selected checkbox

    • 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:
      1.1
      See Also:

    • setCurrent

      @Deprecated public void setCurrent(Checkbox box)
      Deprecated.
      As of JDK version 1.1, replaced by setSelectedCheckbox(Checkbox).
      Sets the currently selected check box in this group to be the specified check box and unsets all others.
      Parameters:
      box - the Checkbox to set as the current selection.

    • 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.