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