net.sf.gridarta.gui.utils.tabbedpanel

Class ButtonList

java.lang.Object

net.sf.gridarta.gui.utils.tabbedpanel.ButtonList

public class ButtonList
extends java.lang.Object

A list of buttons where at most one button is active at any time.

Constructor Summary

Constructors

Constructor and Description
ButtonList(@NotNull Location location) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addButton(@NotNull javax.swing.AbstractButton button) Adds a button.
void	addButtonListListener(@NotNull ButtonListListener listener) Adds a ButtonListListener to be notified.
int	getButtonCount() Returns the total number of buttons.
@NotNull java.awt.Component	getButtons() Returns the Container that contains all buttons.
@Nullable javax.swing.AbstractButton	getSelectedButton() Returns the currently selected button.
void	removeButton(@NotNull javax.swing.AbstractButton button) Removes a button.
void	selectButton(@NotNull javax.swing.AbstractButton button) Selects a button.

Methods inherited from class java.lang.Object

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

Constructor Detail

ButtonList

public ButtonList(@NotNull
                  @NotNull Location location)

Creates a new instance.

Parameters:

location - the location

Method Detail

addButtonListListener

public void addButtonListListener(@NotNull
                                  @NotNull ButtonListListener listener)

Adds a ButtonListListener to be notified.

Parameters:

listener - the button list listener

addButton

public void addButton(@NotNull
                      @NotNull javax.swing.AbstractButton button)

Adds a button.

Parameters:

button - the button

removeButton

public void removeButton(@NotNull
                         @NotNull javax.swing.AbstractButton button)

Removes a button. Does nothing if the button is not part of this button list.

Parameters:

button - the button

selectButton

public void selectButton(@NotNull
                         @NotNull javax.swing.AbstractButton button)

Selects a button.

Parameters:

button - the button

getSelectedButton

@Nullable
public @Nullable javax.swing.AbstractButton getSelectedButton()

Returns the currently selected button.

Returns:

the selected button or null if no button exists

getButtons

@NotNull
public @NotNull java.awt.Component getButtons()

Returns the Container that contains all buttons.

Returns:

the container

getButtonCount

public int getButtonCount()

Returns the total number of buttons.

Returns:

the total number of buttons