edu.cudenver.bios.powercalculator.client.panels.StartPanel.java Source code

Java tutorial

Introduction

Here is the source code for edu.cudenver.bios.powercalculator.client.panels.StartPanel.java

Source

/*
 * .NAME SOFTWARE, one line about what it does
 * 
 * Copyright (C) 2010 Regents of the University of Colorado.
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Please contact Sarah Kreidler (sarah.kreidler@ucdenver.edu) for more information
 * about this software.  Or visit the website at <>
 */

package edu.cudenver.bios.powercalculator.client.panels;

import java.util.ArrayList;

import com.google.gwt.event.dom.client.ChangeEvent;
import com.google.gwt.event.dom.client.ChangeHandler;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.event.dom.client.ClickHandler;
import com.google.gwt.user.client.Window;
import com.google.gwt.user.client.ui.Button;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.FileUpload;
import com.google.gwt.user.client.ui.FormPanel;
import com.google.gwt.user.client.ui.Grid;
import com.google.gwt.user.client.ui.HTML;
import com.google.gwt.user.client.ui.HorizontalPanel;
import com.google.gwt.user.client.ui.ListBox;
import com.google.gwt.user.client.ui.VerticalPanel;
import com.google.gwt.user.client.ui.FormPanel.SubmitCompleteEvent;
import com.google.gwt.user.client.ui.FormPanel.SubmitCompleteHandler;
import com.google.gwt.xml.client.DOMException;
import com.google.gwt.xml.client.Document;
import com.google.gwt.xml.client.Node;
import com.google.gwt.xml.client.XMLParser;

import edu.cudenver.bios.powercalculator.client.PowerCalculatorConstants;
import edu.cudenver.bios.powercalculator.client.PowerCalculatorGUI;
import edu.cudenver.bios.powercalculator.client.listener.InputWizardStepListener;
import edu.cudenver.bios.powercalculator.client.listener.StartListener;

/**
 * Welcome / start panel in the input wizard for the power calculator 
 * site.  Allows the user to select the method for study design input
 * and the statistical model
 * 
 * @author Owner
 *
 */
public class StartPanel extends Composite implements SubmitCompleteHandler {
    // uri of file upload service
    private static final String UPLOAD_URI = "/webapps/file/upload";
    // form tag for file
    private static final String FORM_TAG_FILE = "file";

    protected FormPanel formPanel = new FormPanel();
    protected FileUpload uploader = new FileUpload();

    protected ArrayList<StartListener> startListeners = new ArrayList<StartListener>();

