Merge branch 'develop' into trialMerge
[jalview.git] / src / jalview / io / JalviewFileChooser.java
index 7fbe801..95f4c94 100755 (executable)
@@ -25,6 +25,7 @@ import jalview.bin.Cache;
 import jalview.gui.JvOptionPane;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
+import jalview.util.dialogrunner.DialogRunnerI;
 
 import java.awt.Component;
 import java.awt.Dimension;
@@ -34,9 +35,13 @@ import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
+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;
 
@@ -48,8 +53,6 @@ import javax.swing.JList;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.SpringLayout;
-import javax.swing.SwingUtilities;
-import javax.swing.border.TitledBorder;
 import javax.swing.filechooser.FileFilter;
 import javax.swing.plaf.basic.BasicFileChooserUI;
 
@@ -62,8 +65,15 @@ import javax.swing.plaf.basic.BasicFileChooserUI;
  * @author AMW
  *
  */
-public class JalviewFileChooser extends JFileChooser
+public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
+    PropertyChangeListener
 {
+  private static final long serialVersionUID = 1L;
+
+  private Map<Object, Runnable> callbacks = new HashMap<>();
+  
+  File selectedFile = null;
+
   /**
    * backupfilesCheckBox = "Include backup files" checkbox includeBackupfiles =
    * flag set by checkbox
@@ -160,13 +170,13 @@ public class JalviewFileChooser extends JFileChooser
   }
 
   JalviewFileChooser(String dir, String[] extensions, String[] descs,
-          String selected, boolean allFiles)
+          String selected, boolean acceptAny)
   {
-    this(dir, extensions, descs, selected, allFiles, false);
+    this(dir, extensions, descs, selected, acceptAny, false);
   }
 
   public JalviewFileChooser(String dir, String[] extensions, String[] descs,
-          String selected, boolean allFiles, boolean allowBackupFiles)
+          String selected, boolean acceptAny, boolean allowBackupFiles)
   {
     super(safePath(dir));
     if (extensions.length == descs.length)
@@ -176,7 +186,7 @@ public class JalviewFileChooser extends JFileChooser
       {
         formats.add(new String[] { extensions[i], descs[i] });
       }
-      init(formats, selected, allFiles, allowBackupFiles);
+      init(formats, selected, acceptAny, allowBackupFiles);
     }
     else
     {
@@ -201,19 +211,40 @@ public class JalviewFileChooser extends JFileChooser
   }
 
   /**
+   * 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 showOpenDialog(Component parent)
+  {
+    int value = super.showOpenDialog(this);
+    
+    if (!Platform.isJS())
+    {
+      /*
+       * code here is not run in JalviewJS, instead
+       * propertyChange() is called for dialog action
+       */
+      handleResponse(value);
+    }
+    return value;
+  }
+
+  /**
    * 
    * @param formats
    *          a list of {extensions, description} for each file format
    * @param selected
-   * @param allFiles
+   * @param acceptAny
    *          if true, 'any format' option is included
    */
-  void init(List<String[]> formats, String selected, boolean allFiles)
+  void init(List<String[]> formats, String selected, boolean acceptAny)
   {
-    init(formats, selected, allFiles, false);
+    init(formats, selected, acceptAny, false);
   }
 
-  void init(List<String[]> formats, String selected, boolean allFiles,
+  void init(List<String[]> formats, String selected, boolean acceptAny,
           boolean allowBackupFiles)
   {
 
@@ -221,7 +252,7 @@ public class JalviewFileChooser extends JFileChooser
 
     // SelectAllFilter needs to be set first before adding further
     // file filters to fix bug on Mac OSX
-    setAcceptAllFileFilterUsed(allFiles);
+    setAcceptAllFileFilterUsed(acceptAny);
 
     for (String[] format : formats)
     {
@@ -374,24 +405,20 @@ public class JalviewFileChooser extends JFileChooser
     return null;
   }
 
-  File ourselectedFile = null;
-
   @Override
   public File getSelectedFile()
   {
-    File selfile = super.getSelectedFile();
-    if (selfile == null && ourselectedFile != null)
-    {
-      return ourselectedFile;
-    }
-    return selfile;
+    File f = super.getSelectedFile();
+    return f == null ? selectedFile : f;
   }
 
   @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);
+
     return super.showSaveDialog(parent);
   }
 
@@ -411,9 +438,9 @@ public class JalviewFileChooser extends JFileChooser
       return;
     }
 
-    ourselectedFile = getSelectedFile();
+    selectedFile = getSelectedFile();
 
-    if (ourselectedFile == null)
+    if (selectedFile == null)
     {
       // Workaround for Java 9,10 on OSX - no selected file, but there is a
       // filename typed in
@@ -422,7 +449,7 @@ public class JalviewFileChooser extends JFileChooser
         String filename = ((BasicFileChooserUI) getUI()).getFileName();
         if (filename != null && filename.length() > 0)
         {
-          ourselectedFile = new File(getCurrentDirectory(), filename);
+          selectedFile = new File(getCurrentDirectory(), filename);
         }
       } catch (Throwable x)
       {
@@ -434,7 +461,8 @@ public class JalviewFileChooser extends JFileChooser
       // THE
       // USER PROMPTED FOR A NEW FILENAME
     }
