JAL-3048 wip externalise trigger from RunResponse
[jalview.git] / src / jalview / io / JalviewFileChooser.java
index cf72ffb..6fa6016 100755 (executable)
 package jalview.io;
 
 import jalview.bin.Cache;
+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.Response;
 import jalview.util.dialogrunner.RunResponse;
 
 import java.awt.Component;
@@ -49,6 +50,8 @@ 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.plaf.basic.BasicFileChooserUI;
 
 /**
@@ -60,11 +63,15 @@ import javax.swing.plaf.basic.BasicFileChooserUI;
  * @author AMW
  *
  */
-public class JalviewFileChooser extends JFileChooser
-        implements PropertyChangeListener, DialogRunnerI
+public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
+    PropertyChangeListener
 {
-  jalview.util.dialogrunner.DialogRunner<JalviewFileChooser> runner = new jalview.util.dialogrunner.DialogRunner<>(
-          this);
+  private static final long serialVersionUID = 1L;
+
+  private DialogRunnerI runner = new DialogRunner();
+  
+  File selectedFile = null;
+
   /**
    * Factory method to return a file chooser that offers readable alignment file
    * formats
@@ -145,7 +152,7 @@ public class JalviewFileChooser extends JFileChooser
   }
 
   JalviewFileChooser(String dir, String[] extensions, String[] descs,
-          String selected, boolean allFiles)
+          String selected, boolean acceptAny)
   {
     super(safePath(dir));
     if (extensions.length == descs.length)
@@ -155,7 +162,7 @@ public class JalviewFileChooser extends JFileChooser
       {
         formats.add(new String[] { extensions[i], descs[i] });
       }
-      init(formats, selected, allFiles);
+      init(formats, selected, acceptAny);
     }
     else
     {
@@ -164,18 +171,6 @@ public class JalviewFileChooser extends JFileChooser
     }
   }
 
-  @Override
-  public void propertyChange(PropertyChangeEvent evt)
-  {
-    // TODO other properties need runners...
-    switch (evt.getPropertyName())
-    {
-    case "SelectedFile": 
-      runner.run(APPROVE_OPTION);
-      break;
-    }
-  }
-
   private static File safePath(String dir)
   {
     if (dir == null)
@@ -191,10 +186,21 @@ public class JalviewFileChooser extends JFileChooser
     return f;
   }
 
-  public void openDialog(Component parent)
+  /**
+   * 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 = showOpenDialog(this);
-    runner.run(value);
+   // runner.resetResponses();
+    int value = super.showOpenDialog(this);
+    if (!Jalview.isJS())
+    {
+      runner.handleResponse(value);
+    }
+    return value;
   }
 
   /**
@@ -202,17 +208,17 @@ public class JalviewFileChooser extends JFileChooser
    * @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)
   {
 
     JalviewFileFilter chosen = null;
 
     // 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)
     {
@@ -304,80 +310,97 @@ public class JalviewFileChooser extends JFileChooser
     return null;
   }
 
-  Component saveparent;
-  RunResponse overwriteCheck = new RunResponse(
-          JalviewFileChooser.APPROVE_OPTION)
+  @Override
+  public File getSelectedFile()
+  {
+    File f = super.getSelectedFile();
+    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);
+    this.setSelectedFile(null);
+    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()
   {
-    @Override
-    public void run()
+    if (getDialogType() != SAVE_DIALOG)
     {
-      // 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();
+      super.approveSelection();
+      return;
+    }
 
-        if (!jvf.accept(getSelectedFile()))
-        {
-          String withExtension = getSelectedFile() + "."
-                  + jvf.getAcceptableExtension();
-          setSelectedFile(new File(withExtension));
-        }
-      }
-      // All good, so we continue to save
-      returned = new Response(JalviewFileChooser.APPROVE_OPTION);
+    selectedFile = getSelectedFile();
 
-      // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
-      // USER PROMPTED FOR A NEW FILENAME
-      /**
-       * @j2sNative
-       */
+    if (selectedFile == null)
+    {
+      // Workaround for Java 9,10 on OSX - no selected file, but there is a
+      // filename typed in
+      try
       {
-        if (getSelectedFile().exists())
+        String filename = ((BasicFileChooserUI) getUI()).getFileName();
+        if (filename != null && filename.length() > 0)
         {
-          // TODO JAL-3048 - may not need to raise this for browser saves
-
-          // yes/no cancel
-          int confirm = JvOptionPane.showConfirmDialog(saveparent,
-                  MessageManager.getString("label.overwrite_existing_file"),
-                  MessageManager.getString("label.file_already_exists"),
-                  JvOptionPane.YES_NO_OPTION);
-
-          if (confirm != JvOptionPane.YES_OPTION)
-          {
-            returned = new Response(JalviewFileChooser.CANCEL_OPTION);
-          }
+          selectedFile = new File(getCurrentDirectory(), filename);
         }
+      } catch (Throwable x)
+      {
+        System.err.println(
+                "Unexpected exception when trying to get filename.");
+        x.printStackTrace();
       }
-    };
-  };
-
-  @Override
-  public int showSaveDialog(Component parent) throws HeadlessException
-  {
-    this.setAccessory(null);
+      // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND
+      // THE
+      // USER PROMPTED FOR A NEW FILENAME
+    }
 
