OpenJDK 27 · java.awt.CheckboxGroup · APIdia, the JavaDoc alternative

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.

Modifier and Type	Field and Description
pack-priv Checkbox	selectedCheckbox The current choice.
private static final long	serialVersionUID Use serialVersionUID from JDK 1.1 for interoperability.

Constructor Summary

Access	Constructor and Description
public	CheckboxGroup() Creates a new instance of `CheckboxGroup`.

Method Summary

Modifier and Type	Method and Description
public Checkbox	Returns: the selected 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.
public Checkbox	Returns: the check box that is currently in the "on" state, or `null`. getSelectedCheckbox() Gets the current choice from this check box group.
public synchronized void	setCurrent(Checkbox the `Checkbox` to set as the current selection. 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.
public void	setSelectedCheckbox(Checkbox the `Checkbox` to set as the current selection. box) Sets the currently selected check box in this group to be the specified check box.
public String	Returns: a string representation of this check box group. toString() Overrides java.lang.Object.toString. Returns a string representation of this check box group, including the value of its current selection.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

selectedCheckbox back to summary

selectedCheckbox	back to summary
pack-priv Checkbox selectedCheckbox The current choice. See Also `getCurrent()`, `setCurrent(Checkbox)`

pack-priv Checkbox selectedCheckbox

The current choice.

See Also: getCurrent(), setCurrent(Checkbox)

serialVersionUID	back to summary
private static final long serialVersionUID Use serialVersionUID from JDK 1.1 for interoperability. Annotations @Serial

Constructor Detail

CheckboxGroup	back to summary
public CheckboxGroup() Creates a new instance of `CheckboxGroup`.

Method Detail

getCurrent back to summary

getCurrent	back to summary
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:Checkbox the selected checkbox Annotations @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:Checkbox

the selected checkbox

Annotations

@Deprecated

getSelectedCheckbox back to summary

getSelectedCheckbox	back to summary
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:Checkbox the check box that is currently in the "on" state, or `null`. Since 1.1 See Also `java.awt.Checkbox`, `java.awt.CheckboxGroup#setSelectedCheckbox`

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:Checkbox: the check box that is currently in the "on" state, or null.
Since: 1.1
See Also: java.awt.Checkbox, java.awt.CheckboxGroup#setSelectedCheckbox

setCurrent back to summary

setCurrent	back to summary
public synchronized 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:Checkbox the `Checkbox` to set as the current selection. Annotations @Deprecated

public synchronized 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:Checkbox: the Checkbox to set as the current selection.

Annotations

@Deprecated

setSelectedCheckbox back to summary

setSelectedCheckbox	back to summary
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:Checkbox the `Checkbox` to set as the current selection. Since 1.1 See Also `java.awt.Checkbox`, `java.awt.CheckboxGroup#getSelectedCheckbox`

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:Checkbox: the Checkbox to set as the current selection.

Since

1.1

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation of this check box group, including the value of its current selection. Returns:String a string representation of this check box group.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this check box group, including the value of its current selection.

Returns:String: a string representation of this check box group.

public Class CheckboxGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail