JAL-3032 prefer Jalview.isJS() to j2sNative
[jalview.git] / src / jalview / io / JalviewFileChooser.java
index 73a99e3..56b8637 100755 (executable)
@@ -26,9 +26,7 @@ import jalview.bin.Jalview;
 import jalview.gui.JvOptionPane;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
-import jalview.util.dialogrunner.DialogRunner;
 import jalview.util.dialogrunner.DialogRunnerI;
-import jalview.util.dialogrunner.RunResponse;
 
 import java.awt.Component;
 import java.awt.Dimension;
@@ -40,7 +38,9 @@ import java.beans.PropertyChangeEvent;
 import java.beans.PropertyChangeListener;
 import java.io.File;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.StringTokenizer;
 import java.util.Vector;
 
@@ -64,85 +64,13 @@ import javax.swing.plaf.basic.BasicFileChooserUI;
 public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
     PropertyChangeListener
 {
-  private DialogRunnerI runner = new DialogRunner();
+  private static final long serialVersionUID = 1L;
+
+  private Map<Object, Runnable> callbacks = new HashMap<>();
   
   File selectedFile = null;
 
   /**
-   * On user selecting a file to save to, this response is run to check if the
-   * file already exists, and if so show a dialog to prompt for confirmation of
-   * overwrite.
-   */
-  RunResponse overwriteCheck = new RunResponse(JalviewFileChooser.APPROVE_OPTION)
-  {
-    @Override
-    public void run()
-       {
-           selectedFile = getSelectedFile();
-       
-           if (selectedFile == null)
-           {
-             // Workaround for Java 9,10 on OSX - no selected file, but there is a
-             // filename typed in
-             // TODO is this needed in Java 8 or 11?
-             try
-             {
-               String filename = ((BasicFileChooserUI) getUI()).getFileName();
-               if (filename != null && filename.length() > 0)
-               {
-                 selectedFile = new File(getCurrentDirectory(), filename);
-               }
-             } catch (Throwable x)
-             {
-               System.err.println(
-                       "Unexpected exception when trying to get filename.");
-               x.printStackTrace();
-             }
-           }
-           if (selectedFile == null)
-           {
-             setReturnValue(JalviewFileChooser.CANCEL_OPTION);
-             return;
-           }
-           // JBP Note - this code was executed regardless of 'SAVE' being pressed
-           // need to see if there were side effects
-           if (getFileFilter() instanceof JalviewFileFilter)
-           {
-             JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
-       
-             if (!jvf.accept(getSelectedFile()))
-             {
-               String withExtension = getSelectedFile() + "."
-                       + jvf.getAcceptableExtension();
-               setSelectedFile(new File(withExtension));
-             }
-           }
-           // All good, so we continue to save
-           setReturnValue(JalviewFileChooser.APPROVE_OPTION);
-       
-           // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
-           // USER PROMPTED FOR A NEW FILENAME
-           if (!Jalview.isJS())
-           {
-             if (getSelectedFile().exists())
-             {
-               // JAL-3048 - may not need to raise this for browser saves
-               // yes/no cancel
-               int confirm = JvOptionPane.showConfirmDialog(JalviewFileChooser.this,
-                       MessageManager.getString("label.overwrite_existing_file"),
-                       MessageManager.getString("label.file_already_exists"),
-                 JvOptionPane.YES_NO_OPTION);
-       
-             if (confirm != JvOptionPane.YES_OPTION)
-             {
-                  setReturnValue(JalviewFileChooser.CANCEL_OPTION);
-                }
-              }
-            }
-       };
-  };
-
-  /**
    * Factory method to return a file chooser that offers readable alignment file
    * formats
    * 
@@ -264,11 +192,15 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
   @Override
   public int showOpenDialog(Component parent)
   {
-   // runner.resetResponses();
     int value = super.showOpenDialog(this);
+    
     if (!Jalview.isJS())
     {
-      runner.handleResponse(value);
+      /*
+       * code here is not run in JalviewJS, instead
+       * propertyChange() is called for dialog action
+       */
+      handleResponse(value);
     }
     return value;
   }
@@ -387,43 +319,87 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
     return f == null ? selectedFile : f;
   }
 
