X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FJalviewFileChooser.java;h=3f44596a662e0be6a5f8c0c5341691a1740a23ea;hb=4ea2f7c6e700c5137c62a09a93d0127f8d58158b;hp=7fbe8014a41986112756931f2b24c6ecde864ad2;hpb=0e96750ac13c49fe43f97d4929d2a5e4520eb141;p=jalview.git diff --git a/src/jalview/io/JalviewFileChooser.java b/src/jalview/io/JalviewFileChooser.java index 7fbe801..3f44596 100755 --- a/src/jalview/io/JalviewFileChooser.java +++ b/src/jalview/io/JalviewFileChooser.java @@ -21,11 +21,6 @@ ////////////////////////////////////////////////////////////////// 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; @@ -34,25 +29,40 @@ import java.awt.event.ActionEvent; import java.awt.event.ActionListener; 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.HashMap; import java.util.List; +import java.util.Map; import java.util.StringTokenizer; import java.util.Vector; import javax.swing.BoxLayout; -import javax.swing.DefaultListCellRenderer; import javax.swing.JCheckBox; +import javax.swing.JDialog; import javax.swing.JFileChooser; +import javax.swing.JLabel; import javax.swing.JList; +import javax.swing.JOptionPane; import javax.swing.JPanel; import javax.swing.JScrollPane; +import javax.swing.ListCellRenderer; import javax.swing.SpringLayout; +import javax.swing.SwingConstants; import javax.swing.SwingUtilities; import javax.swing.border.TitledBorder; import javax.swing.filechooser.FileFilter; import javax.swing.plaf.basic.BasicFileChooserUI; +import jalview.bin.Cache; +import jalview.gui.JvOptionPane; +import jalview.util.ChannelProperties; +import jalview.util.MessageManager; +import jalview.util.Platform; +import jalview.util.dialogrunner.DialogRunnerI; + /** * Enhanced file chooser dialog box. * @@ -63,7 +73,14 @@ import javax.swing.plaf.basic.BasicFileChooserUI; * */ public class JalviewFileChooser extends JFileChooser + implements DialogRunnerI, PropertyChangeListener { + private static final long serialVersionUID = 1L; + + private Map callbacks = new HashMap<>(); + + File selectedFile = null; + /** * backupfilesCheckBox = "Include backup files" checkbox includeBackupfiles = * flag set by checkbox @@ -160,13 +177,13 @@ public class JalviewFileChooser extends JFileChooser } JalviewFileChooser(String dir, String[] extensions, String[] descs, - String selected, boolean allFiles) + String selected, boolean acceptAny) { - this(dir, extensions, descs, selected, allFiles, false); + this(dir, extensions, descs, selected, acceptAny, false); } public JalviewFileChooser(String dir, String[] extensions, String[] descs, - String selected, boolean allFiles, boolean allowBackupFiles) + String selected, boolean acceptAny, boolean allowBackupFiles) { super(safePath(dir)); if (extensions.length == descs.length) @@ -176,11 +193,11 @@ public class JalviewFileChooser extends JFileChooser { formats.add(new String[] { extensions[i], descs[i] }); } - init(formats, selected, allFiles, allowBackupFiles); + init(formats, selected, acceptAny, allowBackupFiles); } else { - System.err.println("JalviewFileChooser arguments mismatch: " + jalview.bin.Console.errPrintln("JalviewFileChooser arguments mismatch: " + extensions + ", " + descs); } } @@ -201,19 +218,45 @@ public class JalviewFileChooser extends JFileChooser } /** + * 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) + { + int value = super.showOpenDialog(this); + + if (!Platform.isJS()) + /** + * Java only + * + * @j2sIgnore + */ + { + /* + * code here is not run in JalviewJS, instead + * propertyChange() is called for dialog action + */ + handleResponse(value); + } + return value; + } + + /** * * @param formats * a list of {extensions, description} for each file format * @param selected - * @param allFiles + * @param acceptAny * if true, 'any format' option is included */ - void init(List formats, String selected, boolean allFiles) + void init(List formats, String selected, boolean acceptAny) { - init(formats, selected, allFiles, false); + init(formats, selected, acceptAny, false); } - void init(List formats, String selected, boolean allFiles, + void init(List formats, String selected, boolean acceptAny, boolean allowBackupFiles) { @@ -221,7 +264,32 @@ public class JalviewFileChooser extends JFileChooser // SelectAllFilter needs to be set first before adding further // file filters to fix bug on Mac OSX - setAcceptAllFileFilterUsed(allFiles); + setAcceptAllFileFilterUsed(acceptAny); + + // add a "All known alignment files" option + List allExtensions = new ArrayList<>(); + for (String[] format : formats) + { + String[] extensions = format[0].split(","); + for (String ext : extensions) + { + if (!allExtensions.contains(ext)) + { + allExtensions.add(ext); + } + } + } + allExtensions.sort(null); + JalviewFileFilter alljvf = new JalviewFileFilter( + allExtensions.toArray(new String[] {}), + MessageManager.getString("label.all_known_alignment_files")); + alljvf.setExtensionListInDescription(false); + addChoosableFileFilter(alljvf); + + if (selected == null) + { + chosen = alljvf; + } for (String[] format : formats) { @@ -248,7 +316,8 @@ public class JalviewFileChooser extends JFileChooser multi.setLayout(new BoxLayout(multi, BoxLayout.PAGE_AXIS)); if (backupfilesCheckBox == null) { - try { + try + { includeBackupFiles = Boolean.parseBoolean( Cache.getProperty(BackupFiles.NS + "_FC_INCLUDE")); } catch (Exception e) @@ -278,8 +347,8 @@ public class JalviewFileChooser extends JFileChooser } // fake the OK button changing (to force it to upate) String s = jfc.getApproveButtonText(); - jfc.firePropertyChange( - APPROVE_BUTTON_TEXT_CHANGED_PROPERTY, null, s); + 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); @@ -368,30 +437,26 @@ public class JalviewFileChooser extends JFileChooser return FileFormats.getInstance().forName(format); } catch (IllegalArgumentException e) { - System.err.println("Unexpected format: " + format); + jalview.bin.Console.errPrintln("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; + File f = super.getSelectedFile(); + return f == null ? selectedFile : f; } @Override public int showSaveDialog(Component parent) throws HeadlessException { this.setAccessory(null); + // Java 9,10,11 on OSX - clear selected file so name isn't auto populated this.setSelectedFile(null); + return super.showSaveDialog(parent); } @@ -411,9 +476,9 @@ public class JalviewFileChooser extends JFileChooser return; } - ourselectedFile = getSelectedFile(); + selectedFile = getSelectedFile(); - if (ourselectedFile == null) + if (selectedFile == null) { // Workaround for Java 9,10 on OSX - no selected file, but there is a // filename typed in @@ -422,11 +487,11 @@ public class JalviewFileChooser extends JFileChooser String filename = ((BasicFileChooserUI) getUI()).getFileName(); if (filename != null && filename.length() > 0) { - ourselectedFile = new File(getCurrentDirectory(), filename); + selectedFile = new File(getCurrentDirectory(), filename); } } catch (Throwable x) { - System.err.println( + jalview.bin.Console.errPrintln( "Unexpected exception when trying to get filename."); x.printStackTrace(); } @@ -434,7 +499,8 @@ public class JalviewFileChooser extends JFileChooser // THE // USER PROMPTED FOR A NEW FILENAME } - if (ourselectedFile == null) + + if (selectedFile == null) { return; } @@ -443,21 +509,24 @@ public class JalviewFileChooser extends JFileChooser { JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter(); - if (!jvf.accept(ourselectedFile)) + if (!jvf.accept(selectedFile)) { String withExtension = getSelectedFile().getName() + "." + jvf.getAcceptableExtension(); - ourselectedFile = (new File(getCurrentDirectory(), withExtension)); - setSelectedFile(ourselectedFile); + selectedFile = (new File(getCurrentDirectory(), withExtension)); + setSelectedFile(selectedFile); } } - if (ourselectedFile.exists()) + if (selectedFile.exists()) { - int confirm = JvOptionPane.showConfirmDialog(this, - MessageManager.getString("label.overwrite_existing_file"), - MessageManager.getString("label.file_already_exists"), - JvOptionPane.YES_NO_OPTION); + int confirm = Cache.getDefault("CONFIRM_OVERWRITE_FILE", true) + ? JvOptionPane.showConfirmDialog(this, + MessageManager + .getString("label.overwrite_existing_file"), + MessageManager.getString("label.file_already_exists"), + JvOptionPane.YES_NO_OPTION) + : JOptionPane.YES_OPTION; if (confirm != JvOptionPane.YES_OPTION) { @@ -484,25 +553,24 @@ public class JalviewFileChooser extends JFileChooser } } + if (!file.isAbsolute() && file.exists()) + { + file = file.getAbsoluteFile(); + } + setSelectedFile(file); } } - /** - * 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 { private static final long serialVersionUID = 1L; - private JList list; + JList list; RecentlyOpened() { + setPreferredSize(new Dimension(300, 100)); String historyItems = Cache.getProperty("RECENT_FILE"); StringTokenizer st; Vector recent = new Vector<>(); @@ -510,6 +578,7 @@ public class JalviewFileChooser extends JFileChooser if (historyItems != null) { st = new StringTokenizer(historyItems, "\t"); + while (st.hasMoreTokens()) { recent.addElement(st.nextToken()); @@ -517,10 +586,7 @@ public class JalviewFileChooser extends JFileChooser } list = new JList<>(recent); - - DefaultListCellRenderer dlcr = new DefaultListCellRenderer(); - dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT); - list.setCellRenderer(dlcr); + list.setCellRenderer(new recentlyOpenedCellRenderer()); list.addMouseListener(new MouseAdapter() { @@ -531,8 +597,11 @@ public class JalviewFileChooser extends JFileChooser } }); - this.setBorder(new TitledBorder( - MessageManager.getString("label.recently_opened"))); + TitledBorder recentlyOpenedBorder = new TitledBorder( + MessageManager.getString("label.recently_opened")); + recentlyOpenedBorder.setTitleFont( + recentlyOpenedBorder.getTitleFont().deriveFont(10f)); + this.setBorder(recentlyOpenedBorder); final JScrollPane scroller = new JScrollPane(list); @@ -542,15 +611,8 @@ public class JalviewFileChooser extends JFileChooser layout.putConstraint(SpringLayout.NORTH, scroller, 5, SpringLayout.NORTH, this); - if (Platform.isAMac()) - { - scroller.setPreferredSize(new Dimension(500, 100)); - } - else - { - scroller.setPreferredSize(new Dimension(130, 200)); - } - + // one size okay for all + scroller.setPreferredSize(new Dimension(280, 105)); this.add(scroller); SwingUtilities.invokeLater(new Runnable() @@ -562,6 +624,158 @@ public class JalviewFileChooser extends JFileChooser .setValue(scroller.getHorizontalScrollBar().getMaximum()); } }); + } + } + + class recentlyOpenedCellRenderer extends JLabel + implements ListCellRenderer + { + private final static int maxChars = 46; + + private final static String ellipsis = "..."; + + @Override + public Component getListCellRendererComponent( + JList list, String value, int index, + boolean isSelected, boolean cellHasFocus) + { + String filename = value.toString(); + String displayFilename; + if (filename.length() > maxChars) + { + StringBuilder displayFileSB = new StringBuilder(); + File file = new File(filename); + displayFileSB.append(file.getName()); + if (file.getParent() != null) + { + File parent = file; + boolean spaceleft = true; + while (spaceleft && parent.getParent() != null) + { + parent = parent.getParentFile(); + String name = parent.getName(); + displayFileSB.insert(0, File.separator); + if (displayFileSB.length() + name.length() < maxChars - 1) + { + displayFileSB.insert(0, name); + } + else + { + displayFileSB.insert(0, ellipsis); + spaceleft = false; + } + } + if (spaceleft && filename.startsWith(File.separator) + && !(displayFileSB.charAt(0) == File.separatorChar)) + { + displayFileSB.insert(0, File.separator); + } + } + displayFilename = displayFileSB.toString(); + } + else + { + displayFilename = filename; + } + this.setText(displayFilename.toString()); + this.setToolTipText(filename); + if (isSelected) + { + setBackground(list.getSelectionBackground()); + setForeground(list.getSelectionForeground()); + } + else + { + setBackground(list.getBackground()); + setForeground(list.getForeground()); + } + this.setHorizontalAlignment(SwingConstants.TRAILING); + this.setEnabled(list.isEnabled()); + this.setFont(list.getFont().deriveFont(12f)); + this.setOpaque(true); + return this; + } + + } + + /* + @Override + public JalviewFileChooser setResponseHandler(Object response, + Runnable action) + { + callbacks.put(response, new Callable() + { + @Override + public Void call() + { + action.run(); + return null; + } + }); + return this; + } + */ + + @Override + public DialogRunnerI setResponseHandler(Object response, Runnable action) + { + callbacks.put(response, action); + return this; + } + + @Override + public void handleResponse(Object response) + { + /* + * this test is for NaN in Chrome + */ + if (response != null && !response.equals(response)) + { + return; + } + Runnable action = callbacks.get(response); + if (action != null) + { + try + { + action.run(); + } catch (Exception e) + { + e.printStackTrace(); + } + } + } + + /** + * JalviewJS signals file selection by a property change event for property + * "SelectedFile". This methods responds to that by running the response + * action for 'OK' in the dialog. + * + * @param evt + */ + @Override + public void propertyChange(PropertyChangeEvent evt) + { + // TODO other properties need runners... + switch (evt.getPropertyName()) + { + /* + * property name here matches that used in JFileChooser.js + */ + case "SelectedFile": + handleResponse(APPROVE_OPTION); + break; + } + } + + @Override + protected JDialog createDialog(Component parent) throws HeadlessException + { + JDialog dialog = super.createDialog(parent); + dialog.setIconImages(ChannelProperties.getIconList()); + return dialog; + } + }