Changeset 6594 in josm

Timestamp:

2014-01-02T00:58:33+01:00 (10 years ago)

Author:

simon04

Message:

fix #8969 fix #9394 - add "Do not show again (this session)" choice, and in addition "Do not show again (this operation)" if a bulk operation has been marked in the code

The dialog displays 3 or 4 radio boxes with the labels:

• "Show this dialog again the next time"
• "Do not show again (this operation)"
• "Do not show again (this session)"
• "Do not show again (remembers choice)"

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• ConditionalOptionPaneUtil.java (modified) (7 diffs)
• ExtendedDialog.java (modified) (6 diffs)
• dialogs/relation/GenericRelationEditor.java (modified) (2 diffs)
• io/UploadDialog.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/gui/ConditionalOptionPaneUtil.java

@@ -7 +7 @@
 import java.awt.GridBagLayout;
 import java.awt.HeadlessException;
-
-import javax.swing.JCheckBox;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import javax.swing.ButtonGroup;
 import javax.swing.JLabel;
 import javax.swing.JOptionPane;
 import javax.swing.JPanel;
+import javax.swing.JRadioButton;
 
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.tools.GBC;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -29 +35 @@
     static public final int DIALOG_DISABLED_OPTION = Integer.MIN_VALUE;
 
+    /** (preference key => return value) mappings valid for the current operation (no, those two maps cannot be combined) */
+    protected static final Map<String, Integer> sessionChoices = new HashMap<String, Integer>();
+    /** (preference key => return value) mappings valid for the current session */
+    protected static final Map<String, Integer> immediateChoices = new HashMap<String, Integer>();
+    /** a set indication that (preference key) is or may be stored for the currently active bulk operation */
+    protected static final Set<String> immediateActive = new HashSet<String>();
+
     /**
      * this is a static utility class only
      */
     private ConditionalOptionPaneUtil() {}
-
-    /**
-     * Replies the preference value for the preference key "message." + <code>prefKey</code>.
-     * The default value if the preference key is missing is true.
-     *
-     * @param  prefKey the preference key
-     * @return the preference value for the preference key "message." + <code>prefKey</code>
-     */
-    public static boolean getDialogShowingEnabled(String prefKey) {
-        return Main.pref.getBoolean("message."+prefKey, true);
-    }
-
-    /**
-     * sets the value for the preference key "message." + <code>prefKey</code>.
-     *
-     * @param prefKey the key
-     * @param enabled the value
-     */
-    public static void setDialogShowingEnabled(String prefKey, boolean enabled) {
-        Main.pref.put("message."+prefKey, enabled);
-    }
 
     /**
@@ -62 +54 @@
      * @return the preference value for the preference key "message." + <code>prefKey</code> + ".value"
      */
