/*
* 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 .
* The Jalview Authors are detailed in the 'AUTHORS' file.
*/
package jalview.gui;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseEvent;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import javax.help.HelpSetException;
import javax.swing.JComboBox;
import javax.swing.JFileChooser;
import javax.swing.JInternalFrame;
import javax.swing.JPanel;
import javax.swing.ListSelectionModel;
import javax.swing.RowFilter;
import javax.swing.RowSorter;
import javax.swing.SortOrder;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import javax.swing.table.TableCellRenderer;
import javax.swing.table.TableColumn;
import javax.swing.table.TableModel;
import javax.swing.table.TableRowSorter;
import ext.edu.ucsf.rbvi.strucviz2.StructureManager;
import jalview.analysis.AnnotationSorter.SequenceAnnotationOrder;
import jalview.bin.Cache;
import jalview.ext.pymol.PymolManager;
import jalview.gui.Help.HelpId;
import jalview.gui.StructureViewer.ViewerType;
import jalview.io.BackupFiles;
import jalview.io.BackupFilesPresetEntry;
import jalview.io.FileFormatI;
import jalview.io.JalviewFileChooser;
import jalview.io.JalviewFileView;
import jalview.jbgui.GPreferences;
import jalview.jbgui.GSequenceLink;
import jalview.schemes.ColourSchemeI;
import jalview.schemes.ColourSchemes;
import jalview.schemes.ResidueColourScheme;
import jalview.urls.UrlLinkTableModel;
import jalview.urls.api.UrlProviderFactoryI;
import jalview.urls.api.UrlProviderI;
import jalview.urls.desktop.DesktopUrlProviderFactory;
import jalview.util.MessageManager;
import jalview.util.Platform;
import jalview.util.UrlConstants;
import jalview.ws.sifts.SiftsSettings;
/**
* DOCUMENT ME!
*
* @author $author$
* @version $Revision$
*/
/*
* for merge with Jalview-JS
public class Preferences extends GPreferences implements ApplicationSingletonI
*/
public class Preferences extends GPreferences
{
public static final String ENABLE_SPLIT_FRAME = "ENABLE_SPLIT_FRAME";
public static final String SCALE_PROTEIN_TO_CDNA = "SCALE_PROTEIN_TO_CDNA";
public static final String DEFAULT_COLOUR = "DEFAULT_COLOUR";
public static final String DEFAULT_COLOUR_PROT = "DEFAULT_COLOUR_PROT";
public static final String DEFAULT_COLOUR_NUC = "DEFAULT_COLOUR_NUC";
public static final String ADD_TEMPFACT_ANN = "ADD_TEMPFACT_ANN";
public static final String ADD_SS_ANN = "ADD_SS_ANN";
public static final String USE_RNAVIEW = "USE_RNAVIEW";
public static final String STRUCT_FROM_PDB = "STRUCT_FROM_PDB";
public static final String STRUCTURE_DISPLAY = "STRUCTURE_DISPLAY";
public static final String CHIMERA_PATH = "CHIMERA_PATH";
public static final String CHIMERAX_PATH = "CHIMERAX_PATH";
public static final String PYMOL_PATH = "PYMOL_PATH";
public static final String SORT_ANNOTATIONS = "SORT_ANNOTATIONS";
public static final String SHOW_AUTOCALC_ABOVE = "SHOW_AUTOCALC_ABOVE";
public static final String SHOW_OCCUPANCY = "SHOW_OCCUPANCY";
public static final String SHOW_OV_HIDDEN_AT_START = "SHOW_OV_HIDDEN_AT_START";
public static final String USE_LEGACY_GAP = "USE_LEGACY_GAP";
public static final String GAP_COLOUR = "GAP_COLOUR";
public static final String HIDDEN_COLOUR = "HIDDEN_COLOUR";
private static final int MIN_FONT_SIZE = 1;
private static final int MAX_FONT_SIZE = 30;
private String previousProxyType;
private static Preferences INSTANCE = null; // add "final"
/**
* Holds name and link separated with | character. Sequence ID must be
* $SEQUENCE_ID$ or $SEQUENCE_ID=/.possible | chars ./=$
*/
public static UrlProviderI sequenceUrlLinks;
public static UrlLinkTableModel dataModel;
/**
* Holds name and link separated with | character. Sequence IDS and Sequences
* must be $SEQUENCEIDS$ or $SEQUENCEIDS=/.possible | chars ./=$ and
* $SEQUENCES$ or $SEQUENCES=/.possible | chars ./=$ and separation character
* for first and second token specified after a pipe character at end |,|.
* (TODO: proper escape for using | to separate ids or sequences
*/
public static List groupURLLinks;
static
{
// get links selected to be in the menu (SEQUENCE_LINKS)
// and links entered by the user but not selected (STORED_LINKS)
String inMenuString = Cache.getDefault("SEQUENCE_LINKS", "");
String notInMenuString = Cache.getDefault("STORED_LINKS", "");
String defaultUrl = Cache.getDefault("DEFAULT_URL",
UrlConstants.DEFAULT_LABEL);
// if both links lists are empty, add the DEFAULT_URL link
// otherwise we assume the default link is in one of the lists
if (inMenuString.isEmpty() && notInMenuString.isEmpty())
{
inMenuString = UrlConstants.DEFAULT_STRING;
}
UrlProviderFactoryI factory = new DesktopUrlProviderFactory(defaultUrl,
inMenuString, notInMenuString);
sequenceUrlLinks = factory.createUrlProvider();
dataModel = new UrlLinkTableModel(sequenceUrlLinks);
/**
* TODO: reformulate groupURL encoding so two or more can be stored in the
* .properties file as '|' separated strings
*/
groupURLLinks = new ArrayList<>();
}
JInternalFrame frame;
private WsPreferences wsPrefs;
private OptionsParam promptEachTimeOpt = new OptionsParam(
MessageManager.getString("label.prompt_each_time"),
"Prompt each time");
private OptionsParam lineArtOpt = new OptionsParam(
MessageManager.getString("label.lineart"), "Lineart");
private OptionsParam textOpt = new OptionsParam(
MessageManager.getString("action.text"), "Text");
// get singleton Preferences instance
public static Preferences getInstance()
{
if (INSTANCE == null || INSTANCE.frame == null
|| INSTANCE.frame.isClosed())
{
INSTANCE = new Preferences();
}
return INSTANCE;
/*
* Replace code with the following for Jalvew-JS
Preferences INSTANCE = ApplicationSingletonProvider.getInstance(Preferences.class);
if (INSTANCE == null || INSTANCE.frame == null
|| INSTANCE.frame.isClosed())
{
ApplicationSingletonProvider.remove(Preferences.class);
INSTANCE = ApplicationSingletonProvider.getInstance(Preferences.class);
}
return INSTANCE;
*/
}
public static void openPreferences()
{
openPreferences(0, null);
}
public static void openPreferences(int selectTab, String message)
{
Preferences p = getInstance();
p.selectTab(selectTab);
p.setMessage(message);
p.frame.show();
p.frame.moveToFront();
p.frame.grabFocus();
}
/**
* Creates a new Preferences object.
*/
private Preferences()
{
super();
frame = new JInternalFrame();
frame.setContentPane(this);
if (!Platform.isJS())
/**
* Java only
*
* @j2sIgnore
*/
{
wsPrefs = new WsPreferences();
wsTab.add(wsPrefs, BorderLayout.CENTER);
}
int width = 500, height = 450;
if (Platform.isAMacAndNotJS())
{
width = 570;
height = 480;
}
Desktop.addInternalFrame(frame,
MessageManager.getString("label.preferences"), width, height);
frame.setMinimumSize(new Dimension(width, height));
/*
* Set Visual tab defaults
*/
seqLimit.setSelected(Cache.getDefault("SHOW_JVSUFFIX", true));
rightAlign.setSelected(Cache.getDefault("RIGHT_ALIGN_IDS", false));
fullScreen.setSelected(Cache.getDefault("SHOW_FULLSCREEN", false));
annotations.setSelected(Cache.getDefault("SHOW_ANNOTATIONS", true));
conservation.setSelected(Cache.getDefault("SHOW_CONSERVATION", true));
quality.setSelected(Cache.getDefault("SHOW_QUALITY", true));
identity.setSelected(Cache.getDefault("SHOW_IDENTITY", true));
openoverv.setSelected(Cache.getDefault("SHOW_OVERVIEW", false));
showUnconserved
.setSelected(Cache.getDefault("SHOW_UNCONSERVED", false));
showOccupancy.setSelected(Cache.getDefault(SHOW_OCCUPANCY, false));
showGroupConsensus
.setSelected(Cache.getDefault("SHOW_GROUP_CONSENSUS", false));
showGroupConservation.setSelected(
Cache.getDefault("SHOW_GROUP_CONSERVATION", false));
showConsensHistogram.setSelected(
Cache.getDefault("SHOW_CONSENSUS_HISTOGRAM", true));
showConsensLogo
.setSelected(Cache.getDefault("SHOW_CONSENSUS_LOGO", false));
showNpTooltip
.setSelected(Cache.getDefault("SHOW_NPFEATS_TOOLTIP", true));
showDbRefTooltip
.setSelected(Cache.getDefault("SHOW_DBREFS_TOOLTIP", true));
String[] fonts = java.awt.GraphicsEnvironment
.getLocalGraphicsEnvironment().getAvailableFontFamilyNames();
for (int i = 0; i < fonts.length; i++)
{
fontNameCB.addItem(fonts[i]);
}
for (int i = MIN_FONT_SIZE; i <= MAX_FONT_SIZE; i++)
{
fontSizeCB.addItem(i + "");
}
fontStyleCB.addItem("plain");
fontStyleCB.addItem("bold");
fontStyleCB.addItem("italic");
fontNameCB.setSelectedItem(Cache.getDefault("FONT_NAME", "SansSerif"));
fontSizeCB.setSelectedItem(Cache.getDefault("FONT_SIZE", "10"));
fontStyleCB.setSelectedItem(
Cache.getDefault("FONT_STYLE", Font.PLAIN + ""));
smoothFont.setSelected(Cache.getDefault("ANTI_ALIAS", true));
scaleProteinToCdna
.setSelected(Cache.getDefault(SCALE_PROTEIN_TO_CDNA, false));
idItalics.setSelected(Cache.getDefault("ID_ITALICS", true));
wrap.setSelected(Cache.getDefault("WRAP_ALIGNMENT", false));
gapSymbolCB.addItem("-");
gapSymbolCB.addItem(".");
gapSymbolCB.setSelectedItem(Cache.getDefault("GAP_SYMBOL", "-"));
sortby.addItem("No sort");
sortby.addItem("Id");
sortby.addItem("Pairwise Identity");
sortby.setSelectedItem(Cache.getDefault("SORT_ALIGNMENT", "No sort"));
sortAnnBy.addItem(SequenceAnnotationOrder.NONE.toString());
sortAnnBy
.addItem(SequenceAnnotationOrder.SEQUENCE_AND_LABEL.toString());
sortAnnBy
.addItem(SequenceAnnotationOrder.LABEL_AND_SEQUENCE.toString());
SequenceAnnotationOrder savedSort = SequenceAnnotationOrder
.valueOf(Cache.getDefault(SORT_ANNOTATIONS,
SequenceAnnotationOrder.NONE.name()));
sortAnnBy.setSelectedItem(savedSort.toString());
sortAutocalc.addItem("Autocalculated first");
sortAutocalc.addItem("Autocalculated last");
final boolean showAbove = Cache.getDefault(SHOW_AUTOCALC_ABOVE, true);
sortAutocalc.setSelectedItem(showAbove ? sortAutocalc.getItemAt(0)
: sortAutocalc.getItemAt(1));
startupCheckbox
.setSelected(Cache.getDefault("SHOW_STARTUP_FILE", true));
startupFileTextfield.setText(Cache.getDefault("STARTUP_FILE",
Cache.getDefault("www.jalview.org", "http://www.jalview.org")
+ "/examples/exampleFile_2_3.jar"));
/*
* Set Colours tab defaults
*/
protColour.addItem(ResidueColourScheme.NONE);
nucColour.addItem(ResidueColourScheme.NONE);
for (ColourSchemeI cs : ColourSchemes.getInstance().getColourSchemes())
{
String name = cs.getSchemeName();
protColour.addItem(name);
nucColour.addItem(name);
}
String oldProp = Cache.getDefault(DEFAULT_COLOUR,
ResidueColourScheme.NONE);
String newProp = Cache.getDefault(DEFAULT_COLOUR_PROT, null);
protColour.setSelectedItem(newProp != null ? newProp : oldProp);
newProp = Cache.getDefault(DEFAULT_COLOUR_NUC, null);
nucColour.setSelectedItem(newProp != null ? newProp : oldProp);
minColour.setBackground(
Cache.getDefaultColour("ANNOTATIONCOLOUR_MIN", Color.orange));
maxColour.setBackground(
Cache.getDefaultColour("ANNOTATIONCOLOUR_MAX", Color.red));
/*
* Set overview panel defaults
*/
gapColour.setBackground(Cache.getDefaultColour(GAP_COLOUR,
jalview.renderer.OverviewResColourFinder.OVERVIEW_DEFAULT_GAP));
hiddenColour.setBackground(Cache.getDefaultColour(HIDDEN_COLOUR,
jalview.renderer.OverviewResColourFinder.OVERVIEW_DEFAULT_HIDDEN));
useLegacyGap.setSelected(Cache.getDefault(USE_LEGACY_GAP, false));
gapLabel.setEnabled(!useLegacyGap.isSelected());
gapColour.setEnabled(!useLegacyGap.isSelected());
showHiddenAtStart
.setSelected(Cache.getDefault(SHOW_OV_HIDDEN_AT_START, false));
/*
* Set Structure tab defaults
*/
final boolean structSelected = Cache.getDefault(STRUCT_FROM_PDB, false);
structFromPdb.setSelected(structSelected);
useRnaView.setSelected(Cache.getDefault(USE_RNAVIEW, false));
useRnaView.setEnabled(structSelected);
addSecondaryStructure.setSelected(Cache.getDefault(ADD_SS_ANN, false));
addSecondaryStructure.setEnabled(structSelected);
addTempFactor.setSelected(Cache.getDefault(ADD_TEMPFACT_ANN, false));
addTempFactor.setEnabled(structSelected);
/*
* set choice of structure viewer, and path if saved as a preference;
* default to Jmol (first choice) if an unexpected value is found
*/
String viewerType = Cache.getDefault(STRUCTURE_DISPLAY,
ViewerType.JMOL.name());
structViewer.setSelectedItem(viewerType);
String viewerPath = "";
ViewerType type = null;
try
{
type = ViewerType.valueOf(viewerType);
switch (type)
{
case JMOL:
break;
case CHIMERA:
viewerPath = Cache.getDefault(CHIMERA_PATH, "");
break;
case CHIMERAX:
viewerPath = Cache.getDefault(CHIMERAX_PATH, "");
break;
case PYMOL:
viewerPath = Cache.getDefault(PYMOL_PATH, "");
break;
}
} catch (IllegalArgumentException e)
{
Cache.log.error("Unknown structure viewer type: " + viewerType
+ ", defaulting to Jmol");
type = ViewerType.JMOL;
}
structureViewerPath.setText(viewerPath);
structureViewerPath.addActionListener(new ActionListener()
{
@Override
public void actionPerformed(ActionEvent e)
{
if (validateViewerPath())
{
Cache.setProperty(
structViewer.getSelectedItem().equals(
ViewerType.CHIMERAX.name()) ? CHIMERAX_PATH
: CHIMERA_PATH,
structureViewerPath.getText());
}
}
});
if (Cache.getDefault("MAP_WITH_SIFTS", false))
{
siftsMapping.setSelected(true);
}
else
{
nwMapping.setSelected(true);
}
SiftsSettings
.setMapWithSifts(Cache.getDefault("MAP_WITH_SIFTS", false));
/*
* Set Connections tab defaults
*/
// set up sorting
linkUrlTable.setModel(dataModel);
final TableRowSorter sorter = new TableRowSorter<>(
linkUrlTable.getModel());
linkUrlTable.setRowSorter(sorter);
List sortKeys = new ArrayList<>();
UrlLinkTableModel m = (UrlLinkTableModel) linkUrlTable.getModel();
sortKeys.add(new RowSorter.SortKey(m.getPrimaryColumn(),
SortOrder.DESCENDING));
sortKeys.add(new RowSorter.SortKey(m.getSelectedColumn(),
SortOrder.DESCENDING));
sortKeys.add(
new RowSorter.SortKey(m.getNameColumn(), SortOrder.ASCENDING));
sorter.setSortKeys(sortKeys);
// BH 2018 setSortKeys will do the sort
// sorter.sort();
// set up filtering
ActionListener onReset;
onReset = new ActionListener()
{
@Override
public void actionPerformed(ActionEvent e)
{
filterTB.setText("");
sorter.setRowFilter(RowFilter.regexFilter(""));
}
};
doReset.addActionListener(onReset);
// filter to display only custom urls
final RowFilter customUrlFilter = new RowFilter()
{
@Override
public boolean include(
Entry extends TableModel, ? extends Object> entry)
{
return ((UrlLinkTableModel) entry.getModel()).isUserEntry(entry);
}
};
final TableRowSorter customSorter = new TableRowSorter<>(
linkUrlTable.getModel());
customSorter.setRowFilter(customUrlFilter);
ActionListener onCustomOnly;
onCustomOnly = new ActionListener()
{
@Override
public void actionPerformed(ActionEvent e)
{
filterTB.setText("");
sorter.setRowFilter(customUrlFilter);
}
};
userOnly.addActionListener(onCustomOnly);
filterTB.getDocument().addDocumentListener(new DocumentListener()
{
String caseInsensitiveFlag = "(?i)";
@Override
public void changedUpdate(DocumentEvent e)
{
sorter.setRowFilter(RowFilter
.regexFilter(caseInsensitiveFlag + filterTB.getText()));
}
@Override
public void removeUpdate(DocumentEvent e)
{
sorter.setRowFilter(RowFilter
.regexFilter(caseInsensitiveFlag + filterTB.getText()));
}
@Override
public void insertUpdate(DocumentEvent e)
{
sorter.setRowFilter(RowFilter
.regexFilter(caseInsensitiveFlag + filterTB.getText()));
}
});
// set up list selection functionality
linkUrlTable.getSelectionModel()
.addListSelectionListener(new UrlListSelectionHandler());
// set up radio buttons
int onClickCol = ((UrlLinkTableModel) linkUrlTable.getModel())
.getPrimaryColumn();
String onClickName = linkUrlTable.getColumnName(onClickCol);
linkUrlTable.getColumn(onClickName)
.setCellRenderer(new RadioButtonRenderer());
linkUrlTable.getColumn(onClickName)
.setCellEditor(new RadioButtonEditor());
// get boolean columns and resize those to min possible
for (int column = 0; column < linkUrlTable.getColumnCount(); column++)
{
if (linkUrlTable.getModel().getColumnClass(column)
.equals(Boolean.class))
{
TableColumn tableColumn = linkUrlTable.getColumnModel()
.getColumn(column);
int preferredWidth = tableColumn.getMinWidth();
TableCellRenderer cellRenderer = linkUrlTable.getCellRenderer(0,
column);
Component c = linkUrlTable.prepareRenderer(cellRenderer, 0, column);
int cwidth = c.getPreferredSize().width
+ linkUrlTable.getIntercellSpacing().width;
preferredWidth = Math.max(preferredWidth, cwidth);
tableColumn.setPreferredWidth(preferredWidth);
}
}
String proxyTypeString = Cache.getDefault("USE_PROXY", "false");
previousProxyType = proxyTypeString;
switch (proxyTypeString)
{
case Cache.PROXYTYPE_NONE:
proxyType.setSelected(noProxy.getModel(), true);
break;
case Cache.PROXYTYPE_SYSTEM:
proxyType.setSelected(systemProxy.getModel(), true);
break;
case Cache.PROXYTYPE_CUSTOM:
proxyType.setSelected(customProxy.getModel(), true);
break;
default:
Cache.log.warn(
"Incorrect PROXY_TYPE - should be 'none' (clear proxy properties), 'false' (system settings), 'true' (custom settings): "
+ proxyTypeString);
}
proxyServerHttpTB.setText(Cache.getDefault("PROXY_SERVER", ""));
proxyPortHttpTB.setText(Cache.getDefault("PROXY_PORT", ""));
proxyServerHttpsTB.setText(Cache.getDefault("PROXY_SERVER_HTTPS", ""));
proxyPortHttpsTB.setText(Cache.getDefault("PROXY_PORT_HTTPS", ""));
proxyAuth.setSelected(Cache.getDefault("PROXY_AUTH", false));
proxyAuthUsernameTB
.setText(Cache.getDefault("PROXY_AUTH_USERNAME", ""));
// we are not storing or retrieving proxy password from .jalview_properties
proxyAuthPasswordPB.setText(Cache.proxyAuthPassword == null ? ""
: new String(Cache.proxyAuthPassword));
setCustomProxyEnabled();
applyProxyButtonEnabled(false);
defaultBrowser.setText(Cache.getDefault("DEFAULT_BROWSER", ""));
usagestats.setSelected(Cache.getDefault("USAGESTATS", false));
// note antisense here: default is true
questionnaire
.setSelected(Cache.getProperty("NOQUESTIONNAIRES") == null);
versioncheck.setSelected(Cache.getDefault("VERSION_CHECK", true));
/*
* Set Output tab defaults
*/
setupOutputCombo(epsRendering, "EPS_RENDERING");
setupOutputCombo(htmlRendering, "HTML_RENDERING");
setupOutputCombo(svgRendering, "SVG_RENDERING");
autoIdWidth.setSelected(Cache.getDefault("FIGURE_AUTOIDWIDTH", false));
userIdWidth.setEnabled(!autoIdWidth.isSelected());
userIdWidthlabel.setEnabled(!autoIdWidth.isSelected());
Integer wi = Cache.getIntegerProperty("FIGURE_FIXEDIDWIDTH");
userIdWidth.setText(wi == null ? "" : wi.toString());
// TODO: refactor to use common enum via FormatAdapter and allow extension
// for new flat file formats
blcjv.setSelected(Cache.getDefault("BLC_JVSUFFIX", true));
clustaljv.setSelected(Cache.getDefault("CLUSTAL_JVSUFFIX", true));
fastajv.setSelected(Cache.getDefault("FASTA_JVSUFFIX", true));
msfjv.setSelected(Cache.getDefault("MSF_JVSUFFIX", true));
pfamjv.setSelected(Cache.getDefault("PFAM_JVSUFFIX", true));
pileupjv.setSelected(Cache.getDefault("PILEUP_JVSUFFIX", true));
pirjv.setSelected(Cache.getDefault("PIR_JVSUFFIX", true));
modellerOutput.setSelected(Cache.getDefault("PIR_MODELLER", false));
embbedBioJSON
.setSelected(Cache.getDefault("EXPORT_EMBBED_BIOJSON", true));
/*
* Set Editing tab defaults
*/
autoCalculateConsCheck
.setSelected(Cache.getDefault("AUTO_CALC_CONSENSUS", true));
padGaps.setSelected(Cache.getDefault("PAD_GAPS", false));
sortByTree.setSelected(Cache.getDefault("SORT_BY_TREE", false));
annotations_actionPerformed(null); // update the display of the annotation
// settings
/*
* Set Backups tab defaults
*/
loadLastSavedBackupsOptions();
}
/**
* A helper method that sets the items and initial selection in a character
* rendering option list (Prompt each time/Lineart/Text)
*
* @param comboBox
* @param propertyKey
*/
protected void setupOutputCombo(JComboBox