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 jalview.analysis.AnnotationSorter.SequenceAnnotationOrder;
24 import jalview.analysis.Conservation;
25 import jalview.analysis.TreeModel;
26 import jalview.api.AlignCalcManagerI;
27 import jalview.api.AlignExportSettingsI;
28 import jalview.api.AlignViewportI;
29 import jalview.api.AlignmentViewPanel;
30 import jalview.api.FeaturesDisplayedI;
31 import jalview.api.ViewStyleI;
32 import jalview.commands.CommandI;
33 import jalview.datamodel.AlignedCodonFrame;
34 import jalview.datamodel.AlignmentAnnotation;
35 import jalview.datamodel.AlignmentExportData;
36 import jalview.datamodel.AlignmentI;
37 import jalview.datamodel.AlignmentView;
38 import jalview.datamodel.Annotation;
39 import jalview.datamodel.ColumnSelection;
40 import jalview.datamodel.HiddenColumns;
41 import jalview.datamodel.HiddenSequences;
42 import jalview.datamodel.ProfilesI;
43 import jalview.datamodel.SearchResultsI;
44 import jalview.datamodel.Sequence;
45 import jalview.datamodel.SequenceCollectionI;
46 import jalview.datamodel.SequenceGroup;
47 import jalview.datamodel.SequenceI;
48 import jalview.renderer.ResidueShader;
49 import jalview.renderer.ResidueShaderI;
50 import jalview.schemes.ColourSchemeI;
51 import jalview.structure.CommandListener;
52 import jalview.structure.StructureSelectionManager;
53 import jalview.structure.VamsasSource;
54 import jalview.util.Comparison;
55 import jalview.util.MapList;
56 import jalview.util.MappingUtils;
57 import jalview.util.MessageManager;
58 import jalview.viewmodel.styles.ViewStyle;
59 import jalview.workers.AlignCalcManager;
60 import jalview.workers.ComplementConsensusThread;
61 import jalview.workers.ConsensusThread;
62 import jalview.workers.StrucConsensusThread;
64 import java.awt.Color;
65 import java.beans.PropertyChangeSupport;
66 import java.util.ArrayDeque;
67 import java.util.ArrayList;
68 import java.util.BitSet;
69 import java.util.Deque;
70 import java.util.HashMap;
71 import java.util.Hashtable;
72 import java.util.Iterator;
73 import java.util.List;
77 * base class holding visualization and analysis attributes and common logic for
78 * an active alignment view displayed in the GUI
83 public abstract class AlignmentViewport
84 implements AlignViewportI, CommandListener, VamsasSource
86 protected ViewportRanges ranges;
88 protected ViewStyleI viewStyle = new ViewStyle();
91 * A viewport that hosts the cDna view of this (protein), or vice versa (if
94 AlignViewportI codingComplement = null;
96 FeaturesDisplayedI featuresDisplayed = null;
98 protected Deque<CommandI> historyList = new ArrayDeque<>();
100 protected Deque<CommandI> redoList = new ArrayDeque<>();
103 * alignment displayed in the viewport. Please use get/setter
105 protected AlignmentI alignment;
107 public AlignmentViewport(AlignmentI al)
110 ranges = new ViewportRanges(al);
115 * @see jalview.api.ViewStyleI#setFontName(java.lang.String)
118 public void setFontName(String name)
120 viewStyle.setFontName(name);
125 * @see jalview.api.ViewStyleI#setFontStyle(int)
128 public void setFontStyle(int style)
130 viewStyle.setFontStyle(style);
135 * @see jalview.api.ViewStyleI#setFontSize(int)
138 public void setFontSize(int size)
140 viewStyle.setFontSize(size);
145 * @see jalview.api.ViewStyleI#getFontStyle()
148 public int getFontStyle()
150 return viewStyle.getFontStyle();
155 * @see jalview.api.ViewStyleI#getFontName()
158 public String getFontName()
160 return viewStyle.getFontName();
165 * @see jalview.api.ViewStyleI#getFontSize()
168 public int getFontSize()
170 return viewStyle.getFontSize();
174 * @param upperCasebold
175 * @see jalview.api.ViewStyleI#setUpperCasebold(boolean)
178 public void setUpperCasebold(boolean upperCasebold)
180 viewStyle.setUpperCasebold(upperCasebold);
185 * @see jalview.api.ViewStyleI#isUpperCasebold()
188 public boolean isUpperCasebold()
190 return viewStyle.isUpperCasebold();
195 * @see jalview.api.ViewStyleI#isSeqNameItalics()
198 public boolean isSeqNameItalics()
200 return viewStyle.isSeqNameItalics();
204 * @param colourByReferenceSeq
205 * @see jalview.api.ViewStyleI#setColourByReferenceSeq(boolean)
208 public void setColourByReferenceSeq(boolean colourByReferenceSeq)
210 viewStyle.setColourByReferenceSeq(colourByReferenceSeq);
215 * @see jalview.api.ViewStyleI#setColourAppliesToAllGroups(boolean)
218 public void setColourAppliesToAllGroups(boolean b)
220 viewStyle.setColourAppliesToAllGroups(b);
225 * @see jalview.api.ViewStyleI#getColourAppliesToAllGroups()
228 public boolean getColourAppliesToAllGroups()
230 return viewStyle.getColourAppliesToAllGroups();
235 * @see jalview.api.ViewStyleI#getAbovePIDThreshold()
238 public boolean getAbovePIDThreshold()
240 return viewStyle.getAbovePIDThreshold();
245 * @see jalview.api.ViewStyleI#setIncrement(int)
248 public void setIncrement(int inc)
250 viewStyle.setIncrement(inc);
255 * @see jalview.api.ViewStyleI#getIncrement()
258 public int getIncrement()
260 return viewStyle.getIncrement();
265 * @see jalview.api.ViewStyleI#setConservationSelected(boolean)
268 public void setConservationSelected(boolean b)
270 viewStyle.setConservationSelected(b);
275 * @see jalview.api.ViewStyleI#setShowHiddenMarkers(boolean)
278 public void setShowHiddenMarkers(boolean show)
280 viewStyle.setShowHiddenMarkers(show);
285 * @see jalview.api.ViewStyleI#getShowHiddenMarkers()
288 public boolean getShowHiddenMarkers()
290 return viewStyle.getShowHiddenMarkers();
295 * @see jalview.api.ViewStyleI#setScaleRightWrapped(boolean)
298 public void setScaleRightWrapped(boolean b)
300 viewStyle.setScaleRightWrapped(b);
305 * @see jalview.api.ViewStyleI#setScaleLeftWrapped(boolean)
308 public void setScaleLeftWrapped(boolean b)
310 viewStyle.setScaleLeftWrapped(b);
315 * @see jalview.api.ViewStyleI#setScaleAboveWrapped(boolean)
318 public void setScaleAboveWrapped(boolean b)
320 viewStyle.setScaleAboveWrapped(b);
325 * @see jalview.api.ViewStyleI#getScaleLeftWrapped()
328 public boolean getScaleLeftWrapped()
330 return viewStyle.getScaleLeftWrapped();
335 * @see jalview.api.ViewStyleI#getScaleAboveWrapped()
338 public boolean getScaleAboveWrapped()
340 return viewStyle.getScaleAboveWrapped();
345 * @see jalview.api.ViewStyleI#getScaleRightWrapped()
348 public boolean getScaleRightWrapped()
350 return viewStyle.getScaleRightWrapped();
355 * @see jalview.api.ViewStyleI#setAbovePIDThreshold(boolean)
358 public void setAbovePIDThreshold(boolean b)
360 viewStyle.setAbovePIDThreshold(b);
365 * @see jalview.api.ViewStyleI#setThreshold(int)
368 public void setThreshold(int thresh)
370 viewStyle.setThreshold(thresh);
375 * @see jalview.api.ViewStyleI#getThreshold()
378 public int getThreshold()
380 return viewStyle.getThreshold();
385 * @see jalview.api.ViewStyleI#getShowJVSuffix()
388 public boolean getShowJVSuffix()
390 return viewStyle.getShowJVSuffix();
395 * @see jalview.api.ViewStyleI#setShowJVSuffix(boolean)
398 public void setShowJVSuffix(boolean b)
400 viewStyle.setShowJVSuffix(b);
405 * @see jalview.api.ViewStyleI#setWrapAlignment(boolean)
408 public void setWrapAlignment(boolean state)
410 viewStyle.setWrapAlignment(state);
411 ranges.setWrappedMode(state);
416 * @see jalview.api.ViewStyleI#setShowText(boolean)
419 public void setShowText(boolean state)
421 viewStyle.setShowText(state);
426 * @see jalview.api.ViewStyleI#setRenderGaps(boolean)
429 public void setRenderGaps(boolean state)
431 viewStyle.setRenderGaps(state);
436 * @see jalview.api.ViewStyleI#getColourText()
439 public boolean getColourText()
441 return viewStyle.getColourText();
446 * @see jalview.api.ViewStyleI#setColourText(boolean)
449 public void setColourText(boolean state)
451 viewStyle.setColourText(state);
456 * @see jalview.api.ViewStyleI#getWrapAlignment()
459 public boolean getWrapAlignment()
461 return viewStyle.getWrapAlignment();
466 * @see jalview.api.ViewStyleI#getShowText()
469 public boolean getShowText()
471 return viewStyle.getShowText();
476 * @see jalview.api.ViewStyleI#getWrappedWidth()
479 public int getWrappedWidth()
481 return viewStyle.getWrappedWidth();
486 * @see jalview.api.ViewStyleI#setWrappedWidth(int)
489 public void setWrappedWidth(int w)
491 viewStyle.setWrappedWidth(w);
496 * @see jalview.api.ViewStyleI#getCharHeight()
499 public int getCharHeight()
501 return viewStyle.getCharHeight();
506 * @see jalview.api.ViewStyleI#setCharHeight(int)
509 public void setCharHeight(int h)
511 viewStyle.setCharHeight(h);
516 * @see jalview.api.ViewStyleI#getCharWidth()
519 public int getCharWidth()
521 return viewStyle.getCharWidth();
526 * @see jalview.api.ViewStyleI#setCharWidth(int)
529 public void setCharWidth(int w)
531 viewStyle.setCharWidth(w);
536 * @see jalview.api.ViewStyleI#getShowBoxes()
539 public boolean getShowBoxes()
541 return viewStyle.getShowBoxes();
546 * @see jalview.api.ViewStyleI#getShowUnconserved()
549 public boolean getShowUnconserved()
551 return viewStyle.getShowUnconserved();
555 * @param showunconserved
556 * @see jalview.api.ViewStyleI#setShowUnconserved(boolean)
559 public void setShowUnconserved(boolean showunconserved)
561 viewStyle.setShowUnconserved(showunconserved);
566 * @see jalview.api.ViewStyleI#setSeqNameItalics(boolean)
569 public void setSeqNameItalics(boolean default1)
571 viewStyle.setSeqNameItalics(default1);
575 public AlignmentI getAlignment()
581 public char getGapCharacter()
583 return alignment.getGapCharacter();
586 protected String sequenceSetID;
589 * probably unused indicator that view is of a dataset rather than an
592 protected boolean isDataset = false;
594 public void setDataset(boolean b)
599 public boolean isDataset()
604 private Map<SequenceI, SequenceCollectionI> hiddenRepSequences;
606 protected ColumnSelection colSel = new ColumnSelection();
608 public boolean autoCalculateConsensus = true;
610 protected boolean autoCalculateStrucConsensus = true;
612 protected boolean ignoreGapsInConsensusCalculation = false;
614 protected ResidueShaderI residueShading = new ResidueShader();
617 public void setGlobalColourScheme(ColourSchemeI cs)
619 // TODO: logic refactored from AlignFrame changeColour -
620 // TODO: autorecalc stuff should be changed to rely on the worker system
621 // check to see if we should implement a changeColour(cs) method rather than
622 // put the logic in here
623 // - means that caller decides if they want to just modify state and defer
624 // calculation till later or to do all calculations in thread.
628 * only instantiate alignment colouring once, thereafter update it;
629 * this means that any conservation or PID threshold settings
630 * persist when the alignment colour scheme is changed
632 if (residueShading == null)
634 residueShading = new ResidueShader(viewStyle);
636 residueShading.setColourScheme(cs);
638 // TODO: do threshold and increment belong in ViewStyle or ResidueShader?
639 // ...problem: groups need these, but do not currently have a ViewStyle
643 if (getConservationSelected())
645 residueShading.setConservation(hconservation);
648 * reset conservation flag in case just set to false if
649 * Conservation was null (calculation still in progress)
651 residueShading.setConservationApplied(getConservationSelected());
652 residueShading.alignmentChanged(alignment, hiddenRepSequences);
656 * if 'apply colour to all groups' is selected... do so
657 * (but don't transfer any colour threshold settings to groups)
659 if (getColourAppliesToAllGroups())
661 for (SequenceGroup sg : getAlignment().getGroups())
664 * retain any colour thresholds per group while
665 * changing choice of colour scheme (JAL-2386)
668 cs == null ? null : cs.getInstance(this, sg));
671 sg.getGroupColourScheme().alignmentChanged(sg,
679 public ColourSchemeI getGlobalColourScheme()
681 return residueShading == null ? null : residueShading.getColourScheme();
685 public ResidueShaderI getResidueShading()
687 return residueShading;
690 protected AlignmentAnnotation consensus;
692 protected AlignmentAnnotation complementConsensus;
694 protected AlignmentAnnotation gapcounts;
696 protected AlignmentAnnotation strucConsensus;
698 protected AlignmentAnnotation conservation;
700 protected AlignmentAnnotation quality;
702 protected AlignmentAnnotation[] groupConsensus;
704 protected AlignmentAnnotation[] groupConservation;
707 * results of alignment consensus analysis for visible portion of view
709 protected ProfilesI hconsensus = null;
712 * results of cDNA complement consensus visible portion of view
714 protected Hashtable<String, Object>[] hcomplementConsensus = null;
717 * results of secondary structure base pair consensus for visible portion of
720 protected Hashtable<String, Object>[] hStrucConsensus = null;
722 protected Conservation hconservation = null;
725 public void setConservation(Conservation cons)
727 hconservation = cons;
731 * percentage gaps allowed in a column before all amino acid properties should
732 * be considered unconserved
734 int ConsPercGaps = 25; // JBPNote : This should be a scalable property!
737 public int getConsPercGaps()
743 public void setSequenceConsensusHash(ProfilesI hconsensus)
745 this.hconsensus = hconsensus;
749 public void setComplementConsensusHash(
750 Hashtable<String, Object>[] hconsensus)
752 this.hcomplementConsensus = hconsensus;
756 public ProfilesI getSequenceConsensusHash()
762 public Hashtable<String, Object>[] getComplementConsensusHash()
764 return hcomplementConsensus;
768 public Hashtable<String, Object>[] getRnaStructureConsensusHash()
770 return hStrucConsensus;
774 public void setRnaStructureConsensusHash(
775 Hashtable<String, Object>[] hStrucConsensus)
777 this.hStrucConsensus = hStrucConsensus;
782 public AlignmentAnnotation getAlignmentQualityAnnot()
788 public AlignmentAnnotation getAlignmentConservationAnnotation()
794 public AlignmentAnnotation getAlignmentConsensusAnnotation()
800 public AlignmentAnnotation getAlignmentGapAnnotation()
806 public AlignmentAnnotation getComplementConsensusAnnotation()
808 return complementConsensus;
812 public AlignmentAnnotation getAlignmentStrucConsensusAnnotation()
814 return strucConsensus;
817 protected AlignCalcManagerI calculator = new AlignCalcManager();
820 * trigger update of conservation annotation
822 public void updateConservation(final AlignmentViewPanel ap)
824 // see note in mantis : issue number 8585
825 if (alignment.isNucleotide()
826 || (conservation == null && quality == null)
827 || !autoCalculateConsensus)
831 if (calculator.getRegisteredWorkersOfClass(
832 jalview.workers.ConservationThread.class) == null)
834 calculator.registerWorker(
835 new jalview.workers.ConservationThread(this, ap));
840 * trigger update of consensus annotation
842 public void updateConsensus(final AlignmentViewPanel ap)
844 // see note in mantis : issue number 8585
845 if (consensus == null || !autoCalculateConsensus)
850 .getRegisteredWorkersOfClass(ConsensusThread.class) == null)
852 calculator.registerWorker(new ConsensusThread(this, ap));
856 * A separate thread to compute cDNA consensus for a protein alignment
857 * which has mapping to cDNA
859 final AlignmentI al = this.getAlignment();
860 if (!al.isNucleotide() && al.getCodonFrames() != null
861 && !al.getCodonFrames().isEmpty())
864 * fudge - check first for protein-to-nucleotide mappings
865 * (we don't want to do this for protein-to-protein)
867 boolean doConsensus = false;
868 for (AlignedCodonFrame mapping : al.getCodonFrames())
870 // TODO hold mapping type e.g. dna-to-protein in AlignedCodonFrame?
871 MapList[] mapLists = mapping.getdnaToProt();
872 // mapLists can be empty if project load has not finished resolving seqs
873 if (mapLists.length > 0 && mapLists[0].getFromRatio() == 3)
881 if (calculator.getRegisteredWorkersOfClass(
882 ComplementConsensusThread.class) == null)
885 .registerWorker(new ComplementConsensusThread(this, ap));
891 // --------START Structure Conservation
892 public void updateStrucConsensus(final AlignmentViewPanel ap)
894 if (autoCalculateStrucConsensus && strucConsensus == null
895 && alignment.isNucleotide() && alignment.hasRNAStructure())
897 // secondary structure has been added - so init the consensus line
901 // see note in mantis : issue number 8585
902 if (strucConsensus == null || !autoCalculateStrucConsensus)
906 if (calculator.getRegisteredWorkersOfClass(
907 StrucConsensusThread.class) == null)
909 calculator.registerWorker(new StrucConsensusThread(this, ap));
913 public boolean isCalcInProgress()
915 return calculator.isWorking();
919 public boolean isCalculationInProgress(
920 AlignmentAnnotation alignmentAnnotation)
922 if (!alignmentAnnotation.autoCalculated)
926 if (calculator.workingInvolvedWith(alignmentAnnotation))
928 // System.err.println("grey out ("+alignmentAnnotation.label+")");
934 public void setAlignment(AlignmentI align)
936 this.alignment = align;
940 * Clean up references when this viewport is closed
943 public void dispose()
946 * defensively null out references to large objects in case
947 * this object is not garbage collected (as if!)
950 complementConsensus = null;
951 strucConsensus = null;
954 groupConsensus = null;
955 groupConservation = null;
957 hconservation = null;
958 hcomplementConsensus = null;
961 residueShading = null; // may hold a reference to Consensus
962 changeSupport = null;
965 selectionGroup = null;
971 public boolean isClosed()
973 // TODO: check that this isClosed is only true after panel is closed, not
974 // before it is fully constructed.
975 return alignment == null;
979 public AlignCalcManagerI getCalcManager()
985 * should conservation rows be shown for groups
987 protected boolean showGroupConservation = false;
990 * should consensus rows be shown for groups
992 protected boolean showGroupConsensus = false;
995 * should consensus profile be rendered by default
997 protected boolean showSequenceLogo = false;
1000 * should consensus profile be rendered normalised to row height
1002 protected boolean normaliseSequenceLogo = false;
1005 * should consensus histograms be rendered by default
1007 protected boolean showConsensusHistogram = true;
1010 * @return the showConsensusProfile
1013 public boolean isShowSequenceLogo()
1015 return showSequenceLogo;
1019 * @param showSequenceLogo
1022 public void setShowSequenceLogo(boolean showSequenceLogo)
1024 if (showSequenceLogo != this.showSequenceLogo)
1026 // TODO: decouple settings setting from calculation when refactoring
1027 // annotation update method from alignframe to viewport
1028 this.showSequenceLogo = showSequenceLogo;
1029 calculator.updateAnnotationFor(ConsensusThread.class);
1030 calculator.updateAnnotationFor(ComplementConsensusThread.class);
1031 calculator.updateAnnotationFor(StrucConsensusThread.class);
1033 this.showSequenceLogo = showSequenceLogo;
1037 * @param showConsensusHistogram
1038 * the showConsensusHistogram to set
1040 public void setShowConsensusHistogram(boolean showConsensusHistogram)
1042 this.showConsensusHistogram = showConsensusHistogram;
1046 * @return the showGroupConservation
1048 public boolean isShowGroupConservation()
1050 return showGroupConservation;
1054 * @param showGroupConservation
1055 * the showGroupConservation to set
1057 public void setShowGroupConservation(boolean showGroupConservation)
1059 this.showGroupConservation = showGroupConservation;
1063 * @return the showGroupConsensus
1065 public boolean isShowGroupConsensus()
1067 return showGroupConsensus;
1071 * @param showGroupConsensus
1072 * the showGroupConsensus to set
1074 public void setShowGroupConsensus(boolean showGroupConsensus)
1076 this.showGroupConsensus = showGroupConsensus;
1081 * @return flag to indicate if the consensus histogram should be rendered by
1085 public boolean isShowConsensusHistogram()
1087 return this.showConsensusHistogram;
1091 * when set, updateAlignment will always ensure sequences are of equal length
1093 private boolean padGaps = false;
1096 * when set, alignment should be reordered according to a newly opened tree
1098 public boolean sortByTree = false;
1103 * @return null or the currently selected sequence region
1106 public SequenceGroup getSelectionGroup()
1108 return selectionGroup;
1112 * Set the selection group for this window. Also sets the current alignment as
1113 * the context for the group, if it does not already have one.
1116 * - group holding references to sequences in this alignment view
1120 public void setSelectionGroup(SequenceGroup sg)
1122 selectionGroup = sg;
1123 if (sg != null && sg.getContext() == null)
1125 sg.setContext(alignment);
1129 public void setHiddenColumns(HiddenColumns hidden)
1131 this.alignment.setHiddenColumns(hidden);
1135 public ColumnSelection getColumnSelection()
1141 public void setColumnSelection(ColumnSelection colSel)
1143 this.colSel = colSel;
1146 updateHiddenColumns();
1148 isColSelChanged(true);
1156 public Map<SequenceI, SequenceCollectionI> getHiddenRepSequences()
1158 return hiddenRepSequences;
1162 public void setHiddenRepSequences(
1163 Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
1165 this.hiddenRepSequences = hiddenRepSequences;
1169 public boolean hasSelectedColumns()
1171 ColumnSelection columnSelection = getColumnSelection();
1172 return columnSelection != null && columnSelection.hasSelectedColumns();
1176 public boolean hasHiddenColumns()
1178 return alignment.getHiddenColumns() != null
1179 && alignment.getHiddenColumns().hasHiddenColumns();
1182 public void updateHiddenColumns()
1184 // this method doesn't really do anything now. But - it could, since a
1185 // column Selection could be in the process of modification
1186 // hasHiddenColumns = colSel.hasHiddenColumns();
1190 public boolean hasHiddenRows()
1192 return alignment.getHiddenSequences().getSize() > 0;
1195 protected SequenceGroup selectionGroup;
1197 public void setSequenceSetId(String newid)
1199 if (sequenceSetID != null)
1202 "Warning - overwriting a sequenceSetId for a viewport!");
1204 sequenceSetID = new String(newid);
1208 public String getSequenceSetId()
1210 if (sequenceSetID == null)
1212 sequenceSetID = alignment.hashCode() + "";
1215 return sequenceSetID;
1219 * unique viewId for synchronizing state (e.g. with stored Jalview Project)
1222 protected String viewId = null;
1225 public String getViewId()
1229 viewId = this.getSequenceSetId() + "." + this.hashCode() + "";
1234 public void setIgnoreGapsConsensus(boolean b, AlignmentViewPanel ap)
1236 ignoreGapsInConsensusCalculation = b;
1239 updateConsensus(ap);
1240 if (residueShading != null)
1242 residueShading.setThreshold(residueShading.getThreshold(),
1243 ignoreGapsInConsensusCalculation);
1249 private long sgrouphash = -1, colselhash = -1;
1252 * checks current SelectionGroup against record of last hash value, and
1256 * update the record of last hash value
1258 * @return true if SelectionGroup changed since last call (when b is true)
1260 public boolean isSelectionGroupChanged(boolean b)
1262 int hc = (selectionGroup == null || selectionGroup.getSize() == 0) ? -1
1263 : selectionGroup.hashCode();
1264 if (hc != -1 && hc != sgrouphash)
1276 * checks current colsel against record of last hash value, and optionally
1280 * update the record of last hash value
1281 * @return true if colsel changed since last call (when b is true)
1283 public boolean isColSelChanged(boolean b)
1285 int hc = (colSel == null || colSel.isEmpty()) ? -1 : colSel.hashCode();
1286 if (hc != -1 && hc != colselhash)
1298 public boolean isIgnoreGapsConsensus()
1300 return ignoreGapsInConsensusCalculation;
1303 // property change stuff
1304 // JBPNote Prolly only need this in the applet version.
1305 private PropertyChangeSupport changeSupport = new PropertyChangeSupport(
1308 protected boolean showConservation = true;
1310 protected boolean showQuality = true;
1312 protected boolean showConsensus = true;
1314 protected boolean showOccupancy = true;
1316 private Map<SequenceI, Color> sequenceColours = new HashMap<>();
1318 protected SequenceAnnotationOrder sortAnnotationsBy = null;
1320 protected boolean showAutocalculatedAbove;
1323 * when set, view will scroll to show the highlighted position
1325 private boolean followHighlight = true;
1328 * Property change listener for changes in alignment
1333 public void addPropertyChangeListener(
1334 java.beans.PropertyChangeListener listener)
1336 changeSupport.addPropertyChangeListener(listener);
1345 public void removePropertyChangeListener(
1346 java.beans.PropertyChangeListener listener)
1348 if (changeSupport != null)
1350 changeSupport.removePropertyChangeListener(listener);
1355 * Property change listener for changes in alignment
1364 public void firePropertyChange(String prop, Object oldvalue,
1367 changeSupport.firePropertyChange(prop, oldvalue, newvalue);
1370 // common hide/show column stuff
1372 public void hideSelectedColumns()
1374 if (colSel.isEmpty())
1379 colSel.hideSelectedColumns(alignment);
1380 setSelectionGroup(null);
1381 isColSelChanged(true);
1384 public void hideColumns(int start, int end)
1388 colSel.hideSelectedColumns(start, alignment.getHiddenColumns());
1392 alignment.getHiddenColumns().hideColumns(start, end);
1394 isColSelChanged(true);
1397 public void showColumn(int col)
1399 alignment.getHiddenColumns().revealHiddenColumns(col, colSel);
1400 isColSelChanged(true);
1403 public void showAllHiddenColumns()
1405 alignment.getHiddenColumns().revealAllHiddenColumns(colSel);
1406 isColSelChanged(true);
1409 // common hide/show seq stuff
1410 public void showAllHiddenSeqs()
1412 int startSeq = ranges.getStartSeq();
1413 int endSeq = ranges.getEndSeq();
1415 if (alignment.getHiddenSequences().getSize() > 0)
1417 if (selectionGroup == null)
1419 selectionGroup = new SequenceGroup();
1420 selectionGroup.setEndRes(alignment.getWidth() - 1);
1422 List<SequenceI> tmp = alignment.getHiddenSequences()
1423 .showAll(hiddenRepSequences);
1424 for (SequenceI seq : tmp)
1426 selectionGroup.addSequence(seq, false);
1427 setSequenceAnnotationsVisible(seq, true);
1430 hiddenRepSequences = null;
1432 ranges.setStartEndSeq(startSeq, endSeq + tmp.size());
1434 firePropertyChange("alignment", null, alignment.getSequences());
1435 // used to set hasHiddenRows/hiddenRepSequences here, after the property
1441 public void showSequence(int index)
1443 int startSeq = ranges.getStartSeq();
1444 int endSeq = ranges.getEndSeq();
1446 List<SequenceI> tmp = alignment.getHiddenSequences().showSequence(index,
1447 hiddenRepSequences);
1450 if (selectionGroup == null)
1452 selectionGroup = new SequenceGroup();
1453 selectionGroup.setEndRes(alignment.getWidth() - 1);
1456 for (SequenceI seq : tmp)
1458 selectionGroup.addSequence(seq, false);
1459 setSequenceAnnotationsVisible(seq, true);
1462 ranges.setStartEndSeq(startSeq, endSeq + tmp.size());
1464 firePropertyChange("alignment", null, alignment.getSequences());
1469 public void hideAllSelectedSeqs()
1471 if (selectionGroup == null || selectionGroup.getSize() < 1)
1476 SequenceI[] seqs = selectionGroup.getSequencesInOrder(alignment);
1480 setSelectionGroup(null);
1483 public void hideSequence(SequenceI[] seq)
1486 * cache offset to first visible sequence
1488 int startSeq = ranges.getStartSeq();
1492 for (int i = 0; i < seq.length; i++)
1494 alignment.getHiddenSequences().hideSequence(seq[i]);
1495 setSequenceAnnotationsVisible(seq[i], false);
1497 ranges.setStartSeq(startSeq);
1498 firePropertyChange("alignment", null, alignment.getSequences());
1503 * Hides the specified sequence, or the sequences it represents
1506 * the sequence to hide, or keep as representative
1507 * @param representGroup
1508 * if true, hide the current selection group except for the
1509 * representative sequence
1511 public void hideSequences(SequenceI sequence, boolean representGroup)
1513 if (selectionGroup == null || selectionGroup.getSize() < 1)
1515 hideSequence(new SequenceI[] { sequence });
1521 hideRepSequences(sequence, selectionGroup);
1522 setSelectionGroup(null);
1526 int gsize = selectionGroup.getSize();
1527 SequenceI[] hseqs = selectionGroup.getSequences()
1528 .toArray(new SequenceI[gsize]);
1530 hideSequence(hseqs);
1531 setSelectionGroup(null);
1536 * Set visibility for any annotations for the given sequence.
1540 protected void setSequenceAnnotationsVisible(SequenceI sequenceI,
1543 AlignmentAnnotation[] anns = alignment.getAlignmentAnnotation();
1546 for (AlignmentAnnotation ann : anns)
1548 if (ann.sequenceRef == sequenceI)
1550 ann.visible = visible;
1556 public void hideRepSequences(SequenceI repSequence, SequenceGroup sg)
1558 int sSize = sg.getSize();
1564 if (hiddenRepSequences == null)
1566 hiddenRepSequences = new Hashtable<>();
1569 hiddenRepSequences.put(repSequence, sg);
1571 // Hide all sequences except the repSequence
1572 SequenceI[] seqs = new SequenceI[sSize - 1];
1574 for (int i = 0; i < sSize; i++)
1576 if (sg.getSequenceAt(i) != repSequence)
1578 if (index == sSize - 1)
1583 seqs[index++] = sg.getSequenceAt(i);
1586 sg.setSeqrep(repSequence); // note: not done in 2.7applet
1587 sg.setHidereps(true); // note: not done in 2.7applet
1594 * @return null or the current reference sequence
1596 public SequenceI getReferenceSeq()
1598 return alignment.getSeqrep();
1603 * @return true iff seq is the reference for the alignment
1605 public boolean isReferenceSeq(SequenceI seq)
1607 return alignment.getSeqrep() == seq;
1613 * @return true if there are sequences represented by this sequence that are
1616 public boolean isHiddenRepSequence(SequenceI seq)
1618 return (hiddenRepSequences != null
1619 && hiddenRepSequences.containsKey(seq));
1625 * @return null or a sequence group containing the sequences that seq
1628 public SequenceGroup getRepresentedSequences(SequenceI seq)
1630 return (SequenceGroup) (hiddenRepSequences == null ? null
1631 : hiddenRepSequences.get(seq));
1635 public int adjustForHiddenSeqs(int alignmentIndex)
1637 return alignment.getHiddenSequences()
1638 .adjustForHiddenSeqs(alignmentIndex);
1642 public void invertColumnSelection()
1644 colSel.invertColumnSelection(0, alignment.getWidth(), alignment);
1645 isColSelChanged(true);
1649 public SequenceI[] getSelectionAsNewSequence()
1651 SequenceI[] sequences;
1652 // JBPNote: Need to test jalviewLite.getSelectedSequencesAsAlignmentFrom -
1653 // this was the only caller in the applet for this method
1654 // JBPNote: in applet, this method returned references to the alignment
1655 // sequences, and it did not honour the presence/absence of annotation
1656 // attached to the alignment (probably!)
1657 if (selectionGroup == null || selectionGroup.getSize() == 0)
1659 sequences = alignment.getSequencesArray();
1660 AlignmentAnnotation[] annots = alignment.getAlignmentAnnotation();
1661 for (int i = 0; i < sequences.length; i++)
1663 // construct new sequence with subset of visible annotation
1664 sequences[i] = new Sequence(sequences[i], annots);
1669 sequences = selectionGroup.getSelectionAsNewSequences(alignment);
1676 public SequenceI[] getSequenceSelection()
1678 SequenceI[] sequences = null;
1679 if (selectionGroup != null)
1681 sequences = selectionGroup.getSequencesInOrder(alignment);
1683 if (sequences == null)
1685 sequences = alignment.getSequencesArray();
1691 public jalview.datamodel.AlignmentView getAlignmentView(
1692 boolean selectedOnly)
1694 return getAlignmentView(selectedOnly, false);
1698 public jalview.datamodel.AlignmentView getAlignmentView(
1699 boolean selectedOnly, boolean markGroups)
1701 return new AlignmentView(alignment, alignment.getHiddenColumns(),
1703 alignment.getHiddenColumns() != null
1704 && alignment.getHiddenColumns().hasHiddenColumns(),
1705 selectedOnly, markGroups);
1709 public String[] getViewAsString(boolean selectedRegionOnly)
1711 return getViewAsString(selectedRegionOnly, true);
1715 public String[] getViewAsString(boolean selectedRegionOnly,
1716 boolean exportHiddenSeqs)
1718 String[] selection = null;
1719 SequenceI[] seqs = null;
1721 int start = 0, end = 0;
1722 if (selectedRegionOnly && selectionGroup != null)
1724 iSize = selectionGroup.getSize();
1725 seqs = selectionGroup.getSequencesInOrder(alignment);
1726 start = selectionGroup.getStartRes();
1727 end = selectionGroup.getEndRes() + 1;
1731 if (hasHiddenRows() && exportHiddenSeqs)
1733 AlignmentI fullAlignment = alignment.getHiddenSequences()
1734 .getFullAlignment();
1735 iSize = fullAlignment.getHeight();
1736 seqs = fullAlignment.getSequencesArray();
1737 end = fullAlignment.getWidth();
1741 iSize = alignment.getHeight();
1742 seqs = alignment.getSequencesArray();
1743 end = alignment.getWidth();
1747 selection = new String[iSize];
1748 if (alignment.getHiddenColumns() != null
1749 && alignment.getHiddenColumns().hasHiddenColumns())
1751 for (i = 0; i < iSize; i++)
1753 Iterator<int[]> blocks = alignment.getHiddenColumns()
1754 .getVisContigsIterator(start, end + 1, false);
1755 selection[i] = seqs[i].getSequenceStringFromIterator(blocks);
1760 for (i = 0; i < iSize; i++)
1762 selection[i] = seqs[i].getSequenceAsString(start, end);
1770 public List<int[]> getVisibleRegionBoundaries(int min, int max)
1772 ArrayList<int[]> regions = new ArrayList<>();
1778 HiddenColumns hidden = alignment.getHiddenColumns();
1779 if (hidden != null && hidden.hasHiddenColumns())
1783 start = hidden.visibleToAbsoluteColumn(start);
1786 end = hidden.getNextHiddenBoundary(false, start);
1797 regions.add(new int[] { start, end });
1799 if (hidden != null && hidden.hasHiddenColumns())
1801 start = hidden.visibleToAbsoluteColumn(end);
1802 start = hidden.getNextHiddenBoundary(true, start) + 1;
1804 } while (end < max);
1806 // int[][] startEnd = new int[regions.size()][2];
1812 public List<AlignmentAnnotation> getVisibleAlignmentAnnotation(
1813 boolean selectedOnly)
1815 ArrayList<AlignmentAnnotation> ala = new ArrayList<>();
1816 AlignmentAnnotation[] aa;
1817 if ((aa = alignment.getAlignmentAnnotation()) != null)
1819 for (AlignmentAnnotation annot : aa)
1821 AlignmentAnnotation clone = new AlignmentAnnotation(annot);
1822 if (selectedOnly && selectionGroup != null)
1824 clone.makeVisibleAnnotation(
1825 selectionGroup.getStartRes(), selectionGroup.getEndRes(),
1826 alignment.getHiddenColumns());
1830 clone.makeVisibleAnnotation(alignment.getHiddenColumns());
1839 public boolean isPadGaps()
1845 public void setPadGaps(boolean padGaps)
1847 this.padGaps = padGaps;
1851 * apply any post-edit constraints and trigger any calculations needed after
1852 * an edit has been performed on the alignment
1857 public void alignmentChanged(AlignmentViewPanel ap)
1861 alignment.padGaps();
1863 if (autoCalculateConsensus)
1865 updateConsensus(ap);
1867 if (hconsensus != null && autoCalculateConsensus)
1869 updateConservation(ap);
1871 if (autoCalculateStrucConsensus)
1873 updateStrucConsensus(ap);
1876 // Reset endRes of groups if beyond alignment width
1877 int alWidth = alignment.getWidth();
1878 List<SequenceGroup> groups = alignment.getGroups();
1881 for (SequenceGroup sg : groups)
1883 if (sg.getEndRes() > alWidth)
1885 sg.setEndRes(alWidth - 1);
1890 if (selectionGroup != null && selectionGroup.getEndRes() > alWidth)
1892 selectionGroup.setEndRes(alWidth - 1);
1895 updateAllColourSchemes();
1896 calculator.restartWorkers();
1897 // alignment.adjustSequenceAnnotations();
1901 * reset scope and do calculations for all applied colourschemes on alignment
1903 void updateAllColourSchemes()
1905 ResidueShaderI rs = residueShading;
1908 rs.alignmentChanged(alignment, hiddenRepSequences);
1910 rs.setConsensus(hconsensus);
1911 if (rs.conservationApplied())
1913 rs.setConservation(Conservation.calculateConservation("All",
1914 alignment.getSequences(), 0, alignment.getWidth(), false,
1915 getConsPercGaps(), false));
1919 for (SequenceGroup sg : alignment.getGroups())
1923 sg.cs.alignmentChanged(sg, hiddenRepSequences);
1925 sg.recalcConservation();
1929 protected void initAutoAnnotation()
1931 // TODO: add menu option action that nulls or creates consensus object
1932 // depending on if the user wants to see the annotation or not in a
1933 // specific alignment
1935 if (hconsensus == null && !isDataset)
1937 if (!alignment.isNucleotide())
1946 consensus = new AlignmentAnnotation("Consensus",
1947 MessageManager.getString("label.consensus_descr"),
1948 new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
1949 initConsensus(consensus);
1952 initComplementConsensus();
1957 * If this is a protein alignment and there are mappings to cDNA, adds the
1958 * cDNA consensus annotation and returns true, else returns false.
1960 public boolean initComplementConsensus()
1962 if (!alignment.isNucleotide())
1964 final List<AlignedCodonFrame> codonMappings = alignment
1966 if (codonMappings != null && !codonMappings.isEmpty())
1968 boolean doConsensus = false;
1969 for (AlignedCodonFrame mapping : codonMappings)
1971 // TODO hold mapping type e.g. dna-to-protein in AlignedCodonFrame?
1972 MapList[] mapLists = mapping.getdnaToProt();
1973 // mapLists can be empty if project load has not finished resolving
1975 if (mapLists.length > 0 && mapLists[0].getFromRatio() == 3)
1983 complementConsensus = new AlignmentAnnotation("cDNA Consensus",
1985 .getString("label.complement_consensus_descr"),
1986 new Annotation[1], 0f, 100f,
1987 AlignmentAnnotation.BAR_GRAPH);
1988 initConsensus(complementConsensus);
1996 private void initConsensus(AlignmentAnnotation aa)
1999 aa.autoCalculated = true;
2003 alignment.addAnnotation(aa);
2007 // these should be extracted from the view model - style and settings for
2008 // derived annotation
2009 private void initGapCounts()
2013 gapcounts = new AlignmentAnnotation("Occupancy",
2014 MessageManager.getString("label.occupancy_descr"),
2015 new Annotation[1], 0f, alignment.getHeight(),
2016 AlignmentAnnotation.BAR_GRAPH);
2017 gapcounts.hasText = true;
2018 gapcounts.autoCalculated = true;
2019 gapcounts.scaleColLabel = true;
2020 gapcounts.graph = AlignmentAnnotation.BAR_GRAPH;
2022 alignment.addAnnotation(gapcounts);
2026 private void initConservation()
2028 if (showConservation)
2030 if (conservation == null)
2032 conservation = new AlignmentAnnotation("Conservation",
2033 MessageManager.formatMessage("label.conservation_descr",
2035 new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
2036 conservation.hasText = true;
2037 conservation.autoCalculated = true;
2038 alignment.addAnnotation(conservation);
2043 private void initQuality()
2047 if (quality == null)
2049 quality = new AlignmentAnnotation("Quality",
2050 MessageManager.getString("label.quality_descr"),
2051 new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
2052 quality.hasText = true;
2053 quality.autoCalculated = true;
2054 alignment.addAnnotation(quality);
2059 private void initRNAStructure()
2061 if (alignment.hasRNAStructure() && strucConsensus == null)
2063 strucConsensus = new AlignmentAnnotation("StrucConsensus",
2064 MessageManager.getString("label.strucconsensus_descr"),
2065 new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
2066 strucConsensus.hasText = true;
2067 strucConsensus.autoCalculated = true;
2071 alignment.addAnnotation(strucConsensus);
2079 * @see jalview.api.AlignViewportI#calcPanelHeight()
2082 public int calcPanelHeight()
2084 // setHeight of panels
2085 AlignmentAnnotation[] anns = getAlignment().getAlignmentAnnotation();
2087 int charHeight = getCharHeight();
2090 BitSet graphgrp = new BitSet();
2091 for (AlignmentAnnotation aa : anns)
2095 System.err.println("Null annotation row: ignoring.");
2102 if (aa.graphGroup > -1)
2104 if (graphgrp.get(aa.graphGroup))
2110 graphgrp.set(aa.graphGroup);
2117 aa.height += charHeight;
2127 aa.height += aa.graphHeight;
2135 height += aa.height;
2147 public void updateGroupAnnotationSettings(boolean applyGlobalSettings,
2148 boolean preserveNewGroupSettings)
2150 boolean updateCalcs = false;
2151 boolean conv = isShowGroupConservation();
2152 boolean cons = isShowGroupConsensus();
2153 boolean showprf = isShowSequenceLogo();
2154 boolean showConsHist = isShowConsensusHistogram();
2155 boolean normLogo = isNormaliseSequenceLogo();
2158 * TODO reorder the annotation rows according to group/sequence ordering on
2161 // boolean sortg = true;
2163 // remove old automatic annotation
2164 // add any new annotation
2166 // intersect alignment annotation with alignment groups
2168 AlignmentAnnotation[] aan = alignment.getAlignmentAnnotation();
2169 List<SequenceGroup> oldrfs = new ArrayList<>();
2172 for (int an = 0; an < aan.length; an++)
2174 if (aan[an].autoCalculated && aan[an].groupRef != null)
2176 oldrfs.add(aan[an].groupRef);
2177 alignment.deleteAnnotation(aan[an], false);
2181 if (alignment.getGroups() != null)
2183 for (SequenceGroup sg : alignment.getGroups())
2185 updateCalcs = false;
2186 if (applyGlobalSettings
2187 || (!preserveNewGroupSettings && !oldrfs.contains(sg)))
2189 // set defaults for this group's conservation/consensus
2190 sg.setshowSequenceLogo(showprf);
2191 sg.setShowConsensusHistogram(showConsHist);
2192 sg.setNormaliseSequenceLogo(normLogo);
2197 alignment.addAnnotation(sg.getConservationRow(), 0);
2202 alignment.addAnnotation(sg.getConsensus(), 0);
2204 // refresh the annotation rows
2207 sg.recalcConservation();
2215 public boolean isDisplayReferenceSeq()
2217 return alignment.hasSeqrep() && viewStyle.isDisplayReferenceSeq();
2221 public void setDisplayReferenceSeq(boolean displayReferenceSeq)
2223 viewStyle.setDisplayReferenceSeq(displayReferenceSeq);
2227 public boolean isColourByReferenceSeq()
2229 return alignment.hasSeqrep() && viewStyle.isColourByReferenceSeq();
2233 public Color getSequenceColour(SequenceI seq)
2235 Color sqc = sequenceColours.get(seq);
2236 return (sqc == null ? Color.white : sqc);
2240 public void setSequenceColour(SequenceI seq, Color col)
2244 sequenceColours.remove(seq);
2248 sequenceColours.put(seq, col);
2253 public void updateSequenceIdColours()
2255 for (SequenceGroup sg : alignment.getGroups())
2257 if (sg.idColour != null)
2259 for (SequenceI s : sg.getSequences(getHiddenRepSequences()))
2261 sequenceColours.put(s, sg.idColour);
2268 public void clearSequenceColours()
2270 sequenceColours.clear();
2274 public AlignViewportI getCodingComplement()
2276 return this.codingComplement;
2280 * Set this as the (cDna/protein) complement of the given viewport. Also
2281 * ensures the reverse relationship is set on the given viewport.
2284 public void setCodingComplement(AlignViewportI av)
2288 System.err.println("Ignoring recursive setCodingComplement request");
2292 this.codingComplement = av;
2293 // avoid infinite recursion!
2294 if (av.getCodingComplement() != this)
2296 av.setCodingComplement(this);
2302 public boolean isNucleotide()
2304 return getAlignment() == null ? false : getAlignment().isNucleotide();
2308 public FeaturesDisplayedI getFeaturesDisplayed()
2310 return featuresDisplayed;
2314 public void setFeaturesDisplayed(FeaturesDisplayedI featuresDisplayedI)
2316 featuresDisplayed = featuresDisplayedI;
2320 public boolean areFeaturesDisplayed()
2322 return featuresDisplayed != null
2323 && featuresDisplayed.getRegisteredFeaturesCount() > 0;
2330 * features are displayed if true
2333 public void setShowSequenceFeatures(boolean b)
2335 viewStyle.setShowSequenceFeatures(b);
2339 public boolean isShowSequenceFeatures()
2341 return viewStyle.isShowSequenceFeatures();
2345 public void setShowSequenceFeaturesHeight(boolean selected)
2347 viewStyle.setShowSequenceFeaturesHeight(selected);
2351 public boolean isShowSequenceFeaturesHeight()
2353 return viewStyle.isShowSequenceFeaturesHeight();
2357 public void setShowAnnotation(boolean b)
2359 viewStyle.setShowAnnotation(b);
2363 public boolean isShowAnnotation()
2365 return viewStyle.isShowAnnotation();
2369 public boolean isRightAlignIds()
2371 return viewStyle.isRightAlignIds();
2375 public void setRightAlignIds(boolean rightAlignIds)
2377 viewStyle.setRightAlignIds(rightAlignIds);
2381 public boolean getConservationSelected()
2383 return viewStyle.getConservationSelected();
2387 public void setShowBoxes(boolean state)
2389 viewStyle.setShowBoxes(state);
2394 * @see jalview.api.ViewStyleI#getTextColour()
2397 public Color getTextColour()
2399 return viewStyle.getTextColour();
2404 * @see jalview.api.ViewStyleI#getTextColour2()
2407 public Color getTextColour2()
2409 return viewStyle.getTextColour2();
2414 * @see jalview.api.ViewStyleI#getThresholdTextColour()
2417 public int getThresholdTextColour()
2419 return viewStyle.getThresholdTextColour();
2424 * @see jalview.api.ViewStyleI#isConservationColourSelected()
2427 public boolean isConservationColourSelected()
2429 return viewStyle.isConservationColourSelected();
2434 * @see jalview.api.ViewStyleI#isRenderGaps()
2437 public boolean isRenderGaps()
2439 return viewStyle.isRenderGaps();
2444 * @see jalview.api.ViewStyleI#isShowColourText()
2447 public boolean isShowColourText()
2449 return viewStyle.isShowColourText();
2453 * @param conservationColourSelected
2454 * @see jalview.api.ViewStyleI#setConservationColourSelected(boolean)
2457 public void setConservationColourSelected(
2458 boolean conservationColourSelected)
2460 viewStyle.setConservationColourSelected(conservationColourSelected);
2464 * @param showColourText
2465 * @see jalview.api.ViewStyleI#setShowColourText(boolean)
2468 public void setShowColourText(boolean showColourText)
2470 viewStyle.setShowColourText(showColourText);
2475 * @see jalview.api.ViewStyleI#setTextColour(java.awt.Color)
2478 public void setTextColour(Color textColour)
2480 viewStyle.setTextColour(textColour);
2484 * @param thresholdTextColour
2485 * @see jalview.api.ViewStyleI#setThresholdTextColour(int)
2488 public void setThresholdTextColour(int thresholdTextColour)
2490 viewStyle.setThresholdTextColour(thresholdTextColour);
2494 * @param textColour2
2495 * @see jalview.api.ViewStyleI#setTextColour2(java.awt.Color)
2498 public void setTextColour2(Color textColour2)
2500 viewStyle.setTextColour2(textColour2);
2504 public ViewStyleI getViewStyle()
2506 return new ViewStyle(viewStyle);
2510 public void setViewStyle(ViewStyleI settingsForView)
2512 viewStyle = new ViewStyle(settingsForView);
2513 if (residueShading != null)
2515 residueShading.setConservationApplied(
2516 settingsForView.isConservationColourSelected());
2521 public boolean sameStyle(ViewStyleI them)
2523 return viewStyle.sameStyle(them);
2528 * @see jalview.api.ViewStyleI#getIdWidth()
2531 public int getIdWidth()
2533 return viewStyle.getIdWidth();
2538 * @see jalview.api.ViewStyleI#setIdWidth(int)
2541 public void setIdWidth(int i)
2543 viewStyle.setIdWidth(i);
2548 * @see jalview.api.ViewStyleI#isCentreColumnLabels()
2551 public boolean isCentreColumnLabels()
2553 return viewStyle.isCentreColumnLabels();
2557 * @param centreColumnLabels
2558 * @see jalview.api.ViewStyleI#setCentreColumnLabels(boolean)
2561 public void setCentreColumnLabels(boolean centreColumnLabels)
2563 viewStyle.setCentreColumnLabels(centreColumnLabels);
2568 * @see jalview.api.ViewStyleI#setShowDBRefs(boolean)
2571 public void setShowDBRefs(boolean showdbrefs)
2573 viewStyle.setShowDBRefs(showdbrefs);
2578 * @see jalview.api.ViewStyleI#isShowDBRefs()
2581 public boolean isShowDBRefs()
2583 return viewStyle.isShowDBRefs();
2588 * @see jalview.api.ViewStyleI#isShowNPFeats()
2591 public boolean isShowNPFeats()
2593 return viewStyle.isShowNPFeats();
2597 * @param shownpfeats
2598 * @see jalview.api.ViewStyleI#setShowNPFeats(boolean)
2601 public void setShowNPFeats(boolean shownpfeats)
2603 viewStyle.setShowNPFeats(shownpfeats);
2606 public abstract StructureSelectionManager getStructureSelectionManager();
2609 * Add one command to the command history list.
2613 public void addToHistoryList(CommandI command)
2615 if (this.historyList != null)
2617 this.historyList.push(command);
2618 broadcastCommand(command, false);
2622 protected void broadcastCommand(CommandI command, boolean undo)
2624 getStructureSelectionManager().commandPerformed(command, undo,
2629 * Add one command to the command redo list.
2633 public void addToRedoList(CommandI command)
2635 if (this.redoList != null)
2637 this.redoList.push(command);
2639 broadcastCommand(command, true);
2643 * Clear the command redo list.
2645 public void clearRedoList()
2647 if (this.redoList != null)
2649 this.redoList.clear();
2653 public void setHistoryList(Deque<CommandI> list)
2655 this.historyList = list;
2658 public Deque<CommandI> getHistoryList()
2660 return this.historyList;
2663 public void setRedoList(Deque<CommandI> list)
2665 this.redoList = list;
2668 public Deque<CommandI> getRedoList()
2670 return this.redoList;
2674 public VamsasSource getVamsasSource()
2679 public SequenceAnnotationOrder getSortAnnotationsBy()
2681 return sortAnnotationsBy;
2684 public void setSortAnnotationsBy(
2685 SequenceAnnotationOrder sortAnnotationsBy)
2687 this.sortAnnotationsBy = sortAnnotationsBy;
2690 public boolean isShowAutocalculatedAbove()
2692 return showAutocalculatedAbove;
2695 public void setShowAutocalculatedAbove(boolean showAutocalculatedAbove)
2697 this.showAutocalculatedAbove = showAutocalculatedAbove;
2701 public boolean isScaleProteinAsCdna()
2703 return viewStyle.isScaleProteinAsCdna();
2707 public void setScaleProteinAsCdna(boolean b)
2709 viewStyle.setScaleProteinAsCdna(b);
2713 public boolean isProteinFontAsCdna()
2715 return viewStyle.isProteinFontAsCdna();
2719 public void setProteinFontAsCdna(boolean b)
2721 viewStyle.setProteinFontAsCdna(b);
2725 public void setShowComplementFeatures(boolean b)
2727 viewStyle.setShowComplementFeatures(b);
2731 public boolean isShowComplementFeatures()
2733 return viewStyle.isShowComplementFeatures();
2737 public void setShowComplementFeaturesOnTop(boolean b)
2739 viewStyle.setShowComplementFeaturesOnTop(b);
2743 public boolean isShowComplementFeaturesOnTop()
2745 return viewStyle.isShowComplementFeaturesOnTop();
2749 * @return true if view should scroll to show the highlighted region of a
2754 public final boolean isFollowHighlight()
2756 return followHighlight;
2760 public final void setFollowHighlight(boolean b)
2762 this.followHighlight = b;
2766 public ViewportRanges getRanges()
2772 * Helper method to populate the SearchResults with the location in the
2773 * complementary alignment to scroll to, in order to match this one.
2776 * the SearchResults to add to
2777 * @return the offset (below top of visible region) of the matched sequence
2779 protected int findComplementScrollTarget(SearchResultsI sr)
2781 final AlignViewportI complement = getCodingComplement();
2782 if (complement == null || !complement.isFollowHighlight())
2786 boolean iAmProtein = !getAlignment().isNucleotide();
2787 AlignmentI proteinAlignment = iAmProtein ? getAlignment()
2788 : complement.getAlignment();
2789 if (proteinAlignment == null)
2793 final List<AlignedCodonFrame> mappings = proteinAlignment
2797 * Heuristic: find the first mapped sequence (if any) with a non-gapped
2798 * residue in the middle column of the visible region. Scroll the
2799 * complementary alignment to line up the corresponding residue.
2802 SequenceI sequence = null;
2805 * locate 'middle' column (true middle if an odd number visible, left of
2806 * middle if an even number visible)
2808 int middleColumn = ranges.getStartRes()
2809 + (ranges.getEndRes() - ranges.getStartRes()) / 2;
2810 final HiddenSequences hiddenSequences = getAlignment()
2811 .getHiddenSequences();
2814 * searching to the bottom of the alignment gives smoother scrolling across
2815 * all gapped visible regions
2817 int lastSeq = alignment.getHeight() - 1;
2818 List<AlignedCodonFrame> seqMappings = null;
2819 for (int seqNo = ranges
2820 .getStartSeq(); seqNo <= lastSeq; seqNo++, seqOffset++)
2822 sequence = getAlignment().getSequenceAt(seqNo);
2823 if (hiddenSequences != null && hiddenSequences.isHidden(sequence))
2827 if (Comparison.isGap(sequence.getCharAt(middleColumn)))
2831 seqMappings = MappingUtils.findMappingsForSequenceAndOthers(sequence,
2833 getCodingComplement().getAlignment().getSequences());
2834 if (!seqMappings.isEmpty())
2840 if (sequence == null || seqMappings == null || seqMappings.isEmpty())
2843 * No ungapped mapped sequence in middle column - do nothing
2847 MappingUtils.addSearchResults(sr, sequence,
2848 sequence.findPosition(middleColumn), seqMappings);
2853 * synthesize a column selection if none exists so it covers the given
2854 * selection group. if wholewidth is false, no column selection is made if the
2855 * selection group covers the whole alignment width.
2860 public void expandColSelection(SequenceGroup sg, boolean wholewidth)
2863 if (sg != null && (sgs = sg.getStartRes()) >= 0
2864 && sg.getStartRes() <= (sge = sg.getEndRes())
2865 && !this.hasSelectedColumns())
2867 if (!wholewidth && alignment.getWidth() == (1 + sge - sgs))
2874 colSel = new ColumnSelection();
2876 for (int cspos = sg.getStartRes(); cspos <= sg.getEndRes(); cspos++)
2878 colSel.addElement(cspos);
2884 * hold status of current selection group - defined on alignment or not.
2886 private boolean selectionIsDefinedGroup = false;
2889 public boolean isSelectionDefinedGroup()
2891 if (selectionGroup == null)
2895 if (isSelectionGroupChanged(true))
2897 selectionIsDefinedGroup = false;
2898 List<SequenceGroup> gps = alignment.getGroups();
2899 if (gps == null || gps.size() == 0)
2901 selectionIsDefinedGroup = false;
2905 selectionIsDefinedGroup = gps.contains(selectionGroup);
2908 return selectionGroup.isDefined() || selectionIsDefinedGroup;
2912 * null, or currently highlighted results on this view
2914 private SearchResultsI searchResults = null;
2916 protected TreeModel currentTree = null;
2919 public boolean hasSearchResults()
2921 return searchResults != null;
2925 public void setSearchResults(SearchResultsI results)
2927 searchResults = results;
2931 public SearchResultsI getSearchResults()
2933 return searchResults;
2937 * get the consensus sequence as displayed under the PID consensus annotation
2940 * @return consensus sequence as a new sequence object
2942 public SequenceI getConsensusSeq()
2944 if (consensus == null)
2946 updateConsensus(null);
2948 if (consensus == null)
2952 StringBuffer seqs = new StringBuffer();
2953 for (int i = 0; i < consensus.annotations.length; i++)
2955 Annotation annotation = consensus.annotations[i];
2956 if (annotation != null)
2958 String description = annotation.description;
2959 if (description != null && description.startsWith("["))
2961 // consensus is a tie - just pick the first one
2962 seqs.append(description.charAt(1));
2966 seqs.append(annotation.displayCharacter);
2971 SequenceI sq = new Sequence("Consensus", seqs.toString());
2972 sq.setDescription("Percentage Identity Consensus "
2973 + ((ignoreGapsInConsensusCalculation) ? " without gaps" : ""));
2978 public void setCurrentTree(TreeModel tree)
2984 public TreeModel getCurrentTree()
2990 public AlignmentExportData getAlignExportData(AlignExportSettingsI options)
2992 AlignmentI alignmentToExport = null;
2993 String[] omitHidden = null;
2994 alignmentToExport = null;
2996 if (hasHiddenColumns() && !options.isExportHiddenColumns())
2998 omitHidden = getViewAsString(false,
2999 options.isExportHiddenSequences());
3002 int[] alignmentStartEnd = new int[2];
3003 if (hasHiddenRows() && options.isExportHiddenSequences())
3005 alignmentToExport = getAlignment().getHiddenSequences()
3006 .getFullAlignment();
3010 alignmentToExport = getAlignment();
3012 alignmentStartEnd = getAlignment().getHiddenColumns()
3013 .getVisibleStartAndEndIndex(alignmentToExport.getWidth());
3014 AlignmentExportData ed = new AlignmentExportData(alignmentToExport,
3015 omitHidden, alignmentStartEnd);
3020 * flag set to indicate if structure views might be out of sync with sequences
3024 private boolean needToUpdateStructureViews = false;
3027 public boolean isUpdateStructures()
3029 return needToUpdateStructureViews;
3033 public void setUpdateStructures(boolean update)
3035 needToUpdateStructureViews = update;
3039 public boolean needToUpdateStructureViews()
3041 boolean update = needToUpdateStructureViews;
3042 needToUpdateStructureViews = false;
3047 public void addSequenceGroup(SequenceGroup sequenceGroup)
3049 alignment.addGroup(sequenceGroup);
3051 Color col = sequenceGroup.idColour;
3054 col = col.brighter();
3056 for (SequenceI sq : sequenceGroup.getSequences())
3058 setSequenceColour(sq, col);
3062 if (codingComplement != null)
3064 SequenceGroup mappedGroup = MappingUtils
3065 .mapSequenceGroup(sequenceGroup, this, codingComplement);
3066 if (mappedGroup.getSequences().size() > 0)
3068 codingComplement.getAlignment().addGroup(mappedGroup);
3072 for (SequenceI seq : mappedGroup.getSequences())
3074 codingComplement.setSequenceColour(seq, col);
3078 // propagate the structure view update flag according to our own setting
3079 codingComplement.setUpdateStructures(needToUpdateStructureViews);
3084 public Iterator<int[]> getViewAsVisibleContigs(boolean selectedRegionOnly)
3088 if (selectedRegionOnly && selectionGroup != null)
3090 start = selectionGroup.getStartRes();
3091 end = selectionGroup.getEndRes() + 1;
3095 end = alignment.getWidth();
3097 return (alignment.getHiddenColumns().getVisContigsIterator(start, end,