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