src/jalview/viewmodel/AlignmentViewport.java

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