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