- java.lang.Object
-
- javax.swing.ButtonGroup
-
- All Implemented Interfaces:
- Serializable
public class ButtonGroup extends Object implements Serializable
This class is used to create a multiple-exclusion scope for a set of buttons. Creating a set of buttons with the sameButtonGroup
object means that turning "on" one of those buttons turns off all other buttons in the group.A
ButtonGroup
can be used with any set of objects that inherit fromAbstractButton
. Typically a button group contains instances ofJRadioButton
,JRadioButtonMenuItem
, orJToggleButton
. It wouldn't make sense to put an instance ofJButton
orJMenuItem
in a button group becauseJButton
andJMenuItem
don't implement the selected state.Initially, all buttons in the group are unselected.
For examples and further information on using button groups see How to Use Radio Buttons, a section in The Java Tutorial.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the
java.beans
package. Please seeXMLEncoder
.
-
-
Field Summary
Fields Modifier and Type Field and Description protected Vector<AbstractButton>
buttons
-
Constructor Summary
Constructors Constructor and Description ButtonGroup()
Creates a newButtonGroup
.
-
Method Summary
Methods Modifier and Type Method and Description void
add(AbstractButton b)
Adds the button to the group.void
clearSelection()
Clears the selection such that none of the buttons in theButtonGroup
are selected.int
getButtonCount()
Returns the number of buttons in the group.Enumeration<AbstractButton>
getElements()
Returns all the buttons that are participating in this group.ButtonModel
getSelection()
Returns the model of the selected button.boolean
isSelected(ButtonModel m)
Returns whether aButtonModel
is selected.void
remove(AbstractButton b)
Removes the button from the group.void
setSelected(ButtonModel m, boolean b)
Sets the selected value for theButtonModel
.
-
-
-
Field Detail
-
buttons
protected Vector<AbstractButton> buttons
-
-
Method Detail
-
add
public void add(AbstractButton b)
Adds the button to the group.- Parameters:
b
- the button to be added
-
remove
public void remove(AbstractButton b)
Removes the button from the group.- Parameters:
b
- the button to be removed
-
clearSelection
public void clearSelection()
Clears the selection such that none of the buttons in theButtonGroup
are selected.- Since:
- 1.6
-
getElements
public Enumeration<AbstractButton> getElements()
Returns all the buttons that are participating in this group.- Returns:
- an
Enumeration
of the buttons in this group
-
getSelection
public ButtonModel getSelection()
Returns the model of the selected button.- Returns:
- the selected button model
-
setSelected
public void setSelected(ButtonModel m, boolean b)
Sets the selected value for theButtonModel
. Only one button in the group may be selected at a time.- Parameters:
m
- theButtonModel
b
-true
if this button is to be selected, otherwisefalse
-
isSelected
public boolean isSelected(ButtonModel m)
Returns whether aButtonModel
is selected.- Returns:
true
if the button is selected, otherwise returnsfalse
-
getButtonCount
public int getButtonCount()
Returns the number of buttons in the group.- Returns:
- the button count
- Since:
- 1.3
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/buttongroup.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.