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