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