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