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.bin.Cache;
  24 import jalview.datamodel.Sequence;
  25 import jalview.datamodel.SequenceFeature;
  26 import jalview.datamodel.SequenceGroup;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.io.SequenceAnnotationReport;
  29 import jalview.util.BrowserLauncher;
  30 import jalview.util.MessageManager;
  31 import jalview.util.UrlLink;
  32 import jalview.viewmodel.AlignmentViewport;
  33
  34 import java.awt.BorderLayout;
  35 import java.awt.event.MouseEvent;
  36 import java.awt.event.MouseListener;
  37 import java.awt.event.MouseMotionListener;
  38 import java.awt.event.MouseWheelEvent;
  39 import java.awt.event.MouseWheelListener;
  40 import java.util.List;
  41 import java.util.Vector;
  42
  43 import javax.swing.JOptionPane;
  44 import javax.swing.JPanel;
  45 import javax.swing.SwingUtilities;
  46 import javax.swing.ToolTipManager;
  47
  48 /**
  49  * This panel hosts alignment sequence ids and responds to mouse clicks on them,
  50  * as well as highlighting ids matched by a search from the Find menu.
  51  *
  52  * @author $author$
  53  * @version $Revision$
  54  */
  55 public class IdPanel extends JPanel implements MouseListener,
  56         MouseMotionListener, MouseWheelListener
  57 {
  58   private IdCanvas idCanvas;
  59
  60   protected AlignmentViewport av;
  61
  62   protected AlignmentPanel alignPanel;
  63
  64   ScrollThread scrollThread = null;
  65
  66   String linkImageURL;
  67
  68   int offy;
  69
  70   // int width;
  71   int lastid = -1;
  72
  73   boolean mouseDragging = false;
  74
  75   private final SequenceAnnotationReport seqAnnotReport;
  76
  77   /**
  78    * Creates a new IdPanel object.
  79    *
  80    * @param av
  81    * @param parent
  82    */
  83   public IdPanel(AlignViewport av, AlignmentPanel parent)
  84   {
  85     this.av = av;
  86     alignPanel = parent;
  87     setIdCanvas(new IdCanvas(av));
  88     linkImageURL = getClass().getResource("/images/link.gif").toString();
  89     seqAnnotReport = new SequenceAnnotationReport(linkImageURL);
  90     setLayout(new BorderLayout());
  91     add(getIdCanvas(), BorderLayout.CENTER);
  92     addMouseListener(this);
  93     addMouseMotionListener(this);
  94     addMouseWheelListener(this);
  95     ToolTipManager.sharedInstance().registerComponent(this);
  96   }
  97
  98   /**
  99    * Respond to mouse movement by constructing tooltip text for the sequence id
 100    * under the mouse.
 101    *
 102    * @param e
 103    *          DOCUMENT ME!
 104    */
 105   @Override
 106   public void mouseMoved(MouseEvent e)
 107   {
 108     SeqPanel sp = alignPanel.getSeqPanel();
 109     int seq = Math.max(0, sp.findSeq(e));
 110     if (seq > -1 && seq < av.getAlignment().getHeight())
 111     {
 112       SequenceI sequence = av.getAlignment().getSequenceAt(seq);
 113       StringBuffer tip = new StringBuffer(64);
 114       seqAnnotReport
 115               .createSequenceAnnotationReport(tip, sequence,
 116               av.isShowDBRefs(), av.isShowNPFeats(),
 117                       sp.seqCanvas.fr.getMinMax());
 118       setToolTipText("<html>" + sequence.getDisplayId(true) + " "
 119               + tip.toString() + "</html>");
 120     }
 121   }
 122
 123   /**
 124    * Responds to a mouse drag by selecting the sequences under the dragged
 125    * region.
 126    *
 127    * @param e
 128    */
 129   @Override
 130   public void mouseDragged(MouseEvent e)
 131   {
 132     mouseDragging = true;
 133
 134     int seq = Math.max(0, alignPanel.getSeqPanel().findSeq(e));
 135
 136     if (seq < lastid)
 137     {
 138       selectSeqs(lastid - 1, seq);
 139     }
 140     else if (seq > lastid)
 141     {
 142       selectSeqs(lastid + 1, seq);
 143     }
 144
 145     lastid = seq;
 146     alignPanel.paintAlignment(true);
 147   }
 148
 149   /**
 150    * Response to the mouse wheel by scrolling the alignment panel.
 151    */
 152   @Override
 153   public void mouseWheelMoved(MouseWheelEvent e)
 154   {
 155     e.consume();
 156     if (e.getWheelRotation() > 0)
 157     {
 158       if (e.isShiftDown())
 159       {
 160         alignPanel.scrollRight(true);
 161       }
 162       else
 163       {
 164         alignPanel.scrollUp(false);
 165       }
 166     }
 167     else
 168     {
 169       if (e.isShiftDown())
 170       {
 171         alignPanel.scrollRight(false);
 172       }
 173       else
 174       {
 175         alignPanel.scrollUp(true);
 176       }
 177     }
 178   }
 179
 180   /**
 181    * Handle a mouse click event. Currently only responds to a double-click. The
 182    * action is to try to open a browser window at a URL that searches for the
 183    * selected sequence id. The search URL is configured in Preferences |
 184    * Connections | URL link from Sequence ID. For example:
 185    *
 186    * http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$SEQUENCE_ID$
 187    *
 188    * @param e
 189    */
 190   @Override
 191   public void mouseClicked(MouseEvent e)
 192   {
 193     /*
 194      * Ignore single click. Ignore 'left' click followed by 'right' click (user
 195      * selects a row then its pop-up menu).
 196      */
 197     if (e.getClickCount() < 2 || SwingUtilities.isRightMouseButton(e))
 198     {
 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       UrlLink urlLink = null;
 218       try
 219       {
 220         urlLink = new UrlLink(url);
 221       } catch (Exception foo)
 222       {
 223         Cache.log.error("Exception for URLLink '" + url + "'",
 224                 foo);
 225         url = null;
 226         continue;
 227       }
 228       ;
 229       if (!urlLink.isValid())
 230       {
 231         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       BrowserLauncher.openURL(url);
 248     } catch (Exception ex)
 249     {
 250       JOptionPane
 251               .showInternalMessageDialog(
 252                       Desktop.desktop,
 253                       MessageManager.getString("label.web_browser_not_found_unix"),
 254                       MessageManager.getString("label.web_browser_not_found"), JOptionPane.WARNING_MESSAGE);
 255       ex.printStackTrace();
 256     }
 257   }
 258
 259   /**
 260    * DOCUMENT ME!
 261    *
 262    * @param e
 263    *          DOCUMENT ME!
 264    */
 265   @Override
 266   public void mouseEntered(MouseEvent e)
 267   {
 268     if (scrollThread != null)
 269     {
 270       scrollThread.running = false;
 271     }
 272   }
 273
 274   /**
 275    * DOCUMENT ME!
 276    *
 277    * @param e
 278    *          DOCUMENT ME!
 279    */
 280   @Override
 281   public void mouseExited(MouseEvent e)
 282   {
 283     if (av.getWrapAlignment())
 284     {
 285       return;
 286     }
 287
 288     if (mouseDragging && (e.getY() < 0) && (av.getStartSeq() > 0))
 289     {
 290       scrollThread = new ScrollThread(true);
 291     }
 292
 293     if (mouseDragging && (e.getY() >= getHeight())
 294             && (av.getAlignment().getHeight() > av.getEndSeq()))
 295     {
 296       scrollThread = new ScrollThread(false);
 297     }
 298   }
 299
 300   /**
 301    * Respond to a mouse press. Does nothing for (left) double-click as this is
 302    * handled by mouseClicked().
 303    *
 304    * Right mouse down - construct and show context menu.
 305    *
 306    * Ctrl-down or Shift-down - add to or expand current selection group if there
 307    * is one.
 308    *
 309    * Mouse down - select this sequence.
 310    *
 311    * @param e
 312    */
 313   @Override
 314   public void mousePressed(MouseEvent e)
 315   {
 316     if (e.getClickCount() == 2 && SwingUtilities.isLeftMouseButton(e))
 317     {
 318       return;
 319     }
 320
 321     int seq = alignPanel.getSeqPanel().findSeq(e);
 322
 323     if (SwingUtilities.isRightMouseButton(e))
 324     {
 325       Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq);
 326       // build a new links menu based on the current links + any non-positional
 327       // features
 328       Vector nlinks = new Vector(Preferences.sequenceURLLinks);
 329       SequenceFeature sf[] = sq == null ? null : sq.getSequenceFeatures();
 330       for (int sl = 0; sf != null && sl < sf.length; sl++)
 331       {
 332         if (sf[sl].begin == sf[sl].end && sf[sl].begin == 0)
 333         {
 334           if (sf[sl].links != null && sf[sl].links.size() > 0)
 335           {
 336             for (int l = 0, lSize = sf[sl].links.size(); l < lSize; l++)
 337             {
 338               nlinks.addElement(sf[sl].links.elementAt(l));
 339             }
 340           }
 341         }
 342       }
 343
 344       PopupMenu pop = new PopupMenu(alignPanel, sq,
 345               nlinks, new Vector(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 }