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