GUIPreferences.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.Container;
import java.awt.GridBagLayout;
import java.util.Arrays;
import java.util.Comparator;
import java.util.Locale;
import java.util.Objects;
import java.util.prefs.Preferences;
import javax.swing.AbstractButton;
import javax.swing.Box;
import javax.swing.JCheckBox;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JPanel;
import javax.swing.border.Border;
import javax.swing.border.CompoundBorder;
import javax.swing.border.TitledBorder;
import net.sf.gridarta.MainControl;
import net.sf.gridarta.gui.utils.GUIConstants;
import net.sf.gridarta.model.settings.EditorSettings;
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.misc.LocaleListCellRenderer;
import net.sf.japi.swing.prefs.AbstractPrefs;
import net.sf.japi.util.LocaleComparator;
import org.jetbrains.annotations.NotNull;
 
public class GUIPreferences extends AbstractPrefs {
 
    public static final String PREFERENCES_LANGUAGE = "language";
 
    private static final long serialVersionUID = 1L;
 
    @NotNull
    private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
 
    @NotNull
    private static final Preferences PREFERENCES = Preferences.userNodeForPackage(MainControl.class);
 
    @NotNull
    private static final String @NotNull [] EMPTY_STRING_ARRAY = new String[0];
 
    @NotNull
    private final EditorSettings editorSettings;
 
    @NotNull
    private JComboBox<Locale> localeBox;
 
    @NotNull
    private AbstractButton showMainToolbar;
 
    @NotNull
    private Locale @NotNull [] locales;
 
    @NotNull
    private final Comparator<Locale> comp = new LocaleComparator();
 
    public GUIPreferences(@NotNull final EditorSettings editorSettings) {
        this.editorSettings = editorSettings;
 
        setListLabelText(ActionBuilderUtils.getString(ACTION_BUILDER, "prefsGUI.title"));
        setListLabelIcon(ACTION_BUILDER.getIcon("prefsGUI.icon"));
 
        add(createGlobalPanel());
        add(createLayoutPanel());
        add(Box.createVerticalGlue());
    }
 
    @NotNull
    private static Border createTitledBorder(@NotNull final String titleKey) {
        return new CompoundBorder(new TitledBorder(ActionBuilderUtils.getString(ACTION_BUILDER, titleKey)), GUIConstants.DIALOG_BORDER);
    }
 
    @Override
    public void apply() {
        final Locale loc = (Locale) localeBox.getSelectedItem();
        if (loc == null) {
            PREFERENCES.remove(PREFERENCES_LANGUAGE);
        } else {
            PREFERENCES.put(PREFERENCES_LANGUAGE, loc.getLanguage());
        }
        editorSettings.setShowMainToolbar(showMainToolbar.isSelected());
    }
 
    @Override
    public void revert() {
        final String current = PREFERENCES.get(PREFERENCES_LANGUAGE, null);
        localeBox.setSelectedIndex(Arrays.binarySearch(locales, current == null ? null : new Locale(current), comp));
        showMainToolbar.setSelected(editorSettings.isShowMainToolbar());
    }
 
    @Override
    public void defaults() {
        localeBox.setSelectedIndex(Arrays.binarySearch(locales, null, comp));
        showMainToolbar.setSelected(EditorSettings.SHOW_MAIN_TOOLBAR_DEFAULT);
    }
 
    @Override
    public boolean isChanged() {
        final Locale loc = (Locale) localeBox.getSelectedItem();
        final String currentName = PREFERENCES.get(PREFERENCES_LANGUAGE, null);
        final Locale current = currentName == null ? null : new Locale(currentName);
        return !Objects.equals(loc, current) || showMainToolbar.isSelected() != editorSettings.isShowMainToolbar();
    }
 
    @NotNull
    private Component buildLocaleBox() {
        final Container lineLayout = Box.createHorizontalBox();
 
        final CharSequence availableLocales = ACTION_BUILDER.getString("availableLocales");
        final String[] locNames = availableLocales == null ? EMPTY_STRING_ARRAY : StringUtils.PATTERN_WHITESPACE.split(availableLocales, 0);
        locales = new Locale[locNames.length + 1];
        // locales[0] is intentionally null. It will be displayed as default and always get sorted to the top.
        for (int i = 0; i < locNames.length; i++) {
            locales[i + 1] = new Locale(locNames[i]);
        }
        Arrays.sort(locales, comp);
 
        lineLayout.add(ActionBuilderUtils.newLabel(ACTION_BUILDER, "optionsLanguage"));  // create label
 
        localeBox = new JComboBox<>(locales);     // set "content"
        localeBox.setRenderer(new LocaleListCellRenderer());
        //localeBox.setPreferredSize(new Dimension(150, 25));
        final String current = PREFERENCES.get(PREFERENCES_LANGUAGE, null);
        localeBox.setSelectedIndex(Arrays.binarySearch(locales, current == null ? null : new Locale(current), comp));
 
        lineLayout.add(localeBox);
        return lineLayout;
    }
 
    @NotNull
    private Component createGlobalPanel() {
        final JComponent panel = new JPanel(new GridBagLayout());
        final PreferencesHelper preferencesHelper = new PreferencesHelper(panel);
        panel.setBorder(createTitledBorder("optionsGlobal"));
 
        preferencesHelper.addComponent(buildLocaleBox());
 
        return panel;
    }
 
    @NotNull
    private Component createLayoutPanel() {
        final JComponent panel = new JPanel(new GridBagLayout());
        final PreferencesHelper preferencesHelper = new PreferencesHelper(panel);
        panel.setBorder(createTitledBorder("optionsLayout"));
 
        showMainToolbar = new JCheckBox(ACTION_BUILDER.createAction(false, "optionsShowMainToolbar"));
        showMainToolbar.setSelected(editorSettings.isShowMainToolbar());
        preferencesHelper.addComponent(showMainToolbar);
 
        return panel;
    }
 
}