Adds StandardMessageDialog

Adds "blocking" code to StandardDialog
Adds a getResult message to StandardQuestionDialog
Removes all uses of JOptionPane from the swing UI

Fixes issue 3663

Change-Id: Id91412c262d4bb812ffbfe6eef72d8ca99cd40f0
Reviewed-on: http://gerrit.dmdirc.com/710
Automatic-Compile: Shane Mc Cormack <shane@dmdirc.com>
Reviewed-by: Shane Mc Cormack <shane@dmdirc.com>

src/com/dmdirc/addons/ui_swing/SwingController.java

@@ -38,6 +38,8 @@ import com.dmdirc.addons.ui_swing.components.statusbar.FeedbackNag;
 import com.dmdirc.addons.ui_swing.components.statusbar.SwingStatusBar;
 import com.dmdirc.addons.ui_swing.components.themepanel.ThemePanel;
 import com.dmdirc.addons.ui_swing.dialogs.DialogKeyListener;
+import com.dmdirc.addons.ui_swing.dialogs.StandardInputDialog;
+import com.dmdirc.addons.ui_swing.dialogs.StandardMessageDialog;
 import com.dmdirc.addons.ui_swing.dialogs.channelsetting.ChannelSettingsDialog;
 import com.dmdirc.addons.ui_swing.dialogs.error.ErrorListDialog;
 import com.dmdirc.addons.ui_swing.dialogs.prefs.SwingPreferencesDialog;
@@ -58,6 +60,7 @@ import com.dmdirc.config.prefs.PreferencesInterface;
 import com.dmdirc.config.prefs.PreferencesManager;
 import com.dmdirc.config.prefs.PreferencesSetting;
 import com.dmdirc.config.prefs.PreferencesType;
+import com.dmdirc.config.prefs.validator.NotEmptyValidator;
 import com.dmdirc.config.prefs.validator.NumericalValidator;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
@@ -73,6 +76,7 @@ import com.dmdirc.ui.interfaces.UIController;
 import com.dmdirc.ui.interfaces.Window;
 import com.dmdirc.updater.Update;
 import com.dmdirc.util.ReturnableThread;
+import java.awt.Dialog.ModalityType;
 
 import java.awt.Font;
 import java.awt.GraphicsEnvironment;
@@ -86,7 +90,6 @@ import java.util.Map;
 import java.util.concurrent.Semaphore;
 
 import java.util.concurrent.atomic.AtomicBoolean;
-import javax.swing.JOptionPane;
 import javax.swing.SwingUtilities;
 import javax.swing.UIManager;
 import javax.swing.UIManager.LookAndFeelInfo;
@@ -163,7 +166,7 @@ public final class SwingController extends Plugin implements UIController {
 
     /**
      * Retrieves the Swing Status Bar used by this UI.
-     * 
+     *
      * @return This UI's status bar
      */
     public SwingStatusBar getSwingStatusBar() {
@@ -268,7 +271,7 @@ public final class SwingController extends Plugin implements UIController {
 
     /**
      * Shows a first run wizard, or a migration wizard.
-     * 
+     *
      * @param firstRun First run?
      */
     private synchronized void showFirstRunWizard(final boolean firstRun) {
@@ -373,20 +376,16 @@ public final class SwingController extends Plugin implements UIController {
             });
         } catch (ClassNotFoundException ex) {
             Logger.userError(ErrorLevel.LOW,
-                    "Unable to change Look and Feel: " +
-                    ex.getMessage());
+                    "Unable to change Look and Feel: " + ex.getMessage());
         } catch (InstantiationException ex) {
             Logger.userError(ErrorLevel.LOW,
-                    "Unable to change Look and Feel: " +
-                    ex.getMessage());
+                    "Unable to change Look and Feel: " + ex.getMessage());
         } catch (IllegalAccessException ex) {
             Logger.userError(ErrorLevel.LOW,
-                    "Unable to change Look and Feel: " +
-                    ex.getMessage());
+                    "Unable to change Look and Feel: " + ex.getMessage());
         } catch (UnsupportedLookAndFeelException ex) {
             Logger.userError(ErrorLevel.LOW,
-                    "Unable to change Look and Feel: " +
-                    ex.getMessage());
+                    "Unable to change Look and Feel: " + ex.getMessage());
         }
     }
 
