ExtractGeneIntervalsDialog.java

/*******************************************************************************
 * GenPlay, Einstein Genome Analyzer
 * Copyright (C) 2009, 2014 Albert Einstein College of Medicine
 * 
 * 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/>.
 * Authors: Julien Lajugie <julien.lajugie@einstein.yu.edu>
 *          Nicolas Fourel <nicolas.fourel@einstein.yu.edu>
 *          Eric Bouhassira <eric.bouhassira@einstein.yu.edu>
 * 
 * Website: <http://genplay.einstein.yu.edu>
 ******************************************************************************/
package edu.yu.einstein.genplay.gui.dialog;

import java.awt.Component;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
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.JFormattedTextField;
import javax.swing.JLabel;
import javax.swing.WindowConstants;
import javax.swing.text.NumberFormatter;

import edu.yu.einstein.genplay.core.operation.geneList.GLOExtractIntervals;
import edu.yu.einstein.genplay.gui.action.layer.geneLayer.GLAExtractInterval;
import edu.yu.einstein.genplay.util.Images;
import edu.yu.einstein.genplay.util.NumberFormats;


/**
 * A frame to define the interval for the {@link GLAExtractInterval}
 * @author Julien Lajugie
 * @author Chirag Gorasia
 * @version 0.1
 */
public final class ExtractGeneIntervalsDialog extends JDialog implements ActionListener {

	/**
	 * Return value when OK has been clicked.
	 */
	public static final int 	APPROVE_OPTION = 0;
	/**
	 * Return value when Cancel has been clicked.
	 */
	public static final int 	CANCEL_OPTION = 1;

	private static final long serialVersionUID = 4391029438908582693L;	// generated ID
	private final static String[] OPTIONS =
		{"before start position", "after start position", "before middle position",
		"after middle position", "before stop position", "after stop position"};		// available options in the comboBoxes
	private final static int[] OPTION_VALUES = {
		GLOExtractIntervals.BEFORE_START,
		GLOExtractIntervals.AFTER_START,
		GLOExtractIntervals.BEFORE_MIDDLE,
		GLOExtractIntervals.AFTER_MIDDLE,
		GLOExtractIntervals.BEFORE_STOP,
		GLOExtractIntervals.AFTER_STOP
	};														// value associated to this operations
	private final JLabel 				jlStart1;			// first label start
	private final JFormattedTextField 	jftfStartDistance;	// text field start distance
	private final JLabel 				jlStart2;			// second label start
	private final JComboBox 			jcbStartFrom;		// comboBox start from
	private final JLabel 				jlStop1;			// first label stop
	private final JFormattedTextField 	jftfStopDistance;	// text field stop distance
	private final JLabel 				jlStop2;			// second label stop
	private final JComboBox 			jcbStopFrom;		// comboBox stop from
	private final JButton 				jbOk;				// button okay
	private final JButton 				jbCancel;			// button cancel
	private int	approved = CANCEL_OPTION;					// approved or canceled


	/**
	 * Creates an instance of {@link ExtractGeneIntervalsDialog}
	 */
	public ExtractGeneIntervalsDialog() {
		super();

		jlStart1 = new JLabel("Extract intervals starting at ");
		jftfStartDistance = new JFormattedTextField(NumberFormats.getPositionFormat());
		((NumberFormatter)jftfStartDistance.getFormatter()).setMinimum(0);
		jftfStartDistance.setValue(0);
		jftfStartDistance.setColumns(9);
		jlStart2 = new JLabel(" bp ");
		jcbStartFrom = new JComboBox(OPTIONS);

		jlStop1 = new JLabel("and stop at ");
		jftfStopDistance = new JFormattedTextField(NumberFormats.getPositionFormat());
		jftfStopDistance.setValue(0);
		jftfStopDistance.setColumns(9);
		jlStop2 = new JLabel(" bp ");
		((NumberFormatter)jftfStopDistance.getFormatter()).setMinimum(0);
		jcbStopFrom = new JComboBox(OPTIONS);

		jbOk = new JButton("Ok");
		jbOk.setDefaultCapable(true);
		jbOk.addActionListener(this);

		jbCancel = new JButton("Cancel");
		jbCancel.addActionListener(this);

		// we want the size of the two buttons to be equal
		jbOk.setPreferredSize(jbCancel.getPreferredSize());

		setLayout(new GridBagLayout());
		GridBagConstraints gbc = new GridBagConstraints();

		gbc.weightx = 1;
		gbc.weighty = 1;
		gbc.gridx = 0;
		gbc.gridy = 0;
		add(jlStart1, gbc);

		gbc.gridx = 1;
		gbc.gridy = 0;
		add(jftfStartDistance, gbc);

		gbc.gridx = 2;
		gbc.gridy = 0;
		add(jlStart2, gbc);

		gbc.gridx = 3;
		gbc.gridy = 0;
		add(jcbStartFrom, gbc);

		gbc.gridx = 0;
		gbc.gridy = 1;
		gbc.anchor = GridBagConstraints.LINE_END;
		add(jlStop1, gbc);

		gbc.gridx = 1;
		gbc.gridy = 1;
		gbc.anchor = GridBagConstraints.CENTER;
		add(jftfStopDistance, gbc);

		gbc.gridx = 2;
		gbc.gridy = 1;
		add(jlStop2, gbc);

		gbc.gridx = 3;
		gbc.gridy = 1;
		add(jcbStopFrom, gbc);

		gbc.gridx = 0;
		gbc.gridy = 2;
		gbc.gridwidth = 2;
		gbc.anchor = GridBagConstraints.LINE_END;
		add(jbOk, gbc);

		gbc.gridx = 2;
		gbc.gridy = 2;
		gbc.anchor = GridBagConstraints.LINE_START;
		add(jbCancel, gbc);

		pack();
		setResizable(false);
		setDefaultCloseOperation(WindowConstants.HIDE_ON_CLOSE);
		setTitle("Extract Intervals");
		setIconImages(Images.getApplicationImages());
		setVisible(false);
		jbOk.setDefaultCapable(true);
		getRootPane().setDefaultButton(jbOk);
	}


	@Override
	public void actionPerformed(ActionEvent arg0) {
		if (arg0.getSource() == jbOk) {
			approved = APPROVE_OPTION;
		}
		setVisible(false);
	}


	/**
	 * @return the start distance
	 */
	public int getStartDistance() {
		Number res = (Number) jftfStartDistance.getValue();
		return res.intValue();
	}


	/**
	 * @return an int corresponding to start from
	 */
	public int getStartFrom() {
		return OPTION_VALUES[jcbStartFrom.getSelectedIndex()];
	}


	/**
	 * @return the stop distance
	 */
	public int getStopDistance() {
		Number res = (Number) jftfStopDistance.getValue();
		return res.intValue();
	}


	/**
	 * @return an int corresponding to stop from
	 */
	public int getStopFrom() {
		return OPTION_VALUES[jcbStopFrom.getSelectedIndex()];
	}


	/**
	 * Shows the component.
	 * @param parent the parent component of the dialog, can be null; see showDialog for details
	 * @return APPROVE_OPTION is OK is clicked. CANCEL_OPTION otherwise.
	 */
	public int showDialog(Component parent) {
		setModalityType(ModalityType.APPLICATION_MODAL);
		setLocationRelativeTo(parent);
		setVisible(true);
		return approved;
	}
}