New wizard layout fixing GTK bugs, removed some useless crap added a listener (installer might be broken)

git-svn-id: http://svn.dmdirc.com/trunk@2655 00569f92-eb28-0410-84fd-f71c24880f

src/com/dmdirc/installer/Main.java

@@ -99,8 +99,8 @@ public final class Main implements Wizard {
 			steps.add(new StepError());
 		} else {
 			steps.add(new StepSettings());
-			steps.add(new StepConfirm());
-			steps.add(new StepInstall());
+			steps.add(new StepConfirm(wizardDialog));
+			steps.add(new StepInstall(wizardDialog));
 		}
 		
 		String releaseName = "";

src/com/dmdirc/installer/StepConfirm.java

@@ -23,8 +23,9 @@
 package com.dmdirc.installer;
 
 import com.dmdirc.installer.Installer.ShortcutType;
-import com.dmdirc.ui.swing.dialogs.wizard.SpecialStep;
 import com.dmdirc.ui.swing.dialogs.wizard.Step;
+import com.dmdirc.ui.swing.dialogs.wizard.StepListener;
+import com.dmdirc.ui.swing.dialogs.wizard.WizardDialog;
 import static com.dmdirc.ui.swing.UIUtilities.LARGE_BORDER;
 import static com.dmdirc.ui.swing.UIUtilities.SMALL_BORDER;
 
@@ -36,7 +37,7 @@ import javax.swing.JTextArea;
 /**
  * This confirms the settings chosen in the previous step
  */
