refactoring: shift responsibility for display from GCDocument to

ChartPanelView

Author: chewiebug

src/main/java/com/tagtraum/perf/gcviewer/ChartPanelView.java

@@ -30,30 +30,31 @@
 import javax.swing.JTextArea;
 import javax.swing.SwingConstants;
 import javax.swing.SwingUtilities;
+import javax.swing.event.ChangeListener;
 import javax.swing.event.SwingPropertyChangeSupport;
 
 import com.tagtraum.perf.gcviewer.log.TextAreaLogHandler;
 
-
 /**
  *
  * @author <a href="mailto:[email protected]">Hendrik Schreiber</a>
  * <p>Date: May 5, 2005<br/>
  * Time: 2:14:36 PM</p>
  *
  */
-public class ChartPanelView {
+public class ChartPanelView extends JPanel {
 
+    public static final String EVENT_MINIMIZED = "minimized";
+    
+    private static final long serialVersionUID = -4259423581681643286L;
     private static final ResourceBundle localStrings = ResourceBundle.getBundle("com.tagtraum.perf.gcviewer.localStrings");
     private static final DataReaderFactory factory = new DataReaderFactory();
 
     private GCPreferences preferences;
-    
     private ModelChartImpl modelChart;
     private ModelPanel modelPanel;
     private GCModel model;
     private ViewBar viewBar;
-    private boolean viewBarVisible;
     private boolean minimized;
     private SwingPropertyChangeSupport propertyChangeSupport;
     private GCDocument gcDocument;
@@ -70,12 +71,59 @@ public ChartPanelView(GCDocument gcDocument, URL url) throws IOException {
         this.viewBar = new ViewBar(this);
         this.propertyChangeSupport = new SwingPropertyChangeSupport(this);
         this.textAreaLogHandler = new TextAreaLogHandler();
+        
+        addComponents();
+        
         final GCModel model = loadModel(url);
         setModel(model);
         // TODO delete
         model.printDetailedInformation();
     }
 
+    private void addComponents() {
+        GridBagLayout layout = new GridBagLayout();
+        setLayout(layout);
+
+        int row = 0;
+        GridBagConstraints constraints = new GridBagConstraints();
+        constraints.fill = GridBagConstraints.HORIZONTAL;
+        constraints.anchor = GridBagConstraints.NORTH;
+
+        // show viewbar if needed (GCDocument knows, when this is necessary
+        // -> more than one chartPanel is displayed in the same document)
+        constraints.gridy = row;
+        //if (isViewBarVisible()) {
+            viewBar.setVisible(false);
+            constraints.gridwidth = 2;
+            constraints.weightx = 2;
+            add(getViewBar(), constraints);
+            row++;
+        //}
+        
+        // show modelchart if not minimised
+        constraints.fill = GridBagConstraints.BOTH;
+        constraints.gridy = row;
+        constraints.gridwidth = 1;
+        constraints.gridheight = 1;
+        constraints.gridx = 0;
+        constraints.weightx = 2;
+        constraints.weighty = 2;
+        modelChart.setPreferredSize(new Dimension(800, 1024));
+        modelChart.setVisible(!isMinimized());
+        add(modelChart, constraints);
+
+        // show modelPanel if not minimised
+        constraints.gridy = row;
+        constraints.gridheight = 1;
+        constraints.gridx = 1;
+        constraints.weightx = 0;
+        constraints.weighty = 0;
+        constraints.fill = GridBagConstraints.HORIZONTAL;
+        constraints.anchor = GridBagConstraints.SOUTH;
+        add(modelPanel, constraints);
+        modelPanel.setVisible(preferences.isShowDataPanel());
+    }
+    
     /**
      * @return true, if the files has been reloaded
      * @throws IOException
@@ -124,13 +172,33 @@ public void run() {
     }
 
     public void invalidate() {
+        super.invalidate();
+        
         modelChart.invalidate();
         modelPanel.invalidate();
     }
 
     public void addPropertyChangeListener(PropertyChangeListener propertyChangeListener) {
         propertyChangeSupport.addPropertyChangeListener(propertyChangeListener);
     }
+    
+    public void addChartScrollBarChangeListener(ChangeListener changeListener) {
+        modelChart.getViewport().addChangeListener(changeListener);
+    }
+    
+    public void removeChartScrollBarChangeListeners() {
+        for (ChangeListener listener : modelChart.getViewport().getChangeListeners()) {
+            if (listener instanceof ChartPanelView) {
+                modelChart.getViewport().removeChangeListener(listener);
+            }
+        }
+    }
+    
+    public void setScrollBarVisible(boolean scrollBarVisible) {
+        modelChart.setHorizontalScrollBarPolicy(scrollBarVisible 
+                ? JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED
+                        : JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
+    }
 
     public ViewBar getViewBar() {
         return viewBar;
@@ -141,11 +209,11 @@ public JTextArea getParseLog() {
     }
 
     public boolean isViewBarVisible() {
-        return viewBarVisible;
+        return viewBar.isVisible();
     }
 
     public void setViewBarVisible(boolean viewBarVisible) {
-        this.viewBarVisible = viewBarVisible;
+        this.viewBar.setVisible(viewBarVisible);
     }
 
     public boolean isMinimized() {
@@ -156,7 +224,11 @@ public void setMinimized(boolean minimized) {
         boolean oldValue = this.minimized;
         if (minimized != this.minimized) {
             this.minimized = minimized;
-            propertyChangeSupport.firePropertyChange("minimized", oldValue, minimized);
+            
+            modelChart.setVisible(!minimized);
+            modelPanel.setVisible(preferences.isShowDataPanel() && !minimized);
+            
+            propertyChangeSupport.firePropertyChange(EVENT_MINIMIZED, oldValue, minimized);
         }
     }
 
@@ -175,6 +247,7 @@ public GCModel getModel() {
     public void setModel(GCModel model) {
         this.model = model;
         this.modelPanel.setModel(model);
+        this.modelPanel.setVisible(preferences.isShowDataPanel());
         this.modelChart.setModel(model, preferences);
         this.viewBar.setTitle(model.getURL().toString());
     }
@@ -184,6 +257,7 @@ public void close() {
     }
 
     private static class ViewBar extends JPanel {
+        private static final long serialVersionUID = -5219100256784644319L;
         private JLabel title = new JLabel();
         private ViewBarButton closeButton = new ViewBarButton("images/close.png", "images/close_selected.png");
         private MinMaxButton minimizeButton = new MinMaxButton();
@@ -237,6 +311,8 @@ protected void paintComponent(Graphics graphics) {
         }
 
         private static class ViewBarButton extends JButton {
+            private static final long serialVersionUID = 587920510707520092L;
+
             public ViewBarButton(String image1, String image2) {
                 final ImageIcon imageIcon1 = new ImageIcon(Toolkit.getDefaultToolkit().getImage(getClass().getResource(image1)));
                 final ImageIcon imageIcon2 = new ImageIcon(Toolkit.getDefaultToolkit().getImage(getClass().getResource(image2)));
@@ -254,7 +330,9 @@ public void setIcons(final ImageIcon imageIcon1, final ImageIcon imageIcon2) {
             }
 
         }
+        
         private static class MinMaxButton extends JButton {
+            private static final long serialVersionUID = -6518226257396629789L;
             private final ImageIcon min1 = new ImageIcon(Toolkit.getDefaultToolkit().getImage(getClass().getResource("images/minimize.png")));
             private final ImageIcon min2 = new ImageIcon(Toolkit.getDefaultToolkit().getImage(getClass().getResource("images/minimize_selected.png")));
             private final ImageIcon max1 = new ImageIcon(Toolkit.getDefaultToolkit().getImage(getClass().getResource("images/maximize.png")));

src/main/java/com/tagtraum/perf/gcviewer/GCDocument.java

@@ -2,7 +2,6 @@
 
 import java.awt.Dimension;
 import java.awt.GridBagConstraints;
-import java.awt.GridBagLayout;
 import java.awt.Point;
 import java.awt.datatransfer.DataFlavor;
 import java.awt.datatransfer.Transferable;
@@ -22,6 +21,7 @@
 import java.util.List;
 
 import javax.swing.BoundedRangeModel;
+import javax.swing.BoxLayout;
 import javax.swing.DefaultBoundedRangeModel;
 import javax.swing.JInternalFrame;
 import javax.swing.JPanel;
@@ -51,8 +51,9 @@ public GCDocument(final GCViewer gcViewer, String s) {
         this.refreshWatchDog = new RefreshWatchDog();
         refreshWatchDog.setGcDocument(this);
         preferences = gcViewer.getPreferences();
+        showModelPanel = preferences.isShowDataPanel();
         modelChartListFacade = new MultiModelChartFacade();
-        GridBagLayout layout = new GridBagLayout();
+        BoxLayout layout = new BoxLayout(getContentPane(), BoxLayout.Y_AXIS);
         getContentPane().setLayout(layout);
         // TODO refactor; looks very similar to DesktopPane implementation
         getContentPane().setDropTarget(new DropTarget(this, DnDConstants.ACTION_COPY, new DropTargetListener(){
@@ -142,7 +143,7 @@ public void add(final URL url) throws IOException {
         chartPanelViews.add(chartPanelView);
         chartPanelView.addPropertyChangeListener(new PropertyChangeListener() {
             public void propertyChange(PropertyChangeEvent event) {
-                if ("minimized".equals(event.getPropertyName())) relayout();
+                if (ChartPanelView.EVENT_MINIMIZED.equals(event.getPropertyName())) relayout();
             }
         });
         // make sure all models in one document have the same display properties
@@ -176,65 +177,28 @@ public void relayout() {
             setTitle(((ChartPanelView) chartPanelViews.get(0)).getModel().getURL().toString());
         else
             setTitle("");
-        int row = 0;
+        
         boolean noMaximizedChartPanelView = true;
         ChartPanelView lastMaximizedChartPanelView = getLastMaximizedChartPanelView();
         MasterViewPortChangeListener masterViewPortChangeListener = new MasterViewPortChangeListener();
 
         for (int i = 0; i < chartPanelViews.size(); i++) {
             final ChartPanelView chartPanelView = (ChartPanelView) chartPanelViews.get(i);
             final ModelChartImpl modelChart = (ModelChartImpl) chartPanelView.getModelChart();
-            final ModelPanel modelPanel = chartPanelView.getModelPanel();
-            //final JComponent parseLog = new JScrollPane(chartPanelView.getParseLog());
-            modelChart.invalidate();
-            GridBagConstraints constraints = new GridBagConstraints();
-            constraints.fill = GridBagConstraints.HORIZONTAL;
-            constraints.anchor = GridBagConstraints.NORTH;
-
-            constraints.gridy = row;
-            if (chartPanelViews.size() > 1 || (chartPanelView.isMinimized() && chartPanelViews.size() == 1)) {
-                constraints.gridwidth = 2;
-                constraints.weightx = 2;
-                //constraints.weighty = 1;
-                getContentPane().add(chartPanelView.getViewBar(), constraints);
-                row++;
-            }
-            constraints.fill = GridBagConstraints.BOTH;
-            constraints.gridy = row;
-            constraints.gridwidth = 1;
-            constraints.gridheight = 1; //2
-            constraints.gridx = 0;
-            constraints.weightx = 2;
-            constraints.weighty = 2;
-            modelChart.setPreferredSize(new Dimension(800, 600));
-            modelChart.setVisible(!chartPanelView.isMinimized());
-            getContentPane().add(modelChart, constraints);
-
-            /*
-            constraints.gridheight = 1;
-            constraints.gridy = row;
-            constraints.gridx = 1;
-            constraints.weightx = 0;
-            constraints.weighty = 4;
-            constraints.fill = GridBagConstraints.BOTH;
-            constraints.anchor = GridBagConstraints.NORTH;
-            getContentPane().add(parseLog, constraints);
-            parseLog.setVisible(!chartPanelView.isMinimized());
-
-            row++;
-            */
-
-            constraints.gridy = row;
-            constraints.gridheight = 1;
-            constraints.gridx = 1;
-            constraints.weightx = 0;
-            constraints.weighty = 0;
-            constraints.fill = GridBagConstraints.HORIZONTAL;
-            constraints.anchor = GridBagConstraints.SOUTH;
-            getContentPane().add(modelPanel, constraints);
-            modelPanel.setVisible(showModelPanel && (!chartPanelView.isMinimized()));
-
+            
+            //chartPanelView.invalidate();
+            getContentPane().add(chartPanelView);
+            
+            chartPanelView.setViewBarVisible(
+                    chartPanelViews.size() > 1 
+                    || (chartPanelView.isMinimized() && chartPanelViews.size() == 1));
+            
             if (!chartPanelView.isMinimized()) {
+                // if more than one chart is displayed, only the last visible has a scrollbar
+                // and all charts must scroll synchronously
+                // -> event.source for scrolling:
+                //    - user moves scrollbar
+                //    - model of last visible chart has changed and is watched 
                 noMaximizedChartPanelView = false;
                 final boolean isLastMaximizedChartPanelView = lastMaximizedChartPanelView == chartPanelView;
                 // lock viewports with each other...
@@ -257,16 +221,12 @@ public void relayout() {
                     horizontalScrollBar.setEnabled(!isWatched());
                 }
             }
-            row++;
         }
         if (noMaximizedChartPanelView) {
-            // add dummy panel
-            GridBagConstraints constraints = new GridBagConstraints();
-            constraints.fill = GridBagConstraints.BOTH;
-            constraints.gridy = row;
-            constraints.weightx = 3;
-            constraints.weighty = 3;
-            getContentPane().add(new JPanel(), constraints);
+            // fill empty space below minimized chartPanelView
+            JPanel dummyPanel = new JPanel();
+            dummyPanel.setPreferredSize(new Dimension(100, 3000));
+            getContentPane().add(dummyPanel);
         }
         scaleModelChart();
         revalidate();