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