-    public static Integer getDialogReturnValue(String prefKey) {
-        return Main.pref.getInteger("message."+prefKey+".value", -1);
-    }
-
-    /**
-     * sets the value for the preference key "message." + <code>prefKey</code> + ".value".
-     *
-     * @param prefKey the key
-     * @param value the value
-     */
-    public static void setDialogReturnValue(String prefKey, Integer value) {
-        Main.pref.putInteger("message."+prefKey+".value", value);
+    public static int getDialogReturnValue(String prefKey) {
+        return Utils.firstNonNull(
+                immediateChoices.get(prefKey),
+                sessionChoices.get(prefKey),
+                !Main.pref.getBoolean("message." + prefKey, true) ? Main.pref.getInteger("message." + prefKey + ".value", -1) : -1
+        );
+    }
+
+    /**
+     * Marks the beginning of a bulk operation in order to provide a "Do not show again (this operation)" option.
+     * @param prefKey the preference key
+     */
+    public static void startBulkOperation(final String prefKey) {
+        immediateActive.add(prefKey);
+    }
+
+    /**
+     * Marks the ending of a bulk operation. Removes the "Do not show again (this operation)" result value.
+     * @param prefKey the preference key
+     */
+    public static void endBulkOperation(final String prefKey) {
+        immediateActive.remove(prefKey);
+        immediateChoices.remove(prefKey);
     }
 
@@ -104 +107 @@
     static public int showOptionDialog(String preferenceKey, Component parent, Object message, String title, int optionType, int messageType, Object [] options, Object defaultOption) throws HeadlessException {
         int ret = getDialogReturnValue(preferenceKey);
-        if (!getDialogShowingEnabled(preferenceKey) && ((ret == JOptionPane.YES_OPTION) || (ret == JOptionPane.NO_OPTION)))
+        if (isYesOrNo(ret))
             return ret;
-        MessagePanel pnl = new MessagePanel(false, message);
+        MessagePanel pnl = new MessagePanel(message, immediateActive.contains(preferenceKey));
         ret = JOptionPane.showOptionDialog(parent, pnl, title, optionType, messageType, null, options, defaultOption);
-
-        if (((ret == JOptionPane.YES_OPTION) || (ret == JOptionPane.NO_OPTION)) && !pnl.getDialogShowingEnabled()) {
-            setDialogShowingEnabled(preferenceKey, false);
-            setDialogReturnValue(preferenceKey, ret);
+        if (isYesOrNo(ret)) {
+            pnl.getNotShowAgain().store(preferenceKey, ret);
         }
         return ret;
@@ -149 +150 @@
     static public boolean showConfirmationDialog(String preferenceKey, Component parent, Object message, String title, int optionType, int messageType, int trueOption) throws HeadlessException {
         int ret = getDialogReturnValue(preferenceKey);
-        if (!getDialogShowingEnabled(preferenceKey) && ((ret == JOptionPane.YES_OPTION) || (ret == JOptionPane.NO_OPTION)))
+        if (isYesOrNo(ret))
             return ret == trueOption;
-        MessagePanel pnl = new MessagePanel(false, message);
+        MessagePanel pnl = new MessagePanel(message, immediateActive.contains(preferenceKey));
         ret = JOptionPane.showConfirmDialog(parent, pnl, title, optionType, messageType);
-        if (((ret == JOptionPane.YES_OPTION) || (ret == JOptionPane.NO_OPTION)) && !pnl.getDialogShowingEnabled()) {
-            setDialogShowingEnabled(preferenceKey, false);
-            setDialogReturnValue(preferenceKey, ret);
+        if ((isYesOrNo(ret))) {
+            pnl.getNotShowAgain().store(preferenceKey, ret);
         }
         return ret == trueOption;
+    }
+
+    private static boolean isYesOrNo(int returnCode) {
+        return (returnCode == JOptionPane.YES_OPTION) || (returnCode == JOptionPane.NO_OPTION);
     }
 
@@ -179 +183 @@
      */
     static public void showMessageDialog(String preferenceKey, Component parent, Object message, String title,int messageType) {
-        if (!getDialogShowingEnabled(preferenceKey))
+        if (getDialogReturnValue(preferenceKey) == Integer.MAX_VALUE)
             return;
-        MessagePanel pnl = new MessagePanel(false, message);
+        MessagePanel pnl = new MessagePanel(message, immediateActive.contains(preferenceKey));
         JOptionPane.showMessageDialog(parent, pnl, title, messageType);
-        if(!pnl.getDialogShowingEnabled()) {
-            setDialogShowingEnabled(preferenceKey, false);
+        pnl.getNotShowAgain().store(preferenceKey, Integer.MAX_VALUE);
+    }
+
+    /**
+     * An enum designating how long to not show this message again, i.e., for how long to store
+     */
+    static enum NotShowAgain {
+        NO, OPERATION, SESSION, PERMANENT;
+
+        /**
+         * Stores the dialog result {@code value} at the corresponding place.
+         * @param prefKey the preference key
+         * @param value the dialog result
+         */
+        void store(String prefKey, Integer value) {
+            switch (this) {
+                case NO:
+                    break;
+                case OPERATION:
+                    immediateChoices.put(prefKey, value);
+                    break;
+                case SESSION:
+                    sessionChoices.put(prefKey, value);
+                    break;
+                case PERMANENT:
+                    Main.pref.put("message." + prefKey, false);
+                    Main.pref.putInteger("message." + prefKey + ".value", value);
+                    break;
+            }
+        }
+
+        String getLabel() {
+            switch (this) {
+                case NO:
+                    return tr("Show this dialog again the next time");
+                case OPERATION:
+                    return tr("Do not show again (this operation)");
+                case SESSION:
+                    return tr("Do not show again (this session)");
+                case PERMANENT:
+                    return tr("Do not show again (remembers choice)");
+            }
+            throw new IllegalStateException();
         }
     }
@@ -195 +240 @@
      *
      */
-    private static class MessagePanel extends JPanel {
-        JCheckBox cbShowDialog;
-
-        public MessagePanel(boolean donotshow, Object message) {
-            cbShowDialog = new JCheckBox(tr("Do not show again (remembers choice)"));
-            cbShowDialog.setSelected(donotshow);
+    static class MessagePanel extends JPanel {
+        private final ButtonGroup group = new ButtonGroup();
+        private final JRadioButton cbShowPermanentDialog = new JRadioButton(NotShowAgain.PERMANENT.getLabel());
+        private final JRadioButton cbShowSessionDialog = new JRadioButton(NotShowAgain.SESSION.getLabel());
+        private final JRadioButton cbShowImmediateDialog = new JRadioButton(NotShowAgain.OPERATION.getLabel());
+        private final JRadioButton cbStandard = new JRadioButton(NotShowAgain.NO.getLabel());
+
+        /**
+         * Constructs a new panel.
+         * @param message the the message (null to add no message, Component instances are added directly, otherwise a JLabel with the string representation is added)
+         * @param displayImmediateOption whether to provide "Do not show again (this session)"
+         */
+        public MessagePanel(Object message, boolean displayImmediateOption) {
+            cbStandard.setSelected(true);
+            group.add(cbShowPermanentDialog);
+            group.add(cbShowSessionDialog);
+            group.add(cbShowImmediateDialog);
+            group.add(cbStandard);
+
             setLayout(new GridBagLayout());
-
             if (message instanceof Component) {
-                add((Component)message, GBC.eop());
-            } else {
-                add(new JLabel(message.toString()),GBC.eop());
-            }
-            add(cbShowDialog, GBC.eol());
-        }
-
-        public boolean getDialogShowingEnabled() {
-            return !cbShowDialog.isSelected();
+                add((Component) message, GBC.eop());
+            } else if (message != null) {
+                add(new JLabel(message.toString()), GBC.eop());
+            }
+            add(cbShowPermanentDialog, GBC.eol());
+            add(cbShowSessionDialog, GBC.eol());
+            if (displayImmediateOption) {
+                add(cbShowImmediateDialog, GBC.eol());
+            }
+            add(cbStandard, GBC.eol());
+        }
+
+        NotShowAgain getNotShowAgain() {
+            return cbStandard.isSelected()
+                    ? NotShowAgain.NO
+                    : cbShowImmediateDialog.isSelected()
+                    ? NotShowAgain.OPERATION
+                    : cbShowSessionDialog.isSelected()
+                    ? NotShowAgain.SESSION
+                    : cbShowPermanentDialog.isSelected()
+                    ? NotShowAgain.PERMANENT
+                    : null;
         }
     }

trunk/src/org/openstreetmap/josm/gui/ExtendedDialog.java

@@ -20 +20 @@
 import javax.swing.Icon;
 import javax.swing.JButton;
-import javax.swing.JCheckBox;
 import javax.swing.JComponent;
 import javax.swing.JDialog;
@@ -79 +78 @@
     private String togglePref = "";
     private int toggleValue = -1;
-    private String toggleCheckboxText = tr("Do not show again (remembers choice)");
-    private JCheckBox toggleCheckbox = null;
+    private ConditionalOptionPaneUtil.MessagePanel togglePanel;
     private Component parent;
     private Component content;
@@ -372 +370 @@
 
         if (toggleable) {
-            toggleCheckbox = new JCheckBox(toggleCheckboxText);
-            boolean showDialog = Main.pref.getBoolean("message."+ togglePref, true);
-            toggleCheckbox.setSelected(!showDialog);
+            togglePanel = new ConditionalOptionPaneUtil.MessagePanel(null, false);
             gc.gridx = icon != null ? 1 : 0;
             gc.gridy = y++;
             gc.anchor = GridBagConstraints.LINE_START;
             gc.insets = new Insets(5,contentInsets.left,5,contentInsets.right);
-            cp.add(toggleCheckbox, gc);
+            cp.add(togglePanel, gc);
         }
 
@@ -546 +542 @@
 
     /**
-     * Overwrites the default "Don't show again" text of the toggle checkbox
-     * if you want to give more information. Only has an effect if
-     * <code>toggleEnable</code> is set.
-     * @param text The toggle checkbox text
-     * @return {@code this}
-     */
-    public ExtendedDialog setToggleCheckboxText(String text) {
-        this.toggleCheckboxText = text;
-        return this;
-    }
-
-    /**
      * Sets the button that will react to ENTER.
      * @param defaultButtonIdx The button index (starts to )
@@ -597 +581 @@
     public final boolean toggleCheckState() {
         toggleable = togglePref != null && !togglePref.isEmpty();
-
-        toggleValue = Main.pref.getInteger("message."+togglePref+".value", -1);
-        // No identifier given, so return false (= show the dialog)
-        if (!toggleable || toggleValue == -1)
-            return false;
-        // The pref is true, if the dialog should be shown.
-        return !(Main.pref.getBoolean("message."+ togglePref, true));
+        toggleValue = ConditionalOptionPaneUtil.getDialogReturnValue(togglePref);
+        return toggleable && toggleValue != -1;
     }
 
@@ -612 +591 @@
     private void toggleSaveState() {
         if (!toggleable ||
-                toggleCheckbox == null ||
+                togglePanel == null ||
                 cancelButtonIdx.contains(result) ||
                 result == ExtendedDialog.DialogClosedOtherwise)
             return;
-        Main.pref.put("message."+ togglePref, !toggleCheckbox.isSelected());
-        Main.pref.putInteger("message."+togglePref+".value", result);
+        togglePanel.getNotShowAgain().store(togglePref, result);
     }
 

trunk/src/org/openstreetmap/josm/gui/dialogs/relation/GenericRelationEditor.java

@@ -768 +768 @@
                 return primitives;
             List<OsmPrimitive> ret = new ArrayList<OsmPrimitive>();
+            ConditionalOptionPaneUtil.startBulkOperation("add_primitive_to_relation");
             for (OsmPrimitive primitive : primitives) {
                 if (primitive instanceof Relation && getRelation() != null && getRelation().equals(primitive)) {
@@ -782 +783 @@
                 }
             }
+            ConditionalOptionPaneUtil.endBulkOperation("add_primitive_to_relation");
             return ret;
         }

trunk/src/org/openstreetmap/josm/gui/io/UploadDialog.java

@@ -458 +458 @@
             dlg.setIcon(JOptionPane.WARNING_MESSAGE);
             dlg.toggleEnable(togglePref);
-            dlg.setToggleCheckboxText(tr("Do not show this message again"));
             dlg.setCancelButton(1, 2);
             return dlg.showDialog().getValue() != 3;