JAL-1988 JAL-3772 Non-blocking modal dialogs for unsaved changes and saving files...
[jalview.git] / src / jalview / io / JalviewFileChooser.java
index 88a337a..dba7ad1 100755 (executable)
 //////////////////////////////////////////////////////////////////
 package jalview.io;
 
-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;
 import java.awt.EventQueue;
 import java.awt.HeadlessException;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
 import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
 import java.beans.PropertyChangeEvent;
@@ -42,15 +38,26 @@ import java.util.List;
 import java.util.Map;
 import java.util.StringTokenizer;
 import java.util.Vector;
+import java.util.concurrent.Callable;
 
+import javax.swing.BoxLayout;
 import javax.swing.DefaultListCellRenderer;
+import javax.swing.JCheckBox;
 import javax.swing.JFileChooser;
 import javax.swing.JList;
+import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.SpringLayout;
+import javax.swing.filechooser.FileFilter;
 import javax.swing.plaf.basic.BasicFileChooserUI;
 
+import jalview.bin.Cache;
+import jalview.gui.JvOptionPane;
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+import jalview.util.dialogrunner.DialogRunnerI;
+
 /**
  * Enhanced file chooser dialog box.
  *
@@ -60,16 +67,24 @@ import javax.swing.plaf.basic.BasicFileChooserUI;
  * @author AMW
  *
  */
-public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
-    PropertyChangeListener
+public class JalviewFileChooser extends JFileChooser
+        implements DialogRunnerI, PropertyChangeListener
 {
   private static final long serialVersionUID = 1L;
 
-  private Map<Object, Runnable> callbacks = new HashMap<>();
-  
+  private Map<Object, Callable> callbacks = new HashMap<>();
+
   File selectedFile = null;
 
   /**
+   * backupfilesCheckBox = "Include backup files" checkbox includeBackupfiles =
+   * flag set by checkbox
+   */
+  private JCheckBox backupfilesCheckBox = null;
+
+  protected boolean includeBackupFiles = false;
+
+  /**
    * Factory method to return a file chooser that offers readable alignment file
    * formats
    * 
@@ -80,6 +95,12 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
   public static JalviewFileChooser forRead(String directory,
           String selected)
   {
+    return JalviewFileChooser.forRead(directory, selected, false);
+  }
+
+  public static JalviewFileChooser forRead(String directory,
+          String selected, boolean allowBackupFiles)
+  {
     List<String> extensions = new ArrayList<>();
     List<String> descs = new ArrayList<>();
     for (FileFormatI format : FileFormats.getInstance().getFormats())
@@ -90,9 +111,11 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
         descs.add(format.getName());
       }
     }
+
     return new JalviewFileChooser(directory,
             extensions.toArray(new String[extensions.size()]),
-            descs.toArray(new String[descs.size()]), selected, true);
+            descs.toArray(new String[descs.size()]), selected, true,
+            allowBackupFiles);
   }
 
   /**
@@ -151,6 +174,12 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
   JalviewFileChooser(String dir, String[] extensions, String[] descs,
           String selected, boolean acceptAny)
   {
+    this(dir, extensions, descs, selected, acceptAny, false);
+  }
+
+  public JalviewFileChooser(String dir, String[] extensions, String[] descs,
+          String selected, boolean acceptAny, boolean allowBackupFiles)
+  {
     super(safePath(dir));
     if (extensions.length == descs.length)
     {
@@ -159,7 +188,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
       {
         formats.add(new String[] { extensions[i], descs[i] });
       }
-      init(formats, selected, acceptAny);
+      init(formats, selected, acceptAny, allowBackupFiles);
     }
     else
     {
@@ -184,20 +213,28 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
   }
 
   /**
-   * Overridden for JalviewJS compatibility: only one thread in Javascript, 
-   * so we can't wait for user choice in another thread and then perform the 
+   * 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);
-    
-    /*
-     * code below here is not reached in JalviewJS, instead
-     * propertyChange() is called for dialog action
+
+    if (!Platform.isJS())
+    /**
+     * Java only
+     * 
+     * @j2sIgnore
      */
-    handleResponse(value);
+    {
+      /*
+       * code here is not run in JalviewJS, instead
+       * propertyChange() is called for dialog action
+       */
+      handleResponse(value);
+    }
     return value;
   }
 
