JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / io / JalviewFileChooser.java
index 7e6bd1b..951b998 100755 (executable)
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+//////////////////////////////////////////////////////////////////
 package jalview.io;
 
-import java.awt.*;
-import java.awt.event.*;
-import java.io.*;
-import java.util.*;
-
-import javax.swing.*;
-import javax.swing.plaf.*;
-import javax.swing.plaf.basic.*;
-import javax.swing.plaf.metal.*;
-import javax.swing.table.*;
-
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+
+import java.awt.Component;
+import java.awt.Dimension;
+import java.awt.EventQueue;
+import java.awt.HeadlessException;
+import java.awt.event.MouseAdapter;
+import java.awt.event.MouseEvent;
+import java.io.File;
+import java.util.StringTokenizer;
+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;
+
+/**
+ * Enhanced file chooser dialog box.
+ *
+ * NOTE: bug on Windows systems when filechooser opened on directory to view
+ * files with colons in title.
+ *
+ * @author AMW
+ *
+ */
 public class JalviewFileChooser extends JFileChooser
 {
+  public JalviewFileChooser(String dir)
+  {
+    super(safePath(dir));
+    setAccessory(new RecentlyOpened());
+  }
 
-  private static final int COLUMN_FILENAME = 0;
-  private static final int COLUMN_FILESIZE = 1;
-  private static final int COLUMN_FILETYPE = 2;
-  private static final int COLUMN_FILEDATE = 3;
-  private static final int COLUMN_FILEATTR = 4;
-  private static final int COLUMN_COLCOUNT = 5;
-  private static String[] COLUMNS = null;
+  private static File safePath(String dir)
+  {
+    if (dir == null)
+    {
+      return null;
+    }
 
-  public JalviewFileChooser(String dir)
+    File f = new File(dir);
+    if (f.getName().indexOf(':') > -1)
+    {
+      return null;
+    }
+    return f;
+  }
+
+  public JalviewFileChooser(String dir, String[] suffix, String[] desc,
+          String selected, boolean selectAll)
+  {
+    super(safePath(dir));
+    init(suffix, desc, selected, selectAll);
+  }
+
+  public JalviewFileChooser(String dir, String[] suffix, String[] desc,
+          String selected)
+  {
+    super(safePath(dir));
+    init(suffix, desc, selected, true);
+  }
+
+  void init(String[] suffix, String[] desc, String selected,
+          boolean selectAll)
   {
-    super(dir);
-    if (COLUMNS == null)
+
+    JalviewFileFilter chosen = null;
+
+    // SelectAllFilter needs to be set first before adding further
+    // file filters to fix bug on Mac OSX
+    setAcceptAllFileFilterUsed(selectAll);
+
+    for (int i = 0; i < suffix.length; i++)
     {
-      Locale l = getLocale();
-      COLUMNS = new String[]{
-        UIManager.getString("FileChooser.fileNameHeaderText",l),
-        UIManager.getString("FileChooser.fileSizeHeaderText",l),
-        UIManager.getString("FileChooser.fileTypeHeaderText",l),
-        UIManager.getString("FileChooser.fileDateHeaderText",l),
-        UIManager.getString("FileChooser.fileAttrHeaderText",l)
-      };
+      JalviewFileFilter jvf = new JalviewFileFilter(suffix[i], desc[i]);
+      addChoosableFileFilter(jvf);
+      if ((selected != null) && selected.equalsIgnoreCase(desc[i]))
+      {
+        chosen = jvf;
+      }
     }
 
+    if (chosen != null)
+    {
+      setFileFilter(chosen);
+    }
+
+    setAccessory(new RecentlyOpened());
   }
 
-  public JalviewFileChooser()
+  @Override
+  public void setFileFilter(javax.swing.filechooser.FileFilter filter)
   {
-    if (COLUMNS == null)
+    super.setFileFilter(filter);
+
+    try
+    {
+      if (getUI() instanceof javax.swing.plaf.basic.BasicFileChooserUI)
+      {
+        final javax.swing.plaf.basic.BasicFileChooserUI ui = (javax.swing.plaf.basic.BasicFileChooserUI) getUI();
+        final String name = ui.getFileName().trim();
+
+        if ((name == null) || (name.length() == 0))
+        {
+          return;
+        }
+
+        EventQueue.invokeLater(new Thread()
+        {
+          @Override
+          public void run()
+          {
+            String currentName = ui.getFileName();
+            if ((currentName == null) || (currentName.length() == 0))
+            {
+              ui.setFileName(name);
+            }
+          }
+        });
+      }
+    } catch (Exception ex)
     {
-      Locale l = getLocale();
-      COLUMNS = new String[]{
-        UIManager.getString("FileChooser.fileNameHeaderText",l),
-        UIManager.getString("FileChooser.fileSizeHeaderText",l),
-        UIManager.getString("FileChooser.fileTypeHeaderText",l),
-        UIManager.getString("FileChooser.fileDateHeaderText",l),
-        UIManager.getString("FileChooser.fileAttrHeaderText",l)
-      };
+      ex.printStackTrace();
+      // Some platforms do not have BasicFileChooserUI
     }
   }
 
+  public String getSelectedFormat()
+  {
+    if (getFileFilter() == null)
+    {
+      return null;
+    }
 
-  /**************************************************************************
-   * Always create the local UI
-   * @param comp
-   *************************************************************************/
-  public final void setUI(ComponentUI comp)
+    String format = getFileFilter().getDescription();
+
+    if (format.toUpperCase().startsWith("JALVIEW"))
+    {
+      format = "Jalview";
+    }
+    else if (format.toUpperCase().startsWith("FASTA"))
+    {
+      format = "FASTA";
+    }
+    else if (format.toUpperCase().startsWith("MSF"))
+    {
+      format = "MSF";
+    }
+    else if (format.toUpperCase().startsWith("CLUSTAL"))
+    {
+      format = "CLUSTAL";
+    }
+    else if (format.toUpperCase().startsWith("BLC"))
+    {
+      format = "BLC";
+    }
+    else if (format.toUpperCase().startsWith("PIR"))
+    {
+      format = "PIR";
+    }
+    else if (format.toUpperCase().startsWith("PFAM"))
+    {
+      format = "PFAM";
+    }
+    else if (format.toUpperCase().startsWith(PhylipFile.FILE_DESC))
+    {
+      format = PhylipFile.FILE_DESC;
+    }
+
+    return format;
+  }
+
+  @Override
+  public int showSaveDialog(Component parent) throws HeadlessException
   {
-    super.setUI(new UI(this));
+    this.setAccessory(null);
+
+    setDialogType(SAVE_DIALOG);
+
+    int ret = showDialog(parent, MessageManager.getString("action.save"));
+
+    if (getFileFilter() instanceof JalviewFileFilter)
+    {
+      JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
+
+      if (!jvf.accept(getSelectedFile()))
+      {
+        String withExtension = getSelectedFile() + "."
+                + jvf.getAcceptableExtension();
+        setSelectedFile(new File(withExtension));
+      }
+    }
+    // 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)
+      {
+        ret = JalviewFileChooser.CANCEL_OPTION;
+      }
+    }
+
+    return ret;
   }
 
