src/jalview/gui/OverviewPanel.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2007 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 java.awt.*;\r
  22 import java.awt.event.*;\r
  23 import java.awt.image.*;\r
  24 import javax.swing.*;\r
  25 \r
  26 /**\r
  27  * DOCUMENT ME!\r
  28  *\r
  29  * @author $author$\r
  30  * @version $Revision$\r
  31  */\r
  32 public class OverviewPanel\r
  33     extends JPanel implements Runnable\r
  34 {\r
  35   BufferedImage miniMe;\r
  36   AlignViewport av;\r
  37   AlignmentPanel ap;\r
  38   float scalew = 1f;\r
  39   float scaleh = 1f;\r
  40   int width;\r
  41   int sequencesHeight;\r
  42   int graphHeight = 20;\r
  43   int boxX = -1;\r
  44   int boxY = -1;\r
  45   int boxWidth = -1;\r
  46   int boxHeight = -1;\r
  47   boolean resizing = false;\r
  48 \r
  49   // Can set different properties in this seqCanvas than\r
  50   // main visible SeqCanvas\r
  51   SequenceRenderer sr;\r
  52   FeatureRenderer fr;\r
  53 \r
  54   /**\r
  55    * Creates a new OverviewPanel object.\r
  56    *\r
  57    * @param ap DOCUMENT ME!\r
  58    */\r
  59   public OverviewPanel(AlignmentPanel ap)\r
  60   {\r
  61     this.av = ap.av;\r
  62     this.ap = ap;\r
  63     setLayout(null);\r
  64 \r
  65     sr = new SequenceRenderer(av);\r
  66     sr.renderGaps = false;\r
  67     sr.forOverview = true;\r
  68     fr = new FeatureRenderer(ap);\r
  69 \r
  70     // scale the initial size of overviewpanel to shape of alignment\r
  71     float initialScale = (float) av.alignment.getWidth() /\r
  72         (float) av.alignment.getHeight();\r
  73 \r
  74     if (av.conservation == null)\r
  75     {\r
  76       graphHeight = 0;\r
  77     }\r
  78 \r
  79     if (av.alignment.getWidth() > av.alignment.getHeight())\r
  80     {\r
  81       // wider\r
  82       width = 400;\r
  83       sequencesHeight = (int) (400f / initialScale);\r
  84       if (sequencesHeight < 40)\r
  85       {\r
  86         sequencesHeight = 40;\r
  87       }\r
  88     }\r
  89     else\r
  90     {\r
  91       // taller\r
  92       width = (int) (400f * initialScale);\r
  93       sequencesHeight = 300;\r
  94 \r
  95       if (width < 120)\r
  96       {\r
  97         width = 120;\r
  98       }\r
  99     }\r
 100 \r
 101     addComponentListener(new ComponentAdapter()\r
 102     {\r
 103       public void componentResized(ComponentEvent evt)\r
 104       {\r
 105         if ( (getWidth() != width) ||\r
 106             (getHeight() != (sequencesHeight + graphHeight)))\r
 107         {\r
 108           updateOverviewImage();\r
 109         }\r
 110       }\r
 111     });\r
 112 \r
 113     addMouseMotionListener(new MouseMotionAdapter()\r
 114     {\r
 115       public void mouseDragged(MouseEvent evt)\r
 116       {\r
 117         if (!av.wrapAlignment)\r
 118         {\r
 119           boxX = evt.getX();\r
 120           boxY = evt.getY();\r
 121           checkValid();\r
 122         }\r
 123       }\r
 124     });\r
 125 \r
 126     addMouseListener(new MouseAdapter()\r
 127     {\r
 128       public void mousePressed(MouseEvent evt)\r
 129       {\r
 130         if (!av.wrapAlignment)\r
 131         {\r
 132           boxX = evt.getX();\r
 133           boxY = evt.getY();\r
 134           checkValid();\r
 135         }\r
 136       }\r
 137     });\r
 138 \r
 139     updateOverviewImage();\r
 140   }\r
 141 \r
 142   /**\r
 143    * DOCUMENT ME!\r
 144    */\r
 145   void checkValid()\r
 146   {\r
 147     if (boxY < 0)\r
 148     {\r
 149       boxY = 0;\r
 150     }\r
 151 \r
 152     if (boxY > (sequencesHeight - boxHeight))\r
 153     {\r
 154       boxY = sequencesHeight - boxHeight + 1;\r
 155     }\r
 156 \r
 157     if (boxX < 0)\r
 158     {\r
 159       boxX = 0;\r
 160     }\r
 161 \r
 162     if (boxX > (width - boxWidth))\r
 163     {\r
 164       if (av.hasHiddenColumns)\r
 165       {\r
 166         //Try smallest possible box\r
 167         boxWidth = (int) ( (av.endRes - av.startRes + 1) *\r
 168                           av.getCharWidth() * scalew);\r
 169       }\r
 170       boxX = width - boxWidth;\r
 171     }\r
 172 \r
 173     int col = (int) (boxX / scalew / av.getCharWidth());\r
 174     int row = (int) (boxY / scaleh / av.getCharHeight());\r
 175 \r
 176     if (av.hasHiddenColumns)\r
 177     {\r
 178       if (!av.getColumnSelection().isVisible(col))\r
 179       {\r
 180         return;\r
 181       }\r
 182 \r
 183       col = av.getColumnSelection().findColumnPosition(col);\r
 184     }\r
 185 \r
 186     if (av.hasHiddenRows)\r
 187     {\r
 188       row = av.alignment.getHiddenSequences().findIndexWithoutHiddenSeqs(row);\r
 189     }\r
 190 \r
 191     ap.setScrollValues(col, row);\r
 192 \r
 193   }\r
 194 \r
 195   /**\r
 196    * DOCUMENT ME!\r
 197    */\r
 198   public void updateOverviewImage()\r
 199   {\r
 200     if (resizing)\r
 201     {\r
 202       resizeAgain = true;\r
 203       return;\r
 204     }\r
 205 \r
 206     resizing = true;\r
 207 \r
 208     if ( (getWidth() > 0) && (getHeight() > 0))\r
 209     {\r
 210       width = getWidth();\r
 211       sequencesHeight = getHeight() - graphHeight;\r
 212     }\r
 213 \r
 214     setPreferredSize(new Dimension(width, sequencesHeight + graphHeight));\r
 215 \r
 216     Thread thread = new Thread(this);\r
 217     thread.start();\r
 218     repaint();\r
 219   }\r
 220 \r
 221   // This is set true if the user resizes whilst\r
 222   // the overview is being calculated\r
 223   boolean resizeAgain = false;\r
 224 \r
 225   /**\r
 226    * DOCUMENT ME!\r
 227    */\r
 228   public void run()\r
 229   {\r
 230     miniMe = null;\r
 231 \r
 232     if (av.showSequenceFeatures)\r
 233     {\r
 234       fr.transferSettings(ap.seqPanel.seqCanvas.getFeatureRenderer());\r
 235     }\r
 236 \r
 237     int alwidth = av.alignment.getWidth();\r
 238     int alheight = av.alignment.getHeight()\r
 239         + av.alignment.getHiddenSequences().getSize();\r
 240 \r
 241     setPreferredSize(new Dimension(width, sequencesHeight + graphHeight));\r
 242 \r
 243     int fullsizeWidth = alwidth * av.getCharWidth();\r
 244     int fullsizeHeight = alheight * av.getCharHeight();\r
 245 \r
 246     scalew = (float) width / (float) fullsizeWidth;\r
 247     scaleh = (float) sequencesHeight / (float) fullsizeHeight;\r
 248 \r
 249     miniMe = new BufferedImage(width, sequencesHeight + graphHeight,\r
 250                                BufferedImage.TYPE_INT_RGB);\r
 251 \r
 252     Graphics mg = miniMe.getGraphics();\r
 253     mg.setColor(Color.orange);\r
 254     mg.fillRect(0, 0, width, miniMe.getHeight());\r
 255 \r
 256     float sampleCol = (float) alwidth / (float) width;\r
 257     float sampleRow = (float) alheight / (float) sequencesHeight;\r
 258 \r
 259     int lastcol = -1, lastrow = -1;\r
 260     int color = Color.white.getRGB();\r
 261     int row, col;\r
 262     jalview.datamodel.SequenceI seq;\r
 263     boolean hiddenRow = false;\r
 264     for (row = 0; row < sequencesHeight; row++)\r
 265     {\r
 266       if ( (int) (row * sampleRow) == lastrow)\r
 267       {\r
 268         //No need to recalculate the colours,\r
 269         //Just copy from the row above\r
 270         for (col = 0; col < width; col++)\r
 271         {\r
 272           miniMe.setRGB(col, row, miniMe.getRGB(col, row - 1));\r
 273         }\r
 274         continue;\r
 275       }\r
 276 \r
 277       lastrow = (int) (row * sampleRow);\r
 278 \r
 279       hiddenRow = false;\r
 280       if (av.hasHiddenRows)\r
 281       {\r
 282         seq = av.alignment.getHiddenSequences().getHiddenSequence(lastrow);\r
 283         if (seq == null)\r
 284         {\r
 285           int index =\r
 286               av.alignment.getHiddenSequences().findIndexWithoutHiddenSeqs(\r
 287               lastrow);\r
 288 \r
 289           seq = av.alignment.getSequenceAt(index);\r
 290         }\r
 291         else\r
 292         {\r
 293           hiddenRow = true;\r
 294         }\r
 295       }\r
 296       else\r
 297       {\r
 298         seq = av.alignment.getSequenceAt(lastrow);\r
 299       }\r
 300 \r
 301       if (seq == null)\r
 302       {\r
 303         System.out.println(lastrow + " null");\r
 304         continue;\r
 305       }\r
 306 \r
 307       for (col = 0; col < width; col++)\r
 308       {\r
 309         if ( (int) (col * sampleCol) == lastcol &&\r
 310             (int) (row * sampleRow) == lastrow)\r
 311         {\r
 312           miniMe.setRGB(col, row, color);\r
 313           continue;\r
 314         }\r
 315 \r
 316         lastcol = (int) (col * sampleCol);\r
 317 \r
 318         if (seq.getLength() > lastcol)\r
 319         {\r
 320           color = sr.getResidueBoxColour(\r
 321               seq, lastcol).getRGB();\r
 322 \r
 323           if (av.showSequenceFeatures)\r
 324           {\r
 325             color = fr.findFeatureColour(color, seq, lastcol);\r
 326           }\r
 327         }\r
 328         else\r
 329         {\r
 330           color = -1; //White\r
 331         }\r
 332 \r
 333         if (hiddenRow ||\r
 334             (av.hasHiddenColumns && !av.getColumnSelection().isVisible(lastcol)))\r
 335         {\r
 336           color = new Color(color).darker().darker().getRGB();\r
 337         }\r
 338 \r
 339         miniMe.setRGB(col, row, color);\r
 340 \r
 341       }\r
 342     }\r
 343 \r
 344     if (av.conservation != null)\r
 345     {\r
 346       for (col = 0; col < width; col++)\r
 347       {\r
 348         lastcol = (int) (col * sampleCol);\r
 349         {\r
 350           mg.translate(col, sequencesHeight);\r
 351           ap.annotationPanel.drawGraph(mg, av.conservation,\r
 352                                        (int) (sampleCol) + 1,\r
 353                                        graphHeight,\r
 354                                        (int) (col * sampleCol),\r
 355                                        (int) (col * sampleCol) + 1);\r
 356           mg.translate( -col, -sequencesHeight);\r
 357         }\r
 358       }\r
 359     }\r
 360     System.gc();\r
 361 \r
 362     resizing = false;\r
 363 \r
 364     setBoxPosition();\r
 365 \r
 366     if (resizeAgain)\r
 367     {\r
 368       resizeAgain = false;\r
 369       updateOverviewImage();\r
 370     }\r
 371   }\r
 372 \r
 373   /**\r
 374    * DOCUMENT ME!\r
 375    */\r
 376   public void setBoxPosition()\r
 377   {\r
 378     int fullsizeWidth = av.alignment.getWidth() * av.getCharWidth();\r
 379     int fullsizeHeight = (av.alignment.getHeight()\r
 380                           + av.alignment.getHiddenSequences().getSize()) *\r
 381         av.getCharHeight();\r
 382 \r
 383     int startRes = av.getStartRes();\r
 384     int endRes = av.getEndRes();\r
 385 \r
 386     if (av.hasHiddenColumns)\r
 387     {\r
 388       startRes = av.getColumnSelection().adjustForHiddenColumns(startRes);\r
 389       endRes = av.getColumnSelection().adjustForHiddenColumns(endRes);\r
 390     }\r
 391 \r
 392     int startSeq = av.startSeq;\r
 393     int endSeq = av.endSeq;\r
 394 \r
 395     if (av.hasHiddenRows)\r
 396     {\r
 397       startSeq =\r
 398           av.alignment.getHiddenSequences().adjustForHiddenSeqs(startSeq);\r
 399 \r
 400       endSeq =\r
 401           av.alignment.getHiddenSequences().adjustForHiddenSeqs(endSeq);\r
 402 \r
 403     }\r
 404 \r
 405     scalew = (float) width / (float) fullsizeWidth;\r
 406     scaleh = (float) sequencesHeight / (float) fullsizeHeight;\r
 407 \r
 408     boxX = (int) (startRes * av.getCharWidth() * scalew);\r
 409     boxY = (int) (startSeq * av.getCharHeight() * scaleh);\r
 410 \r
 411     if (av.hasHiddenColumns)\r
 412     {\r
 413       boxWidth = (int) ( (endRes - startRes + 1) * av.getCharWidth() * scalew);\r
 414     }\r
 415     else\r
 416     {\r
 417       boxWidth = (int) ( (endRes - startRes + 1) * av.getCharWidth() * scalew);\r
 418     }\r
 419 \r
 420     boxHeight = (int) ( (endSeq - startSeq) * av.getCharHeight() * scaleh);\r
 421 \r
 422     repaint();\r
 423   }\r
 424 \r
 425   /**\r
 426    * DOCUMENT ME!\r
 427    *\r
 428    * @param g DOCUMENT ME!\r
 429    */\r
 430   public void paintComponent(Graphics g)\r
 431   {\r
 432     if(resizing)\r
 433     {\r
 434       g.setColor(Color.white);\r
 435       g.fillRect(0,0,getWidth(),getHeight());\r
 436     }\r
 437     else if (miniMe != null)\r
 438     {\r
 439       g.drawImage(miniMe, 0, 0, this);\r
 440     }\r
 441 \r
 442     g.setColor(Color.red);\r
 443     g.drawRect(boxX, boxY, boxWidth, boxHeight);\r
 444     g.drawRect(boxX + 1, boxY + 1, boxWidth - 2, boxHeight - 2);\r
 445 \r
 446   }\r
 447 }\r