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