    public StartPanel(InputWizardStepListener wizard, int stepIndex) {
        VerticalPanel panel = new VerticalPanel();

        // layout the widgets        
        // add introductory text
        HTML header = new HTML(PowerCalculatorGUI.constants.textStartPanelHeader());
        HTML description = new HTML(PowerCalculatorGUI.constants.textStartPanelDescription());
        panel.add(header);
        panel.add(description);

        // create user input container
        VerticalPanel inputContainer = new VerticalPanel();

        // template design mode
        Grid templateModeContainer = new Grid(1, 2);
        VerticalPanel templateTextContainer = new VerticalPanel();
        templateTextContainer.add(new HTML("<b>Study Design Templates</b>"));
        templateTextContainer.add(new HTML(
                "Common study designs including ANOVA, ANCOVA, and MANOVA.  For users less familiar with the general linear model"));
        templateModeContainer.setWidget(0, 0, templateTextContainer);
        Button templateGo = new Button("Go", new ClickHandler() {
            public void onClick(ClickEvent e) {
                for (StartListener listener : startListeners)
                    listener.onTemplateMode();
            }
        });
        templateGo.setStyleName("startPanelGoButton");
        templateModeContainer.setWidget(0, 1, templateGo);

        // matrix entry mode
        Grid matrixModeContainer = new Grid(1, 2);
        VerticalPanel matrixTextContainer = new VerticalPanel();
        matrixTextContainer.add(new HTML("<b>Matrix Mode</b>"));
        matrixTextContainer.add(new HTML(
                "Directly enter matrix representation for the general linear model.  For users who are more familiar with statistical methods."));
        matrixModeContainer.setWidget(0, 0, matrixTextContainer);
        Button matrixGo = new Button("Go", new ClickHandler() {
            public void onClick(ClickEvent e) {
                for (StartListener listener : startListeners)
                    listener.onMatrixMode();
            }
        });
        matrixGo.setStyleName("startPanelGoButton");
        matrixModeContainer.setWidget(0, 1, matrixGo);

        // upload an existing study        
        VerticalPanel uploadContainer = new VerticalPanel();
        uploadContainer.add(new HTML("<b>Upload an Existing Study</b>"));
        uploadContainer.add(new HTML(
                "If you have previously saved a study design from Glimmpse, you may upload it here.  Click browse to select your study design file."));
        // build the upload form
        // for file upload, we need to use the POST method, and multipart MIME encoding.
        formPanel.setEncoding(FormPanel.ENCODING_MULTIPART);
        formPanel.setMethod(FormPanel.METHOD_POST);
        formPanel.setAction(UPLOAD_URI);
        // panel to contain the contents of the submission form
        HorizontalPanel formContents = new HorizontalPanel();
        // create an upload widget
        uploader.addChangeHandler(new ChangeHandler() {
            public void onChange(ChangeEvent e) {
                String filename = uploader.getFilename();
                if (filename == null || filename.isEmpty()) {
                    Window.alert(
                            "No filename specified.  Please click the 'Browse' button and select a file for upload.");
                } else {
                    formPanel.submit();
                }
            }
        });
        uploader.setName(FORM_TAG_FILE);
        formContents.add(uploader);
        formPanel.add(formContents);
        formPanel.addSubmitCompleteHandler(this);
        uploadContainer.add(formPanel);

        templateModeContainer.setStyleName("startPanelContainer");
        matrixModeContainer.setStyleName("startPanelContainer");
        uploadContainer.setStyleName("startPanelContainer");
        inputContainer.add(templateModeContainer);
        inputContainer.add(matrixModeContainer);
        inputContainer.add(uploadContainer);

        panel.add(inputContainer);

        // add style
        header.setStyleName(PowerCalculatorConstants.STYLE_WIZARD_STEP_HEADER);
        description.setStyleName(PowerCalculatorConstants.STYLE_WIZARD_STEP_DESCRIPTION);
        panel.setStyleName(PowerCalculatorConstants.STYLE_WIZARD_STEP_PANEL);
        inputContainer.setStyleName(PowerCalculatorConstants.STYLE_WIZARD_STEP_INPUT_CONTAINER);

        initWidget(panel);
    }

    /**
     * Add a listener for "start events" which indicate if the user
     * wants to create a new study, or upload an existing design
     * 
     * @param listener 
     */
    public void addStartListener(StartListener listener) {
        startListeners.add(listener);
    }

    public void onSubmitComplete(SubmitCompleteEvent event) {
        String results = event.getResults();
        if (results != null) {
            try {
                // make sure we at least have a study tag and model name specified
                Document doc = XMLParser.parse(results);
                Node studyNode = doc.getElementsByTagName("study").item(0);
                if (studyNode == null)
                    throw new DOMException(DOMException.SYNTAX_ERR, "no study tag specified");
                Node mode = studyNode.getAttributes().getNamedItem("mode");
                if (mode == null)
                    throw new DOMException(DOMException.SYNTAX_ERR, "no model name specified");
                // notify listeners of the file upload
                for (StartListener listener : startListeners)
                    listener.onStudyUpload(doc, mode.getNodeValue());
            } catch (DOMException e) {
                Window.alert("Uploaded file does not contain a valid study description [error: " + e.getMessage()
                        + "].  Please try another file.");
            }
        } else {
            Window.alert("Failed to upload file.  Please try again");
        }

    }

    public void reset() {
        formPanel.reset();
    }
}