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.UrlLink;
  30 import jalview.viewmodel.AlignmentViewport;
  31
  32 import java.awt.BorderLayout;
  33 import java.awt.event.MouseEvent;
  34 import java.awt.event.MouseListener;
  35 import java.awt.event.MouseMotionListener;
  36 import java.awt.event.MouseWheelEvent;
  37 import java.awt.event.MouseWheelListener;
  38 import java.util.List;
  39 import java.util.Vector;
  40
  41 import javax.swing.JOptionPane;
  42 import javax.swing.JPanel;
  43 import javax.swing.SwingUtilities;
  44 import javax.swing.ToolTipManager;
  45
  46 /**
  47  * This panel hosts alignment sequence ids and responds to mouse clicks on them,
  48  * as well as highlighting ids matched by a search from the Find menu.
  49  *
  50  * @author $author$
  51  * @version $Revision$
  52  */
  53 public class IdPanel extends JPanel implements MouseListener,
  54         MouseMotionListener, MouseWheelListener
  55 {
  56   private IdCanvas idCanvas;
  57
  58   protected AlignmentViewport av;
  59
  60   protected AlignmentPanel alignPanel;
  61
  62   ScrollThread scrollThread = null;
  63
  64   String linkImageURL;
  65
  66   int offy;
  67
  68   // int width;
  69   int lastid = -1;
  70
  71   boolean mouseDragging = false;
  72
  73   private final SequenceAnnotationReport seqAnnotReport;
  74
  75   /**
  76    * Creates a new IdPanel object.
  77    *
  78    * @param av
  79    * @param parent
  80    */
  81   public IdPanel(AlignViewport av, AlignmentPanel parent)
  82   {
  83     this.av = av;
  84     alignPanel = parent;
  85     setIdCanvas(new IdCanvas(av));
  86     linkImageURL = getClass().getResource("/images/link.gif").toString();
  87     seqAnnotReport = new SequenceAnnotationReport(linkImageURL);
  88     setLayout(new BorderLayout());
  89     add(getIdCanvas(), BorderLayout.CENTER);
  90     addMouseListener(this);
  91     addMouseMotionListener(this);
  92     addMouseWheelListener(this);
  93     ToolTipManager.sharedInstance().registerComponent(this);
  94   }
  95
  96   /**
  97    * Respond to mouse movement by constructing tooltip text for the sequence id
  98    * under the mouse.
  99    *
 100    * @param e
 101    *          DOCUMENT ME!
 102    */
 103   @Override
 104   public void mouseMoved(MouseEvent e)
 105   {
 106     SeqPanel sp = alignPanel.getSeqPanel();
 107     int seq = Math.max(0, sp.findSeq(e));
 108     if (seq > -1 && seq < av.getAlignment().getHeight())
 109     {
 110       SequenceI sequence = av.getAlignment().getSequenceAt(seq);
 111       StringBuffer tip = new StringBuffer(64);
 112       seqAnnotReport.createSequenceAnnotationReport(tip, sequence,
 113               av.isShowDBRefs(), av.isShowNPFeats(),
 114               sp.seqCanvas.fr.getMinMax());
 115       setToolTipText(JvSwingUtils.wrapTooltip(true,
 116               sequence.getDisplayId(true) + " " + tip.toString()));
 117     }
 118   }
 119
 120   /**
 121    * Responds to a mouse drag by selecting the sequences under the dragged
 122    * region.
 123    *
 124    * @param e
 125    */
 126   @Override
 127   public void mouseDragged(MouseEvent e)
 128   {
 129     mouseDragging = true;
 130
 131     int seq = Math.max(0, alignPanel.getSeqPanel().findSeq(e));
 132
 133     if (seq < lastid)
 134     {
 135       selectSeqs(lastid - 1, seq);
 136     }
 137     else if (seq > lastid)
 138     {
 139       selectSeqs(lastid + 1, seq);
 140     }
 141
 142     lastid = seq;
 143     alignPanel.paintAlignment(true);
 144   }
 145
 146   /**
 147    * Response to the mouse wheel by scrolling the alignment panel.
 148    */
 149   @Override
 150   public void mouseWheelMoved(MouseWheelEvent e)
 151   {
 152     e.consume();
 153     if (e.getWheelRotation() > 0)
 154     {
 155       if (e.isShiftDown())
 156       {
 157         alignPanel.scrollRight(true);
 158       }
 159       else
 160       {
 161         alignPanel.scrollUp(false);
 162       }
 163     }
 164     else
 165     {
 166       if (e.isShiftDown())
 167       {
 168         alignPanel.scrollRight(false);
 169       }
 170       else
 171       {
 172         alignPanel.scrollUp(true);
 173       }
 174     }
 175   }
 176
 177   /**
 178    * Handle a mouse click event. Currently only responds to a double-click. The
 179    * action is to try to open a browser window at a URL that searches for the
 180    * selected sequence id. The search URL is configured in Preferences |
 181    * Connections | URL link from Sequence ID. For example:
 182    *
 183    * http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$SEQUENCE_ID$
 184    *
 185    * @param e
 186    */
 187   @Override
 188   public void mouseClicked(MouseEvent e)
 189   {
 190     /*
 191      * Ignore single click. Ignore 'left' click followed by 'right' click (user
 192      * selects a row then its pop-up menu).
 193      */
 194     if (e.getClickCount() < 2 || SwingUtilities.isRightMouseButton(e))
 195     {
 196       // reinstate isRightMouseButton check to ignore mouse-related popup events
 197       // note - this does nothing on default MacBookPro force-trackpad config!
 198       return;
 199     }
 200
 201     Vector links = Preferences.sequenceURLLinks;
 202     if (links == null || links.size() < 1)
 203     {
 204       return;
 205     }
 206
 207     int seq = alignPanel.getSeqPanel().findSeq(e);
 208     String url = null;
 209     int i = 0;
 210     String id = av.getAlignment().getSequenceAt(seq).getName();
 211     while (url == null && i < links.size())
 212     {
 213       // DEFAULT LINK IS FIRST IN THE LINK LIST
 214       // BUT IF ITS A REGEX AND DOES NOT MATCH THE NEXT ONE WILL BE TRIED
 215       url = links.elementAt(i++).toString();
 216       jalview.util.UrlLink urlLink = null;
 217       try
 218       {
 219         urlLink = new UrlLink(url);
 220       } catch (Exception foo)
 221       {
 222         jalview.bin.Cache.log.error("Exception for URLLink '" + url + "'",
 223                 foo);
 224         url = null;
 225         continue;
 226       }
 227       ;
 228       if (!urlLink.isValid())
 229       {
 230         jalview.bin.Cache.log.error(urlLink.getInvalidMessage());
 231         url = null;
 232         continue;
 233       }
 234
 235       String urls[] = urlLink.makeUrls(id, true);
 236       if (urls == null || urls[0] == null || urls[0].length() < 4)
 237       {
 238         url = null;
 239         continue;
 240       }
 241       // just take first URL made from regex
 242       url = urls[1];
 243     }
 244     try
 245     {
 246       jalview.util.BrowserLauncher.openURL(url);
 247     } catch (Exception ex)
 248     {
 249       JOptionPane.showInternalMessageDialog(Desktop.desktop,
 250               MessageManager.getString("label.web_browser_not_found_unix"),
 251               MessageManager.getString("label.web_browser_not_found"),
 252               JOptionPane.WARNING_MESSAGE);
 253       ex.printStackTrace();
 254     }
 255   }
 256
 257   /**
 258    * DOCUMENT ME!
 259    *
 260    * @param e
 261    *          DOCUMENT ME!
 262    */
 263   @Override
 264   public void mouseEntered(MouseEvent e)
 265   {
 266     if (scrollThread != null)
 267     {
 268       scrollThread.running = false;
 269     }
 270   }
 271
 272   /**
 273    * DOCUMENT ME!
 274    *
 275    * @param e
 276    *          DOCUMENT ME!
 277    */
 278   @Override
 279   public void mouseExited(MouseEvent e)
 280   {
 281     if (av.getWrapAlignment())
 282     {
 283       return;
 284     }
 285
 286     if (mouseDragging && (e.getY() < 0) && (av.getStartSeq() > 0))
 287     {
 288       scrollThread = new ScrollThread(true);
 289     }
 290
 291     if (mouseDragging && (e.getY() >= getHeight())
 292             && (av.getAlignment().getHeight() > av.getEndSeq()))
 293     {
 294       scrollThread = new ScrollThread(false);
 295     }
 296   }
 297
 298   /**
 299    * Respond to a mouse press. Does nothing for (left) double-click as this is
 300    * handled by mouseClicked().
 301    *
 302    * Right mouse down - construct and show context menu.
 303    *
 304    * Ctrl-down or Shift-down - add to or expand current selection group if there
 305    * is one.
 306    *
 307    * Mouse down - select this sequence.
 308    *
 309    * @param e
 310    */
 311   @Override
 312   public void mousePressed(MouseEvent e)
 313   {
 314     if (e.getClickCount() == 2 && SwingUtilities.isLeftMouseButton(e))
 315     {
 316       return;
 317     }
 318
 319     if (e.isPopupTrigger()) // Mac reports this in mousePressed
 320     {
 321       showPopupMenu(e);
 322       return;
 323     }
 324
 325     /*
 326      * defer right-mouse click handling to mouseReleased on Windows
 327      * (where isPopupTrigger() will answer true)
 328      * NB isRightMouseButton is also true for Cmd-click on Mac
 329      */
 330     if (SwingUtilities.isRightMouseButton(e))
 331     {
 332       return;
 333     }
 334
 335     if ((av.getSelectionGroup() == null)
 336             || (!jalview.util.Platform.isControlDown(e)
 337                     && !e.isShiftDown() && av.getSelectionGroup() != null))
 338     {
 339       av.setSelectionGroup(new SequenceGroup());
 340       av.getSelectionGroup().setStartRes(0);
 341       av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1);
 342     }
 343
 344     int seq = alignPanel.getSeqPanel().findSeq(e);
 345     if (e.isShiftDown() && (lastid != -1))
 346     {
 347       selectSeqs(lastid, seq);
 348     }
 349     else
 350     {
 351       selectSeq(seq);
 352     }
 353     // TODO is this addition ok here?
 354     av.isSelectionGroupChanged(true);
 355
 356     alignPanel.paintAlignment(true);
 357   }
 358
 359   /**
 360    * Build and show the popup-menu at the right-click mouse position
 361    *
 362    * @param e
 363    */
 364   void showPopupMenu(MouseEvent e)
 365   {
 366     int seq2 = alignPanel.getSeqPanel().findSeq(e);
 367     Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq2);
 368     // build a new links menu based on the current links + any non-positional
 369     // features
 370     Vector<String> nlinks = new Vector<String>(
 371             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 }