package additionaluserinterface;

import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;

import javax.swing.BorderFactory;
import javax.swing.JComponent;
import javax.swing.JToolBar;

/**
 * This class extends the JToolbar to create grid panel given the possibility to
 * place Java compoments in an organized manner in the dialog box.
 * 
 * @author Daniel Sage, Biomedical Imaging Group, EPFL, Lausanne, Switzerland.
 * 
 */
public class GridToolbar extends JToolBar {

	private GridBagLayout		layout			= new GridBagLayout();
	private GridBagConstraints	constraint		= new GridBagConstraints();
	private int					defaultSpace	= 3;

	/**
	 * Constructor.
	 */
	public GridToolbar() {
		super("Control");
		setLayout(layout);
		setBorder(BorderFactory.createEtchedBorder());
		setFloatable(false);
	}

	/**
	 * Constructor.
	 */
	public GridToolbar(boolean border) {
		super("Control");
		setLayout(layout);
		if (border) {
			setBorder(BorderFactory.createEtchedBorder());
		}
		setFloatable(false);
	}

	/**
	 * Constructor.
	 */
	public GridToolbar(String title) {
		super(title);
		setLayout(layout);
		setBorder(BorderFactory.createTitledBorder(title));
		setFloatable(false);
	}

	/**
	 * Constructor.
	 */
	public GridToolbar(int defaultSpace) {
		super("Control");
		setLayout(layout);
		this.defaultSpace = defaultSpace;
		setBorder(BorderFactory.createEtchedBorder());
		setFloatable(false);
	}

	/**
	 * Constructor.
	 */
	public GridToolbar(boolean border, int defaultSpace) {
		super("Control");
		setLayout(layout);
		this.defaultSpace = defaultSpace;
		if (border) {
			setBorder(BorderFactory.createEtchedBorder());
		}
		setFloatable(false);
	}

	/**
	 * Constructor.
	 */
	public GridToolbar(boolean border, int defaultSpace, boolean floatable) {
		super("Control");
		setLayout(layout);
		this.defaultSpace = defaultSpace;
		if (border) {
			setBorder(BorderFactory.createEtchedBorder());
		}
		setFloatable(floatable);
	}

	/**
	 * Constructor.
	 */
	public GridToolbar(boolean border, boolean floatable) {
		super("Control");
		setLayout(layout);
		if (border) {
			setBorder(BorderFactory.createEtchedBorder());
		}
		setFloatable(floatable);
	}

	/**
	 * Constructor.
	 */
	public GridToolbar(String title, boolean floatable) {
		super(title);
		setLayout(layout);
		setBorder(BorderFactory.createTitledBorder(title));
		setFloatable(floatable);
	}

	/**
	 * Constructor.
	 */
	public GridToolbar(int defaultSpace, boolean floatable) {
		super("Control");
		setLayout(layout);
		this.defaultSpace = defaultSpace;
		setBorder(BorderFactory.createEtchedBorder());
		setFloatable(floatable);
	}

	/**
	 * Constructor.
	 */
	public GridToolbar(String title, int defaultSpace) {
		super(title);
		setLayout(layout);
		this.defaultSpace = defaultSpace;
		setBorder(BorderFactory.createTitledBorder(title));
		setFloatable(false);
	}

	/**
	 * Constructor.
	 */
	public GridToolbar(String title, int defaultSpace, boolean floatable) {
		super(title);
		setLayout(layout);
		this.defaultSpace = defaultSpace;
		setBorder(BorderFactory.createTitledBorder(title));
		setFloatable(floatable);
	}

	/**
	 * Specify the defaultSpace.
	 */
	public void setSpace(int defaultSpace) {
		this.defaultSpace = defaultSpace;
	}

	/**
	 * Place a component in the northwest of the cell.
	 */
	public void place(int row, int col, JComponent comp) {
		place(row, col, 1, 1, defaultSpace, comp);
	}

	/**
	 * Place a component in the northwest of the cell.
	 */
	public void place(int row, int col, int space, JComponent comp) {
		place(row, col, 1, 1, space, comp);
	}

	/**
	 * Place a component in the northwest of the cell.
	 */
	public void place(int row, int col, int width, int height, JComponent comp) {
		place(row, col, width, height, defaultSpace, comp);
	}

	/**
	 * Place a component in the northwest of the cell.
	 */
	public void place(int row, int col, int width, int height, int space, JComponent comp) {
		constraint.gridx = col;
		constraint.gridy = row;
		constraint.gridwidth = width;
		constraint.gridheight = height;
		constraint.anchor = GridBagConstraints.NORTHWEST;
		constraint.insets = new Insets(space, space, space, space);
		constraint.fill = GridBagConstraints.HORIZONTAL;
		layout.setConstraints(comp, constraint);
		add(comp);
	}

}