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