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