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