CheckboxGroup (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

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

Most common way to construct:

CheckboxGroup cbg = new CheckboxGroup();

Based on 186 examples

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.

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

Method Summary
`Checkbox`	`getCurrent()`
`Checkbox`	`getSelectedCheckbox()` Gets the current choice from this check box group.
`void`	`setCurrent(Checkbox box)`
`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, toString, wait, wait, wait`

Constructor Detail

CheckboxGroup

public CheckboxGroup()

Creates a new instance of CheckboxGroup.

Method Detail

getCurrent

public Checkbox getCurrent()

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.

setCurrent

public synchronized void setCurrent(Checkbox box)

Parameters:: box

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.

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.