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