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.gui.JvOptionPane;
25 import jalview.util.MessageManager;
26 import jalview.util.Platform;
28 import java.awt.Component;
29 import java.awt.Dimension;
30 import java.awt.EventQueue;
31 import java.awt.HeadlessException;
32 import java.awt.event.MouseAdapter;
33 import java.awt.event.MouseEvent;
35 import java.util.ArrayList;
36 import java.util.List;
37 import java.util.StringTokenizer;
38 import java.util.Vector;
40 import javax.swing.DefaultListCellRenderer;
41 import javax.swing.JFileChooser;
42 import javax.swing.JList;
43 import javax.swing.JPanel;
44 import javax.swing.JScrollPane;
45 import javax.swing.SpringLayout;
46 import javax.swing.plaf.basic.BasicFileChooserUI;
49 * Enhanced file chooser dialog box.
51 * NOTE: bug on Windows systems when filechooser opened on directory to view
52 * files with colons in title.
57 public class JalviewFileChooser extends JFileChooser
60 * Factory method to return a file chooser that offers readable alignment file
67 public static JalviewFileChooser forRead(String directory, String selected)
69 List<String> extensions = new ArrayList<String>();
70 List<String> descs = new ArrayList<String>();
71 for (FileFormatI format : FileFormats.getInstance().getFormats())
73 if (format.isReadable())
75 extensions.add(format.getExtensions());
76 descs.add(format.getName());
79 return new JalviewFileChooser(directory,
80 extensions.toArray(new String[extensions.size()]),
81 descs.toArray(new String[descs.size()]), selected, true);
85 * Factory method to return a file chooser that offers writable alignment file
92 public static JalviewFileChooser forWrite(String directory,
95 // TODO in Java 8, forRead and forWrite can be a single method
96 // with a lambda expression parameter for isReadable/isWritable
97 List<String> extensions = new ArrayList<String>();
98 List<String> descs = new ArrayList<String>();
99 for (FileFormatI format : FileFormats.getInstance().getFormats())
101 if (format.isWritable())
103 extensions.add(format.getExtensions());
104 descs.add(format.getName());
107 return new JalviewFileChooser(directory,
108 extensions.toArray(new String[extensions.size()]),
109 descs.toArray(new String[descs.size()]), selected, false);
112 public JalviewFileChooser(String dir)
114 super(safePath(dir));
115 setAccessory(new RecentlyOpened());
118 public JalviewFileChooser(String dir, String[] suffix, String[] desc,
121 this(dir, suffix, desc, selected, true);
125 * Constructor for a single choice of file extension and description
131 public JalviewFileChooser(String dir, String extension, String desc)
133 // TODO inline dir as Cache.getProperty("LAST_DIRECTORY") ? if applet
135 this(dir, new String[] { extension }, new String[] { desc }, desc,
139 JalviewFileChooser(String dir, String[] extensions, String[] descs,
140 String selected, boolean allFiles)
142 super(safePath(dir));
143 if (extensions.length == descs.length)
145 List<String[]> formats = new ArrayList<String[]>();
146 for (int i = 0; i < extensions.length; i++)
148 formats.add(new String[] { extensions[i], descs[i] });
150 init(formats, selected, allFiles);
154 System.err.println("JalviewFileChooser arguments mismatch: "
155 + extensions + ", " + descs);
159 private static File safePath(String dir)
166 File f = new File(dir);
167 if (f.getName().indexOf(':') > -1)
177 * a list of {extensions, description} for each file format
180 * if true, 'any format' option is included
182 void init(List<String[]> formats, String selected, boolean allFiles)
185 JalviewFileFilter chosen = null;
187 // SelectAllFilter needs to be set first before adding further
188 // file filters to fix bug on Mac OSX
189 setAcceptAllFileFilterUsed(allFiles);
191 for (String[] format : formats)
193 JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
194 addChoosableFileFilter(jvf);
195 if ((selected != null) && selected.equalsIgnoreCase(format[1]))
203 setFileFilter(chosen);
206 setAccessory(new RecentlyOpened());
210 public void setFileFilter(javax.swing.filechooser.FileFilter filter)
212 super.setFileFilter(filter);
216 if (getUI() instanceof BasicFileChooserUI)
218 final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI();
219 final String name = fcui.getFileName().trim();
221 if ((name == null) || (name.length() == 0))
226 EventQueue.invokeLater(new Thread()
231 String currentName = fcui.getFileName();
232 if ((currentName == null) || (currentName.length() == 0))
234 fcui.setFileName(name);
239 } catch (Exception ex)
241 ex.printStackTrace();
242 // Some platforms do not have BasicFileChooserUI
247 * Returns the selected file format, or null if none selected
251 public FileFormatI getSelectedFormat()
253 if (getFileFilter() == null)
259 * logic here depends on option description being formatted as
260 * formatName (extension, extension...)
261 * or the 'no option selected' value
263 * @see JalviewFileFilter.getDescription
265 String format = getFileFilter().getDescription();
266 int parenPos = format.indexOf("(");
269 format = format.substring(0, parenPos).trim();
272 return FileFormats.getInstance().forName(format);
273 } catch (IllegalArgumentException e)
275 System.err.println("Unexpected format: " + format);
282 public int showSaveDialog(Component parent) throws HeadlessException
284 this.setAccessory(null);
286 setDialogType(SAVE_DIALOG);
288 int ret = showDialog(parent, MessageManager.getString("action.save"));
290 if (getFileFilter() instanceof JalviewFileFilter)
292 JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
294 if (!jvf.accept(getSelectedFile()))
296 String withExtension = getSelectedFile() + "."
297 + jvf.getAcceptableExtension();
298 setSelectedFile(new File(withExtension));
301 // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
302 // USER PROMPTED FOR A NEW FILENAME
303 if ((ret == JalviewFileChooser.APPROVE_OPTION)
304 && getSelectedFile().exists())
306 int confirm = JvOptionPane.showConfirmDialog(parent,
307 MessageManager.getString("label.overwrite_existing_file"),
308 MessageManager.getString("label.file_already_exists"),
309 JvOptionPane.YES_NO_OPTION);
311 if (confirm != JvOptionPane.YES_OPTION)
313 ret = JalviewFileChooser.CANCEL_OPTION;
320 void recentListSelectionChanged(Object selection)
322 setSelectedFile(null);
323 if (selection != null)
325 File file = new File((String) selection);
326 if (getFileFilter() instanceof JalviewFileFilter)
328 JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
330 if (!jvf.accept(file))
332 setFileFilter(getChoosableFileFilters()[0]);
336 setSelectedFile(file);
340 class RecentlyOpened extends JPanel
344 public RecentlyOpened()
347 String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
349 Vector recent = new Vector();
351 if (historyItems != null)
353 st = new StringTokenizer(historyItems, "\t");
355 while (st.hasMoreTokens())
357 recent.addElement(st.nextElement());
361 list = new JList(recent);
363 DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
364 dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
365 list.setCellRenderer(dlcr);
367 list.addMouseListener(new MouseAdapter()
370 public void mousePressed(MouseEvent evt)
372 recentListSelectionChanged(list.getSelectedValue());
376 this.setBorder(new javax.swing.border.TitledBorder(MessageManager
377 .getString("label.recently_opened")));
379 final JScrollPane scroller = new JScrollPane(list);
381 SpringLayout layout = new SpringLayout();
382 layout.putConstraint(SpringLayout.WEST, scroller, 5,
383 SpringLayout.WEST, this);
384 layout.putConstraint(SpringLayout.NORTH, scroller, 5,
385 SpringLayout.NORTH, this);
387 if (new Platform().isAMac())
389 scroller.setPreferredSize(new Dimension(500, 100));
393 scroller.setPreferredSize(new Dimension(130, 200));
398 javax.swing.SwingUtilities.invokeLater(new Runnable()
403 scroller.getHorizontalScrollBar().setValue(
404 scroller.getHorizontalScrollBar().getMaximum());