ColumbusCSVPreferences.java

/**
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
package org.openstreetmap.josm.plugins.columbusCSV;

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

import javax.swing.ButtonGroup;
import javax.swing.JCheckBox;

import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting;
import org.openstreetmap.josm.gui.preferences.PreferenceTabbedPane;

/**
 * Implements the preferences dialog for this plugin.
 * @author Oliver Wieland <oliver.wieland@online.de>
 */
public class ColumbusCSVPreferences extends DefaultTabPreferenceSetting {
    public static final String PREFIX = "columbuscsv.";
    
    /**
     * Show summary after import.
     */
    public static final String SHOW_SUMMARY = PREFIX + "import.showSummary";
    /**
     * Disable auto zoom after import.
     */
    public static final String ZOOM_AFTER_IMPORT = PREFIX + "import.dontZoomAfterImport";
    /** 
     * If <tt>true</tt>, all DOP values (hdop, vdop, pdop) are ignored. If the V-900 runs in simple mode,
     * this setting has no effect.
     */
    public static final String IGNORE_VDOP = PREFIX + "import.ignoreVDOP";
    /**
     * Issue warning on missing audio files.
     */
    public static final String WARN_MISSING_AUDIO = PREFIX + "warn.missingAudio";
    /**
     * Issue warning on conversion errors.
     */
    public static final String WARN_CONVERSION_ERRORS = PREFIX + "warn.conversionErrors";
    
    /**
     * Ui elements for each flag.
     */
    private JCheckBox colCSVShowSummary = new JCheckBox(tr("Show summary after import"));
    private JCheckBox colCSVDontZoomAfterImport = new JCheckBox(tr("Do not zoom after import"));
    private JCheckBox colCSVIgnoreVDOP = new JCheckBox(tr("Ignore hdop/vdop/pdop entries"));
    private JCheckBox colCSVWarnMissingAudio = new JCheckBox(tr("Warn on missing audio files"));
    private JCheckBox colCSVWarnConversionErrors = new JCheckBox(tr("Warn on conversion errors"));
    
    /**
     * Creates a new preferences instance.
     */
    public ColumbusCSVPreferences() {
       super();
    }

    /**
     * Applies the (new) settings after settings dialog has been closed successfully.
     */
    @Override
    public boolean ok() {
        Main.pref.put(SHOW_SUMMARY, colCSVShowSummary.isSelected());
        Main.pref.put(ZOOM_AFTER_IMPORT, colCSVDontZoomAfterImport.isSelected());
        Main.pref.put(IGNORE_VDOP, colCSVIgnoreVDOP.isSelected());
        Main.pref.put(WARN_CONVERSION_ERRORS, colCSVWarnConversionErrors.isSelected());
        Main.pref.put(WARN_MISSING_AUDIO, colCSVWarnMissingAudio.isSelected());        
        return false;
    }
    
    /**
     * If <tt>true</tt>, a summary dialog is shown after import. Default is <tt>true</tt>.
     * @return
     */
    public static boolean showSummary() {
        return Main.pref.getBoolean(SHOW_SUMMARY, true);
    }
    
    /**
     * If <tt>true</tt>, a the bounding box will not be scaled to the imported data.
     * @return
     */
    public static boolean zoomAfterImport() {
        return Main.pref.getBoolean(ZOOM_AFTER_IMPORT, true);
    }
    
    /**
     * If <tt>true</tt>, all DOP values (hdop, vdop, pdop) are ignored. If the V-900 runs in simple mode,
     * this setting has no effect. 
     * Default is <tt>false</tt>.
     * @return
     */
    public static boolean ignoreDOP() {
        return Main.pref.getBoolean(IGNORE_VDOP, false);
    }
    
    /**
     * If <tt>true</tt>, the plugin issues warnings if either date or position errors have been occurred. 
     * Default is <tt>true</tt>.
     * @return
     */
    public static boolean warnConversion() {
        return Main.pref.getBoolean(WARN_CONVERSION_ERRORS, false);
    }
    
    /**
     * If <tt>true</tt>, the plugin issues a warning if a referenced audio file is missing. 
     * Default is <tt>true</tt>.
     * @return
     */
    public static boolean warnMissingAudio() {
        return Main.pref.getBoolean(WARN_MISSING_AUDIO, false);
    }

    /**
     * Populates the UI with our settings.
     * @param gui The pane to populate.
     */
    @Override
    public void addGui(PreferenceTabbedPane gui) {
        // Import settings
        ButtonGroup gpsImportGroup = new ButtonGroup();
        gpsImportGroup.add(colCSVShowSummary);
        gpsImportGroup.add(colCSVDontZoomAfterImport);
        gpsImportGroup.add(colCSVIgnoreVDOP);
      
        // Warning settings
        ButtonGroup gpsWarningsGroup = new ButtonGroup();
        gpsWarningsGroup.add(colCSVWarnMissingAudio);
        gpsWarningsGroup.add(colCSVWarnConversionErrors);

        // Apply settings
        colCSVShowSummary.setSelected(Main.pref.getBoolean(SHOW_SUMMARY, true));
        colCSVDontZoomAfterImport.setSelected(Main.pref.getBoolean(ZOOM_AFTER_IMPORT, true));
        colCSVIgnoreVDOP.setSelected(Main.pref.getBoolean(IGNORE_VDOP, false));
        colCSVWarnConversionErrors.setSelected(Main.pref.getBoolean(WARN_CONVERSION_ERRORS, true));
        colCSVWarnMissingAudio.setSelected(Main.pref.getBoolean(WARN_MISSING_AUDIO, true));
    }

    public boolean isExpert() {
        return false;
    }
    
}