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