-   /**************************************************************************
-    * Internal implementation of Metal LookAndFeel to create the table sorting
-    * ability.
-    *************************************************************************/
-   private final static class UI extends MetalFileChooserUI
-   {
-     private DirectoryModel model;
-
-     /**************************************************************************
-      * Must be overridden to extend
-      * @param e
-      *************************************************************************/
-     public UI(JFileChooser e)
-     {
-       super(e);
-     }
-
-     /**************************************************************************
-      * Overridden to create our own model
-      *************************************************************************/
-     protected final void createModel()
-     {
-       model = new DirectoryModel(getFileChooser());
-     }
-
-     /**************************************************************************
-      * Overridden to get our own model
-      * @return
-      *************************************************************************/
-     public final BasicDirectoryModel getModel() {       return model;     }
-
-     /**************************************************************************
-      * Calls the default method then adds a MouseListener to the JTable
-      * @param chooser
-      * @return
-      *************************************************************************/
-     protected final JPanel createDetailsView(JFileChooser chooser)
-     {
-       final JPanel panel = super.createDetailsView(chooser);
-
-       //Since we can't access MetalFileChooserUI's private member detailsTable
-       //directly, we have to find it in the JPanel
-       final JTable tbl = findJTable(panel.getComponents());
-       if (tbl != null)
-       {
-         //Fix the columns so they can't be rearranged, if we don't do this
-         //we would need to keep track when each column is moved
-         tbl.getTableHeader().setReorderingAllowed(false);
-
-         //Add a mouselistener to listen for clicks on column headers
-         tbl.getTableHeader().addMouseListener(new MouseAdapter(){
-           public void mouseClicked(MouseEvent e)
-           {
-             //Only process single clicks
-             if (e.getClickCount() > 1) return;
-             e.consume();
-             final int col = tbl.getTableHeader().columnAtPoint(e.getPoint());
-             if (col == COLUMN_FILENAME || col == COLUMN_FILESIZE ||
-                 col == COLUMN_FILEDATE)
-               model.sort(col,tbl);
-           }
-         });
-       }
-       return panel;
-     }
-
-     /**************************************************************************
-      * Finds the JTable in the panel so we can add MouseListener
-      * @param comp
-      * @return
-      *************************************************************************/
-     private final static JTable findJTable(Component[] comp)
-     {
-       for (int i=0;i<comp.length;i++)
-       {
-         if (comp[i] instanceof JTable)
-         {
-           return (JTable)comp[i];
-         }
-         if (comp[i] instanceof Container)
-         {
-           JTable tbl = findJTable(((Container)comp[i]).getComponents());
-           if (tbl != null) return tbl;
-         }
-       }
-       return null;
-     }
-   }
-
-  /***************************************************************************
-   * Implementation of BasicDirectoryModel that sorts the Files by column
-   **************************************************************************/
-  private final static class DirectoryModel extends BasicDirectoryModel
-   {
-     int col = 0;
-     boolean ascending;
-
-     /**************************************************************************
-      * Must be overridden to extend BasicDirectoryModel
-      * @param chooser
-      *************************************************************************/
-     DirectoryModel(JFileChooser chooser)
-     {
-       super(chooser);
-     }
-
-
-     /**************************************************************************
-      * Supposedly this is not used anymore, hopefully not.  We implemented
-      * some basic attempt at sorting just in case
-      * @param a
-      * @param b
-      * @return
-      *************************************************************************/
-     protected final boolean lt(File a, File b)
-     {
-       System.out.println("LT called?");
-       boolean less = false;
-       switch (col)
-       {
-         case COLUMN_FILEDATE:
-           less = a.lastModified() > b.lastModified();
-           break;
-         case COLUMN_FILESIZE:
-           less = a.length() > b.length();
-           break;
-         default:
-           less = a.getName().compareToIgnoreCase(b.getName()) > 0;
-         break;
-       }
-       if (ascending) return less = !less;
-       return less;
-     }
-
-     /**************************************************************************
-      * Resorts the JFileChooser table based on new column
-      * @param c
-      *************************************************************************/
-     protected final void sort(int c, JTable tbl)
-     {
-       //Set column and order
-       col = c;
-       ascending = !ascending;
-       String indicator = " (^)";
-       if (ascending)
-         indicator = " (v)";
-
-       final JTableHeader th = tbl.getTableHeader();
-       final TableColumnModel tcm = th.getColumnModel();
-
-       for (int i=0;i<JalviewFileChooser.COLUMN_COLCOUNT;i++)
-       {
-         final TableColumn tc = tcm.getColumn( i ); // the column to change
-         tc.setHeaderValue( COLUMNS[i] );
-       }
-
-       final TableColumn tc = tcm.getColumn( col ); // the column to change
-       tc.setHeaderValue( COLUMNS[col] + indicator );
-
-       th.repaint();
-
-       //Requery the file listing
-       validateFileCache();
-     }
-
-     /**************************************************************************
-      * Sorts the data based on current column setting
-      * @param data
-      *************************************************************************/
-     protected final void sort(Vector data)
-     {
-       switch (col)
-       {
-         case COLUMN_FILEDATE:
-           Collections.sort(data,new Comparator(){
-             public int compare(Object o1,Object o2)
-             {
-               int ret = 1;
-               final File a = (File)o1;
-               final File b = (File)o2;
-               if (a.lastModified() > b.lastModified())
-                 ret = -1;
-               else if (a.lastModified() == b.lastModified())
-                 ret = 0;
-
-               if (ascending)
-                 ret *= -1;
-               return ret;
-             }
-
-           });
-           break;
-         case COLUMN_FILESIZE:
-           Collections.sort(data,new Comparator(){
-             public int compare(Object o1,Object o2)
-             {
-               int ret = 1;
-               final File a = (File)o1;
-               final File b = (File)o2;
-               if (a.length() > b.length())
-                 ret = -1;
-               else if (a.length() == b.length())
-                 ret = 0;
-
-               if (ascending)
-                 ret *= -1;
-               return ret;
-             }
-
-           });
-           break;
-         case COLUMN_FILENAME:
-           Collections.sort(data,new Comparator(){
-             public int compare(Object o1,Object o2)
-             {
-               final File a = (File)o1;
-               final File b = (File)o2;
-               if (ascending)
-                 return a.getName().compareToIgnoreCase(b.getName());
-               else
-                 return -1 * a.getName().compareToIgnoreCase(b.getName());
-             }
-
-           });
-           break;
-       }
-     }
+  void recentListSelectionChanged(Object selection)
+  {
+    setSelectedFile(null);
+    if (selection != null)
+    {
+      File file = new File((String) selection);
+      if (getFileFilter() instanceof JalviewFileFilter)
+      {
+        JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
+
+        if (!jvf.accept(file))
+        {
+          setFileFilter(getChoosableFileFilters()[0]);
+        }
+      }
+
+      setSelectedFile(file);
+    }
   }
-}
 
