src/jalview/gui/TreeCanvas.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.gui;
  22
  23 import jalview.analysis.Conservation;
  24 import jalview.analysis.TreeModel;
  25 import jalview.api.AlignViewportI;
  26 import jalview.datamodel.Sequence;
  27 import jalview.datamodel.SequenceGroup;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.datamodel.SequenceNode;
  30 import jalview.schemes.ColourSchemeI;
  31 import jalview.schemes.ColourSchemeProperty;
  32 import jalview.schemes.UserColourScheme;
  33 import jalview.structure.SelectionSource;
  34 import jalview.util.Format;
  35 import jalview.util.MessageManager;
  36
  37 import java.awt.Color;
  38 import java.awt.Dimension;
  39 import java.awt.Font;
  40 import java.awt.FontMetrics;
  41 import java.awt.Graphics;
  42 import java.awt.Graphics2D;
  43 import java.awt.Point;
  44 import java.awt.Rectangle;
  45 import java.awt.RenderingHints;
  46 import java.awt.event.MouseEvent;
  47 import java.awt.event.MouseListener;
  48 import java.awt.event.MouseMotionListener;
  49 import java.awt.print.PageFormat;
  50 import java.awt.print.Printable;
  51 import java.awt.print.PrinterException;
  52 import java.awt.print.PrinterJob;
  53 import java.util.Enumeration;
  54 import java.util.Hashtable;
  55 import java.util.List;
  56 import java.util.Vector;
  57
  58 import javax.swing.JColorChooser;
  59 import javax.swing.JPanel;
  60 import javax.swing.JScrollPane;
  61 import javax.swing.SwingUtilities;
  62 import javax.swing.ToolTipManager;
  63
  64 /**
  65  * DOCUMENT ME!
  66  *
  67  * @author $author$
  68  * @version $Revision$
  69  */
  70 public class TreeCanvas extends JPanel implements MouseListener, Runnable,
  71         Printable, MouseMotionListener, SelectionSource
  72 {
  73   /** DOCUMENT ME!! */
  74   public static final String PLACEHOLDER = " * ";
  75
  76   TreeModel tree;
  77
  78   JScrollPane scrollPane;
  79
  80   TreePanel tp;
  81
  82   AlignViewport av;
  83
  84   AlignmentPanel ap;
  85
  86   Font font;
  87
  88   FontMetrics fm;
  89
  90   boolean fitToWindow = true;
  91
  92   boolean showDistances = false;
  93
  94   boolean showBootstrap = false;
  95
  96   boolean markPlaceholders = false;
  97
  98   int offx = 20;
  99
 100   int offy;
 101
 102   float threshold;
 103
 104   String longestName;
 105
 106   int labelLength = -1;
 107
 108   Hashtable nameHash = new Hashtable();
 109
 110   Hashtable nodeHash = new Hashtable();
 111
 112   SequenceNode highlightNode;
 113
 114   boolean applyToAllViews = false;
 115
 116   /**
 117    * Creates a new TreeCanvas object.
 118    *
 119    * @param av
 120    *          DOCUMENT ME!
 121    * @param tree
 122    *          DOCUMENT ME!
 123    * @param scroller
 124    *          DOCUMENT ME!
 125    * @param label
 126    *          DOCUMENT ME!
 127    */
 128   public TreeCanvas(TreePanel tp, AlignmentPanel ap, JScrollPane scroller)
 129   {
 130     this.tp = tp;
 131     this.av = ap.av;
 132     this.ap = ap;
 133     font = av.getFont();
 134     scrollPane = scroller;
 135     addMouseListener(this);
 136     addMouseMotionListener(this);
 137     ToolTipManager.sharedInstance().registerComponent(this);
 138   }
 139
 140   /**
 141    * DOCUMENT ME!
 142    *
 143    * @param sequence
 144    *          DOCUMENT ME!
 145    */
 146   public void treeSelectionChanged(SequenceI sequence)
 147   {
 148     AlignmentPanel[] aps = getAssociatedPanels();
 149
 150     for (int a = 0; a < aps.length; a++)
 151     {
 152       SequenceGroup selected = aps[a].av.getSelectionGroup();
 153
 154       if (selected == null)
 155       {
 156         selected = new SequenceGroup();
 157         aps[a].av.setSelectionGroup(selected);
 158       }
 159
 160       selected.setEndRes(aps[a].av.getAlignment().getWidth() - 1);
 161       selected.addOrRemove(sequence, true);
 162     }
 163   }
 164
 165   /**
 166    * DOCUMENT ME!
 167    *
 168    * @param tree
 169    *          DOCUMENT ME!
 170    */
 171   public void setTree(TreeModel tree)
 172   {
 173     this.tree = tree;
 174     tree.findHeight(tree.getTopNode());
 175
 176     // Now have to calculate longest name based on the leaves
 177     Vector<SequenceNode> leaves = tree.findLeaves(tree.getTopNode());
 178     boolean has_placeholders = false;
 179     longestName = "";
 180
 181     for (int i = 0; i < leaves.size(); i++)
 182     {
 183       SequenceNode lf = leaves.elementAt(i);
 184
 185       if (lf.isPlaceholder())
 186       {
 187         has_placeholders = true;
 188       }
 189
 190       if (longestName.length() < ((Sequence) lf.element()).getName()
 191               .length())
 192       {
 193         longestName = TreeCanvas.PLACEHOLDER
 194                 + ((Sequence) lf.element()).getName();
 195       }
 196     }
 197
 198     setMarkPlaceholders(has_placeholders);
 199   }
 200
 201   /**
 202    * DOCUMENT ME!
 203    *
 204    * @param g
 205    *          DOCUMENT ME!
 206    * @param node
 207    *          DOCUMENT ME!
 208    * @param chunk
 209    *          DOCUMENT ME!
 210    * @param wscale
 211    *          DOCUMENT ME!
 212    * @param width
 213    *          DOCUMENT ME!
 214    * @param offx
 215    *          DOCUMENT ME!
 216    * @param offy
 217    *          DOCUMENT ME!
 218    */
 219   public void drawNode(Graphics g, SequenceNode node, float chunk,
 220           double wscale, int width, int offx, int offy)
 221   {
 222     if (node == null)
 223     {
 224       return;
 225     }
 226
 227     if ((node.left() == null) && (node.right() == null))
 228     {
 229       // Drawing leaf node
 230       double height = node.height;
 231       double dist = node.dist;
 232
 233       int xstart = (int) ((height - dist) * wscale) + offx;
 234       int xend = (int) (height * wscale) + offx;
 235
 236       int ypos = (int) (node.ycount * chunk) + offy;
 237
 238       if (node.element() instanceof SequenceI)
 239       {
 240         SequenceI seq = (SequenceI) node.element();
 241
 242         if (av.getSequenceColour(seq) == Color.white)
 243         {
 244           g.setColor(Color.black);
 245         }
 246         else
 247         {
 248           g.setColor(av.getSequenceColour(seq).darker());
 249         }
 250       }
 251       else
 252       {
 253         g.setColor(Color.black);
 254       }
 255
 256       // Draw horizontal line
 257       g.drawLine(xstart, ypos, xend, ypos);
 258
 259       String nodeLabel = "";
 260
 261       if (showDistances && (node.dist > 0))
 262       {
 263         nodeLabel = new Format("%-.2f").form(node.dist);
 264       }
 265
 266       if (showBootstrap && node.bootstrap > -1)
 267       {
 268         if (showDistances)
 269         {
 270           nodeLabel = nodeLabel + " : ";
 271         }
 272
 273         nodeLabel = nodeLabel + String.valueOf(node.bootstrap);
 274       }
 275
 276       if (!nodeLabel.equals(""))
 277       {
 278         g.drawString(nodeLabel, xstart + 2, ypos - 2);
 279       }
 280
 281       String name = (markPlaceholders && node.isPlaceholder())
 282               ? (PLACEHOLDER + node.getName())
 283               : node.getName();
 284
 285       int charWidth = fm.stringWidth(name) + 3;
 286       int charHeight = font.getSize();
 287
 288       Rectangle rect = new Rectangle(xend + 10, ypos - charHeight / 2,
 289               charWidth, charHeight);
 290
 291       nameHash.put(node.element(), rect);
 292
 293       // Colour selected leaves differently
 294       SequenceGroup selected = av.getSelectionGroup();
 295
 296       if ((selected != null)
 297               && selected.getSequences(null).contains(node.element()))
 298       {
 299         g.setColor(Color.gray);
 300
 301         g.fillRect(xend + 10, ypos - charHeight / 2, charWidth, charHeight);
 302         g.setColor(Color.white);
 303       }
 304
 305       g.drawString(name, xend + 10, ypos + fm.getDescent());
 306       g.setColor(Color.black);
 307     }
 308     else
 309     {
 310       drawNode(g, (SequenceNode) node.left(), chunk, wscale, width, offx,
 311               offy);
 312       drawNode(g, (SequenceNode) node.right(), chunk, wscale, width, offx,
 313               offy);
 314
 315       double height = node.height;
 316       double dist = node.dist;
 317
 318       int xstart = (int) ((height - dist) * wscale) + offx;
 319       int xend = (int) (height * wscale) + offx;
 320       int ypos = (int) (node.ycount * chunk) + offy;
 321
 322       g.setColor(node.color.darker());
 323
 324       // Draw horizontal line
 325       g.drawLine(xstart, ypos, xend, ypos);
 326       if (node == highlightNode)
 327       {
 328         g.fillRect(xend - 3, ypos - 3, 6, 6);
 329       }
 330       else
 331       {
 332         g.fillRect(xend - 2, ypos - 2, 4, 4);
 333       }
 334
 335       int ystart = (node.left() == null ? 0
 336               : (int) (((SequenceNode) node.left()).ycount * chunk)) + offy;
 337       int yend = (node.right() == null ? 0
 338               : (int) (((SequenceNode) node.right()).ycount * chunk))
 339               + offy;
 340
 341       Rectangle pos = new Rectangle(xend - 2, ypos - 2, 5, 5);
 342       nodeHash.put(node, pos);
 343
 344       g.drawLine((int) (height * wscale) + offx, ystart,
 345               (int) (height * wscale) + offx, yend);
 346
 347       String nodeLabel = "";
 348
 349       if (showDistances && (node.dist > 0))
 350       {
 351         nodeLabel = new Format("%-.2f").form(node.dist);
 352       }
 353
 354       if (showBootstrap && node.bootstrap > -1)
 355       {
 356         if (showDistances)
 357         {
 358           nodeLabel = nodeLabel + " : ";
 359         }
 360
 361         nodeLabel = nodeLabel + String.valueOf(node.bootstrap);
 362       }
 363
 364       if (!nodeLabel.equals(""))
 365       {
 366         g.drawString(nodeLabel, xstart + 2, ypos - 2);
 367       }
 368     }
 369   }
 370
 371   /**
 372    * DOCUMENT ME!
 373    *
 374    * @param x
 375    *          DOCUMENT ME!
 376    * @param y
 377    *          DOCUMENT ME!
 378    *
 379    * @return DOCUMENT ME!
 380    */
 381   public Object findElement(int x, int y)
 382   {
 383     Enumeration keys = nameHash.keys();
 384
 385     while (keys.hasMoreElements())
 386     {
 387       Object ob = keys.nextElement();
 388       Rectangle rect = (Rectangle) nameHash.get(ob);
 389
 390       if ((x >= rect.x) && (x <= (rect.x + rect.width)) && (y >= rect.y)
 391               && (y <= (rect.y + rect.height)))
 392       {
 393         return ob;
 394       }
 395     }
 396
 397     keys = nodeHash.keys();
 398
 399     while (keys.hasMoreElements())
 400     {
 401       Object ob = keys.nextElement();
 402       Rectangle rect = (Rectangle) nodeHash.get(ob);
 403
 404       if ((x >= rect.x) && (x <= (rect.x + rect.width)) && (y >= rect.y)
 405               && (y <= (rect.y + rect.height)))
 406       {
 407         return ob;
 408       }
 409     }
 410
 411     return null;
 412   }
 413
 414   /**
 415    * DOCUMENT ME!
 416    *
 417    * @param pickBox
 418    *          DOCUMENT ME!
 419    */
 420   public void pickNodes(Rectangle pickBox)
 421   {
 422     int width = getWidth();
 423     int height = getHeight();
 424
 425     SequenceNode top = tree.getTopNode();
 426
 427     double wscale = ((width * .8) - (offx * 2)) / tree.getMaxHeight();
 428
 429     if (top.count == 0)
 430     {
 431       top.count = ((SequenceNode) top.left()).count
 432               + ((SequenceNode) top.right()).count;
 433     }
 434
 435     float chunk = (float) (height - (offy)) / top.count;
 436
 437     pickNode(pickBox, top, chunk, wscale, width, offx, offy);
 438   }
 439
 440   /**
 441    * DOCUMENT ME!
 442    *
 443    * @param pickBox
 444    *          DOCUMENT ME!
 445    * @param node
 446    *          DOCUMENT ME!
 447    * @param chunk
 448    *          DOCUMENT ME!
 449    * @param wscale
 450    *          DOCUMENT ME!
 451    * @param width
 452    *          DOCUMENT ME!
 453    * @param offx
 454    *          DOCUMENT ME!
 455    * @param offy
 456    *          DOCUMENT ME!
 457    */
 458   public void pickNode(Rectangle pickBox, SequenceNode node, float chunk,
 459           double wscale, int width, int offx, int offy)
 460   {
 461     if (node == null)
 462     {
 463       return;
 464     }
 465
 466     if ((node.left() == null) && (node.right() == null))
 467     {
 468       double height = node.height;
 469       double dist = node.dist;
 470
 471       int xstart = (int) ((height - dist) * wscale) + offx;
 472       int xend = (int) (height * wscale) + offx;
 473
 474       int ypos = (int) (node.ycount * chunk) + offy;
 475
 476       if (pickBox.contains(new Point(xend, ypos)))
 477       {
 478         if (node.element() instanceof SequenceI)
 479         {
 480           SequenceI seq = (SequenceI) node.element();
 481           SequenceGroup sg = av.getSelectionGroup();
 482
 483           if (sg != null)
 484           {
 485             sg.addOrRemove(seq, true);
 486           }
 487         }
 488       }
 489     }
 490     else
 491     {
 492       pickNode(pickBox, (SequenceNode) node.left(), chunk, wscale, width,
 493               offx, offy);
 494       pickNode(pickBox, (SequenceNode) node.right(), chunk, wscale, width,
 495               offx, offy);
 496     }
 497   }
 498
 499   /**
 500    * DOCUMENT ME!
 501    *
 502    * @param node
 503    *          DOCUMENT ME!
 504    * @param c
 505    *          DOCUMENT ME!
 506    */
 507   public void setColor(SequenceNode node, Color c)
 508   {
 509     if (node == null)
 510     {
 511       return;
 512     }
 513
 514     node.color = c;
 515     if (node.element() instanceof SequenceI)
 516     {
 517       final SequenceI seq = (SequenceI) node.element();
 518       AlignmentPanel[] aps = getAssociatedPanels();
 519       if (aps != null)
 520       {
 521         for (int a = 0; a < aps.length; a++)
 522         {
 523           aps[a].av.setSequenceColour(seq, c);
 524         }
 525       }
 526     }
 527     setColor((SequenceNode) node.left(), c);
 528     setColor((SequenceNode) node.right(), c);
 529   }
 530
 531   /**
 532    * DOCUMENT ME!
 533    */
 534   void startPrinting()
 535   {
 536     Thread thread = new Thread(this);
 537     thread.start();
 538   }
 539
 540   // put printing in a thread to avoid painting problems
 541   @Override
 542   public void run()
 543   {
 544     PrinterJob printJob = PrinterJob.getPrinterJob();
 545     PageFormat defaultPage = printJob.defaultPage();
 546     PageFormat pf = printJob.pageDialog(defaultPage);
 547
 548     if (defaultPage == pf)
 549     {
 550       /*
 551        * user cancelled
 552        */
 553       return;
 554     }
 555
 556     printJob.setPrintable(this, pf);
 557
 558     if (printJob.printDialog())
 559     {
 560       try
 561       {
 562         printJob.print();
 563       } catch (Exception PrintException)
 564       {
 565         PrintException.printStackTrace();
 566       }
 567     }
 568   }
 569
 570   /**
 571    * DOCUMENT ME!
 572    *
 573    * @param pg
 574    *          DOCUMENT ME!
 575    * @param pf
 576    *          DOCUMENT ME!
 577    * @param pi
 578    *          DOCUMENT ME!
 579    *
 580    * @return DOCUMENT ME!
 581    *
 582    * @throws PrinterException
 583    *           DOCUMENT ME!
 584    */
 585   @Override
 586   public int print(Graphics pg, PageFormat pf, int pi)
 587           throws PrinterException
 588   {
 589     pg.setFont(font);
 590     pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
 591
 592     int pwidth = (int) pf.getImageableWidth();
 593     int pheight = (int) pf.getImageableHeight();
 594
 595     int noPages = getHeight() / pheight;
 596
 597     if (pi > noPages)
 598     {
 599       return Printable.NO_SUCH_PAGE;
 600     }
 601
 602     if (pwidth > getWidth())
 603     {
 604       pwidth = getWidth();
 605     }
 606
 607     if (fitToWindow)
 608     {
 609       if (pheight > getHeight())
 610       {
 611         pheight = getHeight();
 612       }
 613
 614       noPages = 0;
 615     }
 616     else
 617     {
 618       FontMetrics fm = pg.getFontMetrics(font);
 619       int height = fm.getHeight() * nameHash.size();
 620       pg.translate(0, -pi * pheight);
 621       pg.setClip(0, pi * pheight, pwidth, (pi * pheight) + pheight);
 622
 623       // translate number of pages,
 624       // height is screen size as this is the
 625       // non overlapping text size
 626       pheight = height;
 627     }
 628
 629     draw(pg, pwidth, pheight);
 630
 631     return Printable.PAGE_EXISTS;
 632   }
 633
 634   /**
 635    * DOCUMENT ME!
 636    *
 637    * @param g
 638    *          DOCUMENT ME!
 639    */
 640   @Override
 641   public void paintComponent(Graphics g)
 642   {
 643     super.paintComponent(g);
 644     g.setFont(font);
 645
 646     if (tree == null)
 647     {
 648       g.drawString(
 649               MessageManager.getString("label.calculating_tree") + "....",
 650               20, getHeight() / 2);
 651     }
 652     else
 653     {
 654       fm = g.getFontMetrics(font);
 655
 656       if (nameHash.size() == 0)
 657       {
 658         repaint();
 659       }
 660
 661       if (fitToWindow || (!fitToWindow && (scrollPane
 662               .getHeight() > ((fm.getHeight() * nameHash.size()) + offy))))
 663       {
 664         draw(g, scrollPane.getWidth(), scrollPane.getHeight());
 665         setPreferredSize(null);
 666       }
 667       else
 668       {
 669         setPreferredSize(new Dimension(scrollPane.getWidth(),
 670                 fm.getHeight() * nameHash.size()));
 671         draw(g, scrollPane.getWidth(), fm.getHeight() * nameHash.size());
 672       }
 673
 674       scrollPane.revalidate();
 675     }
 676   }
 677
 678   /**
 679    * DOCUMENT ME!
 680    *
 681    * @param fontSize
 682    *          DOCUMENT ME!
 683    */
 684   @Override
 685   public void setFont(Font font)
 686   {
 687     this.font = font;
 688     repaint();
 689   }
 690
 691   /**
 692    * DOCUMENT ME!
 693    *
 694    * @param g1
 695    *          DOCUMENT ME!
 696    * @param width
 697    *          DOCUMENT ME!
 698    * @param height
 699    *          DOCUMENT ME!
 700    */
 701   public void draw(Graphics g1, int width, int height)
 702   {
 703     Graphics2D g2 = (Graphics2D) g1;
 704     g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
 705             RenderingHints.VALUE_ANTIALIAS_ON);
 706     g2.setColor(Color.white);
 707     g2.fillRect(0, 0, width, height);
 708     g2.setFont(font);
 709
 710     if (longestName == null || tree == null)
 711     {
 712       g2.drawString("Calculating tree.", 20, 20);
 713     }
 714     offy = font.getSize() + 10;
 715
 716     fm = g2.getFontMetrics(font);
 717
 718     labelLength = fm.stringWidth(longestName) + 20; // 20 allows for scrollbar
 719
 720     double wscale = (width - labelLength - (offx * 2))
 721             / tree.getMaxHeight();
 722
 723     SequenceNode top = tree.getTopNode();
 724
 725     if (top.count == 0)
 726     {
 727       top.count = ((SequenceNode) top.left()).count
 728               + ((SequenceNode) top.right()).count;
 729     }
 730
 731     float chunk = (float) (height - (offy)) / top.count;
 732
 733     drawNode(g2, tree.getTopNode(), chunk, wscale, width, offx, offy);
 734
 735     if (threshold != 0)
 736     {
 737       if (av.getCurrentTree() == tree)
 738       {
 739         g2.setColor(Color.red);
 740       }
 741       else
 742       {
 743         g2.setColor(Color.gray);
 744       }
 745
 746       int x = (int) ((threshold * (getWidth() - labelLength - (2 * offx)))
 747               + offx);
 748
 749       g2.drawLine(x, 0, x, getHeight());
 750     }
 751   }
 752
 753   /**
 754    * Empty method to satisfy the MouseListener interface
 755    *
 756    * @param e
 757    */
 758   @Override
 759   public void mouseReleased(MouseEvent e)
 760   {
 761     /*
 762      * isPopupTrigger is set on mouseReleased on Windows
 763      */
 764     if (e.isPopupTrigger())
 765     {
 766       chooseSubtreeColour();
 767       e.consume(); // prevent mouseClicked happening
 768     }
 769   }
 770
 771   /**
 772    * Empty method to satisfy the MouseListener interface
 773    *
 774    * @param e
 775    */
 776   @Override
 777   public void mouseEntered(MouseEvent e)
 778   {
 779   }
 780
 781   /**
 782    * Empty method to satisfy the MouseListener interface
 783    *
 784    * @param e
 785    */
 786   @Override
 787   public void mouseExited(MouseEvent e)
 788   {
 789   }
 790
 791   /**
 792    * Handles a mouse click on a tree node (clicks elsewhere are handled in
 793    * mousePressed). Click selects the sub-tree, double-click swaps leaf nodes
 794    * order, right-click opens a dialogue to choose colour for the sub-tree.
 795    *
 796    * @param e
 797    */
 798   @Override
 799   public void mouseClicked(MouseEvent evt)
 800   {
 801     if (highlightNode == null)
 802     {
 803       return;
 804     }
 805
 806     if (evt.getClickCount() > 1)
 807     {
 808       tree.swapNodes(highlightNode);
 809       tree.reCount(tree.getTopNode());
 810       tree.findHeight(tree.getTopNode());
 811     }
 812     else
 813     {
 814       Vector<SequenceNode> leaves = tree.findLeaves(highlightNode);
 815
 816       for (int i = 0; i < leaves.size(); i++)
 817       {
 818         SequenceI seq = (SequenceI) leaves.elementAt(i).element();
 819         treeSelectionChanged(seq);
 820       }
 821       av.sendSelection();
 822     }
 823
 824     PaintRefresher.Refresh(tp, av.getSequenceSetId());
 825     repaint();
 826   }
 827
 828   /**
 829    * Offer the user the option to choose a colour for the highlighted node and
 830    * its children; this colour is also applied to the corresponding sequence ids
 831    * in the alignment
 832    */
 833   void chooseSubtreeColour()
 834   {
 835     Color col = JColorChooser.showDialog(this,
 836             MessageManager.getString("label.select_subtree_colour"),
 837             highlightNode.color);
 838     if (col != null)
 839     {
 840       setColor(highlightNode, col);
 841       PaintRefresher.Refresh(tp, ap.av.getSequenceSetId());
 842       repaint();
 843     }
 844   }
 845
 846   @Override
 847   public void mouseMoved(MouseEvent evt)
 848   {
 849     av.setCurrentTree(tree);
 850
 851     Object ob = findElement(evt.getX(), evt.getY());
 852
 853     if (ob instanceof SequenceNode)
 854     {
 855       highlightNode = (SequenceNode) ob;
 856       this.setToolTipText(
 857               "<html>" + MessageManager.getString("label.highlightnode"));
 858       repaint();
 859
 860     }
 861     else
 862     {
 863       if (highlightNode != null)
 864       {
 865         highlightNode = null;
 866         setToolTipText(null);
 867         repaint();
 868       }
 869     }
 870   }
 871
 872   @Override
 873   public void mouseDragged(MouseEvent ect)
 874   {
 875   }
 876
 877   /**
 878    * Handles a mouse press on a sequence name or the tree background canvas
 879    * (click on a node is handled in mouseClicked). The action is to create
 880    * groups by partitioning the tree at the mouse position. Colours for the
 881    * groups (and sequence names) are generated randomly.
 882    *
 883    * @param e
 884    */
 885   @Override
 886   public void mousePressed(MouseEvent e)
 887   {
 888     av.setCurrentTree(tree);
 889
 890     /*
 891      * isPopupTrigger is set for mousePressed (Mac)
 892      * or mouseReleased (Windows)
 893      */
 894     if (e.isPopupTrigger())
 895     {
 896       if (highlightNode != null)
 897       {
 898         chooseSubtreeColour();
 899       }
 900       return;
 901     }
 902
 903     /*
 904      * defer right-click handling on Windows to
 905      * mouseClicked; note isRightMouseButton
 906      * also matches Cmd-click on Mac which should do
 907      * nothing here
 908      */
 909     if (SwingUtilities.isRightMouseButton(e))
 910     {
 911       return;
 912     }
 913
 914     int x = e.getX();
 915     int y = e.getY();
 916
 917     Object ob = findElement(x, y);
 918
 919     if (ob instanceof SequenceI)
 920     {
 921       treeSelectionChanged((Sequence) ob);
 922       PaintRefresher.Refresh(tp, ap.av.getSequenceSetId());
 923       repaint();
 924       av.sendSelection();
 925       return;
 926     }
 927     else if (!(ob instanceof SequenceNode))
 928     {
 929       // Find threshold
 930       if (tree.getMaxHeight() != 0)
 931       {
 932         threshold = (float) (x - offx)
 933                 / (float) (getWidth() - labelLength - (2 * offx));
 934
 935         List<SequenceNode> groups = tree.groupNodes(threshold);
 936         setColor(tree.getTopNode(), Color.black);
 937
 938         AlignmentPanel[] aps = getAssociatedPanels();
 939
 940         // TODO push calls below into a single AlignViewportI method?
 941         // see also AlignViewController.deleteGroups
 942         for (int a = 0; a < aps.length; a++)
 943         {
 944           aps[a].av.setSelectionGroup(null);
 945           aps[a].av.getAlignment().deleteAllGroups();
 946           aps[a].av.clearSequenceColours();
 947           if (aps[a].av.getCodingComplement() != null)
 948           {
 949             aps[a].av.getCodingComplement().setSelectionGroup(null);
 950             aps[a].av.getCodingComplement().getAlignment()
 951                     .deleteAllGroups();
 952             aps[a].av.getCodingComplement().clearSequenceColours();
 953           }
 954         }
 955         colourGroups(groups);
 956
 957         /*
 958          * clear partition (don't show vertical line) if
 959          * it is to the right of all nodes
 960          */
 961         if (groups.isEmpty())
 962         {
 963           threshold = 0f;
 964         }
 965       }
 966
 967       PaintRefresher.Refresh(tp, ap.av.getSequenceSetId());
 968       repaint();
 969     }
 970
 971   }
 972
 973   void colourGroups(List<SequenceNode> groups)
 974   {
 975     AlignmentPanel[] aps = getAssociatedPanels();
 976     for (int i = 0; i < groups.size(); i++)
 977     {
 978       Color col = new Color((int) (Math.random() * 255),
 979               (int) (Math.random() * 255), (int) (Math.random() * 255));
 980       setColor(groups.get(i), col.brighter());
 981
 982       Vector<SequenceNode> l = tree.findLeaves(groups.get(i));
 983
 984       Vector<SequenceI> sequences = new Vector<>();
 985
 986       for (int j = 0; j < l.size(); j++)
 987       {
 988         SequenceI s1 = (SequenceI) l.elementAt(j).element();
 989
 990         if (!sequences.contains(s1))
 991         {
 992           sequences.addElement(s1);
 993         }
 994       }
 995
 996       ColourSchemeI cs = null;
 997       SequenceGroup sg = new SequenceGroup(sequences, null, cs, true, true,
 998               false, 0, av.getAlignment().getWidth() - 1);
 999
1000       if (av.getGlobalColourScheme() != null)
1001       {
1002         if (av.getGlobalColourScheme() instanceof UserColourScheme)
1003         {
1004           cs = new UserColourScheme(
1005                   ((UserColourScheme) av.getGlobalColourScheme())
1006                           .getColours());
1007
1008         }
1009         else
1010         {
1011           cs = ColourSchemeProperty.getColourScheme(av, sg,
1012                   ColourSchemeProperty
1013                   .getColourName(av.getGlobalColourScheme()));
1014         }
1015         // cs is null if shading is an annotationColourGradient
1016         // if (cs != null)
1017         // {
1018         // cs.setThreshold(av.getViewportColourScheme().getThreshold(),
1019         // av.isIgnoreGapsConsensus());
1020         // }
1021       }
1022       sg.setColourScheme(cs);
1023       sg.getGroupColourScheme().setThreshold(
1024               av.getResidueShading().getThreshold(),
1025               av.isIgnoreGapsConsensus());
1026       // sg.recalcConservation();
1027       sg.setName("JTreeGroup:" + sg.hashCode());
1028       sg.setIdColour(col);
1029
1030       for (int a = 0; a < aps.length; a++)
1031       {
1032         if (aps[a].av.getGlobalColourScheme() != null
1033                 && aps[a].av.getResidueShading().conservationApplied())
1034         {
1035           Conservation c = new Conservation("Group", sg.getSequences(null),
1036                   sg.getStartRes(), sg.getEndRes());
1037           c.calculate();
1038           c.verdict(false, aps[a].av.getConsPercGaps());
1039           sg.cs.setConservation(c);
1040         }
1041         // indicate that associated structure views will need an update
1042         aps[a].av.setUpdateStructures(true);
1043         // propagate structure view update and sequence group to complement view
1044         aps[a].av.addSequenceGroup(new SequenceGroup(sg));
1045       }
1046     }
1047
1048     // notify the panel(s) to redo any group specific stuff
1049     // also updates structure views if necessary
1050     for (int a = 0; a < aps.length; a++)
1051     {
1052       aps[a].updateAnnotation();
1053       final AlignViewportI codingComplement = aps[a].av
1054               .getCodingComplement();
1055       if (codingComplement != null)
1056       {
1057         ((AlignViewport) codingComplement).getAlignPanel()
1058                 .updateAnnotation();
1059       }
1060     }
1061   }
1062
1063   /**
1064    * DOCUMENT ME!
1065    *
1066    * @param state
1067    *          DOCUMENT ME!
1068    */
1069   public void setShowDistances(boolean state)
1070   {
1071     this.showDistances = state;
1072     repaint();
1073   }
1074
1075   /**
1076    * DOCUMENT ME!
1077    *
1078    * @param state
1079    *          DOCUMENT ME!
1080    */
1081   public void setShowBootstrap(boolean state)
1082   {
1083     this.showBootstrap = state;
1084     repaint();
1085   }
1086
1087   /**
1088    * DOCUMENT ME!
1089    *
1090    * @param state
1091    *          DOCUMENT ME!
1092    */
1093   public void setMarkPlaceholders(boolean state)
1094   {
1095     this.markPlaceholders = state;
1096     repaint();
1097   }
1098
1099   AlignmentPanel[] getAssociatedPanels()
1100   {
1101     if (applyToAllViews)
1102     {
1103       return PaintRefresher.getAssociatedPanels(av.getSequenceSetId());
1104     }
1105     else
1106     {
1107       return new AlignmentPanel[] { ap };
1108     }
1109   }
1110 }