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