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