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