Module io.github.parubok.button.group

Package io.github.parubok.button.group

Class KButtonGroup<K extends AbstractButton>

java.lang.Object

javax.swing.ButtonGroup

io.github.parubok.button.group.KButtonGroup<K>

Type Parameters:

K - Type of the buttons in the group.

All Implemented Interfaces:

Serializable, Iterable<K>

public class KButtonGroup<K extends AbstractButton>
extends ButtonGroup
implements Iterable<K>

Extension of Swing ButtonGroup which adds the following functionality:

• Type-safety via generics.
• Auto-selects 1st added button.
• Group listeners.
• Mnemonics.
• Access to the buttons by index.
• Implements Iterable to iterate over buttons in the group.

See Also:

ButtonModel.setGroup(ButtonGroup), Serialized Form

Implementation Note:

Adds ItemListener to the buttons in the group.

Field Summary

Fields inherited from class javax.swing.ButtonGroup

buttons

Constructor Summary

Constructors

Constructor	Description
KButtonGroup(boolean autoSelectFirstButton)	Constructs an empty group.
KButtonGroup(Collection<K> buttons)	Constructs group with the specified buttons.
KButtonGroup(K... buttons)	Constructs group with the specified buttons.

Method Summary

Modifier and Type	Method	Description
void	add(AbstractButton button)	Deprecated. This method is not type-safe.
void	addButton(K button)
void	addButtons(K... buttons)
void	addListener(KButtonGroupListener<K> listener)	KButtonGroupEvent will be fired when there is a new selected button in the group.
K	getButton(int index)
List<K>	getButtons()
int	getLastIndex()
K	getSelectedButton()
int	getSelectedIndex()
boolean	isAutoSelectFirstButton()
Iterator<K>	iterator()
void	remove(AbstractButton button)
void	removeListener(KButtonGroupListener<K> listener)
void	setMnemonics()	Auto-assigns mnemonic characters to the buttons of this group.
void	setSelectedIndex(int index)
String	toString()

Methods inherited from class javax.swing.ButtonGroup

clearSelection, getButtonCount, getElements, getSelection, isSelected, setSelected

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

KButtonGroup

@SafeVarargs
public KButtonGroup(K... buttons)

Constructs group with the specified buttons. The first added button will be automatically selected.

Parameters:

buttons - Buttons to add to the group.

KButtonGroup

public KButtonGroup(Collection<K> buttons)

Constructs group with the specified buttons. The first added button will be automatically selected.

Parameters:

buttons - Buttons to add to the group.

KButtonGroup

public KButtonGroup(boolean autoSelectFirstButton)

Constructs an empty group.

Parameters:

autoSelectFirstButton - If true, the first added button will be automatically selected via AbstractButton.setSelected(boolean).

Method Detail

addButton

public void addButton(K button)

Parameters:

button - Button to add to the group. Not null.

addButtons

@SafeVarargs
public final void addButtons(K... buttons)

add

@Deprecated
public void add(AbstractButton button)

Deprecated.

This method is not type-safe. Use addButton(AbstractButton) instead.

Overrides:

add in class ButtonGroup

remove

public void remove(AbstractButton button)

Overrides:

remove in class ButtonGroup

addListener

public void addListener(KButtonGroupListener<K> listener)

KButtonGroupEvent will be fired when there is a new selected button in the group.

Implementation Specification:

No event is fired if the selection becomes empty.

removeListener

public void removeListener(KButtonGroupListener<K> listener)

setMnemonics

public void setMnemonics()

Auto-assigns mnemonic characters to the buttons of this group.

See Also:

AbstractButton.setMnemonic(char)

getButton

public K getButton(int index)

Returns:

Button at the specified index.

getSelectedButton

public K getSelectedButton()

Returns:

The group's selected button or null if no button is selected.

getSelectedIndex

public int getSelectedIndex()

Returns:

Index of the group's selected button or -1 if no button is selected.

getLastIndex

public int getLastIndex()

Returns:

Maximum button index in the group.

Throws:

NoSuchElementException - If the group is empty.

setSelectedIndex

public void setSelectedIndex(int index)

Parameters:

index - Index of the button to select.

See Also:

getSelectedIndex()

getButtons

public List<K> getButtons()

Returns:

Buttons of this group as unmodifiable List.

iterator

public Iterator<K> iterator()

Specified by:

iterator in interface Iterable<K extends AbstractButton>

isAutoSelectFirstButton

public boolean isAutoSelectFirstButton()

toString

public String toString()

Overrides:

toString in class Object