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       if (urlLink.usesDBAccession())
 251       {
 252         // this URL requires an accession id, not the name of a sequence
 253         url = null;
 254         continue;
 255       }
 256
 257       if (!urlLink.isValid())
 258       {
 259         System.err.println(urlLink.getInvalidMessage());
 260         url = null;
 261         continue;
 262       }
 263
 264       String urls[] = urlLink.makeUrls(id, true);
 265       if (urls == null || urls[0] == null || urls[0].length() < 1)
 266       {
 267         url = null;
 268         continue;
 269       }
 270       // just take first URL made from regex
 271       url = urls[1];
 272     }
 273     try
 274     {
 275
 276       alignPanel.alignFrame.showURL(url, target);
 277     } catch (Exception ex)
 278     {
 279       ex.printStackTrace();
 280     }
 281   }
 282
 283   @Override
 284   public void mouseEntered(MouseEvent e)
 285   {
 286     if (scrollThread != null)
 287     {
 288       scrollThread.running = false;
 289     }
 290   }
 291
 292   @Override
 293   public void mouseExited(MouseEvent e)
 294   {
 295     if (av.getWrapAlignment())
 296     {
 297       return;
 298     }
 299
 300     if (mouseDragging && e.getY() < 0 && av.getStartSeq() > 0)
 301     {
 302       scrollThread = new ScrollThread(true);
 303     }
 304
 305     if (mouseDragging && e.getY() >= getSize().height
 306             && av.getAlignment().getHeight() > av.getEndSeq())
 307     {
 308       scrollThread = new ScrollThread(false);
 309     }
 310   }
 311
 312   @Override
 313   public void mousePressed(MouseEvent e)
 314   {
 315     if (e.getClickCount() > 1)
 316     {
 317       return;
 318     }
 319
 320     int y = e.getY();
 321     if (av.getWrapAlignment())
 322     {
 323       y -= 2 * av.getCharHeight();
 324     }
 325
 326     int seq = alignPanel.seqPanel.findSeq(e);
 327
 328     if ((e.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
 329     {
 330       Sequence sq = (Sequence) av.getAlignment().getSequenceAt(seq);
 331
 332       // build a new links menu based on the current links + any non-positional
 333       // features
 334       Vector nlinks = new Vector();
 335       for (int l = 0, lSize = links.size(); l < lSize; l++)
 336       {
 337         nlinks.addElement(links.elementAt(l));
 338       }
 339       SequenceFeature sf[] = sq == null ? null : sq.getSequenceFeatures();
 340       for (int sl = 0; sf != null && sl < sf.length; sl++)
 341       {
 342         if (sf[sl].begin == sf[sl].end && sf[sl].begin == 0)
 343         {
 344           if (sf[sl].links != null && sf[sl].links.size() > 0)
 345           {
 346             for (int l = 0, lSize = sf[sl].links.size(); l < lSize; l++)
 347             {
 348               nlinks.addElement(sf[sl].links.elementAt(l));
 349             }
 350           }
 351         }
 352       }
 353
 354       APopupMenu popup = new APopupMenu(alignPanel, sq, nlinks);
 355       this.add(popup);
 356       popup.show(this, e.getX(), e.getY());
 357       return;
 358     }
 359
 360     if ((av.getSelectionGroup() == null)
 361             || ((!jalview.util.Platform.isControlDown(e) && !e
 362                     .isShiftDown()) && av.getSelectionGroup() != null))
 363     {
 364       av.setSelectionGroup(new SequenceGroup());
 365       av.getSelectionGroup().setStartRes(0);
 366       av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1);
 367     }
 368
 369     if (e.isShiftDown() && lastid != -1)
 370     {
 371       selectSeqs(lastid, seq);
 372     }
 373     else
 374     {
 375       selectSeq(seq);
 376     }
 377
 378     alignPanel.paintAlignment(false);
 379   }
 380
 381   void selectSeq(int seq)
 382   {
 383     lastid = seq;
 384     SequenceI pickedSeq = av.getAlignment().getSequenceAt(seq);
 385     av.getSelectionGroup().addOrRemove(pickedSeq, true);
 386   }
 387
 388   void selectSeqs(int start, int end)
 389   {
 390
 391     lastid = start;
 392
 393     if (end >= av.getAlignment().getHeight())
 394     {
 395       end = av.getAlignment().getHeight() - 1;
 396     }
 397
 398     if (end < start)
 399     {
 400       int tmp = start;
 401       start = end;
 402       end = tmp;
 403       lastid = end;
 404     }
 405     if (av.getSelectionGroup() == null)
 406     {
 407       av.setSelectionGroup(new SequenceGroup());
 408     }
 409     for (int i = start; i <= end; i++)
 410     {
 411       av.getSelectionGroup().addSequence(
 412               av.getAlignment().getSequenceAt(i), i == end);
 413     }
 414
 415   }
 416
 417   @Override
 418   public void mouseReleased(MouseEvent e)
 419   {
 420     if (scrollThread != null)
 421     {
 422       scrollThread.running = false;
 423     }
 424
 425     if (av.getSelectionGroup() != null)
 426     {
 427       av.getSelectionGroup().recalcConservation();
 428     }
 429
 430     mouseDragging = false;
 431     PaintRefresher.Refresh(this, av.getSequenceSetId());
 432     // always send selection message when mouse is released
 433     av.sendSelection();
 434   }
 435
 436   public void highlightSearchResults(List<SequenceI> list)
 437   {
 438     idCanvas.setHighlighted(list);
 439
 440     if (list == null)
 441     {
 442       return;
 443     }
 444
 445     int index = av.getAlignment().findIndex(list.get(0));
 446
 447     // do we need to scroll the panel?
 448     if (av.getStartSeq() > index || av.getEndSeq() < index)
 449     {
 450       alignPanel.setScrollValues(av.getStartRes(), index);
 451     }
 452   }
 453
 454   // this class allows scrolling off the bottom of the visible alignment
 455   class ScrollThread extends Thread
 456   {
 457     boolean running = false;
 458
 459     boolean up = true;
 460
 461     public ScrollThread(boolean up)
 462     {
 463       this.up = up;
 464       start();
 465     }
 466
 467     public void stopScrolling()
 468     {
 469       running = false;
 470     }
 471
 472     @Override
 473     public void run()
 474     {
 475       running = true;
 476       while (running)
 477       {
 478         if (alignPanel.scrollUp(up))
 479         {
 480           // scroll was ok, so add new sequence to selection
 481           int seq = av.getStartSeq();
 482           if (!up)
 483           {
 484             seq = av.getEndSeq();
 485           }
 486
 487           if (seq < lastid)
 488           {
 489             selectSeqs(lastid - 1, seq);
 490           }
 491           else if (seq > lastid && seq < av.getAlignment().getHeight())
 492           {
 493             selectSeqs(lastid + 1, seq);
 494           }
 495
 496           lastid = seq;
 497         }
 498         else
 499         {
 500           running = false;
 501         }
 502
 503         alignPanel.paintAlignment(true);
 504         try
 505         {
 506           Thread.sleep(100);
 507         } catch (Exception ex)
 508         {
 509         }
 510       }
 511     }
 512   }
 513 }