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       StringBuffer tip = new StringBuffer(64);
 113       seqAnnotReport.createSequenceAnnotationReport(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.isValid())
 230       {
 231         jalview.bin.Cache.log.error(urlLink.getInvalidMessage());
 232         url = null;
 233         continue;
 234       }
 235
 236       String urls[] = urlLink.makeUrls(id, true);
 237       if (urls == null || urls[0] == null || urls[0].length() < 4)
 238       {
 239         url = null;
 240         continue;
 241       }
 242       // just take first URL made from regex
 243       url = urls[1];
 244     }
 245     try
 246     {
 247       jalview.util.BrowserLauncher.openURL(url);
 248     } catch (Exception ex)
 249     {
 250       JOptionPane.showInternalMessageDialog(Desktop.desktop,
 251               MessageManager.getString("label.web_browser_not_found_unix"),
 252               MessageManager.getString("label.web_browser_not_found"),
 253               JOptionPane.WARNING_MESSAGE);
 254       ex.printStackTrace();
 255     }
 256   }
 257
 258   /**
 259    * DOCUMENT ME!
 260    *
 261    * @param e
 262    *          DOCUMENT ME!
 263    */
 264   @Override
 265   public void mouseEntered(MouseEvent e)
 266   {
 267     if (scrollThread != null)
 268     {
 269       scrollThread.running = false;
 270     }
 271   }
 272
 273   /**
 274    * DOCUMENT ME!
 275    *
 276    * @param e
 277    *          DOCUMENT ME!
 278    */
 279   @Override
 280   public void mouseExited(MouseEvent e)
 281   {
 282     if (av.getWrapAlignment())
 283     {
 284       return;
 285     }
 286
 287     if (mouseDragging && (e.getY() < 0) && (av.getStartSeq() > 0))
 288     {
 289       scrollThread = new ScrollThread(true);
 290     }
 291
 292     if (mouseDragging && (e.getY() >= getHeight())
 293             && (av.getAlignment().getHeight() > av.getEndSeq()))
 294     {
 295       scrollThread = new ScrollThread(false);
 296     }
 297   }
 298
 299   /**
 300    * Respond to a mouse press. Does nothing for (left) double-click as this is
 301    * handled by mouseClicked().
 302    *
 303    * Right mouse down - construct and show context menu.
 304    *
 305    * Ctrl-down or Shift-down - add to or expand current selection group if there
 306    * is one.
 307    *
 308    * Mouse down - select this sequence.
 309    *
 310    * @param e
 311    */
 312   @Override
 313   public void mousePressed(MouseEvent e)
 314   {
 315     if (e.getClickCount() == 2 && SwingUtilities.isLeftMouseButton(e))
 316     {
 317       return;
 318     }
 319
 320     if (e.isPopupTrigger()) // Mac reports this in mousePressed
 321     {
 322       showPopupMenu(e);
 323       return;
 324     }
 325
 326     /*
 327      * defer right-mouse click handling to mouseReleased on Windows
 328      * (where isPopupTrigger() will answer true)
 329      * NB isRightMouseButton is also true for Cmd-click on Mac
 330      */
 331     if (SwingUtilities.isRightMouseButton(e) && !Platform.isAMac())
 332     {
 333       return;
 334     }
 335
 336     if ((av.getSelectionGroup() == null)
 337             || (!jalview.util.Platform.isControlDown(e) && !e.isShiftDown() && av
 338                     .getSelectionGroup() != null))
 339     {
 340       av.setSelectionGroup(new SequenceGroup());
 341       av.getSelectionGroup().setStartRes(0);
 342       av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1);
 343     }
 344
 345     int seq = alignPanel.getSeqPanel().findSeq(e);
 346     if (e.isShiftDown() && (lastid != -1))
 347     {
 348       selectSeqs(lastid, seq);
 349     }
 350     else
 351     {
 352       selectSeq(seq);
 353     }
 354
 355     av.isSelectionGroupChanged(true);
 356
 357     alignPanel.paintAlignment(true);
 358   }
 359
 360   /**
 361    * Build and show the popup-menu at the right-click mouse position
 362    *
 363    * @param e
 364    */
 365   void showPopupMenu(MouseEvent e)
 366   {
 367     int seq2 = alignPanel.getSeqPanel().findSeq(e);
 368     Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq2);
 369     // build a new links menu based on the current links + any non-positional
 370     // features
 371     Vector<String> nlinks = new Vector<String>(Preferences.sequenceURLLinks);
 372     SequenceFeature sfs[] = sq == null ? null : sq.getSequenceFeatures();
 373     if (sfs != null)
 374     {
 375       for (SequenceFeature sf : sfs)
 376       {
 377         if (sf.begin == sf.end && sf.begin == 0)
 378         {
 379           if (sf.links != null && sf.links.size() > 0)
 380           {
 381             for (int l = 0, lSize = sf.links.size(); l < lSize; l++)
 382             {
 383               nlinks.addElement(sf.links.elementAt(l));
 384             }
 385           }
 386         }
 387       }
 388     }
 389
 390     PopupMenu pop = new PopupMenu(alignPanel, sq, nlinks,
 391             Preferences.getGroupURLLinks());
 392     pop.show(this, e.getX(), e.getY());
 393   }
 394
 395   /**
 396    * Toggle whether the sequence is part of the current selection group.
 397    *
 398    * @param seq
 399    */
 400   void selectSeq(int seq)
 401   {
 402     lastid = seq;
 403
 404     SequenceI pickedSeq = av.getAlignment().getSequenceAt(seq);
 405     av.getSelectionGroup().addOrRemove(pickedSeq, true);
 406   }
 407
 408   /**
 409    * Add contiguous rows of the alignment to the current selection group. Does
 410    * nothing if there is no selection group.
 411    *
 412    * @param start
 413    * @param end
 414    */
 415   void selectSeqs(int start, int end)
 416   {
 417     if (av.getSelectionGroup() == null)
 418     {
 419       return;
 420     }
 421
 422     if (end >= av.getAlignment().getHeight())
 423     {
 424       end = av.getAlignment().getHeight() - 1;
 425     }
 426
 427     lastid = start;
 428
 429     if (end < start)
 430     {
 431       int tmp = start;
 432       start = end;
 433       end = tmp;
 434       lastid = end;
 435     }
 436
 437     for (int i = start; i <= end; i++)
 438     {
 439       av.getSelectionGroup().addSequence(
 440               av.getAlignment().getSequenceAt(i), i == end);
 441     }
 442   }
 443
 444   /**
 445    * Respond to mouse released. Refreshes the display and triggers broadcast of
 446    * the new selection group to any listeners.
 447    *
 448    * @param e
 449    */
 450   @Override
 451   public void mouseReleased(MouseEvent e)
 452   {
 453     if (scrollThread != null)
 454     {
 455       scrollThread.running = false;
 456     }
 457
 458     mouseDragging = false;
 459     PaintRefresher.Refresh(this, av.getSequenceSetId());
 460     // always send selection message when mouse is released
 461     av.sendSelection();
 462
 463     if (e.isPopupTrigger()) // Windows reports this in mouseReleased
 464     {
 465       showPopupMenu(e);
 466     }
 467   }
 468
 469   /**
 470    * Highlight sequence ids that match the given list, and if necessary scroll
 471    * to the start sequence of the list.
 472    *
 473    * @param list
 474    */
 475   public void highlightSearchResults(List<SequenceI> list)
 476   {
 477     getIdCanvas().setHighlighted(list);
 478
 479     if (list == null)
 480     {
 481       return;
 482     }
 483
 484     int index = av.getAlignment().findIndex(list.get(0));
 485
 486     // do we need to scroll the panel?
 487     if ((av.getStartSeq() > index) || (av.getEndSeq() < index))
 488     {
 489       alignPanel.setScrollValues(av.getStartRes(), index);
 490     }
 491   }
 492
 493   public IdCanvas getIdCanvas()
 494   {
 495     return idCanvas;
 496   }
 497
 498   public void setIdCanvas(IdCanvas idCanvas)
 499   {
 500     this.idCanvas = idCanvas;
 501   }
 502
 503   // this class allows scrolling off the bottom of the visible alignment
 504   class ScrollThread extends Thread
 505   {
 506     boolean running = false;
 507
 508     boolean up = true;
 509
 510     public ScrollThread(boolean up)
 511     {
 512       this.up = up;
 513       start();
 514     }
 515
 516     public void stopScrolling()
 517     {
 518       running = false;
 519     }
 520
 521     @Override
 522     public void run()
 523     {
 524       running = true;
 525
 526       while (running)
 527       {
 528         if (alignPanel.scrollUp(up))
 529         {
 530           // scroll was ok, so add new sequence to selection
 531           int seq = av.getStartSeq();
 532
 533           if (!up)
 534           {
 535             seq = av.getEndSeq();
 536           }
 537
 538           if (seq < lastid)
 539           {
 540             selectSeqs(lastid - 1, seq);
 541           }
 542           else if (seq > lastid)
 543           {
 544             selectSeqs(lastid + 1, seq);
 545           }
 546
 547           lastid = seq;
 548         }
 549         else
 550         {
 551           running = false;
 552         }
 553
 554         alignPanel.paintAlignment(false);
 555
 556         try
 557         {
 558           Thread.sleep(100);
 559         } catch (Exception ex)
 560         {
 561         }
 562       }
 563     }
 564   }
 565 }