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