JAL-3383 minor code tidying and commenting

[jalview.git] / src / jalview / gui / OverviewPanel.java

diff --git a/src/jalview/gui/OverviewPanel.java b/src/jalview/gui/OverviewPanel.java
index 8f24185..9245104 100755 (executable)
--- a/src/jalview/gui/OverviewPanel.java
+++ b/src/jalview/gui/OverviewPanel.java
@@ -110,49 +110,13 @@ public class OverviewPanel extends JPanel
 
     av.getRanges().addPropertyChangeListener(this);
 
-    // without this the overview window does not size to fit the overview canvas
-    // BH - no,no! - This does not include the progressPanel!
-    // BH the problem was that OverviewCanvas.setPreferredSize() had not been set.
-    // setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
-
     addComponentListener(new ComponentAdapter()
     {
       @Override
       public void componentResized(ComponentEvent evt)
       {
-        int ph = (progressPanel.getParent() == null ? 0
-                : progressPanel.getHeight());
-        // Resize is called on the initial display of the overview.
-        // This code adjusts sizes to account for the progress bar if it has not
-        // already been accounted for, which triggers another resize call for
-        // the correct sizing, at which point the overview image is updated.
-        // (This avoids a double recalculation of the image.)
-        if (getWidth() == od.getWidth()
-                && getHeight() == od.getHeight() + ph)
-        {
-          updateOverviewImage();
-        }
-        else
-        {
-          int w = getWidth();
-          int h = getHeight();
-          if ((w > 0) && (h > 0))
-          {
-            if (dim != null)
-            {
-              dim.setSize(w, h - ph);
-            }
-            od.setWidth(w);
-            od.setHeight(h - ph);
-            repaint();
-          }
-          // BH 2019.07.29 this is unnecessary -- it is what layout managers are
-          // for:
-          // setPreferredSize(new Dimension(od.getWidth(), od.getHeight() +
-          // ph));
-        }
+        resizePanel();
       }
-
     });
 
     addMouseMotionListener(new MouseMotionAdapter()
@@ -198,7 +162,6 @@ public class OverviewPanel extends JPanel
                   Cursor.getPredefinedCursor(Cursor.CROSSHAIR_CURSOR));
         }
       }
-
     });
 
     addMouseListener(new MouseAdapter()
@@ -206,7 +169,6 @@ public class OverviewPanel extends JPanel
       @Override
       public void mousePressed(MouseEvent evt)
       {
-
         if (Platform.isWinRightButton(evt))
         {
           showPopupMenu(evt);
@@ -255,16 +217,39 @@ public class OverviewPanel extends JPanel
       {
         draggingBox = false;
       }
-
     });
+  }
 
-    /*
-     * Javascript does not call componentResized on initial display,
-     * so do the update here
-     */
-    if (Platform.isJS())
+  protected void resizePanel()
+  {
+    int ph = (progressPanel.getParent() == null ? 0
+            : progressPanel.getHeight());
+    // Resize is called on the initial display of the overview.
+    // This code adjusts sizes to account for the progress bar if it has not
+    // already been accounted for, which triggers another resize call for
+    // the correct sizing, at which point the overview image is updated.
+    // (This avoids a double recalculation of the image.)
+    if (getWidth() == od.getWidth() && getHeight() == od.getHeight() + ph)
+    {
+      if (canvas.lastMiniMe == null)
+      {
+        updateOverviewImage();
+      }
+    }
+    else
     {
-      updateOverviewImage();
+      int w = getWidth();
+      int h = getHeight();
+      if ((w > 0) && (h > 0))
+      {
+        if (dim != null)
+        {
+          dim.setSize(w, h - ph);
+        }
+        od.setWidth(w);
+        od.setHeight(h - ph);
+        updateOverviewImage();
+      }
     }
   }
 
@@ -288,7 +273,7 @@ public class OverviewPanel extends JPanel
 
   }
 
-  /*
+  /**
    * Displays the popup menu and acts on user input
    */
   protected void showPopupMenu(MouseEvent e)
@@ -313,8 +298,9 @@ public class OverviewPanel extends JPanel
     popup.show(this, e.getX(), e.getY());
   }
 
-  /*
-   * Toggle overview display between showing hidden columns and hiding hidden columns
+  /**
+   * Toggle overview display between showing hidden columns and hiding hidden
+   * columns
    */
   protected void toggleHiddenColumns()
   {
@@ -326,7 +312,20 @@ public class OverviewPanel extends JPanel
   }
 
   /**
-   * Updates the overview image when the related alignment panel is updated
+   * Updates the overview image when the related alignment panel is updated.
+   * 
+   * Cases:
+   * 
+   * AlignFrame.setFeatureGroupState
+   * 
+   * AlignmentPanel.paintAlignment(true,...) (117 references)
+   * 
+   * OverviewPanel..componentResized() OverviewPanel.toggleHiddenColumns()
+   * 
+   * PopupMenu for action.reveal_sequences, action.reveal_all
+   * 
+   * SliderPanel.mouseReleased()
+   * 
    */
   public void updateOverviewImage()
   {
@@ -363,11 +362,11 @@ public class OverviewPanel extends JPanel
   {
     if (canvas != null)
     {
+      setBoxPosition();
       canvas.draw(av.isShowSequenceFeatures(),
               (av.isShowAnnotation()
                       && av.getAlignmentConservationAnnotation() != null),
               ap.getFeatureRenderer());
-      setBoxPosition();
     }
   }