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.Collections;
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.filechooser.FileView;
48 import javax.swing.plaf.basic.BasicFileChooserUI;
51 * Enhanced file chooser dialog box.
53 * NOTE: bug on Windows systems when filechooser opened on directory to view
54 * files with colons in title.
59 public class JalviewFileChooser extends JFileChooser
62 * Factory method to return a file chooser that offers readable alignment file
70 public static JalviewFileChooser forRead(String directory,
71 String selected, boolean selectAll)
73 List<String> extensions = new ArrayList<String>();
74 List<String> descs = new ArrayList<String>();
75 for (FileFormatI format : FileFormat.values())
77 if (format.isReadable())
79 extensions.add(format.getExtensions());
80 descs.add(format.toString());
83 return new JalviewFileChooser(directory,
84 extensions.toArray(new String[extensions.size()]),
85 descs.toArray(new String[descs.size()]),
90 * Factory method to return a file chooser that offers writable alignment file
98 public static JalviewFileChooser forWrite(String directory,
99 String selected, boolean selectAll)
101 // TODO in Java 8, forRead and forWrite can be a single method
102 // with a lambda expression parameter for isReadable/isWritable
103 List<String> extensions = new ArrayList<String>();
104 List<String> descs = new ArrayList<String>();
105 for (FileFormatI format : FileFormat.values())
107 if (format.isWritable())
109 extensions.add(format.getExtensions());
110 descs.add(format.toString());
113 return new JalviewFileChooser(directory,
114 extensions.toArray(new String[extensions.size()]),
115 descs.toArray(new String[descs.size()]), selected);
118 public JalviewFileChooser(String dir)
120 super(safePath(dir));
121 setAccessory(new RecentlyOpened());
124 public JalviewFileChooser(String dir, String extension, String desc,
127 super(safePath(dir));
128 init(Collections.singletonList(new String[] { extension, desc }),
132 public JalviewFileChooser(String dir, String[] extensions, String[] descs,
135 super(safePath(dir));
136 if (extensions.length == descs.length)
138 List<String[]> formats = new ArrayList<String[]>();
139 for (int i = 0; i < extensions.length; i++)
141 formats.add(new String[] { extensions[i], descs[i] });
143 init(formats, selected);
147 System.err.println("JalviewFileChooser arguments mismatch: "
148 + extensions + ", " + descs);
152 private static File safePath(String dir)
159 File f = new File(dir);
160 if (f.getName().indexOf(':') > -1)
170 * a list of {extensions, description} for each file format
173 void init(List<String[]> formats, String selected)
176 JalviewFileFilter chosen = null;
178 // SelectAllFilter needs to be set first before adding further
179 // file filters to fix bug on Mac OSX
180 setAcceptAllFileFilterUsed(true);
182 for (String[] format : formats)
184 JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
185 addChoosableFileFilter(jvf);
186 if ((selected != null) && selected.equalsIgnoreCase(format[1]))
194 setFileFilter(chosen);
197 setAccessory(new RecentlyOpened());
201 public void setFileFilter(javax.swing.filechooser.FileFilter filter)
203 super.setFileFilter(filter);
207 if (getUI() instanceof BasicFileChooserUI)
209 final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI();
210 final String name = fcui.getFileName().trim();
212 if ((name == null) || (name.length() == 0))
217 EventQueue.invokeLater(new Thread()
222 String currentName = fcui.getFileName();
223 if ((currentName == null) || (currentName.length() == 0))
225 fcui.setFileName(name);
230 } catch (Exception ex)
232 ex.printStackTrace();
233 // Some platforms do not have BasicFileChooserUI
238 * Returns the selected file format, or null if none selected
242 public FileFormatI getSelectedFormat()
244 if (getFileFilter() == null)
250 * logic here depends on option description being formatted as
251 * formatName (extension, extension...)
252 * or the 'no option selected' value
254 * @see JalviewFileFilter.getDescription
256 String format = getFileFilter().getDescription();
257 int parenPos = format.indexOf("(");
260 format = format.substring(0, parenPos).trim();
263 return FileFormat.valueOf(format);
264 } catch (IllegalArgumentException e)
266 System.err.println("Unexpected format: " + format);
273 public int showSaveDialog(Component parent) throws HeadlessException
275 this.setAccessory(null);
277 setDialogType(SAVE_DIALOG);
279 int ret = showDialog(parent, MessageManager.getString("action.save"));
281 if (getFileFilter() instanceof JalviewFileFilter)
283 JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
285 if (!jvf.accept(getSelectedFile()))
287 String withExtension = getSelectedFile() + "."
288 + jvf.getAcceptableExtension();
289 setSelectedFile(new File(withExtension));
292 // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
293 // USER PROMPTED FOR A NEW FILENAME
294 if ((ret == JalviewFileChooser.APPROVE_OPTION)
295 && getSelectedFile().exists())
297 int confirm = JvOptionPane.showConfirmDialog(parent,
298 MessageManager.getString("label.overwrite_existing_file"),
299 MessageManager.getString("label.file_already_exists"),
300 JvOptionPane.YES_NO_OPTION);
302 if (confirm != JvOptionPane.YES_OPTION)
304 ret = JalviewFileChooser.CANCEL_OPTION;
311 void recentListSelectionChanged(Object selection)
313 setSelectedFile(null);
314 if (selection != null)
316 File file = new File((String) selection);
317 if (getFileFilter() instanceof JalviewFileFilter)
319 JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
321 if (!jvf.accept(file))
323 setFileFilter(getChoosableFileFilters()[0]);
327 setSelectedFile(file);
331 class RecentlyOpened extends JPanel
335 public RecentlyOpened()
338 String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
340 Vector recent = new Vector();
342 if (historyItems != null)
344 st = new StringTokenizer(historyItems, "\t");
346 while (st.hasMoreTokens())
348 recent.addElement(st.nextElement());
352 list = new JList(recent);
354 DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
355 dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
356 list.setCellRenderer(dlcr);
358 list.addMouseListener(new MouseAdapter()
361 public void mousePressed(MouseEvent evt)
363 recentListSelectionChanged(list.getSelectedValue());
367 this.setBorder(new javax.swing.border.TitledBorder(MessageManager
368 .getString("label.recently_opened")));
370 final JScrollPane scroller = new JScrollPane(list);
372 SpringLayout layout = new SpringLayout();
373 layout.putConstraint(SpringLayout.WEST, scroller, 5,
374 SpringLayout.WEST, this);
375 layout.putConstraint(SpringLayout.NORTH, scroller, 5,
376 SpringLayout.NORTH, this);
378 if (new Platform().isAMac())
380 scroller.setPreferredSize(new Dimension(500, 100));
384 scroller.setPreferredSize(new Dimension(130, 200));
389 javax.swing.SwingUtilities.invokeLater(new Runnable()
394 scroller.getHorizontalScrollBar().setValue(
395 scroller.getHorizontalScrollBar().getMaximum());