X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FJalviewFileChooser.java;h=a9101a1119be93d52fd877e912405446bdba7bbb;hb=66270dda280788c15956c7a0485f0b9adf03c62a;hp=73a99e34479064117d60de6c105d3a4240897c32;hpb=a4aa14220a6a53391ca8e171bc774cef908057a3;p=jalview.git diff --git a/src/jalview/io/JalviewFileChooser.java b/src/jalview/io/JalviewFileChooser.java index 73a99e3..a9101a1 100755 --- a/src/jalview/io/JalviewFileChooser.java +++ b/src/jalview/io/JalviewFileChooser.java @@ -22,34 +22,38 @@ package jalview.io; import jalview.bin.Cache; -import jalview.bin.Jalview; import jalview.gui.JvOptionPane; import jalview.util.MessageManager; import jalview.util.Platform; -import jalview.util.dialogrunner.DialogRunner; import jalview.util.dialogrunner.DialogRunnerI; -import jalview.util.dialogrunner.RunResponse; 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; /** @@ -61,86 +65,22 @@ import javax.swing.plaf.basic.BasicFileChooserUI; * @author AMW * */ -public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, - PropertyChangeListener +public class JalviewFileChooser extends JFileChooser + implements DialogRunnerI, PropertyChangeListener { - private DialogRunnerI runner = new DialogRunner(); - + private static final long serialVersionUID = 1L; + + private Map callbacks = new HashMap<>(); + File selectedFile = null; /** - * On user selecting a file to save to, this response is run to check if the - * file already exists, and if so show a dialog to prompt for confirmation of - * overwrite. + * backupfilesCheckBox = "Include backup files" checkbox includeBackupfiles = + * flag set by checkbox */ - RunResponse overwriteCheck = new RunResponse(JalviewFileChooser.APPROVE_OPTION) - { - @Override - public void run() - { - selectedFile = getSelectedFile(); - - if (selectedFile == null) - { - // Workaround for Java 9,10 on OSX - no selected file, but there is a - // filename typed in - // TODO is this needed in Java 8 or 11? - 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(); - } - } - if (selectedFile == null) - { - setReturnValue(JalviewFileChooser.CANCEL_OPTION); - return; - } - // JBP Note - this code was executed regardless of 'SAVE' being pressed - // need to see if there were side effects - if (getFileFilter() instanceof JalviewFileFilter) - { - JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter(); - - if (!jvf.accept(getSelectedFile())) - { - String withExtension = getSelectedFile() + "." - + jvf.getAcceptableExtension(); - setSelectedFile(new File(withExtension)); - } - } - // All good, so we continue to save - setReturnValue(JalviewFileChooser.APPROVE_OPTION); - - // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE - // USER PROMPTED FOR A NEW FILENAME - if (!Jalview.isJS()) - { - if (getSelectedFile().exists()) - { - // JAL-3048 - may not need to raise this for browser saves - // yes/no cancel - int confirm = JvOptionPane.showConfirmDialog(JalviewFileChooser.this, - MessageManager.getString("label.overwrite_existing_file"), - MessageManager.getString("label.file_already_exists"), - JvOptionPane.YES_NO_OPTION); - - if (confirm != JvOptionPane.YES_OPTION) - { - setReturnValue(JalviewFileChooser.CANCEL_OPTION); - } - } - } - }; - }; + private JCheckBox backupfilesCheckBox = null; + + protected boolean includeBackupFiles = false; /** * Factory method to return a file chooser that offers readable alignment file @@ -153,6 +93,12 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, 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<>(); for (FileFormatI format : FileFormats.getInstance().getFormats()) @@ -163,9 +109,11 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, 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); } /** @@ -224,6 +172,12 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, JalviewFileChooser(String dir, String[] extensions, String[] descs, 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) { @@ -232,7 +186,7 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, { formats.add(new String[] { extensions[i], descs[i] }); } - init(formats, selected, acceptAny); + init(formats, selected, acceptAny, allowBackupFiles); } else { @@ -257,18 +211,27 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, } /** - * Overridden for JalviewJS compatibility: only one thread in Javascript, - * so we can't wait for user choice in another thread and then perform the + * 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) { - // runner.resetResponses(); int value = super.showOpenDialog(this); - if (!Jalview.isJS()) + + if (!Platform.isJS()) + /** + * Java only + * + * @j2sIgnore + */ { - runner.handleResponse(value); + /* + * code here is not run in JalviewJS, instead + * propertyChange() is called for dialog action + */ + handleResponse(value); } return value; } @@ -283,6 +246,12 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, */ 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; @@ -293,6 +262,10 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, 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])) { @@ -305,7 +278,65 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, 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 @@ -387,43 +418,88 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, return f == null ? selectedFile : f; } - /** - * 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 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); - /* - * Save dialog is opened until user picks a file format - */ - /* - if (!runner.isRegistered(overwriteCheck)) + return super.showSaveDialog(parent); + } + + /** + * 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) { - // first call for this instance - runner.setFirstResponse(overwriteCheck); + super.approveSelection(); + return; } - else + + selectedFile = getSelectedFile(); + + if (selectedFile == null) { - // reset response flags - runner.resetResponses(); + // 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 } -*/ - // runner.addResponse(overwriteCheck); -// setDialogType(SAVE_DIALOG); - - // Java 9,10,11 on OSX - clear selected file so name isn't auto populated - this.setSelectedFile(null); - - int value = super.showSaveDialog(parent);//, MessageManager.getString("action.save")); - if (!Jalview.isJS()) + + if (selectedFile == null) { - runner.handleResponse(value); + return; } - return value; + + if (getFileFilter() instanceof JalviewFileFilter) + { + JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter(); + + if (!jvf.accept(selectedFile)) + { + String withExtension = getSelectedFile().getName() + "." + + jvf.getAcceptableExtension(); + selectedFile = (new File(getCurrentDirectory(), withExtension)); + setSelectedFile(selectedFile); + } + } + + if (selectedFile.exists()) + { + 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) + { + return; + } + } + + super.approveSelection(); } void recentListSelectionChanged(Object selection) @@ -448,12 +524,14 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, class RecentlyOpened extends JPanel { + private static final long serialVersionUID = 1L; + JList list; - public RecentlyOpened() + RecentlyOpened() { - - String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE"); + setPreferredSize(new Dimension(300, 100)); + String historyItems = Cache.getProperty("RECENT_FILE"); StringTokenizer st; Vector recent = new Vector<>(); @@ -493,13 +571,13 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, layout.putConstraint(SpringLayout.NORTH, scroller, 5, SpringLayout.NORTH, this); - if (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); @@ -519,15 +597,33 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, } @Override - public DialogRunnerI addResponse(RunResponse action) + public DialogRunnerI setResponseHandler(Object response, Runnable action) { - return runner.addResponse(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. + * 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 */ @@ -537,30 +633,12 @@ public class JalviewFileChooser extends JFileChooser implements DialogRunnerI, // TODO other properties need runners... switch (evt.getPropertyName()) { - case "SelectedFile": - runner.handleResponse(APPROVE_OPTION); + /* + * property name here matches that used in JFileChooser.js + */ + case "SelectedFile": + handleResponse(APPROVE_OPTION); break; } } - - @Override - public void approveSelection() - { - if (getDialogType() == SAVE_DIALOG && !Jalview.isJS()) - { - File selectedFile = getSelectedFile(); - if ((selectedFile != null) && selectedFile.exists()) - { - 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) - { - return; - } - } - } - super.approveSelection(); - } }