JAL-2446 merged to spike branch
[jalview.git] / src / jalview / gui / OverviewPanel.java
index f78f2e6..3fa674e 100755 (executable)
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
- */\r
-package jalview.gui;\r
-\r
-import java.awt.*;\r
-import java.awt.event.*;\r
-import java.awt.image.*;\r
-\r
-import javax.swing.*;\r
-\r
-\r
-/**\r
- * DOCUMENT ME!\r
- *\r
- * @author $author$\r
- * @version $Revision$\r
- */\r
-public class OverviewPanel extends JPanel implements Runnable\r
-{\r
-    BufferedImage miniMe;\r
-    AlignViewport av;\r
-    AlignmentPanel ap;\r
-    float scalew = 1f;\r
-    float scaleh = 1f;\r
-    int width;\r
-    int sequencesHeight;\r
-    int graphHeight = 30;\r
-    int boxX = -1;\r
-    int boxY = -1;\r
-    int boxWidth = -1;\r
-    int boxHeight = -1;\r
-    boolean resizing = false;\r
-\r
-    /**\r
-     * Creates a new OverviewPanel object.\r
-     *\r
-     * @param ap DOCUMENT ME!\r
-     */\r
-    public OverviewPanel(AlignmentPanel ap)\r
-    {\r
-        this.av = ap.av;\r
-        this.ap = ap;\r
-        setLayout(null);\r
-\r
-        // scale the initial size of overviewpanel to shape of alignment\r
-        float initialScale = (float) av.alignment.getWidth() / (float) av.alignment.getHeight();\r
-\r
-        if (av.alignment.getWidth() > av.alignment.getHeight())\r
-        {\r
-            // wider\r
-            width = 400;\r
-            sequencesHeight = (int) (400f / initialScale);\r
-        }\r
-        else\r
-        {\r
-            // taller\r
-            width = (int) (400f * initialScale);\r
-            sequencesHeight = 300;\r
-\r
-            if (width < 120)\r
-            {\r
-                width = 120;\r
-            }\r
-        }\r
-\r
-        addComponentListener(new ComponentAdapter()\r
-            {\r
-                public void componentResized(ComponentEvent evt)\r
-                {\r
-                    if ((getWidth() != width) ||\r
-                            (getHeight() != (sequencesHeight + graphHeight)))\r
-                    {\r
-                        updateOverviewImage();\r
-                    }\r
-                }\r
-            });\r
-\r
-        addMouseMotionListener(new MouseMotionAdapter()\r
-            {\r
-                public void mouseDragged(MouseEvent evt)\r
-                {\r
-                    doMouseDragged(evt);\r
-                }\r
-            });\r
-\r
-        addMouseListener(new MouseAdapter()\r
-            {\r
-                public void mousePressed(MouseEvent evt)\r
-                {\r
-                    doMousePressed(evt);\r
-                }\r
-\r
-                public void mouseReleased(MouseEvent evt)\r
-                {\r
-                    doMouseReleased(evt);\r
-                }\r
-            });\r
-\r
-        updateOverviewImage();\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param evt DOCUMENT ME!\r
-     */\r
-    public void doMousePressed(MouseEvent evt)\r
-    {\r
-        boxX = evt.getX();\r
-        boxY = evt.getY();\r
-\r
-        checkValid();\r
-        repaint();\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param evt DOCUMENT ME!\r
-     */\r
-    public void doMouseReleased(MouseEvent evt)\r
-    {\r
-        boxX = evt.getX();\r
-        boxY = evt.getY();\r
-        checkValid();\r
-\r
-        if (!resizing)\r
-        {\r
-            ap.setScrollValues((int) (boxX / scalew / av.getCharWidth()),\r
-                (int) (boxY / scaleh / av.getCharHeight()));\r
-        }\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param evt DOCUMENT ME!\r
-     */\r
-    public void doMouseDragged(MouseEvent evt)\r
-    {\r
-        boxX = evt.getX();\r
-        boxY = evt.getY();\r
-        checkValid();\r
-\r
-        if (!resizing)\r
-        {\r
-            ap.setScrollValues((int) (boxX / scalew / av.getCharWidth()),\r
-                (int) (boxY / scaleh / av.getCharHeight()));\r
-        }\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     */\r
-    void checkValid()\r
-    {\r
-        if (boxY < 0)\r
-        {\r
-            boxY = 0;\r
-        }\r
-\r
-        if (boxY > (sequencesHeight - boxHeight))\r
-        {\r
-            boxY = sequencesHeight - boxHeight + 1;\r
-        }\r
-\r
-        if (boxX < 0)\r
-        {\r
-            boxX = 0;\r
-        }\r
-\r
-        if (boxX > (width - boxWidth))\r
-        {\r
-            boxX = width - boxWidth;\r
-        }\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     */\r
-    public void updateOverviewImage()\r
-    {\r
-        if (resizing)\r
-        {\r
-            resizeAgain = true;\r
-            return;\r
-        }\r
-\r
-        resizing = true;\r
-\r
-        Thread thread = new Thread(this);\r
-        thread.start();\r
-        repaint();\r
-    }\r
-\r
-    // This is set true if the user resizes whilst\r
-    // the overview is being calculated\r
-    boolean resizeAgain = false;\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     */\r
-    public void run()\r
-    {\r
-        miniMe = null;\r
-\r
-        int alwidth = av.alignment.getWidth();\r
-        int alheight = av.alignment.getHeight();\r
-\r
-        if ((getWidth() > 0) && (getHeight() > 0))\r
-        {\r
-            width = getWidth();\r
-            sequencesHeight = getHeight() - graphHeight;\r
-        }\r
-\r
-        setPreferredSize(new Dimension(width, sequencesHeight + graphHeight));\r
-\r
-        int fullsizeWidth = alwidth * av.getCharWidth();\r
-        int fullsizeHeight = alheight * av.getCharHeight();\r
-\r
-        scalew = (float) width / (float) fullsizeWidth;\r
-        scaleh = (float) sequencesHeight / (float) fullsizeHeight;\r
-\r
-        miniMe = new BufferedImage(width, sequencesHeight + graphHeight,\r
-                BufferedImage.TYPE_INT_RGB);\r
-\r
-        Graphics mg = miniMe.getGraphics();\r
-        BufferedImage consensus = new BufferedImage(fullsizeWidth, 60,\r
-                BufferedImage.TYPE_3BYTE_BGR);\r
-        Graphics g = consensus.getGraphics();\r
-        ap.annotationPanel.drawGraph(g, av.conservation, fullsizeWidth, 60);\r
-        mg.drawImage(consensus, 0, sequencesHeight, width,\r
-            sequencesHeight + graphHeight, 0, 0, fullsizeWidth, 60, this);\r
-\r
-        boolean oldRenderGaps = av.renderGaps;\r
-\r
-        try\r
-        {\r
-            // We'll have to draw the full size alignment in chunks, as an image of the\r
-            // whole alignment requires too much memory\r
-            // Max size depends on the font size, the following is a\r
-            // guess at a size which works\r
-            int maxSize = 2000 / av.getFont().getSize();\r
-            BufferedImage block;\r
-            int blockx = 0;\r
-            int blocky = 0;\r
-            int blockw = 0;\r
-            int blockh = 0;\r
-            int eRes = 0;\r
-            int eSeq = 0;\r
-\r
-            av.setRenderGaps(false);\r
-\r
-            for (int sRes = 0, chunkx = 0; sRes < alwidth;\r
-                    sRes += maxSize, chunkx++)\r
-            {\r
-                if(resizeAgain)\r
-                  break;\r
-\r
-                eSeq = 0;\r
-                eRes += maxSize;\r
-\r
-                if (eRes > alwidth)\r
-                {\r
-                    eRes = alwidth;\r
-                }\r
-\r
-                for (int sSeq = 0, chunky = 0; sSeq < alheight;\r
-                        sSeq += maxSize, chunky++)\r
-                {\r
-                    eSeq += maxSize;\r
-\r
-                    if (eSeq > alheight)\r
-                    {\r
-                        eSeq = alheight;\r
-                    }\r
-\r
-                    blocky = 0;\r
-                    blockx = (int) ((float) sRes / (float) alwidth * width);\r
-\r
-                    block = new BufferedImage((eRes - sRes) * av.charWidth,\r
-                            (eSeq - sSeq) * av.charHeight,\r
-                            BufferedImage.TYPE_3BYTE_BGR);\r
-                    g = block.getGraphics();\r
-\r
-                    ap.seqPanel.seqCanvas.drawPanel(g, sRes, eRes, sSeq, eSeq,\r
-                        sRes, sSeq, 0);\r
-\r
-                    blockh = (int) ((float) (eSeq - sSeq) / (float) alheight * sequencesHeight) +\r
-                        1;\r
-                    blockw = (int) ((float) (eRes - sRes) / (float) alwidth * width) +\r
-                        1;\r
-\r
-                    blocky += (int) ((float) sSeq / (float) alheight * sequencesHeight);\r
-\r
-                    mg.drawImage(block, blockx, blocky, blockx + blockw,\r
-                        blocky + blockh, 0, 0, block.getWidth(),\r
-                        block.getHeight(), null);\r
-\r
-                    block = null;\r
-                }\r
-            }\r
-        }\r
-        catch (OutOfMemoryError error)\r
-        {\r
-            System.err.println(\r
-                "Out of memory when trying to calculate the overview window image!");\r
-        }\r
-\r
-        System.gc();\r
-\r
-        av.setRenderGaps(oldRenderGaps);\r
-        resizing = false;\r
-\r
-        setBoxPosition();\r
-\r
-        if(resizeAgain)\r
-        {\r
-          resizeAgain = false;\r
-          updateOverviewImage();\r
-        }\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     */\r
-    public void setBoxPosition()\r
-    {\r
-      int fullsizeWidth = av.alignment.getWidth() * av.getCharWidth();\r
-      int fullsizeHeight = av.alignment.getHeight() * av.getCharHeight();\r
-\r
-      scalew = (float) width / (float) fullsizeWidth;\r
-      scaleh = (float) sequencesHeight / (float) fullsizeHeight;\r
-\r
-        boxX = (int) (av.getStartRes() * av.getCharWidth() * scalew);\r
-        boxY = (int) (av.getStartSeq() * av.getCharHeight() * scaleh);\r
-        boxWidth = (int) ((av.getEndRes() - av.getStartRes() + 1) * av.getCharWidth() * scalew);\r
-        boxHeight = (int) (av.getEndSeq() * av.getCharHeight() * scaleh) -\r
-            boxY;\r
-        repaint();\r
-    }\r
-\r
-    /**\r
-     * DOCUMENT ME!\r
-     *\r
-     * @param g DOCUMENT ME!\r
-     */\r
-    public void paintComponent(Graphics g)\r
-    {\r
-        g.setColor(Color.white);\r
-        g.fillRect(0, 0, getWidth(), getHeight());\r
-        g.setColor(Color.black);\r
-\r
-        if (resizing)\r
-        {\r
-            g.setFont(new Font("Verdana", Font.BOLD, 15));\r
-            g.drawString("Recalculating", 5, sequencesHeight / 2);\r
-            g.drawString("Overview.....", 5, (sequencesHeight / 2) + 20);\r
-        }\r
-        else\r
-        {\r
-            if (miniMe != null)\r
-            {\r
-                g.drawImage(miniMe, 0, 0, this);\r
-            }\r
-\r
-            g.setColor(Color.red);\r
-            g.drawRect(boxX, boxY, boxWidth, boxHeight);\r
-            g.drawRect(boxX + 1, boxY + 1, boxWidth - 2, boxHeight - 2);\r
-        }\r
-    }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * 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/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.gui;
+
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+import jalview.viewmodel.OverviewDimensions;
+import jalview.viewmodel.OverviewDimensionsHideHidden;
+import jalview.viewmodel.OverviewDimensionsShowHidden;
+import jalview.viewmodel.ViewportListenerI;
+
+import java.awt.BorderLayout;
+import java.awt.Dimension;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.ComponentAdapter;
+import java.awt.event.ComponentEvent;
+import java.awt.event.MouseAdapter;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseMotionAdapter;
+import java.beans.PropertyChangeEvent;
+
+import javax.swing.JCheckBoxMenuItem;
+import javax.swing.JPanel;
+import javax.swing.JPopupMenu;
+import javax.swing.SwingUtilities;
+
+/**
+ * Panel displaying an overview of the full alignment, with an interactive box
+ * representing the viewport onto the alignment.
+ * 
+ * @author $author$
+ * @version $Revision$
+ */
+public class OverviewPanel extends JPanel implements Runnable,
+        ViewportListenerI
+{
+  private OverviewDimensions od;
+
+  private OverviewCanvas oviewCanvas;
+
+  private AlignViewport av;
+
+  private AlignmentPanel ap;
+
+  private JCheckBoxMenuItem displayToggle;
+
+  private boolean showHidden = true;
+
+  /**
+   * Creates a new OverviewPanel object.
+   * 
+   * @param alPanel
+   *          The alignment panel which is shown in the overview panel
+   */
+  public OverviewPanel(AlignmentPanel alPanel)
+  {
+    this.av = alPanel.av;
+    this.ap = alPanel;
+
+    od = new OverviewDimensionsShowHidden(av.getRanges(),
+            (av.isShowAnnotation() && av
+                    .getAlignmentConservationAnnotation() != null));
+
+    setSize(od.getWidth(), od.getHeight());
+
+    oviewCanvas = new OverviewCanvas(od, av);
+    setLayout(new BorderLayout());
+    add(oviewCanvas, BorderLayout.CENTER);
+
+    av.getRanges().addPropertyChangeListener(this);
+
+    addComponentListener(new ComponentAdapter()
+    {
+      @Override
+      public void componentResized(ComponentEvent evt)
+      {
+        if ((getWidth() != od.getWidth())
+                || (getHeight() != (od.getHeight())))
+        {
+          updateOverviewImage();
+          setBoxPosition();
+        }
+      }
+    });
+
+    addMouseMotionListener(new MouseMotionAdapter()
+    {
+      @Override
+      public void mouseDragged(MouseEvent evt)
+      {
+        if (!SwingUtilities.isRightMouseButton(evt)
+                && !av.getWrapAlignment())
+        {
+          od.updateViewportFromMouse(evt.getX(), evt.getY(), av
+                  .getAlignment().getHiddenSequences(), av.getAlignment()
+                  .getHiddenColumns());
+
+        }
+      }
+    });
+
+    addMouseListener(new MouseAdapter()
+    {
+      @Override
+      public void mousePressed(MouseEvent evt)
+      {
+        if (SwingUtilities.isRightMouseButton(evt))
+        {
+          if (!Platform.isAMac())
+          {
+            showPopupMenu(evt);
+          }
+        }
+        else if (!av.getWrapAlignment())
+        {
+          od.updateViewportFromMouse(evt.getX(), evt.getY(), av
+                  .getAlignment().getHiddenSequences(), av.getAlignment()
+                  .getHiddenColumns());
+        }
+      }
+
+      @Override
+      public void mouseClicked(MouseEvent evt)
+      {
+        if (SwingUtilities.isRightMouseButton(evt))
+        {
+          showPopupMenu(evt);
+        }
+      }
+    });
+
+
+    updateOverviewImage();
+  }
+
+  /*
+   * Displays the popup menu and acts on user input
+   */
+  private void showPopupMenu(MouseEvent e)
+  {
+    JPopupMenu popup = new JPopupMenu();
+    ActionListener menuListener = new ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent event)
+      {
+        // switch on/off the hidden columns view
+        toggleHiddenColumns();
+        displayToggle.setSelected(showHidden);
+      }
+    };
+    displayToggle = new JCheckBoxMenuItem(
+            MessageManager.getString("label.togglehidden"));
+    displayToggle.setEnabled(true);
+    displayToggle.setSelected(showHidden);
+    popup.add(displayToggle);
+    displayToggle.addActionListener(menuListener);
+    popup.show(this, e.getX(), e.getY());
+  }
+
+  /*
+   * Toggle overview display between showing hidden columns and hiding hidden columns
+   */
+  private void toggleHiddenColumns()
+  {
+    if (showHidden)
+    {
+      showHidden = false;
+      od = new OverviewDimensionsHideHidden(av.getRanges(),
+              (av.isShowAnnotation() && av
+                      .getAlignmentConservationAnnotation() != null));
+    }
+    else
+    {
+      showHidden = true;
+      od = new OverviewDimensionsShowHidden(av.getRanges(),
+              (av.isShowAnnotation() && av
+                      .getAlignmentConservationAnnotation() != null));
+    }
+    oviewCanvas.resetOviewDims(od);
+    updateOverviewImage();
+    setBoxPosition();
+  }
+
+  /**
+   * Updates the overview image when the related alignment panel is updated
+   */
+  public void updateOverviewImage()
+  {
+    if ((getWidth() > 0) && (getHeight() > 0))
+    {
+      od.setWidth(getWidth());
+      od.setHeight(getHeight());
+    }
+    
+    setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
+
+    if (oviewCanvas.restartDraw())
+    {
+      return;
+    }
+
+    Thread thread = new Thread(this);
+    thread.start();
+    repaint();
+
+  }
+
+  @Override
+  public void run()
+  {
+    oviewCanvas.draw(av.isShowSequenceFeatures(),
+            (av.isShowAnnotation() && av
+                    .getAlignmentConservationAnnotation() != null), ap
+                    .getSeqPanel().seqCanvas.getFeatureRenderer());
+    setBoxPosition();
+  }
+
+  /**
+   * Update the overview panel box when the associated alignment panel is
+   * changed
+   * 
+   */
+  private void setBoxPosition()
+  {
+    od.setBoxPosition(av.getAlignment().getHiddenSequences(), av
+            .getAlignment().getHiddenColumns());
+    repaint();
+  }
+
+  @Override
+  public void propertyChange(PropertyChangeEvent evt)
+  {
+    setBoxPosition();
+  }
+}