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