-  /**
-   * Overridden for JalviewJS compatibility: only one thread in Javascript, 
-   * so we can't wait for user choice in another thread and then perform the 
-   * desired action
-   */
   @Override
   public int showSaveDialog(Component parent) throws HeadlessException
   {
     this.setAccessory(null);
+    // Java 9,10,11 on OSX - clear selected file so name isn't auto populated
+    this.setSelectedFile(null);
 
-    /*
-     * Save dialog is opened until user picks a file format 
-     */
-    /*
-    if (!runner.isRegistered(overwriteCheck))
+    return super.showSaveDialog(parent);
+  }
+
+  /**
+   * If doing a Save, and an existing file is chosen or entered, prompt for
+   * confirmation of overwrite. Proceed if Yes, else leave the file chooser
+   * open.
+   * 
+   * @see https://stackoverflow.com/questions/8581215/jfilechooser-and-checking-for-overwrite
+   */
+  @Override
+  public void approveSelection()
+  {
+    if (getDialogType() != SAVE_DIALOG)
     {
-      // first call for this instance
-      runner.setFirstResponse(overwriteCheck);
+      super.approveSelection();
+      return;
     }
-    else
+
+    selectedFile = getSelectedFile();
+
+    if (selectedFile == null)
     {
-      // reset response flags
-      runner.resetResponses();
+      // Workaround for Java 9,10 on OSX - no selected file, but there is a
+      // filename typed in
+      try
+      {
+        String filename = ((BasicFileChooserUI) getUI()).getFileName();
+        if (filename != null && filename.length() > 0)
+        {
+          selectedFile = new File(getCurrentDirectory(), filename);
+        }
+      } catch (Throwable x)
+      {
+        System.err.println(
+                "Unexpected exception when trying to get filename.");
+        x.printStackTrace();
+      }
+      // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND
+      // THE
+      // USER PROMPTED FOR A NEW FILENAME
     }
-*/
- //   runner.addResponse(overwriteCheck);
-//    setDialogType(SAVE_DIALOG);
-    
-    // Java 9,10,11 on OSX - clear selected file so name isn't auto populated
-    this.setSelectedFile(null);
-    int value = super.showSaveDialog(parent);//, MessageManager.getString("action.save"));
-    if (!Jalview.isJS())
+
+    if (selectedFile == null)
     {
-      runner.handleResponse(value);
+      return;
     }
-    return value;
+
+    if (getFileFilter() instanceof JalviewFileFilter)
+    {
+      JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
+
+      if (!jvf.accept(selectedFile))
+      {
+        String withExtension = getSelectedFile().getName() + "."
+                + jvf.getAcceptableExtension();
+        selectedFile = (new File(getCurrentDirectory(), withExtension));
+        setSelectedFile(selectedFile);
+      }
+    }
+
+    if (selectedFile.exists())
+    {
+      int confirm = JvOptionPane.showConfirmDialog(this,
+              MessageManager.getString("label.overwrite_existing_file"),
+              MessageManager.getString("label.file_already_exists"),
+              JvOptionPane.YES_NO_OPTION);
+      if (confirm != JvOptionPane.YES_OPTION)
+      {
+        return;
+      }
+    }
+
+    super.approveSelection();
   }
 
   void recentListSelectionChanged(Object selection)
@@ -448,12 +424,13 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
 
   class RecentlyOpened extends JPanel
   {
+    private static final long serialVersionUID = 1L;
     JList<String> list;
 
-    public RecentlyOpened()
+    RecentlyOpened()
     {
-
-      String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
+      setPreferredSize(new Dimension(300,100));
+      String historyItems = Cache.getProperty("RECENT_FILE");
       StringTokenizer st;
       Vector<String> recent = new Vector<>();
 
@@ -468,9 +445,9 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
       }
 
       list = new JList<>(recent);
-
+  
       DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
-      dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
+//      dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
       list.setCellRenderer(dlcr);
 
       list.addMouseListener(new MouseAdapter()
@@ -499,7 +476,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
       }
       else
       {
-        scroller.setPreferredSize(new Dimension(130, 200));
+        scroller.setPreferredSize(new Dimension(530, 200));
       }
 
       this.add(scroller);
@@ -519,9 +496,27 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
   }
 
   @Override
-  public DialogRunnerI addResponse(RunResponse action)
+  public DialogRunnerI setResponseHandler(Object response, Runnable action)
+  {
+       callbacks.put(response,  action);
+       return this;
+  }
+
+  @Override
+  public void handleResponse(Object response)
   {
-    return runner.addResponse(action);
+    /*
+        * this test is for NaN in Chrome
+        */
+    if (response != null && !response.equals(response))
+    {
+      return;
+    }
+    Runnable action = callbacks.get(response);
+    if (action != null)
+    {
+      action.run();
+    }
   }
 
   /**
@@ -537,30 +532,12 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
     // TODO other properties need runners...
     switch (evt.getPropertyName())
     {
+    /*
+     * property name here matches that used in JFileChooser.js
+     */
     case "SelectedFile": 
-      runner.handleResponse(APPROVE_OPTION);
+      handleResponse(APPROVE_OPTION);
       break;
     }
   }
-
-       @Override
-       public void approveSelection() 
-       {
-               if (getDialogType() == SAVE_DIALOG && !Jalview.isJS()) 
-               {
-                       File selectedFile = getSelectedFile();
-                       if ((selectedFile != null) && selectedFile.exists()) 
-                       {
-                               int confirm = JvOptionPane.showConfirmDialog(this,
-                                               MessageManager.getString("label.overwrite_existing_file"),
-                                               MessageManager.getString("label.file_already_exists"), JvOptionPane.YES_NO_OPTION);
-       
-                               if (confirm != JvOptionPane.YES_OPTION) 
-                               {
-                                       return;
-                               }
-                       }
-               }
-               super.approveSelection();
-       }
 }