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