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     AlignmentAnnotation[] anns = alignment.getAlignmentAnnotation();
1424     if (anns != null)
1425     {
1426       for (AlignmentAnnotation ann : anns)
1427       {
1428         if (ann.sequenceRef == sequenceI)
1429         {
1430           ann.visible = visible;
1431         }
1432       }
1433     }
1434   }
1435
1436   public void hideRepSequences(SequenceI repSequence, SequenceGroup sg)
1437   {
1438     int sSize = sg.getSize();
1439     if (sSize < 2)
1440     {
1441       return;
1442     }
1443
1444     if (hiddenRepSequences == null)
1445     {
1446       hiddenRepSequences = new Hashtable<SequenceI, SequenceCollectionI>();
1447     }
1448
1449     hiddenRepSequences.put(repSequence, sg);
1450
1451     // Hide all sequences except the repSequence
1452     SequenceI[] seqs = new SequenceI[sSize - 1];
1453     int index = 0;
1454     for (int i = 0; i < sSize; i++)
1455     {
1456       if (sg.getSequenceAt(i) != repSequence)
1457       {
1458         if (index == sSize - 1)
1459         {
1460           return;
1461         }
1462
1463         seqs[index++] = sg.getSequenceAt(i);
1464       }
1465     }
1466     sg.setSeqrep(repSequence); // note: not done in 2.7applet
1467     sg.setHidereps(true); // note: not done in 2.7applet
1468     hideSequence(seqs);
1469
1470   }
1471
1472   /**
1473    *
1474    * @return null or the current reference sequence
1475    */
1476   public SequenceI getReferenceSeq()
1477   {
1478     return alignment.getSeqrep();
1479   }
1480
1481   /**
1482    * @param seq
1483    * @return true iff seq is the reference for the alignment
1484    */
1485   public boolean isReferenceSeq(SequenceI seq)
1486   {
1487     return alignment.getSeqrep() == seq;
1488   }
1489
1490   /**
1491    *
1492    * @param seq
1493    * @return true if there are sequences represented by this sequence that are
1494    *         currently hidden
1495    */
1496   public boolean isHiddenRepSequence(SequenceI seq)
1497   {
1498     return (hiddenRepSequences != null && hiddenRepSequences
1499                     .containsKey(seq));
1500   }
1501
1502   /**
1503    *
1504    * @param seq
1505    * @return null or a sequence group containing the sequences that seq
1506    *         represents
1507    */
1508   public SequenceGroup getRepresentedSequences(SequenceI seq)
1509   {
1510     return (SequenceGroup) (hiddenRepSequences == null ? null
1511             : hiddenRepSequences.get(seq));
1512   }
1513
1514   @Override
1515   public int adjustForHiddenSeqs(int alignmentIndex)
1516   {
1517     return alignment.getHiddenSequences().adjustForHiddenSeqs(
1518             alignmentIndex);
1519   }
1520
1521   @Override
1522   public void invertColumnSelection()
1523   {
1524     colSel.invertColumnSelection(0, alignment.getWidth());
1525   }
1526
1527   @Override
1528   public SequenceI[] getSelectionAsNewSequence()
1529   {
1530     SequenceI[] sequences;
1531     // JBPNote: Need to test jalviewLite.getSelectedSequencesAsAlignmentFrom -
1532     // this was the only caller in the applet for this method
1533     // JBPNote: in applet, this method returned references to the alignment
1534     // sequences, and it did not honour the presence/absence of annotation
1535     // attached to the alignment (probably!)
1536     if (selectionGroup == null || selectionGroup.getSize() == 0)
1537     {
1538       sequences = alignment.getSequencesArray();
1539       AlignmentAnnotation[] annots = alignment.getAlignmentAnnotation();
1540       for (int i = 0; i < sequences.length; i++)
1541       {
1542         // construct new sequence with subset of visible annotation
1543         sequences[i] = new Sequence(sequences[i], annots);
1544       }
1545     }
1546     else
1547     {
1548       sequences = selectionGroup.getSelectionAsNewSequences(alignment);
1549     }
1550
1551     return sequences;
1552   }
1553
1554   @Override
1555   public SequenceI[] getSequenceSelection()
1556   {
1557     SequenceI[] sequences = null;
1558     if (selectionGroup != null)
1559     {
1560       sequences = selectionGroup.getSequencesInOrder(alignment);
1561     }
1562     if (sequences == null)
1563     {
1564       sequences = alignment.getSequencesArray();
1565     }
1566     return sequences;
1567   }
1568
1569   @Override
1570   public CigarArray getViewAsCigars(boolean selectedRegionOnly)
1571   {
1572     return new CigarArray(alignment, colSel,
1573             (selectedRegionOnly ? selectionGroup : null));
1574   }
1575
1576   @Override
1577   public jalview.datamodel.AlignmentView getAlignmentView(
1578           boolean selectedOnly)
1579   {
1580     return getAlignmentView(selectedOnly, false);
1581   }
1582
1583   @Override
1584   public jalview.datamodel.AlignmentView getAlignmentView(
1585           boolean selectedOnly, boolean markGroups)
1586   {
1587     return new AlignmentView(alignment, colSel, selectionGroup,
1588             colSel != null && colSel.hasHiddenColumns(), selectedOnly,
1589             markGroups);
1590   }
1591
1592   @Override
1593   public String[] getViewAsString(boolean selectedRegionOnly)
1594   {
1595     return getViewAsString(selectedRegionOnly, true);
1596   }
1597
1598   @Override
1599   public String[] getViewAsString(boolean selectedRegionOnly,
1600           boolean exportHiddenSeqs)
1601   {
1602     String[] selection = null;
1603     SequenceI[] seqs = null;
1604     int i, iSize;
1605     int start = 0, end = 0;
1606     if (selectedRegionOnly && selectionGroup != null)
1607     {
1608       iSize = selectionGroup.getSize();
1609       seqs = selectionGroup.getSequencesInOrder(alignment);
1610       start = selectionGroup.getStartRes();
1611       end = selectionGroup.getEndRes() + 1;
1612     }
1613     else
1614     {
1615       if (hasHiddenRows() && exportHiddenSeqs)
1616       {
1617         AlignmentI fullAlignment = alignment.getHiddenSequences()
1618                 .getFullAlignment();
1619         iSize = fullAlignment.getHeight();
1620         seqs = fullAlignment.getSequencesArray();
1621         end = fullAlignment.getWidth();
1622       }
1623       else
1624       {
1625         iSize = alignment.getHeight();
1626         seqs = alignment.getSequencesArray();
1627         end = alignment.getWidth();
1628       }
1629     }
1630
1631     selection = new String[iSize];
1632     if (colSel != null && colSel.hasHiddenColumns())
1633     {
1634       selection = colSel.getVisibleSequenceStrings(start, end, seqs);
1635     }
1636     else
1637     {
1638       for (i = 0; i < iSize; i++)
1639       {
1640         selection[i] = seqs[i].getSequenceAsString(start, end);
1641       }
1642
1643     }
1644     return selection;
1645   }
1646
1647   @Override
1648   public List<int[]> getVisibleRegionBoundaries(int min, int max)
1649   {
1650     ArrayList<int[]> regions = new ArrayList<int[]>();
1651     int start = min;
1652     int end = max;
1653
1654     do
1655     {
1656       if (colSel != null && colSel.hasHiddenColumns())
1657       {
1658         if (start == 0)
1659         {
1660           start = colSel.adjustForHiddenColumns(start);
1661         }
1662
1663         end = colSel.getHiddenBoundaryRight(start);
1664         if (start == end)
1665         {
1666           end = max;
1667         }
1668         if (end > max)
1669         {
1670           end = max;
1671         }
1672       }
1673
1674       regions.add(new int[] { start, end });
1675
1676       if (colSel != null && colSel.hasHiddenColumns())
1677       {
1678         start = colSel.adjustForHiddenColumns(end);
1679         start = colSel.getHiddenBoundaryLeft(start) + 1;
1680       }
1681     } while (end < max);
1682
1683     int[][] startEnd = new int[regions.size()][2];
1684
1685     return regions;
1686   }
1687
1688   @Override
1689   public List<AlignmentAnnotation> getVisibleAlignmentAnnotation(
1690           boolean selectedOnly)
1691   {
1692     ArrayList<AlignmentAnnotation> ala = new ArrayList<AlignmentAnnotation>();
1693     AlignmentAnnotation[] aa;
1694     if ((aa = alignment.getAlignmentAnnotation()) != null)
1695     {
1696       for (AlignmentAnnotation annot : aa)
1697       {
1698         AlignmentAnnotation clone = new AlignmentAnnotation(annot);
1699         if (selectedOnly && selectionGroup != null)
1700         {
1701           colSel.makeVisibleAnnotation(selectionGroup.getStartRes(),
1702                   selectionGroup.getEndRes(), clone);
1703         }
1704         else
1705         {
1706           colSel.makeVisibleAnnotation(clone);
1707         }
1708         ala.add(clone);
1709       }
1710     }
1711     return ala;
1712   }
1713
1714   @Override
1715   public boolean isPadGaps()
1716   {
1717     return padGaps;
1718   }
1719
1720   @Override
1721   public void setPadGaps(boolean padGaps)
1722   {
1723     this.padGaps = padGaps;
1724   }
1725
1726   /**
1727    * apply any post-edit constraints and trigger any calculations needed after
1728    * an edit has been performed on the alignment
1729    *
1730    * @param ap
1731    */
1732   @Override
1733   public void alignmentChanged(AlignmentViewPanel ap)
1734   {
1735     if (isPadGaps())
1736     {
1737       alignment.padGaps();
1738     }
1739     if (autoCalculateConsensus)
1740     {
1741       updateConsensus(ap);
1742     }
1743     if (hconsensus != null && autoCalculateConsensus)
1744     {
1745       updateConservation(ap);
1746     }
1747     if (autoCalculateStrucConsensus)
1748     {
1749       updateStrucConsensus(ap);
1750     }
1751
1752     // Reset endRes of groups if beyond alignment width
1753     int alWidth = alignment.getWidth();
1754     List<SequenceGroup> groups = alignment.getGroups();
1755     if (groups != null)
1756     {
1757       for (SequenceGroup sg : groups)
1758       {
1759         if (sg.getEndRes() > alWidth)
1760         {
1761           sg.setEndRes(alWidth - 1);
1762         }
1763       }
1764     }
1765
1766     if (selectionGroup != null && selectionGroup.getEndRes() > alWidth)
1767     {
1768       selectionGroup.setEndRes(alWidth - 1);
1769     }
1770
1771     resetAllColourSchemes();
1772     calculator.restartWorkers();
1773     // alignment.adjustSequenceAnnotations();
1774   }
1775
1776   /**
1777    * reset scope and do calculations for all applied colourschemes on alignment
1778    */
1779   void resetAllColourSchemes()
1780   {
1781     ColourSchemeI cs = globalColourScheme;
1782     if (cs != null)
1783     {
1784       cs.alignmentChanged(alignment, hiddenRepSequences);
1785
1786       cs.setConsensus(hconsensus);
1787       if (cs.conservationApplied())
1788       {
1789         cs.setConservation(Conservation.calculateConservation("All",
1790                 ResidueProperties.propHash, 3, alignment.getSequences(), 0,
1791                 alignment.getWidth(), false, getConsPercGaps(), false));
1792       }
1793     }
1794
1795     for (SequenceGroup sg : alignment.getGroups())
1796     {
1797       if (sg.cs != null)
1798       {
1799         sg.cs.alignmentChanged(sg, hiddenRepSequences);
1800       }
1801       sg.recalcConservation();
1802     }
1803   }
1804
1805   protected void initAutoAnnotation()
1806   {
1807     // TODO: add menu option action that nulls or creates consensus object
1808     // depending on if the user wants to see the annotation or not in a
1809     // specific alignment
1810
1811     if (hconsensus == null && !isDataset)
1812     {
1813       if (!alignment.isNucleotide())
1814       {
1815         initConservation();
1816         initQuality();
1817       }
1818       else
1819       {
1820         initRNAStructure();
1821       }
1822       consensus = new AlignmentAnnotation("Consensus", "PID",
1823               new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
1824       initConsensus(consensus);
1825
1826       initComplementConsensus();
1827     }
1828   }
1829
1830   /**
1831    * If this is a protein alignment and there are mappings to cDNA, add the cDNA
1832    * consensus annotation.
1833    */
1834   public void initComplementConsensus()
1835   {
1836     if (!alignment.isNucleotide())
1837     {
1838       final List<AlignedCodonFrame> codonMappings = alignment
1839               .getCodonFrames();
1840       if (codonMappings != null && !codonMappings.isEmpty())
1841       {
1842         // fudge: check mappings are not protein-to-protein
1843         // TODO: nicer
1844         AlignedCodonFrame mapping = codonMappings.iterator().next();
1845         MapList[] mapLists = mapping.getdnaToProt();
1846         // mapLists can be empty if project load has not finished resolving seqs
1847         if (mapLists.length > 0 && mapLists[0].getFromRatio() == 3)
1848         {
1849           complementConsensus = new AlignmentAnnotation("cDNA Consensus",
1850                   "PID for cDNA", new Annotation[1], 0f, 100f,
1851                   AlignmentAnnotation.BAR_GRAPH);
1852           initConsensus(complementConsensus);
1853         }
1854       }
1855     }
1856   }
1857
1858   private void initConsensus(AlignmentAnnotation aa)
1859   {
1860     aa.hasText = true;
1861     aa.autoCalculated = true;
1862
1863     if (showConsensus)
1864     {
1865       alignment.addAnnotation(aa);
1866     }
1867   }
1868
1869   private void initConservation()
1870   {
1871     if (showConservation)
1872     {
1873       if (conservation == null)
1874       {
1875         conservation = new AlignmentAnnotation("Conservation",
1876                 "Conservation of total alignment less than "
1877                         + getConsPercGaps() + "% gaps", new Annotation[1],
1878                 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
1879         conservation.hasText = true;
1880         conservation.autoCalculated = true;
1881         alignment.addAnnotation(conservation);
1882       }
1883     }
1884   }
1885
1886   private void initQuality()
1887   {
1888     if (showQuality)
1889     {
1890       if (quality == null)
1891       {
1892         quality = new AlignmentAnnotation("Quality",
1893                 "Alignment Quality based on Blosum62 scores",
1894                 new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
1895         quality.hasText = true;
1896         quality.autoCalculated = true;
1897         alignment.addAnnotation(quality);
1898       }
1899     }
1900   }
1901
1902   private void initRNAStructure()
1903   {
1904     if (alignment.hasRNAStructure() && strucConsensus == null)
1905     {
1906       strucConsensus = new AlignmentAnnotation("StrucConsensus", "PID",
1907               new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
1908       strucConsensus.hasText = true;
1909       strucConsensus.autoCalculated = true;
1910
1911       if (showConsensus)
1912       {
1913         alignment.addAnnotation(strucConsensus);
1914       }
1915     }
1916   }
1917
1918   /*
1919    * (non-Javadoc)
1920    *
1921    * @see jalview.api.AlignViewportI#calcPanelHeight()
1922    */
1923   @Override
1924   public int calcPanelHeight()
1925   {
1926     // setHeight of panels
1927     AlignmentAnnotation[] anns = getAlignment().getAlignmentAnnotation();
1928     int height = 0;
1929     int charHeight = getCharHeight();
1930     if (anns != null)
1931     {
1932       BitSet graphgrp = new BitSet();
1933       for (AlignmentAnnotation aa : anns)
1934       {
1935         if (aa == null)
1936         {
1937           System.err.println("Null annotation row: ignoring.");
1938           continue;
1939         }
1940         if (!aa.visible)
1941         {
1942           continue;
1943         }
1944         if (aa.graphGroup > -1)
1945         {
1946           if (graphgrp.get(aa.graphGroup))
1947           {
1948             continue;
1949           }
1950           else
1951           {
1952             graphgrp.set(aa.graphGroup);
1953           }
1954         }
1955         aa.height = 0;
1956
1957         if (aa.hasText)
1958         {
1959           aa.height += charHeight;
1960         }
1961
1962         if (aa.hasIcons)
1963         {
1964           aa.height += 16;
1965         }
1966
1967         if (aa.graph > 0)
1968         {
1969           aa.height += aa.graphHeight;
1970         }
1971
1972         if (aa.height == 0)
1973         {
1974           aa.height = 20;
1975         }
1976
1977         height += aa.height;
1978       }
1979     }
1980     if (height == 0)
1981     {
1982       // set minimum
1983       height = 20;
1984     }
1985     return height;
1986   }
1987
1988   @Override
1989   public void updateGroupAnnotationSettings(boolean applyGlobalSettings,
1990           boolean preserveNewGroupSettings)
1991   {
1992     boolean updateCalcs = false;
1993     boolean conv = isShowGroupConservation();
1994     boolean cons = isShowGroupConsensus();
1995     boolean showprf = isShowSequenceLogo();
1996     boolean showConsHist = isShowConsensusHistogram();
1997     boolean normLogo = isNormaliseSequenceLogo();
1998
1999     /**
2000      * TODO reorder the annotation rows according to group/sequence ordering on
2001      * alignment
2002      */
2003     boolean sortg = true;
2004
2005     // remove old automatic annotation
2006     // add any new annotation
2007
2008     // intersect alignment annotation with alignment groups
2009
2010     AlignmentAnnotation[] aan = alignment.getAlignmentAnnotation();
2011     List<SequenceGroup> oldrfs = new ArrayList<SequenceGroup>();
2012     if (aan != null)
2013     {
2014       for (int an = 0; an < aan.length; an++)
2015       {
2016         if (aan[an].autoCalculated && aan[an].groupRef != null)
2017         {
2018           oldrfs.add(aan[an].groupRef);
2019           alignment.deleteAnnotation(aan[an], false);
2020         }
2021       }
2022     }
2023     if (alignment.getGroups() != null)
2024     {
2025       for (SequenceGroup sg : alignment.getGroups())
2026       {
2027         updateCalcs = false;
2028         if (applyGlobalSettings
2029                 || (!preserveNewGroupSettings && !oldrfs.contains(sg)))
2030         {
2031           // set defaults for this group's conservation/consensus
2032           sg.setshowSequenceLogo(showprf);
2033           sg.setShowConsensusHistogram(showConsHist);
2034           sg.setNormaliseSequenceLogo(normLogo);
2035         }
2036         if (conv)
2037         {
2038           updateCalcs = true;
2039           alignment.addAnnotation(sg.getConservationRow(), 0);
2040         }
2041         if (cons)
2042         {
2043           updateCalcs = true;
2044           alignment.addAnnotation(sg.getConsensus(), 0);
2045         }
2046         // refresh the annotation rows
2047         if (updateCalcs)
2048         {
2049           sg.recalcConservation();
2050         }
2051       }
2052     }
2053     oldrfs.clear();
2054   }
2055
2056   @Override
2057   public boolean isDisplayReferenceSeq()
2058   {
2059     return alignment.hasSeqrep() && viewStyle.isDisplayReferenceSeq();
2060   }
2061
2062   @Override
2063   public void setDisplayReferenceSeq(boolean displayReferenceSeq)
2064   {
2065     viewStyle.setDisplayReferenceSeq(displayReferenceSeq);
2066   }
2067
2068   @Override
2069   public boolean isColourByReferenceSeq()
2070   {
2071     return alignment.hasSeqrep() && viewStyle.isColourByReferenceSeq();
2072   }
2073
2074   @Override
2075   public Color getSequenceColour(SequenceI seq)
2076   {
2077     Color sqc = sequenceColours.get(seq);
2078     return (sqc == null ? Color.white : sqc);
2079   }
2080
2081   @Override
2082   public void setSequenceColour(SequenceI seq, Color col)
2083   {
2084     if (col == null)
2085     {
2086       sequenceColours.remove(seq);
2087     }
2088     else
2089     {
2090       sequenceColours.put(seq, col);
2091     }
2092   }
2093
2094   @Override
2095   public void updateSequenceIdColours()
2096   {
2097     for (SequenceGroup sg : alignment.getGroups())
2098     {
2099       if (sg.idColour != null)
2100       {
2101         for (SequenceI s : sg.getSequences(getHiddenRepSequences()))
2102         {
2103           sequenceColours.put(s, sg.idColour);
2104         }
2105       }
2106     }
2107   }
2108
2109   @Override
2110   public void clearSequenceColours()
2111   {
2112     sequenceColours.clear();
2113   };
2114
2115   @Override
2116   public AlignViewportI getCodingComplement()
2117   {
2118     return this.codingComplement;
2119   }
2120
2121   /**
2122    * Set this as the (cDna/protein) complement of the given viewport. Also
2123    * ensures the reverse relationship is set on the given viewport.
2124    */
2125   @Override
2126   public void setCodingComplement(AlignViewportI av)
2127   {
2128     if (this == av)
2129     {
2130       System.err.println("Ignoring recursive setCodingComplement request");
2131     }
2132     else
2133     {
2134       this.codingComplement = av;
2135       // avoid infinite recursion!
2136       if (av.getCodingComplement() != this)
2137       {
2138         av.setCodingComplement(this);
2139       }
2140     }
2141   }
2142
2143   @Override
2144   public boolean isNucleotide()
2145   {
2146     return getAlignment() == null ? false : getAlignment().isNucleotide();
2147   }
2148
2149   @Override
2150   public FeaturesDisplayedI getFeaturesDisplayed()
2151   {
2152     return featuresDisplayed;
2153   }
2154
2155   @Override
2156   public void setFeaturesDisplayed(FeaturesDisplayedI featuresDisplayedI)
2157   {
2158     featuresDisplayed = featuresDisplayedI;
2159   }
2160
2161   @Override
2162   public boolean areFeaturesDisplayed()
2163   {
2164     return featuresDisplayed != null
2165             && featuresDisplayed.getRegisteredFeaturesCount() > 0;
2166   }
2167
2168   /**
2169    * set the flag
2170    *
2171    * @param b
2172    *          features are displayed if true
2173    */
2174   @Override
2175   public void setShowSequenceFeatures(boolean b)
2176   {
2177     viewStyle.setShowSequenceFeatures(b);
2178   }
2179
2180   @Override
2181   public boolean isShowSequenceFeatures()
2182   {
2183     return viewStyle.isShowSequenceFeatures();
2184   }
2185
2186   @Override
2187   public void setShowSequenceFeaturesHeight(boolean selected)
2188   {
2189     viewStyle.setShowSequenceFeaturesHeight(selected);
2190   }
2191
2192   @Override
2193   public boolean isShowSequenceFeaturesHeight()
2194   {
2195     return viewStyle.isShowSequenceFeaturesHeight();
2196   }
2197
2198   @Override
2199   public void setShowAnnotation(boolean b)
2200   {
2201     viewStyle.setShowAnnotation(b);
2202   }
2203
2204   @Override
2205   public boolean isShowAnnotation()
2206   {
2207     return viewStyle.isShowAnnotation();
2208   }
2209
2210   @Override
2211   public boolean isRightAlignIds()
2212   {
2213     return viewStyle.isRightAlignIds();
2214   }
2215
2216   @Override
2217   public void setRightAlignIds(boolean rightAlignIds)
2218   {
2219     viewStyle.setRightAlignIds(rightAlignIds);
2220   }
2221
2222   @Override
2223   public boolean getConservationSelected()
2224   {
2225     return viewStyle.getConservationSelected();
2226   }
2227
2228   @Override
2229   public void setShowBoxes(boolean state)
2230   {
2231     viewStyle.setShowBoxes(state);
2232   }
2233
2234   /**
2235    * @return
2236    * @see jalview.api.ViewStyleI#getTextColour()
2237    */
2238   @Override
2239   public Color getTextColour()
2240   {
2241     return viewStyle.getTextColour();
2242   }
2243
2244   /**
2245    * @return
2246    * @see jalview.api.ViewStyleI#getTextColour2()
2247    */
2248   @Override
2249   public Color getTextColour2()
2250   {
2251     return viewStyle.getTextColour2();
2252   }
2253
2254   /**
2255    * @return
2256    * @see jalview.api.ViewStyleI#getThresholdTextColour()
2257    */
2258   @Override
2259   public int getThresholdTextColour()
2260   {
2261     return viewStyle.getThresholdTextColour();
2262   }
2263
2264   /**
2265    * @return
2266    * @see jalview.api.ViewStyleI#isConservationColourSelected()
2267    */
2268   @Override
2269   public boolean isConservationColourSelected()
2270   {
2271     return viewStyle.isConservationColourSelected();
2272   }
2273
2274   /**
2275    * @return
2276    * @see jalview.api.ViewStyleI#isRenderGaps()
2277    */
2278   @Override
2279   public boolean isRenderGaps()
2280   {
2281     return viewStyle.isRenderGaps();
2282   }
2283
2284   /**
2285    * @return
2286    * @see jalview.api.ViewStyleI#isShowColourText()
2287    */
2288   @Override
2289   public boolean isShowColourText()
2290   {
2291     return viewStyle.isShowColourText();
2292   }
2293
2294   /**
2295    * @param conservationColourSelected
2296    * @see jalview.api.ViewStyleI#setConservationColourSelected(boolean)
2297    */
2298   @Override
2299   public void setConservationColourSelected(
2300           boolean conservationColourSelected)
2301   {
2302     viewStyle.setConservationColourSelected(conservationColourSelected);
2303   }
2304
2305   /**
2306    * @param showColourText
2307    * @see jalview.api.ViewStyleI#setShowColourText(boolean)
2308    */
2309   @Override
2310   public void setShowColourText(boolean showColourText)
2311   {
2312     viewStyle.setShowColourText(showColourText);
2313   }
2314
2315   /**
2316    * @param textColour
2317    * @see jalview.api.ViewStyleI#setTextColour(java.awt.Color)
2318    */
2319   @Override
2320   public void setTextColour(Color textColour)
2321   {
2322     viewStyle.setTextColour(textColour);
2323   }
2324
2325   /**
2326    * @param thresholdTextColour
2327    * @see jalview.api.ViewStyleI#setThresholdTextColour(int)
2328    */
2329   @Override
2330   public void setThresholdTextColour(int thresholdTextColour)
2331   {
2332     viewStyle.setThresholdTextColour(thresholdTextColour);
2333   }
2334
2335   /**
2336    * @param textColour2
2337    * @see jalview.api.ViewStyleI#setTextColour2(java.awt.Color)
2338    */
2339   @Override
2340   public void setTextColour2(Color textColour2)
2341   {
2342     viewStyle.setTextColour2(textColour2);
2343   }
2344
2345   @Override
2346   public ViewStyleI getViewStyle()
2347   {
2348     return new ViewStyle(viewStyle);
2349   }
2350
2351   @Override
2352   public void setViewStyle(ViewStyleI settingsForView)
2353   {
2354     viewStyle = new ViewStyle(settingsForView);
2355   }
2356
2357   @Override
2358   public boolean sameStyle(ViewStyleI them)
2359   {
2360     return viewStyle.sameStyle(them);
2361   }
2362
2363   /**
2364    * @return
2365    * @see jalview.api.ViewStyleI#getIdWidth()
2366    */
2367   @Override
2368   public int getIdWidth()
2369   {
2370     return viewStyle.getIdWidth();
2371   }
2372
2373   /**
2374    * @param i
2375    * @see jalview.api.ViewStyleI#setIdWidth(int)
2376    */
2377   @Override
2378   public void setIdWidth(int i)
2379   {
2380     viewStyle.setIdWidth(i);
2381   }
2382
2383   /**
2384    * @return
2385    * @see jalview.api.ViewStyleI#isCentreColumnLabels()
2386    */
2387   @Override
2388   public boolean isCentreColumnLabels()
2389   {
2390     return viewStyle.isCentreColumnLabels();
2391   }
2392
2393   /**
2394    * @param centreColumnLabels
2395    * @see jalview.api.ViewStyleI#setCentreColumnLabels(boolean)
2396    */
2397   @Override
2398   public void setCentreColumnLabels(boolean centreColumnLabels)
2399   {
2400     viewStyle.setCentreColumnLabels(centreColumnLabels);
2401   }
2402
2403   /**
2404    * @param showdbrefs
2405    * @see jalview.api.ViewStyleI#setShowDBRefs(boolean)
2406    */
2407   @Override
2408   public void setShowDBRefs(boolean showdbrefs)
2409   {
2410     viewStyle.setShowDBRefs(showdbrefs);
2411   }
2412
2413   /**
2414    * @return
2415    * @see jalview.api.ViewStyleI#isShowDBRefs()
2416    */
2417   @Override
2418   public boolean isShowDBRefs()
2419   {
2420     return viewStyle.isShowDBRefs();
2421   }
2422
2423   /**
2424    * @return
2425    * @see jalview.api.ViewStyleI#isShowNPFeats()
2426    */
2427   @Override
2428   public boolean isShowNPFeats()
2429   {
2430     return viewStyle.isShowNPFeats();
2431   }
2432
2433   /**
2434    * @param shownpfeats
2435    * @see jalview.api.ViewStyleI#setShowNPFeats(boolean)
2436    */
2437   @Override
2438   public void setShowNPFeats(boolean shownpfeats)
2439   {
2440     viewStyle.setShowNPFeats(shownpfeats);
2441   }
2442
2443   public abstract StructureSelectionManager getStructureSelectionManager();
2444
2445   /**
2446    * Add one command to the command history list.
2447    *
2448    * @param command
2449    */
2450   public void addToHistoryList(CommandI command)
2451   {
2452     if (this.historyList != null)
2453     {
2454       this.historyList.push(command);
2455       broadcastCommand(command, false);
2456     }
2457   }
2458
2459   protected void broadcastCommand(CommandI command, boolean undo)
2460   {
2461     getStructureSelectionManager().commandPerformed(command, undo,
2462             getVamsasSource());
2463   }
2464
2465   /**
2466    * Add one command to the command redo list.
2467    *
2468    * @param command
2469    */
2470   public void addToRedoList(CommandI command)
2471   {
2472     if (this.redoList != null)
2473     {
2474       this.redoList.push(command);
2475     }
2476     broadcastCommand(command, true);
2477   }
2478
2479   /**
2480    * Clear the command redo list.
2481    */
2482   public void clearRedoList()
2483   {
2484     if (this.redoList != null)
2485     {
2486       this.redoList.clear();
2487     }
2488   }
2489
2490   public void setHistoryList(Deque<CommandI> list)
2491   {
2492     this.historyList = list;
2493   }
2494
2495   public Deque<CommandI> getHistoryList()
2496   {
2497     return this.historyList;
2498   }
2499
2500   public void setRedoList(Deque<CommandI> list)
2501   {
2502     this.redoList = list;
2503   }
2504
2505   public Deque<CommandI> getRedoList()
2506   {
2507     return this.redoList;
2508   }
2509
2510   @Override
2511   public VamsasSource getVamsasSource()
2512   {
2513     return this;
2514   }
2515
2516   public SequenceAnnotationOrder getSortAnnotationsBy()
2517   {
2518     return sortAnnotationsBy;
2519   }
2520
2521   public void setSortAnnotationsBy(SequenceAnnotationOrder sortAnnotationsBy)
2522   {
2523     this.sortAnnotationsBy = sortAnnotationsBy;
2524   }
2525
2526   public boolean isShowAutocalculatedAbove()
2527   {
2528     return showAutocalculatedAbove;
2529   }
2530
2531   public void setShowAutocalculatedAbove(boolean showAutocalculatedAbove)
2532   {
2533     this.showAutocalculatedAbove = showAutocalculatedAbove;
2534   }
2535
2536   @Override
2537   public boolean isScaleProteinAsCdna()
2538   {
2539     return viewStyle.isScaleProteinAsCdna();
2540   }
2541
2542   @Override
2543   public void setScaleProteinAsCdna(boolean b)
2544   {
2545     viewStyle.setScaleProteinAsCdna(b);
2546   }
2547
2548   /**
2549    * @return true if view should scroll to show the highlighted region of a
2550    *         sequence
2551    * @return
2552    */
2553   @Override
2554   public final boolean isFollowHighlight()
2555   {
2556     return followHighlight;
2557   }
2558
2559   @Override
2560   public final void setFollowHighlight(boolean b)
2561   {
2562     this.followHighlight = b;
2563   }
2564
2565   public int getStartRes()
2566   {
2567     return startRes;
2568   }
2569
2570   @Override
2571   public int getEndRes()
2572   {
2573     return endRes;
2574   }
2575
2576   public int getStartSeq()
2577   {
2578     return startSeq;
2579   }
2580
2581   public void setStartRes(int res)
2582   {
2583     this.startRes = res;
2584   }
2585
2586   public void setStartSeq(int seq)
2587   {
2588     this.startSeq = seq;
2589   }
2590
2591   public void setEndRes(int res)
2592   {
2593     if (res > alignment.getWidth() - 1)
2594     {
2595       // log.System.out.println(" Corrected res from " + res + " to maximum " +
2596       // (alignment.getWidth()-1));
2597       res = alignment.getWidth() - 1;
2598     }
2599     if (res < 0)
2600     {
2601       res = 0;
2602     }
2603     this.endRes = res;
2604   }
2605
2606   public void setEndSeq(int seq)
2607   {
2608     if (seq > alignment.getHeight())
2609     {
2610       seq = alignment.getHeight();
2611     }
2612     if (seq < 0)
2613     {
2614       seq = 0;
2615     }
2616     this.endSeq = seq;
2617   }
2618
2619   public int getEndSeq()
2620   {
2621     return endSeq;
2622   }
2623
2624   /**
2625    * Helper method to populate the SearchResults with the location in the
2626    * complementary alignment to scroll to, in order to match this one.
2627    *
2628    * @param sr
2629    *          the SearchResults to add to
2630    * @return the offset (below top of visible region) of the matched sequence
2631    */
2632   protected int findComplementScrollTarget(SearchResults sr)
2633   {
2634     final AlignViewportI complement = getCodingComplement();
2635     if (complement == null || !complement.isFollowHighlight())
2636     {
2637       return 0;
2638     }
2639     boolean iAmProtein = !getAlignment().isNucleotide();
2640     AlignmentI proteinAlignment = iAmProtein ? getAlignment() : complement
2641             .getAlignment();
2642     if (proteinAlignment == null)
2643     {
2644       return 0;
2645     }
2646     final List<AlignedCodonFrame> mappings = proteinAlignment
2647             .getCodonFrames();
2648
2649     /*
2650      * Heuristic: find the first mapped sequence (if any) with a non-gapped
2651      * residue in the middle column of the visible region. Scroll the
2652      * complementary alignment to line up the corresponding residue.
2653      */
2654     int seqOffset = 0;
2655     SequenceI sequence = null;
2656
2657     /*
2658      * locate 'middle' column (true middle if an odd number visible, left of
2659      * middle if an even number visible)
2660      */
2661     int middleColumn = getStartRes() + (getEndRes() - getStartRes()) / 2;
2662     final HiddenSequences hiddenSequences = getAlignment()
2663             .getHiddenSequences();
2664
2665     /*
2666      * searching to the bottom of the alignment gives smoother scrolling across
2667      * all gapped visible regions
2668      */
2669     int lastSeq = alignment.getHeight() - 1;
2670     for (int seqNo = getStartSeq(); seqNo < lastSeq; seqNo++, seqOffset++)
2671     {
2672       sequence = getAlignment().getSequenceAt(seqNo);
2673       if (hiddenSequences != null && hiddenSequences.isHidden(sequence))
2674       {
2675         continue;
2676       }
2677       if (Comparison.isGap(sequence.getCharAt(middleColumn)))
2678       {
2679         continue;
2680       }
2681       List<AlignedCodonFrame> seqMappings = MappingUtils
2682               .findMappingsForSequence(sequence, mappings);
2683       if (!seqMappings.isEmpty())
2684       {
2685         break;
2686       }
2687     }
2688
2689     if (sequence == null)
2690     {
2691       /*
2692        * No ungapped mapped sequence in middle column - do nothing
2693        */
2694       return 0;
2695     }
2696     MappingUtils.addSearchResults(sr, sequence,
2697             sequence.findPosition(middleColumn), mappings);
2698     return seqOffset;
2699   }
2700
2701   /**
2702    * synthesize a column selection if none exists so it covers the given
2703    * selection group. if wholewidth is false, no column selection is made if the
2704    * selection group covers the whole alignment width.
2705    *
2706    * @param sg
2707    * @param wholewidth
2708    */
2709   public void expandColSelection(SequenceGroup sg, boolean wholewidth)
2710   {
2711     int sgs, sge;
2712     if (sg != null
2713             && (sgs = sg.getStartRes()) >= 0
2714             && sg.getStartRes() <= (sge = sg.getEndRes())
2715             && (colSel == null || colSel.getSelected() == null || colSel
2716                     .getSelected().size() == 0))
2717     {
2718       if (!wholewidth && alignment.getWidth() == (1 + sge - sgs))
2719       {
2720         // do nothing
2721         return;
2722       }
2723       if (colSel == null)
2724       {
2725         colSel = new ColumnSelection();
2726       }
2727       for (int cspos = sg.getStartRes(); cspos <= sg.getEndRes(); cspos++)
2728       {
2729         colSel.addElement(cspos);
2730       }
2731     }
2732   }
2733
2734
2735 }