- 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 sameButtonGroupobject means that turning "on" one of those buttons turns off all other buttons in the group.A
ButtonGroupcan 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 ofJButtonorJMenuItemin a button group becauseJButtonandJMenuItemdon'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 JavaBeans™ has been added to the
java.beanspackage. Please seeXMLEncoder.- Since:
- 1.2
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Vector<AbstractButton>buttonsThe list of buttons participating in this group.
-
Constructor Summary
Constructors Constructor Description ButtonGroup()Creates a newButtonGroup.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidadd(AbstractButton b)Adds the button to the group.voidclearSelection()Clears the selection such that none of the buttons in theButtonGroupare selected.intgetButtonCount()Returns the number of buttons in the group.Enumeration<AbstractButton>getElements()Returns all the buttons that are participating in this group.ButtonModelgetSelection()Returns the model of the selected button.booleanisSelected(ButtonModel m)Returns whether aButtonModelis selected.voidremove(AbstractButton b)Removes the button from the group.voidsetSelected(ButtonModel m, boolean b)Sets the selected value for theButtonModel.
-
-
-
Field Detail
-
buttons
protected Vector<AbstractButton> buttons
The list of buttons participating in this group.
-
-
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 theButtonGroupare selected.- Since:
- 1.6
-
getElements
public Enumeration<AbstractButton> getElements()
Returns all the buttons that are participating in this group.- Returns:
- an
Enumerationof 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- theButtonModelb-trueif this button is to be selected, otherwisefalse
-
isSelected
public boolean isSelected(ButtonModel m)
Returns whether aButtonModelis selected.- Parameters:
m- an isntance ofButtonModel- Returns:
trueif 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
-
-