X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FJalviewFileChooser.java;h=b7eeaabf0f198ac95a43544a7ebe03d6afd3d79b;hb=62dfc89f5222d6a6ef827b46484f48846a7af9bf;hp=7f0bab188b356ec0e510f8c9e81b90ad451f3790;hpb=a45774ee31d9f35d4eff46d54d7deab719afb092;p=jalview.git diff --git a/src/jalview/io/JalviewFileChooser.java b/src/jalview/io/JalviewFileChooser.java index 7f0bab1..b7eeaab 100755 --- a/src/jalview/io/JalviewFileChooser.java +++ b/src/jalview/io/JalviewFileChooser.java @@ -1,47 +1,182 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7) - * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle - * + * 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 + * 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 . + * + * 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 java.io.*; -import java.util.*; - -import java.awt.*; -import java.awt.event.*; -import javax.swing.*; +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; +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.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 + 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 + * @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); + } + } + + @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) @@ -57,36 +192,47 @@ public class JalviewFileChooser extends JFileChooser return f; } - public JalviewFileChooser(String dir, String[] suffix, String[] desc, - String selected, boolean selectAll) + /** + * 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) { - 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); + runner.resetResponses(); + int value = super.showOpenDialog(this); + /** + * @j2sNative + */ + { + runner.firstRun(value); + } + return value; } - 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; } @@ -100,16 +246,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)) { @@ -118,12 +265,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); } } }); @@ -135,111 +283,199 @@ 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")) - { - format = "Jalview"; - } - else if (format.toUpperCase().startsWith("FASTA")) + int parenPos = format.indexOf("("); + if (parenPos > 0) { - format = "FASTA"; - } - else if (format.toUpperCase().startsWith("MSF")) - { - format = "MSF"; + 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("CLUSTAL")) + return null; + } + + File ourselectedFile = null; + + @Override + public File getSelectedFile() + { + File selfile = super.getSelectedFile(); + if (selfile == null && ourselectedFile != null) { - format = "CLUSTAL"; + return ourselectedFile; } - else if (format.toUpperCase().startsWith("BLC")) + return selfile; + } + + Component saveparent; + RunResponse overwriteCheck = new RunResponse( + JalviewFileChooser.APPROVE_OPTION) + { + @Override + public void run() { - format = "BLC"; - } - else if (format.toUpperCase().startsWith("PIR")) + ourselectedFile = getSelectedFile(); + + if (getSelectedFile() == null) { - format = "PIR"; + // 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(); + } } - else if (format.toUpperCase().startsWith("PFAM")) + if (ourselectedFile == null) { - format = "PFAM"; + 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(); - return format; - } + 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); + } + } + } + }; + }; + + /** + * 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); - setDialogType(SAVE_DIALOG); - - int ret = showDialog(parent, "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, - "Overwrite existing file?", "File exists", - JOptionPane.YES_NO_OPTION); - - if (confirm != JOptionPane.YES_OPTION) - { - ret = JalviewFileChooser.CANCEL_OPTION; - } + // 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(String selection) + void recentListSelectionChanged(Object selection) { setSelectedFile(null); - - File file = new File(selection); - if (getFileFilter() instanceof JalviewFileFilter) + if (selection != null) { - JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter(); - - if (!jvf.accept(file)) + File file = new File((String) selection); + if (getFileFilter() instanceof JalviewFileFilter) { - setFileFilter(getChoosableFileFilters()[0]); + JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter(); + + if (!jvf.accept(file)) + { + setFileFilter(getChoosableFileFilters()[0]); + } } - } - setSelectedFile(file); + setSelectedFile(file); + } } class RecentlyOpened extends JPanel { - JList list; + JList list; public RecentlyOpened() { + + setPreferredSize(new Dimension(300,100)); String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE"); StringTokenizer st; - Vector recent = new Vector(); + Vector recent = new Vector<>(); if (historyItems != null) { @@ -247,40 +483,65 @@ 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); +// dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT); list.setCellRenderer(dlcr); list.addMouseListener(new MouseAdapter() { + @Override public void mousePressed(MouseEvent evt) { - recentListSelectionChanged(list.getSelectedValue().toString()); + 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 (Platform.isAMac()) + { + scroller.setPreferredSize(new Dimension(500, 100)); + } + else + { + scroller.setPreferredSize(new Dimension(530, 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()); } }); } } + + @Override + public JalviewFileChooser addResponse(RunResponse action) + { + return runner.addResponse(action); + } + }