-public final class StepConfirm extends Step implements SpecialStep {
+public final class StepConfirm extends Step implements StepListener {
 	/**
 	 * A version number for this class. It should be changed whenever the class
 	 * structure is changed (or anything else that would prevent serialized
@@ -48,10 +49,12 @@ public final class StepConfirm extends Step implements SpecialStep {
 	private JTextArea infoLabel = new JTextArea("");
 	
 	/**
-	 * Creates a new instance of StepConfirm.
-	 */
-	public StepConfirm() {
+	* Creates a new instance of StepConfirm.
+	* @param dialog parent wizard dialog
+	*/
+	public StepConfirm(final WizardDialog dialog) {
 		super();
+		dialog.addStepListener(this);
 		setLayout(new BorderLayout());
 		setBorder(BorderFactory.createEmptyBorder(LARGE_BORDER, LARGE_BORDER, SMALL_BORDER, LARGE_BORDER));
 		
@@ -64,11 +67,10 @@ public final class StepConfirm extends Step implements SpecialStep {
 			
 		add(infoLabel, BorderLayout.CENTER);
 	}
-	
-	/**
-	 * Display Step.
-	 */
-	public void showStep() {
+
+	/** {@inheritDoc} */
+	@Override
+	public void stepAboutToDisplay(final Step step) {
 		String shortcutText = "";
 		
 		StepSettings settings = ((StepSettings) Main.getWizardDialog().getStep(1));
@@ -102,5 +104,11 @@ public final class StepConfirm extends Step implements SpecialStep {
 		                + "    " +((StepSettings) Main.getWizardDialog().getStep(1)).getInstallLocation() + "\n"
 		                + shortcutText + "\n"
 		                + "If these are correct, press Next to begin the installation, else press Previous to change them");
+    }
+
+	/** {@inheritDoc} */
+	@Override
+	public void stepHidden(final Step step ) {
+	//Ignore
 	}
 }

src/com/dmdirc/installer/StepInstall.java

@@ -23,9 +23,9 @@
 package com.dmdirc.installer;
 
 import com.dmdirc.installer.Installer.ShortcutType;
-import com.dmdirc.ui.swing.dialogs.wizard.SpecialStep;
-import com.dmdirc.ui.swing.dialogs.wizard.TextStep;
 import com.dmdirc.ui.swing.dialogs.wizard.Step;
+import com.dmdirc.ui.swing.dialogs.wizard.StepListener;
+import com.dmdirc.ui.swing.dialogs.wizard.WizardDialog;
 import static com.dmdirc.ui.swing.UIUtilities.LARGE_BORDER;
 import static com.dmdirc.ui.swing.UIUtilities.SMALL_BORDER;
 
@@ -37,7 +37,7 @@ import javax.swing.JTextArea;
 /**
  * This confirms the settings chosen in the previous step
  */
-public final class StepInstall extends Step implements SpecialStep, TextStep {
+public final class StepInstall extends Step implements StepListener {
 	/**
 	 * A version number for this class. It should be changed whenever the class
 	 * structure is changed (or anything else that would prevent serialized
@@ -49,10 +49,12 @@ public final class StepInstall extends Step implements SpecialStep, TextStep {
 	private JTextArea infoLabel = new JTextArea("Beginning Install");
 	
 	/**
-	 * Creates a new instance of StepInstall.
-	 */
-	public StepInstall() {
+	* Creates a new instance of StepInstall.
+	* @param dialog parent wizard dialog
+	*/
+	public StepInstall(final WizardDialog dialog) {
 		super();
+		dialog.addStepListener(this);
 		setLayout(new BorderLayout());
 		setBorder(BorderFactory.createEmptyBorder(LARGE_BORDER, LARGE_BORDER, SMALL_BORDER, LARGE_BORDER));
 		
@@ -75,16 +77,6 @@ public final class StepInstall extends Step implements SpecialStep, TextStep {
 		infoLabel.setText(infoLabel.getText() + text +"\n");
 	}
 	
-	/**
-	 * Display Step.
-	 */
-	public void showStep() {
-		Main.getWizardDialog().enableNextStep(false);
-		Main.getWizardDialog().enablePreviousStep(false);
-		Main.getInstaller().setInstallStep(this);
-		Main.getInstaller().start();
-	}
-	
 	/**
 	 * Perform the installation.
 	 */
@@ -128,4 +120,19 @@ public final class StepInstall extends Step implements SpecialStep, TextStep {
 		addText("Installation finished\n");
 		Main.getWizardDialog().enableNextStep(true);
 	}
+
+	/** {@inheritDoc} */
+	@Override
+	public void stepAboutToDisplay(final Step step) {
+		Main.getWizardDialog().enableNextStep(false);
+		Main.getWizardDialog().enablePreviousStep(false);
+		Main.getInstaller().setInstallStep(this);
+		Main.getInstaller().start();
+	}
+
+	/** {@inheritDoc} */
+	@Override
+	public void stepHidden(final Step step) {
+		//Ignore
+	}
 }

src/com/dmdirc/ui/swing/dialogs/wizard/StepLayout.java

@@ -0,0 +1,94 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.ui.swing.dialogs.wizard;
+
+import java.awt.CardLayout;
+import java.lang.reflect.Field;
+import java.util.List;
+import java.util.Vector;
+
+/**
+ *
+ */
+public class StepLayout extends CardLayout {
+
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 2;
+    Vector elements = null;
+
+    public StepLayout() {
+        this(0, 0);
+    }
+
+    public StepLayout(final int hgap, final int vgap) {
+        super(hgap, vgap);
+        elements = new Vector<Object>();
+        try {
+            Field f = CardLayout.class.getDeclaredField("vector");
+            f.setAccessible(true);
+            f.set(this, elements);
+        } catch (IllegalArgumentException ex) {
+            //Ignore, wont happen
+        } catch (IllegalAccessException ex) {
+            //Ignore, wont happen
+        } catch (NoSuchFieldException ex) {
+            //Ignore, wont happen
+        } catch (SecurityException ex) {
+            //Ignore, wont happen
+        }
+    }
+
+    public int size() {
+        return elements.size();
+    }
+
+    public boolean isEmpty() {
+        return elements.isEmpty();
+    }
+
+    public Step getStep(final int index) {
+        try {
+            Field f = elements.get(index).getClass().getDeclaredField("comp");
+            f.setAccessible(true);
+
+            return (Step) f.get(elements.get(index));
+        } catch (IllegalArgumentException ex) {
+            //Ignore, wont happen
+        } catch (IllegalAccessException ex) {
+            //Ignore, wont happen
+        } catch (NoSuchFieldException ex) {
+            //Ignore, wont happen
+        } catch (SecurityException ex) {
+            //Ignore, wont happen
+        }
+        return null;
+    }
+
+    public List getSteps() {
+        return elements;
+    }
+}

src/com/dmdirc/ui/swing/dialogs/wizard/SpecialStep.java → src/com/dmdirc/ui/swing/dialogs/wizard/StepListener.java

@@ -23,11 +23,21 @@
 package com.dmdirc.ui.swing.dialogs.wizard;
 
 /**
- * Wizard step that needs to know when it is about to be displayed.
+ * Step listener interfaces.
  */
-public interface SpecialStep {
+public interface StepListener {
+
+    /**
+     * Called just before a step is displayed
+     * 
+     * @param step Step to be displayed
+     */
+    void stepAboutToDisplay(final Step step);
+
     /**
-     * Display Step.
+     * Called when a step is hidden.
+     * 
+     * @param step Step thats been hidden
      */
-    void showStep();
-}
+    void stepHidden(final Step step);
+}

src/com/dmdirc/ui/swing/dialogs/wizard/TextStep.java

@@ -1,35 +0,0 @@
-/*
- * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-package com.dmdirc.ui.swing.dialogs.wizard;
-
-/**
- * Wizard step that has a modifiable text-based component.
- */
-public interface TextStep {
-    /**
-     * Add text to the infolabel.
-     *
-     * @param text Text to add.
-     */
-    void addText(final String text);
-}

src/com/dmdirc/ui/swing/dialogs/wizard/WizardDialog.java

@@ -24,7 +24,7 @@ package com.dmdirc.ui.swing.dialogs.wizard;
 
 import static com.dmdirc.ui.swing.UIUtilities.SMALL_BORDER;
 import com.dmdirc.ui.swing.components.StandardDialog;
-
+import com.dmdirc.util.ListenerList;
 import java.awt.BorderLayout;
 import java.awt.Color;
 import java.awt.Component;
@@ -38,9 +38,7 @@ import java.awt.Rectangle;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.io.Serializable;
-import java.util.ArrayList;
 import java.util.List;
-
 import javax.swing.BorderFactory;
 import javax.swing.Box;
 import javax.swing.BoxLayout;
@@ -55,24 +53,23 @@ import javax.swing.JSeparator;
  */
 public final class WizardDialog extends StandardDialog implements ActionListener,
         Serializable {
-    
+
     /**
      * A version number for this class. It should be changed whenever the class
      * structure is changed (or anything else that would prevent serialized
      * objects being unserialized with the new class).
      */
-    private static final long serialVersionUID = 1;
-    
+    private static final long serialVersionUID = 2;
     /** Step panel list. */
-    private final List<Step> steps;
+    private final StepLayout steps;
     /** Wizard title. */
     private final String title;
     /** Wizard. */
     private final transient Wizard wizard;
-    
     /** Parent component. */
     private final Component parent;
-    
+    /** Step panel. */
+    private JPanel stepsPanel;
     /** Button panel. */
     private JPanel buttonsPanel;
     /** Title panel. */
@@ -85,7 +82,9 @@ public final class WizardDialog extends StandardDialog implements ActionListener
     private JButton next;
     /** Progress label. */
     private JLabel progressLabel;
-    
+    /** Step Listeners. */
+    private ListenerList stepListeners;
+
     /**
      * Creates a new instance of WizardFrame that requires a mainframe.
      *
@@ -95,125 +94,139 @@ public final class WizardDialog extends StandardDialog implements ActionListener
      * @param modal Whether the wizard should be modal
      * @param parent Parent component
      */
-    public WizardDialog(final String title, final List<Step> steps,
-            final Wizard wizard, final boolean modal, final Component parent) {
+    public WizardDialog(final String title,
+            final List<Step> steps,
+            final Wizard wizard, final boolean modal,
+            final Component parent) {
         super(null, modal);
-        
+
+        stepListeners = new ListenerList();
+
         this.title = title;
-        this.steps = new ArrayList<Step>(steps);
+        this.steps = new StepLayout();
         this.wizard = wizard;
         this.parent = parent;
-        
+
         initComponents();
         layoutComponents();
+
+        for (Step step : steps) {
+            addStep(step);
+        }
     }
-    
+
     /** Initialises the components. */
     private void initComponents() {
         final JLabel titleLabel = new JLabel(title);
-        
+
         titlePanel = new JPanel();
         titlePanel.setLayout(new BorderLayout());
         titlePanel.setBackground(Color.WHITE);
-        
-        titleLabel.setFont(titleLabel.getFont().deriveFont(
-                (float) (titleLabel.getFont().getSize() * 1.5)));
+        stepsPanel = new JPanel(steps);
+
+        titleLabel.setFont(titleLabel.getFont().
+                deriveFont((float) (titleLabel.getFont().getSize() * 1.5)));
         titleLabel.setBorder(BorderFactory.createEmptyBorder(SMALL_BORDER,
                 SMALL_BORDER, SMALL_BORDER, SMALL_BORDER));
-        
+
         titlePanel.add(titleLabel, BorderLayout.CENTER);
         titlePanel.add(new JSeparator(), BorderLayout.PAGE_END);
-        
+
         initButtonsPanel();
     }
-    
+
     /** Lays out the components. */
     private void layoutComponents() {
-        this.setLayout(new BorderLayout());
-        
-        
-        this.add(titlePanel, BorderLayout.PAGE_START);
-        this.add(buttonsPanel, BorderLayout.PAGE_END);
+        setLayout(new BorderLayout());
+
+        add(titlePanel, BorderLayout.PAGE_START);
+        add(stepsPanel, BorderLayout.CENTER);
+        add(buttonsPanel, BorderLayout.PAGE_END);
     }
-    
+
     /** Initialises the button panel. */
     private void initButtonsPanel() {
         final JPanel buttonPanel = new JPanel();
         buttonsPanel = new JPanel();
         progressLabel = new JLabel();
-        
+
         orderButtons(new JButton(), new JButton());
         next = new JButton();
         setOkButton(next);
-        
+
         prev = new JButton("<< Previous");
         next.setText("Next >>");
-        
+
         prev.setPreferredSize(new Dimension(110, 30));
         next.setPreferredSize(new Dimension(110, 30));
-        
+
         prev.setMargin(new Insets(prev.getMargin().top, 0,
                 prev.getMargin().bottom, 0));
         next.setMargin(new Insets(next.getMargin().top, 0,
                 next.getMargin().bottom, 0));
-        
+
         getCancelButton().addActionListener(this);
         prev.addActionListener(this);
         next.addActionListener(this);
-        
+
         buttonPanel.setBorder(BorderFactory.createEmptyBorder(SMALL_BORDER,
                 SMALL_BORDER, SMALL_BORDER, SMALL_BORDER));
-        
-        buttonPanel.setLayout(new BoxLayout(buttonPanel, BoxLayout.LINE_AXIS));
+
+        buttonPanel.setLayout(new BoxLayout(buttonPanel,
+                BoxLayout.LINE_AXIS));
         buttonPanel.add(progressLabel);
         buttonPanel.add(Box.createHorizontalStrut(SMALL_BORDER));
         buttonPanel.add(Box.createHorizontalGlue());
         buttonPanel.add(prev);
         buttonPanel.add(Box.createHorizontalStrut(SMALL_BORDER));
         buttonPanel.add(next);
-        
+
         buttonsPanel.setLayout(new BorderLayout());
-        
+
         buttonsPanel.add(new JSeparator(), BorderLayout.PAGE_START);
         buttonsPanel.add(buttonPanel, BorderLayout.CENTER);
     }
-    
+
     /** Displays the wizard. */
     public void display() {
         if (!steps.isEmpty()) {
-            
-            add(steps.get(0), BorderLayout.CENTER);
+            steps.first(stepsPanel);
             currentStep = 0;
-            
+
             prev.setEnabled(false);
             if (steps.size() == 1) {
                 next.setText("Finish");
             }
-            
+
             updateProgressLabel();
-            
+
             setTitle(title);
             setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
             pack();
-            if (parent == null) {
+            if (parent != null) {
                 setLocationRelativeTo(parent);
             } else {
                 // Position wizard center-screen on the correct monitor of a
                 // multi-monitor system. (See MainFrame constructor for more info)
-                final PointerInfo myPointerInfo = MouseInfo.getPointerInfo();
+                final PointerInfo myPointerInfo =
+                        MouseInfo.getPointerInfo();
                 final GraphicsDevice myDevice = myPointerInfo.getDevice();
-                final GraphicsConfiguration myGraphicsConfig = myDevice.getDefaultConfiguration();
+                final GraphicsConfiguration myGraphicsConfig =
+                        myDevice.getDefaultConfiguration();
                 final Rectangle gcBounds = myGraphicsConfig.getBounds();
-                final int xPos = gcBounds.x + ((gcBounds.width - getWidth()) / 2);
-                final int yPos = gcBounds.y + ((gcBounds.height - getHeight()) / 2);
+                final int xPos =
+                        gcBounds.x + ((gcBounds.width - getWidth()) / 2);
+                final int yPos =
+                        gcBounds.y + ((gcBounds.height - getHeight()) / 2);
                 setLocation(xPos, yPos);
             }
             setResizable(false);
             setVisible(true);
         }
     }
-    
+
     /** {@inheritDoc} */
+    @Override
     public void actionPerformed(final ActionEvent e) {
         if (e.getSource() == next) {
             nextStep();
@@ -223,16 +236,16 @@ public final class WizardDialog extends StandardDialog implements ActionListener
             wizard.wizardCancelled();
         }
     }
-    
+
     /**
      * Adds a step to the wizard.
      *
      * @param step Step to add
      */
     public void addStep(final Step step) {
-        steps.add(step);
+        stepsPanel.add(step, step.toString());
     }
-    
+
     /**
      * Enables or disables the "next step" button.
      *
@@ -241,7 +254,7 @@ public final class WizardDialog extends StandardDialog implements ActionListener
     public void enableNextStep(final boolean newValue) {
         next.setEnabled(newValue);
     }
-    
+
     /**
      * Enables or disables the "previous step" button.
      *
@@ -250,13 +263,14 @@ public final class WizardDialog extends StandardDialog implements ActionListener
     public void enablePreviousStep(final boolean newValue) {
         prev.setEnabled(newValue);
     }
-    
+
     /** Moves to the next step. */
     private void nextStep() {
-        steps.get(currentStep).setVisible(false);
         if ("Next >>".equals(next.getText())) {
-            remove(steps.get(currentStep));
-            add(steps.get(++currentStep), BorderLayout.CENTER);
+            fireStepAboutToBeDisplayed(steps.getStep(currentStep + 1));
+            steps.next(stepsPanel);
+            fireStepHidden(steps.getStep(currentStep));
+            currentStep++;
             prev.setEnabled(true);
             if (currentStep == steps.size() - 1) {
                 next.setText("Finish");
@@ -264,30 +278,25 @@ public final class WizardDialog extends StandardDialog implements ActionListener
             updateProgressLabel();
             wizard.stepChanged(currentStep - 1, currentStep);
         } else if ("Finish".equals(next.getText())) {
-            this.dispose();
+            dispose();
             wizard.wizardFinished();
         }
-        final Step newstep = steps.get(currentStep);
-        if (newstep instanceof SpecialStep) {
-            ((SpecialStep) newstep).showStep();
-        }
-        newstep.setVisible(true);
     }
-    
+
     /** Moves to the previous step. */
     private void prevStep() {
-        steps.get(currentStep).setVisible(false);
-        remove(steps.get(currentStep));
-        add(steps.get(--currentStep), BorderLayout.CENTER);
+        fireStepAboutToBeDisplayed(steps.getStep(currentStep - 1));
+        steps.previous(stepsPanel);
+        fireStepHidden(steps.getStep(currentStep));
+        currentStep--;
         if (currentStep == 0) {
             prev.setEnabled(false);
         }
         next.setText("Next >>");
-        steps.get(currentStep).setVisible(true);
         updateProgressLabel();
         wizard.stepChanged(currentStep + 1, currentStep);
     }
-    
+
     /**
      * Returns the step at the specified index.
      *
@@ -296,9 +305,9 @@ public final class WizardDialog extends StandardDialog implements ActionListener
      * @return Specified step.
      */
     public Step getStep(final int stepNumber) {
-        return steps.get(stepNumber);
+        return steps.getStep(stepNumber);
     }
-    
+
     /**
      * Returns the current step.
      *
@@ -307,9 +316,53 @@ public final class WizardDialog extends StandardDialog implements ActionListener
     public int getCurrentStep() {
         return currentStep;
     }
-    
+
     /** Updates the progress label. */
     private void updateProgressLabel() {
         progressLabel.setText("Step " + (currentStep + 1) + " of " + steps.size());
-    }    
-}
+    }
+
+    /**
+     * Adds a step listener to the list.
+     *
+     * @param listener
+     */
+    public void addStepListener(final StepListener listener) {
+        stepListeners.add(StepListener.class, listener);
+    }
+
+    /**
+     * Removes a step listener from the list.
+     *
+     * @param listener
+     */
+    public void removeStepListener(final StepListener listener) {
+        stepListeners.remove(StepListener.class, listener);
+    }
+
+    /**
+     * Fires step about to be displayed events.
+     *
+     * @param step Step to be displayed
+     */
+    private void fireStepAboutToBeDisplayed(final Step step) {
+        List<StepListener> listeners =
+                stepListeners.get(StepListener.class);
+        for (StepListener listener : listeners) {
+            listener.stepAboutToDisplay(step);
+        }
+    }
+
+    /**
+     * Fires step hidden events.
+     *
+     * @param step step thats been hidden
+     */
+    private void fireStepHidden(final Step step) {
+        List<StepListener> listeners =
+                stepListeners.get(StepListener.class);
+        for (StepListener listener : listeners) {
+            listener.stepHidden(step);
+        }
+    }
+}