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