Wizard.java

/*
 * Copyright (C) 2011  Ives van der Flaas
 *
 * This program 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.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package be.ac.ua.comp.scarletnebula.wizard;

import java.awt.Component;
import java.awt.Dialog;
import java.awt.Dimension;
import java.awt.Frame;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.Stack;

import javax.swing.JDialog;
import javax.swing.WindowConstants;

public class Wizard {
	Stack<WizardPage> visitedPages = new Stack<WizardPage>();
	DataRecorder recorder;
	JDialog window;
	WizardListener listener = null;

	WizardTemplate wizardTemplate = null;

	public Wizard(final WizardPage startPage, final DataRecorder recorder,
			final WizardTemplate wizardTemplate) {
		this.recorder = recorder;
		this.wizardTemplate = wizardTemplate;
		visitedPages.push(startPage);
	}

	/**
	 * Start the Wizard in the window in parameter
	 * 
	 * @param window
	 */
	public void start(final JDialog window) {
		this.window = window;

		initializeButtons(window);
		displayPage();
	}

	/**
	 * Start the wizard, and do so in a window the Wizard creates itself
	 * 
	 * @param width
	 *            Width of the window
	 * @param height
	 *            Height of the window
	 * @param parent
	 *            Owner of the window, null if no owner
	 */
	public void startModal(final String title, final int width,
			final int height, final Dialog parent) {
		window = new JDialog(parent, true);
		configureDialog(title, width, height, window, parent);
	}

	/**
	 * Start the wizard, and do so in a window the Wizard creates itself
	 * 
	 * @param width
	 *            Width of the window
	 * @param height
	 *            Height of the window
	 * @param parent
	 *            Owner of the window, null if no owner
	 */
	public void startModal(final String title, final int width,
			final int height, final Frame parent) {
		window = new JDialog(parent, true);
		configureDialog(title, width, height, window, parent);
	}

	private void configureDialog(final String title, final int width,
			final int height, final JDialog dialog, final Component parent) {
		dialog.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
		dialog.setSize(new Dimension(width, height));
		dialog.setLocationRelativeTo(parent);
		dialog.setLocationByPlatform(true);
		dialog.setTitle(title);

		start(dialog);

		dialog.setVisible(true);
	}

	private void displayPage() {
		renderPage(visitedPages.peek());
	}

	private void initializeButtons(final JDialog window) {
		wizardTemplate.setupWindow(window);

		wizardTemplate.previousButton.addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(final ActionEvent e) {
				previous();
			}
		});

		wizardTemplate.nextButton.addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(final ActionEvent e) {
				next();
			}
		});

		wizardTemplate.finishButton.addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(final ActionEvent e) {
				finish();
			}
		});

		wizardTemplate.cancelButton.addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(final ActionEvent e) {
				cancel();
			}
		});

		window.getRootPane().setDefaultButton(wizardTemplate.nextButton);
	}

	private void renderPage(final WizardPage page) {
		if (page == null) {
			return;
		}

		wizardTemplate.nextButton.setEnabled(page.nextIsEnabled());
		wizardTemplate.finishButton.setEnabled(page.finishIsEnabled());
		wizardTemplate.previousButton.setEnabled(visitedPages.size() > 1);

		wizardTemplate.container.removeAll();

		for (final Component c : page.getComponents()) {
			c.setVisible(true);
		}

		wizardTemplate.container.add(page);
		wizardTemplate.container.revalidate();
		wizardTemplate.container.repaint();
	}

	private void next() {
		final WizardPage nextPage = visitedPages.peek().next(recorder);

		// If no next page is given, the wizard shouldn't do anything
		if (nextPage == null) {
			return;
		}

		visitedPages.push(nextPage);
		displayPage();
	}

	private void previous() {
		visitedPages.pop();
		displayPage();
	}

	private void finish() {
		// Run this for the side effects to recorder
		visitedPages.peek().next(recorder);
		window.dispose();

		if (listener != null) {
			listener.onFinish(recorder);
		}
	}

	private void cancel() {
		window.dispose();
		if (listener != null) {
			listener.onCancel(recorder);
		}
	}

	public void addWizardListener(final WizardListener l) {
		listener = l;
	}
}