GUIComboBox.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient 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.
 *
 * JXClient 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 JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff.
 * Copyright (C) 2006-2011 Andreas Kirschbaum.
 */

package com.realtime.crossfire.jxclient.gui.combobox;

import com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement;
import com.realtime.crossfire.jxclient.gui.gui.GUIElement;
import com.realtime.crossfire.jxclient.gui.gui.GUIElementListener;
import com.realtime.crossfire.jxclient.gui.gui.TooltipManager;
import com.realtime.crossfire.jxclient.gui.log.GUILabelLog;
import com.realtime.crossfire.jxclient.gui.log.GUILog;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.Transparency;
import java.awt.event.ActionListener;
import javax.swing.DefaultComboBoxModel;
import javax.swing.JComboBox;
import javax.swing.JList;
import javax.swing.ListCellRenderer;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public abstract class GUIComboBox<T> extends AbstractGUIElement {

    private static final long serialVersionUID = 1;

    @NotNull
    private final DefaultComboBoxModel<T> model = new DefaultComboBoxModel<>();

    @Nullable
    private final GUILabelLog label;

    @NotNull
    private final JComboBox<T> comboBox = new JComboBox<>(model);

    @NotNull
    @SuppressWarnings("FieldCanBeLocal")
    private final ListCellRenderer<T> renderer = this::getListCellRendererComponent;

    @NotNull
    private final ActionListener actionListener = e -> updateSelectedItem();

    protected GUIComboBox(@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @Nullable final GUILabelLog label) {
        super(tooltipManager, elementListener, name, Transparency.TRANSLUCENT);
        this.label = label;
        comboBox.setFocusable(false);
        comboBox.setRenderer(renderer);
        comboBox.addActionListener(actionListener);
        add(comboBox);
    }

    @Override
    public void dispose() {
        super.dispose();
        comboBox.removeActionListener(actionListener);
    }

    @Override
    public Dimension getPreferredSize() {
        final Dimension result = comboBox.getPreferredSize();
        return result == null ? super.getPreferredSize() : result;
    }

    @Override
    public Dimension getMinimumSize() {
        final Dimension result = comboBox.getMinimumSize();
        return result == null ? super.getMinimumSize() : result;
    }

    @Override
    public void setBounds(final int x, final int y, final int width, final int height) {
        super.setBounds(x, y, width, height);
        comboBox.setSize(width, height);
    }

    protected void updateModel(@NotNull final Iterable<T> elements) {
        model.removeAllElements();
        for (final T element : elements) {
            model.addElement(element);
        }
    }

    @NotNull
    protected abstract Component getListCellRendererComponent(@NotNull final JList<? extends T> list, @Nullable final T value, final int index, final boolean selected, final boolean cellHasFocus);

    protected void updateSelectedItem() {
        if (label == null) {
            return;
        }

        setChanged();
        @SuppressWarnings("unchecked") final T item = (T)comboBox.getSelectedItem();
        label.updateText(item == null ? "" : getDescription(item));
    }

    @NotNull
    protected abstract String getDescription(@NotNull T item);

}