com.levigo.util.swing
Class JButtonGroup

java.lang.Object
  javax.swing.ButtonGroup
      com.levigo.util.swing.JButtonGroup

All Implemented Interfaces:

Serializable

public class JButtonGroup
extends ButtonGroup

JButtonGroup is an useful enhanced version of its ancestor class ButtonGroup. It provides the possibility to listen to button group and selection changes, but also it allows to clear the button group selection.

Author:

Carolin Köhler

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.ButtonGroup

buttons

Constructor Summary

JButtonGroup()
Creates an empty JButtonGroup

JButtonGroup(AbstractButton[] buttons)
Creates a JButtonGroup object from an array of buttons and adds the buttons to the group.

Method Summary

void	add(AbstractButton button) Adds a button to the group
void	add(AbstractButton[] buttons) Adds an array of buttons to the group
void	addChangeListener(ChangeListener l) Adds a ChangeListener to the button.
void	clearSelection() Clears the current selection.
boolean	contains(AbstractButton button) Checks whether the group contains the given button
protected void	fireStateChanged() Notifies all listeners that have registered interest for notification on this event type.
AbstractButton	getButton(ButtonModel model) Returns the AbstractButton whose ButtonModel is given.
int	getButtonCount()
List<AbstractButton>	getButtons() Returns the buttons in the group as a List
AbstractButton	getSelected() Returns the selected button in the group.
ButtonModel	getSelection()
boolean	isSelected(AbstractButton button) Returns whether the button is selected
void	remove(AbstractButton button) Removes a button from the group
void	remove(AbstractButton[] buttons) Removes all the buttons in the array from the group
void	removeChangeListener(ChangeListener l) Removes a ChangeListener from the button.
void	setSelected(AbstractButton button, boolean selected) Sets the selected button in the group Only one button in the group can be selected
void	setSelected(ButtonModel model, boolean selected) Sets the selected button model in the group

Methods inherited from class javax.swing.ButtonGroup

getElements, 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

JButtonGroup

public JButtonGroup(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

Method Detail

addChangeListener

public void addChangeListener(ChangeListener l)

Adds a ChangeListener to the button.

Parameters:

l - the listener to add

removeChangeListener

public void removeChangeListener(ChangeListener l)

Removes a ChangeListener from the button.

Parameters:

l - the listener to remove

fireStateChanged

protected void fireStateChanged()

Notifies all listeners that have registered interest for notification on this event type. The event instance is created lazily.

See Also:

EventListenerList

add

public void add(AbstractButton button)

Adds a button to the group

Overrides:

add in class ButtonGroup

Parameters:

button - an AbstractButton reference

add

public void add(AbstractButton[] buttons)

Adds an array of buttons to the group

Parameters:

buttons - an array of AbstractButtons

remove

public void remove(AbstractButton button)

Removes a button from the group

Overrides:

remove in class ButtonGroup

Parameters:

button - the button to be removed

remove

public void remove(AbstractButton[] buttons)

Removes all the buttons in the array from the group

Parameters:

buttons - an array of AbstractButtons

setSelected

public void setSelected(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(ButtonModel model,
                        boolean selected)

Sets the selected button model in the group

Overrides:

setSelected in class ButtonGroup

Parameters:

model - a ButtonModel reference

selected - an boolean representing the selection state of the button

getButton

public AbstractButton getButton(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 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

getSelection

public ButtonModel getSelection()

Overrides:

getSelection in class ButtonGroup

isSelected

public boolean isSelected(AbstractButton button)

Returns whether the button is selected

Parameters:

button - an AbstractButton reference

Returns:

true if the button is selected, false otherwise

getButtons

public List<AbstractButton> getButtons()

Returns the buttons in the group as a List

Returns:

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

contains

public boolean contains(AbstractButton button)

Checks whether the group contains the given button

Parameters:

button -

Returns:

true if the button is contained in the group, false otherwise

clearSelection

public void clearSelection()

Clears the current selection.

Overrides:

clearSelection in class ButtonGroup

getButtonCount

public int getButtonCount()

Overrides:

getButtonCount in class ButtonGroup

See Also:

ButtonGroup.getButtonCount()