src/jalview/appletgui/CutAndPasteTransfer.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.appletgui;
  22
  23 import java.awt.BorderLayout;
  24 import java.awt.Button;
  25 import java.awt.Dialog;
  26 import java.awt.Font;
  27 import java.awt.Frame;
  28 import java.awt.Label;
  29 import java.awt.Panel;
  30 import java.awt.TextArea;
  31 import java.awt.event.ActionEvent;
  32 import java.awt.event.ActionListener;
  33 import java.awt.event.MouseEvent;
  34 import java.awt.event.MouseListener;
  35
  36 import jalview.analysis.AlignmentUtils;
  37 import jalview.api.ComplexAlignFile;
  38 import jalview.bin.JalviewLite;
  39 import jalview.datamodel.Alignment;
  40 import jalview.datamodel.AlignmentI;
  41 import jalview.datamodel.ColumnSelection;
  42 import jalview.datamodel.PDBEntry;
  43 import jalview.datamodel.SequenceI;
  44 import jalview.io.AnnotationFile;
  45 import jalview.io.AppletFormatAdapter;
  46 import jalview.io.FileParse;
  47 import jalview.io.IdentifyFile;
  48 import jalview.io.NewickFile;
  49 import jalview.io.TCoffeeScoreFile;
  50 import jalview.schemes.ColourSchemeI;
  51 import jalview.schemes.TCoffeeColourScheme;
  52 import jalview.util.MessageManager;
  53
  54 public class CutAndPasteTransfer extends Panel implements ActionListener,
  55         MouseListener
  56 {
  57   boolean pdbImport = false;
  58
  59   boolean treeImport = false;
  60
  61   boolean annotationImport = false;
  62
  63   SequenceI seq;
  64
  65   AlignFrame alignFrame;
  66
  67   FileParse source = null;
  68
  69   public CutAndPasteTransfer(boolean forImport, AlignFrame alignFrame)
  70   {
  71     try
  72     {
  73       jbInit();
  74     } catch (Exception e)
  75     {
  76       e.printStackTrace();
  77     }
  78
  79     this.alignFrame = alignFrame;
  80
  81     if (!forImport)
  82     {
  83       buttonPanel.setVisible(false);
  84     }
  85   }
  86
  87   public String getText()
  88   {
  89     return textarea.getText();
  90   }
  91
  92   public void setText(String text)
  93   {
  94     textarea.setText(text);
  95   }
  96
  97   public void setPDBImport(SequenceI seq)
  98   {
  99     this.seq = seq;
 100     accept.setLabel(MessageManager.getString("action.accept"));
 101     addSequences.setVisible(false);
 102     pdbImport = true;
 103   }
 104
 105   public void setTreeImport()
 106   {
 107     treeImport = true;
 108     accept.setLabel(MessageManager.getString("action.accept"));
 109     addSequences.setVisible(false);
 110   }
 111
 112   public void setAnnotationImport()
 113   {
 114     annotationImport = true;
 115     accept.setLabel(MessageManager.getString("action.accept"));
 116     addSequences.setVisible(false);
 117   }
 118
 119   public void actionPerformed(ActionEvent evt)
 120   {
 121     if (evt.getSource() == accept)
 122     {
 123       ok(true);
 124     }
 125     else if (evt.getSource() == addSequences)
 126     {
 127       ok(false);
 128     }
 129     else if (evt.getSource() == cancel)
 130     {
 131       cancel();
 132     }
 133   }
 134
 135   protected void ok(boolean newWindow)
 136   {
 137     String text = getText();
 138     int length = text.length();
 139     textarea.append("\n");
 140     if (textarea.getText().length() == length)
 141     {
 142       String warning = "\n\n#################################################\n"
 143               + "WARNING!! THIS IS THE MAXIMUM SIZE OF TEXTAREA!!\n"
 144               + "\nCAN'T INPUT FULL ALIGNMENT"
 145               + "\n\nYOU MUST DELETE THIS WARNING TO CONTINUE"
 146               + "\n\nMAKE SURE LAST SEQUENCE PASTED IS COMPLETE"
 147               + "\n#################################################\n";
 148       textarea.setText(text.substring(0, text.length() - warning.length())
 149               + warning);
 150
 151       textarea.setCaretPosition(text.length());
 152     }
 153
 154     if (pdbImport)
 155     {
 156       openPdbViewer(text);
 157
 158     }
 159     else if (treeImport)
 160     {
 161       if (!loadTree())
 162       {
 163         return;
 164       }
 165     }
 166     else if (annotationImport)
 167     {
 168       loadAnnotations();
 169     }
 170     else if (alignFrame != null)
 171     {
 172       loadAlignment(text, newWindow, alignFrame.getAlignViewport());
 173     }
 174
 175     // TODO: dialog should indicate if data was parsed correctly or not - see
 176     // JAL-1102
 177     if (this.getParent() instanceof Frame)
 178     {
 179       ((Frame) this.getParent()).setVisible(false);
 180     }
 181     else
 182     {
 183       ((Dialog) this.getParent()).setVisible(false);
 184     }
 185   }
 186
 187   /**
 188    * Parses text as Newick Tree format, and loads on to the alignment. Returns
 189    * true if successful, else false.
 190    */
 191   protected boolean loadTree()
 192   {
 193     try
 194     {
 195       NewickFile fin = new NewickFile(textarea.getText(), "Paste");
 196
 197       fin.parse();
 198       if (fin.getTree() != null)
 199       {
 200         alignFrame.loadTree(fin, "Pasted tree file");
 201         return true;
 202       }
 203     } catch (Exception ex)
 204     {
 205       // TODO: JAL-1102 - should have a warning message in dialog, not simply
 206       // overwrite the broken input data with the exception
 207       textarea.setText(MessageManager.formatMessage(
 208               "label.could_not_parse_newick_file", new Object[]
 209               { ex.getMessage() }));
 210       return false;
 211     }
 212     return false;
 213   }
 214
 215   /**
 216    * Parse text as an alignment file and add to the current or a new window.
 217    *
 218    * @param text
 219    * @param newWindow
 220    */
 221   protected void loadAlignment(String text, boolean newWindow,
 222           AlignViewport viewport)
 223   {
 224     Alignment al = null;
 225
 226     String format = new IdentifyFile().Identify(text,
 227             AppletFormatAdapter.PASTE);
 228     AppletFormatAdapter afa = new AppletFormatAdapter(viewport);
 229     try
 230     {
 231       al = afa.readFile(text, AppletFormatAdapter.PASTE, format);
 232       source = afa.getAlignFile();
 233     } catch (java.io.IOException ex)
 234     {
 235       ex.printStackTrace();
 236     }
 237
 238     if (al != null)
 239     {
 240       al.setDataset(null); // set dataset on alignment/sequences
 241
 242       /*
 243        * SplitFrame option dependent on applet parameter for now.
 244        */
 245       boolean allowSplitFrame = alignFrame.viewport.applet
 246               .getDefaultParameter("enableSplitFrame", false);
 247       if (allowSplitFrame && openSplitFrame(al, format))
 248       {
 249         return;
 250       }
 251       if (newWindow)
 252       {
 253         AlignFrame af;
 254
 255         if (source instanceof ComplexAlignFile)
 256         {
 257           ColumnSelection colSel = ((ComplexAlignFile) source)
 258                   .getColumnSelection();
 259           SequenceI[] hiddenSeqs = ((ComplexAlignFile) source)
 260                   .getHiddenSequences();
 261           boolean showSeqFeatures = ((ComplexAlignFile) source)
 262                   .isShowSeqFeatures();
 263           ColourSchemeI cs = ((ComplexAlignFile) source).getColourScheme();
 264           af = new AlignFrame(al, hiddenSeqs, colSel,
 265                   alignFrame.viewport.applet, "Cut & Paste input - "
 266                           + format, false);
 267           af.getAlignViewport().setShowSequenceFeatures(showSeqFeatures);
 268           af.changeColour(cs);
 269         }
 270         else
 271         {
 272           af = new AlignFrame(al, alignFrame.viewport.applet,
 273                   "Cut & Paste input - " + format, false);
 274         }
 275
 276         af.statusBar
 277                 .setText(MessageManager
 278                         .getString("label.successfully_pasted_annotation_to_alignment"));
 279       }
 280       else
 281       {
 282         alignFrame.addSequences(al.getSequencesArray());
 283         alignFrame.statusBar.setText(MessageManager
 284                 .getString("label.successfully_pasted_alignment_file"));
 285       }
 286     }
 287   }
 288
 289   /**
 290    * Check whether the new alignment could be mapped to the current one as
 291    * cDNA/protein, if so offer the option to open as split frame view. Returns
 292    * true if a split frame view is opened, false if not.
 293    *
 294    * @param al
 295    * @return
 296    */
 297   protected boolean openSplitFrame(Alignment al, String format)
 298   {
 299     final AlignmentI thisAlignment = this.alignFrame.getAlignViewport().getAlignment();
 300     if (thisAlignment.isNucleotide() == al.isNucleotide())
 301     {
 302       // both nucleotide or both protein
 303       return false;
 304     }
 305     AlignmentI protein = thisAlignment.isNucleotide() ? al : thisAlignment;
 306     AlignmentI dna = thisAlignment.isNucleotide() ? thisAlignment : al;
 307     boolean mapped = AlignmentUtils.mapProteinToCdna(protein, dna);
 308     if (!mapped)
 309     {
 310       return false;
 311     }
 312
 313     /*
 314      * A mapping is possible; ask user if they want a split frame.
 315      */
 316     String title = MessageManager.getString("label.open_split_window");
 317     final JVDialog dialog = new JVDialog((Frame) this.getParent(), title,
 318             true, 100, 400);
 319     dialog.ok.setLabel(MessageManager.getString("action.yes"));
 320     dialog.cancel.setLabel(MessageManager.getString("action.no"));
 321     Panel question = new Panel(new BorderLayout());
 322     final String text = MessageManager
 323             .getString("label.open_split_window?");
 324     question.add(new Label(text, Label.CENTER), BorderLayout.CENTER);
 325     dialog.setMainPanel(question);
 326     dialog.setVisible(true);
 327     dialog.toFront();
 328
 329     if (!dialog.accept)
 330     {
 331       return false;
 332     }
 333
 334     /*
 335      * Open SplitFrame with DNA above and protein below, including the alignment
 336      * from textbox and a copy of the original.
 337      */
 338     final JalviewLite applet = this.alignFrame.viewport.applet;
 339     AlignFrame copyFrame = new AlignFrame(
 340             this.alignFrame.viewport.getAlignment(), applet,
 341             alignFrame.getTitle(), false, false);
 342     AlignFrame newFrame = new AlignFrame(al, alignFrame.viewport.applet,
 343             "Cut & Paste input - " + format, false, false);
 344     AlignFrame dnaFrame = al.isNucleotide() ? newFrame : copyFrame;
 345     AlignFrame proteinFrame = al.isNucleotide() ? copyFrame
 346             : newFrame;
 347     SplitFrame sf = new SplitFrame(dnaFrame, proteinFrame);
 348     sf.addToDisplay(false, applet);
 349     return true;
 350   }
 351
 352   /**
 353    * Parse the text as a TCoffee score file, if successful add scores as
 354    * alignment annotations.
 355    */
 356   protected void loadAnnotations()
 357   {
 358     TCoffeeScoreFile tcf = null;
 359     try
 360     {
 361       tcf = new TCoffeeScoreFile(textarea.getText(),
 362               jalview.io.AppletFormatAdapter.PASTE);
 363       if (tcf.isValid())
 364       {
 365         if (tcf.annotateAlignment(alignFrame.viewport.getAlignment(),
 366                 true))
 367         {
 368           alignFrame.tcoffeeColour.setEnabled(true);
 369           alignFrame.alignPanel.fontChanged();
 370           alignFrame.changeColour(new TCoffeeColourScheme(
 371                   alignFrame.viewport.getAlignment()));
 372           alignFrame.statusBar
 373                   .setText(MessageManager
 374                           .getString("label.successfully_pasted_tcoffee_scores_to_alignment"));
 375         }
 376         else
 377         {
 378           // file valid but didn't get added to alignment for some reason
 379           alignFrame.statusBar.setText(MessageManager.formatMessage(
 380                   "label.failed_add_tcoffee_scores",
 381                   new Object[]
 382                   { (tcf.getWarningMessage() != null ? tcf
 383                           .getWarningMessage() : "") }));
 384         }
 385       }
 386       else
 387       {
 388         tcf = null;
 389       }
 390     } catch (Exception x)
 391     {
 392       tcf = null;
 393     }
 394     if (tcf == null)
 395     {
 396       if (new AnnotationFile().annotateAlignmentView(alignFrame.viewport,
 397               textarea.getText(),
 398               jalview.io.AppletFormatAdapter.PASTE))
 399       {
 400         alignFrame.alignPanel.fontChanged();
 401         alignFrame.alignPanel.setScrollValues(0, 0);
 402         alignFrame.statusBar
 403                 .setText(MessageManager
 404                         .getString("label.successfully_pasted_annotation_to_alignment"));
 405
 406       }
 407       else
 408       {
 409         if (!alignFrame.parseFeaturesFile(textarea.getText(),
 410                 jalview.io.AppletFormatAdapter.PASTE))
 411         {
 412           alignFrame.statusBar
 413                   .setText(MessageManager
 414                           .getString("label.couldnt_parse_pasted_text_as_valid_annotation_feature_GFF_tcoffee_file"));
 415         }
 416       }
 417     }
 418   }
 419
 420   /**
 421    * Open a Jmol viewer (if available), failing that the built-in PDB viewer,
 422    * passing the input text as the PDB file data.
 423    *
 424    * @param text
 425    */
 426   protected void openPdbViewer(String text)
 427   {
 428     PDBEntry pdb = new PDBEntry();
 429     pdb.setFile(text);
 430
 431     if (alignFrame.alignPanel.av.applet.jmolAvailable)
 432     {
 433       new jalview.appletgui.AppletJmol(pdb, new SequenceI[]
 434       { seq }, null, alignFrame.alignPanel, AppletFormatAdapter.PASTE);
 435     }
 436     else
 437     {
 438       new MCview.AppletPDBViewer(pdb, new SequenceI[]
 439       { seq }, null, alignFrame.alignPanel, AppletFormatAdapter.PASTE);
 440     }
 441   }
 442
 443   protected void cancel()
 444   {
 445     textarea.setText("");
 446     if (this.getParent() instanceof Frame)
 447     {
 448       ((Frame) this.getParent()).setVisible(false);
 449     }
 450     else
 451     {
 452       ((Dialog) this.getParent()).setVisible(false);
 453     }
 454   }
 455
 456   protected TextArea textarea = new TextArea();
 457
 458   Button accept = new Button("New Window");
 459
 460   Button addSequences = new Button("Add to Current Alignment");
 461
 462   Button cancel = new Button("Close");
 463
 464   protected Panel buttonPanel = new Panel();
 465
 466   BorderLayout borderLayout1 = new BorderLayout();
 467
 468   private void jbInit() throws Exception
 469   {
 470     textarea.setFont(new java.awt.Font("Monospaced", Font.PLAIN, 10));
 471     textarea.setText(MessageManager
 472             .getString("label.paste_your_alignment_file"));
 473     textarea.addMouseListener(this);
 474     this.setLayout(borderLayout1);
 475     accept.addActionListener(this);
 476     addSequences.addActionListener(this);
 477     cancel.addActionListener(this);
 478     this.add(buttonPanel, BorderLayout.SOUTH);
 479     buttonPanel.add(accept, null);
 480     buttonPanel.add(addSequences);
 481     buttonPanel.add(cancel, null);
 482     this.add(textarea, java.awt.BorderLayout.CENTER);
 483   }
 484
 485   public void mousePressed(MouseEvent evt)
 486   {
 487     if (textarea.getText().startsWith(
 488             MessageManager.getString("label.paste_your")))
 489     {
 490       textarea.setText("");
 491     }
 492   }
 493
 494   public void mouseReleased(MouseEvent evt)
 495   {
 496   }
 497
 498   public void mouseClicked(MouseEvent evt)
 499   {
 500   }
 501
 502   public void mouseEntered(MouseEvent evt)
 503   {
 504   }
 505
 506   public void mouseExited(MouseEvent evt)
 507   {
 508   }
 509 }