2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3 * Copyright (C) 2014 The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import jalview.analysis.AlignmentSorter;
24 import jalview.analysis.NJTree;
25 import jalview.api.analysis.ScoreModelI;
26 import jalview.api.analysis.ViewBasedAnalysisI;
27 import jalview.bin.Cache;
28 import jalview.commands.CommandI;
29 import jalview.commands.OrderCommand;
30 import jalview.datamodel.Alignment;
31 import jalview.datamodel.AlignmentI;
32 import jalview.datamodel.AlignmentView;
33 import jalview.datamodel.BinaryNode;
34 import jalview.datamodel.ColumnSelection;
35 import jalview.datamodel.DBRefEntry;
36 import jalview.datamodel.NodeTransformI;
37 import jalview.datamodel.SequenceFeature;
38 import jalview.datamodel.SequenceI;
39 import jalview.datamodel.SequenceNode;
40 import jalview.io.JalviewFileChooser;
41 import jalview.io.JalviewFileView;
42 import jalview.io.NewickFile;
43 import jalview.jbgui.GTreePanel;
44 import jalview.schemes.ResidueProperties;
45 import jalview.util.MessageManager;
48 import java.awt.Graphics;
49 import java.awt.event.ActionEvent;
50 import java.awt.event.ActionListener;
51 import java.awt.image.BufferedImage;
52 import java.beans.PropertyChangeEvent;
53 import java.io.FileOutputStream;
54 import java.util.ArrayList;
55 import java.util.List;
57 import javax.imageio.ImageIO;
58 import javax.swing.ButtonGroup;
59 import javax.swing.JMenuItem;
60 import javax.swing.JRadioButtonMenuItem;
62 import org.jibble.epsgraphics.EpsGraphics2D;
70 public class TreePanel extends GTreePanel
76 TreeCanvas treeCanvas;
83 * Creates a new TreePanel object.
98 public TreePanel(AlignmentPanel ap, String type, String pwtype)
101 initTreePanel(ap, type, pwtype, null, null);
103 // We know this tree has distances. JBPNote TODO: prolly should add this as
104 // a userdefined default
105 // showDistances(true);
109 * Creates a new TreePanel object.
122 public TreePanel(AlignmentPanel ap, String type, String pwtype,
126 initTreePanel(ap, type, pwtype, newtree, null);
129 public TreePanel(AlignmentPanel av, String type, String pwtype,
130 NewickFile newtree, AlignmentView inputData)
133 initTreePanel(av, type, pwtype, newtree, inputData);
136 public AlignmentI getAlignment()
138 return treeCanvas.av.getAlignment();
141 public AlignViewport getViewPort()
143 return treeCanvas.av;
146 void initTreePanel(AlignmentPanel ap, String type, String pwtype,
147 NewickFile newTree, AlignmentView inputData)
152 this.pwtype = pwtype;
154 treeCanvas = new TreeCanvas(this, ap, scrollPane);
155 scrollPane.setViewportView(treeCanvas);
157 PaintRefresher.Register(this, ap.av.getSequenceSetId());
159 buildAssociatedViewMenu();
161 av.addPropertyChangeListener(new java.beans.PropertyChangeListener()
163 public void propertyChange(PropertyChangeEvent evt)
165 if (evt.getPropertyName().equals("alignment"))
169 System.out.println("tree is null");
170 // TODO: deal with case when a change event is received whilst a
171 // tree is still being calculated - should save reference for
172 // processing message later.
175 if (evt.getNewValue() == null)
178 .println("new alignment sequences vector value is null");
181 tree.UpdatePlaceHolders((List<SequenceI>) evt.getNewValue());
182 treeCanvas.nameHash.clear(); // reset the mapping between canvas
183 // rectangles and leafnodes
189 TreeLoader tl = new TreeLoader(newTree);
190 if (inputData != null)
192 tl.odata = inputData;
198 public void viewMenu_menuSelected()
200 buildAssociatedViewMenu();
203 void buildAssociatedViewMenu()
205 AlignmentPanel[] aps = PaintRefresher.getAssociatedPanels(av
206 .getSequenceSetId());
207 if (aps.length == 1 && treeCanvas.ap == aps[0])
209 associateLeavesMenu.setVisible(false);
213 associateLeavesMenu.setVisible(true);
215 if ((viewMenu.getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
217 viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
220 associateLeavesMenu.removeAll();
222 JRadioButtonMenuItem item;
223 ButtonGroup buttonGroup = new ButtonGroup();
224 int i, iSize = aps.length;
225 final TreePanel thisTreePanel = this;
226 for (i = 0; i < iSize; i++)
228 final AlignmentPanel ap = aps[i];
229 item = new JRadioButtonMenuItem(ap.av.viewName, ap == treeCanvas.ap);
230 buttonGroup.add(item);
231 item.addActionListener(new ActionListener()
233 public void actionPerformed(ActionEvent evt)
235 treeCanvas.applyToAllViews = false;
237 treeCanvas.av = ap.av;
238 PaintRefresher.Register(thisTreePanel, ap.av.getSequenceSetId());
242 associateLeavesMenu.add(item);
245 final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem("All Views");
246 buttonGroup.add(itemf);
247 itemf.setSelected(treeCanvas.applyToAllViews);
248 itemf.addActionListener(new ActionListener()
250 public void actionPerformed(ActionEvent evt)
252 treeCanvas.applyToAllViews = itemf.isSelected();
255 associateLeavesMenu.add(itemf);
259 class TreeLoader extends Thread
263 jalview.datamodel.AlignmentView odata = null;
265 public TreeLoader(NewickFile newtree)
267 this.newtree = newtree;
270 // Must be outside run(), as Jalview2XML tries to
271 // update distance/bootstrap visibility at the same time
272 showBootstrap(newtree.HasBootstrap());
273 showDistances(newtree.HasDistances());
284 tree = new NJTree(av.getAlignment().getSequencesArray(), newtree);
288 tree = new NJTree(av.getAlignment().getSequencesArray(), odata,
291 if (!tree.hasOriginalSequenceData())
293 allowOriginalSeqData(false);
300 boolean selview = av.getSelectionGroup() != null
301 && av.getSelectionGroup().getSize() > 1;
302 AlignmentView seqStrings = av.getAlignmentView(selview);
306 end = av.getAlignment().getWidth();
307 seqs = av.getAlignment().getSequencesArray();
311 start = av.getSelectionGroup().getStartRes();
312 end = av.getSelectionGroup().getEndRes() + 1;
313 seqs = av.getSelectionGroup().getSequencesInOrder(
317 tree = new NJTree(seqs, seqStrings, type, pwtype, start, end);
321 tree.reCount(tree.getTopNode());
322 tree.findHeight(tree.getTopNode());
323 treeCanvas.setTree(tree);
324 treeCanvas.repaint();
325 av.setCurrentTree(tree);
326 if (av.getSortByTree())
328 sortByTree_actionPerformed(null);
333 public void showDistances(boolean b)
335 treeCanvas.setShowDistances(b);
336 distanceMenu.setSelected(b);
339 public void showBootstrap(boolean b)
341 treeCanvas.setShowBootstrap(b);
342 bootstrapMenu.setSelected(b);
345 public void showPlaceholders(boolean b)
347 placeholdersMenu.setState(b);
348 treeCanvas.setMarkPlaceholders(b);
351 private void allowOriginalSeqData(boolean b)
353 originalSeqData.setVisible(b);
359 * @return DOCUMENT ME!
361 public NJTree getTree()
372 public void textbox_actionPerformed(ActionEvent e)
374 CutAndPasteTransfer cap = new CutAndPasteTransfer();
376 StringBuffer buffer = new StringBuffer();
378 if (type.equals("AV"))
380 buffer.append("Average distance tree using ");
384 buffer.append("Neighbour joining tree using ");
387 if (pwtype.equals("BL"))
389 buffer.append("BLOSUM62");
393 buffer.append("PID");
396 jalview.io.NewickFile fout = new jalview.io.NewickFile(
400 cap.setText(fout.print(tree.isHasBootstrap(), tree.isHasDistances(),
401 tree.isHasRootDistance()));
402 Desktop.addInternalFrame(cap, buffer.toString(), 500, 100);
403 } catch (OutOfMemoryError oom)
405 new OOMWarning("generating newick tree file", oom);
417 public void saveAsNewick_actionPerformed(ActionEvent e)
419 JalviewFileChooser chooser = new JalviewFileChooser(
420 jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
421 chooser.setFileView(new JalviewFileView());
422 chooser.setDialogTitle(MessageManager.getString("label.save_tree_as_newick"));
423 chooser.setToolTipText(MessageManager.getString("action.save"));
425 int value = chooser.showSaveDialog(null);
427 if (value == JalviewFileChooser.APPROVE_OPTION)
429 String choice = chooser.getSelectedFile().getPath();
430 jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
431 .getSelectedFile().getParent());
435 jalview.io.NewickFile fout = new jalview.io.NewickFile(
437 String output = fout.print(tree.isHasBootstrap(),
438 tree.isHasDistances(), tree.isHasRootDistance());
439 java.io.PrintWriter out = new java.io.PrintWriter(
440 new java.io.FileWriter(choice));
443 } catch (Exception ex)
445 ex.printStackTrace();
456 public void printMenu_actionPerformed(ActionEvent e)
458 // Putting in a thread avoids Swing painting problems
459 treeCanvas.startPrinting();
462 public void originalSeqData_actionPerformed(ActionEvent e)
464 if (!tree.hasOriginalSequenceData())
466 jalview.bin.Cache.log
467 .info("Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
470 // decide if av alignment is sufficiently different to original data to
471 // warrant a new window to be created
472 // create new alignmnt window with hidden regions (unhiding hidden regions
473 // yields unaligned seqs)
474 // or create a selection box around columns in alignment view
475 // test Alignment(SeqCigar[])
479 // we try to get the associated view's gap character
480 // but this may fail if the view was closed...
481 gc = av.getGapCharacter();
483 } catch (Exception ex)
487 Object[] alAndColsel = tree.seqData.getAlignmentAndColumnSelection(gc);
489 if (alAndColsel != null && alAndColsel[0] != null)
491 // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
493 Alignment al = new Alignment((SequenceI[]) alAndColsel[0]);
494 Alignment dataset = (av != null && av.getAlignment() != null) ? av
495 .getAlignment().getDataset() : null;
498 al.setDataset(dataset);
504 AlignFrame af = new AlignFrame(al,
505 (ColumnSelection) alAndColsel[1], AlignFrame.DEFAULT_WIDTH,
506 AlignFrame.DEFAULT_HEIGHT);
508 // >>>This is a fix for the moment, until a better solution is
510 // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
512 // af.addSortByOrderMenuItem(ServiceName + " Ordering",
515 Desktop.addInternalFrame(af, MessageManager.formatMessage(
516 "label.original_data_for_params", new String[]
517 { this.title }), AlignFrame.DEFAULT_WIDTH,
518 AlignFrame.DEFAULT_HEIGHT);
529 public void fitToWindow_actionPerformed(ActionEvent e)
531 treeCanvas.fitToWindow = fitToWindow.isSelected();
536 * sort the associated alignment view by the current tree.
540 public void sortByTree_actionPerformed(ActionEvent e)
543 if (treeCanvas.applyToAllViews)
545 final ArrayList<CommandI> commands = new ArrayList<CommandI>();
546 for (AlignmentPanel ap : PaintRefresher.getAssociatedPanels(av
547 .getSequenceSetId()))
549 commands.add(sortAlignmentIn(ap.av.getAlignPanel()));
551 av.getAlignPanel().alignFrame.addHistoryItem(new CommandI()
555 public void undoCommand(AlignmentI[] views)
557 for (CommandI tsort : commands)
559 tsort.undoCommand(views);
566 return commands.size();
570 public String getDescription()
572 return "Tree Sort (many views)";
576 public void doCommand(AlignmentI[] views)
579 for (CommandI tsort : commands)
581 tsort.doCommand(views);
585 for (AlignmentPanel ap : PaintRefresher.getAssociatedPanels(av
586 .getSequenceSetId()))
588 // ensure all the alignFrames refresh their GI after adding an undo item
589 ap.alignFrame.updateEditMenuBar();
594 treeCanvas.ap.alignFrame
595 .addHistoryItem(sortAlignmentIn(treeCanvas.ap));
600 public CommandI sortAlignmentIn(AlignmentPanel ap)
602 AlignViewport av = ap.av;
603 SequenceI[] oldOrder = av.getAlignment().getSequencesArray();
604 AlignmentSorter.sortByTree(av.getAlignment(), tree);
606 undo = new OrderCommand("Tree Sort", oldOrder, av.getAlignment());
608 ap.paintAlignment(true);
618 public void font_actionPerformed(ActionEvent e)
620 if (treeCanvas == null)
625 new FontChooser(this);
628 public Font getTreeFont()
630 return treeCanvas.font;
633 public void setTreeFont(Font font)
635 if (treeCanvas != null)
637 treeCanvas.setFont(font);
647 public void distanceMenu_actionPerformed(ActionEvent e)
649 treeCanvas.setShowDistances(distanceMenu.isSelected());
658 public void bootstrapMenu_actionPerformed(ActionEvent e)
660 treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());
669 public void placeholdersMenu_actionPerformed(ActionEvent e)
671 treeCanvas.setMarkPlaceholders(placeholdersMenu.isSelected());
680 public void epsTree_actionPerformed(ActionEvent e)
682 boolean accurateText = true;
684 String renderStyle = jalview.bin.Cache.getDefault("EPS_RENDERING",
687 // If we need to prompt, and if the GUI is visible then
688 // Prompt for EPS rendering style
689 if (renderStyle.equalsIgnoreCase("Prompt each time")
690 && !(System.getProperty("java.awt.headless") != null && System
691 .getProperty("java.awt.headless").equals("true")))
693 EPSOptions eps = new EPSOptions();
694 renderStyle = eps.getValue();
696 if (renderStyle == null || eps.cancelled)
703 if (renderStyle.equalsIgnoreCase("text"))
705 accurateText = false;
708 int width = treeCanvas.getWidth();
709 int height = treeCanvas.getHeight();
713 jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
714 jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
715 { "eps" }, new String[]
716 { "Encapsulated Postscript" }, "Encapsulated Postscript");
717 chooser.setFileView(new jalview.io.JalviewFileView());
718 chooser.setDialogTitle(MessageManager.getString("label.create_eps_from_tree"));
719 chooser.setToolTipText(MessageManager.getString("action.save"));
721 int value = chooser.showSaveDialog(this);
723 if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)
728 jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
729 .getSelectedFile().getParent());
731 FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());
732 EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width, height);
734 pg.setAccurateTextMode(accurateText);
736 treeCanvas.draw(pg, width, height);
740 } catch (Exception ex)
742 ex.printStackTrace();
752 public void pngTree_actionPerformed(ActionEvent e)
754 int width = treeCanvas.getWidth();
755 int height = treeCanvas.getHeight();
759 jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
760 jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
761 { "png" }, new String[]
762 { "Portable network graphics" }, "Portable network graphics");
764 chooser.setFileView(new jalview.io.JalviewFileView());
765 chooser.setDialogTitle(MessageManager.getString("label.create_png_from_tree"));
766 chooser.setToolTipText(MessageManager.getString("action.save"));
768 int value = chooser.showSaveDialog(this);
770 if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)
775 jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
776 .getSelectedFile().getParent());
778 FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());
780 BufferedImage bi = new BufferedImage(width, height,
781 BufferedImage.TYPE_INT_RGB);
782 Graphics png = bi.getGraphics();
784 treeCanvas.draw(png, width, height);
786 ImageIO.write(bi, "png", out);
788 } catch (Exception ex)
790 ex.printStackTrace();
795 * change node labels to the annotation referred to by labelClass TODO:
796 * promote to a datamodel modification that can be undone TODO: make argument
797 * one case of a generic transformation function ie { undoStep = apply(Tree,
798 * TransformFunction)};
802 public void changeNames(final String labelClass)
804 tree.applyToNodes(new NodeTransformI()
807 public void transform(BinaryNode node)
809 if (node instanceof SequenceNode
810 && !((SequenceNode) node).isPlaceholder()
811 && !((SequenceNode) node).isDummy())
813 String newname = null;
814 SequenceI sq = (SequenceI) ((SequenceNode) node).element();
817 // search dbrefs, features and annotation
818 DBRefEntry[] refs = jalview.util.DBRefUtils.selectRefs(
819 sq.getDBRef(), new String[]
820 { labelClass.toUpperCase() });
823 for (int i = 0; i < refs.length; i++)
827 newname = new String(refs[i].getAccessionId());
831 newname = newname + "; " + refs[i].getAccessionId();
837 SequenceFeature sf[] = sq.getSequenceFeatures();
838 for (int i = 0; sf != null && i < sf.length; i++)
840 if (sf[i].getType().equals(labelClass))
844 newname = new String(sf[i].getDescription());
848 newname = newname + "; " + sf[i].getDescription();
856 String oldname = ((SequenceNode) node).getName();
857 // TODO : save in the undo object for this modification.
858 ((SequenceNode) node).setName(newname);