-    if (ourselectedFile == null)
+
+    if (selectedFile == null)
     {
       return;
     }
@@ -443,16 +471,16 @@ public class JalviewFileChooser extends JFileChooser
     {
       JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
 
-      if (!jvf.accept(ourselectedFile))
+      if (!jvf.accept(selectedFile))
       {
         String withExtension = getSelectedFile().getName() + "."
                 + jvf.getAcceptableExtension();
-        ourselectedFile = (new File(getCurrentDirectory(), withExtension));
-        setSelectedFile(ourselectedFile);
+        selectedFile = (new File(getCurrentDirectory(), withExtension));
+        setSelectedFile(selectedFile);
       }
     }
 
-    if (ourselectedFile.exists())
+    if (selectedFile.exists())
     {
       int confirm = JvOptionPane.showConfirmDialog(this,
               MessageManager.getString("label.overwrite_existing_file"),
@@ -488,21 +516,14 @@ public class JalviewFileChooser extends JFileChooser
     }
   }
 
-  /**
-   * A panel to set as the 'accessory' component to the file chooser dialog,
-   * holding a list of recently opened files (if any). These are held as a
-   * tab-separated list of file paths under key <code>RECENT_FILE</code> in
-   * <code>.jalview_properties</code>. A click in the list calls a method in
-   * JalviewFileChooser to set the chosen file as the selection.
-   */
   class RecentlyOpened extends JPanel
   {
     private static final long serialVersionUID = 1L;
-
-    private JList<String> list;
+    JList<String> list;
 
     RecentlyOpened()
     {
+      setPreferredSize(new Dimension(300,100));
       String historyItems = Cache.getProperty("RECENT_FILE");
       StringTokenizer st;
       Vector<String> recent = new Vector<>();
@@ -510,6 +531,7 @@ public class JalviewFileChooser extends JFileChooser
       if (historyItems != null)
       {
         st = new StringTokenizer(historyItems, "\t");
+
         while (st.hasMoreTokens())
         {
           recent.addElement(st.nextToken());
@@ -517,9 +539,9 @@ public class JalviewFileChooser extends JFileChooser
       }
 
       list = new JList<>(recent);
-
+  
       DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
-      dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
+//      dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
       list.setCellRenderer(dlcr);
 
       list.addMouseListener(new MouseAdapter()
@@ -531,7 +553,7 @@ public class JalviewFileChooser extends JFileChooser
         }
       });
 
-      this.setBorder(new TitledBorder(
+      this.setBorder(new javax.swing.border.TitledBorder(
               MessageManager.getString("label.recently_opened")));
 
       final JScrollPane scroller = new JScrollPane(list);
@@ -542,18 +564,18 @@ public class JalviewFileChooser extends JFileChooser
       layout.putConstraint(SpringLayout.NORTH, scroller, 5,
               SpringLayout.NORTH, this);
 
-      if (Platform.isAMac())
+      if (Platform.isAMacAndNotJS())
       {
         scroller.setPreferredSize(new Dimension(500, 100));
       }
       else
       {
-        scroller.setPreferredSize(new Dimension(130, 200));
+        scroller.setPreferredSize(new Dimension(530, 200));
       }
 
       this.add(scroller);
 
-      SwingUtilities.invokeLater(new Runnable()
+      javax.swing.SwingUtilities.invokeLater(new Runnable()
       {
         @Override
         public void run()
@@ -562,6 +584,54 @@ public class JalviewFileChooser extends JFileChooser
                   .setValue(scroller.getHorizontalScrollBar().getMaximum());
         }
       });
+
+    }
+
+  }
+
+  @Override
+  public DialogRunnerI setResponseHandler(Object response, Runnable action)
+  {
+       callbacks.put(response,  action);
+       return this;
+  }
+
+  @Override
+  public void handleResponse(Object response)
+  {
+    /*
+        * this test is for NaN in Chrome
+        */
+    if (response != null && !response.equals(response))
+    {
+      return;
+    }
+    Runnable action = callbacks.get(response);
+    if (action != null)
+    {
+      action.run();
+    }
+  }
+
+  /**
+   * JalviewJS signals file selection by a property change event
+   * for property "SelectedFile".  This methods responds to that by
+   * running the response action for 'OK' in the dialog.
+   * 
+   * @param evt
+   */
+  @Override
+  public void propertyChange(PropertyChangeEvent evt)
+  {
+    // TODO other properties need runners...
+    switch (evt.getPropertyName())
+    {
+    /*
+     * property name here matches that used in JFileChooser.js
+     */
+    case "SelectedFile": 
+      handleResponse(APPROVE_OPTION);
+      break;
     }
   }
 }