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