src/jalview/io/JalviewFileChooser.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 //////////////////////////////////////////////////////////////////
  22 package jalview.io;
  23
  24 import jalview.util.MessageManager;
  25 import jalview.util.Platform;
  26
  27 import java.awt.Component;
  28 import java.awt.Dimension;
  29 import java.awt.EventQueue;
  30 import java.awt.HeadlessException;
  31 import java.awt.event.MouseAdapter;
  32 import java.awt.event.MouseEvent;
  33 import java.io.File;
  34 import java.util.StringTokenizer;
  35 import java.util.Vector;
  36
  37 import javax.swing.DefaultListCellRenderer;
  38 import javax.swing.JFileChooser;
  39 import javax.swing.JList;
  40 import javax.swing.JOptionPane;
  41 import javax.swing.JPanel;
  42 import javax.swing.JScrollPane;
  43 import javax.swing.SpringLayout;
  44
  45 /**
  46  * Enhanced file chooser dialog box.
  47  *
  48  * NOTE: bug on Windows systems when filechooser opened on directory to view
  49  * files with colons in title.
  50  *
  51  * @author AMW
  52  *
  53  */
  54 public class JalviewFileChooser extends JFileChooser
  55 {
  56   public JalviewFileChooser(String dir)
  57   {
  58     super(safePath(dir));
  59     setAccessory(new RecentlyOpened());
  60   }
  61
  62   private static File safePath(String dir)
  63   {
  64     if (dir == null)
  65     {
  66       return null;
  67     }
  68
  69     File f = new File(dir);
  70     if (f.getName().indexOf(':') > -1)
  71     {
  72       return null;
  73     }
  74     return f;
  75   }
  76
  77   public JalviewFileChooser(String dir, String[] suffix, String[] desc,
  78           String selected, boolean selectAll)
  79   {
  80     super(safePath(dir));
  81     init(suffix, desc, selected, selectAll);
  82   }
  83
  84   public JalviewFileChooser(String dir, String[] suffix, String[] desc,
  85           String selected)
  86   {
  87     super(safePath(dir));
  88     init(suffix, desc, selected, true);
  89   }
  90
  91   void init(String[] suffix, String[] desc, String selected,
  92           boolean selectAll)
  93   {
  94
  95     JalviewFileFilter chosen = null;
  96
  97     // SelectAllFilter needs to be set first before adding further
  98     // file filters to fix bug on Mac OSX
  99     setAcceptAllFileFilterUsed(selectAll);
 100
 101     for (int i = 0; i < suffix.length; i++)
 102     {
 103       JalviewFileFilter jvf = new JalviewFileFilter(suffix[i], desc[i]);
 104       addChoosableFileFilter(jvf);
 105       if ((selected != null) && selected.equalsIgnoreCase(desc[i]))
 106       {
 107         chosen = jvf;
 108       }
 109     }
 110
 111     if (chosen != null)
 112     {
 113       setFileFilter(chosen);
 114     }
 115
 116     setAccessory(new RecentlyOpened());
 117   }
 118
 119   @Override
 120   public void setFileFilter(javax.swing.filechooser.FileFilter filter)
 121   {
 122     super.setFileFilter(filter);
 123
 124     try
 125     {
 126       if (getUI() instanceof javax.swing.plaf.basic.BasicFileChooserUI)
 127       {
 128         final javax.swing.plaf.basic.BasicFileChooserUI ui = (javax.swing.plaf.basic.BasicFileChooserUI) getUI();
 129         final String name = ui.getFileName().trim();
 130
 131         if ((name == null) || (name.length() == 0))
 132         {
 133           return;
 134         }
 135
 136         EventQueue.invokeLater(new Thread()
 137         {
 138           @Override
 139           public void run()
 140           {
 141             String currentName = ui.getFileName();
 142             if ((currentName == null) || (currentName.length() == 0))
 143             {
 144               ui.setFileName(name);
 145             }
 146           }
 147         });
 148       }
 149     } catch (Exception ex)
 150     {
 151       ex.printStackTrace();
 152       // Some platforms do not have BasicFileChooserUI
 153     }
 154   }
 155
 156   public FileFormat getSelectedFormat()
 157   {
 158     if (getFileFilter() == null)
 159     {
 160       return null;
 161     }
 162
 163     String format = getFileFilter().getDescription();
 164     return FileFormat.valueOf(format);
 165   }
 166
 167   @Override
 168   public int showSaveDialog(Component parent) throws HeadlessException
 169   {
 170     this.setAccessory(null);
 171
 172     setDialogType(SAVE_DIALOG);
 173
 174     int ret = showDialog(parent, MessageManager.getString("action.save"));
 175
 176     if (getFileFilter() instanceof JalviewFileFilter)
 177     {
 178       JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
 179
 180       if (!jvf.accept(getSelectedFile()))
 181       {
 182         String withExtension = getSelectedFile() + "."
 183                 + jvf.getAcceptableExtension();
 184         setSelectedFile(new File(withExtension));
 185       }
 186     }
 187     // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
 188     // USER PROMPTED FOR A NEW FILENAME
 189     if ((ret == JalviewFileChooser.APPROVE_OPTION)
 190             && getSelectedFile().exists())
 191     {
 192       int confirm = JOptionPane.showConfirmDialog(parent,
 193               MessageManager.getString("label.overwrite_existing_file"),
 194               MessageManager.getString("label.file_already_exists"),
 195               JOptionPane.YES_NO_OPTION);
 196
 197       if (confirm != JOptionPane.YES_OPTION)
 198       {
 199         ret = JalviewFileChooser.CANCEL_OPTION;
 200       }
 201     }
 202
 203     return ret;
 204   }
 205
 206   void recentListSelectionChanged(Object selection)
 207   {
 208     setSelectedFile(null);
 209     if (selection != null)
 210     {
 211       File file = new File((String) selection);
 212       if (getFileFilter() instanceof JalviewFileFilter)
 213       {
 214         JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
 215
 216         if (!jvf.accept(file))
 217         {
 218           setFileFilter(getChoosableFileFilters()[0]);
 219         }
 220       }
 221
 222       setSelectedFile(file);
 223     }
 224   }
 225
 226   class RecentlyOpened extends JPanel
 227   {
 228     JList list;
 229
 230     public RecentlyOpened()
 231     {
 232
 233       String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
 234       StringTokenizer st;
 235       Vector recent = new Vector();
 236
 237       if (historyItems != null)
 238       {
 239         st = new StringTokenizer(historyItems, "\t");
 240
 241         while (st.hasMoreTokens())
 242         {
 243           recent.addElement(st.nextElement());
 244         }
 245       }
 246
 247       list = new JList(recent);
 248
 249       DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
 250       dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
 251       list.setCellRenderer(dlcr);
 252
 253       list.addMouseListener(new MouseAdapter()
 254       {
 255         @Override
 256         public void mousePressed(MouseEvent evt)
 257         {
 258           recentListSelectionChanged(list.getSelectedValue());
 259         }
 260       });
 261
 262       this.setBorder(new javax.swing.border.TitledBorder(MessageManager
 263               .getString("label.recently_opened")));
 264
 265       final JScrollPane scroller = new JScrollPane(list);
 266
 267       SpringLayout layout = new SpringLayout();
 268       layout.putConstraint(SpringLayout.WEST, scroller, 5,
 269               SpringLayout.WEST, this);
 270       layout.putConstraint(SpringLayout.NORTH, scroller, 5,
 271               SpringLayout.NORTH, this);
 272
 273       if (new Platform().isAMac())
 274       {
 275         scroller.setPreferredSize(new Dimension(500, 100));
 276       }
 277       else
 278       {
 279         scroller.setPreferredSize(new Dimension(130, 200));
 280       }
 281
 282       this.add(scroller);
 283
 284       javax.swing.SwingUtilities.invokeLater(new Runnable()
 285       {
 286         @Override
 287         public void run()
 288         {
 289           scroller.getHorizontalScrollBar().setValue(
 290                   scroller.getHorizontalScrollBar().getMaximum());
 291         }
 292       });
 293
 294     }
 295
 296   }
 297 }