src/jalview/gui/SeqPanel.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.api.AlignViewportI;
  24 import jalview.bin.Cache;
  25 import jalview.commands.EditCommand;
  26 import jalview.commands.EditCommand.Action;
  27 import jalview.commands.EditCommand.Edit;
  28 import jalview.datamodel.AlignmentI;
  29 import jalview.datamodel.ColumnSelection;
  30 import jalview.datamodel.HiddenColumns;
  31 import jalview.datamodel.SearchResultMatchI;
  32 import jalview.datamodel.SearchResults;
  33 import jalview.datamodel.SearchResultsI;
  34 import jalview.datamodel.Sequence;
  35 import jalview.datamodel.SequenceFeature;
  36 import jalview.datamodel.SequenceGroup;
  37 import jalview.datamodel.SequenceI;
  38 import jalview.io.SequenceAnnotationReport;
  39 import jalview.renderer.ResidueShaderI;
  40 import jalview.schemes.ResidueProperties;
  41 import jalview.structure.SelectionListener;
  42 import jalview.structure.SelectionSource;
  43 import jalview.structure.SequenceListener;
  44 import jalview.structure.StructureSelectionManager;
  45 import jalview.structure.VamsasSource;
  46 import jalview.util.Comparison;
  47 import jalview.util.MappingUtils;
  48 import jalview.util.MessageManager;
  49 import jalview.util.Platform;
  50 import jalview.viewmodel.AlignmentViewport;
  51
  52 import java.awt.BorderLayout;
  53 import java.awt.Color;
  54 import java.awt.Font;
  55 import java.awt.FontMetrics;
  56 import java.awt.Point;
  57 import java.awt.event.MouseEvent;
  58 import java.awt.event.MouseListener;
  59 import java.awt.event.MouseMotionListener;
  60 import java.awt.event.MouseWheelEvent;
  61 import java.awt.event.MouseWheelListener;
  62 import java.util.Collections;
  63 import java.util.List;
  64
  65 import javax.swing.JPanel;
  66 import javax.swing.SwingUtilities;
  67 import javax.swing.ToolTipManager;
  68
  69 /**
  70  * DOCUMENT ME!
  71  *
  72  * @author $author$
  73  * @version $Revision: 1.130 $
  74  */
  75 public class SeqPanel extends JPanel
  76         implements MouseListener, MouseMotionListener, MouseWheelListener,
  77         SequenceListener, SelectionListener
  78 {
  79   private static final int MAX_TOOLTIP_LENGTH = 300;
  80
  81   public SeqCanvas seqCanvas;
  82
  83   public AlignmentPanel ap;
  84
  85   /*
  86    * last column position for mouseMoved event
  87    */
  88   private int lastMouseColumn;
  89
  90   /*
  91    * last sequence offset for mouseMoved event
  92    */
  93   private int lastMouseSeq;
  94
  95   protected int lastres;
  96
  97   protected int startseq;
  98
  99   protected AlignViewport av;
 100
 101   ScrollThread scrollThread = null;
 102
 103   boolean mouseDragging = false;
 104
 105   boolean editingSeqs = false;
 106
 107   boolean groupEditing = false;
 108
 109   // ////////////////////////////////////////
 110   // ///Everything below this is for defining the boundary of the rubberband
 111   // ////////////////////////////////////////
 112   int oldSeq = -1;
 113
 114   boolean changeEndSeq = false;
 115
 116   boolean changeStartSeq = false;
 117
 118   boolean changeEndRes = false;
 119
 120   boolean changeStartRes = false;
 121
 122   SequenceGroup stretchGroup = null;
 123
 124   boolean remove = false;
 125
 126   Point lastMousePress;
 127
 128   boolean mouseWheelPressed = false;
 129
 130   StringBuffer keyboardNo1;
 131
 132   StringBuffer keyboardNo2;
 133
 134   java.net.URL linkImageURL;
 135
 136   private final SequenceAnnotationReport seqARep;
 137
 138   StringBuilder tooltipText = new StringBuilder();
 139
 140   String tmpString;
 141
 142   EditCommand editCommand;
 143
 144   StructureSelectionManager ssm;
 145
 146   SearchResultsI lastSearchResults;
 147
 148   /**
 149    * Creates a new SeqPanel object
 150    *
 151    * @param viewport
 152    * @param alignPanel
 153    */
 154   public SeqPanel(AlignViewport viewport, AlignmentPanel alignPanel)
 155   {
 156     linkImageURL = getClass().getResource("/images/link.gif");
 157     seqARep = new SequenceAnnotationReport(linkImageURL.toString());
 158     ToolTipManager.sharedInstance().registerComponent(this);
 159     ToolTipManager.sharedInstance().setInitialDelay(0);
 160     ToolTipManager.sharedInstance().setDismissDelay(10000);
 161     this.av = viewport;
 162     setBackground(Color.white);
 163
 164     seqCanvas = new SeqCanvas(alignPanel);
 165     setLayout(new BorderLayout());
 166     add(seqCanvas, BorderLayout.CENTER);
 167
 168     this.ap = alignPanel;
 169
 170     if (!viewport.isDataset())
 171     {
 172       addMouseMotionListener(this);
 173       addMouseListener(this);
 174       addMouseWheelListener(this);
 175       ssm = viewport.getStructureSelectionManager();
 176       ssm.addStructureViewerListener(this);
 177       ssm.addSelectionListener(this);
 178     }
 179
 180     lastMouseColumn = -1;
 181     lastMouseSeq = -1;
 182   }
 183
 184   int startWrapBlock = -1;
 185
 186   int wrappedBlock = -1;
 187
 188   /**
 189    * Returns the aligned sequence position (base 0) at the mouse position, or
 190    * the closest visible one
 191    *
 192    * @param evt
 193    * @return
 194    */
 195   int findColumn(MouseEvent evt)
 196   {
 197     int res = 0;
 198     int x = evt.getX();
 199
 200     int startRes = av.getRanges().getStartRes();
 201     if (av.getWrapAlignment())
 202     {
 203
 204       int hgap = av.getCharHeight();
 205       if (av.getScaleAboveWrapped())
 206       {
 207         hgap += av.getCharHeight();
 208       }
 209
 210       int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
 211               + hgap + seqCanvas.getAnnotationHeight();
 212
 213       int y = evt.getY();
 214       y = Math.max(0, y - hgap);
 215       x = Math.max(0, x - seqCanvas.getLabelWidthWest());
 216
 217       int cwidth = seqCanvas.getWrappedCanvasWidth(this.getWidth());
 218       if (cwidth < 1)
 219       {
 220         return 0;
 221       }
 222
 223       wrappedBlock = y / cHeight;
 224       wrappedBlock += startRes / cwidth;
 225       // allow for wrapped view scrolled right (possible from Overview)
 226       int startOffset = startRes % cwidth;
 227       res = wrappedBlock * cwidth + startOffset
 228               + +Math.min(cwidth - 1, x / av.getCharWidth());
 229     }
 230     else
 231     {
 232       if (x > seqCanvas.getX() + seqCanvas.getWidth())
 233       {
 234         // make sure we calculate relative to visible alignment, rather than
 235         // right-hand gutter
 236         x = seqCanvas.getX() + seqCanvas.getWidth();
 237       }
 238       res = (x / av.getCharWidth()) + startRes;
 239       if (res > av.getRanges().getEndRes())
 240       {
 241         // moused off right
 242         res = av.getRanges().getEndRes();
 243       }
 244     }
 245
 246     if (av.hasHiddenColumns())
 247     {
 248       res = av.getAlignment().getHiddenColumns()
 249               .visibleToAbsoluteColumn(res);
 250     }
 251
 252     return res;
 253
 254   }
 255
 256   int findSeq(MouseEvent evt)
 257   {
 258     int seq = 0;
 259     int y = evt.getY();
 260
 261     if (av.getWrapAlignment())
 262     {
 263       int hgap = av.getCharHeight();
 264       if (av.getScaleAboveWrapped())
 265       {
 266         hgap += av.getCharHeight();
 267       }
 268
 269       int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
 270               + hgap + seqCanvas.getAnnotationHeight();
 271
 272       y -= hgap;
 273
 274       seq = Math.min((y % cHeight) / av.getCharHeight(),
 275               av.getAlignment().getHeight() - 1);
 276     }
 277     else
 278     {
 279       seq = Math.min(
 280               (y / av.getCharHeight()) + av.getRanges().getStartSeq(),
 281               av.getAlignment().getHeight() - 1);
 282     }
 283
 284     return seq;
 285   }
 286
 287   /**
 288    * When all of a sequence of edits are complete, put the resulting edit list
 289    * on the history stack (undo list), and reset flags for editing in progress.
 290    */
 291   void endEditing()
 292   {
 293     try
 294     {
 295       if (editCommand != null && editCommand.getSize() > 0)
 296       {
 297         ap.alignFrame.addHistoryItem(editCommand);
 298         av.firePropertyChange("alignment", null,
 299                 av.getAlignment().getSequences());
 300       }
 301     } finally
 302     {
 303       /*
 304        * Tidy up come what may...
 305        */
 306       startseq = -1;
 307       lastres = -1;
 308       editingSeqs = false;
 309       groupEditing = false;
 310       keyboardNo1 = null;
 311       keyboardNo2 = null;
 312       editCommand = null;
 313     }
 314   }
 315
 316   void setCursorRow()
 317   {
 318     seqCanvas.cursorY = getKeyboardNo1() - 1;
 319     scrollToVisible(true);
 320   }
 321
 322   void setCursorColumn()
 323   {
 324     seqCanvas.cursorX = getKeyboardNo1() - 1;
 325     scrollToVisible(true);
 326   }
 327
 328   void setCursorRowAndColumn()
 329   {
 330     if (keyboardNo2 == null)
 331     {
 332       keyboardNo2 = new StringBuffer();
 333     }
 334     else
 335     {
 336       seqCanvas.cursorX = getKeyboardNo1() - 1;
 337       seqCanvas.cursorY = getKeyboardNo2() - 1;
 338       scrollToVisible(true);
 339     }
 340   }
 341
 342   void setCursorPosition()
 343   {
 344     SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
 345
 346     seqCanvas.cursorX = sequence.findIndex(getKeyboardNo1()) - 1;
 347     scrollToVisible(true);
 348   }
 349
 350   void moveCursor(int dx, int dy)
 351   {
 352     seqCanvas.cursorX += dx;
 353     seqCanvas.cursorY += dy;
 354
 355     HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 356
 357     if (av.hasHiddenColumns() && !hidden.isVisible(seqCanvas.cursorX))
 358     {
 359       int original = seqCanvas.cursorX - dx;
 360       int maxWidth = av.getAlignment().getWidth();
 361
 362       if (!hidden.isVisible(seqCanvas.cursorX))
 363       {
 364         int visx = hidden.absoluteToVisibleColumn(seqCanvas.cursorX - dx);
 365         int[] region = hidden.getRegionWithEdgeAtRes(visx);
 366
 367         if (region != null) // just in case
 368         {
 369           if (dx == 1)
 370           {
 371             // moving right
 372             seqCanvas.cursorX = region[1] + 1;
 373           }
 374           else if (dx == -1)
 375           {
 376             // moving left
 377             seqCanvas.cursorX = region[0] - 1;
 378           }
 379         }
 380         seqCanvas.cursorX = (seqCanvas.cursorX < 0) ? 0 : seqCanvas.cursorX;
 381       }
 382
 383       if (seqCanvas.cursorX >= maxWidth
 384               || !hidden.isVisible(seqCanvas.cursorX))
 385       {
 386         seqCanvas.cursorX = original;
 387       }
 388     }
 389
 390     scrollToVisible(false);
 391   }
 392
 393   /**
 394    * Scroll to make the cursor visible in the viewport.
 395    *
 396    * @param jump
 397    *          just jump to the location rather than scrolling
 398    */
 399   void scrollToVisible(boolean jump)
 400   {
 401     if (seqCanvas.cursorX < 0)
 402     {
 403       seqCanvas.cursorX = 0;
 404     }
 405     else if (seqCanvas.cursorX > av.getAlignment().getWidth() - 1)
 406     {
 407       seqCanvas.cursorX = av.getAlignment().getWidth() - 1;
 408     }
 409
 410     if (seqCanvas.cursorY < 0)
 411     {
 412       seqCanvas.cursorY = 0;
 413     }
 414     else if (seqCanvas.cursorY > av.getAlignment().getHeight() - 1)
 415     {
 416       seqCanvas.cursorY = av.getAlignment().getHeight() - 1;
 417     }
 418
 419     endEditing();
 420
 421     boolean repaintNeeded = true;
 422     if (jump)
 423     {
 424       // only need to repaint if the viewport did not move, as otherwise it will
 425       // get a repaint
 426       repaintNeeded = !av.getRanges().setViewportLocation(seqCanvas.cursorX,
 427               seqCanvas.cursorY);
 428     }
 429     else
 430     {
 431       if (av.getWrapAlignment())
 432       {
 433         // scrollToWrappedVisible expects x-value to have hidden cols subtracted
 434         int x = av.getAlignment().getHiddenColumns()
 435                 .absoluteToVisibleColumn(seqCanvas.cursorX);
 436         av.getRanges().scrollToWrappedVisible(x);
 437       }
 438       else
 439       {
 440         av.getRanges().scrollToVisible(seqCanvas.cursorX,
 441                 seqCanvas.cursorY);
 442       }
 443     }
 444
 445     if (av.getAlignment().getHiddenColumns().isVisible(seqCanvas.cursorX))
 446     {
 447       setStatusMessage(av.getAlignment().getSequenceAt(seqCanvas.cursorY),
 448             seqCanvas.cursorX, seqCanvas.cursorY);
 449     }
 450
 451     if (repaintNeeded)
 452     {
 453       seqCanvas.repaint();
 454     }
 455   }
 456
 457
 458   void setSelectionAreaAtCursor(boolean topLeft)
 459   {
 460     SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
 461
 462     if (av.getSelectionGroup() != null)
 463     {
 464       SequenceGroup sg = av.getSelectionGroup();
 465       // Find the top and bottom of this group
 466       int min = av.getAlignment().getHeight(), max = 0;
 467       for (int i = 0; i < sg.getSize(); i++)
 468       {
 469         int index = av.getAlignment().findIndex(sg.getSequenceAt(i));
 470         if (index > max)
 471         {
 472           max = index;
 473         }
 474         if (index < min)
 475         {
 476           min = index;
 477         }
 478       }
 479
 480       max++;
 481
 482       if (topLeft)
 483       {
 484         sg.setStartRes(seqCanvas.cursorX);
 485         if (sg.getEndRes() < seqCanvas.cursorX)
 486         {
 487           sg.setEndRes(seqCanvas.cursorX);
 488         }
 489
 490         min = seqCanvas.cursorY;
 491       }
 492       else
 493       {
 494         sg.setEndRes(seqCanvas.cursorX);
 495         if (sg.getStartRes() > seqCanvas.cursorX)
 496         {
 497           sg.setStartRes(seqCanvas.cursorX);
 498         }
 499
 500         max = seqCanvas.cursorY + 1;
 501       }
 502
 503       if (min > max)
 504       {
 505         // Only the user can do this
 506         av.setSelectionGroup(null);
 507       }
 508       else
 509       {
 510         // Now add any sequences between min and max
 511         sg.getSequences(null).clear();
 512         for (int i = min; i < max; i++)
 513         {
 514           sg.addSequence(av.getAlignment().getSequenceAt(i), false);
 515         }
 516       }
 517     }
 518
 519     if (av.getSelectionGroup() == null)
 520     {
 521       SequenceGroup sg = new SequenceGroup();
 522       sg.setStartRes(seqCanvas.cursorX);
 523       sg.setEndRes(seqCanvas.cursorX);
 524       sg.addSequence(sequence, false);
 525       av.setSelectionGroup(sg);
 526     }
 527
 528     ap.paintAlignment(false, false);
 529     av.sendSelection();
 530   }
 531
 532   void insertGapAtCursor(boolean group)
 533   {
 534     groupEditing = group;
 535     startseq = seqCanvas.cursorY;
 536     lastres = seqCanvas.cursorX;
 537     editSequence(true, false, seqCanvas.cursorX + getKeyboardNo1());
 538     endEditing();
 539   }
 540
 541   void deleteGapAtCursor(boolean group)
 542   {
 543     groupEditing = group;
 544     startseq = seqCanvas.cursorY;
 545     lastres = seqCanvas.cursorX + getKeyboardNo1();
 546     editSequence(false, false, seqCanvas.cursorX);
 547     endEditing();
 548   }
 549
 550   void insertNucAtCursor(boolean group, String nuc)
 551   {
 552     // TODO not called - delete?
 553     groupEditing = group;
 554     startseq = seqCanvas.cursorY;
 555     lastres = seqCanvas.cursorX;
 556     editSequence(false, true, seqCanvas.cursorX + getKeyboardNo1());
 557     endEditing();
 558   }
 559
 560   void numberPressed(char value)
 561   {
 562     if (keyboardNo1 == null)
 563     {
 564       keyboardNo1 = new StringBuffer();
 565     }
 566
 567     if (keyboardNo2 != null)
 568     {
 569       keyboardNo2.append(value);
 570     }
 571     else
 572     {
 573       keyboardNo1.append(value);
 574     }
 575   }
 576
 577   int getKeyboardNo1()
 578   {
 579     try
 580     {
 581       if (keyboardNo1 != null)
 582       {
 583         int value = Integer.parseInt(keyboardNo1.toString());
 584         keyboardNo1 = null;
 585         return value;
 586       }
 587     } catch (Exception x)
 588     {
 589     }
 590     keyboardNo1 = null;
 591     return 1;
 592   }
 593
 594   int getKeyboardNo2()
 595   {
 596     try
 597     {
 598       if (keyboardNo2 != null)
 599       {
 600         int value = Integer.parseInt(keyboardNo2.toString());
 601         keyboardNo2 = null;
 602         return value;
 603       }
 604     } catch (Exception x)
 605     {
 606     }
 607     keyboardNo2 = null;
 608     return 1;
 609   }
 610
 611   /**
 612    * DOCUMENT ME!
 613    *
 614    * @param evt
 615    *          DOCUMENT ME!
 616    */
 617   @Override
 618   public void mouseReleased(MouseEvent evt)
 619   {
 620     boolean didDrag = mouseDragging; // did we come here after a drag
 621     mouseDragging = false;
 622     mouseWheelPressed = false;
 623
 624     if (evt.isPopupTrigger()) // Windows: mouseReleased
 625     {
 626       showPopupMenu(evt);
 627       evt.consume();
 628       return;
 629     }
 630
 631     if (!editingSeqs)
 632     {
 633       doMouseReleasedDefineMode(evt, didDrag);
 634       return;
 635     }
 636
 637     endEditing();
 638   }
 639
 640   /**
 641    * DOCUMENT ME!
 642    *
 643    * @param evt
 644    *          DOCUMENT ME!
 645    */
 646   @Override
 647   public void mousePressed(MouseEvent evt)
 648   {
 649     lastMousePress = evt.getPoint();
 650
 651     if (SwingUtilities.isMiddleMouseButton(evt))
 652     {
 653       mouseWheelPressed = true;
 654       return;
 655     }
 656
 657     boolean isControlDown = Platform.isControlDown(evt);
 658     if (evt.isShiftDown() || isControlDown)
 659     {
 660       editingSeqs = true;
 661       if (isControlDown)
 662       {
 663         groupEditing = true;
 664       }
 665     }
 666     else
 667     {
 668       doMousePressedDefineMode(evt);
 669       return;
 670     }
 671
 672     int seq = findSeq(evt);
 673     int res = findColumn(evt);
 674
 675     if (seq < 0 || res < 0)
 676     {
 677       return;
 678     }
 679
 680     if ((seq < av.getAlignment().getHeight())
 681             && (res < av.getAlignment().getSequenceAt(seq).getLength()))
 682     {
 683       startseq = seq;
 684       lastres = res;
 685     }
 686     else
 687     {
 688       startseq = -1;
 689       lastres = -1;
 690     }
 691
 692     return;
 693   }
 694
 695   String lastMessage;
 696
 697   @Override
 698   public void mouseOverSequence(SequenceI sequence, int index, int pos)
 699   {
 700     String tmp = sequence.hashCode() + " " + index + " " + pos;
 701
 702     if (lastMessage == null || !lastMessage.equals(tmp))
 703     {
 704       // System.err.println("mouseOver Sequence: "+tmp);
 705       ssm.mouseOverSequence(sequence, index, pos, av);
 706     }
 707     lastMessage = tmp;
 708   }
 709
 710   /**
 711    * Highlight the mapped region described by the search results object (unless
 712    * unchanged). This supports highlight of protein while mousing over linked
 713    * cDNA and vice versa. The status bar is also updated to show the location of
 714    * the start of the highlighted region.
 715    */
 716   @Override
 717   public void highlightSequence(SearchResultsI results)
 718   {
 719     if (results == null || results.equals(lastSearchResults))
 720     {
 721       return;
 722     }
 723     lastSearchResults = results;
 724
 725     boolean wasScrolled = false;
 726
 727     if (av.isFollowHighlight())
 728     {
 729       // don't allow highlight of protein/cDNA to also scroll a complementary
 730       // panel,as this sets up a feedback loop (scrolling panel 1 causes moused
 731       // over residue to change abruptly, causing highlighted residue in panel 2
 732       // to change, causing a scroll in panel 1 etc)
 733       ap.setToScrollComplementPanel(false);
 734       wasScrolled = ap.scrollToPosition(results, false);
 735       if (wasScrolled)
 736       {
 737         seqCanvas.revalidate();
 738       }
 739       ap.setToScrollComplementPanel(true);
 740     }
 741
 742     boolean noFastPaint = wasScrolled && av.getWrapAlignment();
 743     if (seqCanvas.highlightSearchResults(results, noFastPaint))
 744     {
 745       setStatusMessage(results);
 746     }
 747   }
 748
 749   @Override
 750   public VamsasSource getVamsasSource()
 751   {
 752     return this.ap == null ? null : this.ap.av;
 753   }
 754
 755   @Override
 756   public void updateColours(SequenceI seq, int index)
 757   {
 758     System.out.println("update the seqPanel colours");
 759     // repaint();
 760   }
 761
 762   /**
 763    * Action on mouse movement is to update the status bar to show the current
 764    * sequence position, and (if features are shown) to show any features at the
 765    * position in a tooltip. Does nothing if the mouse move does not change
 766    * residue position.
 767    *
 768    * @param evt
 769    */
 770   @Override
 771   public void mouseMoved(MouseEvent evt)
 772   {
 773     if (editingSeqs)
 774     {
 775       // This is because MacOSX creates a mouseMoved
 776       // If control is down, other platforms will not.
 777       mouseDragged(evt);
 778     }
 779
 780     final int column = findColumn(evt);
 781     final int seq = findSeq(evt);
 782
 783     if (column < 0 || seq < 0 || seq >= av.getAlignment().getHeight())
 784     {
 785       lastMouseSeq = -1;
 786       return;
 787     }
 788     if (column == lastMouseColumn && seq == lastMouseSeq)
 789     {
 790       /*
 791        * just a pixel move without change of residue
 792        */
 793       return;
 794     }
 795     lastMouseColumn = column;
 796     lastMouseSeq = seq;
 797
 798     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
 799
 800     if (column >= sequence.getLength())
 801     {
 802       return;
 803     }
 804
 805     /*
 806      * set status bar message, returning residue position in sequence
 807      */
 808     boolean isGapped = Comparison.isGap(sequence.getCharAt(column));
 809     final int pos = setStatusMessage(sequence, column, seq);
 810     if (ssm != null && !isGapped)
 811     {
 812       mouseOverSequence(sequence, column, pos);
 813     }
 814
 815     tooltipText.setLength(6); // Cuts the buffer back to <html>
 816
 817     SequenceGroup[] groups = av.getAlignment().findAllGroups(sequence);
 818     if (groups != null)
 819     {
 820       for (int g = 0; g < groups.length; g++)
 821       {
 822         if (groups[g].getStartRes() <= column
 823                 && groups[g].getEndRes() >= column)
 824         {
 825           if (!groups[g].getName().startsWith("JTreeGroup")
 826                   && !groups[g].getName().startsWith("JGroup"))
 827           {
 828             tooltipText.append(groups[g].getName());
 829           }
 830
 831           if (groups[g].getDescription() != null)
 832           {
 833             tooltipText.append(": " + groups[g].getDescription());
 834           }
 835         }
 836       }
 837     }
 838
 839     /*
 840      * add any features at the position to the tooltip; if over a gap, only
 841      * add features that straddle the gap (pos may be the residue before or
 842      * after the gap)
 843      */
 844     if (av.isShowSequenceFeatures())
 845     {
 846       List<SequenceFeature> features = ap.getFeatureRenderer()
 847               .findFeaturesAtColumn(sequence, column + 1);
 848       seqARep.appendFeatures(tooltipText, pos, features,
 849               this.ap.getSeqPanel().seqCanvas.fr);
 850     }
 851     if (tooltipText.length() == 6) // <html>
 852     {
 853       setToolTipText(null);
 854       lastTooltip = null;
 855     }
 856     else
 857     {
 858       if (tooltipText.length() > MAX_TOOLTIP_LENGTH) // constant
 859       {
 860         tooltipText.setLength(MAX_TOOLTIP_LENGTH);
 861         tooltipText.append("...");
 862       }
 863       String textString = tooltipText.toString();
 864       if (lastTooltip == null || !lastTooltip.equals(textString))
 865       {
 866         String formattedTooltipText = JvSwingUtils.wrapTooltip(true,
 867                 textString);
 868         setToolTipText(formattedTooltipText);
 869         lastTooltip = textString;
 870       }
 871     }
 872   }
 873
 874   private Point lastp = null;
 875
 876   /*
 877    * (non-Javadoc)
 878    *
 879    * @see javax.swing.JComponent#getToolTipLocation(java.awt.event.MouseEvent)
 880    */
 881   @Override
 882   public Point getToolTipLocation(MouseEvent event)
 883   {
 884     int x = event.getX(), w = getWidth();
 885     int wdth = (w - x < 200) ? -(w / 2) : 5; // switch sides when tooltip is too
 886     // close to edge
 887     Point p = lastp;
 888     if (!event.isShiftDown() || p == null)
 889     {
 890       p = (tooltipText != null && tooltipText.length() > 6)
 891               ? new Point(event.getX() + wdth, event.getY() - 20)
 892               : null;
 893     }
 894     /*
 895      * TODO: try to modify position region is not obcured by tooltip
 896      */
 897     return lastp = p;
 898   }
 899
 900   String lastTooltip;
 901
 902   /**
 903    * set when the current UI interaction has resulted in a change that requires
 904    * shading in overviews and structures to be recalculated. this could be
 905    * changed to a something more expressive that indicates what actually has
 906    * changed, so selective redraws can be applied (ie. only structures, only
 907    * overview, etc)
 908    */
 909   private boolean updateOverviewAndStructs = false; // TODO: refactor to avcontroller
 910
 911   /**
 912    * set if av.getSelectionGroup() refers to a group that is defined on the
 913    * alignment view, rather than a transient selection
 914    */
 915   // private boolean editingDefinedGroup = false; // TODO: refactor to
 916   // avcontroller or viewModel
 917
 918   /**
 919    * Sets the status message in alignment panel, showing the sequence number
 920    * (index) and id, and residue and residue position if not at a gap, for the
 921    * given sequence and column position. Returns the residue position returned
 922    * by Sequence.findPosition. Note this may be for the nearest adjacent residue
 923    * if at a gapped position.
 924    *
 925    * @param sequence
 926    *          aligned sequence object
 927    * @param column
 928    *          alignment column
 929    * @param seqIndex
 930    *          index of sequence in alignment
 931    * @return sequence position of residue at column, or adjacent residue if at a
 932    *         gap
 933    */
 934   int setStatusMessage(SequenceI sequence, final int column, int seqIndex)
 935   {
 936     char sequenceChar = sequence.getCharAt(column);
 937     int pos = sequence.findPosition(column);
 938     setStatusMessage(sequence, seqIndex, sequenceChar, pos);
 939
 940     return pos;
 941   }
 942
 943   /**
 944    * Builds the status message for the current cursor location and writes it to
 945    * the status bar, for example
 946    *
 947    * <pre>
 948    * Sequence 3 ID: FER1_SOLLC
 949    * Sequence 5 ID: FER1_PEA Residue: THR (4)
 950    * Sequence 5 ID: FER1_PEA Residue: B (3)
 951    * Sequence 6 ID: O.niloticus.3 Nucleotide: Uracil (2)
 952    * </pre>
 953    *
 954    * @param sequence
 955    * @param seqIndex
 956    *          sequence position in the alignment (1..)
 957    * @param sequenceChar
 958    *          the character under the cursor
 959    * @param residuePos
 960    *          the sequence residue position (if not over a gap)
 961    */
 962   protected void setStatusMessage(SequenceI sequence, int seqIndex,
 963           char sequenceChar, int residuePos)
 964   {
 965     StringBuilder text = new StringBuilder(32);
 966
 967     /*
 968      * Sequence number (if known), and sequence name.
 969      */
 970     String seqno = seqIndex == -1 ? "" : " " + (seqIndex + 1);
 971     text.append("Sequence").append(seqno).append(" ID: ")
 972             .append(sequence.getName());
 973
 974     String residue = null;
 975
 976     /*
 977      * Try to translate the display character to residue name (null for gap).
 978      */
 979     boolean isGapped = Comparison.isGap(sequenceChar);
 980
 981     if (!isGapped)
 982     {
 983       boolean nucleotide = av.getAlignment().isNucleotide();
 984       String displayChar = String.valueOf(sequenceChar);
 985       if (nucleotide)
 986       {
 987         residue = ResidueProperties.nucleotideName.get(displayChar);
 988       }
 989       else
 990       {
 991         residue = "X".equalsIgnoreCase(displayChar) ? "X"
 992                 : ("*".equals(displayChar) ? "STOP"
 993                         : ResidueProperties.aa2Triplet.get(displayChar));
 994       }
 995       text.append(" ").append(nucleotide ? "Nucleotide" : "Residue")
 996               .append(": ").append(residue == null ? displayChar : residue);
 997
 998       text.append(" (").append(Integer.toString(residuePos)).append(")");
 999     }
1000     ap.alignFrame.statusBar.setText(text.toString());
1001   }
1002
1003   /**
1004    * Set the status bar message to highlight the first matched position in
1005    * search results.
1006    *
1007    * @param results
1008    */
1009   private void setStatusMessage(SearchResultsI results)
1010   {
1011     AlignmentI al = this.av.getAlignment();
1012     int sequenceIndex = al.findIndex(results);
1013     if (sequenceIndex == -1)
1014     {
1015       return;
1016     }
1017     SequenceI ds = al.getSequenceAt(sequenceIndex).getDatasetSequence();
1018     for (SearchResultMatchI m : results.getResults())
1019     {
1020       SequenceI seq = m.getSequence();
1021       if (seq.getDatasetSequence() != null)
1022       {
1023         seq = seq.getDatasetSequence();
1024       }
1025
1026       if (seq == ds)
1027       {
1028         int start = m.getStart();
1029         setStatusMessage(seq, sequenceIndex, seq.getCharAt(start - 1),
1030                 start);
1031         return;
1032       }
1033     }
1034   }
1035
1036   /**
1037    * {@inheritDoc}
1038    */
1039   @Override
1040   public void mouseDragged(MouseEvent evt)
1041   {
1042     if (mouseWheelPressed)
1043     {
1044       boolean inSplitFrame = ap.av.getCodingComplement() != null;
1045       boolean copyChanges = inSplitFrame && av.isProteinFontAsCdna();
1046
1047       int oldWidth = av.getCharWidth();
1048
1049       // Which is bigger, left-right or up-down?
1050       if (Math.abs(evt.getY() - lastMousePress.getY()) > Math
1051               .abs(evt.getX() - lastMousePress.getX()))
1052       {
1053         /*
1054          * on drag up or down, decrement or increment font size
1055          */
1056         int fontSize = av.font.getSize();
1057         boolean fontChanged = false;
1058
1059         if (evt.getY() < lastMousePress.getY())
1060         {
1061           fontChanged = true;
1062           fontSize--;
1063         }
1064         else if (evt.getY() > lastMousePress.getY())
1065         {
1066           fontChanged = true;
1067           fontSize++;
1068         }
1069
1070         if (fontSize < 1)
1071         {
1072           fontSize = 1;
1073         }
1074
1075         if (fontChanged)
1076         {
1077           Font newFont = new Font(av.font.getName(), av.font.getStyle(),
1078                   fontSize);
1079           av.setFont(newFont, true);
1080           av.setCharWidth(oldWidth);
1081           ap.fontChanged();
1082           if (copyChanges)
1083           {
1084             ap.av.getCodingComplement().setFont(newFont, true);
1085             SplitFrame splitFrame = (SplitFrame) ap.alignFrame
1086                     .getSplitViewContainer();
1087             splitFrame.adjustLayout();
1088             splitFrame.repaint();
1089           }
1090         }
1091       }
1092       else
1093       {
1094         /*
1095          * on drag left or right, decrement or increment character width
1096          */
1097         int newWidth = 0;
1098         if (evt.getX() < lastMousePress.getX() && av.getCharWidth() > 1)
1099         {
1100           newWidth = av.getCharWidth() - 1;
1101           av.setCharWidth(newWidth);
1102         }
1103         else if (evt.getX() > lastMousePress.getX())
1104         {
1105           newWidth = av.getCharWidth() + 1;
1106           av.setCharWidth(newWidth);
1107         }
1108         if (newWidth > 0)
1109         {
1110           ap.paintAlignment(false, false);
1111           if (copyChanges)
1112           {
1113             /*
1114              * need to ensure newWidth is set on cdna, regardless of which
1115              * panel the mouse drag happened in; protein will compute its
1116              * character width as 1:1 or 3:1
1117              */
1118             av.getCodingComplement().setCharWidth(newWidth);
1119             SplitFrame splitFrame = (SplitFrame) ap.alignFrame
1120                     .getSplitViewContainer();
1121             splitFrame.adjustLayout();
1122             splitFrame.repaint();
1123           }
1124         }
1125       }
1126
1127       FontMetrics fm = getFontMetrics(av.getFont());
1128       av.validCharWidth = fm.charWidth('M') <= av.getCharWidth();
1129
1130       lastMousePress = evt.getPoint();
1131
1132       return;
1133     }
1134
1135     if (!editingSeqs)
1136     {
1137       doMouseDraggedDefineMode(evt);
1138       return;
1139     }
1140
1141     int res = findColumn(evt);
1142
1143     if (res < 0)
1144     {
1145       res = 0;
1146     }
1147
1148     if ((lastres == -1) || (lastres == res))
1149     {
1150       return;
1151     }
1152
1153     if ((res < av.getAlignment().getWidth()) && (res < lastres))
1154     {
1155       // dragLeft, delete gap
1156       editSequence(false, false, res);
1157     }
1158     else
1159     {
1160       editSequence(true, false, res);
1161     }
1162
1163     mouseDragging = true;
1164     if ((scrollThread != null) && (scrollThread.isRunning()))
1165     {
1166       scrollThread.setEvent(evt);
1167     }
1168   }
1169
1170   // TODO: Make it more clever than many booleans
1171   synchronized void editSequence(boolean insertGap, boolean editSeq,
1172           int startres)
1173   {
1174     int fixedLeft = -1;
1175     int fixedRight = -1;
1176     boolean fixedColumns = false;
1177     SequenceGroup sg = av.getSelectionGroup();
1178
1179     SequenceI seq = av.getAlignment().getSequenceAt(startseq);
1180
1181     // No group, but the sequence may represent a group
1182     if (!groupEditing && av.hasHiddenRows())
1183     {
1184       if (av.isHiddenRepSequence(seq))
1185       {
1186         sg = av.getRepresentedSequences(seq);
1187         groupEditing = true;
1188       }
1189     }
1190
1191     StringBuilder message = new StringBuilder(64);
1192     if (groupEditing)
1193     {
1194       message.append("Edit group:");
1195       if (editCommand == null)
1196       {
1197         editCommand = new EditCommand(
1198                 MessageManager.getString("action.edit_group"));
1199       }
1200     }
1201     else
1202     {
1203       message.append("Edit sequence: " + seq.getName());
1204       String label = seq.getName();
1205       if (label.length() > 10)
1206       {
1207         label = label.substring(0, 10);
1208       }
1209       if (editCommand == null)
1210       {
1211         editCommand = new EditCommand(MessageManager
1212                 .formatMessage("label.edit_params", new String[]
1213                 { label }));
1214       }
1215     }
1216
1217     if (insertGap)
1218     {
1219       message.append(" insert ");
1220     }
1221     else
1222     {
1223       message.append(" delete ");
1224     }
1225
1226     message.append(Math.abs(startres - lastres) + " gaps.");
1227     ap.alignFrame.statusBar.setText(message.toString());
1228
1229     // Are we editing within a selection group?
1230     if (groupEditing || (sg != null
1231             && sg.getSequences(av.getHiddenRepSequences()).contains(seq)))
1232     {
1233       fixedColumns = true;
1234
1235       // sg might be null as the user may only see 1 sequence,
1236       // but the sequence represents a group
1237       if (sg == null)
1238       {
1239         if (!av.isHiddenRepSequence(seq))
1240         {
1241           endEditing();
1242           return;
1243         }
1244         sg = av.getRepresentedSequences(seq);
1245       }
1246
1247       fixedLeft = sg.getStartRes();
1248       fixedRight = sg.getEndRes();
1249
1250       if ((startres < fixedLeft && lastres >= fixedLeft)
1251               || (startres >= fixedLeft && lastres < fixedLeft)
1252               || (startres > fixedRight && lastres <= fixedRight)
1253               || (startres <= fixedRight && lastres > fixedRight))
1254       {
1255         endEditing();
1256         return;
1257       }
1258
1259       if (fixedLeft > startres)
1260       {
1261         fixedRight = fixedLeft - 1;
1262         fixedLeft = 0;
1263       }
1264       else if (fixedRight < startres)
1265       {
1266         fixedLeft = fixedRight;
1267         fixedRight = -1;
1268       }
1269     }
1270
1271     if (av.hasHiddenColumns())
1272     {
1273       fixedColumns = true;
1274       int y1 = av.getAlignment().getHiddenColumns()
1275               .getNextHiddenBoundary(true, startres);
1276       int y2 = av.getAlignment().getHiddenColumns()
1277               .getNextHiddenBoundary(false, startres);
1278
1279       if ((insertGap && startres > y1 && lastres < y1)
1280               || (!insertGap && startres < y2 && lastres > y2))
1281       {
1282         endEditing();
1283         return;
1284       }
1285
1286       // System.out.print(y1+" "+y2+" "+fixedLeft+" "+fixedRight+"~~");
1287       // Selection spans a hidden region
1288       if (fixedLeft < y1 && (fixedRight > y2 || fixedRight == -1))
1289       {
1290         if (startres >= y2)
1291         {
1292           fixedLeft = y2;
1293         }
1294         else
1295         {
1296           fixedRight = y2 - 1;
1297         }
1298       }
1299     }
1300
1301     if (groupEditing)
1302     {
1303       List<SequenceI> vseqs = sg.getSequences(av.getHiddenRepSequences());
1304       int g, groupSize = vseqs.size();
1305       SequenceI[] groupSeqs = new SequenceI[groupSize];
1306       for (g = 0; g < groupSeqs.length; g++)
1307       {
1308         groupSeqs[g] = vseqs.get(g);
1309       }
1310
1311       // drag to right
1312       if (insertGap)
1313       {
1314         // If the user has selected the whole sequence, and is dragging to
1315         // the right, we can still extend the alignment and selectionGroup
1316         if (sg.getStartRes() == 0 && sg.getEndRes() == fixedRight
1317                 && sg.getEndRes() == av.getAlignment().getWidth() - 1)
1318         {
1319           sg.setEndRes(av.getAlignment().getWidth() + startres - lastres);
1320           fixedRight = sg.getEndRes();
1321         }
1322
1323         // Is it valid with fixed columns??
1324         // Find the next gap before the end
1325         // of the visible region boundary
1326         boolean blank = false;
1327         for (; fixedRight > lastres; fixedRight--)
1328         {
1329           blank = true;
1330
1331           for (g = 0; g < groupSize; g++)
1332           {
1333             for (int j = 0; j < startres - lastres; j++)
1334             {
1335               if (!Comparison.isGap(groupSeqs[g].getCharAt(fixedRight - j)))
1336               {
1337                 blank = false;
1338                 break;
1339               }
1340             }
1341           }
1342           if (blank)
1343           {
1344             break;
1345           }
1346         }
1347
1348         if (!blank)
1349         {
1350           if (sg.getSize() == av.getAlignment().getHeight())
1351           {
1352             if ((av.hasHiddenColumns() && startres < av.getAlignment()
1353                     .getHiddenColumns()
1354                     .getNextHiddenBoundary(false, startres)))
1355             {
1356               endEditing();
1357               return;
1358             }
1359
1360             int alWidth = av.getAlignment().getWidth();
1361             if (av.hasHiddenRows())
1362             {
1363               int hwidth = av.getAlignment().getHiddenSequences()
1364                       .getWidth();
1365               if (hwidth > alWidth)
1366               {
1367                 alWidth = hwidth;
1368               }
1369             }
1370             // We can still insert gaps if the selectionGroup
1371             // contains all the sequences
1372             sg.setEndRes(sg.getEndRes() + startres - lastres);
1373             fixedRight = alWidth + startres - lastres;
1374           }
1375           else
1376           {
1377             endEditing();
1378             return;
1379           }
1380         }
1381       }
1382
1383       // drag to left
1384       else if (!insertGap)
1385       {
1386         // / Are we able to delete?
1387         // ie are all columns blank?
1388
1389         for (g = 0; g < groupSize; g++)
1390         {
1391           for (int j = startres; j < lastres; j++)
1392           {
1393             if (groupSeqs[g].getLength() <= j)
1394             {
1395               continue;
1396             }
1397
1398             if (!Comparison.isGap(groupSeqs[g].getCharAt(j)))
1399             {
1400               // Not a gap, block edit not valid
1401               endEditing();
1402               return;
1403             }
1404           }
1405         }
1406       }
1407
1408       if (insertGap)
1409       {
1410         // dragging to the right
1411         if (fixedColumns && fixedRight != -1)
1412         {
1413           for (int j = lastres; j < startres; j++)
1414           {
1415             insertChar(j, groupSeqs, fixedRight);
1416           }
1417         }
1418         else
1419         {
1420           appendEdit(Action.INSERT_GAP, groupSeqs, startres,
1421                   startres - lastres);
1422         }
1423       }
1424       else
1425       {
1426         // dragging to the left
1427         if (fixedColumns && fixedRight != -1)
1428         {
1429           for (int j = lastres; j > startres; j--)
1430           {
1431             deleteChar(startres, groupSeqs, fixedRight);
1432           }
1433         }
1434         else
1435         {
1436           appendEdit(Action.DELETE_GAP, groupSeqs, startres,
1437                   lastres - startres);
1438         }
1439
1440       }
1441     }
1442     else
1443     // ///Editing a single sequence///////////
1444     {
1445       if (insertGap)
1446       {
1447         // dragging to the right
1448         if (fixedColumns && fixedRight != -1)
1449         {
1450           for (int j = lastres; j < startres; j++)
1451           {
1452             insertChar(j, new SequenceI[] { seq }, fixedRight);
1453           }
1454         }
1455         else
1456         {
1457           appendEdit(Action.INSERT_GAP, new SequenceI[] { seq }, lastres,
1458                   startres - lastres);
1459         }
1460       }
1461       else
1462       {
1463         if (!editSeq)
1464         {
1465           // dragging to the left
1466           if (fixedColumns && fixedRight != -1)
1467           {
1468             for (int j = lastres; j > startres; j--)
1469             {
1470               if (!Comparison.isGap(seq.getCharAt(startres)))
1471               {
1472                 endEditing();
1473                 break;
1474               }
1475               deleteChar(startres, new SequenceI[] { seq }, fixedRight);
1476             }
1477           }
1478           else
1479           {
1480             // could be a keyboard edit trying to delete none gaps
1481             int max = 0;
1482             for (int m = startres; m < lastres; m++)
1483             {
1484               if (!Comparison.isGap(seq.getCharAt(m)))
1485               {
1486                 break;
1487               }
1488               max++;
1489             }
1490
1491             if (max > 0)
1492             {
1493               appendEdit(Action.DELETE_GAP, new SequenceI[] { seq },
1494                       startres, max);
1495             }
1496           }
1497         }
1498         else
1499         {// insertGap==false AND editSeq==TRUE;
1500           if (fixedColumns && fixedRight != -1)
1501           {
1502             for (int j = lastres; j < startres; j++)
1503             {
1504               insertChar(j, new SequenceI[] { seq }, fixedRight);
1505             }
1506           }
1507           else
1508           {
1509             appendEdit(Action.INSERT_NUC, new SequenceI[] { seq }, lastres,
1510                     startres - lastres);
1511           }
1512         }
1513       }
1514     }
1515
1516     lastres = startres;
1517     seqCanvas.repaint();
1518   }
1519
1520   void insertChar(int j, SequenceI[] seq, int fixedColumn)
1521   {
1522     int blankColumn = fixedColumn;
1523     for (int s = 0; s < seq.length; s++)
1524     {
1525       // Find the next gap before the end of the visible region boundary
1526       // If lastCol > j, theres a boundary after the gap insertion
1527
1528       for (blankColumn = fixedColumn; blankColumn > j; blankColumn--)
1529       {
1530         if (Comparison.isGap(seq[s].getCharAt(blankColumn)))
1531         {
1532           // Theres a space, so break and insert the gap
1533           break;
1534         }
1535       }
1536
1537       if (blankColumn <= j)
1538       {
1539         blankColumn = fixedColumn;
1540         endEditing();
1541         return;
1542       }
1543     }
1544
1545     appendEdit(Action.DELETE_GAP, seq, blankColumn, 1);
1546
1547     appendEdit(Action.INSERT_GAP, seq, j, 1);
1548
1549   }
1550
1551   /**
1552    * Helper method to add and perform one edit action.
1553    *
1554    * @param action
1555    * @param seq
1556    * @param pos
1557    * @param count
1558    */
1559   protected void appendEdit(Action action, SequenceI[] seq, int pos,
1560           int count)
1561   {
1562
1563     final Edit edit = new EditCommand().new Edit(action, seq, pos, count,
1564             av.getAlignment().getGapCharacter());
1565
1566     editCommand.appendEdit(edit, av.getAlignment(), true, null);
1567   }
1568
1569   void deleteChar(int j, SequenceI[] seq, int fixedColumn)
1570   {
1571
1572     appendEdit(Action.DELETE_GAP, seq, j, 1);
1573
1574     appendEdit(Action.INSERT_GAP, seq, fixedColumn, 1);
1575   }
1576
1577   /**
1578    * DOCUMENT ME!
1579    *
1580    * @param e
1581    *          DOCUMENT ME!
1582    */
1583   @Override
1584   public void mouseEntered(MouseEvent e)
1585   {
1586     if (oldSeq < 0)
1587     {
1588       oldSeq = 0;
1589     }
1590
1591     if ((scrollThread != null) && (scrollThread.isRunning()))
1592     {
1593       scrollThread.stopScrolling();
1594       scrollThread = null;
1595     }
1596   }
1597
1598   /**
1599    * DOCUMENT ME!
1600    *
1601    * @param e
1602    *          DOCUMENT ME!
1603    */
1604   @Override
1605   public void mouseExited(MouseEvent e)
1606   {
1607     if (av.getWrapAlignment())
1608     {
1609       return;
1610     }
1611
1612     if (mouseDragging && scrollThread == null)
1613     {
1614       scrollThread = new ScrollThread();
1615     }
1616   }
1617
1618   /**
1619    * Handler for double-click on a position with one or more sequence features.
1620    * Opens the Amend Features dialog to allow feature details to be amended, or
1621    * the feature deleted.
1622    */
1623   @Override
1624   public void mouseClicked(MouseEvent evt)
1625   {
1626     SequenceGroup sg = null;
1627     SequenceI sequence = av.getAlignment().getSequenceAt(findSeq(evt));
1628     if (evt.getClickCount() > 1)
1629     {
1630       sg = av.getSelectionGroup();
1631       if (sg != null && sg.getSize() == 1
1632               && sg.getEndRes() - sg.getStartRes() < 2)
1633       {
1634         av.setSelectionGroup(null);
1635       }
1636
1637       int column = findColumn(evt);
1638
1639       /*
1640        * find features at the position (if not gapped), or straddling
1641        * the position (if at a gap)
1642        */
1643       List<SequenceFeature> features = seqCanvas.getFeatureRenderer()
1644               .findFeaturesAtColumn(sequence, column + 1);
1645
1646       if (!features.isEmpty())
1647       {
1648         /*
1649          * highlight the first feature at the position on the alignment
1650          */
1651         SearchResultsI highlight = new SearchResults();
1652         highlight.addResult(sequence, features.get(0).getBegin(), features
1653                 .get(0).getEnd());
1654         seqCanvas.highlightSearchResults(highlight, false);
1655
1656         /*
1657          * open the Amend Features dialog; clear highlighting afterwards,
1658          * whether changes were made or not
1659          */
1660         List<SequenceI> seqs = Collections.singletonList(sequence);
1661         seqCanvas.getFeatureRenderer().amendFeatures(seqs, features, false,
1662                 ap);
1663         av.setSearchResults(null); // clear highlighting
1664         seqCanvas.repaint(); // draw new/amended features
1665       }
1666     }
1667   }
1668
1669   @Override
1670   public void mouseWheelMoved(MouseWheelEvent e)
1671   {
1672     e.consume();
1673     double wheelRotation = e.getPreciseWheelRotation();
1674     if (wheelRotation > 0)
1675     {
1676       if (e.isShiftDown())
1677       {
1678         av.getRanges().scrollRight(true);
1679
1680       }
1681       else
1682       {
1683         av.getRanges().scrollUp(false);
1684       }
1685     }
1686     else if (wheelRotation < 0)
1687     {
1688       if (e.isShiftDown())
1689       {
1690         av.getRanges().scrollRight(false);
1691       }
1692       else
1693       {
1694         av.getRanges().scrollUp(true);
1695       }
1696     }
1697
1698     /*
1699      * update status bar and tooltip for new position
1700      * (need to synthesize a mouse movement to refresh tooltip)
1701      */
1702     mouseMoved(e);
1703     ToolTipManager.sharedInstance().mouseMoved(e);
1704   }
1705
1706   /**
1707    * DOCUMENT ME!
1708    *
1709    * @param evt
1710    *          DOCUMENT ME!
1711    */
1712   public void doMousePressedDefineMode(MouseEvent evt)
1713   {
1714     final int res = findColumn(evt);
1715     final int seq = findSeq(evt);
1716     oldSeq = seq;
1717     updateOverviewAndStructs = false;
1718
1719     startWrapBlock = wrappedBlock;
1720
1721     if (av.getWrapAlignment() && seq > av.getAlignment().getHeight())
1722     {
1723       JvOptionPane.showInternalMessageDialog(Desktop.desktop,
1724               MessageManager.getString(
1725                       "label.cannot_edit_annotations_in_wrapped_view"),
1726               MessageManager.getString("label.wrapped_view_no_edit"),
1727               JvOptionPane.WARNING_MESSAGE);
1728       return;
1729     }
1730
1731     if (seq < 0 || res < 0)
1732     {
1733       return;
1734     }
1735
1736     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1737
1738     if ((sequence == null) || (res > sequence.getLength()))
1739     {
1740       return;
1741     }
1742
1743     stretchGroup = av.getSelectionGroup();
1744
1745     if (stretchGroup == null || !stretchGroup.contains(sequence, res))
1746     {
1747       stretchGroup = av.getAlignment().findGroup(sequence, res);
1748       if (stretchGroup != null)
1749       {
1750         // only update the current selection if the popup menu has a group to
1751         // focus on
1752         av.setSelectionGroup(stretchGroup);
1753       }
1754     }
1755
1756     if (evt.isPopupTrigger()) // Mac: mousePressed
1757     {
1758       showPopupMenu(evt);
1759       return;
1760     }
1761
1762     /*
1763      * defer right-mouse click handling to mouseReleased on Windows
1764      * (where isPopupTrigger() will answer true)
1765      * NB isRightMouseButton is also true for Cmd-click on Mac
1766      */
1767     if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
1768     {
1769       return;
1770     }
1771
1772     if (av.cursorMode)
1773     {
1774       seqCanvas.cursorX = findColumn(evt);
1775       seqCanvas.cursorY = findSeq(evt);
1776       seqCanvas.repaint();
1777       return;
1778     }
1779
1780     if (stretchGroup == null)
1781     {
1782       createStretchGroup(res, sequence);
1783     }
1784
1785     if (stretchGroup != null)
1786     {
1787       stretchGroup.addPropertyChangeListener(seqCanvas);
1788     }
1789
1790     seqCanvas.repaint();
1791   }
1792
1793   private void createStretchGroup(int res, SequenceI sequence)
1794   {
1795     // Only if left mouse button do we want to change group sizes
1796     // define a new group here
1797     SequenceGroup sg = new SequenceGroup();
1798     sg.setStartRes(res);
1799     sg.setEndRes(res);
1800     sg.addSequence(sequence, false);
1801     av.setSelectionGroup(sg);
1802     stretchGroup = sg;
1803
1804     if (av.getConservationSelected())
1805     {
1806       SliderPanel.setConservationSlider(ap, av.getResidueShading(),
1807               ap.getViewName());
1808     }
1809
1810     if (av.getAbovePIDThreshold())
1811     {
1812       SliderPanel.setPIDSliderSource(ap, av.getResidueShading(),
1813               ap.getViewName());
1814     }
1815     // TODO: stretchGroup will always be not null. Is this a merge error ?
1816     // or is there a threading issue here?
1817     if ((stretchGroup != null) && (stretchGroup.getEndRes() == res))
1818     {
1819       // Edit end res position of selected group
1820       changeEndRes = true;
1821     }
1822     else if ((stretchGroup != null) && (stretchGroup.getStartRes() == res))
1823     {
1824       // Edit end res position of selected group
1825       changeStartRes = true;
1826     }
1827     stretchGroup.getWidth();
1828
1829   }
1830
1831   /**
1832    * Build and show a pop-up menu at the right-click mouse position
1833    *
1834    * @param evt
1835    * @param res
1836    * @param sequences
1837    */
1838   void showPopupMenu(MouseEvent evt)
1839   {
1840     final int column = findColumn(evt);
1841     final int seq = findSeq(evt);
1842     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1843     List<SequenceFeature> features = ap.getFeatureRenderer()
1844             .findFeaturesAtColumn(sequence, column + 1);
1845
1846     PopupMenu pop = new PopupMenu(ap, null, features);
1847     pop.show(this, evt.getX(), evt.getY());
1848   }
1849
1850   /**
1851    * Update the display after mouse up on a selection or group
1852    *
1853    * @param evt
1854    *          mouse released event details
1855    * @param afterDrag
1856    *          true if this event is happening after a mouse drag (rather than a
1857    *          mouse down)
1858    */
1859   public void doMouseReleasedDefineMode(MouseEvent evt, boolean afterDrag)
1860   {
1861     if (stretchGroup == null)
1862     {
1863       return;
1864     }
1865
1866     stretchGroup.removePropertyChangeListener(seqCanvas);
1867
1868     // always do this - annotation has own state
1869     // but defer colourscheme update until hidden sequences are passed in
1870     boolean vischange = stretchGroup.recalcConservation(true);
1871     updateOverviewAndStructs |= vischange && av.isSelectionDefinedGroup()
1872             && afterDrag;
1873     if (stretchGroup.cs != null)
1874     {
1875       stretchGroup.cs.alignmentChanged(stretchGroup,
1876               av.getHiddenRepSequences());
1877
1878       ResidueShaderI groupColourScheme = stretchGroup
1879               .getGroupColourScheme();
1880       String name = stretchGroup.getName();
1881       if (stretchGroup.cs.conservationApplied())
1882       {
1883         SliderPanel.setConservationSlider(ap, groupColourScheme, name);
1884       }
1885       if (stretchGroup.cs.getThreshold() > 0)
1886       {
1887         SliderPanel.setPIDSliderSource(ap, groupColourScheme, name);
1888       }
1889     }
1890     PaintRefresher.Refresh(this, av.getSequenceSetId());
1891     // TODO: structure colours only need updating if stretchGroup used to or now
1892     // does contain sequences with structure views
1893     ap.paintAlignment(updateOverviewAndStructs, updateOverviewAndStructs);
1894     updateOverviewAndStructs = false;
1895     changeEndRes = false;
1896     changeStartRes = false;
1897     stretchGroup = null;
1898     av.sendSelection();
1899   }
1900
1901   /**
1902    * DOCUMENT ME!
1903    *
1904    * @param evt
1905    *          DOCUMENT ME!
1906    */
1907   public void doMouseDraggedDefineMode(MouseEvent evt)
1908   {
1909     int res = findColumn(evt);
1910     int y = findSeq(evt);
1911
1912     if (wrappedBlock != startWrapBlock)
1913     {
1914       return;
1915     }
1916
1917     if (stretchGroup == null)
1918     {
1919       return;
1920     }
1921
1922     if (res >= av.getAlignment().getWidth())
1923     {
1924       res = av.getAlignment().getWidth() - 1;
1925     }
1926
1927     if (stretchGroup.getEndRes() == res)
1928     {
1929       // Edit end res position of selected group
1930       changeEndRes = true;
1931     }
1932     else if (stretchGroup.getStartRes() == res)
1933     {
1934       // Edit start res position of selected group
1935       changeStartRes = true;
1936     }
1937
1938     if (res < av.getRanges().getStartRes())
1939     {
1940       res = av.getRanges().getStartRes();
1941     }
1942
1943     if (changeEndRes)
1944     {
1945       if (res > (stretchGroup.getStartRes() - 1))
1946       {
1947         stretchGroup.setEndRes(res);
1948         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
1949       }
1950     }
1951     else if (changeStartRes)
1952     {
1953       if (res < (stretchGroup.getEndRes() + 1))
1954       {
1955         stretchGroup.setStartRes(res);
1956         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
1957       }
1958     }
1959
1960     int dragDirection = 0;
1961
1962     if (y > oldSeq)
1963     {
1964       dragDirection = 1;
1965     }
1966     else if (y < oldSeq)
1967     {
1968       dragDirection = -1;
1969     }
1970
1971     while ((y != oldSeq) && (oldSeq > -1)
1972             && (y < av.getAlignment().getHeight()))
1973     {
1974       // This routine ensures we don't skip any sequences, as the
1975       // selection is quite slow.
1976       Sequence seq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1977
1978       oldSeq += dragDirection;
1979
1980       if (oldSeq < 0)
1981       {
1982         break;
1983       }
1984
1985       Sequence nextSeq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1986
1987       if (stretchGroup.getSequences(null).contains(nextSeq))
1988       {
1989         stretchGroup.deleteSequence(seq, false);
1990         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
1991       }
1992       else
1993       {
1994         if (seq != null)
1995         {
1996           stretchGroup.addSequence(seq, false);
1997         }
1998
1999         stretchGroup.addSequence(nextSeq, false);
2000         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
2001       }
2002     }
2003
2004     if (oldSeq < 0)
2005     {
2006       oldSeq = -1;
2007     }
2008
2009     mouseDragging = true;
2010
2011     if ((scrollThread != null) && (scrollThread.isRunning()))
2012     {
2013       scrollThread.setEvent(evt);
2014     }
2015   }
2016
2017   void scrollCanvas(MouseEvent evt)
2018   {
2019     if (evt == null)
2020     {
2021       if ((scrollThread != null) && (scrollThread.isRunning()))
2022       {
2023         scrollThread.stopScrolling();
2024         scrollThread = null;
2025       }
2026       mouseDragging = false;
2027     }
2028     else
2029     {
2030       if (scrollThread == null)
2031       {
2032         scrollThread = new ScrollThread();
2033       }
2034
2035       mouseDragging = true;
2036       scrollThread.setEvent(evt);
2037     }
2038
2039   }
2040
2041   // this class allows scrolling off the bottom of the visible alignment
2042   class ScrollThread extends Thread
2043   {
2044     MouseEvent evt;
2045
2046     private volatile boolean threadRunning = true;
2047
2048     public ScrollThread()
2049     {
2050       start();
2051     }
2052
2053     public void setEvent(MouseEvent e)
2054     {
2055       evt = e;
2056     }
2057
2058     public void stopScrolling()
2059     {
2060       threadRunning = false;
2061     }
2062
2063     public boolean isRunning()
2064     {
2065       return threadRunning;
2066     }
2067
2068     @Override
2069     public void run()
2070     {
2071       while (threadRunning)
2072       {
2073         if (evt != null)
2074         {
2075           if (mouseDragging && (evt.getY() < 0)
2076                   && (av.getRanges().getStartSeq() > 0))
2077           {
2078             av.getRanges().scrollUp(true);
2079           }
2080
2081           if (mouseDragging && (evt.getY() >= getHeight()) && (av
2082                   .getAlignment().getHeight() > av.getRanges().getEndSeq()))
2083           {
2084             av.getRanges().scrollUp(false);
2085           }
2086
2087           if (mouseDragging && (evt.getX() < 0))
2088           {
2089             av.getRanges().scrollRight(false);
2090           }
2091           else if (mouseDragging && (evt.getX() >= getWidth()))
2092           {
2093             av.getRanges().scrollRight(true);
2094           }
2095         }
2096
2097         try
2098         {
2099           Thread.sleep(20);
2100         } catch (Exception ex)
2101         {
2102         }
2103       }
2104     }
2105   }
2106
2107   /**
2108    * modify current selection according to a received message.
2109    */
2110   @Override
2111   public void selection(SequenceGroup seqsel, ColumnSelection colsel,
2112           HiddenColumns hidden, SelectionSource source)
2113   {
2114     // TODO: fix this hack - source of messages is align viewport, but SeqPanel
2115     // handles selection messages...
2116     // TODO: extend config options to allow user to control if selections may be
2117     // shared between viewports.
2118     boolean iSentTheSelection = (av == source
2119             || (source instanceof AlignViewport
2120                     && ((AlignmentViewport) source).getSequenceSetId()
2121                             .equals(av.getSequenceSetId())));
2122
2123     if (iSentTheSelection)
2124     {
2125       // respond to our own event by updating dependent dialogs
2126       if (ap.getCalculationDialog() != null)
2127       {
2128         ap.getCalculationDialog().validateCalcTypes();
2129       }
2130
2131       return;
2132     }
2133
2134     // process further ?
2135     if (!av.followSelection)
2136     {
2137       return;
2138     }
2139
2140     /*
2141      * Ignore the selection if there is one of our own pending.
2142      */
2143     if (av.isSelectionGroupChanged(false) || av.isColSelChanged(false))
2144     {
2145       return;
2146     }
2147
2148     /*
2149      * Check for selection in a view of which this one is a dna/protein
2150      * complement.
2151      */
2152     if (selectionFromTranslation(seqsel, colsel, hidden, source))
2153     {
2154       return;
2155     }
2156
2157     // do we want to thread this ? (contention with seqsel and colsel locks, I
2158     // suspect)
2159     /*
2160      * only copy colsel if there is a real intersection between
2161      * sequence selection and this panel's alignment
2162      */
2163     boolean repaint = false;
2164     boolean copycolsel = false;
2165
2166     SequenceGroup sgroup = null;
2167     if (seqsel != null && seqsel.getSize() > 0)
2168     {
2169       if (av.getAlignment() == null)
2170       {
2171         Cache.log.warn("alignviewport av SeqSetId=" + av.getSequenceSetId()
2172                 + " ViewId=" + av.getViewId()
2173                 + " 's alignment is NULL! returning immediately.");
2174         return;
2175       }
2176       sgroup = seqsel.intersect(av.getAlignment(),
2177               (av.hasHiddenRows()) ? av.getHiddenRepSequences() : null);
2178       if ((sgroup != null && sgroup.getSize() > 0))
2179       {
2180         copycolsel = true;
2181       }
2182     }
2183     if (sgroup != null && sgroup.getSize() > 0)
2184     {
2185       av.setSelectionGroup(sgroup);
2186     }
2187     else
2188     {
2189       av.setSelectionGroup(null);
2190     }
2191     av.isSelectionGroupChanged(true);
2192     repaint = true;
2193
2194     if (copycolsel)
2195     {
2196       // the current selection is unset or from a previous message
2197       // so import the new colsel.
2198       if (colsel == null || colsel.isEmpty())
2199       {
2200         if (av.getColumnSelection() != null)
2201         {
2202           av.getColumnSelection().clear();
2203           repaint = true;
2204         }
2205       }
2206       else
2207       {
2208         // TODO: shift colSel according to the intersecting sequences
2209         if (av.getColumnSelection() == null)
2210         {
2211           av.setColumnSelection(new ColumnSelection(colsel));
2212         }
2213         else
2214         {
2215           av.getColumnSelection().setElementsFrom(colsel,
2216                   av.getAlignment().getHiddenColumns());
2217         }
2218       }
2219       av.isColSelChanged(true);
2220       repaint = true;
2221     }
2222
2223     if (copycolsel && av.hasHiddenColumns()
2224             && (av.getAlignment().getHiddenColumns() == null))
2225     {
2226       System.err.println("Bad things");
2227     }
2228     if (repaint) // always true!
2229     {
2230       // probably finessing with multiple redraws here
2231       PaintRefresher.Refresh(this, av.getSequenceSetId());
2232       // ap.paintAlignment(false);
2233     }
2234
2235     // lastly, update dependent dialogs
2236     if (ap.getCalculationDialog() != null)
2237     {
2238       ap.getCalculationDialog().validateCalcTypes();
2239     }
2240
2241   }
2242
2243   /**
2244    * If this panel is a cdna/protein translation view of the selection source,
2245    * tries to map the source selection to a local one, and returns true. Else
2246    * returns false.
2247    *
2248    * @param seqsel
2249    * @param colsel
2250    * @param source
2251    */
2252   protected boolean selectionFromTranslation(SequenceGroup seqsel,
2253           ColumnSelection colsel, HiddenColumns hidden,
2254           SelectionSource source)
2255   {
2256     if (!(source instanceof AlignViewportI))
2257     {
2258       return false;
2259     }
2260     final AlignViewportI sourceAv = (AlignViewportI) source;
2261     if (sourceAv.getCodingComplement() != av
2262             && av.getCodingComplement() != sourceAv)
2263     {
2264       return false;
2265     }
2266
2267     /*
2268      * Map sequence selection
2269      */
2270     SequenceGroup sg = MappingUtils.mapSequenceGroup(seqsel, sourceAv, av);
2271     av.setSelectionGroup(sg);
2272     av.isSelectionGroupChanged(true);
2273
2274     /*
2275      * Map column selection
2276      */
2277     // ColumnSelection cs = MappingUtils.mapColumnSelection(colsel, sourceAv,
2278     // av);
2279     ColumnSelection cs = new ColumnSelection();
2280     HiddenColumns hs = new HiddenColumns();
2281     MappingUtils.mapColumnSelection(colsel, hidden, sourceAv, av, cs, hs);
2282     av.setColumnSelection(cs);
2283     av.getAlignment().setHiddenColumns(hs);
2284
2285     // lastly, update any dependent dialogs
2286     if (ap.getCalculationDialog() != null)
2287     {
2288       ap.getCalculationDialog().validateCalcTypes();
2289     }
2290
2291     PaintRefresher.Refresh(this, av.getSequenceSetId());
2292
2293     return true;
2294   }
2295
2296   /**
2297    *
2298    * @return null or last search results handled by this panel
2299    */
2300   public SearchResultsI getLastSearchResults()
2301   {
2302     return lastSearchResults;
2303   }
2304 }