/*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
- * This program is free software; you can redistribute it and/or
+ * 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 2
+ * as published by the Free Software Foundation, either version 3
* 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.
+ * 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 this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ * 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.io.*;
-import java.util.*;
+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.Collections;
+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.filechooser.FileView;
+import javax.swing.plaf.basic.BasicFileChooserUI;
-import java.awt.*;
-import java.awt.event.*;
-import javax.swing.*;
/**
* Enhanced file chooser dialog box.
- *
- * NOTE: bug on Windows systems when filechooser opened on directory to view files with colons in title.
- *
+ *
+ * NOTE: bug on Windows systems when filechooser opened on directory to view
+ * files with colons in title.
+ *
* @author AMW
*
*/
-public class JalviewFileChooser
- extends JFileChooser
+public class JalviewFileChooser extends JFileChooser
{
- public JalviewFileChooser(String dir)
+ /**
+ * Factory method to return a file chooser that offers readable alignment file
+ * formats
+ *
+ * @param directory
+ * @param selected
+ * @param selectAll
+ * @return
+ */
+ public static JalviewFileChooser forRead(String directory,
+ String selected, boolean selectAll)
{
- super(safePath(dir));
- setAccessory(new RecentlyOpened());
+ List<String> extensions = new ArrayList<String>();
+ List<String> descs = new ArrayList<String>();
+ for (FileFormatI format : FileFormat.values())
+ {
+ if (format.isReadable())
+ {
+ extensions.add(format.getExtensions());
+ descs.add(format.toString());
+ }
+ }
+ return new JalviewFileChooser(directory,
+ extensions.toArray(new String[extensions.size()]),
+ descs.toArray(new String[descs.size()]),
+ selected);
}
- private static File safePath(String dir)
+ /**
+ * Factory method to return a file chooser that offers writable alignment file
+ * formats
+ *
+ * @param directory
+ * @param selected
+ * @param selectAll
+ * @return
+ */
+ public static JalviewFileChooser forWrite(String directory,
+ String selected, boolean selectAll)
{
- if (dir==null)
- { return null;
- }
-
- File f = new File(dir);
- if (f.getName().indexOf(':')>-1)
+ // 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<String>();
+ List<String> descs = new ArrayList<String>();
+ for (FileFormatI format : FileFormat.values())
{
- return null;
+ if (format.isWritable())
+ {
+ extensions.add(format.getExtensions());
+ descs.add(format.toString());
+ }
}
- return f;
+ return new JalviewFileChooser(directory,
+ extensions.toArray(new String[extensions.size()]),
+ descs.toArray(new String[descs.size()]), selected);
+ }
+
+ public JalviewFileChooser(String dir)
+ {
+ super(safePath(dir));
+ setAccessory(new RecentlyOpened());
}
- public JalviewFileChooser(String dir,
- String[] suffix,
- String[] desc,
- String selected,
- boolean selectAll)
+ public JalviewFileChooser(String dir, String extension, String desc,
+ String selected)
{
super(safePath(dir));
- init(suffix, desc, selected, selectAll);
+ init(Collections.singletonList(new String[] { extension, desc }),
+ selected);
}
- public JalviewFileChooser(String dir,
- String[] suffix,
- String[] desc,
- String selected)
+ public JalviewFileChooser(String dir, String[] extensions, String[] descs,
+ String selected)
{
super(safePath(dir));
- init(suffix, desc, selected, true);
+ if (extensions.length == descs.length)
+ {
+ List<String[]> formats = new ArrayList<String[]>();
+ for (int i = 0; i < extensions.length; i++)
+ {
+ formats.add(new String[] { extensions[i], descs[i] });
+ }
+ init(formats, selected);
+ }
+ else
+ {
+ System.err.println("JalviewFileChooser arguments mismatch: "
+ + extensions + ", " + descs);
+ }
}
- void init(String[] suffix,
- String[] desc,
- String selected,
- boolean selectAll)
+ 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
+ */
+ void init(List<String[]> formats, String selected)
{
JalviewFileFilter chosen = null;
- //SelectAllFilter needs to be set first before adding further
- //file filters to fix bug on Mac OSX
- setAcceptAllFileFilterUsed(selectAll);
+ // SelectAllFilter needs to be set first before adding further
+ // file filters to fix bug on Mac OSX
+ setAcceptAllFileFilterUsed(true);
- 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;
}
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))
+ if ((name == null) || (name.length() == 0))
{
return;
}
EventQueue.invokeLater(new Thread()
{
+ @Override
public void run()
{
- String currentName = ui.getFileName();
- if ( (currentName == null) || (currentName.length() == 0))
+ String currentName = fcui.getFileName();
+ if ((currentName == null) || (currentName.length() == 0))
{
- ui.setFileName(name);
+ fcui.setFileName(name);
}
}
});
}
- }
- catch (Exception ex)
+ } catch (Exception ex)
{
ex.printStackTrace();
// Some platforms do not have BasicFileChooserUI
}
}
- 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"))
- {
- format = "FASTA";
- }
- else if (format.toUpperCase().startsWith("MSF"))
+ int parenPos = format.indexOf("(");
+ if (parenPos > 0)
{
- 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";
+ format = format.substring(0, parenPos).trim();
+ try
+ {
+ return FileFormat.valueOf(format);
+ } catch (IllegalArgumentException e)
+ {
+ System.err.println("Unexpected format: " + format);
+ }
}
-
- return format;
+ return null;
}
- public int showSaveDialog(Component parent)
- throws HeadlessException
+ @Override
+ public int showSaveDialog(Component parent) throws HeadlessException
{
this.setAccessory(null);
setDialogType(SAVE_DIALOG);
- int ret = showDialog(parent, "Save");
+ int ret = showDialog(parent, MessageManager.getString("action.save"));
if (getFileFilter() instanceof JalviewFileFilter)
{
if (!jvf.accept(getSelectedFile()))
{
- String withExtension = getSelectedFile() + "." +
- jvf.getAcceptableExtension();
+ String withExtension = getSelectedFile() + "."
+ + jvf.getAcceptableExtension();
setSelectedFile(new File(withExtension));
}
}
- // 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())
+ // 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())
{
- 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;
}
return ret;
}
- 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
+ class RecentlyOpened extends JPanel
{
JList list;
+
public RecentlyOpened()
{
+
String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
StringTokenizer st;
Vector recent = new Vector();
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 (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().getMaximum());
}
});