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