freecol/src/net/sf/freecol/client/gui/panel/FindSettlementPanel.java

/**
 *  Copyright (C) 2002-2022   The FreeCol Team
 *
 *  This file is part of FreeCol.
 *
 *  FreeCol 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.
 *
 *  FreeCol 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 FreeCol.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.sf.freecol.client.gui.panel;

import java.awt.Dimension;
import java.awt.event.ActionEvent;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.logging.Logger;

import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.DefaultListModel;
import javax.swing.ImageIcon;
import javax.swing.JComboBox;
import javax.swing.JLabel;
import javax.swing.JList;
import javax.swing.JScrollPane;
import javax.swing.KeyStroke;
import javax.swing.ListSelectionModel;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;

import net.miginfocom.swing.MigLayout;
import net.sf.freecol.client.FreeColClient;
import net.sf.freecol.client.gui.ImageLibrary;
import net.sf.freecol.client.gui.plaf.FreeColComboBoxRenderer;
import net.sf.freecol.common.i18n.Messages;
import net.sf.freecol.common.model.Colony;
import net.sf.freecol.common.model.IndianSettlement;
import net.sf.freecol.common.model.Player;
import net.sf.freecol.common.model.Settlement;
import net.sf.freecol.common.model.StringTemplate;


/**
 * Centers the map on a known settlement or colony.  Pressing ENTER
 * opens a panel if appropriate.
 */
public final class FindSettlementPanel extends FreeColPanel
    implements ListSelectionListener, ItemListener {

    @SuppressWarnings("unused")
    private static final Logger logger = Logger.getLogger(FindSettlementPanel.class.getName());

    private static class SettlementRenderer
        extends FreeColComboBoxRenderer<Settlement> {

        private final ImageLibrary lib;
        
        public SettlementRenderer(ImageLibrary lib) {
            this.lib = lib;
        }
        
        /**
         * {@inheritDoc}
         */
        @Override
        public void setLabelValues(JLabel label, Settlement value) {
            StringTemplate template = StringTemplate
                .template("findSettlementPanel.settlement")
                .addName("%name%", value.getName())
                .addName("%capital%", ((value.isCapital()) ? "*" : ""))
                .addStringTemplate("%nation%",
                    value.getOwner().getNationLabel());
            label.setText(Messages.message(template));
            label.setIcon(new ImageIcon(lib.getSettlementImage(value,
                        new Dimension(64, -1))));
        }
    }

    private enum DisplayListOption {
        ALL,
        ONLY_NATIVES,
        ONLY_EUROPEAN
    }

    /** Box to choose the type of settlements to list. */
    private JComboBox<String> displayOptionBox;

    /** The list of settlements to display. */
    private final JList<Settlement> settlementList;


    /**
     * Create a new panel.
     *
     * @param freeColClient The {@code FreeColClient} for the game.
     */
    public FindSettlementPanel(FreeColClient freeColClient) {
        super(freeColClient, null,
              new MigLayout("wrap 1", "[align center]", "[]30[]30[]"));
        this.settlementList = new JList<>();
        this.settlementList.setCellRenderer(new SettlementRenderer(getImageLibrary()));
        this.settlementList.setFixedCellHeight(48);
        this.settlementList.addListSelectionListener(this);
        this.settlementList.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
        Action selectAction = new AbstractAction() {
                @Override
                public void actionPerformed(ActionEvent ae) {
                    selectSettlement();
                }
            };
        this.settlementList.getInputMap().put(KeyStroke.getKeyStroke("ENTER"),
                                              "select");
        this.settlementList.getActionMap().put("select", selectAction);
        Action quitAction = new AbstractAction() {
                @Override
                public void actionPerformed(ActionEvent ae) {
                    getGUI().removeComponent(FindSettlementPanel.this);
                }
            };
        this.settlementList.getInputMap().put(KeyStroke.getKeyStroke("ESCAPE"),
                                             "quit");
        this.settlementList.getActionMap().put("quit", quitAction);
        this.settlementList.addMouseListener(new MouseAdapter() {
                @Override
                public void mouseClicked(MouseEvent e) {
                    if (e.getClickCount() == 2) {
                        selectSettlement();
                    }
                }
            });
        JScrollPane listScroller = new JScrollPane(this.settlementList);
        listScroller.setPreferredSize(new Dimension(250, 250));

        this.displayOptionBox = new JComboBox<>(new String[] {
                Messages.message("findSettlementPanel.displayAll"),
                Messages.message("findSettlementPanel.displayOnlyNatives"),
                Messages.message("findSettlementPanel.displayOnlyEuropean"),
            });
        this.displayOptionBox.addItemListener(this);

        add(Utility.localizedHeader(Messages.nameKey("findSettlementPanel"),
                                    Utility.FONTSPEC_SUBTITLE));
        add(listScroller, "width max(300, 100%), height max(300, 100%)");
        add(this.displayOptionBox);
        add(okButton, "tag ok");

        getGUI().restoreSavedSize(this, getPreferredSize());

        updateSearch(DisplayListOption.valueOf("ALL"));
        
        setEscapeAction(new AbstractAction() {
            @Override
            public void actionPerformed(ActionEvent ae) {
                okButton.doClick();
            }
        });
    }

    private void updateSearch(DisplayListOption displayListOption) {
        DefaultListModel<Settlement> model
            = new DefaultListModel<>();
        Object selected = this.settlementList.getSelectedValue();

        for (Player player : getGame().getLivePlayerList()) {
            boolean ok;
            switch (displayListOption) {
            case ONLY_NATIVES:
                ok = player.isIndian();
                break;
            case ONLY_EUROPEAN:
                ok = player.isEuropean();
                break;
            case ALL:
                ok = true;
                break;
            default:
                ok = false;
                break;
            }
            if (ok) {
                for (Settlement s : player.getSettlementList()) {
                    model.addElement(s);
                }
            }
        }

        this.settlementList.setModel(model);
        this.settlementList.setSelectedValue(selected, true);
        if (this.settlementList.getSelectedIndex() < 0) {
            this.settlementList.setSelectedIndex(0);
        }
    }

    private void selectSettlement() {
        Settlement settlement = this.settlementList.getSelectedValue();
        if (settlement instanceof Colony
            && settlement.getOwner() == getMyPlayer()) {
            getGUI().removeComponent(FindSettlementPanel.this);
            getGUI().showColonyPanel((Colony)settlement, null);
        } else if (settlement instanceof IndianSettlement) {
            getGUI().removeComponent(FindSettlementPanel.this);
            getGUI().showIndianSettlementPanel((IndianSettlement)settlement);
        }
    }


    // Interface ItemListener

    @Override
    public void itemStateChanged(ItemEvent event) {
        switch (this.displayOptionBox.getSelectedIndex()) {
        case 0:
        default:
            updateSearch(DisplayListOption.valueOf("ALL"));
            break;
        case 1:
            updateSearch(DisplayListOption.valueOf("ONLY_NATIVES"));
            break;
        case 2:
            updateSearch(DisplayListOption.valueOf("ONLY_EUROPEAN"));
        }
    }


    // Interface ListSelectionListener

    /**
     * {@inheritDoc}
     */
    @Override
    public void valueChanged(ListSelectionEvent e) {
        Settlement settlement = this.settlementList.getSelectedValue();
        if (settlement != null) {
            getGUI().setFocus(settlement.getTile());
        }
    }


    // Override Component

    /**
     * {@inheritDoc}
     */
    @Override
    public void requestFocus() {
        this.settlementList.requestFocus();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void removeNotify() {
        super.removeNotify();

        removeAll();
        this.displayOptionBox = null;
    }
}