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