X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FJalviewFileChooser.java;h=a7f8fa6f43ac905b2a174678bd84ecc777d2185f;hb=7047b076a62df177047ceb16c3611efe020bdd76;hp=7ebe0814241b293ac355f304c2c47ed2bdd7115f;hpb=483e7163b1fb8d4bcb9393014816c944befce328;p=jalview.git diff --git a/src/jalview/io/JalviewFileChooser.java b/src/jalview/io/JalviewFileChooser.java index 7ebe081..a7f8fa6 100755 --- a/src/jalview/io/JalviewFileChooser.java +++ b/src/jalview/io/JalviewFileChooser.java @@ -21,9 +21,14 @@ ////////////////////////////////////////////////////////////////// package jalview.io; +import jalview.bin.Cache; 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.Response; +import jalview.util.dialogrunner.RunResponse; import java.awt.Component; import java.awt.Dimension; @@ -31,9 +36,10 @@ import java.awt.EventQueue; import java.awt.HeadlessException; 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.Collections; import java.util.List; import java.util.StringTokenizer; import java.util.Vector; @@ -44,7 +50,6 @@ import javax.swing.JList; import javax.swing.JPanel; import javax.swing.JScrollPane; import javax.swing.SpringLayout; -import javax.swing.filechooser.FileView; import javax.swing.plaf.basic.BasicFileChooserUI; /** @@ -57,33 +62,34 @@ import javax.swing.plaf.basic.BasicFileChooserUI; * */ public class JalviewFileChooser extends JFileChooser + implements PropertyChangeListener, DialogRunnerI { + DialogRunner runner = new DialogRunner<>(this); + /** * Factory method to return a file chooser that offers readable alignment file * formats * * @param directory * @param selected - * @param selectAll * @return */ public static JalviewFileChooser forRead(String directory, - String selected, boolean selectAll) + String selected) { - List extensions = new ArrayList(); - List descs = new ArrayList(); - for (FileFormatI format : FileFormat.values()) + List extensions = new ArrayList<>(); + List descs = new ArrayList<>(); + for (FileFormatI format : FileFormats.getInstance().getFormats()) { if (format.isReadable()) { extensions.add(format.getExtensions()); - descs.add(format.toString()); + descs.add(format.getName()); } } return new JalviewFileChooser(directory, extensions.toArray(new String[extensions.size()]), - descs.toArray(new String[descs.size()]), - selected); + descs.toArray(new String[descs.size()]), selected, true); } /** @@ -92,27 +98,26 @@ public class JalviewFileChooser extends JFileChooser * * @param directory * @param selected - * @param selectAll * @return */ public static JalviewFileChooser forWrite(String directory, - String selected, boolean selectAll) + String selected) { // 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(); - for (FileFormatI format : FileFormat.values()) + List extensions = new ArrayList<>(); + List descs = new ArrayList<>(); + for (FileFormatI format : FileFormats.getInstance().getFormats()) { if (format.isWritable()) { extensions.add(format.getExtensions()); - descs.add(format.toString()); + descs.add(format.getName()); } } return new JalviewFileChooser(directory, extensions.toArray(new String[extensions.size()]), - descs.toArray(new String[descs.size()]), selected); + descs.toArray(new String[descs.size()]), selected, false); } public JalviewFileChooser(String dir) @@ -121,26 +126,37 @@ public class JalviewFileChooser extends JFileChooser setAccessory(new RecentlyOpened()); } - public JalviewFileChooser(String dir, String extension, String desc, + public JalviewFileChooser(String dir, String[] suffix, String[] desc, String selected) { - super(safePath(dir)); - init(Collections.singletonList(new String[] { extension, desc }), - selected); + this(dir, suffix, desc, selected, true); } - public JalviewFileChooser(String dir, String[] extensions, String[] descs, - String selected) + /** + * Constructor for a single choice of file extension and description + * + * @param extension + * @param desc + */ + public JalviewFileChooser(String extension, String desc) + { + this(Cache.getProperty("LAST_DIRECTORY"), new String[] { extension }, + new String[] + { desc }, desc, true); + } + + JalviewFileChooser(String dir, String[] extensions, String[] descs, + String selected, boolean allFiles) { 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); + init(formats, selected, allFiles); } else { @@ -149,6 +165,18 @@ public class JalviewFileChooser extends JFileChooser } } + @Override + public void propertyChange(PropertyChangeEvent evt) + { + // TODO other properties need runners... + switch (evt.getPropertyName()) + { + case "SelectedFile": + runner.run(APPROVE_OPTION); + break; + } + } + private static File safePath(String dir) { if (dir == null) @@ -165,19 +193,40 @@ 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) + { + runner.resetResponses(); + int value = super.showOpenDialog(this); + /** + * @j2sNative + */ + { + runner.firstRun(value); + } + return value; + } + + /** * * @param formats * a list of {extensions, description} for each file format * @param selected + * @param allFiles + * if true, 'any format' option is included */ - void init(List formats, String selected) + void init(List formats, String selected, boolean allFiles) { JalviewFileFilter chosen = null; // SelectAllFilter needs to be set first before adding further // file filters to fix bug on Mac OSX - setAcceptAllFileFilterUsed(true); + setAcceptAllFileFilterUsed(allFiles); for (String[] format : formats) { @@ -260,7 +309,7 @@ public class JalviewFileChooser extends JFileChooser format = format.substring(0, parenPos).trim(); try { - return FileFormat.valueOf(format); + return FileFormats.getInstance().forName(format); } catch (IllegalArgumentException e) { System.err.println("Unexpected format: " + format); @@ -268,44 +317,132 @@ public class JalviewFileChooser extends JFileChooser } return null; } + + File ourselectedFile = null; @Override - public int showSaveDialog(Component parent) throws HeadlessException + public File getSelectedFile() { - this.setAccessory(null); - - setDialogType(SAVE_DIALOG); - - int ret = showDialog(parent, MessageManager.getString("action.save")); + File selfile = super.getSelectedFile(); + if (selfile == null && ourselectedFile != null) + { + return ourselectedFile; + } + return selfile; + } - if (getFileFilter() instanceof JalviewFileFilter) + Component saveparent; + RunResponse overwriteCheck = new RunResponse( + JalviewFileChooser.APPROVE_OPTION) + { + @Override + public void run() { - JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter(); + ourselectedFile = getSelectedFile(); - if (!jvf.accept(getSelectedFile())) + if (getSelectedFile() == 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) + { + ourselectedFile = new File(getCurrentDirectory(), filename); + } + } catch (Throwable x) { - String withExtension = getSelectedFile() + "." - + jvf.getAcceptableExtension(); - setSelectedFile(new File(withExtension)); + 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 ((ret == JalviewFileChooser.APPROVE_OPTION) - && getSelectedFile().exists()) + if (ourselectedFile == null) { - int confirm = JvOptionPane.showConfirmDialog(parent, - MessageManager.getString("label.overwrite_existing_file"), - MessageManager.getString("label.file_already_exists"), - JvOptionPane.YES_NO_OPTION); + returned = new Response(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 (confirm != JvOptionPane.YES_OPTION) + if (!jvf.accept(getSelectedFile())) + { + String withExtension = getSelectedFile() + "." + + jvf.getAcceptableExtension(); + setSelectedFile(new File(withExtension)); + } + } + // All good, so we continue to save + returned = new Response(JalviewFileChooser.APPROVE_OPTION); + + // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE + // USER PROMPTED FOR A NEW FILENAME + /** + * @j2sNative + */ { - ret = JalviewFileChooser.CANCEL_OPTION; + if (getSelectedFile().exists()) + { + // JAL-3048 - may not need to raise this for browser saves + + // yes/no cancel + int confirm = JvOptionPane.showConfirmDialog(saveparent, + MessageManager.getString("label.overwrite_existing_file"), + MessageManager.getString("label.file_already_exists"), + JvOptionPane.YES_NO_OPTION); + + if (confirm != JvOptionPane.YES_OPTION) + { + returned = new Response(JalviewFileChooser.CANCEL_OPTION); + } + } } + }; + }; + + /** + * 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); + + /* + * Save dialog is opened until user picks a file format + */ + if (!runner.isRegistered(overwriteCheck)) + { + // first call for this instance + runner.firstResponse(overwriteCheck); + } + else + { + // reset response flags + runner.resetResponses(); } - return ret; + setDialogType(SAVE_DIALOG); + + // Java 9,10,11 on OSX - clear selected file so name isn't auto populated + this.setSelectedFile(null); + + saveparent = parent; + + int value = showDialog(parent, MessageManager.getString("action.save")); + /** + * @j2sNative + */ + { + runner.firstRun(value); + } + return value; } void recentListSelectionChanged(Object selection) @@ -330,14 +467,14 @@ public class JalviewFileChooser extends JFileChooser class RecentlyOpened extends JPanel { - JList list; + JList list; public RecentlyOpened() { String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE"); StringTokenizer st; - Vector recent = new Vector(); + Vector recent = new Vector<>(); if (historyItems != null) { @@ -345,11 +482,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); @@ -364,8 +501,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); @@ -375,7 +512,7 @@ public class JalviewFileChooser extends JFileChooser layout.putConstraint(SpringLayout.NORTH, scroller, 5, SpringLayout.NORTH, this); - if (new Platform().isAMac()) + if (Platform.isAMac()) { scroller.setPreferredSize(new Dimension(500, 100)); } @@ -391,12 +528,19 @@ public class JalviewFileChooser extends JFileChooser @Override public void run() { - scroller.getHorizontalScrollBar().setValue( - scroller.getHorizontalScrollBar().getMaximum()); + scroller.getHorizontalScrollBar() + .setValue(scroller.getHorizontalScrollBar().getMaximum()); } }); } } + + @Override + public JalviewFileChooser response(RunResponse action) + { + return runner.response(action); + } + }