2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
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 of the License, or (at your option) any later version.
11 * Jalview is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
17 * The Jalview Authors are detailed in the 'AUTHORS' file.
24 import java.util.List;
26 import javax.imageio.*;
29 import java.awt.event.*;
30 import java.awt.image.*;
33 import org.jibble.epsgraphics.*;
34 import jalview.analysis.*;
35 import jalview.commands.CommandI;
36 import jalview.commands.OrderCommand;
37 import jalview.datamodel.*;
39 import jalview.jbgui.*;
47 public class TreePanel extends GTreePanel
53 TreeCanvas treeCanvas;
60 * Creates a new TreePanel object.
75 public TreePanel(AlignmentPanel ap, String type, String pwtype)
78 initTreePanel(ap, type, pwtype, null, null);
80 // We know this tree has distances. JBPNote TODO: prolly should add this as
81 // a userdefined default
82 // showDistances(true);
86 * Creates a new TreePanel object.
99 public TreePanel(AlignmentPanel ap, String type, String pwtype,
103 initTreePanel(ap, type, pwtype, newtree, null);
106 public TreePanel(AlignmentPanel av, String type, String pwtype,
107 NewickFile newtree, AlignmentView inputData)
110 initTreePanel(av, type, pwtype, newtree, inputData);
113 public AlignmentI getAlignment()
115 return treeCanvas.av.getAlignment();
118 public AlignViewport getViewPort()
120 return treeCanvas.av;
123 void initTreePanel(AlignmentPanel ap, String type, String pwtype,
124 NewickFile newTree, AlignmentView inputData)
129 this.pwtype = pwtype;
131 treeCanvas = new TreeCanvas(this, ap, scrollPane);
132 scrollPane.setViewportView(treeCanvas);
134 PaintRefresher.Register(this, ap.av.getSequenceSetId());
136 buildAssociatedViewMenu();
138 av.addPropertyChangeListener(new java.beans.PropertyChangeListener()
140 public void propertyChange(PropertyChangeEvent evt)
142 if (evt.getPropertyName().equals("alignment"))
146 System.out.println("tree is null");
147 // TODO: deal with case when a change event is received whilst a
148 // tree is still being calculated - should save reference for
149 // processing message later.
152 if (evt.getNewValue() == null)
155 .println("new alignment sequences vector value is null");
158 tree.UpdatePlaceHolders((List<SequenceI>) evt.getNewValue());
159 treeCanvas.nameHash.clear(); // reset the mapping between canvas
160 // rectangles and leafnodes
166 TreeLoader tl = new TreeLoader(newTree);
167 if (inputData != null)
169 tl.odata = inputData;
175 public void viewMenu_menuSelected()
177 buildAssociatedViewMenu();
180 void buildAssociatedViewMenu()
182 AlignmentPanel[] aps = PaintRefresher.getAssociatedPanels(av
183 .getSequenceSetId());
184 if (aps.length == 1 && treeCanvas.ap == aps[0])
186 associateLeavesMenu.setVisible(false);
190 associateLeavesMenu.setVisible(true);
192 if ((viewMenu.getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
194 viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
197 associateLeavesMenu.removeAll();
199 JRadioButtonMenuItem item;
200 ButtonGroup buttonGroup = new ButtonGroup();
201 int i, iSize = aps.length;
202 final TreePanel thisTreePanel = this;
203 for (i = 0; i < iSize; i++)
205 final AlignmentPanel ap = aps[i];
206 item = new JRadioButtonMenuItem(ap.av.viewName, ap == treeCanvas.ap);
207 buttonGroup.add(item);
208 item.addActionListener(new ActionListener()
210 public void actionPerformed(ActionEvent evt)
212 treeCanvas.applyToAllViews = false;
214 treeCanvas.av = ap.av;
215 PaintRefresher.Register(thisTreePanel, ap.av.getSequenceSetId());
219 associateLeavesMenu.add(item);
222 final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem("All Views");
223 buttonGroup.add(itemf);
224 itemf.setSelected(treeCanvas.applyToAllViews);
225 itemf.addActionListener(new ActionListener()
227 public void actionPerformed(ActionEvent evt)
229 treeCanvas.applyToAllViews = itemf.isSelected();
232 associateLeavesMenu.add(itemf);
236 class TreeLoader extends Thread
240 jalview.datamodel.AlignmentView odata = null;
242 public TreeLoader(NewickFile newtree)
244 this.newtree = newtree;
247 // Must be outside run(), as Jalview2XML tries to
248 // update distance/bootstrap visibility at the same time
249 showBootstrap(newtree.HasBootstrap());
250 showDistances(newtree.HasDistances());
261 tree = new NJTree(av.getAlignment().getSequencesArray(), newtree);
265 tree = new NJTree(av.getAlignment().getSequencesArray(), odata,
268 if (!tree.hasOriginalSequenceData())
270 allowOriginalSeqData(false);
277 boolean selview = av.getSelectionGroup() != null
278 && av.getSelectionGroup().getSize() > 1;
279 AlignmentView seqStrings = av.getAlignmentView(selview);
283 end = av.getAlignment().getWidth();
284 seqs = av.getAlignment().getSequencesArray();
288 start = av.getSelectionGroup().getStartRes();
289 end = av.getSelectionGroup().getEndRes() + 1;
290 seqs = av.getSelectionGroup().getSequencesInOrder(
294 tree = new NJTree(seqs, seqStrings, type, pwtype, start, end);
298 tree.reCount(tree.getTopNode());
299 tree.findHeight(tree.getTopNode());
300 treeCanvas.setTree(tree);
301 treeCanvas.repaint();
302 av.setCurrentTree(tree);
303 if (av.getSortByTree())
305 sortByTree_actionPerformed(null);
310 public void showDistances(boolean b)
312 treeCanvas.setShowDistances(b);
313 distanceMenu.setSelected(b);
316 public void showBootstrap(boolean b)
318 treeCanvas.setShowBootstrap(b);
319 bootstrapMenu.setSelected(b);
322 public void showPlaceholders(boolean b)
324 placeholdersMenu.setState(b);
325 treeCanvas.setMarkPlaceholders(b);
328 private void allowOriginalSeqData(boolean b)
330 originalSeqData.setVisible(b);
336 * @return DOCUMENT ME!
338 public NJTree getTree()
349 public void textbox_actionPerformed(ActionEvent e)
351 CutAndPasteTransfer cap = new CutAndPasteTransfer();
353 StringBuffer buffer = new StringBuffer();
355 if (type.equals("AV"))
357 buffer.append("Average distance tree using ");
361 buffer.append("Neighbour joining tree using ");
364 if (pwtype.equals("BL"))
366 buffer.append("BLOSUM62");
370 buffer.append("PID");
373 jalview.io.NewickFile fout = new jalview.io.NewickFile(
377 cap.setText(fout.print(tree.isHasBootstrap(), tree.isHasDistances(),
378 tree.isHasRootDistance()));
379 Desktop.addInternalFrame(cap, buffer.toString(), 500, 100);
380 } catch (OutOfMemoryError oom)
382 new OOMWarning("generating newick tree file", oom);
394 public void saveAsNewick_actionPerformed(ActionEvent e)
396 JalviewFileChooser chooser = new JalviewFileChooser(
397 jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
398 chooser.setFileView(new JalviewFileView());
399 chooser.setDialogTitle("Save tree as newick file");
400 chooser.setToolTipText("Save");
402 int value = chooser.showSaveDialog(null);
404 if (value == JalviewFileChooser.APPROVE_OPTION)
406 String choice = chooser.getSelectedFile().getPath();
407 jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
408 .getSelectedFile().getParent());
412 jalview.io.NewickFile fout = new jalview.io.NewickFile(
414 String output = fout.print(tree.isHasBootstrap(),
415 tree.isHasDistances(), tree.isHasRootDistance());
416 java.io.PrintWriter out = new java.io.PrintWriter(
417 new java.io.FileWriter(choice));
420 } catch (Exception ex)
422 ex.printStackTrace();
433 public void printMenu_actionPerformed(ActionEvent e)
435 // Putting in a thread avoids Swing painting problems
436 treeCanvas.startPrinting();
439 public void originalSeqData_actionPerformed(ActionEvent e)
441 if (!tree.hasOriginalSequenceData())
443 jalview.bin.Cache.log
444 .info("Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
447 // decide if av alignment is sufficiently different to original data to
448 // warrant a new window to be created
449 // create new alignmnt window with hidden regions (unhiding hidden regions
450 // yields unaligned seqs)
451 // or create a selection box around columns in alignment view
452 // test Alignment(SeqCigar[])
456 // we try to get the associated view's gap character
457 // but this may fail if the view was closed...
458 gc = av.getGapCharacter();
460 } catch (Exception ex)
464 Object[] alAndColsel = tree.seqData.getAlignmentAndColumnSelection(gc);
466 if (alAndColsel != null && alAndColsel[0] != null)
468 // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
470 Alignment al = new Alignment((SequenceI[]) alAndColsel[0]);
471 Alignment dataset = (av != null && av.getAlignment() != null) ? av
472 .getAlignment().getDataset() : null;
475 al.setDataset(dataset);
481 AlignFrame af = new AlignFrame(al,
482 (ColumnSelection) alAndColsel[1], AlignFrame.DEFAULT_WIDTH,
483 AlignFrame.DEFAULT_HEIGHT);
485 // >>>This is a fix for the moment, until a better solution is
487 // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
489 // af.addSortByOrderMenuItem(ServiceName + " Ordering",
492 Desktop.addInternalFrame(af, "Original Data for " + this.title,
493 AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
504 public void fitToWindow_actionPerformed(ActionEvent e)
506 treeCanvas.fitToWindow = fitToWindow.isSelected();
511 * sort the associated alignment view by the current tree.
515 public void sortByTree_actionPerformed(ActionEvent e)
518 if (treeCanvas.applyToAllViews)
520 final ArrayList<CommandI> commands = new ArrayList<CommandI>();
521 for (AlignmentPanel ap : PaintRefresher.getAssociatedPanels(av
522 .getSequenceSetId()))
524 commands.add(sortAlignmentIn(ap.av.getAlignPanel()));
526 av.getAlignPanel().alignFrame.addHistoryItem(new CommandI()
530 public void undoCommand(AlignmentI[] views)
532 for (CommandI tsort : commands)
534 tsort.undoCommand(views);
541 return commands.size();
545 public String getDescription()
547 return "Tree Sort (many views)";
551 public void doCommand(AlignmentI[] views)
554 for (CommandI tsort : commands)
556 tsort.doCommand(views);
560 for (AlignmentPanel ap : PaintRefresher.getAssociatedPanels(av
561 .getSequenceSetId()))
563 // ensure all the alignFrames refresh their GI after adding an undo item
564 ap.alignFrame.updateEditMenuBar();
569 treeCanvas.ap.alignFrame
570 .addHistoryItem(sortAlignmentIn(treeCanvas.ap));
575 public CommandI sortAlignmentIn(AlignmentPanel ap)
577 AlignViewport av = ap.av;
578 SequenceI[] oldOrder = av.getAlignment().getSequencesArray();
579 AlignmentSorter.sortByTree(av.getAlignment(), tree);
581 undo = new OrderCommand("Tree Sort", oldOrder, av.getAlignment());
583 ap.paintAlignment(true);
593 public void font_actionPerformed(ActionEvent e)
595 if (treeCanvas == null)
600 new FontChooser(this);
603 public Font getTreeFont()
605 return treeCanvas.font;
608 public void setTreeFont(Font font)
610 if (treeCanvas != null)
612 treeCanvas.setFont(font);
622 public void distanceMenu_actionPerformed(ActionEvent e)
624 treeCanvas.setShowDistances(distanceMenu.isSelected());
633 public void bootstrapMenu_actionPerformed(ActionEvent e)
635 treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());
644 public void placeholdersMenu_actionPerformed(ActionEvent e)
646 treeCanvas.setMarkPlaceholders(placeholdersMenu.isSelected());
655 public void epsTree_actionPerformed(ActionEvent e)
657 boolean accurateText = true;
659 String renderStyle = jalview.bin.Cache.getDefault("EPS_RENDERING",
662 // If we need to prompt, and if the GUI is visible then
663 // Prompt for EPS rendering style
664 if (renderStyle.equalsIgnoreCase("Prompt each time")
665 && !(System.getProperty("java.awt.headless") != null && System
666 .getProperty("java.awt.headless").equals("true")))
668 EPSOptions eps = new EPSOptions();
669 renderStyle = eps.getValue();
671 if (renderStyle == null || eps.cancelled)
678 if (renderStyle.equalsIgnoreCase("text"))
680 accurateText = false;
683 int width = treeCanvas.getWidth();
684 int height = treeCanvas.getHeight();
688 jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
689 jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
690 { "eps" }, new String[]
691 { "Encapsulated Postscript" }, "Encapsulated Postscript");
692 chooser.setFileView(new jalview.io.JalviewFileView());
693 chooser.setDialogTitle("Create EPS file from tree");
694 chooser.setToolTipText("Save");
696 int value = chooser.showSaveDialog(this);
698 if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)
703 jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
704 .getSelectedFile().getParent());
706 FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());
707 EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width, height);
709 pg.setAccurateTextMode(accurateText);
711 treeCanvas.draw(pg, width, height);
715 } catch (Exception ex)
717 ex.printStackTrace();
727 public void pngTree_actionPerformed(ActionEvent e)
729 int width = treeCanvas.getWidth();
730 int height = treeCanvas.getHeight();
734 jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
735 jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
736 { "png" }, new String[]
737 { "Portable network graphics" }, "Portable network graphics");
739 chooser.setFileView(new jalview.io.JalviewFileView());
740 chooser.setDialogTitle("Create PNG image from tree");
741 chooser.setToolTipText("Save");
743 int value = chooser.showSaveDialog(this);
745 if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)
750 jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
751 .getSelectedFile().getParent());
753 FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());
755 BufferedImage bi = new BufferedImage(width, height,
756 BufferedImage.TYPE_INT_RGB);
757 Graphics png = bi.getGraphics();
759 treeCanvas.draw(png, width, height);
761 ImageIO.write(bi, "png", out);
763 } catch (Exception ex)
765 ex.printStackTrace();
770 * change node labels to the annotation referred to by labelClass TODO:
771 * promote to a datamodel modification that can be undone TODO: make argument
772 * one case of a generic transformation function ie { undoStep = apply(Tree,
773 * TransformFunction)};
777 public void changeNames(final String labelClass)
779 tree.applyToNodes(new NodeTransformI()
782 public void transform(BinaryNode node)
784 if (node instanceof SequenceNode
785 && !((SequenceNode) node).isPlaceholder()
786 && !((SequenceNode) node).isDummy())
788 String newname = null;
789 SequenceI sq = (SequenceI) ((SequenceNode) node).element();
792 // search dbrefs, features and annotation
793 DBRefEntry[] refs = jalview.util.DBRefUtils.selectRefs(
794 sq.getDBRef(), new String[]
795 { labelClass.toUpperCase() });
798 for (int i = 0; i < refs.length; i++)
802 newname = new String(refs[i].getAccessionId());
806 newname = newname + "; " + refs[i].getAccessionId();
812 SequenceFeature sf[] = sq.getSequenceFeatures();
813 for (int i = 0; sf != null && i < sf.length; i++)
815 if (sf[i].getType().equals(labelClass))
819 newname = new String(sf[i].getDescription());
823 newname = newname + "; " + sf[i].getDescription();
831 String oldname = ((SequenceNode) node).getName();
832 // TODO : save in the undo object for this modification.
833 ((SequenceNode) node).setName(newname);