@@ -211,6 +248,12 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
    */
   void init(List<String[]> formats, String selected, boolean acceptAny)
   {
+    init(formats, selected, acceptAny, false);
+  }
+
+  void init(List<String[]> formats, String selected, boolean acceptAny,
+          boolean allowBackupFiles)
+  {
 
     JalviewFileFilter chosen = null;
 
@@ -221,6 +264,10 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
     for (String[] format : formats)
     {
       JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
+      if (allowBackupFiles)
+      {
+        jvf.setParentJFC(this);
+      }
       addChoosableFileFilter(jvf);
       if ((selected != null) && selected.equalsIgnoreCase(format[1]))
       {
@@ -233,7 +280,65 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
       setFileFilter(chosen);
     }
 
-    setAccessory(new RecentlyOpened());
+    if (allowBackupFiles)
+    {
+      JPanel multi = new JPanel();
+      multi.setLayout(new BoxLayout(multi, BoxLayout.PAGE_AXIS));
+      if (backupfilesCheckBox == null)
+      {
+        try
+        {
+          includeBackupFiles = Boolean.parseBoolean(
+                  Cache.getProperty(BackupFiles.NS + "_FC_INCLUDE"));
+        } catch (Exception e)
+        {
+          includeBackupFiles = false;
+        }
+        backupfilesCheckBox = new JCheckBox(
+                MessageManager.getString("label.include_backup_files"),
+                includeBackupFiles);
+        backupfilesCheckBox.setAlignmentX(Component.CENTER_ALIGNMENT);
+        JalviewFileChooser jfc = this;
+        backupfilesCheckBox.addActionListener(new ActionListener()
+        {
+          @Override
+          public void actionPerformed(ActionEvent e)
+          {
+            includeBackupFiles = backupfilesCheckBox.isSelected();
+            Cache.setProperty(BackupFiles.NS + "_FC_INCLUDE",
+                    String.valueOf(includeBackupFiles));
+
+            FileFilter f = jfc.getFileFilter();
+            // deselect the selected file if it's no longer choosable
+            File selectedFile = jfc.getSelectedFile();
+            if (selectedFile != null && !f.accept(selectedFile))
+            {
+              jfc.setSelectedFile(null);
+            }
+            // fake the OK button changing (to force it to upate)
+            String s = jfc.getApproveButtonText();
+            jfc.firePropertyChange(APPROVE_BUTTON_TEXT_CHANGED_PROPERTY,
+                    null, s);
+            // fake the file filter changing (its behaviour actually has)
+            jfc.firePropertyChange(FILE_FILTER_CHANGED_PROPERTY, null, f);
+
+            jfc.rescanCurrentDirectory();
+            jfc.revalidate();
+            jfc.repaint();
+          }
+        });
+      }
+      multi.add(new RecentlyOpened());
+      multi.add(backupfilesCheckBox);
+      setAccessory(multi);
+    }
+    else
+    {
+      // set includeBackupFiles=false to avoid other file choosers from picking
+      // up backup files (Just In Case)
+      includeBackupFiles = false;
+      setAccessory(new RecentlyOpened());
+    }
   }
 
   @Override
@@ -385,10 +490,14 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
 
     if (selectedFile.exists())
     {
-      int confirm = JvOptionPane.showConfirmDialog(this,
-              MessageManager.getString("label.overwrite_existing_file"),
-              MessageManager.getString("label.file_already_exists"),
-              JvOptionPane.YES_NO_OPTION);
+      int confirm = Cache.getDefault("CONFIRM_OVERWRITE_FILE", true)
+              ? JvOptionPane.showConfirmDialog(this,
+                      MessageManager
+                              .getString("label.overwrite_existing_file"),
+                      MessageManager.getString("label.file_already_exists"),
+                      JvOptionPane.YES_NO_OPTION)
+              : JOptionPane.YES_OPTION;
+
       if (confirm != JvOptionPane.YES_OPTION)
       {
         return;
@@ -421,11 +530,12 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
   class RecentlyOpened extends JPanel
   {
     private static final long serialVersionUID = 1L;
+
     JList<String> list;
 
     RecentlyOpened()
     {
-      setPreferredSize(new Dimension(300,100));
+      setPreferredSize(new Dimension(300, 100));
       String historyItems = Cache.getProperty("RECENT_FILE");
       StringTokenizer st;
       Vector<String> recent = new Vector<>();
@@ -441,9 +551,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()
@@ -466,7 +576,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
       layout.putConstraint(SpringLayout.NORTH, scroller, 5,
               SpringLayout.NORTH, this);
 
-      if (Platform.isAMac())
+      if (Platform.isAMacAndNotJS())
       {
         scroller.setPreferredSize(new Dimension(500, 100));
       }
@@ -491,34 +601,58 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
 
   }
 
+  /*
+  @Override
+  public JalviewFileChooser setResponseHandler(Object response,
+          Runnable action)
+  {
+    callbacks.put(response, new Callable<Void>()
+    {
+      @Override
+      public Void call()
+      {
+        action.run();
+        return null;
+      }
+    });
+    return this;
+  }
+  */
+
   @Override
-  public DialogRunnerI setResponseHandler(Object response, Runnable action)
+  public DialogRunnerI setResponseHandler(Object response, Callable action)
   {
-       callbacks.put(response,  action);
-       return this;
+    callbacks.put(response, action);
+    return this;
   }
 
   @Override
   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;
     }
-    Runnable action = callbacks.get(response);
+    Callable action = callbacks.get(response);
     if (action != null)
     {
-      action.run();
+      try
+      {
+        action.call();
+      } catch (Exception e)
+      {
+        e.printStackTrace();
+      }
     }
   }
 
   /**
-   * 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.
+   * 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
    */
@@ -531,7 +665,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
     /*
      * property name here matches that used in JFileChooser.js
      */
-    case "SelectedFile": 
+    case "SelectedFile":
       handleResponse(APPROVE_OPTION);
       break;
     }