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     /*
1192      * initialise the edit command if there is not
1193      * already one being extended
1194      */
1195     if (editCommand == null)
1196     {
1197       if (groupEditing)
1198       {
1199         editCommand = new EditCommand(
1200                 MessageManager.getString("action.edit_group"));
1201       }
1202       else
1203       {
1204         String label = seq.getName();
1205         if (label.length() > 10)
1206         {
1207           label = label.substring(0, 10);
1208         }
1209         editCommand = new EditCommand(MessageManager
1210                 .formatMessage("label.edit_params", new String[]
1211                 { label }));
1212       }
1213     }
1214
1215
1216     // Are we editing within a selection group?
1217     if (groupEditing || (sg != null
1218             && sg.getSequences(av.getHiddenRepSequences()).contains(seq)))
1219     {
1220       fixedColumns = true;
1221
1222       // sg might be null as the user may only see 1 sequence,
1223       // but the sequence represents a group
1224       if (sg == null)
1225       {
1226         if (!av.isHiddenRepSequence(seq))
1227         {
1228           endEditing();
1229           return;
1230         }
1231         sg = av.getRepresentedSequences(seq);
1232       }
1233
1234       fixedLeft = sg.getStartRes();
1235       fixedRight = sg.getEndRes();
1236
1237       if ((startres < fixedLeft && lastres >= fixedLeft)
1238               || (startres >= fixedLeft && lastres < fixedLeft)
1239               || (startres > fixedRight && lastres <= fixedRight)
1240               || (startres <= fixedRight && lastres > fixedRight))
1241       {
1242         endEditing();
1243         return;
1244       }
1245
1246       if (fixedLeft > startres)
1247       {
1248         fixedRight = fixedLeft - 1;
1249         fixedLeft = 0;
1250       }
1251       else if (fixedRight < startres)
1252       {
1253         fixedLeft = fixedRight;
1254         fixedRight = -1;
1255       }
1256     }
1257
1258     if (av.hasHiddenColumns())
1259     {
1260       fixedColumns = true;
1261       int y1 = av.getAlignment().getHiddenColumns()
1262               .getNextHiddenBoundary(true, startres);
1263       int y2 = av.getAlignment().getHiddenColumns()
1264               .getNextHiddenBoundary(false, startres);
1265
1266       if ((insertGap && startres > y1 && lastres < y1)
1267               || (!insertGap && startres < y2 && lastres > y2))
1268       {
1269         endEditing();
1270         return;
1271       }
1272
1273       // System.out.print(y1+" "+y2+" "+fixedLeft+" "+fixedRight+"~~");
1274       // Selection spans a hidden region
1275       if (fixedLeft < y1 && (fixedRight > y2 || fixedRight == -1))
1276       {
1277         if (startres >= y2)
1278         {
1279           fixedLeft = y2;
1280         }
1281         else
1282         {
1283           fixedRight = y2 - 1;
1284         }
1285       }
1286     }
1287
1288     if (groupEditing)
1289     {
1290       ap.alignFrame.statusBar.setText(" "); // defer this as difficult!
1291       List<SequenceI> vseqs = sg.getSequences(av.getHiddenRepSequences());
1292       int g, groupSize = vseqs.size();
1293       SequenceI[] groupSeqs = new SequenceI[groupSize];
1294       for (g = 0; g < groupSeqs.length; g++)
1295       {
1296         groupSeqs[g] = vseqs.get(g);
1297       }
1298
1299       // drag to right
1300       if (insertGap)
1301       {
1302         // If the user has selected the whole sequence, and is dragging to
1303         // the right, we can still extend the alignment and selectionGroup
1304         if (sg.getStartRes() == 0 && sg.getEndRes() == fixedRight
1305                 && sg.getEndRes() == av.getAlignment().getWidth() - 1)
1306         {
1307           sg.setEndRes(av.getAlignment().getWidth() + startres - lastres);
1308           fixedRight = sg.getEndRes();
1309         }
1310
1311         // Is it valid with fixed columns??
1312         // Find the next gap before the end
1313         // of the visible region boundary
1314         boolean blank = false;
1315         for (; fixedRight > lastres; fixedRight--)
1316         {
1317           blank = true;
1318
1319           for (g = 0; g < groupSize; g++)
1320           {
1321             for (int j = 0; j < startres - lastres; j++)
1322             {
1323               if (!Comparison.isGap(groupSeqs[g].getCharAt(fixedRight - j)))
1324               {
1325                 blank = false;
1326                 break;
1327               }
1328             }
1329           }
1330           if (blank)
1331           {
1332             break;
1333           }
1334         }
1335
1336         if (!blank)
1337         {
1338           if (sg.getSize() == av.getAlignment().getHeight())
1339           {
1340             if ((av.hasHiddenColumns() && startres < av.getAlignment()
1341                     .getHiddenColumns()
1342                     .getNextHiddenBoundary(false, startres)))
1343             {
1344               endEditing();
1345               return;
1346             }
1347
1348             int alWidth = av.getAlignment().getWidth();
1349             if (av.hasHiddenRows())
1350             {
1351               int hwidth = av.getAlignment().getHiddenSequences()
1352                       .getWidth();
1353               if (hwidth > alWidth)
1354               {
1355                 alWidth = hwidth;
1356               }
1357             }
1358             // We can still insert gaps if the selectionGroup
1359             // contains all the sequences
1360             sg.setEndRes(sg.getEndRes() + startres - lastres);
1361             fixedRight = alWidth + startres - lastres;
1362           }
1363           else
1364           {
1365             endEditing();
1366             return;
1367           }
1368         }
1369       }
1370
1371       // drag to left
1372       else if (!insertGap)
1373       {
1374         // / Are we able to delete?
1375         // ie are all columns blank?
1376
1377         for (g = 0; g < groupSize; g++)
1378         {
1379           for (int j = startres; j < lastres; j++)
1380           {
1381             if (groupSeqs[g].getLength() <= j)
1382             {
1383               continue;
1384             }
1385
1386             if (!Comparison.isGap(groupSeqs[g].getCharAt(j)))
1387             {
1388               // Not a gap, block edit not valid
1389               endEditing();
1390               return;
1391             }
1392           }
1393         }
1394       }
1395
1396       if (insertGap)
1397       {
1398         // dragging to the right
1399         if (fixedColumns && fixedRight != -1)
1400         {
1401           for (int j = lastres; j < startres; j++)
1402           {
1403             insertChar(j, groupSeqs, fixedRight);
1404           }
1405         }
1406         else
1407         {
1408           appendEdit(Action.INSERT_GAP, groupSeqs, startres,
1409                   startres - lastres);
1410         }
1411       }
1412       else
1413       {
1414         // dragging to the left
1415         if (fixedColumns && fixedRight != -1)
1416         {
1417           for (int j = lastres; j > startres; j--)
1418           {
1419             deleteChar(startres, groupSeqs, fixedRight);
1420           }
1421         }
1422         else
1423         {
1424           appendEdit(Action.DELETE_GAP, groupSeqs, startres,
1425                   lastres - startres);
1426         }
1427
1428       }
1429     }
1430     else
1431     // ///Editing a single sequence///////////
1432     {
1433       if (fixedRight == -1)
1434       {
1435         String msg = getEditStatusMessage(insertGap, seq.getName());
1436         ap.alignFrame.statusBar.setText(msg);
1437       }
1438       else
1439       {
1440         ap.alignFrame.statusBar.setText(" ");
1441       }
1442       if (insertGap)
1443       {
1444         // dragging to the right
1445         if (fixedColumns && fixedRight != -1)
1446         {
1447           for (int j = lastres; j < startres; j++)
1448           {
1449             insertChar(j, new SequenceI[] { seq }, fixedRight);
1450           }
1451         }
1452         else
1453         {
1454           appendEdit(Action.INSERT_GAP, new SequenceI[] { seq }, lastres,
1455                   startres - lastres);
1456         }
1457       }
1458       else
1459       {
1460         if (!editSeq)
1461         {
1462           // dragging to the left
1463           if (fixedColumns && fixedRight != -1)
1464           {
1465             for (int j = lastres; j > startres; j--)
1466             {
1467               if (!Comparison.isGap(seq.getCharAt(startres)))
1468               {
1469                 endEditing();
1470                 break;
1471               }
1472               deleteChar(startres, new SequenceI[] { seq }, fixedRight);
1473             }
1474           }
1475           else
1476           {
1477             // could be a keyboard edit trying to delete none gaps
1478             int max = 0;
1479             for (int m = startres; m < lastres; m++)
1480             {
1481               if (!Comparison.isGap(seq.getCharAt(m)))
1482               {
1483                 break;
1484               }
1485               max++;
1486             }
1487
1488             if (max > 0)
1489             {
1490               appendEdit(Action.DELETE_GAP, new SequenceI[] { seq },
1491                       startres, max);
1492             }
1493           }
1494         }
1495         else
1496         {// insertGap==false AND editSeq==TRUE;
1497           if (fixedColumns && fixedRight != -1)
1498           {
1499             for (int j = lastres; j < startres; j++)
1500             {
1501               insertChar(j, new SequenceI[] { seq }, fixedRight);
1502             }
1503           }
1504           else
1505           {
1506             appendEdit(Action.INSERT_NUC, new SequenceI[] { seq }, lastres,
1507                     startres - lastres);
1508           }
1509         }
1510       }
1511     }
1512
1513     lastres = startres;
1514     seqCanvas.repaint();
1515   }
1516
1517   /**
1518    * Constructs an informative status bar message while dragging to insert or
1519    * delete gaps
1520    *
1521    * @param insert
1522    * @param seqName
1523    * @return
1524    */
1525   protected String getEditStatusMessage(boolean insert, String seqName)
1526   {
1527     /*
1528      * add any inserts, and subtract any deletes, so far
1529      */
1530     int count = 0;
1531     for (Edit cmd : editCommand.getEdits())
1532     {
1533       count += cmd.getAction() == Action.INSERT_GAP ? cmd.getNumber()
1534               : -cmd.getNumber();
1535     }
1536
1537     /*
1538      * add the current action
1539      */
1540     count += insert ? 1 : -1;
1541
1542     if (count == 0)
1543     {
1544       /*
1545        * inserts and deletes cancel out
1546        */
1547       return " ";
1548     }
1549     StringBuilder message = new StringBuilder(64);
1550     if (groupEditing)
1551     {
1552       message.append("Edit group:");
1553     }
1554     else
1555     {
1556       message.append("Edit sequence: ").append(seqName);
1557     }
1558
1559     message.append(count > 0 ? " insert " : " delete ");
1560     count = Math.abs(count);
1561     message.append(String.valueOf(count));
1562     message.append(count > 1 ? " gaps" : " gap");
1563     String msg = message.toString();
1564     return msg;
1565   }
1566
1567   void insertChar(int j, SequenceI[] seq, int fixedColumn)
1568   {
1569     int blankColumn = fixedColumn;
1570     for (int s = 0; s < seq.length; s++)
1571     {
1572       // Find the next gap before the end of the visible region boundary
1573       // If lastCol > j, theres a boundary after the gap insertion
1574
1575       for (blankColumn = fixedColumn; blankColumn > j; blankColumn--)
1576       {
1577         if (Comparison.isGap(seq[s].getCharAt(blankColumn)))
1578         {
1579           // Theres a space, so break and insert the gap
1580           break;
1581         }
1582       }
1583
1584       if (blankColumn <= j)
1585       {
1586         blankColumn = fixedColumn;
1587         endEditing();
1588         return;
1589       }
1590     }
1591
1592     appendEdit(Action.DELETE_GAP, seq, blankColumn, 1);
1593
1594     appendEdit(Action.INSERT_GAP, seq, j, 1);
1595
1596   }
1597
1598   /**
1599    * Helper method to add and perform one edit action.
1600    *
1601    * @param action
1602    * @param seq
1603    * @param pos
1604    * @param count
1605    */
1606   protected void appendEdit(Action action, SequenceI[] seq, int pos,
1607           int count)
1608   {
1609
1610     final Edit edit = new EditCommand().new Edit(action, seq, pos, count,
1611             av.getAlignment().getGapCharacter());
1612
1613     editCommand.appendEdit(edit, av.getAlignment(), true, null);
1614   }
1615
1616   void deleteChar(int j, SequenceI[] seq, int fixedColumn)
1617   {
1618
1619     appendEdit(Action.DELETE_GAP, seq, j, 1);
1620
1621     appendEdit(Action.INSERT_GAP, seq, fixedColumn, 1);
1622   }
1623
1624   /**
1625    * DOCUMENT ME!
1626    *
1627    * @param e
1628    *          DOCUMENT ME!
1629    */
1630   @Override
1631   public void mouseEntered(MouseEvent e)
1632   {
1633     if (oldSeq < 0)
1634     {
1635       oldSeq = 0;
1636     }
1637
1638     if ((scrollThread != null) && (scrollThread.isRunning()))
1639     {
1640       scrollThread.stopScrolling();
1641       scrollThread = null;
1642     }
1643   }
1644
1645   /**
1646    * DOCUMENT ME!
1647    *
1648    * @param e
1649    *          DOCUMENT ME!
1650    */
1651   @Override
1652   public void mouseExited(MouseEvent e)
1653   {
1654     if (av.getWrapAlignment())
1655     {
1656       return;
1657     }
1658
1659     if (mouseDragging && scrollThread == null)
1660     {
1661       scrollThread = new ScrollThread();
1662     }
1663   }
1664
1665   /**
1666    * Handler for double-click on a position with one or more sequence features.
1667    * Opens the Amend Features dialog to allow feature details to be amended, or
1668    * the feature deleted.
1669    */
1670   @Override
1671   public void mouseClicked(MouseEvent evt)
1672   {
1673     SequenceGroup sg = null;
1674     SequenceI sequence = av.getAlignment().getSequenceAt(findSeq(evt));
1675     if (evt.getClickCount() > 1)
1676     {
1677       sg = av.getSelectionGroup();
1678       if (sg != null && sg.getSize() == 1
1679               && sg.getEndRes() - sg.getStartRes() < 2)
1680       {
1681         av.setSelectionGroup(null);
1682       }
1683
1684       int column = findColumn(evt);
1685
1686       /*
1687        * find features at the position (if not gapped), or straddling
1688        * the position (if at a gap)
1689        */
1690       List<SequenceFeature> features = seqCanvas.getFeatureRenderer()
1691               .findFeaturesAtColumn(sequence, column + 1);
1692
1693       if (!features.isEmpty())
1694       {
1695         /*
1696          * highlight the first feature at the position on the alignment
1697          */
1698         SearchResultsI highlight = new SearchResults();
1699         highlight.addResult(sequence, features.get(0).getBegin(), features
1700                 .get(0).getEnd());
1701         seqCanvas.highlightSearchResults(highlight, false);
1702
1703         /*
1704          * open the Amend Features dialog; clear highlighting afterwards,
1705          * whether changes were made or not
1706          */
1707         List<SequenceI> seqs = Collections.singletonList(sequence);
1708         seqCanvas.getFeatureRenderer().amendFeatures(seqs, features, false,
1709                 ap);
1710         av.setSearchResults(null); // clear highlighting
1711         seqCanvas.repaint(); // draw new/amended features
1712       }
1713     }
1714   }
1715
1716   @Override
1717   public void mouseWheelMoved(MouseWheelEvent e)
1718   {
1719     e.consume();
1720     double wheelRotation = e.getPreciseWheelRotation();
1721     if (wheelRotation > 0)
1722     {
1723       if (e.isShiftDown())
1724       {
1725         av.getRanges().scrollRight(true);
1726
1727       }
1728       else
1729       {
1730         av.getRanges().scrollUp(false);
1731       }
1732     }
1733     else if (wheelRotation < 0)
1734     {
1735       if (e.isShiftDown())
1736       {
1737         av.getRanges().scrollRight(false);
1738       }
1739       else
1740       {
1741         av.getRanges().scrollUp(true);
1742       }
1743     }
1744
1745     /*
1746      * update status bar and tooltip for new position
1747      * (need to synthesize a mouse movement to refresh tooltip)
1748      */
1749     mouseMoved(e);
1750     ToolTipManager.sharedInstance().mouseMoved(e);
1751   }
1752
1753   /**
1754    * DOCUMENT ME!
1755    *
1756    * @param evt
1757    *          DOCUMENT ME!
1758    */
1759   public void doMousePressedDefineMode(MouseEvent evt)
1760   {
1761     final int res = findColumn(evt);
1762     final int seq = findSeq(evt);
1763     oldSeq = seq;
1764     updateOverviewAndStructs = false;
1765
1766     startWrapBlock = wrappedBlock;
1767
1768     if (av.getWrapAlignment() && seq > av.getAlignment().getHeight())
1769     {
1770       JvOptionPane.showInternalMessageDialog(Desktop.desktop,
1771               MessageManager.getString(
1772                       "label.cannot_edit_annotations_in_wrapped_view"),
1773               MessageManager.getString("label.wrapped_view_no_edit"),
1774               JvOptionPane.WARNING_MESSAGE);
1775       return;
1776     }
1777
1778     if (seq < 0 || res < 0)
1779     {
1780       return;
1781     }
1782
1783     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1784
1785     if ((sequence == null) || (res > sequence.getLength()))
1786     {
1787       return;
1788     }
1789
1790     stretchGroup = av.getSelectionGroup();
1791
1792     if (stretchGroup == null || !stretchGroup.contains(sequence, res))
1793     {
1794       stretchGroup = av.getAlignment().findGroup(sequence, res);
1795       if (stretchGroup != null)
1796       {
1797         // only update the current selection if the popup menu has a group to
1798         // focus on
1799         av.setSelectionGroup(stretchGroup);
1800       }
1801     }
1802
1803     if (evt.isPopupTrigger()) // Mac: mousePressed
1804     {
1805       showPopupMenu(evt);
1806       return;
1807     }
1808
1809     /*
1810      * defer right-mouse click handling to mouseReleased on Windows
1811      * (where isPopupTrigger() will answer true)
1812      * NB isRightMouseButton is also true for Cmd-click on Mac
1813      */
1814     if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
1815     {
1816       return;
1817     }
1818
1819     if (av.cursorMode)
1820     {
1821       seqCanvas.cursorX = findColumn(evt);
1822       seqCanvas.cursorY = findSeq(evt);
1823       seqCanvas.repaint();
1824       return;
1825     }
1826
1827     if (stretchGroup == null)
1828     {
1829       createStretchGroup(res, sequence);
1830     }
1831
1832     if (stretchGroup != null)
1833     {
1834       stretchGroup.addPropertyChangeListener(seqCanvas);
1835     }
1836
1837     seqCanvas.repaint();
1838   }
1839
1840   private void createStretchGroup(int res, SequenceI sequence)
1841   {
1842     // Only if left mouse button do we want to change group sizes
1843     // define a new group here
1844     SequenceGroup sg = new SequenceGroup();
1845     sg.setStartRes(res);
1846     sg.setEndRes(res);
1847     sg.addSequence(sequence, false);
1848     av.setSelectionGroup(sg);
1849     stretchGroup = sg;
1850
1851     if (av.getConservationSelected())
1852     {
1853       SliderPanel.setConservationSlider(ap, av.getResidueShading(),
1854               ap.getViewName());
1855     }
1856
1857     if (av.getAbovePIDThreshold())
1858     {
1859       SliderPanel.setPIDSliderSource(ap, av.getResidueShading(),
1860               ap.getViewName());
1861     }
1862     // TODO: stretchGroup will always be not null. Is this a merge error ?
1863     // or is there a threading issue here?
1864     if ((stretchGroup != null) && (stretchGroup.getEndRes() == res))
1865     {
1866       // Edit end res position of selected group
1867       changeEndRes = true;
1868     }
1869     else if ((stretchGroup != null) && (stretchGroup.getStartRes() == res))
1870     {
1871       // Edit end res position of selected group
1872       changeStartRes = true;
1873     }
1874     stretchGroup.getWidth();
1875
1876   }
1877
1878   /**
1879    * Build and show a pop-up menu at the right-click mouse position
1880    *
1881    * @param evt
1882    * @param res
1883    * @param sequences
1884    */
1885   void showPopupMenu(MouseEvent evt)
1886   {
1887     final int column = findColumn(evt);
1888     final int seq = findSeq(evt);
1889     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1890     List<SequenceFeature> features = ap.getFeatureRenderer()
1891             .findFeaturesAtColumn(sequence, column + 1);
1892
1893     PopupMenu pop = new PopupMenu(ap, null, features);
1894     pop.show(this, evt.getX(), evt.getY());
1895   }
1896
1897   /**
1898    * Update the display after mouse up on a selection or group
1899    *
1900    * @param evt
1901    *          mouse released event details
1902    * @param afterDrag
1903    *          true if this event is happening after a mouse drag (rather than a
1904    *          mouse down)
1905    */
1906   public void doMouseReleasedDefineMode(MouseEvent evt, boolean afterDrag)
1907   {
1908     if (stretchGroup == null)
1909     {
1910       return;
1911     }
1912
1913     stretchGroup.removePropertyChangeListener(seqCanvas);
1914
1915     // always do this - annotation has own state
1916     // but defer colourscheme update until hidden sequences are passed in
1917     boolean vischange = stretchGroup.recalcConservation(true);
1918     updateOverviewAndStructs |= vischange && av.isSelectionDefinedGroup()
1919             && afterDrag;
1920     if (stretchGroup.cs != null)
1921     {
1922       stretchGroup.cs.alignmentChanged(stretchGroup,
1923               av.getHiddenRepSequences());
1924
1925       ResidueShaderI groupColourScheme = stretchGroup
1926               .getGroupColourScheme();
1927       String name = stretchGroup.getName();
1928       if (stretchGroup.cs.conservationApplied())
1929       {
1930         SliderPanel.setConservationSlider(ap, groupColourScheme, name);
1931       }
1932       if (stretchGroup.cs.getThreshold() > 0)
1933       {
1934         SliderPanel.setPIDSliderSource(ap, groupColourScheme, name);
1935       }
1936     }
1937     PaintRefresher.Refresh(this, av.getSequenceSetId());
1938     // TODO: structure colours only need updating if stretchGroup used to or now
1939     // does contain sequences with structure views
1940     ap.paintAlignment(updateOverviewAndStructs, updateOverviewAndStructs);
1941     updateOverviewAndStructs = false;
1942     changeEndRes = false;
1943     changeStartRes = false;
1944     stretchGroup = null;
1945     av.sendSelection();
1946   }
1947
1948   /**
1949    * DOCUMENT ME!
1950    *
1951    * @param evt
1952    *          DOCUMENT ME!
1953    */
1954   public void doMouseDraggedDefineMode(MouseEvent evt)
1955   {
1956     int res = findColumn(evt);
1957     int y = findSeq(evt);
1958
1959     if (wrappedBlock != startWrapBlock)
1960     {
1961       return;
1962     }
1963
1964     if (stretchGroup == null)
1965     {
1966       return;
1967     }
1968
1969     if (res >= av.getAlignment().getWidth())
1970     {
1971       res = av.getAlignment().getWidth() - 1;
1972     }
1973
1974     if (stretchGroup.getEndRes() == res)
1975     {
1976       // Edit end res position of selected group
1977       changeEndRes = true;
1978     }
1979     else if (stretchGroup.getStartRes() == res)
1980     {
1981       // Edit start res position of selected group
1982       changeStartRes = true;
1983     }
1984
1985     if (res < av.getRanges().getStartRes())
1986     {
1987       res = av.getRanges().getStartRes();
1988     }
1989
1990     if (changeEndRes)
1991     {
1992       if (res > (stretchGroup.getStartRes() - 1))
1993       {
1994         stretchGroup.setEndRes(res);
1995         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
1996       }
1997     }
1998     else if (changeStartRes)
1999     {
2000       if (res < (stretchGroup.getEndRes() + 1))
2001       {
2002         stretchGroup.setStartRes(res);
2003         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
2004       }
2005     }
2006
2007     int dragDirection = 0;
2008
2009     if (y > oldSeq)
2010     {
2011       dragDirection = 1;
2012     }
2013     else if (y < oldSeq)
2014     {
2015       dragDirection = -1;
2016     }
2017
2018     while ((y != oldSeq) && (oldSeq > -1)
2019             && (y < av.getAlignment().getHeight()))
2020     {
2021       // This routine ensures we don't skip any sequences, as the
2022       // selection is quite slow.
2023       Sequence seq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
2024
2025       oldSeq += dragDirection;
2026
2027       if (oldSeq < 0)
2028       {
2029         break;
2030       }
2031
2032       Sequence nextSeq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
2033
2034       if (stretchGroup.getSequences(null).contains(nextSeq))
2035       {
2036         stretchGroup.deleteSequence(seq, false);
2037         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
2038       }
2039       else
2040       {
2041         if (seq != null)
2042         {
2043           stretchGroup.addSequence(seq, false);
2044         }
2045
2046         stretchGroup.addSequence(nextSeq, false);
2047         updateOverviewAndStructs |= av.isSelectionDefinedGroup();
2048       }
2049     }
2050
2051     if (oldSeq < 0)
2052     {
2053       oldSeq = -1;
2054     }
2055
2056     mouseDragging = true;
2057
2058     if ((scrollThread != null) && (scrollThread.isRunning()))
2059     {
2060       scrollThread.setEvent(evt);
2061     }
2062
2063     /*
2064      * construct a status message showing the range of the selection
2065      */
2066     StringBuilder status = new StringBuilder(64);
2067     List<SequenceI> seqs = stretchGroup.getSequences();
2068     String name = seqs.get(0).getName();
2069     if (name.length() > 20)
2070     {
2071       name = name.substring(0, 20);
2072     }
2073     status.append(name).append(" - ");
2074     name = seqs.get(seqs.size() - 1).getName();
2075     if (name.length() > 20)
2076     {
2077       name = name.substring(0, 20);
2078     }
2079     status.append(name).append(" ");
2080     int startRes = stretchGroup.getStartRes();
2081     status.append(" cols ").append(String.valueOf(startRes + 1))
2082             .append("-");
2083     int endRes = stretchGroup.getEndRes();
2084     status.append(String.valueOf(endRes + 1));
2085     status.append(" (").append(String.valueOf(seqs.size())).append(" x ")
2086             .append(String.valueOf(endRes - startRes + 1)).append(")");
2087     ap.alignFrame.setStatus(status.toString());
2088   }
2089
2090   void scrollCanvas(MouseEvent evt)
2091   {
2092     if (evt == null)
2093     {
2094       if ((scrollThread != null) && (scrollThread.isRunning()))
2095       {
2096         scrollThread.stopScrolling();
2097         scrollThread = null;
2098       }
2099       mouseDragging = false;
2100     }
2101     else
2102     {
2103       if (scrollThread == null)
2104       {
2105         scrollThread = new ScrollThread();
2106       }
2107
2108       mouseDragging = true;
2109       scrollThread.setEvent(evt);
2110     }
2111
2112   }
2113
2114   // this class allows scrolling off the bottom of the visible alignment
2115   class ScrollThread extends Thread
2116   {
2117     MouseEvent evt;
2118
2119     private volatile boolean threadRunning = true;
2120
2121     public ScrollThread()
2122     {
2123       start();
2124     }
2125
2126     public void setEvent(MouseEvent e)
2127     {
2128       evt = e;
2129     }
2130
2131     public void stopScrolling()
2132     {
2133       threadRunning = false;
2134     }
2135
2136     public boolean isRunning()
2137     {
2138       return threadRunning;
2139     }
2140
2141     @Override
2142     public void run()
2143     {
2144       while (threadRunning)
2145       {
2146         if (evt != null)
2147         {
2148           if (mouseDragging && (evt.getY() < 0)
2149                   && (av.getRanges().getStartSeq() > 0))
2150           {
2151             av.getRanges().scrollUp(true);
2152           }
2153
2154           if (mouseDragging && (evt.getY() >= getHeight()) && (av
2155                   .getAlignment().getHeight() > av.getRanges().getEndSeq()))
2156           {
2157             av.getRanges().scrollUp(false);
2158           }
2159
2160           if (mouseDragging && (evt.getX() < 0))
2161           {
2162             av.getRanges().scrollRight(false);
2163           }
2164           else if (mouseDragging && (evt.getX() >= getWidth()))
2165           {
2166             av.getRanges().scrollRight(true);
2167           }
2168         }
2169
2170         try
2171         {
2172           Thread.sleep(20);
2173         } catch (Exception ex)
2174         {
2175         }
2176       }
2177     }
2178   }
2179
2180   /**
2181    * modify current selection according to a received message.
2182    */
2183   @Override
2184   public void selection(SequenceGroup seqsel, ColumnSelection colsel,
2185           HiddenColumns hidden, SelectionSource source)
2186   {
2187     // TODO: fix this hack - source of messages is align viewport, but SeqPanel
2188     // handles selection messages...
2189     // TODO: extend config options to allow user to control if selections may be
2190     // shared between viewports.
2191     boolean iSentTheSelection = (av == source
2192             || (source instanceof AlignViewport
2193                     && ((AlignmentViewport) source).getSequenceSetId()
2194                             .equals(av.getSequenceSetId())));
2195
2196     if (iSentTheSelection)
2197     {
2198       // respond to our own event by updating dependent dialogs
2199       if (ap.getCalculationDialog() != null)
2200       {
2201         ap.getCalculationDialog().validateCalcTypes();
2202       }
2203
2204       return;
2205     }
2206
2207     // process further ?
2208     if (!av.followSelection)
2209     {
2210       return;
2211     }
2212
2213     /*
2214      * Ignore the selection if there is one of our own pending.
2215      */
2216     if (av.isSelectionGroupChanged(false) || av.isColSelChanged(false))
2217     {
2218       return;
2219     }
2220
2221     /*
2222      * Check for selection in a view of which this one is a dna/protein
2223      * complement.
2224      */
2225     if (selectionFromTranslation(seqsel, colsel, hidden, source))
2226     {
2227       return;
2228     }
2229
2230     // do we want to thread this ? (contention with seqsel and colsel locks, I
2231     // suspect)
2232     /*
2233      * only copy colsel if there is a real intersection between
2234      * sequence selection and this panel's alignment
2235      */
2236     boolean repaint = false;
2237     boolean copycolsel = false;
2238
2239     SequenceGroup sgroup = null;
2240     if (seqsel != null && seqsel.getSize() > 0)
2241     {
2242       if (av.getAlignment() == null)
2243       {
2244         Cache.log.warn("alignviewport av SeqSetId=" + av.getSequenceSetId()
2245                 + " ViewId=" + av.getViewId()
2246                 + " 's alignment is NULL! returning immediately.");
2247         return;
2248       }
2249       sgroup = seqsel.intersect(av.getAlignment(),
2250               (av.hasHiddenRows()) ? av.getHiddenRepSequences() : null);
2251       if ((sgroup != null && sgroup.getSize() > 0))
2252       {
2253         copycolsel = true;
2254       }
2255     }
2256     if (sgroup != null && sgroup.getSize() > 0)
2257     {
2258       av.setSelectionGroup(sgroup);
2259     }
2260     else
2261     {
2262       av.setSelectionGroup(null);
2263     }
2264     av.isSelectionGroupChanged(true);
2265     repaint = true;
2266
2267     if (copycolsel)
2268     {
2269       // the current selection is unset or from a previous message
2270       // so import the new colsel.
2271       if (colsel == null || colsel.isEmpty())
2272       {
2273         if (av.getColumnSelection() != null)
2274         {
2275           av.getColumnSelection().clear();
2276           repaint = true;
2277         }
2278       }
2279       else
2280       {
2281         // TODO: shift colSel according to the intersecting sequences
2282         if (av.getColumnSelection() == null)
2283         {
2284           av.setColumnSelection(new ColumnSelection(colsel));
2285         }
2286         else
2287         {
2288           av.getColumnSelection().setElementsFrom(colsel,
2289                   av.getAlignment().getHiddenColumns());
2290         }
2291       }
2292       av.isColSelChanged(true);
2293       repaint = true;
2294     }
2295
2296     if (copycolsel && av.hasHiddenColumns()
2297             && (av.getAlignment().getHiddenColumns() == null))
2298     {
2299       System.err.println("Bad things");
2300     }
2301     if (repaint) // always true!
2302     {
2303       // probably finessing with multiple redraws here
2304       PaintRefresher.Refresh(this, av.getSequenceSetId());
2305       // ap.paintAlignment(false);
2306     }
2307
2308     // lastly, update dependent dialogs
2309     if (ap.getCalculationDialog() != null)
2310     {
2311       ap.getCalculationDialog().validateCalcTypes();
2312     }
2313
2314   }
2315
2316   /**
2317    * If this panel is a cdna/protein translation view of the selection source,
2318    * tries to map the source selection to a local one, and returns true. Else
2319    * returns false.
2320    *
2321    * @param seqsel
2322    * @param colsel
2323    * @param source
2324    */
2325   protected boolean selectionFromTranslation(SequenceGroup seqsel,
2326           ColumnSelection colsel, HiddenColumns hidden,
2327           SelectionSource source)
2328   {
2329     if (!(source instanceof AlignViewportI))
2330     {
2331       return false;
2332     }
2333     final AlignViewportI sourceAv = (AlignViewportI) source;
2334     if (sourceAv.getCodingComplement() != av
2335             && av.getCodingComplement() != sourceAv)
2336     {
2337       return false;
2338     }
2339
2340     /*
2341      * Map sequence selection
2342      */
2343     SequenceGroup sg = MappingUtils.mapSequenceGroup(seqsel, sourceAv, av);
2344     av.setSelectionGroup(sg);
2345     av.isSelectionGroupChanged(true);
2346
2347     /*
2348      * Map column selection
2349      */
2350     // ColumnSelection cs = MappingUtils.mapColumnSelection(colsel, sourceAv,
2351     // av);
2352     ColumnSelection cs = new ColumnSelection();
2353     HiddenColumns hs = new HiddenColumns();
2354     MappingUtils.mapColumnSelection(colsel, hidden, sourceAv, av, cs, hs);
2355     av.setColumnSelection(cs);
2356     av.getAlignment().setHiddenColumns(hs);
2357
2358     // lastly, update any dependent dialogs
2359     if (ap.getCalculationDialog() != null)
2360     {
2361       ap.getCalculationDialog().validateCalcTypes();
2362     }
2363
2364     PaintRefresher.Refresh(this, av.getSequenceSetId());
2365
2366     return true;
2367   }
2368
2369   /**
2370    *
2371    * @return null or last search results handled by this panel
2372    */
2373   public SearchResultsI getLastSearchResults()
2374   {
2375     return lastSearchResults;
2376   }
2377 }