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     imgWidth = (av.endRes - av.startRes + 1) * av.charWidth;\r
 210 \r
 211     if (image == null || imgWidth != image.getWidth(this))\r
 212     {\r
 213       image = createImage(imgWidth, ap.annotationPanel.getSize().height);\r
 214       gg = image.getGraphics();\r
 215       gg.setFont(av.getFont());\r
 216       fm = gg.getFontMetrics();\r
 217       fastPaint = false;\r
 218     }\r
 219 \r
 220     if (fastPaint)\r
 221     {\r
 222       g.drawImage(image, 0, 0, this);\r
 223       fastPaint = false;\r
 224       return;\r
 225     }\r
 226 \r
 227     drawComponent(gg, av.startRes, av.endRes + 1);\r
 228     g.drawImage(image, 0, 0, this);\r
 229   }\r
 230 \r
 231   public void fastPaint(int horizontal)\r
 232   {\r
 233     if (horizontal == 0\r
 234         || av.alignment.getAlignmentAnnotation() == null\r
 235         || av.alignment.getAlignmentAnnotation().length < 1\r
 236         )\r
 237     {\r
 238       repaint();\r
 239       return;\r
 240     }\r
 241 \r
 242     gg.copyArea(0, 0, imgWidth, getSize().height, -horizontal * av.charWidth, 0);\r
 243     int sr = av.startRes, er = av.endRes + 1, transX = 0;\r
 244 \r
 245     if (horizontal > 0) // scrollbar pulled right, image to the left\r
 246     {\r
 247       transX = (er - sr - horizontal) * av.charWidth;\r
 248       sr = er - horizontal;\r
 249     }\r
 250     else if (horizontal < 0)\r
 251     {\r
 252       er = sr - horizontal;\r
 253     }\r
 254 \r
 255     gg.translate(transX, 0);\r
 256 \r
 257     drawComponent(gg, sr, er);\r
 258 \r
 259     gg.translate( -transX, 0);\r
 260 \r
 261     fastPaint = true;\r
 262     repaint();\r
 263   }\r
 264 \r
 265   /**\r
 266    * DOCUMENT ME!\r
 267    *\r
 268    * @param g DOCUMENT ME!\r
 269    * @param startRes DOCUMENT ME!\r
 270    * @param endRes DOCUMENT ME!\r
 271    */\r
 272   public void drawComponent(Graphics g, int startRes, int endRes)\r
 273   {\r
 274     g.setFont(av.getFont());\r
 275 \r
 276     if (fm == null)\r
 277       fm = g.getFontMetrics();\r
 278 \r
 279 \r
 280       g.setColor(Color.white);\r
 281       g.fillRect(0, 0, (endRes - startRes) * av.charWidth, getSize().height);\r
 282 \r
 283       if ((av.alignment.getAlignmentAnnotation() == null) ||\r
 284               (av.alignment.getAlignmentAnnotation().length < 1))\r
 285       {\r
 286           g.setColor(Color.white);\r
 287           g.fillRect(0, 0, getSize().width, getSize().height);\r
 288           g.setColor(Color.black);\r
 289           g.drawString("Alignment has no annotations", 20, 15);\r
 290 \r
 291           return;\r
 292       }\r
 293 \r
 294       AlignmentAnnotation[] aa = av.alignment.getAlignmentAnnotation();\r
 295 \r
 296       int j;\r
 297       int x = 0;\r
 298       int y = 0;\r
 299       char[] lastSS = new char[aa.length];\r
 300       int[] lastSSX = new int[aa.length];\r
 301       int iconOffset = av.charHeight / 2;\r
 302       boolean validRes = false;\r
 303 \r
 304       boolean [] graphGroupDrawn = new boolean[aa.length];\r
 305 \r
 306 \r
 307       //\u03B2 \u03B1\r
 308       for (int i = 0; i < aa.length; i++)\r
 309       {\r
 310           AlignmentAnnotation row = aa[i];\r
 311 \r
 312           if (!row.visible)\r
 313           {\r
 314               continue;\r
 315           }\r
 316 \r
 317 \r
 318 \r
 319           if (row.graph>0)\r
 320           {\r
 321               if(row.graphGroup>-1 && graphGroupDrawn[ row.graphGroup ] )\r
 322                 continue;\r
 323 \r
 324               // this is so that we draw the characters below the graph\r
 325               y += row.height;\r
 326 \r
 327               if (row.hasText)\r
 328               {\r
 329                   y -= av.charHeight;\r
 330               }\r
 331           }\r
 332 \r
 333           if (row.hasText)\r
 334           {\r
 335               iconOffset = av.charHeight / 2;\r
 336           }\r
 337           else\r
 338           {\r
 339               iconOffset = 0;\r
 340           }\r
 341 \r
 342           for (j = startRes; j < endRes; j++)\r
 343           {\r
 344               if ((row.annotations.length <= j) ||\r
 345                       (row.annotations[j] == null))\r
 346               {\r
 347                   validRes = false;\r
 348               }\r
 349               else\r
 350               {\r
 351                   validRes = true;\r
 352               }\r
 353 \r
 354               x = (j - startRes) * av.charWidth;\r
 355 \r
 356               if (activeRow == i)\r
 357               {\r
 358                   g.setColor(Color.red);\r
 359 \r
 360                   if (activeRes != null)\r
 361                   {\r
 362                       for (int n = 0; n < activeRes.size(); n++)\r
 363                       {\r
 364                           int v = Integer.parseInt(activeRes.elementAt(n).toString());\r
 365 \r
 366                           if (v == j)\r
 367                           {\r
 368                               g.fillRect((j - startRes) * av.charWidth, y,\r
 369                                   av.charWidth, row.height);\r
 370                           }\r
 371                       }\r
 372                   }\r
 373               }\r
 374 \r
 375               if (validRes &&\r
 376                       (row.annotations[j].displayCharacter.length() > 0))\r
 377               {\r
 378 \r
 379                   int charOffset = (av.charWidth -\r
 380                       fm.charWidth(row.annotations[j].displayCharacter.charAt(\r
 381                               0))) / 2;\r
 382                   g.setColor(row.annotations[j].colour);\r
 383 \r
 384                   if (j == 0 || row.graph>0)\r
 385                   {\r
 386                       g.drawString(row.annotations[j].displayCharacter, x+charOffset,\r
 387                           y + iconOffset + 3);\r
 388                   }\r
 389                   else if (((row.annotations[j - 1] == null) ||\r
 390                           (!row.annotations[j].displayCharacter.equals(\r
 391                            row.annotations[j - 1].displayCharacter))))\r
 392                   {\r
 393                       g.drawString(row.annotations[j].displayCharacter, x+charOffset,\r
 394                           y + iconOffset + 3);\r
 395                   }\r
 396               }\r
 397 \r
 398               if (row.hasIcons)\r
 399               {\r
 400                   if (!validRes ||\r
 401                           (row.annotations[j].secondaryStructure != lastSS[i]))\r
 402                   {\r
 403                       switch (lastSS[i])\r
 404                       {\r
 405                       case 'H':\r
 406                           g.setColor(HELIX_COLOUR);\r
 407                           g.fillRoundRect(lastSSX[i], y + 4 + iconOffset,\r
 408                               x - lastSSX[i], 7, 8, 8);\r
 409 \r
 410                           break;\r
 411 \r
 412                       case 'E':\r
 413                           g.setColor(SHEET_COLOUR);\r
 414                           g.fillRect(lastSSX[i], y + 4 + iconOffset,\r
 415                               x - lastSSX[i] - 4, 7);\r
 416                           g.fillPolygon(new int[] { x - 4, x - 4, x },\r
 417                               new int[]\r
 418                               {\r
 419                                   y + iconOffset, y + 14 + iconOffset,\r
 420                                   y + 8 + iconOffset\r
 421                               }, 3);\r
 422 \r
 423                           break;\r
 424 \r
 425 \r
 426                       default:\r
 427                           g.setColor(Color.gray);\r
 428                           g.fillRect(lastSSX[i], y + 6 + iconOffset,\r
 429                               x - lastSSX[i], 2);\r
 430 \r
 431                           break;\r
 432                       }\r
 433 \r
 434                       if (validRes)\r
 435                       {\r
 436                           lastSS[i] = row.annotations[j].secondaryStructure;\r
 437                       }\r
 438                       else\r
 439                       {\r
 440                           lastSS[i] = ' ';\r
 441                       }\r
 442 \r
 443                       lastSSX[i] = x;\r
 444                   }\r
 445               }\r
 446           }\r
 447 \r
 448           x += av.charWidth;\r
 449 \r
 450           if (row.hasIcons)\r
 451           {\r
 452               switch (lastSS[i])\r
 453               {\r
 454               case 'H':\r
 455                   g.setColor(HELIX_COLOUR);\r
 456                   g.fillRoundRect(lastSSX[i], y + 4 + iconOffset,\r
 457                       x - lastSSX[i], 7, 8, 8);\r
 458 \r
 459                   break;\r
 460 \r
 461               case 'E':\r
 462                   g.setColor(SHEET_COLOUR);\r
 463 \r
 464                   if (row.annotations.length > endRes\r
 465                       && row.annotations[endRes].secondaryStructure != 'E')\r
 466                   {\r
 467                     g.fillRect(lastSSX[i], y + 4 + iconOffset,\r
 468                                x - lastSSX[i] - 4, 7);\r
 469                     g.fillPolygon(new int[]\r
 470                                   {x - 4, x - 4, x},\r
 471                                   new int[]\r
 472                                   {\r
 473                                   y + iconOffset, y + 14 + iconOffset,\r
 474                                   y + 7 + iconOffset\r
 475                     }, 3);\r
 476                   }\r
 477                   else\r
 478                     g.fillRect(lastSSX[i], y + 4 + iconOffset,\r
 479                                x - lastSSX[i], 7);\r
 480 \r
 481                   break;\r
 482 \r
 483               case 'C':\r
 484                   break;\r
 485 \r
 486               default:\r
 487                   g.setColor(Color.gray);\r
 488                   g.fillRect(lastSSX[i], y + 6 + iconOffset, x - lastSSX[i], 2);\r
 489 \r
 490                   break;\r
 491               }\r
 492           }\r
 493 \r
 494           if (row.graph>0)\r
 495           {\r
 496               if(row.graph == AlignmentAnnotation.LINE_GRAPH )\r
 497               {\r
 498                 if(row.graphGroup>-1 && !graphGroupDrawn[row.graphGroup])\r
 499                  {\r
 500                    float groupmax=-999999, groupmin=9999999;\r
 501                    for(int gg=0; gg<aa.length; gg++)\r
 502                    {\r
 503                      if(aa[gg].graphGroup!=row.graphGroup)\r
 504                        continue;\r
 505 \r
 506                      if(aa[gg]!=row)\r
 507                        aa[gg].visible = false;\r
 508 \r
 509                      if(aa[gg].graphMax>groupmax)\r
 510                        groupmax = aa[gg].graphMax;\r
 511                      if(aa[gg].graphMin<groupmin)\r
 512                        groupmin = aa[gg].graphMin;\r
 513                    }\r
 514 \r
 515                    for (int gg = 0; gg < aa.length; gg++)\r
 516                    {\r
 517                      if (aa[gg].graphGroup == row.graphGroup)\r
 518                      {\r
 519                        drawLineGraph(g, aa[gg], startRes, endRes, y,\r
 520                                      groupmin, groupmax,\r
 521                                      row.graphHeight);\r
 522                      }\r
 523                    }\r
 524 \r
 525                    graphGroupDrawn[ row.graphGroup ] = true;\r
 526                  }\r
 527                  else\r
 528                    drawLineGraph(g, row, startRes, endRes,\r
 529                                  y, row.graphMin, row.graphMax, row.graphHeight  );\r
 530               }\r
 531               else if(row.graph == AlignmentAnnotation.BAR_GRAPH )\r
 532                  drawBarGraph(g, row, startRes, endRes,\r
 533                               row.graphMin, row.graphMax, y);\r
 534           }\r
 535 \r
 536           if (row.graph>0 && row.hasText)\r
 537           {\r
 538               y += av.charHeight;\r
 539           }\r
 540 \r
 541           if (row.graph==0)\r
 542           {\r
 543               y += aa[i].height;\r
 544           }\r
 545       }\r
 546   }\r
 547 \r
 548   public void drawLineGraph(Graphics g, AlignmentAnnotation aa,\r
 549                             int sRes, int eRes,\r
 550                             int y,\r
 551                             float min, float max,\r
 552                             int graphHeight)\r
 553   {\r
 554     if(sRes>aa.annotations.length)\r
 555       return;\r
 556 \r
 557 \r
 558     eRes = Math.min(eRes, aa.annotations.length);\r
 559 \r
 560     int x = 0;\r
 561 \r
 562     //Adjustment for fastpaint to left\r
 563     if(eRes<av.endRes)\r
 564       eRes++;\r
 565 \r
 566     if(sRes==0)\r
 567     {\r
 568       sRes++;\r
 569       x+=av.charWidth;\r
 570     }\r
 571 \r
 572     int y1=y, y2=y;\r
 573     float range = max - min;\r
 574 \r
 575     ////Draw origin\r
 576     if(min<0)\r
 577       y2 = (int)(y - (0-min / range)*graphHeight);\r
 578 \r
 579     g.setColor(Color.gray);\r
 580     g.drawLine(x-av.charWidth,y2,(eRes-sRes)*av.charWidth,y2);\r
 581 \r
 582 \r
 583     for (int j = sRes; j < eRes; j++)\r
 584     {\r
 585       if(aa.annotations[j]==null || aa.annotations[j-1]==null)\r
 586       {\r
 587         x+=av.charWidth;\r
 588         continue;\r
 589       }\r
 590         g.setColor(aa.annotations[j].colour);\r
 591         y1 = y - (int) (((aa.annotations[j-1].value-min) / range) * graphHeight);\r
 592         y2 = y - (int) (((aa.annotations[j].value-min) / range) * graphHeight);\r
 593         g.drawLine(x-av.charWidth/2, y1, x+av.charWidth/2, y2);\r
 594         x += av.charWidth;\r
 595      }\r
 596 \r
 597 \r
 598      if(aa.threshold!=null)\r
 599      {\r
 600          g.setColor(aa.threshold.colour);\r
 601          y2 = (int)(y - ((aa.threshold.value-min) / range)*aa.graphHeight);\r
 602          g.drawLine(0,y2,(eRes-sRes)*av.charWidth,y2);\r
 603      }\r
 604 \r
 605   }\r
 606 \r
 607   public void drawBarGraph(Graphics g, AlignmentAnnotation aa,\r
 608                            int sRes, int eRes,\r
 609                            float min, float max,\r
 610                            int y)\r
 611   {\r
 612     if(sRes>aa.annotations.length)\r
 613       return;\r
 614 \r
 615 \r
 616     eRes = Math.min(eRes, aa.annotations.length);\r
 617 \r
 618     int x=0, y1, y2;\r
 619 \r
 620     float range = max - min;\r
 621 \r
 622     y1 = y2 = y;\r
 623 \r
 624     if(min<0)\r
 625       y2 = (int)(y - (0-min / (range))*aa.graphHeight);\r
 626 \r
 627     g.setColor(Color.gray);\r
 628 \r
 629     g.drawLine(x,y2,(eRes-sRes)*av.charWidth,y2);\r
 630 \r
 631     for (int j = sRes; j < eRes; j++)\r
 632     {\r
 633 \r
 634       if (aa.annotations[j] == null)\r
 635       {\r
 636         x += av.charWidth;\r
 637         continue;\r
 638       }\r
 639 \r
 640         g.setColor(aa.annotations[j].colour);\r
 641         y1 = y - (int) (((aa.annotations[j].value-min) / (range)) * aa.graphHeight);\r
 642 \r
 643         if(y1-y2>0)\r
 644           g.fillRect(x, y2, av.charWidth, y1-y2 );\r
 645         else\r
 646           g.fillRect(x, y1, av.charWidth, y2-y1 );\r
 647 \r
 648         x += av.charWidth;\r
 649     }\r
 650 \r
 651 \r
 652     if(aa.threshold!=null)\r
 653     {\r
 654         g.setColor(aa.threshold.colour);\r
 655         y2 = (int)(y - ((aa.threshold.value-min) / range)*aa.graphHeight);\r
 656         g.drawLine(0,y2,(eRes-sRes)*av.charWidth,y2);\r
 657     }\r
 658 \r
 659 \r
 660   }\r
 661 \r
 662   // used by overview window\r
 663   public void drawGraph(Graphics g, AlignmentAnnotation aa, int width, int y, int sRes, int eRes)\r
 664   {\r
 665       g.setColor(Color.white);\r
 666       g.fillRect(0, 0, width, y);\r
 667       g.setColor(new Color(0, 0, 180));\r
 668 \r
 669       int x = 0, height;\r
 670 \r
 671       for (int j = sRes; j < eRes; j++)\r
 672       {\r
 673           g.setColor(aa.annotations[j].colour);\r
 674 \r
 675           height = (int) ((aa.annotations[j].value / aa.graphMax) * GRAPH_HEIGHT);\r
 676           if(height>y)\r
 677               height = y;\r
 678           g.fillRect(x, y - height, av.charWidth, height);\r
 679           x += av.charWidth;\r
 680       }\r
 681     }\r
 682 }\r