JAL-3169 leave file browser open on Cancel in overwrite check
[jalview.git] / src / jalview / io / JalviewFileChooser.java
index a4362dc..271ac53 100755 (executable)
@@ -21,6 +21,8 @@
 //////////////////////////////////////////////////////////////////
 package jalview.io;
 
+import jalview.bin.Cache;
+import jalview.gui.JvOptionPane;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
 
@@ -32,7 +34,6 @@ import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
 import java.io.File;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.StringTokenizer;
 import java.util.Vector;
@@ -40,7 +41,6 @@ import java.util.Vector;
 import javax.swing.DefaultListCellRenderer;
 import javax.swing.JFileChooser;
 import javax.swing.JList;
-import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.SpringLayout;
@@ -63,26 +63,24 @@ public class JalviewFileChooser extends JFileChooser
    * 
    * @param directory
    * @param selected
-   * @param selectAll
    * @return
    */
   public static JalviewFileChooser forRead(String directory,
-          String selected, boolean selectAll)
+          String selected)
   {
-    List<String> extensions = new ArrayList<String>();
-    List<String> descs = new ArrayList<String>();
-    for (FileFormatI format : FileFormat.values())
+    List<String> extensions = new ArrayList<>();
+    List<String> descs = new ArrayList<>();
+    for (FileFormatI format : FileFormats.getInstance().getFormats())
     {
       if (format.isReadable())
       {
         extensions.add(format.getExtensions());
-        descs.add(format.getShortDescription());
+        descs.add(format.getName());
       }
     }
     return new JalviewFileChooser(directory,
             extensions.toArray(new String[extensions.size()]),
-            descs.toArray(new String[descs.size()]),
-            selected);
+            descs.toArray(new String[descs.size()]), selected, true);
   }
 
   /**
@@ -91,27 +89,26 @@ public class JalviewFileChooser extends JFileChooser
    * 
    * @param directory
    * @param selected
-   * @param selectAll
    * @return
    */
   public static JalviewFileChooser forWrite(String directory,
-          String selected, boolean selectAll)
+          String selected)
   {
     // TODO in Java 8, forRead and forWrite can be a single method
     // with a lambda expression parameter for isReadable/isWritable
-    List<String> extensions = new ArrayList<String>();
-    List<String> descs = new ArrayList<String>();
-    for (FileFormatI format : FileFormat.values())
+    List<String> extensions = new ArrayList<>();
+    List<String> descs = new ArrayList<>();
+    for (FileFormatI format : FileFormats.getInstance().getFormats())
     {
       if (format.isWritable())
       {
         extensions.add(format.getExtensions());
-        descs.add(format.getShortDescription());
+        descs.add(format.getName());
       }
     }
     return new JalviewFileChooser(directory,
             extensions.toArray(new String[extensions.size()]),
-            descs.toArray(new String[descs.size()]), selected);
+            descs.toArray(new String[descs.size()]), selected, false);
   }
 
   public JalviewFileChooser(String dir)
@@ -120,26 +117,37 @@ public class JalviewFileChooser extends JFileChooser
     setAccessory(new RecentlyOpened());
   }
 
