src/jalview/appletgui/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.appletgui;
  22
  23 import static jalview.util.UrlConstants.EMBLEBI_STRING;
  24 import static jalview.util.UrlConstants.SRS_STRING;
  25
  26 import jalview.datamodel.Sequence;
  27 import jalview.datamodel.SequenceFeature;
  28 import jalview.datamodel.SequenceGroup;
  29 import jalview.datamodel.SequenceI;
  30 import jalview.util.UrlLink;
  31 import jalview.viewmodel.AlignmentViewport;
  32
  33 import java.awt.BorderLayout;
  34 import java.awt.Panel;
  35 import java.awt.event.InputEvent;
  36 import java.awt.event.MouseEvent;
  37 import java.awt.event.MouseListener;
  38 import java.awt.event.MouseMotionListener;
  39 import java.util.List;
  40 import java.util.Vector;
  41
  42 public class IdPanel extends Panel implements MouseListener,
  43         MouseMotionListener
  44 {
  45
  46   protected IdCanvas idCanvas;
  47
  48   protected AlignmentViewport av;
  49
  50   protected AlignmentPanel alignPanel;
  51
  52   ScrollThread scrollThread = null;
  53
  54   int lastid = -1;
  55
  56   boolean mouseDragging = false;
  57
  58   java.util.Vector links = new java.util.Vector();
  59
  60   public IdPanel(AlignViewport av, AlignmentPanel parent)
  61   {
  62     this.av = av;
  63     alignPanel = parent;
  64     idCanvas = new IdCanvas(av);
  65     setLayout(new BorderLayout());
  66     add(idCanvas, BorderLayout.CENTER);
  67     idCanvas.addMouseListener(this);
  68     idCanvas.addMouseMotionListener(this);
  69
  70     String label, url;
  71     // TODO: add in group link parameter
  72     if (av.applet != null)
  73     {
  74       for (int i = 1; i < 10; i++)
  75       {
  76         label = av.applet.getParameter("linkLabel_" + i);
  77         url = av.applet.getParameter("linkURL_" + i);
  78
  79         if (label != null && url != null)
  80         {
  81           links.addElement(label + "|" + url);
  82         }
  83
  84       }
  85     }
  86     {
  87       // upgrade old SRS link
  88       int srsPos = links.indexOf(SRS_STRING);
  89       if (srsPos > -1)
  90       {
  91         links.setElementAt(EMBLEBI_STRING, srsPos);
  92       }
  93     }
  94     if (links.size() < 1)
  95     {
  96       links = new java.util.Vector();
  97       links.addElement(EMBLEBI_STRING);
  98     }
  99   }
 100
 101   Tooltip tooltip;
 102
 103   @Override
 104   public void mouseMoved(MouseEvent e)
 105   {
 106     int seq = alignPanel.seqPanel.findSeq(e);
 107
 108     SequenceI sequence = av.getAlignment().getSequenceAt(seq);
 109
 110     // look for non-pos features
 111     StringBuffer tooltiptext = new StringBuffer();
 112     if (sequence != null)
 113     {
 114       if (sequence.getDescription() != null)
 115       {
 116         tooltiptext.append(sequence.getDescription());
 117         tooltiptext.append("\n");
 118       }
 119
 120       SequenceFeature sf[] = sequence.getSequenceFeatures();
 121       for (int sl = 0; sf != null && sl < sf.length; sl++)
 122       {
 123         if (sf[sl].begin == sf[sl].end && sf[sl].begin == 0)
 124         {
 125           boolean nl = false;
 126           if (sf[sl].getFeatureGroup() != null)
 127           {
 128             tooltiptext.append(sf[sl].getFeatureGroup());
 129             nl = true;
 130           }
 131           ;
 132           if (sf[sl].getType() != null)
 133           {
 134             tooltiptext.append(" ");
 135             tooltiptext.append(sf[sl].getType());
 136             nl = true;
 137           }
 138           ;
 139           if (sf[sl].getDescription() != null)
 140           {
 141             tooltiptext.append(" ");
 142             tooltiptext.append(sf[sl].getDescription());
 143             nl = true;
 144           }
 145           ;
 146           if (!Float.isNaN(sf[sl].getScore()) && sf[sl].getScore() != 0f)
 147           {
 148             tooltiptext.append(" Score = ");
 149             tooltiptext.append(sf[sl].getScore());
 150             nl = true;
 151           }
 152           ;
 153           if (sf[sl].getStatus() != null && sf[sl].getStatus().length() > 0)
 154           {
 155             tooltiptext.append(" (");
 156             tooltiptext.append(sf[sl].getStatus());
 157             tooltiptext.append(")");
 158             nl = true;
 159           }
 160           ;
 161           if (nl)
 162           {
 163             tooltiptext.append("\n");
 164           }
 165         }
 166       }
 167     }
 168     if (tooltiptext.length() == 0)
 169     {
 170       // nothing to display - so clear tooltip if one is visible
 171       if (tooltip != null)
 172       {
 173         tooltip.setVisible(false);
 174       }
 175       tooltip = null;
 176       tooltiptext = null;
 177       return;
 178     }
 179     if (tooltip == null)
 180     {
 181       tooltip = new Tooltip(sequence.getDisplayId(true) + "\n"
 182               + tooltiptext.toString(), idCanvas);
 183     }
 184     else
 185     {
 186       tooltip.setTip(sequence.getDisplayId(true) + "\n"
 187               + tooltiptext.toString());
 188     }
 189     tooltiptext = null;
 190   }
 191
 192   @Override
 193   public void mouseDragged(MouseEvent e)
 194   {
 195     mouseDragging = true;
 196
 197     int seq = Math.max(0, alignPanel.seqPanel.findSeq(e));
 198
 199     if (seq < lastid)
 200     {
 201       selectSeqs(lastid - 1, seq);
 202     }
 203     else if (seq > lastid)
 204     {
 205       selectSeqs(lastid + 1, seq);
 206     }
 207
 208     lastid = seq;
 209     alignPanel.paintAlignment(false);
 210   }
 211
 212   @Override
 213   public void mouseClicked(MouseEvent e)
 214   {
 215     if (e.getClickCount() < 2)
 216     {
 217       return;
 218     }
 219
 220     // DEFAULT LINK IS FIRST IN THE LINK LIST
 221     int seq = alignPanel.seqPanel.findSeq(e);
 222     SequenceI sq = av.getAlignment().getSequenceAt(seq);
 223     if (sq == null)
 224     {
 225       return;
 226     }
 227     String id = sq.getName();
 228
 229     String target = null;
 230     String url = null;
 231     int i = 0;
 232     while (url == null && i < links.size())
 233     {
 234       // DEFAULT LINK IS FIRST IN THE LINK LIST
 235       // BUT IF ITS A REGEX AND DOES NOT MATCH THE NEXT ONE WILL BE TRIED
 236       url = links.elementAt(i++).toString();
 237       jalview.util.UrlLink urlLink = null;
 238       try
 239       {
 240         urlLink = new UrlLink(url);
 241         target = urlLink.getTarget();
 242       } catch (Exception foo)
 243       {
 244         System.err.println("Exception for URLLink '" + url + "'");
 245         foo.printStackTrace();
 246         url = null;
 247         continue;
 248       }
 249       ;
 250
 251       if (urlLink.usesSeqId())
 252       {
 253         // this URL requires an accession id, not the name of a sequence
 254         url = null;
 255         continue;
 256       }
 257
 258       if (!urlLink.isValid())
 259       {
 260         System.err.println(urlLink.getInvalidMessage());
 261         url = null;
 262         continue;
 263       }
 264
 265       String urls[] = urlLink.makeUrls(id, true);
 266       if (urls == null || urls[0] == null || urls[0].length() < 1)
 267       {
 268         url = null;
 269         continue;
 270       }
 271       // just take first URL made from regex
 272       url = urls[1];
 273     }
 274     try
 275     {
 276
 277       alignPanel.alignFrame.showURL(url, target);
 278     } catch (Exception ex)
 279     {
 280       ex.printStackTrace();
 281     }
 282   }
 283
 284   @Override
 285   public void mouseEntered(MouseEvent e)
 286   {
 287     if (scrollThread != null)
 288     {
 289       scrollThread.running = false;
 290     }
 291   }
 292
 293   @Override
 294   public void mouseExited(MouseEvent e)
 295   {
 296     if (av.getWrapAlignment())
 297     {
 298       return;
 299     }
 300
 301     if (mouseDragging && e.getY() < 0 && av.getStartSeq() > 0)
 302     {
 303       scrollThread = new ScrollThread(true);
 304     }
 305
 306     if (mouseDragging && e.getY() >= getSize().height
 307             && av.getAlignment().getHeight() > av.getEndSeq())
 308     {
 309       scrollThread = new ScrollThread(false);
 310     }
 311   }
 312
 313   @Override
 314   public void mousePressed(MouseEvent e)
 315   {
 316     if (e.getClickCount() > 1)
 317     {
 318       return;
 319     }
 320
 321     int y = e.getY();
 322     if (av.getWrapAlignment())
 323     {
 324       y -= 2 * av.getCharHeight();
 325     }
 326
 327     int seq = alignPanel.seqPanel.findSeq(e);
 328
 329     if ((e.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
 330     {
 331       Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq);
 332
 333       // build a new links menu based on the current links + any non-positional
 334       // features
 335       Vector nlinks = new Vector();
 336       for (int l = 0, lSize = links.size(); l < lSize; l++)
 337       {
 338         nlinks.addElement(links.elementAt(l));
 339       }
 340       SequenceFeature sf[] = sq == null ? null : sq.getSequenceFeatures();
 341       for (int sl = 0; sf != null && sl < sf.length; sl++)
 342       {
 343         if (sf[sl].begin == sf[sl].end && sf[sl].begin == 0)
 344         {
 345           if (sf[sl].links != null && sf[sl].links.size() > 0)
 346           {
 347             for (int l = 0, lSize = sf[sl].links.size(); l < lSize; l++)
 348             {
 349               nlinks.addElement(sf[sl].links.elementAt(l));
 350             }
 351           }
 352         }
 353       }
 354
 355       APopupMenu popup = new APopupMenu(alignPanel, sq, nlinks);
 356       this.add(popup);
 357       popup.show(this, e.getX(), e.getY());
 358       return;
 359     }
 360
 361     if ((av.getSelectionGroup() == null)
 362             || ((!jalview.util.Platform.isControlDown(e) && !e
 363                     .isShiftDown()) && av.getSelectionGroup() != null))
 364     {
 365       av.setSelectionGroup(new SequenceGroup());
 366       av.getSelectionGroup().setStartRes(0);
 367       av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1);
 368     }
 369
 370     if (e.isShiftDown() && lastid != -1)
 371     {
 372       selectSeqs(lastid, seq);
 373     }
 374     else
 375     {
 376       selectSeq(seq);
 377     }
 378
 379     alignPanel.paintAlignment(false);
 380   }
 381
 382   void selectSeq(int seq)
 383   {
 384     lastid = seq;
 385     SequenceI pickedSeq = av.getAlignment().getSequenceAt(seq);
 386     av.getSelectionGroup().addOrRemove(pickedSeq, true);
 387   }
 388
 389   void selectSeqs(int start, int end)
 390   {
 391
 392     lastid = start;
 393
 394     if (end >= av.getAlignment().getHeight())
 395     {
 396       end = av.getAlignment().getHeight() - 1;
 397     }
 398
 399     if (end < start)
 400     {
 401       int tmp = start;
 402       start = end;
 403       end = tmp;
 404       lastid = end;
 405     }
 406     if (av.getSelectionGroup() == null)
 407     {
 408       av.setSelectionGroup(new SequenceGroup());
 409     }
 410     for (int i = start; i <= end; i++)
 411     {
 412       av.getSelectionGroup().addSequence(
 413               av.getAlignment().getSequenceAt(i), i == end);
 414     }
 415
 416   }
 417
 418   @Override
 419   public void mouseReleased(MouseEvent e)
 420   {
 421     if (scrollThread != null)
 422     {
 423       scrollThread.running = false;
 424     }
 425
 426     if (av.getSelectionGroup() != null)
 427     {
 428       av.getSelectionGroup().recalcConservation();
 429     }
 430
 431     mouseDragging = false;
 432     PaintRefresher.Refresh(this, av.getSequenceSetId());
 433     // always send selection message when mouse is released
 434     av.sendSelection();
 435   }
 436
 437   public void highlightSearchResults(List<SequenceI> list)
 438   {
 439     idCanvas.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   // this class allows scrolling off the bottom of the visible alignment
 456   class ScrollThread extends Thread
 457   {
 458     boolean running = false;
 459
 460     boolean up = true;
 461
 462     public ScrollThread(boolean up)
 463     {
 464       this.up = up;
 465       start();
 466     }
 467
 468     public void stopScrolling()
 469     {
 470       running = false;
 471     }
 472
 473     @Override
 474     public void run()
 475     {
 476       running = true;
 477       while (running)
 478       {
 479         if (alignPanel.scrollUp(up))
 480         {
 481           // scroll was ok, so add new sequence to selection
 482           int seq = av.getStartSeq();
 483           if (!up)
 484           {
 485             seq = av.getEndSeq();
 486           }
 487
 488           if (seq < lastid)
 489           {
 490             selectSeqs(lastid - 1, seq);
 491           }
 492           else if (seq > lastid && seq < av.getAlignment().getHeight())
 493           {
 494             selectSeqs(lastid + 1, seq);
 495           }
 496
 497           lastid = seq;
 498         }
 499         else
 500         {
 501           running = false;
 502         }
 503
 504         alignPanel.paintAlignment(true);
 505         try
 506         {
 507           Thread.sleep(100);
 508         } catch (Exception ex)
 509         {
 510         }
 511       }
 512     }
 513   }
 514 }