-    /*
-     * Save dialog is opened until user picks a file format 
-     */
-    if (!runner.isRegistered(overwriteCheck))
+    if (selectedFile == null)
     {
-      // first call for this instance
-      runner.firstResponse(overwriteCheck);
+      return;
     }
-    else
+
+    if (getFileFilter() instanceof JalviewFileFilter)
     {
-      // reset response flags
-      runner.resetResponses();
+      JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
+
+      if (!jvf.accept(selectedFile))
+      {
+        String withExtension = getSelectedFile().getName() + "."
+                + jvf.getAcceptableExtension();
+        selectedFile = (new File(getCurrentDirectory(), withExtension));
+        setSelectedFile(selectedFile);
+      }
     }
 
-    setDialogType(SAVE_DIALOG);
-    saveparent = parent;
+    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;
+      }
+    }
 
-    int value = showDialog(parent, MessageManager.getString("action.save"));
-    
-    runner.run(value);
-    return value;
+    super.approveSelection();
   }
 
   void recentListSelectionChanged(Object selection)
@@ -400,28 +423,35 @@ 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
   {
-    JList list;
+    private static final long serialVersionUID = 1L;
 
-    public RecentlyOpened()
-    {
+    JList<String> list;
 
-      String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
+    RecentlyOpened()
+    {
+      String historyItems = Cache.getProperty("RECENT_FILE");
       StringTokenizer st;
-      Vector recent = new Vector();
+      Vector<String> recent = new Vector<>();
 
       if (historyItems != null)
       {
         st = new StringTokenizer(historyItems, "\t");
-
         while (st.hasMoreTokens())
         {
-          recent.addElement(st.nextElement());
+          recent.addElement(st.nextToken());
         }
       }
 
-      list = new JList(recent);
+      list = new JList<>(recent);
 
       DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
       dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
@@ -436,7 +466,7 @@ public class JalviewFileChooser extends JFileChooser
         }
       });
 
-      this.setBorder(new javax.swing.border.TitledBorder(
+      this.setBorder(new TitledBorder(
               MessageManager.getString("label.recently_opened")));
 
       final JScrollPane scroller = new JScrollPane(list);
@@ -447,7 +477,7 @@ public class JalviewFileChooser extends JFileChooser
       layout.putConstraint(SpringLayout.NORTH, scroller, 5,
               SpringLayout.NORTH, this);
 
-      if (new Platform().isAMac())
+      if (Platform.isAMac())
       {
         scroller.setPreferredSize(new Dimension(500, 100));
       }
@@ -458,7 +488,7 @@ public class JalviewFileChooser extends JFileChooser
 
       this.add(scroller);
 
-      javax.swing.SwingUtilities.invokeLater(new Runnable()
+      SwingUtilities.invokeLater(new Runnable()
       {
         @Override
         public void run()
@@ -467,15 +497,31 @@ public class JalviewFileChooser extends JFileChooser
                   .setValue(scroller.getHorizontalScrollBar().getMaximum());
         }
       });
-
     }
-
   }
 
   @Override
-  public JalviewFileChooser response(RunResponse action)
+  public DialogRunnerI addResponse(Object response, RunResponse action)
   {
-    return runner.response(action);
+    return runner.addResponse(response, action);
   }
 
+  /**
+   * 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())
+    {
+    case "SelectedFile": 
+      runner.handleResponse(APPROVE_OPTION);
+      break;
+    }
+  }
 }