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