@@ -439,8 +438,8 @@ public final class SwingController extends Plugin implements UIController {
 
     /**
      * {@inheritDoc}
-     * 
-     * @deprecated 
+     *
+     * @deprecated
      */
     @Override
     @Deprecated
@@ -450,8 +449,8 @@ public final class SwingController extends Plugin implements UIController {
 
     /**
      * {@inheritDoc}
-     * 
-     * @deprecated 
+     *
+     * @deprecated
      */
     @Override
     @Deprecated
@@ -516,8 +515,8 @@ public final class SwingController extends Plugin implements UIController {
             /** {@inheritDoc} */
             @Override
             public void run() {
-                JOptionPane.showMessageDialog(null, message, title,
-                        JOptionPane.PLAIN_MESSAGE);
+                new StandardMessageDialog(me, ModalityType.MODELESS, title,
+                        message).display();
             }
         });
     }
@@ -532,7 +531,29 @@ public final class SwingController extends Plugin implements UIController {
     /** {@inheritDoc} */
     @Override
     public String getUserInput(final String prompt) {
-        return JOptionPane.showInputDialog(prompt);
+        final StandardInputDialog dialog = new StandardInputDialog(me,
+                ModalityType.MODELESS, "Input required", prompt,
+                new NotEmptyValidator()) {
+
+            /**
+             * A version number for this class. It should be changed whenever the class
+             * structure is changed (or anything else that would prevent serialized
+             * objects being unserialized with the new class).
+             */
+            private static final long serialVersionUID = 1;
+
+            /** {@inheritDoc} */
+            @Override
+            public boolean save() {
+                return true;
+            }
+
+            /** {@inheritDoc} */
+            @Override
+            public void cancelled() {}
+        };
+        dialog.displayBlocking();
+        return dialog.getText();
     }
 
     /** {@inheritDoc} */
@@ -589,7 +610,7 @@ public final class SwingController extends Plugin implements UIController {
 
     /**
      * Returns the current look and feel.
-     * 
+     *
      * @return Current look and feel
      */
     public static String getLookAndFeel() {
@@ -628,10 +649,10 @@ public final class SwingController extends Plugin implements UIController {
         }
 
         if (System.getProperty("java.vm.name", "unknown").contains("OpenJDK")) {
-            JOptionPane.showMessageDialog(null, "OpenJDK has known graphical " +
-                    "issues and as such is unsupported by DMDirc.  Please " +
-                    "consider using the official JRE.", "Unsupported JRE",
-                    JOptionPane.WARNING_MESSAGE);
+            new StandardMessageDialog(me, ModalityType.MODELESS,
+                    "Unsupported JRE", "OpenJDK has known graphical "
+                    + "issues and as such is unsupported by DMDirc.  Please "
+                    + "consider using the official JRE.").display();
         }
 
         Main.setUI(this);
@@ -676,8 +697,8 @@ public final class SwingController extends Plugin implements UIController {
      */
     private PreferencesCategory createGeneralCategory() {
         final PreferencesCategory general = new PluginPreferencesCategory(
-                getPluginInfo(), "Swing UI", "These config options apply " +
-                "only to the swing UI.", "category-gui");
+                getPluginInfo(), "Swing UI", "These config options apply "
+                + "only to the swing UI.", "category-gui");
 
         final Map<String, String> lafs = new HashMap<String, String>();
         final Map<String, String> framemanagers = new HashMap<String, String>();
@@ -708,8 +729,8 @@ public final class SwingController extends Plugin implements UIController {
                 "Window manager", "Which window manager should be used?",
                 framemanagers).setRestartNeeded());
         general.addSetting(new PreferencesSetting("ui", "framemanagerPosition",
-                "Window manager position", "Where should the window " +
-                "manager be positioned?", fmpositions).setRestartNeeded());
+                "Window manager position", "Where should the window "
+                + "manager be positioned?", fmpositions).setRestartNeeded());
         general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
                 "ui", "stylelinks", "Style links", "Style links in text areas"));
         general.addSetting(new PreferencesSetting(PreferencesType.FONT,
@@ -740,8 +761,8 @@ public final class SwingController extends Plugin implements UIController {
 
         advanced.addSetting(new PreferencesSetting(PreferencesType.INTEGER,
                 new NumericalValidator(10, -1), "ui", "frameBufferSize",
-                "Window buffer size", "The maximum number of lines in a window" +
-                " buffer"));
+                "Window buffer size", "The maximum number of lines in a window"
+                + " buffer"));
         advanced.addSetting(new PreferencesSetting("ui", "mdiBarVisibility",
                 "MDI Bar Visibility", "Controls the visibility of the MDI bar",
                 options));
@@ -749,26 +770,29 @@ public final class SwingController extends Plugin implements UIController {
                 new PreferencesSetting(PreferencesType.BOOLEAN, "ui",
                 "useOneTouchExpandable", "Use one touch expandable split panes?",
                 "Use one touch expandable arrows for collapsing/expanding the split panes"));
-       advanced.addSetting(new PreferencesSetting(PreferencesType.INTEGER, getDomain(),
-               "windowMenuItems", "Window menu item count",
-               "Number of items to show in the window menu"));
-       advanced.addSetting(new PreferencesSetting(PreferencesType.INTEGER, getDomain(),
-               "windowMenuScrollInterval", "Window menu scroll interval",
-               "Number of milliseconds to pause when autoscrolling in the window menu"));
-       advanced.addSetting(
+        advanced.addSetting(new PreferencesSetting(PreferencesType.INTEGER,
+                getDomain(), "windowMenuItems", "Window menu item count",
+                "Number of items to show in the window menu"));
+        advanced.addSetting(
+                new PreferencesSetting(PreferencesType.INTEGER, getDomain(),
+                "windowMenuScrollInterval", "Window menu scroll interval",
+                "Number of milliseconds to pause when autoscrolling in the window menu"));
+        advanced.addSetting(
                 new PreferencesSetting(PreferencesType.BOOLEAN, getDomain(),
                 "showtopicbar", "Show topic bar",
                 "Shows a graphical topic bar in channels."));
-        advanced.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN, getDomain(),
-               "shownicklist", "Show nicklist?", "Do you want the nicklist visible"));
+        advanced.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
+                getDomain(),
+                "shownicklist", "Show nicklist?",
+                "Do you want the nicklist visible"));
         //TODO issue 3251
         //advanced.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN, getDomain(),
         //       "showfulltopic", "Show full topic in topic bar?",
         //       "Do you want to show the full topic in the topic bar or just" +
         //       "first line?"));
