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.util.MessageManager;
25 import jalview.util.Platform;
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;
34 import java.util.ArrayList;
35 import java.util.Collections;
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.JOptionPane;
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
69 public static JalviewFileChooser forRead(String directory,
70 String selected, boolean selectAll)
72 List<String> extensions = new ArrayList<String>();
73 List<String> descs = new ArrayList<String>();
74 for (FileFormatI format : FileFormat.values())
76 if (format.isReadable())
78 extensions.add(format.getExtensions());
79 descs.add(format.getShortDescription());
82 return new JalviewFileChooser(directory,
83 extensions.toArray(new String[extensions.size()]),
84 descs.toArray(new String[descs.size()]),
89 * Factory method to return a file chooser that offers writable alignment file
97 public static JalviewFileChooser forWrite(String directory,
98 String selected, boolean selectAll)
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<String>();
103 List<String> descs = new ArrayList<String>();
104 for (FileFormatI format : FileFormat.values())
106 if (format.isWritable())
108 extensions.add(format.getExtensions());
109 descs.add(format.getShortDescription());
112 return new JalviewFileChooser(directory,
113 extensions.toArray(new String[extensions.size()]),
114 descs.toArray(new String[descs.size()]), selected);
117 public JalviewFileChooser(String dir)
119 super(safePath(dir));
120 setAccessory(new RecentlyOpened());
123 public JalviewFileChooser(String dir, String extension, String desc,
126 super(safePath(dir));
127 init(Collections.singletonList(new String[] { extension, desc }),
131 public JalviewFileChooser(String dir, String[] extensions, String[] descs,
134 super(safePath(dir));
135 if (extensions.length == descs.length)
137 List<String[]> formats = new ArrayList<String[]>();
138 for (int i = 0; i < extensions.length; i++)
140 formats.add(new String[] { extensions[i], descs[i] });
142 init(formats, selected);
146 System.err.println("JalviewFileChooser arguments mismatch: "
147 + extensions + ", " + descs);
151 private static File safePath(String dir)
158 File f = new File(dir);
159 if (f.getName().indexOf(':') > -1)
169 * a list of {extensions, description} for each file format
172 void init(List<String[]> formats, String selected)
175 JalviewFileFilter chosen = null;
177 // SelectAllFilter needs to be set first before adding further
178 // file filters to fix bug on Mac OSX
179 setAcceptAllFileFilterUsed(true);
181 for (String[] format : formats)
183 JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
184 addChoosableFileFilter(jvf);
185 if ((selected != null) && selected.equalsIgnoreCase(format[1]))
193 setFileFilter(chosen);
196 setAccessory(new RecentlyOpened());
200 public void setFileFilter(javax.swing.filechooser.FileFilter filter)
202 super.setFileFilter(filter);
206 if (getUI() instanceof BasicFileChooserUI)
208 final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI();
209 final String name = fcui.getFileName().trim();
211 if ((name == null) || (name.length() == 0))
216 EventQueue.invokeLater(new Thread()
221 String currentName = fcui.getFileName();
222 if ((currentName == null) || (currentName.length() == 0))
224 fcui.setFileName(name);
229 } catch (Exception ex)
231 ex.printStackTrace();
232 // Some platforms do not have BasicFileChooserUI
236 public FileFormatI getSelectedFormat()
238 if (getFileFilter() == null)
243 String format = getFileFilter().getDescription();
244 return FileFormat.valueOf(format);
248 public int showSaveDialog(Component parent) throws HeadlessException
250 this.setAccessory(null);
252 setDialogType(SAVE_DIALOG);
254 int ret = showDialog(parent, MessageManager.getString("action.save"));
256 if (getFileFilter() instanceof JalviewFileFilter)
258 JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
260 if (!jvf.accept(getSelectedFile()))
262 String withExtension = getSelectedFile() + "."
263 + jvf.getAcceptableExtension();
264 setSelectedFile(new File(withExtension));
267 // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
268 // USER PROMPTED FOR A NEW FILENAME
269 if ((ret == JalviewFileChooser.APPROVE_OPTION)
270 && getSelectedFile().exists())
272 int confirm = JOptionPane.showConfirmDialog(parent,
273 MessageManager.getString("label.overwrite_existing_file"),
274 MessageManager.getString("label.file_already_exists"),
275 JOptionPane.YES_NO_OPTION);
277 if (confirm != JOptionPane.YES_OPTION)
279 ret = JalviewFileChooser.CANCEL_OPTION;
286 void recentListSelectionChanged(Object selection)
288 setSelectedFile(null);
289 if (selection != null)
291 File file = new File((String) selection);
292 if (getFileFilter() instanceof JalviewFileFilter)
294 JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
296 if (!jvf.accept(file))
298 setFileFilter(getChoosableFileFilters()[0]);
302 setSelectedFile(file);
306 class RecentlyOpened extends JPanel
310 public RecentlyOpened()
313 String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
315 Vector recent = new Vector();
317 if (historyItems != null)
319 st = new StringTokenizer(historyItems, "\t");
321 while (st.hasMoreTokens())
323 recent.addElement(st.nextElement());
327 list = new JList(recent);
329 DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
330 dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
331 list.setCellRenderer(dlcr);
333 list.addMouseListener(new MouseAdapter()
336 public void mousePressed(MouseEvent evt)
338 recentListSelectionChanged(list.getSelectedValue());
342 this.setBorder(new javax.swing.border.TitledBorder(MessageManager
343 .getString("label.recently_opened")));
345 final JScrollPane scroller = new JScrollPane(list);
347 SpringLayout layout = new SpringLayout();
348 layout.putConstraint(SpringLayout.WEST, scroller, 5,
349 SpringLayout.WEST, this);
350 layout.putConstraint(SpringLayout.NORTH, scroller, 5,
351 SpringLayout.NORTH, this);
353 if (new Platform().isAMac())
355 scroller.setPreferredSize(new Dimension(500, 100));
359 scroller.setPreferredSize(new Dimension(130, 200));
364 javax.swing.SwingUtilities.invokeLater(new Runnable()
369 scroller.getHorizontalScrollBar().setValue(
370 scroller.getHorizontalScrollBar().getMaximum());