CustomFileComboBox.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.customComponent.customComboBox;

import java.io.File;

import javax.swing.JOptionPane;

import edu.yu.einstein.genplay.gui.customComponent.customComboBox.customComboBoxEvent.CustomComboBoxEvent;
import edu.yu.einstein.genplay.gui.fileFilter.ExtendedFileFilter;
import edu.yu.einstein.genplay.util.FileChooser;

/**
 * This class extends the {@link CustomComboBox} class.
 * It is specific for file content.
 * Developer can specify filters.
 * 
 * @author Nicolas Fourel
 * @version 0.1
 */
public class CustomFileComboBox extends CustomComboBox<File> {

	/**
	 * Generated default serial version
	 */
	private static final long serialVersionUID = -872347430907803557L;
	private ExtendedFileFilter[] filters;			// filters for adding files to the combo box


	/**
	 * Constructor of {@link CustomFileComboBox}
	 */
	public CustomFileComboBox () {
		filters = null;
	}


	/**
	 * Constructor of {@link CustomFileComboBox}
	 * @param filters filters for file
	 */
	public CustomFileComboBox (ExtendedFileFilter[] filters) {
		this.filters = filters;
	}


	/**
	 * Action on the file after its selection and before its process.
	 * By default, the method return the same file and does not verify anything.
	 * If the class is extended, that method can be overwrited in order to validate the file selection.
	 * See the method in the class {@link CustomFileComboBoxMG} for more example.
	 * 
	 * @param file the selected file
	 * @return the verified/processed file to add or null if not valid
	 */
	protected File actionPostSelection (File file) {
		return file;
	}


	/**
	 * Adds a new element to the combo box.
	 * Shows a popup in order to define the new entry.
	 */
	@Override
	protected void addAction () {
		File selectedFile = FileChooser.chooseFile(getRootPane(), FileChooser.OPEN_FILE_MODE, "Select a File", filters, false);
		if(selectedFile != null) {
			selectedFile = actionPostSelection(selectedFile);
			addElementToCombo(selectedFile);
		}
	}


	protected void addElementToCombo (File element) {
		if (element != null) {
			addElement(element);
			resetCombo();
			setSelectedItem(element);
		}
	}


	@Override
	public void customComboBoxHasChanged(CustomComboBoxEvent evt) {
		if (evt.getAction() == CustomComboBoxEvent.SELECT_ACTION) {
			setSelectedItem(evt.getElement());
		} else if (evt.getAction() == CustomComboBoxEvent.ADD_ACTION) {
			addAction();
		} else if (evt.getAction() == CustomComboBoxEvent.REMOVE_ACTION) {
			removeAction((File)evt.getElement());
		} else if (evt.getAction() == CustomComboBoxEvent.REPLACE_ACTION) {
			replaceAction((File)evt.getElement());
		}
	}


	/**
	 * @return the filters
	 */
	public ExtendedFileFilter[] getFilters() {
		return filters;
	}


	/**
	 * Removes an element from the combo box.
	 * Shows a popup in order to confirm the action.
	 * @param element element to remove
	 */
	@Override
	protected void removeAction (File element) {
		Object[] options = {"Yes", "No"};
		int n = JOptionPane.showOptionDialog(this,
				"Do you really want to erase '" + element + "' ?",
				"Entry deletion",
				JOptionPane.YES_NO_OPTION,
				JOptionPane.WARNING_MESSAGE,
				null,
				options,
				options[0]);

		if (n == JOptionPane.YES_OPTION) {
			elements.remove(element);
			resetCombo();
			setSelectedIndex(0);
		}
	}


	/**
	 * Replaces an existing element by another one to the combo box.
	 * Shows a popup in order to define the new entry.
	 * @param element the element to replace
	 */
	@Override
	protected void replaceAction (File element) {
		File newElement = FileChooser.chooseFile(getRootPane(), FileChooser.OPEN_FILE_MODE, "Select a File", filters, false);
		if (newElement != null) {
			elements.remove(element);
			addElement(newElement);
			resetCombo();
			setSelectedItem(element);
		}
	}


	/**
	 * @param filters the filters to set
	 */
	public void setFilters(ExtendedFileFilter[] filters) {
		this.filters = filters;
	};
}