EncogCommonDialog.java

/*
 * Encog(tm) Workbench v3.4
 * http://www.heatonresearch.com/encog/
 * https://github.com/encog/encog-java-workbench
 *
 * Copyright 2008-2016 Heaton Research, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *   
 * For more information on Heaton Research copyrights, licenses 
 * and trademarks visit:
 * http://www.heatonresearch.com/copyright
 */
package org.encog.workbench.dialogs.common;

import java.awt.BorderLayout;
import java.awt.Container;
import java.awt.Frame;
import java.awt.Window;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JDialog;
import javax.swing.JPanel;
import javax.swing.JTextField;

import org.encog.workbench.EncogWorkBench;

/**
 * Common dialog box for use in the workbench.  Provides an ok and cancel
 * button.  Also provides methods for collecting and validating values
 * from the dialog box.
 * @author jheaton
 */
abstract public class EncogCommonDialog extends JDialog implements
		ActionListener {

	/**
	 * The serial id.
	 */
	private static final long serialVersionUID = 8307697052772231235L;

	/**
	 * The OK button.
	 */
	private JButton ctrlOK;
	
	/**
	 * The cancel button.
	 */
	private JButton ctrlCancel;
	
	/**
	 * The pannel that holds the body of this dialog.
	 */
	private final JPanel bodyPanel;
	
	/**
	 * The panel that holds the OK and cancel button.
	 */
	private final JPanel buttonPanel;
	
	/**
	 * True if the user clicked OK and this dialog should
	 * be processed.
	 */
	private boolean shouldProcess;

	/**
	 * Construct the common dialog box.
	 * @param owner The owner of this dialog box.
	 */
	public EncogCommonDialog(final Frame owner) {
		super(owner, true);
		this.bodyPanel = new JPanel();
		this.buttonPanel = new JPanel();
		init();
		
	}
	
	public EncogCommonDialog(JDialog owner)
	{
		super(owner, true);
		this.bodyPanel = new JPanel();
		this.buttonPanel = new JPanel();
		init();
	}
	
	
	private void init()
	{
		final Container content = getContentPane();
		content.setLayout(new BorderLayout());

		this.buttonPanel.add(this.ctrlOK = new JButton("OK"));
		this.buttonPanel.add(this.ctrlCancel = new JButton("Cancel"));

		this.ctrlCancel.addActionListener(this);
		this.ctrlOK.addActionListener(this);

		content.add(this.bodyPanel, BorderLayout.CENTER);
		content.add(this.buttonPanel, BorderLayout.SOUTH);
	}

	/**
	 * Process action events.
	 * @param e The action event.
	 */
	public void actionPerformed(final ActionEvent e) {

		if (e.getSource() == this.ctrlOK) {
			if ( collect() && passesValidation()) {
				dispose();
				this.shouldProcess = true;
			}
		} else if (e.getSource() == this.ctrlCancel) {
			dispose();
			this.shouldProcess = false;
		}
	}

	public boolean passesValidation() {
		return true;
	}

	/**
	 * Collect the values from all of the fields.
	 * @return True if no validation errors occured.
	 */
	public boolean collect() {
		try {
			collectFields();
			return true;
		} catch (final ValidationException e) {
			EncogWorkBench.displayError("Validation Error", e.getMessage());
			return false;
		}
	}

	/**
	 * Implmented by child classes to collect data from their fields.
	 * @throws ValidationException A validation error occured.
	 */
	abstract public void collectFields() throws ValidationException;

	/**
	 * @return the bodyPanel
	 */
	public JPanel getBodyPanel() {
		return this.bodyPanel;
	}

	/**
	 * @return the buttonPanel
	 */
	public JPanel getButtonPanel() {
		return this.buttonPanel;
	}

	/**
	 * Called to display the dialog box and wait for the user
	 * to click OK or Cancel.
	 * @return True if the dialog box should be processed.
	 */
	public boolean process() {
		setFields();
		setVisible(true);
		return this.shouldProcess;
	}

	/**
	 * Implemented by subclasses to set the fields of the dialog box.
	 */
	abstract public void setFields();

	/**
	 * Validate and collect the value from a numeric field.
	 * @param name The name of the field.
	 * @param field The field.
	 * @return The numeric value collected from the field.
	 * @throws ValidationException Thrown if a validation error occurs.
	 */
	public double validateFieldNumeric(final String name, final JTextField field)
			throws ValidationException {
		try {
			final double d = Double.parseDouble(field.getText());
			return d;
		} catch (final NumberFormatException e) {
			throw new ValidationException("Must enter a valid number for: "
					+ name);
		}
	}

	/**
	 * Validate and collect the value from a numeric field.
	 * @param name The name of the field.
	 * @param field The field.
	 * @param low The low value for the field.
	 * @return The numeric value collected from the field.
	 * @throws ValidationException Thrown if a validation error occurs.
	 */
	public double validateFieldNumeric(final String name,
			final JTextField field, final double low, final double high)
			throws ValidationException {
		final double d = validateFieldNumeric(name, field);
		if (d < low) {
			throw new ValidationException("Must enter a value above " + low
					+ " for: " + name);
		}
		if( (high>low) && (d > high) ) {
			throw new ValidationException("Must enter a value below " + low
					+ " for: " + name);
		}

		return d;
	}

	/**
	 * Validate and collect the value from a string field.
	 * @param name The name of the field.
	 * @param field The field.
	 * @param required Is this field required?
	 * @return The value collected.
	 * @throws ValidationException A validation error occured.
	 */
	public String validateFieldString(final String name, final JComboBox field,
			final boolean required) throws ValidationException {
		String result = (String) field.getSelectedItem();
		if (result == null && required) {
			throw new ValidationException("The " + name + " field is required.");
		}

		if (result != null) {
			result = result.trim();
		}

		return result;
	}

	/**
	 * Validate and collect the value from a string field.
	 * @param name The name of the field.
	 * @param field The field.
	 * @param required Is this field required.
	 * @return The value collected.
	 * @throws ValidationException A validation error occured.
	 */
	public String validateFieldString(final String name,
			final JTextField field, final boolean required)
			throws ValidationException {
		final String result = field.getText().trim();
		if (result.length() < 1 && required) {
			throw new ValidationException("The " + name + " field is required.");
		}
		return result;
	}
	
}