src/jalview/gui/SeqPanel.java

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