source: josm/trunk/src/org/openstreetmap/josm/gui/preferences/projection/CustomProjectionChoice.java

// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.gui.preferences.projection;

import static org.openstreetmap.josm.tools.I18n.tr;

import java.awt.BorderLayout;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.ActionListener;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JPanel;

import org.openstreetmap.josm.data.projection.CustomProjection;
import org.openstreetmap.josm.data.projection.Projection;
import org.openstreetmap.josm.data.projection.ProjectionConfigurationException;
import org.openstreetmap.josm.data.projection.Projections;
import org.openstreetmap.josm.gui.ExtendedDialog;
import org.openstreetmap.josm.gui.widgets.AbstractTextComponentValidator;
import org.openstreetmap.josm.gui.widgets.HistoryComboBox;
import org.openstreetmap.josm.gui.widgets.HtmlPanel;
import org.openstreetmap.josm.tools.GBC;
import org.openstreetmap.josm.tools.ImageProvider;
import org.openstreetmap.josm.tools.Logging;
import org.openstreetmap.josm.tools.Utils;

/**
 * ProjectionChoice where a CRS can be defined using various parameters.
 * <p>
 * The configuration string mimics the syntax of the PROJ.4 project and should
 * be mostly compatible.
 * @see CustomProjection
 */
public class CustomProjectionChoice extends AbstractProjectionChoice implements SubPrefsOptions {

    private String pref;

    /**
     * Constructs a new {@code CustomProjectionChoice}.
     */
    public CustomProjectionChoice() {
        super(tr("Custom Projection"), /* NO-ICON */ "core:custom");
    }

    private static class PreferencePanel extends JPanel {

        private HistoryComboBox cbInput;

        PreferencePanel(String initialText, ActionListener listener) {
            build(initialText, listener);
        }

        private void build(String initialText, final ActionListener listener) {
            cbInput = new HistoryComboBox();
            cbInput.getEditorComponent().setColumns(30);
            List<String> samples = Arrays.asList(
                    "+proj=lonlat +ellps=WGS84 +datum=WGS84 +bounds=-180,-90,180,90",
                    "+proj=tmerc +lat_0=0 +lon_0=9 +k_0=1 +x_0=3500000 +y_0=0 +ellps=bessel +nadgrids=BETA2007.gsb");
            cbInput.getModel().prefs().load("projection.custom.value.history", samples);
            cbInput.setText(initialText == null ? "" : initialText);

            final HtmlPanel errorsPanel = new HtmlPanel();
            errorsPanel.setVisible(false);
            final JLabel valStatus = new JLabel();
            valStatus.setVisible(false);

            final AbstractTextComponentValidator val = new AbstractTextComponentValidator(cbInput.getEditorComponent(), false, false, false) {

                private String error;

                @Override
                public void validate() {
                    if (!isValid()) {
                        feedbackInvalid(tr("Invalid projection configuration: {0}", error));
                    } else {
                        feedbackValid(tr("Projection configuration is valid."));
                    }
                    listener.actionPerformed(null);
                }

                @Override
                public boolean isValid() {
                    try {
                        CustomProjection test = new CustomProjection();
                        test.update(cbInput.getEditorComponent().getText());
                    } catch (ProjectionConfigurationException ex) {
                        Logging.warn(ex);
                        error = ex.getMessage();
                        valStatus.setIcon(ImageProvider.get("data", "error"));
                        valStatus.setVisible(true);
                        errorsPanel.setText(error);
                        errorsPanel.setVisible(true);
                        return false;
                    }
                    errorsPanel.setVisible(false);
                    valStatus.setIcon(ImageProvider.get("misc", "green_check"));
                    valStatus.setVisible(true);
                    return true;
                }
            };

            JButton btnCheck = new JButton(tr("Validate"));
            btnCheck.addActionListener(e -> val.validate());
            btnCheck.setLayout(new BorderLayout());
            btnCheck.setMargin(new Insets(-1, 0, -1, 0));

            JButton btnInfo = new JButton(tr("Parameter information..."));
            btnInfo.addActionListener(e -> {
                CustomProjectionChoice.ParameterInfoDialog dlg = new CustomProjectionChoice.ParameterInfoDialog();
                dlg.showDialog();
                dlg.toFront();
            });

            this.setLayout(new GridBagLayout());
            JPanel p2 = new JPanel(new GridBagLayout());
            p2.add(cbInput, GBC.std().fill(GridBagConstraints.HORIZONTAL).insets(0, 20, 5, 5));
            p2.add(btnCheck, GBC.eol().insets(0, 20, 0, 5));
            this.add(p2, GBC.eol().fill(GridBagConstraints.HORIZONTAL));
            p2 = new JPanel(new GridBagLayout());
            p2.add(valStatus, GBC.std().anchor(GridBagConstraints.WEST).weight(0.0001, 0));
            p2.add(errorsPanel, GBC.eol().fill(GridBagConstraints.HORIZONTAL));
            this.add(p2, GBC.eol().fill(GridBagConstraints.HORIZONTAL));
            p2 = new JPanel(new GridBagLayout());
            p2.add(btnInfo, GBC.std().insets(0, 20, 0, 0));
            p2.add(GBC.glue(1, 0), GBC.eol().fill(GridBagConstraints.HORIZONTAL));
            this.add(p2, GBC.eol().fill(GridBagConstraints.HORIZONTAL));
        }

