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(
 668                 cs == null ? null : cs.getInstance(this, sg));
 669         if (cs != null)
 670         {
 671           sg.getGroupColourScheme().alignmentChanged(sg,
 672                   hiddenRepSequences);
 673         }
 674       }
 675     }
 676   }
 677
 678   @Override
 679   public ColourSchemeI getGlobalColourScheme()
 680   {
 681     return residueShading == null ? null : residueShading.getColourScheme();
 682   }
 683
 684   @Override
 685   public ResidueShaderI getResidueShading()
 686   {
 687     return residueShading;
 688   }
 689
 690   protected AlignmentAnnotation consensus;
 691
 692   protected AlignmentAnnotation complementConsensus;
 693
 694   protected AlignmentAnnotation gapcounts;
 695
 696   protected AlignmentAnnotation strucConsensus;
 697
 698   protected AlignmentAnnotation conservation;
 699
 700   protected AlignmentAnnotation quality;
 701
 702   protected AlignmentAnnotation[] groupConsensus;
 703
 704   protected AlignmentAnnotation[] groupConservation;
 705
 706   /**
 707    * results of alignment consensus analysis for visible portion of view
 708    */
 709   protected ProfilesI hconsensus = null;
 710
 711   /**
 712    * results of cDNA complement consensus visible portion of view
 713    */
 714   protected Hashtable<String, Object>[] hcomplementConsensus = null;
 715
 716   /**
 717    * results of secondary structure base pair consensus for visible portion of
 718    * view
 719    */
 720   protected Hashtable<String, Object>[] hStrucConsensus = null;
 721
 722   protected Conservation hconservation = null;
 723
 724   @Override
 725   public void setConservation(Conservation cons)
 726   {
 727     hconservation = cons;
 728   }
 729
 730   /**
 731    * percentage gaps allowed in a column before all amino acid properties should
 732    * be considered unconserved
 733    */
 734   int ConsPercGaps = 25; // JBPNote : This should be a scalable property!
 735
 736   @Override
 737   public int getConsPercGaps()
 738   {
 739     return ConsPercGaps;
 740   }
 741
 742   @Override
 743   public void setSequenceConsensusHash(ProfilesI hconsensus)
 744   {
 745     this.hconsensus = hconsensus;
 746   }
 747
 748   @Override
 749   public void setComplementConsensusHash(
 750           Hashtable<String, Object>[] hconsensus)
 751   {
 752     this.hcomplementConsensus = hconsensus;
 753   }
 754
 755   @Override
 756   public ProfilesI getSequenceConsensusHash()
 757   {
 758     return hconsensus;
 759   }
 760
 761   @Override
 762   public Hashtable<String, Object>[] getComplementConsensusHash()
 763   {
 764     return hcomplementConsensus;
 765   }
 766
 767   @Override
 768   public Hashtable<String, Object>[] getRnaStructureConsensusHash()
 769   {
 770     return hStrucConsensus;
 771   }
 772
 773   @Override
 774   public void setRnaStructureConsensusHash(
 775           Hashtable<String, Object>[] hStrucConsensus)
 776   {
 777     this.hStrucConsensus = hStrucConsensus;
 778
 779   }
 780
 781   @Override
 782   public AlignmentAnnotation getAlignmentQualityAnnot()
 783   {
 784     return quality;
 785   }
 786
 787   @Override
 788   public AlignmentAnnotation getAlignmentConservationAnnotation()
 789   {
 790     return conservation;
 791   }
 792
 793   @Override
 794   public AlignmentAnnotation getAlignmentConsensusAnnotation()
 795   {
 796     return consensus;
 797   }
 798
 799   @Override
 800   public AlignmentAnnotation getAlignmentGapAnnotation()
 801   {
 802     return gapcounts;
 803   }
 804
 805   @Override
 806   public AlignmentAnnotation getComplementConsensusAnnotation()
 807   {
 808     return complementConsensus;
 809   }
 810
 811   @Override
 812   public AlignmentAnnotation getAlignmentStrucConsensusAnnotation()
 813   {
 814     return strucConsensus;
 815   }
 816
 817   protected AlignCalcManagerI calculator = new AlignCalcManager();
 818
 819   /**
 820    * trigger update of conservation annotation
 821    */
 822   public void updateConservation(final AlignmentViewPanel ap)
 823   {
 824     // see note in mantis : issue number 8585
 825     if (alignment.isNucleotide()
 826             || (conservation == null && quality == null)
 827             || !autoCalculateConsensus)
 828     {
 829       return;
 830     }
 831     if (calculator.getRegisteredWorkersOfClass(
 832             jalview.workers.ConservationThread.class) == null)
 833     {
 834       calculator.registerWorker(
 835               new jalview.workers.ConservationThread(this, ap));
 836     }
 837   }
 838
 839   /**
 840    * trigger update of consensus annotation
 841    */
 842   public void updateConsensus(final AlignmentViewPanel ap)
 843   {
 844     // see note in mantis : issue number 8585
 845     if (consensus == null || !autoCalculateConsensus)
 846     {
 847       return;
 848     }
 849     if (calculator
 850             .getRegisteredWorkersOfClass(ConsensusThread.class) == null)
 851     {
 852       calculator.registerWorker(new ConsensusThread(this, ap));
 853     }
 854
 855     /*
 856      * A separate thread to compute cDNA consensus for a protein alignment
 857      * which has mapping to cDNA
 858      */
 859     final AlignmentI al = this.getAlignment();
 860     if (!al.isNucleotide() && al.getCodonFrames() != null
 861             && !al.getCodonFrames().isEmpty())
 862     {
 863       /*
 864        * fudge - check first for protein-to-nucleotide mappings
 865        * (we don't want to do this for protein-to-protein)
 866        */
 867       boolean doConsensus = false;
 868       for (AlignedCodonFrame mapping : al.getCodonFrames())
 869       {
 870         // TODO hold mapping type e.g. dna-to-protein in AlignedCodonFrame?
 871         MapList[] mapLists = mapping.getdnaToProt();
 872         // mapLists can be empty if project load has not finished resolving seqs
 873         if (mapLists.length > 0 && mapLists[0].getFromRatio() == 3)
 874         {
 875           doConsensus = true;
 876           break;
 877         }
 878       }
 879       if (doConsensus)
 880       {
 881         if (calculator.getRegisteredWorkersOfClass(
 882                 ComplementConsensusThread.class) == null)
 883         {
 884           calculator
 885                   .registerWorker(new ComplementConsensusThread(this, ap));
 886         }
 887       }
 888     }
 889   }
 890
 891   // --------START Structure Conservation
 892   public void updateStrucConsensus(final AlignmentViewPanel ap)
 893   {
 894     if (autoCalculateStrucConsensus && strucConsensus == null
 895             && alignment.isNucleotide() && alignment.hasRNAStructure())
 896     {
 897       // secondary structure has been added - so init the consensus line
 898       initRNAStructure();
 899     }
 900
 901     // see note in mantis : issue number 8585
 902     if (strucConsensus == null || !autoCalculateStrucConsensus)
 903     {
 904       return;
 905     }
 906     if (calculator.getRegisteredWorkersOfClass(
 907             StrucConsensusThread.class) == null)
 908     {
 909       calculator.registerWorker(new StrucConsensusThread(this, ap));
 910     }
 911   }
 912
 913   public boolean isCalcInProgress()
 914   {
 915     return calculator.isWorking();
 916   }
 917
 918   @Override
 919   public boolean isCalculationInProgress(
 920           AlignmentAnnotation alignmentAnnotation)
 921   {
 922     if (!alignmentAnnotation.autoCalculated)
 923     {
 924       return false;
 925     }
 926     if (calculator.workingInvolvedWith(alignmentAnnotation))
 927     {
 928       // System.err.println("grey out ("+alignmentAnnotation.label+")");
 929       return true;
 930     }
 931     return false;
 932   }
 933
 934   public void setAlignment(AlignmentI align)
 935   {
 936     this.alignment = align;
 937   }
 938
 939   /**
 940    * Clean up references when this viewport is closed
 941    */
 942   @Override
 943   public void dispose()
 944   {
 945     /*
 946      * defensively null out references to large objects in case
 947      * this object is not garbage collected (as if!)
 948      */
 949     consensus = null;
 950     complementConsensus = null;
 951     strucConsensus = null;
 952     conservation = null;
 953     quality = null;
 954     groupConsensus = null;
 955     groupConservation = null;
 956     hconsensus = null;
 957     hconservation = null;
 958     hcomplementConsensus = null;
 959     gapcounts = null;
 960     calculator = null;
 961     residueShading = null; // may hold a reference to Consensus
 962     changeSupport = null;
 963     ranges = null;
 964     currentTree = null;
 965     selectionGroup = 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(
1824                   selectionGroup.getStartRes(), selectionGroup.getEndRes(),
1825                   alignment.getHiddenColumns());
1826         }
1827         else
1828         {
1829           clone.makeVisibleAnnotation(alignment.getHiddenColumns());
1830         }
1831         ala.add(clone);
1832       }
1833     }
1834     return ala;
1835   }
1836
1837   @Override
1838   public boolean isPadGaps()
1839   {
1840     return padGaps;
1841   }
1842
1843   @Override
1844   public void setPadGaps(boolean padGaps)
1845   {
1846     this.padGaps = padGaps;
1847   }
1848
1849   /**
1850    * apply any post-edit constraints and trigger any calculations needed after
1851    * an edit has been performed on the alignment
1852    *
1853    * @param ap
1854    */
1855   @Override
1856   public void alignmentChanged(AlignmentViewPanel ap)
1857   {
1858     if (isPadGaps())
1859     {
1860       alignment.padGaps();
1861     }
1862     if (autoCalculateConsensus)
1863     {
1864       updateConsensus(ap);
1865     }
1866     if (hconsensus != null && autoCalculateConsensus)
1867     {
1868       updateConservation(ap);
1869     }
1870     if (autoCalculateStrucConsensus)
1871     {
1872       updateStrucConsensus(ap);
1873     }
1874
1875     // Reset endRes of groups if beyond alignment width
1876     int alWidth = alignment.getWidth();
1877     List<SequenceGroup> groups = alignment.getGroups();
1878     if (groups != null)
1879     {
1880       for (SequenceGroup sg : groups)
1881       {
1882         if (sg.getEndRes() > alWidth)
1883         {
1884           sg.setEndRes(alWidth - 1);
1885         }
1886       }
1887     }
1888
1889     if (selectionGroup != null && selectionGroup.getEndRes() > alWidth)
1890     {
1891       selectionGroup.setEndRes(alWidth - 1);
1892     }
1893
1894     updateAllColourSchemes();
1895     calculator.restartWorkers();
1896     // alignment.adjustSequenceAnnotations();
1897   }
1898
1899   /**
1900    * reset scope and do calculations for all applied colourschemes on alignment
1901    */
1902   void updateAllColourSchemes()
1903   {
1904     ResidueShaderI rs = residueShading;
1905     if (rs != null)
1906     {
1907       rs.alignmentChanged(alignment, hiddenRepSequences);
1908
1909       rs.setConsensus(hconsensus);
1910       if (rs.conservationApplied())
1911       {
1912         rs.setConservation(Conservation.calculateConservation("All",
1913                 alignment.getSequences(), 0, alignment.getWidth(), false,
1914                 getConsPercGaps(), false));
1915       }
1916     }
1917
1918     for (SequenceGroup sg : alignment.getGroups())
1919     {
1920       if (sg.cs != null)
1921       {
1922         sg.cs.alignmentChanged(sg, hiddenRepSequences);
1923       }
1924       sg.recalcConservation();
1925     }
1926   }
1927
1928   protected void initAutoAnnotation()
1929   {
1930     // TODO: add menu option action that nulls or creates consensus object
1931     // depending on if the user wants to see the annotation or not in a
1932     // specific alignment
1933
1934     if (hconsensus == null && !isDataset)
1935     {
1936       if (!alignment.isNucleotide())
1937       {
1938         initConservation();
1939         initQuality();
1940       }
1941       else
1942       {
1943         initRNAStructure();
1944       }
1945       consensus = new AlignmentAnnotation("Consensus",
1946               MessageManager.getString("label.consensus_descr"),
1947               new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
1948       initConsensus(consensus);
1949       initGapCounts();
1950
1951       initComplementConsensus();
1952     }
1953   }
1954
1955   /**
1956    * If this is a protein alignment and there are mappings to cDNA, adds the
1957    * cDNA consensus annotation and returns true, else returns false.
1958    */
1959   public boolean initComplementConsensus()
1960   {
1961     if (!alignment.isNucleotide())
1962     {
1963       final List<AlignedCodonFrame> codonMappings = alignment
1964               .getCodonFrames();
1965       if (codonMappings != null && !codonMappings.isEmpty())
1966       {
1967         boolean doConsensus = false;
1968         for (AlignedCodonFrame mapping : codonMappings)
1969         {
1970           // TODO hold mapping type e.g. dna-to-protein in AlignedCodonFrame?
1971           MapList[] mapLists = mapping.getdnaToProt();
1972           // mapLists can be empty if project load has not finished resolving
1973           // seqs
1974           if (mapLists.length > 0 && mapLists[0].getFromRatio() == 3)
1975           {
1976             doConsensus = true;
1977             break;
1978           }
1979         }
1980         if (doConsensus)
1981         {
1982           complementConsensus = new AlignmentAnnotation("cDNA Consensus",
1983                   MessageManager
1984                           .getString("label.complement_consensus_descr"),
1985                   new Annotation[1], 0f, 100f,
1986                   AlignmentAnnotation.BAR_GRAPH);
1987           initConsensus(complementConsensus);
1988           return true;
1989         }
1990       }
1991     }
1992     return false;
1993   }
1994
1995   private void initConsensus(AlignmentAnnotation aa)
1996   {
1997     aa.hasText = true;
1998     aa.autoCalculated = true;
1999
2000     if (showConsensus)
2001     {
2002       alignment.addAnnotation(aa);
2003     }
2004   }
2005
2006   // these should be extracted from the view model - style and settings for
2007   // derived annotation
2008   private void initGapCounts()
2009   {
2010     if (showOccupancy)
2011     {
2012       gapcounts = new AlignmentAnnotation("Occupancy",
2013               MessageManager.getString("label.occupancy_descr"),
2014               new Annotation[1], 0f, alignment.getHeight(),
2015               AlignmentAnnotation.BAR_GRAPH);
2016       gapcounts.hasText = true;
2017       gapcounts.autoCalculated = true;
2018       gapcounts.scaleColLabel = true;
2019       gapcounts.graph = AlignmentAnnotation.BAR_GRAPH;
2020
2021       alignment.addAnnotation(gapcounts);
2022     }
2023   }
2024
2025   private void initConservation()
2026   {
2027     if (showConservation)
2028     {
2029       if (conservation == null)
2030       {
2031         conservation = new AlignmentAnnotation("Conservation",
2032                 MessageManager.formatMessage("label.conservation_descr",
2033                         getConsPercGaps()),
2034                 new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
2035         conservation.hasText = true;
2036         conservation.autoCalculated = true;
2037         alignment.addAnnotation(conservation);
2038       }
2039     }
2040   }
2041
2042   private void initQuality()
2043   {
2044     if (showQuality)
2045     {
2046       if (quality == null)
2047       {
2048         quality = new AlignmentAnnotation("Quality",
2049                 MessageManager.getString("label.quality_descr"),
2050                 new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
2051         quality.hasText = true;
2052         quality.autoCalculated = true;
2053         alignment.addAnnotation(quality);
2054       }
2055     }
2056   }
2057
2058   private void initRNAStructure()
2059   {
2060     if (alignment.hasRNAStructure() && strucConsensus == null)
2061     {
2062       strucConsensus = new AlignmentAnnotation("StrucConsensus",
2063               MessageManager.getString("label.strucconsensus_descr"),
2064               new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
2065       strucConsensus.hasText = true;
2066       strucConsensus.autoCalculated = true;
2067
2068       if (showConsensus)
2069       {
2070         alignment.addAnnotation(strucConsensus);
2071       }
2072     }
2073   }
2074
2075   /*
2076    * (non-Javadoc)
2077    *
2078    * @see jalview.api.AlignViewportI#calcPanelHeight()
2079    */
2080   @Override
2081   public int calcPanelHeight()
2082   {
2083     // setHeight of panels
2084     AlignmentAnnotation[] anns = getAlignment().getAlignmentAnnotation();
2085     int height = 0;
2086     int charHeight = getCharHeight();
2087     if (anns != null)
2088     {
2089       BitSet graphgrp = new BitSet();
2090       for (AlignmentAnnotation aa : anns)
2091       {
2092         if (aa == null)
2093         {
2094           System.err.println("Null annotation row: ignoring.");
2095           continue;
2096         }
2097         if (!aa.visible)
2098         {
2099           continue;
2100         }
2101         if (aa.graphGroup > -1)
2102         {
2103           if (graphgrp.get(aa.graphGroup))
2104           {
2105             continue;
2106           }
2107           else
2108           {
2109             graphgrp.set(aa.graphGroup);
2110           }
2111         }
2112         aa.height = 0;
2113
2114         if (aa.hasText)
2115         {
2116           aa.height += charHeight;
2117         }
2118
2119         if (aa.hasIcons)
2120         {
2121           aa.height += 16;
2122         }
2123
2124         if (aa.graph > 0)
2125         {
2126           aa.height += aa.graphHeight;
2127         }
2128
2129         if (aa.height == 0)
2130         {
2131           aa.height = 20;
2132         }
2133
2134         height += aa.height;
2135       }
2136     }
2137     if (height == 0)
2138     {
2139       // set minimum
2140       height = 20;
2141     }
2142     return height;
2143   }
2144
2145   @Override
2146   public void updateGroupAnnotationSettings(boolean applyGlobalSettings,
2147           boolean preserveNewGroupSettings)
2148   {
2149     boolean updateCalcs = false;
2150     boolean conv = isShowGroupConservation();
2151     boolean cons = isShowGroupConsensus();
2152     boolean showprf = isShowSequenceLogo();
2153     boolean showConsHist = isShowConsensusHistogram();
2154     boolean normLogo = isNormaliseSequenceLogo();
2155
2156     /**
2157      * TODO reorder the annotation rows according to group/sequence ordering on
2158      * alignment
2159      */
2160     // boolean sortg = true;
2161
2162     // remove old automatic annotation
2163     // add any new annotation
2164
2165     // intersect alignment annotation with alignment groups
2166
2167     AlignmentAnnotation[] aan = alignment.getAlignmentAnnotation();
2168     List<SequenceGroup> oldrfs = new ArrayList<>();
2169     if (aan != null)
2170     {
2171       for (int an = 0; an < aan.length; an++)
2172       {
2173         if (aan[an].autoCalculated && aan[an].groupRef != null)
2174         {
2175           oldrfs.add(aan[an].groupRef);
2176           alignment.deleteAnnotation(aan[an], false);
2177         }
2178       }
2179     }
2180     if (alignment.getGroups() != null)
2181     {
2182       for (SequenceGroup sg : alignment.getGroups())
2183       {
2184         updateCalcs = false;
2185         if (applyGlobalSettings
2186                 || (!preserveNewGroupSettings && !oldrfs.contains(sg)))
2187         {
2188           // set defaults for this group's conservation/consensus
2189           sg.setshowSequenceLogo(showprf);
2190           sg.setShowConsensusHistogram(showConsHist);
2191           sg.setNormaliseSequenceLogo(normLogo);
2192         }
2193         if (conv)
2194         {
2195           updateCalcs = true;
2196           alignment.addAnnotation(sg.getConservationRow(), 0);
2197         }
2198         if (cons)
2199         {
2200           updateCalcs = true;
2201           alignment.addAnnotation(sg.getConsensus(), 0);
2202         }
2203         // refresh the annotation rows
2204         if (updateCalcs)
2205         {
2206           sg.recalcConservation();
2207         }
2208       }
2209     }
2210     oldrfs.clear();
2211   }
2212
2213   @Override
2214   public boolean isDisplayReferenceSeq()
2215   {
2216     return alignment.hasSeqrep() && viewStyle.isDisplayReferenceSeq();
2217   }
2218
2219   @Override
2220   public void setDisplayReferenceSeq(boolean displayReferenceSeq)
2221   {
2222     viewStyle.setDisplayReferenceSeq(displayReferenceSeq);
2223   }
2224
2225   @Override
2226   public boolean isColourByReferenceSeq()
2227   {
2228     return alignment.hasSeqrep() && viewStyle.isColourByReferenceSeq();
2229   }
2230
2231   @Override
2232   public Color getSequenceColour(SequenceI seq)
2233   {
2234     Color sqc = sequenceColours.get(seq);
2235     return (sqc == null ? Color.white : sqc);
2236   }
2237
2238   @Override
2239   public void setSequenceColour(SequenceI seq, Color col)
2240   {
2241     if (col == null)
2242     {
2243       sequenceColours.remove(seq);
2244     }
2245     else
2246     {
2247       sequenceColours.put(seq, col);
2248     }
2249   }
2250
2251   @Override
2252   public void updateSequenceIdColours()
2253   {
2254     for (SequenceGroup sg : alignment.getGroups())
2255     {
2256       if (sg.idColour != null)
2257       {
2258         for (SequenceI s : sg.getSequences(getHiddenRepSequences()))
2259         {
2260           sequenceColours.put(s, sg.idColour);
2261         }
2262       }
2263     }
2264   }
2265
2266   @Override
2267   public void clearSequenceColours()
2268   {
2269     sequenceColours.clear();
2270   }
2271
2272   @Override
2273   public AlignViewportI getCodingComplement()
2274   {
2275     return this.codingComplement;
2276   }
2277
2278   /**
2279    * Set this as the (cDna/protein) complement of the given viewport. Also
2280    * ensures the reverse relationship is set on the given viewport.
2281    */
2282   @Override
2283   public void setCodingComplement(AlignViewportI av)
2284   {
2285     if (this == av)
2286     {
2287       System.err.println("Ignoring recursive setCodingComplement request");
2288     }
2289     else
2290     {
2291       this.codingComplement = av;
2292       // avoid infinite recursion!
2293       if (av.getCodingComplement() != this)
2294       {
2295         av.setCodingComplement(this);
2296       }
2297     }
2298   }
2299
2300   @Override
2301   public boolean isNucleotide()
2302   {
2303     return getAlignment() == null ? false : getAlignment().isNucleotide();
2304   }
2305
2306   @Override
2307   public FeaturesDisplayedI getFeaturesDisplayed()
2308   {
2309     return featuresDisplayed;
2310   }
2311
2312   @Override
2313   public void setFeaturesDisplayed(FeaturesDisplayedI featuresDisplayedI)
2314   {
2315     featuresDisplayed = featuresDisplayedI;
2316   }
2317
2318   @Override
2319   public boolean areFeaturesDisplayed()
2320   {
2321     return featuresDisplayed != null
2322             && featuresDisplayed.getRegisteredFeaturesCount() > 0;
2323   }
2324
2325   /**
2326    * set the flag
2327    *
2328    * @param b
2329    *          features are displayed if true
2330    */
2331   @Override
2332   public void setShowSequenceFeatures(boolean b)
2333   {
2334     viewStyle.setShowSequenceFeatures(b);
2335   }
2336
2337   @Override
2338   public boolean isShowSequenceFeatures()
2339   {
2340     return viewStyle.isShowSequenceFeatures();
2341   }
2342
2343   @Override
2344   public void setShowSequenceFeaturesHeight(boolean selected)
2345   {
2346     viewStyle.setShowSequenceFeaturesHeight(selected);
2347   }
2348
2349   @Override
2350   public boolean isShowSequenceFeaturesHeight()
2351   {
2352     return viewStyle.isShowSequenceFeaturesHeight();
2353   }
2354
2355   @Override
2356   public void setShowAnnotation(boolean b)
2357   {
2358     viewStyle.setShowAnnotation(b);
2359   }
2360
2361   @Override
2362   public boolean isShowAnnotation()
2363   {
2364     return viewStyle.isShowAnnotation();
2365   }
2366
2367   @Override
2368   public boolean isRightAlignIds()
2369   {
2370     return viewStyle.isRightAlignIds();
2371   }
2372
2373   @Override
2374   public void setRightAlignIds(boolean rightAlignIds)
2375   {
2376     viewStyle.setRightAlignIds(rightAlignIds);
2377   }
2378
2379   @Override
2380   public boolean getConservationSelected()
2381   {
2382     return viewStyle.getConservationSelected();
2383   }
2384
2385   @Override
2386   public void setShowBoxes(boolean state)
2387   {
2388     viewStyle.setShowBoxes(state);
2389   }
2390
2391   /**
2392    * @return
2393    * @see jalview.api.ViewStyleI#getTextColour()
2394    */
2395   @Override
2396   public Color getTextColour()
2397   {
2398     return viewStyle.getTextColour();
2399   }
2400
2401   /**
2402    * @return
2403    * @see jalview.api.ViewStyleI#getTextColour2()
2404    */
2405   @Override
2406   public Color getTextColour2()
2407   {
2408     return viewStyle.getTextColour2();
2409   }
2410
2411   /**
2412    * @return
2413    * @see jalview.api.ViewStyleI#getThresholdTextColour()
2414    */
2415   @Override
2416   public int getThresholdTextColour()
2417   {
2418     return viewStyle.getThresholdTextColour();
2419   }
2420
2421   /**
2422    * @return
2423    * @see jalview.api.ViewStyleI#isConservationColourSelected()
2424    */
2425   @Override
2426   public boolean isConservationColourSelected()
2427   {
2428     return viewStyle.isConservationColourSelected();
2429   }
2430
2431   /**
2432    * @return
2433    * @see jalview.api.ViewStyleI#isRenderGaps()
2434    */
2435   @Override
2436   public boolean isRenderGaps()
2437   {
2438     return viewStyle.isRenderGaps();
2439   }
2440
2441   /**
2442    * @return
2443    * @see jalview.api.ViewStyleI#isShowColourText()
2444    */
2445   @Override
2446   public boolean isShowColourText()
2447   {
2448     return viewStyle.isShowColourText();
2449   }
2450
2451   /**
2452    * @param conservationColourSelected
2453    * @see jalview.api.ViewStyleI#setConservationColourSelected(boolean)
2454    */
2455   @Override
2456   public void setConservationColourSelected(
2457           boolean conservationColourSelected)
2458   {
2459     viewStyle.setConservationColourSelected(conservationColourSelected);
2460   }
2461
2462   /**
2463    * @param showColourText
2464    * @see jalview.api.ViewStyleI#setShowColourText(boolean)
2465    */
2466   @Override
2467   public void setShowColourText(boolean showColourText)
2468   {
2469     viewStyle.setShowColourText(showColourText);
2470   }
2471
2472   /**
2473    * @param textColour
2474    * @see jalview.api.ViewStyleI#setTextColour(java.awt.Color)
2475    */
2476   @Override
2477   public void setTextColour(Color textColour)
2478   {
2479     viewStyle.setTextColour(textColour);
2480   }
2481
2482   /**
2483    * @param thresholdTextColour
2484    * @see jalview.api.ViewStyleI#setThresholdTextColour(int)
2485    */
2486   @Override
2487   public void setThresholdTextColour(int thresholdTextColour)
2488   {
2489     viewStyle.setThresholdTextColour(thresholdTextColour);
2490   }
2491
2492   /**
2493    * @param textColour2
2494    * @see jalview.api.ViewStyleI#setTextColour2(java.awt.Color)
2495    */
2496   @Override
2497   public void setTextColour2(Color textColour2)
2498   {
2499     viewStyle.setTextColour2(textColour2);
2500   }
2501
2502   @Override
2503   public ViewStyleI getViewStyle()
2504   {
2505     return new ViewStyle(viewStyle);
2506   }
2507
2508   @Override
2509   public void setViewStyle(ViewStyleI settingsForView)
2510   {
2511     viewStyle = new ViewStyle(settingsForView);
2512     if (residueShading != null)
2513     {
2514       residueShading.setConservationApplied(
2515               settingsForView.isConservationColourSelected());
2516     }
2517   }
2518
2519   @Override
2520   public boolean sameStyle(ViewStyleI them)
2521   {
2522     return viewStyle.sameStyle(them);
2523   }
2524
2525   /**
2526    * @return
2527    * @see jalview.api.ViewStyleI#getIdWidth()
2528    */
2529   @Override
2530   public int getIdWidth()
2531   {
2532     return viewStyle.getIdWidth();
2533   }
2534
2535   /**
2536    * @param i
2537    * @see jalview.api.ViewStyleI#setIdWidth(int)
2538    */
2539   @Override
2540   public void setIdWidth(int i)
2541   {
2542     viewStyle.setIdWidth(i);
2543   }
2544
2545   /**
2546    * @return
2547    * @see jalview.api.ViewStyleI#isCentreColumnLabels()
2548    */
2549   @Override
2550   public boolean isCentreColumnLabels()
2551   {
2552     return viewStyle.isCentreColumnLabels();
2553   }
2554
2555   /**
2556    * @param centreColumnLabels
2557    * @see jalview.api.ViewStyleI#setCentreColumnLabels(boolean)
2558    */
2559   @Override
2560   public void setCentreColumnLabels(boolean centreColumnLabels)
2561   {
2562     viewStyle.setCentreColumnLabels(centreColumnLabels);
2563   }
2564
2565   /**
2566    * @param showdbrefs
2567    * @see jalview.api.ViewStyleI#setShowDBRefs(boolean)
2568    */
2569   @Override
2570   public void setShowDBRefs(boolean showdbrefs)
2571   {
2572     viewStyle.setShowDBRefs(showdbrefs);
2573   }
2574
2575   /**
2576    * @return
2577    * @see jalview.api.ViewStyleI#isShowDBRefs()
2578    */
2579   @Override
2580   public boolean isShowDBRefs()
2581   {
2582     return viewStyle.isShowDBRefs();
2583   }
2584
2585   /**
2586    * @return
2587    * @see jalview.api.ViewStyleI#isShowNPFeats()
2588    */
2589   @Override
2590   public boolean isShowNPFeats()
2591   {
2592     return viewStyle.isShowNPFeats();
2593   }
2594
2595   /**
2596    * @param shownpfeats
2597    * @see jalview.api.ViewStyleI#setShowNPFeats(boolean)
2598    */
2599   @Override
2600   public void setShowNPFeats(boolean shownpfeats)
2601   {
2602     viewStyle.setShowNPFeats(shownpfeats);
2603   }
2604
2605   public abstract StructureSelectionManager getStructureSelectionManager();
2606
2607   /**
2608    * Add one command to the command history list.
2609    *
2610    * @param command
2611    */
2612   public void addToHistoryList(CommandI command)
2613   {
2614     if (this.historyList != null)
2615     {
2616       this.historyList.push(command);
2617       broadcastCommand(command, false);
2618     }
2619   }
2620
2621   protected void broadcastCommand(CommandI command, boolean undo)
2622   {
2623     getStructureSelectionManager().commandPerformed(command, undo,
2624             getVamsasSource());
2625   }
2626
2627   /**
2628    * Add one command to the command redo list.
2629    *
2630    * @param command
2631    */
2632   public void addToRedoList(CommandI command)
2633   {
2634     if (this.redoList != null)
2635     {
2636       this.redoList.push(command);
2637     }
2638     broadcastCommand(command, true);
2639   }
2640
2641   /**
2642    * Clear the command redo list.
2643    */
2644   public void clearRedoList()
2645   {
2646     if (this.redoList != null)
2647     {
2648       this.redoList.clear();
2649     }
2650   }
2651
2652   public void setHistoryList(Deque<CommandI> list)
2653   {
2654     this.historyList = list;
2655   }
2656
2657   public Deque<CommandI> getHistoryList()
2658   {
2659     return this.historyList;
2660   }
2661
2662   public void setRedoList(Deque<CommandI> list)
2663   {
2664     this.redoList = list;
2665   }
2666
2667   public Deque<CommandI> getRedoList()
2668   {
2669     return this.redoList;
2670   }
2671
2672   @Override
2673   public VamsasSource getVamsasSource()
2674   {
2675     return this;
2676   }
2677
2678   public SequenceAnnotationOrder getSortAnnotationsBy()
2679   {
2680     return sortAnnotationsBy;
2681   }
2682
2683   public void setSortAnnotationsBy(
2684           SequenceAnnotationOrder sortAnnotationsBy)
2685   {
2686     this.sortAnnotationsBy = sortAnnotationsBy;
2687   }
2688
2689   public boolean isShowAutocalculatedAbove()
2690   {
2691     return showAutocalculatedAbove;
2692   }
2693
2694   public void setShowAutocalculatedAbove(boolean showAutocalculatedAbove)
2695   {
2696     this.showAutocalculatedAbove = showAutocalculatedAbove;
2697   }
2698
2699   @Override
2700   public boolean isScaleProteinAsCdna()
2701   {
2702     return viewStyle.isScaleProteinAsCdna();
2703   }
2704
2705   @Override
2706   public void setScaleProteinAsCdna(boolean b)
2707   {
2708     viewStyle.setScaleProteinAsCdna(b);
2709   }
2710
2711   @Override
2712   public boolean isProteinFontAsCdna()
2713   {
2714     return viewStyle.isProteinFontAsCdna();
2715   }
2716
2717   @Override
2718   public void setProteinFontAsCdna(boolean b)
2719   {
2720     viewStyle.setProteinFontAsCdna(b);
2721   }
2722
2723   /**
2724    * @return true if view should scroll to show the highlighted region of a
2725    *         sequence
2726    * @return
2727    */
2728   @Override
2729   public final boolean isFollowHighlight()
2730   {
2731     return followHighlight;
2732   }
2733
2734   @Override
2735   public final void setFollowHighlight(boolean b)
2736   {
2737     this.followHighlight = b;
2738   }
2739
2740   @Override
2741   public ViewportRanges getRanges()
2742   {
2743     return ranges;
2744   }
2745
2746   /**
2747    * Helper method to populate the SearchResults with the location in the
2748    * complementary alignment to scroll to, in order to match this one.
2749    *
2750    * @param sr
2751    *          the SearchResults to add to
2752    * @return the offset (below top of visible region) of the matched sequence
2753    */
2754   protected int findComplementScrollTarget(SearchResultsI sr)
2755   {
2756     final AlignViewportI complement = getCodingComplement();
2757     if (complement == null || !complement.isFollowHighlight())
2758     {
2759       return 0;
2760     }
2761     boolean iAmProtein = !getAlignment().isNucleotide();
2762     AlignmentI proteinAlignment = iAmProtein ? getAlignment()
2763             : complement.getAlignment();
2764     if (proteinAlignment == null)
2765     {
2766       return 0;
2767     }
2768     final List<AlignedCodonFrame> mappings = proteinAlignment
2769             .getCodonFrames();
2770
2771     /*
2772      * Heuristic: find the first mapped sequence (if any) with a non-gapped
2773      * residue in the middle column of the visible region. Scroll the
2774      * complementary alignment to line up the corresponding residue.
2775      */
2776     int seqOffset = 0;
2777     SequenceI sequence = null;
2778
2779     /*
2780      * locate 'middle' column (true middle if an odd number visible, left of
2781      * middle if an even number visible)
2782      */
2783     int middleColumn = ranges.getStartRes()
2784             + (ranges.getEndRes() - ranges.getStartRes()) / 2;
2785     final HiddenSequences hiddenSequences = getAlignment()
2786             .getHiddenSequences();
2787
2788     /*
2789      * searching to the bottom of the alignment gives smoother scrolling across
2790      * all gapped visible regions
2791      */
2792     int lastSeq = alignment.getHeight() - 1;
2793     List<AlignedCodonFrame> seqMappings = null;
2794     for (int seqNo = ranges
2795             .getStartSeq(); seqNo <= lastSeq; seqNo++, seqOffset++)
2796     {
2797       sequence = getAlignment().getSequenceAt(seqNo);
2798       if (hiddenSequences != null && hiddenSequences.isHidden(sequence))
2799       {
2800         continue;
2801       }
2802       if (Comparison.isGap(sequence.getCharAt(middleColumn)))
2803       {
2804         continue;
2805       }
2806       seqMappings = MappingUtils.findMappingsForSequenceAndOthers(sequence,
2807               mappings,
2808               getCodingComplement().getAlignment().getSequences());
2809       if (!seqMappings.isEmpty())
2810       {
2811         break;
2812       }
2813     }
2814
2815     if (sequence == null || seqMappings == null || seqMappings.isEmpty())
2816     {
2817       /*
2818        * No ungapped mapped sequence in middle column - do nothing
2819        */
2820       return 0;
2821     }
2822     MappingUtils.addSearchResults(sr, sequence,
2823             sequence.findPosition(middleColumn), seqMappings);
2824     return seqOffset;
2825   }
2826
2827   /**
2828    * synthesize a column selection if none exists so it covers the given
2829    * selection group. if wholewidth is false, no column selection is made if the
2830    * selection group covers the whole alignment width.
2831    *
2832    * @param sg
2833    * @param wholewidth
2834    */
2835   public void expandColSelection(SequenceGroup sg, boolean wholewidth)
2836   {
2837     int sgs, sge;
2838     if (sg != null && (sgs = sg.getStartRes()) >= 0
2839             && sg.getStartRes() <= (sge = sg.getEndRes())
2840             && !this.hasSelectedColumns())
2841     {
2842       if (!wholewidth && alignment.getWidth() == (1 + sge - sgs))
2843       {
2844         // do nothing
2845         return;
2846       }
2847       if (colSel == null)
2848       {
2849         colSel = new ColumnSelection();
2850       }
2851       for (int cspos = sg.getStartRes(); cspos <= sg.getEndRes(); cspos++)
2852       {
2853         colSel.addElement(cspos);
2854       }
2855     }
2856   }
2857
2858   /**
2859    * hold status of current selection group - defined on alignment or not.
2860    */
2861   private boolean selectionIsDefinedGroup = false;
2862
2863   @Override
2864   public boolean isSelectionDefinedGroup()
2865   {
2866     if (selectionGroup == null)
2867     {
2868       return false;
2869     }
2870     if (isSelectionGroupChanged(true))
2871     {
2872       selectionIsDefinedGroup = false;
2873       List<SequenceGroup> gps = alignment.getGroups();
2874       if (gps == null || gps.size() == 0)
2875       {
2876         selectionIsDefinedGroup = false;
2877       }
2878       else
2879       {
2880         selectionIsDefinedGroup = gps.contains(selectionGroup);
2881       }
2882     }
2883     return selectionGroup.isDefined() || selectionIsDefinedGroup;
2884   }
2885
2886   /**
2887    * null, or currently highlighted results on this view
2888    */
2889   private SearchResultsI searchResults = null;
2890
2891   protected TreeModel currentTree = null;
2892
2893   @Override
2894   public boolean hasSearchResults()
2895   {
2896     return searchResults != null;
2897   }
2898
2899   @Override
2900   public void setSearchResults(SearchResultsI results)
2901   {
2902     searchResults = results;
2903   }
2904
2905   @Override
2906   public SearchResultsI getSearchResults()
2907   {
2908     return searchResults;
2909   }
2910
2911   /**
2912    * get the consensus sequence as displayed under the PID consensus annotation
2913    * row.
2914    *
2915    * @return consensus sequence as a new sequence object
2916    */
2917   public SequenceI getConsensusSeq()
2918   {
2919     if (consensus == null)
2920     {
2921       updateConsensus(null);
2922     }
2923     if (consensus == null)
2924     {
2925       return null;
2926     }
2927     StringBuffer seqs = new StringBuffer();
2928     for (int i = 0; i < consensus.annotations.length; i++)
2929     {
2930       Annotation annotation = consensus.annotations[i];
2931       if (annotation != null)
2932       {
2933         String description = annotation.description;
2934         if (description != null && description.startsWith("["))
2935         {
2936           // consensus is a tie - just pick the first one
2937           seqs.append(description.charAt(1));
2938         }
2939         else
2940         {
2941           seqs.append(annotation.displayCharacter);
2942         }
2943       }
2944     }
2945
2946     SequenceI sq = new Sequence("Consensus", seqs.toString());
2947     sq.setDescription("Percentage Identity Consensus "
2948             + ((ignoreGapsInConsensusCalculation) ? " without gaps" : ""));
2949     return sq;
2950   }
2951
2952   @Override
2953   public void setCurrentTree(TreeModel tree)
2954   {
2955     currentTree = tree;
2956   }
2957
2958   @Override
2959   public TreeModel getCurrentTree()
2960   {
2961     return currentTree;
2962   }
2963
2964   @Override
2965   public AlignmentExportData getAlignExportData(AlignExportSettingsI options)
2966   {
2967     AlignmentI alignmentToExport = null;
2968     String[] omitHidden = null;
2969     alignmentToExport = null;
2970
2971     if (hasHiddenColumns() && !options.isExportHiddenColumns())
2972     {
2973       omitHidden = getViewAsString(false,
2974               options.isExportHiddenSequences());
2975     }
2976
2977     int[] alignmentStartEnd = new int[2];
2978     if (hasHiddenRows() && options.isExportHiddenSequences())
2979     {
2980       alignmentToExport = getAlignment().getHiddenSequences()
2981               .getFullAlignment();
2982     }
2983     else
2984     {
2985       alignmentToExport = getAlignment();
2986     }
2987     alignmentStartEnd = getAlignment().getHiddenColumns()
2988             .getVisibleStartAndEndIndex(alignmentToExport.getWidth());
2989     AlignmentExportData ed = new AlignmentExportData(alignmentToExport,
2990             omitHidden, alignmentStartEnd);
2991     return ed;
2992   }
2993
2994   /**
2995    * flag set to indicate if structure views might be out of sync with sequences
2996    * in the alignment
2997    */
2998
2999   private boolean needToUpdateStructureViews = false;
3000
3001   @Override
3002   public boolean isUpdateStructures()
3003   {
3004     return needToUpdateStructureViews;
3005   }
3006
3007   @Override
3008   public void setUpdateStructures(boolean update)
3009   {
3010     needToUpdateStructureViews = update;
3011   }
3012
3013   @Override
3014   public boolean needToUpdateStructureViews()
3015   {
3016     boolean update = needToUpdateStructureViews;
3017     needToUpdateStructureViews = false;
3018     return update;
3019   }
3020
3021   @Override
3022   public void addSequenceGroup(SequenceGroup sequenceGroup)
3023   {
3024     alignment.addGroup(sequenceGroup);
3025
3026     Color col = sequenceGroup.idColour;
3027     if (col != null)
3028     {
3029       col = col.brighter();
3030
3031       for (SequenceI sq : sequenceGroup.getSequences())
3032       {
3033         setSequenceColour(sq, col);
3034       }
3035     }
3036
3037     if (codingComplement != null)
3038     {
3039       SequenceGroup mappedGroup = MappingUtils
3040               .mapSequenceGroup(sequenceGroup, this, codingComplement);
3041       if (mappedGroup.getSequences().size() > 0)
3042       {
3043         codingComplement.getAlignment().addGroup(mappedGroup);
3044
3045         if (col != null)
3046         {
3047           for (SequenceI seq : mappedGroup.getSequences())
3048           {
3049             codingComplement.setSequenceColour(seq, col);
3050           }
3051         }
3052       }
3053       // propagate the structure view update flag according to our own setting
3054       codingComplement.setUpdateStructures(needToUpdateStructureViews);
3055     }
3056   }
3057 }