ResPreferences.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.gui.dialog.prefs;
 
import java.awt.Component;
import java.awt.GridBagLayout;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.io.File;
import java.util.Arrays;
import javax.swing.Box;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JFileChooser;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.border.Border;
import javax.swing.border.CompoundBorder;
import javax.swing.border.TitledBorder;
import net.sf.gridarta.gui.utils.GUIConstants;
import net.sf.gridarta.gui.utils.JFileField;
import net.sf.gridarta.model.configsource.ConfigSource;
import net.sf.gridarta.model.configsource.ConfigSourceFactory;
import net.sf.gridarta.model.settings.EditorSettings;
import net.sf.gridarta.model.settings.ProjectSettings;
import net.sf.gridarta.utils.ActionBuilderUtils;
import net.sf.gridarta.utils.StringUtils;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.prefs.AbstractPrefs;
import net.sf.japi.util.Arrays2;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class ResPreferences extends AbstractPrefs {
 
    private static final long serialVersionUID = 1L;
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private final ProjectSettings projectSettings;
 
    @NotNull
    private final EditorSettings editorSettings;
 
    @NotNull
    private final ConfigSourceFactory configSourceFactory;
 
    @NotNull
    private JFileField archField;
 
    @NotNull
    private JFileField mapField;
 
    @Nullable
    private JFileField mediaField;
 
    @NotNull
    private JComboBox<ConfigSource> configSourceComboBox;
 
    @Nullable
    private JComboBox<String> imageSetBox;
 
    @Nullable
    private String @NotNull [] imageSets;
 
    @NotNull
    private final ItemListener itemListener = new ItemListener() {
 
        @Override
        public void itemStateChanged(final ItemEvent e) {
            if (e.getStateChange() == ItemEvent.SELECTED) {
                final ConfigSource configSource = (ConfigSource) e.getItem();
                archField.setEnabled(configSource.isArchDirectoryInputFieldEnabled());
            }
        }
 
    };
 
    public ResPreferences(@NotNull final ProjectSettings projectSettings, @NotNull final EditorSettings editorSettings, @NotNull final ConfigSourceFactory configSourceFactory) {
        this.projectSettings = projectSettings;
        this.editorSettings = editorSettings;
        this.configSourceFactory = configSourceFactory;
        setListLabelText(ActionBuilderUtils.getString(ACTION_BUILDER, "prefsRes.title"));
        setListLabelIcon(ACTION_BUILDER.getIcon("prefsRes.icon"));
 
        add(createResourcePanel());
        add(createGlobalPanel());
        add(Box.createVerticalGlue());
    }
 
    @NotNull
    private static Border createTitledBorder(final String titleKey) {
        return new CompoundBorder(new TitledBorder(ActionBuilderUtils.getString(ACTION_BUILDER, titleKey)), GUIConstants.DIALOG_BORDER);
    }
 
    @Override
    public void apply() {
        projectSettings.setArchDirectory(archField.getFile());
        projectSettings.setMapsDirectory(mapField.getFile());
        if (editorSettings.hasMediaDirectory()) {
            assert mediaField != null;
            projectSettings.setMediaDirectory(mediaField.getFile());
        }
        projectSettings.setConfigSourceName(((ConfigSource) configSourceComboBox.getSelectedItem()).getName());
 
        if (editorSettings.hasImageSet()) {
            assert imageSetBox != null;
            final String imageSet = (String) imageSetBox.getSelectedItem();
            projectSettings.setImageSet(imageSet == null || imageSet.equals("disabled") ? "none" : imageSet);
        }
 
        ACTION_BUILDER.showOnetimeMessageDialog(this, JOptionPane.WARNING_MESSAGE, "optionsRestart");
    }
 
    @Override
    public void revert() {
        archField.setFile(projectSettings.getArchDirectory());
        mapField.setFile(projectSettings.getMapsDirectory());
        if (editorSettings.hasMediaDirectory()) {
            final File mediaDirectory = projectSettings.getMediaDirectory();
            assert mediaField != null;
            mediaField.setFile(mediaDirectory);
        }
        configSourceComboBox.setSelectedItem(configSourceFactory.getConfigSource(projectSettings.getConfigSourceName()));
        if (editorSettings.hasImageSet()) {
            final String imageSet = getCurrentImageSet();
            assert imageSets != null;
            final int index = Arrays2.linearEqualitySearch(imageSet, imageSets);
            assert imageSetBox != null;
            imageSetBox.setSelectedIndex(index);
        }
    }
 
    @Override
    public void defaults() {
        archField.setFile(editorSettings.getArchDirectoryDefault());
        mapField.setFile(editorSettings.getMapsDirectoryDefault());
        if (editorSettings.hasMediaDirectory()) {
            final File mediaDirectory = editorSettings.getMediaDirectoryDefault();
            assert mediaField != null;
            mediaField.setFile(mediaDirectory);
        }
        configSourceComboBox.setSelectedItem(configSourceFactory.getDefaultConfigSource());
        if (editorSettings.hasImageSet()) {
            assert imageSets != null;
            final int index = Arrays2.linearEqualitySearch("disabled", imageSets);
            assert imageSetBox != null;
            imageSetBox.setSelectedIndex(index);
        }
    }
 
    @Override
    public boolean isChanged() {
        final String imageSet;
        if (editorSettings.hasImageSet()) {
            assert imageSetBox != null;
            imageSet = convertImageSet((String) imageSetBox.getSelectedItem());
        } else {
            imageSet = convertImageSet(null);
        }
        if (!archField.getFile().equals(projectSettings.getArchDirectory()) || !mapField.getFile().equals(projectSettings.getMapsDirectory())) {
            return true;
        }
 
        if (editorSettings.hasMediaDirectory()) {
            assert mediaField != null;
            if (!mediaField.getFile().equals(projectSettings.getMediaDirectory())) {
                return true;
            }
        }
 
        return !imageSet.equals(getCurrentImageSet()) || !((ConfigSource) configSourceComboBox.getSelectedItem()).getName().equals(projectSettings.getConfigSourceName());
    }
 
    private Component createResourcePanel() {
        final JComponent panel = new JPanel(new GridBagLayout());
        final PreferencesHelper preferencesHelper = new PreferencesHelper(panel);
        panel.setBorder(createTitledBorder("optionsResPaths"));
        archField = new JFileField(this, "optionsResArch", null, projectSettings.getArchDirectory(), JFileChooser.DIRECTORIES_ONLY);
        preferencesHelper.addComponent(ActionBuilderUtils.newLabel(ACTION_BUILDER, "optionsResArch"));
        preferencesHelper.addComponent(archField);
        mapField = new JFileField(this, "optionsResMaps", null, projectSettings.getMapsDirectory(), JFileChooser.DIRECTORIES_ONLY);
        preferencesHelper.addComponent(ActionBuilderUtils.newLabel(ACTION_BUILDER, "optionsResMaps"));
        preferencesHelper.addComponent(mapField);
        if (editorSettings.hasMediaDirectory()) {
            mediaField = new JFileField(this, "optionsResMedia", null, projectSettings.getMediaDirectory(), JFileChooser.DIRECTORIES_ONLY);
            preferencesHelper.addComponent(ActionBuilderUtils.newLabel(ACTION_BUILDER, "optionsResMedia"));
            assert mediaField != null;
            preferencesHelper.addComponent(mediaField);
        }
        return panel;
    }
 
    @NotNull
    private Component createGlobalPanel() {
        final JComponent panel = new JPanel(new GridBagLayout());
        final PreferencesHelper preferencesHelper = new PreferencesHelper(panel);
        panel.setBorder(createTitledBorder("optionsGlobal"));
 
        configSourceComboBox = new JComboBox<>(configSourceFactory.getConfigSources());
        final ConfigSource configSource = configSourceFactory.getConfigSource(projectSettings.getConfigSourceName());
        configSourceComboBox.setSelectedItem(configSource);
        configSourceComboBox.addItemListener(itemListener);
        preferencesHelper.addComponent(ActionBuilderUtils.newLabel(ACTION_BUILDER, "optionsConfigSource.text"));
        preferencesHelper.addComponent(configSourceComboBox);
        archField.setEnabled(configSource.isArchDirectoryInputFieldEnabled());
 
        if (editorSettings.hasImageSet()) {
            preferencesHelper.addComponent(ActionBuilderUtils.newLabel(ACTION_BUILDER, "optionsImageSet"));
            preferencesHelper.addComponent(buildImageSetBox());
        }
 
        return panel;
    }
 
    @NotNull
    private Component buildImageSetBox() {
        final String[] imageSetNames = StringUtils.PATTERN_WHITESPACE.split(ActionBuilderUtils.getString(ACTION_BUILDER, "availableImageSets"), 0);
        Arrays.sort(imageSetNames);
        imageSets = new String[imageSetNames.length + 1];
        imageSets[0] = "disabled";
        System.arraycopy(imageSetNames, 0, imageSets, 1, imageSetNames.length);
 
        imageSetBox = new JComboBox<>(imageSets);     // set "content"
        final String imageSet = getCurrentImageSet();
        assert imageSets != null;
        final int index = Arrays2.linearEqualitySearch(imageSet, imageSets);
        assert imageSetBox != null;
        imageSetBox.setSelectedIndex(index);
 
        assert imageSetBox != null;
        return imageSetBox;
    }
 
    @NotNull
    private String getCurrentImageSet() {
        return convertImageSet(projectSettings.getImageSet());
    }
 
    @NotNull
    private static String convertImageSet(@Nullable final String imageSet) {
        return imageSet == null || imageSet.isEmpty() || imageSet.equals("none") ? "disabled" : imageSet;
    }
 
}