NetPreferences.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.net.InetSocketAddress;
import java.net.Proxy;
import java.net.Proxy.Type;
import java.util.EnumSet;
import java.util.prefs.Preferences;
import javax.swing.Box;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JPanel;
import javax.swing.JSpinner;
import javax.swing.JTextField;
import javax.swing.SpinnerNumberModel;
import javax.swing.border.Border;
import javax.swing.border.CompoundBorder;
import javax.swing.border.TitledBorder;
import javax.swing.text.JTextComponent;
import net.sf.gridarta.MainControl;
import net.sf.gridarta.gui.utils.GUIConstants;
import net.sf.gridarta.utils.ActionBuilderUtils;
import net.sf.japi.swing.action.ActionBuilder;
import net.sf.japi.swing.action.ActionBuilderFactory;
import net.sf.japi.swing.prefs.AbstractPrefs;
import org.jetbrains.annotations.NotNull;
 
public class NetPreferences extends AbstractPrefs implements ItemListener {
 
    private static final long serialVersionUID = 1L;
 
    @NotNull
    private static final String NET_PREFERENCES_KEY_TYPE = "proxy.type";
 
    @NotNull
    private static final String NET_PREFERENCES_KEY_HOST = "proxy.host";
 
    @NotNull
    private static final String NET_PREFERENCES_KEY_PORT = "proxy.port";
 
    @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 final JComboBox<Type> proxyType = createProxyType();
 
    @NotNull
    private final JTextComponent proxyHost = new JTextField(PREFERENCES.get(NET_PREFERENCES_KEY_HOST, ""));
 
    @NotNull
    private final JSpinner proxyPort = new JSpinner(new SpinnerNumberModel(PREFERENCES.getInt(NET_PREFERENCES_KEY_PORT, 3128), 1, 65535, 1));
 
    public NetPreferences() {
        setListLabelText(ActionBuilderUtils.getString(ACTION_BUILDER, "prefsNet.title"));
        setListLabelIcon(ACTION_BUILDER.getIcon("prefsNet.icon"));
        proxyType.addItemListener(this);
 
        add(createNetPanel());
        add(Box.createVerticalGlue());
        revert();
    }
 
    @NotNull
    private static Border createTitledBorder(@NotNull final String titleKey) {
        return new CompoundBorder(new TitledBorder(ActionBuilderUtils.getString(ACTION_BUILDER, titleKey)), GUIConstants.DIALOG_BORDER);
    }
 
    @Override
    public boolean isChanged() {
        return proxyType.getSelectedItem() != Type.valueOf(PREFERENCES.get(NET_PREFERENCES_KEY_TYPE, "DIRECT")) || !PREFERENCES.get(NET_PREFERENCES_KEY_HOST, "").equals(proxyHost.getText()) || PREFERENCES.getInt(NET_PREFERENCES_KEY_PORT, 3128) != (Integer) proxyPort.getValue();
 
    }
 
    @Override
    public void defaults() {
        PREFERENCES.remove(NET_PREFERENCES_KEY_TYPE);
        PREFERENCES.remove(NET_PREFERENCES_KEY_HOST);
        PREFERENCES.remove(NET_PREFERENCES_KEY_PORT);
        revert();
    }
 
    @Override
    public final void revert() {
        //Cannot weaken tp Enum<Proxy.Type> because some javac versions (1.6.0_01, 1.6.0_16, 1.7.0-ea) report incomparable types
        final Type keyType = Type.valueOf(PREFERENCES.get(NET_PREFERENCES_KEY_TYPE, "DIRECT"));
        proxyType.setSelectedIndex(keyType.ordinal());
        final boolean enableProxy = keyType != Type.DIRECT;
        proxyHost.setEnabled(enableProxy);
        proxyPort.setEnabled(enableProxy);
        proxyHost.setText(PREFERENCES.get(NET_PREFERENCES_KEY_HOST, ""));
        proxyPort.setValue(PREFERENCES.getInt(NET_PREFERENCES_KEY_PORT, 3128));
    }
 
    @Override
    public void apply() {
        //JComboBox does not use type parameters
        @SuppressWarnings("unchecked") final Enum<Type> typeEnum = (Enum<Type>) proxyType.getSelectedItem();
        PREFERENCES.put(NET_PREFERENCES_KEY_TYPE, typeEnum.name());
        PREFERENCES.put(NET_PREFERENCES_KEY_HOST, proxyHost.getText());
        PREFERENCES.putInt(NET_PREFERENCES_KEY_PORT, (Integer) proxyPort.getValue());
    }
 
    @NotNull
    private Component createNetPanel() {
        final JComponent panel = new JPanel(new GridBagLayout());
        final PreferencesHelper preferencesHelper = new PreferencesHelper(panel);
        panel.setBorder(createTitledBorder("optionsNetProxy"));
        preferencesHelper.addComponent(proxyType);
        preferencesHelper.addComponent(proxyHost);
        preferencesHelper.addComponent(proxyPort);
        return panel;
    }
 
    @NotNull
    private static JComboBox<Type> createProxyType() {
 
        return new JComboBox<>(EnumSet.allOf(Type.class).toArray(new Type[0]));
    }
 
    @NotNull
    public static Proxy getProxy() {
        final Type proxyType = Type.valueOf(PREFERENCES.get(NET_PREFERENCES_KEY_TYPE, "DIRECT"));
        return proxyType == Type.DIRECT ? Proxy.NO_PROXY : new Proxy(proxyType, new InetSocketAddress(PREFERENCES.get(NET_PREFERENCES_KEY_HOST, "proxy"), PREFERENCES.getInt(NET_PREFERENCES_KEY_PORT, 3128)));
    }
 
    @Override
    public void itemStateChanged(@NotNull final ItemEvent e) {
        final Type proxyTypeSelection = (Type) proxyType.getSelectedItem();
        final boolean enableProxy = proxyTypeSelection != Type.DIRECT;
        proxyHost.setEnabled(enableProxy);
        proxyPort.setEnabled(enableProxy);
    }
 
}