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     if (av.getWrapAlignment())
 205     {
 206
 207       int hgap = av.getCharHeight();
 208       if (av.getScaleAboveWrapped())
 209       {
 210         hgap += av.getCharHeight();
 211       }
 212
 213       int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
 214               + hgap + seqCanvas.getAnnotationHeight();
 215
 216       int y = evt.getY();
 217       y -= hgap;
 218       x -= seqCanvas.labelWidthWest;
 219
 220       int cwidth = seqCanvas.getWrappedCanvasWidth(this.getWidth());
 221       if (cwidth < 1)
 222       {
 223         return 0;
 224       }
 225
 226       wrappedBlock = y / cHeight;
 227       wrappedBlock += av.getRanges().getStartRes() / cwidth;
 228
 229       res = wrappedBlock * cwidth + x / av.getCharWidth();
 230
 231     }
 232     else
 233     {
 234       if (x > seqCanvas.getX() + seqCanvas.getWidth())
 235       {
 236         // make sure we calculate relative to visible alignment, rather than
 237         // right-hand gutter
 238         x = seqCanvas.getX() + seqCanvas.getWidth();
 239       }
 240       res = (x / av.getCharWidth()) + av.getRanges().getStartRes();
 241       if (res > av.getRanges().getEndRes())
 242       {
 243         // moused off right
 244         res = av.getRanges().getEndRes();
 245       }
 246     }
 247
 248     if (av.hasHiddenColumns())
 249     {
 250       res = av.getAlignment().getHiddenColumns()
 251               .adjustForHiddenColumns(res);
 252     }
 253
 254     return res;
 255
 256   }
 257
 258   int findSeq(MouseEvent evt)
 259   {
 260     int seq = 0;
 261     int y = evt.getY();
 262
 263     if (av.getWrapAlignment())
 264     {
 265       int hgap = av.getCharHeight();
 266       if (av.getScaleAboveWrapped())
 267       {
 268         hgap += av.getCharHeight();
 269       }
 270
 271       int cHeight = av.getAlignment().getHeight() * av.getCharHeight()
 272               + hgap + seqCanvas.getAnnotationHeight();
 273
 274       y -= hgap;
 275
 276       seq = Math.min((y % cHeight) / av.getCharHeight(), av.getAlignment()
 277               .getHeight() - 1);
 278     }
 279     else
 280     {
 281       seq = Math.min((y / av.getCharHeight())
 282               + av.getRanges().getStartSeq(),
 283               av
 284               .getAlignment().getHeight() - 1);
 285     }
 286
 287     return seq;
 288   }
 289
 290   /**
 291    * When all of a sequence of edits are complete, put the resulting edit list
 292    * on the history stack (undo list), and reset flags for editing in progress.
 293    */
 294   void endEditing()
 295   {
 296     try
 297     {
 298       if (editCommand != null && editCommand.getSize() > 0)
 299       {
 300         ap.alignFrame.addHistoryItem(editCommand);
 301         av.firePropertyChange("alignment", null, av.getAlignment()
 302                 .getSequences());
 303       }
 304     } finally
 305     {
 306       /*
 307        * Tidy up come what may...
 308        */
 309       startseq = -1;
 310       lastres = -1;
 311       editingSeqs = false;
 312       groupEditing = false;
 313       keyboardNo1 = null;
 314       keyboardNo2 = null;
 315       editCommand = null;
 316     }
 317   }
 318
 319   void setCursorRow()
 320   {
 321     seqCanvas.cursorY = getKeyboardNo1() - 1;
 322     scrollToVisible();
 323   }
 324
 325   void setCursorColumn()
 326   {
 327     seqCanvas.cursorX = getKeyboardNo1() - 1;
 328     scrollToVisible();
 329   }
 330
 331   void setCursorRowAndColumn()
 332   {
 333     if (keyboardNo2 == null)
 334     {
 335       keyboardNo2 = new StringBuffer();
 336     }
 337     else
 338     {
 339       seqCanvas.cursorX = getKeyboardNo1() - 1;
 340       seqCanvas.cursorY = getKeyboardNo2() - 1;
 341       scrollToVisible();
 342     }
 343   }
 344
 345   void setCursorPosition()
 346   {
 347     SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
 348
 349     seqCanvas.cursorX = sequence.findIndex(getKeyboardNo1()) - 1;
 350     scrollToVisible();
 351   }
 352
 353   void moveCursor(int dx, int dy)
 354   {
 355     seqCanvas.cursorX += dx;
 356     seqCanvas.cursorY += dy;
 357
 358     HiddenColumns hidden = av.getAlignment().getHiddenColumns();
 359
 360     if (av.hasHiddenColumns()
 361  && !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);
 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) ? new Point(
 842               event.getX() + wdth, event.getY() - 20) : null;
 843     }
 844     /*
 845      * TODO: try to modify position region is not obcured by tooltip
 846      */
 847     return lastp = p;
 848   }
 849
 850   String lastTooltip;
 851
 852   /**
 853    * set when the current UI interaction has resulted in a change that requires
 854    * overview shading to be recalculated. this could be changed to something
 855    * more expressive that indicates what actually has changed, so selective
 856    * redraws can be applied
 857    */
 858   private boolean needOverviewUpdate = false; // TODO: refactor to avcontroller
 859
 860   /**
 861    * set if av.getSelectionGroup() refers to a group that is defined on the
 862    * alignment view, rather than a transient selection
 863    */
 864   // private boolean editingDefinedGroup = false; // TODO: refactor to
 865   // avcontroller or viewModel
 866
 867   /**
 868    * Sets the status message in alignment panel, showing the sequence number
 869    * (index) and id, and residue and residue position if not at a gap, for the
 870    * given sequence and column position. Returns the residue position returned
 871    * by Sequence.findPosition. Note this may be for the nearest adjacent residue
 872    * if at a gapped position.
 873    *
 874    * @param sequence
 875    *          aligned sequence object
 876    * @param column
 877    *          alignment column
 878    * @param seqIndex
 879    *          index of sequence in alignment
 880    * @return sequence position of residue at column, or adjacent residue if at a
 881    *         gap
 882    */
 883   int setStatusMessage(SequenceI sequence, final int column, int seqIndex)
 884   {
 885     char sequenceChar = sequence.getCharAt(column);
 886     int pos = sequence.findPosition(column);
 887     setStatusMessage(sequence, seqIndex, sequenceChar, pos);
 888
 889     return pos;
 890   }
 891
 892   /**
 893    * Builds the status message for the current cursor location and writes it to
 894    * the status bar, for example
 895    *
 896    * <pre>
 897    * Sequence 3 ID: FER1_SOLLC
 898    * Sequence 5 ID: FER1_PEA Residue: THR (4)
 899    * Sequence 5 ID: FER1_PEA Residue: B (3)
 900    * Sequence 6 ID: O.niloticus.3 Nucleotide: Uracil (2)
 901    * </pre>
 902    *
 903    * @param sequence
 904    * @param seqIndex
 905    *          sequence position in the alignment (1..)
 906    * @param sequenceChar
 907    *          the character under the cursor
 908    * @param residuePos
 909    *          the sequence residue position (if not over a gap)
 910    */
 911   protected void setStatusMessage(SequenceI sequence, int seqIndex,
 912           char sequenceChar, int residuePos)
 913   {
 914     StringBuilder text = new StringBuilder(32);
 915
 916     /*
 917      * Sequence number (if known), and sequence name.
 918      */
 919     String seqno = seqIndex == -1 ? "" : " " + (seqIndex + 1);
 920     text.append("Sequence").append(seqno).append(" ID: ")
 921             .append(sequence.getName());
 922
 923     String residue = null;
 924
 925     /*
 926      * Try to translate the display character to residue name (null for gap).
 927      */
 928     boolean isGapped = Comparison.isGap(sequenceChar);
 929
 930     if (!isGapped)
 931     {
 932       boolean nucleotide = av.getAlignment().isNucleotide();
 933       String displayChar = String.valueOf(sequenceChar);
 934       if (nucleotide)
 935       {
 936         residue = ResidueProperties.nucleotideName.get(displayChar);
 937       }
 938       else
 939       {
 940         residue = "X".equalsIgnoreCase(displayChar) ? "X" : ("*"
 941                 .equals(displayChar) ? "STOP"
 942                 : ResidueProperties.aa2Triplet.get(displayChar));
 943       }
 944       text.append(" ").append(nucleotide ? "Nucleotide" : "Residue")
 945               .append(": ").append(residue == null ? displayChar : residue);
 946
 947       text.append(" (").append(Integer.toString(residuePos)).append(")");
 948     }
 949     ap.alignFrame.statusBar.setText(text.toString());
 950   }
 951
 952   /**
 953    * Set the status bar message to highlight the first matched position in
 954    * search results.
 955    *
 956    * @param results
 957    */
 958   private void setStatusMessage(SearchResultsI results)
 959   {
 960     AlignmentI al = this.av.getAlignment();
 961     int sequenceIndex = al.findIndex(results);
 962     if (sequenceIndex == -1)
 963     {
 964       return;
 965     }
 966     SequenceI ds = al.getSequenceAt(sequenceIndex).getDatasetSequence();
 967     for (SearchResultMatchI m : results.getResults())
 968     {
 969       SequenceI seq = m.getSequence();
 970       if (seq.getDatasetSequence() != null)
 971       {
 972         seq = seq.getDatasetSequence();
 973       }
 974
 975       if (seq == ds)
 976       {
 977         int start = m.getStart();
 978         setStatusMessage(seq, sequenceIndex, seq.getCharAt(start - 1),
 979                 start);
 980         return;
 981       }
 982     }
 983   }
 984
 985   /**
 986    * {@inheritDoc}
 987    */
 988   @Override
 989   public void mouseDragged(MouseEvent evt)
 990   {
 991     if (mouseWheelPressed)
 992     {
 993       boolean inSplitFrame = ap.av.getCodingComplement() != null;
 994       boolean copyChanges = inSplitFrame && av.isProteinFontAsCdna();
 995
 996       int oldWidth = av.getCharWidth();
 997
 998       // Which is bigger, left-right or up-down?
 999       if (Math.abs(evt.getY() - lastMousePress.getY()) > Math.abs(evt
1000               .getX() - lastMousePress.getX()))
1001       {
1002         /*
1003          * on drag up or down, decrement or increment font size
1004          */
1005         int fontSize = av.font.getSize();
1006         boolean fontChanged = false;
1007
1008         if (evt.getY() < lastMousePress.getY())
1009         {
1010           fontChanged = true;
1011           fontSize--;
1012         }
1013         else if (evt.getY() > lastMousePress.getY())
1014         {
1015           fontChanged = true;
1016           fontSize++;
1017         }
1018
1019         if (fontSize < 1)
1020         {
1021           fontSize = 1;
1022         }
1023
1024         if (fontChanged)
1025         {
1026           Font newFont = new Font(av.font.getName(), av.font.getStyle(),
1027                   fontSize);
1028           av.setFont(newFont, true);
1029           av.setCharWidth(oldWidth);
1030           ap.fontChanged();
1031           if (copyChanges)
1032           {
1033             ap.av.getCodingComplement().setFont(newFont, true);
1034             SplitFrame splitFrame = (SplitFrame) ap.alignFrame
1035                     .getSplitViewContainer();
1036             splitFrame.adjustLayout();
1037             splitFrame.repaint();
1038           }
1039         }
1040       }
1041       else
1042       {
1043         /*
1044          * on drag left or right, decrement or increment character width
1045          */
1046         int newWidth = 0;
1047         if (evt.getX() < lastMousePress.getX() && av.getCharWidth() > 1)
1048         {
1049           newWidth = av.getCharWidth() - 1;
1050           av.setCharWidth(newWidth);
1051         }
1052         else if (evt.getX() > lastMousePress.getX())
1053         {
1054           newWidth = av.getCharWidth() + 1;
1055           av.setCharWidth(newWidth);
1056         }
1057         if (newWidth > 0)
1058         {
1059           ap.paintAlignment(false);
1060           if (copyChanges)
1061           {
1062             /*
1063              * need to ensure newWidth is set on cdna, regardless of which
1064              * panel the mouse drag happened in; protein will compute its
1065              * character width as 1:1 or 3:1
1066              */
1067             av.getCodingComplement().setCharWidth(newWidth);
1068             SplitFrame splitFrame = (SplitFrame) ap.alignFrame
1069                     .getSplitViewContainer();
1070             splitFrame.adjustLayout();
1071             splitFrame.repaint();
1072           }
1073         }
1074       }
1075
1076       FontMetrics fm = getFontMetrics(av.getFont());
1077       av.validCharWidth = fm.charWidth('M') <= av.getCharWidth();
1078
1079       lastMousePress = evt.getPoint();
1080
1081       return;
1082     }
1083
1084     if (!editingSeqs)
1085     {
1086       doMouseDraggedDefineMode(evt);
1087       return;
1088     }
1089
1090     int res = findColumn(evt);
1091
1092     if (res < 0)
1093     {
1094       res = 0;
1095     }
1096
1097     if ((lastres == -1) || (lastres == res))
1098     {
1099       return;
1100     }
1101
1102     if ((res < av.getAlignment().getWidth()) && (res < lastres))
1103     {
1104       // dragLeft, delete gap
1105       editSequence(false, false, res);
1106     }
1107     else
1108     {
1109       editSequence(true, false, res);
1110     }
1111
1112     mouseDragging = true;
1113     if (scrollThread != null)
1114     {
1115       scrollThread.setEvent(evt);
1116     }
1117   }
1118
1119   // TODO: Make it more clever than many booleans
1120   synchronized void editSequence(boolean insertGap, boolean editSeq,
1121           int startres)
1122   {
1123     int fixedLeft = -1;
1124     int fixedRight = -1;
1125     boolean fixedColumns = false;
1126     SequenceGroup sg = av.getSelectionGroup();
1127
1128     SequenceI seq = av.getAlignment().getSequenceAt(startseq);
1129
1130     // No group, but the sequence may represent a group
1131     if (!groupEditing && av.hasHiddenRows())
1132     {
1133       if (av.isHiddenRepSequence(seq))
1134       {
1135         sg = av.getRepresentedSequences(seq);
1136         groupEditing = true;
1137       }
1138     }
1139
1140     StringBuilder message = new StringBuilder(64);
1141     if (groupEditing)
1142     {
1143       message.append("Edit group:");
1144       if (editCommand == null)
1145       {
1146         editCommand = new EditCommand(
1147                 MessageManager.getString("action.edit_group"));
1148       }
1149     }
1150     else
1151     {
1152       message.append("Edit sequence: " + seq.getName());
1153       String label = seq.getName();
1154       if (label.length() > 10)
1155       {
1156         label = label.substring(0, 10);
1157       }
1158       if (editCommand == null)
1159       {
1160         editCommand = new EditCommand(MessageManager.formatMessage(
1161                 "label.edit_params", new String[] { label }));
1162       }
1163     }
1164
1165     if (insertGap)
1166     {
1167       message.append(" insert ");
1168     }
1169     else
1170     {
1171       message.append(" delete ");
1172     }
1173
1174     message.append(Math.abs(startres - lastres) + " gaps.");
1175     ap.alignFrame.statusBar.setText(message.toString());
1176
1177     // Are we editing within a selection group?
1178     if (groupEditing
1179             || (sg != null && sg.getSequences(av.getHiddenRepSequences())
1180                     .contains(seq)))
1181     {
1182       fixedColumns = true;
1183
1184       // sg might be null as the user may only see 1 sequence,
1185       // but the sequence represents a group
1186       if (sg == null)
1187       {
1188         if (!av.isHiddenRepSequence(seq))
1189         {
1190           endEditing();
1191           return;
1192         }
1193         sg = av.getRepresentedSequences(seq);
1194       }
1195
1196       fixedLeft = sg.getStartRes();
1197       fixedRight = sg.getEndRes();
1198
1199       if ((startres < fixedLeft && lastres >= fixedLeft)
1200               || (startres >= fixedLeft && lastres < fixedLeft)
1201               || (startres > fixedRight && lastres <= fixedRight)
1202               || (startres <= fixedRight && lastres > fixedRight))
1203       {
1204         endEditing();
1205         return;
1206       }
1207
1208       if (fixedLeft > startres)
1209       {
1210         fixedRight = fixedLeft - 1;
1211         fixedLeft = 0;
1212       }
1213       else if (fixedRight < startres)
1214       {
1215         fixedLeft = fixedRight;
1216         fixedRight = -1;
1217       }
1218     }
1219
1220     if (av.hasHiddenColumns())
1221     {
1222       fixedColumns = true;
1223       int y1 = av.getAlignment().getHiddenColumns()
1224               .getHiddenBoundaryLeft(startres);
1225       int y2 = av.getAlignment().getHiddenColumns()
1226               .getHiddenBoundaryRight(startres);
1227
1228       if ((insertGap && startres > y1 && lastres < y1)
1229               || (!insertGap && startres < y2 && lastres > y2))
1230       {
1231         endEditing();
1232         return;
1233       }
1234
1235       // System.out.print(y1+" "+y2+" "+fixedLeft+" "+fixedRight+"~~");
1236       // Selection spans a hidden region
1237       if (fixedLeft < y1 && (fixedRight > y2 || fixedRight == -1))
1238       {
1239         if (startres >= y2)
1240         {
1241           fixedLeft = y2;
1242         }
1243         else
1244         {
1245           fixedRight = y2 - 1;
1246         }
1247       }
1248     }
1249
1250     if (groupEditing)
1251     {
1252       List<SequenceI> vseqs = sg.getSequences(av.getHiddenRepSequences());
1253       int g, groupSize = vseqs.size();
1254       SequenceI[] groupSeqs = new SequenceI[groupSize];
1255       for (g = 0; g < groupSeqs.length; g++)
1256       {
1257         groupSeqs[g] = vseqs.get(g);
1258       }
1259
1260       // drag to right
1261       if (insertGap)
1262       {
1263         // If the user has selected the whole sequence, and is dragging to
1264         // the right, we can still extend the alignment and selectionGroup
1265         if (sg.getStartRes() == 0 && sg.getEndRes() == fixedRight
1266                 && sg.getEndRes() == av.getAlignment().getWidth() - 1)
1267         {
1268           sg.setEndRes(av.getAlignment().getWidth() + startres - lastres);
1269           fixedRight = sg.getEndRes();
1270         }
1271
1272         // Is it valid with fixed columns??
1273         // Find the next gap before the end
1274         // of the visible region boundary
1275         boolean blank = false;
1276         for (fixedRight = fixedRight; fixedRight > lastres; fixedRight--)
1277         {
1278           blank = true;
1279
1280           for (g = 0; g < groupSize; g++)
1281           {
1282             for (int j = 0; j < startres - lastres; j++)
1283             {
1284               if (!Comparison.isGap(groupSeqs[g].getCharAt(fixedRight - j)))
1285               {
1286                 blank = false;
1287                 break;
1288               }
1289             }
1290           }
1291           if (blank)
1292           {
1293             break;
1294           }
1295         }
1296
1297         if (!blank)
1298         {
1299           if (sg.getSize() == av.getAlignment().getHeight())
1300           {
1301             if ((av.hasHiddenColumns() && startres < av.getAlignment()
1302                     .getHiddenColumns().getHiddenBoundaryRight(startres)))
1303             {
1304               endEditing();
1305               return;
1306             }
1307
1308             int alWidth = av.getAlignment().getWidth();
1309             if (av.hasHiddenRows())
1310             {
1311               int hwidth = av.getAlignment().getHiddenSequences()
1312                       .getWidth();
1313               if (hwidth > alWidth)
1314               {
1315                 alWidth = hwidth;
1316               }
1317             }
1318             // We can still insert gaps if the selectionGroup
1319             // contains all the sequences
1320             sg.setEndRes(sg.getEndRes() + startres - lastres);
1321             fixedRight = alWidth + startres - lastres;
1322           }
1323           else
1324           {
1325             endEditing();
1326             return;
1327           }
1328         }
1329       }
1330
1331       // drag to left
1332       else if (!insertGap)
1333       {
1334         // / Are we able to delete?
1335         // ie are all columns blank?
1336
1337         for (g = 0; g < groupSize; g++)
1338         {
1339           for (int j = startres; j < lastres; j++)
1340           {
1341             if (groupSeqs[g].getLength() <= j)
1342             {
1343               continue;
1344             }
1345
1346             if (!Comparison.isGap(groupSeqs[g].getCharAt(j)))
1347             {
1348               // Not a gap, block edit not valid
1349               endEditing();
1350               return;
1351             }
1352           }
1353         }
1354       }
1355
1356       if (insertGap)
1357       {
1358         // dragging to the right
1359         if (fixedColumns && fixedRight != -1)
1360         {
1361           for (int j = lastres; j < startres; j++)
1362           {
1363             insertChar(j, groupSeqs, fixedRight);
1364           }
1365         }
1366         else
1367         {
1368           appendEdit(Action.INSERT_GAP, groupSeqs, startres, startres
1369                   - lastres);
1370         }
1371       }
1372       else
1373       {
1374         // dragging to the left
1375         if (fixedColumns && fixedRight != -1)
1376         {
1377           for (int j = lastres; j > startres; j--)
1378           {
1379             deleteChar(startres, groupSeqs, fixedRight);
1380           }
1381         }
1382         else
1383         {
1384           appendEdit(Action.DELETE_GAP, groupSeqs, startres, lastres
1385                   - startres);
1386         }
1387
1388       }
1389     }
1390     else
1391     // ///Editing a single sequence///////////
1392     {
1393       if (insertGap)
1394       {
1395         // dragging to the right
1396         if (fixedColumns && fixedRight != -1)
1397         {
1398           for (int j = lastres; j < startres; j++)
1399           {
1400             insertChar(j, new SequenceI[] { seq }, fixedRight);
1401           }
1402         }
1403         else
1404         {
1405           appendEdit(Action.INSERT_GAP, new SequenceI[] { seq }, lastres,
1406                   startres - lastres);
1407         }
1408       }
1409       else
1410       {
1411         if (!editSeq)
1412         {
1413           // dragging to the left
1414           if (fixedColumns && fixedRight != -1)
1415           {
1416             for (int j = lastres; j > startres; j--)
1417             {
1418               if (!Comparison.isGap(seq.getCharAt(startres)))
1419               {
1420                 endEditing();
1421                 break;
1422               }
1423               deleteChar(startres, new SequenceI[] { seq }, fixedRight);
1424             }
1425           }
1426           else
1427           {
1428             // could be a keyboard edit trying to delete none gaps
1429             int max = 0;
1430             for (int m = startres; m < lastres; m++)
1431             {
1432               if (!Comparison.isGap(seq.getCharAt(m)))
1433               {
1434                 break;
1435               }
1436               max++;
1437             }
1438
1439             if (max > 0)
1440             {
1441               appendEdit(Action.DELETE_GAP, new SequenceI[] { seq },
1442                       startres, max);
1443             }
1444           }
1445         }
1446         else
1447         {// insertGap==false AND editSeq==TRUE;
1448           if (fixedColumns && fixedRight != -1)
1449           {
1450             for (int j = lastres; j < startres; j++)
1451             {
1452               insertChar(j, new SequenceI[] { seq }, fixedRight);
1453             }
1454           }
1455           else
1456           {
1457             appendEdit(Action.INSERT_NUC, new SequenceI[] { seq }, lastres,
1458                     startres - lastres);
1459           }
1460         }
1461       }
1462     }
1463
1464     lastres = startres;
1465     seqCanvas.repaint();
1466   }
1467
1468   void insertChar(int j, SequenceI[] seq, int fixedColumn)
1469   {
1470     int blankColumn = fixedColumn;
1471     for (int s = 0; s < seq.length; s++)
1472     {
1473       // Find the next gap before the end of the visible region boundary
1474       // If lastCol > j, theres a boundary after the gap insertion
1475
1476       for (blankColumn = fixedColumn; blankColumn > j; blankColumn--)
1477       {
1478         if (Comparison.isGap(seq[s].getCharAt(blankColumn)))
1479         {
1480           // Theres a space, so break and insert the gap
1481           break;
1482         }
1483       }
1484
1485       if (blankColumn <= j)
1486       {
1487         blankColumn = fixedColumn;
1488         endEditing();
1489         return;
1490       }
1491     }
1492
1493     appendEdit(Action.DELETE_GAP, seq, blankColumn, 1);
1494
1495     appendEdit(Action.INSERT_GAP, seq, j, 1);
1496
1497   }
1498
1499   /**
1500    * Helper method to add and perform one edit action.
1501    *
1502    * @param action
1503    * @param seq
1504    * @param pos
1505    * @param count
1506    */
1507   protected void appendEdit(Action action, SequenceI[] seq, int pos,
1508           int count)
1509   {
1510
1511     final Edit edit = new EditCommand().new Edit(action, seq, pos, count,
1512             av.getAlignment().getGapCharacter());
1513
1514     editCommand.appendEdit(edit, av.getAlignment(), true, null);
1515   }
1516
1517   void deleteChar(int j, SequenceI[] seq, int fixedColumn)
1518   {
1519
1520     appendEdit(Action.DELETE_GAP, seq, j, 1);
1521
1522     appendEdit(Action.INSERT_GAP, seq, fixedColumn, 1);
1523   }
1524
1525   /**
1526    * DOCUMENT ME!
1527    *
1528    * @param e
1529    *          DOCUMENT ME!
1530    */
1531   @Override
1532   public void mouseEntered(MouseEvent e)
1533   {
1534     if (oldSeq < 0)
1535     {
1536       oldSeq = 0;
1537     }
1538
1539     if (scrollThread != null)
1540     {
1541       scrollThread.running = false;
1542       scrollThread = null;
1543     }
1544   }
1545
1546   /**
1547    * DOCUMENT ME!
1548    *
1549    * @param e
1550    *          DOCUMENT ME!
1551    */
1552   @Override
1553   public void mouseExited(MouseEvent e)
1554   {
1555     if (av.getWrapAlignment())
1556     {
1557       return;
1558     }
1559
1560     if (mouseDragging)
1561     {
1562       scrollThread = new ScrollThread();
1563     }
1564   }
1565
1566   /**
1567    * Handler for double-click on a position with one or more sequence features.
1568    * Opens the Amend Features dialog to allow feature details to be amended, or
1569    * the feature deleted.
1570    */
1571   @Override
1572   public void mouseClicked(MouseEvent evt)
1573   {
1574     SequenceGroup sg = null;
1575     SequenceI sequence = av.getAlignment().getSequenceAt(findSeq(evt));
1576     if (evt.getClickCount() > 1)
1577     {
1578       sg = av.getSelectionGroup();
1579       if (sg != null && sg.getSize() == 1
1580               && sg.getEndRes() - sg.getStartRes() < 2)
1581       {
1582         av.setSelectionGroup(null);
1583       }
1584
1585       int column = findColumn(evt);
1586
1587       /*
1588        * find features at the position (if not gapped), or straddling
1589        * the position (if at a gap)
1590        */
1591       List<SequenceFeature> features = seqCanvas.getFeatureRenderer()
1592               .findFeaturesAtColumn(sequence, column + 1);
1593
1594       if (!features.isEmpty())
1595       {
1596         /*
1597          * highlight the first feature at the position on the alignment
1598          */
1599         SearchResultsI highlight = new SearchResults();
1600         highlight.addResult(sequence, features.get(0).getBegin(), features
1601                 .get(0).getEnd());
1602         seqCanvas.highlightSearchResults(highlight, false);
1603
1604         /*
1605          * open the Amend Features dialog; clear highlighting afterwards,
1606          * whether changes were made or not
1607          */
1608         List<SequenceI> seqs = Collections.singletonList(sequence);
1609         seqCanvas.getFeatureRenderer().amendFeatures(seqs, features, false,
1610                 ap);
1611         av.setSearchResults(null); // clear highlighting
1612         seqCanvas.repaint(); // draw new/amended features
1613       }
1614     }
1615   }
1616
1617   @Override
1618   public void mouseWheelMoved(MouseWheelEvent e)
1619   {
1620     e.consume();
1621     if (e.getWheelRotation() > 0)
1622     {
1623       if (e.isShiftDown())
1624       {
1625         av.getRanges().scrollRight(true);
1626
1627       }
1628       else
1629       {
1630         av.getRanges().scrollUp(false);
1631       }
1632     }
1633     else
1634     {
1635       if (e.isShiftDown())
1636       {
1637         av.getRanges().scrollRight(false);
1638       }
1639       else
1640       {
1641         av.getRanges().scrollUp(true);
1642       }
1643     }
1644     // TODO Update tooltip for new position.
1645   }
1646
1647   /**
1648    * DOCUMENT ME!
1649    *
1650    * @param evt
1651    *          DOCUMENT ME!
1652    */
1653   public void doMousePressedDefineMode(MouseEvent evt)
1654   {
1655     final int res = findColumn(evt);
1656     final int seq = findSeq(evt);
1657     oldSeq = seq;
1658     needOverviewUpdate = false;
1659
1660     startWrapBlock = wrappedBlock;
1661
1662     if (av.getWrapAlignment() && seq > av.getAlignment().getHeight())
1663     {
1664       JvOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
1665               .getString("label.cannot_edit_annotations_in_wrapped_view"),
1666               MessageManager.getString("label.wrapped_view_no_edit"),
1667               JvOptionPane.WARNING_MESSAGE);
1668       return;
1669     }
1670
1671     if (seq < 0 || res < 0)
1672     {
1673       return;
1674     }
1675
1676     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1677
1678     if ((sequence == null) || (res > sequence.getLength()))
1679     {
1680       return;
1681     }
1682
1683     stretchGroup = av.getSelectionGroup();
1684
1685     if (stretchGroup == null || !stretchGroup.contains(sequence, res))
1686     {
1687       stretchGroup = av.getAlignment().findGroup(sequence, res);
1688       if (stretchGroup != null)
1689       {
1690         // only update the current selection if the popup menu has a group to
1691         // focus on
1692         av.setSelectionGroup(stretchGroup);
1693       }
1694     }
1695
1696     if (evt.isPopupTrigger()) // Mac: mousePressed
1697     {
1698       showPopupMenu(evt);
1699       return;
1700     }
1701
1702     /*
1703      * defer right-mouse click handling to mouseReleased on Windows
1704      * (where isPopupTrigger() will answer true)
1705      * NB isRightMouseButton is also true for Cmd-click on Mac
1706      */
1707     if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
1708     {
1709       return;
1710     }
1711
1712     if (av.cursorMode)
1713     {
1714       seqCanvas.cursorX = findColumn(evt);
1715       seqCanvas.cursorY = findSeq(evt);
1716       seqCanvas.repaint();
1717       return;
1718     }
1719
1720     if (stretchGroup == null)
1721     {
1722       // Only if left mouse button do we want to change group sizes
1723
1724       // define a new group here
1725       SequenceGroup sg = new SequenceGroup();
1726       sg.setStartRes(res);
1727       sg.setEndRes(res);
1728       sg.addSequence(sequence, false);
1729       av.setSelectionGroup(sg);
1730       stretchGroup = sg;
1731
1732       if (av.getConservationSelected())
1733       {
1734         SliderPanel.setConservationSlider(ap, av.getResidueShading(),
1735                 ap.getViewName());
1736       }
1737
1738       if (av.getAbovePIDThreshold())
1739       {
1740         SliderPanel.setPIDSliderSource(ap, av.getResidueShading(),
1741                 ap.getViewName());
1742       }
1743       // TODO: stretchGroup will always be not null. Is this a merge error ?
1744       if ((stretchGroup != null) && (stretchGroup.getEndRes() == res))
1745       {
1746         // Edit end res position of selected group
1747         changeEndRes = true;
1748       }
1749       else if ((stretchGroup != null)
1750               && (stretchGroup.getStartRes() == res))
1751       {
1752         // Edit end res position of selected group
1753         changeStartRes = true;
1754       }
1755       stretchGroup.getWidth();
1756     }
1757
1758     seqCanvas.repaint();
1759   }
1760
1761   /**
1762    * Build and show a pop-up menu at the right-click mouse position
1763    *
1764    * @param evt
1765    * @param res
1766    * @param sequences
1767    */
1768   void showPopupMenu(MouseEvent evt)
1769   {
1770     final int column = findColumn(evt);
1771     final int seq = findSeq(evt);
1772     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1773     List<SequenceFeature> allFeatures = ap.getFeatureRenderer()
1774             .findFeaturesAtColumn(sequence, column + 1);
1775     List<String> links = new ArrayList<>();
1776     for (SequenceFeature sf : allFeatures)
1777     {
1778       if (sf.links != null)
1779       {
1780         for (String link : sf.links)
1781         {
1782           links.add(link);
1783         }
1784       }
1785     }
1786
1787     PopupMenu pop = new PopupMenu(ap, null, links);
1788     pop.show(this, evt.getX(), evt.getY());
1789   }
1790
1791   /**
1792    * Update the display after mouse up on a selection or group
1793    *
1794    * @param evt
1795    *          mouse released event details
1796    * @param afterDrag
1797    *          true if this event is happening after a mouse drag (rather than a
1798    *          mouse down)
1799    */
1800   public void doMouseReleasedDefineMode(MouseEvent evt, boolean afterDrag)
1801   {
1802     if (stretchGroup == null)
1803     {
1804       return;
1805     }
1806     // always do this - annotation has own state
1807     // but defer colourscheme update until hidden sequences are passed in
1808     boolean vischange = stretchGroup.recalcConservation(true);
1809     needOverviewUpdate |= vischange && av.isSelectionDefinedGroup()
1810             && afterDrag;
1811     if (stretchGroup.cs != null)
1812     {
1813       stretchGroup.cs.alignmentChanged(stretchGroup,
1814               av.getHiddenRepSequences());
1815
1816       ResidueShaderI groupColourScheme = stretchGroup.getGroupColourScheme();
1817       String name = stretchGroup.getName();
1818       if (stretchGroup.cs.conservationApplied())
1819       {
1820         SliderPanel.setConservationSlider(ap, groupColourScheme, name);
1821       }
1822       if (stretchGroup.cs.getThreshold() > 0)
1823       {
1824         SliderPanel.setPIDSliderSource(ap, groupColourScheme, name);
1825       }
1826     }
1827     PaintRefresher.Refresh(this, av.getSequenceSetId());
1828     ap.paintAlignment(needOverviewUpdate);
1829     needOverviewUpdate = false;
1830     changeEndRes = false;
1831     changeStartRes = false;
1832     stretchGroup = null;
1833     av.sendSelection();
1834   }
1835
1836   /**
1837    * DOCUMENT ME!
1838    *
1839    * @param evt
1840    *          DOCUMENT ME!
1841    */
1842   public void doMouseDraggedDefineMode(MouseEvent evt)
1843   {
1844     int res = findColumn(evt);
1845     int y = findSeq(evt);
1846
1847     if (wrappedBlock != startWrapBlock)
1848     {
1849       return;
1850     }
1851
1852     if (stretchGroup == null)
1853     {
1854       return;
1855     }
1856
1857     if (res >= av.getAlignment().getWidth())
1858     {
1859       res = av.getAlignment().getWidth() - 1;
1860     }
1861
1862     if (stretchGroup.getEndRes() == res)
1863     {
1864       // Edit end res position of selected group
1865       changeEndRes = true;
1866     }
1867     else if (stretchGroup.getStartRes() == res)
1868     {
1869       // Edit start res position of selected group
1870       changeStartRes = true;
1871     }
1872
1873     if (res < av.getRanges().getStartRes())
1874     {
1875       res = av.getRanges().getStartRes();
1876     }
1877
1878     if (changeEndRes)
1879     {
1880       if (res > (stretchGroup.getStartRes() - 1))
1881       {
1882         stretchGroup.setEndRes(res);
1883         needOverviewUpdate |= av.isSelectionDefinedGroup();
1884       }
1885     }
1886     else if (changeStartRes)
1887     {
1888       if (res < (stretchGroup.getEndRes() + 1))
1889       {
1890         stretchGroup.setStartRes(res);
1891         needOverviewUpdate |= av.isSelectionDefinedGroup();
1892       }
1893     }
1894
1895     int dragDirection = 0;
1896
1897     if (y > oldSeq)
1898     {
1899       dragDirection = 1;
1900     }
1901     else if (y < oldSeq)
1902     {
1903       dragDirection = -1;
1904     }
1905
1906     while ((y != oldSeq) && (oldSeq > -1)
1907             && (y < av.getAlignment().getHeight()))
1908     {
1909       // This routine ensures we don't skip any sequences, as the
1910       // selection is quite slow.
1911       Sequence seq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1912
1913       oldSeq += dragDirection;
1914
1915       if (oldSeq < 0)
1916       {
1917         break;
1918       }
1919
1920       Sequence nextSeq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1921
1922       if (stretchGroup.getSequences(null).contains(nextSeq))
1923       {
1924         stretchGroup.deleteSequence(seq, false);
1925         needOverviewUpdate |= av.isSelectionDefinedGroup();
1926       }
1927       else
1928       {
1929         if (seq != null)
1930         {
1931           stretchGroup.addSequence(seq, false);
1932         }
1933
1934         stretchGroup.addSequence(nextSeq, false);
1935         needOverviewUpdate |= av.isSelectionDefinedGroup();
1936       }
1937     }
1938
1939     if (oldSeq < 0)
1940     {
1941       oldSeq = -1;
1942     }
1943
1944     mouseDragging = true;
1945
1946     if (scrollThread != null)
1947     {
1948       scrollThread.setEvent(evt);
1949     }
1950
1951     seqCanvas.repaint();
1952   }
1953
1954   void scrollCanvas(MouseEvent evt)
1955   {
1956     if (evt == null)
1957     {
1958       if (scrollThread != null)
1959       {
1960         scrollThread.running = false;
1961         scrollThread = null;
1962       }
1963       mouseDragging = false;
1964     }
1965     else
1966     {
1967       if (scrollThread == null)
1968       {
1969         scrollThread = new ScrollThread();
1970       }
1971
1972       mouseDragging = true;
1973       scrollThread.setEvent(evt);
1974     }
1975
1976   }
1977
1978   // this class allows scrolling off the bottom of the visible alignment
1979   class ScrollThread extends Thread
1980   {
1981     MouseEvent evt;
1982
1983     boolean running = false;
1984
1985     public ScrollThread()
1986     {
1987       start();
1988     }
1989
1990     public void setEvent(MouseEvent e)
1991     {
1992       evt = e;
1993     }
1994
1995     public void stopScrolling()
1996     {
1997       running = false;
1998     }
1999
2000     @Override
2001     public void run()
2002     {
2003       running = true;
2004
2005       while (running)
2006       {
2007         if (evt != null)
2008         {
2009           if (mouseDragging && (evt.getY() < 0)
2010                   && (av.getRanges().getStartSeq() > 0))
2011           {
2012             running = av.getRanges().scrollUp(true);
2013           }
2014
2015           if (mouseDragging && (evt.getY() >= getHeight())
2016                   && (av.getAlignment().getHeight() > av.getRanges()
2017                           .getEndSeq()))
2018           {
2019             running = av.getRanges().scrollUp(false);
2020           }
2021
2022           if (mouseDragging && (evt.getX() < 0))
2023           {
2024             running = av.getRanges().scrollRight(false);
2025           }
2026           else if (mouseDragging && (evt.getX() >= getWidth()))
2027           {
2028             running = av.getRanges().scrollRight(true);
2029           }
2030         }
2031
2032         try
2033         {
2034           Thread.sleep(20);
2035         } catch (Exception ex)
2036         {
2037         }
2038       }
2039     }
2040   }
2041
2042   /**
2043    * modify current selection according to a received message.
2044    */
2045   @Override
2046   public void selection(SequenceGroup seqsel, ColumnSelection colsel,
2047           HiddenColumns hidden, SelectionSource source)
2048   {
2049     // TODO: fix this hack - source of messages is align viewport, but SeqPanel
2050     // handles selection messages...
2051     // TODO: extend config options to allow user to control if selections may be
2052     // shared between viewports.
2053     boolean iSentTheSelection = (av == source || (source instanceof AlignViewport && ((AlignmentViewport) source)
2054             .getSequenceSetId().equals(av.getSequenceSetId())));
2055
2056     if (iSentTheSelection)
2057     {
2058       // respond to our own event by updating dependent dialogs
2059       if (ap.getCalculationDialog() != null)
2060       {
2061         ap.getCalculationDialog().validateCalcTypes();
2062       }
2063
2064       return;
2065     }
2066
2067     // process further ?
2068     if (!av.followSelection)
2069     {
2070       return;
2071     }
2072
2073     /*
2074      * Ignore the selection if there is one of our own pending.
2075      */
2076     if (av.isSelectionGroupChanged(false) || av.isColSelChanged(false))
2077     {
2078       return;
2079     }
2080
2081     /*
2082      * Check for selection in a view of which this one is a dna/protein
2083      * complement.
2084      */
2085     if (selectionFromTranslation(seqsel, colsel, hidden, source))
2086     {
2087       return;
2088     }
2089
2090     // do we want to thread this ? (contention with seqsel and colsel locks, I
2091     // suspect)
2092     /*
2093      * only copy colsel if there is a real intersection between
2094      * sequence selection and this panel's alignment
2095      */
2096     boolean repaint = false;
2097     boolean copycolsel = false;
2098
2099     SequenceGroup sgroup = null;
2100     if (seqsel != null && seqsel.getSize() > 0)
2101     {
2102       if (av.getAlignment() == null)
2103       {
2104         Cache.log.warn("alignviewport av SeqSetId=" + av.getSequenceSetId()
2105                 + " ViewId=" + av.getViewId()
2106                 + " 's alignment is NULL! returning immediately.");
2107         return;
2108       }
2109       sgroup = seqsel.intersect(av.getAlignment(),
2110               (av.hasHiddenRows()) ? av.getHiddenRepSequences() : null);
2111       if ((sgroup != null && sgroup.getSize() > 0))
2112       {
2113         copycolsel = true;
2114       }
2115     }
2116     if (sgroup != null && sgroup.getSize() > 0)
2117     {
2118       av.setSelectionGroup(sgroup);
2119     }
2120     else
2121     {
2122       av.setSelectionGroup(null);
2123     }
2124     av.isSelectionGroupChanged(true);
2125     repaint = true;
2126
2127     if (copycolsel)
2128     {
2129       // the current selection is unset or from a previous message
2130       // so import the new colsel.
2131       if (colsel == null || colsel.isEmpty())
2132       {
2133         if (av.getColumnSelection() != null)
2134         {
2135           av.getColumnSelection().clear();
2136           repaint = true;
2137         }
2138       }
2139       else
2140       {
2141         // TODO: shift colSel according to the intersecting sequences
2142         if (av.getColumnSelection() == null)
2143         {
2144           av.setColumnSelection(new ColumnSelection(colsel));
2145         }
2146         else
2147         {
2148           av.getColumnSelection().setElementsFrom(colsel,
2149                   av.getAlignment().getHiddenColumns());
2150         }
2151       }
2152       av.isColSelChanged(true);
2153       repaint = true;
2154     }
2155
2156     if (copycolsel
2157             && av.hasHiddenColumns()
2158             && (av.getAlignment().getHiddenColumns() == null))
2159     {
2160       System.err.println("Bad things");
2161     }
2162     if (repaint) // always true!
2163     {
2164       // probably finessing with multiple redraws here
2165       PaintRefresher.Refresh(this, av.getSequenceSetId());
2166       // ap.paintAlignment(false);
2167     }
2168
2169     // lastly, update dependent dialogs
2170     if (ap.getCalculationDialog() != null)
2171     {
2172       ap.getCalculationDialog().validateCalcTypes();
2173     }
2174
2175   }
2176
2177   /**
2178    * If this panel is a cdna/protein translation view of the selection source,
2179    * tries to map the source selection to a local one, and returns true. Else
2180    * returns false.
2181    *
2182    * @param seqsel
2183    * @param colsel
2184    * @param source
2185    */
2186   protected boolean selectionFromTranslation(SequenceGroup seqsel,
2187           ColumnSelection colsel, HiddenColumns hidden,
2188           SelectionSource source)
2189   {
2190     if (!(source instanceof AlignViewportI))
2191     {
2192       return false;
2193     }
2194     final AlignViewportI sourceAv = (AlignViewportI) source;
2195     if (sourceAv.getCodingComplement() != av
2196             && av.getCodingComplement() != sourceAv)
2197     {
2198       return false;
2199     }
2200
2201     /*
2202      * Map sequence selection
2203      */
2204     SequenceGroup sg = MappingUtils.mapSequenceGroup(seqsel, sourceAv, av);
2205     av.setSelectionGroup(sg);
2206     av.isSelectionGroupChanged(true);
2207
2208     /*
2209      * Map column selection
2210      */
2211     // ColumnSelection cs = MappingUtils.mapColumnSelection(colsel, sourceAv,
2212     // av);
2213     ColumnSelection cs = new ColumnSelection();
2214     HiddenColumns hs = new HiddenColumns();
2215     MappingUtils.mapColumnSelection(colsel, hidden, sourceAv, av, cs, hs);
2216     av.setColumnSelection(cs);
2217     av.getAlignment().setHiddenColumns(hs);
2218
2219     // lastly, update any dependent dialogs
2220     if (ap.getCalculationDialog() != null)
2221     {
2222       ap.getCalculationDialog().validateCalcTypes();
2223     }
2224
2225     PaintRefresher.Refresh(this, av.getSequenceSetId());
2226
2227     return true;
2228   }
2229 }