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