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