905a54ad815c372e84c1847a37aaa207b2be79cb
[jalview.git] / TreePanel.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.AverageDistanceTree;
24 import jalview.analysis.NJTree;
25 import jalview.analysis.TreeBuilder;
26 import jalview.analysis.TreeModel;
27 import jalview.analysis.scoremodels.ScoreModels;
28 import jalview.analysis.scoremodels.SimilarityParams;
29 import jalview.api.analysis.ScoreModelI;
30 import jalview.api.analysis.ViewBasedAnalysisI;
31 import jalview.bin.Cache;
32 import jalview.datamodel.Alignment;
33 import jalview.datamodel.ColumnSelection;
34 import jalview.datamodel.SequenceI;
35 import jalview.io.NewickFile;
36 import jalview.util.MessageManager;
37
38 import java.awt.BorderLayout;
39 import java.awt.CheckboxMenuItem;
40 import java.awt.Color;
41 import java.awt.Menu;
42 import java.awt.MenuBar;
43 import java.awt.MenuItem;
44 import java.awt.ScrollPane;
45 import java.awt.event.ActionEvent;
46 import java.awt.event.ActionListener;
47 import java.awt.event.ItemEvent;
48 import java.awt.event.ItemListener;
49
50 public class TreePanel extends EmbmenuFrame implements ActionListener,
51         ItemListener
52 {
53   SequenceI[] seq;
54
55   String type;
56
57   String pwtype;
58
59   int start;
60
61   int end;
62
63   TreeCanvas treeCanvas;
64
65   TreeModel tree;
66
67   AlignmentPanel ap;
68
69   AlignViewport av;
70
71   public TreeModel getTree()
72   {
73     return tree;
74   }
75
76   @Override
77   public void finalize() throws Throwable
78   {
79     ap = null;
80     av = null;
81     super.finalize();
82   }
83
84   /**
85    * Creates a new TreePanel object.
86    * 
87    * @param av
88    *          DOCUMENT ME!
89    * @param seqVector
90    *          DOCUMENT ME!
91    * @param type
92    *          DOCUMENT ME!
93    * @param pwtype
94    *          DOCUMENT ME!
95    * @param s
96    *          DOCUMENT ME!
97    * @param e
98    *          DOCUMENT ME!
99    */
100   public TreePanel(AlignmentPanel ap, String type, String pwtype)
101   {
102     try
103     {
104       jbInit();
105       this.setMenuBar(jMenuBar1);
106     } catch (Exception ex)
107     {
108       ex.printStackTrace();
109     }
110
111     initTreePanel(ap, type, pwtype, null);
112   }
113
114   /**
115    * Creates a new TreePanel object.
116    * 
117    * @param av
118    *          DOCUMENT ME!
119    * @param seqVector
120    *          DOCUMENT ME!
121    * @param newtree
122    *          DOCUMENT ME!
123    * @param type
124    *          DOCUMENT ME!
125    * @param pwtype
126    *          DOCUMENT ME!
127    */
128   public TreePanel(AlignmentPanel ap, String type, String pwtype,
129           NewickFile newtree)
130   {
131     try
132     {
133       jbInit();
134       this.setMenuBar(jMenuBar1);
135     } catch (Exception e)
136     {
137       e.printStackTrace();
138     }
139
140     initTreePanel(ap, type, pwtype, newtree);
141   }
142
143   void initTreePanel(AlignmentPanel ap, String type, String pwtype,
144           NewickFile newTree)
145   {
146
147     this.ap = ap;
148     this.av = ap.av;
149     this.type = type;
150     this.pwtype = pwtype;
151
152     treeCanvas = new TreeCanvas(ap, scrollPane);
153     TreeLoader tl = new TreeLoader(newTree);
154     tl.start();
155     embedMenuIfNeeded(treeCanvas);
156     scrollPane.add(treeCanvas, BorderLayout.CENTER);
157   }
158
159   void showOriginalData()
160   {
161     // decide if av alignment is sufficiently different to original data to
162     // warrant a new window to be created
163     // create new alignmnt window with hidden regions (unhiding hidden regions
164     // yields unaligned seqs)
165     // or create a selection box around columns in alignment view
166     // test Alignment(SeqCigar[])
167     if (tree.getOriginalData() != null)
168     {
169       char gc = '-';
170       try
171       {
172         // we try to get the associated view's gap character
173         // but this may fail if the view was closed...
174         gc = av.getGapCharacter();
175       } catch (Exception ex)
176       {
177       }
178
179       Object[] alAndColsel = tree.getOriginalData()
180               .getAlignmentAndColumnSelection(gc);
181
182       if (alAndColsel != null && alAndColsel[0] != null)
183       {
184         Alignment al = new Alignment((SequenceI[]) alAndColsel[0]);
185         AlignFrame af = new AlignFrame(al, av.applet,
186                 "Original Data for Tree", false);
187
188         af.viewport.setHiddenColumns((ColumnSelection) alAndColsel[1]);
189       }
190     }
191     else
192     {
193       System.out.println("Original Tree Data not available");
194     }
195   }
196
197   class TreeLoader extends Thread
198   {
199     NewickFile newtree;
200
201     jalview.datamodel.AlignmentView odata = null;
202
203     public TreeLoader(NewickFile newtree)
204     {
205       this.newtree = newtree;
206     }
207
208     @Override
209     public void run()
210     {
211       if (newtree != null)
212       {
213         tree = new TreeModel(av.getAlignment().getSequencesArray(), odata,
214                 newtree);
215       }
216       else
217       {
218         ScoreModelI sm = configureScoreModel(pwtype);
219         TreeBuilder njtree = type.equals(TreeBuilder.NEIGHBOUR_JOINING) ? new NJTree(
220                 av, sm, SimilarityParams.Jalview)
221                 : new AverageDistanceTree(av, sm, SimilarityParams.Jalview);
222         tree = new TreeModel(njtree);
223       }
224
225       tree.reCount(tree.getTopNode());
226       tree.findHeight(tree.getTopNode());
227       treeCanvas.setTree(tree);
228       if (newtree != null)
229       {
230         // Set default view, paying lip service to any overriding tree view
231         // parameter settings
232         boolean showDist = newtree.HasDistances()
233                 && av.applet.getDefaultParameter("showTreeDistances",
234                         newtree.HasDistances());
235         boolean showBoots = newtree.HasBootstrap()
236                 && av.applet.getDefaultParameter("showTreeBootstraps",
237                         newtree.HasBootstrap());
238         distanceMenu.setState(showDist);
239         bootstrapMenu.setState(showBoots);
240         treeCanvas.setShowBootstrap(showBoots);
241         treeCanvas.setShowDistances(showDist);
242         treeCanvas.setMarkPlaceholders(av.applet.getDefaultParameter(
243                 "showUnlinkedTreeNodes", false));
244       }
245
246       treeCanvas.repaint();
247
248       av.setCurrentTree(tree);
249
250     }
251   }
252
253   @Override
254   public void actionPerformed(ActionEvent evt)
255   {
256     if (evt.getSource() == newickOutput)
257     {
258       newickOutput_actionPerformed();
259     }
260     else if (evt.getSource() == fontSize)
261     {
262       fontSize_actionPerformed();
263     }
264     else if (evt.getSource() == inputData)
265     {
266       showOriginalData();
267     }
268   }
269
270   @Override
271   public void itemStateChanged(ItemEvent evt)
272   {
273     if (evt.getSource() == fitToWindow)
274     {
275       treeCanvas.fitToWindow = fitToWindow.getState();
276     }
277
278     else if (evt.getSource() == distanceMenu)
279     {
280       treeCanvas.setShowDistances(distanceMenu.getState());
281     }
282
283     else if (evt.getSource() == bootstrapMenu)
284     {
285       treeCanvas.setShowBootstrap(bootstrapMenu.getState());
286     }
287
288     else if (evt.getSource() == placeholdersMenu)
289     {
290       treeCanvas.setMarkPlaceholders(placeholdersMenu.getState());
291     }
292
293     treeCanvas.repaint();
294   }
295
296   public void newickOutput_actionPerformed()
297   {
298     jalview.io.NewickFile fout = new jalview.io.NewickFile(
299             tree.getTopNode());
300     String output = fout.print(false, true);
301     CutAndPasteTransfer cap = new CutAndPasteTransfer(false, null);
302     cap.setText(output);
303     java.awt.Frame frame = new java.awt.Frame();
304     frame.add(cap);
305     jalview.bin.JalviewLite.addFrame(frame, type + " " + pwtype, 500, 100);
306   }
307
308   public java.awt.Font getTreeFont()
309   {
310     return treeCanvas.font;
311   }
312
313   public void setTreeFont(java.awt.Font font)
314   {
315     treeCanvas.font = font;
316     treeCanvas.repaint();
317   }
318
319   protected void fontSize_actionPerformed()
320   {
321     if (treeCanvas == null)
322     {
323       return;
324     }
325
326     new FontChooser(this);
327   }
328
329   BorderLayout borderLayout1 = new BorderLayout();
330
331   protected ScrollPane scrollPane = new ScrollPane();
332
333   MenuBar jMenuBar1 = new MenuBar();
334
335   Menu jMenu2 = new Menu();
336
337   protected MenuItem fontSize = new MenuItem();
338
339   protected CheckboxMenuItem bootstrapMenu = new CheckboxMenuItem();
340
341   protected CheckboxMenuItem distanceMenu = new CheckboxMenuItem();
342
343   protected CheckboxMenuItem placeholdersMenu = new CheckboxMenuItem();
344
345   protected CheckboxMenuItem fitToWindow = new CheckboxMenuItem();
346
347   Menu fileMenu = new Menu();
348
349   MenuItem newickOutput = new MenuItem();
350
351   MenuItem inputData = new MenuItem();
352
353   private void jbInit() throws Exception
354   {
355     setLayout(borderLayout1);
356     this.setBackground(Color.white);
357     this.setFont(new java.awt.Font("Verdana", 0, 12));
358     jMenu2.setLabel(MessageManager.getString("action.view"));
359     fontSize.setLabel(MessageManager.getString("action.font"));
360     fontSize.addActionListener(this);
361     bootstrapMenu.setLabel(MessageManager
362             .getString("label.show_bootstrap_values"));
363     bootstrapMenu.addItemListener(this);
364     distanceMenu.setLabel(MessageManager.getString("label.show_distances"));
365     distanceMenu.addItemListener(this);
366     placeholdersMenu.setLabel(MessageManager
367             .getString("label.mark_unassociated_leaves"));
368     placeholdersMenu.addItemListener(this);
369     fitToWindow.setState(true);
370     fitToWindow.setLabel(MessageManager.getString("label.fit_to_window"));
371     fitToWindow.addItemListener(this);
372     fileMenu.setLabel(MessageManager.getString("action.file"));
373     newickOutput.setLabel(MessageManager.getString("label.newick_format"));
374     newickOutput.addActionListener(this);
375     inputData.setLabel(MessageManager.getString("label.input_data"));
376
377     add(scrollPane, BorderLayout.CENTER);
378     jMenuBar1.add(fileMenu);
379     jMenuBar1.add(jMenu2);
380     jMenu2.add(fitToWindow);
381     jMenu2.add(fontSize);
382     jMenu2.add(distanceMenu);
383     jMenu2.add(bootstrapMenu);
384     jMenu2.add(placeholdersMenu);
385     fileMenu.add(newickOutput);
386     fileMenu.add(inputData);
387     inputData.addActionListener(this);
388   }
389
390   /**
391    * Gets the score model for the given name. If the score model is one that
392    * requires to get state data from the current view, allow it to do so
393    * 
394    * @param sm
395    * @return
396    */
397   protected ScoreModelI configureScoreModel(String modelName)
398   {
399     ScoreModelI sm = ScoreModels.getInstance().forName(modelName);
400     if (sm instanceof ViewBasedAnalysisI)
401     {
402       try
403       {
404         sm = sm.getClass().newInstance();
405         ((ViewBasedAnalysisI) sm).configureFromAlignmentView(treeCanvas.ap);
406       } catch (Exception q)
407       {
408         Cache.log.error("Couldn't create a scoremodel instance for "
409                 + sm.getName());
410       }
411     }
412     return sm;
413   }
414
415 }