com.datagis.terraexplorer.menu

Class ButtonGroup

java.lang.Object

javax.swing.ButtonGroup

com.datagis.terraexplorer.menu.ButtonGroup

All Implemented Interfaces:

Serializable

public class ButtonGroup
extends ButtonGroup

This class is used to create a multiple-exclusion scope for a set of buttons. Creating a set of buttons with the same ButtonGroup object means that turning "on" one of those buttons turns off all other buttons in the group.

This class is an extension to javax.swing.ButtonGroup, adding support for MenuItem objects.

Since:

TEJ2.0

Author:

Carsten Klein

See Also:

MenuItem, ButtonGroup, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector<Object>	buttons The list of buttons participating in this group

Constructor Summary

Constructors

Constructor and Description
ButtonGroup() Creates a new ButtonGroup.

Method Summary

Modifier and Type	Method and Description
void	add(AbstractButton b) Adds the button to the group.
void	add(MenuItem menuItem) Adds the menu item to the group.
void	clearSelection() Clears the selection such that none of the buttons in the ButtonGroup are selected.
int	getButtonCount() Returns the number of buttons in the group.
Enumeration	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 a ButtonModel is selected.
void	remove(AbstractButton b) Removes the button from the group.
void	remove(MenuItem menuItem) Removes the menu item from the group.
void	setSelected(ButtonModel m, boolean b) Sets the selected value for the ButtonModel.

Methods inherited from class java.lang.Object

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

Field Detail

buttons

protected Vector<Object> buttons

The list of buttons participating in this group

Constructor Detail

ButtonGroup

public ButtonGroup()

Creates a new ButtonGroup.

Method Detail

add

public void add(AbstractButton b)

Adds the button to the group.

Overrides:

add in class ButtonGroup

Parameters:

b - the button to be added

add

public void add(MenuItem menuItem)

Adds the menu item to the group.

Parameters:

menuItem - the menu item to be added

remove

public void remove(AbstractButton b)

Removes the button from the group.

Overrides:

remove in class ButtonGroup

Parameters:

b - the button to be removed

remove

public void remove(MenuItem menuItem)

Removes the menu item from the group.

Parameters:

menuItem - the menu item to be removed

clearSelection

public void clearSelection()

Clears the selection such that none of the buttons in the ButtonGroup are selected.

Overrides:

clearSelection in class ButtonGroup

getElements

public Enumeration getElements()

Returns all the buttons that are participating in this group.

Overrides:

getElements in class ButtonGroup

Returns:

an Enumeration of the buttons in this group

getSelection

public ButtonModel getSelection()

Returns the model of the selected button.

Overrides:

getSelection in class ButtonGroup

Returns:

the selected button model

setSelected

public void setSelected(ButtonModel m,
                        boolean b)

Sets the selected value for the ButtonModel. Only one button in the group may be selected at a time.

Overrides:

setSelected in class ButtonGroup

Parameters:

m - the ButtonModel

b - true if this button is to be selected, otherwise false

isSelected

public boolean isSelected(ButtonModel m)

Returns whether a ButtonModel is selected.

Overrides:

isSelected in class ButtonGroup

Returns:

true if the button is selected, otherwise returns false

getButtonCount

public int getButtonCount()

Returns the number of buttons in the group.

Overrides:

getButtonCount in class ButtonGroup

Returns:

the button count