+/*
+ * 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 <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+//////////////////////////////////////////////////////////////////
package jalview.io;
-import java.awt.*;
-import java.awt.event.*;
-import java.io.*;
-import java.util.*;
-
-import javax.swing.*;
-import javax.swing.plaf.*;
-import javax.swing.plaf.basic.*;
-import javax.swing.plaf.metal.*;
-import javax.swing.table.*;
-
+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.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.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.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;
+
+/**
+ * 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
{
+ /**
+ * 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
+ * @return
+ */
+ public static JalviewFileChooser forRead(String directory,
+ String selected)
+ {
+ return JalviewFileChooser.forRead(directory, selected, false);
+ }
- private static final int COLUMN_FILENAME = 0;
- private static final int COLUMN_FILESIZE = 1;
- private static final int COLUMN_FILETYPE = 2;
- private static final int COLUMN_FILEDATE = 3;
- private static final int COLUMN_FILEATTR = 4;
- private static final int COLUMN_COLCOUNT = 5;
- private static String[] COLUMNS = null;
+ public static JalviewFileChooser forRead(String directory,
+ String selected, boolean allowBackupFiles)
+ {
+ List<String> extensions = new ArrayList<>();
+ List<String> 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,
+ allowBackupFiles);
+ }
+
+ /**
+ * 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<String> extensions = new ArrayList<>();
+ List<String> 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(dir);
- if (COLUMNS == null)
+ 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)
+ {
+ this(dir, extensions, descs, selected, allFiles, false);
+ }
+
+ public JalviewFileChooser(String dir, String[] extensions, String[] descs,
+ String selected, boolean allFiles, boolean allowBackupFiles)
+ {
+ super(safePath(dir));
+ if (extensions.length == descs.length)
+ {
+ List<String[]> formats = new ArrayList<>();
+ for (int i = 0; i < extensions.length; i++)
+ {
+ formats.add(new String[] { extensions[i], descs[i] });
+ }
+ init(formats, selected, allFiles, allowBackupFiles);
+ }
+ 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<String[]> formats, String selected, boolean allFiles)
+ {
+ init(formats, selected, allFiles, false);
+ }
+
+ void init(List<String[]> 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(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]))
+ {
+ chosen = jvf;
+ }
+ }
+
+ if (chosen != null)
+ {
+ setFileFilter(chosen);
+ }
+
+ 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
+ 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)
{
- Locale l = getLocale();
- COLUMNS = new String[]{
- UIManager.getString("FileChooser.fileNameHeaderText",l),
- UIManager.getString("FileChooser.fileSizeHeaderText",l),
- UIManager.getString("FileChooser.fileTypeHeaderText",l),
- UIManager.getString("FileChooser.fileDateHeaderText",l),
- UIManager.getString("FileChooser.fileAttrHeaderText",l)
- };
+ 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;
}
- public JalviewFileChooser()
+ File ourselectedFile = null;
+
+ @Override
+ public File getSelectedFile()
{
- if (COLUMNS == null)
+ File selfile = super.getSelectedFile();
+ if (selfile == null && ourselectedFile != null)
{
- Locale l = getLocale();
- COLUMNS = new String[]{
- UIManager.getString("FileChooser.fileNameHeaderText",l),
- UIManager.getString("FileChooser.fileSizeHeaderText",l),
- UIManager.getString("FileChooser.fileTypeHeaderText",l),
- UIManager.getString("FileChooser.fileDateHeaderText",l),
- UIManager.getString("FileChooser.fileAttrHeaderText",l)
- };
+ return ourselectedFile;
}
+ return selfile;
}
+ @Override
+ public int showSaveDialog(Component parent) throws HeadlessException
+ {
+ this.setAccessory(null);
+ this.setSelectedFile(null);
+ return super.showSaveDialog(parent);
+ }
- /**************************************************************************
- * Always create the local UI
- * @param comp
- *************************************************************************/
- public final void setUI(ComponentUI comp)
+ /**
+ * 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()
{
- super.setUI(new UI(this));
+ if (getDialogType() != SAVE_DIALOG)
+ {
+ super.approveSelection();
+ return;
+ }
+
+ 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(ourselectedFile))
+ {
+ String withExtension = getSelectedFile().getName() + "."
+ + jvf.getAcceptableExtension();
+ ourselectedFile = (new File(getCurrentDirectory(), withExtension));
+ setSelectedFile(ourselectedFile);
+ }
+ }
+
+ if (ourselectedFile.exists())
+ {
+ int confirm = JvOptionPane.showConfirmDialog(this,
+ MessageManager.getString("label.overwrite_existing_file"),
+ MessageManager.getString("label.file_already_exists"),
+ JvOptionPane.YES_NO_OPTION);
+
+ if (confirm != JvOptionPane.YES_OPTION)
+ {
+ return;
+ }
+ }
+
+ super.approveSelection();
}
- /**************************************************************************
- * Internal implementation of Metal LookAndFeel to create the table sorting
- * ability.
- *************************************************************************/
- private final static class UI extends MetalFileChooserUI
- {
- private DirectoryModel model;
-
- /**************************************************************************
- * Must be overridden to extend
- * @param e
- *************************************************************************/
- public UI(JFileChooser e)
- {
- super(e);
- }
-
- /**************************************************************************
- * 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)
- {
- //Fix the columns so they can't be rearranged, if we don't do this
- //we would need to keep track when each column is moved
- tbl.getTableHeader().setReorderingAllowed(false);
-
- //Add a mouselistener to listen for clicks on column headers
- tbl.getTableHeader().addMouseListener(new MouseAdapter(){
- public void mouseClicked(MouseEvent e)
- {
- //Only process single clicks
- if (e.getClickCount() > 1) return;
- e.consume();
- final int col = tbl.getTableHeader().columnAtPoint(e.getPoint());
- if (col == COLUMN_FILENAME || col == COLUMN_FILESIZE ||
- col == COLUMN_FILEDATE)
- model.sort(col,tbl);
- }
- });
- }
- return panel;
- }
-
- /**************************************************************************
- * Finds the JTable in the panel so we can add MouseListener
- * @param comp
- * @return
- *************************************************************************/
- private final static 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 static class DirectoryModel extends BasicDirectoryModel
- {
- int col = 0;
- boolean ascending;
-
- /**************************************************************************
- * Must be overridden to extend BasicDirectoryModel
- * @param chooser
- *************************************************************************/
- DirectoryModel(JFileChooser chooser)
- {
- super(chooser);
- }
-
-
- /**************************************************************************
- * Supposedly this is not used anymore, hopefully not. We implemented
- * some basic attempt at sorting just in case
- * @param a
- * @param b
- * @return
- *************************************************************************/
- protected final boolean lt(File a, File b)
- {
- System.out.println("LT called?");
- boolean less = false;
- switch (col)
- {
- case COLUMN_FILEDATE:
- less = a.lastModified() > b.lastModified();
- break;
- case COLUMN_FILESIZE:
- less = a.length() > b.length();
- break;
- default:
- less = a.getName().compareToIgnoreCase(b.getName()) > 0;
- break;
- }
- if (ascending) return less = !less;
- return less;
- }
-
- /**************************************************************************
- * 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();
-
- for (int i=0;i<JalviewFileChooser.COLUMN_COLCOUNT;i++)
- {
- final TableColumn tc = tcm.getColumn( i ); // the column to change
- tc.setHeaderValue( COLUMNS[i] );
- }
-
- final TableColumn tc = tcm.getColumn( col ); // the column to change
- tc.setHeaderValue( COLUMNS[col] + indicator );
-
- th.repaint();
-
- //Requery the file listing
- validateFileCache();
- }
-
- /**************************************************************************
- * Sorts the data based on current column setting
- * @param data
- *************************************************************************/
- protected final void sort(Vector data)
- {
- switch (col)
- {
- case COLUMN_FILEDATE:
- 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.lastModified() > b.lastModified())
- ret = -1;
- else if (a.lastModified() == b.lastModified())
- ret = 0;
-
- if (ascending)
- ret *= -1;
- return ret;
- }
-
- });
- break;
- case COLUMN_FILESIZE:
- 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;
- }
-
- });
- break;
- case COLUMN_FILENAME:
- Collections.sort(data,new Comparator(){
- public int compare(Object o1,Object o2)
- {
- final File a = (File)o1;
- final File b = (File)o2;
- if (ascending)
- return a.getName().compareToIgnoreCase(b.getName());
- else
- return -1 * a.getName().compareToIgnoreCase(b.getName());
- }
-
- });
- break;
- }
- }
+ 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);
+ }
}
-}
+ /**
+ * 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 <code>RECENT_FILE</code> in
+ * <code>.jalview_properties</code>. 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<String> list;
+
+ RecentlyOpened()
+ {
+ String historyItems = Cache.getProperty("RECENT_FILE");
+ StringTokenizer st;
+ Vector<String> recent = new Vector<>();
+
+ if (historyItems != null)
+ {
+ st = new StringTokenizer(historyItems, "\t");
+ while (st.hasMoreTokens())
+ {
+ recent.addElement(st.nextToken());
+ }
+ }
+
+ 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 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 (Platform.isAMac())
+ {
+ scroller.setPreferredSize(new Dimension(500, 100));
+ }
+ else
+ {
+ scroller.setPreferredSize(new Dimension(130, 200));
+ }
+
+ this.add(scroller);
+
+ SwingUtilities.invokeLater(new Runnable()
+ {
+ @Override
+ public void run()
+ {
+ scroller.getHorizontalScrollBar()
+ .setValue(scroller.getHorizontalScrollBar().getMaximum());
+ }
+ });
+ }
+ }
+}
git://source.jalview.org / jalview.git / blobdiff