2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 //////////////////////////////////////////////////////////////////
24 import jalview.bin.Cache;
25 import jalview.gui.JvOptionPane;
26 import jalview.util.MessageManager;
27 import jalview.util.Platform;
29 import java.awt.Component;
30 import java.awt.Dimension;
31 import java.awt.EventQueue;
32 import java.awt.HeadlessException;
33 import java.awt.event.MouseAdapter;
34 import java.awt.event.MouseEvent;
36 import java.util.ArrayList;
37 import java.util.List;
38 import java.util.StringTokenizer;
39 import java.util.Vector;
41 import javax.swing.DefaultListCellRenderer;
42 import javax.swing.JFileChooser;
43 import javax.swing.JList;
44 import javax.swing.JPanel;
45 import javax.swing.JScrollPane;
46 import javax.swing.SpringLayout;
47 import javax.swing.plaf.basic.BasicFileChooserUI;
50 * Enhanced file chooser dialog box.
52 * NOTE: bug on Windows systems when filechooser opened on directory to view
53 * files with colons in title.
58 public class JalviewFileChooser extends JFileChooser
61 * Factory method to return a file chooser that offers readable alignment file
68 public static JalviewFileChooser forRead(String directory, String selected)
70 List<String> extensions = new ArrayList<String>();
71 List<String> descs = new ArrayList<String>();
72 for (FileFormatI format : FileFormats.getInstance().getFormats())
74 if (format.isReadable())
76 extensions.add(format.getExtensions());
77 descs.add(format.getName());
80 return new JalviewFileChooser(directory,
81 extensions.toArray(new String[extensions.size()]),
82 descs.toArray(new String[descs.size()]), selected, true);
86 * Factory method to return a file chooser that offers writable alignment file
93 public static JalviewFileChooser forWrite(String directory,
96 // TODO in Java 8, forRead and forWrite can be a single method
97 // with a lambda expression parameter for isReadable/isWritable
98 List<String> extensions = new ArrayList<String>();
99 List<String> descs = new ArrayList<String>();
100 for (FileFormatI format : FileFormats.getInstance().getFormats())
102 if (format.isWritable())
104 extensions.add(format.getExtensions());
105 descs.add(format.getName());
108 return new JalviewFileChooser(directory,
109 extensions.toArray(new String[extensions.size()]),
110 descs.toArray(new String[descs.size()]), selected, false);
113 public JalviewFileChooser(String dir)
115 super(safePath(dir));
116 setAccessory(new RecentlyOpened());
119 public JalviewFileChooser(String dir, String[] suffix, String[] desc,
122 this(dir, suffix, desc, selected, true);
126 * Constructor for a single choice of file extension and description
131 public JalviewFileChooser(String extension, String desc)
133 this(Cache.getProperty("LAST_DIRECTORY"), new String[] { extension },
134 new String[] { desc }, desc, true);
137 JalviewFileChooser(String dir, String[] extensions, String[] descs,
138 String selected, boolean allFiles)
140 super(safePath(dir));
141 if (extensions.length == descs.length)
143 List<String[]> formats = new ArrayList<String[]>();
144 for (int i = 0; i < extensions.length; i++)
146 formats.add(new String[] { extensions[i], descs[i] });
148 init(formats, selected, allFiles);
152 System.err.println("JalviewFileChooser arguments mismatch: "
153 + extensions + ", " + descs);
157 private static File safePath(String dir)
164 File f = new File(dir);
165 if (f.getName().indexOf(':') > -1)
175 * a list of {extensions, description} for each file format
178 * if true, 'any format' option is included
180 void init(List<String[]> formats, String selected, boolean allFiles)
183 JalviewFileFilter chosen = null;
185 // SelectAllFilter needs to be set first before adding further
186 // file filters to fix bug on Mac OSX
187 setAcceptAllFileFilterUsed(allFiles);
189 for (String[] format : formats)
191 JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
192 addChoosableFileFilter(jvf);
193 if ((selected != null) && selected.equalsIgnoreCase(format[1]))
201 setFileFilter(chosen);
204 setAccessory(new RecentlyOpened());
208 public void setFileFilter(javax.swing.filechooser.FileFilter filter)
210 super.setFileFilter(filter);
214 if (getUI() instanceof BasicFileChooserUI)
216 final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI();
217 final String name = fcui.getFileName().trim();
219 if ((name == null) || (name.length() == 0))
224 EventQueue.invokeLater(new Thread()
229 String currentName = fcui.getFileName();
230 if ((currentName == null) || (currentName.length() == 0))
232 fcui.setFileName(name);
237 } catch (Exception ex)
239 ex.printStackTrace();
240 // Some platforms do not have BasicFileChooserUI
245 * Returns the selected file format, or null if none selected
249 public FileFormatI getSelectedFormat()
251 if (getFileFilter() == null)
257 * logic here depends on option description being formatted as
258 * formatName (extension, extension...)
259 * or the 'no option selected' value
261 * @see JalviewFileFilter.getDescription
263 String format = getFileFilter().getDescription();
264 int parenPos = format.indexOf("(");
267 format = format.substring(0, parenPos).trim();
270 return FileFormats.getInstance().forName(format);
271 } catch (IllegalArgumentException e)
273 System.err.println("Unexpected format: " + format);
280 public int showSaveDialog(Component parent) throws HeadlessException
282 this.setAccessory(null);
284 setDialogType(SAVE_DIALOG);
286 int ret = showDialog(parent, MessageManager.getString("action.save"));
288 if (getFileFilter() instanceof JalviewFileFilter)
290 JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
292 if (!jvf.accept(getSelectedFile()))
294 String withExtension = getSelectedFile() + "."
295 + jvf.getAcceptableExtension();
296 setSelectedFile(new File(withExtension));
299 // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
300 // USER PROMPTED FOR A NEW FILENAME
301 if ((ret == JalviewFileChooser.APPROVE_OPTION)
302 && getSelectedFile().exists())
304 int confirm = JvOptionPane.showConfirmDialog(parent,
305 MessageManager.getString("label.overwrite_existing_file"),
306 MessageManager.getString("label.file_already_exists"),
307 JvOptionPane.YES_NO_OPTION);
309 if (confirm != JvOptionPane.YES_OPTION)
311 ret = JalviewFileChooser.CANCEL_OPTION;
318 void recentListSelectionChanged(Object selection)
320 setSelectedFile(null);
321 if (selection != null)
323 File file = new File((String) selection);
324 if (getFileFilter() instanceof JalviewFileFilter)
326 JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
328 if (!jvf.accept(file))
330 setFileFilter(getChoosableFileFilters()[0]);
334 setSelectedFile(file);
338 class RecentlyOpened extends JPanel
342 public RecentlyOpened()
345 String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
347 Vector recent = new Vector();
349 if (historyItems != null)
351 st = new StringTokenizer(historyItems, "\t");
353 while (st.hasMoreTokens())
355 recent.addElement(st.nextElement());
359 list = new JList(recent);
361 DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
362 dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
363 list.setCellRenderer(dlcr);
365 list.addMouseListener(new MouseAdapter()
368 public void mousePressed(MouseEvent evt)
370 recentListSelectionChanged(list.getSelectedValue());
374 this.setBorder(new javax.swing.border.TitledBorder(MessageManager
375 .getString("label.recently_opened")));
377 final JScrollPane scroller = new JScrollPane(list);
379 SpringLayout layout = new SpringLayout();
380 layout.putConstraint(SpringLayout.WEST, scroller, 5,
381 SpringLayout.WEST, this);
382 layout.putConstraint(SpringLayout.NORTH, scroller, 5,
383 SpringLayout.NORTH, this);
385 if (new Platform().isAMac())
387 scroller.setPreferredSize(new Dimension(500, 100));
391 scroller.setPreferredSize(new Dimension(130, 200));
396 javax.swing.SwingUtilities.invokeLater(new Runnable()
401 scroller.getHorizontalScrollBar().setValue(
402 scroller.getHorizontalScrollBar().getMaximum());