ArchetypeChooserView.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.util.prefs.Preferences;
import javax.swing.AbstractButton;
import javax.swing.Action;
import javax.swing.BorderFactory;
import javax.swing.ButtonGroup;
import javax.swing.JPanel;
import javax.swing.JTabbedPane;
import javax.swing.JToggleButton;
import javax.swing.SwingConstants;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import net.sf.gridarta.MainControl;
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.archetypechooser.ArchetypeChooserFolder;
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.DisplayMode;
import net.sf.gridarta.model.face.FaceObjectProviders;
import net.sf.gridarta.model.face.FaceObjectProvidersListener;
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.ActionMethod;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

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

    @NotNull
    private static final String DISPLAY_MODE_KEY = "archetypeChooserDisplayMode";

    private static final long serialVersionUID = 1L;

    @NotNull
    private static final Preferences PREFERENCES = Preferences.userNodeForPackage(MainControl.class);

    @NotNull
    private final AbstractButton buttonDisplayGameObjectNames;

    @NotNull
    private final AbstractButton buttonDisplayArchetypeNames;

    @NotNull
    private final AbstractButton buttonDisplayIconsOnly;

    @NotNull
    private final ArchetypeChooserModel<G, A, R> archetypeChooserModel;

    @NotNull
    private final JTabbedPane tabDesktop = new JTabbedPane(SwingConstants.TOP);

    @NotNull
    private final DisplayMode<G, A, R> displayModeGameObjectNames;

    @NotNull
    private final DisplayMode<G, A, R> displayModeArchetypeNames;

    @NotNull
    private final DisplayMode<G, A, R> displayModeIconsOnly;

    @NotNull
    private final ChangeListener changeListener = new ChangeListener() {

        @Override
        public void stateChanged(final ChangeEvent e) {
            final JTabbedPane tabbedPane = (JTabbedPane) e.getSource();
            final int index = tabbedPane.getSelectedIndex();
            if (index != -1) {
                setSelectedPanelInt(getArchetypePanel(index));
            }
        }
    };

    public ArchetypeChooserView(final boolean createDirectionPane, @NotNull final ArchetypeChooserModel<G, A, R> archetypeChooserModel, @NotNull final FaceObjectProviders faceObjectProviders, @NotNull final Action displayGameObjectNamesAction, @NotNull final Action displayArchetypeNamesAction, @NotNull final Action displayIconsOnlyAction, @NotNull final DisplayMode<G, A, R> displayModeGameObjectNames, @NotNull final DisplayMode<G, A, R> displayModeArchetypeNames, @NotNull final DisplayMode<G, A, R> displayModeIconsOnly) {
        super(new BorderLayout());
        this.archetypeChooserModel = archetypeChooserModel;
        this.displayModeGameObjectNames = displayModeGameObjectNames;
        this.displayModeArchetypeNames = displayModeArchetypeNames;
        this.displayModeIconsOnly = displayModeIconsOnly;

        archetypeChooserModel.addArchetypeChooserModelListener(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) {
                if (displayMode == displayModeGameObjectNames) {
                    PREFERENCES.putInt(DISPLAY_MODE_KEY, 0);
                } else if (displayMode == displayModeArchetypeNames) {
                    PREFERENCES.putInt(DISPLAY_MODE_KEY, 1);
                } else if (displayMode == displayModeIconsOnly) {
                    PREFERENCES.putInt(DISPLAY_MODE_KEY, 2);
                }
                updateActions();
            }

        });
        final FaceObjectProvidersListener faceObjectProvidersListener = new FaceObjectProvidersListener() {

            @Override
            public void facesReloaded() {
                final ArchetypeChooserPanel<G, A, R> archetypeChooserPanel = archetypeChooserModel.getSelectedPanel();
                if (archetypeChooserPanel != null) {
                    final ArchetypePanel<G, A, R> archetypePanel = findPanel(archetypeChooserPanel.getName());
                    if (archetypePanel != null) {
                        archetypePanel.repaint();
                    }
                }
            }

        };
        faceObjectProviders.addFaceObjectProvidersListener(faceObjectProvidersListener);

        buttonDisplayGameObjectNames = new JToggleButton(displayGameObjectNamesAction);
        buttonDisplayArchetypeNames = new JToggleButton(displayArchetypeNamesAction);
        buttonDisplayIconsOnly = new JToggleButton(displayIconsOnlyAction);
        final ButtonGroup buttonGroup = new ButtonGroup();
        buttonGroup.add(buttonDisplayGameObjectNames);
        buttonGroup.add(buttonDisplayArchetypeNames);
        buttonGroup.add(buttonDisplayIconsOnly);
        final int preferencesDisplayMode = PREFERENCES.getInt(DISPLAY_MODE_KEY, 0);
        switch (preferencesDisplayMode) {
        case 0:
        default:
            archetypeChooserModel.setDisplayMode(displayModeGameObjectNames);
            break;

        case 1:
            archetypeChooserModel.setDisplayMode(displayModeArchetypeNames);
            break;

        case 2:
            archetypeChooserModel.setDisplayMode(displayModeIconsOnly);
            break;
        }
        tabDesktop.setBorder(BorderFactory.createEmptyBorder(CommonConstants.SPACE_PICKMAP_ARCHETYPE_TOP, 0, 0, 0));
        add(tabDesktop);
        if (createDirectionPane) {
            add(new DirectionPane<>(archetypeChooserModel, true), BorderLayout.SOUTH);
        }
        final ArchetypeChooserPanel<G, A, R> selectedPanel = archetypeChooserModel.getSelectedPanel();
        if (selectedPanel != null) {
            final ArchetypePanel<G, A, R> archetypePanel = findPanel(selectedPanel.getName());
            if (archetypePanel != null) {
                setSelectedPanel(archetypePanel);
            }
        }
        tabDesktop.addChangeListener(changeListener);
    }

    @NotNull
    public ArchetypePanel<G, A, R> findOrCreatePanel(@NotNull final String panelName) {
        final ArchetypePanel<G, A, R> existingPanel = findPanel(panelName);
        if (existingPanel != null) {
            return existingPanel;
        }

        final ArchetypeChooserPanel<G, A, R> archetypeChooserPanel = archetypeChooserModel.getPanel(panelName);
        final ArchetypePanel<G, A, R> newPanel = new ArchetypePanel<>(archetypeChooserModel, archetypeChooserPanel);

        // insert new panel in alphabetical order
        int i;
        for (i = 0; i < tabDesktop.getTabCount() && panelName.compareToIgnoreCase(tabDesktop.getTitleAt(i)) > 0; i++) {
        }
        tabDesktop.insertTab(panelName, null, newPanel, null, i);

        return newPanel;
    }

    @Nullable
    private ArchetypePanel<G, A, R> findPanel(@NotNull final String panelName) {
        for (int i = 0; i < tabDesktop.getTabCount(); i++) {
            if (panelName.equals(tabDesktop.getTitleAt(i))) {
                return getArchetypePanel(i);
            }
        }

        return null;
    }

    @NotNull
    private ArchetypePanel<G, A, R> getArchetypePanel(final int index) {
        //JTabbedPane does not use type parameters
        @SuppressWarnings("unchecked") final ArchetypePanel<G, A, R> archetypePanel = (ArchetypePanel<G, A, R>) tabDesktop.getComponentAt(index);
        return archetypePanel;
    }

    public final void setSelectedPanel(@NotNull final ArchetypePanel<G, A, R> selectedPanel) {
        final int selectedIndex = tabDesktop.indexOfComponent(selectedPanel);
        if (selectedIndex == -1 || selectedIndex == tabDesktop.getSelectedIndex()) {
            return;
        }

        setSelectedPanelInt(selectedPanel);
        tabDesktop.setSelectedIndex(selectedIndex);
    }

    @ActionMethod
    public void displayArchetypeNames() {
        archetypeChooserModel.setDisplayMode(displayModeArchetypeNames);
    }

    @ActionMethod
    public void displayIconsOnly() {
        archetypeChooserModel.setDisplayMode(displayModeIconsOnly);
    }

    private void updateActions() {
        final DisplayMode<G, A, R> displayMode = archetypeChooserModel.getDisplayMode();
        if (displayMode == displayModeGameObjectNames) {
            buttonDisplayGameObjectNames.setSelected(true);
        } else if (displayMode == displayModeArchetypeNames) {
            buttonDisplayArchetypeNames.setSelected(true);
        } else if (displayMode == displayModeIconsOnly) {
            buttonDisplayIconsOnly.setSelected(true);
        }
    }

    private void setSelectedPanelInt(@NotNull final ArchetypePanel<G, A, R> archetypePanel) {
        archetypeChooserModel.setSelectedPanel(archetypePanel.getArchetypeChooserPanel());
    }

}