src/jalview/gui/SeqPanel.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.api.AlignViewportI;
  24 import jalview.bin.Cache;
  25 import jalview.commands.EditCommand;
  26 import jalview.commands.EditCommand.Action;
  27 import jalview.commands.EditCommand.Edit;
  28 import jalview.datamodel.AlignmentI;
  29 import jalview.datamodel.ColumnSelection;
  30 import jalview.datamodel.HiddenColumns;
  31 import jalview.datamodel.SearchResultMatchI;
  32 import jalview.datamodel.SearchResults;
  33 import jalview.datamodel.SearchResultsI;
  34 import jalview.datamodel.Sequence;
  35 import jalview.datamodel.SequenceFeature;
  36 import jalview.datamodel.SequenceGroup;
  37 import jalview.datamodel.SequenceI;
  38 import jalview.io.SequenceAnnotationReport;
  39 import jalview.renderer.ResidueShaderI;
  40 import jalview.schemes.ResidueProperties;
  41 import jalview.structure.SelectionListener;
  42 import jalview.structure.SelectionSource;
  43 import jalview.structure.SequenceListener;
  44 import jalview.structure.StructureSelectionManager;
  45 import jalview.structure.VamsasSource;
  46 import jalview.util.Comparison;
  47 import jalview.util.MappingUtils;
  48 import jalview.util.MessageManager;
  49 import jalview.util.Platform;
  50 import jalview.viewmodel.AlignmentViewport;
  51
  52 import java.awt.BorderLayout;
  53 import java.awt.Color;
  54 import java.awt.Font;
  55 import java.awt.FontMetrics;
  56 import java.awt.Point;
  57 import java.awt.event.MouseEvent;
  58 import java.awt.event.MouseListener;
  59 import java.awt.event.MouseMotionListener;
  60 import java.awt.event.MouseWheelEvent;
  61 import java.awt.event.MouseWheelListener;
  62 import java.util.ArrayList;
  63 import java.util.Collections;
  64 import java.util.List;
  65
  66 import javax.swing.JPanel;
  67 import javax.swing.SwingUtilities;
  68 import javax.swing.ToolTipManager;
  69
  70 /**
  71  * DOCUMENT ME!
  72  *
  73  * @author $author$
  74  * @version $Revision: 1.130 $
  75  */
  76 public class SeqPanel extends JPanel implements MouseListener,
  77         MouseMotionListener, MouseWheelListener, SequenceListener,
  78         SelectionListener
  79
  80 {
  81   /** DOCUMENT ME!! */
  82   public SeqCanvas seqCanvas;
  83
  84   /** DOCUMENT ME!! */
  85   public AlignmentPanel ap;
  86
  87   /*
  88    * last column position for mouseMoved event
  89    */
  90   private int lastMouseColumn;
  91
  92   /*
  93    * last sequence offset for mouseMoved event
  94    */
  95   private int lastMouseSeq;
  96
  97   protected int lastres;
  98
  99   protected int startseq;
 100
 101   protected AlignViewport av;
 102
 103   ScrollThread scrollThread = null;
 104
 105   boolean mouseDragging = false;
 106
 107   boolean editingSeqs = false;
 108
 109   boolean groupEditing = false;
 110
 111   // ////////////////////////////////////////
 112   // ///Everything below this is for defining the boundary of the rubberband
 113   // ////////////////////////////////////////
 114   int oldSeq = -1;
 115
 116   boolean changeEndSeq = false;
 117
 118   boolean changeStartSeq = false;
 119
 120   boolean changeEndRes = false;
 121
 122   boolean changeStartRes = false;
 123
 124   SequenceGroup stretchGroup = null;
 125
 126   boolean remove = false;
 127
 128   Point lastMousePress;
 129
 130   boolean mouseWheelPressed = false;
 131
 132   StringBuffer keyboardNo1;
 133
 134   StringBuffer keyboardNo2;
 135
 136   java.net.URL linkImageURL;
 137
 138   private final SequenceAnnotationReport seqARep;
 139
 140   StringBuilder tooltipText = new StringBuilder();
 141
 142   String tmpString;
 143
 144   EditCommand editCommand;
 145
 146   StructureSelectionManager ssm;
 147
 148   SearchResultsI lastSearchResults;
 149
 150   /**
 151    * Creates a new SeqPanel object.
 152    *
 153    * @param avp
 154    *          DOCUMENT ME!
 155    * @param p
 156    *          DOCUMENT ME!
 157    */
 158   public SeqPanel(AlignViewport av, AlignmentPanel ap)
 159   {
 160     linkImageURL = getClass().getResource("/images/link.gif");
 161     seqARep = new SequenceAnnotationReport(linkImageURL.toString());
 162     ToolTipManager.sharedInstance().registerComponent(this);
 163     ToolTipManager.sharedInstance().setInitialDelay(0);
 164     ToolTipManager.sharedInstance().setDismissDelay(10000);
 165     this.av = av;
 166     setBackground(Color.white);
 167
 168     seqCanvas = new SeqCanvas(ap);
 169     setLayout(new BorderLayout());
 170     add(seqCanvas, BorderLayout.CENTER);
 171
 172     this.ap = ap;
 173
 174     if (!av.isDataset())
 175     {
 176       addMouseMotionListener(this);
 177       addMouseListener(this);
 178       addMouseWheelListener(this);
 179       ssm = av.getStructureSelectionManager();
 180       ssm.addStructureViewerListener(this);
 181       ssm.addSelectionListener(this);
 182     }
 183
 184     lastMouseColumn = -1;
 185     lastMouseSeq = -1;
 186   }
 187
 188   int startWrapBlock = -1;
 189
 190   int wrappedBlock = -1;
 191
 192   /**
 193    * Returns the aligned sequence position (base 0) at the mouse position, or
 194    * the closest visible one
 195    *
 196    * @param evt
 197    * @return
 198    */
 199   int findColumn(MouseEvent evt)
 200   {
 201     int res = 0;
 202     int x = evt.getX();
 203
 204     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 -= hgap;
 219       x = Math.max(0, x - seqCanvas.labelWidthWest);
 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(), av.getAlignment()
 279               .getHeight() - 1);
 280     }
 281     else
 282     {
 283       seq = Math.min((y / av.getCharHeight())
 284               + av.getRanges().getStartSeq(),
 285               av
 286               .getAlignment().getHeight() - 1);
 287     }
 288
 289     return seq;
 290   }
 291
 292   /**
 293    * When all of a sequence of edits are complete, put the resulting edit list
 294    * on the history stack (undo list), and reset flags for editing in progress.
 295    */
 296   void endEditing()
 297   {
 298     try
 299     {
 300       if (editCommand != null && editCommand.getSize() > 0)
 301       {
 302         ap.alignFrame.addHistoryItem(editCommand);
 303         av.firePropertyChange("alignment", null, av.getAlignment()
 304                 .getSequences());
 305       }
 306     } finally
 307     {
 308       /*
 309        * Tidy up come what may...
 310        */
 311       startseq = -1;
 312       lastres = -1;
 313       editingSeqs = false;
 314       groupEditing = false;
 315       keyboardNo1 = null;
 316       keyboardNo2 = null;
 317       editCommand = null;
 318     }
 319   }
 320
 321   void setCursorRow()
 322   {
 323     seqCanvas.cursorY = getKeyboardNo1() - 1;
 324     scrollToVisible();
 325   }
 326
 327   void setCursorColumn()
 328   {
 329     seqCanvas.cursorX = getKeyboardNo1() - 1;
 330     scrollToVisible();
 331   }
 332
 333   void setCursorRowAndColumn()
 334   {
 335     if (keyboardNo2 == null)
 336     {
 337       keyboardNo2 = new StringBuffer();
 338     }
 339     else
 340     {
 341       seqCanvas.cursorX = getKeyboardNo1() - 1;
 342       seqCanvas.cursorY = getKeyboardNo2() - 1;
 343       scrollToVisible();
 344     }
 345   }
 346
 347   void setCursorPosition()
 348   {
 349     SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
 350
 351     seqCanvas.cursorX = sequence.findIndex(getKeyboardNo1()) - 1;
 352     scrollToVisible();
 353   }
 354
 355   void moveCursor(int dx, int dy)
 356   {
 357     seqCanvas.cursorX += dx;
 358     seqCanvas.cursorY += dy;
 359
 360     HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 361
 362     if (av.hasHiddenColumns()
 363  && !hidden.isVisible(seqCanvas.cursorX))
 364     {
 365       int original = seqCanvas.cursorX - dx;
 366       int maxWidth = av.getAlignment().getWidth();
 367
 368       while (!hidden.isVisible(seqCanvas.cursorX)
 369               && seqCanvas.cursorX < maxWidth && seqCanvas.cursorX > 0)
 370       {
 371         seqCanvas.cursorX += dx;
 372       }
 373
 374       if (seqCanvas.cursorX >= maxWidth
 375               || !hidden.isVisible(seqCanvas.cursorX))
 376       {
 377         seqCanvas.cursorX = original;
 378       }
 379     }
 380
 381     scrollToVisible();
 382   }
 383
 384   void scrollToVisible()
 385   {
 386     if (seqCanvas.cursorX < 0)
 387     {
 388       seqCanvas.cursorX = 0;
 389     }
 390     else if (seqCanvas.cursorX > av.getAlignment().getWidth() - 1)
 391     {
 392       seqCanvas.cursorX = av.getAlignment().getWidth() - 1;
 393     }
 394
 395     if (seqCanvas.cursorY < 0)
 396     {
 397       seqCanvas.cursorY = 0;
 398     }
 399     else if (seqCanvas.cursorY > av.getAlignment().getHeight() - 1)
 400     {
 401       seqCanvas.cursorY = av.getAlignment().getHeight() - 1;
 402     }
 403
 404     endEditing();
 405     if (av.getWrapAlignment())
 406     {
 407       av.getRanges().scrollToWrappedVisible(seqCanvas.cursorX);
 408     }
 409     else
 410     {
 411       av.getRanges().scrollToVisible(seqCanvas.cursorX, seqCanvas.cursorY);
 412     }
 413     setStatusMessage(av.getAlignment().getSequenceAt(seqCanvas.cursorY),
 414             seqCanvas.cursorX, seqCanvas.cursorY);
 415
 416     seqCanvas.repaint();
 417   }
 418
 419   void setSelectionAreaAtCursor(boolean topLeft)
 420   {
 421     SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
 422
 423     if (av.getSelectionGroup() != null)
 424     {
 425       SequenceGroup sg = av.getSelectionGroup();
 426       // Find the top and bottom of this group
 427       int min = av.getAlignment().getHeight(), max = 0;
 428       for (int i = 0; i < sg.getSize(); i++)
 429       {
 430         int index = av.getAlignment().findIndex(sg.getSequenceAt(i));
 431         if (index > max)
 432         {
 433           max = index;
 434         }
 435         if (index < min)
 436         {
 437           min = index;
 438         }
 439       }
 440
 441       max++;
 442
 443       if (topLeft)
 444       {
 445         sg.setStartRes(seqCanvas.cursorX);
 446         if (sg.getEndRes() < seqCanvas.cursorX)
 447         {
 448           sg.setEndRes(seqCanvas.cursorX);
 449         }
 450
 451         min = seqCanvas.cursorY;
 452       }
 453       else
 454       {
 455         sg.setEndRes(seqCanvas.cursorX);
 456         if (sg.getStartRes() > seqCanvas.cursorX)
 457         {
 458           sg.setStartRes(seqCanvas.cursorX);
 459         }
 460
 461         max = seqCanvas.cursorY + 1;
 462       }
 463
 464       if (min > max)
 465       {
 466         // Only the user can do this
 467         av.setSelectionGroup(null);
 468       }
 469       else
 470       {
 471         // Now add any sequences between min and max
 472         sg.getSequences(null).clear();
 473         for (int i = min; i < max; i++)
 474         {
 475           sg.addSequence(av.getAlignment().getSequenceAt(i), false);
 476         }
 477       }
 478     }
 479
 480     if (av.getSelectionGroup() == null)
 481     {
 482       SequenceGroup sg = new SequenceGroup();
 483       sg.setStartRes(seqCanvas.cursorX);
 484       sg.setEndRes(seqCanvas.cursorX);
 485       sg.addSequence(sequence, false);
 486       av.setSelectionGroup(sg);
 487     }
 488
 489     ap.paintAlignment(false);
 490     av.sendSelection();
 491   }
 492
 493   void insertGapAtCursor(boolean group)
 494   {
 495     groupEditing = group;
 496     startseq = seqCanvas.cursorY;
 497     lastres = seqCanvas.cursorX;
 498     editSequence(true, false, seqCanvas.cursorX + getKeyboardNo1());
 499     endEditing();
 500   }
 501
 502   void deleteGapAtCursor(boolean group)
 503   {
 504     groupEditing = group;
 505     startseq = seqCanvas.cursorY;
 506     lastres = seqCanvas.cursorX + getKeyboardNo1();
 507     editSequence(false, false, seqCanvas.cursorX);
 508     endEditing();
 509   }
 510
 511   void insertNucAtCursor(boolean group, String nuc)
 512   {
 513     // TODO not called - delete?
 514     groupEditing = group;
 515     startseq = seqCanvas.cursorY;
 516     lastres = seqCanvas.cursorX;
 517     editSequence(false, true, seqCanvas.cursorX + getKeyboardNo1());
 518     endEditing();
 519   }
 520
 521   void numberPressed(char value)
 522   {
 523     if (keyboardNo1 == null)
 524     {
 525       keyboardNo1 = new StringBuffer();
 526     }
 527
 528     if (keyboardNo2 != null)
 529     {
 530       keyboardNo2.append(value);
 531     }
 532     else
 533     {
 534       keyboardNo1.append(value);
 535     }
 536   }
 537
 538   int getKeyboardNo1()
 539   {
 540     try
 541     {
 542       if (keyboardNo1 != null)
 543       {
 544         int value = Integer.parseInt(keyboardNo1.toString());
 545         keyboardNo1 = null;
 546         return value;
 547       }
 548     } catch (Exception x)
 549     {
 550     }
 551     keyboardNo1 = null;
 552     return 1;
 553   }
 554
 555   int getKeyboardNo2()
 556   {
 557     try
 558     {
 559       if (keyboardNo2 != null)
 560       {
 561         int value = Integer.parseInt(keyboardNo2.toString());
 562         keyboardNo2 = null;
 563         return value;
 564       }
 565     } catch (Exception x)
 566     {
 567     }
 568     keyboardNo2 = null;
 569     return 1;
 570   }
 571
 572   /**
 573    * DOCUMENT ME!
 574    *
 575    * @param evt
 576    *          DOCUMENT ME!
 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 (evt.isPopupTrigger()) // Windows: mouseReleased
 586     {
 587       showPopupMenu(evt);
 588       evt.consume();
 589       return;
 590     }
 591
 592     if (!editingSeqs)
 593     {
 594       doMouseReleasedDefineMode(evt, didDrag);
 595       return;
 596     }
 597
 598     endEditing();
 599   }
 600
 601   /**
 602    * DOCUMENT ME!
 603    *
 604    * @param evt
 605    *          DOCUMENT ME!
 606    */
 607   @Override
 608   public void mousePressed(MouseEvent evt)
 609   {
 610     lastMousePress = evt.getPoint();
 611
 612     if (SwingUtilities.isMiddleMouseButton(evt))
 613     {
 614       mouseWheelPressed = true;
 615       return;
 616     }
 617
 618     boolean isControlDown = Platform.isControlDown(evt);
 619     if (evt.isShiftDown() || isControlDown)
 620     {
 621       editingSeqs = true;
 622       if (isControlDown)
 623       {
 624         groupEditing = true;
 625       }
 626     }
 627     else
 628     {
 629       doMousePressedDefineMode(evt);
 630       return;
 631     }
 632
 633     int seq = findSeq(evt);
 634     int res = findColumn(evt);
 635
 636     if (seq < 0 || res < 0)
 637     {
 638       return;
 639     }
 640
 641     if ((seq < av.getAlignment().getHeight())
 642             && (res < av.getAlignment().getSequenceAt(seq).getLength()))
 643     {
 644       startseq = seq;
 645       lastres = res;
 646     }
 647     else
 648     {
 649       startseq = -1;
 650       lastres = -1;
 651     }
 652
 653     return;
 654   }
 655
 656   String lastMessage;
 657
 658   @Override
 659   public void mouseOverSequence(SequenceI sequence, int index, int pos)
 660   {
 661     String tmp = sequence.hashCode() + " " + index + " " + pos;
 662
 663     if (lastMessage == null || !lastMessage.equals(tmp))
 664     {
 665       // System.err.println("mouseOver Sequence: "+tmp);
 666       ssm.mouseOverSequence(sequence, index, pos, av);
 667     }
 668     lastMessage = tmp;
 669   }
 670
 671   /**
 672    * Highlight the mapped region described by the search results object (unless
 673    * unchanged). This supports highlight of protein while mousing over linked
 674    * cDNA and vice versa. The status bar is also updated to show the location of
 675    * the start of the highlighted region.
 676    */
 677   @Override
 678   public void highlightSequence(SearchResultsI results)
 679   {
 680     if (results == null || results.equals(lastSearchResults))
 681     {
 682       return;
 683     }
 684     lastSearchResults = results;
 685
 686     boolean wasScrolled = false;
 687
 688     if (av.isFollowHighlight())
 689     {
 690       // don't allow highlight of protein/cDNA to also scroll a complementary
 691       // panel,as this sets up a feedback loop (scrolling panel 1 causes moused
 692       // over residue to change abruptly, causing highlighted residue in panel 2
 693       // to change, causing a scroll in panel 1 etc)
 694       ap.setToScrollComplementPanel(false);
 695       wasScrolled = ap.scrollToPosition(results, false);
 696       if (wasScrolled)
 697       {
 698         seqCanvas.revalidate();
 699       }
 700       ap.setToScrollComplementPanel(true);
 701     }
 702
 703     boolean noFastPaint = wasScrolled && av.getWrapAlignment();
 704     if (seqCanvas.highlightSearchResults(results, noFastPaint))
 705     {
 706       setStatusMessage(results);
 707     }
 708   }
 709
 710   @Override
 711   public VamsasSource getVamsasSource()
 712   {
 713     return this.ap == null ? null : this.ap.av;
 714   }
 715
 716   @Override
 717   public void updateColours(SequenceI seq, int index)
 718   {
 719     System.out.println("update the seqPanel colours");
 720     // repaint();
 721   }
 722
 723   /**
 724    * DOCUMENT ME!
 725    *
 726    * @param evt
 727    *          DOCUMENT ME!
 728    */
 729   @Override
 730   public void mouseMoved(MouseEvent evt)
 731   {
 732     if (editingSeqs)
 733     {
 734       // This is because MacOSX creates a mouseMoved
 735       // If control is down, other platforms will not.
 736       mouseDragged(evt);
 737     }
 738
 739     final int column = findColumn(evt);
 740     int seq = findSeq(evt);
 741     if (column < 0 || seq < 0 || seq >= av.getAlignment().getHeight())
 742     {
 743       lastMouseSeq = -1;
 744       return;
 745     }
 746     if (column == lastMouseColumn && seq == lastMouseSeq)
 747     {
 748       /*
 749        * just a pixel move without change of residue
 750        */
 751       return;
 752     }
 753     lastMouseColumn = column;
 754     lastMouseSeq = seq;
 755
 756     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
 757
 758     if (column >= sequence.getLength())
 759     {
 760       return;
 761     }
 762
 763     /*
 764      * set status bar message, returning residue position in sequence
 765      */
 766     boolean isGapped = Comparison.isGap(sequence.getCharAt(column));
 767     final int pos = setStatusMessage(sequence, column, seq);
 768     if (ssm != null && !isGapped)
 769     {
 770       mouseOverSequence(sequence, column, pos);
 771     }
 772
 773     tooltipText.setLength(6); // Cuts the buffer back to <html>
 774
 775     SequenceGroup[] groups = av.getAlignment().findAllGroups(sequence);
 776     if (groups != null)
 777     {
 778       for (int g = 0; g < groups.length; g++)
 779       {
 780         if (groups[g].getStartRes() <= column
 781                 && groups[g].getEndRes() >= column)
 782         {
 783           if (!groups[g].getName().startsWith("JTreeGroup")
 784                   && !groups[g].getName().startsWith("JGroup"))
 785           {
 786             tooltipText.append(groups[g].getName());
 787           }
 788
 789           if (groups[g].getDescription() != null)
 790           {
 791             tooltipText.append(": " + groups[g].getDescription());
 792           }
 793         }
 794       }
 795     }
 796
 797     /*
 798      * add any features at the position to the tooltip; if over a gap, only
 799      * add features that straddle the gap (pos may be the residue before or
 800      * after the gap)
 801      */
 802     if (av.isShowSequenceFeatures())
 803     {
 804       List<SequenceFeature> features = ap.getFeatureRenderer()
 805               .findFeaturesAtColumn(sequence, column + 1);
 806       seqARep.appendFeatures(tooltipText, pos, features,
 807               this.ap.getSeqPanel().seqCanvas.fr.getMinMax());
 808     }
 809     if (tooltipText.length() == 6) // <html>
 810     {
 811       setToolTipText(null);
 812       lastTooltip = null;
 813     }
 814     else
 815     {
 816       String textString = tooltipText.toString();
 817       if (lastTooltip == null || !lastTooltip.equals(textString))
 818       {
 819         String formattedTooltipText = JvSwingUtils.wrapTooltip(true,
 820                 textString);
 821         setToolTipText(formattedTooltipText);
 822         lastTooltip = textString;
 823       }
 824     }
 825   }
 826
 827   private Point lastp = null;
 828
 829   /*
 830    * (non-Javadoc)
 831    *
 832    * @see javax.swing.JComponent#getToolTipLocation(java.awt.event.MouseEvent)
 833    */
 834   @Override
 835   public Point getToolTipLocation(MouseEvent event)
 836   {
 837     int x = event.getX(), w = getWidth();
 838     int wdth = (w - x < 200) ? -(w / 2) : 5; // switch sides when tooltip is too
 839     // close to edge
 840     Point p = lastp;
 841     if (!event.isShiftDown() || p == null)
 842     {
 843       p = (tooltipText != null && tooltipText.length() > 6) ? new Point(
 844               event.getX() + wdth, event.getY() - 20) : null;
 845     }
 846     /*
 847      * TODO: try to modify position region is not obcured by tooltip
 848      */
 849     return lastp = p;
 850   }
 851
 852   String lastTooltip;
 853
 854   /**
 855    * set when the current UI interaction has resulted in a change that requires
 856    * overview shading to be recalculated. this could be changed to something
 857    * more expressive that indicates what actually has changed, so selective
 858    * redraws can be applied
 859    */
 860   private boolean needOverviewUpdate = 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.abs(evt
1002               .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);
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)
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.formatMessage(
1163                 "label.edit_params", new String[] { label }));
1164       }
1165     }
1166
1167     if (insertGap)
1168     {
1169       message.append(" insert ");
1170     }
1171     else
1172     {
1173       message.append(" delete ");
1174     }
1175
1176     message.append(Math.abs(startres - lastres) + " gaps.");
1177     ap.alignFrame.statusBar.setText(message.toString());
1178
1179     // Are we editing within a selection group?
1180     if (groupEditing
1181             || (sg != null && sg.getSequences(av.getHiddenRepSequences())
1182                     .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 = fixedRight; 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, startres
1371                   - 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, lastres
1387                   - 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)
1542     {
1543       scrollThread.running = false;
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)
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     needOverviewUpdate = false;
1661
1662     startWrapBlock = wrappedBlock;
1663
1664     if (av.getWrapAlignment() && seq > av.getAlignment().getHeight())
1665     {
1666       JvOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
1667               .getString("label.cannot_edit_annotations_in_wrapped_view"),
1668               MessageManager.getString("label.wrapped_view_no_edit"),
1669               JvOptionPane.WARNING_MESSAGE);
1670       return;
1671     }
1672
1673     if (seq < 0 || res < 0)
1674     {
1675       return;
1676     }
1677
1678     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1679
1680     if ((sequence == null) || (res > sequence.getLength()))
1681     {
1682       return;
1683     }
1684
1685     stretchGroup = av.getSelectionGroup();
1686
1687     if (stretchGroup == null || !stretchGroup.contains(sequence, res))
1688     {
1689       stretchGroup = av.getAlignment().findGroup(sequence, res);
1690       if (stretchGroup != null)
1691       {
1692         // only update the current selection if the popup menu has a group to
1693         // focus on
1694         av.setSelectionGroup(stretchGroup);
1695       }
1696     }
1697
1698     if (evt.isPopupTrigger()) // Mac: mousePressed
1699     {
1700       showPopupMenu(evt);
1701       return;
1702     }
1703
1704     /*
1705      * defer right-mouse click handling to mouseReleased on Windows
1706      * (where isPopupTrigger() will answer true)
1707      * NB isRightMouseButton is also true for Cmd-click on Mac
1708      */
1709     if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
1710     {
1711       return;
1712     }
1713
1714     if (av.cursorMode)
1715     {
1716       seqCanvas.cursorX = findColumn(evt);
1717       seqCanvas.cursorY = findSeq(evt);
1718       seqCanvas.repaint();
1719       return;
1720     }
1721
1722     if (stretchGroup == null)
1723     {
1724       // Only if left mouse button do we want to change group sizes
1725
1726       // define a new group here
1727       SequenceGroup sg = new SequenceGroup();
1728       sg.setStartRes(res);
1729       sg.setEndRes(res);
1730       sg.addSequence(sequence, false);
1731       av.setSelectionGroup(sg);
1732       stretchGroup = sg;
1733
1734       if (av.getConservationSelected())
1735       {
1736         SliderPanel.setConservationSlider(ap, av.getResidueShading(),
1737                 ap.getViewName());
1738       }
1739
1740       if (av.getAbovePIDThreshold())
1741       {
1742         SliderPanel.setPIDSliderSource(ap, av.getResidueShading(),
1743                 ap.getViewName());
1744       }
1745       // TODO: stretchGroup will always be not null. Is this a merge error ?
1746       if ((stretchGroup != null) && (stretchGroup.getEndRes() == res))
1747       {
1748         // Edit end res position of selected group
1749         changeEndRes = true;
1750       }
1751       else if ((stretchGroup != null)
1752               && (stretchGroup.getStartRes() == res))
1753       {
1754         // Edit end res position of selected group
1755         changeStartRes = true;
1756       }
1757       stretchGroup.getWidth();
1758     }
1759
1760     seqCanvas.repaint();
1761   }
1762
1763   /**
1764    * Build and show a pop-up menu at the right-click mouse position
1765    *
1766    * @param evt
1767    * @param res
1768    * @param sequences
1769    */
1770   void showPopupMenu(MouseEvent evt)
1771   {
1772     final int column = findColumn(evt);
1773     final int seq = findSeq(evt);
1774     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1775     List<SequenceFeature> allFeatures = ap.getFeatureRenderer()
1776             .findFeaturesAtColumn(sequence, column + 1);
1777     List<String> links = new ArrayList<>();
1778     for (SequenceFeature sf : allFeatures)
1779     {
1780       if (sf.links != null)
1781       {
1782         for (String link : sf.links)
1783         {
1784           links.add(link);
1785         }
1786       }
1787     }
1788
1789     PopupMenu pop = new PopupMenu(ap, null, links);
1790     pop.show(this, evt.getX(), evt.getY());
1791   }
1792
1793   /**
1794    * Update the display after mouse up on a selection or group
1795    *
1796    * @param evt
1797    *          mouse released event details
1798    * @param afterDrag
1799    *          true if this event is happening after a mouse drag (rather than a
1800    *          mouse down)
1801    */
1802   public void doMouseReleasedDefineMode(MouseEvent evt, boolean afterDrag)
1803   {
1804     if (stretchGroup == null)
1805     {
1806       return;
1807     }
1808     // always do this - annotation has own state
1809     // but defer colourscheme update until hidden sequences are passed in
1810     boolean vischange = stretchGroup.recalcConservation(true);
1811     needOverviewUpdate |= vischange && av.isSelectionDefinedGroup()
1812             && afterDrag;
1813     if (stretchGroup.cs != null)
1814     {
1815       stretchGroup.cs.alignmentChanged(stretchGroup,
1816               av.getHiddenRepSequences());
1817
1818       ResidueShaderI groupColourScheme = stretchGroup.getGroupColourScheme();
1819       String name = stretchGroup.getName();
1820       if (stretchGroup.cs.conservationApplied())
1821       {
1822         SliderPanel.setConservationSlider(ap, groupColourScheme, name);
1823       }
1824       if (stretchGroup.cs.getThreshold() > 0)
1825       {
1826         SliderPanel.setPIDSliderSource(ap, groupColourScheme, name);
1827       }
1828     }
1829     PaintRefresher.Refresh(this, av.getSequenceSetId());
1830     ap.paintAlignment(needOverviewUpdate);
1831     needOverviewUpdate = false;
1832     changeEndRes = false;
1833     changeStartRes = false;
1834     stretchGroup = null;
1835     av.sendSelection();
1836   }
1837
1838   /**
1839    * DOCUMENT ME!
1840    *
1841    * @param evt
1842    *          DOCUMENT ME!
1843    */
1844   public void doMouseDraggedDefineMode(MouseEvent evt)
1845   {
1846     int res = findColumn(evt);
1847     int y = findSeq(evt);
1848
1849     if (wrappedBlock != startWrapBlock)
1850     {
1851       return;
1852     }
1853
1854     if (stretchGroup == null)
1855     {
1856       return;
1857     }
1858
1859     if (res >= av.getAlignment().getWidth())
1860     {
1861       res = av.getAlignment().getWidth() - 1;
1862     }
1863
1864     if (stretchGroup.getEndRes() == res)
1865     {
1866       // Edit end res position of selected group
1867       changeEndRes = true;
1868     }
1869     else if (stretchGroup.getStartRes() == res)
1870     {
1871       // Edit start res position of selected group
1872       changeStartRes = true;
1873     }
1874
1875     if (res < av.getRanges().getStartRes())
1876     {
1877       res = av.getRanges().getStartRes();
1878     }
1879
1880     if (changeEndRes)
1881     {
1882       if (res > (stretchGroup.getStartRes() - 1))
1883       {
1884         stretchGroup.setEndRes(res);
1885         needOverviewUpdate |= av.isSelectionDefinedGroup();
1886       }
1887     }
1888     else if (changeStartRes)
1889     {
1890       if (res < (stretchGroup.getEndRes() + 1))
1891       {
1892         stretchGroup.setStartRes(res);
1893         needOverviewUpdate |= av.isSelectionDefinedGroup();
1894       }
1895     }
1896
1897     int dragDirection = 0;
1898
1899     if (y > oldSeq)
1900     {
1901       dragDirection = 1;
1902     }
1903     else if (y < oldSeq)
1904     {
1905       dragDirection = -1;
1906     }
1907
1908     while ((y != oldSeq) && (oldSeq > -1)
1909             && (y < av.getAlignment().getHeight()))
1910     {
1911       // This routine ensures we don't skip any sequences, as the
1912       // selection is quite slow.
1913       Sequence seq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1914
1915       oldSeq += dragDirection;
1916
1917       if (oldSeq < 0)
1918       {
1919         break;
1920       }
1921
1922       Sequence nextSeq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1923
1924       if (stretchGroup.getSequences(null).contains(nextSeq))
1925       {
1926         stretchGroup.deleteSequence(seq, false);
1927         needOverviewUpdate |= av.isSelectionDefinedGroup();
1928       }
1929       else
1930       {
1931         if (seq != null)
1932         {
1933           stretchGroup.addSequence(seq, false);
1934         }
1935
1936         stretchGroup.addSequence(nextSeq, false);
1937         needOverviewUpdate |= av.isSelectionDefinedGroup();
1938       }
1939     }
1940
1941     if (oldSeq < 0)
1942     {
1943       oldSeq = -1;
1944     }
1945
1946     mouseDragging = true;
1947
1948     if (scrollThread != null)
1949     {
1950       scrollThread.setEvent(evt);
1951     }
1952
1953     seqCanvas.repaint();
1954   }
1955
1956   void scrollCanvas(MouseEvent evt)
1957   {
1958     if (evt == null)
1959     {
1960       if (scrollThread != null)
1961       {
1962         scrollThread.running = false;
1963         scrollThread = null;
1964       }
1965       mouseDragging = false;
1966     }
1967     else
1968     {
1969       if (scrollThread == null)
1970       {
1971         scrollThread = new ScrollThread();
1972       }
1973
1974       mouseDragging = true;
1975       scrollThread.setEvent(evt);
1976     }
1977
1978   }
1979
1980   // this class allows scrolling off the bottom of the visible alignment
1981   class ScrollThread extends Thread
1982   {
1983     MouseEvent evt;
1984
1985     boolean running = false;
1986
1987     public ScrollThread()
1988     {
1989       start();
1990     }
1991
1992     public void setEvent(MouseEvent e)
1993     {
1994       evt = e;
1995     }
1996
1997     public void stopScrolling()
1998     {
1999       running = false;
2000     }
2001
2002     @Override
2003     public void run()
2004     {
2005       running = true;
2006
2007       while (running)
2008       {
2009         if (evt != null)
2010         {
2011           if (mouseDragging && (evt.getY() < 0)
2012                   && (av.getRanges().getStartSeq() > 0))
2013           {
2014             running = av.getRanges().scrollUp(true);
2015           }
2016
2017           if (mouseDragging && (evt.getY() >= getHeight())
2018                   && (av.getAlignment().getHeight() > av.getRanges()
2019                           .getEndSeq()))
2020           {
2021             running = av.getRanges().scrollUp(false);
2022           }
2023
2024           if (mouseDragging && (evt.getX() < 0))
2025           {
2026             running = av.getRanges().scrollRight(false);
2027           }
2028           else if (mouseDragging && (evt.getX() >= getWidth()))
2029           {
2030             running = av.getRanges().scrollRight(true);
2031           }
2032         }
2033
2034         try
2035         {
2036           Thread.sleep(20);
2037         } catch (Exception ex)
2038         {
2039         }
2040       }
2041     }
2042   }
2043
2044   /**
2045    * modify current selection according to a received message.
2046    */
2047   @Override
2048   public void selection(SequenceGroup seqsel, ColumnSelection colsel,
2049           HiddenColumns hidden, SelectionSource source)
2050   {
2051     // TODO: fix this hack - source of messages is align viewport, but SeqPanel
2052     // handles selection messages...
2053     // TODO: extend config options to allow user to control if selections may be
2054     // shared between viewports.
2055     boolean iSentTheSelection = (av == source || (source instanceof AlignViewport && ((AlignmentViewport) source)
2056             .getSequenceSetId().equals(av.getSequenceSetId())));
2057
2058     if (iSentTheSelection)
2059     {
2060       // respond to our own event by updating dependent dialogs
2061       if (ap.getCalculationDialog() != null)
2062       {
2063         ap.getCalculationDialog().validateCalcTypes();
2064       }
2065
2066       return;
2067     }
2068
2069     // process further ?
2070     if (!av.followSelection)
2071     {
2072       return;
2073     }
2074
2075     /*
2076      * Ignore the selection if there is one of our own pending.
2077      */
2078     if (av.isSelectionGroupChanged(false) || av.isColSelChanged(false))
2079     {
2080       return;
2081     }
2082
2083     /*
2084      * Check for selection in a view of which this one is a dna/protein
2085      * complement.
2086      */
2087     if (selectionFromTranslation(seqsel, colsel, hidden, source))
2088     {
2089       return;
2090     }
2091
2092     // do we want to thread this ? (contention with seqsel and colsel locks, I
2093     // suspect)
2094     /*
2095      * only copy colsel if there is a real intersection between
2096      * sequence selection and this panel's alignment
2097      */
2098     boolean repaint = false;
2099     boolean copycolsel = false;
2100
2101     SequenceGroup sgroup = null;
2102     if (seqsel != null && seqsel.getSize() > 0)
2103     {
2104       if (av.getAlignment() == null)
2105       {
2106         Cache.log.warn("alignviewport av SeqSetId=" + av.getSequenceSetId()
2107                 + " ViewId=" + av.getViewId()
2108                 + " 's alignment is NULL! returning immediately.");
2109         return;
2110       }
2111       sgroup = seqsel.intersect(av.getAlignment(),
2112               (av.hasHiddenRows()) ? av.getHiddenRepSequences() : null);
2113       if ((sgroup != null && sgroup.getSize() > 0))
2114       {
2115         copycolsel = true;
2116       }
2117     }
2118     if (sgroup != null && sgroup.getSize() > 0)
2119     {
2120       av.setSelectionGroup(sgroup);
2121     }
2122     else
2123     {
2124       av.setSelectionGroup(null);
2125     }
2126     av.isSelectionGroupChanged(true);
2127     repaint = true;
2128
2129     if (copycolsel)
2130     {
2131       // the current selection is unset or from a previous message
2132       // so import the new colsel.
2133       if (colsel == null || colsel.isEmpty())
2134       {
2135         if (av.getColumnSelection() != null)
2136         {
2137           av.getColumnSelection().clear();
2138           repaint = true;
2139         }
2140       }
2141       else
2142       {
2143         // TODO: shift colSel according to the intersecting sequences
2144         if (av.getColumnSelection() == null)
2145         {
2146           av.setColumnSelection(new ColumnSelection(colsel));
2147         }
2148         else
2149         {
2150           av.getColumnSelection().setElementsFrom(colsel,
2151                   av.getAlignment().getHiddenColumns());
2152         }
2153       }
2154       av.isColSelChanged(true);
2155       repaint = true;
2156     }
2157
2158     if (copycolsel
2159             && av.hasHiddenColumns()
2160             && (av.getAlignment().getHiddenColumns() == null))
2161     {
2162       System.err.println("Bad things");
2163     }
2164     if (repaint) // always true!
2165     {
2166       // probably finessing with multiple redraws here
2167       PaintRefresher.Refresh(this, av.getSequenceSetId());
2168       // ap.paintAlignment(false);
2169     }
2170
2171     // lastly, update dependent dialogs
2172     if (ap.getCalculationDialog() != null)
2173     {
2174       ap.getCalculationDialog().validateCalcTypes();
2175     }
2176
2177   }
2178
2179   /**
2180    * If this panel is a cdna/protein translation view of the selection source,
2181    * tries to map the source selection to a local one, and returns true. Else
2182    * returns false.
2183    *
2184    * @param seqsel
2185    * @param colsel
2186    * @param source
2187    */
2188   protected boolean selectionFromTranslation(SequenceGroup seqsel,
2189           ColumnSelection colsel, HiddenColumns hidden,
2190           SelectionSource source)
2191   {
2192     if (!(source instanceof AlignViewportI))
2193     {
2194       return false;
2195     }
2196     final AlignViewportI sourceAv = (AlignViewportI) source;
2197     if (sourceAv.getCodingComplement() != av
2198             && av.getCodingComplement() != sourceAv)
2199     {
2200       return false;
2201     }
2202
2203     /*
2204      * Map sequence selection
2205      */
2206     SequenceGroup sg = MappingUtils.mapSequenceGroup(seqsel, sourceAv, av);
2207     av.setSelectionGroup(sg);
2208     av.isSelectionGroupChanged(true);
2209
2210     /*
2211      * Map column selection
2212      */
2213     // ColumnSelection cs = MappingUtils.mapColumnSelection(colsel, sourceAv,
2214     // av);
2215     ColumnSelection cs = new ColumnSelection();
2216     HiddenColumns hs = new HiddenColumns();
2217     MappingUtils.mapColumnSelection(colsel, hidden, sourceAv, av, cs, hs);
2218     av.setColumnSelection(cs);
2219     av.getAlignment().setHiddenColumns(hs);
2220
2221     // lastly, update any dependent dialogs
2222     if (ap.getCalculationDialog() != null)
2223     {
2224       ap.getCalculationDialog().validateCalcTypes();
2225     }
2226
2227     PaintRefresher.Refresh(this, av.getSequenceSetId());
2228
2229     return true;
2230   }
2231 }