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    * DOCUMENT ME!
 723    *
 724    * @param evt
 725    *          DOCUMENT ME!
 726    */
 727   @Override
 728   public void mouseMoved(MouseEvent evt)
 729   {
 730     if (editingSeqs)
 731     {
 732       // This is because MacOSX creates a mouseMoved
 733       // If control is down, other platforms will not.
 734       mouseDragged(evt);
 735     }
 736
 737     final int column = findColumn(evt);
 738     int seq = findSeq(evt);
 739     if (column < 0 || seq < 0 || seq >= av.getAlignment().getHeight())
 740     {
 741       lastMouseSeq = -1;
 742       return;
 743     }
 744     if (column == lastMouseColumn && seq == lastMouseSeq)
 745     {
 746       /*
 747        * just a pixel move without change of residue
 748        */
 749       return;
 750     }
 751     lastMouseColumn = column;
 752     lastMouseSeq = seq;
 753
 754     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
 755
 756     if (column >= sequence.getLength())
 757     {
 758       return;
 759     }
 760
 761     /*
 762      * set status bar message, returning residue position in sequence
 763      */
 764     boolean isGapped = Comparison.isGap(sequence.getCharAt(column));
 765     final int pos = setStatusMessage(sequence, column, seq);
 766     if (ssm != null && !isGapped)
 767     {
 768       mouseOverSequence(sequence, column, pos);
 769     }
 770
 771     tooltipText.setLength(6); // Cuts the buffer back to <html>
 772
 773     SequenceGroup[] groups = av.getAlignment().findAllGroups(sequence);
 774     if (groups != null)
 775     {
 776       for (int g = 0; g < groups.length; g++)
 777       {
 778         if (groups[g].getStartRes() <= column
 779                 && groups[g].getEndRes() >= column)
 780         {
 781           if (!groups[g].getName().startsWith("JTreeGroup")
 782                   && !groups[g].getName().startsWith("JGroup"))
 783           {
 784             tooltipText.append(groups[g].getName());
 785           }
 786
 787           if (groups[g].getDescription() != null)
 788           {
 789             tooltipText.append(": " + groups[g].getDescription());
 790           }
 791         }
 792       }
 793     }
 794
 795     /*
 796      * add any features at the position to the tooltip; if over a gap, only
 797      * add features that straddle the gap (pos may be the residue before or
 798      * after the gap)
 799      */
 800     if (av.isShowSequenceFeatures())
 801     {
 802       List<SequenceFeature> features = ap.getFeatureRenderer()
 803               .findFeaturesAtColumn(sequence, column + 1);
 804       seqARep.appendFeatures(tooltipText, pos, features,
 805               this.ap.getSeqPanel().seqCanvas.fr.getMinMax());
 806     }
 807     if (tooltipText.length() == 6) // <html>
 808     {
 809       setToolTipText(null);
 810       lastTooltip = null;
 811     }
 812     else
 813     {
 814       String textString = tooltipText.toString();
 815       if (lastTooltip == null || !lastTooltip.equals(textString))
 816       {
 817         String formattedTooltipText = JvSwingUtils.wrapTooltip(true,
 818                 textString);
 819         setToolTipText(formattedTooltipText);
 820         lastTooltip = textString;
 821       }
 822     }
 823   }
 824
 825   private Point lastp = null;
 826
 827   /*
 828    * (non-Javadoc)
 829    *
 830    * @see javax.swing.JComponent#getToolTipLocation(java.awt.event.MouseEvent)
 831    */
 832   @Override
 833   public Point getToolTipLocation(MouseEvent event)
 834   {
 835     int x = event.getX(), w = getWidth();
 836     int wdth = (w - x < 200) ? -(w / 2) : 5; // switch sides when tooltip is too
 837     // close to edge
 838     Point p = lastp;
 839     if (!event.isShiftDown() || p == null)
 840     {
 841       p = (tooltipText != null && tooltipText.length() > 6)
 842               ? new Point(event.getX() + wdth, event.getY() - 20)
 843               : null;
 844     }
 845     /*
 846      * TODO: try to modify position region is not obcured by tooltip
 847      */
 848     return lastp = p;
 849   }
 850
 851   String lastTooltip;
 852
 853   /**
 854    * set when the current UI interaction has resulted in a change that requires
 855    * overview shading to be recalculated. this could be changed to something
 856    * more expressive that indicates what actually has changed, so selective
 857    * redraws can be applied
 858    */
 859   private boolean needOverviewUpdate = 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);
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     needOverviewUpdate = 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> allFeatures = ap.getFeatureRenderer()
1786             .findFeaturesAtColumn(sequence, column + 1);
1787     List<String> links = new ArrayList<>();
1788     for (SequenceFeature sf : allFeatures)
1789     {
1790       if (sf.links != null)
1791       {
1792         for (String link : sf.links)
1793         {
1794           links.add(link);
1795         }
1796       }
1797     }
1798
1799     PopupMenu pop = new PopupMenu(ap, null, links);
1800     pop.show(this, evt.getX(), evt.getY());
1801   }
1802
1803   /**
1804    * Update the display after mouse up on a selection or group
1805    *
1806    * @param evt
1807    *          mouse released event details
1808    * @param afterDrag
1809    *          true if this event is happening after a mouse drag (rather than a
1810    *          mouse down)
1811    */
1812   public void doMouseReleasedDefineMode(MouseEvent evt, boolean afterDrag)
1813   {
1814     if (stretchGroup == null)
1815     {
1816       return;
1817     }
1818
1819     stretchGroup.removePropertyChangeListener(seqCanvas);
1820
1821     // always do this - annotation has own state
1822     // but defer colourscheme update until hidden sequences are passed in
1823     boolean vischange = stretchGroup.recalcConservation(true);
1824     needOverviewUpdate |= vischange && av.isSelectionDefinedGroup()
1825             && afterDrag;
1826     if (stretchGroup.cs != null)
1827     {
1828       stretchGroup.cs.alignmentChanged(stretchGroup,
1829               av.getHiddenRepSequences());
1830
1831       ResidueShaderI groupColourScheme = stretchGroup
1832               .getGroupColourScheme();
1833       String name = stretchGroup.getName();
1834       if (stretchGroup.cs.conservationApplied())
1835       {
1836         SliderPanel.setConservationSlider(ap, groupColourScheme, name);
1837       }
1838       if (stretchGroup.cs.getThreshold() > 0)
1839       {
1840         SliderPanel.setPIDSliderSource(ap, groupColourScheme, name);
1841       }
1842     }
1843     PaintRefresher.Refresh(this, av.getSequenceSetId());
1844     ap.paintAlignment(needOverviewUpdate);
1845     needOverviewUpdate = false;
1846     changeEndRes = false;
1847     changeStartRes = false;
1848     stretchGroup = null;
1849     av.sendSelection();
1850   }
1851
1852   /**
1853    * DOCUMENT ME!
1854    *
1855    * @param evt
1856    *          DOCUMENT ME!
1857    */
1858   public void doMouseDraggedDefineMode(MouseEvent evt)
1859   {
1860     int res = findColumn(evt);
1861     int y = findSeq(evt);
1862
1863     if (wrappedBlock != startWrapBlock)
1864     {
1865       return;
1866     }
1867
1868     if (stretchGroup == null)
1869     {
1870       return;
1871     }
1872
1873     if (res >= av.getAlignment().getWidth())
1874     {
1875       res = av.getAlignment().getWidth() - 1;
1876     }
1877
1878     if (stretchGroup.getEndRes() == res)
1879     {
1880       // Edit end res position of selected group
1881       changeEndRes = true;
1882     }
1883     else if (stretchGroup.getStartRes() == res)
1884     {
1885       // Edit start res position of selected group
1886       changeStartRes = true;
1887     }
1888
1889     if (res < av.getRanges().getStartRes())
1890     {
1891       res = av.getRanges().getStartRes();
1892     }
1893
1894     if (changeEndRes)
1895     {
1896       if (res > (stretchGroup.getStartRes() - 1))
1897       {
1898         stretchGroup.setEndRes(res);
1899         needOverviewUpdate |= av.isSelectionDefinedGroup();
1900       }
1901     }
1902     else if (changeStartRes)
1903     {
1904       if (res < (stretchGroup.getEndRes() + 1))
1905       {
1906         stretchGroup.setStartRes(res);
1907         needOverviewUpdate |= av.isSelectionDefinedGroup();
1908       }
1909     }
1910
1911     int dragDirection = 0;
1912
1913     if (y > oldSeq)
1914     {
1915       dragDirection = 1;
1916     }
1917     else if (y < oldSeq)
1918     {
1919       dragDirection = -1;
1920     }
1921
1922     while ((y != oldSeq) && (oldSeq > -1)
1923             && (y < av.getAlignment().getHeight()))
1924     {
1925       // This routine ensures we don't skip any sequences, as the
1926       // selection is quite slow.
1927       Sequence seq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1928
1929       oldSeq += dragDirection;
1930
1931       if (oldSeq < 0)
1932       {
1933         break;
1934       }
1935
1936       Sequence nextSeq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1937
1938       if (stretchGroup.getSequences(null).contains(nextSeq))
1939       {
1940         stretchGroup.deleteSequence(seq, false);
1941         needOverviewUpdate |= av.isSelectionDefinedGroup();
1942       }
1943       else
1944       {
1945         if (seq != null)
1946         {
1947           stretchGroup.addSequence(seq, false);
1948         }
1949
1950         stretchGroup.addSequence(nextSeq, false);
1951         needOverviewUpdate |= av.isSelectionDefinedGroup();
1952       }
1953     }
1954
1955     if (oldSeq < 0)
1956     {
1957       oldSeq = -1;
1958     }
1959
1960     mouseDragging = true;
1961
1962     if ((scrollThread != null) && (scrollThread.isRunning()))
1963     {
1964       scrollThread.setEvent(evt);
1965     }
1966   }
1967
1968   void scrollCanvas(MouseEvent evt)
1969   {
1970     if (evt == null)
1971     {
1972       if ((scrollThread != null) && (scrollThread.isRunning()))
1973       {
1974         scrollThread.stopScrolling();
1975         scrollThread = null;
1976       }
1977       mouseDragging = false;
1978     }
1979     else
1980     {
1981       if (scrollThread == null)
1982       {
1983         scrollThread = new ScrollThread();
1984       }
1985
1986       mouseDragging = true;
1987       scrollThread.setEvent(evt);
1988     }
1989
1990   }
1991
1992   // this class allows scrolling off the bottom of the visible alignment
1993   class ScrollThread extends Thread
1994   {
1995     MouseEvent evt;
1996
1997     private volatile boolean threadRunning = true;
1998
1999     public ScrollThread()
2000     {
2001       start();
2002     }
2003
2004     public void setEvent(MouseEvent e)
2005     {
2006       evt = e;
2007     }
2008
2009     public void stopScrolling()
2010     {
2011       threadRunning = false;
2012     }
2013
2014     public boolean isRunning()
2015     {
2016       return threadRunning;
2017     }
2018
2019     @Override
2020     public void run()
2021     {
2022       while (threadRunning)
2023       {
2024         if (evt != null)
2025         {
2026           if (mouseDragging && (evt.getY() < 0)
2027                   && (av.getRanges().getStartSeq() > 0))
2028           {
2029             av.getRanges().scrollUp(true);
2030           }
2031
2032           if (mouseDragging && (evt.getY() >= getHeight()) && (av
2033                   .getAlignment().getHeight() > av.getRanges().getEndSeq()))
2034           {
2035             av.getRanges().scrollUp(false);
2036           }
2037
2038           if (mouseDragging && (evt.getX() < 0))
2039           {
2040             av.getRanges().scrollRight(false);
2041           }
2042           else if (mouseDragging && (evt.getX() >= getWidth()))
2043           {
2044             av.getRanges().scrollRight(true);
2045           }
2046         }
2047
2048         try
2049         {
2050           Thread.sleep(20);
2051         } catch (Exception ex)
2052         {
2053         }
2054       }
2055     }
2056   }
2057
2058   /**
2059    * modify current selection according to a received message.
2060    */
2061   @Override
2062   public void selection(SequenceGroup seqsel, ColumnSelection colsel,
2063           HiddenColumns hidden, SelectionSource source)
2064   {
2065     // TODO: fix this hack - source of messages is align viewport, but SeqPanel
2066     // handles selection messages...
2067     // TODO: extend config options to allow user to control if selections may be
2068     // shared between viewports.
2069     boolean iSentTheSelection = (av == source
2070             || (source instanceof AlignViewport
2071                     && ((AlignmentViewport) source).getSequenceSetId()
2072                             .equals(av.getSequenceSetId())));
2073
2074     if (iSentTheSelection)
2075     {
2076       // respond to our own event by updating dependent dialogs
2077       if (ap.getCalculationDialog() != null)
2078       {
2079         ap.getCalculationDialog().validateCalcTypes();
2080       }
2081
2082       return;
2083     }
2084
2085     // process further ?
2086     if (!av.followSelection)
2087     {
2088       return;
2089     }
2090
2091     /*
2092      * Ignore the selection if there is one of our own pending.
2093      */
2094     if (av.isSelectionGroupChanged(false) || av.isColSelChanged(false))
2095     {
2096       return;
2097     }
2098
2099     /*
2100      * Check for selection in a view of which this one is a dna/protein
2101      * complement.
2102      */
2103     if (selectionFromTranslation(seqsel, colsel, hidden, source))
2104     {
2105       return;
2106     }
2107
2108     // do we want to thread this ? (contention with seqsel and colsel locks, I
2109     // suspect)
2110     /*
2111      * only copy colsel if there is a real intersection between
2112      * sequence selection and this panel's alignment
2113      */
2114     boolean repaint = false;
2115     boolean copycolsel = false;
2116
2117     SequenceGroup sgroup = null;
2118     if (seqsel != null && seqsel.getSize() > 0)
2119     {
2120       if (av.getAlignment() == null)
2121       {
2122         Cache.log.warn("alignviewport av SeqSetId=" + av.getSequenceSetId()
2123                 + " ViewId=" + av.getViewId()
2124                 + " 's alignment is NULL! returning immediately.");
2125         return;
2126       }
2127       sgroup = seqsel.intersect(av.getAlignment(),
2128               (av.hasHiddenRows()) ? av.getHiddenRepSequences() : null);
2129       if ((sgroup != null && sgroup.getSize() > 0))
2130       {
2131         copycolsel = true;
2132       }
2133     }
2134     if (sgroup != null && sgroup.getSize() > 0)
2135     {
2136       av.setSelectionGroup(sgroup);
2137     }
2138     else
2139     {
2140       av.setSelectionGroup(null);
2141     }
2142     av.isSelectionGroupChanged(true);
2143     repaint = true;
2144
2145     if (copycolsel)
2146     {
2147       // the current selection is unset or from a previous message
2148       // so import the new colsel.
2149       if (colsel == null || colsel.isEmpty())
2150       {
2151         if (av.getColumnSelection() != null)
2152         {
2153           av.getColumnSelection().clear();
2154           repaint = true;
2155         }
2156       }
2157       else
2158       {
2159         // TODO: shift colSel according to the intersecting sequences
2160         if (av.getColumnSelection() == null)
2161         {
2162           av.setColumnSelection(new ColumnSelection(colsel));
2163         }
2164         else
2165         {
2166           av.getColumnSelection().setElementsFrom(colsel,
2167                   av.getAlignment().getHiddenColumns());
2168         }
2169       }
2170       av.isColSelChanged(true);
2171       repaint = true;
2172     }
2173
2174     if (copycolsel && av.hasHiddenColumns()
2175             && (av.getAlignment().getHiddenColumns() == null))
2176     {
2177       System.err.println("Bad things");
2178     }
2179     if (repaint) // always true!
2180     {
2181       // probably finessing with multiple redraws here
2182       PaintRefresher.Refresh(this, av.getSequenceSetId());
2183       // ap.paintAlignment(false);
2184     }
2185
2186     // lastly, update dependent dialogs
2187     if (ap.getCalculationDialog() != null)
2188     {
2189       ap.getCalculationDialog().validateCalcTypes();
2190     }
2191
2192   }
2193
2194   /**
2195    * If this panel is a cdna/protein translation view of the selection source,
2196    * tries to map the source selection to a local one, and returns true. Else
2197    * returns false.
2198    *
2199    * @param seqsel
2200    * @param colsel
2201    * @param source
2202    */
2203   protected boolean selectionFromTranslation(SequenceGroup seqsel,
2204           ColumnSelection colsel, HiddenColumns hidden,
2205           SelectionSource source)
2206   {
2207     if (!(source instanceof AlignViewportI))
2208     {
2209       return false;
2210     }
2211     final AlignViewportI sourceAv = (AlignViewportI) source;
2212     if (sourceAv.getCodingComplement() != av
2213             && av.getCodingComplement() != sourceAv)
2214     {
2215       return false;
2216     }
2217
2218     /*
2219      * Map sequence selection
2220      */
2221     SequenceGroup sg = MappingUtils.mapSequenceGroup(seqsel, sourceAv, av);
2222     av.setSelectionGroup(sg);
2223     av.isSelectionGroupChanged(true);
2224
2225     /*
2226      * Map column selection
2227      */
2228     // ColumnSelection cs = MappingUtils.mapColumnSelection(colsel, sourceAv,
2229     // av);
2230     ColumnSelection cs = new ColumnSelection();
2231     HiddenColumns hs = new HiddenColumns();
2232     MappingUtils.mapColumnSelection(colsel, hidden, sourceAv, av, cs, hs);
2233     av.setColumnSelection(cs);
2234     av.getAlignment().setHiddenColumns(hs);
2235
2236     // lastly, update any dependent dialogs
2237     if (ap.getCalculationDialog() != null)
2238     {
2239       ap.getCalculationDialog().validateCalcTypes();
2240     }
2241
2242     PaintRefresher.Refresh(this, av.getSequenceSetId());
2243
2244     return true;
2245   }
2246 }