2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
21 package jalview.viewmodel;
23 import java.awt.Color;
24 import java.util.ArrayDeque;
25 import java.util.ArrayList;
26 import java.util.BitSet;
27 import java.util.Deque;
28 import java.util.HashMap;
29 import java.util.Hashtable;
30 import java.util.List;
34 import jalview.analysis.AnnotationSorter.SequenceAnnotationOrder;
35 import jalview.analysis.Conservation;
36 import jalview.api.AlignCalcManagerI;
37 import jalview.api.AlignViewportI;
38 import jalview.api.AlignmentViewPanel;
39 import jalview.api.FeaturesDisplayedI;
40 import jalview.api.ViewStyleI;
41 import jalview.commands.CommandI;
42 import jalview.datamodel.AlignedCodonFrame;
43 import jalview.datamodel.AlignmentAnnotation;
44 import jalview.datamodel.AlignmentI;
45 import jalview.datamodel.AlignmentView;
46 import jalview.datamodel.Annotation;
47 import jalview.datamodel.CigarArray;
48 import jalview.datamodel.ColumnSelection;
49 import jalview.datamodel.HiddenSequences;
50 import jalview.datamodel.SearchResults;
51 import jalview.datamodel.Sequence;
52 import jalview.datamodel.SequenceCollectionI;
53 import jalview.datamodel.SequenceGroup;
54 import jalview.datamodel.SequenceI;
55 import jalview.schemes.Blosum62ColourScheme;
56 import jalview.schemes.ColourSchemeI;
57 import jalview.schemes.PIDColourScheme;
58 import jalview.schemes.ResidueProperties;
59 import jalview.structure.CommandListener;
60 import jalview.structure.StructureSelectionManager;
61 import jalview.structure.VamsasSource;
62 import jalview.util.Comparison;
63 import jalview.util.MappingUtils;
64 import jalview.viewmodel.styles.ViewStyle;
65 import jalview.workers.AlignCalcManager;
66 import jalview.workers.ComplementConsensusThread;
67 import jalview.workers.ConsensusThread;
68 import jalview.workers.StrucConsensusThread;
71 * base class holding visualization and analysis attributes and common logic for
72 * an active alignment view displayed in the GUI
77 public abstract class AlignmentViewport implements AlignViewportI,
78 CommandListener, VamsasSource
80 protected ViewStyleI viewStyle = new ViewStyle();
83 * A viewport that hosts the cDna view of this (protein), or vice versa (if
86 AlignViewportI codingComplement = null;
88 FeaturesDisplayedI featuresDisplayed = null;
90 protected Deque<CommandI> historyList = new ArrayDeque<CommandI>();
92 protected Deque<CommandI> redoList = new ArrayDeque<CommandI>();
96 * @see jalview.api.ViewStyleI#setFontName(java.lang.String)
98 public void setFontName(String name)
100 viewStyle.setFontName(name);
105 * @see jalview.api.ViewStyleI#setFontStyle(int)
107 public void setFontStyle(int style)
109 viewStyle.setFontStyle(style);
114 * @see jalview.api.ViewStyleI#setFontSize(int)
116 public void setFontSize(int size)
118 viewStyle.setFontSize(size);
123 * @see jalview.api.ViewStyleI#getFontStyle()
125 public int getFontStyle()
127 return viewStyle.getFontStyle();
132 * @see jalview.api.ViewStyleI#getFontName()
134 public String getFontName()
136 return viewStyle.getFontName();
141 * @see jalview.api.ViewStyleI#getFontSize()
143 public int getFontSize()
145 return viewStyle.getFontSize();
149 * @param upperCasebold
150 * @see jalview.api.ViewStyleI#setUpperCasebold(boolean)
152 public void setUpperCasebold(boolean upperCasebold)
154 viewStyle.setUpperCasebold(upperCasebold);
159 * @see jalview.api.ViewStyleI#isUpperCasebold()
161 public boolean isUpperCasebold()
163 return viewStyle.isUpperCasebold();
168 * @see jalview.api.ViewStyleI#isSeqNameItalics()
170 public boolean isSeqNameItalics()
172 return viewStyle.isSeqNameItalics();
176 * @param colourByReferenceSeq
177 * @see jalview.api.ViewStyleI#setColourByReferenceSeq(boolean)
179 public void setColourByReferenceSeq(boolean colourByReferenceSeq)
181 viewStyle.setColourByReferenceSeq(colourByReferenceSeq);
186 * @see jalview.api.ViewStyleI#setColourAppliesToAllGroups(boolean)
188 public void setColourAppliesToAllGroups(boolean b)
190 viewStyle.setColourAppliesToAllGroups(b);
195 * @see jalview.api.ViewStyleI#getColourAppliesToAllGroups()
197 public boolean getColourAppliesToAllGroups()
199 return viewStyle.getColourAppliesToAllGroups();
204 * @see jalview.api.ViewStyleI#getAbovePIDThreshold()
206 public boolean getAbovePIDThreshold()
208 return viewStyle.getAbovePIDThreshold();
213 * @see jalview.api.ViewStyleI#setIncrement(int)
215 public void setIncrement(int inc)
217 viewStyle.setIncrement(inc);
222 * @see jalview.api.ViewStyleI#getIncrement()
224 public int getIncrement()
226 return viewStyle.getIncrement();
231 * @see jalview.api.ViewStyleI#setConservationSelected(boolean)
233 public void setConservationSelected(boolean b)
235 viewStyle.setConservationSelected(b);
240 * @see jalview.api.ViewStyleI#setShowHiddenMarkers(boolean)
242 public void setShowHiddenMarkers(boolean show)
244 viewStyle.setShowHiddenMarkers(show);
249 * @see jalview.api.ViewStyleI#getShowHiddenMarkers()
251 public boolean getShowHiddenMarkers()
253 return viewStyle.getShowHiddenMarkers();
258 * @see jalview.api.ViewStyleI#setScaleRightWrapped(boolean)
260 public void setScaleRightWrapped(boolean b)
262 viewStyle.setScaleRightWrapped(b);
267 * @see jalview.api.ViewStyleI#setScaleLeftWrapped(boolean)
269 public void setScaleLeftWrapped(boolean b)
271 viewStyle.setScaleLeftWrapped(b);
276 * @see jalview.api.ViewStyleI#setScaleAboveWrapped(boolean)
278 public void setScaleAboveWrapped(boolean b)
280 viewStyle.setScaleAboveWrapped(b);
285 * @see jalview.api.ViewStyleI#getScaleLeftWrapped()
287 public boolean getScaleLeftWrapped()
289 return viewStyle.getScaleLeftWrapped();
294 * @see jalview.api.ViewStyleI#getScaleAboveWrapped()
296 public boolean getScaleAboveWrapped()
298 return viewStyle.getScaleAboveWrapped();
303 * @see jalview.api.ViewStyleI#getScaleRightWrapped()
305 public boolean getScaleRightWrapped()
307 return viewStyle.getScaleRightWrapped();
312 * @see jalview.api.ViewStyleI#setAbovePIDThreshold(boolean)
314 public void setAbovePIDThreshold(boolean b)
316 viewStyle.setAbovePIDThreshold(b);
321 * @see jalview.api.ViewStyleI#setThreshold(int)
323 public void setThreshold(int thresh)
325 viewStyle.setThreshold(thresh);
330 * @see jalview.api.ViewStyleI#getThreshold()
332 public int getThreshold()
334 return viewStyle.getThreshold();
339 * @see jalview.api.ViewStyleI#getShowJVSuffix()
341 public boolean getShowJVSuffix()
343 return viewStyle.getShowJVSuffix();
348 * @see jalview.api.ViewStyleI#setShowJVSuffix(boolean)
350 public void setShowJVSuffix(boolean b)
352 viewStyle.setShowJVSuffix(b);
357 * @see jalview.api.ViewStyleI#setWrapAlignment(boolean)
359 public void setWrapAlignment(boolean state)
361 viewStyle.setWrapAlignment(state);
366 * @see jalview.api.ViewStyleI#setShowText(boolean)
368 public void setShowText(boolean state)
370 viewStyle.setShowText(state);
375 * @see jalview.api.ViewStyleI#setRenderGaps(boolean)
377 public void setRenderGaps(boolean state)
379 viewStyle.setRenderGaps(state);
384 * @see jalview.api.ViewStyleI#getColourText()
386 public boolean getColourText()
388 return viewStyle.getColourText();
393 * @see jalview.api.ViewStyleI#setColourText(boolean)
395 public void setColourText(boolean state)
397 viewStyle.setColourText(state);
402 * @see jalview.api.ViewStyleI#getWrapAlignment()
404 public boolean getWrapAlignment()
406 return viewStyle.getWrapAlignment();
411 * @see jalview.api.ViewStyleI#getShowText()
413 public boolean getShowText()
415 return viewStyle.getShowText();
420 * @see jalview.api.ViewStyleI#getWrappedWidth()
422 public int getWrappedWidth()
424 return viewStyle.getWrappedWidth();
429 * @see jalview.api.ViewStyleI#setWrappedWidth(int)
431 public void setWrappedWidth(int w)
433 viewStyle.setWrappedWidth(w);
438 * @see jalview.api.ViewStyleI#getCharHeight()
440 public int getCharHeight()
442 return viewStyle.getCharHeight();
447 * @see jalview.api.ViewStyleI#setCharHeight(int)
449 public void setCharHeight(int h)
451 viewStyle.setCharHeight(h);
456 * @see jalview.api.ViewStyleI#getCharWidth()
458 public int getCharWidth()
460 return viewStyle.getCharWidth();
465 * @see jalview.api.ViewStyleI#setCharWidth(int)
467 public void setCharWidth(int w)
469 viewStyle.setCharWidth(w);
474 * @see jalview.api.ViewStyleI#getShowBoxes()
476 public boolean getShowBoxes()
478 return viewStyle.getShowBoxes();
483 * @see jalview.api.ViewStyleI#getShowUnconserved()
485 public boolean getShowUnconserved()
487 return viewStyle.getShowUnconserved();
491 * @param showunconserved
492 * @see jalview.api.ViewStyleI#setShowUnconserved(boolean)
494 public void setShowUnconserved(boolean showunconserved)
496 viewStyle.setShowUnconserved(showunconserved);
501 * @see jalview.api.ViewStyleI#setSeqNameItalics(boolean)
503 public void setSeqNameItalics(boolean default1)
505 viewStyle.setSeqNameItalics(default1);
509 * alignment displayed in the viewport. Please use get/setter
511 protected AlignmentI alignment;
514 public AlignmentI getAlignment()
520 public char getGapCharacter()
522 return alignment.getGapCharacter();
525 protected String sequenceSetID;
528 * probably unused indicator that view is of a dataset rather than an
531 protected boolean isDataset = false;
533 public void setDataset(boolean b)
538 public boolean isDataset()
544 private Map<SequenceI, SequenceCollectionI> hiddenRepSequences;
546 protected ColumnSelection colSel = new ColumnSelection();
548 public boolean autoCalculateConsensus = true;
550 protected boolean autoCalculateStrucConsensus = true;
552 protected boolean ignoreGapsInConsensusCalculation = false;
554 protected ColourSchemeI globalColourScheme = null;
558 public void setGlobalColourScheme(ColourSchemeI cs)
560 // TODO: logic refactored from AlignFrame changeColour -
561 // autorecalc stuff should be changed to rely on the worker system
562 // check to see if we should implement a changeColour(cs) method rather than
563 // put th logic in here
564 // - means that caller decides if they want to just modify state and defer
565 // calculation till later or to do all calculations in thread.
567 globalColourScheme = cs;
568 boolean recalc = false;
571 cs.setConservationApplied(recalc = getConservationSelected());
572 if (getAbovePIDThreshold() || cs instanceof PIDColourScheme
573 || cs instanceof Blosum62ColourScheme)
576 cs.setThreshold(viewStyle.getThreshold(),
577 ignoreGapsInConsensusCalculation);
581 cs.setThreshold(0, ignoreGapsInConsensusCalculation);
585 cs.setConsensus(hconsensus);
586 cs.setConservation(hconservation);
588 cs.alignmentChanged(alignment, hiddenRepSequences);
590 if (getColourAppliesToAllGroups())
592 for (SequenceGroup sg : getAlignment().getGroups())
599 sg.cs = cs.applyTo(sg, getHiddenRepSequences());
600 sg.setConsPercGaps(ConsPercGaps);
601 if (getAbovePIDThreshold() || cs instanceof PIDColourScheme
602 || cs instanceof Blosum62ColourScheme)
604 sg.cs.setThreshold(viewStyle.getThreshold(),
605 isIgnoreGapsConsensus());
610 sg.cs.setThreshold(0, isIgnoreGapsConsensus());
613 if (getConservationSelected())
615 sg.cs.setConservationApplied(true);
620 sg.cs.setConservation(null);
621 // sg.cs.setThreshold(0, getIgnoreGapsConsensus());
625 sg.recalcConservation();
629 sg.cs.alignmentChanged(sg, hiddenRepSequences);
637 public ColourSchemeI getGlobalColourScheme()
639 return globalColourScheme;
642 protected AlignmentAnnotation consensus;
644 protected AlignmentAnnotation complementConsensus;
646 protected AlignmentAnnotation strucConsensus;
648 protected AlignmentAnnotation conservation;
650 protected AlignmentAnnotation quality;
652 protected AlignmentAnnotation[] groupConsensus;
654 protected AlignmentAnnotation[] groupConservation;
657 * results of alignment consensus analysis for visible portion of view
659 protected Hashtable[] hconsensus = null;
662 * results of cDNA complement consensus visible portion of view
664 protected Hashtable[] hcomplementConsensus = null;
667 * results of secondary structure base pair consensus for visible portion of
670 protected Hashtable[] hStrucConsensus = null;
672 protected Conservation hconservation = null;
675 public void setConservation(Conservation cons)
677 hconservation = cons;
681 * percentage gaps allowed in a column before all amino acid properties should
682 * be considered unconserved
684 int ConsPercGaps = 25; // JBPNote : This should be a scalable property!
687 public int getConsPercGaps()
693 public void setSequenceConsensusHash(Hashtable[] hconsensus)
695 this.hconsensus = hconsensus;
699 public void setComplementConsensusHash(Hashtable[] hconsensus)
701 this.hcomplementConsensus = hconsensus;
705 public Hashtable[] getSequenceConsensusHash()
711 public Hashtable[] getComplementConsensusHash()
713 return hcomplementConsensus;
717 public Hashtable[] getRnaStructureConsensusHash()
719 return hStrucConsensus;
723 public void setRnaStructureConsensusHash(Hashtable[] hStrucConsensus)
725 this.hStrucConsensus = hStrucConsensus;
730 public AlignmentAnnotation getAlignmentQualityAnnot()
736 public AlignmentAnnotation getAlignmentConservationAnnotation()
742 public AlignmentAnnotation getAlignmentConsensusAnnotation()
748 public AlignmentAnnotation getComplementConsensusAnnotation()
750 return complementConsensus;
754 public AlignmentAnnotation getAlignmentStrucConsensusAnnotation()
756 return strucConsensus;
759 protected AlignCalcManagerI calculator = new AlignCalcManager();
762 * trigger update of conservation annotation
764 public void updateConservation(final AlignmentViewPanel ap)
766 // see note in mantis : issue number 8585
767 if (alignment.isNucleotide() || conservation == null
768 || !autoCalculateConsensus)
773 .getRegisteredWorkersOfClass(jalview.workers.ConservationThread.class) == null)
775 calculator.registerWorker(new jalview.workers.ConservationThread(
781 * trigger update of consensus annotation
783 public void updateConsensus(final AlignmentViewPanel ap)
785 // see note in mantis : issue number 8585
786 if (consensus == null || !autoCalculateConsensus)
790 if (calculator.getRegisteredWorkersOfClass(ConsensusThread.class) == null)
792 calculator.registerWorker(new ConsensusThread(this, ap));
796 * A separate thread to compute cDNA consensus for a protein alignment
798 final AlignmentI al = this.getAlignment();
799 if (!al.isNucleotide() && al.getCodonFrames() != null
800 && !al.getCodonFrames().isEmpty())
803 .getRegisteredWorkersOfClass(ComplementConsensusThread.class) == null)
805 calculator.registerWorker(new ComplementConsensusThread(this, ap));
810 // --------START Structure Conservation
811 public void updateStrucConsensus(final AlignmentViewPanel ap)
813 if (autoCalculateStrucConsensus && strucConsensus == null
814 && alignment.isNucleotide() && alignment.hasRNAStructure())
816 // secondary structure has been added - so init the consensus line
820 // see note in mantis : issue number 8585
821 if (strucConsensus == null || !autoCalculateStrucConsensus)
825 if (calculator.getRegisteredWorkersOfClass(StrucConsensusThread.class) == null)
827 calculator.registerWorker(new StrucConsensusThread(this, ap));
831 public boolean isCalcInProgress()
833 return calculator.isWorking();
837 public boolean isCalculationInProgress(
838 AlignmentAnnotation alignmentAnnotation)
840 if (!alignmentAnnotation.autoCalculated)
844 if (calculator.workingInvolvedWith(alignmentAnnotation))
846 // System.err.println("grey out ("+alignmentAnnotation.label+")");
853 public boolean isClosed()
855 // TODO: check that this isClosed is only true after panel is closed, not
856 // before it is fully constructed.
857 return alignment == null;
861 public AlignCalcManagerI getCalcManager()
867 * should conservation rows be shown for groups
869 protected boolean showGroupConservation = false;
872 * should consensus rows be shown for groups
874 protected boolean showGroupConsensus = false;
877 * should consensus profile be rendered by default
879 protected boolean showSequenceLogo = false;
882 * should consensus profile be rendered normalised to row height
884 protected boolean normaliseSequenceLogo = false;
887 * should consensus histograms be rendered by default
889 protected boolean showConsensusHistogram = true;
892 * @return the showConsensusProfile
895 public boolean isShowSequenceLogo()
897 return showSequenceLogo;
901 * @param showSequenceLogo
904 public void setShowSequenceLogo(boolean showSequenceLogo)
906 if (showSequenceLogo != this.showSequenceLogo)
908 // TODO: decouple settings setting from calculation when refactoring
909 // annotation update method from alignframe to viewport
910 this.showSequenceLogo = showSequenceLogo;
911 calculator.updateAnnotationFor(ConsensusThread.class);
912 calculator.updateAnnotationFor(ComplementConsensusThread.class);
913 calculator.updateAnnotationFor(StrucConsensusThread.class);
915 this.showSequenceLogo = showSequenceLogo;
919 * @param showConsensusHistogram
920 * the showConsensusHistogram to set
922 public void setShowConsensusHistogram(boolean showConsensusHistogram)
924 this.showConsensusHistogram = showConsensusHistogram;
928 * @return the showGroupConservation
930 public boolean isShowGroupConservation()
932 return showGroupConservation;
936 * @param showGroupConservation
937 * the showGroupConservation to set
939 public void setShowGroupConservation(boolean showGroupConservation)
941 this.showGroupConservation = showGroupConservation;
945 * @return the showGroupConsensus
947 public boolean isShowGroupConsensus()
949 return showGroupConsensus;
953 * @param showGroupConsensus
954 * the showGroupConsensus to set
956 public void setShowGroupConsensus(boolean showGroupConsensus)
958 this.showGroupConsensus = showGroupConsensus;
963 * @return flag to indicate if the consensus histogram should be rendered by
967 public boolean isShowConsensusHistogram()
969 return this.showConsensusHistogram;
973 * when set, updateAlignment will always ensure sequences are of equal length
975 private boolean padGaps = false;
978 * when set, alignment should be reordered according to a newly opened tree
980 public boolean sortByTree = false;
986 * @return null or the currently selected sequence region
989 public SequenceGroup getSelectionGroup()
991 return selectionGroup;
995 * Set the selection group for this window.
998 * - group holding references to sequences in this alignment view
1002 public void setSelectionGroup(SequenceGroup sg)
1004 selectionGroup = sg;
1007 public void setHiddenColumns(ColumnSelection colsel)
1009 this.colSel = colsel;
1013 public ColumnSelection getColumnSelection()
1019 public void setColumnSelection(ColumnSelection colSel)
1021 this.colSel = colSel;
1024 updateHiddenColumns();
1033 public Map<SequenceI, SequenceCollectionI> getHiddenRepSequences()
1035 return hiddenRepSequences;
1039 public void setHiddenRepSequences(
1040 Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
1042 this.hiddenRepSequences = hiddenRepSequences;
1046 public boolean hasHiddenColumns()
1048 return colSel != null && colSel.hasHiddenColumns();
1051 public void updateHiddenColumns()
1053 // this method doesn't really do anything now. But - it could, since a
1054 // column Selection could be in the process of modification
1055 // hasHiddenColumns = colSel.hasHiddenColumns();
1058 protected boolean hasHiddenRows = false;
1061 public boolean hasHiddenRows()
1063 return hasHiddenRows;
1066 public void setHasHiddenRows(boolean hasHiddenRows)
1068 this.hasHiddenRows = hasHiddenRows;
1071 protected SequenceGroup selectionGroup;
1073 public void setSequenceSetId(String newid)
1075 if (sequenceSetID != null)
1078 .println("Warning - overwriting a sequenceSetId for a viewport!");
1080 sequenceSetID = new String(newid);
1084 public String getSequenceSetId()
1086 if (sequenceSetID == null)
1088 sequenceSetID = alignment.hashCode() + "";
1091 return sequenceSetID;
1095 * unique viewId for synchronizing state (e.g. with stored Jalview Project)
1098 protected String viewId = null;
1101 public String getViewId()
1105 viewId = this.getSequenceSetId() + "." + this.hashCode() + "";
1110 public void setIgnoreGapsConsensus(boolean b, AlignmentViewPanel ap)
1112 ignoreGapsInConsensusCalculation = b;
1115 updateConsensus(ap);
1116 if (globalColourScheme != null)
1118 globalColourScheme.setThreshold(globalColourScheme.getThreshold(),
1119 ignoreGapsInConsensusCalculation);
1125 private long sgrouphash = -1, colselhash = -1;
1128 * checks current SelectionGroup against record of last hash value, and
1132 * update the record of last hash value
1134 * @return true if SelectionGroup changed since last call (when b is true)
1136 public boolean isSelectionGroupChanged(boolean b)
1138 int hc = (selectionGroup == null || selectionGroup.getSize() == 0) ? -1
1139 : selectionGroup.hashCode();
1140 if (hc != -1 && hc != sgrouphash)
1152 * checks current colsel against record of last hash value, and optionally
1156 * update the record of last hash value
1157 * @return true if colsel changed since last call (when b is true)
1159 public boolean isColSelChanged(boolean b)
1161 int hc = (colSel == null || colSel.size() == 0) ? -1 : colSel
1163 if (hc != -1 && hc != colselhash)
1175 public boolean isIgnoreGapsConsensus()
1177 return ignoreGapsInConsensusCalculation;
1180 // / property change stuff
1182 // JBPNote Prolly only need this in the applet version.
1183 private final java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(
1186 protected boolean showConservation = true;
1188 protected boolean showQuality = true;
1190 protected boolean showConsensus = true;
1192 private Map<SequenceI, Color> sequenceColours = new HashMap<SequenceI, Color>();
1194 protected SequenceAnnotationOrder sortAnnotationsBy = null;
1196 protected boolean showAutocalculatedAbove;
1199 * when set, view will scroll to show the highlighted position
1201 private boolean followHighlight = true;
1203 // TODO private with getters and setters?
1204 public int startRes;
1208 public int startSeq;
1213 * Property change listener for changes in alignment
1218 public void addPropertyChangeListener(
1219 java.beans.PropertyChangeListener listener)
1221 changeSupport.addPropertyChangeListener(listener);
1230 public void removePropertyChangeListener(
1231 java.beans.PropertyChangeListener listener)
1233 changeSupport.removePropertyChangeListener(listener);
1237 * Property change listener for changes in alignment
1246 public void firePropertyChange(String prop, Object oldvalue,
1249 changeSupport.firePropertyChange(prop, oldvalue, newvalue);
1252 // common hide/show column stuff
1254 public void hideSelectedColumns()
1256 if (colSel.size() < 1)
1261 colSel.hideSelectedColumns();
1262 setSelectionGroup(null);
1266 public void hideColumns(int start, int end)
1270 colSel.hideColumns(start);
1274 colSel.hideColumns(start, end);
1278 public void showColumn(int col)
1280 colSel.revealHiddenColumns(col);
1284 public void showAllHiddenColumns()
1286 colSel.revealAllHiddenColumns();
1289 // common hide/show seq stuff
1290 public void showAllHiddenSeqs()
1292 if (alignment.getHiddenSequences().getSize() > 0)
1294 if (selectionGroup == null)
1296 selectionGroup = new SequenceGroup();
1297 selectionGroup.setEndRes(alignment.getWidth() - 1);
1299 List<SequenceI> tmp = alignment.getHiddenSequences().showAll(
1300 hiddenRepSequences);
1301 for (SequenceI seq : tmp)
1303 selectionGroup.addSequence(seq, false);
1304 setSequenceAnnotationsVisible(seq, true);
1307 hasHiddenRows = false;
1308 hiddenRepSequences = null;
1310 firePropertyChange("alignment", null, alignment.getSequences());
1311 // used to set hasHiddenRows/hiddenRepSequences here, after the property
1317 public void showSequence(int index)
1319 List<SequenceI> tmp = alignment.getHiddenSequences().showSequence(
1321 hiddenRepSequences);
1324 if (selectionGroup == null)
1326 selectionGroup = new SequenceGroup();
1327 selectionGroup.setEndRes(alignment.getWidth() - 1);
1330 for (SequenceI seq : tmp)
1332 selectionGroup.addSequence(seq, false);
1333 setSequenceAnnotationsVisible(seq, true);
1335 // JBPNote: refactor: only update flag if we modified visiblity (used to
1336 // do this regardless)
1337 if (alignment.getHiddenSequences().getSize() < 1)
1339 hasHiddenRows = false;
1341 firePropertyChange("alignment", null, alignment.getSequences());
1346 public void hideAllSelectedSeqs()
1348 if (selectionGroup == null || selectionGroup.getSize() < 1)
1353 SequenceI[] seqs = selectionGroup.getSequencesInOrder(alignment);
1357 setSelectionGroup(null);
1360 public void hideSequence(SequenceI[] seq)
1364 for (int i = 0; i < seq.length; i++)
1366 alignment.getHiddenSequences().hideSequence(seq[i]);
1367 setSequenceAnnotationsVisible(seq[i], false);
1369 hasHiddenRows = true;
1370 firePropertyChange("alignment", null, alignment.getSequences());
1375 * Set visibility for any annotations for the given sequence.
1379 protected void setSequenceAnnotationsVisible(SequenceI sequenceI,
1382 for (AlignmentAnnotation ann : alignment.getAlignmentAnnotation())
1384 if (ann.sequenceRef == sequenceI)
1386 ann.visible = visible;
1391 public void hideRepSequences(SequenceI repSequence, SequenceGroup sg)
1393 int sSize = sg.getSize();
1399 if (hiddenRepSequences == null)
1401 hiddenRepSequences = new Hashtable();
1404 hiddenRepSequences.put(repSequence, sg);
1406 // Hide all sequences except the repSequence
1407 SequenceI[] seqs = new SequenceI[sSize - 1];
1409 for (int i = 0; i < sSize; i++)
1411 if (sg.getSequenceAt(i) != repSequence)
1413 if (index == sSize - 1)
1418 seqs[index++] = sg.getSequenceAt(i);
1421 sg.setSeqrep(repSequence); // note: not done in 2.7applet
1422 sg.setHidereps(true); // note: not done in 2.7applet
1427 public boolean isHiddenRepSequence(SequenceI seq)
1429 return alignment.getSeqrep()==seq || (hiddenRepSequences != null
1430 && hiddenRepSequences.containsKey(seq));
1433 public SequenceGroup getRepresentedSequences(SequenceI seq)
1435 return (SequenceGroup) (hiddenRepSequences == null ? null
1436 : hiddenRepSequences.get(seq));
1440 public int adjustForHiddenSeqs(int alignmentIndex)
1442 return alignment.getHiddenSequences().adjustForHiddenSeqs(
1447 public void invertColumnSelection()
1449 colSel.invertColumnSelection(0, alignment.getWidth());
1454 public SequenceI[] getSelectionAsNewSequence()
1456 SequenceI[] sequences;
1457 // JBPNote: Need to test jalviewLite.getSelectedSequencesAsAlignmentFrom -
1458 // this was the only caller in the applet for this method
1459 // JBPNote: in applet, this method returned references to the alignment
1460 // sequences, and it did not honour the presence/absence of annotation
1461 // attached to the alignment (probably!)
1462 if (selectionGroup == null || selectionGroup.getSize() == 0)
1464 sequences = alignment.getSequencesArray();
1465 AlignmentAnnotation[] annots = alignment.getAlignmentAnnotation();
1466 for (int i = 0; i < sequences.length; i++)
1468 // construct new sequence with subset of visible annotation
1469 sequences[i] = new Sequence(sequences[i], annots);
1474 sequences = selectionGroup.getSelectionAsNewSequences(alignment);
1482 public SequenceI[] getSequenceSelection()
1484 SequenceI[] sequences = null;
1485 if (selectionGroup != null)
1487 sequences = selectionGroup.getSequencesInOrder(alignment);
1489 if (sequences == null)
1491 sequences = alignment.getSequencesArray();
1498 public CigarArray getViewAsCigars(
1499 boolean selectedRegionOnly)
1501 return new CigarArray(alignment, colSel,
1502 (selectedRegionOnly ? selectionGroup : null));
1507 public jalview.datamodel.AlignmentView getAlignmentView(
1508 boolean selectedOnly)
1510 return getAlignmentView(selectedOnly, false);
1515 public jalview.datamodel.AlignmentView getAlignmentView(
1516 boolean selectedOnly, boolean markGroups)
1518 return new AlignmentView(alignment, colSel, selectionGroup,
1519 colSel != null && colSel.hasHiddenColumns(), selectedOnly,
1525 public String[] getViewAsString(boolean selectedRegionOnly)
1527 String[] selection = null;
1528 SequenceI[] seqs = null;
1530 int start = 0, end = 0;
1531 if (selectedRegionOnly && selectionGroup != null)
1533 iSize = selectionGroup.getSize();
1534 seqs = selectionGroup.getSequencesInOrder(alignment);
1535 start = selectionGroup.getStartRes();
1536 end = selectionGroup.getEndRes() + 1;
1540 iSize = alignment.getHeight();
1541 seqs = alignment.getSequencesArray();
1542 end = alignment.getWidth();
1545 selection = new String[iSize];
1546 if (colSel != null && colSel.hasHiddenColumns())
1548 selection = colSel.getVisibleSequenceStrings(start, end, seqs);
1552 for (i = 0; i < iSize; i++)
1554 selection[i] = seqs[i].getSequenceAsString(start, end);
1563 public List<int[]> getVisibleRegionBoundaries(int min, int max)
1565 ArrayList<int[]> regions = new ArrayList<int[]>();
1571 if (colSel != null && colSel.hasHiddenColumns())
1575 start = colSel.adjustForHiddenColumns(start);
1578 end = colSel.getHiddenBoundaryRight(start);
1589 regions.add(new int[]
1592 if (colSel != null && colSel.hasHiddenColumns())
1594 start = colSel.adjustForHiddenColumns(end);
1595 start = colSel.getHiddenBoundaryLeft(start) + 1;
1597 } while (end < max);
1599 int[][] startEnd = new int[regions.size()][2];
1605 public List<AlignmentAnnotation> getVisibleAlignmentAnnotation(boolean selectedOnly)
1607 ArrayList<AlignmentAnnotation> ala = new ArrayList<AlignmentAnnotation>();
1608 AlignmentAnnotation[] aa;
1609 if ((aa=alignment.getAlignmentAnnotation())!=null)
1611 for (AlignmentAnnotation annot:aa)
1613 AlignmentAnnotation clone = new AlignmentAnnotation(annot);
1614 if (selectedOnly && selectionGroup!=null)
1616 colSel.makeVisibleAnnotation(selectionGroup.getStartRes(), selectionGroup.getEndRes(),clone);
1618 colSel.makeVisibleAnnotation(clone);
1628 public boolean isPadGaps()
1635 public void setPadGaps(boolean padGaps)
1637 this.padGaps = padGaps;
1641 * apply any post-edit constraints and trigger any calculations needed after
1642 * an edit has been performed on the alignment
1647 public void alignmentChanged(AlignmentViewPanel ap)
1651 alignment.padGaps();
1653 if (autoCalculateConsensus)
1655 updateConsensus(ap);
1657 if (hconsensus != null && autoCalculateConsensus)
1659 updateConservation(ap);
1661 if (autoCalculateStrucConsensus)
1663 updateStrucConsensus(ap);
1666 // Reset endRes of groups if beyond alignment width
1667 int alWidth = alignment.getWidth();
1668 List<SequenceGroup> groups = alignment.getGroups();
1671 for (SequenceGroup sg : groups)
1673 if (sg.getEndRes() > alWidth)
1675 sg.setEndRes(alWidth - 1);
1680 if (selectionGroup != null && selectionGroup.getEndRes() > alWidth)
1682 selectionGroup.setEndRes(alWidth - 1);
1685 resetAllColourSchemes();
1686 calculator.restartWorkers();
1687 // alignment.adjustSequenceAnnotations();
1691 * reset scope and do calculations for all applied colourschemes on alignment
1693 void resetAllColourSchemes()
1695 ColourSchemeI cs = globalColourScheme;
1698 cs.alignmentChanged(alignment, hiddenRepSequences);
1700 cs.setConsensus(hconsensus);
1701 if (cs.conservationApplied())
1703 cs.setConservation(Conservation.calculateConservation("All",
1704 ResidueProperties.propHash, 3, alignment.getSequences(), 0,
1705 alignment.getWidth(), false, getConsPercGaps(), false));
1709 for (SequenceGroup sg : alignment.getGroups())
1713 sg.cs.alignmentChanged(sg, hiddenRepSequences);
1715 sg.recalcConservation();
1719 protected void initAutoAnnotation()
1721 // TODO: add menu option action that nulls or creates consensus object
1722 // depending on if the user wants to see the annotation or not in a
1723 // specific alignment
1725 if (hconsensus == null && !isDataset)
1727 if (!alignment.isNucleotide())
1736 consensus = new AlignmentAnnotation("Consensus", "PID",
1737 new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
1738 initConsensus(consensus);
1740 initComplementConsensus();
1745 * If this is a protein alignment and there are mappings to cDNA, add the cDNA
1746 * consensus annotation.
1748 public void initComplementConsensus()
1750 if (!alignment.isNucleotide())
1752 final Set<AlignedCodonFrame> codonMappings = alignment
1754 if (codonMappings != null && !codonMappings.isEmpty())
1756 complementConsensus = new AlignmentAnnotation("cDNA Consensus",
1757 "PID for cDNA", new Annotation[1], 0f, 100f,
1758 AlignmentAnnotation.BAR_GRAPH);
1759 initConsensus(complementConsensus);
1764 private void initConsensus(AlignmentAnnotation aa)
1767 aa.autoCalculated = true;
1771 alignment.addAnnotation(aa);
1775 private void initConservation()
1777 if (showConservation)
1779 if (conservation == null)
1781 conservation = new AlignmentAnnotation("Conservation",
1782 "Conservation of total alignment less than "
1783 + getConsPercGaps() + "% gaps", new Annotation[1],
1784 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
1785 conservation.hasText = true;
1786 conservation.autoCalculated = true;
1787 alignment.addAnnotation(conservation);
1792 private void initQuality()
1796 if (quality == null)
1798 quality = new AlignmentAnnotation("Quality",
1799 "Alignment Quality based on Blosum62 scores",
1800 new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
1801 quality.hasText = true;
1802 quality.autoCalculated = true;
1803 alignment.addAnnotation(quality);
1808 private void initRNAStructure()
1810 if (alignment.hasRNAStructure() && strucConsensus == null)
1812 strucConsensus = new AlignmentAnnotation("StrucConsensus", "PID",
1813 new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
1814 strucConsensus.hasText = true;
1815 strucConsensus.autoCalculated = true;
1819 alignment.addAnnotation(strucConsensus);
1827 * @see jalview.api.AlignViewportI#calcPanelHeight()
1830 public int calcPanelHeight()
1832 // setHeight of panels
1833 AlignmentAnnotation[] anns = getAlignment().getAlignmentAnnotation();
1835 int charHeight = getCharHeight();
1838 BitSet graphgrp = new BitSet();
1839 for (AlignmentAnnotation aa : anns)
1843 System.err.println("Null annotation row: ignoring.");
1850 if (aa.graphGroup > -1)
1852 if (graphgrp.get(aa.graphGroup))
1858 graphgrp.set(aa.graphGroup);
1865 aa.height += charHeight;
1875 aa.height += aa.graphHeight;
1883 height += aa.height;
1895 public void updateGroupAnnotationSettings(boolean applyGlobalSettings,
1896 boolean preserveNewGroupSettings)
1898 boolean updateCalcs = false;
1899 boolean conv = isShowGroupConservation();
1900 boolean cons = isShowGroupConsensus();
1901 boolean showprf = isShowSequenceLogo();
1902 boolean showConsHist = isShowConsensusHistogram();
1903 boolean normLogo = isNormaliseSequenceLogo();
1906 * TODO reorder the annotation rows according to group/sequence ordering on
1909 boolean sortg = true;
1911 // remove old automatic annotation
1912 // add any new annotation
1914 // intersect alignment annotation with alignment groups
1916 AlignmentAnnotation[] aan = alignment.getAlignmentAnnotation();
1917 List<SequenceGroup> oldrfs = new ArrayList<SequenceGroup>();
1920 for (int an = 0; an < aan.length; an++)
1922 if (aan[an].autoCalculated && aan[an].groupRef != null)
1924 oldrfs.add(aan[an].groupRef);
1925 alignment.deleteAnnotation(aan[an], false);
1929 if (alignment.getGroups() != null)
1931 for (SequenceGroup sg : alignment.getGroups())
1933 updateCalcs = false;
1934 if (applyGlobalSettings
1935 || (!preserveNewGroupSettings && !oldrfs.contains(sg)))
1937 // set defaults for this group's conservation/consensus
1938 sg.setshowSequenceLogo(showprf);
1939 sg.setShowConsensusHistogram(showConsHist);
1940 sg.setNormaliseSequenceLogo(normLogo);
1945 alignment.addAnnotation(sg.getConservationRow(), 0);
1950 alignment.addAnnotation(sg.getConsensus(), 0);
1952 // refresh the annotation rows
1955 sg.recalcConservation();
1962 public boolean isDisplayReferenceSeq()
1964 return alignment.hasSeqrep() && viewStyle.isDisplayReferenceSeq();
1968 public void setDisplayReferenceSeq(boolean displayReferenceSeq)
1970 viewStyle.setDisplayReferenceSeq(displayReferenceSeq);
1974 public boolean isColourByReferenceSeq()
1976 return alignment.hasSeqrep() && viewStyle.isColourByReferenceSeq();
1980 public Color getSequenceColour(SequenceI seq)
1982 Color sqc = sequenceColours.get(seq);
1983 return (sqc == null ? Color.white : sqc);
1987 public void setSequenceColour(SequenceI seq, Color col)
1991 sequenceColours.remove(seq);
1995 sequenceColours.put(seq, col);
2000 public void updateSequenceIdColours()
2002 for (SequenceGroup sg : alignment.getGroups())
2004 if (sg.idColour != null)
2006 for (SequenceI s : sg.getSequences(getHiddenRepSequences()))
2008 sequenceColours.put(s, sg.idColour);
2015 public void clearSequenceColours()
2017 sequenceColours.clear();
2021 public AlignViewportI getCodingComplement()
2023 return this.codingComplement;
2027 * Set this as the (cDna/protein) complement of the given viewport. Also
2028 * ensures the reverse relationship is set on the given viewport.
2031 public void setCodingComplement(AlignViewportI av)
2035 System.err.println("Ignoring recursive setCodingComplement request");
2039 this.codingComplement = av;
2040 // avoid infinite recursion!
2041 if (av.getCodingComplement() != this)
2043 av.setCodingComplement(this);
2049 public boolean isNucleotide()
2051 return getAlignment() == null ? false : getAlignment().isNucleotide();
2055 public FeaturesDisplayedI getFeaturesDisplayed()
2057 return featuresDisplayed;
2061 public void setFeaturesDisplayed(FeaturesDisplayedI featuresDisplayedI)
2063 featuresDisplayed = featuresDisplayedI;
2067 public boolean areFeaturesDisplayed()
2069 return featuresDisplayed != null && featuresDisplayed.getRegisterdFeaturesCount()>0;
2076 * features are displayed if true
2079 public void setShowSequenceFeatures(boolean b)
2081 viewStyle.setShowSequenceFeatures(b);
2084 public boolean isShowSequenceFeatures()
2086 return viewStyle.isShowSequenceFeatures();
2090 public void setShowSequenceFeaturesHeight(boolean selected)
2092 viewStyle.setShowSequenceFeaturesHeight(selected);
2096 public boolean isShowSequenceFeaturesHeight()
2098 return viewStyle.isShowSequenceFeaturesHeight();
2104 public void setShowAnnotation(boolean b)
2106 viewStyle.setShowAnnotation(b);
2110 public boolean isShowAnnotation()
2112 return viewStyle.isShowAnnotation();
2116 public boolean isRightAlignIds()
2118 return viewStyle.isRightAlignIds();
2122 public void setRightAlignIds(boolean rightAlignIds)
2124 viewStyle.setRightAlignIds(rightAlignIds);
2128 public boolean getConservationSelected()
2130 return viewStyle.getConservationSelected();
2134 public void setShowBoxes(boolean state)
2136 viewStyle.setShowBoxes(state);
2141 * @see jalview.api.ViewStyleI#getTextColour()
2143 public Color getTextColour()
2145 return viewStyle.getTextColour();
2150 * @see jalview.api.ViewStyleI#getTextColour2()
2152 public Color getTextColour2()
2154 return viewStyle.getTextColour2();
2159 * @see jalview.api.ViewStyleI#getThresholdTextColour()
2161 public int getThresholdTextColour()
2163 return viewStyle.getThresholdTextColour();
2168 * @see jalview.api.ViewStyleI#isConservationColourSelected()
2170 public boolean isConservationColourSelected()
2172 return viewStyle.isConservationColourSelected();
2177 * @see jalview.api.ViewStyleI#isRenderGaps()
2179 public boolean isRenderGaps()
2181 return viewStyle.isRenderGaps();
2186 * @see jalview.api.ViewStyleI#isShowColourText()
2188 public boolean isShowColourText()
2190 return viewStyle.isShowColourText();
2194 * @param conservationColourSelected
2195 * @see jalview.api.ViewStyleI#setConservationColourSelected(boolean)
2197 public void setConservationColourSelected(
2198 boolean conservationColourSelected)
2200 viewStyle.setConservationColourSelected(conservationColourSelected);
2204 * @param showColourText
2205 * @see jalview.api.ViewStyleI#setShowColourText(boolean)
2207 public void setShowColourText(boolean showColourText)
2209 viewStyle.setShowColourText(showColourText);
2214 * @see jalview.api.ViewStyleI#setTextColour(java.awt.Color)
2216 public void setTextColour(Color textColour)
2218 viewStyle.setTextColour(textColour);
2222 * @param thresholdTextColour
2223 * @see jalview.api.ViewStyleI#setThresholdTextColour(int)
2225 public void setThresholdTextColour(int thresholdTextColour)
2227 viewStyle.setThresholdTextColour(thresholdTextColour);
2231 * @param textColour2
2232 * @see jalview.api.ViewStyleI#setTextColour2(java.awt.Color)
2234 public void setTextColour2(Color textColour2)
2236 viewStyle.setTextColour2(textColour2);
2240 public ViewStyleI getViewStyle()
2242 return new ViewStyle(viewStyle);
2246 public void setViewStyle(ViewStyleI settingsForView)
2248 viewStyle = new ViewStyle(settingsForView);
2252 public boolean sameStyle(ViewStyleI them)
2254 return viewStyle.sameStyle(them);
2259 * @see jalview.api.ViewStyleI#getIdWidth()
2261 public int getIdWidth()
2263 return viewStyle.getIdWidth();
2268 * @see jalview.api.ViewStyleI#setIdWidth(int)
2270 public void setIdWidth(int i)
2272 viewStyle.setIdWidth(i);
2277 * @see jalview.api.ViewStyleI#isCentreColumnLabels()
2279 public boolean isCentreColumnLabels()
2281 return viewStyle.isCentreColumnLabels();
2285 * @param centreColumnLabels
2286 * @see jalview.api.ViewStyleI#setCentreColumnLabels(boolean)
2288 public void setCentreColumnLabels(boolean centreColumnLabels)
2290 viewStyle.setCentreColumnLabels(centreColumnLabels);
2295 * @see jalview.api.ViewStyleI#setShowDBRefs(boolean)
2297 public void setShowDBRefs(boolean showdbrefs)
2299 viewStyle.setShowDBRefs(showdbrefs);
2304 * @see jalview.api.ViewStyleI#isShowDBRefs()
2306 public boolean isShowDBRefs()
2308 return viewStyle.isShowDBRefs();
2313 * @see jalview.api.ViewStyleI#isShowNPFeats()
2315 public boolean isShowNPFeats()
2317 return viewStyle.isShowNPFeats();
2321 * @param shownpfeats
2322 * @see jalview.api.ViewStyleI#setShowNPFeats(boolean)
2324 public void setShowNPFeats(boolean shownpfeats)
2326 viewStyle.setShowNPFeats(shownpfeats);
2329 public abstract StructureSelectionManager getStructureSelectionManager();
2332 * Add one command to the command history list.
2336 public void addToHistoryList(CommandI command)
2338 if (this.historyList != null)
2340 this.historyList.push(command);
2341 broadcastCommand(command, false);
2345 protected void broadcastCommand(CommandI command, boolean undo)
2347 getStructureSelectionManager().commandPerformed(command, undo, getVamsasSource());
2351 * Add one command to the command redo list.
2355 public void addToRedoList(CommandI command)
2357 if (this.redoList != null)
2359 this.redoList.push(command);
2361 broadcastCommand(command, true);
2365 * Clear the command redo list.
2367 public void clearRedoList()
2369 if (this.redoList != null)
2371 this.redoList.clear();
2375 public void setHistoryList(Deque<CommandI> list)
2377 this.historyList = list;
2380 public Deque<CommandI> getHistoryList()
2382 return this.historyList;
2385 public void setRedoList(Deque<CommandI> list)
2387 this.redoList = list;
2390 public Deque<CommandI> getRedoList()
2392 return this.redoList;
2396 public VamsasSource getVamsasSource()
2401 public SequenceAnnotationOrder getSortAnnotationsBy()
2403 return sortAnnotationsBy;
2406 public void setSortAnnotationsBy(SequenceAnnotationOrder sortAnnotationsBy)
2408 this.sortAnnotationsBy = sortAnnotationsBy;
2411 public boolean isShowAutocalculatedAbove()
2413 return showAutocalculatedAbove;
2416 public void setShowAutocalculatedAbove(boolean showAutocalculatedAbove)
2418 this.showAutocalculatedAbove = showAutocalculatedAbove;
2422 public boolean isScaleProteinAsCdna()
2424 return viewStyle.isScaleProteinAsCdna();
2428 public void setScaleProteinAsCdna(boolean b)
2430 viewStyle.setScaleProteinAsCdna(b);
2434 * @return true if view should scroll to show the highlighted region of a
2439 public final boolean isFollowHighlight()
2441 return followHighlight;
2445 public final void setFollowHighlight(boolean b)
2447 this.followHighlight = b;
2450 public int getStartRes()
2455 public int getEndRes()
2460 public int getStartSeq()
2465 public void setStartRes(int res)
2467 this.startRes = res;
2470 public void setStartSeq(int seq)
2472 this.startSeq = seq;
2475 public void setEndRes(int res)
2477 if (res > alignment.getWidth() - 1)
2479 // log.System.out.println(" Corrected res from " + res + " to maximum " +
2480 // (alignment.getWidth()-1));
2481 res = alignment.getWidth() - 1;
2490 public void setEndSeq(int seq)
2492 if (seq > alignment.getHeight())
2494 seq = alignment.getHeight();
2503 public int getEndSeq()
2509 * Helper method to populate the SearchResults with the location in the
2510 * complementary alignment to scroll to, in order to match this one.
2513 * the SearchResults to add to
2514 * @return the offset (below top of visible region) of the matched sequence
2516 protected int findComplementScrollTarget(SearchResults sr)
2518 final AlignViewportI codingComplement = getCodingComplement();
2519 if (codingComplement == null || !codingComplement.isFollowHighlight())
2523 boolean iAmProtein = !getAlignment().isNucleotide();
2524 AlignmentI proteinAlignment = iAmProtein ? getAlignment()
2525 : codingComplement.getAlignment();
2526 if (proteinAlignment == null)
2530 final Set<AlignedCodonFrame> mappings = proteinAlignment
2534 * Heuristic: find the first mapped sequence (if any) with a non-gapped
2535 * residue in the middle column of the visible region. Scroll the
2536 * complementary alignment to line up the corresponding residue.
2539 SequenceI sequence = null;
2542 * locate 'middle' column (true middle if an odd number visible, left of
2543 * middle if an even number visible)
2545 int middleColumn = getStartRes() + (getEndRes() - getStartRes()) / 2;
2546 final HiddenSequences hiddenSequences = getAlignment()
2547 .getHiddenSequences();
2548 for (int seqNo = getStartSeq(); seqNo < getEndSeq(); seqNo++, seqOffset++)
2550 sequence = getAlignment().getSequenceAt(seqNo);
2551 if (hiddenSequences != null && hiddenSequences.isHidden(sequence))
2555 if (Comparison.isGap(sequence.getCharAt(middleColumn)))
2559 List<AlignedCodonFrame> seqMappings = MappingUtils
2560 .findMappingsForSequence(sequence, mappings);
2561 if (!seqMappings.isEmpty())
2567 if (sequence == null)
2570 * No ungapped mapped sequence in middle column - do nothing
2574 MappingUtils.addSearchResults(sr, sequence,
2575 sequence.findPosition(middleColumn), mappings);