src/jalview/gui/SeqPanel.java

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