JAL-1713 refactorings to allow save/restore Overview to/from project
[jalview.git] / src / jalview / gui / OverviewPanel.java
index 567a121..6cb4b96 100755 (executable)
  */
 package jalview.gui;
 
-import jalview.bin.Cache;
-import jalview.renderer.OverviewRenderer;
-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.Cursor;
 import java.awt.Dimension;
-import java.awt.Image;
-import java.awt.Point;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.awt.event.ComponentAdapter;
@@ -44,13 +33,20 @@ import java.awt.event.MouseMotionAdapter;
 import java.beans.PropertyChangeEvent;
 import java.beans.PropertyVetoException;
 
-import javax.swing.ImageIcon;
 import javax.swing.JCheckBoxMenuItem;
 import javax.swing.JInternalFrame;
 import javax.swing.JPanel;
 import javax.swing.JPopupMenu;
 import javax.swing.SwingUtilities;
 
+import jalview.renderer.OverviewRenderer;
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+import jalview.viewmodel.OverviewDimensions;
+import jalview.viewmodel.OverviewDimensionsHideHidden;
+import jalview.viewmodel.OverviewDimensionsShowHidden;
+import jalview.viewmodel.ViewportListenerI;
+
 /**
  * Panel displaying an overview of the full alignment, with an interactive box
  * representing the viewport onto the alignment.
@@ -58,42 +54,39 @@ import javax.swing.SwingUtilities;
  * @author $author$
  * @version $Revision$
  */
+@SuppressWarnings("serial")
 public class OverviewPanel extends JPanel
         implements Runnable, ViewportListenerI
 {
-  protected Image dragImage = new ImageIcon(
-          getClass().getResource("/images/dragcursor.png"))
-                  .getImage();
-
-  private OverviewDimensions od;
+  protected OverviewDimensions od;
 
   private OverviewCanvas oviewCanvas;
 
-  private AlignViewport av;
+  protected AlignViewport av;
 
   private AlignmentPanel ap;
 
-  private JCheckBoxMenuItem displayToggle;
+  protected JCheckBoxMenuItem displayToggle;
 
-  private boolean showHidden = true;
+  protected boolean showHidden = true;
 
-  private boolean draggingBox = false;
+  protected boolean draggingBox = false;
 
-  private ProgressPanel progressPanel;
+  protected ProgressPanel progressPanel;
 
   /**
    * Creates a new OverviewPanel object.
    * 
    * @param alPanel
    *          The alignment panel which is shown in the overview panel
+   * @param isShowHidden TODO
    */
-  public OverviewPanel(AlignmentPanel alPanel)
+  public OverviewPanel(AlignmentPanel alPanel, boolean isShowHidden)
   {
     this.av = alPanel.av;
     this.ap = alPanel;
 
-    showHidden = Cache.getDefault(Preferences.SHOW_OV_HIDDEN_AT_START,
-            true);
+    showHidden = isShowHidden;
     if (showHidden)
     {
       od = new OverviewDimensionsShowHidden(av.getRanges(),
@@ -119,22 +112,6 @@ public class OverviewPanel extends JPanel
 
     // without this the overview window does not size to fit the overview canvas
     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
-
-    // set up custom cursor for use on Mac...
-    Point hotSpot = new Point(16, 16);
-    String cursorName = "Custom drag cursor";
-    
-    Cursor tempCursor;
-    if (Platform.isAMac())
-    {
-      tempCursor = getToolkit().createCustomCursor(dragImage, hotSpot,
-              cursorName);
-    }
-    else
-    {
-      tempCursor = Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR);
-    }
-    final Cursor dragCursor = tempCursor;
     
     addComponentListener(new ComponentAdapter()
     {
@@ -195,14 +172,18 @@ public class OverviewPanel extends JPanel
       {
         if (od.isPositionInBox(evt.getX(), evt.getY()))
         {
-          // display drag cursor at mouse position
-          getParent().setCursor(dragCursor);
+          /*
+           * using HAND_CURSOR rather than DRAG_CURSOR 
+           * as the latter is not supported on Mac
+           */
+          getParent().setCursor(
+                  Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
         }
         else
         {
           // reset cursor
           getParent().setCursor(
-                  Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
+                  Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR));
         }
       }
 
@@ -213,24 +194,29 @@ public class OverviewPanel extends JPanel
       @Override
       public void mousePressed(MouseEvent evt)
       {
-        if (SwingUtilities.isRightMouseButton(evt))
-        {
-          if (!Platform.isAMac())
-          {
-            showPopupMenu(evt);
-          }
+         
+       if (Platform.isWinRightButton(evt)) {
+               showPopupMenu(evt);
+               return;
+       }
+        if (SwingUtilities.isRightMouseButton(evt)) {
+               return;
         }
-        else
-        {
           // 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
           if (!od.isPositionInBox(evt.getX(), evt.getY()))
           {
             draggingBox = false;
+
+            // display drag cursor at mouse position
+            setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR));
+
             od.updateViewportFromMouse(evt.getX(), evt.getY(),
                     av.getAlignment().getHiddenSequences(),
                     av.getAlignment().getHiddenColumns());
+            getParent().setCursor(
+                    Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
           }
           else
           {
@@ -239,7 +225,6 @@ public class OverviewPanel extends JPanel
                     av.getAlignment().getHiddenSequences(),
                     av.getAlignment().getHiddenColumns());
           }
-        }
       }
 
       @Override
@@ -249,26 +234,30 @@ public class OverviewPanel extends JPanel
         {
           showPopupMenu(evt);
         }
-        // click in box should also reset the cursor
-        else if (od.isPositionInBox(evt.getX(), evt.getY()))
-        {
-          // display drag cursor at mouse position
-          getParent().setCursor(dragCursor);
-        }
-        else
-        {
-          // reset cursor
-          getParent().setCursor(
-                  Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
-        }
       }
+
+      @Override
+      public void mouseReleased(MouseEvent evt)
+      {
+        draggingBox = false;
+      }
+
     });
+
+    /*
+     * Javascript does not call componentResized on initial display,
+     * so do the update here
+     */
+    if (Platform.isJS())
+    {
+      updateOverviewImage();
+    }
   }
 
   /*
    * Displays the popup menu and acts on user input
    */
-  private void showPopupMenu(MouseEvent e)
+  protected void showPopupMenu(MouseEvent e)
   {
     JPopupMenu popup = new JPopupMenu();
     ActionListener menuListener = new ActionListener()
@@ -293,7 +282,7 @@ public class OverviewPanel extends JPanel
   /*
    * Toggle overview display between showing hidden columns and hiding hidden columns
    */
-  private void toggleHiddenColumns()
+  protected void toggleHiddenColumns()
   {
     if (showHidden)
     {
@@ -430,4 +419,14 @@ public class OverviewPanel extends JPanel
       od = null;
     }
   }
+  
+  public boolean isShowHiddenRegions()
+  {
+    return showHidden;
+  }
+
+  public OverviewCanvas getCanvas()
+  {
+    return oviewCanvas;
+  }
 }