src/jalview/appletgui/AnnotationPanel.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 \r
  20 package jalview.appletgui;\r
  21 \r
  22 import java.util.*;\r
  23 \r
  24 import java.awt.*;\r
  25 import java.awt.event.*;\r
  26 \r
  27 import jalview.datamodel.*;\r
  28 \r
  29 public class AnnotationPanel\r
  30     extends Panel implements AdjustmentListener\r
  31 {\r
  32   AlignViewport av;\r
  33   AlignmentPanel ap;\r
  34   int activeRow = -1;\r
  35 \r
  36   Vector activeRes;\r
  37   static String HELIX = "Helix";\r
  38   static String SHEET = "Sheet";\r
  39   static String LABEL = "Label";\r
  40   static String REMOVE = "Remove Annotation";\r
  41   static String COLOUR = "Colour";\r
  42   static Color HELIX_COLOUR = Color.red.darker();\r
  43   static Color SHEET_COLOUR = Color.green.darker().darker();\r
  44 \r
  45   Image image;\r
  46   Graphics gg;\r
  47   FontMetrics fm;\r
  48   int imgWidth = 0;\r
  49 \r
  50   boolean fastPaint = false;\r
  51 \r
  52   public static int GRAPH_HEIGHT = 40;\r
  53 \r
  54   public AnnotationPanel(AlignmentPanel ap)\r
  55   {\r
  56     this.ap = ap;\r
  57     av = ap.av;\r
  58     this.setLayout(null);\r
  59     adjustPanelHeight();\r
  60 \r
  61     addMouseMotionListener(new MouseMotionAdapter()\r
  62     {\r
  63       public void mouseMoved(MouseEvent evt)\r
  64       {\r
  65         doMouseMoved(evt);\r
  66       }\r
  67     });\r
  68 \r
  69     // ap.annotationScroller.getVAdjustable().addAdjustmentListener( this );\r
  70   }\r
  71 \r
  72 \r
  73   public AnnotationPanel(AlignViewport av)\r
  74   {\r
  75     this.av = av;\r
  76   }\r
  77 \r
  78 \r
  79   public void adjustmentValueChanged(AdjustmentEvent evt)\r
  80   {\r
  81     ap.alabels.setScrollOffset( -evt.getValue());\r
  82   }\r
  83 \r
  84   public int adjustPanelHeight()\r
  85   {\r
  86     // setHeight of panels\r
  87     AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation();\r
  88 \r
  89 \r
  90     int height = 0;\r
  91     if (aa != null)\r
  92     {\r
  93       for (int i = 0; i < aa.length; i++)\r
  94       {\r
  95         if (!aa[i].visible)\r
  96         {\r
  97           continue;\r
  98         }\r
  99 \r
 100         aa[i].height = 0;\r
 101 \r
 102         if (aa[i].hasText)\r
 103         {\r
 104           aa[i].height += av.charHeight;\r
 105         }\r
 106         if (aa[i].hasIcons)\r
 107         {\r
 108           aa[i].height += 16;\r
 109         }\r
 110 \r
 111         if (aa[i].graph>0)\r
 112         {\r
 113           aa[i].height += GRAPH_HEIGHT;\r
 114         }\r
 115 \r
 116         if (aa[i].height == 0)\r
 117         {\r
 118           aa[i].height = 20;\r
 119         }\r
 120         height += aa[i].height;\r
 121       }\r
 122     }\r
 123     else\r
 124     {\r
 125       height = 20;\r
 126     }\r
 127 \r
 128     this.setSize(getSize().width, height);\r
 129     if(ap!=null)\r
 130        ap.annotationScroller.setSize(getSize().width, height);\r
 131 \r
 132 \r
 133     repaint();\r
 134 \r
 135     return height;\r
 136 \r
 137   }\r
 138 \r
 139   public void addEditableColumn(int i)\r
 140   {\r
 141     if (activeRow == -1)\r
 142     {\r
 143       AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation();\r
 144       if(aa ==null)\r
 145         return;\r
 146 \r
 147       for (int j = 0; j < aa.length; j++)\r
 148       {\r
 149         if (aa[j].editable)\r
 150         {\r
 151           activeRow = j;\r
 152           break;\r
 153         }\r
 154       }\r
 155     }\r
 156 \r
 157     if (activeRes == null)\r
 158     {\r
 159       activeRes = new Vector();\r
 160       activeRes.addElement(String.valueOf(i));\r
 161       return;\r
 162     }\r
 163 \r
 164     activeRes.addElement(String.valueOf(i));\r
 165   }\r
 166 \r
 167   public void doMouseMoved(MouseEvent evt)\r
 168   {\r
 169     AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation();\r
 170     if (aa == null)\r
 171     {\r
 172       return;\r
 173     }\r
 174 \r
 175     int row = -1;\r
 176     int height = 0;\r
 177     for (int i = 0; i < aa.length; i++)\r
 178     {\r
 179 \r
 180       if (aa[i].visible)\r
 181       {\r
 182         height += aa[i].height;\r
 183       }\r
 184 \r
 185       if (evt.getY() < height)\r
 186       {\r
 187         row = i;\r
 188         break;\r
 189       }\r
 190     }\r
 191 \r
 192     int res = evt.getX() / av.getCharWidth() + av.getStartRes();\r
 193     if (row > -1 && res < aa[row].annotations.length && aa[row].annotations[res] != null)\r
 194     {\r
 195       StringBuffer text = new StringBuffer("Sequence position " + (res + 1) +\r
 196                                            "  " +\r
 197                                            aa[row].annotations[res].description);\r
 198       ap.alignFrame.statusBar.setText(text.toString());\r
 199     }\r
 200   }\r
 201 \r
 202   public void update(Graphics g)\r
 203   {\r
 204     paint(g);\r
 205   }\r
 206 \r
 207   public void paint(Graphics g)\r
 208   {\r
 209     g.setColor(Color.white);\r
 210     g.fillRect(0,0, getSize().width, getSize().height);\r
 211     imgWidth = (av.endRes - av.startRes + 1) * av.charWidth;\r
 212 \r
 213     if (image == null || imgWidth != image.getWidth(this))\r
 214     {\r
 215       image = createImage(imgWidth, ap.annotationPanel.getSize().height);\r
 216       gg = image.getGraphics();\r
 217       gg.setFont(av.getFont());\r
 218       fm = gg.getFontMetrics();\r
 219       fastPaint = false;\r
 220     }\r
 221 \r
 222     if (fastPaint)\r
 223     {\r
 224       g.drawImage(image, 0, 0, this);\r
 225       fastPaint = false;\r
 226       return;\r
 227     }\r
 228 \r
 229     drawComponent(gg, av.startRes, av.endRes + 1);\r
 230     g.drawImage(image, 0, 0, this);\r
 231   }\r
 232 \r
 233   public void fastPaint(int horizontal)\r
 234   {\r
 235     if (horizontal == 0\r
 236         || av.alignment.getAlignmentAnnotation() == null\r
 237         || av.alignment.getAlignmentAnnotation().length < 1\r
 238         )\r
 239     {\r
 240       repaint();\r
 241       return;\r
 242     }\r
 243 \r
 244     gg.copyArea(0, 0, imgWidth, getSize().height, -horizontal * av.charWidth, 0);\r
 245     int sr = av.startRes, er = av.endRes + 1, transX = 0;\r
 246 \r
 247     if (horizontal > 0) // scrollbar pulled right, image to the left\r
 248     {\r
 249       transX = (er - sr - horizontal) * av.charWidth;\r
 250       sr = er - horizontal;\r
 251     }\r
 252     else if (horizontal < 0)\r
 253     {\r
 254       er = sr - horizontal;\r
 255     }\r
 256 \r
 257     gg.translate(transX, 0);\r
 258 \r
 259     drawComponent(gg, sr, er);\r
 260 \r
 261     gg.translate( -transX, 0);\r
 262 \r
 263     fastPaint = true;\r
 264     repaint();\r
 265   }\r
 266 \r
 267   public void drawComponent(Graphics g, int startRes, int endRes)\r
 268   {\r
 269     g.setFont(av.getFont());\r
 270 \r
 271     if (fm == null)\r
 272       fm = g.getFontMetrics();\r
 273 \r
 274 \r
 275       g.setColor(Color.white);\r
 276       g.fillRect(0, 0, (endRes - startRes) * av.charWidth, getSize().height);\r
 277 \r
 278       if ((av.alignment.getAlignmentAnnotation() == null) ||\r
 279               (av.alignment.getAlignmentAnnotation().length < 1))\r
 280       {\r
 281           g.setColor(Color.white);\r
 282           g.fillRect(0, 0, getSize().width, getSize().height);\r
 283           g.setColor(Color.black);\r
 284           g.drawString("Alignment has no annotations", 20, 15);\r
 285 \r
 286           return;\r
 287       }\r
 288 \r
 289       AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation();\r
 290 \r
 291       int j;\r
 292       int x = 0;\r
 293       int y = 0;\r
 294       char[] lastSS = new char[aa.length];\r
 295       int[] lastSSX = new int[aa.length];\r
 296       int iconOffset = av.charHeight / 2;\r
 297       boolean validRes = false;\r
 298 \r
 299       //\u03B2 \u03B1\r
 300       for (int i = 0; i < aa.length; i++)\r
 301       {\r
 302           AlignmentAnnotation row = aa[i];\r
 303 \r
 304           if (!row.visible)\r
 305           {\r
 306               continue;\r
 307           }\r
 308 \r
 309 \r
 310           if (row.graph>0)\r
 311           {\r
 312               // this is so that we draw the characters below the graph\r
 313               y += row.height;\r
 314 \r
 315               if (row.hasText)\r
 316               {\r
 317                   y -= av.charHeight;\r
 318               }\r
 319           }\r
 320 \r
 321           if (row.hasText)\r
 322           {\r
 323               iconOffset = av.charHeight / 2;\r
 324           }\r
 325           else\r
 326           {\r
 327               iconOffset = 0;\r
 328           }\r
 329 \r
 330           for (j = startRes; j < endRes; j++)\r
 331           {\r
 332               if ((row.annotations.length <= j) ||\r
 333                       (row.annotations[j] == null))\r
 334               {\r
 335                   validRes = false;\r
 336               }\r
 337               else\r
 338               {\r
 339                   validRes = true;\r
 340               }\r
 341 \r
 342               x = (j - startRes) * av.charWidth;\r
 343 \r
 344 \r
 345               if (validRes &&\r
 346                       (row.annotations[j].displayCharacter.length() > 0))\r
 347               {\r
 348 \r
 349                   int charOffset = (av.charWidth -\r
 350                       fm.charWidth(row.annotations[j].displayCharacter.charAt(\r
 351                               0))) / 2;\r
 352                   g.setColor(row.annotations[j].colour);\r
 353 \r
 354                   if (j == 0 || row.graph>0)\r
 355                   {\r
 356                       g.drawString(row.annotations[j].displayCharacter, x+charOffset,\r
 357                           y + iconOffset + 3);\r
 358                   }\r
 359                   else if (((row.annotations[j - 1] == null) ||\r
 360                           (row.annotations[j].displayCharacter != row.annotations[j -\r
 361                           1].displayCharacter)))\r
 362                   {\r
 363                       g.drawString(row.annotations[j].displayCharacter, x+charOffset,\r
 364                           y + iconOffset + 3);\r
 365                   }\r
 366               }\r
 367 \r
 368               if (row.hasIcons)\r
 369               {\r
 370                   if (!validRes ||\r
 371                           (row.annotations[j].secondaryStructure != lastSS[i]))\r
 372                   {\r
 373                       switch (lastSS[i])\r
 374                       {\r
 375                       case 'H':\r
 376                           g.setColor(HELIX_COLOUR);\r
 377                           g.fillRoundRect(lastSSX[i], y + 4 + iconOffset,\r
 378                               x - lastSSX[i], 7, 8, 8);\r
 379 \r
 380                           break;\r
 381 \r
 382                       case 'E':\r
 383                           g.setColor(SHEET_COLOUR);\r
 384                           g.fillRect(lastSSX[i], y + 4 + iconOffset,\r
 385                               x - lastSSX[i] - 4, 7);\r
 386                           g.fillPolygon(new int[] { x - 4, x - 4, x },\r
 387                               new int[]\r
 388                               {\r
 389                                   y + iconOffset, y + 14 + iconOffset,\r
 390                                   y + 8 + iconOffset\r
 391                               }, 3);\r
 392 \r
 393                           break;\r
 394 \r
 395                       case 'C':\r
 396                           break;\r
 397 \r
 398                       default:\r
 399                           g.setColor(Color.gray);\r
 400                           g.fillRect(lastSSX[i], y + 6 + iconOffset,\r
 401                               x - lastSSX[i], 2);\r
 402 \r
 403                           break;\r
 404                       }\r
 405 \r
 406                       if (validRes)\r
 407                       {\r
 408                           lastSS[i] = row.annotations[j].secondaryStructure;\r
 409                       }\r
 410                       else\r
 411                       {\r
 412                           lastSS[i] = ' ';\r
 413                       }\r
 414 \r
 415                       lastSSX[i] = x;\r
 416                   }\r
 417               }\r
 418 \r
 419               if (validRes && row.graph>0)\r
 420               {\r
 421                   g.setColor(new Color(0, 0, 180));\r
 422 \r
 423                   int height = (int) ((row.annotations[j].value / row.graphMax) * GRAPH_HEIGHT);\r
 424 \r
 425                   g.setColor(row.annotations[j].colour);\r
 426                   g.fillRect(x, y - height, av.charWidth, height);\r
 427               }\r
 428           }\r
 429 \r
 430           x += av.charWidth;\r
 431 \r
 432           if (row.hasIcons)\r
 433           {\r
 434               switch (lastSS[i])\r
 435               {\r
 436               case 'H':\r
 437                   g.setColor(HELIX_COLOUR);\r
 438                   g.fillRoundRect(lastSSX[i], y + 4 + iconOffset,\r
 439                       x - lastSSX[i], 7, 8, 8);\r
 440 \r
 441                   break;\r
 442 \r
 443               case 'E':\r
 444                   g.setColor(SHEET_COLOUR);\r
 445                   g.fillRect(lastSSX[i], y + 4 + iconOffset,\r
 446                       x - lastSSX[i] - 4, 7);\r
 447                   g.fillPolygon(new int[] { x - 4, x - 4, x },\r
 448                       new int[]\r
 449                       {\r
 450                           y + iconOffset, y + 14 + iconOffset,\r
 451                           y + 7 + iconOffset\r
 452                       }, 3);\r
 453 \r
 454                   break;\r
 455 \r
 456               case 'C':\r
 457                   break;\r
 458 \r
 459               default:\r
 460                   g.setColor(Color.gray);\r
 461                   g.fillRect(lastSSX[i], y + 6 + iconOffset, x - lastSSX[i], 2);\r
 462 \r
 463                   break;\r
 464               }\r
 465           }\r
 466 \r
 467           if (row.graph>0 && row.hasText)\r
 468           {\r
 469               y += av.charHeight;\r
 470           }\r
 471 \r
 472           if (row.graph==0)\r
 473           {\r
 474               y += aa[i].height;\r
 475           }\r
 476         }\r
 477   }\r
 478 \r
 479   // used by overview window\r
 480   public void drawGraph(Graphics g, AlignmentAnnotation aa, int width, int y, int sRes, int eRes)\r
 481   {\r
 482       g.setColor(Color.white);\r
 483       g.fillRect(0, 0, width, y);\r
 484       g.setColor(new Color(0, 0, 180));\r
 485 \r
 486       int x = 0, height;\r
 487 \r
 488       for (int j = sRes; j < eRes; j++)\r
 489       {\r
 490           g.setColor(new Color(0, 0, 180));\r
 491 \r
 492           height = (int) ((aa.annotations[j].value / aa.graphMax) * GRAPH_HEIGHT);\r
 493           if(height>y)\r
 494               height = y;\r
 495           g.fillRect(x, y - height, av.charWidth, height);\r
 496           x += av.charWidth;\r
 497       }\r
 498     }\r
 499 }\r