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.ArrayList;
  39 import java.util.List;
  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("<html>" + sequence.getDisplayId(true) + " "
 116               + tip.toString() + "</html>");
 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     List<String> links = Preferences.getSequenceURLLinks();
 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.get(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   @Override
 256   public void mouseEntered(MouseEvent e)
 257   {
 258     if (scrollThread != null)
 259     {
 260       scrollThread.running = false;
 261     }
 262   }
 263
 264   @Override
 265   public void mouseExited(MouseEvent e)
 266   {
 267     if (av.getWrapAlignment())
 268     {
 269       return;
 270     }
 271
 272     if (mouseDragging && (e.getY() < 0) && (av.getStartSeq() > 0))
 273     {
 274       scrollThread = new ScrollThread(true);
 275     }
 276
 277     if (mouseDragging && (e.getY() >= getHeight())
 278             && (av.getAlignment().getHeight() > av.getEndSeq()))
 279     {
 280       scrollThread = new ScrollThread(false);
 281     }
 282   }
 283
 284   /**
 285    * Respond to a mouse press. Does nothing for (left) double-click as this is
 286    * handled by mouseClicked().
 287    *
 288    * Right mouse down - construct and show context menu.
 289    *
 290    * Ctrl-down or Shift-down - add to or expand current selection group if there
 291    * is one.
 292    *
 293    * Mouse down - select this sequence.
 294    *
 295    * @param e
 296    */
 297   @Override
 298   public void mousePressed(MouseEvent e)
 299   {
 300     if (e.getClickCount() == 2 && SwingUtilities.isLeftMouseButton(e))
 301     {
 302       return;
 303     }
 304
 305     int seq = alignPanel.getSeqPanel().findSeq(e);
 306
 307     if (SwingUtilities.isRightMouseButton(e))
 308     {
 309       Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq);
 310       // build a new links menu based on the current links + any non-positional
 311       // features
 312       List<String> nlinks = new ArrayList<String>(
 313               Preferences.getSequenceURLLinks());
 314       SequenceFeature sf[] = sq == null ? null : sq.getSequenceFeatures();
 315       for (int sl = 0; sf != null && sl < sf.length; sl++)
 316       {
 317         if (sf[sl].begin == sf[sl].end && sf[sl].begin == 0)
 318         {
 319           if (sf[sl].links != null && sf[sl].links.size() > 0)
 320           {
 321             for (int l = 0, lSize = sf[sl].links.size(); l < lSize; l++)
 322             {
 323               nlinks.add(sf[sl].links.elementAt(l));
 324             }
 325           }
 326         }
 327       }
 328
 329       PopupMenu pop = new PopupMenu(alignPanel, sq, nlinks,
 330               Preferences.getGroupURLLinks());
 331       pop.show(this, e.getX(), e.getY());
 332
 333       return;
 334     }
 335
 336     if ((av.getSelectionGroup() == null)
 337             || ((!e.isControlDown() && !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     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    * Toggle whether the sequence is part of the current selection group.
 361    *
 362    * @param seq
 363    */
 364   void selectSeq(int seq)
 365   {
 366     lastid = seq;
 367
 368     SequenceI pickedSeq = av.getAlignment().getSequenceAt(seq);
 369     av.getSelectionGroup().addOrRemove(pickedSeq, true);
 370   }
 371
 372   /**
 373    * Add contiguous rows of the alignment to the current selection group. Does
 374    * nothing if there is no selection group.
 375    *
 376    * @param start
 377    * @param end
 378    */
 379   void selectSeqs(int start, int end)
 380   {
 381     if (av.getSelectionGroup() == null)
 382     {
 383       return;
 384     }
 385
 386     if (end >= av.getAlignment().getHeight())
 387     {
 388       end = av.getAlignment().getHeight() - 1;
 389     }
 390
 391     lastid = start;
 392
 393     if (end < start)
 394     {
 395       int tmp = start;
 396       start = end;
 397       end = tmp;
 398       lastid = end;
 399     }
 400
 401     for (int i = start; i <= end; i++)
 402     {
 403       av.getSelectionGroup().addSequence(
 404               av.getAlignment().getSequenceAt(i), i == end);
 405     }
 406   }
 407
 408   /**
 409    * Respond to mouse released. Refreshes the display and triggers broadcast of
 410    * the new selection group to any listeners.
 411    *
 412    * @param e
 413    */
 414   @Override
 415   public void mouseReleased(MouseEvent e)
 416   {
 417     if (scrollThread != null)
 418     {
 419       scrollThread.running = false;
 420     }
 421
 422     mouseDragging = false;
 423     PaintRefresher.Refresh(this, av.getSequenceSetId());
 424     // always send selection message when mouse is released
 425     av.sendSelection();
 426   }
 427
 428   /**
 429    * Highlight sequence ids that match the given list, and if necessary scroll
 430    * to the start sequence of the list.
 431    *
 432    * @param list
 433    */
 434   public void highlightSearchResults(List<SequenceI> list)
 435   {
 436     getIdCanvas().setHighlighted(list);
 437
 438     if (list == null)
 439     {
 440       return;
 441     }
 442
 443     int index = av.getAlignment().findIndex(list.get(0));
 444
 445     // do we need to scroll the panel?
 446     if ((av.getStartSeq() > index) || (av.getEndSeq() < index))
 447     {
 448       alignPanel.setScrollValues(av.getStartRes(), index);
 449     }
 450   }
 451
 452   public IdCanvas getIdCanvas()
 453   {
 454     return idCanvas;
 455   }
 456
 457   public void setIdCanvas(IdCanvas idCanvas)
 458   {
 459     this.idCanvas = idCanvas;
 460   }
 461
 462   // this class allows scrolling off the bottom of the visible alignment
 463   class ScrollThread extends Thread
 464   {
 465     boolean running = false;
 466
 467     boolean up = true;
 468
 469     public ScrollThread(boolean up)
 470     {
 471       this.up = up;
 472       start();
 473     }
 474
 475     public void stopScrolling()
 476     {
 477       running = false;
 478     }
 479
 480     @Override
 481     public void run()
 482     {
 483       running = true;
 484
 485       while (running)
 486       {
 487         if (alignPanel.scrollUp(up))
 488         {
 489           // scroll was ok, so add new sequence to selection
 490           int seq = av.getStartSeq();
 491
 492           if (!up)
 493           {
 494             seq = av.getEndSeq();
 495           }
 496
 497           if (seq < lastid)
 498           {
 499             selectSeqs(lastid - 1, seq);
 500           }
 501           else if (seq > lastid)
 502           {
 503             selectSeqs(lastid + 1, seq);
 504           }
 505
 506           lastid = seq;
 507         }
 508         else
 509         {
 510           running = false;
 511         }
 512
 513         alignPanel.paintAlignment(false);
 514
 515         try
 516         {
 517           Thread.sleep(100);
 518         } catch (Exception ex)
 519         {
 520         }
 521       }
 522     }
 523   }
 524 }