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
  40 import javax.swing.JPanel;
  41 import javax.swing.SwingUtilities;
  42 import javax.swing.ToolTipManager;
  43
  44 /**
  45  * This panel hosts alignment sequence ids and responds to mouse clicks on them,
  46  * as well as highlighting ids matched by a search from the Find menu.
  47  *
  48  * @author $author$
  49  * @version $Revision$
  50  */
  51 public class IdPanel extends JPanel
  52         implements MouseListener, MouseMotionListener, MouseWheelListener
  53 {
  54   private IdCanvas idCanvas;
  55
  56   protected AlignmentViewport av;
  57
  58   protected AlignmentPanel alignPanel;
  59
  60   ScrollThread scrollThread = null;
  61
  62   String linkImageURL;
  63
  64   int offy;
  65
  66   // int width;
  67   int lastid = -1;
  68
  69   boolean mouseDragging = false;
  70
  71   private final SequenceAnnotationReport seqAnnotReport;
  72
  73   /**
  74    * Creates a new IdPanel object.
  75    *
  76    * @param av
  77    * @param parent
  78    */
  79   public IdPanel(AlignViewport av, AlignmentPanel parent)
  80   {
  81     this.av = av;
  82     alignPanel = parent;
  83     setIdCanvas(new IdCanvas(av));
  84     linkImageURL = getClass().getResource("/images/link.gif").toString();
  85     seqAnnotReport = new SequenceAnnotationReport(linkImageURL);
  86     setLayout(new BorderLayout());
  87     add(getIdCanvas(), BorderLayout.CENTER);
  88     addMouseListener(this);
  89     addMouseMotionListener(this);
  90     addMouseWheelListener(this);
  91     ToolTipManager.sharedInstance().registerComponent(this);
  92   }
  93
  94   /**
  95    * Respond to mouse movement by constructing tooltip text for the sequence id
  96    * under the mouse.
  97    *
  98    * @param e
  99    *          DOCUMENT ME!
 100    */
 101   @Override
 102   public void mouseMoved(MouseEvent e)
 103   {
 104     SeqPanel sp = alignPanel.getSeqPanel();
 105     int seq = Math.max(0, sp.findSeq(e));
 106     if (seq > -1 && seq < av.getAlignment().getHeight())
 107     {
 108       SequenceI sequence = av.getAlignment().getSequenceAt(seq);
 109       StringBuilder tip = new StringBuilder(64);
 110       seqAnnotReport.createTooltipAnnotationReport(tip, sequence,
 111               av.isShowDBRefs(), av.isShowNPFeats(),
 112               sp.seqCanvas.fr.getMinMax());
 113       setToolTipText(JvSwingUtils.wrapTooltip(true,
 114               sequence.getDisplayId(true) + " " + tip.toString()));
 115     }
 116   }
 117
 118   /**
 119    * Responds to a mouse drag by selecting the sequences under the dragged
 120    * region.
 121    *
 122    * @param e
 123    */
 124   @Override
 125   public void mouseDragged(MouseEvent e)
 126   {
 127     mouseDragging = true;
 128
 129     int seq = Math.max(0, alignPanel.getSeqPanel().findSeq(e));
 130
 131     if (seq < lastid)
 132     {
 133       selectSeqs(lastid - 1, seq);
 134     }
 135     else if (seq > lastid)
 136     {
 137       selectSeqs(lastid + 1, seq);
 138     }
 139
 140     lastid = seq;
 141     alignPanel.paintAlignment(false);
 142   }
 143
 144   /**
 145    * Response to the mouse wheel by scrolling the alignment panel.
 146    */
 147   @Override
 148   public void mouseWheelMoved(MouseWheelEvent e)
 149   {
 150     e.consume();
 151     if (e.getWheelRotation() > 0)
 152     {
 153       if (e.isShiftDown())
 154       {
 155         av.getRanges().scrollRight(true);
 156       }
 157       else if (!av.getWrapAlignment())
 158       {
 159         av.getRanges().scrollUp(false);
 160       }
 161     }
 162     else
 163     {
 164       if (e.isShiftDown())
 165       {
 166         av.getRanges().scrollRight(false);
 167       }
 168       else if (!av.getWrapAlignment())
 169       {
 170         av.getRanges().scrollUp(true);
 171       }
 172     }
 173   }
 174
 175   /**
 176    * Handle a mouse click event. Currently only responds to a double-click. The
 177    * action is to try to open a browser window at a URL that searches for the
 178    * selected sequence id. The search URL is configured in Preferences |
 179    * Connections | URL link from Sequence ID. For example:
 180    *
 181    * http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$SEQUENCE_ID$
 182    *
 183    * @param e
 184    */
 185   @Override
 186   public void mouseClicked(MouseEvent e)
 187   {
 188     /*
 189      * Ignore single click. Ignore 'left' click followed by 'right' click (user
 190      * selects a row then its pop-up menu).
 191      */
 192     if (e.getClickCount() < 2 || SwingUtilities.isRightMouseButton(e))
 193     {
 194       // reinstate isRightMouseButton check to ignore mouse-related popup events
 195       // note - this does nothing on default MacBookPro force-trackpad config!
 196       return;
 197     }
 198
 199     int seq = alignPanel.getSeqPanel().findSeq(e);
 200     String id = av.getAlignment().getSequenceAt(seq).getName();
 201     String url = Preferences.sequenceUrlLinks.getPrimaryUrl(id);
 202
 203     try
 204     {
 205       jalview.util.BrowserLauncher.openURL(url);
 206     } catch (Exception ex)
 207     {
 208       JvOptionPane.showInternalMessageDialog(Desktop.desktop,
 209               MessageManager.getString("label.web_browser_not_found_unix"),
 210               MessageManager.getString("label.web_browser_not_found"),
 211               JvOptionPane.WARNING_MESSAGE);
 212       ex.printStackTrace();
 213     }
 214   }
 215
 216   /**
 217    * DOCUMENT ME!
 218    *
 219    * @param e
 220    *          DOCUMENT ME!
 221    */
 222   @Override
 223   public void mouseEntered(MouseEvent e)
 224   {
 225     if (scrollThread != null)
 226     {
 227       scrollThread.running = false;
 228     }
 229   }
 230
 231   /**
 232    * DOCUMENT ME!
 233    *
 234    * @param e
 235    *          DOCUMENT ME!
 236    */
 237   @Override
 238   public void mouseExited(MouseEvent e)
 239   {
 240     if (av.getWrapAlignment())
 241     {
 242       return;
 243     }
 244
 245     if (mouseDragging && (e.getY() < 0)
 246             && (av.getRanges().getStartSeq() > 0))
 247     {
 248       scrollThread = new ScrollThread(true);
 249     }
 250
 251     if (mouseDragging && (e.getY() >= getHeight())
 252             && (av.getAlignment().getHeight() > av.getRanges().getEndSeq()))
 253     {
 254       scrollThread = new ScrollThread(false);
 255     }
 256   }
 257
 258   /**
 259    * Respond to a mouse press. Does nothing for (left) double-click as this is
 260    * handled by mouseClicked().
 261    *
 262    * Right mouse down - construct and show context menu.
 263    *
 264    * Ctrl-down or Shift-down - add to or expand current selection group if there
 265    * is one.
 266    *
 267    * Mouse down - select this sequence.
 268    *
 269    * @param e
 270    */
 271   @Override
 272   public void mousePressed(MouseEvent e)
 273   {
 274     if (e.getClickCount() == 2 && SwingUtilities.isLeftMouseButton(e))
 275     {
 276       return;
 277     }
 278
 279     if (e.isPopupTrigger()) // Mac reports this in mousePressed
 280     {
 281       showPopupMenu(e);
 282       return;
 283     }
 284
 285     /*
 286      * defer right-mouse click handling to mouseReleased on Windows
 287      * (where isPopupTrigger() will answer true)
 288      * NB isRightMouseButton is also true for Cmd-click on Mac
 289      */
 290     if (SwingUtilities.isRightMouseButton(e) && !Platform.isAMac())
 291     {
 292       return;
 293     }
 294
 295     if ((av.getSelectionGroup() == null)
 296             || (!jalview.util.Platform.isControlDown(e) && !e.isShiftDown()
 297                     && av.getSelectionGroup() != null))
 298     {
 299       av.setSelectionGroup(new SequenceGroup());
 300       av.getSelectionGroup().setStartRes(0);
 301       av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1);
 302     }
 303
 304     int seq = alignPanel.getSeqPanel().findSeq(e);
 305     if (e.isShiftDown() && (lastid != -1))
 306     {
 307       selectSeqs(lastid, seq);
 308     }
 309     else
 310     {
 311       selectSeq(seq);
 312     }
 313
 314     av.isSelectionGroupChanged(true);
 315
 316     alignPanel.paintAlignment(false);
 317   }
 318
 319   /**
 320    * Build and show the popup-menu at the right-click mouse position
 321    *
 322    * @param e
 323    */
 324   void showPopupMenu(MouseEvent e)
 325   {
 326     int seq2 = alignPanel.getSeqPanel().findSeq(e);
 327     Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq2);
 328     // build a new links menu based on the current links + any non-positional
 329     // features
 330     List<String> nlinks = Preferences.sequenceUrlLinks.getLinksForMenu();
 331     SequenceFeature sfs[] = sq == null ? null : sq.getSequenceFeatures();
 332     if (sfs != null)
 333     {
 334       for (SequenceFeature sf : sfs)
 335       {
 336         if (sf.begin == sf.end && sf.begin == 0)
 337         {
 338           if (sf.links != null && sf.links.size() > 0)
 339           {
 340             for (int l = 0, lSize = sf.links.size(); l < lSize; l++)
 341             {
 342               nlinks.add(sf.links.elementAt(l));
 343             }
 344           }
 345         }
 346       }
 347     }
 348
 349     PopupMenu pop = new PopupMenu(alignPanel, sq, nlinks,
 350             Preferences.getGroupURLLinks());
 351     pop.show(this, e.getX(), e.getY());
 352   }
 353
 354   /**
 355    * Toggle whether the sequence is part of the current selection group.
 356    *
 357    * @param seq
 358    */
 359   void selectSeq(int seq)
 360   {
 361     lastid = seq;
 362
 363     SequenceI pickedSeq = av.getAlignment().getSequenceAt(seq);
 364     av.getSelectionGroup().addOrRemove(pickedSeq, true);
 365   }
 366
 367   /**
 368    * Add contiguous rows of the alignment to the current selection group. Does
 369    * nothing if there is no selection group.
 370    *
 371    * @param start
 372    * @param end
 373    */
 374   void selectSeqs(int start, int end)
 375   {
 376     if (av.getSelectionGroup() == null)
 377     {
 378       return;
 379     }
 380
 381     if (end >= av.getAlignment().getHeight())
 382     {
 383       end = av.getAlignment().getHeight() - 1;
 384     }
 385
 386     lastid = start;
 387
 388     if (end < start)
 389     {
 390       int tmp = start;
 391       start = end;
 392       end = tmp;
 393       lastid = end;
 394     }
 395
 396     for (int i = start; i <= end; i++)
 397     {
 398       av.getSelectionGroup().addSequence(av.getAlignment().getSequenceAt(i),
 399               i == end);
 400     }
 401   }
 402
 403   /**
 404    * Respond to mouse released. Refreshes the display and triggers broadcast of
 405    * the new selection group to any listeners.
 406    *
 407    * @param e
 408    */
 409   @Override
 410   public void mouseReleased(MouseEvent e)
 411   {
 412     if (scrollThread != null)
 413     {
 414       scrollThread.running = false;
 415     }
 416
 417     mouseDragging = false;
 418     PaintRefresher.Refresh(this, av.getSequenceSetId());
 419     // always send selection message when mouse is released
 420     av.sendSelection();
 421
 422     if (e.isPopupTrigger()) // Windows reports this in mouseReleased
 423     {
 424       showPopupMenu(e);
 425     }
 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.getRanges().getStartSeq() > index)
 447             || (av.getRanges().getEndSeq() < index))
 448     {
 449       av.getRanges().setStartSeq(index);
 450     }
 451   }
 452
 453   public IdCanvas getIdCanvas()
 454   {
 455     return idCanvas;
 456   }
 457
 458   public void setIdCanvas(IdCanvas idCanvas)
 459   {
 460     this.idCanvas = idCanvas;
 461   }
 462
 463   // this class allows scrolling off the bottom of the visible alignment
 464   class ScrollThread extends Thread
 465   {
 466     boolean running = false;
 467
 468     boolean up = true;
 469
 470     public ScrollThread(boolean up)
 471     {
 472       this.up = up;
 473       start();
 474     }
 475
 476     public void stopScrolling()
 477     {
 478       running = false;
 479     }
 480
 481     @Override
 482     public void run()
 483     {
 484       running = true;
 485
 486       while (running)
 487       {
 488         if (av.getRanges().scrollUp(up))
 489         {
 490           // scroll was ok, so add new sequence to selection
 491           int seq = av.getRanges().getStartSeq();
 492
 493           if (!up)
 494           {
 495             seq = av.getRanges().getEndSeq();
 496           }
 497
 498           if (seq < lastid)
 499           {
 500             selectSeqs(lastid - 1, seq);
 501           }
 502           else if (seq > lastid)
 503           {
 504             selectSeqs(lastid + 1, seq);
 505           }
 506
 507           lastid = seq;
 508         }
 509         else
 510         {
 511           running = false;
 512         }
 513
 514         alignPanel.paintAlignment(false);
 515
 516         try
 517         {
 518           Thread.sleep(100);
 519         } catch (Exception ex)
 520         {
 521         }
 522       }
 523     }
 524   }
 525 }