src/jalview/gui/AlignViewport.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.gui;
  22
  23 import jalview.analysis.AlignmentUtils;
  24 import jalview.analysis.AnnotationSorter.SequenceAnnotationOrder;
  25 import jalview.api.AlignViewportI;
  26 import jalview.api.AlignmentViewPanel;
  27 import jalview.api.FeatureColourI;
  28 import jalview.api.FeatureSettingsModelI;
  29 import jalview.api.FeaturesDisplayedI;
  30 import jalview.api.ViewStyleI;
  31 import jalview.bin.Cache;
  32 import jalview.commands.CommandI;
  33 import jalview.datamodel.AlignedCodonFrame;
  34 import jalview.datamodel.Alignment;
  35 import jalview.datamodel.AlignmentI;
  36 import jalview.datamodel.ColumnSelection;
  37 import jalview.datamodel.HiddenColumns;
  38 import jalview.datamodel.SearchResults;
  39 import jalview.datamodel.SearchResultsI;
  40 import jalview.datamodel.SequenceGroup;
  41 import jalview.datamodel.SequenceI;
  42 import jalview.renderer.ResidueShader;
  43 import jalview.schemes.ColourSchemeI;
  44 import jalview.schemes.ColourSchemeProperty;
  45 import jalview.schemes.ResidueColourScheme;
  46 import jalview.schemes.UserColourScheme;
  47 import jalview.structure.SelectionSource;
  48 import jalview.structure.StructureSelectionManager;
  49 import jalview.structure.VamsasSource;
  50 import jalview.util.MessageManager;
  51 import jalview.viewmodel.AlignmentViewport;
  52 import jalview.ws.params.AutoCalcSetting;
  53
  54 import java.awt.Container;
  55 import java.awt.Dimension;
  56 import java.awt.Font;
  57 import java.awt.FontMetrics;
  58 import java.awt.Rectangle;
  59 import java.util.Hashtable;
  60 import java.util.Iterator;
  61 import java.util.List;
  62
  63 import javax.swing.JInternalFrame;
  64
  65 /**
  66  * DOCUMENT ME!
  67  *
  68  * @author $author$
  69  * @version $Revision: 1.141 $
  70  */
  71 public class AlignViewport extends AlignmentViewport
  72         implements SelectionSource
  73 {
  74   Font font;
  75
  76   boolean cursorMode = false;
  77
  78   boolean antiAlias = false;
  79
  80   private Rectangle explodedGeometry;
  81
  82   private String viewName;
  83
  84   /*
  85    * Flag set true on the view that should 'gather' multiple views of the same
  86    * sequence set id when a project is reloaded. Set false on all views when
  87    * they are 'exploded' into separate windows. Set true on the current view
  88    * when 'Gather' is performed, and also on the first tab when the first new
  89    * view is created.
  90    */
  91   private boolean gatherViewsHere = false;
  92
  93   private AnnotationColumnChooser annotationColumnSelectionState;
  94
  95   /**
  96    * Creates a new AlignViewport object.
  97    *
  98    * @param al
  99    *          alignment to view
 100    */
 101   public AlignViewport(AlignmentI al)
 102   {
 103     super(al);
 104     init();
 105   }
 106
 107   /**
 108    * Create a new AlignViewport object with a specific sequence set ID
 109    *
 110    * @param al
 111    * @param seqsetid
 112    *          (may be null - but potential for ambiguous constructor exception)
 113    */
 114   public AlignViewport(AlignmentI al, String seqsetid)
 115   {
 116     this(al, seqsetid, null);
 117   }
 118
 119   public AlignViewport(AlignmentI al, String seqsetid, String viewid)
 120   {
 121     super(al);
 122     sequenceSetID = seqsetid;
 123     viewId = viewid;
 124     // TODO remove these once 2.4.VAMSAS release finished
 125     if (Cache.log != null && Cache.log.isDebugEnabled() && seqsetid != null)
 126     {
 127       Cache.log.debug(
 128               "Setting viewport's sequence set id : " + sequenceSetID);
 129     }
 130     if (Cache.log != null && Cache.log.isDebugEnabled() && viewId != null)
 131     {
 132       Cache.log.debug("Setting viewport's view id : " + viewId);
 133     }
 134     init();
 135
 136   }
 137
 138   /**
 139    * Create a new AlignViewport with hidden regions
 140    *
 141    * @param al
 142    *          AlignmentI
 143    * @param hiddenColumns
 144    *          ColumnSelection
 145    */
 146   public AlignViewport(AlignmentI al, HiddenColumns hiddenColumns)
 147   {
 148     super(al);
 149     if (hiddenColumns != null)
 150     {
 151       al.setHiddenColumns(hiddenColumns);
 152     }
 153     init();
 154   }
 155
 156   /**
 157    * New viewport with hidden columns and an existing sequence set id
 158    *
 159    * @param al
 160    * @param hiddenColumns
 161    * @param seqsetid
 162    *          (may be null)
 163    */
 164   public AlignViewport(AlignmentI al, HiddenColumns hiddenColumns,
 165           String seqsetid)
 166   {
 167     this(al, hiddenColumns, seqsetid, null);
 168   }
 169
 170   /**
 171    * New viewport with hidden columns and an existing sequence set id and viewid
 172    *
 173    * @param al
 174    * @param hiddenColumns
 175    * @param seqsetid
 176    *          (may be null)
 177    * @param viewid
 178    *          (may be null)
 179    */
 180   public AlignViewport(AlignmentI al, HiddenColumns hiddenColumns,
 181           String seqsetid, String viewid)
 182   {
 183     super(al);
 184     sequenceSetID = seqsetid;
 185     viewId = viewid;
 186     // TODO remove these once 2.4.VAMSAS release finished
 187     if (Cache.log != null && Cache.log.isDebugEnabled() && seqsetid != null)
 188     {
 189       Cache.log.debug(
 190               "Setting viewport's sequence set id : " + sequenceSetID);
 191     }
 192     if (Cache.log != null && Cache.log.isDebugEnabled() && viewId != null)
 193     {
 194       Cache.log.debug("Setting viewport's view id : " + viewId);
 195     }
 196
 197     if (hiddenColumns != null)
 198     {
 199       al.setHiddenColumns(hiddenColumns);
 200     }
 201     init();
 202   }
 203
 204   /**
 205    * Apply any settings saved in user preferences
 206    */
 207   private void applyViewProperties()
 208   {
 209     antiAlias = Cache.getDefault("ANTI_ALIAS", false);
 210
 211     viewStyle.setShowJVSuffix(Cache.getDefault("SHOW_JVSUFFIX", true));
 212     setShowAnnotation(Cache.getDefault(Preferences.SHOW_ANNOTATIONS, true));
 213
 214     setRightAlignIds(Cache.getDefault("RIGHT_ALIGN_IDS", false));
 215     setCentreColumnLabels(Cache.getDefault("CENTRE_COLUMN_LABELS", false));
 216     autoCalculateConsensus = Cache.getDefault("AUTO_CALC_CONSENSUS", true);
 217
 218     setPadGaps(Cache.getDefault("PAD_GAPS", true));
 219     setShowNPFeats(Cache.getDefault("SHOW_NPFEATS_TOOLTIP", true));
 220     setShowDBRefs(Cache.getDefault("SHOW_DBREFS_TOOLTIP", true));
 221     viewStyle.setSeqNameItalics(Cache.getDefault("ID_ITALICS", true));
 222     viewStyle.setWrapAlignment(
 223             Cache.getDefault(Preferences.WRAP_ALIGNMENT, false));
 224     viewStyle.setShowUnconserved(
 225             Cache.getDefault(Preferences.SHOW_UNCONSERVED, false));
 226     sortByTree = Cache.getDefault(Preferences.SORT_BY_TREE, false);
 227     followSelection = Cache.getDefault("FOLLOW_SELECTIONS", true);
 228     sortAnnotationsBy = SequenceAnnotationOrder
 229             .valueOf(Cache.getDefault(Preferences.SORT_ANNOTATIONS,
 230                     SequenceAnnotationOrder.NONE.name()));
 231     showAutocalculatedAbove = Cache
 232             .getDefault(Preferences.SHOW_AUTOCALC_ABOVE, false);
 233     viewStyle.setScaleProteinAsCdna(
 234             Cache.getDefault(Preferences.SCALE_PROTEIN_TO_CDNA, true));
 235   }
 236
 237   void init()
 238   {
 239     applyViewProperties();
 240
 241     String fontName = Cache.getDefault("FONT_NAME", "SansSerif");
 242     String fontStyle = Cache.getDefault("FONT_STYLE", Font.PLAIN + "");
 243     String fontSize = Cache.getDefault("FONT_SIZE", "10");
 244
 245     int style = 0;
 246
 247     if (fontStyle.equals("bold"))
 248     {
 249       style = 1;
 250     }
 251     else if (fontStyle.equals("italic"))
 252     {
 253       style = 2;
 254     }
 255
 256     setFont(new Font(fontName, style, Integer.parseInt(fontSize)), true);
 257
 258     alignment
 259             .setGapCharacter(Cache.getDefault("GAP_SYMBOL", "-").charAt(0));
 260
 261     // We must set conservation and consensus before setting colour,
 262     // as Blosum and Clustal require this to be done
 263     if (hconsensus == null && !isDataset)
 264     {
 265       if (!alignment.isNucleotide())
 266       {
 267         showConservation = Cache.getDefault(Preferences.SHOW_CONSERVATION, true);
 268         showQuality = Cache.getDefault(Preferences.SHOW_QUALITY, true);
 269         showGroupConservation = Cache.getDefault("SHOW_GROUP_CONSERVATION",
 270                 false);
 271       }
 272       showConsensusHistogram = Cache.getDefault("SHOW_CONSENSUS_HISTOGRAM",
 273               true);
 274       showSequenceLogo = Cache.getDefault(Preferences.SHOW_CONSENSUS_LOGO, false);
 275
 276       normaliseSequenceLogo = Cache.getDefault(
 277               Preferences.NORMALISE_CONSENSUS_LOGO,
 278               false);
 279       showGroupConsensus = Cache
 280               .getDefault(Preferences.SHOW_GROUP_CONSENSUS, false);
 281       showConsensus = Cache.getDefault("SHOW_IDENTITY", true);
 282
 283       showOccupancy = Cache.getDefault(Preferences.SHOW_OCCUPANCY, true);
 284     }
 285     initAutoAnnotation();
 286     String colourProperty = alignment.isNucleotide()
 287             ? Preferences.DEFAULT_COLOUR_NUC
 288             : Preferences.DEFAULT_COLOUR_PROT;
 289     String schemeName = Cache.getProperty(colourProperty);
 290     if (schemeName == null)
 291     {
 292       // only DEFAULT_COLOUR available in Jalview before 2.9
 293       schemeName = Cache.getDefault(Preferences.DEFAULT_COLOUR,
 294               ResidueColourScheme.NONE);
 295     }
 296     ColourSchemeI colourScheme = ColourSchemeProperty
 297             .getColourScheme(this, alignment, schemeName);
 298     residueShading = new ResidueShader(colourScheme);
 299
 300     if (colourScheme instanceof UserColourScheme)
 301     {
 302       residueShading = new ResidueShader(
 303               UserDefinedColours.loadDefaultColours());
 304       residueShading.setThreshold(0, isIgnoreGapsConsensus());
 305     }
 306
 307     if (residueShading != null)
 308     {
 309       residueShading.setConsensus(hconsensus);
 310     }
 311     setColourAppliesToAllGroups(true);
 312   }
 313
 314   boolean validCharWidth;
 315
 316   /**
 317    * {@inheritDoc}
 318    */
 319   @Override
 320   public void setFont(Font f, boolean setGrid)
 321   {
 322     font = f;
 323
 324     Container c = new Container();
 325
 326     if (setGrid)
 327     {
 328       FontMetrics fm = c.getFontMetrics(font);
 329       int ww = fm.charWidth('M');
 330       setCharHeight(fm.getHeight());
 331       setCharWidth(ww);
 332     }
 333     viewStyle.setFontName(font.getName());
 334     viewStyle.setFontStyle(font.getStyle());
 335     viewStyle.setFontSize(font.getSize());
 336
 337     validCharWidth = true;
 338   }
 339
 340   @Override
 341   public void setViewStyle(ViewStyleI settingsForView)
 342   {
 343     super.setViewStyle(settingsForView);
 344     setFont(new Font(viewStyle.getFontName(), viewStyle.getFontStyle(),
 345             viewStyle.getFontSize()), false);
 346   }
 347
 348   /**
 349    * DOCUMENT ME!
 350    *
 351    * @return DOCUMENT ME!
 352    */
 353   public Font getFont()
 354   {
 355     return font;
 356   }
 357
 358   /**
 359    * DOCUMENT ME!
 360    *
 361    * @param align
 362    *          DOCUMENT ME!
 363    */
 364   @Override
 365   public void setAlignment(AlignmentI align)
 366   {
 367     replaceMappings(align);
 368     super.setAlignment(align);
 369   }
 370
 371   /**
 372    * Replace any codon mappings for this viewport with those for the given
 373    * viewport
 374    *
 375    * @param align
 376    */
 377   public void replaceMappings(AlignmentI align)
 378   {
 379
 380     /*
 381      * Deregister current mappings (if any)
 382      */
 383     deregisterMappings();
 384
 385     /*
 386      * Register new mappings (if any)
 387      */
 388     if (align != null)
 389     {
 390       Desktop.getInstance().getStructureSelectionManager()
 391               .registerMappings(align.getCodonFrames());
 392     }
 393
 394     /*
 395      * replace mappings on our alignment
 396      */
 397     if (alignment != null && align != null)
 398     {
 399       alignment.setCodonFrames(align.getCodonFrames());
 400     }
 401   }
 402
 403   protected void deregisterMappings()
 404   {
 405     AlignmentI al = getAlignment();
 406     if (al != null)
 407     {
 408       List<AlignedCodonFrame> mappings = al.getCodonFrames();
 409       if (mappings != null)
 410       {
 411         StructureSelectionManager ssm = Desktop.getInstance()
 412                 .getStructureSelectionManager();
 413         for (AlignedCodonFrame acf : mappings)
 414         {
 415           if (noReferencesTo(acf))
 416           {
 417             ssm.deregisterMapping(acf);
 418           }
 419         }
 420       }
 421     }
 422   }
 423
 424   /**
 425    * DOCUMENT ME!
 426    *
 427    * @return DOCUMENT ME!
 428    */
 429   @Override
 430   public char getGapCharacter()
 431   {
 432     return getAlignment().getGapCharacter();
 433   }
 434
 435   /**
 436    * DOCUMENT ME!
 437    *
 438    * @param gap
 439    *          DOCUMENT ME!
 440    */
 441   public void setGapCharacter(char gap)
 442   {
 443     if (getAlignment() != null)
 444     {
 445       getAlignment().setGapCharacter(gap);
 446     }
 447   }
 448
 449   /**
 450    * returns the visible column regions of the alignment
 451    *
 452    * @param selectedRegionOnly
 453    *          true to just return the contigs intersecting with the selected
 454    *          area
 455    * @return
 456    */
 457   public Iterator<int[]> getViewAsVisibleContigs(boolean selectedRegionOnly)
 458   {
 459     int start = 0;
 460     int end = 0;
 461     if (selectedRegionOnly && selectionGroup != null)
 462     {
 463       start = selectionGroup.getStartRes();
 464       end = selectionGroup.getEndRes() + 1;
 465     }
 466     else
 467     {
 468       end = alignment.getWidth();
 469     }
 470     return (alignment.getHiddenColumns().getVisContigsIterator(start, end,
 471             false));
 472   }
 473
 474   /**
 475    * get hash of undo and redo list for the alignment
 476    *
 477    * @return long[] { historyList.hashCode, redoList.hashCode };
 478    */
 479   public long[] getUndoRedoHash()
 480   {
 481     // TODO: JAL-1126
 482     if (historyList == null || redoList == null)
 483     {
 484       return new long[] { -1, -1 };
 485     }
 486     return new long[] { historyList.hashCode(), this.redoList.hashCode() };
 487   }
 488
 489   /**
 490    * test if a particular set of hashcodes are different to the hashcodes for
 491    * the undo and redo list.
 492    *
 493    * @param undoredo
 494    *          the stored set of hashcodes as returned by getUndoRedoHash
 495    * @return true if the hashcodes differ (ie the alignment has been edited) or
 496    *         the stored hashcode array differs in size
 497    */
 498   public boolean isUndoRedoHashModified(long[] undoredo)
 499   {
 500     if (undoredo == null)
 501     {
 502       return true;
 503     }
 504     long[] cstate = getUndoRedoHash();
 505     if (cstate.length != undoredo.length)
 506     {
 507       return true;
 508     }
 509
 510     for (int i = 0; i < cstate.length; i++)
 511     {
 512       if (cstate[i] != undoredo[i])
 513       {
 514         return true;
 515       }
 516     }
 517     return false;
 518   }
 519
 520   public boolean followSelection = true;
 521
 522   /**
 523    * @return true if view selection should always follow the selections
 524    *         broadcast by other selection sources
 525    */
 526   public boolean getFollowSelection()
 527   {
 528     return followSelection;
 529   }
 530
 531   /**
 532    * Send the current selection to be broadcast to any selection listeners.
 533    */
 534   @Override
 535   public void sendSelection()
 536   {
 537     Desktop.getInstance().getStructureSelectionManager().sendSelection(
 538             new SequenceGroup(getSelectionGroup()),
 539             new ColumnSelection(getColumnSelection()),
 540             new HiddenColumns(getAlignment().getHiddenColumns()), this);
 541   }
 542
 543   /**
 544    * return the alignPanel containing the given viewport. Use this to get the
 545    * components currently handling the given viewport.
 546    *
 547    * @param av
 548    * @return null or an alignPanel guaranteed to have non-null alignFrame
 549    *         reference
 550    */
 551   public AlignmentPanel getAlignPanel()
 552   {
 553     AlignmentPanel[] aps = PaintRefresher
 554             .getAssociatedPanels(this.getSequenceSetId());
 555     for (int p = 0; aps != null && p < aps.length; p++)
 556     {
 557       if (aps[p].av == this)
 558       {
 559         return aps[p];
 560       }
 561     }
 562     return null;
 563   }
 564
 565   public boolean getSortByTree()
 566   {
 567     return sortByTree;
 568   }
 569
 570   public void setSortByTree(boolean sort)
 571   {
 572     sortByTree = sort;
 573   }
 574
 575   /**
 576    * Returns the (Desktop) instance of the StructureSelectionManager
 577    */
 578   @Override
 579   public StructureSelectionManager getStructureSelectionManager()
 580   {
 581     return Desktop.getInstance().getStructureSelectionManager();
 582   }
 583
 584   @Override
 585   public boolean isNormaliseSequenceLogo()
 586   {
 587     return normaliseSequenceLogo;
 588   }
 589
 590   public void setNormaliseSequenceLogo(boolean state)
 591   {
 592     normaliseSequenceLogo = state;
 593   }
 594
 595   /**
 596    *
 597    * @return true if alignment characters should be displayed
 598    */
 599   @Override
 600   public boolean isValidCharWidth()
 601   {
 602     return validCharWidth;
 603   }
 604
 605   private Hashtable<String, AutoCalcSetting> calcIdParams = new Hashtable<>();
 606
 607   public AutoCalcSetting getCalcIdSettingsFor(String calcId)
 608   {
 609     return calcIdParams.get(calcId);
 610   }
 611
 612   public void setCalcIdSettingsFor(String calcId, AutoCalcSetting settings,
 613           boolean needsUpdate)
 614   {
 615     calcIdParams.put(calcId, settings);
 616     // TODO: create a restart list to trigger any calculations that need to be
 617     // restarted after load
 618     // calculator.getRegisteredWorkersOfClass(settings.getWorkerClass())
 619     if (needsUpdate)
 620     {
 621       Cache.log.debug("trigger update for " + calcId);
 622     }
 623   }
 624
 625   /**
 626    * Method called when another alignment's edit (or possibly other) command is
 627    * broadcast to here.
 628    *
 629    * To allow for sequence mappings (e.g. protein to cDNA), we have to first
 630    * 'unwind' the command on the source sequences (in simulation, not in fact),
 631    * and then for each edit in turn:
 632    * <ul>
 633    * <li>compute the equivalent edit on the mapped sequences</li>
 634    * <li>apply the mapped edit</li>
 635    * <li>'apply' the source edit to the working copy of the source
 636    * sequences</li>
 637    * </ul>
 638    *
 639    * @param command
 640    * @param undo
 641    * @param ssm
 642    */
 643   @Override
 644   public void mirrorCommand(CommandI command, boolean undo,
 645           StructureSelectionManager ssm, VamsasSource source)
 646   {
 647     /*
 648      * Do nothing unless we are a 'complement' of the source. May replace this
 649      * with direct calls not via SSM.
 650      */
 651     if (source instanceof AlignViewportI
 652             && ((AlignViewportI) source).getCodingComplement() == this)
 653     {
 654       // ok to continue;
 655     }
 656     else
 657     {
 658       return;
 659     }
 660
 661     CommandI mappedCommand = ssm.mapCommand(command, undo, getAlignment(),
 662             getGapCharacter());
 663     if (mappedCommand != null)
 664     {
 665       AlignmentI[] views = getAlignPanel().alignFrame.getViewAlignments();
 666       mappedCommand.doCommand(views);
 667       getAlignPanel().alignmentChanged();
 668     }
 669   }
 670
 671   /**
 672    * Add the sequences from the given alignment to this viewport. Optionally,
 673    * may give the user the option to open a new frame, or split panel, with cDNA
 674    * and protein linked.
 675    *
 676    * @param toAdd
 677    * @param title
 678    */
 679   public void addAlignment(AlignmentI toAdd, String title)
 680   {
 681     // TODO: promote to AlignViewportI? applet CutAndPasteTransfer is different
 682
 683     // JBPComment: title is a largely redundant parameter at the moment
 684     // JBPComment: this really should be an 'insert/pre/append' controller
 685     // JBPComment: but the DNA/Protein check makes it a bit more complex
 686
 687     // refactored from FileLoader / CutAndPasteTransfer / SequenceFetcher with
 688     // this comment:
 689     // TODO: create undo object for this JAL-1101
 690
 691     /*
 692      * Ensure datasets are created for the new alignment as
 693      * mappings operate on dataset sequences
 694      */
 695     toAdd.setDataset(null);
 696
 697     /*
 698      * Check if any added sequence could be the object of a mapping or
 699      * cross-reference; if so, make the mapping explicit
 700      */
 701     getAlignment().realiseMappings(toAdd.getSequences());
 702
 703     /*
 704      * If any cDNA/protein mappings exist or can be made between the alignments,
 705      * offer to open a split frame with linked alignments
 706      */
 707     if (Cache.getDefault(Preferences.ENABLE_SPLIT_FRAME, true))
 708     {
 709       if (AlignmentUtils.isMappable(toAdd, getAlignment()))
 710       {
 711         openLinkedAlignment(toAdd, title);
 712         return;
 713       }
 714     }
 715     addDataToAlignment(toAdd);
 716   }
 717
 718   /**
 719    * adds sequences to this alignment
 720    *
 721    * @param toAdd
 722    */
 723   void addDataToAlignment(AlignmentI toAdd)
 724   {
 725     // TODO: JAL-407 regardless of above - identical sequences (based on ID and
 726     // provenance) should share the same dataset sequence
 727
 728     AlignmentI al = getAlignment();
 729     String gap = String.valueOf(al.getGapCharacter());
 730     for (int i = 0; i < toAdd.getHeight(); i++)
 731     {
 732       SequenceI seq = toAdd.getSequenceAt(i);
 733       /*
 734        * experimental!
 735        * - 'align' any mapped sequences as per existing
 736        *    e.g. cdna to genome, domain hit to protein sequence
 737        * very experimental! (need a separate menu option for this)
 738        * - only add mapped sequences ('select targets from a dataset')
 739        */
 740       if (true /*AlignmentUtils.alignSequenceAs(seq, al, gap, true, true)*/)
 741       {
 742         al.addSequence(seq);
 743       }
 744     }
 745
 746     ranges.setEndSeq(getAlignment().getHeight() - 1); // BH 2019.04.18
 747     firePropertyChange("alignment", null, getAlignment().getSequences());
 748   }
 749
 750   public final static int NO_SPLIT = 0;
 751
 752   public final static int SPLIT_FRAME = 1;
 753
 754   public final static int NEW_WINDOW = 2;
 755
 756   /**
 757    * Show a dialog with the option to open and link (cDNA <-> protein) as a new
 758    * alignment, either as a standalone alignment or in a split frame. Returns
 759    * true if the new alignment was opened, false if not, because the user
 760    * declined the offer.
 761    *
 762    * @param al
 763    * @param title
 764    */
 765   protected void openLinkedAlignment(AlignmentI al, String title)
 766   {
 767     String[] options = new String[] { MessageManager.getString("action.no"),
 768         MessageManager.getString("label.split_window"),
 769         MessageManager.getString("label.new_window"), };
 770     final String question = JvSwingUtils.wrapTooltip(true,
 771             MessageManager.getString("label.open_split_window?"));
 772
 773
 774     /*
 775      * options No, Split Window, New Window correspond to
 776      * dialog responses 0, 1, 2 (even though JOptionPane shows them
 777      * in reverse order)
 778      */
 779     JvOptionPane dialog = JvOptionPane.newOptionDialog(Desktop.getDesktopPane())
 780             .setResponseHandler(NO_SPLIT, new Runnable()
 781             {
 782               @Override
 783               public void run()
 784               {
 785                   addDataToAlignment(al);
 786               }
 787             }).setResponseHandler(SPLIT_FRAME, new Runnable()
 788             {
 789               @Override
 790               public void run()
 791               {
 792                 openLinkedAlignmentAs(getAlignPanel().alignFrame,
 793                         new Alignment(getAlignment()), al,
 794                         title, SPLIT_FRAME);
 795               }
 796             }).setResponseHandler(NEW_WINDOW, new Runnable()
 797             {
 798               @Override
 799               public void run()
 800               {
 801                 openLinkedAlignmentAs(null, getAlignment(), al, title,
 802                         NEW_WINDOW);
 803               }
 804             });
 805     dialog.showDialog(question,
 806             MessageManager.getString("label.open_split_window"),
 807             JvOptionPane.DEFAULT_OPTION, JvOptionPane.PLAIN_MESSAGE, null,
 808             options, options[0]);
 809   }
 810
 811   /**
 812    * Open a split frame or a new window
 813    *
 814    * @param al
 815    * @param title
 816    * @param mode
 817    *          SPLIT_FRAME or NEW_WINDOW
 818    */
 819   public static void openLinkedAlignmentAs(AlignFrame thisFrame, AlignmentI thisAlignment,
 820           AlignmentI al, String title,
 821           int mode)
 822   {
 823     /*
 824      * Identify protein and dna alignments. Make a copy of this one if opening
 825      * in a new split pane.
 826      */
 827     AlignmentI protein = al.isNucleotide() ? thisAlignment : al;
 828     AlignmentI cdna = al.isNucleotide() ? al : thisAlignment;
 829
 830     /*
 831      * Map sequences. At least one should get mapped as we have already passed
 832      * the test for 'mappability'. Any mappings made will be added to the
 833      * protein alignment. Note creating dataset sequences on the new alignment
 834      * is a pre-requisite for building mappings.
 835      */
 836     al.setDataset(null);
 837     AlignmentUtils.mapProteinAlignmentToCdna(protein, cdna);
 838
 839     /*
 840      * Create the AlignFrame for the added alignment. If it is protein, mappings
 841      * are registered with StructureSelectionManager as a side-effect.
 842      */
 843     AlignFrame newAlignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
 844             AlignFrame.DEFAULT_HEIGHT);
 845     newAlignFrame.setTitle(title);
 846     newAlignFrame.setStatus(MessageManager
 847             .formatMessage("label.successfully_loaded_file", new Object[]
 848             { title }));
 849
 850     // TODO if we want this (e.g. to enable reload of the alignment from file),
 851     // we will need to add parameters to the stack.
 852     // if (!protocol.equals(DataSourceType.PASTE))
 853     // {
 854     // alignFrame.setFileName(file, format);
 855     // }
 856
 857     if (mode == NEW_WINDOW)
 858     {
 859       Desktop.addInternalFrame(newAlignFrame, title,
 860               AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 861     }
 862
 863     try
 864     {
 865       newAlignFrame.setMaximum(
 866               jalview.bin.Cache.getDefault("SHOW_FULLSCREEN", false));
 867     } catch (java.beans.PropertyVetoException ex)
 868     {
 869     }
 870
 871     if (mode == SPLIT_FRAME)
 872     {
 873       al.alignAs(thisAlignment);
 874       openSplitFrame(thisFrame, newAlignFrame, thisAlignment);
 875     }
 876   }
 877
 878   /**
 879    * Helper method to open a new SplitFrame holding linked dna and protein
 880    * alignments.
 881    *
 882    * @param newAlignFrame
 883    *          containing a new alignment to be shown
 884    * @param complement
 885    *          cdna/protein complement alignment to show in the other split half
 886    * @return the protein alignment in the split frame
 887    */
 888   static protected AlignmentI openSplitFrame(AlignFrame thisFrame,
 889           AlignFrame newAlignFrame,
 890           AlignmentI complement)
 891   {
 892     /*
 893      * Make a new frame with a copy of the alignment we are adding to. If this
 894      * is protein, the mappings to cDNA will be registered with
 895      * StructureSelectionManager as a side-effect.
 896      */
 897     AlignFrame copyMe = new AlignFrame(complement, AlignFrame.DEFAULT_WIDTH,
 898             AlignFrame.DEFAULT_HEIGHT);
 899     copyMe.setTitle(thisFrame.getTitle());
 900
 901     AlignmentI al = newAlignFrame.viewport.getAlignment();
 902     final AlignFrame proteinFrame = al.isNucleotide() ? copyMe
 903             : newAlignFrame;
 904     final AlignFrame cdnaFrame = al.isNucleotide() ? newAlignFrame : copyMe;
 905     cdnaFrame.setVisible(true);
 906     proteinFrame.setVisible(true);
 907     String linkedTitle = MessageManager
 908             .getString("label.linked_view_title");
 909
 910     /*
 911      * Open in split pane. DNA sequence above, protein below.
 912      */
 913     JInternalFrame splitFrame = new SplitFrame(cdnaFrame, proteinFrame);
 914     Desktop.addInternalFrame(splitFrame, linkedTitle, -1, -1);
 915
 916     return proteinFrame.viewport.getAlignment();
 917   }
 918
 919   public AnnotationColumnChooser getAnnotationColumnSelectionState()
 920   {
 921     return annotationColumnSelectionState;
 922   }
 923
 924   public void setAnnotationColumnSelectionState(
 925           AnnotationColumnChooser currentAnnotationColumnSelectionState)
 926   {
 927     this.annotationColumnSelectionState = currentAnnotationColumnSelectionState;
 928   }
 929
 930   @Override
 931   public void setIdWidth(int i)
 932   {
 933     super.setIdWidth(i);
 934     AlignmentPanel ap = getAlignPanel();
 935     if (ap != null)
 936     {
 937       // modify GUI elements to reflect geometry change
 938       Dimension idw = getAlignPanel().getIdPanel().getIdCanvas()
 939               .getPreferredSize();
 940       idw.width = i;
 941       getAlignPanel().getIdPanel().getIdCanvas().setPreferredSize(idw);
 942     }
 943   }
 944
 945   public Rectangle getExplodedGeometry()
 946   {
 947     return explodedGeometry;
 948   }
 949
 950   public void setExplodedGeometry(Rectangle explodedPosition)
 951   {
 952     this.explodedGeometry = explodedPosition;
 953   }
 954
 955   public boolean isGatherViewsHere()
 956   {
 957     return gatherViewsHere;
 958   }
 959
 960   public void setGatherViewsHere(boolean gatherViewsHere)
 961   {
 962     this.gatherViewsHere = gatherViewsHere;
 963   }
 964
 965   /**
 966    * If this viewport has a (Protein/cDNA) complement, then scroll the
 967    * complementary alignment to match this one.
 968    */
 969   public void scrollComplementaryAlignment()
 970   {
 971     /*
 972      * Populate a SearchResults object with the mapped location to scroll to. If
 973      * there is no complement, or it is not following highlights, or no mapping
 974      * is found, the result will be empty.
 975      */
 976     SearchResultsI sr = new SearchResults();
 977     int verticalOffset = findComplementScrollTarget(sr);
 978     if (!sr.isEmpty())
 979     {
 980       // TODO would like next line without cast but needs more refactoring...
 981       final AlignmentPanel complementPanel = ((AlignViewport) getCodingComplement())
 982               .getAlignPanel();
 983       complementPanel.setToScrollComplementPanel(false);
 984       complementPanel.scrollToCentre(sr, verticalOffset);
 985       complementPanel.setToScrollComplementPanel(true);
 986     }
 987   }
 988
 989   /**
 990    * Answers true if no alignment holds a reference to the given mapping
 991    *
 992    * @param acf
 993    * @return
 994    */
 995   protected boolean noReferencesTo(AlignedCodonFrame acf)
 996   {
 997     AlignFrame[] frames = Desktop.getAlignFrames();
 998     if (frames == null)
 999     {
1000       return true;
1001     }
1002     for (AlignFrame af : frames)
1003     {
1004       if (!af.isClosed())
1005       {
1006         for (AlignmentViewPanel ap : af.getAlignPanels())
1007         {
1008           AlignmentI al = ap.getAlignment();
1009           if (al != null && al.getCodonFrames().contains(acf))
1010           {
1011             return false;
1012           }
1013         }
1014       }
1015     }
1016     return true;
1017   }
1018
1019   /**
1020    * Applies the supplied feature settings descriptor to currently known
1021    * features. This supports an 'initial configuration' of feature colouring
1022    * based on a preset or user favourite. This may then be modified in the usual
1023    * way using the Feature Settings dialogue.
1024    *
1025    * @param featureSettings
1026    */
1027   @Override
1028   public void applyFeaturesStyle(FeatureSettingsModelI featureSettings)
1029   {
1030     if (featureSettings == null)
1031     {
1032       return;
1033     }
1034
1035     FeatureRenderer fr = getAlignPanel().getSeqPanel().seqCanvas
1036             .getFeatureRenderer();
1037     fr.findAllFeatures(true);
1038     List<String> renderOrder = fr.getRenderOrder();
1039     FeaturesDisplayedI displayed = fr.getFeaturesDisplayed();
1040     displayed.clear();
1041     // TODO this clears displayed.featuresRegistered - do we care?
1042
1043     /*
1044      * set feature colour if specified by feature settings
1045      * set visibility of all features
1046      */
1047     for (String type : renderOrder)
1048     {
1049       FeatureColourI preferredColour = featureSettings
1050               .getFeatureColour(type);
1051       if (preferredColour != null)
1052       {
1053         fr.setColour(type, preferredColour);
1054       }
1055       if (featureSettings.isFeatureDisplayed(type))
1056       {
1057         displayed.setVisible(type);
1058       }
1059     }
1060
1061     /*
1062      * set visibility of feature groups
1063      */
1064     for (String group : fr.getFeatureGroups())
1065     {
1066       fr.setGroupVisibility(group, featureSettings.isGroupDisplayed(group));
1067     }
1068
1069     /*
1070      * order the features
1071      */
1072     if (featureSettings.optimiseOrder())
1073     {
1074       // TODO not supported (yet?)
1075     }
1076     else
1077     {
1078       fr.orderFeatures(featureSettings);
1079     }
1080     fr.setTransparency(featureSettings.getTransparency());
1081   }
1082
1083   public String getViewName()
1084   {
1085     return viewName;
1086   }
1087
1088   public void setViewName(String viewName)
1089   {
1090     this.viewName = viewName;
1091   }
1092 }