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         StringBuffer tip = new StringBuffer("<html>");\r
  83         tip.append(av.alignment.getSequenceAt(seq).getDisplayId(true));\r
  84         if (av.alignment.getSequenceAt(seq).getDescription() != null)\r
  85         {\r
  86           tip.append("<table width=250 border=0><tr><td><i>");\r
  87           tip.append(av.alignment.getSequenceAt(seq).getDescription());\r
  88           tip.append("</i></td></tr></table>");\r
  89         }\r
  90         tip.append("</html>");\r
  91         setToolTipText(tip.toString());\r
  92       }\r
  93 \r
  94       if(av.hasHiddenRows)\r
  95       {\r
  96         if(av.adjustForHiddenSeqs(seq) -\r
  97            av.adjustForHiddenSeqs(seq-1)>1)\r
  98         {\r
  99           JPopupMenu pop = new JPopupMenu();\r
 100           JMenuItem item = new JMenuItem("Reveal");\r
 101           item.addActionListener(new ActionListener()\r
 102           {\r
 103             public void actionPerformed(ActionEvent e)\r
 104             {\r
 105               av.showSequence(seq);\r
 106               alignPanel.repaint();\r
 107               if(alignPanel.overviewPanel!=null)\r
 108                 alignPanel.overviewPanel.updateOverviewImage();\r
 109             }\r
 110           });\r
 111           pop.add(item);\r
 112           pop.show(this, e.getX(), e.getY());\r
 113         }\r
 114       }\r
 115     }\r
 116 \r
 117 \r
 118     int getWrappedY(int y)\r
 119     {\r
 120       int hgap = av.charHeight;\r
 121       if (av.scaleAboveWrapped)\r
 122         hgap += av.charHeight;\r
 123 \r
 124       return y - hgap;\r
 125     }\r
 126 \r
 127 \r
 128     /**\r
 129      * DOCUMENT ME!\r
 130      *\r
 131      * @param e DOCUMENT ME!\r
 132      */\r
 133     public void mouseDragged(MouseEvent e)\r
 134     {\r
 135         mouseDragging = true;\r
 136 \r
 137         int y = e.getY();\r
 138 \r
 139         if (av.getWrapAlignment())\r
 140         {\r
 141             y = getWrappedY(y);\r
 142         }\r
 143 \r
 144         int seq = av.getIndex(y);\r
 145 \r
 146         if (seq < 0)\r
 147         {\r
 148             return;\r
 149         }\r
 150 \r
 151         if (seq < lastid)\r
 152         {\r
 153             selectSeqs(lastid - 1, seq);\r
 154         }\r
 155         else if (seq > lastid)\r
 156         {\r
 157             selectSeqs(lastid + 1, seq);\r
 158         }\r
 159 \r
 160         lastid = seq;\r
 161         alignPanel.repaint();\r
 162     }\r
 163 \r
 164 \r
 165     /**\r
 166      * DOCUMENT ME!\r
 167      *\r
 168      * @param e DOCUMENT ME!\r
 169      */\r
 170     public void mouseClicked(MouseEvent e)\r
 171     {\r
 172       if (e.getClickCount() < 2)\r
 173         return;\r
 174 \r
 175       java.util.Vector links = Preferences.sequenceURLLinks;\r
 176       if (links == null || links.size() < 1)\r
 177         return;\r
 178 \r
 179       int y = e.getY();\r
 180 \r
 181       if (av.getWrapAlignment())\r
 182       {\r
 183          y = getWrappedY(y);\r
 184       }\r
 185 \r
 186       //DEFAULT LINK IS FIRST IN THE LINK LIST\r
 187       int seq = av.getIndex(y);\r
 188       if(seq==-1)\r
 189         return;\r
 190 \r
 191       String id = av.getAlignment().getSequenceAt(seq).getName();\r
 192       if (id.indexOf("|") > -1)\r
 193         id = id.substring(id.lastIndexOf("|") + 1);\r
 194 \r
 195 \r
 196       String url = links.elementAt(0).toString();\r
 197       url = url.substring(url.indexOf("|")+1);\r
 198 \r
 199       int index = url.indexOf("$SEQUENCE_ID$");\r
 200       url = url.substring(0, index)+ id + url.substring(index+13);\r
 201 \r
 202       try\r
 203       {\r
 204         jalview.util.BrowserLauncher.openURL(url);\r
 205       }\r
 206       catch (Exception ex)\r
 207       {\r
 208        JOptionPane.showInternalMessageDialog(Desktop.desktop,\r
 209            "Unixers: Couldn't find default web browser."\r
 210           +"\nAdd the full path to your browser in Preferences.",\r
 211           "Web browser not found", JOptionPane.WARNING_MESSAGE );\r
 212         ex.printStackTrace();\r
 213       }\r
 214     }\r
 215 \r
 216     /**\r
 217      * DOCUMENT ME!\r
 218      *\r
 219      * @param e DOCUMENT ME!\r
 220      */\r
 221     public void mouseEntered(MouseEvent e)\r
 222     {\r
 223         if (scrollThread != null)\r
 224         {\r
 225             scrollThread.running = false;\r
 226         }\r
 227     }\r
 228 \r
 229     /**\r
 230      * DOCUMENT ME!\r
 231      *\r
 232      * @param e DOCUMENT ME!\r
 233      */\r
 234     public void mouseExited(MouseEvent e)\r
 235     {\r
 236         if (av.getWrapAlignment())\r
 237         {\r
 238             return;\r
 239         }\r
 240 \r
 241         if (mouseDragging && (e.getY() < 0) && (av.getStartSeq() > 0))\r
 242         {\r
 243             scrollThread = new ScrollThread(true);\r
 244         }\r
 245 \r
 246         if (mouseDragging && (e.getY() >= getHeight()) &&\r
 247                 (av.alignment.getHeight() > av.getEndSeq()))\r
 248         {\r
 249             scrollThread = new ScrollThread(false);\r
 250         }\r
 251     }\r
 252 \r
 253     /**\r
 254      * DOCUMENT ME!\r
 255      *\r
 256      * @param e DOCUMENT ME!\r
 257      */\r
 258     public void mousePressed(MouseEvent e)\r
 259     {\r
 260         if (e.getClickCount() == 2)\r
 261         {\r
 262             return;\r
 263         }\r
 264 \r
 265         int y = e.getY();\r
 266 \r
 267         if (av.getWrapAlignment())\r
 268         {\r
 269             y = getWrappedY(y);\r
 270         }\r
 271 \r
 272         int seq = av.getIndex(y);\r
 273 \r
 274         if (seq == -1)\r
 275         {\r
 276             return;\r
 277         }\r
 278 \r
 279         if (javax.swing.SwingUtilities.isRightMouseButton(e))\r
 280         {\r
 281             jalview.gui.PopupMenu pop = new jalview.gui.PopupMenu(alignPanel,\r
 282                     (Sequence) av.getAlignment().getSequenceAt(seq));\r
 283             pop.show(this, e.getX(), y);\r
 284 \r
 285             return;\r
 286         }\r
 287 \r
 288         if (!e.isControlDown() && !e.isShiftDown() &&\r
 289                 (av.alignment.findGroup(av.alignment.getSequenceAt(seq)) != null))\r
 290         {\r
 291             SequenceGroup selection = new SequenceGroup();\r
 292             SequenceGroup sg = av.alignment.findGroup(av.alignment.getSequenceAt(\r
 293                         seq));\r
 294             selection.setStartRes(0);\r
 295             selection.setEndRes(av.alignment.getWidth() - 1);\r
 296 \r
 297             for (int i = 0; i < sg.getSize(); i++)\r
 298             {\r
 299                 selection.addSequence(sg.getSequenceAt(i), true);\r
 300             }\r
 301 \r
 302             av.setSelectionGroup(selection);\r
 303 \r
 304             return;\r
 305         }\r
 306 \r
 307         if ((av.getSelectionGroup() == null) ||\r
 308                 (!e.isControlDown() && (av.getSelectionGroup() != null)))\r
 309         {\r
 310             av.setSelectionGroup(new SequenceGroup());\r
 311         }\r
 312 \r
 313         av.getSelectionGroup().setStartRes(0);\r
 314         av.getSelectionGroup().setEndRes(av.alignment.getWidth() - 1);\r
 315 \r
 316         if (e.isShiftDown() && (lastid != -1))\r
 317         {\r
 318             selectSeqs(lastid, seq);\r
 319         }\r
 320         else\r
 321         {\r
 322             selectSeq(seq);\r
 323         }\r
 324 \r
 325         alignPanel.repaint();\r
 326     }\r
 327 \r
 328     /**\r
 329      * DOCUMENT ME!\r
 330      *\r
 331      * @param seq DOCUMENT ME!\r
 332      */\r
 333     void selectSeq(int seq)\r
 334     {\r
 335         lastid = seq;\r
 336 \r
 337         SequenceI pickedSeq = av.getAlignment().getSequenceAt(seq);\r
 338         av.getSelectionGroup().addOrRemove(pickedSeq, true);\r
 339     }\r
 340 \r
 341     /**\r
 342      * DOCUMENT ME!\r
 343      *\r
 344      * @param start DOCUMENT ME!\r
 345      * @param end DOCUMENT ME!\r
 346      */\r
 347     void selectSeqs(int start, int end)\r
 348     {\r
 349       if(av.getSelectionGroup()==null)\r
 350             return;\r
 351 \r
 352         lastid = start;\r
 353 \r
 354         if (end < start)\r
 355         {\r
 356             int tmp = start;\r
 357             start = end;\r
 358             end = tmp;\r
 359             lastid = end;\r
 360         }\r
 361 \r
 362         for (int i = start; i <= end; i++)\r
 363         {\r
 364           av.getSelectionGroup().addSequence(av.getAlignment().getSequenceAt(i),\r
 365                 true);\r
 366         }\r
 367     }\r
 368 \r
 369     /**\r
 370      * DOCUMENT ME!\r
 371      *\r
 372      * @param e DOCUMENT ME!\r
 373      */\r
 374     public void mouseReleased(MouseEvent e)\r
 375     {\r
 376         if (scrollThread != null)\r
 377         {\r
 378             scrollThread.running = false;\r
 379         }\r
 380 \r
 381         mouseDragging = false;\r
 382         PaintRefresher.Refresh(av.alignment);\r
 383     }\r
 384 \r
 385     /**\r
 386      * DOCUMENT ME!\r
 387      *\r
 388      * @param found DOCUMENT ME!\r
 389      */\r
 390     public void highlightSearchResults(java.util.Vector found)\r
 391     {\r
 392         idCanvas.setHighlighted(found);\r
 393 \r
 394         if (found == null)\r
 395         {\r
 396             return;\r
 397         }\r
 398 \r
 399         int index = av.alignment.findIndex((SequenceI) found.get(0));\r
 400 \r
 401         // do we need to scroll the panel?\r
 402         if ((av.getStartSeq() > index) || (av.getEndSeq() < index))\r
 403         {\r
 404             alignPanel.setScrollValues(av.getStartRes(), index);\r
 405         }\r
 406     }\r
 407 \r
 408     // this class allows scrolling off the bottom of the visible alignment\r
 409     class ScrollThread extends Thread\r
 410     {\r
 411         boolean running = false;\r
 412         boolean up = true;\r
 413 \r
 414         public ScrollThread(boolean up)\r
 415         {\r
 416             this.up = up;\r
 417             start();\r
 418         }\r
 419 \r
 420         public void stopScrolling()\r
 421         {\r
 422             running = false;\r
 423         }\r
 424 \r
 425         public void run()\r
 426         {\r
 427             running = true;\r
 428 \r
 429             while (running)\r
 430             {\r
 431                 if (alignPanel.scrollUp(up))\r
 432                 {\r
 433                     // scroll was ok, so add new sequence to selection\r
 434                     int seq = av.getStartSeq();\r
 435 \r
 436                     if (!up)\r
 437                     {\r
 438                         seq = av.getEndSeq();\r
 439                     }\r
 440 \r
 441                     if (seq < lastid)\r
 442                     {\r
 443                         selectSeqs(lastid - 1, seq);\r
 444                     }\r
 445                     else if (seq > lastid)\r
 446                     {\r
 447                         selectSeqs(lastid + 1, seq);\r
 448                     }\r
 449 \r
 450                     lastid = seq;\r
 451                 }\r
 452                 else\r
 453                 {\r
 454                     running = false;\r
 455                 }\r
 456 \r
 457                 alignPanel.repaint();\r
 458 \r
 459                 try\r
 460                 {\r
 461                     Thread.sleep(100);\r
 462                 }\r
 463                 catch (Exception ex)\r
 464                 {\r
 465                 }\r
 466             }\r
 467         }\r
 468     }\r
 469 }\r