X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FJalviewFileChooser.java;h=1294e8924ff3bed0aa3d4bf9b4f77e9dd77e79e6;hb=9109818e704dd0945567b234af8f3d34ba4b2b67;hp=90e32291b0da334622099591c6cfd229e7e7b249;hpb=47168f025aefdaa044802bd5f8f510ffe43a4808;p=jalview.git diff --git a/src/jalview/io/JalviewFileChooser.java b/src/jalview/io/JalviewFileChooser.java index 90e3229..1294e89 100755 --- a/src/jalview/io/JalviewFileChooser.java +++ b/src/jalview/io/JalviewFileChooser.java @@ -1,19 +1,19 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2) - * Copyright (C) 2014 The Jalview Authors - * + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors + * * This file is part of Jalview. - * + * * Jalview is free software: you can redistribute it and/or - * modify it under the terms of the GNU General Public License + * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation, either version 3 * of the License, or (at your option) any later version. - * - * Jalview is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty - * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. See the GNU General Public License for more details. - * + * * You should have received a copy of the GNU General Public License * along with Jalview. If not, see . * The Jalview Authors are detailed in the 'AUTHORS' file. @@ -21,32 +21,141 @@ ////////////////////////////////////////////////////////////////// package jalview.io; +import jalview.bin.Cache; +import jalview.gui.JvOptionPane; import jalview.util.MessageManager; - -import java.io.*; -import java.util.*; - -import java.awt.*; -import java.awt.event.*; -import javax.swing.*; +import jalview.util.Platform; + +import java.awt.Component; +import java.awt.Dimension; +import java.awt.EventQueue; +import java.awt.HeadlessException; +import java.awt.event.MouseAdapter; +import java.awt.event.MouseEvent; +import java.io.File; +import java.util.ArrayList; +import java.util.List; +import java.util.StringTokenizer; +import java.util.Vector; + +import javax.swing.DefaultListCellRenderer; +import javax.swing.JFileChooser; +import javax.swing.JList; +import javax.swing.JPanel; +import javax.swing.JScrollPane; +import javax.swing.SpringLayout; +import javax.swing.plaf.basic.BasicFileChooserUI; /** * Enhanced file chooser dialog box. - * + * * NOTE: bug on Windows systems when filechooser opened on directory to view * files with colons in title. - * + * * @author AMW - * + * */ public class JalviewFileChooser extends JFileChooser { + /** + * Factory method to return a file chooser that offers readable alignment file + * formats + * + * @param directory + * @param selected + * @return + */ + public static JalviewFileChooser forRead(String directory, + String selected) + { + List extensions = new ArrayList(); + List descs = new ArrayList(); + for (FileFormatI format : FileFormats.getInstance().getFormats()) + { + if (format.isReadable()) + { + extensions.add(format.getExtensions()); + descs.add(format.getName()); + } + } + return new JalviewFileChooser(directory, + extensions.toArray(new String[extensions.size()]), + descs.toArray(new String[descs.size()]), selected, true); + } + + /** + * Factory method to return a file chooser that offers writable alignment file + * formats + * + * @param directory + * @param selected + * @return + */ + public static JalviewFileChooser forWrite(String directory, + 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 : FileFormats.getInstance().getFormats()) + { + if (format.isWritable()) + { + extensions.add(format.getExtensions()); + descs.add(format.getName()); + } + } + return new JalviewFileChooser(directory, + extensions.toArray(new String[extensions.size()]), + descs.toArray(new String[descs.size()]), selected, false); + } + public JalviewFileChooser(String dir) { super(safePath(dir)); setAccessory(new RecentlyOpened()); } + public JalviewFileChooser(String dir, String[] suffix, String[] desc, + String 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) + { + super(safePath(dir)); + if (extensions.length == descs.length) + { + List formats = new ArrayList(); + for (int i = 0; i < extensions.length; i++) + { + formats.add(new String[] { extensions[i], descs[i] }); + } + init(formats, selected, allFiles); + } + else + { + System.err.println("JalviewFileChooser arguments mismatch: " + + extensions + ", " + descs); + } + } + private static File safePath(String dir) { if (dir == null) @@ -62,35 +171,28 @@ public class JalviewFileChooser extends JFileChooser return f; } - public JalviewFileChooser(String dir, String[] suffix, String[] desc, - String selected, boolean selectAll) - { - super(safePath(dir)); - init(suffix, desc, selected, selectAll); - } - - public JalviewFileChooser(String dir, String[] suffix, String[] desc, - String selected) - { - super(safePath(dir)); - init(suffix, desc, selected, true); - } - - void init(String[] suffix, String[] desc, String selected, - boolean selectAll) + /** + * + * @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, boolean allFiles) { JalviewFileFilter chosen = null; // SelectAllFilter needs to be set first before adding further // file filters to fix bug on Mac OSX - setAcceptAllFileFilterUsed(selectAll); + setAcceptAllFileFilterUsed(allFiles); - for (int i = 0; i < suffix.length; i++) + for (String[] format : formats) { - JalviewFileFilter jvf = new JalviewFileFilter(suffix[i], desc[i]); + JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]); addChoosableFileFilter(jvf); - if ((selected != null) && selected.equalsIgnoreCase(desc[i])) + if ((selected != null) && selected.equalsIgnoreCase(format[1])) { chosen = jvf; } @@ -104,16 +206,17 @@ public class JalviewFileChooser extends JFileChooser setAccessory(new RecentlyOpened()); } + @Override public void setFileFilter(javax.swing.filechooser.FileFilter filter) { super.setFileFilter(filter); try { - if (getUI() instanceof javax.swing.plaf.basic.BasicFileChooserUI) + if (getUI() instanceof BasicFileChooserUI) { - final javax.swing.plaf.basic.BasicFileChooserUI ui = (javax.swing.plaf.basic.BasicFileChooserUI) getUI(); - final String name = ui.getFileName().trim(); + final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI(); + final String name = fcui.getFileName().trim(); if ((name == null) || (name.length() == 0)) { @@ -122,12 +225,13 @@ public class JalviewFileChooser extends JFileChooser EventQueue.invokeLater(new Thread() { + @Override public void run() { - String currentName = ui.getFileName(); + String currentName = fcui.getFileName(); if ((currentName == null) || (currentName.length() == 0)) { - ui.setFileName(name); + fcui.setFileName(name); } } }); @@ -139,76 +243,110 @@ public class JalviewFileChooser extends JFileChooser } } - public String getSelectedFormat() + /** + * Returns the selected file format, or null if none selected + * + * @return + */ + public FileFormatI getSelectedFormat() { if (getFileFilter() == null) { 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(); - - if (format.toUpperCase().startsWith("JALVIEW")) + int parenPos = format.indexOf("("); + if (parenPos > 0) { - format = "Jalview"; - } - else if (format.toUpperCase().startsWith("FASTA")) - { - format = "FASTA"; - } - else if (format.toUpperCase().startsWith("MSF")) - { - format = "MSF"; - } - else if (format.toUpperCase().startsWith("CLUSTAL")) - { - format = "CLUSTAL"; - } - else if (format.toUpperCase().startsWith("BLC")) - { - format = "BLC"; - } - else if (format.toUpperCase().startsWith("PIR")) - { - format = "PIR"; + format = format.substring(0, parenPos).trim(); + try + { + return FileFormats.getInstance().forName(format); + } catch (IllegalArgumentException e) + { + System.err.println("Unexpected format: " + format); + } } - else if (format.toUpperCase().startsWith("PFAM")) + return null; + } + + File ourselectedFile = null; + + @Override + public File getSelectedFile() + { + File selfile = super.getSelectedFile(); + if (selfile == null && ourselectedFile != null) { - format = "PFAM"; + return ourselectedFile; } - - return format; + return selfile; } + @Override public int showSaveDialog(Component parent) throws HeadlessException { this.setAccessory(null); setDialogType(SAVE_DIALOG); + this.setSelectedFile(null); int ret = showDialog(parent, MessageManager.getString("action.save")); + ourselectedFile = 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) + { + System.err.println( + "Unexpected exception when trying to get filename."); + x.printStackTrace(); + } + } + if (ourselectedFile == null) + { + return JalviewFileChooser.CANCEL_OPTION; + } 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()) + && ourselectedFile.exists()) { - int confirm = JOptionPane.showConfirmDialog(parent, - "Overwrite existing file?", "File exists", - JOptionPane.YES_NO_OPTION); + int confirm = JvOptionPane.showConfirmDialog(parent, + MessageManager.getString("label.overwrite_existing_file"), + MessageManager.getString("label.file_already_exists"), + JvOptionPane.YES_NO_OPTION); - if (confirm != JOptionPane.YES_OPTION) + if (confirm != JvOptionPane.YES_OPTION) { ret = JalviewFileChooser.CANCEL_OPTION; } @@ -243,6 +381,7 @@ public class JalviewFileChooser extends JFileChooser public RecentlyOpened() { + String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE"); StringTokenizer st; Vector recent = new Vector(); @@ -265,24 +404,42 @@ public class JalviewFileChooser extends JFileChooser list.addMouseListener(new MouseAdapter() { + @Override public void mousePressed(MouseEvent evt) { recentListSelectionChanged(list.getSelectedValue()); } }); - this.setBorder(new javax.swing.border.TitledBorder("Recently Opened")); + this.setBorder(new javax.swing.border.TitledBorder( + MessageManager.getString("label.recently_opened"))); final JScrollPane scroller = new JScrollPane(list); - scroller.setPreferredSize(new Dimension(130, 200)); + + SpringLayout layout = new SpringLayout(); + layout.putConstraint(SpringLayout.WEST, scroller, 5, + SpringLayout.WEST, this); + layout.putConstraint(SpringLayout.NORTH, scroller, 5, + SpringLayout.NORTH, this); + + if (new Platform().isAMac()) + { + scroller.setPreferredSize(new Dimension(500, 100)); + } + else + { + scroller.setPreferredSize(new Dimension(130, 200)); + } + this.add(scroller); javax.swing.SwingUtilities.invokeLater(new Runnable() { + @Override public void run() { - scroller.getHorizontalScrollBar().setValue( - scroller.getHorizontalScrollBar().getMaximum()); + scroller.getHorizontalScrollBar() + .setValue(scroller.getHorizontalScrollBar().getMaximum()); } });