-  public JalviewFileChooser(String dir, String extension, String desc,
+  public JalviewFileChooser(String dir, String[] suffix, String[] desc,
           String selected)
   {
-    super(safePath(dir));
-    init(Collections.singletonList(new String[] { extension, desc }),
-            selected);
+    this(dir, suffix, desc, selected, true);
   }
 
-  public JalviewFileChooser(String dir, String[] extensions, String[] descs,
-          String selected)
+  /**
+   * Constructor for a single choice of file extension and description
+   * 
+   * @param extension
+   * @param desc
+   */
+  public JalviewFileChooser(String extension, String desc)
+  {
+    this(Cache.getProperty("LAST_DIRECTORY"), new String[] { extension },
+            new String[]
+            { desc }, desc, true);
+  }
+
+  JalviewFileChooser(String dir, String[] extensions, String[] descs,
+          String selected, boolean allFiles)
   {
     super(safePath(dir));
     if (extensions.length == descs.length)
     {
-      List<String[]> formats = new ArrayList<String[]>();
+      List<String[]> formats = new ArrayList<>();
       for (int i = 0; i < extensions.length; i++)
       {
         formats.add(new String[] { extensions[i], descs[i] });
       }
-      init(formats, selected);
+      init(formats, selected, allFiles);
     }
     else
     {
@@ -168,15 +176,17 @@ public class JalviewFileChooser extends JFileChooser
    * @param formats
    *          a list of {extensions, description} for each file format
    * @param selected
+   * @param allFiles
+   *          if true, 'any format' option is included
    */
-  void init(List<String[]> formats, String selected)
+  void init(List<String[]> formats, String selected, boolean allFiles)
   {
 
     JalviewFileFilter chosen = null;
 
     // SelectAllFilter needs to be set first before adding further
     // file filters to fix bug on Mac OSX
-    setAcceptAllFileFilterUsed(true);
+    setAcceptAllFileFilterUsed(allFiles);
 
     for (String[] format : formats)
     {
@@ -233,6 +243,11 @@ public class JalviewFileChooser extends JFileChooser
     }
   }
 
+  /**
+   * Returns the selected file format, or null if none selected
+   * 
+   * @return
+   */
   public FileFormatI getSelectedFormat()
   {
     if (getFileFilter() == null)
@@ -240,47 +255,121 @@ public class JalviewFileChooser extends JFileChooser
       return null;
     }
 
+    /*
+     * logic here depends on option description being formatted as 
+     * formatName (extension, extension...)
+     * or the 'no option selected' value
+     * All Files
+     * @see JalviewFileFilter.getDescription
+     */
     String format = getFileFilter().getDescription();
-    return FileFormat.valueOf(format);
+    int parenPos = format.indexOf("(");
+    if (parenPos > 0)
+    {
+      format = format.substring(0, parenPos).trim();
+      try
+      {
+        return FileFormats.getInstance().forName(format);
+      } catch (IllegalArgumentException e)
+      {
+        System.err.println("Unexpected format: " + format);
+      }
+    }
+    return null;
+  }
+
+  File ourselectedFile = null;
+
+  @Override
+  public File getSelectedFile()
+  {
+    File selfile = super.getSelectedFile();
+    if (selfile == null && ourselectedFile != null)
+    {
+      return ourselectedFile;
+    }
+    return selfile;
   }
 
   @Override
   public int showSaveDialog(Component parent) throws HeadlessException
   {
     this.setAccessory(null);
+    this.setSelectedFile(null);
+    return super.showSaveDialog(parent);
+  }
 
-    setDialogType(SAVE_DIALOG);
+  /**
+   * 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()
+  {
+    if (getDialogType() != SAVE_DIALOG)
+    {
+      super.approveSelection();
+      return;
+    }
 
-    int ret = showDialog(parent, MessageManager.getString("action.save"));
+    ourselectedFile = getSelectedFile();
+
+    if (ourselectedFile == null)
+    {
+      // Workaround for Java 9,10 on OSX - no selected file, but there is a
+      // filename typed in
+      try
+      {
+        String filename = ((BasicFileChooserUI) getUI()).getFileName();
+        if (filename != null && filename.length() > 0)
+        {
+          ourselectedFile = new File(getCurrentDirectory(), filename);
+        }
+      } catch (Throwable x)
+      {
+        System.err.println(
+                "Unexpected exception when trying to get filename.");
+        x.printStackTrace();
+      }
+      // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND
+      // THE
+      // USER PROMPTED FOR A NEW FILENAME
+    }
+    if (ourselectedFile == null)
+    {
+      return;
+    }
 
     if (getFileFilter() instanceof JalviewFileFilter)
     {
       JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
 
-      if (!jvf.accept(getSelectedFile()))
+      if (!jvf.accept(ourselectedFile))
       {
-        String withExtension = getSelectedFile() + "."
+        String withExtension = getSelectedFile().getName() + "."
                 + jvf.getAcceptableExtension();
-        setSelectedFile(new File(withExtension));
+        ourselectedFile = (new File(getCurrentDirectory(), withExtension));
+        setSelectedFile(ourselectedFile);
       }
     }
-    // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
-    // USER PROMPTED FOR A NEW FILENAME
-    if ((ret == JalviewFileChooser.APPROVE_OPTION)
-            && getSelectedFile().exists())
-    {
-      int confirm = JOptionPane.showConfirmDialog(parent,
-              MessageManager.getString("label.overwrite_existing_file"),
-              MessageManager.getString("label.file_already_exists"),
-              JOptionPane.YES_NO_OPTION);
 
-      if (confirm != JOptionPane.YES_OPTION)
+    if (ourselectedFile.exists())
       {
-        ret = JalviewFileChooser.CANCEL_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 ret;
+    super.approveSelection();
   }
 
   void recentListSelectionChanged(Object selection)
@@ -339,8 +428,8 @@ public class JalviewFileChooser extends JFileChooser
         }
       });
 
-      this.setBorder(new javax.swing.border.TitledBorder(MessageManager
-              .getString("label.recently_opened")));
+      this.setBorder(new javax.swing.border.TitledBorder(
+              MessageManager.getString("label.recently_opened")));
 
       final JScrollPane scroller = new JScrollPane(list);
 
@@ -366,8 +455,8 @@ public class JalviewFileChooser extends JFileChooser
         @Override
         public void run()
         {
-          scroller.getHorizontalScrollBar().setValue(
-                  scroller.getHorizontalScrollBar().getMaximum());
+          scroller.getHorizontalScrollBar()
+                  .setValue(scroller.getHorizontalScrollBar().getMaximum());
         }
       });