JAL-3048 wip externalise trigger from RunResponse

[jalview.git] / src / jalview / io / JalviewFileChooser.java

diff --git a/src/jalview/io/JalviewFileChooser.java b/src/jalview/io/JalviewFileChooser.java
index 6b0eba8..6fa6016 100755 (executable)
--- a/src/jalview/io/JalviewFileChooser.java
+++ b/src/jalview/io/JalviewFileChooser.java
@@ -22,9 +22,13 @@
 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.RunResponse;
 
 import java.awt.Component;
 import java.awt.Dimension;
@@ -32,6 +36,8 @@ import java.awt.EventQueue;
 import java.awt.HeadlessException;
 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.List;
@@ -57,8 +63,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 DialogRunnerI runner = new DialogRunner();
+  
+  File selectedFile = null;
+
   /**
    * Factory method to return a file chooser that offers readable alignment file
    * formats
@@ -139,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)
@@ -149,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
     {
@@ -174,21 +187,38 @@ 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)
+  {
+   // runner.resetResponses();
+    int value = super.showOpenDialog(this);
+    if (!Jalview.isJS())
+    {
+      runner.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)
   {
 
     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)
     {
@@ -280,19 +310,18 @@ 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;
   }
 
+  /**
+   * 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
   {
@@ -317,9 +346,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
@@ -328,7 +357,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)
       {
@@ -340,7 +369,8 @@ public class JalviewFileChooser extends JFileChooser
       // THE
       // USER PROMPTED FOR A NEW FILENAME
     }
-    if (ourselectedFile == null)
+
+    if (selectedFile == null)
     {
       return;
     }
@@ -349,27 +379,26 @@ 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"),
+              MessageManager.getString("label.file_already_exists"),
+              JvOptionPane.YES_NO_OPTION);
+      if (confirm != JvOptionPane.YES_OPTION)
       {
-        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;
-        }
+        return;
       }
+    }
 
     super.approveSelection();
   }
@@ -405,7 +434,7 @@ public class JalviewFileChooser extends JFileChooser
   {
     private static final long serialVersionUID = 1L;
 
-    private JList<String> list;
+    JList<String> list;
 
     RecentlyOpened()
     {
@@ -470,4 +499,29 @@ public class JalviewFileChooser extends JFileChooser
       });
     }
   }
+
+  @Override
+  public DialogRunnerI addResponse(Object response, RunResponse 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;
+    }
+  }
 }