MapPropertiesDialog.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.var.daimonin.gui.mappropertiesdialog;
 
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.Container;
import java.awt.FlowLayout;
import java.awt.Frame;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.GridLayout;
import java.awt.Insets;
import java.awt.Window;
import javax.swing.AbstractButton;
import javax.swing.BorderFactory;
import javax.swing.BoxLayout;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JFileChooser;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTabbedPane;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.ScrollPaneConstants;
import javax.swing.border.Border;
import javax.swing.border.EmptyBorder;
import javax.swing.filechooser.FileFilter;
import net.sf.gridarta.gui.dialog.help.Help;
import net.sf.gridarta.gui.map.maptilepane.AbstractMapTilePane;
import net.sf.gridarta.gui.map.maptilepane.IsoMapTilePane;
import net.sf.gridarta.gui.utils.GUIConstants;
import net.sf.gridarta.gui.utils.TextComponentUtils;
import net.sf.gridarta.model.mapmanager.MapManager;
import net.sf.gridarta.model.mapmodel.MapModel;
import net.sf.gridarta.model.settings.ProjectSettings;
import net.sf.gridarta.utils.ActionBuilderUtils;
import net.sf.gridarta.utils.Size2D;
import net.sf.gridarta.var.daimonin.model.archetype.Archetype;
import net.sf.gridarta.var.daimonin.model.gameobject.GameObject;
import net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.action.ActionMethod;
import net.sf.japi.swing.misc.JFileChooserButton;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class MapPropertiesDialog extends JOptionPane {
 
    private static final long serialVersionUID = 1L;
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final Frame helpParent;
 
    @NotNull
    private final ProjectSettings projectSettings;
 
    @NotNull
    private final MapModel<GameObject, MapArchObject, Archetype> mapModel;
 
    @Nullable
    private Window dialog;
 
    @NotNull
    private final JTextArea mapDescription = new JTextArea(4, 4);
 
    @NotNull
    private final JTextField mapName = new JTextField();
 
    @NotNull
    private final JTextField mapBackgroundMusic = new JTextField();
 
    @NotNull
    private final JTextField mapWidthField = new JTextField();
 
    @NotNull
    private final JTextField mapHeightField = new JTextField();
 
    @NotNull
    private final AbstractButton checkboxOutdoor = new JCheckBox();
 
    @NotNull
    private final JTextField fieldEnterX = new JTextField();
 
    @NotNull
    private final JTextField fieldEnterY = new JTextField();
 
    @NotNull
    private final JTextField fieldSwapTime = new JTextField();
 
    @NotNull
    private final JTextField fieldResetTimeout = new JTextField();
 
    @NotNull
    private final JTextField fieldDifficulty = new JTextField();
 
    @NotNull
    private final JTextField fieldDarkness = new JTextField();
 
    @NotNull
    private final AbstractButton checkboxFixedReset = new JCheckBox();
 
    @NotNull
    private final AbstractButton checkboxNoSave = new JCheckBox();
 
    @NotNull
    private final AbstractButton checkboxNoMagic = new JCheckBox();
 
    @NotNull
    private final AbstractButton checkboxNoPriest = new JCheckBox();
 
    @NotNull
    private final AbstractButton checkboxNoSummon = new JCheckBox();
 
    @NotNull
    private final AbstractButton checkboxNoHarm = new JCheckBox();
 
    @NotNull
    private final AbstractButton checkboxNoFixedLogin = new JCheckBox();
 
    @NotNull
    private final AbstractButton checkboxPermDeath = new JCheckBox();
 
    @NotNull
    private final AbstractButton checkboxUltraDeath = new JCheckBox();
 
    @NotNull
    private final AbstractButton checkboxUltimateDeath = new JCheckBox();
 
    @NotNull
    private final AbstractButton checkboxPvp = new JCheckBox();
 
    @NotNull
    private final JButton okButton = new JButton(ACTION_BUILDER.createAction(false, "mapOkay", this));
 
    @NotNull
    private final JButton cancelButton = new JButton(ACTION_BUILDER.createAction(false, "mapCancel", this));
 
    @NotNull
    private final AbstractMapTilePane<GameObject, MapArchObject, Archetype> mapTilePane;
 
    private final boolean mapTilePaneEnabled;
 
    public MapPropertiesDialog(@NotNull final Frame helpParent, @NotNull final MapManager<GameObject, MapArchObject, Archetype> mapManager, @NotNull final ProjectSettings projectSettings, @NotNull final MapModel<GameObject, MapArchObject, Archetype> mapModel, @NotNull final FileFilter mapFileFilter) {
        okButton.setDefaultCapable(true);
        final JButton helpButton = new JButton(ACTION_BUILDER.createAction(false, "mapHelp", this));
        final JButton restoreButton = new JButton(ACTION_BUILDER.createAction(false, "mapRestore", this));
        setOptions(new Object[] { helpButton, okButton, restoreButton, cancelButton });
 
        this.helpParent = helpParent;
        this.projectSettings = projectSettings;
        this.mapModel = mapModel;
        final MapArchObject map = mapModel.getMapArchObject();
 
        final JTabbedPane tabs = new JTabbedPane();
        tabs.setBorder(new EmptyBorder(10, 4, 4, 4));
 
        final Component mainPanel = createMainPanel(map);
        tabs.add(ActionBuilderUtils.getString(ACTION_BUILDER, "mapMapTabTitle"), mainPanel);
 
        mapTilePane = new IsoMapTilePane<>(mapManager, projectSettings, mapModel, mapFileFilter);
        final Component tilePanel = createTilePathPanel(mapTilePane);
        tabs.add(ActionBuilderUtils.getString(ACTION_BUILDER, "mapTilesTabTitle"), tilePanel);
 
        mapTilePaneEnabled = mapModel.getMapFile() != null;
        tabs.setEnabledAt(tabs.indexOfComponent(tilePanel), mapTilePaneEnabled);
 
        // The layoutHack is used because otherwise a tabbed pane isn't increased to its vertical size by some OptionPaneUI implementations.
        final Container layoutHack = new JPanel(new BorderLayout());
        layoutHack.add(tabs);
        setMessage(layoutHack);
 
        TextComponentUtils.setAutoSelectOnFocus(mapDescription);
        TextComponentUtils.setAutoSelectOnFocus(mapName);
        TextComponentUtils.setAutoSelectOnFocus(mapBackgroundMusic);
        TextComponentUtils.setAutoSelectOnFocus(mapWidthField);
        TextComponentUtils.setAutoSelectOnFocus(mapHeightField);
        TextComponentUtils.setAutoSelectOnFocus(fieldEnterX);
        TextComponentUtils.setAutoSelectOnFocus(fieldEnterY);
        TextComponentUtils.setAutoSelectOnFocus(fieldSwapTime);
        TextComponentUtils.setAutoSelectOnFocus(fieldResetTimeout);
        TextComponentUtils.setAutoSelectOnFocus(fieldDifficulty);
        TextComponentUtils.setAutoSelectOnFocus(fieldDarkness);
    }
 
    @NotNull
    private Component createMainPanel(@NotNull final MapArchObject map) {
        final GridBagConstraints gbc = new GridBagConstraints();
        final JComponent mainPanel = new JPanel(new GridBagLayout());
        mainPanel.setBorder(GUIConstants.DIALOG_BORDER);
        gbc.fill = GridBagConstraints.BOTH;
 
        gbc.gridx = 1;
        gbc.gridy = 1;
        gbc.weightx = 1.0;
        gbc.weighty = 1.0;
        mainPanel.add(createMapPanel(map), gbc);
 
        gbc.gridx = 1;
        gbc.gridy = 2;
        gbc.weighty = 1.0;
        mainPanel.add(createMapDataPanel(map), gbc);
 
        gbc.gridx = 2;
        gbc.gridy = 1;
        gbc.weighty = 2.0;
        gbc.gridheight = 4;
        mainPanel.add(createOptionsPanel(map), gbc);
 
        gbc.weightx = 1.0;
        gbc.weighty = 1.0;
 
        return mainPanel;
    }
 
    @NotNull
    private Component createMapDataPanel(@NotNull final net.sf.gridarta.model.maparchobject.MapArchObject<MapArchObject> map) {
        mapDescription.setText(map.getText());
        mapDescription.setCaretPosition(0);
        final JScrollPane scrollPane = new JScrollPane(mapDescription);
        mapDescription.setBorder(BorderFactory.createEmptyBorder(1, 4, 0, 0));
        scrollPane.setHorizontalScrollBarPolicy(ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
        scrollPane.setBorder(createTitledBorder("mapText"));
        return scrollPane;
    }
 
    @NotNull
    private Component createOptionsPanel(@NotNull final MapArchObject map) {
        final JPanel optionPanel = new JPanel(new GridLayout(0, 2));
 
        optionPanel.add(createPanelLine(fieldEnterX, 10, map.getEnterX(), "mapEnterX"));
        optionPanel.add(createPanelLine(fieldEnterY, 10, map.getEnterY(), "mapEnterY"));
        optionPanel.add(createPanelLine(fieldDifficulty, 10, map.getDifficulty(), "mapDifficulty"));
        optionPanel.add(createPanelLine(fieldDarkness, 10, map.getDarkness(), "mapDarkness"));
        optionPanel.add(createPanelLine(fieldSwapTime, 10, map.getSwapTime(), "mapSwapTime"));
        optionPanel.add(createPanelLine(fieldResetTimeout, 10, map.getResetTimeout(), "mapResetTimeout"));
 
        optionPanel.add(createPanelCBox(checkboxNoSave, map.isNoSave(), "mapNoSave"));
        optionPanel.add(createPanelCBox(checkboxNoMagic, map.isNoMagic(), "mapNoMagic"));
        optionPanel.add(createPanelCBox(checkboxNoPriest, map.isNoPriest(), "mapNoPrayers"));
        optionPanel.add(createPanelCBox(checkboxNoHarm, map.isNoHarm(), "mapNoHarm"));
        optionPanel.add(createPanelCBox(checkboxNoSummon, map.isNoSummon(), "mapNoSumm"));
        optionPanel.add(createPanelCBox(checkboxNoFixedLogin, map.isFixedLogin(), "mapFixedLogin"));
        optionPanel.add(createPanelCBox(checkboxPermDeath, map.isPermDeath(), "mapPermDeath"));
        optionPanel.add(createPanelCBox(checkboxUltraDeath, map.isUltraDeath(), "mapUltraDeath"));
        optionPanel.add(createPanelCBox(checkboxUltimateDeath, map.isUltimateDeath(), "mapInstantDeath"));
        optionPanel.add(createPanelCBox(checkboxPvp, map.isPvp(), "mapPvP"));
 
        final JComponent scrollPane = new JScrollPane(optionPanel);
        scrollPane.setBorder(createTitledBorder("mapOptions"));
        return scrollPane;
    }
 
    @NotNull
    private Component createMapPanel(@NotNull final MapArchObject map) {
        final JPanel mapPanel = new JPanel(new GridBagLayout());
        final GridBagConstraints labelGbc = new GridBagConstraints();
        labelGbc.anchor = GridBagConstraints.EAST;
        labelGbc.insets = new Insets(2, 10, 2, 2);
        final GridBagConstraints gbc = new GridBagConstraints();
        gbc.insets = new Insets(2, 2, 2, 2);
        gbc.fill = GridBagConstraints.HORIZONTAL;
        gbc.gridwidth = GridBagConstraints.REMAINDER;
        gbc.weightx = 2.0;
 
        mapPanel.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "mapName"), labelGbc);
        mapName.setColumns(16);
        mapName.setText(map.getMapName());
        mapPanel.add(mapName, gbc);
 
        mapPanel.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "mapBackgroundMusic"), labelGbc);
        mapBackgroundMusic.setColumns(16);
        mapBackgroundMusic.setText(map.getBackgroundMusic());
        final Container mapBackgroundMusicPanel = new JPanel(new BorderLayout());
        mapBackgroundMusicPanel.add(mapBackgroundMusic);
        mapBackgroundMusicPanel.add(new JFileChooserButton(projectSettings.getMediaDirectory(), mapBackgroundMusic, JFileChooser.FILES_ONLY), BorderLayout.EAST);
        mapPanel.add(mapBackgroundMusicPanel, gbc);
 
        mapPanel.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "mapWidth"), labelGbc);
        mapWidthField.setColumns(5);
        mapWidthField.setText(Integer.toString(mapModel.getMapArchObject().getMapSize().getWidth()));
        gbc.gridwidth = 1;
        gbc.weightx = 1.0;
        mapPanel.add(mapWidthField, gbc);
 
        mapPanel.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "mapHeight"), labelGbc);
        mapHeightField.setColumns(5);
        mapHeightField.setText(Integer.toString(mapModel.getMapArchObject().getMapSize().getHeight()));
        gbc.gridwidth = GridBagConstraints.REMAINDER;
        gbc.weightx = 1.0;
        mapPanel.add(mapHeightField, gbc);
 
        final Container p2 = new JPanel(new GridBagLayout());
        gbc.gridwidth = 1;
        gbc.weightx = 1.0;
        gbc.anchor = GridBagConstraints.CENTER;
        gbc.fill = GridBagConstraints.NONE;
        p2.add(createPanelCBox(checkboxOutdoor, map.isOutdoor(), "mapOutdoor"), gbc);
        gbc.gridwidth = GridBagConstraints.REMAINDER;
        p2.add(createPanelCBox(checkboxFixedReset, map.isFixedReset(), "mapFixedReset"), gbc);
 
        gbc.weightx = 2.0;
        gbc.fill = GridBagConstraints.HORIZONTAL;
        mapPanel.add(p2, gbc);
 
        final JComponent scrollPane = new JScrollPane(mapPanel);
        scrollPane.setBorder(createTitledBorder("mapMap"));
        return scrollPane;
    }
 
    @NotNull
    private static Component createTilePathPanel(@NotNull final Component mapTilePane) {
        final Container panel = new JPanel(new BorderLayout());
        panel.add(mapTilePane, BorderLayout.NORTH);
        return panel;
    }
 
    @ActionMethod
    public void mapHelp() {
        new Help(helpParent, "tut_mapattr.html").setVisible(true);
    }
 
    @ActionMethod
    public void mapOkay() {
        if (modifyMapProperties()) {
            setValue(okButton);
        }
    }
 
    @ActionMethod
    public void mapRestore() {
        restoreMapProperties();
    }
 
    @ActionMethod
    public void mapCancel() {
        setValue(cancelButton);
    }
 
    @Override
    public void setValue(@Nullable final Object newValue) {
        super.setValue(newValue);
        if (dialog != null && newValue != UNINITIALIZED_VALUE) {
            dialog.dispose();
        }
    }
 
    @NotNull
    private static Border createTitledBorder(@NotNull final String key) {
        return BorderFactory.createCompoundBorder(BorderFactory.createTitledBorder(ActionBuilderUtils.getString(ACTION_BUILDER, key)), GUIConstants.DIALOG_BORDER);
    }
 
    @NotNull
    private static Component createPanelLine(@NotNull final JTextField textField, final int n, final int defaultValue, @NotNull final String labelKey) {
        final Container lineLayout = new JPanel(new FlowLayout(FlowLayout.RIGHT));
        lineLayout.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, labelKey));
        textField.setColumns(n);
        textField.setText(Integer.toString(defaultValue));
        textField.setToolTipText(ACTION_BUILDER.getString(labelKey + ".shortdescription"));
        lineLayout.add(textField);
        return lineLayout;
    }
 
    @NotNull
    private static Component createPanelCBox(@NotNull final AbstractButton checkBox, final boolean state, @NotNull final String labelKey) {
        final JPanel panel = new JPanel();
        panel.setLayout(new BoxLayout(panel, BoxLayout.X_AXIS));
        panel.add(checkBox);
        checkBox.setText(ActionBuilderUtils.getString(ACTION_BUILDER, labelKey));
        checkBox.setSelected(state);
        return panel;
    }
 
    private boolean modifyMapProperties() {
        // first check if the entries are all okay
        final int darkness;
        final int difficulty;
        final int swapTime;
        final int resetTimeout;
        final Size2D mapSize;
        final int enterX;
        final int enterY;
        try {
            // try to parse everything
            final int width = parseProperty(mapWidthField.getText(), "Width");
            final int height = parseProperty(mapHeightField.getText(), "Height");
            enterX = parseProperty(fieldEnterX.getText(), "Enter X");
            enterY = parseProperty(fieldEnterY.getText(), "Enter Y");
            swapTime = parseProperty(fieldSwapTime.getText(), "Swap Time");
            resetTimeout = parseProperty(fieldResetTimeout.getText(), "Reset Timeout");
            difficulty = parseProperty(fieldDifficulty.getText(), "Difficulty");
            if (difficulty < 1) {
                throw new IllegalArgumentException("Difficulty must be > 0"); // TODO: i18n/l10n
            }
            darkness = parseProperty(fieldDarkness.getText(), "Darkness");
 
            // Now do some sanity checks:
            if (width < 1 || height < 1) {
                ACTION_BUILDER.showMessageDialog(this, "mapErrorIllegalSize");
                return false;
            }
            mapSize = new Size2D(width, height);
            /*
               if (fieldDarkness > 1000) {
               mainControl.showMessage("Illegal Value", "Darkness level must be in range 0-1000." );
               return false;
               }*/
            if (mapName.getText().isEmpty()) {
                ACTION_BUILDER.showMessageDialog(this, "mapErrorMissingMapName");
                return false;
            }
        } catch (final IllegalArgumentException e) {
            ACTION_BUILDER.showMessageDialog(this, "mapErrorInvalidEntry", e.getMessage());
            return false;
        }
 
        // now that all is well, write the new values into the map arch object
 
        mapModel.beginTransaction("Map properties"); // TODO: I18N/L10N
        try {
            final MapArchObject mapArchObject = mapModel.getMapArchObject();
            mapArchObject.beginTransaction();
            try {
                mapArchObject.setMapSize(mapSize);
                mapArchObject.setText(mapDescription.getText());
                mapArchObject.setMapName(mapName.getText());
                mapArchObject.setBackgroundMusic(mapBackgroundMusic.getText());
 
                mapArchObject.setEnterX(enterX);
                mapArchObject.setEnterY(enterY);
                mapArchObject.setResetTimeout(resetTimeout);
                mapArchObject.setSwapTime(swapTime);
                mapArchObject.setDifficulty(difficulty);
                mapArchObject.setFixedReset(checkboxFixedReset.isSelected());
                mapArchObject.setDarkness(darkness);
                mapArchObject.setOutdoor(checkboxOutdoor.isSelected());
 
                mapArchObject.setNoSave(checkboxNoSave.isSelected());
                mapArchObject.setNoMagic(checkboxNoMagic.isSelected());
                mapArchObject.setNoPriest(checkboxNoPriest.isSelected());
                mapArchObject.setNoHarm(checkboxNoHarm.isSelected());
                mapArchObject.setNoSummon(checkboxNoSummon.isSelected());
                mapArchObject.setFixedLogin(checkboxNoFixedLogin.isSelected());
                mapArchObject.setPermDeath(checkboxPermDeath.isSelected());
                mapArchObject.setUltraDeath(checkboxUltraDeath.isSelected());
                mapArchObject.setUltimateDeath(checkboxUltimateDeath.isSelected());
                mapArchObject.setPvp(checkboxPvp.isSelected());
 
                mapTilePane.modifyMapProperties();
            } finally {
                mapArchObject.endTransaction();
            }
        } finally {
            mapModel.endTransaction();
        }
 
        return true;
    }
 
    private static int parseProperty(@NotNull final String s, @NotNull final String label) {
        if (s.isEmpty()) {
            return 0;   // empty string is interpreted as zero
        }
        final int r = Integer.parseInt(s);  // trying to parse
        // negative values are not allowed
        if (r < 0 && !label.equals("Darkness")) {
            throw new IllegalArgumentException(label + ": '" + s + "' is negative.");
        }
 
        return r; // everything okay
    }
 
    private void restoreMapProperties() {
        final MapArchObject map = mapModel.getMapArchObject();
 
        mapDescription.setText(map.getText());
        mapName.setText(map.getMapName());
        mapBackgroundMusic.setText(map.getBackgroundMusic());
        mapWidthField.setText(Integer.toString(map.getMapSize().getWidth()));
        mapHeightField.setText(Integer.toString(map.getMapSize().getHeight()));
        fieldEnterX.setText(Integer.toString(map.getEnterX()));
        fieldEnterY.setText(Integer.toString(map.getEnterY()));
        fieldSwapTime.setText(Integer.toString(map.getSwapTime()));
        fieldResetTimeout.setText(Integer.toString(map.getResetTimeout()));
        fieldDarkness.setText(Integer.toString(map.getDarkness()));
        fieldDifficulty.setText(Integer.toString(map.getDifficulty()));
 
        checkboxOutdoor.setSelected(map.isOutdoor());
        checkboxFixedReset.setSelected(map.isFixedReset());
 
        checkboxNoSave.setSelected(map.isNoSave());
        checkboxNoMagic.setSelected(map.isNoMagic());
        checkboxNoPriest.setSelected(map.isNoPriest());
        checkboxNoHarm.setSelected(map.isNoHarm());
        checkboxNoSummon.setSelected(map.isNoSummon());
        checkboxNoFixedLogin.setSelected(map.isFixedLogin());
        checkboxPermDeath.setSelected(map.isPermDeath());
        checkboxUltraDeath.setSelected(map.isUltraDeath());
        checkboxUltimateDeath.setSelected(map.isUltimateDeath());
        checkboxPvp.setSelected(map.isPvp());
 
        mapTilePane.restoreMapProperties();
    }
 
    public void showDialog(@NotNull final Component parentComponent) {
        final String title = ACTION_BUILDER.format("mapTitle", mapModel.getMapArchObject().getMapName(), mapModel.getMapArchObject().getMapName());
        final JDialog window = createDialog(parentComponent, title);
        dialog = window;
        window.getRootPane().setDefaultButton(okButton);
        window.setResizable(true);
        window.setModal(false);
        window.setVisible(true);
        if (!mapTilePaneEnabled) {
            ACTION_BUILDER.showOnetimeMessageDialog(window, WARNING_MESSAGE, "mapTilesNoMapFileNoMapTilePane");
        }
    }
 
}