-        advanced.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN, 
+        advanced.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
                 getDomain(), "hideEmptyTopicBar", "Hide empty topic bar?",
-               "Do you want to hide the topic bar when there is no topic"));
+                "Do you want to hide the topic bar when there is no topic"));
 
         return advanced;
     }
@@ -845,7 +869,7 @@ public final class SwingController extends Plugin implements UIController {
 
     /**
      * Adds a top level window to the window list.
-     * 
+     *
      * @param source New window
      */
     protected void addTopLevelWindow(final java.awt.Window source) {
@@ -856,7 +880,7 @@ public final class SwingController extends Plugin implements UIController {
 
     /**
      * Deletes a top level window to the window list.
-     * 
+     *
      * @param source Old window
      */
     protected void delTopLevelWindow(final java.awt.Window source) {

src/com/dmdirc/addons/ui_swing/components/SwingSearchBar.java

@@ -30,6 +30,7 @@ import com.dmdirc.ui.interfaces.SearchBar;
 import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.addons.ui_swing.actions.SearchAction;
 import com.dmdirc.addons.ui_swing.components.validating.ValidatingJTextField;
+import com.dmdirc.addons.ui_swing.dialogs.StandardQuestionDialog;
 import com.dmdirc.addons.ui_swing.textpane.IRCDocument;
 import com.dmdirc.addons.ui_swing.textpane.IRCDocumentSearcher;
 import com.dmdirc.addons.ui_swing.textpane.LinePosition;
@@ -38,6 +39,7 @@ import com.dmdirc.config.IdentityManager;
 import com.dmdirc.config.prefs.validator.Validator;
 import com.dmdirc.interfaces.ConfigChangeListener;
 import com.dmdirc.util.ListenerList;
+import java.awt.Dialog.ModalityType;
 
 import java.awt.Window;
 import java.awt.event.ActionEvent;
@@ -48,7 +50,6 @@ import java.awt.event.KeyListener;
 import javax.swing.JButton;
 import javax.swing.JCheckBox;
 import javax.swing.JComponent;
-import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 import javax.swing.KeyStroke;
 import javax.swing.SwingUtilities;
@@ -92,7 +93,7 @@ public final class SwingSearchBar extends JPanel implements ActionListener,
 
     /**
      * Creates a new instance of StatusBar.
-     * 
+     *
      * @param newParent parent frame for the dialog
      * @param parentWindow Parent window
      */
@@ -253,15 +254,32 @@ public final class SwingSearchBar extends JPanel implements ActionListener,
                 && ((up && result.getEndLine() > textPane.getSelectedRange().
                 getEndLine())
                 || (!up && result.getStartLine() < textPane.getSelectedRange().
-                getStartLine()))
-                && JOptionPane.showConfirmDialog(parentWindow,
-                "Do you want to continue searching from the " + (up ? "end"
-                : "beginning") + "?",
-                "No more results", JOptionPane.OK_CANCEL_OPTION,
-                JOptionPane.QUESTION_MESSAGE) != JOptionPane.OK_OPTION) {
-            // It's wrapped, and they don't want to continue searching
-
-            foundText = false;
+                getStartLine()))) {
+            final StandardQuestionDialog dialog = new StandardQuestionDialog(
+                    parentWindow, ModalityType.MODELESS, "No more results",
+                    "Do you want to continue searching from the "
+                    + (up ? "end" : "beginning") + "?") {
+
+                /**
+                 * A version number for this class. It should be changed whenever the class
+                 * structure is changed (or anything else that would prevent serialized
+                 * objects being unserialized with the new class).
+                 */
+                 private static final long serialVersionUID = 1;
+
+                 /**{@inheritDoc} */
+                 @Override
+                 public boolean save() {
+                     return true;
+                 }
+
+                 @Override
+                 public void cancelled() {
+                     //Continue
+                 }
+            };
+            dialog.displayBlocking();
+            foundText = dialog.getResult();
         } else {
             //found, select and return found
             textPane.setScrollBarPosition(result.getEndLine());

src/com/dmdirc/addons/ui_swing/dialogs/StandardDialog.java

@@ -31,9 +31,11 @@ import java.awt.Frame;
 import java.awt.Window;
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;
+import java.util.concurrent.Semaphore;
 
 import javax.swing.JButton;
 import javax.swing.JDialog;
+import javax.swing.SwingUtilities;
 
 /**
  * Provides common methods for dialogs.
@@ -107,7 +109,7 @@ public class StandardDialog extends JDialog {
      *
      * @param owner Window to center on
      */
-    public void display(Component owner) {
+    public void display(final Component owner) {
         addWindowListener(new WindowAdapter() {
 
             /** {@inheritDoc} */
@@ -122,6 +124,34 @@ public class StandardDialog extends JDialog {
         setVisible(true);
     }
 
+    /**
+     * Displays the dialog centering on the parent window, blocking until
+     * complete.
+     */
+    public void displayBlocking() {
+        displayBlocking(owner);
+    }
+
+    /**
+     * Displays the dialog centering on the specified window, blocking until
+     * complete.
+     *
+     * @param owner Window to center on
+     */
+    public void displayBlocking(final Component owner) {
+        SwingUtilities.invokeLater(new Runnable() {
+
+            /** {@inheritDoc} */
+            @Override
+            public void run() {
+                display(owner);
+            }
+        });
+        while (isVisible()) {
+            Thread.yield();
+        }
+    }
+
 
     /**
      * Centres this dialog on its owner, or the screen if no owner is present.

src/com/dmdirc/addons/ui_swing/dialogs/StandardMessageDialog.java

@@ -0,0 +1,141 @@
+/*
+ * 
+ * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.addons.ui_swing.dialogs;
+
+import com.dmdirc.addons.ui_swing.components.text.TextLabel;
+
+import java.awt.Window;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowEvent;
+
+import javax.swing.JButton;
+
+import net.miginfocom.swing.MigLayout;
+
+/**
+ * Abstract standard dialog for showing messages.
+ */
+public class StandardMessageDialog extends StandardDialog {
+
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 1;
+    /** Blurb label. */
+    private TextLabel blurb;
+    /** Message. */
+    private String message;
+
+    /**
+     * Instantiates a new standard input dialog.
+     *
+     * @param owner Dialog owner
+     * @param modal modality type
+     * @param title Dialog title
+     * @param message Dialog message
+     */
+    public StandardMessageDialog(Window owner, ModalityType modal,
+            final String title, final String message) {
+        super(owner, modal);
+
+        this.message = message;
+
+        setTitle(title);
+        setDefaultCloseOperation(StandardInputDialog.DISPOSE_ON_CLOSE);
+
+        initComponents();
+        addListeners();
+        layoutComponents();
+    }
+
+    /**
+     * Called when the dialog's OK button is clicked.
+     *
+     * @return whether the dialog can close
+     */
+    public boolean save() {
+        return true;
+    }
+
+    /**
+     * Called when the dialog's cancel button is clicked, or otherwise closed.
+     */
+    public void cancelled() {
+    }
+
+    /**
+     * Initialises the components.
+     */
+    private final void initComponents() {
+        orderButtons(new JButton(), new JButton());
+        getOkButton().setText("OK");
+        blurb = new TextLabel(message);
+    }
+
+    /**
+     * Adds the listeners
+     */
+    private final void addListeners() {
+        final ActionListener listener = new ActionListener() {
+
+            /** {@inheritDoc} */
+            @Override
+            public void actionPerformed(ActionEvent e) {
+                if (save()) {
+                    dispose();
+                }
+            }
+        };
+        getCancelButton().addActionListener(listener);
+        getOkButton().addActionListener(listener);
+        addWindowListener(new WindowAdapter() {
+
+            /** {@inheritDoc} */
+            @Override
+            public void windowOpened(WindowEvent e) {
+                //Ignore
+            }
+
+            /** {@inheritDoc} */
+            @Override
+            public void windowClosed(WindowEvent e) {
+                cancelled();
+            }
+        });
+    }
+
+    /**
+     * Lays out the components.
+     */
+    private final void layoutComponents() {
+        setLayout(new MigLayout("fill, wrap 1, hidemode 3"));
+
+        add(blurb, "growx");
+        add(getOkButton(), "right");
+    }
+}

src/com/dmdirc/addons/ui_swing/dialogs/StandardQuestionDialog.java

@@ -43,6 +43,8 @@ public abstract class StandardQuestionDialog extends StandardDialog {
     private TextLabel blurb;
     /** Message. */
     private String message;
+    /** Question result. */
+    private boolean result = false;
 
     /**
      * Instantiates a new standard input dialog.
@@ -98,6 +100,7 @@ public abstract class StandardQuestionDialog extends StandardDialog {
             @Override
             public void actionPerformed(ActionEvent e) {
                 if (save()) {
+                    result = true;
                     dispose();
                 }
             }
@@ -137,4 +140,13 @@ public abstract class StandardQuestionDialog extends StandardDialog {
         add(getLeftButton(), "split 2, right");
         add(getRightButton(), "right");
     }
+
+    /**
+     * Returns the result of the question.
+     *
+     * @return true iif the user pressed Yes
+     */
+    public boolean getResult() {
+        return result;
+    }
 }

src/com/dmdirc/addons/ui_swing/dialogs/profiles/ProfileDetailPanel.java

@@ -46,7 +46,6 @@ import javax.swing.BorderFactory;
 import javax.swing.DefaultListModel;
 import javax.swing.JButton;
 import javax.swing.JLabel;
-import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.border.Border;