JAL-3438 spotless for 2.11.2.0
[jalview.git] / src / jalview / io / JalviewFileChooser.java
index 9c99603..a9101a1 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.RunResponse;
 
 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.SwingUtilities;
-import javax.swing.border.TitledBorder;
+import javax.swing.filechooser.FileFilter;
 import javax.swing.plaf.basic.BasicFileChooserUI;
 
 /**
@@ -63,16 +65,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 DialogRunnerI runner = new DialogRunner();
-  
+  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
    * 
@@ -83,6 +93,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())
@@ -93,9 +109,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);
   }
 
   /**
@@ -154,6 +172,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)
     {
@@ -162,7 +186,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
     {
@@ -187,18 +211,27 @@ 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)
   {
-   // runner.resetResponses();
     int value = super.showOpenDialog(this);
-    if (!Jalview.isJS())
+
+    if (!Platform.isJS())
+    /**
+     * Java only
+     * 
+     * @j2sIgnore
+     */
     {
-      runner.handleResponse(value);
+      /*
+       * code here is not run in JalviewJS, instead
+       * propertyChange() is called for dialog action
+       */
+      handleResponse(value);
     }
     return value;
   }
@@ -213,6 +246,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;
 
@@ -223,6 +262,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]))
       {
@@ -235,7 +278,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
@@ -317,16 +418,13 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
     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);
+    // Java 9,10,11 on OSX - clear selected file so name isn't auto populated
     this.setSelectedFile(null);
+
     return super.showSaveDialog(parent);
   }
 
@@ -394,6 +492,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
               MessageManager.getString("label.overwrite_existing_file"),
               MessageManager.getString("label.file_already_exists"),
               JvOptionPane.YES_NO_OPTION);
+
       if (confirm != JvOptionPane.YES_OPTION)
       {
         return;
@@ -423,13 +522,6 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
     }
   }
 
-  /**
-   * 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;
@@ -438,7 +530,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
 
     RecentlyOpened()
     {
-      setPreferredSize(new Dimension(300,100));
+      setPreferredSize(new Dimension(300, 100));
       String historyItems = Cache.getProperty("RECENT_FILE");
       StringTokenizer st;
       Vector<String> recent = new Vector<>();
@@ -446,6 +538,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
       if (historyItems != null)
       {
         st = new StringTokenizer(historyItems, "\t");
+
         while (st.hasMoreTokens())
         {
           recent.addElement(st.nextToken());
@@ -453,9 +546,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()
@@ -467,7 +560,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
         }
       });
 
-      this.setBorder(new TitledBorder(
+      this.setBorder(new javax.swing.border.TitledBorder(
               MessageManager.getString("label.recently_opened")));
 
       final JScrollPane scroller = new JScrollPane(list);
@@ -478,7 +571,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));
       }
@@ -489,7 +582,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
 
       this.add(scroller);
 
-      SwingUtilities.invokeLater(new Runnable()
+      javax.swing.SwingUtilities.invokeLater(new Runnable()
       {
         @Override
         public void run()
@@ -498,19 +591,39 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
                   .setValue(scroller.getHorizontalScrollBar().getMaximum());
         }
       });
+
     }
+
   }
 
   @Override
-  public DialogRunnerI addResponse(Object response, RunResponse action)
+  public DialogRunnerI setResponseHandler(Object response, Runnable action)
   {
-    return runner.addResponse(response, 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.
+   * 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
    */
@@ -520,8 +633,11 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
     // TODO other properties need runners...
     switch (evt.getPropertyName())
     {
-    case "SelectedFile": 
-      runner.handleResponse(APPROVE_OPTION);
+    /*
+     * property name here matches that used in JFileChooser.js
+     */
+    case "SelectedFile":
+      handleResponse(APPROVE_OPTION);
       break;
     }
   }