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