Ruler.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.track.ruler;

import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.image.BufferedImage;

import javax.swing.BorderFactory;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JPanel;

import edu.yu.einstein.genplay.core.manager.project.ProjectManager;
import edu.yu.einstein.genplay.core.manager.project.ProjectWindow;
import edu.yu.einstein.genplay.gui.event.genomeWindowEvent.GenomeWindowEvent;
import edu.yu.einstein.genplay.gui.event.genomeWindowEvent.GenomeWindowListener;
import edu.yu.einstein.genplay.gui.track.Drawer;
import edu.yu.einstein.genplay.gui.track.GraphicsPanel;
import edu.yu.einstein.genplay.util.Images;
import edu.yu.einstein.genplay.util.colors.Colors;

/**
 * Ruler that shows the positions of the current genome window and contains the project option button
 * @author Julien Lajugie
 */
public class Ruler implements GenomeWindowListener {

	private static final int 		HANDLE_WIDTH = 50;					// Width of the track handle
	private static final int 		TRACKS_SCROLL_WIDTH = 17;			// Width of the scroll bar
	public static final int 		RULER_HEIGHT = 20;					// Height of the ruler
	private final GraphicsPanel		rulerGraphics;						// Graphics part
	private final JPanel			rulerPanel;							// top container
	private final JButton 			rulerButton;						// button of the ruler


	/**
	 * Creates an instance of {@link Ruler}
	 */
	public Ruler() {
		super();
		rulerPanel = new JPanel();
		rulerGraphics = new GraphicsPanel();
		initGraphics();
		rulerButton = new JButton();
		initButton();
		rulerPanel.setLayout(new GridBagLayout());
		GridBagConstraints gbc = new GridBagConstraints();
		gbc.fill = GridBagConstraints.BOTH;
		gbc.insets = new Insets(0, 0, 0, 0);
		gbc.gridx = 0;
		gbc.gridy = 0;
		gbc.weightx = 0;
		gbc.weighty = 1;
		rulerPanel.add(rulerButton, gbc);
		gbc = new GridBagConstraints();
		gbc.fill = GridBagConstraints.BOTH;
		gbc.insets = new Insets(0, 0, 0, TRACKS_SCROLL_WIDTH);
		gbc.gridx = 1;
		gbc.gridy = 0;
		gbc.weightx = 1;
		gbc.weighty = 1;
		rulerPanel.add(rulerGraphics, gbc);
		rulerPanel.setMinimumSize(new Dimension(rulerPanel.getPreferredSize().width, RULER_HEIGHT));
		// register the ruler to the project window manager so the ruler can be notified when the project window changes
		ProjectWindow projectWindow = ProjectManager.getInstance().getProjectWindow();
		projectWindow.addGenomeWindowListener(this);
	}


	@Override
	public void genomeWindowChanged(GenomeWindowEvent evt) {
		rulerGraphics.repaint();
	}


	/**
	 * @return an image of the ruler (without its button)
	 */
	public BufferedImage getImage() {
		BufferedImage image = new BufferedImage(rulerGraphics.getWidth(), rulerGraphics.getHeight(), BufferedImage.TYPE_INT_ARGB);
		Graphics g = image.getGraphics();
		rulerGraphics.paint(g);
		return image;
	}


	/**
	 * @return the main button of the application attached to the Ruler
	 */
	public JButton getOptionButton() {
		return rulerButton;
	}


	/**
	 * @return the graphics panel of the ruler
	 */
	public GraphicsPanel getRulerGraphics() {
		return rulerGraphics;
	}


	/**
	 * @return the panel that contains the ruler
	 */
	public JPanel getRulerPanel() {
		return rulerPanel;
	}


	/**
	 * Initializes the button of the ruler
	 */
	private void initButton() {
		rulerButton.setBackground(Colors.TRACK_HANDLE_BACKGROUND);
		rulerButton.setMargin(new Insets(0, 0, 0, 0));
		rulerButton.setFocusPainted(false);
		rulerButton.setIcon(new ImageIcon(Images.getToolsImage()));
		rulerButton.setBorder(BorderFactory.createMatteBorder(0, 1, 0, 1, Colors.LIGHT_GREY));
		rulerButton.setContentAreaFilled(false);
		rulerButton.setOpaque(true);
		rulerButton.setPreferredSize(new Dimension(HANDLE_WIDTH + 1, RULER_HEIGHT));
		rulerButton.addMouseListener(new MouseAdapter() {
			@Override
			public void mouseEntered(MouseEvent e) {
				if (rulerButton.isEnabled()) {
					rulerButton.setBackground(Colors.TRACK_HANDLE_ROLLOVER);
				}
				super.mouseEntered(e);
			}
			@Override
			public void mouseExited(MouseEvent e) {
				if (rulerButton.isEnabled()) {
					rulerButton.setBackground(Colors.TRACK_HANDLE_BACKGROUND);
				}
				super.mouseExited(e);
			}
		});
	}


	/**
	 * Initializes the ruler graphics panel
	 */
	private void initGraphics() {
		Drawer[] drawers = {new RulerDrawer()};
		rulerGraphics.setDrawers(drawers);
	}


	/**
	 * Locks the ruler (the button)
	 */
	public void lock() {
		rulerButton.setEnabled(false);
	}


	/**
	 * Unlocks the ruler (the button)
	 */
	public void unlock() {
		rulerButton.setEnabled(true);
	}
}