X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FJalviewFileChooser.java;h=7fbe8014a41986112756931f2b24c6ecde864ad2;hb=90cf1b4dbeb37554fd4b654c1da523f5791383e4;hp=a4362dc7c60810ac7db8714b189884e86900e6f6;hpb=8b27085fa7fc5f2877e078421284c2636b85b8c6;p=jalview.git diff --git a/src/jalview/io/JalviewFileChooser.java b/src/jalview/io/JalviewFileChooser.java index a4362dc..7fbe801 100755 --- a/src/jalview/io/JalviewFileChooser.java +++ b/src/jalview/io/JalviewFileChooser.java @@ -21,6 +21,8 @@ ////////////////////////////////////////////////////////////////// package jalview.io; +import jalview.bin.Cache; +import jalview.gui.JvOptionPane; import jalview.util.MessageManager; import jalview.util.Platform; @@ -28,22 +30,27 @@ 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.io.File; import java.util.ArrayList; -import java.util.Collections; import java.util.List; 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.JOptionPane; import javax.swing.JPanel; import javax.swing.JScrollPane; import javax.swing.SpringLayout; +import javax.swing.SwingUtilities; +import javax.swing.border.TitledBorder; +import javax.swing.filechooser.FileFilter; import javax.swing.plaf.basic.BasicFileChooserUI; /** @@ -58,31 +65,45 @@ import javax.swing.plaf.basic.BasicFileChooserUI; public class JalviewFileChooser extends JFileChooser { /** + * 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 * * @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()) + 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()) { 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, + allowBackupFiles); } /** @@ -91,27 +112,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 +140,43 @@ 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); + } + + /** + * 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) + { + this(dir, extensions, descs, selected, allFiles, false); } public JalviewFileChooser(String dir, String[] extensions, String[] descs, - String selected) + String selected, boolean allFiles, 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); + init(formats, selected, allFiles, allowBackupFiles); } else { @@ -168,19 +205,31 @@ public class JalviewFileChooser extends JFileChooser * @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) + { + init(formats, selected, allFiles, false); + } + + void init(List formats, String selected, boolean allFiles, + boolean allowBackupFiles) { 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) { JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]); + if (allowBackupFiles) + { + jvf.setParentJFC(this); + } addChoosableFileFilter(jvf); if ((selected != null) && selected.equalsIgnoreCase(format[1])) { @@ -193,7 +242,64 @@ 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 @@ -233,6 +339,11 @@ public class JalviewFileChooser extends JFileChooser } } + /** + * Returns the selected file format, or null if none selected + * + * @return + */ public FileFormatI getSelectedFormat() { if (getFileFilter() == null) @@ -240,47 +351,121 @@ 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(); - 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; + } + + File ourselectedFile = null; + + @Override + public File getSelectedFile() + { + File selfile = super.getSelectedFile(); + if (selfile == null && ourselectedFile != null) + { + return ourselectedFile; + } + return selfile; } @Override public int showSaveDialog(Component parent) throws HeadlessException { this.setAccessory(null); + this.setSelectedFile(null); + return super.showSaveDialog(parent); + } - setDialogType(SAVE_DIALOG); + /** + * 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; + } - int ret = showDialog(parent, MessageManager.getString("action.save")); + ourselectedFile = getSelectedFile(); + + if (ourselectedFile == 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) + { + 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 (ourselectedFile == null) + { + return; + } if (getFileFilter() instanceof JalviewFileFilter) { JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter(); - if (!jvf.accept(getSelectedFile())) + if (!jvf.accept(ourselectedFile)) { - String withExtension = getSelectedFile() + "." + String withExtension = getSelectedFile().getName() + "." + jvf.getAcceptableExtension(); - setSelectedFile(new File(withExtension)); + ourselectedFile = (new File(getCurrentDirectory(), withExtension)); + setSelectedFile(ourselectedFile); } } - // 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.exists()) { - int confirm = JOptionPane.showConfirmDialog(parent, + int confirm = JvOptionPane.showConfirmDialog(this, MessageManager.getString("label.overwrite_existing_file"), MessageManager.getString("label.file_already_exists"), - JOptionPane.YES_NO_OPTION); + JvOptionPane.YES_NO_OPTION); - if (confirm != JOptionPane.YES_OPTION) + if (confirm != JvOptionPane.YES_OPTION) { - ret = JalviewFileChooser.CANCEL_OPTION; + return; } } - return ret; + super.approveSelection(); } void recentListSelectionChanged(Object selection) @@ -303,28 +488,35 @@ public class JalviewFileChooser extends JFileChooser } } + /** + * A panel to set as the 'accessory' component to the file chooser dialog, + * holding a list of recently opened files (if any). These are held as a + * tab-separated list of file paths under key RECENT_FILE in + * .jalview_properties. A click in the list calls a method in + * JalviewFileChooser to set the chosen file as the selection. + */ class RecentlyOpened extends JPanel { - JList list; + private static final long serialVersionUID = 1L; - public RecentlyOpened() - { + private JList list; - String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE"); + RecentlyOpened() + { + String historyItems = Cache.getProperty("RECENT_FILE"); StringTokenizer st; - Vector recent = new Vector(); + Vector recent = new Vector<>(); if (historyItems != null) { st = new StringTokenizer(historyItems, "\t"); - 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); @@ -339,8 +531,8 @@ public class JalviewFileChooser extends JFileChooser } }); - this.setBorder(new javax.swing.border.TitledBorder(MessageManager - .getString("label.recently_opened"))); + this.setBorder(new TitledBorder( + MessageManager.getString("label.recently_opened"))); final JScrollPane scroller = new JScrollPane(list); @@ -350,7 +542,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)); } @@ -361,17 +553,15 @@ public class JalviewFileChooser extends JFileChooser this.add(scroller); - javax.swing.SwingUtilities.invokeLater(new Runnable() + SwingUtilities.invokeLater(new Runnable() { @Override public void run() { - scroller.getHorizontalScrollBar().setValue( - scroller.getHorizontalScrollBar().getMaximum()); + scroller.getHorizontalScrollBar() + .setValue(scroller.getHorizontalScrollBar().getMaximum()); } }); - } - } }