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   private boolean disableFastPaint; // BH 2019.04.18
1327
1328   /**
1329    * BH 2019.04.18 When gap filling is on and a modification is made to fill
1330    * those, we need to disallow fast painting for paste just once
1331    *
1332    * @return
1333    */
1334   public boolean isFastPaintDisabled()
1335   {
1336     boolean ret = disableFastPaint;
1337     disableFastPaint = false;
1338     return ret;
1339   }
1340
1341   /**
1342    * Property change listener for changes in alignment
1343    *
1344    * @param listener
1345    *          DOCUMENT ME!
1346    */
1347   public void addPropertyChangeListener(
1348           java.beans.PropertyChangeListener listener)
1349   {
1350     changeSupport.addPropertyChangeListener(listener);
1351   }
1352
1353   /**
1354    * DOCUMENT ME!
1355    *
1356    * @param listener
1357    *          DOCUMENT ME!
1358    */
1359   public void removePropertyChangeListener(
1360           java.beans.PropertyChangeListener listener)
1361   {
1362     if (changeSupport != null)
1363     {
1364       changeSupport.removePropertyChangeListener(listener);
1365     }
1366   }
1367
1368   /**
1369    * Property change listener for changes in alignment
1370    *
1371    * @param prop
1372    *          DOCUMENT ME!
1373    * @param oldvalue
1374    *          DOCUMENT ME!
1375    * @param newvalue
1376    *          DOCUMENT ME!
1377    */
1378   public void firePropertyChange(String prop, Object oldvalue,
1379           Object newvalue)
1380   {
1381     changeSupport.firePropertyChange(prop, oldvalue, newvalue);
1382   }
1383
1384   // common hide/show column stuff
1385
1386   public void hideSelectedColumns()
1387   {
1388     if (colSel.isEmpty())
1389     {
1390       return;
1391     }
1392
1393     colSel.hideSelectedColumns(alignment);
1394     setSelectionGroup(null);
1395     isColSelChanged(true);
1396   }
1397
1398   public void hideColumns(int start, int end)
1399   {
1400     if (start == end)
1401     {
1402       colSel.hideSelectedColumns(start, alignment.getHiddenColumns());
1403     }
1404     else
1405     {
1406       alignment.getHiddenColumns().hideColumns(start, end);
1407     }
1408     isColSelChanged(true);
1409   }
1410
1411   public void showColumn(int col)
1412   {
1413     alignment.getHiddenColumns().revealHiddenColumns(col, colSel);
1414     isColSelChanged(true);
1415   }
1416
1417   public void showAllHiddenColumns()
1418   {
1419     alignment.getHiddenColumns().revealAllHiddenColumns(colSel);
1420     isColSelChanged(true);
1421   }
1422
1423   // common hide/show seq stuff
1424   public void showAllHiddenSeqs()
1425   {
1426     int startSeq = ranges.getStartSeq();
1427     int endSeq = ranges.getEndSeq();
1428
1429     if (alignment.getHiddenSequences().getSize() > 0)
1430     {
1431       if (selectionGroup == null)
1432       {
1433         selectionGroup = new SequenceGroup();
1434         selectionGroup.setEndRes(alignment.getWidth() - 1);
1435       }
1436       List<SequenceI> tmp = alignment.getHiddenSequences()
1437               .showAll(hiddenRepSequences);
1438       for (SequenceI seq : tmp)
1439       {
1440         selectionGroup.addSequence(seq, false);
1441         setSequenceAnnotationsVisible(seq, true);
1442       }
1443
1444       hiddenRepSequences = null;
1445
1446       ranges.setStartEndSeq(startSeq, endSeq + tmp.size());
1447
1448       firePropertyChange("alignment", null, alignment.getSequences());
1449       // used to set hasHiddenRows/hiddenRepSequences here, after the property
1450       // changed event
1451       sendSelection();
1452     }
1453   }
1454
1455   public void showSequence(int index)
1456   {
1457     int startSeq = ranges.getStartSeq();
1458     int endSeq = ranges.getEndSeq();
1459
1460     List<SequenceI> tmp = alignment.getHiddenSequences().showSequence(index,
1461             hiddenRepSequences);
1462     if (tmp.size() > 0)
1463     {
1464       if (selectionGroup == null)
1465       {
1466         selectionGroup = new SequenceGroup();
1467         selectionGroup.setEndRes(alignment.getWidth() - 1);
1468       }
1469
1470       for (SequenceI seq : tmp)
1471       {
1472         selectionGroup.addSequence(seq, false);
1473         setSequenceAnnotationsVisible(seq, true);
1474       }
1475
1476       ranges.setStartEndSeq(startSeq, endSeq + tmp.size());
1477
1478       firePropertyChange("alignment", null, alignment.getSequences());
1479       sendSelection();
1480     }
1481   }
1482
1483   public void hideAllSelectedSeqs()
1484   {
1485     if (selectionGroup == null || selectionGroup.getSize() < 1)
1486     {
1487       return;
1488     }
1489
1490     SequenceI[] seqs = selectionGroup.getSequencesInOrder(alignment);
1491
1492     hideSequence(seqs);
1493
1494     setSelectionGroup(null);
1495   }
1496
1497   public void hideSequence(SequenceI[] seq)
1498   {
1499     /*
1500      * cache offset to first visible sequence
1501      */
1502     int startSeq = ranges.getStartSeq();
1503
1504     if (seq != null)
1505     {
1506       for (int i = 0; i < seq.length; i++)
1507       {
1508         alignment.getHiddenSequences().hideSequence(seq[i]);
1509         setSequenceAnnotationsVisible(seq[i], false);
1510       }
1511       ranges.setStartSeq(startSeq);
1512       firePropertyChange("alignment", null, alignment.getSequences());
1513     }
1514   }
1515
1516   /**
1517    * Hides the specified sequence, or the sequences it represents
1518    *
1519    * @param sequence
1520    *          the sequence to hide, or keep as representative
1521    * @param representGroup
1522    *          if true, hide the current selection group except for the
1523    *          representative sequence
1524    */
1525   public void hideSequences(SequenceI sequence, boolean representGroup)
1526   {
1527     if (selectionGroup == null || selectionGroup.getSize() < 1)
1528     {
1529       hideSequence(new SequenceI[] { sequence });
1530       return;
1531     }
1532
1533     if (representGroup)
1534     {
1535       hideRepSequences(sequence, selectionGroup);
1536       setSelectionGroup(null);
1537       return;
1538     }
1539
1540     int gsize = selectionGroup.getSize();
1541     SequenceI[] hseqs = selectionGroup.getSequences()
1542             .toArray(new SequenceI[gsize]);
1543
1544     hideSequence(hseqs);
1545     setSelectionGroup(null);
1546     sendSelection();
1547   }
1548
1549   /**
1550    * Set visibility for any annotations for the given sequence.
1551    *
1552    * @param sequenceI
1553    */
1554   protected void setSequenceAnnotationsVisible(SequenceI sequenceI,
1555           boolean visible)
1556   {
1557     AlignmentAnnotation[] anns = alignment.getAlignmentAnnotation();
1558     if (anns != null)
1559     {
1560       for (AlignmentAnnotation ann : anns)
1561       {
1562         if (ann.sequenceRef == sequenceI)
1563         {
1564           ann.visible = visible;
1565         }
1566       }
1567     }
1568   }
1569
1570   public void hideRepSequences(SequenceI repSequence, SequenceGroup sg)
1571   {
1572     int sSize = sg.getSize();
1573     if (sSize < 2)
1574     {
1575       return;
1576     }
1577
1578     if (hiddenRepSequences == null)
1579     {
1580       hiddenRepSequences = new Hashtable<>();
1581     }
1582
1583     hiddenRepSequences.put(repSequence, sg);
1584
1585     // Hide all sequences except the repSequence
1586     SequenceI[] seqs = new SequenceI[sSize - 1];
1587     int index = 0;
1588     for (int i = 0; i < sSize; i++)
1589     {
1590       if (sg.getSequenceAt(i) != repSequence)
1591       {
1592         if (index == sSize - 1)
1593         {
1594           return;
1595         }
1596
1597         seqs[index++] = sg.getSequenceAt(i);
1598       }
1599     }
1600     sg.setSeqrep(repSequence); // note: not done in 2.7applet
1601     sg.setHidereps(true); // note: not done in 2.7applet
1602     hideSequence(seqs);
1603
1604   }
1605
1606   /**
1607    *
1608    * @return null or the current reference sequence
1609    */
1610   public SequenceI getReferenceSeq()
1611   {
1612     return alignment.getSeqrep();
1613   }
1614
1615   /**
1616    * @param seq
1617    * @return true iff seq is the reference for the alignment
1618    */
1619   public boolean isReferenceSeq(SequenceI seq)
1620   {
1621     return alignment.getSeqrep() == seq;
1622   }
1623
1624   /**
1625    *
1626    * @param seq
1627    * @return true if there are sequences represented by this sequence that are
1628    *         currently hidden
1629    */
1630   public boolean isHiddenRepSequence(SequenceI seq)
1631   {
1632     return (hiddenRepSequences != null
1633             && hiddenRepSequences.containsKey(seq));
1634   }
1635
1636   /**
1637    *
1638    * @param seq
1639    * @return null or a sequence group containing the sequences that seq
1640    *         represents
1641    */
1642   public SequenceGroup getRepresentedSequences(SequenceI seq)
1643   {
1644     return (SequenceGroup) (hiddenRepSequences == null ? null
1645             : hiddenRepSequences.get(seq));
1646   }
1647
1648   @Override
1649   public int adjustForHiddenSeqs(int alignmentIndex)
1650   {
1651     return alignment.getHiddenSequences()
1652             .adjustForHiddenSeqs(alignmentIndex);
1653   }
1654
1655   @Override
1656   public void invertColumnSelection()
1657   {
1658     colSel.invertColumnSelection(0, alignment.getWidth(), alignment);
1659     isColSelChanged(true);
1660   }
1661
1662   @Override
1663   public SequenceI[] getSelectionAsNewSequence()
1664   {
1665     SequenceI[] sequences;
1666     // JBPNote: Need to test jalviewLite.getSelectedSequencesAsAlignmentFrom -
1667     // this was the only caller in the applet for this method
1668     // JBPNote: in applet, this method returned references to the alignment
1669     // sequences, and it did not honour the presence/absence of annotation
1670     // attached to the alignment (probably!)
1671     if (selectionGroup == null || selectionGroup.getSize() == 0)
1672     {
1673       sequences = alignment.getSequencesArray();
1674       AlignmentAnnotation[] annots = alignment.getAlignmentAnnotation();
1675       for (int i = 0; i < sequences.length; i++)
1676       {
1677         // construct new sequence with subset of visible annotation
1678         sequences[i] = new Sequence(sequences[i], annots);
1679       }
1680     }
1681     else
1682     {
1683       sequences = selectionGroup.getSelectionAsNewSequences(alignment);
1684     }
1685
1686     return sequences;
1687   }
1688
1689   @Override
1690   public SequenceI[] getSequenceSelection()
1691   {
1692     SequenceI[] sequences = null;
1693     if (selectionGroup != null)
1694     {
1695       sequences = selectionGroup.getSequencesInOrder(alignment);
1696     }
1697     if (sequences == null)
1698     {
1699       sequences = alignment.getSequencesArray();
1700     }
1701     return sequences;
1702   }
1703
1704   @Override
1705   public jalview.datamodel.AlignmentView getAlignmentView(
1706           boolean selectedOnly)
1707   {
1708     return getAlignmentView(selectedOnly, false);
1709   }
1710
1711   @Override
1712   public jalview.datamodel.AlignmentView getAlignmentView(
1713           boolean selectedOnly, boolean markGroups)
1714   {
1715     return new AlignmentView(alignment, alignment.getHiddenColumns(),
1716             selectionGroup,
1717             alignment.getHiddenColumns() != null
1718                     && alignment.getHiddenColumns().hasHiddenColumns(),
1719             selectedOnly, markGroups);
1720   }
1721
1722   @Override
1723   public String[] getViewAsString(boolean selectedRegionOnly)
1724   {
1725     return getViewAsString(selectedRegionOnly, true);
1726   }
1727
1728   @Override
1729   public String[] getViewAsString(boolean selectedRegionOnly,
1730           boolean exportHiddenSeqs)
1731   {
1732     String[] selection = null;
1733     SequenceI[] seqs = null;
1734     int i, iSize;
1735     int start = 0, end = 0;
1736     if (selectedRegionOnly && selectionGroup != null)
1737     {
1738       iSize = selectionGroup.getSize();
1739       seqs = selectionGroup.getSequencesInOrder(alignment);
1740       start = selectionGroup.getStartRes();
1741       end = selectionGroup.getEndRes() + 1;
1742     }
1743     else
1744     {
1745       if (hasHiddenRows() && exportHiddenSeqs)
1746       {
1747         AlignmentI fullAlignment = alignment.getHiddenSequences()
1748                 .getFullAlignment();
1749         iSize = fullAlignment.getHeight();
1750         seqs = fullAlignment.getSequencesArray();
1751         end = fullAlignment.getWidth();
1752       }
1753       else
1754       {
1755         iSize = alignment.getHeight();
1756         seqs = alignment.getSequencesArray();
1757         end = alignment.getWidth();
1758       }
1759     }
1760
1761     selection = new String[iSize];
1762     if (alignment.getHiddenColumns() != null
1763             && alignment.getHiddenColumns().hasHiddenColumns())
1764     {
1765       for (i = 0; i < iSize; i++)
1766       {
1767         Iterator<int[]> blocks = alignment.getHiddenColumns()
1768                 .getVisContigsIterator(start, end + 1, false);
1769         selection[i] = seqs[i].getSequenceStringFromIterator(blocks);
1770       }
1771     }
1772     else
1773     {
1774       for (i = 0; i < iSize; i++)
1775       {
1776         selection[i] = seqs[i].getSequenceAsString(start, end);
1777       }
1778
1779     }
1780     return selection;
1781   }
1782
1783   @Override
1784   public List<int[]> getVisibleRegionBoundaries(int min, int max)
1785   {
1786     ArrayList<int[]> regions = new ArrayList<>();
1787     int start = min;
1788     int end = max;
1789
1790     do
1791     {
1792       HiddenColumns hidden = alignment.getHiddenColumns();
1793       if (hidden != null && hidden.hasHiddenColumns())
1794       {
1795         if (start == 0)
1796         {
1797           start = hidden.visibleToAbsoluteColumn(start);
1798         }
1799
1800         end = hidden.getNextHiddenBoundary(false, start);
1801         if (start == end)
1802         {
1803           end = max;
1804         }
1805         if (end > max)
1806         {
1807           end = max;
1808         }
1809       }
1810
1811       regions.add(new int[] { start, end });
1812
1813       if (hidden != null && hidden.hasHiddenColumns())
1814       {
1815         start = hidden.visibleToAbsoluteColumn(end);
1816         start = hidden.getNextHiddenBoundary(true, start) + 1;
1817       }
1818     } while (end < max);
1819
1820     // int[][] startEnd = new int[regions.size()][2];
1821
1822     return regions;
1823   }
1824
1825   @Override
1826   public List<AlignmentAnnotation> getVisibleAlignmentAnnotation(
1827           boolean selectedOnly)
1828   {
1829     ArrayList<AlignmentAnnotation> ala = new ArrayList<>();
1830     AlignmentAnnotation[] aa;
1831     if ((aa = alignment.getAlignmentAnnotation()) != null)
1832     {
1833       for (AlignmentAnnotation annot : aa)
1834       {
1835         AlignmentAnnotation clone = new AlignmentAnnotation(annot);
1836         if (selectedOnly && selectionGroup != null)
1837         {
1838           clone.makeVisibleAnnotation(
1839                   selectionGroup.getStartRes(), selectionGroup.getEndRes(),
1840                   alignment.getHiddenColumns());
1841         }
1842         else
1843         {
1844           clone.makeVisibleAnnotation(alignment.getHiddenColumns());
1845         }
1846         ala.add(clone);
1847       }
1848     }
1849     return ala;
1850   }
1851
1852   @Override
1853   public boolean isPadGaps()
1854   {
1855     return padGaps;
1856   }
1857
1858   @Override
1859   public void setPadGaps(boolean padGaps)
1860   {
1861     this.padGaps = padGaps;
1862   }
1863
1864   /**
1865    * apply any post-edit constraints and trigger any calculations needed after
1866    * an edit has been performed on the alignment
1867    *
1868    * @param ap
1869    */
1870   @Override
1871   public void alignmentChanged(AlignmentViewPanel ap)
1872   {
1873     if (isPadGaps())
1874     {
1875       if (alignment.padGaps())
1876       {
1877         // the new alignment has been modified -- can't fast paint
1878         disableFastPaint = true;
1879       }
1880     }
1881     if (autoCalculateConsensus)
1882     {
1883       updateConsensus(ap);
1884     }
1885     if (hconsensus != null && autoCalculateConsensus)
1886     {
1887       updateConservation(ap);
1888     }
1889     if (autoCalculateStrucConsensus)
1890     {
1891       updateStrucConsensus(ap);
1892     }
1893
1894     // Reset endRes of groups if beyond alignment width
1895     int alWidth = alignment.getWidth();
1896     List<SequenceGroup> groups = alignment.getGroups();
1897     if (groups != null)
1898     {
1899       for (SequenceGroup sg : groups)
1900       {
1901         if (sg.getEndRes() > alWidth)
1902         {
1903           sg.setEndRes(alWidth - 1);
1904         }
1905       }
1906     }
1907
1908     if (selectionGroup != null && selectionGroup.getEndRes() > alWidth)
1909     {
1910       selectionGroup.setEndRes(alWidth - 1);
1911     }
1912
1913     updateAllColourSchemes();
1914     calculator.restartWorkers();
1915     // alignment.adjustSequenceAnnotations();
1916   }
1917
1918   /**
1919    * reset scope and do calculations for all applied colourschemes on alignment
1920    */
1921   void updateAllColourSchemes()
1922   {
1923     ResidueShaderI rs = residueShading;
1924     if (rs != null)
1925     {
1926       rs.alignmentChanged(alignment, hiddenRepSequences);
1927
1928       rs.setConsensus(hconsensus);
1929       if (rs.conservationApplied())
1930       {
1931         rs.setConservation(Conservation.calculateConservation("All",
1932                 alignment.getSequences(), 0, alignment.getWidth(), false,
1933                 getConsPercGaps(), false));
1934       }
1935     }
1936
1937     for (SequenceGroup sg : alignment.getGroups())
1938     {
1939       if (sg.cs != null)
1940       {
1941         sg.cs.alignmentChanged(sg, hiddenRepSequences);
1942       }
1943       sg.recalcConservation();
1944     }
1945   }
1946
1947   protected void initAutoAnnotation()
1948   {
1949     // TODO: add menu option action that nulls or creates consensus object
1950     // depending on if the user wants to see the annotation or not in a
1951     // specific alignment
1952
1953     if (hconsensus == null && !isDataset)
1954     {
1955       if (!alignment.isNucleotide())
1956       {
1957         initConservation();
1958         initQuality();
1959       }
1960       else
1961       {
1962         initRNAStructure();
1963       }
1964       consensus = new AlignmentAnnotation("Consensus",
1965               MessageManager.getString("label.consensus_descr"),
1966               new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
1967       initConsensus(consensus);
1968       initGapCounts();
1969
1970       initComplementConsensus();
1971     }
1972   }
1973
1974   /**
1975    * If this is a protein alignment and there are mappings to cDNA, adds the
1976    * cDNA consensus annotation and returns true, else returns false.
1977    */
1978   public boolean initComplementConsensus()
1979   {
1980     if (!alignment.isNucleotide())
1981     {
1982       final List<AlignedCodonFrame> codonMappings = alignment
1983               .getCodonFrames();
1984       if (codonMappings != null && !codonMappings.isEmpty())
1985       {
1986         boolean doConsensus = false;
1987         for (AlignedCodonFrame mapping : codonMappings)
1988         {
1989           // TODO hold mapping type e.g. dna-to-protein in AlignedCodonFrame?
1990           MapList[] mapLists = mapping.getdnaToProt();
1991           // mapLists can be empty if project load has not finished resolving
1992           // seqs
1993           if (mapLists.length > 0 && mapLists[0].getFromRatio() == 3)
1994           {
1995             doConsensus = true;
1996             break;
1997           }
1998         }
1999         if (doConsensus)
2000         {
2001           complementConsensus = new AlignmentAnnotation("cDNA Consensus",
2002                   MessageManager
2003                           .getString("label.complement_consensus_descr"),
2004                   new Annotation[1], 0f, 100f,
2005                   AlignmentAnnotation.BAR_GRAPH);
2006           initConsensus(complementConsensus);
2007           return true;
2008         }
2009       }
2010     }
2011     return false;
2012   }
2013
2014   private void initConsensus(AlignmentAnnotation aa)
2015   {
2016     aa.hasText = true;
2017     aa.autoCalculated = true;
2018
2019     if (showConsensus)
2020     {
2021       alignment.addAnnotation(aa);
2022     }
2023   }
2024
2025   // these should be extracted from the view model - style and settings for
2026   // derived annotation
2027   private void initGapCounts()
2028   {
2029     if (showOccupancy)
2030     {
2031       gapcounts = new AlignmentAnnotation("Occupancy",
2032               MessageManager.getString("label.occupancy_descr"),
2033               new Annotation[1], 0f, alignment.getHeight(),
2034               AlignmentAnnotation.BAR_GRAPH);
2035       gapcounts.hasText = true;
2036       gapcounts.autoCalculated = true;
2037       gapcounts.scaleColLabel = true;
2038       gapcounts.graph = AlignmentAnnotation.BAR_GRAPH;
2039
2040       alignment.addAnnotation(gapcounts);
2041     }
2042   }
2043
2044   private void initConservation()
2045   {
2046     if (showConservation)
2047     {
2048       if (conservation == null)
2049       {
2050         conservation = new AlignmentAnnotation("Conservation",
2051                 MessageManager.formatMessage("label.conservation_descr",
2052                         getConsPercGaps()),
2053                 new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
2054         conservation.hasText = true;
2055         conservation.autoCalculated = true;
2056         alignment.addAnnotation(conservation);
2057       }
2058     }
2059   }
2060
2061   private void initQuality()
2062   {
2063     if (showQuality)
2064     {
2065       if (quality == null)
2066       {
2067         quality = new AlignmentAnnotation("Quality",
2068                 MessageManager.getString("label.quality_descr"),
2069                 new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
2070         quality.hasText = true;
2071         quality.autoCalculated = true;
2072         alignment.addAnnotation(quality);
2073       }
2074     }
2075   }
2076
2077   private void initRNAStructure()
2078   {
2079     if (alignment.hasRNAStructure() && strucConsensus == null)
2080     {
2081       strucConsensus = new AlignmentAnnotation("StrucConsensus",
2082               MessageManager.getString("label.strucconsensus_descr"),
2083               new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
2084       strucConsensus.hasText = true;
2085       strucConsensus.autoCalculated = true;
2086
2087       if (showConsensus)
2088       {
2089         alignment.addAnnotation(strucConsensus);
2090       }
2091     }
2092   }
2093
2094   /*
2095    * (non-Javadoc)
2096    *
2097    * @see jalview.api.AlignViewportI#calcPanelHeight()
2098    */
2099   @Override
2100   public int calcPanelHeight()
2101   {
2102     // setHeight of panels
2103     AlignmentAnnotation[] anns = getAlignment().getAlignmentAnnotation();
2104     int height = 0;
2105     int charHeight = getCharHeight();
2106     if (anns != null)
2107     {
2108       BitSet graphgrp = new BitSet();
2109       for (AlignmentAnnotation aa : anns)
2110       {
2111         if (aa == null)
2112         {
2113           System.err.println("Null annotation row: ignoring.");
2114           continue;
2115         }
2116         if (!aa.visible)
2117         {
2118           continue;
2119         }
2120         if (aa.graphGroup > -1)
2121         {
2122           if (graphgrp.get(aa.graphGroup))
2123           {
2124             continue;
2125           }
2126           else
2127           {
2128             graphgrp.set(aa.graphGroup);
2129           }
2130         }
2131         aa.height = 0;
2132
2133         if (aa.hasText)
2134         {
2135           aa.height += charHeight;
2136         }
2137
2138         if (aa.hasIcons)
2139         {
2140           aa.height += 16;
2141         }
2142
2143         if (aa.graph > 0)
2144         {
2145           aa.height += aa.graphHeight;
2146         }
2147
2148         if (aa.height == 0)
2149         {
2150           aa.height = 20;
2151         }
2152
2153         height += aa.height;
2154       }
2155     }
2156     if (height == 0)
2157     {
2158       // set minimum
2159       height = 20;
2160     }
2161     return height;
2162   }
2163
2164   @Override
2165   public void updateGroupAnnotationSettings(boolean applyGlobalSettings,
2166           boolean preserveNewGroupSettings)
2167   {
2168     boolean updateCalcs = false;
2169     boolean conv = isShowGroupConservation();
2170     boolean cons = isShowGroupConsensus();
2171     boolean showprf = isShowSequenceLogo();
2172     boolean showConsHist = isShowConsensusHistogram();
2173     boolean normLogo = isNormaliseSequenceLogo();
2174
2175     /**
2176      * TODO reorder the annotation rows according to group/sequence ordering on
2177      * alignment
2178      */
2179     // boolean sortg = true;
2180
2181     // remove old automatic annotation
2182     // add any new annotation
2183
2184     // intersect alignment annotation with alignment groups
2185
2186     AlignmentAnnotation[] aan = alignment.getAlignmentAnnotation();
2187     List<SequenceGroup> oldrfs = new ArrayList<>();
2188     if (aan != null)
2189     {
2190       for (int an = 0; an < aan.length; an++)
2191       {
2192         if (aan[an].autoCalculated && aan[an].groupRef != null)
2193         {
2194           oldrfs.add(aan[an].groupRef);
2195           alignment.deleteAnnotation(aan[an], false);
2196         }
2197       }
2198     }
2199     if (alignment.getGroups() != null)
2200     {
2201       for (SequenceGroup sg : alignment.getGroups())
2202       {
2203         updateCalcs = false;
2204         if (applyGlobalSettings
2205                 || (!preserveNewGroupSettings && !oldrfs.contains(sg)))
2206         {
2207           // set defaults for this group's conservation/consensus
2208           sg.setshowSequenceLogo(showprf);
2209           sg.setShowConsensusHistogram(showConsHist);
2210           sg.setNormaliseSequenceLogo(normLogo);
2211         }
2212         if (conv)
2213         {
2214           updateCalcs = true;
2215           alignment.addAnnotation(sg.getConservationRow(), 0);
2216         }
2217         if (cons)
2218         {
2219           updateCalcs = true;
2220           alignment.addAnnotation(sg.getConsensus(), 0);
2221         }
2222         // refresh the annotation rows
2223         if (updateCalcs)
2224         {
2225           sg.recalcConservation();
2226         }
2227       }
2228     }
2229     oldrfs.clear();
2230   }
2231
2232   @Override
2233   public boolean isDisplayReferenceSeq()
2234   {
2235     return alignment.hasSeqrep() && viewStyle.isDisplayReferenceSeq();
2236   }
2237
2238   @Override
2239   public void setDisplayReferenceSeq(boolean displayReferenceSeq)
2240   {
2241     viewStyle.setDisplayReferenceSeq(displayReferenceSeq);
2242   }
2243
2244   @Override
2245   public boolean isColourByReferenceSeq()
2246   {
2247     return alignment.hasSeqrep() && viewStyle.isColourByReferenceSeq();
2248   }
2249
2250   @Override
2251   public Color getSequenceColour(SequenceI seq)
2252   {
2253     Color sqc = sequenceColours.get(seq);
2254     return (sqc == null ? Color.white : sqc);
2255   }
2256
2257   @Override
2258   public void setSequenceColour(SequenceI seq, Color col)
2259   {
2260     if (col == null)
2261     {
2262       sequenceColours.remove(seq);
2263     }
2264     else
2265     {
2266       sequenceColours.put(seq, col);
2267     }
2268   }
2269
2270   @Override
2271   public void updateSequenceIdColours()
2272   {
2273     for (SequenceGroup sg : alignment.getGroups())
2274     {
2275       if (sg.idColour != null)
2276       {
2277         for (SequenceI s : sg.getSequences(getHiddenRepSequences()))
2278         {
2279           sequenceColours.put(s, sg.idColour);
2280         }
2281       }
2282     }
2283   }
2284
2285   @Override
2286   public void clearSequenceColours()
2287   {
2288     sequenceColours.clear();
2289   };
2290
2291   @Override
2292   public AlignViewportI getCodingComplement()
2293   {
2294     return this.codingComplement;
2295   }
2296
2297   /**
2298    * Set this as the (cDna/protein) complement of the given viewport. Also
2299    * ensures the reverse relationship is set on the given viewport.
2300    */
2301   @Override
2302   public void setCodingComplement(AlignViewportI av)
2303   {
2304     if (this == av)
2305     {
2306       System.err.println("Ignoring recursive setCodingComplement request");
2307     }
2308     else
2309     {
2310       this.codingComplement = av;
2311       // avoid infinite recursion!
2312       if (av.getCodingComplement() != this)
2313       {
2314         av.setCodingComplement(this);
2315       }
2316     }
2317   }
2318
2319   @Override
2320   public boolean isNucleotide()
2321   {
2322     return getAlignment() == null ? false : getAlignment().isNucleotide();
2323   }
2324
2325   @Override
2326   public FeaturesDisplayedI getFeaturesDisplayed()
2327   {
2328     return featuresDisplayed;
2329   }
2330
2331   @Override
2332   public void setFeaturesDisplayed(FeaturesDisplayedI featuresDisplayedI)
2333   {
2334     featuresDisplayed = featuresDisplayedI;
2335   }
2336
2337   @Override
2338   public boolean areFeaturesDisplayed()
2339   {
2340     return featuresDisplayed != null
2341             && featuresDisplayed.getRegisteredFeaturesCount() > 0;
2342   }
2343
2344   /**
2345    * set the flag
2346    *
2347    * @param b
2348    *          features are displayed if true
2349    */
2350   @Override
2351   public void setShowSequenceFeatures(boolean b)
2352   {
2353     viewStyle.setShowSequenceFeatures(b);
2354   }
2355
2356   @Override
2357   public boolean isShowSequenceFeatures()
2358   {
2359     return viewStyle.isShowSequenceFeatures();
2360   }
2361
2362   @Override
2363   public void setShowSequenceFeaturesHeight(boolean selected)
2364   {
2365     viewStyle.setShowSequenceFeaturesHeight(selected);
2366   }
2367
2368   @Override
2369   public boolean isShowSequenceFeaturesHeight()
2370   {
2371     return viewStyle.isShowSequenceFeaturesHeight();
2372   }
2373
2374   @Override
2375   public void setShowAnnotation(boolean b)
2376   {
2377     viewStyle.setShowAnnotation(b);
2378   }
2379
2380   @Override
2381   public boolean isShowAnnotation()
2382   {
2383     return viewStyle.isShowAnnotation();
2384   }
2385
2386   @Override
2387   public boolean isRightAlignIds()
2388   {
2389     return viewStyle.isRightAlignIds();
2390   }
2391
2392   @Override
2393   public void setRightAlignIds(boolean rightAlignIds)
2394   {
2395     viewStyle.setRightAlignIds(rightAlignIds);
2396   }
2397
2398   @Override
2399   public boolean getConservationSelected()
2400   {
2401     return viewStyle.getConservationSelected();
2402   }
2403
2404   @Override
2405   public void setShowBoxes(boolean state)
2406   {
2407     viewStyle.setShowBoxes(state);
2408   }
2409
2410   /**
2411    * @return
2412    * @see jalview.api.ViewStyleI#getTextColour()
2413    */
2414   @Override
2415   public Color getTextColour()
2416   {
2417     return viewStyle.getTextColour();
2418   }
2419
2420   /**
2421    * @return
2422    * @see jalview.api.ViewStyleI#getTextColour2()
2423    */
2424   @Override
2425   public Color getTextColour2()
2426   {
2427     return viewStyle.getTextColour2();
2428   }
2429
2430   /**
2431    * @return
2432    * @see jalview.api.ViewStyleI#getThresholdTextColour()
2433    */
2434   @Override
2435   public int getThresholdTextColour()
2436   {
2437     return viewStyle.getThresholdTextColour();
2438   }
2439
2440   /**
2441    * @return
2442    * @see jalview.api.ViewStyleI#isConservationColourSelected()
2443    */
2444   @Override
2445   public boolean isConservationColourSelected()
2446   {
2447     return viewStyle.isConservationColourSelected();
2448   }
2449
2450   /**
2451    * @return
2452    * @see jalview.api.ViewStyleI#isRenderGaps()
2453    */
2454   @Override
2455   public boolean isRenderGaps()
2456   {
2457     return viewStyle.isRenderGaps();
2458   }
2459
2460   /**
2461    * @return
2462    * @see jalview.api.ViewStyleI#isShowColourText()
2463    */
2464   @Override
2465   public boolean isShowColourText()
2466   {
2467     return viewStyle.isShowColourText();
2468   }
2469
2470   /**
2471    * @param conservationColourSelected
2472    * @see jalview.api.ViewStyleI#setConservationColourSelected(boolean)
2473    */
2474   @Override
2475   public void setConservationColourSelected(
2476           boolean conservationColourSelected)
2477   {
2478     viewStyle.setConservationColourSelected(conservationColourSelected);
2479   }
2480
2481   /**
2482    * @param showColourText
2483    * @see jalview.api.ViewStyleI#setShowColourText(boolean)
2484    */
2485   @Override
2486   public void setShowColourText(boolean showColourText)
2487   {
2488     viewStyle.setShowColourText(showColourText);
2489   }
2490
2491   /**
2492    * @param textColour
2493    * @see jalview.api.ViewStyleI#setTextColour(java.awt.Color)
2494    */
2495   @Override
2496   public void setTextColour(Color textColour)
2497   {
2498     viewStyle.setTextColour(textColour);
2499   }
2500
2501   /**
2502    * @param thresholdTextColour
2503    * @see jalview.api.ViewStyleI#setThresholdTextColour(int)
2504    */
2505   @Override
2506   public void setThresholdTextColour(int thresholdTextColour)
2507   {
2508     viewStyle.setThresholdTextColour(thresholdTextColour);
2509   }
2510
2511   /**
2512    * @param textColour2
2513    * @see jalview.api.ViewStyleI#setTextColour2(java.awt.Color)
2514    */
2515   @Override
2516   public void setTextColour2(Color textColour2)
2517   {
2518     viewStyle.setTextColour2(textColour2);
2519   }
2520
2521   @Override
2522   public ViewStyleI getViewStyle()
2523   {
2524     return new ViewStyle(viewStyle);
2525   }
2526
2527   @Override
2528   public void setViewStyle(ViewStyleI settingsForView)
2529   {
2530     viewStyle = new ViewStyle(settingsForView);
2531     if (residueShading != null)
2532     {
2533       residueShading.setConservationApplied(
2534               settingsForView.isConservationColourSelected());
2535     }
2536   }
2537
2538   @Override
2539   public boolean sameStyle(ViewStyleI them)
2540   {
2541     return viewStyle.sameStyle(them);
2542   }
2543
2544   /**
2545    * @return
2546    * @see jalview.api.ViewStyleI#getIdWidth()
2547    */
2548   @Override
2549   public int getIdWidth()
2550   {
2551     return viewStyle.getIdWidth();
2552   }
2553
2554   /**
2555    * @param i
2556    * @see jalview.api.ViewStyleI#setIdWidth(int)
2557    */
2558   @Override
2559   public void setIdWidth(int i)
2560   {
2561     viewStyle.setIdWidth(i);
2562   }
2563
2564   /**
2565    * @return
2566    * @see jalview.api.ViewStyleI#isCentreColumnLabels()
2567    */
2568   @Override
2569   public boolean isCentreColumnLabels()
2570   {
2571     return viewStyle.isCentreColumnLabels();
2572   }
2573
2574   /**
2575    * @param centreColumnLabels
2576    * @see jalview.api.ViewStyleI#setCentreColumnLabels(boolean)
2577    */
2578   @Override
2579   public void setCentreColumnLabels(boolean centreColumnLabels)
2580   {
2581     viewStyle.setCentreColumnLabels(centreColumnLabels);
2582   }
2583
2584   /**
2585    * @param showdbrefs
2586    * @see jalview.api.ViewStyleI#setShowDBRefs(boolean)
2587    */
2588   @Override
2589   public void setShowDBRefs(boolean showdbrefs)
2590   {
2591     viewStyle.setShowDBRefs(showdbrefs);
2592   }
2593
2594   /**
2595    * @return
2596    * @see jalview.api.ViewStyleI#isShowDBRefs()
2597    */
2598   @Override
2599   public boolean isShowDBRefs()
2600   {
2601     return viewStyle.isShowDBRefs();
2602   }
2603
2604   /**
2605    * @return
2606    * @see jalview.api.ViewStyleI#isShowNPFeats()
2607    */
2608   @Override
2609   public boolean isShowNPFeats()
2610   {
2611     return viewStyle.isShowNPFeats();
2612   }
2613
2614   /**
2615    * @param shownpfeats
2616    * @see jalview.api.ViewStyleI#setShowNPFeats(boolean)
2617    */
2618   @Override
2619   public void setShowNPFeats(boolean shownpfeats)
2620   {
2621     viewStyle.setShowNPFeats(shownpfeats);
2622   }
2623
2624   public abstract StructureSelectionManager getStructureSelectionManager();
2625
2626   /**
2627    * Add one command to the command history list.
2628    *
2629    * @param command
2630    */
2631   public void addToHistoryList(CommandI command)
2632   {
2633     if (this.historyList != null)
2634     {
2635       this.historyList.push(command);
2636       broadcastCommand(command, false);
2637     }
2638   }
2639
2640   protected void broadcastCommand(CommandI command, boolean undo)
2641   {
2642     getStructureSelectionManager().commandPerformed(command, undo,
2643             getVamsasSource());
2644   }
2645
2646   /**
2647    * Add one command to the command redo list.
2648    *
2649    * @param command
2650    */
2651   public void addToRedoList(CommandI command)
2652   {
2653     if (this.redoList != null)
2654     {
2655       this.redoList.push(command);
2656     }
2657     broadcastCommand(command, true);
2658   }
2659
2660   /**
2661    * Clear the command redo list.
2662    */
2663   public void clearRedoList()
2664   {
2665     if (this.redoList != null)
2666     {
2667       this.redoList.clear();
2668     }
2669   }
2670
2671   public void setHistoryList(Deque<CommandI> list)
2672   {
2673     this.historyList = list;
2674   }
2675
2676   public Deque<CommandI> getHistoryList()
2677   {
2678     return this.historyList;
2679   }
2680
2681   public void setRedoList(Deque<CommandI> list)
2682   {
2683     this.redoList = list;
2684   }
2685
2686   public Deque<CommandI> getRedoList()
2687   {
2688     return this.redoList;
2689   }
2690
2691   @Override
2692   public VamsasSource getVamsasSource()
2693   {
2694     return this;
2695   }
2696
2697   public SequenceAnnotationOrder getSortAnnotationsBy()
2698   {
2699     return sortAnnotationsBy;
2700   }
2701
2702   public void setSortAnnotationsBy(
2703           SequenceAnnotationOrder sortAnnotationsBy)
2704   {
2705     this.sortAnnotationsBy = sortAnnotationsBy;
2706   }
2707
2708   public boolean isShowAutocalculatedAbove()
2709   {
2710     return showAutocalculatedAbove;
2711   }
2712
2713   public void setShowAutocalculatedAbove(boolean showAutocalculatedAbove)
2714   {
2715     this.showAutocalculatedAbove = showAutocalculatedAbove;
2716   }
2717
2718   @Override
2719   public boolean isScaleProteinAsCdna()
2720   {
2721     return viewStyle.isScaleProteinAsCdna();
2722   }
2723
2724   @Override
2725   public void setScaleProteinAsCdna(boolean b)
2726   {
2727     viewStyle.setScaleProteinAsCdna(b);
2728   }
2729
2730   @Override
2731   public boolean isProteinFontAsCdna()
2732   {
2733     return viewStyle.isProteinFontAsCdna();
2734   }
2735
2736   @Override
2737   public void setProteinFontAsCdna(boolean b)
2738   {
2739     viewStyle.setProteinFontAsCdna(b);
2740   }
2741
2742   /**
2743    * @return true if view should scroll to show the highlighted region of a
2744    *         sequence
2745    * @return
2746    */
2747   @Override
2748   public final boolean isFollowHighlight()
2749   {
2750     return followHighlight;
2751   }
2752
2753   @Override
2754   public final void setFollowHighlight(boolean b)
2755   {
2756     this.followHighlight = b;
2757   }
2758
2759   @Override
2760   public ViewportRanges getRanges()
2761   {
2762     return ranges;
2763   }
2764
2765   /**
2766    * Helper method to populate the SearchResults with the location in the
2767    * complementary alignment to scroll to, in order to match this one.
2768    *
2769    * @param sr
2770    *          the SearchResults to add to
2771    * @return the offset (below top of visible region) of the matched sequence
2772    */
2773   protected int findComplementScrollTarget(SearchResultsI sr)
2774   {
2775     final AlignViewportI complement = getCodingComplement();
2776     if (complement == null || !complement.isFollowHighlight())
2777     {
2778       return 0;
2779     }
2780     boolean iAmProtein = !getAlignment().isNucleotide();
2781     AlignmentI proteinAlignment = iAmProtein ? getAlignment()
2782             : complement.getAlignment();
2783     if (proteinAlignment == null)
2784     {
2785       return 0;
2786     }
2787     final List<AlignedCodonFrame> mappings = proteinAlignment
2788             .getCodonFrames();
2789
2790     /*
2791      * Heuristic: find the first mapped sequence (if any) with a non-gapped
2792      * residue in the middle column of the visible region. Scroll the
2793      * complementary alignment to line up the corresponding residue.
2794      */
2795     int seqOffset = 0;
2796     SequenceI sequence = null;
2797
2798     /*
2799      * locate 'middle' column (true middle if an odd number visible, left of
2800      * middle if an even number visible)
2801      */
2802     int middleColumn = ranges.getStartRes()
2803             + (ranges.getEndRes() - ranges.getStartRes()) / 2;
2804     final HiddenSequences hiddenSequences = getAlignment()
2805             .getHiddenSequences();
2806
2807     /*
2808      * searching to the bottom of the alignment gives smoother scrolling across
2809      * all gapped visible regions
2810      */
2811     int lastSeq = alignment.getHeight() - 1;
2812     List<AlignedCodonFrame> seqMappings = null;
2813     for (int seqNo = ranges
2814             .getStartSeq(); seqNo <= lastSeq; seqNo++, seqOffset++)
2815     {
2816       sequence = getAlignment().getSequenceAt(seqNo);
2817       if (hiddenSequences != null && hiddenSequences.isHidden(sequence))
2818       {
2819         continue;
2820       }
2821       if (Comparison.isGap(sequence.getCharAt(middleColumn)))
2822       {
2823         continue;
2824       }
2825       seqMappings = MappingUtils.findMappingsForSequenceAndOthers(sequence,
2826               mappings,
2827               getCodingComplement().getAlignment().getSequences());
2828       if (!seqMappings.isEmpty())
2829       {
2830         break;
2831       }
2832     }
2833
2834     if (sequence == null || seqMappings == null || seqMappings.isEmpty())
2835     {
2836       /*
2837        * No ungapped mapped sequence in middle column - do nothing
2838        */
2839       return 0;
2840     }
2841     MappingUtils.addSearchResults(sr, sequence,
2842             sequence.findPosition(middleColumn), seqMappings);
2843     return seqOffset;
2844   }
2845
2846   /**
2847    * synthesize a column selection if none exists so it covers the given
2848    * selection group. if wholewidth is false, no column selection is made if the
2849    * selection group covers the whole alignment width.
2850    *
2851    * @param sg
2852    * @param wholewidth
2853    */
2854   public void expandColSelection(SequenceGroup sg, boolean wholewidth)
2855   {
2856     int sgs, sge;
2857     if (sg != null && (sgs = sg.getStartRes()) >= 0
2858             && sg.getStartRes() <= (sge = sg.getEndRes())
2859             && !this.hasSelectedColumns())
2860     {
2861       if (!wholewidth && alignment.getWidth() == (1 + sge - sgs))
2862       {
2863         // do nothing
2864         return;
2865       }
2866       if (colSel == null)
2867       {
2868         colSel = new ColumnSelection();
2869       }
2870       for (int cspos = sg.getStartRes(); cspos <= sg.getEndRes(); cspos++)
2871       {
2872         colSel.addElement(cspos);
2873       }
2874     }
2875   }
2876
2877   /**
2878    * hold status of current selection group - defined on alignment or not.
2879    */
2880   private boolean selectionIsDefinedGroup = false;
2881
2882   @Override
2883   public boolean isSelectionDefinedGroup()
2884   {
2885     if (selectionGroup == null)
2886     {
2887       return false;
2888     }
2889     if (isSelectionGroupChanged(true))
2890     {
2891       selectionIsDefinedGroup = false;
2892       List<SequenceGroup> gps = alignment.getGroups();
2893       if (gps == null || gps.size() == 0)
2894       {
2895         selectionIsDefinedGroup = false;
2896       }
2897       else
2898       {
2899         selectionIsDefinedGroup = gps.contains(selectionGroup);
2900       }
2901     }
2902     return selectionGroup.isDefined() || selectionIsDefinedGroup;
2903   }
2904
2905   /**
2906    * null, or currently highlighted results on this view
2907    */
2908   private SearchResultsI searchResults = null;
2909
2910   protected TreeModel currentTree = null;
2911
2912   @Override
2913   public boolean hasSearchResults()
2914   {
2915     return searchResults != null;
2916   }
2917
2918   @Override
2919   public void setSearchResults(SearchResultsI results)
2920   {
2921     searchResults = results;
2922   }
2923
2924   @Override
2925   public SearchResultsI getSearchResults()
2926   {
2927     return searchResults;
2928   }
2929
2930   /**
2931    * get the consensus sequence as displayed under the PID consensus annotation
2932    * row.
2933    *
2934    * @return consensus sequence as a new sequence object
2935    */
2936   public SequenceI getConsensusSeq()
2937   {
2938     if (consensus == null)
2939     {
2940       updateConsensus(null);
2941     }
2942     if (consensus == null)
2943     {
2944       return null;
2945     }
2946     StringBuffer seqs = new StringBuffer();
2947     for (int i = 0; i < consensus.annotations.length; i++)
2948     {
2949       Annotation annotation = consensus.annotations[i];
2950       if (annotation != null)
2951       {
2952         String description = annotation.description;
2953         if (description != null && description.startsWith("["))
2954         {
2955           // consensus is a tie - just pick the first one
2956           seqs.append(description.charAt(1));
2957         }
2958         else
2959         {
2960           seqs.append(annotation.displayCharacter);
2961         }
2962       }
2963     }
2964
2965     SequenceI sq = new Sequence("Consensus", seqs.toString());
2966     sq.setDescription("Percentage Identity Consensus "
2967             + ((ignoreGapsInConsensusCalculation) ? " without gaps" : ""));
2968     return sq;
2969   }
2970
2971   @Override
2972   public void setCurrentTree(TreeModel tree)
2973   {
2974     currentTree = tree;
2975   }
2976
2977   @Override
2978   public TreeModel getCurrentTree()
2979   {
2980     return currentTree;
2981   }
2982
2983   @Override
2984   public AlignmentExportData getAlignExportData(AlignExportSettingsI options)
2985   {
2986     AlignmentI alignmentToExport = null;
2987     String[] omitHidden = null;
2988     alignmentToExport = null;
2989
2990     if (hasHiddenColumns() && !options.isExportHiddenColumns())
2991     {
2992       omitHidden = getViewAsString(false,
2993               options.isExportHiddenSequences());
2994     }
2995
2996     int[] alignmentStartEnd = new int[2];
2997     if (hasHiddenRows() && options.isExportHiddenSequences())
2998     {
2999       alignmentToExport = getAlignment().getHiddenSequences()
3000               .getFullAlignment();
3001     }
3002     else
3003     {
3004       alignmentToExport = getAlignment();
3005     }
3006     alignmentStartEnd = getAlignment().getHiddenColumns()
3007             .getVisibleStartAndEndIndex(alignmentToExport.getWidth());
3008     AlignmentExportData ed = new AlignmentExportData(alignmentToExport,
3009             omitHidden, alignmentStartEnd);
3010     return ed;
3011   }
3012
3013   /**
3014    * flag set to indicate if structure views might be out of sync with sequences
3015    * in the alignment
3016    */
3017
3018   private boolean needToUpdateStructureViews = false;
3019
3020   @Override
3021   public boolean isUpdateStructures()
3022   {
3023     return needToUpdateStructureViews;
3024   }
3025
3026   @Override
3027   public void setUpdateStructures(boolean update)
3028   {
3029     needToUpdateStructureViews = update;
3030   }
3031
3032   @Override
3033   public boolean needToUpdateStructureViews()
3034   {
3035     boolean update = needToUpdateStructureViews;
3036     needToUpdateStructureViews = false;
3037     return update;
3038   }
3039
3040   @Override
3041   public void addSequenceGroup(SequenceGroup sequenceGroup)
3042   {
3043     alignment.addGroup(sequenceGroup);
3044
3045     Color col = sequenceGroup.idColour;
3046     if (col != null)
3047     {
3048       col = col.brighter();
3049
3050       for (SequenceI sq : sequenceGroup.getSequences())
3051       {
3052         setSequenceColour(sq, col);
3053       }
3054     }
3055
3056     if (codingComplement != null)
3057     {
3058       SequenceGroup mappedGroup = MappingUtils
3059               .mapSequenceGroup(sequenceGroup, this, codingComplement);
3060       if (mappedGroup.getSequences().size() > 0)
3061       {
3062         codingComplement.getAlignment().addGroup(mappedGroup);
3063
3064         if (col != null)
3065         {
3066           for (SequenceI seq : mappedGroup.getSequences())
3067           {
3068             codingComplement.setSequenceColour(seq, col);
3069           }
3070         }
3071       }
3072       // propagate the structure view update flag according to our own setting
3073       codingComplement.setUpdateStructures(needToUpdateStructureViews);
3074     }
3075   }
3076 }