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;
30 import java.awt.Component;
31 import java.awt.Dimension;
32 import java.awt.EventQueue;
33 import java.awt.HeadlessException;
34 import java.awt.event.MouseAdapter;
35 import java.awt.event.MouseEvent;
36 import java.beans.PropertyChangeEvent;
37 import java.beans.PropertyChangeListener;
39 import java.util.ArrayList;
40 import java.util.HashMap;
41 import java.util.List;
43 import java.util.StringTokenizer;
44 import java.util.Vector;
46 import javax.swing.DefaultListCellRenderer;
47 import javax.swing.JFileChooser;
48 import javax.swing.JList;
49 import javax.swing.JPanel;
50 import javax.swing.JScrollPane;
51 import javax.swing.SpringLayout;
52 import javax.swing.plaf.basic.BasicFileChooserUI;
55 * Enhanced file chooser dialog box.
57 * NOTE: bug on Windows systems when filechooser opened on directory to view
58 * files with colons in title.
63 public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
64 PropertyChangeListener
66 private static final long serialVersionUID = 1L;
68 private Map<Object, Runnable> callbacks = new HashMap<>();
70 File selectedFile = null;
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 acceptAny)
154 super(safePath(dir));
155 if (extensions.length == descs.length)
157 List<String[]> formats = new ArrayList<>();
158 for (int i = 0; i < extensions.length; i++)
160 formats.add(new String[] { extensions[i], descs[i] });
162 init(formats, selected, acceptAny);
166 System.err.println("JalviewFileChooser arguments mismatch: "
167 + extensions + ", " + descs);
171 private static File safePath(String dir)
178 File f = new File(dir);
179 if (f.getName().indexOf(':') > -1)
187 * Overridden for JalviewJS compatibility: only one thread in Javascript,
188 * so we can't wait for user choice in another thread and then perform the
192 public int showOpenDialog(Component parent)
194 int value = super.showOpenDialog(this);
196 if (!Platform.isJS())
199 * code here is not run in JalviewJS, instead
200 * propertyChange() is called for dialog action
202 handleResponse(value);
210 * a list of {extensions, description} for each file format
213 * if true, 'any format' option is included
215 void init(List<String[]> formats, String selected, boolean acceptAny)
218 JalviewFileFilter chosen = null;
220 // SelectAllFilter needs to be set first before adding further
221 // file filters to fix bug on Mac OSX
222 setAcceptAllFileFilterUsed(acceptAny);
224 for (String[] format : formats)
226 JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
227 addChoosableFileFilter(jvf);
228 if ((selected != null) && selected.equalsIgnoreCase(format[1]))
236 setFileFilter(chosen);
239 setAccessory(new RecentlyOpened());
243 public void setFileFilter(javax.swing.filechooser.FileFilter filter)
245 super.setFileFilter(filter);
249 if (getUI() instanceof BasicFileChooserUI)
251 final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI();
252 final String name = fcui.getFileName().trim();
254 if ((name == null) || (name.length() == 0))
259 EventQueue.invokeLater(new Thread()
264 String currentName = fcui.getFileName();
265 if ((currentName == null) || (currentName.length() == 0))
267 fcui.setFileName(name);
272 } catch (Exception ex)
274 ex.printStackTrace();
275 // Some platforms do not have BasicFileChooserUI
280 * Returns the selected file format, or null if none selected
284 public FileFormatI getSelectedFormat()
286 if (getFileFilter() == null)
292 * logic here depends on option description being formatted as
293 * formatName (extension, extension...)
294 * or the 'no option selected' value
296 * @see JalviewFileFilter.getDescription
298 String format = getFileFilter().getDescription();
299 int parenPos = format.indexOf("(");
302 format = format.substring(0, parenPos).trim();
305 return FileFormats.getInstance().forName(format);
306 } catch (IllegalArgumentException e)
308 System.err.println("Unexpected format: " + format);
315 public File getSelectedFile()
317 File f = super.getSelectedFile();
318 return f == null ? selectedFile : f;
322 public int showSaveDialog(Component parent) throws HeadlessException
324 this.setAccessory(null);
325 // Java 9,10,11 on OSX - clear selected file so name isn't auto populated
326 this.setSelectedFile(null);
328 return super.showSaveDialog(parent);
332 * If doing a Save, and an existing file is chosen or entered, prompt for
333 * confirmation of overwrite. Proceed if Yes, else leave the file chooser
336 * @see https://stackoverflow.com/questions/8581215/jfilechooser-and-checking-for-overwrite
339 public void approveSelection()
341 if (getDialogType() != SAVE_DIALOG)
343 super.approveSelection();
347 selectedFile = getSelectedFile();
349 if (selectedFile == null)
351 // Workaround for Java 9,10 on OSX - no selected file, but there is a
355 String filename = ((BasicFileChooserUI) getUI()).getFileName();
356 if (filename != null && filename.length() > 0)
358 selectedFile = new File(getCurrentDirectory(), filename);
360 } catch (Throwable x)
363 "Unexpected exception when trying to get filename.");
366 // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND
368 // USER PROMPTED FOR A NEW FILENAME
371 if (selectedFile == null)
376 if (getFileFilter() instanceof JalviewFileFilter)
378 JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
380 if (!jvf.accept(selectedFile))
382 String withExtension = getSelectedFile().getName() + "."
383 + jvf.getAcceptableExtension();
384 selectedFile = (new File(getCurrentDirectory(), withExtension));
385 setSelectedFile(selectedFile);
389 if (selectedFile.exists())
391 int confirm = JvOptionPane.showConfirmDialog(this,
392 MessageManager.getString("label.overwrite_existing_file"),
393 MessageManager.getString("label.file_already_exists"),
394 JvOptionPane.YES_NO_OPTION);
395 if (confirm != JvOptionPane.YES_OPTION)
401 super.approveSelection();
404 void recentListSelectionChanged(Object selection)
406 setSelectedFile(null);
407 if (selection != null)
409 File file = new File((String) selection);
410 if (getFileFilter() instanceof JalviewFileFilter)
412 JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
414 if (!jvf.accept(file))
416 setFileFilter(getChoosableFileFilters()[0]);
420 setSelectedFile(file);
424 class RecentlyOpened extends JPanel
426 private static final long serialVersionUID = 1L;
431 setPreferredSize(new Dimension(300,100));
432 String historyItems = Cache.getProperty("RECENT_FILE");
434 Vector<String> recent = new Vector<>();
436 if (historyItems != null)
438 st = new StringTokenizer(historyItems, "\t");
440 while (st.hasMoreTokens())
442 recent.addElement(st.nextToken());
446 list = new JList<>(recent);
448 DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
449 // dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
450 list.setCellRenderer(dlcr);
452 list.addMouseListener(new MouseAdapter()
455 public void mousePressed(MouseEvent evt)
457 recentListSelectionChanged(list.getSelectedValue());
461 this.setBorder(new javax.swing.border.TitledBorder(
462 MessageManager.getString("label.recently_opened")));
464 final JScrollPane scroller = new JScrollPane(list);
466 SpringLayout layout = new SpringLayout();
467 layout.putConstraint(SpringLayout.WEST, scroller, 5,
468 SpringLayout.WEST, this);
469 layout.putConstraint(SpringLayout.NORTH, scroller, 5,
470 SpringLayout.NORTH, this);
472 if (Platform.isAMacAndNotJS())
474 scroller.setPreferredSize(new Dimension(500, 100));
478 scroller.setPreferredSize(new Dimension(530, 200));
483 javax.swing.SwingUtilities.invokeLater(new Runnable()
488 scroller.getHorizontalScrollBar()
489 .setValue(scroller.getHorizontalScrollBar().getMaximum());
498 public DialogRunnerI setResponseHandler(Object response, Runnable action)
500 callbacks.put(response, action);
505 public void handleResponse(Object response)
508 * this test is for NaN in Chrome
510 if (response != null && !response.equals(response))
514 Runnable action = callbacks.get(response);
522 * JalviewJS signals file selection by a property change event
523 * for property "SelectedFile". This methods responds to that by
524 * running the response action for 'OK' in the dialog.
529 public void propertyChange(PropertyChangeEvent evt)
531 // TODO other properties need runners...
532 switch (evt.getPropertyName())
535 * property name here matches that used in JFileChooser.js
538 handleResponse(APPROVE_OPTION);