JAL-3438 spotless for 2.11.2.0
[jalview.git] / src / jalview / io / JalviewFileChooser.java
index 271ac53..a9101a1 100755 (executable)
@@ -25,25 +25,35 @@ 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;
+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;
 
+import javax.swing.BoxLayout;
 import javax.swing.DefaultListCellRenderer;
+import javax.swing.JCheckBox;
 import javax.swing.JFileChooser;
 import javax.swing.JList;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.SpringLayout;
+import javax.swing.filechooser.FileFilter;
 import javax.swing.plaf.basic.BasicFileChooserUI;
 
 /**
@@ -56,7 +66,22 @@ import javax.swing.plaf.basic.BasicFileChooserUI;
  *
  */
 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
+   */
+  private JCheckBox backupfilesCheckBox = null;
+
+  protected boolean includeBackupFiles = false;
+
   /**
    * Factory method to return a file chooser that offers readable alignment file
    * formats
@@ -68,6 +93,12 @@ public class JalviewFileChooser extends JFileChooser
   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())
@@ -78,9 +109,11 @@ public class JalviewFileChooser extends JFileChooser
         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);
   }
 
   /**
@@ -137,7 +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, acceptAny, false);
+  }
+
+  public JalviewFileChooser(String dir, String[] extensions, String[] descs,
+          String selected, boolean acceptAny, boolean allowBackupFiles)
   {
     super(safePath(dir));
     if (extensions.length == descs.length)
@@ -147,7 +186,7 @@ public class JalviewFileChooser extends JFileChooser
       {
         formats.add(new String[] { extensions[i], descs[i] });
       }
-      init(formats, selected, allFiles);
+      init(formats, selected, acceptAny, allowBackupFiles);
     }
     else
     {
@@ -172,25 +211,61 @@ 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())
+    /**
+     * Java only
+     * 
+     * @j2sIgnore
+     */
+    {
+      /*
+       * 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, acceptAny, false);
+  }
+
+  void init(List<String[]> formats, String selected, boolean acceptAny,
+          boolean allowBackupFiles)
   {
 
     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)
     {
       JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
+      if (allowBackupFiles)
+      {
+        jvf.setParentJFC(this);
+      }
       addChoosableFileFilter(jvf);
       if ((selected != null) && selected.equalsIgnoreCase(format[1]))
       {
@@ -203,7 +278,65 @@ public class JalviewFileChooser extends JFileChooser
       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
@@ -278,24 +411,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);
   }
 
@@ -315,9 +444,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
@@ -326,7 +455,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)
       {
@@ -338,7 +467,8 @@ public class JalviewFileChooser extends JFileChooser
       // THE
       // USER PROMPTED FOR A NEW FILENAME
     }
-    if (ourselectedFile == null)
+
+    if (selectedFile == null)
     {
       return;
     }
@@ -347,27 +477,27 @@ 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())
-      {
-        int confirm = JvOptionPane.showConfirmDialog(this,
-                MessageManager.getString("label.overwrite_existing_file"),
-                MessageManager.getString("label.file_already_exists"),
-                JvOptionPane.YES_NO_OPTION);
+    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;
-        }
+      if (confirm != JvOptionPane.YES_OPTION)
+      {
+        return;
       }
+    }
 
     super.approveSelection();
   }
@@ -394,14 +524,16 @@ public class JalviewFileChooser extends JFileChooser
 
   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()
+    {
+      setPreferredSize(new Dimension(300, 100));
+      String historyItems = Cache.getProperty("RECENT_FILE");
       StringTokenizer st;
-      Vector recent = new Vector();
+      Vector<String> recent = new Vector<>();
 
       if (historyItems != null)
       {
@@ -409,11 +541,11 @@ public class JalviewFileChooser extends JFileChooser
 
         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);
@@ -439,13 +571,13 @@ public class JalviewFileChooser extends JFileChooser
       layout.putConstraint(SpringLayout.NORTH, scroller, 5,
               SpringLayout.NORTH, this);
 
-      if (new 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);
@@ -463,4 +595,50 @@ public class JalviewFileChooser extends JFileChooser
     }
 
   }
+
+  @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;
+    }
+  }
 }