JAL-2611 Pre-merge checkin
[jalview.git] / src / jalview / gui / OverviewPanel.java
index 02fb656..35a3148 100755 (executable)
-package jalview.gui;\r
-\r
-import javax.swing.*;\r
-import java.awt.event.*;\r
-import java.awt.image.*;\r
-import java.awt.*;\r
-\r
-public class OverviewPanel extends JPanel\r
-{\r
-  BufferedImage miniMe;\r
-  AlignViewport av;\r
-  AlignmentPanel ap;\r
-  float scalew = 1f;\r
-  float scaleh = 1f;\r
-\r
-  int sequencesWidth, sequencesHeight;\r
-  int graphHeight=30;\r
-  int boxX=-1, boxY=-1, boxWidth=-1, boxHeight=-1;\r
-\r
-  public OverviewPanel(AlignmentPanel ap, AlignViewport av)\r
-  {\r
-    this.av = av;\r
-    this.ap = ap;\r
-\r
-    // scale the initial size of overviewpanel to shape of alignment\r
-\r
-    float initialScale = (float)av.getAlignment().getWidth()/(float)av.getAlignment().getHeight();\r
-    if(av.getAlignment().getWidth() > av.getAlignment().getHeight())\r
-    {\r
-      // wider\r
-      sequencesWidth = 400;\r
-      sequencesHeight = (int)(400f/initialScale);\r
-    }\r
-    else\r
-    {\r
-      // taller\r
-      sequencesWidth = (int)(400f*initialScale);\r
-      sequencesHeight = 300;\r
-    }\r
-\r
-\r
-\r
-    setSize(sequencesWidth, sequencesHeight+graphHeight);\r
-    setLayout(null);\r
-\r
-    updateOverviewImage();\r
-\r
-    addComponentListener(new ComponentAdapter()\r
-   {\r
-\r
-       public void componentResized(ComponentEvent evt)\r
-       {\r
-         if( getWidth()!=sequencesWidth || getHeight()!=sequencesHeight+graphHeight)\r
-           updateOverviewImage();\r
-       }\r
-   });\r
-\r
-\r
-    addMouseMotionListener(new MouseMotionAdapter()\r
-           {\r
-             public void mouseDragged(MouseEvent evt)\r
-             { doMouseDragged(evt);}\r
-           });\r
-\r
-    addMouseListener(new MouseAdapter()\r
-    {\r
-      public void mousePressed(MouseEvent evt)\r
-      { doMousePressed(evt);}\r
-      public void mouseReleased(MouseEvent evt)\r
-      { doMouseReleased(evt);}\r
-    });\r
-\r
-  }\r
-\r
-  public void doMousePressed(MouseEvent evt)\r
-  {\r
-    checkValid(evt.getX(), evt.getY());\r
-    repaint();\r
-  }\r
-\r
-  public void doMouseReleased(MouseEvent evt)\r
-  {\r
-    int x = evt.getX();\r
-    int y = evt.getY();\r
-    checkValid(x, y);\r
-    ap.setScrollValues( (int)(x/scalew/av.getCharWidth()), (int)(y/scaleh/av.getCharHeight()) );\r
-  }\r
-\r
-  public void doMouseDragged(MouseEvent evt)\r
-  {\r
-    int x = evt.getX();\r
-    int y = evt.getY();\r
-    checkValid(x, y);\r
-    ap.setScrollValues( (int)(x/scalew/av.getCharWidth()), (int)(y/scaleh/av.getCharHeight()) );\r
-    repaint();\r
-  }\r
-\r
-  void checkValid(int x, int y)\r
-  {\r
-\r
-    if (y < 0)\r
-      y = 0;\r
-    if (y > sequencesHeight - boxHeight)\r
-      y = sequencesHeight- boxHeight;\r
-\r
-\r
-    if (x < 0)\r
-      x = 0;\r
-\r
-    if (x > sequencesWidth - boxWidth)\r
-      x = sequencesWidth - boxWidth;\r
-\r
-    boxX = x;\r
-    boxY = y;\r
-  }\r
-\r
-  public void updateOverviewImage()\r
-  {\r
-\r
-  boolean oldRenderGaps = av.renderGaps;\r
-  av.setRenderGaps(false);\r
-   miniMe = null;\r
-   setPreferredSize (new Dimension(sequencesWidth, sequencesHeight+graphHeight));\r
-   sequencesWidth=getWidth();\r
-   sequencesHeight=this.getHeight()-graphHeight;\r
-\r
-\r
-    int fullsizeWidth  = av.getAlignment().getWidth() * av.getCharWidth();\r
-    int fullsizeHeight = av.getAlignment().getHeight()* av.getCharHeight();\r
-\r
-\r
-    BufferedImage fullSize = new BufferedImage(fullsizeWidth,\r
-                                               fullsizeHeight,\r
-                                               BufferedImage.TYPE_INT_RGB);\r
-\r
-    BufferedImage consensus = new BufferedImage(fullsizeWidth,\r
-                                               80,\r
-                                               BufferedImage.TYPE_INT_RGB);\r
-\r
-\r
-    Graphics g = fullSize.getGraphics();\r
-    ap.seqPanel.seqCanvas.drawPanel(g,0,av.getAlignment().getWidth(),0,av.getAlignment().getHeight(),0,0,0);\r
-\r
-    g = consensus.getGraphics();\r
-    ap.scorePanel.drawScorePanel(g, fullsizeWidth, 0, av.getAlignment().getWidth());\r
-\r
-    try{\r
-      miniMe = new BufferedImage(sequencesWidth, sequencesHeight + graphHeight,\r
-                                 BufferedImage.TYPE_INT_RGB);\r
-      Graphics mg = miniMe.getGraphics();\r
-\r
-      mg.drawImage(fullSize, 0, 0, sequencesWidth, sequencesHeight, 0, 0,\r
-                   fullsizeWidth, fullsizeHeight, this);\r
-      mg.drawImage(consensus, 0, sequencesHeight, sequencesWidth,\r
-                   sequencesHeight + graphHeight, 0, 0, fullsizeWidth, 60, this);\r
-\r
-      scalew = (float) sequencesWidth / (float) fullsizeWidth;\r
-      scaleh = (float) sequencesHeight / (float) fullsizeHeight;\r
-\r
-      setBoxPosition();\r
-    }catch(Exception ex)\r
-    {// most likely the frame size is zero\r
-      miniMe = null;\r
-    }\r
-\r
-    av.setRenderGaps(oldRenderGaps);\r
-\r
-  }\r
-\r
-  public void setBoxPosition()\r
-  {\r
-      boxX = (int) (av.getStartRes() * av.getCharWidth() * scalew);\r
-      boxY = (int) (av.getStartSeq() * av.getCharHeight() * scaleh);\r
-      boxWidth = (int) (av.getEndRes() * av.getCharWidth() * scalew) - boxX;\r
-      boxHeight = (int) (av.getEndSeq() * av.getCharHeight() * scaleh) - boxY;\r
-      repaint();\r
-\r
-  }\r
-\r
-\r
-  public void paintComponent(Graphics g)\r
-  {\r
-    if(miniMe!=null)\r
-      g.drawImage(miniMe, 0,0,this);\r
-\r
-    g.setColor(Color.red);\r
-\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());
+
+        }
+      }
+
+      @Override
+      public void mouseMoved(MouseEvent evt)
+      {
+        if (od.isPositionInBox(evt.getX(), evt.getY()))
+        {
+          // display drag cursor at mouse position
+
+        }
+        else
+        {
+          // reset cursor
+
+        }
+      }
+    });
+
+    addMouseListener(new MouseAdapter()
+    {
+      @Override
+      public void mousePressed(MouseEvent evt)
+      {
+        if (SwingUtilities.isRightMouseButton(evt))
+        {
+          if (!Platform.isAMac())
+          {
+            showPopupMenu(evt);
+          }
+        }
+        else if (!av.getWrapAlignment())
+        {
+          if (!od.isPositionInBox(evt.getX(), evt.getY()))
+          {
+            // don't do anything if the mouse press is in the overview's box
+            // (wait to see if it's a drag instead)
+            // otherwise update the viewport
+            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();
+  }
+}