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;
28 import jalview.util.dialogrunner.DialogRunnerI;
29 import jalview.util.dialogrunner.RunResponse;
31 import java.awt.Component;
32 import java.awt.Dimension;
33 import java.awt.EventQueue;
34 import java.awt.HeadlessException;
35 import java.awt.event.MouseAdapter;
36 import java.awt.event.MouseEvent;
37 import java.beans.PropertyChangeEvent;
38 import java.beans.PropertyChangeListener;
40 import java.util.ArrayList;
41 import java.util.List;
42 import java.util.StringTokenizer;
43 import java.util.Vector;
45 import javax.swing.DefaultListCellRenderer;
46 import javax.swing.JFileChooser;
47 import javax.swing.JList;
48 import javax.swing.JPanel;
49 import javax.swing.JScrollPane;
50 import javax.swing.SpringLayout;
51 import javax.swing.plaf.basic.BasicFileChooserUI;
54 * Enhanced file chooser dialog box.
56 * NOTE: bug on Windows systems when filechooser opened on directory to view
57 * files with colons in title.
62 public class JalviewFileChooser extends JFileChooser
63 implements PropertyChangeListener, DialogRunnerI
65 jalview.util.dialogrunner.DialogRunner<JalviewFileChooser> runner = new jalview.util.dialogrunner.DialogRunner<>(
68 * Factory method to return a file chooser that offers readable alignment file
75 public static JalviewFileChooser forRead(String directory,
78 List<String> extensions = new ArrayList<>();
79 List<String> descs = new ArrayList<>();
80 for (FileFormatI format : FileFormats.getInstance().getFormats())
82 if (format.isReadable())
84 extensions.add(format.getExtensions());
85 descs.add(format.getName());
88 return new JalviewFileChooser(directory,
89 extensions.toArray(new String[extensions.size()]),
90 descs.toArray(new String[descs.size()]), selected, true);
94 * Factory method to return a file chooser that offers writable alignment file
101 public static JalviewFileChooser forWrite(String directory,
104 // TODO in Java 8, forRead and forWrite can be a single method
105 // with a lambda expression parameter for isReadable/isWritable
106 List<String> extensions = new ArrayList<>();
107 List<String> descs = new ArrayList<>();
108 for (FileFormatI format : FileFormats.getInstance().getFormats())
110 if (format.isWritable())
112 extensions.add(format.getExtensions());
113 descs.add(format.getName());
116 return new JalviewFileChooser(directory,
117 extensions.toArray(new String[extensions.size()]),
118 descs.toArray(new String[descs.size()]), selected, false);
121 public JalviewFileChooser(String dir)
123 super(safePath(dir));
124 setAccessory(new RecentlyOpened());
127 public JalviewFileChooser(String dir, String[] suffix, String[] desc,
130 this(dir, suffix, desc, selected, true);
134 * Constructor for a single choice of file extension and description
139 public JalviewFileChooser(String extension, String desc)
141 this(Cache.getProperty("LAST_DIRECTORY"), new String[] { extension },
143 { desc }, desc, true);
146 JalviewFileChooser(String dir, String[] extensions, String[] descs,
147 String selected, boolean allFiles)
149 super(safePath(dir));
150 if (extensions.length == descs.length)
152 List<String[]> formats = new ArrayList<>();
153 for (int i = 0; i < extensions.length; i++)
155 formats.add(new String[] { extensions[i], descs[i] });
157 init(formats, selected, allFiles);
161 System.err.println("JalviewFileChooser arguments mismatch: "
162 + extensions + ", " + descs);
167 public void propertyChange(PropertyChangeEvent evt)
169 // TODO other properties need runners...
170 switch (evt.getPropertyName())
173 runner.run(APPROVE_OPTION);
178 private static File safePath(String dir)
185 File f = new File(dir);
186 if (f.getName().indexOf(':') > -1)
193 public void openDialog(Component parent)
195 int value = showOpenDialog(this);
202 * a list of {extensions, description} for each file format
205 * if true, 'any format' option is included
207 void init(List<String[]> formats, String selected, boolean allFiles)
210 JalviewFileFilter chosen = null;
212 // SelectAllFilter needs to be set first before adding further
213 // file filters to fix bug on Mac OSX
214 setAcceptAllFileFilterUsed(allFiles);
216 for (String[] format : formats)
218 JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
219 addChoosableFileFilter(jvf);
220 if ((selected != null) && selected.equalsIgnoreCase(format[1]))
228 setFileFilter(chosen);
231 setAccessory(new RecentlyOpened());
235 public void setFileFilter(javax.swing.filechooser.FileFilter filter)
237 super.setFileFilter(filter);
241 if (getUI() instanceof BasicFileChooserUI)
243 final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI();
244 final String name = fcui.getFileName().trim();
246 if ((name == null) || (name.length() == 0))
251 EventQueue.invokeLater(new Thread()
256 String currentName = fcui.getFileName();
257 if ((currentName == null) || (currentName.length() == 0))
259 fcui.setFileName(name);
264 } catch (Exception ex)
266 ex.printStackTrace();
267 // Some platforms do not have BasicFileChooserUI
272 * Returns the selected file format, or null if none selected
276 public FileFormatI getSelectedFormat()
278 if (getFileFilter() == null)
284 * logic here depends on option description being formatted as
285 * formatName (extension, extension...)
286 * or the 'no option selected' value
288 * @see JalviewFileFilter.getDescription
290 String format = getFileFilter().getDescription();
291 int parenPos = format.indexOf("(");
294 format = format.substring(0, parenPos).trim();
297 return FileFormats.getInstance().forName(format);
298 } catch (IllegalArgumentException e)
300 System.err.println("Unexpected format: " + format);
307 public int showSaveDialog(Component parent) throws HeadlessException
309 this.setAccessory(null);
311 setDialogType(SAVE_DIALOG);
313 int ret = showDialog(parent, MessageManager.getString("action.save"));
316 if (getFileFilter() instanceof JalviewFileFilter)
318 JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
320 if (!jvf.accept(getSelectedFile()))
322 String withExtension = getSelectedFile() + "."
323 + jvf.getAcceptableExtension();
324 setSelectedFile(new File(withExtension));
327 // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
328 // USER PROMPTED FOR A NEW FILENAME
329 if ((ret == JalviewFileChooser.APPROVE_OPTION)
330 && getSelectedFile().exists())
332 int confirm = JvOptionPane.showConfirmDialog(parent,
333 MessageManager.getString("label.overwrite_existing_file"),
334 MessageManager.getString("label.file_already_exists"),
335 JvOptionPane.YES_NO_OPTION);
337 if (confirm != JvOptionPane.YES_OPTION)
339 ret = JalviewFileChooser.CANCEL_OPTION;
346 void recentListSelectionChanged(Object selection)
348 setSelectedFile(null);
349 if (selection != null)
351 File file = new File((String) selection);
352 if (getFileFilter() instanceof JalviewFileFilter)
354 JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
356 if (!jvf.accept(file))
358 setFileFilter(getChoosableFileFilters()[0]);
362 setSelectedFile(file);
366 class RecentlyOpened extends JPanel
370 public RecentlyOpened()
373 String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
375 Vector recent = new Vector();
377 if (historyItems != null)
379 st = new StringTokenizer(historyItems, "\t");
381 while (st.hasMoreTokens())
383 recent.addElement(st.nextElement());
387 list = new JList(recent);
389 DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
390 dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
391 list.setCellRenderer(dlcr);
393 list.addMouseListener(new MouseAdapter()
396 public void mousePressed(MouseEvent evt)
398 recentListSelectionChanged(list.getSelectedValue());
402 this.setBorder(new javax.swing.border.TitledBorder(
403 MessageManager.getString("label.recently_opened")));
405 final JScrollPane scroller = new JScrollPane(list);
407 SpringLayout layout = new SpringLayout();
408 layout.putConstraint(SpringLayout.WEST, scroller, 5,
409 SpringLayout.WEST, this);
410 layout.putConstraint(SpringLayout.NORTH, scroller, 5,
411 SpringLayout.NORTH, this);
413 if (new Platform().isAMac())
415 scroller.setPreferredSize(new Dimension(500, 100));
419 scroller.setPreferredSize(new Dimension(130, 200));
424 javax.swing.SwingUtilities.invokeLater(new Runnable()
429 scroller.getHorizontalScrollBar()
430 .setValue(scroller.getHorizontalScrollBar().getMaximum());
439 public JalviewFileChooser response(RunResponse action)
441 return runner.response(action);