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