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