src/jalview/gui/IdPanel.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.datamodel.Sequence;
  24 import jalview.datamodel.SequenceFeature;
  25 import jalview.datamodel.SequenceGroup;
  26 import jalview.datamodel.SequenceI;
  27 import jalview.io.SequenceAnnotationReport;
  28 import jalview.util.MessageManager;
  29 import jalview.util.Platform;
  30 import jalview.util.UrlLink;
  31 import jalview.viewmodel.AlignmentViewport;
  32
  33 import java.awt.BorderLayout;
  34 import java.awt.event.MouseEvent;
  35 import java.awt.event.MouseListener;
  36 import java.awt.event.MouseMotionListener;
  37 import java.awt.event.MouseWheelEvent;
  38 import java.awt.event.MouseWheelListener;
  39 import java.util.List;
  40 import java.util.Vector;
  41
  42 import javax.swing.JOptionPane;
  43 import javax.swing.JPanel;
  44 import javax.swing.SwingUtilities;
  45 import javax.swing.ToolTipManager;
  46
  47 /**
  48  * This panel hosts alignment sequence ids and responds to mouse clicks on them,
  49  * as well as highlighting ids matched by a search from the Find menu.
  50  *
  51  * @author $author$
  52  * @version $Revision$
  53  */
  54 public class IdPanel extends JPanel implements MouseListener,
  55         MouseMotionListener, MouseWheelListener
  56 {
  57   private IdCanvas idCanvas;
  58
  59   protected AlignmentViewport av;
  60
  61   protected AlignmentPanel alignPanel;
  62
  63   ScrollThread scrollThread = null;
  64
  65   String linkImageURL;
  66
  67   int offy;
  68
  69   // int width;
  70   int lastid = -1;
  71
  72   boolean mouseDragging = false;
  73
  74   private final SequenceAnnotationReport seqAnnotReport;
  75
  76   /**
  77    * Creates a new IdPanel object.
  78    *
  79    * @param av
  80    * @param parent
  81    */
  82   public IdPanel(AlignViewport av, AlignmentPanel parent)
  83   {
  84     this.av = av;
  85     alignPanel = parent;
  86     setIdCanvas(new IdCanvas(av));
  87     linkImageURL = getClass().getResource("/images/link.gif").toString();
  88     seqAnnotReport = new SequenceAnnotationReport(linkImageURL);
  89     setLayout(new BorderLayout());
  90     add(getIdCanvas(), BorderLayout.CENTER);
  91     addMouseListener(this);
  92     addMouseMotionListener(this);
  93     addMouseWheelListener(this);
  94     ToolTipManager.sharedInstance().registerComponent(this);
  95   }
  96
  97   /**
  98    * Respond to mouse movement by constructing tooltip text for the sequence id
  99    * under the mouse.
 100    *
 101    * @param e
 102    *          DOCUMENT ME!
 103    */
 104   @Override
 105   public void mouseMoved(MouseEvent e)
 106   {
 107     SeqPanel sp = alignPanel.getSeqPanel();
 108     int seq = Math.max(0, sp.findSeq(e));
 109     if (seq > -1 && seq < av.getAlignment().getHeight())
 110     {
 111       SequenceI sequence = av.getAlignment().getSequenceAt(seq);
 112       StringBuilder tip = new StringBuilder(64);
 113       seqAnnotReport.createTooltipAnnotationReport(tip, sequence,
 114               av.isShowDBRefs(), av.isShowNPFeats(),
 115               sp.seqCanvas.fr.getMinMax());
 116       setToolTipText(JvSwingUtils.wrapTooltip(true,
 117               sequence.getDisplayId(true) + " " + tip.toString()));
 118     }
 119   }
 120
 121   /**
 122    * Responds to a mouse drag by selecting the sequences under the dragged
 123    * region.
 124    *
 125    * @param e
 126    */
 127   @Override
 128   public void mouseDragged(MouseEvent e)
 129   {
 130     mouseDragging = true;
 131
 132     int seq = Math.max(0, alignPanel.getSeqPanel().findSeq(e));
 133
 134     if (seq < lastid)
 135     {
 136       selectSeqs(lastid - 1, seq);
 137     }
 138     else if (seq > lastid)
 139     {
 140       selectSeqs(lastid + 1, seq);
 141     }
 142
 143     lastid = seq;
 144     alignPanel.paintAlignment(true);
 145   }
 146
 147   /**
 148    * Response to the mouse wheel by scrolling the alignment panel.
 149    */
 150   @Override
 151   public void mouseWheelMoved(MouseWheelEvent e)
 152   {
 153     e.consume();
 154     if (e.getWheelRotation() > 0)
 155     {
 156       if (e.isShiftDown())
 157       {
 158         alignPanel.scrollRight(true);
 159       }
 160       else
 161       {
 162         alignPanel.scrollUp(false);
 163       }
 164     }
 165     else
 166     {
 167       if (e.isShiftDown())
 168       {
 169         alignPanel.scrollRight(false);
 170       }
 171       else
 172       {
 173         alignPanel.scrollUp(true);
 174       }
 175     }
 176   }
 177
 178   /**
 179    * Handle a mouse click event. Currently only responds to a double-click. The
 180    * action is to try to open a browser window at a URL that searches for the
 181    * selected sequence id. The search URL is configured in Preferences |
 182    * Connections | URL link from Sequence ID. For example:
 183    *
 184    * http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$SEQUENCE_ID$
 185    *
 186    * @param e
 187    */
 188   @Override
 189   public void mouseClicked(MouseEvent e)
 190   {
 191     /*
 192      * Ignore single click. Ignore 'left' click followed by 'right' click (user
 193      * selects a row then its pop-up menu).
 194      */
 195     if (e.getClickCount() < 2 || SwingUtilities.isRightMouseButton(e))
 196     {
 197       // reinstate isRightMouseButton check to ignore mouse-related popup events
 198       // note - this does nothing on default MacBookPro force-trackpad config!
 199       return;
 200     }
 201
 202     Vector links = Preferences.sequenceURLLinks;
 203     if (links == null || links.size() < 1)
 204     {
 205       return;
 206     }
 207
 208     int seq = alignPanel.getSeqPanel().findSeq(e);
 209     String url = null;
 210     int i = 0;
 211     String id = av.getAlignment().getSequenceAt(seq).getName();
 212     while (url == null && i < links.size())
 213     {
 214       // DEFAULT LINK IS FIRST IN THE LINK LIST
 215       // BUT IF ITS A REGEX AND DOES NOT MATCH THE NEXT ONE WILL BE TRIED
 216       url = links.elementAt(i++).toString();
 217       jalview.util.UrlLink urlLink = null;
 218       try
 219       {
 220         urlLink = new UrlLink(url);
 221       } catch (Exception foo)
 222       {
 223         jalview.bin.Cache.log.error("Exception for URLLink '" + url + "'",
 224                 foo);
 225         url = null;
 226         continue;
 227       }
 228
 229       if (urlLink.usesDBAccession())
 230       {
 231         // this URL requires an accession id, not the name of a sequence
 232         url = null;
 233         continue;
 234       }
 235
 236       if (!urlLink.isValid())
 237       {
 238         jalview.bin.Cache.log.error(urlLink.getInvalidMessage());
 239         url = null;
 240         continue;
 241       }
 242
 243       String urls[] = urlLink.makeUrls(id, true);
 244       if (urls == null || urls[0] == null || urls[0].length() < 4)
 245       {
 246         url = null;
 247         continue;
 248       }
 249       // just take first URL made from regex
 250       url = urls[1];
 251     }
 252     try
 253     {
 254       jalview.util.BrowserLauncher.openURL(url);
 255     } catch (Exception ex)
 256     {
 257       JOptionPane.showInternalMessageDialog(Desktop.desktop,
 258               MessageManager.getString("label.web_browser_not_found_unix"),
 259               MessageManager.getString("label.web_browser_not_found"),
 260               JOptionPane.WARNING_MESSAGE);
 261       ex.printStackTrace();
 262     }
 263   }
 264
 265   /**
 266    * DOCUMENT ME!
 267    *
 268    * @param e
 269    *          DOCUMENT ME!
 270    */
 271   @Override
 272   public void mouseEntered(MouseEvent e)
 273   {
 274     if (scrollThread != null)
 275     {
 276       scrollThread.running = false;
 277     }
 278   }
 279
 280   /**
 281    * DOCUMENT ME!
 282    *
 283    * @param e
 284    *          DOCUMENT ME!
 285    */
 286   @Override
 287   public void mouseExited(MouseEvent e)
 288   {
 289     if (av.getWrapAlignment())
 290     {
 291       return;
 292     }
 293
 294     if (mouseDragging && (e.getY() < 0) && (av.getStartSeq() > 0))
 295     {
 296       scrollThread = new ScrollThread(true);
 297     }
 298
 299     if (mouseDragging && (e.getY() >= getHeight())
 300             && (av.getAlignment().getHeight() > av.getEndSeq()))
 301     {
 302       scrollThread = new ScrollThread(false);
 303     }
 304   }
 305
 306   /**
 307    * Respond to a mouse press. Does nothing for (left) double-click as this is
 308    * handled by mouseClicked().
 309    *
 310    * Right mouse down - construct and show context menu.
 311    *
 312    * Ctrl-down or Shift-down - add to or expand current selection group if there
 313    * is one.
 314    *
 315    * Mouse down - select this sequence.
 316    *
 317    * @param e
 318    */
 319   @Override
 320   public void mousePressed(MouseEvent e)
 321   {
 322     if (e.getClickCount() == 2 && SwingUtilities.isLeftMouseButton(e))
 323     {
 324       return;
 325     }
 326
 327     if (e.isPopupTrigger()) // Mac reports this in mousePressed
 328     {
 329       showPopupMenu(e);
 330       return;
 331     }
 332
 333     /*
 334      * defer right-mouse click handling to mouseReleased on Windows
 335      * (where isPopupTrigger() will answer true)
 336      * NB isRightMouseButton is also true for Cmd-click on Mac
 337      */
 338     if (SwingUtilities.isRightMouseButton(e) && !Platform.isAMac())
 339     {
 340       return;
 341     }
 342
 343     if ((av.getSelectionGroup() == null)
 344             || (!jalview.util.Platform.isControlDown(e) && !e.isShiftDown() && av
 345                     .getSelectionGroup() != null))
 346     {
 347       av.setSelectionGroup(new SequenceGroup());
 348       av.getSelectionGroup().setStartRes(0);
 349       av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1);
 350     }
 351
 352     int seq = alignPanel.getSeqPanel().findSeq(e);
 353     if (e.isShiftDown() && (lastid != -1))
 354     {
 355       selectSeqs(lastid, seq);
 356     }
 357     else
 358     {
 359       selectSeq(seq);
 360     }
 361
 362     av.isSelectionGroupChanged(true);
 363
 364     alignPanel.paintAlignment(true);
 365   }
 366
 367   /**
 368    * Build and show the popup-menu at the right-click mouse position
 369    *
 370    * @param e
 371    */
 372   void showPopupMenu(MouseEvent e)
 373   {
 374     int seq2 = alignPanel.getSeqPanel().findSeq(e);
 375     Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq2);
 376     // build a new links menu based on the current links + any non-positional
 377     // features
 378     Vector<String> nlinks = new Vector<String>(Preferences.sequenceURLLinks);
 379     SequenceFeature sfs[] = sq == null ? null : sq.getSequenceFeatures();
 380     if (sfs != null)
 381     {
 382       for (SequenceFeature sf : sfs)
 383       {
 384         if (sf.begin == sf.end && sf.begin == 0)
 385         {
 386           if (sf.links != null && sf.links.size() > 0)
 387           {
 388             for (int l = 0, lSize = sf.links.size(); l < lSize; l++)
 389             {
 390               nlinks.addElement(sf.links.elementAt(l));
 391             }
 392           }
 393         }
 394       }
 395     }
 396
 397     PopupMenu pop = new PopupMenu(alignPanel, sq, nlinks,
 398             Preferences.getGroupURLLinks());
 399     pop.show(this, e.getX(), e.getY());
 400   }
 401
 402   /**
 403    * Toggle whether the sequence is part of the current selection group.
 404    *
 405    * @param seq
 406    */
 407   void selectSeq(int seq)
 408   {
 409     lastid = seq;
 410
 411     SequenceI pickedSeq = av.getAlignment().getSequenceAt(seq);
 412     av.getSelectionGroup().addOrRemove(pickedSeq, true);
 413   }
 414
 415   /**
 416    * Add contiguous rows of the alignment to the current selection group. Does
 417    * nothing if there is no selection group.
 418    *
 419    * @param start
 420    * @param end
 421    */
 422   void selectSeqs(int start, int end)
 423   {
 424     if (av.getSelectionGroup() == null)
 425     {
 426       return;
 427     }
 428
 429     if (end >= av.getAlignment().getHeight())
 430     {
 431       end = av.getAlignment().getHeight() - 1;
 432     }
 433
 434     lastid = start;
 435
 436     if (end < start)
 437     {
 438       int tmp = start;
 439       start = end;
 440       end = tmp;
 441       lastid = end;
 442     }
 443
 444     for (int i = start; i <= end; i++)
 445     {
 446       av.getSelectionGroup().addSequence(
 447               av.getAlignment().getSequenceAt(i), i == end);
 448     }
 449   }
 450
 451   /**
 452    * Respond to mouse released. Refreshes the display and triggers broadcast of
 453    * the new selection group to any listeners.
 454    *
 455    * @param e
 456    */
 457   @Override
 458   public void mouseReleased(MouseEvent e)
 459   {
 460     if (scrollThread != null)
 461     {
 462       scrollThread.running = false;
 463     }
 464
 465     mouseDragging = false;
 466     PaintRefresher.Refresh(this, av.getSequenceSetId());
 467     // always send selection message when mouse is released
 468     av.sendSelection();
 469
 470     if (e.isPopupTrigger()) // Windows reports this in mouseReleased
 471     {
 472       showPopupMenu(e);
 473     }
 474   }
 475
 476   /**
 477    * Highlight sequence ids that match the given list, and if necessary scroll
 478    * to the start sequence of the list.
 479    *
 480    * @param list
 481    */
 482   public void highlightSearchResults(List<SequenceI> list)
 483   {
 484     getIdCanvas().setHighlighted(list);
 485
 486     if (list == null)
 487     {
 488       return;
 489     }
 490
 491     int index = av.getAlignment().findIndex(list.get(0));
 492
 493     // do we need to scroll the panel?
 494     if ((av.getStartSeq() > index) || (av.getEndSeq() < index))
 495     {
 496       alignPanel.setScrollValues(av.getStartRes(), index);
 497     }
 498   }
 499
 500   public IdCanvas getIdCanvas()
 501   {
 502     return idCanvas;
 503   }
 504
 505   public void setIdCanvas(IdCanvas idCanvas)
 506   {
 507     this.idCanvas = idCanvas;
 508   }
 509
 510   // this class allows scrolling off the bottom of the visible alignment
 511   class ScrollThread extends Thread
 512   {
 513     boolean running = false;
 514
 515     boolean up = true;
 516
 517     public ScrollThread(boolean up)
 518     {
 519       this.up = up;
 520       start();
 521     }
 522
 523     public void stopScrolling()
 524     {
 525       running = false;
 526     }
 527
 528     @Override
 529     public void run()
 530     {
 531       running = true;
 532
 533       while (running)
 534       {
 535         if (alignPanel.scrollUp(up))
 536         {
 537           // scroll was ok, so add new sequence to selection
 538           int seq = av.getStartSeq();
 539
 540           if (!up)
 541           {
 542             seq = av.getEndSeq();
 543           }
 544
 545           if (seq < lastid)
 546           {
 547             selectSeqs(lastid - 1, seq);
 548           }
 549           else if (seq > lastid)
 550           {
 551             selectSeqs(lastid + 1, seq);
 552           }
 553
 554           lastid = seq;
 555         }
 556         else
 557         {
 558           running = false;
 559         }
 560
 561         alignPanel.paintAlignment(false);
 562
 563         try
 564         {
 565           Thread.sleep(100);
 566         } catch (Exception ex)
 567         {
 568         }
 569       }
 570     }
 571   }
 572 }