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