org.danieltofan.tools

Class JButtonGroup

java.lang.Object

javax.swing.ButtonGroup

org.danieltofan.tools.JButtonGroup

All Implemented Interfaces:

Serializable

public class JButtonGroup
extends javax.swing.ButtonGroup

Extends javax.swing.ButtonGroup to provide methods that allow working with button references instead of button models.

See Also:

ButtonGroup, Serialized Form

Field Summary

Fields inherited from class javax.swing.ButtonGroup

buttons

Constructor Summary

Constructors

Constructor and Description
JButtonGroup() Creates an empty JButtonGroup

Method Summary

Modifier and Type	Method and Description
void	add(javax.swing.AbstractButton button) Adds a button to the group
void	add(javax.swing.AbstractButton[] buttons) Adds an array of buttons to the group
boolean	contains(javax.swing.AbstractButton button) Checks whether the group contains the given button
static JButtonGroup	create(javax.swing.AbstractButton[] buttons) Creates a JButtonGroup object from an array of buttons and adds the buttons to the group.
javax.swing.AbstractButton	getButton(javax.swing.ButtonModel model) Returns the AbstractButton whose ButtonModel is given.
java.util.List	getButtons() Returns the buttons in the group as a List
javax.swing.AbstractButton	getSelected() Returns the selected button in the group.
boolean	isSelected(javax.swing.AbstractButton button) Returns whether the button is selected
void	remove(javax.swing.AbstractButton button) Removes a button from the group
void	remove(javax.swing.AbstractButton[] buttons) Removes all the buttons in the array from the group
void	setSelected(javax.swing.AbstractButton button, boolean selected) Sets the selected button in the group Only one button in the group can be selected
void	setSelected(javax.swing.ButtonModel model, boolean selected) Sets the selected button model in the group

Methods inherited from class javax.swing.ButtonGroup

clearSelection, getButtonCount, getElements, getSelection, isSelected

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JButtonGroup

public JButtonGroup()

Creates an empty JButtonGroup

Method Detail

create

public static JButtonGroup create(javax.swing.AbstractButton[] buttons)

Creates a JButtonGroup object from an array of buttons and adds the buttons to the group. No button will be selected initially.

Parameters:

buttons - an array of AbstractButtons

Returns:

the newly created JButtonGroup.

add

public void add(javax.swing.AbstractButton button)

Adds a button to the group

Overrides:

add in class javax.swing.ButtonGroup

Parameters:

button - an AbstractButton reference

add

public void add(javax.swing.AbstractButton[] buttons)

Adds an array of buttons to the group

Parameters:

buttons - an array of AbstractButtons

remove

public void remove(javax.swing.AbstractButton button)

Removes a button from the group

Overrides:

remove in class javax.swing.ButtonGroup

Parameters:

button - the button to be removed

remove

public void remove(javax.swing.AbstractButton[] buttons)

Removes all the buttons in the array from the group

Parameters:

buttons - an array of AbstractButtons

setSelected

public void setSelected(javax.swing.AbstractButton button,
                        boolean selected)

Sets the selected button in the group Only one button in the group can be selected

Parameters:

button - an AbstractButton reference

selected - an boolean representing the selection state of the button

setSelected

public void setSelected(javax.swing.ButtonModel model,
                        boolean selected)

Sets the selected button model in the group

Overrides:

setSelected in class javax.swing.ButtonGroup

Parameters:

model - a ButtonModel reference

selected - an boolean representing the selection state of the button

getButton

public javax.swing.AbstractButton getButton(javax.swing.ButtonModel model)

Returns the AbstractButton whose ButtonModel is given. If the model does not belong to a button in the group, returns null.

Parameters:

model - a ButtonModel that should belong to a button in the group

Returns:

an AbstractButton reference whose model is model if the button belongs to the group, nullotherwise

getSelected

public javax.swing.AbstractButton getSelected()

Returns the selected button in the group.

Returns:

a reference to the currently selected button in the group or null if no button is selected

isSelected

public boolean isSelected(javax.swing.AbstractButton button)

Returns whether the button is selected

Parameters:

button - an AbstractButton reference

Returns:

true if the button is selected, false otherwise

getButtons

public java.util.List getButtons()

Returns the buttons in the group as a List

Returns:

a List of the buttons in the group, in the order they were added to the group

contains

public boolean contains(javax.swing.AbstractButton button)

Checks whether the group contains the given button

Parameters:

button - the given button

Returns:

true if the button is in the group, false otherwise