ca.sqlpower.architect.swingui.action.ProgressAction.java Source code

Introduction

Here is the source code for ca.sqlpower.architect.swingui.action.ProgressAction.java

Source

/*
 * Copyright (c) 2008, SQL Power Group Inc.
 *
 * This file is part of Power*Architect.
 *
 * Power*Architect 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.
 *
 * Power*Architect 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 ca.sqlpower.architect.swingui.action;

import java.awt.event.ActionEvent;
import java.util.HashMap;
import java.util.Map;

import javax.swing.AbstractAction;
import javax.swing.Icon;
import javax.swing.JButton;
import javax.swing.JDialog;
import javax.swing.JLabel;
import javax.swing.JProgressBar;

import ca.sqlpower.architect.swingui.ASUtils;
import ca.sqlpower.architect.swingui.ArchitectFrame;
import ca.sqlpower.architect.swingui.ArchitectSwingSession;
import ca.sqlpower.architect.swingui.PlayPen;
import ca.sqlpower.swingui.ProgressWatcher;
import ca.sqlpower.swingui.SPSwingWorker;
import ca.sqlpower.util.MonitorableImpl;

import com.jgoodies.forms.builder.PanelBuilder;
import com.jgoodies.forms.layout.CellConstraints;
import com.jgoodies.forms.layout.FormLayout;

/**
 * This class creates an action with a built in progress dialog.  
 * <p>
 * By default this class sets up a dialog with an indeterminate progress
 * bar.  The dialog automatically closes when the job finishes.
 */
public abstract class ProgressAction extends AbstractArchitectAction {

    public ProgressAction(ArchitectSwingSession session, PlayPen playpen, String actionName,
            String actionDescription, Icon icon) {
        super(session, playpen, actionName, actionDescription, icon);
    }

    public ProgressAction(ArchitectFrame frame, String actionName, String actionDescription, Icon icon) {
        super(frame, actionName, actionDescription, icon);
    }

    public ProgressAction(ArchitectSwingSession session, String actionName, String actionDescription, Icon icon) {
        super(session, actionName, actionDescription, icon);
    }

    public ProgressAction(ArchitectSwingSession session, String actionName, String actionDescription) {
        super(session, actionName, actionDescription);
    }

    /**
     * Setup the dialog, monitors and worker.  Classes that extend this class
     * should use doStuff() and cleanUp()
     */
    public void actionPerformed(ActionEvent e) {
        final JDialog progressDialog;
        final Map<String, Object> properties = new HashMap<String, Object>();
        progressDialog = new JDialog(frame, Messages.getString("ProgressAction.name"), false); //$NON-NLS-1$
        progressDialog.setLocationRelativeTo(frame);
        progressDialog.setTitle(getDialogMessage());

        PanelBuilder pb = new PanelBuilder(
                new FormLayout("4dlu,fill:min(100dlu;default):grow, pref, fill:min(100dlu;default):grow,4dlu", //$NON-NLS-1$
                        "4dlu,pref,4dlu, pref, 6dlu, pref,4dlu")); //$NON-NLS-1$
        JLabel label = new JLabel(getDialogMessage());
        JProgressBar progressBar = new JProgressBar();
        final MonitorableImpl monitor = new MonitorableImpl();
        if (!setup(monitor, properties)) {
            // if setup indicates not to continue (returns false), then exit method
            return;
        }
        CellConstraints c = new CellConstraints();
        pb.add(label, c.xyw(2, 2, 3));
        pb.add(progressBar, c.xyw(2, 4, 3));
        pb.add(new JButton(new AbstractAction(getButtonText()) {
            public void actionPerformed(ActionEvent e) {
                progressDialog.dispose();
                monitor.setCancelled(true);
            }
        }), c.xy(3, 6));
        progressDialog.add(pb.getPanel());

        SPSwingWorker worker = new SPSwingWorker(getSession()) {
            @Override
            public void cleanup() throws Exception {
                if (getDoStuffException() != null) {
                    ASUtils.showExceptionDialog(getSession(),
                            Messages.getString("ProgressAction.unexpectedException"), getDoStuffException()); //$NON-NLS-1$
                }
                ProgressAction.this.cleanUp(monitor);
                monitor.setFinished(true);
                progressDialog.dispose();
            }

            @Override
            public void doStuff() throws Exception {
                ProgressAction.this.doStuff(monitor, properties);
            }
        };
        ProgressWatcher.watchProgress(progressBar, monitor);
        progressDialog.pack();
        progressDialog.setVisible(true);

        new Thread(worker).start();
    }

    /**
     *  Return the text that shows up on the dialog button
     */
    public abstract String getButtonText();

    /**
     * Setup the monitor and doStuff parameters before the progress dialog is shown.
     * @return return true to continue with the action, return false to stop the action
     *          This could be used to respond to user choice to cancel the action
     */
    public abstract boolean setup(MonitorableImpl monitor, Map<String, Object> properties);

    /**
     * doStuff replaces the actionPerformed() call
     */
    public abstract void doStuff(MonitorableImpl monitor, Map<String, Object> properties);

    /**
     * Perform any cleanup code here 
     */
    public abstract void cleanUp(MonitorableImpl monitor);

    /**
     * Gets the message that will be displayed on the progressbar
     * 
     * @return the message displayed on the dialog above the progressbar
     */
    public abstract String getDialogMessage();
}