ArchetypePanel.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 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.panel.archetypechooser;

import java.awt.BorderLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import javax.swing.DefaultListModel;
import javax.swing.JComboBox;
import javax.swing.JPanel;
import javax.swing.JPopupMenu;
import javax.swing.JScrollPane;
import javax.swing.JViewport;
import javax.swing.ListSelectionModel;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import net.sf.gridarta.gui.utils.GList;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.archetypechooser.ArchetypeChooserFolder;
import net.sf.gridarta.model.archetypechooser.ArchetypeChooserFolderListener;
import net.sf.gridarta.model.archetypechooser.ArchetypeChooserModel;
import net.sf.gridarta.model.archetypechooser.ArchetypeChooserModelListener;
import net.sf.gridarta.model.archetypechooser.ArchetypeChooserPanel;
import net.sf.gridarta.model.archetypechooser.ArchetypeChooserPanelListener;
import net.sf.gridarta.model.archetypechooser.DisplayMode;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.utils.CommonConstants;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.action.ActionMethod;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class ArchetypePanel<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends JPanel {

    private static final long serialVersionUID = 1L;

    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");

    @NotNull
    private final ArchetypeChooserPanel<G, A, R> archetypeChooserPanel;

    // This looks unused, but don't remove it. It will be used in future.
    @NotNull
    private final JPopupMenu popupMenu = createListPopupMenu();

    @NotNull
    private final DefaultListModel<R> archetypeListModel = new DefaultListModel<>();

    @NotNull
    private final GList<R> archetypeList = new GList<>(archetypeListModel);

    @Nullable
    private ArchetypeChooserFolder<G, A, R> archetypeListFolder;

    @NotNull
    private final JComboBox<ArchetypeChooserFolder<G, A, R>> folders = new JComboBox<>();

    @NotNull
    private Comparator<Archetype<G, A, R>> displayMode;

    private boolean updateInProgress;

    @NotNull
    private final ArchetypeChooserFolderListener<G, A, R> archetypeChooserFolderListener = this::setSelectedArchetype;

    public ArchetypePanel(@NotNull final ArchetypeChooserModel<G, A, R> archetypeChooserModel, @NotNull final ArchetypeChooserPanel<G, A, R> archetypeChooserPanel) {
        super(new BorderLayout());
        this.archetypeChooserPanel = archetypeChooserPanel;
        archetypeList.setFocusable(false);
        archetypeList.setBackground(CommonConstants.BG_COLOR);
        archetypeList.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
        final JScrollPane scrollPane = new JScrollPane(archetypeList);
        add(scrollPane, BorderLayout.CENTER);
        add(folders, BorderLayout.NORTH);
        scrollPane.setAutoscrolls(true);
        scrollPane.getViewport().setScrollMode(JViewport.SIMPLE_SCROLL_MODE);
        folders.setAutoscrolls(true);

        final ArchetypeChooserModelListener<G, A, R> archetypeChooserModelListener = new ArchetypeChooserModelListener<G, A, R>() {

            @Override
            public void selectedPanelChanged(@NotNull final ArchetypeChooserPanel<G, A, R> selectedPanel) {
            }

            @Override
            public void selectedFolderChanged(@NotNull final ArchetypeChooserFolder<G, A, R> selectedFolder) {
            }

            @Override
            public void selectedArchetypeChanged(@Nullable final R selectedArchetype) {
            }

            @Override
            public void directionChanged(@Nullable final Integer direction) {
            }

            @Override
            public void displayModeChanged(@NotNull final DisplayMode<G, A, R> displayMode) {
                updateCellRenderer(displayMode);
            }

        };
        archetypeChooserModel.addArchetypeChooserModelListener(archetypeChooserModelListener);
        updateCellRenderer(archetypeChooserModel.getDisplayMode());

        final ArchetypeChooserPanelListener<G, A, R> archetypeChooserPanelListener = new ArchetypeChooserPanelListener<G, A, R>() {

            @Override
            public void selectedFolderChanged(@NotNull final ArchetypeChooserFolder<G, A, R> selectedFolder) {
                folders.setSelectedItem(selectedFolder);
                updateArchetypeList();
            }

            @Override
            public void selectedArchetypeChanged(@Nullable final R selectedArchetype) {
                setSelectedArchetype(selectedArchetype);
            }

        };

        archetypeList.addListSelectionListener(new ListSelectionListener() {

            @Override
            public void valueChanged(@NotNull final ListSelectionEvent e) {
                if (!updateInProgress) {
                    final ArchetypeChooserFolder<G, A, R> folder = archetypeListFolder;
                    if (folder != null) {
                        folder.setSelectedArchetype(getSelectedArchetype());
                    }
                }
            }

        });

        archetypeChooserPanel.addArchetypeChooserPanelListener(archetypeChooserPanelListener);

        for (final ArchetypeChooserFolder<G, A, R> folder : archetypeChooserPanel.getFolders()) {
            folders.addItem(folder);
        }
        folders.setRenderer(new FolderListCellRenderer());
        folders.setSelectedItem(archetypeChooserPanel.getSelectedFolder());
        folders.addActionListener(new ActionListener() {

            @Override
            public void actionPerformed(@NotNull final ActionEvent e) {
                final ArchetypeChooserFolder<G, A, R> folder = getSelectedFolder();
                if (folder != null) {
                    ArchetypePanel.this.archetypeChooserPanel.setSelectedFolder(folder);
                }
            }

        });

        updateArchetypeList();
    }

    private void updateCellRenderer(@NotNull final DisplayMode<G, A, R> displayMode) {
        this.displayMode = displayMode;
        archetypeList.setCellRenderer(displayMode);
        archetypeList.setLayoutOrientation(displayMode.getLayoutOrientation());
        archetypeList.setVisibleRowCount(-1);
        final R selectedValue = getSelectedArchetype();
        updateArchetypeList();
        setSelectedArchetype(selectedValue);
    }

    @Nullable
    public R getSelectedArchetype() {
        return archetypeList.getSelectedValue();
    }

    private void setSelectedArchetype(@Nullable final R archetype) {
        archetypeList.setSelectedValue(archetype, true);
        archetypeList.ensureIndexIsVisible(archetypeList.getSelectedIndex());
    }

    @Nullable
    private ArchetypeChooserFolder<G, A, R> getSelectedFolder() {
        //JComboBox does not use type parameters
        @SuppressWarnings("unchecked") final ArchetypeChooserFolder<G, A, R> selectedFolder = (ArchetypeChooserFolder<G, A, R>) folders.getSelectedItem();
        return selectedFolder;
    }

    private void updateArchetypeList() {
        synchronized (archetypeList.getTreeLock()) {
            final ArchetypeChooserFolder<G, A, R> folder = getSelectedFolder();
            if (archetypeListFolder != folder) {
                try {
                    updateInProgress = true;
                    archetypeListModel.removeAllElements();
                    if (folder != null) {
                        final List<R> archetypes = new ArrayList<>();
                        archetypes.addAll(folder.getArchetypes());
                        archetypes.sort(displayMode);
                        for (final R archetype : archetypes) {
                            archetypeListModel.addElement(archetype);
                        }
                        if (archetypeListFolder != null) {
                            final R oldSelectedArchetype = archetypeListFolder.getSelectedArchetype();
                            if (oldSelectedArchetype != null && folder.containsArchetype(oldSelectedArchetype)) {
                                folder.setSelectedArchetype(oldSelectedArchetype); // retain selected archetype when switching from or to "all"
                            }
                        }
                        setSelectedArchetype(folder.getSelectedArchetype());
                    }
                    if (archetypeListFolder != null) {
                        archetypeListFolder.removeArchetypeChooserFolderListener(archetypeChooserFolderListener);
                    }
                    archetypeListFolder = folder;
                    if (archetypeListFolder != null) {
                        archetypeListFolder.addArchetypeChooserFolderListener(archetypeChooserFolderListener);
                    }
                } finally {
                    updateInProgress = false;
                }
            }
        }
    }

    @NotNull
    private JPopupMenu createListPopupMenu() {
        final JPopupMenu menu = new JPopupMenu();
        menu.add(ACTION_BUILDER.createAction(false, "editPopup", this));
        return menu;
    }

    @ActionMethod
    public void editPopup() {
        //XXX:        gameObjectAttributesDialogFactory.showAttributeDialog(getSelectedArchetype());
    }

    public void selectArchetype(@NotNull final R archetype) {
        final List<ArchetypeChooserFolder<G, A, R>> archetypeChooserFolders = archetypeChooserPanel.getFolders();
        for (int index = 1; index < archetypeChooserFolders.size(); index++) {
            final ArchetypeChooserFolder<G, A, R> folder = archetypeChooserFolders.get(index);
            if (folder.containsArchetype(archetype)) {
                folders.setSelectedIndex(index);
                setSelectedArchetype(archetype);
                return;
            }
        }

    }

    @NotNull
    public ArchetypeChooserPanel<G, A, R> getArchetypeChooserPanel() {
        return archetypeChooserPanel;
    }

}