//////////////////////////////////////////////////////////////////
package jalview.io;
-import jalview.bin.Cache;
-import jalview.bin.Jalview;
-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.RunResponse;
-
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.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.DefaultListCellRenderer;
+import javax.swing.BoxLayout;
+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.
*
* @author AMW
*
*/
-public class JalviewFileChooser extends JFileChooser implements DialogRunnerI,
- PropertyChangeListener
+public class JalviewFileChooser extends JFileChooser
+ implements DialogRunnerI, PropertyChangeListener
{
private static final long serialVersionUID = 1L;
- private DialogRunnerI runner = new DialogRunner();
-
+ private Map<Object, Runnable> callbacks = new HashMap<>();
+
File selectedFile = null;
/**
- * On user selecting a file to save to, this response is run to check if the
- * file already exists, and if so show a dialog to prompt for confirmation of
- * overwrite.
+ * backupfilesCheckBox = "Include backup files" checkbox includeBackupfiles =
+ * flag set by checkbox
*/
- RunResponse overwriteCheck = new RunResponse(JalviewFileChooser.APPROVE_OPTION)
- {
- @Override
- public void run()
- {
- selectedFile = getSelectedFile();
-
- if (selectedFile == null)
- {
- // Workaround for Java 9,10 on OSX - no selected file, but there is a
- // filename typed in
- // TODO is this needed in Java 8 or 11?
- try
- {
- String filename = ((BasicFileChooserUI) getUI()).getFileName();
- if (filename != null && filename.length() > 0)
- {
- selectedFile = new File(getCurrentDirectory(), filename);
- }
- } catch (Throwable x)
- {
- System.err.println(
- "Unexpected exception when trying to get filename.");
- x.printStackTrace();
- }
- }
- if (selectedFile == null)
- {
- setReturnValue(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();
-
- if (!jvf.accept(getSelectedFile()))
- {
- String withExtension = getSelectedFile() + "."
- + jvf.getAcceptableExtension();
- setSelectedFile(new File(withExtension));
- }
- }
- // All good, so we continue to save
- setReturnValue(JalviewFileChooser.APPROVE_OPTION);
-
- // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
- // USER PROMPTED FOR A NEW FILENAME
- if (!Jalview.isJS())
- {
- if (getSelectedFile().exists())
- {
- // JAL-3048 - may not need to raise this for browser saves
- // yes/no cancel
- int confirm = JvOptionPane.showConfirmDialog(JalviewFileChooser.this,
- MessageManager.getString("label.overwrite_existing_file"),
- MessageManager.getString("label.file_already_exists"),
- JvOptionPane.YES_NO_OPTION);
-
- if (confirm != JvOptionPane.YES_OPTION)
- {
- setReturnValue(JalviewFileChooser.CANCEL_OPTION);
- }
- }
- }
- };
- };
+ private JCheckBox backupfilesCheckBox = null;
+
+ protected boolean includeBackupFiles = false;
/**
* Factory method to return a file chooser that offers readable alignment file
public static JalviewFileChooser forRead(String directory,
String selected)
{
+ return JalviewFileChooser.forRead(directory, selected, false);
+ }
+
+ 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())
descs.add(format.getName());
}
}
+
return new JalviewFileChooser(directory,
extensions.toArray(new String[extensions.size()]),
- descs.toArray(new String[descs.size()]), selected, true);
+ descs.toArray(new String[descs.size()]), selected, true,
+ allowBackupFiles);
}
/**
JalviewFileChooser(String dir, String[] extensions, String[] descs,
String selected, boolean acceptAny)
{
+ this(dir, extensions, descs, selected, acceptAny, false);
+ }
+
+ public JalviewFileChooser(String dir, String[] extensions, String[] descs,
+ String selected, boolean acceptAny, boolean allowBackupFiles)
+ {
super(safePath(dir));
if (extensions.length == descs.length)
{
{
formats.add(new String[] { extensions[i], descs[i] });
}
- init(formats, selected, acceptAny);
+ init(formats, selected, acceptAny, allowBackupFiles);
}
else
{
}
/**
- * Overridden for JalviewJS compatibility: only one thread in Javascript,
- * so we can't wait for user choice in another thread and then perform the
+ * 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)
{
- // runner.resetResponses();
int value = super.showOpenDialog(this);
- if (!Jalview.isJS())
+
+ if (!Platform.isJS())
+ /**
+ * Java only
+ *
+ * @j2sIgnore
+ */
{
- runner.handleResponse(value);
+ /*
+ * code here is not run in JalviewJS, instead
+ * propertyChange() is called for dialog action
+ */
+ handleResponse(value);
}
return value;
}
*/
void init(List<String[]> formats, String selected, boolean acceptAny)
{
+ init(formats, selected, acceptAny, false);
+ }
+
+ void init(List<String[]> formats, String selected, boolean acceptAny,
+ boolean allowBackupFiles)
+ {
JalviewFileFilter chosen = null;
// file filters to fix bug on Mac OSX
setAcceptAllFileFilterUsed(acceptAny);
+ // add a "All known alignment files" option
+ List<String> 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);
+
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]))
{
setFileFilter(chosen);
}
- setAccessory(new RecentlyOpened());
+ 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
return f == null ? selectedFile : f;
}
- /**
- * 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);
+ // Java 9,10,11 on OSX - clear selected file so name isn't auto populated
this.setSelectedFile(null);
+
return super.showSaveDialog(parent);
}
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)
{
return;
}
}
- /**
- * 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;
RecentlyOpened()
{
+ setPreferredSize(new Dimension(300, 100));
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.setCellRenderer(new recentlyOpenedCellRenderer());
list.addMouseListener(new MouseAdapter()
{
}
});
- 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);
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()
.setValue(scroller.getHorizontalScrollBar().getMaximum());
}
});
+
}
+
+ }
+
+ class recentlyOpenedCellRenderer extends JLabel
+ implements ListCellRenderer<String>
+ {
+ private final static int maxChars = 46;
+
+ private final static String ellipsis = "...";
+
+ @Override
+ public Component getListCellRendererComponent(
+ JList<? extends String> 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<Void>()
+ {
+ @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 DialogRunnerI addResponse(RunResponse action)
+ public void handleResponse(Object response)
{
- return runner.addResponse(action);
+ /*
+ * 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.
+ * 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
*/
// TODO other properties need runners...
switch (evt.getPropertyName())
{
- case "SelectedFile":
- runner.handleResponse(APPROVE_OPTION);
+ /*
+ * 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;
+ }
+
}
git://source.jalview.org / jalview.git / blobdiff