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