X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FJalviewFileChooser.java;h=809985de4e4cd9b87924b5a30b99b4489fd41c17;hb=8ca1ac83b31ae44e8025b246800a4671f44cbb0c;hp=7e1aaa1ff443fc74d6200100c4398dfdf05c7cc4;hpb=74b531f56bbaad5c5e06a4744980256fe8110923;p=jalview.git diff --git a/src/jalview/io/JalviewFileChooser.java b/src/jalview/io/JalviewFileChooser.java index 7e1aaa1..809985d 100755 --- a/src/jalview/io/JalviewFileChooser.java +++ b/src/jalview/io/JalviewFileChooser.java @@ -21,8 +21,13 @@ ////////////////////////////////////////////////////////////////// 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 jalview.util.dialogrunner.Response; +import jalview.util.dialogrunner.RunResponse; import java.awt.Component; import java.awt.Dimension; @@ -30,9 +35,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; @@ -40,7 +46,6 @@ import java.util.Vector; import javax.swing.DefaultListCellRenderer; import javax.swing.JFileChooser; import javax.swing.JList; -import javax.swing.JOptionPane; import javax.swing.JPanel; import javax.swing.JScrollPane; import javax.swing.SpringLayout; @@ -56,33 +61,34 @@ import javax.swing.plaf.basic.BasicFileChooserUI; * */ public class JalviewFileChooser extends JFileChooser + implements PropertyChangeListener, DialogRunnerI { + jalview.util.dialogrunner.DialogRunner runner = new jalview.util.dialogrunner.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.getShortDescription()); + 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); } /** @@ -91,27 +97,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.getShortDescription()); + 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) @@ -120,26 +125,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 { @@ -148,6 +164,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) @@ -163,20 +191,34 @@ public class JalviewFileChooser extends JFileChooser return f; } + public void openDialog(Component parent) + { + runner.resetResponses(); + int value = showOpenDialog(this); + /** + * @j2sNative + */ + { + runner.firstRun(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) { @@ -233,6 +275,11 @@ public class JalviewFileChooser extends JFileChooser } } + /** + * Returns the selected file format, or null if none selected + * + * @return + */ public FileFormatI getSelectedFormat() { if (getFileFilter() == null) @@ -240,48 +287,107 @@ public class JalviewFileChooser extends JFileChooser return null; } + /* + * logic here depends on option description being formatted as + * formatName (extension, extension...) + * or the 'no option selected' value + * All Files + * @see JalviewFileFilter.getDescription + */ String format = getFileFilter().getDescription(); - format = format.substring(0, format.indexOf("(") - 1); - return FileFormat.valueOf(format); + int parenPos = format.indexOf("("); + if (parenPos > 0) + { + format = format.substring(0, parenPos).trim(); + try + { + return FileFormats.getInstance().forName(format); + } catch (IllegalArgumentException e) + { + System.err.println("Unexpected format: " + format); + } + } + return null; } + Component saveparent; + RunResponse overwriteCheck = new RunResponse( + JalviewFileChooser.APPROVE_OPTION) + { + @Override + public void run() + { + // 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 + 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 + */ + { + 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); + } + } + } + }; + }; + @Override public int showSaveDialog(Component parent) throws HeadlessException { this.setAccessory(null); - setDialogType(SAVE_DIALOG); - - int ret = showDialog(parent, MessageManager.getString("action.save")); - - if (getFileFilter() instanceof JalviewFileFilter) + /* + * Save dialog is opened until user picks a file format + */ + if (!runner.isRegistered(overwriteCheck)) { - JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter(); - - if (!jvf.accept(getSelectedFile())) - { - String withExtension = getSelectedFile() + "." - + jvf.getAcceptableExtension(); - setSelectedFile(new File(withExtension)); - } + // first call for this instance + runner.firstResponse(overwriteCheck); } - // 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()) + else { - int confirm = JOptionPane.showConfirmDialog(parent, - MessageManager.getString("label.overwrite_existing_file"), - MessageManager.getString("label.file_already_exists"), - JOptionPane.YES_NO_OPTION); - - if (confirm != JOptionPane.YES_OPTION) - { - ret = JalviewFileChooser.CANCEL_OPTION; - } + // reset response flags + runner.resetResponses(); } - return ret; + setDialogType(SAVE_DIALOG); + saveparent = parent; + + int value = showDialog(parent, MessageManager.getString("action.save")); + /** + * @j2sNative + */ + { + runner.firstRun(value); + } + return value; } void recentListSelectionChanged(Object selection) @@ -340,8 +446,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); @@ -367,12 +473,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); + } + }