ButtonList.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.gui.utils.tabbedpanel;
 
import java.awt.Component;
import java.awt.Container;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;
import javax.swing.AbstractButton;
import javax.swing.BoxLayout;
import javax.swing.JPanel;
import javax.swing.event.ChangeListener;
import net.sf.gridarta.gui.utils.borderpanel.Location;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class ButtonList {
 
    @NotNull
    private final Container buttons = new JPanel();
 
    @NotNull
    private final Collection<ButtonListListener> listeners = new CopyOnWriteArrayList<>();
 
    @NotNull
    private final List<AbstractButton> selectedButtons = new ArrayList<>();
 
    @NotNull
    private final ChangeListener changeListener = e -> {
        final AbstractButton button = (AbstractButton) e.getSource();
        if (button.isSelected()) {
            selectButton(button);
        } else if (!selectedButtons.isEmpty() && button == selectedButtons.get(0)) {
            selectedButtons.remove(0);
            fireSelectedButtonChanged(button);
            if (!selectedButtons.isEmpty()) {
                selectedButtons.get(0).setSelected(true);
            }
        }
    };
 
    public ButtonList(@NotNull final Location location) {
        buttons.setLayout(new BoxLayout(buttons, location.getAxis()));
    }
 
    public void addButtonListListener(@NotNull final ButtonListListener listener) {
        listeners.add(listener);
    }
 
    public void addButton(@NotNull final AbstractButton button) {
        if (button.isSelected()) {
            throw new IllegalArgumentException("can't add a selected button");
        }
 
        final String title = button.getText();
        int index;
        for (index = 0; index < buttons.getComponentCount(); index++) {
            final Component tmp = buttons.getComponent(index);
            if (tmp instanceof AbstractButton) {
                final AbstractButton tmpButton = (AbstractButton) tmp;
                final Comparable<String> tmpTitle = tmpButton.getText();
                if (tmpTitle.compareTo(title) > 0) {
                    break;
                }
            }
        }
        buttons.add(button, index);
        buttons.validate();
        button.addChangeListener(changeListener);
    }
 
    public void removeButton(@NotNull final AbstractButton button) {
        button.removeChangeListener(changeListener);
        buttons.remove(button);
        buttons.validate();
        final int index = selectedButtons.indexOf(button);
        if (index != -1) {
            selectedButtons.remove(index);
            if (index == 0) {
                fireSelectedButtonChanged(button);
                if (!selectedButtons.isEmpty()) {
                    selectedButtons.get(0).setSelected(true);
                }
            }
        }
    }
 
    public void selectButton(@NotNull final AbstractButton button) {
        if (selectedButtons.isEmpty() || button != selectedButtons.get(0)) {
            final AbstractButton prevSelectedButton = getSelectedButton();
            selectedButtons.remove(button);
            selectedButtons.add(0, button);
            fireSelectedButtonChanged(prevSelectedButton);
            button.setSelected(true);
            if (prevSelectedButton != null) {
                prevSelectedButton.setSelected(false);
            }
        }
    }
 
    private void fireSelectedButtonChanged(@Nullable final AbstractButton prevSelectedButton) {
        final AbstractButton selectedButton = getSelectedButton();
        for (final ButtonListListener listener : listeners) {
            listener.selectedButtonChanged(prevSelectedButton, selectedButton);
        }
    }
 
    @Nullable
    public AbstractButton getSelectedButton() {
        return selectedButtons.isEmpty() ? null : selectedButtons.get(0);
    }
 
    @NotNull
    public Component getButtons() {
        return buttons;
    }
 
    public int getButtonCount() {
        return buttons.getComponentCount();
    }
 
}