2 * Jalview - A Sequence Alignment Editor and Viewer
\r
3 * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
\r
5 * This program is free software; you can redistribute it and/or
\r
6 * modify it under the terms of the GNU General Public License
\r
7 * as published by the Free Software Foundation; either version 2
\r
8 * of the License, or (at your option) any later version.
\r
10 * This program is distributed in the hope that it will be useful,
\r
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
13 * GNU General Public License for more details.
\r
15 * You should have received a copy of the GNU General Public License
\r
16 * along with this program; if not, write to the Free Software
\r
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
\r
19 package jalview.gui;
\r
21 import jalview.analysis.*;
\r
23 import jalview.datamodel.*;
\r
25 import jalview.schemes.*;
\r
27 import jalview.util.*;
\r
30 import java.awt.event.*;
\r
31 import java.awt.print.*;
\r
35 import javax.swing.*;
\r
42 * @version $Revision$
\r
44 public class TreeCanvas extends JPanel implements MouseListener, Runnable,
\r
45 Printable, MouseMotionListener
\r
47 /** DOCUMENT ME!! */
\r
48 public static final String PLACEHOLDER = " * ";
\r
50 JScrollPane scrollPane;
\r
55 boolean fitToWindow = true;
\r
56 boolean showDistances = false;
\r
57 boolean showBootstrap = false;
\r
58 boolean markPlaceholders = false;
\r
63 int labelLength = -1;
\r
65 Hashtable nameHash = new Hashtable();
\r
66 Hashtable nodeHash = new Hashtable();
\r
67 SequenceNode highlightNode;
\r
70 * Creates a new TreeCanvas object.
\r
72 * @param av DOCUMENT ME!
\r
73 * @param tree DOCUMENT ME!
\r
74 * @param scroller DOCUMENT ME!
\r
75 * @param label DOCUMENT ME!
\r
77 public TreeCanvas(AlignmentPanel ap, JScrollPane scroller)
\r
81 font = av.getFont();
\r
82 scrollPane = scroller;
\r
83 addMouseListener(this);
\r
84 addMouseMotionListener(this);
\r
85 PaintRefresher.Register(this, ap.av.getSequenceSetId());
\r
86 ToolTipManager.sharedInstance().registerComponent(this);
\r
93 * @param sequence DOCUMENT ME!
\r
95 public void treeSelectionChanged(SequenceI sequence)
\r
97 SequenceGroup selected = av.getSelectionGroup();
\r
99 if (selected == null)
\r
101 selected = new SequenceGroup();
\r
102 av.setSelectionGroup(selected);
\r
105 selected.setEndRes(av.alignment.getWidth()-1);
\r
106 selected.addOrRemove(sequence, true);
\r
112 * @param tree DOCUMENT ME!
\r
114 public void setTree(NJTree tree)
\r
117 tree.findHeight(tree.getTopNode());
\r
119 // Now have to calculate longest name based on the leaves
\r
120 Vector leaves = tree.findLeaves(tree.getTopNode(), new Vector());
\r
121 boolean has_placeholders = false;
\r
124 for (int i = 0; i < leaves.size(); i++)
\r
126 SequenceNode lf = (SequenceNode) leaves.elementAt(i);
\r
128 if (lf.isPlaceholder())
\r
130 has_placeholders = true;
\r
133 if (longestName.length() < ( (Sequence) lf.element()).getName()
\r
136 longestName = TreeCanvas.PLACEHOLDER +
\r
137 ( (Sequence) lf.element()).getName();
\r
141 setMarkPlaceholders(has_placeholders);
\r
147 * @param g DOCUMENT ME!
\r
148 * @param node DOCUMENT ME!
\r
149 * @param chunk DOCUMENT ME!
\r
150 * @param scale DOCUMENT ME!
\r
151 * @param width DOCUMENT ME!
\r
152 * @param offx DOCUMENT ME!
\r
153 * @param offy DOCUMENT ME!
\r
155 public void drawNode(Graphics g, SequenceNode node, float chunk,
\r
156 float scale, int width, int offx, int offy)
\r
163 if ((node.left() == null) && (node.right() == null))
\r
165 // Drawing leaf node
\r
166 float height = node.height;
\r
167 float dist = node.dist;
\r
169 int xstart = (int) ((height - dist) * scale) + offx;
\r
170 int xend = (int) (height * scale) + offx;
\r
172 int ypos = (int) (node.ycount * chunk) + offy;
\r
174 if (node.element() instanceof SequenceI)
\r
176 if (((SequenceI) ((SequenceNode) node).element()).getColor() == Color.white)
\r
178 g.setColor(Color.black);
\r
182 g.setColor(((SequenceI) ((SequenceNode) node).element()).getColor()
\r
188 g.setColor(Color.black);
\r
191 // Draw horizontal line
\r
192 g.drawLine(xstart, ypos, xend, ypos);
\r
194 String nodeLabel = "";
\r
196 if (showDistances && (node.dist > 0))
\r
198 nodeLabel = new Format("%-.2f").form(node.dist);
\r
205 nodeLabel = nodeLabel + " : ";
\r
208 nodeLabel = nodeLabel + String.valueOf(node.getBootstrap());
\r
211 if (!nodeLabel.equals(""))
\r
213 g.drawString(nodeLabel, xstart+2, ypos - 2);
\r
216 String name = (markPlaceholders && node.isPlaceholder())
\r
217 ? (PLACEHOLDER + node.getName()) : node.getName();
\r
219 int charWidth = fm.stringWidth(name) + 3;
\r
220 int charHeight = font.getSize();
\r
222 Rectangle rect = new Rectangle(xend+10, ypos-charHeight/2,
\r
223 charWidth, charHeight);
\r
225 nameHash.put((SequenceI) node.element(), rect);
\r
227 // Colour selected leaves differently
\r
228 SequenceGroup selected = av.getSelectionGroup();
\r
230 if ((selected != null) &&
\r
231 selected.getSequences(false).contains((SequenceI) node.element()))
\r
233 g.setColor(Color.gray);
\r
235 g.fillRect(xend + 10, ypos-charHeight/2, charWidth,
\r
237 g.setColor(Color.white);
\r
240 g.drawString(name, xend + 10, ypos+fm.getDescent());
\r
241 g.setColor(Color.black);
\r
245 drawNode(g, (SequenceNode) node.left(), chunk, scale, width, offx,
\r
247 drawNode(g, (SequenceNode) node.right(), chunk, scale, width, offx,
\r
250 float height = node.height;
\r
251 float dist = node.dist;
\r
253 int xstart = (int) ((height - dist) * scale) + offx;
\r
254 int xend = (int) (height * scale) + offx;
\r
255 int ypos = (int) (node.ycount * chunk) + offy;
\r
257 g.setColor(((SequenceNode) node).color.darker());
\r
259 // Draw horizontal line
\r
260 g.drawLine(xstart, ypos, xend, ypos);
\r
261 if (node == highlightNode)
\r
262 g.fillRect(xend - 3, ypos - 3, 6, 6);
\r
264 g.fillRect(xend - 2, ypos - 2, 4, 4);
\r
266 int ystart = (int) (((SequenceNode) node.left()).ycount * chunk) +
\r
268 int yend = (int) (((SequenceNode) node.right()).ycount * chunk) +
\r
271 Rectangle pos = new Rectangle(xend - 2, ypos - 2, 5, 5);
\r
272 nodeHash.put(node, pos);
\r
274 g.drawLine((int) (height * scale) + offx, ystart,
\r
275 (int) (height * scale) + offx, yend);
\r
277 if (showDistances && (node.dist > 0))
\r
279 g.drawString(new Format("%-.2f").form(node.dist).trim(), xstart+2,
\r
288 * @param x DOCUMENT ME!
\r
289 * @param y DOCUMENT ME!
\r
291 * @return DOCUMENT ME!
\r
293 public Object findElement(int x, int y)
\r
295 Enumeration keys = nameHash.keys();
\r
297 while (keys.hasMoreElements())
\r
299 Object ob = keys.nextElement();
\r
300 Rectangle rect = (Rectangle) nameHash.get(ob);
\r
302 if ((x >= rect.x) && (x <= (rect.x + rect.width)) && (y >= rect.y) &&
\r
303 (y <= (rect.y + rect.height)))
\r
309 keys = nodeHash.keys();
\r
311 while (keys.hasMoreElements())
\r
313 Object ob = keys.nextElement();
\r
314 Rectangle rect = (Rectangle) nodeHash.get(ob);
\r
316 if ((x >= rect.x) && (x <= (rect.x + rect.width)) && (y >= rect.y) &&
\r
317 (y <= (rect.y + rect.height)))
\r
329 * @param pickBox DOCUMENT ME!
\r
331 public void pickNodes(Rectangle pickBox)
\r
333 int width = getWidth();
\r
334 int height = getHeight();
\r
336 SequenceNode top = tree.getTopNode();
\r
338 float wscale = (float) ((width * .8) - (offx * 2)) / tree.getMaxHeight();
\r
340 if (top.count == 0)
\r
342 top.count = ((SequenceNode) top.left()).count +
\r
343 ((SequenceNode) top.right()).count;
\r
346 float chunk = (float) (height - (offy)) / top.count;
\r
348 pickNode(pickBox, top, chunk, wscale, width, offx, offy);
\r
354 * @param pickBox DOCUMENT ME!
\r
355 * @param node DOCUMENT ME!
\r
356 * @param chunk DOCUMENT ME!
\r
357 * @param scale DOCUMENT ME!
\r
358 * @param width DOCUMENT ME!
\r
359 * @param offx DOCUMENT ME!
\r
360 * @param offy DOCUMENT ME!
\r
362 public void pickNode(Rectangle pickBox, SequenceNode node, float chunk,
\r
363 float scale, int width, int offx, int offy)
\r
370 if ((node.left() == null) && (node.right() == null))
\r
372 float height = node.height;
\r
373 float dist = node.dist;
\r
375 int xstart = (int) ((height - dist) * scale) + offx;
\r
376 int xend = (int) (height * scale) + offx;
\r
378 int ypos = (int) (node.ycount * chunk) + offy;
\r
380 if (pickBox.contains(new Point(xend, ypos)))
\r
382 if (node.element() instanceof SequenceI)
\r
384 SequenceI seq = (SequenceI) node.element();
\r
385 SequenceGroup sg = av.getSelectionGroup();
\r
389 sg.addOrRemove(seq, true);
\r
396 pickNode(pickBox, (SequenceNode) node.left(), chunk, scale, width,
\r
398 pickNode(pickBox, (SequenceNode) node.right(), chunk, scale, width,
\r
406 * @param node DOCUMENT ME!
\r
407 * @param c DOCUMENT ME!
\r
409 public void setColor(SequenceNode node, Color c)
\r
416 if ((node.left() == null) && (node.right() == null))
\r
420 if (node.element() instanceof SequenceI)
\r
422 ((SequenceI) node.element()).setColor(c);
\r
428 setColor((SequenceNode) node.left(), c);
\r
429 setColor((SequenceNode) node.right(), c);
\r
436 void startPrinting()
\r
438 Thread thread = new Thread(this);
\r
442 // put printing in a thread to avoid painting problems
\r
445 PrinterJob printJob = PrinterJob.getPrinterJob();
\r
446 PageFormat pf = printJob.pageDialog(printJob.defaultPage());
\r
448 printJob.setPrintable(this, pf);
\r
450 if (printJob.printDialog())
\r
456 catch (Exception PrintException)
\r
458 PrintException.printStackTrace();
\r
466 * @param pg DOCUMENT ME!
\r
467 * @param pf DOCUMENT ME!
\r
468 * @param pi DOCUMENT ME!
\r
470 * @return DOCUMENT ME!
\r
472 * @throws PrinterException DOCUMENT ME!
\r
474 public int print(Graphics pg, PageFormat pf, int pi)
\r
475 throws PrinterException
\r
478 pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
\r
480 int pwidth = (int) pf.getImageableWidth();
\r
481 int pheight = (int) pf.getImageableHeight();
\r
483 int noPages = getHeight() / pheight;
\r
487 return Printable.NO_SUCH_PAGE;
\r
490 if (pwidth > getWidth())
\r
492 pwidth = getWidth();
\r
497 if (pheight > getHeight())
\r
499 pheight = getHeight();
\r
506 FontMetrics fm = pg.getFontMetrics(font);
\r
507 int height = fm.getHeight() * nameHash.size();
\r
508 pg.translate(0, -pi * pheight);
\r
509 pg.setClip(0, pi * pheight, pwidth, (pi * pheight) + pheight);
\r
511 // translate number of pages,
\r
512 // height is screen size as this is the
\r
513 // non overlapping text size
\r
517 draw(pg, pwidth, pheight);
\r
519 return Printable.PAGE_EXISTS;
\r
525 * @param g DOCUMENT ME!
\r
527 public void paintComponent(Graphics g)
\r
529 super.paintComponent(g);
\r
534 g.drawString("Calculating tree....", 20, getHeight()/2);
\r
538 fm = g.getFontMetrics(font);
\r
540 if (nameHash.size() == 0)
\r
547 (scrollPane.getHeight() > ( (fm.getHeight() * nameHash.size()) +
\r
550 draw(g, scrollPane.getWidth(), scrollPane.getHeight());
\r
551 setPreferredSize(null);
\r
555 setPreferredSize(new Dimension(scrollPane.getWidth(),
\r
556 fm.getHeight() * nameHash.size()));
\r
557 draw(g, scrollPane.getWidth(), fm.getHeight() * nameHash.size());
\r
560 scrollPane.revalidate();
\r
568 * @param fontSize DOCUMENT ME!
\r
570 public void setFont(Font font)
\r
579 * @param g1 DOCUMENT ME!
\r
580 * @param width DOCUMENT ME!
\r
581 * @param height DOCUMENT ME!
\r
583 public void draw(Graphics g1, int width, int height)
\r
585 Graphics2D g2 = (Graphics2D) g1;
\r
586 g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
\r
587 RenderingHints.VALUE_ANTIALIAS_ON);
\r
588 g2.setColor(Color.white);
\r
589 g2.fillRect(0, 0, width, height);
\r
593 offy = font.getSize()+10;
\r
595 fm = g2.getFontMetrics(font);
\r
597 labelLength = fm.stringWidth(longestName) + 20; //20 allows for scrollbar
\r
599 float wscale = (float) (width - labelLength - (offx * 2)) / tree.getMaxHeight();
\r
601 SequenceNode top = tree.getTopNode();
\r
603 if (top.count == 0)
\r
605 top.count = ((SequenceNode) top.left()).count +
\r
606 ((SequenceNode) top.right()).count;
\r
609 float chunk = (float) (height - (offy)) / top.count;
\r
611 drawNode(g2, tree.getTopNode(), chunk, wscale, width, offx, offy);
\r
613 if (threshold != 0)
\r
615 if (av.getCurrentTree() == tree)
\r
617 g2.setColor(Color.red);
\r
621 g2.setColor(Color.gray);
\r
624 int x = (int) ((threshold * (float) (getWidth() - labelLength -
\r
625 (2 * offx))) + offx);
\r
627 g2.drawLine(x, 0, x, getHeight());
\r
634 * @param e DOCUMENT ME!
\r
636 public void mouseReleased(MouseEvent e)
\r
643 * @param e DOCUMENT ME!
\r
645 public void mouseEntered(MouseEvent e)
\r
652 * @param e DOCUMENT ME!
\r
654 public void mouseExited(MouseEvent e)
\r
661 * @param e DOCUMENT ME!
\r
663 public void mouseClicked(MouseEvent evt)
\r
665 if(highlightNode!=null)
\r
667 if (SwingUtilities.isRightMouseButton(evt))
\r
669 Color col = JColorChooser.showDialog(this, "Select Background Colour",
\r
670 highlightNode.color);
\r
672 setColor(highlightNode, col);
\r
675 if(evt.getClickCount()>1)
\r
677 tree.swapNodes(highlightNode);
\r
678 tree.reCount(tree.getTopNode());
\r
679 tree.findHeight(tree.getTopNode());
\r
683 Vector leaves = new Vector();
\r
684 tree.findLeaves(highlightNode, leaves);
\r
686 for (int i = 0; i < leaves.size(); i++)
\r
689 (SequenceI) ( (SequenceNode) leaves.elementAt(i)).element();
\r
690 treeSelectionChanged(seq);
\r
694 PaintRefresher.Refresh(this, av.getSequenceSetId());
\r
701 public void mouseMoved(MouseEvent evt)
\r
703 av.setCurrentTree(tree);
\r
705 Object ob = findElement(evt.getX(), evt.getY());
\r
707 if (ob instanceof SequenceNode)
\r
709 highlightNode = (SequenceNode) ob;
\r
710 this.setToolTipText(
\r
711 "<html>Left click to select leaves"
\r
712 + "<br>Double-click to invert leaves"
\r
713 + "<br>Right click to change colour");
\r
719 if (highlightNode != null)
\r
721 highlightNode = null;
\r
722 setToolTipText("");
\r
728 public void mouseDragged(MouseEvent ect)
\r
734 * @param e DOCUMENT ME!
\r
736 public void mousePressed(MouseEvent e)
\r
738 av.setCurrentTree(tree);
\r
743 Object ob = findElement(x, y);
\r
745 if (ob instanceof SequenceI)
\r
747 treeSelectionChanged( (Sequence) ob);
\r
748 PaintRefresher.Refresh(this, ap.av.getSequenceSetId());
\r
752 else if( !(ob instanceof SequenceNode) )
\r
755 if (tree.getMaxHeight() != 0)
\r
757 threshold = (float) (x - offx) / (float) (getWidth() -
\r
758 labelLength - (2 * offx));
\r
760 tree.getGroups().removeAllElements();
\r
761 tree.groupNodes(tree.getTopNode(), threshold);
\r
762 setColor(tree.getTopNode(), Color.black);
\r
764 av.setSelectionGroup(null);
\r
765 av.alignment.deleteAllGroups();
\r
770 PaintRefresher.Refresh(this, ap.av.getSequenceSetId());
\r
777 void colourGroups()
\r
779 for (int i = 0; i < tree.getGroups().size(); i++)
\r
781 Color col = new Color( (int) (Math.random() * 255),
\r
782 (int) (Math.random() * 255),
\r
783 (int) (Math.random() * 255));
\r
784 setColor( (SequenceNode) tree.getGroups().elementAt(i),
\r
787 Vector l = tree.findLeaves( (SequenceNode) tree.getGroups()
\r
791 Vector sequences = new Vector();
\r
793 for (int j = 0; j < l.size(); j++)
\r
795 SequenceI s1 = (SequenceI) ( (SequenceNode) l.elementAt(j)).element();
\r
797 if (!sequences.contains(s1))
\r
799 sequences.addElement(s1);
\r
803 ColourSchemeI cs = null;
\r
805 if (av.getGlobalColourScheme() != null)
\r
807 if (av.getGlobalColourScheme() instanceof UserColourScheme)
\r
809 cs = new UserColourScheme(
\r
810 ( (UserColourScheme) av.getGlobalColourScheme()).getColours());
\r
814 cs = ColourSchemeProperty.getColour(sequences,
\r
815 av.alignment.getWidth(),
\r
816 ColourSchemeProperty.
\r
818 av.getGlobalColourScheme()));
\r
820 cs.setThreshold(av.getGlobalColourScheme().getThreshold(),
\r
821 av.getIgnoreGapsConsensus());
\r
824 SequenceGroup sg = new SequenceGroup(sequences,
\r
825 "TreeGroup", cs, true, true, false,
\r
827 av.alignment.getWidth() - 1);
\r
829 if (av.getGlobalColourScheme() != null
\r
830 && av.getGlobalColourScheme().conservationApplied())
\r
832 Conservation c = new Conservation("Group",
\r
833 ResidueProperties.propHash, 3,
\r
834 sg.getSequences(false),
\r
835 sg.getStartRes(), sg.getEndRes());
\r
838 c.verdict(false, av.ConsPercGaps);
\r
839 sg.cs.setConservation(c);
\r
842 av.alignment.addGroup(sg);
\r
850 * @param state DOCUMENT ME!
\r
852 public void setShowDistances(boolean state)
\r
854 this.showDistances = state;
\r
861 * @param state DOCUMENT ME!
\r
863 public void setShowBootstrap(boolean state)
\r
865 this.showBootstrap = state;
\r
872 * @param state DOCUMENT ME!
\r
874 public void setMarkPlaceholders(boolean state)
\r
876 this.markPlaceholders = state;
\r