+  class RecentlyOpened extends JPanel
+  {
+    JList list;
+
+    public RecentlyOpened()
+    {
+
+      String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
+      StringTokenizer st;
+      Vector recent = new Vector();
+
+      if (historyItems != null)
+      {
+        st = new StringTokenizer(historyItems, "\t");
+
+        while (st.hasMoreTokens())
+        {
+          recent.addElement(st.nextElement());
+        }
+      }
+
+      list = new JList(recent);
+
+      DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
+      dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
+      list.setCellRenderer(dlcr);
+
+      list.addMouseListener(new MouseAdapter()
+      {
+        @Override
+        public void mousePressed(MouseEvent evt)
+        {
+          recentListSelectionChanged(list.getSelectedValue());
+        }
+      });
+
+      this.setBorder(new javax.swing.border.TitledBorder(MessageManager
+              .getString("label.recently_opened")));
+
+      final JScrollPane scroller = new JScrollPane(list);
+
+      SpringLayout layout = new SpringLayout();
+      layout.putConstraint(SpringLayout.WEST, scroller, 5,
+              SpringLayout.WEST, this);
+      layout.putConstraint(SpringLayout.NORTH, scroller, 5,
+              SpringLayout.NORTH, this);
+
+      if (new Platform().isAMac())
+      {
+        scroller.setPreferredSize(new Dimension(500, 100));
+      }
+      else
+      {
+        scroller.setPreferredSize(new Dimension(130, 200));
+      }
+
+      this.add(scroller);
+
+      javax.swing.SwingUtilities.invokeLater(new Runnable()
+      {
+        @Override
+        public void run()
+        {
+          scroller.getHorizontalScrollBar().setValue(
+                  scroller.getHorizontalScrollBar().getMaximum());
+        }
+      });
+
+    }
+
+  }
+}