CheckboxGroup (Java Platform SE 6) (original) (raw)
java.awt
Class CheckboxGroup
java.lang.Object
java.awt.CheckboxGroup
All Implemented Interfaces:
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:
| 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](../../java/lang/Object.html#wait%28long, int%29) |
| 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
@Deprecated 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
@Deprecated 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](../../java/lang/Object.html#toString%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")
Returns:
a string representation of this check box group.
Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.