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