Merge branch 'feature/JAL-3169cancelOverwrite' into

JAL-3048dialogRunner2

Conflicts:
	src/jalview/io/JalviewFileChooser.java

diff --git a/src/jalview/io/JalviewFileChooser.java b/src/jalview/io/JalviewFileChooser.java
index 73a99e3..8e0fe30 100755 (executable)
--- a/src/jalview/io/JalviewFileChooser.java
+++ b/src/jalview/io/JalviewFileChooser.java
@@ -50,6 +50,8 @@ 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.plaf.basic.BasicFileChooserUI;
 
 /**
@@ -64,6 +66,8 @@ import javax.swing.plaf.basic.BasicFileChooserUI;
 public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
     PropertyChangeListener
 {
+  private static final long serialVersionUID = 1L;
+
   private DialogRunnerI runner = new DialogRunner();
   
   File selectedFile = null;
@@ -396,34 +400,81 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
   public int showSaveDialog(Component parent) throws HeadlessException
   {
     this.setAccessory(null);
+    this.setSelectedFile(null);
+    return super.showSaveDialog(parent);
+  }
 
-    /*
-     * Save dialog is opened until user picks a file format 
-     */
-    /*
-    if (!runner.isRegistered(overwriteCheck))
+  /**
+   * 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)
     {
-      // first call for this instance
-      runner.setFirstResponse(overwriteCheck);
+      super.approveSelection();
+      return;
     }
-    else
+
+    selectedFile = getSelectedFile();
+
+    if (selectedFile == null)
     {
-      // reset response flags
-      runner.resetResponses();
+      // 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)
+        {
+          selectedFile = 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
     }
-*/
- //   runner.addResponse(overwriteCheck);
-//    setDialogType(SAVE_DIALOG);
-    
-    // Java 9,10,11 on OSX - clear selected file so name isn't auto populated
-    this.setSelectedFile(null);
- 
-    int value = super.showSaveDialog(parent);//, MessageManager.getString("action.save"));
-    if (!Jalview.isJS())
+
+    if (selectedFile == null)
     {
-      runner.handleResponse(value);
+      return;
     }
-    return value;
+
+    if (getFileFilter() instanceof JalviewFileFilter)
+    {
+      JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
+
+      if (!jvf.accept(selectedFile))
+      {
+        String withExtension = getSelectedFile().getName() + "."
+                + jvf.getAcceptableExtension();
+        selectedFile = (new File(getCurrentDirectory(), withExtension));
+        setSelectedFile(selectedFile);
+      }
+    }
+
+    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;
+      }
+    }
+
+    super.approveSelection();
   }
 
   void recentListSelectionChanged(Object selection)
@@ -446,21 +497,28 @@ 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;
+
     JList<String> list;
 
-    public RecentlyOpened()
+    RecentlyOpened()
     {
-
-      String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
+      String historyItems = Cache.getProperty("RECENT_FILE");
       StringTokenizer st;
       Vector<String> recent = new Vector<>();
 
       if (historyItems != null)
       {
         st = new StringTokenizer(historyItems, "\t");
-
         while (st.hasMoreTokens())
         {
           recent.addElement(st.nextToken());
@@ -482,7 +540,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
         }
       });
 
-      this.setBorder(new javax.swing.border.TitledBorder(
+      this.setBorder(new TitledBorder(
               MessageManager.getString("label.recently_opened")));
 
       final JScrollPane scroller = new JScrollPane(list);
@@ -504,7 +562,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
 
       this.add(scroller);
 
-      javax.swing.SwingUtilities.invokeLater(new Runnable()
+      SwingUtilities.invokeLater(new Runnable()
       {
         @Override
         public void run()
@@ -513,9 +571,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
                   .setValue(scroller.getHorizontalScrollBar().getMaximum());
         }
       });
-
     }
-
   }
 
   @Override
@@ -542,25 +598,4 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
       break;
     }
   }
-
-       @Override
-       public void approveSelection() 
-       {
-               if (getDialogType() == SAVE_DIALOG && !Jalview.isJS()) 
-               {
-                       File selectedFile = getSelectedFile();
-                       if ((selectedFile != null) && 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;
-                               }
-                       }
-               }
-               super.approveSelection();
-       }
 }