        /**
         * Remember the current input
         */
        public void rememberHistory() {
            cbInput.addCurrentItemToHistory();
            cbInput.getModel().prefs().save("projection.custom.value.history");
        }
    }

    /**
     * A dialog for the available parameters of the custom projection
     */
    public static class ParameterInfoDialog extends ExtendedDialog {

        /**
         * Constructs a new {@code ParameterInfoDialog}.
         */
        public ParameterInfoDialog() {
            super(null, tr("Parameter information"), new String[] {tr("Close")}, false);
            setContent(build());
        }

        private static JComponent build() {
            StringBuilder s = new StringBuilder(1024);
            s.append("<b>+proj=...</b> - <i>").append(tr("Projection name"))
             .append("</i><br>&nbsp;&nbsp;&nbsp;&nbsp;").append(tr("Supported values:")).append(' ')
             .append(Projections.listProjs())
             .append("<br><b>+lat_0=..., +lat_1=..., +lat_2=...</b> - <i>").append(tr("Projection parameters"))
             .append("</i><br><b>+x_0=..., +y_0=...</b> - <i>").append(tr("False easting and false northing"))
             .append("</i><br><b>+lon_0=...</b> - <i>").append(tr("Central meridian"))
             .append("</i><br><b>+k_0=...</b> - <i>").append(tr("Scaling factor"))
             .append("</i><br><b>+ellps=...</b> - <i>").append(tr("Ellipsoid name"))
             .append("</i><br>&nbsp;&nbsp;&nbsp;&nbsp;").append(tr("Supported values:")).append(' ')
             .append(Projections.listEllipsoids())
             .append("<br><b>+a=..., +b=..., +rf=..., +f=..., +es=...</b> - <i>").append(tr("Ellipsoid parameters"))
             .append("</i><br><b>+datum=...</b> - <i>").append(tr("Datum name"))
             .append("</i><br>&nbsp;&nbsp;&nbsp;&nbsp;").append(tr("Supported values:")).append(' ')
             .append(Projections.listDatums())
             .append("<br><b>+towgs84=...</b> - <i>").append(tr("3 or 7 term datum transform parameters"))
             .append("</i><br><b>+nadgrids=...</b> - <i>").append(tr("NTv2 grid file"))
             .append("</i><br>&nbsp;&nbsp;&nbsp;&nbsp;").append(tr("Built-in:")).append(' ')
             .append(Projections.listNadgrids())
             .append("<br><b>+bounds=</b>minlon,minlat,maxlon,maxlat - <i>").append(tr("Projection bounds (in degrees)"))
             .append("</i><br><b>+wmssrs=</b>EPSG:123456 - <i>").append(tr("Sets the SRS=... parameter in the WMS request"))
             .append("</i><br>");

            return new HtmlPanel(s.toString());
        }
    }

    @Override
    public void setPreferences(Collection<String> args) {
        if (!Utils.isEmpty(args)) {
            pref = args.iterator().next();
        }
    }

    @Override
    public Projection getProjection() {
        return new CustomProjection(pref);
    }

    @Override
    public String getCurrentCode() {
        // not needed - getProjection() is overridden
        throw new UnsupportedOperationException();
    }

    @Override
    public String getProjectionName() {
        // not needed - getProjection() is overridden
        throw new UnsupportedOperationException();
    }

    @Override
    public JPanel getPreferencePanel(ActionListener listener) {
        return new PreferencePanel(pref, listener);
    }

    @Override
    public Collection<String> getPreferences(JPanel panel) {
        if (!(panel instanceof PreferencePanel)) {
            throw new IllegalArgumentException("Unsupported panel: "+panel);
        }
        PreferencePanel prefPanel = (PreferencePanel) panel;
        String savePreferences = prefPanel.cbInput.getEditorComponent().getText();
        prefPanel.rememberHistory();
        return Collections.singleton(savePreferences);
    }

    @Override
    public String[] allCodes() {
        return new String[0];
    }

    @Override
    public Collection<String> getPreferencesFromCode(String code) {
        return null;
    }

    @Override
    public boolean showProjectionCode() {
        return false;
    }

    @Override
    public boolean showProjectionName() {
        return false;
    }
}