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.LABEL_WEST;
 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               av);
 411     }
 412     setStatusMessage(av.getAlignment().getSequenceAt(seqCanvas.cursorY),
 413             seqCanvas.cursorX, seqCanvas.cursorY);
 414
 415     seqCanvas.repaint();
 416   }
 417
 418   void setSelectionAreaAtCursor(boolean topLeft)
 419   {
 420     SequenceI sequence = av.getAlignment().getSequenceAt(seqCanvas.cursorY);
 421
 422     if (av.getSelectionGroup() != null)
 423     {
 424       SequenceGroup sg = av.getSelectionGroup();
 425       // Find the top and bottom of this group
 426       int min = av.getAlignment().getHeight(), max = 0;
 427       for (int i = 0; i < sg.getSize(); i++)
 428       {
 429         int index = av.getAlignment().findIndex(sg.getSequenceAt(i));
 430         if (index > max)
 431         {
 432           max = index;
 433         }
 434         if (index < min)
 435         {
 436           min = index;
 437         }
 438       }
 439
 440       max++;
 441
 442       if (topLeft)
 443       {
 444         sg.setStartRes(seqCanvas.cursorX);
 445         if (sg.getEndRes() < seqCanvas.cursorX)
 446         {
 447           sg.setEndRes(seqCanvas.cursorX);
 448         }
 449
 450         min = seqCanvas.cursorY;
 451       }
 452       else
 453       {
 454         sg.setEndRes(seqCanvas.cursorX);
 455         if (sg.getStartRes() > seqCanvas.cursorX)
 456         {
 457           sg.setStartRes(seqCanvas.cursorX);
 458         }
 459
 460         max = seqCanvas.cursorY + 1;
 461       }
 462
 463       if (min > max)
 464       {
 465         // Only the user can do this
 466         av.setSelectionGroup(null);
 467       }
 468       else
 469       {
 470         // Now add any sequences between min and max
 471         sg.getSequences(null).clear();
 472         for (int i = min; i < max; i++)
 473         {
 474           sg.addSequence(av.getAlignment().getSequenceAt(i), false);
 475         }
 476       }
 477     }
 478
 479     if (av.getSelectionGroup() == null)
 480     {
 481       SequenceGroup sg = new SequenceGroup();
 482       sg.setStartRes(seqCanvas.cursorX);
 483       sg.setEndRes(seqCanvas.cursorX);
 484       sg.addSequence(sequence, false);
 485       av.setSelectionGroup(sg);
 486     }
 487
 488     ap.paintAlignment(false);
 489     av.sendSelection();
 490   }
 491
 492   void insertGapAtCursor(boolean group)
 493   {
 494     groupEditing = group;
 495     startseq = seqCanvas.cursorY;
 496     lastres = seqCanvas.cursorX;
 497     editSequence(true, false, seqCanvas.cursorX + getKeyboardNo1());
 498     endEditing();
 499   }
 500
 501   void deleteGapAtCursor(boolean group)
 502   {
 503     groupEditing = group;
 504     startseq = seqCanvas.cursorY;
 505     lastres = seqCanvas.cursorX + getKeyboardNo1();
 506     editSequence(false, false, seqCanvas.cursorX);
 507     endEditing();
 508   }
 509
 510   void insertNucAtCursor(boolean group, String nuc)
 511   {
 512     // TODO not called - delete?
 513     groupEditing = group;
 514     startseq = seqCanvas.cursorY;
 515     lastres = seqCanvas.cursorX;
 516     editSequence(false, true, seqCanvas.cursorX + getKeyboardNo1());
 517     endEditing();
 518   }
 519
 520   void numberPressed(char value)
 521   {
 522     if (keyboardNo1 == null)
 523     {
 524       keyboardNo1 = new StringBuffer();
 525     }
 526
 527     if (keyboardNo2 != null)
 528     {
 529       keyboardNo2.append(value);
 530     }
 531     else
 532     {
 533       keyboardNo1.append(value);
 534     }
 535   }
 536
 537   int getKeyboardNo1()
 538   {
 539     try
 540     {
 541       if (keyboardNo1 != null)
 542       {
 543         int value = Integer.parseInt(keyboardNo1.toString());
 544         keyboardNo1 = null;
 545         return value;
 546       }
 547     } catch (Exception x)
 548     {
 549     }
 550     keyboardNo1 = null;
 551     return 1;
 552   }
 553
 554   int getKeyboardNo2()
 555   {
 556     try
 557     {
 558       if (keyboardNo2 != null)
 559       {
 560         int value = Integer.parseInt(keyboardNo2.toString());
 561         keyboardNo2 = null;
 562         return value;
 563       }
 564     } catch (Exception x)
 565     {
 566     }
 567     keyboardNo2 = null;
 568     return 1;
 569   }
 570
 571   /**
 572    * DOCUMENT ME!
 573    *
 574    * @param evt
 575    *          DOCUMENT ME!
 576    */
 577   @Override
 578   public void mouseReleased(MouseEvent evt)
 579   {
 580     boolean didDrag = mouseDragging; // did we come here after a drag
 581     mouseDragging = false;
 582     mouseWheelPressed = false;
 583
 584     if (evt.isPopupTrigger()) // Windows: mouseReleased
 585     {
 586       showPopupMenu(evt);
 587       evt.consume();
 588       return;
 589     }
 590
 591     if (!editingSeqs)
 592     {
 593       doMouseReleasedDefineMode(evt, didDrag);
 594       return;
 595     }
 596
 597     endEditing();
 598   }
 599
 600   /**
 601    * DOCUMENT ME!
 602    *
 603    * @param evt
 604    *          DOCUMENT ME!
 605    */
 606   @Override
 607   public void mousePressed(MouseEvent evt)
 608   {
 609     lastMousePress = evt.getPoint();
 610
 611     if (SwingUtilities.isMiddleMouseButton(evt))
 612     {
 613       mouseWheelPressed = true;
 614       return;
 615     }
 616
 617     boolean isControlDown = Platform.isControlDown(evt);
 618     if (evt.isShiftDown() || isControlDown)
 619     {
 620       editingSeqs = true;
 621       if (isControlDown)
 622       {
 623         groupEditing = true;
 624       }
 625     }
 626     else
 627     {
 628       doMousePressedDefineMode(evt);
 629       return;
 630     }
 631
 632     int seq = findSeq(evt);
 633     int res = findColumn(evt);
 634
 635     if (seq < 0 || res < 0)
 636     {
 637       return;
 638     }
 639
 640     if ((seq < av.getAlignment().getHeight())
 641             && (res < av.getAlignment().getSequenceAt(seq).getLength()))
 642     {
 643       startseq = seq;
 644       lastres = res;
 645     }
 646     else
 647     {
 648       startseq = -1;
 649       lastres = -1;
 650     }
 651
 652     return;
 653   }
 654
 655   String lastMessage;
 656
 657   @Override
 658   public void mouseOverSequence(SequenceI sequence, int index, int pos)
 659   {
 660     String tmp = sequence.hashCode() + " " + index + " " + pos;
 661
 662     if (lastMessage == null || !lastMessage.equals(tmp))
 663     {
 664       // System.err.println("mouseOver Sequence: "+tmp);
 665       ssm.mouseOverSequence(sequence, index, pos, av);
 666     }
 667     lastMessage = tmp;
 668   }
 669
 670   /**
 671    * Highlight the mapped region described by the search results object (unless
 672    * unchanged). This supports highlight of protein while mousing over linked
 673    * cDNA and vice versa. The status bar is also updated to show the location of
 674    * the start of the highlighted region.
 675    */
 676   @Override
 677   public void highlightSequence(SearchResultsI results)
 678   {
 679     if (results == null || results.equals(lastSearchResults))
 680     {
 681       return;
 682     }
 683     lastSearchResults = results;
 684
 685     if (av.isFollowHighlight())
 686     {
 687       // don't allow highlight of protein/cDNA to also scroll a complementary
 688       // panel,as this sets up a feedback loop (scrolling panel 1 causes moused
 689       // over residue to change abruptly, causing highlighted residue in panel 2
 690       // to change, causing a scroll in panel 1 etc)
 691       ap.setToScrollComplementPanel(false);
 692       if (ap.scrollToPosition(results, false))
 693       {
 694         seqCanvas.revalidate();
 695       }
 696       ap.setToScrollComplementPanel(true);
 697     }
 698     setStatusMessage(results);
 699     seqCanvas.highlightSearchResults(results);
 700   }
 701
 702   @Override
 703   public VamsasSource getVamsasSource()
 704   {
 705     return this.ap == null ? null : this.ap.av;
 706   }
 707
 708   @Override
 709   public void updateColours(SequenceI seq, int index)
 710   {
 711     System.out.println("update the seqPanel colours");
 712     // repaint();
 713   }
 714
 715   /**
 716    * DOCUMENT ME!
 717    *
 718    * @param evt
 719    *          DOCUMENT ME!
 720    */
 721   @Override
 722   public void mouseMoved(MouseEvent evt)
 723   {
 724     if (editingSeqs)
 725     {
 726       // This is because MacOSX creates a mouseMoved
 727       // If control is down, other platforms will not.
 728       mouseDragged(evt);
 729     }
 730
 731     final int column = findColumn(evt);
 732     int seq = findSeq(evt);
 733     if (column < 0 || seq < 0 || seq >= av.getAlignment().getHeight())
 734     {
 735       lastMouseSeq = -1;
 736       return;
 737     }
 738     if (column == lastMouseColumn && seq == lastMouseSeq)
 739     {
 740       /*
 741        * just a pixel move without change of residue
 742        */
 743       return;
 744     }
 745     lastMouseColumn = column;
 746     lastMouseSeq = seq;
 747
 748     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
 749
 750     if (column >= sequence.getLength())
 751     {
 752       return;
 753     }
 754
 755     /*
 756      * set status bar message, returning residue position in sequence
 757      */
 758     boolean isGapped = Comparison.isGap(sequence.getCharAt(column));
 759     final int pos = setStatusMessage(sequence, column, seq);
 760     if (ssm != null && !isGapped)
 761     {
 762       mouseOverSequence(sequence, column, pos);
 763     }
 764
 765     tooltipText.setLength(6); // Cuts the buffer back to <html>
 766
 767     SequenceGroup[] groups = av.getAlignment().findAllGroups(sequence);
 768     if (groups != null)
 769     {
 770       for (int g = 0; g < groups.length; g++)
 771       {
 772         if (groups[g].getStartRes() <= column
 773                 && groups[g].getEndRes() >= column)
 774         {
 775           if (!groups[g].getName().startsWith("JTreeGroup")
 776                   && !groups[g].getName().startsWith("JGroup"))
 777           {
 778             tooltipText.append(groups[g].getName());
 779           }
 780
 781           if (groups[g].getDescription() != null)
 782           {
 783             tooltipText.append(": " + groups[g].getDescription());
 784           }
 785         }
 786       }
 787     }
 788
 789     /*
 790      * add any features at the position to the tooltip; if over a gap, only
 791      * add features that straddle the gap (pos may be the residue before or
 792      * after the gap)
 793      */
 794     if (av.isShowSequenceFeatures())
 795     {
 796       List<SequenceFeature> features = ap.getFeatureRenderer()
 797               .findFeaturesAtColumn(sequence, column + 1);
 798       seqARep.appendFeatures(tooltipText, pos, features,
 799               this.ap.getSeqPanel().seqCanvas.fr.getMinMax());
 800     }
 801     if (tooltipText.length() == 6) // <html>
 802     {
 803       setToolTipText(null);
 804       lastTooltip = null;
 805     }
 806     else
 807     {
 808       String textString = tooltipText.toString();
 809       if (lastTooltip == null || !lastTooltip.equals(textString))
 810       {
 811         String formattedTooltipText = JvSwingUtils.wrapTooltip(true,
 812                 textString);
 813         setToolTipText(formattedTooltipText);
 814         lastTooltip = textString;
 815       }
 816     }
 817   }
 818
 819   private Point lastp = null;
 820
 821   /*
 822    * (non-Javadoc)
 823    *
 824    * @see javax.swing.JComponent#getToolTipLocation(java.awt.event.MouseEvent)
 825    */
 826   @Override
 827   public Point getToolTipLocation(MouseEvent event)
 828   {
 829     int x = event.getX(), w = getWidth();
 830     int wdth = (w - x < 200) ? -(w / 2) : 5; // switch sides when tooltip is too
 831     // close to edge
 832     Point p = lastp;
 833     if (!event.isShiftDown() || p == null)
 834     {
 835       p = (tooltipText != null && tooltipText.length() > 6) ? new Point(
 836               event.getX() + wdth, event.getY() - 20) : null;
 837     }
 838     /*
 839      * TODO: try to modify position region is not obcured by tooltip
 840      */
 841     return lastp = p;
 842   }
 843
 844   String lastTooltip;
 845
 846   /**
 847    * set when the current UI interaction has resulted in a change that requires
 848    * overview shading to be recalculated. this could be changed to something
 849    * more expressive that indicates what actually has changed, so selective
 850    * redraws can be applied
 851    */
 852   private boolean needOverviewUpdate = false; // TODO: refactor to avcontroller
 853
 854   /**
 855    * set if av.getSelectionGroup() refers to a group that is defined on the
 856    * alignment view, rather than a transient selection
 857    */
 858   // private boolean editingDefinedGroup = false; // TODO: refactor to
 859   // avcontroller or viewModel
 860
 861   /**
 862    * Sets the status message in alignment panel, showing the sequence number
 863    * (index) and id, and residue and residue position if not at a gap, for the
 864    * given sequence and column position. Returns the residue position returned
 865    * by Sequence.findPosition. Note this may be for the nearest adjacent residue
 866    * if at a gapped position.
 867    *
 868    * @param sequence
 869    *          aligned sequence object
 870    * @param column
 871    *          alignment column
 872    * @param seq
 873    *          index of sequence in alignment
 874    * @return sequence position of residue at column, or adjacent residue if at a
 875    *         gap
 876    */
 877   int setStatusMessage(SequenceI sequence, final int column, int seq)
 878   {
 879     StringBuilder text = new StringBuilder(32);
 880
 881     /*
 882      * Sequence number (if known), and sequence name.
 883      */
 884     String seqno = seq == -1 ? "" : " " + (seq + 1);
 885     text.append("Sequence").append(seqno).append(" ID: ")
 886             .append(sequence.getName());
 887
 888     String residue = null;
 889
 890     /*
 891      * Try to translate the display character to residue name (null for gap).
 892      */
 893     final String displayChar = String.valueOf(sequence.getCharAt(column));
 894     boolean isGapped = Comparison.isGap(sequence.getCharAt(column));
 895     int pos = sequence.findPosition(column);
 896
 897     if (!isGapped)
 898     {
 899       boolean nucleotide = av.getAlignment().isNucleotide();
 900       if (nucleotide)
 901       {
 902         residue = ResidueProperties.nucleotideName.get(displayChar);
 903       }
 904       else
 905       {
 906         residue = "X".equalsIgnoreCase(displayChar) ? "X" : ("*"
 907                 .equals(displayChar) ? "STOP"
 908                 : ResidueProperties.aa2Triplet.get(displayChar));
 909       }
 910       text.append(" ").append(nucleotide ? "Nucleotide" : "Residue")
 911               .append(": ").append(residue == null ? displayChar : residue);
 912
 913       text.append(" (").append(Integer.toString(pos)).append(")");
 914     }
 915     ap.alignFrame.statusBar.setText(text.toString());
 916
 917     return pos;
 918   }
 919
 920   /**
 921    * Set the status bar message to highlight the first matched position in
 922    * search results.
 923    *
 924    * @param results
 925    */
 926   private void setStatusMessage(SearchResultsI results)
 927   {
 928     AlignmentI al = this.av.getAlignment();
 929     int sequenceIndex = al.findIndex(results);
 930     if (sequenceIndex == -1)
 931     {
 932       return;
 933     }
 934     SequenceI ds = al.getSequenceAt(sequenceIndex).getDatasetSequence();
 935     for (SearchResultMatchI m : results.getResults())
 936     {
 937       SequenceI seq = m.getSequence();
 938       if (seq.getDatasetSequence() != null)
 939       {
 940         seq = seq.getDatasetSequence();
 941       }
 942
 943       if (seq == ds)
 944       {
 945         /*
 946          * Convert position in sequence (base 1) to sequence character array
 947          * index (base 0)
 948          */
 949         int start = m.getStart() - m.getSequence().getStart();
 950         setStatusMessage(seq, start, sequenceIndex);
 951         return;
 952       }
 953     }
 954   }
 955
 956   /**
 957    * {@inheritDoc}
 958    */
 959   @Override
 960   public void mouseDragged(MouseEvent evt)
 961   {
 962     if (mouseWheelPressed)
 963     {
 964       boolean inSplitFrame = ap.av.getCodingComplement() != null;
 965       boolean copyChanges = inSplitFrame && av.isProteinFontAsCdna();
 966
 967       int oldWidth = av.getCharWidth();
 968
 969       // Which is bigger, left-right or up-down?
 970       if (Math.abs(evt.getY() - lastMousePress.getY()) > Math.abs(evt
 971               .getX() - lastMousePress.getX()))
 972       {
 973         /*
 974          * on drag up or down, decrement or increment font size
 975          */
 976         int fontSize = av.font.getSize();
 977         boolean fontChanged = false;
 978
 979         if (evt.getY() < lastMousePress.getY())
 980         {
 981           fontChanged = true;
 982           fontSize--;
 983         }
 984         else if (evt.getY() > lastMousePress.getY())
 985         {
 986           fontChanged = true;
 987           fontSize++;
 988         }
 989
 990         if (fontSize < 1)
 991         {
 992           fontSize = 1;
 993         }
 994
 995         if (fontChanged)
 996         {
 997           Font newFont = new Font(av.font.getName(), av.font.getStyle(),
 998                   fontSize);
 999           av.setFont(newFont, true);
1000           av.setCharWidth(oldWidth);
1001           ap.fontChanged();
1002           if (copyChanges)
1003           {
1004             ap.av.getCodingComplement().setFont(newFont, true);
1005             SplitFrame splitFrame = (SplitFrame) ap.alignFrame
1006                     .getSplitViewContainer();
1007             splitFrame.adjustLayout();
1008             splitFrame.repaint();
1009           }
1010         }
1011       }
1012       else
1013       {
1014         /*
1015          * on drag left or right, decrement or increment character width
1016          */
1017         int newWidth = 0;
1018         if (evt.getX() < lastMousePress.getX() && av.getCharWidth() > 1)
1019         {
1020           newWidth = av.getCharWidth() - 1;
1021           av.setCharWidth(newWidth);
1022         }
1023         else if (evt.getX() > lastMousePress.getX())
1024         {
1025           newWidth = av.getCharWidth() + 1;
1026           av.setCharWidth(newWidth);
1027         }
1028         if (newWidth > 0)
1029         {
1030           ap.paintAlignment(false);
1031           if (copyChanges)
1032           {
1033             /*
1034              * need to ensure newWidth is set on cdna, regardless of which
1035              * panel the mouse drag happened in; protein will compute its
1036              * character width as 1:1 or 3:1
1037              */
1038             av.getCodingComplement().setCharWidth(newWidth);
1039             SplitFrame splitFrame = (SplitFrame) ap.alignFrame
1040                     .getSplitViewContainer();
1041             splitFrame.adjustLayout();
1042             splitFrame.repaint();
1043           }
1044         }
1045       }
1046
1047       FontMetrics fm = getFontMetrics(av.getFont());
1048       av.validCharWidth = fm.charWidth('M') <= av.getCharWidth();
1049
1050       lastMousePress = evt.getPoint();
1051
1052       return;
1053     }
1054
1055     if (!editingSeqs)
1056     {
1057       doMouseDraggedDefineMode(evt);
1058       return;
1059     }
1060
1061     int res = findColumn(evt);
1062
1063     if (res < 0)
1064     {
1065       res = 0;
1066     }
1067
1068     if ((lastres == -1) || (lastres == res))
1069     {
1070       return;
1071     }
1072
1073     if ((res < av.getAlignment().getWidth()) && (res < lastres))
1074     {
1075       // dragLeft, delete gap
1076       editSequence(false, false, res);
1077     }
1078     else
1079     {
1080       editSequence(true, false, res);
1081     }
1082
1083     mouseDragging = true;
1084     if (scrollThread != null)
1085     {
1086       scrollThread.setEvent(evt);
1087     }
1088   }
1089
1090   // TODO: Make it more clever than many booleans
1091   synchronized void editSequence(boolean insertGap, boolean editSeq,
1092           int startres)
1093   {
1094     int fixedLeft = -1;
1095     int fixedRight = -1;
1096     boolean fixedColumns = false;
1097     SequenceGroup sg = av.getSelectionGroup();
1098
1099     SequenceI seq = av.getAlignment().getSequenceAt(startseq);
1100
1101     // No group, but the sequence may represent a group
1102     if (!groupEditing && av.hasHiddenRows())
1103     {
1104       if (av.isHiddenRepSequence(seq))
1105       {
1106         sg = av.getRepresentedSequences(seq);
1107         groupEditing = true;
1108       }
1109     }
1110
1111     StringBuilder message = new StringBuilder(64);
1112     if (groupEditing)
1113     {
1114       message.append("Edit group:");
1115       if (editCommand == null)
1116       {
1117         editCommand = new EditCommand(
1118                 MessageManager.getString("action.edit_group"));
1119       }
1120     }
1121     else
1122     {
1123       message.append("Edit sequence: " + seq.getName());
1124       String label = seq.getName();
1125       if (label.length() > 10)
1126       {
1127         label = label.substring(0, 10);
1128       }
1129       if (editCommand == null)
1130       {
1131         editCommand = new EditCommand(MessageManager.formatMessage(
1132                 "label.edit_params", new String[] { label }));
1133       }
1134     }
1135
1136     if (insertGap)
1137     {
1138       message.append(" insert ");
1139     }
1140     else
1141     {
1142       message.append(" delete ");
1143     }
1144
1145     message.append(Math.abs(startres - lastres) + " gaps.");
1146     ap.alignFrame.statusBar.setText(message.toString());
1147
1148     // Are we editing within a selection group?
1149     if (groupEditing
1150             || (sg != null && sg.getSequences(av.getHiddenRepSequences())
1151                     .contains(seq)))
1152     {
1153       fixedColumns = true;
1154
1155       // sg might be null as the user may only see 1 sequence,
1156       // but the sequence represents a group
1157       if (sg == null)
1158       {
1159         if (!av.isHiddenRepSequence(seq))
1160         {
1161           endEditing();
1162           return;
1163         }
1164         sg = av.getRepresentedSequences(seq);
1165       }
1166
1167       fixedLeft = sg.getStartRes();
1168       fixedRight = sg.getEndRes();
1169
1170       if ((startres < fixedLeft && lastres >= fixedLeft)
1171               || (startres >= fixedLeft && lastres < fixedLeft)
1172               || (startres > fixedRight && lastres <= fixedRight)
1173               || (startres <= fixedRight && lastres > fixedRight))
1174       {
1175         endEditing();
1176         return;
1177       }
1178
1179       if (fixedLeft > startres)
1180       {
1181         fixedRight = fixedLeft - 1;
1182         fixedLeft = 0;
1183       }
1184       else if (fixedRight < startres)
1185       {
1186         fixedLeft = fixedRight;
1187         fixedRight = -1;
1188       }
1189     }
1190
1191     if (av.hasHiddenColumns())
1192     {
1193       fixedColumns = true;
1194       int y1 = av.getAlignment().getHiddenColumns()
1195               .getHiddenBoundaryLeft(startres);
1196       int y2 = av.getAlignment().getHiddenColumns()
1197               .getHiddenBoundaryRight(startres);
1198
1199       if ((insertGap && startres > y1 && lastres < y1)
1200               || (!insertGap && startres < y2 && lastres > y2))
1201       {
1202         endEditing();
1203         return;
1204       }
1205
1206       // System.out.print(y1+" "+y2+" "+fixedLeft+" "+fixedRight+"~~");
1207       // Selection spans a hidden region
1208       if (fixedLeft < y1 && (fixedRight > y2 || fixedRight == -1))
1209       {
1210         if (startres >= y2)
1211         {
1212           fixedLeft = y2;
1213         }
1214         else
1215         {
1216           fixedRight = y2 - 1;
1217         }
1218       }
1219     }
1220
1221     if (groupEditing)
1222     {
1223       List<SequenceI> vseqs = sg.getSequences(av.getHiddenRepSequences());
1224       int g, groupSize = vseqs.size();
1225       SequenceI[] groupSeqs = new SequenceI[groupSize];
1226       for (g = 0; g < groupSeqs.length; g++)
1227       {
1228         groupSeqs[g] = vseqs.get(g);
1229       }
1230
1231       // drag to right
1232       if (insertGap)
1233       {
1234         // If the user has selected the whole sequence, and is dragging to
1235         // the right, we can still extend the alignment and selectionGroup
1236         if (sg.getStartRes() == 0 && sg.getEndRes() == fixedRight
1237                 && sg.getEndRes() == av.getAlignment().getWidth() - 1)
1238         {
1239           sg.setEndRes(av.getAlignment().getWidth() + startres - lastres);
1240           fixedRight = sg.getEndRes();
1241         }
1242
1243         // Is it valid with fixed columns??
1244         // Find the next gap before the end
1245         // of the visible region boundary
1246         boolean blank = false;
1247         for (fixedRight = fixedRight; fixedRight > lastres; fixedRight--)
1248         {
1249           blank = true;
1250
1251           for (g = 0; g < groupSize; g++)
1252           {
1253             for (int j = 0; j < startres - lastres; j++)
1254             {
1255               if (!Comparison.isGap(groupSeqs[g].getCharAt(fixedRight - j)))
1256               {
1257                 blank = false;
1258                 break;
1259               }
1260             }
1261           }
1262           if (blank)
1263           {
1264             break;
1265           }
1266         }
1267
1268         if (!blank)
1269         {
1270           if (sg.getSize() == av.getAlignment().getHeight())
1271           {
1272             if ((av.hasHiddenColumns() && startres < av.getAlignment()
1273                     .getHiddenColumns().getHiddenBoundaryRight(startres)))
1274             {
1275               endEditing();
1276               return;
1277             }
1278
1279             int alWidth = av.getAlignment().getWidth();
1280             if (av.hasHiddenRows())
1281             {
1282               int hwidth = av.getAlignment().getHiddenSequences()
1283                       .getWidth();
1284               if (hwidth > alWidth)
1285               {
1286                 alWidth = hwidth;
1287               }
1288             }
1289             // We can still insert gaps if the selectionGroup
1290             // contains all the sequences
1291             sg.setEndRes(sg.getEndRes() + startres - lastres);
1292             fixedRight = alWidth + startres - lastres;
1293           }
1294           else
1295           {
1296             endEditing();
1297             return;
1298           }
1299         }
1300       }
1301
1302       // drag to left
1303       else if (!insertGap)
1304       {
1305         // / Are we able to delete?
1306         // ie are all columns blank?
1307
1308         for (g = 0; g < groupSize; g++)
1309         {
1310           for (int j = startres; j < lastres; j++)
1311           {
1312             if (groupSeqs[g].getLength() <= j)
1313             {
1314               continue;
1315             }
1316
1317             if (!Comparison.isGap(groupSeqs[g].getCharAt(j)))
1318             {
1319               // Not a gap, block edit not valid
1320               endEditing();
1321               return;
1322             }
1323           }
1324         }
1325       }
1326
1327       if (insertGap)
1328       {
1329         // dragging to the right
1330         if (fixedColumns && fixedRight != -1)
1331         {
1332           for (int j = lastres; j < startres; j++)
1333           {
1334             insertChar(j, groupSeqs, fixedRight);
1335           }
1336         }
1337         else
1338         {
1339           appendEdit(Action.INSERT_GAP, groupSeqs, startres, startres
1340                   - lastres);
1341         }
1342       }
1343       else
1344       {
1345         // dragging to the left
1346         if (fixedColumns && fixedRight != -1)
1347         {
1348           for (int j = lastres; j > startres; j--)
1349           {
1350             deleteChar(startres, groupSeqs, fixedRight);
1351           }
1352         }
1353         else
1354         {
1355           appendEdit(Action.DELETE_GAP, groupSeqs, startres, lastres
1356                   - startres);
1357         }
1358
1359       }
1360     }
1361     else
1362     // ///Editing a single sequence///////////
1363     {
1364       if (insertGap)
1365       {
1366         // dragging to the right
1367         if (fixedColumns && fixedRight != -1)
1368         {
1369           for (int j = lastres; j < startres; j++)
1370           {
1371             insertChar(j, new SequenceI[] { seq }, fixedRight);
1372           }
1373         }
1374         else
1375         {
1376           appendEdit(Action.INSERT_GAP, new SequenceI[] { seq }, lastres,
1377                   startres - lastres);
1378         }
1379       }
1380       else
1381       {
1382         if (!editSeq)
1383         {
1384           // dragging to the left
1385           if (fixedColumns && fixedRight != -1)
1386           {
1387             for (int j = lastres; j > startres; j--)
1388             {
1389               if (!Comparison.isGap(seq.getCharAt(startres)))
1390               {
1391                 endEditing();
1392                 break;
1393               }
1394               deleteChar(startres, new SequenceI[] { seq }, fixedRight);
1395             }
1396           }
1397           else
1398           {
1399             // could be a keyboard edit trying to delete none gaps
1400             int max = 0;
1401             for (int m = startres; m < lastres; m++)
1402             {
1403               if (!Comparison.isGap(seq.getCharAt(m)))
1404               {
1405                 break;
1406               }
1407               max++;
1408             }
1409
1410             if (max > 0)
1411             {
1412               appendEdit(Action.DELETE_GAP, new SequenceI[] { seq },
1413                       startres, max);
1414             }
1415           }
1416         }
1417         else
1418         {// insertGap==false AND editSeq==TRUE;
1419           if (fixedColumns && fixedRight != -1)
1420           {
1421             for (int j = lastres; j < startres; j++)
1422             {
1423               insertChar(j, new SequenceI[] { seq }, fixedRight);
1424             }
1425           }
1426           else
1427           {
1428             appendEdit(Action.INSERT_NUC, new SequenceI[] { seq }, lastres,
1429                     startres - lastres);
1430           }
1431         }
1432       }
1433     }
1434
1435     lastres = startres;
1436     seqCanvas.repaint();
1437   }
1438
1439   void insertChar(int j, SequenceI[] seq, int fixedColumn)
1440   {
1441     int blankColumn = fixedColumn;
1442     for (int s = 0; s < seq.length; s++)
1443     {
1444       // Find the next gap before the end of the visible region boundary
1445       // If lastCol > j, theres a boundary after the gap insertion
1446
1447       for (blankColumn = fixedColumn; blankColumn > j; blankColumn--)
1448       {
1449         if (Comparison.isGap(seq[s].getCharAt(blankColumn)))
1450         {
1451           // Theres a space, so break and insert the gap
1452           break;
1453         }
1454       }
1455
1456       if (blankColumn <= j)
1457       {
1458         blankColumn = fixedColumn;
1459         endEditing();
1460         return;
1461       }
1462     }
1463
1464     appendEdit(Action.DELETE_GAP, seq, blankColumn, 1);
1465
1466     appendEdit(Action.INSERT_GAP, seq, j, 1);
1467
1468   }
1469
1470   /**
1471    * Helper method to add and perform one edit action.
1472    *
1473    * @param action
1474    * @param seq
1475    * @param pos
1476    * @param count
1477    */
1478   protected void appendEdit(Action action, SequenceI[] seq, int pos,
1479           int count)
1480   {
1481
1482     final Edit edit = new EditCommand().new Edit(action, seq, pos, count,
1483             av.getAlignment().getGapCharacter());
1484
1485     editCommand.appendEdit(edit, av.getAlignment(), true, null);
1486   }
1487
1488   void deleteChar(int j, SequenceI[] seq, int fixedColumn)
1489   {
1490
1491     appendEdit(Action.DELETE_GAP, seq, j, 1);
1492
1493     appendEdit(Action.INSERT_GAP, seq, fixedColumn, 1);
1494   }
1495
1496   /**
1497    * DOCUMENT ME!
1498    *
1499    * @param e
1500    *          DOCUMENT ME!
1501    */
1502   @Override
1503   public void mouseEntered(MouseEvent e)
1504   {
1505     if (oldSeq < 0)
1506     {
1507       oldSeq = 0;
1508     }
1509
1510     if (scrollThread != null)
1511     {
1512       scrollThread.running = false;
1513       scrollThread = null;
1514     }
1515   }
1516
1517   /**
1518    * DOCUMENT ME!
1519    *
1520    * @param e
1521    *          DOCUMENT ME!
1522    */
1523   @Override
1524   public void mouseExited(MouseEvent e)
1525   {
1526     if (av.getWrapAlignment())
1527     {
1528       return;
1529     }
1530
1531     if (mouseDragging)
1532     {
1533       scrollThread = new ScrollThread();
1534     }
1535   }
1536
1537   /**
1538    * Handler for double-click on a position with one or more sequence features.
1539    * Opens the Amend Features dialog to allow feature details to be amended, or
1540    * the feature deleted.
1541    */
1542   @Override
1543   public void mouseClicked(MouseEvent evt)
1544   {
1545     SequenceGroup sg = null;
1546     SequenceI sequence = av.getAlignment().getSequenceAt(findSeq(evt));
1547     if (evt.getClickCount() > 1)
1548     {
1549       sg = av.getSelectionGroup();
1550       if (sg != null && sg.getSize() == 1
1551               && sg.getEndRes() - sg.getStartRes() < 2)
1552       {
1553         av.setSelectionGroup(null);
1554       }
1555
1556       int column = findColumn(evt);
1557
1558       /*
1559        * find features at the position (if not gapped), or straddling
1560        * the position (if at a gap)
1561        */
1562       List<SequenceFeature> features = seqCanvas.getFeatureRenderer()
1563               .findFeaturesAtColumn(sequence, column + 1);
1564
1565       if (!features.isEmpty())
1566       {
1567         /*
1568          * highlight the first feature at the position on the alignment
1569          */
1570         SearchResultsI highlight = new SearchResults();
1571         highlight.addResult(sequence, features.get(0).getBegin(), features
1572                 .get(0).getEnd());
1573         seqCanvas.highlightSearchResults(highlight);
1574
1575         /*
1576          * open the Amend Features dialog; clear highlighting afterwards,
1577          * whether changes were made or not
1578          */
1579         List<SequenceI> seqs = Collections.singletonList(sequence);
1580         seqCanvas.getFeatureRenderer().amendFeatures(seqs, features, false,
1581                 ap);
1582         seqCanvas.highlightSearchResults(null);
1583       }
1584     }
1585   }
1586
1587   @Override
1588   public void mouseWheelMoved(MouseWheelEvent e)
1589   {
1590     e.consume();
1591     if (e.getWheelRotation() > 0)
1592     {
1593       if (e.isShiftDown())
1594       {
1595         av.getRanges().scrollRight(true);
1596
1597       }
1598       else
1599       {
1600         av.getRanges().scrollUp(false);
1601       }
1602     }
1603     else
1604     {
1605       if (e.isShiftDown())
1606       {
1607         av.getRanges().scrollRight(false);
1608       }
1609       else
1610       {
1611         av.getRanges().scrollUp(true);
1612       }
1613     }
1614     // TODO Update tooltip for new position.
1615   }
1616
1617   /**
1618    * DOCUMENT ME!
1619    *
1620    * @param evt
1621    *          DOCUMENT ME!
1622    */
1623   public void doMousePressedDefineMode(MouseEvent evt)
1624   {
1625     final int res = findColumn(evt);
1626     final int seq = findSeq(evt);
1627     oldSeq = seq;
1628     needOverviewUpdate = false;
1629
1630     startWrapBlock = wrappedBlock;
1631
1632     if (av.getWrapAlignment() && seq > av.getAlignment().getHeight())
1633     {
1634       JvOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
1635               .getString("label.cannot_edit_annotations_in_wrapped_view"),
1636               MessageManager.getString("label.wrapped_view_no_edit"),
1637               JvOptionPane.WARNING_MESSAGE);
1638       return;
1639     }
1640
1641     if (seq < 0 || res < 0)
1642     {
1643       return;
1644     }
1645
1646     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1647
1648     if ((sequence == null) || (res > sequence.getLength()))
1649     {
1650       return;
1651     }
1652
1653     stretchGroup = av.getSelectionGroup();
1654
1655     if (stretchGroup == null || !stretchGroup.contains(sequence, res))
1656     {
1657       stretchGroup = av.getAlignment().findGroup(sequence, res);
1658       if (stretchGroup != null)
1659       {
1660         // only update the current selection if the popup menu has a group to
1661         // focus on
1662         av.setSelectionGroup(stretchGroup);
1663       }
1664     }
1665
1666     if (evt.isPopupTrigger()) // Mac: mousePressed
1667     {
1668       showPopupMenu(evt);
1669       return;
1670     }
1671
1672     /*
1673      * defer right-mouse click handling to mouseReleased on Windows
1674      * (where isPopupTrigger() will answer true)
1675      * NB isRightMouseButton is also true for Cmd-click on Mac
1676      */
1677     if (SwingUtilities.isRightMouseButton(evt) && !Platform.isAMac())
1678     {
1679       return;
1680     }
1681
1682     if (av.cursorMode)
1683     {
1684       seqCanvas.cursorX = findColumn(evt);
1685       seqCanvas.cursorY = findSeq(evt);
1686       seqCanvas.repaint();
1687       return;
1688     }
1689
1690     if (stretchGroup == null)
1691     {
1692       // Only if left mouse button do we want to change group sizes
1693
1694       // define a new group here
1695       SequenceGroup sg = new SequenceGroup();
1696       sg.setStartRes(res);
1697       sg.setEndRes(res);
1698       sg.addSequence(sequence, false);
1699       av.setSelectionGroup(sg);
1700       stretchGroup = sg;
1701
1702       if (av.getConservationSelected())
1703       {
1704         SliderPanel.setConservationSlider(ap, av.getResidueShading(),
1705                 ap.getViewName());
1706       }
1707
1708       if (av.getAbovePIDThreshold())
1709       {
1710         SliderPanel.setPIDSliderSource(ap, av.getResidueShading(),
1711                 ap.getViewName());
1712       }
1713       // TODO: stretchGroup will always be not null. Is this a merge error ?
1714       if ((stretchGroup != null) && (stretchGroup.getEndRes() == res))
1715       {
1716         // Edit end res position of selected group
1717         changeEndRes = true;
1718       }
1719       else if ((stretchGroup != null)
1720               && (stretchGroup.getStartRes() == res))
1721       {
1722         // Edit end res position of selected group
1723         changeStartRes = true;
1724       }
1725       stretchGroup.getWidth();
1726     }
1727
1728     seqCanvas.repaint();
1729   }
1730
1731   /**
1732    * Build and show a pop-up menu at the right-click mouse position
1733    *
1734    * @param evt
1735    * @param res
1736    * @param sequences
1737    */
1738   void showPopupMenu(MouseEvent evt)
1739   {
1740     final int column = findColumn(evt);
1741     final int seq = findSeq(evt);
1742     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
1743     List<SequenceFeature> allFeatures = ap.getFeatureRenderer()
1744             .findFeaturesAtColumn(sequence, column + 1);
1745     List<String> links = new ArrayList<>();
1746     for (SequenceFeature sf : allFeatures)
1747     {
1748       if (sf.links != null)
1749       {
1750         for (String link : sf.links)
1751         {
1752           links.add(link);
1753         }
1754       }
1755     }
1756
1757     PopupMenu pop = new PopupMenu(ap, null, links);
1758     pop.show(this, evt.getX(), evt.getY());
1759   }
1760
1761   /**
1762    * Update the display after mouse up on a selection or group
1763    *
1764    * @param evt
1765    *          mouse released event details
1766    * @param afterDrag
1767    *          true if this event is happening after a mouse drag (rather than a
1768    *          mouse down)
1769    */
1770   public void doMouseReleasedDefineMode(MouseEvent evt, boolean afterDrag)
1771   {
1772     if (stretchGroup == null)
1773     {
1774       return;
1775     }
1776     // always do this - annotation has own state
1777     // but defer colourscheme update until hidden sequences are passed in
1778     boolean vischange = stretchGroup.recalcConservation(true);
1779     needOverviewUpdate |= vischange && av.isSelectionDefinedGroup()
1780             && afterDrag;
1781     if (stretchGroup.cs != null)
1782     {
1783       stretchGroup.cs.alignmentChanged(stretchGroup,
1784               av.getHiddenRepSequences());
1785
1786       ResidueShaderI groupColourScheme = stretchGroup.getGroupColourScheme();
1787       String name = stretchGroup.getName();
1788       if (stretchGroup.cs.conservationApplied())
1789       {
1790         SliderPanel.setConservationSlider(ap, groupColourScheme, name);
1791       }
1792       if (stretchGroup.cs.getThreshold() > 0)
1793       {
1794         SliderPanel.setPIDSliderSource(ap, groupColourScheme, name);
1795       }
1796     }
1797     PaintRefresher.Refresh(this, av.getSequenceSetId());
1798     ap.paintAlignment(needOverviewUpdate);
1799     needOverviewUpdate = false;
1800     changeEndRes = false;
1801     changeStartRes = false;
1802     stretchGroup = null;
1803     av.sendSelection();
1804   }
1805
1806   /**
1807    * DOCUMENT ME!
1808    *
1809    * @param evt
1810    *          DOCUMENT ME!
1811    */
1812   public void doMouseDraggedDefineMode(MouseEvent evt)
1813   {
1814     int res = findColumn(evt);
1815     int y = findSeq(evt);
1816
1817     if (wrappedBlock != startWrapBlock)
1818     {
1819       return;
1820     }
1821
1822     if (stretchGroup == null)
1823     {
1824       return;
1825     }
1826
1827     if (res >= av.getAlignment().getWidth())
1828     {
1829       res = av.getAlignment().getWidth() - 1;
1830     }
1831
1832     if (stretchGroup.getEndRes() == res)
1833     {
1834       // Edit end res position of selected group
1835       changeEndRes = true;
1836     }
1837     else if (stretchGroup.getStartRes() == res)
1838     {
1839       // Edit start res position of selected group
1840       changeStartRes = true;
1841     }
1842
1843     if (res < av.getRanges().getStartRes())
1844     {
1845       res = av.getRanges().getStartRes();
1846     }
1847
1848     if (changeEndRes)
1849     {
1850       if (res > (stretchGroup.getStartRes() - 1))
1851       {
1852         stretchGroup.setEndRes(res);
1853         needOverviewUpdate |= av.isSelectionDefinedGroup();
1854       }
1855     }
1856     else if (changeStartRes)
1857     {
1858       if (res < (stretchGroup.getEndRes() + 1))
1859       {
1860         stretchGroup.setStartRes(res);
1861         needOverviewUpdate |= av.isSelectionDefinedGroup();
1862       }
1863     }
1864
1865     int dragDirection = 0;
1866
1867     if (y > oldSeq)
1868     {
1869       dragDirection = 1;
1870     }
1871     else if (y < oldSeq)
1872     {
1873       dragDirection = -1;
1874     }
1875
1876     while ((y != oldSeq) && (oldSeq > -1)
1877             && (y < av.getAlignment().getHeight()))
1878     {
1879       // This routine ensures we don't skip any sequences, as the
1880       // selection is quite slow.
1881       Sequence seq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1882
1883       oldSeq += dragDirection;
1884
1885       if (oldSeq < 0)
1886       {
1887         break;
1888       }
1889
1890       Sequence nextSeq = (Sequence) av.getAlignment().getSequenceAt(oldSeq);
1891
1892       if (stretchGroup.getSequences(null).contains(nextSeq))
1893       {
1894         stretchGroup.deleteSequence(seq, false);
1895         needOverviewUpdate |= av.isSelectionDefinedGroup();
1896       }
1897       else
1898       {
1899         if (seq != null)
1900         {
1901           stretchGroup.addSequence(seq, false);
1902         }
1903
1904         stretchGroup.addSequence(nextSeq, false);
1905         needOverviewUpdate |= av.isSelectionDefinedGroup();
1906       }
1907     }
1908
1909     if (oldSeq < 0)
1910     {
1911       oldSeq = -1;
1912     }
1913
1914     mouseDragging = true;
1915
1916     if (scrollThread != null)
1917     {
1918       scrollThread.setEvent(evt);
1919     }
1920
1921     seqCanvas.repaint();
1922   }
1923
1924   void scrollCanvas(MouseEvent evt)
1925   {
1926     if (evt == null)
1927     {
1928       if (scrollThread != null)
1929       {
1930         scrollThread.running = false;
1931         scrollThread = null;
1932       }
1933       mouseDragging = false;
1934     }
1935     else
1936     {
1937       if (scrollThread == null)
1938       {
1939         scrollThread = new ScrollThread();
1940       }
1941
1942       mouseDragging = true;
1943       scrollThread.setEvent(evt);
1944     }
1945
1946   }
1947
1948   // this class allows scrolling off the bottom of the visible alignment
1949   class ScrollThread extends Thread
1950   {
1951     MouseEvent evt;
1952
1953     boolean running = false;
1954
1955     public ScrollThread()
1956     {
1957       start();
1958     }
1959
1960     public void setEvent(MouseEvent e)
1961     {
1962       evt = e;
1963     }
1964
1965     public void stopScrolling()
1966     {
1967       running = false;
1968     }
1969
1970     @Override
1971     public void run()
1972     {
1973       running = true;
1974
1975       while (running)
1976       {
1977         if (evt != null)
1978         {
1979           if (mouseDragging && (evt.getY() < 0)
1980                   && (av.getRanges().getStartSeq() > 0))
1981           {
1982             running = av.getRanges().scrollUp(true);
1983           }
1984
1985           if (mouseDragging && (evt.getY() >= getHeight())
1986                   && (av.getAlignment().getHeight() > av.getRanges()
1987                           .getEndSeq()))
1988           {
1989             running = av.getRanges().scrollUp(false);
1990           }
1991
1992           if (mouseDragging && (evt.getX() < 0))
1993           {
1994             running = av.getRanges().scrollRight(false);
1995           }
1996           else if (mouseDragging && (evt.getX() >= getWidth()))
1997           {
1998             running = av.getRanges().scrollRight(true);
1999           }
2000         }
2001
2002         try
2003         {
2004           Thread.sleep(20);
2005         } catch (Exception ex)
2006         {
2007         }
2008       }
2009     }
2010   }
2011
2012   /**
2013    * modify current selection according to a received message.
2014    */
2015   @Override
2016   public void selection(SequenceGroup seqsel, ColumnSelection colsel,
2017           HiddenColumns hidden, SelectionSource source)
2018   {
2019     // TODO: fix this hack - source of messages is align viewport, but SeqPanel
2020     // handles selection messages...
2021     // TODO: extend config options to allow user to control if selections may be
2022     // shared between viewports.
2023     boolean iSentTheSelection = (av == source || (source instanceof AlignViewport && ((AlignmentViewport) source)
2024             .getSequenceSetId().equals(av.getSequenceSetId())));
2025
2026     if (iSentTheSelection)
2027     {
2028       // respond to our own event by updating dependent dialogs
2029       if (ap.getCalculationDialog() != null)
2030       {
2031         ap.getCalculationDialog().validateCalcTypes();
2032       }
2033
2034       return;
2035     }
2036
2037     // process further ?
2038     if (!av.followSelection)
2039     {
2040       return;
2041     }
2042
2043     /*
2044      * Ignore the selection if there is one of our own pending.
2045      */
2046     if (av.isSelectionGroupChanged(false) || av.isColSelChanged(false))
2047     {
2048       return;
2049     }
2050
2051     /*
2052      * Check for selection in a view of which this one is a dna/protein
2053      * complement.
2054      */
2055     if (selectionFromTranslation(seqsel, colsel, hidden, source))
2056     {
2057       return;
2058     }
2059
2060     // do we want to thread this ? (contention with seqsel and colsel locks, I
2061     // suspect)
2062     /*
2063      * only copy colsel if there is a real intersection between
2064      * sequence selection and this panel's alignment
2065      */
2066     boolean repaint = false;
2067     boolean copycolsel = false;
2068
2069     SequenceGroup sgroup = null;
2070     if (seqsel != null && seqsel.getSize() > 0)
2071     {
2072       if (av.getAlignment() == null)
2073       {
2074         Cache.log.warn("alignviewport av SeqSetId=" + av.getSequenceSetId()
2075                 + " ViewId=" + av.getViewId()
2076                 + " 's alignment is NULL! returning immediately.");
2077         return;
2078       }
2079       sgroup = seqsel.intersect(av.getAlignment(),
2080               (av.hasHiddenRows()) ? av.getHiddenRepSequences() : null);
2081       if ((sgroup != null && sgroup.getSize() > 0))
2082       {
2083         copycolsel = true;
2084       }
2085     }
2086     if (sgroup != null && sgroup.getSize() > 0)
2087     {
2088       av.setSelectionGroup(sgroup);
2089     }
2090     else
2091     {
2092       av.setSelectionGroup(null);
2093     }
2094     av.isSelectionGroupChanged(true);
2095     repaint = true;
2096
2097     if (copycolsel)
2098     {
2099       // the current selection is unset or from a previous message
2100       // so import the new colsel.
2101       if (colsel == null || colsel.isEmpty())
2102       {
2103         if (av.getColumnSelection() != null)
2104         {
2105           av.getColumnSelection().clear();
2106           repaint = true;
2107         }
2108       }
2109       else
2110       {
2111         // TODO: shift colSel according to the intersecting sequences
2112         if (av.getColumnSelection() == null)
2113         {
2114           av.setColumnSelection(new ColumnSelection(colsel));
2115         }
2116         else
2117         {
2118           av.getColumnSelection().setElementsFrom(colsel,
2119                   av.getAlignment().getHiddenColumns());
2120         }
2121       }
2122       av.isColSelChanged(true);
2123       repaint = true;
2124     }
2125
2126     if (copycolsel
2127             && av.hasHiddenColumns()
2128             && (av.getAlignment().getHiddenColumns() == null || av
2129                     .getAlignment().getHiddenColumns().getHiddenRegions() == null))
2130     {
2131       System.err.println("Bad things");
2132     }
2133     if (repaint) // always true!
2134     {
2135       // probably finessing with multiple redraws here
2136       PaintRefresher.Refresh(this, av.getSequenceSetId());
2137       // ap.paintAlignment(false);
2138     }
2139
2140     // lastly, update dependent dialogs
2141     if (ap.getCalculationDialog() != null)
2142     {
2143       ap.getCalculationDialog().validateCalcTypes();
2144     }
2145
2146   }
2147
2148   /**
2149    * If this panel is a cdna/protein translation view of the selection source,
2150    * tries to map the source selection to a local one, and returns true. Else
2151    * returns false.
2152    *
2153    * @param seqsel
2154    * @param colsel
2155    * @param source
2156    */
2157   protected boolean selectionFromTranslation(SequenceGroup seqsel,
2158           ColumnSelection colsel, HiddenColumns hidden,
2159           SelectionSource source)
2160   {
2161     if (!(source instanceof AlignViewportI))
2162     {
2163       return false;
2164     }
2165     final AlignViewportI sourceAv = (AlignViewportI) source;
2166     if (sourceAv.getCodingComplement() != av
2167             && av.getCodingComplement() != sourceAv)
2168     {
2169       return false;
2170     }
2171
2172     /*
2173      * Map sequence selection
2174      */
2175     SequenceGroup sg = MappingUtils.mapSequenceGroup(seqsel, sourceAv, av);
2176     av.setSelectionGroup(sg);
2177     av.isSelectionGroupChanged(true);
2178
2179     /*
2180      * Map column selection
2181      */
2182     // ColumnSelection cs = MappingUtils.mapColumnSelection(colsel, sourceAv,
2183     // av);
2184     ColumnSelection cs = new ColumnSelection();
2185     HiddenColumns hs = new HiddenColumns();
2186     MappingUtils.mapColumnSelection(colsel, hidden, sourceAv, av, cs, hs);
2187     av.setColumnSelection(cs);
2188     av.getAlignment().setHiddenColumns(hs);
2189
2190     // lastly, update any dependent dialogs
2191     if (ap.getCalculationDialog() != null)
2192     {
2193       ap.getCalculationDialog().validateCalcTypes();
2194     }
2195
2196     PaintRefresher.Refresh(this, av.getSequenceSetId());
2197
2198     return true;
2199   }
2200 }