src/jalview/viewmodel/AlignmentViewport.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21 package jalview.viewmodel;
  22
  23 import jalview.analysis.AnnotationSorter.SequenceAnnotationOrder;
  24 import jalview.analysis.Conservation;
  25 import jalview.api.AlignCalcManagerI;
  26 import jalview.api.AlignViewportI;
  27 import jalview.api.AlignmentViewPanel;
  28 import jalview.api.FeaturesDisplayedI;
  29 import jalview.api.ViewStyleI;
  30 import jalview.commands.CommandI;
  31 import jalview.datamodel.AlignedCodonFrame;
  32 import jalview.datamodel.AlignmentAnnotation;
  33 import jalview.datamodel.AlignmentI;
  34 import jalview.datamodel.AlignmentView;
  35 import jalview.datamodel.Annotation;
  36 import jalview.datamodel.CigarArray;
  37 import jalview.datamodel.ColumnSelection;
  38 import jalview.datamodel.HiddenColumns;
  39 import jalview.datamodel.HiddenSequences;
  40 import jalview.datamodel.ProfilesI;
  41 import jalview.datamodel.SearchResultsI;
  42 import jalview.datamodel.Sequence;
  43 import jalview.datamodel.SequenceCollectionI;
  44 import jalview.datamodel.SequenceGroup;
  45 import jalview.datamodel.SequenceI;
  46 import jalview.renderer.ResidueShader;
  47 import jalview.renderer.ResidueShaderI;
  48 import jalview.schemes.ColourSchemeI;
  49 import jalview.structure.CommandListener;
  50 import jalview.structure.StructureSelectionManager;
  51 import jalview.structure.VamsasSource;
  52 import jalview.util.Comparison;
  53 import jalview.util.MapList;
  54 import jalview.util.MappingUtils;
  55 import jalview.util.MessageManager;
  56 import jalview.viewmodel.styles.ViewStyle;
  57 import jalview.workers.AlignCalcManager;
  58 import jalview.workers.ComplementConsensusThread;
  59 import jalview.workers.ConsensusThread;
  60 import jalview.workers.StrucConsensusThread;
  61
  62 import java.awt.Color;
  63 import java.beans.PropertyChangeSupport;
  64 import java.util.ArrayDeque;
  65 import java.util.ArrayList;
  66 import java.util.BitSet;
  67 import java.util.Deque;
  68 import java.util.HashMap;
  69 import java.util.Hashtable;
  70 import java.util.List;
  71 import java.util.Map;
  72
  73 /**
  74  * base class holding visualization and analysis attributes and common logic for
  75  * an active alignment view displayed in the GUI
  76  *
  77  * @author jimp
  78  *
  79  */
  80 public abstract class AlignmentViewport implements AlignViewportI,
  81         CommandListener, VamsasSource
  82 {
  83   final protected ViewportRanges ranges;
  84
  85   protected ViewStyleI viewStyle = new ViewStyle();
  86
  87   /**
  88    * A viewport that hosts the cDna view of this (protein), or vice versa (if
  89    * set).
  90    */
  91   AlignViewportI codingComplement = null;
  92
  93   FeaturesDisplayedI featuresDisplayed = null;
  94
  95   protected Deque<CommandI> historyList = new ArrayDeque<>();
  96
  97   protected Deque<CommandI> redoList = new ArrayDeque<>();
  98
  99   /**
 100    * alignment displayed in the viewport. Please use get/setter
 101    */
 102   protected AlignmentI alignment;
 103
 104   public AlignmentViewport(AlignmentI al)
 105   {
 106     setAlignment(al);
 107     ranges = new ViewportRanges(al);
 108   }
 109
 110   /**
 111    * @param name
 112    * @see jalview.api.ViewStyleI#setFontName(java.lang.String)
 113    */
 114   @Override
 115   public void setFontName(String name)
 116   {
 117     viewStyle.setFontName(name);
 118   }
 119
 120   /**
 121    * @param style
 122    * @see jalview.api.ViewStyleI#setFontStyle(int)
 123    */
 124   @Override
 125   public void setFontStyle(int style)
 126   {
 127     viewStyle.setFontStyle(style);
 128   }
 129
 130   /**
 131    * @param size
 132    * @see jalview.api.ViewStyleI#setFontSize(int)
 133    */
 134   @Override
 135   public void setFontSize(int size)
 136   {
 137     viewStyle.setFontSize(size);
 138   }
 139
 140   /**
 141    * @return
 142    * @see jalview.api.ViewStyleI#getFontStyle()
 143    */
 144   @Override
 145   public int getFontStyle()
 146   {
 147     return viewStyle.getFontStyle();
 148   }
 149
 150   /**
 151    * @return
 152    * @see jalview.api.ViewStyleI#getFontName()
 153    */
 154   @Override
 155   public String getFontName()
 156   {
 157     return viewStyle.getFontName();
 158   }
 159
 160   /**
 161    * @return
 162    * @see jalview.api.ViewStyleI#getFontSize()
 163    */
 164   @Override
 165   public int getFontSize()
 166   {
 167     return viewStyle.getFontSize();
 168   }
 169
 170   /**
 171    * @param upperCasebold
 172    * @see jalview.api.ViewStyleI#setUpperCasebold(boolean)
 173    */
 174   @Override
 175   public void setUpperCasebold(boolean upperCasebold)
 176   {
 177     viewStyle.setUpperCasebold(upperCasebold);
 178   }
 179
 180   /**
 181    * @return
 182    * @see jalview.api.ViewStyleI#isUpperCasebold()
 183    */
 184   @Override
 185   public boolean isUpperCasebold()
 186   {
 187     return viewStyle.isUpperCasebold();
 188   }
 189
 190   /**
 191    * @return
 192    * @see jalview.api.ViewStyleI#isSeqNameItalics()
 193    */
 194   @Override
 195   public boolean isSeqNameItalics()
 196   {
 197     return viewStyle.isSeqNameItalics();
 198   }
 199
 200   /**
 201    * @param colourByReferenceSeq
 202    * @see jalview.api.ViewStyleI#setColourByReferenceSeq(boolean)
 203    */
 204   @Override
 205   public void setColourByReferenceSeq(boolean colourByReferenceSeq)
 206   {
 207     viewStyle.setColourByReferenceSeq(colourByReferenceSeq);
 208   }
 209
 210   /**
 211    * @param b
 212    * @see jalview.api.ViewStyleI#setColourAppliesToAllGroups(boolean)
 213    */
 214   @Override
 215   public void setColourAppliesToAllGroups(boolean b)
 216   {
 217     viewStyle.setColourAppliesToAllGroups(b);
 218   }
 219
 220   /**
 221    * @return
 222    * @see jalview.api.ViewStyleI#getColourAppliesToAllGroups()
 223    */
 224   @Override
 225   public boolean getColourAppliesToAllGroups()
 226   {
 227     return viewStyle.getColourAppliesToAllGroups();
 228   }
 229
 230   /**
 231    * @return
 232    * @see jalview.api.ViewStyleI#getAbovePIDThreshold()
 233    */
 234   @Override
 235   public boolean getAbovePIDThreshold()
 236   {
 237     return viewStyle.getAbovePIDThreshold();
 238   }
 239
 240   /**
 241    * @param inc
 242    * @see jalview.api.ViewStyleI#setIncrement(int)
 243    */
 244   @Override
 245   public void setIncrement(int inc)
 246   {
 247     viewStyle.setIncrement(inc);
 248   }
 249
 250   /**
 251    * @return
 252    * @see jalview.api.ViewStyleI#getIncrement()
 253    */
 254   @Override
 255   public int getIncrement()
 256   {
 257     return viewStyle.getIncrement();
 258   }
 259
 260   /**
 261    * @param b
 262    * @see jalview.api.ViewStyleI#setConservationSelected(boolean)
 263    */
 264   @Override
 265   public void setConservationSelected(boolean b)
 266   {
 267     viewStyle.setConservationSelected(b);
 268   }
 269
 270   /**
 271    * @param show
 272    * @see jalview.api.ViewStyleI#setShowHiddenMarkers(boolean)
 273    */
 274   @Override
 275   public void setShowHiddenMarkers(boolean show)
 276   {
 277     viewStyle.setShowHiddenMarkers(show);
 278   }
 279
 280   /**
 281    * @return
 282    * @see jalview.api.ViewStyleI#getShowHiddenMarkers()
 283    */
 284   @Override
 285   public boolean getShowHiddenMarkers()
 286   {
 287     return viewStyle.getShowHiddenMarkers();
 288   }
 289
 290   /**
 291    * @param b
 292    * @see jalview.api.ViewStyleI#setScaleRightWrapped(boolean)
 293    */
 294   @Override
 295   public void setScaleRightWrapped(boolean b)
 296   {
 297     viewStyle.setScaleRightWrapped(b);
 298   }
 299
 300   /**
 301    * @param b
 302    * @see jalview.api.ViewStyleI#setScaleLeftWrapped(boolean)
 303    */
 304   @Override
 305   public void setScaleLeftWrapped(boolean b)
 306   {
 307     viewStyle.setScaleLeftWrapped(b);
 308   }
 309
 310   /**
 311    * @param b
 312    * @see jalview.api.ViewStyleI#setScaleAboveWrapped(boolean)
 313    */
 314   @Override
 315   public void setScaleAboveWrapped(boolean b)
 316   {
 317     viewStyle.setScaleAboveWrapped(b);
 318   }
 319
 320   /**
 321    * @return
 322    * @see jalview.api.ViewStyleI#getScaleLeftWrapped()
 323    */
 324   @Override
 325   public boolean getScaleLeftWrapped()
 326   {
 327     return viewStyle.getScaleLeftWrapped();
 328   }
 329
 330   /**
 331    * @return
 332    * @see jalview.api.ViewStyleI#getScaleAboveWrapped()
 333    */
 334   @Override
 335   public boolean getScaleAboveWrapped()
 336   {
 337     return viewStyle.getScaleAboveWrapped();
 338   }
 339
 340   /**
 341    * @return
 342    * @see jalview.api.ViewStyleI#getScaleRightWrapped()
 343    */
 344   @Override
 345   public boolean getScaleRightWrapped()
 346   {
 347     return viewStyle.getScaleRightWrapped();
 348   }
 349
 350   /**
 351    * @param b
 352    * @see jalview.api.ViewStyleI#setAbovePIDThreshold(boolean)
 353    */
 354   @Override
 355   public void setAbovePIDThreshold(boolean b)
 356   {
 357     viewStyle.setAbovePIDThreshold(b);
 358   }
 359
 360   /**
 361    * @param thresh
 362    * @see jalview.api.ViewStyleI#setThreshold(int)
 363    */
 364   @Override
 365   public void setThreshold(int thresh)
 366   {
 367     viewStyle.setThreshold(thresh);
 368   }
 369
 370   /**
 371    * @return
 372    * @see jalview.api.ViewStyleI#getThreshold()
 373    */
 374   @Override
 375   public int getThreshold()
 376   {
 377     return viewStyle.getThreshold();
 378   }
 379
 380   /**
 381    * @return
 382    * @see jalview.api.ViewStyleI#getShowJVSuffix()
 383    */
 384   @Override
 385   public boolean getShowJVSuffix()
 386   {
 387     return viewStyle.getShowJVSuffix();
 388   }
 389
 390   /**
 391    * @param b
 392    * @see jalview.api.ViewStyleI#setShowJVSuffix(boolean)
 393    */
 394   @Override
 395   public void setShowJVSuffix(boolean b)
 396   {
 397     viewStyle.setShowJVSuffix(b);
 398   }
 399
 400   /**
 401    * @param state
 402    * @see jalview.api.ViewStyleI#setWrapAlignment(boolean)
 403    */
 404   @Override
 405   public void setWrapAlignment(boolean state)
 406   {
 407     viewStyle.setWrapAlignment(state);
 408     ranges.setWrappedMode(state);
 409   }
 410
 411   /**
 412    * @param state
 413    * @see jalview.api.ViewStyleI#setShowText(boolean)
 414    */
 415   @Override
 416   public void setShowText(boolean state)
 417   {
 418     viewStyle.setShowText(state);
 419   }
 420
 421   /**
 422    * @param state
 423    * @see jalview.api.ViewStyleI#setRenderGaps(boolean)
 424    */
 425   @Override
 426   public void setRenderGaps(boolean state)
 427   {
 428     viewStyle.setRenderGaps(state);
 429   }
 430
 431   /**
 432    * @return
 433    * @see jalview.api.ViewStyleI#getColourText()
 434    */
 435   @Override
 436   public boolean getColourText()
 437   {
 438     return viewStyle.getColourText();
 439   }
 440
 441   /**
 442    * @param state
 443    * @see jalview.api.ViewStyleI#setColourText(boolean)
 444    */
 445   @Override
 446   public void setColourText(boolean state)
 447   {
 448     viewStyle.setColourText(state);
 449   }
 450
 451   /**
 452    * @return
 453    * @see jalview.api.ViewStyleI#getWrapAlignment()
 454    */
 455   @Override
 456   public boolean getWrapAlignment()
 457   {
 458     return viewStyle.getWrapAlignment();
 459   }
 460
 461   /**
 462    * @return
 463    * @see jalview.api.ViewStyleI#getShowText()
 464    */
 465   @Override
 466   public boolean getShowText()
 467   {
 468     return viewStyle.getShowText();
 469   }
 470
 471   /**
 472    * @return
 473    * @see jalview.api.ViewStyleI#getWrappedWidth()
 474    */
 475   @Override
 476   public int getWrappedWidth()
 477   {
 478     return viewStyle.getWrappedWidth();
 479   }
 480
 481   /**
 482    * @param w
 483    * @see jalview.api.ViewStyleI#setWrappedWidth(int)
 484    */
 485   @Override
 486   public void setWrappedWidth(int w)
 487   {
 488     viewStyle.setWrappedWidth(w);
 489   }
 490
 491   /**
 492    * @return
 493    * @see jalview.api.ViewStyleI#getCharHeight()
 494    */
 495   @Override
 496   public int getCharHeight()
 497   {
 498     return viewStyle.getCharHeight();
 499   }
 500
 501   /**
 502    * @param h
 503    * @see jalview.api.ViewStyleI#setCharHeight(int)
 504    */
 505   @Override
 506   public void setCharHeight(int h)
 507   {
 508     viewStyle.setCharHeight(h);
 509   }
 510
 511   /**
 512    * @return
 513    * @see jalview.api.ViewStyleI#getCharWidth()
 514    */
 515   @Override
 516   public int getCharWidth()
 517   {
 518     return viewStyle.getCharWidth();
 519   }
 520
 521   /**
 522    * @param w
 523    * @see jalview.api.ViewStyleI#setCharWidth(int)
 524    */
 525   @Override
 526   public void setCharWidth(int w)
 527   {
 528     viewStyle.setCharWidth(w);
 529   }
 530
 531   /**
 532    * @return
 533    * @see jalview.api.ViewStyleI#getShowBoxes()
 534    */
 535   @Override
 536   public boolean getShowBoxes()
 537   {
 538     return viewStyle.getShowBoxes();
 539   }
 540
 541   /**
 542    * @return
 543    * @see jalview.api.ViewStyleI#getShowUnconserved()
 544    */
 545   @Override
 546   public boolean getShowUnconserved()
 547   {
 548     return viewStyle.getShowUnconserved();
 549   }
 550
 551   /**
 552    * @param showunconserved
 553    * @see jalview.api.ViewStyleI#setShowUnconserved(boolean)
 554    */
 555   @Override
 556   public void setShowUnconserved(boolean showunconserved)
 557   {
 558     viewStyle.setShowUnconserved(showunconserved);
 559   }
 560
 561   /**
 562    * @param default1
 563    * @see jalview.api.ViewStyleI#setSeqNameItalics(boolean)
 564    */
 565   @Override
 566   public void setSeqNameItalics(boolean default1)
 567   {
 568     viewStyle.setSeqNameItalics(default1);
 569   }
 570
 571
 572
 573   @Override
 574   public AlignmentI getAlignment()
 575   {
 576     return alignment;
 577   }
 578
 579   @Override
 580   public char getGapCharacter()
 581   {
 582     return alignment.getGapCharacter();
 583   }
 584
 585   protected String sequenceSetID;
 586
 587   /**
 588    * probably unused indicator that view is of a dataset rather than an
 589    * alignment
 590    */
 591   protected boolean isDataset = false;
 592
 593   public void setDataset(boolean b)
 594   {
 595     isDataset = b;
 596   }
 597
 598   public boolean isDataset()
 599   {
 600     return isDataset;
 601   }
 602
 603   private Map<SequenceI, SequenceCollectionI> hiddenRepSequences;
 604
 605   protected ColumnSelection colSel = new ColumnSelection();
 606
 607   public boolean autoCalculateConsensus = true;
 608
 609   protected boolean autoCalculateStrucConsensus = true;
 610
 611   protected boolean ignoreGapsInConsensusCalculation = false;
 612
 613   protected ResidueShaderI residueShading = new ResidueShader();
 614
 615   @Override
 616   public void setGlobalColourScheme(ColourSchemeI cs)
 617   {
 618     // TODO: logic refactored from AlignFrame changeColour -
 619     // TODO: autorecalc stuff should be changed to rely on the worker system
 620     // check to see if we should implement a changeColour(cs) method rather than
 621     // put the logic in here
 622     // - means that caller decides if they want to just modify state and defer
 623     // calculation till later or to do all calculations in thread.
 624     // via changecolour
 625
 626     /*
 627      * only instantiate alignment colouring once, thereafter update it;
 628      * this means that any conservation or PID threshold settings
 629      * persist when the alignment colour scheme is changed
 630      */
 631     if (residueShading == null)
 632     {
 633       residueShading = new ResidueShader(viewStyle);
 634     }
 635     residueShading.setColourScheme(cs);
 636
 637     // TODO: do threshold and increment belong in ViewStyle or ResidueShader?
 638     // ...problem: groups need these, but do not currently have a ViewStyle
 639
 640     if (cs != null)
 641     {
 642       if (getConservationSelected())
 643       {
 644         residueShading.setConservation(hconservation);
 645       }
 646       residueShading.alignmentChanged(alignment, hiddenRepSequences);
 647     }
 648
 649     /*
 650      * if 'apply colour to all groups' is selected... do so
 651      * (but don't transfer any colour threshold settings to groups)
 652      */
 653     if (getColourAppliesToAllGroups())
 654     {
 655       for (SequenceGroup sg : getAlignment().getGroups())
 656       {
 657         /*
 658          * retain any colour thresholds per group while
 659          * changing choice of colour scheme (JAL-2386)
 660          */
 661         sg.setColourScheme(cs);
 662         if (cs != null)
 663         {
 664           sg.getGroupColourScheme()
 665                   .alignmentChanged(sg, hiddenRepSequences);
 666         }
 667       }
 668     }
 669   }
 670
 671   @Override
 672   public ColourSchemeI getGlobalColourScheme()
 673   {
 674     return residueShading == null ? null : residueShading
 675             .getColourScheme();
 676   }
 677
 678   @Override
 679   public ResidueShaderI getResidueShading()
 680   {
 681     return residueShading;
 682   }
 683
 684   protected AlignmentAnnotation consensus;
 685
 686   protected AlignmentAnnotation complementConsensus;
 687
 688   protected AlignmentAnnotation gapcounts;
 689
 690   protected AlignmentAnnotation strucConsensus;
 691
 692   protected AlignmentAnnotation conservation;
 693
 694   protected AlignmentAnnotation quality;
 695
 696   protected AlignmentAnnotation[] groupConsensus;
 697
 698   protected AlignmentAnnotation[] groupConservation;
 699
 700   /**
 701    * results of alignment consensus analysis for visible portion of view
 702    */
 703   protected ProfilesI hconsensus = null;
 704
 705   /**
 706    * results of cDNA complement consensus visible portion of view
 707    */
 708   protected Hashtable[] hcomplementConsensus = null;
 709
 710   /**
 711    * results of secondary structure base pair consensus for visible portion of
 712    * view
 713    */
 714   protected Hashtable[] hStrucConsensus = null;
 715
 716   protected Conservation hconservation = null;
 717
 718   @Override
 719   public void setConservation(Conservation cons)
 720   {
 721     hconservation = cons;
 722   }
 723
 724   /**
 725    * percentage gaps allowed in a column before all amino acid properties should
 726    * be considered unconserved
 727    */
 728   int ConsPercGaps = 25; // JBPNote : This should be a scalable property!
 729
 730   @Override
 731   public int getConsPercGaps()
 732   {
 733     return ConsPercGaps;
 734   }
 735
 736   @Override
 737   public void setSequenceConsensusHash(ProfilesI hconsensus)
 738   {
 739     this.hconsensus = hconsensus;
 740   }
 741
 742   @Override
 743   public void setComplementConsensusHash(Hashtable[] hconsensus)
 744   {
 745     this.hcomplementConsensus = hconsensus;
 746   }
 747
 748   @Override
 749   public ProfilesI getSequenceConsensusHash()
 750   {
 751     return hconsensus;
 752   }
 753
 754   @Override
 755   public Hashtable[] getComplementConsensusHash()
 756   {
 757     return hcomplementConsensus;
 758   }
 759
 760   @Override
 761   public Hashtable[] getRnaStructureConsensusHash()
 762   {
 763     return hStrucConsensus;
 764   }
 765
 766   @Override
 767   public void setRnaStructureConsensusHash(Hashtable[] hStrucConsensus)
 768   {
 769     this.hStrucConsensus = hStrucConsensus;
 770
 771   }
 772
 773   @Override
 774   public AlignmentAnnotation getAlignmentQualityAnnot()
 775   {
 776     return quality;
 777   }
 778
 779   @Override
 780   public AlignmentAnnotation getAlignmentConservationAnnotation()
 781   {
 782     return conservation;
 783   }
 784
 785   @Override
 786   public AlignmentAnnotation getAlignmentConsensusAnnotation()
 787   {
 788     return consensus;
 789   }
 790
 791   @Override
 792   public AlignmentAnnotation getAlignmentGapAnnotation()
 793   {
 794     return gapcounts;
 795   }
 796
 797   @Override
 798   public AlignmentAnnotation getComplementConsensusAnnotation()
 799   {
 800     return complementConsensus;
 801   }
 802
 803   @Override
 804   public AlignmentAnnotation getAlignmentStrucConsensusAnnotation()
 805   {
 806     return strucConsensus;
 807   }
 808
 809   protected AlignCalcManagerI calculator = new AlignCalcManager();
 810
 811   /**
 812    * trigger update of conservation annotation
 813    */
 814   public void updateConservation(final AlignmentViewPanel ap)
 815   {
 816     // see note in mantis : issue number 8585
 817     if (alignment.isNucleotide()
 818             || (conservation == null && quality == null)
 819             || !autoCalculateConsensus)
 820     {
 821       return;
 822     }
 823     if (calculator
 824             .getRegisteredWorkersOfClass(jalview.workers.ConservationThread.class) == null)
 825     {
 826       calculator.registerWorker(new jalview.workers.ConservationThread(
 827               this, ap));
 828     }
 829   }
 830
 831   /**
 832    * trigger update of consensus annotation
 833    */
 834   public void updateConsensus(final AlignmentViewPanel ap)
 835   {
 836     // see note in mantis : issue number 8585
 837     if (consensus == null || !autoCalculateConsensus)
 838     {
 839       return;
 840     }
 841     if (calculator.getRegisteredWorkersOfClass(ConsensusThread.class) == null)
 842     {
 843       calculator.registerWorker(new ConsensusThread(this, ap));
 844     }
 845
 846     /*
 847      * A separate thread to compute cDNA consensus for a protein alignment
 848      * which has mapping to cDNA
 849      */
 850     final AlignmentI al = this.getAlignment();
 851     if (!al.isNucleotide() && al.getCodonFrames() != null
 852             && !al.getCodonFrames().isEmpty())
 853     {
 854       /*
 855        * fudge - check first for protein-to-nucleotide mappings
 856        * (we don't want to do this for protein-to-protein)
 857        */
 858       boolean doConsensus = false;
 859       for (AlignedCodonFrame mapping : al.getCodonFrames())
 860       {
 861         // TODO hold mapping type e.g. dna-to-protein in AlignedCodonFrame?
 862         MapList[] mapLists = mapping.getdnaToProt();
 863         // mapLists can be empty if project load has not finished resolving seqs
 864         if (mapLists.length > 0 && mapLists[0].getFromRatio() == 3)
 865         {
 866           doConsensus = true;
 867           break;
 868         }
 869       }
 870       if (doConsensus)
 871       {
 872         if (calculator
 873                 .getRegisteredWorkersOfClass(ComplementConsensusThread.class) == null)
 874         {
 875           calculator
 876                   .registerWorker(new ComplementConsensusThread(this, ap));
 877         }
 878       }
 879     }
 880   }
 881
 882   // --------START Structure Conservation
 883   public void updateStrucConsensus(final AlignmentViewPanel ap)
 884   {
 885     if (autoCalculateStrucConsensus && strucConsensus == null
 886             && alignment.isNucleotide() && alignment.hasRNAStructure())
 887     {
 888       // secondary structure has been added - so init the consensus line
 889       initRNAStructure();
 890     }
 891
 892     // see note in mantis : issue number 8585
 893     if (strucConsensus == null || !autoCalculateStrucConsensus)
 894     {
 895       return;
 896     }
 897     if (calculator.getRegisteredWorkersOfClass(StrucConsensusThread.class) == null)
 898     {
 899       calculator.registerWorker(new StrucConsensusThread(this, ap));
 900     }
 901   }
 902
 903   public boolean isCalcInProgress()
 904   {
 905     return calculator.isWorking();
 906   }
 907
 908   @Override
 909   public boolean isCalculationInProgress(
 910           AlignmentAnnotation alignmentAnnotation)
 911   {
 912     if (!alignmentAnnotation.autoCalculated)
 913     {
 914       return false;
 915     }
 916     if (calculator.workingInvolvedWith(alignmentAnnotation))
 917     {
 918       // System.err.println("grey out ("+alignmentAnnotation.label+")");
 919       return true;
 920     }
 921     return false;
 922   }
 923
 924   public void setAlignment(AlignmentI align)
 925   {
 926     this.alignment = align;
 927   }
 928
 929   /**
 930    * Clean up references when this viewport is closed
 931    */
 932   @Override
 933   public void dispose()
 934   {
 935     /*
 936      * defensively null out references to large objects in case
 937      * this object is not garbage collected (as if!)
 938      */
 939     consensus = null;
 940     complementConsensus = null;
 941     strucConsensus = null;
 942     conservation = null;
 943     quality = null;
 944     groupConsensus = null;
 945     groupConservation = null;
 946     hconsensus = null;
 947     hcomplementConsensus = null;
 948     // colour scheme may hold reference to consensus
 949     residueShading = null;
 950     // TODO remove listeners from changeSupport?
 951     changeSupport = null;
 952     setAlignment(null);
 953   }
 954
 955   @Override
 956   public boolean isClosed()
 957   {
 958     // TODO: check that this isClosed is only true after panel is closed, not
 959     // before it is fully constructed.
 960     return alignment == null;
 961   }
 962
 963   @Override
 964   public AlignCalcManagerI getCalcManager()
 965   {
 966     return calculator;
 967   }
 968
 969   /**
 970    * should conservation rows be shown for groups
 971    */
 972   protected boolean showGroupConservation = false;
 973
 974   /**
 975    * should consensus rows be shown for groups
 976    */
 977   protected boolean showGroupConsensus = false;
 978
 979   /**
 980    * should consensus profile be rendered by default
 981    */
 982   protected boolean showSequenceLogo = false;
 983
 984   /**
 985    * should consensus profile be rendered normalised to row height
 986    */
 987   protected boolean normaliseSequenceLogo = false;
 988
 989   /**
 990    * should consensus histograms be rendered by default
 991    */
 992   protected boolean showConsensusHistogram = true;
 993
 994   /**
 995    * @return the showConsensusProfile
 996    */
 997   @Override
 998   public boolean isShowSequenceLogo()
 999   {
1000     return showSequenceLogo;
1001   }
1002
1003   /**
1004    * @param showSequenceLogo
1005    *          the new value
1006    */
1007   public void setShowSequenceLogo(boolean showSequenceLogo)
1008   {
1009     if (showSequenceLogo != this.showSequenceLogo)
1010     {
1011       // TODO: decouple settings setting from calculation when refactoring
1012       // annotation update method from alignframe to viewport
1013       this.showSequenceLogo = showSequenceLogo;
1014       calculator.updateAnnotationFor(ConsensusThread.class);
1015       calculator.updateAnnotationFor(ComplementConsensusThread.class);
1016       calculator.updateAnnotationFor(StrucConsensusThread.class);
1017     }
1018     this.showSequenceLogo = showSequenceLogo;
1019   }
1020
1021   /**
1022    * @param showConsensusHistogram
1023    *          the showConsensusHistogram to set
1024    */
1025   public void setShowConsensusHistogram(boolean showConsensusHistogram)
1026   {
1027     this.showConsensusHistogram = showConsensusHistogram;
1028   }
1029
1030   /**
1031    * @return the showGroupConservation
1032    */
1033   public boolean isShowGroupConservation()
1034   {
1035     return showGroupConservation;
1036   }
1037
1038   /**
1039    * @param showGroupConservation
1040    *          the showGroupConservation to set
1041    */
1042   public void setShowGroupConservation(boolean showGroupConservation)
1043   {
1044     this.showGroupConservation = showGroupConservation;
1045   }
1046
1047   /**
1048    * @return the showGroupConsensus
1049    */
1050   public boolean isShowGroupConsensus()
1051   {
1052     return showGroupConsensus;
1053   }
1054
1055   /**
1056    * @param showGroupConsensus
1057    *          the showGroupConsensus to set
1058    */
1059   public void setShowGroupConsensus(boolean showGroupConsensus)
1060   {
1061     this.showGroupConsensus = showGroupConsensus;
1062   }
1063
1064   /**
1065    *
1066    * @return flag to indicate if the consensus histogram should be rendered by
1067    *         default
1068    */
1069   @Override
1070   public boolean isShowConsensusHistogram()
1071   {
1072     return this.showConsensusHistogram;
1073   }
1074
1075   /**
1076    * when set, updateAlignment will always ensure sequences are of equal length
1077    */
1078   private boolean padGaps = false;
1079
1080   /**
1081    * when set, alignment should be reordered according to a newly opened tree
1082    */
1083   public boolean sortByTree = false;
1084
1085   /**
1086    *
1087    *
1088    * @return null or the currently selected sequence region
1089    */
1090   @Override
1091   public SequenceGroup getSelectionGroup()
1092   {
1093     return selectionGroup;
1094   }
1095
1096   /**
1097    * Set the selection group for this window. Also sets the current alignment as
1098    * the context for the group, if it does not already have one.
1099    *
1100    * @param sg
1101    *          - group holding references to sequences in this alignment view
1102    *
1103    */
1104   @Override
1105   public void setSelectionGroup(SequenceGroup sg)
1106   {
1107     selectionGroup = sg;
1108     if (sg != null && sg.getContext() == null)
1109     {
1110       sg.setContext(alignment);
1111     }
1112   }
1113
1114   public void setHiddenColumns(HiddenColumns hidden)
1115   {
1116     this.alignment.setHiddenColumns(hidden);
1117   }
1118
1119   @Override
1120   public ColumnSelection getColumnSelection()
1121   {
1122     return colSel;
1123   }
1124
1125   @Override
1126   public void setColumnSelection(ColumnSelection colSel)
1127   {
1128     this.colSel = colSel;
1129     if (colSel != null)
1130     {
1131       updateHiddenColumns();
1132     }
1133     isColSelChanged(true);
1134   }
1135
1136   /**
1137    *
1138    * @return
1139    */
1140   @Override
1141   public Map<SequenceI, SequenceCollectionI> getHiddenRepSequences()
1142   {
1143     return hiddenRepSequences;
1144   }
1145
1146   @Override
1147   public void setHiddenRepSequences(
1148           Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
1149   {
1150     this.hiddenRepSequences = hiddenRepSequences;
1151   }
1152
1153   @Override
1154   public boolean hasSelectedColumns()
1155   {
1156     ColumnSelection columnSelection = getColumnSelection();
1157     return columnSelection != null && columnSelection.hasSelectedColumns();
1158   }
1159
1160   @Override
1161   public boolean hasHiddenColumns()
1162   {
1163     return alignment.getHiddenColumns() != null
1164             && alignment.getHiddenColumns().hasHiddenColumns();
1165   }
1166
1167   public void updateHiddenColumns()
1168   {
1169     // this method doesn't really do anything now. But - it could, since a
1170     // column Selection could be in the process of modification
1171     // hasHiddenColumns = colSel.hasHiddenColumns();
1172   }
1173
1174   @Override
1175   public boolean hasHiddenRows()
1176   {
1177     return alignment.getHiddenSequences().getSize() > 0;
1178   }
1179
1180   protected SequenceGroup selectionGroup;
1181
1182   public void setSequenceSetId(String newid)
1183   {
1184     if (sequenceSetID != null)
1185     {
1186       System.err
1187               .println("Warning - overwriting a sequenceSetId for a viewport!");
1188     }
1189     sequenceSetID = new String(newid);
1190   }
1191
1192   @Override
1193   public String getSequenceSetId()
1194   {
1195     if (sequenceSetID == null)
1196     {
1197       sequenceSetID = alignment.hashCode() + "";
1198     }
1199
1200     return sequenceSetID;
1201   }
1202
1203   /**
1204    * unique viewId for synchronizing state (e.g. with stored Jalview Project)
1205    *
1206    */
1207   protected String viewId = null;
1208
1209   @Override
1210   public String getViewId()
1211   {
1212     if (viewId == null)
1213     {
1214       viewId = this.getSequenceSetId() + "." + this.hashCode() + "";
1215     }
1216     return viewId;
1217   }
1218
1219   public void setIgnoreGapsConsensus(boolean b, AlignmentViewPanel ap)
1220   {
1221     ignoreGapsInConsensusCalculation = b;
1222     if (ap != null)
1223     {
1224       updateConsensus(ap);
1225       if (residueShading != null)
1226       {
1227         residueShading.setThreshold(residueShading.getThreshold(),
1228                 ignoreGapsInConsensusCalculation);
1229       }
1230     }
1231
1232   }
1233
1234   private long sgrouphash = -1, colselhash = -1;
1235
1236   /**
1237    * checks current SelectionGroup against record of last hash value, and
1238    * updates record.
1239    *
1240    * @param b
1241    *          update the record of last hash value
1242    *
1243    * @return true if SelectionGroup changed since last call (when b is true)
1244    */
1245   public boolean isSelectionGroupChanged(boolean b)
1246   {
1247     int hc = (selectionGroup == null || selectionGroup.getSize() == 0) ? -1
1248             : selectionGroup.hashCode();
1249     if (hc != -1 && hc != sgrouphash)
1250     {
1251       if (b)
1252       {
1253         sgrouphash = hc;
1254       }
1255       return true;
1256     }
1257     return false;
1258   }
1259
1260   /**
1261    * checks current colsel against record of last hash value, and optionally
1262    * updates record.
1263    *
1264    * @param b
1265    *          update the record of last hash value
1266    * @return true if colsel changed since last call (when b is true)
1267    */
1268   public boolean isColSelChanged(boolean b)
1269   {
1270     int hc = (colSel == null || colSel.isEmpty()) ? -1 : colSel.hashCode();
1271     if (hc != -1 && hc != colselhash)
1272     {
1273       if (b)
1274       {
1275         colselhash = hc;
1276       }
1277       return true;
1278     }
1279     return false;
1280   }
1281
1282   @Override
1283   public boolean isIgnoreGapsConsensus()
1284   {
1285     return ignoreGapsInConsensusCalculation;
1286   }
1287
1288   // property change stuff
1289   // JBPNote Prolly only need this in the applet version.
1290   private PropertyChangeSupport changeSupport = new PropertyChangeSupport(
1291           this);
1292
1293   protected boolean showConservation = true;
1294
1295   protected boolean showQuality = true;
1296
1297   protected boolean showConsensus = true;
1298
1299   protected boolean showOccupancy = true;
1300
1301   private Map<SequenceI, Color> sequenceColours = new HashMap<>();
1302
1303   protected SequenceAnnotationOrder sortAnnotationsBy = null;
1304
1305   protected boolean showAutocalculatedAbove;
1306
1307   /**
1308    * when set, view will scroll to show the highlighted position
1309    */
1310   private boolean followHighlight = true;
1311
1312   /**
1313    * Property change listener for changes in alignment
1314    *
1315    * @param listener
1316    *          DOCUMENT ME!
1317    */
1318   public void addPropertyChangeListener(
1319           java.beans.PropertyChangeListener listener)
1320   {
1321     changeSupport.addPropertyChangeListener(listener);
1322   }
1323
1324   /**
1325    * DOCUMENT ME!
1326    *
1327    * @param listener
1328    *          DOCUMENT ME!
1329    */
1330   public void removePropertyChangeListener(
1331           java.beans.PropertyChangeListener listener)
1332   {
1333     changeSupport.removePropertyChangeListener(listener);
1334   }
1335
1336   /**
1337    * Property change listener for changes in alignment
1338    *
1339    * @param prop
1340    *          DOCUMENT ME!
1341    * @param oldvalue
1342    *          DOCUMENT ME!
1343    * @param newvalue
1344    *          DOCUMENT ME!
1345    */
1346   public void firePropertyChange(String prop, Object oldvalue,
1347           Object newvalue)
1348   {
1349     changeSupport.firePropertyChange(prop, oldvalue, newvalue);
1350   }
1351
1352   // common hide/show column stuff
1353
1354   public void hideSelectedColumns()
1355   {
1356     if (colSel.isEmpty())
1357     {
1358       return;
1359     }
1360
1361     colSel.hideSelectedColumns(alignment);
1362     setSelectionGroup(null);
1363     isColSelChanged(true);
1364   }
1365
1366   public void hideColumns(int start, int end)
1367   {
1368     if (start == end)
1369     {
1370       colSel.hideSelectedColumns(start, alignment.getHiddenColumns());
1371     }
1372     else
1373     {
1374       alignment.getHiddenColumns().hideColumns(start, end);
1375     }
1376     isColSelChanged(true);
1377   }
1378
1379   public void showColumn(int col)
1380   {
1381     alignment.getHiddenColumns().revealHiddenColumns(col, colSel);
1382     isColSelChanged(true);
1383   }
1384
1385   public void showAllHiddenColumns()
1386   {
1387     alignment.getHiddenColumns().revealAllHiddenColumns(colSel);
1388     isColSelChanged(true);
1389   }
1390
1391   // common hide/show seq stuff
1392   public void showAllHiddenSeqs()
1393   {
1394     if (alignment.getHiddenSequences().getSize() > 0)
1395     {
1396       if (selectionGroup == null)
1397       {
1398         selectionGroup = new SequenceGroup();
1399         selectionGroup.setEndRes(alignment.getWidth() - 1);
1400       }
1401       List<SequenceI> tmp = alignment.getHiddenSequences().showAll(
1402               hiddenRepSequences);
1403       for (SequenceI seq : tmp)
1404       {
1405         selectionGroup.addSequence(seq, false);
1406         setSequenceAnnotationsVisible(seq, true);
1407       }
1408
1409       hiddenRepSequences = null;
1410
1411       ranges.setViewportStartAndHeight(0, alignment.getHeight());
1412       firePropertyChange("alignment", null, alignment.getSequences());
1413       // used to set hasHiddenRows/hiddenRepSequences here, after the property
1414       // changed event
1415       sendSelection();
1416     }
1417   }
1418
1419   public void showSequence(int index)
1420   {
1421     List<SequenceI> tmp = alignment.getHiddenSequences().showSequence(
1422             index, hiddenRepSequences);
1423     if (tmp.size() > 0)
1424     {
1425       if (selectionGroup == null)
1426       {
1427         selectionGroup = new SequenceGroup();
1428         selectionGroup.setEndRes(alignment.getWidth() - 1);
1429       }
1430
1431       for (SequenceI seq : tmp)
1432       {
1433         selectionGroup.addSequence(seq, false);
1434         setSequenceAnnotationsVisible(seq, true);
1435       }
1436       ranges.setViewportStartAndHeight(0, alignment.getHeight());
1437       firePropertyChange("alignment", null, alignment.getSequences());
1438       sendSelection();
1439     }
1440   }
1441
1442   public void hideAllSelectedSeqs()
1443   {
1444     if (selectionGroup == null || selectionGroup.getSize() < 1)
1445     {
1446       return;
1447     }
1448
1449     SequenceI[] seqs = selectionGroup.getSequencesInOrder(alignment);
1450
1451     hideSequence(seqs);
1452
1453     setSelectionGroup(null);
1454   }
1455
1456   public void hideSequence(SequenceI[] seq)
1457   {
1458     if (seq != null)
1459     {
1460       for (int i = 0; i < seq.length; i++)
1461       {
1462         alignment.getHiddenSequences().hideSequence(seq[i]);
1463         setSequenceAnnotationsVisible(seq[i], false);
1464       }
1465       ranges.setViewportStartAndHeight(0, alignment.getHeight());
1466       firePropertyChange("alignment", null, alignment.getSequences());
1467     }
1468   }
1469
1470   /**
1471    * Hides the specified sequence, or the sequences it represents
1472    *
1473    * @param sequence
1474    *          the sequence to hide, or keep as representative
1475    * @param representGroup
1476    *          if true, hide the current selection group except for the
1477    *          representative sequence
1478    */
1479   public void hideSequences(SequenceI sequence, boolean representGroup)
1480   {
1481     if (selectionGroup == null || selectionGroup.getSize() < 1)
1482     {
1483       hideSequence(new SequenceI[] { sequence });
1484       return;
1485     }
1486
1487     if (representGroup)
1488     {
1489       hideRepSequences(sequence, selectionGroup);
1490       setSelectionGroup(null);
1491       return;
1492     }
1493
1494     int gsize = selectionGroup.getSize();
1495     SequenceI[] hseqs = selectionGroup.getSequences().toArray(
1496             new SequenceI[gsize]);
1497
1498     hideSequence(hseqs);
1499     setSelectionGroup(null);
1500     sendSelection();
1501   }
1502
1503   /**
1504    * Set visibility for any annotations for the given sequence.
1505    *
1506    * @param sequenceI
1507    */
1508   protected void setSequenceAnnotationsVisible(SequenceI sequenceI,
1509           boolean visible)
1510   {
1511     AlignmentAnnotation[] anns = alignment.getAlignmentAnnotation();
1512     if (anns != null)
1513     {
1514       for (AlignmentAnnotation ann : anns)
1515       {
1516         if (ann.sequenceRef == sequenceI)
1517         {
1518           ann.visible = visible;
1519         }
1520       }
1521     }
1522   }
1523
1524   public void hideRepSequences(SequenceI repSequence, SequenceGroup sg)
1525   {
1526     int sSize = sg.getSize();
1527     if (sSize < 2)
1528     {
1529       return;
1530     }
1531
1532     if (hiddenRepSequences == null)
1533     {
1534       hiddenRepSequences = new Hashtable<>();
1535     }
1536
1537     hiddenRepSequences.put(repSequence, sg);
1538
1539     // Hide all sequences except the repSequence
1540     SequenceI[] seqs = new SequenceI[sSize - 1];
1541     int index = 0;
1542     for (int i = 0; i < sSize; i++)
1543     {
1544       if (sg.getSequenceAt(i) != repSequence)
1545       {
1546         if (index == sSize - 1)
1547         {
1548           return;
1549         }
1550
1551         seqs[index++] = sg.getSequenceAt(i);
1552       }
1553     }
1554     sg.setSeqrep(repSequence); // note: not done in 2.7applet
1555     sg.setHidereps(true); // note: not done in 2.7applet
1556     hideSequence(seqs);
1557
1558   }
1559
1560   /**
1561    *
1562    * @return null or the current reference sequence
1563    */
1564   public SequenceI getReferenceSeq()
1565   {
1566     return alignment.getSeqrep();
1567   }
1568
1569   /**
1570    * @param seq
1571    * @return true iff seq is the reference for the alignment
1572    */
1573   public boolean isReferenceSeq(SequenceI seq)
1574   {
1575     return alignment.getSeqrep() == seq;
1576   }
1577
1578   /**
1579    *
1580    * @param seq
1581    * @return true if there are sequences represented by this sequence that are
1582    *         currently hidden
1583    */
1584   public boolean isHiddenRepSequence(SequenceI seq)
1585   {
1586     return (hiddenRepSequences != null && hiddenRepSequences
1587             .containsKey(seq));
1588   }
1589
1590   /**
1591    *
1592    * @param seq
1593    * @return null or a sequence group containing the sequences that seq
1594    *         represents
1595    */
1596   public SequenceGroup getRepresentedSequences(SequenceI seq)
1597   {
1598     return (SequenceGroup) (hiddenRepSequences == null ? null
1599             : hiddenRepSequences.get(seq));
1600   }
1601
1602   @Override
1603   public int adjustForHiddenSeqs(int alignmentIndex)
1604   {
1605     return alignment.getHiddenSequences().adjustForHiddenSeqs(
1606             alignmentIndex);
1607   }
1608
1609   @Override
1610   public void invertColumnSelection()
1611   {
1612     colSel.invertColumnSelection(0, alignment.getWidth(), alignment);
1613   }
1614
1615   @Override
1616   public SequenceI[] getSelectionAsNewSequence()
1617   {
1618     SequenceI[] sequences;
1619     // JBPNote: Need to test jalviewLite.getSelectedSequencesAsAlignmentFrom -
1620     // this was the only caller in the applet for this method
1621     // JBPNote: in applet, this method returned references to the alignment
1622     // sequences, and it did not honour the presence/absence of annotation
1623     // attached to the alignment (probably!)
1624     if (selectionGroup == null || selectionGroup.getSize() == 0)
1625     {
1626       sequences = alignment.getSequencesArray();
1627       AlignmentAnnotation[] annots = alignment.getAlignmentAnnotation();
1628       for (int i = 0; i < sequences.length; i++)
1629       {
1630         // construct new sequence with subset of visible annotation
1631         sequences[i] = new Sequence(sequences[i], annots);
1632       }
1633     }
1634     else
1635     {
1636       sequences = selectionGroup.getSelectionAsNewSequences(alignment);
1637     }
1638
1639     return sequences;
1640   }
1641
1642   @Override
1643   public SequenceI[] getSequenceSelection()
1644   {
1645     SequenceI[] sequences = null;
1646     if (selectionGroup != null)
1647     {
1648       sequences = selectionGroup.getSequencesInOrder(alignment);
1649     }
1650     if (sequences == null)
1651     {
1652       sequences = alignment.getSequencesArray();
1653     }
1654     return sequences;
1655   }
1656
1657   @Override
1658   public CigarArray getViewAsCigars(boolean selectedRegionOnly)
1659   {
1660     return new CigarArray(alignment, alignment.getHiddenColumns(),
1661             (selectedRegionOnly ? selectionGroup : null));
1662   }
1663
1664   @Override
1665   public jalview.datamodel.AlignmentView getAlignmentView(
1666           boolean selectedOnly)
1667   {
1668     return getAlignmentView(selectedOnly, false);
1669   }
1670
1671   @Override
1672   public jalview.datamodel.AlignmentView getAlignmentView(
1673           boolean selectedOnly, boolean markGroups)
1674   {
1675     return new AlignmentView(alignment, alignment.getHiddenColumns(),
1676             selectionGroup, alignment.getHiddenColumns() != null
1677                     && alignment.getHiddenColumns().hasHiddenColumns(),
1678             selectedOnly,
1679             markGroups);
1680   }
1681
1682   @Override
1683   public String[] getViewAsString(boolean selectedRegionOnly)
1684   {
1685     return getViewAsString(selectedRegionOnly, true);
1686   }
1687
1688   @Override
1689   public String[] getViewAsString(boolean selectedRegionOnly,
1690           boolean exportHiddenSeqs)
1691   {
1692     String[] selection = null;
1693     SequenceI[] seqs = null;
1694     int i, iSize;
1695     int start = 0, end = 0;
1696     if (selectedRegionOnly && selectionGroup != null)
1697     {
1698       iSize = selectionGroup.getSize();
1699       seqs = selectionGroup.getSequencesInOrder(alignment);
1700       start = selectionGroup.getStartRes();
1701       end = selectionGroup.getEndRes() + 1;
1702     }
1703     else
1704     {
1705       if (hasHiddenRows() && exportHiddenSeqs)
1706       {
1707         AlignmentI fullAlignment = alignment.getHiddenSequences()
1708                 .getFullAlignment();
1709         iSize = fullAlignment.getHeight();
1710         seqs = fullAlignment.getSequencesArray();
1711         end = fullAlignment.getWidth();
1712       }
1713       else
1714       {
1715         iSize = alignment.getHeight();
1716         seqs = alignment.getSequencesArray();
1717         end = alignment.getWidth();
1718       }
1719     }
1720
1721     selection = new String[iSize];
1722     if (alignment.getHiddenColumns() != null
1723             && alignment.getHiddenColumns().hasHiddenColumns())
1724     {
1725       selection = alignment.getHiddenColumns().getVisibleSequenceStrings(
1726               start, end, seqs);
1727     }
1728     else
1729     {
1730       for (i = 0; i < iSize; i++)
1731       {
1732         selection[i] = seqs[i].getSequenceAsString(start, end);
1733       }
1734
1735     }
1736     return selection;
1737   }
1738
1739   @Override
1740   public List<int[]> getVisibleRegionBoundaries(int min, int max)
1741   {
1742     ArrayList<int[]> regions = new ArrayList<>();
1743     int start = min;
1744     int end = max;
1745
1746     do
1747     {
1748       HiddenColumns hidden = alignment.getHiddenColumns();
1749       if (hidden != null && hidden.hasHiddenColumns())
1750       {
1751         if (start == 0)
1752         {
1753           start = hidden.adjustForHiddenColumns(start);
1754         }
1755
1756         end = hidden.getHiddenBoundaryRight(start);
1757         if (start == end)
1758         {
1759           end = max;
1760         }
1761         if (end > max)
1762         {
1763           end = max;
1764         }
1765       }
1766
1767       regions.add(new int[] { start, end });
1768
1769       if (hidden != null && hidden.hasHiddenColumns())
1770       {
1771         start = hidden.adjustForHiddenColumns(end);
1772         start = hidden.getHiddenBoundaryLeft(start) + 1;
1773       }
1774     } while (end < max);
1775
1776     int[][] startEnd = new int[regions.size()][2];
1777
1778     return regions;
1779   }
1780
1781   @Override
1782   public List<AlignmentAnnotation> getVisibleAlignmentAnnotation(
1783           boolean selectedOnly)
1784   {
1785     ArrayList<AlignmentAnnotation> ala = new ArrayList<>();
1786     AlignmentAnnotation[] aa;
1787     if ((aa = alignment.getAlignmentAnnotation()) != null)
1788     {
1789       for (AlignmentAnnotation annot : aa)
1790       {
1791         AlignmentAnnotation clone = new AlignmentAnnotation(annot);
1792         if (selectedOnly && selectionGroup != null)
1793         {
1794           alignment.getHiddenColumns().makeVisibleAnnotation(
1795                   selectionGroup.getStartRes(),
1796                   selectionGroup.getEndRes(), clone);
1797         }
1798         else
1799         {
1800           alignment.getHiddenColumns().makeVisibleAnnotation(clone);
1801         }
1802         ala.add(clone);
1803       }
1804     }
1805     return ala;
1806   }
1807
1808   @Override
1809   public boolean isPadGaps()
1810   {
1811     return padGaps;
1812   }
1813
1814   @Override
1815   public void setPadGaps(boolean padGaps)
1816   {
1817     this.padGaps = padGaps;
1818   }
1819
1820   /**
1821    * apply any post-edit constraints and trigger any calculations needed after
1822    * an edit has been performed on the alignment
1823    *
1824    * @param ap
1825    */
1826   @Override
1827   public void alignmentChanged(AlignmentViewPanel ap)
1828   {
1829     if (isPadGaps())
1830     {
1831       alignment.padGaps();
1832     }
1833     if (autoCalculateConsensus)
1834     {
1835       updateConsensus(ap);
1836     }
1837     if (hconsensus != null && autoCalculateConsensus)
1838     {
1839       updateConservation(ap);
1840     }
1841     if (autoCalculateStrucConsensus)
1842     {
1843       updateStrucConsensus(ap);
1844     }
1845
1846     // Reset endRes of groups if beyond alignment width
1847     int alWidth = alignment.getWidth();
1848     List<SequenceGroup> groups = alignment.getGroups();
1849     if (groups != null)
1850     {
1851       for (SequenceGroup sg : groups)
1852       {
1853         if (sg.getEndRes() > alWidth)
1854         {
1855           sg.setEndRes(alWidth - 1);
1856         }
1857       }
1858     }
1859
1860     if (selectionGroup != null && selectionGroup.getEndRes() > alWidth)
1861     {
1862       selectionGroup.setEndRes(alWidth - 1);
1863     }
1864
1865     updateAllColourSchemes();
1866     calculator.restartWorkers();
1867     // alignment.adjustSequenceAnnotations();
1868   }
1869
1870   /**
1871    * reset scope and do calculations for all applied colourschemes on alignment
1872    */
1873   void updateAllColourSchemes()
1874   {
1875     ResidueShaderI rs = residueShading;
1876     if (rs != null)
1877     {
1878       rs.alignmentChanged(alignment, hiddenRepSequences);
1879
1880       rs.setConsensus(hconsensus);
1881       if (rs.conservationApplied())
1882       {
1883         rs.setConservation(Conservation.calculateConservation("All",
1884                 alignment.getSequences(), 0, alignment.getWidth(), false,
1885                 getConsPercGaps(), false));
1886       }
1887     }
1888
1889     for (SequenceGroup sg : alignment.getGroups())
1890     {
1891       if (sg.cs != null)
1892       {
1893         sg.cs.alignmentChanged(sg, hiddenRepSequences);
1894       }
1895       sg.recalcConservation();
1896     }
1897   }
1898
1899   protected void initAutoAnnotation()
1900   {
1901     // TODO: add menu option action that nulls or creates consensus object
1902     // depending on if the user wants to see the annotation or not in a
1903     // specific alignment
1904
1905     if (hconsensus == null && !isDataset)
1906     {
1907       if (!alignment.isNucleotide())
1908       {
1909         initConservation();
1910         initQuality();
1911       }
1912       else
1913       {
1914         initRNAStructure();
1915       }
1916       consensus = new AlignmentAnnotation("Consensus",
1917               MessageManager.getString("label.consensus_descr"),
1918               new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
1919       initConsensus(consensus);
1920       initGapCounts();
1921
1922       initComplementConsensus();
1923     }
1924   }
1925
1926   /**
1927    * If this is a protein alignment and there are mappings to cDNA, adds the
1928    * cDNA consensus annotation and returns true, else returns false.
1929    */
1930   public boolean initComplementConsensus()
1931   {
1932     if (!alignment.isNucleotide())
1933     {
1934       final List<AlignedCodonFrame> codonMappings = alignment
1935               .getCodonFrames();
1936       if (codonMappings != null && !codonMappings.isEmpty())
1937       {
1938         boolean doConsensus = false;
1939         for (AlignedCodonFrame mapping : codonMappings)
1940         {
1941           // TODO hold mapping type e.g. dna-to-protein in AlignedCodonFrame?
1942           MapList[] mapLists = mapping.getdnaToProt();
1943           // mapLists can be empty if project load has not finished resolving
1944           // seqs
1945           if (mapLists.length > 0 && mapLists[0].getFromRatio() == 3)
1946           {
1947             doConsensus = true;
1948             break;
1949           }
1950         }
1951         if (doConsensus)
1952         {
1953           complementConsensus = new AlignmentAnnotation("cDNA Consensus",
1954                   MessageManager
1955                           .getString("label.complement_consensus_descr"),
1956                   new Annotation[1], 0f, 100f,
1957                   AlignmentAnnotation.BAR_GRAPH);
1958           initConsensus(complementConsensus);
1959           return true;
1960         }
1961       }
1962     }
1963     return false;
1964   }
1965
1966   private void initConsensus(AlignmentAnnotation aa)
1967   {
1968     aa.hasText = true;
1969     aa.autoCalculated = true;
1970
1971     if (showConsensus)
1972     {
1973       alignment.addAnnotation(aa);
1974     }
1975   }
1976
1977   // these should be extracted from the view model - style and settings for
1978   // derived annotation
1979   private void initGapCounts()
1980   {
1981     if (showOccupancy)
1982     {
1983       gapcounts = new AlignmentAnnotation("Occupancy",
1984               MessageManager.getString("label.occupancy_descr"),
1985               new Annotation[1], 0f,
1986               alignment.getHeight(), AlignmentAnnotation.BAR_GRAPH);
1987       gapcounts.hasText = true;
1988       gapcounts.autoCalculated = true;
1989       gapcounts.scaleColLabel = true;
1990       gapcounts.graph = AlignmentAnnotation.BAR_GRAPH;
1991
1992       alignment.addAnnotation(gapcounts);
1993     }
1994   }
1995
1996   private void initConservation()
1997   {
1998     if (showConservation)
1999     {
2000       if (conservation == null)
2001       {
2002         conservation = new AlignmentAnnotation("Conservation",
2003                 MessageManager.formatMessage("label.conservation_descr",
2004                         getConsPercGaps()), new Annotation[1],
2005                 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
2006         conservation.hasText = true;
2007         conservation.autoCalculated = true;
2008         alignment.addAnnotation(conservation);
2009       }
2010     }
2011   }
2012
2013   private void initQuality()
2014   {
2015     if (showQuality)
2016     {
2017       if (quality == null)
2018       {
2019         quality = new AlignmentAnnotation("Quality",
2020                 MessageManager.getString("label.quality_descr"),
2021                 new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
2022         quality.hasText = true;
2023         quality.autoCalculated = true;
2024         alignment.addAnnotation(quality);
2025       }
2026     }
2027   }
2028
2029   private void initRNAStructure()
2030   {
2031     if (alignment.hasRNAStructure() && strucConsensus == null)
2032     {
2033       strucConsensus = new AlignmentAnnotation("StrucConsensus",
2034               MessageManager.getString("label.strucconsensus_descr"),
2035               new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
2036       strucConsensus.hasText = true;
2037       strucConsensus.autoCalculated = true;
2038
2039       if (showConsensus)
2040       {
2041         alignment.addAnnotation(strucConsensus);
2042       }
2043     }
2044   }
2045
2046   /*
2047    * (non-Javadoc)
2048    *
2049    * @see jalview.api.AlignViewportI#calcPanelHeight()
2050    */
2051   @Override
2052   public int calcPanelHeight()
2053   {
2054     // setHeight of panels
2055     AlignmentAnnotation[] anns = getAlignment().getAlignmentAnnotation();
2056     int height = 0;
2057     int charHeight = getCharHeight();
2058     if (anns != null)
2059     {
2060       BitSet graphgrp = new BitSet();
2061       for (AlignmentAnnotation aa : anns)
2062       {
2063         if (aa == null)
2064         {
2065           System.err.println("Null annotation row: ignoring.");
2066           continue;
2067         }
2068         if (!aa.visible)
2069         {
2070           continue;
2071         }
2072         if (aa.graphGroup > -1)
2073         {
2074           if (graphgrp.get(aa.graphGroup))
2075           {
2076             continue;
2077           }
2078           else
2079           {
2080             graphgrp.set(aa.graphGroup);
2081           }
2082         }
2083         aa.height = 0;
2084
2085         if (aa.hasText)
2086         {
2087           aa.height += charHeight;
2088         }
2089
2090         if (aa.hasIcons)
2091         {
2092           aa.height += 16;
2093         }
2094
2095         if (aa.graph > 0)
2096         {
2097           aa.height += aa.graphHeight;
2098         }
2099
2100         if (aa.height == 0)
2101         {
2102           aa.height = 20;
2103         }
2104
2105         height += aa.height;
2106       }
2107     }
2108     if (height == 0)
2109     {
2110       // set minimum
2111       height = 20;
2112     }
2113     return height;
2114   }
2115
2116   @Override
2117   public void updateGroupAnnotationSettings(boolean applyGlobalSettings,
2118           boolean preserveNewGroupSettings)
2119   {
2120     boolean updateCalcs = false;
2121     boolean conv = isShowGroupConservation();
2122     boolean cons = isShowGroupConsensus();
2123     boolean showprf = isShowSequenceLogo();
2124     boolean showConsHist = isShowConsensusHistogram();
2125     boolean normLogo = isNormaliseSequenceLogo();
2126
2127     /**
2128      * TODO reorder the annotation rows according to group/sequence ordering on
2129      * alignment
2130      */
2131     boolean sortg = true;
2132
2133     // remove old automatic annotation
2134     // add any new annotation
2135
2136     // intersect alignment annotation with alignment groups
2137
2138     AlignmentAnnotation[] aan = alignment.getAlignmentAnnotation();
2139     List<SequenceGroup> oldrfs = new ArrayList<>();
2140     if (aan != null)
2141     {
2142       for (int an = 0; an < aan.length; an++)
2143       {
2144         if (aan[an].autoCalculated && aan[an].groupRef != null)
2145         {
2146           oldrfs.add(aan[an].groupRef);
2147           alignment.deleteAnnotation(aan[an], false);
2148         }
2149       }
2150     }
2151     if (alignment.getGroups() != null)
2152     {
2153       for (SequenceGroup sg : alignment.getGroups())
2154       {
2155         updateCalcs = false;
2156         if (applyGlobalSettings
2157                 || (!preserveNewGroupSettings && !oldrfs.contains(sg)))
2158         {
2159           // set defaults for this group's conservation/consensus
2160           sg.setshowSequenceLogo(showprf);
2161           sg.setShowConsensusHistogram(showConsHist);
2162           sg.setNormaliseSequenceLogo(normLogo);
2163         }
2164         if (conv)
2165         {
2166           updateCalcs = true;
2167           alignment.addAnnotation(sg.getConservationRow(), 0);
2168         }
2169         if (cons)
2170         {
2171           updateCalcs = true;
2172           alignment.addAnnotation(sg.getConsensus(), 0);
2173         }
2174         // refresh the annotation rows
2175         if (updateCalcs)
2176         {
2177           sg.recalcConservation();
2178         }
2179       }
2180     }
2181     oldrfs.clear();
2182   }
2183
2184   @Override
2185   public boolean isDisplayReferenceSeq()
2186   {
2187     return alignment.hasSeqrep() && viewStyle.isDisplayReferenceSeq();
2188   }
2189
2190   @Override
2191   public void setDisplayReferenceSeq(boolean displayReferenceSeq)
2192   {
2193     viewStyle.setDisplayReferenceSeq(displayReferenceSeq);
2194   }
2195
2196   @Override
2197   public boolean isColourByReferenceSeq()
2198   {
2199     return alignment.hasSeqrep() && viewStyle.isColourByReferenceSeq();
2200   }
2201
2202   @Override
2203   public Color getSequenceColour(SequenceI seq)
2204   {
2205     Color sqc = sequenceColours.get(seq);
2206     return (sqc == null ? Color.white : sqc);
2207   }
2208
2209   @Override
2210   public void setSequenceColour(SequenceI seq, Color col)
2211   {
2212     if (col == null)
2213     {
2214       sequenceColours.remove(seq);
2215     }
2216     else
2217     {
2218       sequenceColours.put(seq, col);
2219     }
2220   }
2221
2222   @Override
2223   public void updateSequenceIdColours()
2224   {
2225     for (SequenceGroup sg : alignment.getGroups())
2226     {
2227       if (sg.idColour != null)
2228       {
2229         for (SequenceI s : sg.getSequences(getHiddenRepSequences()))
2230         {
2231           sequenceColours.put(s, sg.idColour);
2232         }
2233       }
2234     }
2235   }
2236
2237   @Override
2238   public void clearSequenceColours()
2239   {
2240     sequenceColours.clear();
2241   };
2242
2243   @Override
2244   public AlignViewportI getCodingComplement()
2245   {
2246     return this.codingComplement;
2247   }
2248
2249   /**
2250    * Set this as the (cDna/protein) complement of the given viewport. Also
2251    * ensures the reverse relationship is set on the given viewport.
2252    */
2253   @Override
2254   public void setCodingComplement(AlignViewportI av)
2255   {
2256     if (this == av)
2257     {
2258       System.err.println("Ignoring recursive setCodingComplement request");
2259     }
2260     else
2261     {
2262       this.codingComplement = av;
2263       // avoid infinite recursion!
2264       if (av.getCodingComplement() != this)
2265       {
2266         av.setCodingComplement(this);
2267       }
2268     }
2269   }
2270
2271   @Override
2272   public boolean isNucleotide()
2273   {
2274     return getAlignment() == null ? false : getAlignment().isNucleotide();
2275   }
2276
2277   @Override
2278   public FeaturesDisplayedI getFeaturesDisplayed()
2279   {
2280     return featuresDisplayed;
2281   }
2282
2283   @Override
2284   public void setFeaturesDisplayed(FeaturesDisplayedI featuresDisplayedI)
2285   {
2286     featuresDisplayed = featuresDisplayedI;
2287   }
2288
2289   @Override
2290   public boolean areFeaturesDisplayed()
2291   {
2292     return featuresDisplayed != null
2293             && featuresDisplayed.getRegisteredFeaturesCount() > 0;
2294   }
2295
2296   /**
2297    * set the flag
2298    *
2299    * @param b
2300    *          features are displayed if true
2301    */
2302   @Override
2303   public void setShowSequenceFeatures(boolean b)
2304   {
2305     viewStyle.setShowSequenceFeatures(b);
2306   }
2307
2308   @Override
2309   public boolean isShowSequenceFeatures()
2310   {
2311     return viewStyle.isShowSequenceFeatures();
2312   }
2313
2314   @Override
2315   public void setShowSequenceFeaturesHeight(boolean selected)
2316   {
2317     viewStyle.setShowSequenceFeaturesHeight(selected);
2318   }
2319
2320   @Override
2321   public boolean isShowSequenceFeaturesHeight()
2322   {
2323     return viewStyle.isShowSequenceFeaturesHeight();
2324   }
2325
2326   @Override
2327   public void setShowAnnotation(boolean b)
2328   {
2329     viewStyle.setShowAnnotation(b);
2330   }
2331
2332   @Override
2333   public boolean isShowAnnotation()
2334   {
2335     return viewStyle.isShowAnnotation();
2336   }
2337
2338   @Override
2339   public boolean isRightAlignIds()
2340   {
2341     return viewStyle.isRightAlignIds();
2342   }
2343
2344   @Override
2345   public void setRightAlignIds(boolean rightAlignIds)
2346   {
2347     viewStyle.setRightAlignIds(rightAlignIds);
2348   }
2349
2350   @Override
2351   public boolean getConservationSelected()
2352   {
2353     return viewStyle.getConservationSelected();
2354   }
2355
2356   @Override
2357   public void setShowBoxes(boolean state)
2358   {
2359     viewStyle.setShowBoxes(state);
2360   }
2361
2362   /**
2363    * @return
2364    * @see jalview.api.ViewStyleI#getTextColour()
2365    */
2366   @Override
2367   public Color getTextColour()
2368   {
2369     return viewStyle.getTextColour();
2370   }
2371
2372   /**
2373    * @return
2374    * @see jalview.api.ViewStyleI#getTextColour2()
2375    */
2376   @Override
2377   public Color getTextColour2()
2378   {
2379     return viewStyle.getTextColour2();
2380   }
2381
2382   /**
2383    * @return
2384    * @see jalview.api.ViewStyleI#getThresholdTextColour()
2385    */
2386   @Override
2387   public int getThresholdTextColour()
2388   {
2389     return viewStyle.getThresholdTextColour();
2390   }
2391
2392   /**
2393    * @return
2394    * @see jalview.api.ViewStyleI#isConservationColourSelected()
2395    */
2396   @Override
2397   public boolean isConservationColourSelected()
2398   {
2399     return viewStyle.isConservationColourSelected();
2400   }
2401
2402   /**
2403    * @return
2404    * @see jalview.api.ViewStyleI#isRenderGaps()
2405    */
2406   @Override
2407   public boolean isRenderGaps()
2408   {
2409     return viewStyle.isRenderGaps();
2410   }
2411
2412   /**
2413    * @return
2414    * @see jalview.api.ViewStyleI#isShowColourText()
2415    */
2416   @Override
2417   public boolean isShowColourText()
2418   {
2419     return viewStyle.isShowColourText();
2420   }
2421
2422   /**
2423    * @param conservationColourSelected
2424    * @see jalview.api.ViewStyleI#setConservationColourSelected(boolean)
2425    */
2426   @Override
2427   public void setConservationColourSelected(
2428           boolean conservationColourSelected)
2429   {
2430     viewStyle.setConservationColourSelected(conservationColourSelected);
2431   }
2432
2433   /**
2434    * @param showColourText
2435    * @see jalview.api.ViewStyleI#setShowColourText(boolean)
2436    */
2437   @Override
2438   public void setShowColourText(boolean showColourText)
2439   {
2440     viewStyle.setShowColourText(showColourText);
2441   }
2442
2443   /**
2444    * @param textColour
2445    * @see jalview.api.ViewStyleI#setTextColour(java.awt.Color)
2446    */
2447   @Override
2448   public void setTextColour(Color textColour)
2449   {
2450     viewStyle.setTextColour(textColour);
2451   }
2452
2453   /**
2454    * @param thresholdTextColour
2455    * @see jalview.api.ViewStyleI#setThresholdTextColour(int)
2456    */
2457   @Override
2458   public void setThresholdTextColour(int thresholdTextColour)
2459   {
2460     viewStyle.setThresholdTextColour(thresholdTextColour);
2461   }
2462
2463   /**
2464    * @param textColour2
2465    * @see jalview.api.ViewStyleI#setTextColour2(java.awt.Color)
2466    */
2467   @Override
2468   public void setTextColour2(Color textColour2)
2469   {
2470     viewStyle.setTextColour2(textColour2);
2471   }
2472
2473   @Override
2474   public ViewStyleI getViewStyle()
2475   {
2476     return new ViewStyle(viewStyle);
2477   }
2478
2479   @Override
2480   public void setViewStyle(ViewStyleI settingsForView)
2481   {
2482     viewStyle = new ViewStyle(settingsForView);
2483     if (residueShading != null)
2484     {
2485       residueShading.setConservationApplied(settingsForView
2486               .isConservationColourSelected());
2487     }
2488   }
2489
2490   @Override
2491   public boolean sameStyle(ViewStyleI them)
2492   {
2493     return viewStyle.sameStyle(them);
2494   }
2495
2496   /**
2497    * @return
2498    * @see jalview.api.ViewStyleI#getIdWidth()
2499    */
2500   @Override
2501   public int getIdWidth()
2502   {
2503     return viewStyle.getIdWidth();
2504   }
2505
2506   /**
2507    * @param i
2508    * @see jalview.api.ViewStyleI#setIdWidth(int)
2509    */
2510   @Override
2511   public void setIdWidth(int i)
2512   {
2513     viewStyle.setIdWidth(i);
2514   }
2515
2516   /**
2517    * @return
2518    * @see jalview.api.ViewStyleI#isCentreColumnLabels()
2519    */
2520   @Override
2521   public boolean isCentreColumnLabels()
2522   {
2523     return viewStyle.isCentreColumnLabels();
2524   }
2525
2526   /**
2527    * @param centreColumnLabels
2528    * @see jalview.api.ViewStyleI#setCentreColumnLabels(boolean)
2529    */
2530   @Override
2531   public void setCentreColumnLabels(boolean centreColumnLabels)
2532   {
2533     viewStyle.setCentreColumnLabels(centreColumnLabels);
2534   }
2535
2536   /**
2537    * @param showdbrefs
2538    * @see jalview.api.ViewStyleI#setShowDBRefs(boolean)
2539    */
2540   @Override
2541   public void setShowDBRefs(boolean showdbrefs)
2542   {
2543     viewStyle.setShowDBRefs(showdbrefs);
2544   }
2545
2546   /**
2547    * @return
2548    * @see jalview.api.ViewStyleI#isShowDBRefs()
2549    */
2550   @Override
2551   public boolean isShowDBRefs()
2552   {
2553     return viewStyle.isShowDBRefs();
2554   }
2555
2556   /**
2557    * @return
2558    * @see jalview.api.ViewStyleI#isShowNPFeats()
2559    */
2560   @Override
2561   public boolean isShowNPFeats()
2562   {
2563     return viewStyle.isShowNPFeats();
2564   }
2565
2566   /**
2567    * @param shownpfeats
2568    * @see jalview.api.ViewStyleI#setShowNPFeats(boolean)
2569    */
2570   @Override
2571   public void setShowNPFeats(boolean shownpfeats)
2572   {
2573     viewStyle.setShowNPFeats(shownpfeats);
2574   }
2575
2576   public abstract StructureSelectionManager getStructureSelectionManager();
2577
2578   /**
2579    * Add one command to the command history list.
2580    *
2581    * @param command
2582    */
2583   public void addToHistoryList(CommandI command)
2584   {
2585     if (this.historyList != null)
2586     {
2587       this.historyList.push(command);
2588       broadcastCommand(command, false);
2589     }
2590   }
2591
2592   protected void broadcastCommand(CommandI command, boolean undo)
2593   {
2594     getStructureSelectionManager().commandPerformed(command, undo,
2595             getVamsasSource());
2596   }
2597
2598   /**
2599    * Add one command to the command redo list.
2600    *
2601    * @param command
2602    */
2603   public void addToRedoList(CommandI command)
2604   {
2605     if (this.redoList != null)
2606     {
2607       this.redoList.push(command);
2608     }
2609     broadcastCommand(command, true);
2610   }
2611
2612   /**
2613    * Clear the command redo list.
2614    */
2615   public void clearRedoList()
2616   {
2617     if (this.redoList != null)
2618     {
2619       this.redoList.clear();
2620     }
2621   }
2622
2623   public void setHistoryList(Deque<CommandI> list)
2624   {
2625     this.historyList = list;
2626   }
2627
2628   public Deque<CommandI> getHistoryList()
2629   {
2630     return this.historyList;
2631   }
2632
2633   public void setRedoList(Deque<CommandI> list)
2634   {
2635     this.redoList = list;
2636   }
2637
2638   public Deque<CommandI> getRedoList()
2639   {
2640     return this.redoList;
2641   }
2642
2643   @Override
2644   public VamsasSource getVamsasSource()
2645   {
2646     return this;
2647   }
2648
2649   public SequenceAnnotationOrder getSortAnnotationsBy()
2650   {
2651     return sortAnnotationsBy;
2652   }
2653
2654   public void setSortAnnotationsBy(SequenceAnnotationOrder sortAnnotationsBy)
2655   {
2656     this.sortAnnotationsBy = sortAnnotationsBy;
2657   }
2658
2659   public boolean isShowAutocalculatedAbove()
2660   {
2661     return showAutocalculatedAbove;
2662   }
2663
2664   public void setShowAutocalculatedAbove(boolean showAutocalculatedAbove)
2665   {
2666     this.showAutocalculatedAbove = showAutocalculatedAbove;
2667   }
2668
2669   @Override
2670   public boolean isScaleProteinAsCdna()
2671   {
2672     return viewStyle.isScaleProteinAsCdna();
2673   }
2674
2675   @Override
2676   public void setScaleProteinAsCdna(boolean b)
2677   {
2678     viewStyle.setScaleProteinAsCdna(b);
2679   }
2680
2681   @Override
2682   public boolean isProteinFontAsCdna()
2683   {
2684     return viewStyle.isProteinFontAsCdna();
2685   }
2686
2687   @Override
2688   public void setProteinFontAsCdna(boolean b)
2689   {
2690     viewStyle.setProteinFontAsCdna(b);
2691   }
2692
2693   /**
2694    * @return true if view should scroll to show the highlighted region of a
2695    *         sequence
2696    * @return
2697    */
2698   @Override
2699   public final boolean isFollowHighlight()
2700   {
2701     return followHighlight;
2702   }
2703
2704   @Override
2705   public final void setFollowHighlight(boolean b)
2706   {
2707     this.followHighlight = b;
2708   }
2709
2710   @Override
2711   public ViewportRanges getRanges()
2712   {
2713     return ranges;
2714   }
2715
2716   /**
2717    * Helper method to populate the SearchResults with the location in the
2718    * complementary alignment to scroll to, in order to match this one.
2719    *
2720    * @param sr
2721    *          the SearchResults to add to
2722    * @return the offset (below top of visible region) of the matched sequence
2723    */
2724   protected int findComplementScrollTarget(SearchResultsI sr)
2725   {
2726     final AlignViewportI complement = getCodingComplement();
2727     if (complement == null || !complement.isFollowHighlight())
2728     {
2729       return 0;
2730     }
2731     boolean iAmProtein = !getAlignment().isNucleotide();
2732     AlignmentI proteinAlignment = iAmProtein ? getAlignment() : complement
2733             .getAlignment();
2734     if (proteinAlignment == null)
2735     {
2736       return 0;
2737     }
2738     final List<AlignedCodonFrame> mappings = proteinAlignment
2739             .getCodonFrames();
2740
2741     /*
2742      * Heuristic: find the first mapped sequence (if any) with a non-gapped
2743      * residue in the middle column of the visible region. Scroll the
2744      * complementary alignment to line up the corresponding residue.
2745      */
2746     int seqOffset = 0;
2747     SequenceI sequence = null;
2748
2749     /*
2750      * locate 'middle' column (true middle if an odd number visible, left of
2751      * middle if an even number visible)
2752      */
2753     int middleColumn = ranges.getStartRes()
2754             + (ranges.getEndRes() - ranges.getStartRes()) / 2;
2755     final HiddenSequences hiddenSequences = getAlignment()
2756             .getHiddenSequences();
2757
2758     /*
2759      * searching to the bottom of the alignment gives smoother scrolling across
2760      * all gapped visible regions
2761      */
2762     int lastSeq = alignment.getHeight() - 1;
2763     List<AlignedCodonFrame> seqMappings = null;
2764     for (int seqNo = ranges.getStartSeq(); seqNo < lastSeq; seqNo++, seqOffset++)
2765     {
2766       sequence = getAlignment().getSequenceAt(seqNo);
2767       if (hiddenSequences != null && hiddenSequences.isHidden(sequence))
2768       {
2769         continue;
2770       }
2771       if (Comparison.isGap(sequence.getCharAt(middleColumn)))
2772       {
2773         continue;
2774       }
2775       seqMappings = MappingUtils
2776               .findMappingsForSequenceAndOthers(sequence, mappings,
2777                       getCodingComplement().getAlignment().getSequences());
2778       if (!seqMappings.isEmpty())
2779       {
2780         break;
2781       }
2782     }
2783
2784     if (sequence == null || seqMappings == null || seqMappings.isEmpty())
2785     {
2786       /*
2787        * No ungapped mapped sequence in middle column - do nothing
2788        */
2789       return 0;
2790     }
2791     MappingUtils.addSearchResults(sr, sequence,
2792             sequence.findPosition(middleColumn), seqMappings);
2793     return seqOffset;
2794   }
2795
2796   /**
2797    * synthesize a column selection if none exists so it covers the given
2798    * selection group. if wholewidth is false, no column selection is made if the
2799    * selection group covers the whole alignment width.
2800    *
2801    * @param sg
2802    * @param wholewidth
2803    */
2804   public void expandColSelection(SequenceGroup sg, boolean wholewidth)
2805   {
2806     int sgs, sge;
2807     if (sg != null && (sgs = sg.getStartRes()) >= 0
2808             && sg.getStartRes() <= (sge = sg.getEndRes())
2809             && !this.hasSelectedColumns())
2810     {
2811       if (!wholewidth && alignment.getWidth() == (1 + sge - sgs))
2812       {
2813         // do nothing
2814         return;
2815       }
2816       if (colSel == null)
2817       {
2818         colSel = new ColumnSelection();
2819       }
2820       for (int cspos = sg.getStartRes(); cspos <= sg.getEndRes(); cspos++)
2821       {
2822         colSel.addElement(cspos);
2823       }
2824     }
2825   }
2826
2827   /**
2828    * hold status of current selection group - defined on alignment or not.
2829    */
2830   private boolean selectionIsDefinedGroup = false;
2831
2832   @Override
2833   public boolean isSelectionDefinedGroup()
2834   {
2835     if (selectionGroup == null)
2836     {
2837       return false;
2838     }
2839     if (isSelectionGroupChanged(true))
2840     {
2841       selectionIsDefinedGroup = false;
2842       List<SequenceGroup> gps = alignment.getGroups();
2843       if (gps == null || gps.size() == 0)
2844       {
2845         selectionIsDefinedGroup = false;
2846       }
2847       else
2848       {
2849         selectionIsDefinedGroup = gps.contains(selectionGroup);
2850       }
2851     }
2852     return selectionGroup.isDefined() || selectionIsDefinedGroup;
2853   }
2854
2855   /**
2856    * null, or currently highlighted results on this view
2857    */
2858   private SearchResultsI searchResults = null;
2859
2860   @Override
2861   public boolean hasSearchResults()
2862   {
2863     return searchResults != null;
2864   }
2865
2866   @Override
2867   public void setSearchResults(SearchResultsI results)
2868   {
2869     searchResults = results;
2870   }
2871
2872   @Override
2873   public SearchResultsI getSearchResults()
2874   {
2875     return searchResults;
2876   }
2877
2878   /**
2879    * get the consensus sequence as displayed under the PID consensus annotation
2880    * row.
2881    *
2882    * @return consensus sequence as a new sequence object
2883    */
2884   public SequenceI getConsensusSeq()
2885   {
2886     if (consensus == null)
2887     {
2888       updateConsensus(null);
2889     }
2890     if (consensus == null)
2891     {
2892       return null;
2893     }
2894     StringBuffer seqs = new StringBuffer();
2895     for (int i = 0; i < consensus.annotations.length; i++)
2896     {
2897       Annotation annotation = consensus.annotations[i];
2898       if (annotation != null)
2899       {
2900         String description = annotation.description;
2901         if (description != null && description.startsWith("["))
2902         {
2903           // consensus is a tie - just pick the first one
2904           seqs.append(description.charAt(1));
2905         }
2906         else
2907         {
2908           seqs.append(annotation.displayCharacter);
2909         }
2910       }
2911     }
2912
2913     SequenceI sq = new Sequence("Consensus", seqs.toString());
2914     sq.setDescription("Percentage Identity Consensus "
2915             + ((ignoreGapsInConsensusCalculation) ? " without gaps" : ""));
2916     return sq;
2917   }
2918 }