X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FJalviewFileChooser.java;h=a9101a1119be93d52fd877e912405446bdba7bbb;hb=57738a1f3c19b1c3a00bd3ac5108f8cd0af32f99;hp=2a0f8b12aba9e413b0e441d5060b6b282d213132;hpb=95ebbef7b78bf266a8252bd479510be3c80cd234;p=jalview.git diff --git a/src/jalview/io/JalviewFileChooser.java b/src/jalview/io/JalviewFileChooser.java index 2a0f8b1..a9101a1 100755 --- a/src/jalview/io/JalviewFileChooser.java +++ b/src/jalview/io/JalviewFileChooser.java @@ -21,28 +21,39 @@ ////////////////////////////////////////////////////////////////// package jalview.io; +import jalview.bin.Cache; import jalview.gui.JvOptionPane; import jalview.util.MessageManager; import jalview.util.Platform; +import jalview.util.dialogrunner.DialogRunnerI; import java.awt.Component; import java.awt.Dimension; import java.awt.EventQueue; import java.awt.HeadlessException; +import java.awt.event.ActionEvent; +import java.awt.event.ActionListener; import java.awt.event.MouseAdapter; import java.awt.event.MouseEvent; +import java.beans.PropertyChangeEvent; +import java.beans.PropertyChangeListener; import java.io.File; import java.util.ArrayList; +import java.util.HashMap; import java.util.List; +import java.util.Map; import java.util.StringTokenizer; import java.util.Vector; +import javax.swing.BoxLayout; import javax.swing.DefaultListCellRenderer; +import javax.swing.JCheckBox; import javax.swing.JFileChooser; import javax.swing.JList; import javax.swing.JPanel; import javax.swing.JScrollPane; import javax.swing.SpringLayout; +import javax.swing.filechooser.FileFilter; import javax.swing.plaf.basic.BasicFileChooserUI; /** @@ -55,7 +66,22 @@ import javax.swing.plaf.basic.BasicFileChooserUI; * */ public class JalviewFileChooser extends JFileChooser + implements DialogRunnerI, PropertyChangeListener { + private static final long serialVersionUID = 1L; + + private Map callbacks = new HashMap<>(); + + File selectedFile = null; + + /** + * backupfilesCheckBox = "Include backup files" checkbox includeBackupfiles = + * flag set by checkbox + */ + private JCheckBox backupfilesCheckBox = null; + + protected boolean includeBackupFiles = false; + /** * Factory method to return a file chooser that offers readable alignment file * formats @@ -64,10 +90,17 @@ public class JalviewFileChooser extends JFileChooser * @param selected * @return */ - public static JalviewFileChooser forRead(String directory, String selected) + public static JalviewFileChooser forRead(String directory, + String selected) + { + return JalviewFileChooser.forRead(directory, selected, false); + } + + public static JalviewFileChooser forRead(String directory, + String selected, boolean allowBackupFiles) { - List extensions = new ArrayList(); - List descs = new ArrayList(); + List extensions = new ArrayList<>(); + List descs = new ArrayList<>(); for (FileFormatI format : FileFormats.getInstance().getFormats()) { if (format.isReadable()) @@ -76,9 +109,11 @@ public class JalviewFileChooser extends JFileChooser descs.add(format.getName()); } } + return new JalviewFileChooser(directory, extensions.toArray(new String[extensions.size()]), - descs.toArray(new String[descs.size()]), selected, true); + descs.toArray(new String[descs.size()]), selected, true, + allowBackupFiles); } /** @@ -94,8 +129,8 @@ public class JalviewFileChooser extends JFileChooser { // TODO in Java 8, forRead and forWrite can be a single method // with a lambda expression parameter for isReadable/isWritable - List extensions = new ArrayList(); - List descs = new ArrayList(); + List extensions = new ArrayList<>(); + List descs = new ArrayList<>(); for (FileFormatI format : FileFormats.getInstance().getFormats()) { if (format.isWritable()) @@ -124,30 +159,34 @@ public class JalviewFileChooser extends JFileChooser /** * Constructor for a single choice of file extension and description * - * @param dir * @param extension * @param desc */ - public JalviewFileChooser(String dir, String extension, String desc) + public JalviewFileChooser(String extension, String desc) { - // TODO inline dir as Cache.getProperty("LAST_DIRECTORY") ? if applet - // builds ok - this(dir, new String[] { extension }, new String[] { desc }, desc, - true); + this(Cache.getProperty("LAST_DIRECTORY"), new String[] { extension }, + new String[] + { desc }, desc, true); } JalviewFileChooser(String dir, String[] extensions, String[] descs, - String selected, boolean allFiles) + String selected, boolean acceptAny) + { + this(dir, extensions, descs, selected, acceptAny, false); + } + + public JalviewFileChooser(String dir, String[] extensions, String[] descs, + String selected, boolean acceptAny, boolean allowBackupFiles) { super(safePath(dir)); if (extensions.length == descs.length) { - List formats = new ArrayList(); + List formats = new ArrayList<>(); for (int i = 0; i < extensions.length; i++) { formats.add(new String[] { extensions[i], descs[i] }); } - init(formats, selected, allFiles); + init(formats, selected, acceptAny, allowBackupFiles); } else { @@ -172,25 +211,61 @@ public class JalviewFileChooser extends JFileChooser } /** + * Overridden for JalviewJS compatibility: only one thread in Javascript, so + * we can't wait for user choice in another thread and then perform the + * desired action + */ + @Override + public int showOpenDialog(Component parent) + { + int value = super.showOpenDialog(this); + + if (!Platform.isJS()) + /** + * Java only + * + * @j2sIgnore + */ + { + /* + * code here is not run in JalviewJS, instead + * propertyChange() is called for dialog action + */ + handleResponse(value); + } + return value; + } + + /** * * @param formats * a list of {extensions, description} for each file format * @param selected - * @param allFiles + * @param acceptAny * if true, 'any format' option is included */ - void init(List formats, String selected, boolean allFiles) + void init(List formats, String selected, boolean acceptAny) + { + init(formats, selected, acceptAny, false); + } + + void init(List formats, String selected, boolean acceptAny, + boolean allowBackupFiles) { JalviewFileFilter chosen = null; // SelectAllFilter needs to be set first before adding further // file filters to fix bug on Mac OSX - setAcceptAllFileFilterUsed(allFiles); + setAcceptAllFileFilterUsed(acceptAny); for (String[] format : formats) { JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]); + if (allowBackupFiles) + { + jvf.setParentJFC(this); + } addChoosableFileFilter(jvf); if ((selected != null) && selected.equalsIgnoreCase(format[1])) { @@ -203,7 +278,65 @@ public class JalviewFileChooser extends JFileChooser setFileFilter(chosen); } - setAccessory(new RecentlyOpened()); + if (allowBackupFiles) + { + JPanel multi = new JPanel(); + multi.setLayout(new BoxLayout(multi, BoxLayout.PAGE_AXIS)); + if (backupfilesCheckBox == null) + { + try + { + includeBackupFiles = Boolean.parseBoolean( + Cache.getProperty(BackupFiles.NS + "_FC_INCLUDE")); + } catch (Exception e) + { + includeBackupFiles = false; + } + backupfilesCheckBox = new JCheckBox( + MessageManager.getString("label.include_backup_files"), + includeBackupFiles); + backupfilesCheckBox.setAlignmentX(Component.CENTER_ALIGNMENT); + JalviewFileChooser jfc = this; + backupfilesCheckBox.addActionListener(new ActionListener() + { + @Override + public void actionPerformed(ActionEvent e) + { + includeBackupFiles = backupfilesCheckBox.isSelected(); + Cache.setProperty(BackupFiles.NS + "_FC_INCLUDE", + String.valueOf(includeBackupFiles)); + + FileFilter f = jfc.getFileFilter(); + // deselect the selected file if it's no longer choosable + File selectedFile = jfc.getSelectedFile(); + if (selectedFile != null && !f.accept(selectedFile)) + { + jfc.setSelectedFile(null); + } + // fake the OK button changing (to force it to upate) + String s = jfc.getApproveButtonText(); + jfc.firePropertyChange(APPROVE_BUTTON_TEXT_CHANGED_PROPERTY, + null, s); + // fake the file filter changing (its behaviour actually has) + jfc.firePropertyChange(FILE_FILTER_CHANGED_PROPERTY, null, f); + + jfc.rescanCurrentDirectory(); + jfc.revalidate(); + jfc.repaint(); + } + }); + } + multi.add(new RecentlyOpened()); + multi.add(backupfilesCheckBox); + setAccessory(multi); + } + else + { + // set includeBackupFiles=false to avoid other file choosers from picking + // up backup files (Just In Case) + includeBackupFiles = false; + setAccessory(new RecentlyOpened()); + } } @Override @@ -279,42 +412,94 @@ public class JalviewFileChooser extends JFileChooser } @Override + public File getSelectedFile() + { + File f = super.getSelectedFile(); + return f == null ? selectedFile : f; + } + + @Override public int showSaveDialog(Component parent) throws HeadlessException { this.setAccessory(null); + // Java 9,10,11 on OSX - clear selected file so name isn't auto populated + this.setSelectedFile(null); - setDialogType(SAVE_DIALOG); + return super.showSaveDialog(parent); + } - int ret = showDialog(parent, MessageManager.getString("action.save")); + /** + * If doing a Save, and an existing file is chosen or entered, prompt for + * confirmation of overwrite. Proceed if Yes, else leave the file chooser + * open. + * + * @see https://stackoverflow.com/questions/8581215/jfilechooser-and-checking-for-overwrite + */ + @Override + public void approveSelection() + { + if (getDialogType() != SAVE_DIALOG) + { + super.approveSelection(); + return; + } + + selectedFile = getSelectedFile(); + + if (selectedFile == null) + { + // Workaround for Java 9,10 on OSX - no selected file, but there is a + // filename typed in + try + { + String filename = ((BasicFileChooserUI) getUI()).getFileName(); + if (filename != null && filename.length() > 0) + { + selectedFile = new File(getCurrentDirectory(), filename); + } + } catch (Throwable x) + { + System.err.println( + "Unexpected exception when trying to get filename."); + x.printStackTrace(); + } + // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND + // THE + // USER PROMPTED FOR A NEW FILENAME + } + + if (selectedFile == null) + { + return; + } if (getFileFilter() instanceof JalviewFileFilter) { JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter(); - if (!jvf.accept(getSelectedFile())) + if (!jvf.accept(selectedFile)) { - String withExtension = getSelectedFile() + "." + String withExtension = getSelectedFile().getName() + "." + jvf.getAcceptableExtension(); - setSelectedFile(new File(withExtension)); + selectedFile = (new File(getCurrentDirectory(), withExtension)); + setSelectedFile(selectedFile); } } - // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE - // USER PROMPTED FOR A NEW FILENAME - if ((ret == JalviewFileChooser.APPROVE_OPTION) - && getSelectedFile().exists()) + + if (selectedFile.exists()) { - int confirm = JvOptionPane.showConfirmDialog(parent, + int confirm = JvOptionPane.showConfirmDialog(this, MessageManager.getString("label.overwrite_existing_file"), MessageManager.getString("label.file_already_exists"), JvOptionPane.YES_NO_OPTION); if (confirm != JvOptionPane.YES_OPTION) { - ret = JalviewFileChooser.CANCEL_OPTION; + return; } } - return ret; + super.approveSelection(); } void recentListSelectionChanged(Object selection) @@ -339,14 +524,16 @@ public class JalviewFileChooser extends JFileChooser class RecentlyOpened extends JPanel { - JList list; + private static final long serialVersionUID = 1L; - public RecentlyOpened() - { + JList list; - String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE"); + RecentlyOpened() + { + setPreferredSize(new Dimension(300, 100)); + String historyItems = Cache.getProperty("RECENT_FILE"); StringTokenizer st; - Vector recent = new Vector(); + Vector recent = new Vector<>(); if (historyItems != null) { @@ -354,11 +541,11 @@ public class JalviewFileChooser extends JFileChooser while (st.hasMoreTokens()) { - recent.addElement(st.nextElement()); + recent.addElement(st.nextToken()); } } - list = new JList(recent); + list = new JList<>(recent); DefaultListCellRenderer dlcr = new DefaultListCellRenderer(); dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT); @@ -373,8 +560,8 @@ public class JalviewFileChooser extends JFileChooser } }); - this.setBorder(new javax.swing.border.TitledBorder(MessageManager - .getString("label.recently_opened"))); + this.setBorder(new javax.swing.border.TitledBorder( + MessageManager.getString("label.recently_opened"))); final JScrollPane scroller = new JScrollPane(list); @@ -384,13 +571,13 @@ public class JalviewFileChooser extends JFileChooser layout.putConstraint(SpringLayout.NORTH, scroller, 5, SpringLayout.NORTH, this); - if (new Platform().isAMac()) + if (Platform.isAMacAndNotJS()) { scroller.setPreferredSize(new Dimension(500, 100)); } else { - scroller.setPreferredSize(new Dimension(130, 200)); + scroller.setPreferredSize(new Dimension(530, 200)); } this.add(scroller); @@ -400,12 +587,58 @@ public class JalviewFileChooser extends JFileChooser @Override public void run() { - scroller.getHorizontalScrollBar().setValue( - scroller.getHorizontalScrollBar().getMaximum()); + scroller.getHorizontalScrollBar() + .setValue(scroller.getHorizontalScrollBar().getMaximum()); } }); } } + + @Override + public DialogRunnerI setResponseHandler(Object response, Runnable action) + { + callbacks.put(response, action); + return this; + } + + @Override + public void handleResponse(Object response) + { + /* + * this test is for NaN in Chrome + */ + if (response != null && !response.equals(response)) + { + return; + } + Runnable action = callbacks.get(response); + if (action != null) + { + action.run(); + } + } + + /** + * JalviewJS signals file selection by a property change event for property + * "SelectedFile". This methods responds to that by running the response + * action for 'OK' in the dialog. + * + * @param evt + */ + @Override + public void propertyChange(PropertyChangeEvent evt) + { + // TODO other properties need runners... + switch (evt.getPropertyName()) + { + /* + * property name here matches that used in JFileChooser.js + */ + case "SelectedFile": + handleResponse(APPROVE_OPTION); + break; + } + } }