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