ExpressTrackChooserPanel.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.trackChooser;

import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.FontMetrics;

import javax.swing.DefaultListModel;
import javax.swing.JList;
import javax.swing.JPanel;
import javax.swing.ListSelectionModel;

import edu.yu.einstein.genplay.gui.mainFrame.MainFrame;
import edu.yu.einstein.genplay.gui.track.Track;

/**
 * @author Nicolas Fourel
 * @version 0.1
 */
public class ExpressTrackChooserPanel extends JPanel {

	/** Generated default version ID */
	private static final long serialVersionUID = -1472615405340919386L;

	private final Track[] allTracks;
	private final JList jList;
	private final DefaultListModel model;


	/**
	 * Constructor of {@link ExpressTrackChooserPanel}
	 */
	public ExpressTrackChooserPanel () {
		// Sets the layout
		((FlowLayout)getLayout()).setHgap(0);
		((FlowLayout)getLayout()).setVgap(0);

		// Creates the model
		model = new DefaultListModel();
		allTracks = MainFrame.getInstance().getTrackListPanel().getModel().getTracks();
		for (Track track: allTracks) {
			model.addElement(track);
		}

		// Creates the list
		jList = new JList();
		jList.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
		jList.setModel(model);

		// Adds the list
		add(jList);
		jList.setSelectionModel(new ExpressTrackChooserListSelectionModel());
	}


	/**
	 * Makes the calculation of the minimum dimension of the list.
	 * @return the dimension of the list
	 */
	public Dimension getDimension () {
		String longestString = "";
		for (Track track: allTracks) {
			String currentString = track.getName();
			if (currentString.length() > longestString.length()) {
				longestString = currentString;
			}
		}
		FontMetrics fm = getFontMetrics(getFont());
		int width = fm.stringWidth(longestString);
		int height = (fm.getHeight() + 3) * allTracks.length;
		return new Dimension(width, height);
	}


	/**
	 * @return an array of selected tracks
	 */
	public Track[] getSelectedTrack () {
		int[] indexes = jList.getSelectedIndices();
		Track[] tracks = new Track[indexes.length];
		for (int i = 0; i < indexes.length; i++) {
			tracks[i] = allTracks[indexes[i]];
		}
		return tracks;
	}


	/**
	 * Retrieve the index of a track from the list of track
	 * @param track a track
	 * @return		its index on the list of track
	 */
	private int getTrackIndex (Track track) {
		for (int i = 0; i < model.size(); i++) {
			if (model.get(i).equals(track)) {
				return i;
			}
		}
		return -1;
	}


	/**
	 * Reset the panel clearing the list selection.
	 */
	public void reset () {
		jList.clearSelection();
	}


	/**
	 * Set the size of the list.
	 * @param dimension
	 */
	public void setListSize (Dimension dimension) {
		jList.setPreferredSize(dimension);
	}


	/**
	 * Sets the tracks in the list
	 * @param tracks the tracks to select
	 */
	public void setSelectedTrack (Track[] tracks) {
		for (Track track: tracks) {
			int index = getTrackIndex(track);
			if (index >= 0) {
				jList.setSelectedIndex(index);
			}
		}
	}

}