*/
package jalview.gui;
-import java.awt.Container;
-import java.awt.Dimension;
-import java.awt.Font;
-import java.awt.Rectangle;
-import java.util.ArrayList;
-import java.util.Hashtable;
-import java.util.Set;
-import java.util.Vector;
-
-import javax.swing.JInternalFrame;
-import javax.swing.JOptionPane;
-
import jalview.analysis.AlignmentUtils;
import jalview.analysis.AnnotationSorter.SequenceAnnotationOrder;
import jalview.analysis.NJTree;
import jalview.api.AlignViewportI;
+import jalview.api.AlignmentViewPanel;
+import jalview.api.FeatureColourI;
+import jalview.api.FeatureSettingsModelI;
+import jalview.api.FeaturesDisplayedI;
import jalview.api.ViewStyleI;
import jalview.bin.Cache;
import jalview.commands.CommandI;
import jalview.datamodel.AlignmentI;
import jalview.datamodel.ColumnSelection;
import jalview.datamodel.PDBEntry;
+import jalview.datamodel.SearchResults;
import jalview.datamodel.Sequence;
import jalview.datamodel.SequenceGroup;
import jalview.datamodel.SequenceI;
import jalview.viewmodel.AlignmentViewport;
import jalview.ws.params.AutoCalcSetting;
+import java.awt.Container;
+import java.awt.Dimension;
+import java.awt.Font;
+import java.awt.Rectangle;
+import java.util.ArrayList;
+import java.util.Hashtable;
+import java.util.List;
+import java.util.Vector;
+
+import javax.swing.JInternalFrame;
+import javax.swing.JOptionPane;
+
/**
* DOCUMENT ME!
*
* @version $Revision: 1.141 $
*/
public class AlignViewport extends AlignmentViewport implements
- SelectionSource, AlignViewportI, CommandListener
+ SelectionSource, CommandListener
{
- int startRes;
-
- int endRes;
-
- int startSeq;
-
- int endSeq;
-
Font font;
NJTree currentTree = null;
private boolean gatherViewsHere = false;
private AnnotationColumnChooser annotationColumnSelectionState;
+
/**
* Creates a new AlignViewport object.
*
init();
}
+ /**
+ * Apply any settings saved in user preferences
+ */
private void applyViewProperties()
{
antiAlias = Cache.getDefault("ANTI_ALIAS", false);
SequenceAnnotationOrder.NONE.name()));
showAutocalculatedAbove = Cache.getDefault(
Preferences.SHOW_AUTOCALC_ABOVE, false);
-
+ viewStyle.setScaleProteinAsCdna(Cache.getDefault(
+ Preferences.SCALE_PROTEIN_TO_CDNA, true));
}
void init()
return sq;
}
- /**
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
- */
- public int getStartRes()
- {
- return startRes;
- }
-
- /**
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
- */
- public int getEndRes()
- {
- return endRes;
- }
-
- /**
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
- */
- public int getStartSeq()
- {
- return startSeq;
- }
-
- /**
- * DOCUMENT ME!
- *
- * @param res
- * DOCUMENT ME!
- */
- public void setStartRes(int res)
- {
- this.startRes = res;
- }
-
- /**
- * DOCUMENT ME!
- *
- * @param seq
- * DOCUMENT ME!
- */
- public void setStartSeq(int seq)
- {
- this.startSeq = seq;
- }
-
- /**
- * DOCUMENT ME!
- *
- * @param res
- * DOCUMENT ME!
- */
- public void setEndRes(int res)
- {
- if (res > (alignment.getWidth() - 1))
- {
- // log.System.out.println(" Corrected res from " + res + " to maximum " +
- // (alignment.getWidth()-1));
- res = alignment.getWidth() - 1;
- }
-
- if (res < 0)
- {
- res = 0;
- }
-
- this.endRes = res;
- }
-
- /**
- * DOCUMENT ME!
- *
- * @param seq
- * DOCUMENT ME!
- */
- public void setEndSeq(int seq)
- {
- if (seq > alignment.getHeight())
- {
- seq = alignment.getHeight();
- }
-
- if (seq < 0)
- {
- seq = 0;
- }
-
- this.endSeq = seq;
- }
-
- /**
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
- */
- public int getEndSeq()
- {
- return endSeq;
- }
-
boolean validCharWidth;
/**
viewStyle.getFontSize()), false);
}
+
/**
* DOCUMENT ME!
*
*/
public void setAlignment(AlignmentI align)
{
- if (alignment != null && alignment.getCodonFrames() != null)
+ replaceMappings(align);
+ this.alignment = align;
+ }
+
+ /**
+ * Replace any codon mappings for this viewport with those for the given
+ * viewport
+ *
+ * @param align
+ */
+ public void replaceMappings(AlignmentI align)
+ {
+
+ /*
+ * Deregister current mappings (if any)
+ */
+ deregisterMappings();
+
+ /*
+ * Register new mappings (if any)
+ */
+ if (align != null)
{
- StructureSelectionManager.getStructureSelectionManager(
- Desktop.instance).removeMappings(alignment.getCodonFrames());
+ StructureSelectionManager ssm = StructureSelectionManager
+ .getStructureSelectionManager(Desktop.instance);
+ ssm.registerMappings(align.getCodonFrames());
}
- this.alignment = align;
- if (alignment != null && alignment.getCodonFrames() != null)
+
+ /*
+ * replace mappings on our alignment
+ */
+ if (alignment != null && align != null)
+ {
+ alignment.setCodonFrames(align.getCodonFrames());
+ }
+ }
+
+ protected void deregisterMappings()
+ {
+ AlignmentI al = getAlignment();
+ if (al != null)
{
- StructureSelectionManager.getStructureSelectionManager(
- Desktop.instance).addMappings(alignment.getCodonFrames());
+ List<AlignedCodonFrame> mappings = al.getCodonFrames();
+ if (mappings != null)
+ {
+ StructureSelectionManager ssm = StructureSelectionManager
+ .getStructureSelectionManager(Desktop.instance);
+ for (AlignedCodonFrame acf : mappings)
+ {
+ if (noReferencesTo(acf))
+ {
+ ssm.deregisterMapping(acf);
+ }
+ }
+ }
}
}
*
* @return DOCUMENT ME!
*/
+ @Override
public char getGapCharacter()
{
return getAlignment().getGapCharacter();
*
* @return DOCUMENT ME!
*/
+ @Override
public ColumnSelection getColumnSelection()
{
return colSel;
// TODO: JAL-1126
if (historyList == null || redoList == null)
{
- return new long[]
- { -1, -1 };
+ return new long[] { -1, -1 };
}
- return new long[]
- { historyList.hashCode(), this.redoList.hashCode() };
+ return new long[] { historyList.hashCode(), this.redoList.hashCode() };
}
/**
return false;
}
- /**
- * when set, view will scroll to show the highlighted position
- */
- public boolean followHighlight = true;
-
- /**
- * @return true if view should scroll to show the highlighted region of a
- * sequence
- * @return
- */
- public boolean getFollowHighlight()
- {
- return followHighlight;
- }
-
public boolean followSelection = true;
/**
/**
* Send the current selection to be broadcast to any selection listeners.
*/
+ @Override
public void sendSelection()
{
jalview.structure.StructureSelectionManager
/**
*
* @param pdbEntries
- * @return a series of SequenceI arrays, one for each PDBEntry, listing which
- * sequence in the alignment holds a reference to it
+ * @return an array of SequenceI arrays, one for each PDBEntry, listing which
+ * sequences in the alignment hold a reference to it
*/
public SequenceI[][] collateForPDB(PDBEntry[] pdbEntries)
{
- ArrayList<SequenceI[]> seqvectors = new ArrayList<SequenceI[]>();
+ List<SequenceI[]> seqvectors = new ArrayList<SequenceI[]>();
for (PDBEntry pdb : pdbEntries)
{
- ArrayList<SequenceI> seqs = new ArrayList<SequenceI>();
- for (int i = 0; i < alignment.getHeight(); i++)
+ List<SequenceI> seqs = new ArrayList<SequenceI>();
+ for (SequenceI sq : alignment.getSequences())
{
- Vector pdbs = alignment.getSequenceAt(i).getDatasetSequence()
- .getPDBId();
+ Vector<PDBEntry> pdbs = sq.getDatasetSequence().getAllPDBEntries();
if (pdbs == null)
{
continue;
}
- SequenceI sq;
- for (int p = 0; p < pdbs.size(); p++)
+ for (PDBEntry p1 : pdbs)
{
- PDBEntry p1 = (PDBEntry) pdbs.elementAt(p);
if (p1.getId().equals(pdb.getId()))
{
- if (!seqs.contains(sq = alignment.getSequenceAt(i)))
+ if (!seqs.contains(sq))
{
seqs.add(sq);
+ continue;
}
-
- continue;
}
}
}
return seqvectors.toArray(new SequenceI[seqvectors.size()][]);
}
+ @Override
public boolean isNormaliseSequenceLogo()
{
return normaliseSequenceLogo;
*
* @return true if alignment characters should be displayed
*/
+ @Override
public boolean isValidCharWidth()
{
return validCharWidth;
* may give the user the option to open a new frame, or split panel, with cDNA
* and protein linked.
*
- * @param al
+ * @param toAdd
* @param title
*/
- public void addAlignment(AlignmentI al, String title)
+ public void addAlignment(AlignmentI toAdd, String title)
{
// TODO: promote to AlignViewportI? applet CutAndPasteTransfer is different
// TODO: create undo object for this JAL-1101
/*
- * If one alignment is protein and one nucleotide, with at least one
- * sequence name in common, offer to open a linked alignment.
+ * Ensure datasets are created for the new alignment as
+ * mappings operate on dataset sequences
+ */
+ toAdd.setDataset(null);
+
+ /*
+ * Check if any added sequence could be the object of a mapping or
+ * cross-reference; if so, make the mapping explicit
*/
- if (AlignmentUtils.isMappable(al, getAlignment()))
+ getAlignment().realiseMappings(toAdd.getSequences());
+
+ /*
+ * If any cDNA/protein mappings exist or can be made between the alignments,
+ * offer to open a split frame with linked alignments
+ */
+ if (Cache.getDefault(Preferences.ENABLE_SPLIT_FRAME, true))
{
- if (openLinkedAlignment(al, title))
+ if (AlignmentUtils.isMappable(toAdd, getAlignment()))
{
- return;
+ if (openLinkedAlignment(toAdd, title))
+ {
+ return;
+ }
}
}
+
+ /*
+ * No mappings, or offer declined - add sequences to this alignment
+ */
// TODO: JAL-407 regardless of above - identical sequences (based on ID and
// provenance) should share the same dataset sequence
- for (int i = 0; i < al.getHeight(); i++)
+ AlignmentI al = getAlignment();
+ String gap = String.valueOf(al.getGapCharacter());
+ for (int i = 0; i < toAdd.getHeight(); i++)
{
- getAlignment().addSequence(al.getSequenceAt(i));
+ SequenceI seq = toAdd.getSequenceAt(i);
+ /*
+ * experimental!
+ * - 'align' any mapped sequences as per existing
+ * e.g. cdna to genome, domain hit to protein sequence
+ * very experimental! (need a separate menu option for this)
+ * - only add mapped sequences ('select targets from a dataset')
+ */
+ if (true /*AlignmentUtils.alignSequenceAs(seq, al, gap, true, true)*/)
+ {
+ al.addSequence(seq);
+ }
}
- // TODO this call was done by SequenceFetcher but not FileLoader or
- // CutAndPasteTransfer. Is it needed?
- // JBPComment: this repositions the view to show the new sequences
- // JBPComment: so it is needed for UX
+
setEndSeq(getAlignment().getHeight());
firePropertyChange("alignment", null, getAlignment().getSequences());
}
/**
* Show a dialog with the option to open and link (cDNA <-> protein) as a new
- * alignment. Returns true if the new alignment was opened, false if not,
- * because the user declined the offer.
+ * alignment, either as a standalone alignment or in a split frame. Returns
+ * true if the new alignment was opened, false if not, because the user
+ * declined the offer.
*
+ * @param al
* @param title
*/
protected boolean openLinkedAlignment(AlignmentI al, String title)
{
- String[] options = new String[]
- { MessageManager.getString("action.no"),
+ String[] options = new String[] {
+ MessageManager.getString("action.no"),
MessageManager.getString("label.split_window"),
MessageManager.getString("label.new_window"), };
final String question = JvSwingUtils.wrapTooltip(true,
final boolean openInNewWindow = (response == 2);
/*
- * Create the AlignFrame first (which creates the new alignment's datasets),
- * before attempting sequence mapping.
- */
- AlignFrame newAlignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
- AlignFrame.DEFAULT_HEIGHT);
- newAlignFrame.setTitle(title);
-
- /*
* Identify protein and dna alignments. Make a copy of this one if opening
* in a new split pane.
*/
AlignmentI protein = al.isNucleotide() ? thisAlignment : al;
final AlignmentI cdna = al.isNucleotide() ? al : thisAlignment;
+ /*
+ * Map sequences. At least one should get mapped as we have already passed
+ * the test for 'mappability'. Any mappings made will be added to the
+ * protein alignment. Note creating dataset sequences on the new alignment
+ * is a pre-requisite for building mappings.
+ */
+ al.setDataset(null);
+ AlignmentUtils.mapProteinAlignmentToCdna(protein, cdna);
+
+ /*
+ * Create the AlignFrame for the added alignment. If it is protein, mappings
+ * are registered with StructureSelectionManager as a side-effect.
+ */
+ AlignFrame newAlignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
+ AlignFrame.DEFAULT_HEIGHT);
+ newAlignFrame.setTitle(title);
newAlignFrame.statusBar.setText(MessageManager.formatMessage(
- "label.successfully_loaded_file", new Object[]
- { title }));
+ "label.successfully_loaded_file", new Object[] { title }));
// TODO if we want this (e.g. to enable reload of the alignment from file),
// we will need to add parameters to the stack.
if (openInNewWindow)
{
Desktop.addInternalFrame(newAlignFrame, title,
- AlignFrame.DEFAULT_WIDTH,
- AlignFrame.DEFAULT_HEIGHT);
+ AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
}
- /*
- * Map sequences. At least one should get mapped as we have already passed
- * the test for 'mappability'. Any mappings made will be added to the
- * protein alignment.
- */
- AlignmentUtils.mapProteinToCdna(protein, cdna);
-
try
{
newAlignFrame.setMaximum(jalview.bin.Cache.getDefault(
- "SHOW_FULLSCREEN",
- false));
+ "SHOW_FULLSCREEN", false));
} catch (java.beans.PropertyVetoException ex)
{
}
if (openSplitPane)
{
- protein = openSplitFrame(newAlignFrame, thisAlignment,
- protein.getCodonFrames());
+ al.alignAs(thisAlignment);
+ protein = openSplitFrame(newAlignFrame, thisAlignment);
}
- /*
- * Register the mappings (held on the protein alignment) with the
- * StructureSelectionManager (for mouseover linking).
- */
- final StructureSelectionManager ssm = StructureSelectionManager
- .getStructureSelectionManager(Desktop.instance);
- ssm.addMappings(protein.getCodonFrames());
-
return true;
}
* containing a new alignment to be shown
* @param complement
* cdna/protein complement alignment to show in the other split half
- * @param mappings
* @return the protein alignment in the split frame
*/
protected AlignmentI openSplitFrame(AlignFrame newAlignFrame,
- AlignmentI complement, Set<AlignedCodonFrame> mappings)
+ AlignmentI complement)
{
/*
- * Open in split pane. DNA sequence above, protein below.
+ * Make a new frame with a copy of the alignment we are adding to. If this
+ * is protein, the mappings to cDNA will be registered with
+ * StructureSelectionManager as a side-effect.
*/
AlignFrame copyMe = new AlignFrame(complement,
AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
AlignmentI al = newAlignFrame.viewport.getAlignment();
final AlignFrame proteinFrame = al.isNucleotide() ? copyMe
: newAlignFrame;
- final AlignFrame cdnaFrame = al.isNucleotide() ? newAlignFrame
- : copyMe;
- AlignmentI protein = proteinFrame.viewport.getAlignment();
- protein.setCodonFrames(mappings);
-
+ final AlignFrame cdnaFrame = al.isNucleotide() ? newAlignFrame : copyMe;
cdnaFrame.setVisible(true);
proteinFrame.setVisible(true);
String linkedTitle = MessageManager
.getString("label.linked_view_title");
+
+ /*
+ * Open in split pane. DNA sequence above, protein below.
+ */
JInternalFrame splitFrame = new SplitFrame(cdnaFrame, proteinFrame);
Desktop.addInternalFrame(splitFrame, linkedTitle, -1, -1);
- return protein;
+ return proteinFrame.viewport.getAlignment();
}
public AnnotationColumnChooser getAnnotationColumnSelectionState()
{
this.gatherViewsHere = gatherViewsHere;
}
+
+ /**
+ * If this viewport has a (Protein/cDNA) complement, then scroll the
+ * complementary alignment to match this one.
+ */
+ public void scrollComplementaryAlignment()
+ {
+ /*
+ * Populate a SearchResults object with the mapped location to scroll to. If
+ * there is no complement, or it is not following highlights, or no mapping
+ * is found, the result will be empty.
+ */
+ SearchResults sr = new SearchResults();
+ int verticalOffset = findComplementScrollTarget(sr);
+ if (!sr.isEmpty())
+ {
+ // TODO would like next line without cast but needs more refactoring...
+ final AlignmentPanel complementPanel = ((AlignViewport) getCodingComplement())
+ .getAlignPanel();
+ complementPanel.setDontScrollComplement(true);
+ complementPanel.scrollToCentre(sr, verticalOffset);
+ }
+ }
+
+ /**
+ * Answers true if no alignment holds a reference to the given mapping
+ *
+ * @param acf
+ * @return
+ */
+ protected boolean noReferencesTo(AlignedCodonFrame acf)
+ {
+ AlignFrame[] frames = Desktop.getAlignFrames();
+ if (frames == null)
+ {
+ return true;
+ }
+ for (AlignFrame af : frames)
+ {
+ if (!af.isClosed())
+ {
+ for (AlignmentViewPanel ap : af.getAlignPanels())
+ {
+ AlignmentI al = ap.getAlignment();
+ if (al != null && al.getCodonFrames().contains(acf))
+ {
+ return false;
+ }
+ }
+ }
+ }
+ return true;
+ }
+
+ /**
+ * Applies the supplied feature settings descriptor to currently known
+ * features. This supports an 'initial configuration' of feature colouring
+ * based on a preset or user favourite. This may then be modified in the usual
+ * way using the Feature Settings dialogue.
+ *
+ * @param featureSettings
+ */
+ public void applyFeaturesStyle(FeatureSettingsModelI featureSettings)
+ {
+ if (featureSettings == null)
+ {
+ return;
+ }
+
+ FeatureRenderer fr = getAlignPanel().getSeqPanel().seqCanvas
+ .getFeatureRenderer();
+ fr.findAllFeatures(true);
+ List<String> renderOrder = fr.getRenderOrder();
+ FeaturesDisplayedI displayed = fr.getFeaturesDisplayed();
+ displayed.clear();
+ // TODO this clears displayed.featuresRegistered - do we care?
+
+ /*
+ * set feature colour if specified by feature settings
+ * set visibility of all features
+ */
+ for (String type : renderOrder)
+ {
+ FeatureColourI preferredColour = featureSettings
+ .getFeatureColour(type);
+ if (preferredColour != null)
+ {
+ fr.setColour(type, preferredColour);
+ }
+ if (featureSettings.isFeatureDisplayed(type))
+ {
+ displayed.setVisible(type);
+ }
+ }
+
+ /*
+ * set visibility of feature groups
+ */
+ for (String group : fr.getFeatureGroups())
+ {
+ fr.setGroupVisibility(group, featureSettings.isGroupDisplayed(group));
+ }
+
+ /*
+ * order the features
+ */
+ if (featureSettings.optimiseOrder())
+ {
+ // TODO not supported (yet?)
+ }
+ else
+ {
+ fr.orderFeatures(featureSettings);
+ }
+ fr.setTransparency(featureSettings.getTransparency());
+ }
+
}