X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FJalviewFileChooser.java;h=1294e8924ff3bed0aa3d4bf9b4f77e9dd77e79e6;hb=9109818e704dd0945567b234af8f3d34ba4b2b67;hp=08b99c2d11578616c316981bbd7a8e48d4b72e1b;hpb=a407d4d7fd8fc8ee573bfe4cb9aaa63271a1ea69;p=jalview.git diff --git a/src/jalview/io/JalviewFileChooser.java b/src/jalview/io/JalviewFileChooser.java index 08b99c2..1294e89 100755 --- a/src/jalview/io/JalviewFileChooser.java +++ b/src/jalview/io/JalviewFileChooser.java @@ -1,475 +1,449 @@ -/* - * Jalview - A Sequence Alignment Editor and Viewer - * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program 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 this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA - */ -/*/////////////////////////////////////////////////////////////////// -// This file was taken from java forum -// Re: JFileChooser functioning like normal Windows Apps FileChooser -// Author: ddanimal -// http://forum.java.sun.com/thread.jspa?forumID=57&threadID=327712 -*/ - -////////////////////////////////////////////////////////////////// -package jalview.io; - -import java.io.*; -import java.util.*; - -import java.awt.*; -import java.awt.event.*; -import javax.swing.*; -import javax.swing.plaf.*; -import javax.swing.plaf.basic.*; -import javax.swing.plaf.metal.*; -import javax.swing.table.*; - -public class JalviewFileChooser - extends JFileChooser -{ - - - public JalviewFileChooser(String dir, String[] suffix, String[] desc, - String selected) - { - super(dir); - - JalviewFileFilter chosen = null; - - for (int i = 0; i < suffix.length; i++) - { - JalviewFileFilter jvf = new JalviewFileFilter(suffix[i], desc[i]); - addChoosableFileFilter(jvf); - - if ( (selected != null) && selected.equalsIgnoreCase(desc[i])) - { - chosen = jvf; - } - } - - if (chosen != null) - { - setFileFilter(chosen); - } - - } - - - public void setFileFilter(javax.swing.filechooser.FileFilter filter) - { - super.setFileFilter(filter); - - if (!(getUI() instanceof BasicFileChooserUI)) { - return; - } - - final BasicFileChooserUI ui = (BasicFileChooserUI) getUI(); - final String name = ui.getFileName().trim(); - - if ((name == null) || (name.length() == 0)) { - return; - } - - EventQueue.invokeLater(new Thread() { - public void run() { - String currentName = ui.getFileName(); - if ((currentName == null) || (currentName.length() == 0)) { - ui.setFileName(name); - } - } - }); - } - - - public JalviewFileChooser(String dir) - { - super(dir); - } - - public String getSelectedFormat() - { - String format = getFileFilter().getDescription(); - - if (format.toUpperCase().startsWith("JALVIEW")) - { - 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"; - } - else if (format.toUpperCase().startsWith("PFAM")) - { - format = "PFAM"; - } - - return format; - } - - public int showSaveDialog(Component parent) - throws HeadlessException - { - setDialogType(SAVE_DIALOG); - - int ret = showDialog(parent, null); - - if (getFileFilter() instanceof JalviewFileFilter) - { - JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter(); - - if (!jvf.accept(getSelectedFile())) - { - String withExtension = getSelectedFile() + "." + - jvf.getAcceptableExtension(); - setSelectedFile(new File(withExtension)); - } - } - - if ( (ret == JalviewFileChooser.APPROVE_OPTION) && - getSelectedFile().exists()) - { - int confirm = JOptionPane.showConfirmDialog(parent, - "Overwrite existing file?", - "File exists", - JOptionPane.YES_NO_OPTION); - - if (confirm != JOptionPane.YES_OPTION) - { - ret = this.CANCEL_OPTION; - } - } - - return ret; - } - - - - /************************************************************************** - * Always create the local UI - * @param comp - *************************************************************************/ - public final void setUI(ComponentUI comp) - { - UI ui = new UI(this); - - super.setUI(ui); - } - - /************************************************************************** - * Internal implementation of Metal LookAndFeel to create the table sorting - * ability. - *************************************************************************/ - private class UI - extends MetalFileChooserUI - { - private DirectoryModel model; - - /************************************************************************** - * Must be overridden to extend - * @param e - *************************************************************************/ - public UI(JFileChooser e) - { - super(e); - try{ - this.installIcons(e); - }catch(Exception ex) - { System.out.println(ex+"\nProblem installing icons, FileChooser");} - } - - /************************************************************************** - * Overridden to create our own model - *************************************************************************/ - protected final void createModel() - { - model = new DirectoryModel(getFileChooser()); - } - - /************************************************************************** - * Overridden to get our own model - * @return - *************************************************************************/ - public final BasicDirectoryModel getModel() - { - return model; - } - - /************************************************************************** - * Calls the default method then adds a MouseListener to the JTable - * @param chooser - * @return - *************************************************************************/ - protected final JPanel createDetailsView(JFileChooser chooser) - { - final JPanel panel = super.createDetailsView(chooser); - - //Since we can't access MetalFileChooserUI's private member detailsTable - //directly, we have to find it in the JPanel - final JTable tbl = findJTable(panel.getComponents()); - - if (tbl != null) - { - //Add a mouselistener to listen for presses on column headers - tbl.getTableHeader().addMouseListener(new MouseAdapter() - { - public void mousePressed(MouseEvent e) - { - - e.consume(); - - final int col = tbl.getTableHeader().columnAtPoint(e.getPoint()); - model.sort(col, tbl); - - } - }); - } - - return panel; - } - - /************************************************************************** - * Finds the JTable in the panel so we can add MouseListener - * @param comp - * @return - *************************************************************************/ - private JTable findJTable(Component[] comp) - { - for (int i = 0; i < comp.length; i++) - { - if (comp[i] instanceof JTable) - { - return (JTable) comp[i]; - } - - if (comp[i] instanceof Container) - { - JTable tbl = findJTable( ( (Container) comp[i]).getComponents()); - - if (tbl != null) - { - return tbl; - } - } - } - - return null; - } - } - - /*************************************************************************** - * Implementation of BasicDirectoryModel that sorts the Files by column - **************************************************************************/ - private final class DirectoryModel - extends BasicDirectoryModel - { - String sortingColumnName=null; - int col = 0; - boolean ascending; - - /************************************************************************** - * Must be overridden to extend BasicDirectoryModel - * @param chooser - *************************************************************************/ - DirectoryModel(JFileChooser chooser) - { - super(chooser); - } - - - /************************************************************************** - * Resorts the JFileChooser table based on new column - * @param c - *************************************************************************/ - protected final void sort(int c, JTable tbl) - { - - - //Set column and order - col = c; - ascending = !ascending; - - String indicator = " (^)"; - - if (ascending) - { - indicator = " (v)"; - } - - final JTableHeader th = tbl.getTableHeader(); - final TableColumnModel tcm = th.getColumnModel(); - TableColumn tc = null; - String title = null; - - - //Remove indicator from old sort, and add to new - for(int i=0; i b.lastModified()) - { - ret = -1; - } - else if (a.lastModified() == b.lastModified()) - { - ret = 0; - } - - if (ascending) - { - ret *= -1; - } - - return ret; - } - }); - } - else if(sortingColumnName.equals(UIManager.getString("FileChooser.fileSizeHeaderText"))) - { - - Collections.sort(data, - new Comparator() - { - - public int compare(Object o1, Object o2) - { - int ret = 1; - final File a = (File) o1; - final File b = (File) o2; - - if (a.length() > b.length()) - { - ret = -1; - } - else if (a.length() == b.length()) - { - ret = 0; - } - - if (ascending) - { - ret *= -1; - } - - return ret; - } - }); - } - else if(sortingColumnName.equals(UIManager.getString("FileChooser.fileTypeHeaderText"))) - { - Collections.sort(data, - new Comparator() - { - public int compare(Object o1, Object o2) - { - final String a = getFileSystemView().getSystemTypeDescription( (File)o1 ); - final String b = getFileSystemView().getSystemTypeDescription( (File)o2 ); - if (ascending) - { - return a.compareToIgnoreCase(b); - } - else - { - return -1 * a.compareToIgnoreCase(b); - } - } - }); - } - else if(sortingColumnName.equals(UIManager.getString("FileChooser.fileNameHeaderText"))) -{ - Collections.sort(data, - new Comparator() - { - public int compare(Object o1, Object o2) - { - final String a = ((File) o1).getName(); - final String b = ((File) o2).getName(); - - if (ascending) - { - return a.compareToIgnoreCase(b); - } - else - { - return -1 * a.compareToIgnoreCase(b); - } - } - }); - } - - } - } -} +/* + * 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 + * 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 + * 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. + */ +////////////////////////////////////////////////////////////////// +package jalview.io; + +import jalview.bin.Cache; +import jalview.gui.JvOptionPane; +import jalview.util.MessageManager; +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) + { + return null; + } + + File f = new File(dir); + if (f.getName().indexOf(':') > -1) + { + return null; + } + return f; + } + + /** + * + * @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(allFiles); + + for (String[] format : formats) + { + JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]); + addChoosableFileFilter(jvf); + if ((selected != null) && selected.equalsIgnoreCase(format[1])) + { + chosen = jvf; + } + } + + if (chosen != null) + { + setFileFilter(chosen); + } + + setAccessory(new RecentlyOpened()); + } + + @Override + public void setFileFilter(javax.swing.filechooser.FileFilter filter) + { + super.setFileFilter(filter); + + try + { + if (getUI() instanceof BasicFileChooserUI) + { + final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI(); + final String name = fcui.getFileName().trim(); + + if ((name == null) || (name.length() == 0)) + { + return; + } + + EventQueue.invokeLater(new Thread() + { + @Override + public void run() + { + String currentName = fcui.getFileName(); + if ((currentName == null) || (currentName.length() == 0)) + { + fcui.setFileName(name); + } + } + }); + } + } catch (Exception ex) + { + ex.printStackTrace(); + // Some platforms do not have BasicFileChooserUI + } + } + + /** + * 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(); + 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); + + 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(ourselectedFile)) + { + String withExtension = getSelectedFile().getName() + "." + + jvf.getAcceptableExtension(); + 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) + && ourselectedFile.exists()) + { + int confirm = JvOptionPane.showConfirmDialog(parent, + MessageManager.getString("label.overwrite_existing_file"), + MessageManager.getString("label.file_already_exists"), + JvOptionPane.YES_NO_OPTION); + + if (confirm != JvOptionPane.YES_OPTION) + { + ret = JalviewFileChooser.CANCEL_OPTION; + } + } + + return ret; + } + + void recentListSelectionChanged(Object selection) + { + setSelectedFile(null); + if (selection != null) + { + File file = new File((String) selection); + if (getFileFilter() instanceof JalviewFileFilter) + { + JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter(); + + if (!jvf.accept(file)) + { + setFileFilter(getChoosableFileFilters()[0]); + } + } + + setSelectedFile(file); + } + } + + class RecentlyOpened extends JPanel + { + JList list; + + public RecentlyOpened() + { + + String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE"); + StringTokenizer st; + Vector recent = new Vector(); + + if (historyItems != null) + { + st = new StringTokenizer(historyItems, "\t"); + + while (st.hasMoreTokens()) + { + recent.addElement(st.nextElement()); + } + } + + list = new JList(recent); + + DefaultListCellRenderer dlcr = new DefaultListCellRenderer(); + dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT); + list.setCellRenderer(dlcr); + + list.addMouseListener(new MouseAdapter() + { + @Override + public void mousePressed(MouseEvent evt) + { + recentListSelectionChanged(list.getSelectedValue()); + } + }); + + this.setBorder(new javax.swing.border.TitledBorder( + MessageManager.getString("label.recently_opened"))); + + final JScrollPane scroller = new JScrollPane(list); + + 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()); + } + }); + + } + + } +}