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