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.ActionEvent;
34 import java.awt.event.ActionListener;
35 import java.awt.event.MouseAdapter;
36 import java.awt.event.MouseEvent;
38 import java.util.ArrayList;
39 import java.util.List;
40 import java.util.StringTokenizer;
41 import java.util.Vector;
43 import javax.swing.BoxLayout;
44 import javax.swing.DefaultListCellRenderer;
45 import javax.swing.JCheckBox;
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
65 * backupfilesCheckBox = "Include backup files" checkbox includeBackupfiles =
66 * flag set by checkbox
68 private JCheckBox backupfilesCheckBox = null;
70 protected boolean includeBackupFiles = false;
73 * Factory method to return a file chooser that offers readable alignment file
80 public static JalviewFileChooser forRead(String directory,
83 List<String> extensions = new ArrayList<>();
84 List<String> descs = new ArrayList<>();
85 for (FileFormatI format : FileFormats.getInstance().getFormats())
87 if (format.isReadable())
89 extensions.add(format.getExtensions());
90 descs.add(format.getName());
93 return new JalviewFileChooser(directory,
94 extensions.toArray(new String[extensions.size()]),
95 descs.toArray(new String[descs.size()]), selected, true);
99 * Factory method to return a file chooser that offers writable alignment file
106 public static JalviewFileChooser forWrite(String directory,
109 // TODO in Java 8, forRead and forWrite can be a single method
110 // with a lambda expression parameter for isReadable/isWritable
111 List<String> extensions = new ArrayList<>();
112 List<String> descs = new ArrayList<>();
113 for (FileFormatI format : FileFormats.getInstance().getFormats())
115 if (format.isWritable())
117 extensions.add(format.getExtensions());
118 descs.add(format.getName());
121 return new JalviewFileChooser(directory,
122 extensions.toArray(new String[extensions.size()]),
123 descs.toArray(new String[descs.size()]), selected, false);
126 public JalviewFileChooser(String dir)
128 super(safePath(dir));
129 setAccessory(new RecentlyOpened());
132 public JalviewFileChooser(String dir, String[] suffix, String[] desc,
135 this(dir, suffix, desc, selected, true);
139 * Constructor for a single choice of file extension and description
144 public JalviewFileChooser(String extension, String desc)
146 this(Cache.getProperty("LAST_DIRECTORY"), new String[] { extension },
148 { desc }, desc, true);
151 JalviewFileChooser(String dir, String[] extensions, String[] descs,
152 String selected, boolean allFiles)
154 this(dir, extensions, descs, selected, allFiles, false);
157 public JalviewFileChooser(String dir, String[] extensions, String[] descs,
158 String selected, boolean allFiles, boolean allowBackupFiles)
160 super(safePath(dir));
161 if (extensions.length == descs.length)
163 List<String[]> formats = new ArrayList<>();
164 for (int i = 0; i < extensions.length; i++)
166 formats.add(new String[] { extensions[i], descs[i] });
168 init(formats, selected, allFiles, allowBackupFiles);
172 System.err.println("JalviewFileChooser arguments mismatch: "
173 + extensions + ", " + descs);
177 private static File safePath(String dir)
184 File f = new File(dir);
185 if (f.getName().indexOf(':') > -1)
195 * a list of {extensions, description} for each file format
198 * if true, 'any format' option is included
200 void init(List<String[]> formats, String selected, boolean allFiles)
202 init(formats, selected, allFiles, false);
205 void init(List<String[]> formats, String selected, boolean allFiles,
206 boolean allowBackupFiles)
209 JalviewFileFilter chosen = null;
211 // SelectAllFilter needs to be set first before adding further
212 // file filters to fix bug on Mac OSX
213 setAcceptAllFileFilterUsed(allFiles);
215 for (String[] format : formats)
217 JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
218 if (allowBackupFiles)
220 jvf.setParentJFC(this);
222 addChoosableFileFilter(jvf);
223 if ((selected != null) && selected.equalsIgnoreCase(format[1]))
231 setFileFilter(chosen);
234 if (allowBackupFiles)
236 JPanel multi = new JPanel();
237 multi.setLayout(new BoxLayout(multi, BoxLayout.PAGE_AXIS));
238 if (backupfilesCheckBox == null)
241 includeBackupFiles = Boolean.parseBoolean(
242 Cache.getProperty(BackupFiles.NS + "_FC_INCLUDE"));
243 } catch (Exception e)
245 includeBackupFiles = false;
247 backupfilesCheckBox = new JCheckBox(
248 MessageManager.getString("label.include_backup_files"),
250 backupfilesCheckBox.setAlignmentX(Component.CENTER_ALIGNMENT);
251 JalviewFileChooser jfc = this;
252 backupfilesCheckBox.addActionListener(new ActionListener()
255 public void actionPerformed(ActionEvent e)
257 includeBackupFiles = backupfilesCheckBox.isSelected();
258 Cache.setProperty(BackupFiles.NS + "_FC_INCLUDE",
259 String.valueOf(includeBackupFiles));
260 jfc.rescanCurrentDirectory();
263 // This is a kludge. Cannot find out how to get the file list to
266 Object o = jfc.getClientProperty(
267 CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY);
268 jfc.firePropertyChange(CHOOSABLE_FILE_FILTER_CHANGED_PROPERTY,
274 multi.add(new RecentlyOpened());
275 multi.add(backupfilesCheckBox);
280 // set includeBackupFiles=false to avoid other file choosers from picking
281 // up backup files (Just In Case)
282 includeBackupFiles = false;
283 setAccessory(new RecentlyOpened());
288 public void setFileFilter(javax.swing.filechooser.FileFilter filter)
290 super.setFileFilter(filter);
294 if (getUI() instanceof BasicFileChooserUI)
296 final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI();
297 final String name = fcui.getFileName().trim();
299 if ((name == null) || (name.length() == 0))
304 EventQueue.invokeLater(new Thread()
309 String currentName = fcui.getFileName();
310 if ((currentName == null) || (currentName.length() == 0))
312 fcui.setFileName(name);
317 } catch (Exception ex)
319 ex.printStackTrace();
320 // Some platforms do not have BasicFileChooserUI
325 * Returns the selected file format, or null if none selected
329 public FileFormatI getSelectedFormat()
331 if (getFileFilter() == null)
337 * logic here depends on option description being formatted as
338 * formatName (extension, extension...)
339 * or the 'no option selected' value
341 * @see JalviewFileFilter.getDescription
343 String format = getFileFilter().getDescription();
344 int parenPos = format.indexOf("(");
347 format = format.substring(0, parenPos).trim();
350 return FileFormats.getInstance().forName(format);
351 } catch (IllegalArgumentException e)
353 System.err.println("Unexpected format: " + format);
359 File ourselectedFile = null;
362 public File getSelectedFile()
364 File selfile = super.getSelectedFile();
365 if (selfile == null && ourselectedFile != null)
367 return ourselectedFile;
373 public int showSaveDialog(Component parent) throws HeadlessException
375 this.setAccessory(null);
377 setDialogType(SAVE_DIALOG);
379 this.setSelectedFile(null);
380 int ret = showDialog(parent, MessageManager.getString("action.save"));
381 ourselectedFile = getSelectedFile();
383 if (getSelectedFile() == null)
385 // Workaround for Java 9,10 on OSX - no selected file, but there is a
389 String filename = ((BasicFileChooserUI) getUI()).getFileName();
390 if (filename != null && filename.length() > 0)
392 ourselectedFile = new File(getCurrentDirectory(), filename);
394 } catch (Throwable x)
397 "Unexpected exception when trying to get filename.");
401 if (ourselectedFile == null)
403 return JalviewFileChooser.CANCEL_OPTION;
405 if (getFileFilter() instanceof JalviewFileFilter)
407 JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
409 if (!jvf.accept(ourselectedFile))
411 String withExtension = getSelectedFile().getName() + "."
412 + jvf.getAcceptableExtension();
413 ourselectedFile = (new File(getCurrentDirectory(), withExtension));
414 setSelectedFile(ourselectedFile);
418 // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
419 // USER PROMPTED FOR A NEW FILENAME.
420 // DO NOT need to confirm file overwrite if using backup files (the files
421 // aren't being overwritten!)
422 if ((ret == JalviewFileChooser.APPROVE_OPTION)
423 && ourselectedFile.exists() && (!BackupFiles.getEnabled()))
425 int confirm = JvOptionPane.showConfirmDialog(parent,
426 MessageManager.getString("label.overwrite_existing_file"),
427 MessageManager.getString("label.file_already_exists"),
428 JvOptionPane.YES_NO_OPTION);
430 if (confirm != JvOptionPane.YES_OPTION)
432 ret = JalviewFileChooser.CANCEL_OPTION;
440 void recentListSelectionChanged(Object selection)
442 setSelectedFile(null);
443 if (selection != null)
445 File file = new File((String) selection);
446 if (getFileFilter() instanceof JalviewFileFilter)
448 JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
450 if (!jvf.accept(file))
452 setFileFilter(getChoosableFileFilters()[0]);
456 setSelectedFile(file);
460 class RecentlyOpened extends JPanel
464 public RecentlyOpened()
467 String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
469 Vector recent = new Vector();
471 if (historyItems != null)
473 st = new StringTokenizer(historyItems, "\t");
475 while (st.hasMoreTokens())
477 recent.addElement(st.nextElement());
481 list = new JList(recent);
483 DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
484 dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
485 list.setCellRenderer(dlcr);
487 list.addMouseListener(new MouseAdapter()
490 public void mousePressed(MouseEvent evt)
492 recentListSelectionChanged(list.getSelectedValue());
496 this.setBorder(new javax.swing.border.TitledBorder(
497 MessageManager.getString("label.recently_opened")));
499 final JScrollPane scroller = new JScrollPane(list);
501 SpringLayout layout = new SpringLayout();
502 layout.putConstraint(SpringLayout.WEST, scroller, 5,
503 SpringLayout.WEST, this);
504 layout.putConstraint(SpringLayout.NORTH, scroller, 5,
505 SpringLayout.NORTH, this);
507 if (new Platform().isAMac())
509 scroller.setPreferredSize(new Dimension(500, 100));
513 scroller.setPreferredSize(new Dimension(130, 200));
518 javax.swing.SwingUtilities.invokeLater(new Runnable()
523 scroller.getHorizontalScrollBar()
524 .setValue(scroller.getHorizontalScrollBar().getMaximum());