src/jalview/gui/IdPanel.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  *\r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  *\r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  *\r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.gui;\r
  20 \r
  21 import jalview.datamodel.*;\r
  22 \r
  23 import java.awt.*;\r
  24 import java.awt.event.*;\r
  25 \r
  26 import javax.swing.*;\r
  27 \r
  28 \r
  29 /**\r
  30  * DOCUMENT ME!\r
  31  *\r
  32  * @author $author$\r
  33  * @version $Revision$\r
  34  */\r
  35 public class IdPanel extends JPanel implements MouseListener,\r
  36     MouseMotionListener\r
  37 {\r
  38     protected IdCanvas idCanvas;\r
  39     protected AlignViewport av;\r
  40     protected AlignmentPanel alignPanel;\r
  41     ScrollThread scrollThread = null;\r
  42     int offy;\r
  43     int width;\r
  44     int lastid = -1;\r
  45     boolean mouseDragging = false;\r
  46 \r
  47     /**\r
  48      * Creates a new IdPanel object.\r
  49      *\r
  50      * @param av DOCUMENT ME!\r
  51      * @param parent DOCUMENT ME!\r
  52      */\r
  53     public IdPanel(AlignViewport av, AlignmentPanel parent)\r
  54     {\r
  55         this.av = av;\r
  56         alignPanel = parent;\r
  57         idCanvas = new IdCanvas(av);\r
  58         setLayout(new BorderLayout());\r
  59         add(idCanvas, BorderLayout.CENTER);\r
  60         addMouseListener(this);\r
  61         addMouseMotionListener(this);\r
  62         ToolTipManager.sharedInstance().registerComponent(this);\r
  63     }\r
  64 \r
  65     /**\r
  66      * DOCUMENT ME!\r
  67      *\r
  68      * @param e DOCUMENT ME!\r
  69      */\r
  70     public void mouseMoved(MouseEvent e)\r
  71     {\r
  72       int y = e.getY();\r
  73 \r
  74       if (av.getWrapAlignment())\r
  75       {\r
  76         y = getWrappedY(y);\r
  77       }\r
  78 \r
  79       final int seq = av.getIndex(y);\r
  80       if(seq!=-1)\r
  81       {\r
  82         SequenceI sequence = av.alignment.getSequenceAt(seq);\r
  83         StringBuffer tip = new StringBuffer("<html>");\r
  84         tip.append(sequence.getDisplayId(true));\r
  85         if (av.alignment.getSequenceAt(seq).getDescription() != null)\r
  86         {\r
  87           tip.append("<table width=250 border=0><tr><td><i>");\r
  88           tip.append(av.alignment.getSequenceAt(seq).getDescription());\r
  89 \r
  90           //ADD NON POSITIONAL SEQUENCE INFO\r
  91           SequenceFeature [] features = sequence.getDatasetSequence().getSequenceFeatures();\r
  92           if(features!=null)\r
  93           {\r
  94             for(int i=0; i<features.length; i++)\r
  95             {\r
  96               if(features[i].begin == 0 && features[i].end ==0)\r
  97               {\r
  98                 tip.append("<br>"+features[i].featureGroup\r
  99                           +" "+ features[i].getType()+" "+features[i].description);\r
 100               }\r
 101             }\r
 102           }\r
 103           tip.append("</i></td></tr></table>");\r
 104         }\r
 105 \r
 106         DBRefEntry[] dbrefs = sequence.getDatasetSequence().getDBRef();\r
 107         if (dbrefs != null)\r
 108         {\r
 109           tip.append("<i>");\r
 110           for (int i = 0; i < dbrefs.length; i++)\r
 111           {\r
 112             tip.append("<br>");\r
 113             tip.append(dbrefs[i].getSource() + " "\r
 114                        + dbrefs[i].getAccessionId());\r
 115           }\r
 116           tip.append("</i>");\r
 117         }\r
 118 \r
 119         tip.append("</html>");\r
 120         setToolTipText(tip.toString());\r
 121       }\r
 122     }\r
 123 \r
 124 \r
 125     int getWrappedY(int y)\r
 126     {\r
 127       int hgap = av.charHeight;\r
 128       if (av.scaleAboveWrapped)\r
 129         hgap += av.charHeight;\r
 130 \r
 131       return y - hgap;\r
 132     }\r
 133 \r
 134 \r
 135     /**\r
 136      * DOCUMENT ME!\r
 137      *\r
 138      * @param e DOCUMENT ME!\r
 139      */\r
 140     public void mouseDragged(MouseEvent e)\r
 141     {\r
 142         mouseDragging = true;\r
 143 \r
 144         int y = e.getY();\r
 145 \r
 146         if (av.getWrapAlignment())\r
 147         {\r
 148             y = getWrappedY(y);\r
 149         }\r
 150 \r
 151         int seq = av.getIndex(y);\r
 152 \r
 153         if (seq < 0)\r
 154         {\r
 155             return;\r
 156         }\r
 157 \r
 158         if (seq < lastid)\r
 159         {\r
 160             selectSeqs(lastid - 1, seq);\r
 161         }\r
 162         else if (seq > lastid)\r
 163         {\r
 164             selectSeqs(lastid + 1, seq);\r
 165         }\r
 166 \r
 167         lastid = seq;\r
 168         alignPanel.repaint();\r
 169     }\r
 170 \r
 171 \r
 172     /**\r
 173      * DOCUMENT ME!\r
 174      *\r
 175      * @param e DOCUMENT ME!\r
 176      */\r
 177     public void mouseClicked(MouseEvent e)\r
 178     {\r
 179       if (e.getClickCount() < 2)\r
 180         return;\r
 181 \r
 182       java.util.Vector links = Preferences.sequenceURLLinks;\r
 183       if (links == null || links.size() < 1)\r
 184         return;\r
 185 \r
 186       int y = e.getY();\r
 187 \r
 188       if (av.getWrapAlignment())\r
 189       {\r
 190          y = getWrappedY(y);\r
 191       }\r
 192 \r
 193       //DEFAULT LINK IS FIRST IN THE LINK LIST\r
 194       int seq = av.getIndex(y);\r
 195       if(seq==-1)\r
 196         return;\r
 197 \r
 198       String id = av.getAlignment().getSequenceAt(seq).getName();\r
 199       if (id.indexOf("|") > -1)\r
 200         id = id.substring(id.lastIndexOf("|") + 1);\r
 201 \r
 202 \r
 203       String url = links.elementAt(0).toString();\r
 204       url = url.substring(url.indexOf("|")+1);\r
 205 \r
 206       int index = url.indexOf("$SEQUENCE_ID$");\r
 207       url = url.substring(0, index)+ id + url.substring(index+13);\r
 208 \r
 209       try\r
 210       {\r
 211         jalview.util.BrowserLauncher.openURL(url);\r
 212       }\r
 213       catch (Exception ex)\r
 214       {\r
 215        JOptionPane.showInternalMessageDialog(Desktop.desktop,\r
 216            "Unixers: Couldn't find default web browser."\r
 217           +"\nAdd the full path to your browser in Preferences.",\r
 218           "Web browser not found", JOptionPane.WARNING_MESSAGE );\r
 219         ex.printStackTrace();\r
 220       }\r
 221     }\r
 222 \r
 223     /**\r
 224      * DOCUMENT ME!\r
 225      *\r
 226      * @param e DOCUMENT ME!\r
 227      */\r
 228     public void mouseEntered(MouseEvent e)\r
 229     {\r
 230         if (scrollThread != null)\r
 231         {\r
 232             scrollThread.running = false;\r
 233         }\r
 234     }\r
 235 \r
 236     /**\r
 237      * DOCUMENT ME!\r
 238      *\r
 239      * @param e DOCUMENT ME!\r
 240      */\r
 241     public void mouseExited(MouseEvent e)\r
 242     {\r
 243         if (av.getWrapAlignment())\r
 244         {\r
 245             return;\r
 246         }\r
 247 \r
 248         if (mouseDragging && (e.getY() < 0) && (av.getStartSeq() > 0))\r
 249         {\r
 250             scrollThread = new ScrollThread(true);\r
 251         }\r
 252 \r
 253         if (mouseDragging && (e.getY() >= getHeight()) &&\r
 254                 (av.alignment.getHeight() > av.getEndSeq()))\r
 255         {\r
 256             scrollThread = new ScrollThread(false);\r
 257         }\r
 258     }\r
 259 \r
 260     /**\r
 261      * DOCUMENT ME!\r
 262      *\r
 263      * @param e DOCUMENT ME!\r
 264      */\r
 265     public void mousePressed(MouseEvent e)\r
 266     {\r
 267         if (e.getClickCount() == 2)\r
 268         {\r
 269             return;\r
 270         }\r
 271 \r
 272         int y = e.getY();\r
 273 \r
 274         if (av.getWrapAlignment())\r
 275         {\r
 276             y = getWrappedY(y);\r
 277         }\r
 278 \r
 279         int seq = av.getIndex(y);\r
 280 \r
 281         if (seq == -1)\r
 282         {\r
 283             return;\r
 284         }\r
 285 \r
 286         if (javax.swing.SwingUtilities.isRightMouseButton(e))\r
 287         {\r
 288             jalview.gui.PopupMenu pop = new jalview.gui.PopupMenu(alignPanel,\r
 289                     (Sequence) av.getAlignment().getSequenceAt(seq),\r
 290                     Preferences.sequenceURLLinks);\r
 291             pop.show(this, e.getX(), y);\r
 292 \r
 293             return;\r
 294         }\r
 295 \r
 296       /*  if (!e.isControlDown() && !e.isShiftDown() &&\r
 297                 (av.alignment.findGroup(av.alignment.getSequenceAt(seq)) != null))\r
 298         {\r
 299           System.out.println("no modifiers");\r
 300             SequenceGroup selection = new SequenceGroup();\r
 301             SequenceGroup sg = av.alignment.findGroup(av.alignment.getSequenceAt(\r
 302                         seq));\r
 303             selection.setStartRes(0);\r
 304             selection.setEndRes(av.alignment.getWidth() - 1);\r
 305 \r
 306             for (int i = 0; i < sg.getSize(); i++)\r
 307             {\r
 308                 selection.addSequence(sg.getSequenceAt(i), true);\r
 309             }\r
 310 \r
 311             av.setSelectionGroup(selection);\r
 312 \r
 313             return;\r
 314         }*/\r
 315 \r
 316         if ((av.getSelectionGroup() == null) ||\r
 317                 ((!e.isControlDown() && !e.isShiftDown()) && av.getSelectionGroup() != null))\r
 318         {\r
 319           av.setSelectionGroup(new SequenceGroup());\r
 320           av.getSelectionGroup().setStartRes(0);\r
 321           av.getSelectionGroup().setEndRes(av.alignment.getWidth() - 1);\r
 322         }\r
 323 \r
 324 \r
 325 \r
 326         if (e.isShiftDown() && (lastid != -1))\r
 327         {\r
 328             selectSeqs(lastid, seq);\r
 329         }\r
 330         else\r
 331         {\r
 332             selectSeq(seq);\r
 333         }\r
 334 \r
 335         alignPanel.repaint();\r
 336     }\r
 337 \r
 338     /**\r
 339      * DOCUMENT ME!\r
 340      *\r
 341      * @param seq DOCUMENT ME!\r
 342      */\r
 343     void selectSeq(int seq)\r
 344     {\r
 345         lastid = seq;\r
 346 \r
 347         SequenceI pickedSeq = av.getAlignment().getSequenceAt(seq);\r
 348         av.getSelectionGroup().addOrRemove(pickedSeq, true);\r
 349     }\r
 350 \r
 351     /**\r
 352      * DOCUMENT ME!\r
 353      *\r
 354      * @param start DOCUMENT ME!\r
 355      * @param end DOCUMENT ME!\r
 356      */\r
 357     void selectSeqs(int start, int end)\r
 358     {\r
 359       if(av.getSelectionGroup()==null)\r
 360             return;\r
 361 \r
 362         lastid = start;\r
 363 \r
 364         if (end < start)\r
 365         {\r
 366             int tmp = start;\r
 367             start = end;\r
 368             end = tmp;\r
 369             lastid = end;\r
 370         }\r
 371 \r
 372         for (int i = start; i <= end; i++)\r
 373         {\r
 374           av.getSelectionGroup().addSequence(av.getAlignment().getSequenceAt(i),\r
 375                 true);\r
 376         }\r
 377     }\r
 378 \r
 379     /**\r
 380      * DOCUMENT ME!\r
 381      *\r
 382      * @param e DOCUMENT ME!\r
 383      */\r
 384     public void mouseReleased(MouseEvent e)\r
 385     {\r
 386         if (scrollThread != null)\r
 387         {\r
 388             scrollThread.running = false;\r
 389         }\r
 390 \r
 391         mouseDragging = false;\r
 392         PaintRefresher.Refresh(av.alignment);\r
 393     }\r
 394 \r
 395     /**\r
 396      * DOCUMENT ME!\r
 397      *\r
 398      * @param found DOCUMENT ME!\r
 399      */\r
 400     public void highlightSearchResults(java.util.Vector found)\r
 401     {\r
 402         idCanvas.setHighlighted(found);\r
 403 \r
 404         if (found == null)\r
 405         {\r
 406             return;\r
 407         }\r
 408 \r
 409         int index = av.alignment.findIndex((SequenceI) found.get(0));\r
 410 \r
 411         // do we need to scroll the panel?\r
 412         if ((av.getStartSeq() > index) || (av.getEndSeq() < index))\r
 413         {\r
 414             alignPanel.setScrollValues(av.getStartRes(), index);\r
 415         }\r
 416     }\r
 417 \r
 418     // this class allows scrolling off the bottom of the visible alignment\r
 419     class ScrollThread extends Thread\r
 420     {\r
 421         boolean running = false;\r
 422         boolean up = true;\r
 423 \r
 424         public ScrollThread(boolean up)\r
 425         {\r
 426             this.up = up;\r
 427             start();\r
 428         }\r
 429 \r
 430         public void stopScrolling()\r
 431         {\r
 432             running = false;\r
 433         }\r
 434 \r
 435         public void run()\r
 436         {\r
 437             running = true;\r
 438 \r
 439             while (running)\r
 440             {\r
 441                 if (alignPanel.scrollUp(up))\r
 442                 {\r
 443                     // scroll was ok, so add new sequence to selection\r
 444                     int seq = av.getStartSeq();\r
 445 \r
 446                     if (!up)\r
 447                     {\r
 448                         seq = av.getEndSeq();\r
 449                     }\r
 450 \r
 451                     if (seq < lastid)\r
 452                     {\r
 453                         selectSeqs(lastid - 1, seq);\r
 454                     }\r
 455                     else if (seq > lastid)\r
 456                     {\r
 457                         selectSeqs(lastid + 1, seq);\r
 458                     }\r
 459 \r
 460                     lastid = seq;\r
 461                 }\r
 462                 else\r
 463                 {\r
 464                     running = false;\r
 465                 }\r
 466 \r
 467                 alignPanel.repaint();\r
 468 \r
 469                 try\r
 470                 {\r
 471                     Thread.sleep(100);\r
 472                 }\r
 473                 catch (Exception ex)\r
 474                 {\r
 475                 }\r
 476             }\r
 477         }\r
 478     }\r
 479 }\r