JAL-4214 Close modal internal frame if JRootPane activity detected. Problem with...
[jalview.git] / src / jalview / gui / JvOptionPane.java
index 752f25c..5da37fe 100644 (file)
@@ -18,7 +18,6 @@
  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
-
 package jalview.gui;
 
 import java.awt.AWTEvent;
@@ -37,12 +36,13 @@ import java.awt.event.MouseAdapter;
 import java.awt.event.MouseMotionAdapter;
 import java.beans.PropertyChangeEvent;
 import java.beans.PropertyChangeListener;
+import java.beans.PropertyVetoException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.concurrent.Callable;
+import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 
 import javax.swing.Icon;
@@ -58,6 +58,9 @@ import javax.swing.UIManager;
 import javax.swing.event.InternalFrameEvent;
 import javax.swing.event.InternalFrameListener;
 
+import jalview.bin.Console;
+import jalview.util.ChannelProperties;
+import jalview.util.MessageManager;
 import jalview.util.Platform;
 import jalview.util.dialogrunner.DialogRunnerI;
 
@@ -70,19 +73,27 @@ public class JvOptionPane extends JOptionPane
 
   private static boolean interactiveMode = true;
 
+  public static final Runnable NULLCALLABLE = () -> {
+  };
+
   private Component parentComponent;
 
