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