org.itsnat.comp.button

Interface ItsNatButtonGroup

public interface ItsNatButtonGroup

Represents a button group.

Button groups are currently used only by radio buttons (ItsNatButtonRadio).

A button group has a name, this name is unique per document no other button group has this name. The same is applied for the javax.swing.ButtonGroup associated to this group.

ButtonGroup objects are used to provide some support to the Swing standard way to create groups (see javax.swing.ButtonModel.setGroup(ButtonGroup)), but some methods like ButtonGroup.add(AbstractButton) have no sense in ItsNat, use addButton(ItsNatComponent) instead.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatComponentManager.createItsNatButtonGroup()

Method Summary

Methods

Modifier and Type	Method and Description
void	addButton(ItsNatComponent button) Adds the specified button to this group.
ItsNatComponent	getButton(int index) Returns the button at the specified position.
int	getButtonCount() Returns the number of buttons of this group.
javax.swing.ButtonGroup	getButtonGroup() Returns the Swing ButtonGroup object of this button group.
java.lang.String	getName() Returns the name of this button group.
void	removeButton(ItsNatComponent button) Removes the specified button from this group.

Method Detail

getName

java.lang.String getName()

Returns the name of this button group. This name is not shared (unique) per document.

Returns:

the button group name.

See Also:

ItsNatComponentManager.getItsNatButtonGroup(String)

getButtonGroup

javax.swing.ButtonGroup getButtonGroup()

Returns the Swing ButtonGroup object of this button group. This object is not shared (unique) per document.

Returns:

the ButtonGroup object of this button group.

See Also:

ItsNatComponentManager.getItsNatButtonGroup(javax.swing.ButtonGroup)

addButton

void addButton(ItsNatComponent button)

Adds the specified button to this group.

Parameters:

button - the button to add.

See Also:

removeButton(ItsNatComponent), ItsNatButtonRadio.setItsNatButtonGroup(ItsNatButtonGroup)

removeButton

void removeButton(ItsNatComponent button)

Removes the specified button from this group.

Parameters:

button - the button to remove.

See Also:

addButton(ItsNatComponent)

getButtonCount

int getButtonCount()

Returns the number of buttons of this group.

Returns:

the number of buttons.

getButton

ItsNatComponent getButton(int index)

Returns the button at the specified position.

Parameters:

index - 0 based index of the button.

Returns:

the button at the specified position.