-  private Map<Object, Callable<Void>> callbacks = new HashMap<>();
+  private ExecutorService executor = Executors.newCachedThreadPool();
+
+  private JDialog dialog = null;
+
+  private Map<Object, Runnable> callbacks = new HashMap<>();
 
   /*
-   * JalviewJS reports user choice in the dialog as the selected
-   * option (text); this list allows conversion to index (int)
+   * JalviewJS reports user choice in the dialog as the selected option (text);
+   * this list allows conversion to index (int)
    */
   List<Object> ourOptions;
 
   public JvOptionPane(final Component parent)
   {
     this.parentComponent = Platform.isJS() ? this : parent;
+    this.setIcon(null);
   }
 
   public static int showConfirmDialog(Component parentComponent,
@@ -804,6 +815,7 @@ public class JvOptionPane extends JOptionPane
     if (!isInteractiveMode())
     {
       handleResponse(getMockResponse());
+      return;
     }
     // two uses:
     //
@@ -847,7 +859,7 @@ public class JvOptionPane extends JOptionPane
             initialValueButton = jb;
 
           int buttonAction = buttonActions[i];
-          Callable<Void> action = callbacks.get(buttonAction);
+          Runnable action = callbacks.get(buttonAction);
           jb.setText((String) o);
           jb.addActionListener(new ActionListener()
           {
@@ -876,7 +888,7 @@ public class JvOptionPane extends JOptionPane
               JOptionPane joptionpane = (JOptionPane) joptionpaneObject;
               joptionpane.setValue(buttonAction);
               if (action != null)
-                Executors.newSingleThreadExecutor().submit(action);
+                new Thread(action).start();
               joptionpane.transferFocusBackward();
               joptionpane.setVisible(false);
               // put focus and raise parent window if possible, unless cancel or
@@ -918,8 +930,8 @@ public class JvOptionPane extends JOptionPane
               useButtons ? initialValueButton : initialValue);
 
       /*
-       * In Java, the response is returned to this thread and handled here;
-       * (for Javascript, see propertyChange)
+       * In Java, the response is returned to this thread and handled here; (for
+       * Javascript, see propertyChange)
        */
       if (!Platform.isJS())
       /**
@@ -934,9 +946,9 @@ public class JvOptionPane extends JOptionPane
     else
     {
       /*
-       * This is java similar to the swingjs handling, with the callbacks
-       * attached to the button press of the dialog.  This means we can use
-       * a non-modal JDialog for the confirmation without blocking the GUI.
+       * This is java similar to the swingjs handling, with the callbacks attached to
+       * the button press of the dialog. This means we can use a non-modal JDialog for
+       * the confirmation without blocking the GUI.
        */
       JOptionPane joptionpane = new JOptionPane();
       // Make button options
@@ -965,7 +977,8 @@ public class JvOptionPane extends JOptionPane
 
       ArrayList<JButton> options_btns = new ArrayList<>();
       Object initialValue_btn = null;
-      if (!Platform.isJS()) // JalviewJS already uses callback, don't need to add them here
+      if (!Platform.isJS()) // JalviewJS already uses callback, don't need to
+                            // add them here
       {
         for (int i = 0; i < options.length && i < 3; i++)
         {
@@ -976,12 +989,13 @@ public class JvOptionPane extends JOptionPane
           jb.setText((String) o);
           jb.addActionListener(new ActionListener()
           {
+
             @Override
             public void actionPerformed(ActionEvent e)
             {
               joptionpane.setValue(buttonAction);
               if (action != null)
-                Executors.defaultThreadFactory().newThread(action).start();
+                new Thread(action).start();
               // joptionpane.transferFocusBackward();
               joptionpane.transferFocusBackward();
               joptionpane.setVisible(false);
@@ -1028,15 +1042,16 @@ public class JvOptionPane extends JOptionPane
               Platform.isJS() ? initialValue : initialValue_btn);
 
       JDialog dialog = joptionpane.createDialog(parentComponent, title);
-      dialog.setIconImage(WindowIcons.logoIcon.getImage());
+      dialog.setIconImages(ChannelProperties.getIconList());
       dialog.setModalityType(modal ? ModalityType.APPLICATION_MODAL
               : ModalityType.MODELESS);
       dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
       dialog.setVisible(true);
+      setDialog(dialog);
     }
   }
 
-  public void showInternalDialog(JPanel mainPanel, String title,
+  public void showInternalDialog(Object mainPanel, String title,
           int yesNoCancelOption, int questionMessage, Icon icon,
           Object[] options, String initresponse)
   {
@@ -1054,47 +1069,56 @@ public class JvOptionPane extends JOptionPane
     this.setMessage(mainPanel);
 
     ourOptions = Arrays.asList(options);
-    int response;
-    if (parentComponent != this)
+    if (parentComponent != this
+            && !(parentComponent == null && Desktop.instance == null))
     {
-      JInternalFrame jif = this.createInternalFrame(parentComponent, title);
-      jif.setFrameIcon(WindowIcons.logoIcon);
+      JInternalFrame jif = this.createInternalFrame(
+              parentComponent != null ? parentComponent : Desktop.instance,
+              title);
+      jif.setFrameIcon(null);
       jif.addInternalFrameListener(new InternalFrameListener()
       {
         @Override
         public void internalFrameActivated(InternalFrameEvent arg0)
         {
+          System.err.println("##### internalFrameActivated");
         }
 
         @Override
         public void internalFrameClosed(InternalFrameEvent arg0)
         {
+          System.err.println("##### internalFrameClosed");
           JvOptionPane.this.internalDialogHandleResponse();
         }
 
         @Override
         public void internalFrameClosing(InternalFrameEvent arg0)
         {
+          System.err.println("##### internalFrameClosing");
         }
 
         @Override
         public void internalFrameDeactivated(InternalFrameEvent arg0)
         {
+          System.err.println("##### internalFrameDeactivated");
         }
 
         @Override
         public void internalFrameDeiconified(InternalFrameEvent arg0)
         {
+          System.err.println("##### internalFrameDeiconified");
         }
 
         @Override
         public void internalFrameIconified(InternalFrameEvent arg0)
         {
+          System.err.println("##### internalFrameIconified");
         }
 
         @Override
         public void internalFrameOpened(InternalFrameEvent arg0)
         {
+          System.err.println("##### internalFrameOpened");
         }
       });
       jif.setVisible(true);
@@ -1104,7 +1128,7 @@ public class JvOptionPane extends JOptionPane
     else
     {
       JDialog dialog = this.createDialog(parentComponent, title);
-      dialog.setIconImage(WindowIcons.logoIcon.getImage());
+      dialog.setIconImages(ChannelProperties.getIconList());
       dialog.setVisible(true); // blocking
       this.internalDialogHandleResponse();
       return;
@@ -1128,27 +1152,31 @@ public class JvOptionPane extends JOptionPane
   }
 
   /*
+   * @Override public JvOptionPane setResponseHandler(Object response, Runnable
+   * action) { callbacks.put(response, new Callable<Void>() {
+   * 
+   * @Override public Void call() { action.run(); return null; } }); return this;
+   * }
+   */
   @Override
   public JvOptionPane setResponseHandler(Object response, Runnable action)
   {
-    callbacks.put(response, new Callable<Void>()
+    if (action == null)
     {
-      @Override
-      public Void call()
-      {
-        action.run();
-        return null;
-      }
-    });
+      action = NULLCALLABLE;
+    }
+    callbacks.put(response, action);
     return this;
   }
-  */
-  @Override
-  public JvOptionPane setResponseHandler(Object response,
-          Callable<Void> action)
+
+  public void setDialog(JDialog d)
   {
-    callbacks.put(response, action);
-    return this;
+    dialog = d;
+  }
+
+  public JDialog getDialog()
+  {
+    return dialog;
   }
 
   /**
@@ -1158,6 +1186,18 @@ public class JvOptionPane extends JOptionPane
   public static int showDialogOnTop(String label, String actionString,
           int JOPTIONPANE_OPTION, int JOPTIONPANE_MESSAGETYPE)
   {
+    return showDialogOnTop(null, label, actionString, JOPTIONPANE_OPTION,
+            JOPTIONPANE_MESSAGETYPE);
+  }
+
+  public static int showDialogOnTop(Component dialogParentComponent,
+          String label, String actionString, int JOPTIONPANE_OPTION,
+          int JOPTIONPANE_MESSAGETYPE)
+  {
+    if (!isInteractiveMode())
+    {
+      return (int) getMockResponse();
+    }
     // Ensure Jalview window is brought to front (primarily for Quit
     // confirmation window to be visible)
 
@@ -1168,13 +1208,23 @@ public class JvOptionPane extends JOptionPane
     // A better hack which works is to create a new JFrame parent with
     // setAlwaysOnTop(true)
     JFrame dialogParent = new JFrame();
-    dialogParent.setAlwaysOnTop(true);
+    if (dialogParentComponent == null)
+    {
+      dialogParent.setIconImages(ChannelProperties.getIconList());
+      dialogParent.setAlwaysOnTop(true);
+    }
 
-    int answer = JOptionPane.showConfirmDialog(dialogParent, label,
-            actionString, JOPTIONPANE_OPTION, JOPTIONPANE_MESSAGETYPE);
+    int answer = JOptionPane.showConfirmDialog(
+            dialogParentComponent == null ? dialogParent
+                    : dialogParentComponent,
+            label, actionString, JOPTIONPANE_OPTION,
+            JOPTIONPANE_MESSAGETYPE);
 
-    dialogParent.setAlwaysOnTop(false);
-    dialogParent.dispose();
+    if (dialogParentComponent == null)
+    {
+      dialogParent.setAlwaysOnTop(false);
+      dialogParent.dispose();
+    }
 
     return answer;
   }
@@ -1183,9 +1233,10 @@ public class JvOptionPane extends JOptionPane
           int JOPTIONPANE_OPTION, int JOPTIONPANE_MESSAGETYPE, Icon icon,
           Object[] options, Object initialValue, boolean modal)
   {
-    showDialogOnTopAsync(new JFrame(), label, actionString,
-            JOPTIONPANE_OPTION, JOPTIONPANE_MESSAGETYPE, icon, options,
-            initialValue, modal);
+    JFrame frame = new JFrame();
+    frame.setIconImages(ChannelProperties.getIconList());
+    showDialogOnTopAsync(frame, label, actionString, JOPTIONPANE_OPTION,
+            JOPTIONPANE_MESSAGETYPE, icon, options, initialValue, modal);
   }
 
   public void showDialogOnTopAsync(JFrame dialogParent, Object label,
@@ -1203,6 +1254,11 @@ public class JvOptionPane extends JOptionPane
           int JOPTIONPANE_MESSAGETYPE, Icon icon, Object[] options,
           Object initialValue, boolean modal, JButton[] buttons)
   {
+    if (!isInteractiveMode())
+    {
+      handleResponse(getMockResponse());
+      return;
+    }
     // Ensure Jalview window is brought to front (primarily for Quit
     // confirmation window to be visible)
 
@@ -1250,18 +1306,19 @@ public class JvOptionPane extends JOptionPane
   public void handleResponse(Object response)
   {
     /*
-    * this test is for NaN in Chrome
-    */
+     * this test is for NaN in Chrome
+     */
     if (response != null && !response.equals(response))
     {
       return;
     }
-    Callable<Void> action = callbacks.get(response);
+    Runnable action = callbacks.get(response);
     if (action != null)
     {
       try
       {
-        action.call();
+        new Thread(action).start();
+        // action.call();
       } catch (Exception e)
       {
         e.printStackTrace();
@@ -1287,6 +1344,11 @@ public class JvOptionPane extends JOptionPane
           Object[] options, Object initialValue, boolean modal,
           JButton[] buttons)
   {
+    if (!isInteractiveMode())
+    {
+      handleResponse(getMockResponse());
+      return null;
+    }
     JButton[] optionsButtons = null;
     Object initialValueButton = null;
     JOptionPane joptionpane = new JOptionPane();
@@ -1334,7 +1396,7 @@ public class JvOptionPane extends JOptionPane
       {
         Object o = options[i];
         int buttonAction = buttonActions[i];
-        Callable<Void> action = callbacks.get(buttonAction);
+        Runnable action = callbacks.get(buttonAction);
         JButton jb;
         if (buttons != null && buttons.length > i && buttons[i] != null)
         {
@@ -1352,7 +1414,7 @@ public class JvOptionPane extends JOptionPane
           {
             joptionpane.setValue(buttonAction);
             if (action != null)
-              Executors.newSingleThreadExecutor().submit(action);
+              new Thread(action).start();
             // joptionpane.transferFocusBackward();
             joptionpane.transferFocusBackward();
             joptionpane.setVisible(false);
@@ -1398,9 +1460,11 @@ public class JvOptionPane extends JOptionPane
             Platform.isJS() ? initialValue : initialValueButton);
 
     JDialog dialog = joptionpane.createDialog(parentComponent, title);
+    dialog.setIconImages(ChannelProperties.getIconList());
     dialog.setModalityType(
             modal ? ModalityType.APPLICATION_MODAL : ModalityType.MODELESS);
     dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
+    setDialog(dialog);
     return dialog;
   }
 
@@ -1448,7 +1512,8 @@ public class JvOptionPane extends JOptionPane
     EventQueue queue = Toolkit.getDefaultToolkit().getSystemEventQueue();
     try
     {
-      while (!f.isClosed())
+      boolean stillModal = true;
+      while (!f.isClosed() && stillModal)
       {
         if (EventQueue.isDispatchThread())
         {
@@ -1458,34 +1523,136 @@ public class JvOptionPane extends JOptionPane
           // This mimics EventQueue.dispatchEvent(). We can't use
           // EventQueue.dispatchEvent() directly, because it is
           // protected, unfortunately.
+          System.out.println(
+                  "##### ev source=" + ev.getSource().getClass() + "");
           if (ev instanceof ActiveEvent)
+          {
+            System.err.println("##### 1");
             ((ActiveEvent) ev).dispatch();
-          else if (ev.getSource() instanceof Component)
-            ((Component) ev.getSource()).dispatchEvent(ev);
+          }
           else if (ev.getSource() instanceof MenuComponent)
+          {
+            System.err.println("##### 2");
             ((MenuComponent) ev.getSource()).dispatchEvent(ev);
+          }
+          else if (ev.getSource() instanceof Component)
+          {
+            System.err.println("##### 3");
+            if (ev.getSource().equals(Desktop.getDesktop().getRootPane()))
+            {
+              stillModal = false;
+            }
+            else
+            {
+              ((Component) ev.getSource()).dispatchEvent(ev);
+            }
+          }
           // Other events are ignored as per spec in
           // EventQueue.dispatchEvent
+          System.err.println("##### 4");
         }
         else
         {
           // Give other threads a chance to become active.
+          System.err.println("##### 5");
           Thread.yield();
         }
       }
     } catch (InterruptedException ex)
     {
       // If we get interrupted, then leave the modal state.
+      System.err.println("##### 6");
     } finally
     {
+      System.err.println("##### 7");
       // Clean up the modal interceptor.
       lp.remove(modalInterceptor);
 
+      f.setVisible(false);
+
+      try
+      {
+        f.setClosed(true);
+      } catch (PropertyVetoException e)
+      {
+        f.doDefaultCloseAction();
+      }
+
       // Remove the internal frame from its parent, so it is no longer
       // lurking around and clogging memory.
       Container parent = f.getParent();
       if (parent != null)
+      {
         parent.remove(f);
+      }
     }
   }
+
+  public static JvOptionPane frameDialog(Object message, String title,
+          int messageType, String[] buttonsTextS, String defaultButtonS,
+          List<Runnable> handlers, boolean modal)
+  {
+    JFrame parent = new JFrame();
+    JvOptionPane jvop = JvOptionPane.newOptionDialog();
+    final String[] buttonsText;
+    final String defaultButton;
+    if (buttonsTextS == null)
+    {
+      String ok = MessageManager.getString("action.ok");
+      buttonsText = new String[] { ok };
+      defaultButton = ok;
+    }
+    else
+    {
+      buttonsText = buttonsTextS;
+      defaultButton = defaultButtonS;
+    }
+    JButton[] buttons = new JButton[buttonsText.length];
+    for (int i = 0; i < buttonsText.length; i++)
+    {
+      buttons[i] = new JButton();
+      buttons[i].setText(buttonsText[i]);
+      Console.debug("DISABLING BUTTON " + buttons[i].getText());
+      buttons[i].setEnabled(false);
+      buttons[i].setVisible(false);
+    }
+
+    int dialogType = -1;
+    if (buttonsText.length == 1)
+    {
+      dialogType = JOptionPane.OK_OPTION;
+    }
+    else if (buttonsText.length == 2)
+    {
+      dialogType = JOptionPane.YES_NO_OPTION;
+    }
+    else
+    {
+      dialogType = JOptionPane.YES_NO_CANCEL_OPTION;
+    }
+    jvop.setResponseHandler(JOptionPane.YES_OPTION,
+            (handlers != null && handlers.size() > 0) ? handlers.get(0)
+                    : NULLCALLABLE);
+    if (dialogType == JOptionPane.YES_NO_OPTION
+            || dialogType == JOptionPane.YES_NO_CANCEL_OPTION)
+    {
+      jvop.setResponseHandler(JOptionPane.NO_OPTION,
+              (handlers != null && handlers.size() > 1) ? handlers.get(1)
+                      : NULLCALLABLE);
+    }
+    if (dialogType == JOptionPane.YES_NO_CANCEL_OPTION)
+    {
+      jvop.setResponseHandler(JOptionPane.CANCEL_OPTION,
+              (handlers != null && handlers.size() > 2) ? handlers.get(2)
+                      : NULLCALLABLE);
+    }
+
+    final int dt = dialogType;
+    new Thread(() -> {
+      jvop.showDialog(message, title, dt, messageType, null, buttonsText,
+              defaultButton, modal, buttons);
+    }).start();
+
+    return jvop;
+  }
 }