update author list in license for (JAL-826)
[jalview.git] / src / jalview / gui / IdCanvas.java
index 6d4a5b9..59d9f8f 100755 (executable)
-package jalview.gui;\r
-\r
-import java.awt.*;\r
-import java.awt.Graphics2D.*;\r
-\r
-import javax.swing.*;\r
-import jalview.datamodel.*;\r
-import jalview.analysis.*;\r
-public class IdCanvas extends JPanel\r
-{\r
-  protected AlignViewport av;\r
-\r
-  public boolean paintFlag   = false;\r
-  protected boolean showScores  = true;\r
-\r
-  protected int     maxIdLength = -1;\r
-  protected String  maxIdStr    = null;\r
-\r
-  public IdCanvas(AlignViewport av)\r
-  {\r
-    setLayout(new BorderLayout());\r
-    this.av         = av;\r
-    PaintRefresher.Register(this);\r
-  }\r
-\r
-  public void drawIdString(Graphics gg,SequenceI ds,int i, int starty, int ypos) {\r
-      int charHeight = av.getCharHeight();\r
-\r
-      if (av.getSelection().contains(ds)) {\r
-         gg.setColor(Color.lightGray);\r
-         gg.fillRect(0,AlignmentUtil.getPixelHeight(starty,i,charHeight)+ ypos,getWidth(),charHeight);\r
-         gg.setColor(Color.white);\r
-      } else {\r
-         gg.setColor(ds.getColor());\r
-         gg.fillRect(0,AlignmentUtil.getPixelHeight(starty,i,charHeight)+ ypos,getWidth(),charHeight);\r
-         gg.setColor(Color.black);\r
-      }\r
-\r
-      String string = ds.getName() + "/" + ds.getStart() + "-" + ds.getEnd();\r
-\r
-      gg.drawString(string,0,AlignmentUtil.getPixelHeight(starty,i,charHeight) + ypos + charHeight-   (charHeight/5));\r
-\r
-  }\r
-\r
-  public void paintComponent(Graphics gg) {\r
-    AlignmentI da         = av.getAlignment();\r
-    int        charHeight = av.getCharHeight();\r
-    gg.setFont(av.getFont());\r
-\r
-    //Fill in the background\r
-    gg.setColor(Color.white);\r
-    gg.fillRect(0,0,getWidth(),getHeight());\r
-\r
-    Color currentColor     = Color.white;\r
-    Color currentTextColor = Color.black;\r
-\r
-    //Which ids are we printing\r
-    int starty = av.getStartSeq();\r
-    int endy   = av.getEndSeq();\r
-\r
-    if (av.getWrapAlignment())\r
-    {\r
-       starty = starty%av.getChunkHeight();\r
-\r
-       int ypos     = 0;\r
-       int rowstart = starty;\r
-\r
-       if (starty == 0)\r
-           ypos = 2*charHeight;\r
-       else if (starty == 1)\r
-       {\r
-           starty = 0;\r
-           ypos = charHeight;\r
-       }\r
-\r
-       endy   = starty + da.getHeight();\r
-\r
-       if (endy > da.getHeight()) {\r
-           endy = da.getHeight();\r
-       }\r
-\r
-       for (int i = starty; i < endy; i++) {\r
-         SequenceI s = da.getSequenceAt(i);\r
-         drawIdString(gg,s,i,starty,ypos);\r
-       }\r
-       if (rowstart == 0) {\r
-           ypos   = ypos +  av.getChunkHeight();\r
-       } else if (rowstart == 1) {\r
-           ypos   = ypos +  av.getChunkHeight();\r
-       } else {\r
-           ypos   = ypos +  av.getChunkHeight() - rowstart*charHeight;\r
-       }\r
-\r
-       starty = 0;\r
-\r
-       int chunkwidth = av.getChunkWidth();\r
-       int startx = (int)(av.getEndSeq()/chunkwidth)*chunkwidth;\r
-       int endx   = startx + chunkwidth;\r
-\r
-\r
-       while (ypos <= getHeight() && endx < da.getWidth()) {\r
-\r
-           for (int i = starty; i < endy; i++) {\r
-             SequenceI s = da.getSequenceAt(i);\r
-             drawIdString(gg,s,i,starty,ypos);\r
-           }\r
-\r
-           ypos   += av.getChunkHeight();\r
-           startx += chunkwidth;\r
-           endx = startx + chunkwidth;\r
-\r
-           if (endx > da.getWidth()) {\r
-               endx = da.getWidth();\r
-           }\r
-\r
-           starty = 0;\r
-\r
-           if (endy > da.getHeight()) {\r
-               endy = da.getHeight();\r
-           }\r
-\r
-       }\r
-    } else\r
-    {\r
-\r
-      //Now draw the id strings\r
-      for (int i = starty; i < endy; i++)\r
-      {\r
-        // Selected sequence colours\r
-        if (av.getSelection().contains(da.getSequenceAt(i)))\r
-        {\r
-          currentColor = Color.lightGray;\r
-          currentTextColor = Color.black;\r
-        }\r
-        else\r
-        {\r
-          currentColor = da.getSequenceAt(i).getColor();\r
-          currentTextColor = Color.black;\r
-        }\r
-\r
-        gg.setColor(currentColor);\r
-\r
-        gg.fillRect(0,\r
-                    AlignmentUtil.getPixelHeight(starty, i, charHeight),\r
-                    getWidth(),\r
-                    charHeight);\r
-\r
-        gg.setColor(currentTextColor);\r
-        String string = da.getSequenceAt(i).getDisplayId();\r
-        gg.drawString(string, 0,\r
-                      AlignmentUtil.getPixelHeight(starty, i, charHeight) +\r
-                      charHeight - (charHeight / 5));\r
-      }\r
-    }\r
-\r
-  }\r
-\r
-\r
-  public Dimension getLabelWidth()\r
-  {\r
-\r
-   FontMetrics fm = this.getGraphics().getFontMetrics(av.font);\r
-   AlignmentI al = av.getAlignment();\r
-\r
-   int i   = 0;\r
-   int idWidth = 0;\r
-\r
-   while (i < al.getHeight() && al.getSequenceAt(i) != null)\r
-   {\r
-     SequenceI s   = al.getSequenceAt(i);\r
-     String str   = s.getDisplayId();\r
-     if (fm.stringWidth(str) > idWidth)\r
-       idWidth = fm.stringWidth(str);\r
-     i++;\r
-   }\r
-\r
-   return new Dimension(idWidth + 10,getHeight());\r
- }\r
-\r
- public Dimension getPreferredSize()\r
- {\r
-   return getLabelWidth();\r
- }\r
-\r
-\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ * 
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package jalview.gui;
+
+import java.awt.*;
+import java.awt.image.*;
+import javax.swing.*;
+
+import jalview.datamodel.*;
+
+/**
+ * DOCUMENT ME!
+ * 
+ * @author $author$
+ * @version $Revision$
+ */
+public class IdCanvas extends JPanel
+{
+  protected AlignViewport av;
+
+  protected boolean showScores = true;
+
+  protected int maxIdLength = -1;
+
+  protected String maxIdStr = null;
+
+  BufferedImage image;
+
+  Graphics2D gg;
+
+  int imgHeight = 0;
+
+  boolean fastPaint = false;
+
+  java.util.Vector searchResults;
+
+  FontMetrics fm;
+
+  AnnotationLabels labels = null;
+
+  AnnotationPanel ap;
+
+  Font idfont;
+
+  /**
+   * Creates a new IdCanvas object.
+   * 
+   * @param av
+   *          DOCUMENT ME!
+   */
+  public IdCanvas(AlignViewport av)
+  {
+    setLayout(new BorderLayout());
+    this.av = av;
+    PaintRefresher.Register(this, av.getSequenceSetId());
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param gg
+   *          DOCUMENT ME!
+   * @param s
+   *          DOCUMENT ME!
+   * @param i
+   *          DOCUMENT ME!
+   * @param starty
+   *          DOCUMENT ME!
+   * @param ypos
+   *          DOCUMENT ME!
+   */
+  public void drawIdString(Graphics2D gg, SequenceI s, int i, int starty,
+          int ypos)
+  {
+    int xPos = 0;
+    int panelWidth = getWidth();
+    int charHeight = av.charHeight;
+
+    if ((searchResults != null) && searchResults.contains(s))
+    {
+      gg.setColor(Color.black);
+      gg.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
+              charHeight);
+      gg.setColor(Color.white);
+    }
+    else if ((av.getSelectionGroup() != null)
+            && av.getSelectionGroup().getSequences(null).contains(s))
+    {
+      gg.setColor(Color.lightGray);
+      gg.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
+              charHeight);
+      gg.setColor(Color.white);
+    }
+    else
+    {
+      gg.setColor(av.getSequenceColour(s));
+      gg.fillRect(0, ((i - starty) * charHeight) + ypos, getWidth(),
+              charHeight);
+      gg.setColor(Color.black);
+    }
+
+    if (av.rightAlignIds)
+    {
+      xPos = panelWidth
+              - fm.stringWidth(s.getDisplayId(av.getShowJVSuffix())) - 4;
+    }
+
+    gg.drawString(s.getDisplayId(av.getShowJVSuffix()), xPos,
+            (((i - starty + 1) * charHeight) + ypos) - (charHeight / 5));
+
+    if (av.hasHiddenRows && av.showHiddenMarkers)
+    {
+      drawMarker(i, starty, ypos);
+    }
+
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param vertical
+   *          DOCUMENT ME!
+   */
+  public void fastPaint(int vertical)
+  {
+    if (gg == null)
+    {
+      repaint();
+
+      return;
+    }
+
+    gg.copyArea(0, 0, getWidth(), imgHeight, 0, -vertical * av.charHeight);
+
+    int ss = av.startSeq;
+    int es = av.endSeq;
+    int transY = 0;
+
+    if (vertical > 0) // scroll down
+    {
+      ss = es - vertical;
+
+      if (ss < av.startSeq)
+      { // ie scrolling too fast, more than a page at a time
+        ss = av.startSeq;
+      }
+      else
+      {
+        transY = imgHeight - (vertical * av.charHeight);
+      }
+    }
+    else if (vertical < 0)
+    {
+      es = ss - vertical;
+
+      if (es > av.endSeq)
+      {
+        es = av.endSeq;
+      }
+    }
+
+    gg.translate(0, transY);
+
+    drawIds(ss, es);
+
+    gg.translate(0, -transY);
+
+    fastPaint = true;
+    repaint();
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param g
+   *          DOCUMENT ME!
+   */
+  public void paintComponent(Graphics g)
+  {
+    g.setColor(Color.white);
+    g.fillRect(0, 0, getWidth(), getHeight());
+
+    if (fastPaint)
+    {
+      fastPaint = false;
+      g.drawImage(image, 0, 0, this);
+
+      return;
+    }
+
+    int oldHeight = imgHeight;
+
+    imgHeight = getHeight();
+    imgHeight -= (imgHeight % av.charHeight);
+
+    if (imgHeight < 1)
+    {
+      return;
+    }
+
+    if (oldHeight != imgHeight || image.getWidth(this) != getWidth())
+    {
+      image = new BufferedImage(getWidth(), imgHeight,
+              BufferedImage.TYPE_INT_RGB);
+    }
+
+    gg = (Graphics2D) image.getGraphics();
+
+    // Fill in the background
+    gg.setColor(Color.white);
+    gg.fillRect(0, 0, getWidth(), imgHeight);
+
+    drawIds(av.getStartSeq(), av.endSeq);
+
+    g.drawImage(image, 0, 0, this);
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param starty
+   *          DOCUMENT ME!
+   * @param endy
+   *          DOCUMENT ME!
+   */
+  void drawIds(int starty, int endy)
+  {
+    if (av.seqNameItalics)
+    {
+      idfont = new Font(av.getFont().getName(), Font.ITALIC, av.getFont()
+              .getSize());
+    }
+    else
+    {
+      idfont = av.getFont();
+    }
+
+    gg.setFont(idfont);
+    fm = gg.getFontMetrics();
+
+    if (av.antiAlias)
+    {
+      gg.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
+              RenderingHints.VALUE_ANTIALIAS_ON);
+    }
+
+    Color currentColor = Color.white;
+    Color currentTextColor = Color.black;
+
+    if (av.getWrapAlignment())
+    {
+      int maxwidth = av.alignment.getWidth();
+      int alheight = av.alignment.getHeight();
+
+      if (av.hasHiddenColumns)
+      {
+        maxwidth = av.getColumnSelection().findColumnPosition(maxwidth) - 1;
+      }
+
+      int annotationHeight = 0;
+
+      if (av.showAnnotation)
+      {
+        if (ap == null)
+        {
+          ap = new AnnotationPanel(av);
+        }
+
+        annotationHeight = ap.adjustPanelHeight();
+        if (labels == null)
+        {
+          labels = new AnnotationLabels(av);
+        }
+      }
+
+      int hgap = av.charHeight;
+      if (av.scaleAboveWrapped)
+      {
+        hgap += av.charHeight;
+      }
+
+      int cHeight = alheight * av.charHeight + hgap + annotationHeight;
+
+      int rowSize = av.getEndRes() - av.getStartRes();
+
+      // Draw the rest of the panels
+      for (int ypos = hgap, row = av.startRes; (ypos <= getHeight())
+              && (row < maxwidth); ypos += cHeight, row += rowSize)
+      {
+        for (int i = starty; i < alheight; i++)
+        {
+          SequenceI s = av.alignment.getSequenceAt(i);
+          if (av.hasHiddenRows)
+          {
+            setHiddenFont(s);
+          }
+          else
+          {
+            gg.setFont(idfont);
+          }
+
+          drawIdString(gg, s, i, 0, ypos);
+        }
+
+        if (labels != null && av.showAnnotation)
+        {
+          gg.translate(0, ypos + (alheight * av.charHeight));
+          labels.drawComponent(gg, getWidth());
+          gg.translate(0, -ypos - (alheight * av.charHeight));
+        }
+      }
+    }
+    else
+    {
+      // No need to hang on to labels if we're not wrapped
+      labels = null;
+
+      // Now draw the id strings
+      int panelWidth = getWidth();
+      int xPos = 0;
+
+      SequenceI sequence;
+      // Now draw the id strings
+      for (int i = starty; i < endy; i++)
+      {
+        sequence = av.alignment.getSequenceAt(i);
+
+        if (sequence == null)
+        {
+          continue;
+        }
+
+        if (av.hasHiddenRows)
+        {
+          setHiddenFont(sequence);
+        }
+
+        // Selected sequence colours
+        if ((searchResults != null) && searchResults.contains(sequence))
+        {
+          currentColor = Color.black;
+          currentTextColor = Color.white;
+        }
+        else if ((av.getSelectionGroup() != null)
+                && av.getSelectionGroup().getSequences(null)
+                        .contains(sequence))
+        {
+          currentColor = Color.lightGray;
+          currentTextColor = Color.black;
+        }
+        else
+        {
+          currentColor = av.getSequenceColour(sequence);
+          currentTextColor = Color.black;
+        }
+
+        gg.setColor(currentColor);
+
+        gg.fillRect(0, (i - starty) * av.charHeight, getWidth(),
+                av.charHeight);
+
+        gg.setColor(currentTextColor);
+
+        String string = sequence.getDisplayId(av.getShowJVSuffix());
+
+        if (av.rightAlignIds)
+        {
+          xPos = panelWidth - fm.stringWidth(string) - 4;
+        }
+
+        gg.drawString(string, xPos,
+                (((i - starty) * av.charHeight) + av.charHeight)
+                        - (av.charHeight / 5));
+
+        if (av.hasHiddenRows && av.showHiddenMarkers)
+        {
+          drawMarker(i, starty, 0);
+        }
+
+      }
+
+    }
+  }
+
+  void drawMarker(int i, int starty, int yoffset)
+  {
+
+    SequenceI[] hseqs = av.alignment.getHiddenSequences().hiddenSequences;
+    // Use this method here instead of calling hiddenSeq adjust
+    // 3 times.
+    int hSize = hseqs.length;
+
+    int hiddenIndex = i;
+    int lastIndex = i - 1;
+    int nextIndex = i + 1;
+
+    for (int j = 0; j < hSize; j++)
+    {
+      if (hseqs[j] != null)
+      {
+        if (j - 1 < hiddenIndex)
+        {
+          hiddenIndex++;
+        }
+        if (j - 1 < lastIndex)
+        {
+          lastIndex++;
+        }
+        if (j - 1 < nextIndex)
+        {
+          nextIndex++;
+        }
+      }
+    }
+
+    boolean below = (hiddenIndex > lastIndex + 1);
+    boolean above = (nextIndex > hiddenIndex + 1);
+
+    gg.setColor(Color.blue);
+    if (below)
+    {
+      gg.fillPolygon(
+              new int[]
+              { getWidth() - av.charHeight, getWidth() - av.charHeight,
+                  getWidth() }, new int[]
+              {
+                  (i - starty) * av.charHeight + yoffset,
+                  (i - starty) * av.charHeight + yoffset + av.charHeight
+                          / 4, (i - starty) * av.charHeight + yoffset }, 3);
+    }
+    if (above)
+    {
+      gg.fillPolygon(
+              new int[]
+              { getWidth() - av.charHeight, getWidth() - av.charHeight,
+                  getWidth() }, new int[]
+              {
+                  (i - starty + 1) * av.charHeight + yoffset,
+                  (i - starty + 1) * av.charHeight + yoffset
+                          - av.charHeight / 4,
+                  (i - starty + 1) * av.charHeight + yoffset }, 3);
+
+    }
+  }
+
+  void setHiddenFont(SequenceI seq)
+  {
+    Font bold = new Font(av.getFont().getName(), Font.BOLD, av.getFont()
+            .getSize());
+
+    if (av.hiddenRepSequences != null
+            && av.hiddenRepSequences.containsKey(seq))
+    {
+      gg.setFont(bold);
+    }
+    else
+    {
+      gg.setFont(idfont);
+    }
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param found
+   *          DOCUMENT ME!
+   */
+  public void setHighlighted(java.util.Vector found)
+  {
+    searchResults = found;
+    repaint();
+  }
+}