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;
35 import java.beans.PropertyChangeEvent;
36 import java.beans.PropertyChangeListener;
38 import java.util.ArrayList;
39 import java.util.List;
40 import java.util.StringTokenizer;
41 import java.util.Vector;
43 import javax.swing.DefaultListCellRenderer;
44 import javax.swing.JFileChooser;
45 import javax.swing.JList;
46 import javax.swing.JPanel;
47 import javax.swing.JScrollPane;
48 import javax.swing.SpringLayout;
49 import javax.swing.plaf.basic.BasicFileChooserUI;
52 * Enhanced file chooser dialog box.
54 * NOTE: bug on Windows systems when filechooser opened on directory to view
55 * files with colons in title.
60 public class JalviewFileChooser extends JFileChooser
61 implements PropertyChangeListener
64 * Factory method to return a file chooser that offers readable alignment file
71 public static JalviewFileChooser forRead(String directory,
74 List<String> extensions = new ArrayList<>();
75 List<String> descs = new ArrayList<>();
76 for (FileFormatI format : FileFormats.getInstance().getFormats())
78 if (format.isReadable())
80 extensions.add(format.getExtensions());
81 descs.add(format.getName());
84 return new JalviewFileChooser(directory,
85 extensions.toArray(new String[extensions.size()]),
86 descs.toArray(new String[descs.size()]), selected, true);
90 * Factory method to return a file chooser that offers writable alignment file
97 public static JalviewFileChooser forWrite(String directory,
100 // TODO in Java 8, forRead and forWrite can be a single method
101 // with a lambda expression parameter for isReadable/isWritable
102 List<String> extensions = new ArrayList<>();
103 List<String> descs = new ArrayList<>();
104 for (FileFormatI format : FileFormats.getInstance().getFormats())
106 if (format.isWritable())
108 extensions.add(format.getExtensions());
109 descs.add(format.getName());
112 return new JalviewFileChooser(directory,
113 extensions.toArray(new String[extensions.size()]),
114 descs.toArray(new String[descs.size()]), selected, false);
117 public JalviewFileChooser(String dir)
119 super(safePath(dir));
120 setAccessory(new RecentlyOpened());
123 public JalviewFileChooser(String dir, String[] suffix, String[] desc,
126 this(dir, suffix, desc, selected, true);
130 * Constructor for a single choice of file extension and description
135 public JalviewFileChooser(String extension, String desc)
137 this(Cache.getProperty("LAST_DIRECTORY"), new String[] { extension },
139 { desc }, desc, true);
142 JalviewFileChooser(String dir, String[] extensions, String[] descs,
143 String selected, boolean allFiles)
145 super(safePath(dir));
146 if (extensions.length == descs.length)
148 List<String[]> formats = new ArrayList<>();
149 for (int i = 0; i < extensions.length; i++)
151 formats.add(new String[] { extensions[i], descs[i] });
153 init(formats, selected, allFiles);
157 System.err.println("JalviewFileChooser arguments mismatch: "
158 + extensions + ", " + descs);
162 private Runnable theCallback;
164 public void setCallback(Runnable callback)
166 this.theCallback = callback;
169 public Runnable getCallback()
175 public void propertyChange(PropertyChangeEvent evt)
177 switch (evt.getPropertyName())
185 private static File safePath(String dir)
192 File f = new File(dir);
193 if (f.getName().indexOf(':') > -1)
203 * a list of {extensions, description} for each file format
206 * if true, 'any format' option is included
208 void init(List<String[]> formats, String selected, boolean allFiles)
211 JalviewFileFilter chosen = null;
213 // SelectAllFilter needs to be set first before adding further
214 // file filters to fix bug on Mac OSX
215 setAcceptAllFileFilterUsed(allFiles);
217 for (String[] format : formats)
219 JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
220 addChoosableFileFilter(jvf);
221 if ((selected != null) && selected.equalsIgnoreCase(format[1]))
229 setFileFilter(chosen);
232 setAccessory(new RecentlyOpened());
236 public void setFileFilter(javax.swing.filechooser.FileFilter filter)
238 super.setFileFilter(filter);
242 if (getUI() instanceof BasicFileChooserUI)
244 final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI();
245 final String name = fcui.getFileName().trim();
247 if ((name == null) || (name.length() == 0))
252 EventQueue.invokeLater(new Thread()
257 String currentName = fcui.getFileName();
258 if ((currentName == null) || (currentName.length() == 0))
260 fcui.setFileName(name);
265 } catch (Exception ex)
267 ex.printStackTrace();
268 // Some platforms do not have BasicFileChooserUI
273 * Returns the selected file format, or null if none selected
277 public FileFormatI getSelectedFormat()
279 if (getFileFilter() == null)
285 * logic here depends on option description being formatted as
286 * formatName (extension, extension...)
287 * or the 'no option selected' value
289 * @see JalviewFileFilter.getDescription
291 String format = getFileFilter().getDescription();
292 int parenPos = format.indexOf("(");
295 format = format.substring(0, parenPos).trim();
298 return FileFormats.getInstance().forName(format);
299 } catch (IllegalArgumentException e)
301 System.err.println("Unexpected format: " + format);
308 public int showSaveDialog(Component parent) throws HeadlessException
310 this.setAccessory(null);
312 setDialogType(SAVE_DIALOG);
314 int ret = showDialog(parent, MessageManager.getString("action.save"));
317 if (getFileFilter() instanceof JalviewFileFilter)
319 JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
321 if (!jvf.accept(getSelectedFile()))
323 String withExtension = getSelectedFile() + "."
324 + jvf.getAcceptableExtension();
325 setSelectedFile(new File(withExtension));
328 // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
329 // USER PROMPTED FOR A NEW FILENAME
330 if ((ret == JalviewFileChooser.APPROVE_OPTION)
331 && getSelectedFile().exists())
333 int confirm = JvOptionPane.showConfirmDialog(parent,
334 MessageManager.getString("label.overwrite_existing_file"),
335 MessageManager.getString("label.file_already_exists"),
336 JvOptionPane.YES_NO_OPTION);
338 if (confirm != JvOptionPane.YES_OPTION)
340 ret = JalviewFileChooser.CANCEL_OPTION;
347 void recentListSelectionChanged(Object selection)
349 setSelectedFile(null);
350 if (selection != null)
352 File file = new File((String) selection);
353 if (getFileFilter() instanceof JalviewFileFilter)
355 JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
357 if (!jvf.accept(file))
359 setFileFilter(getChoosableFileFilters()[0]);
363 setSelectedFile(file);
367 class RecentlyOpened extends JPanel
371 public RecentlyOpened()
374 String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
376 Vector recent = new Vector();
378 if (historyItems != null)
380 st = new StringTokenizer(historyItems, "\t");
382 while (st.hasMoreTokens())
384 recent.addElement(st.nextElement());
388 list = new JList(recent);
390 DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
391 dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
392 list.setCellRenderer(dlcr);
394 list.addMouseListener(new MouseAdapter()
397 public void mousePressed(MouseEvent evt)
399 recentListSelectionChanged(list.getSelectedValue());
403 this.setBorder(new javax.swing.border.TitledBorder(
404 MessageManager.getString("label.recently_opened")));
406 final JScrollPane scroller = new JScrollPane(list);
408 SpringLayout layout = new SpringLayout();
409 layout.putConstraint(SpringLayout.WEST, scroller, 5,
410 SpringLayout.WEST, this);
411 layout.putConstraint(SpringLayout.NORTH, scroller, 5,
412 SpringLayout.NORTH, this);
414 if (new Platform().isAMac())
416 scroller.setPreferredSize(new Dimension(500, 100));
420 scroller.setPreferredSize(new Dimension(130, 200));
425 javax.swing.SwingUtilities.invokeLater(new Runnable()
430 scroller.getHorizontalScrollBar()
431 .setValue(scroller.getHorizontalScrollBar().getMaximum());