fiore@0: /*  
fiore@0:  CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
fiore@0:   
fiore@0:  Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
fiore@0: 
fiore@0:  This program is free software: you can redistribute it and/or modify
fiore@0:  it under the terms of the GNU General Public License as published by
fiore@0:  the Free Software Foundation, either version 3 of the License, or
fiore@0:  (at your option) any later version.
fiore@0: 
fiore@0:  This program is distributed in the hope that it will be useful,
fiore@0:  but WITHOUT ANY WARRANTY; without even the implied warranty of
fiore@0:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
fiore@0:  GNU General Public License for more details.
fiore@0: 
fiore@0:  You should have received a copy of the GNU General Public License
fiore@0:  along with this program.  If not, see <http://www.gnu.org/licenses/>.
fiore@0: */  
fiore@0: 
fiore@0: package uk.ac.qmul.eecs.ccmi.utils;
fiore@0: 
fiore@0: import java.awt.GridBagConstraints;
fiore@0: 
fiore@0: /**
fiore@0:  * 
fiore@0:  * A Utility class providing static method to quickly arrange components, laid out by 
fiore@0:  * a GridBagLayout, in the following way: one component per row and 
fiore@0:  * either taking the whole column or just the right part of it, if preceded by a label.  
fiore@0:  */
fiore@0: public class GridBagUtilities {
fiore@0: 	public GridBagUtilities(){
fiore@0: 		 labelPad = DEFAULT_LABEL_PAD;
fiore@0: 		 row = 0;
fiore@0: 	}
fiore@0: 	
fiore@3: 	/**
fiore@3: 	 * Provides the {@code GridBagConstrains} for a label. The label is placed
fiore@3: 	 * on the left
fiore@3: 	 * @param pad the pad between the label and the left margin of the component containing
fiore@3: 	 * it 
fiore@3: 	 * @return a {@code GridBagConstrains} object to pass to the {@code add} method of {@code JComponent}
fiore@3: 	 */
fiore@0: 	public GridBagConstraints label(int pad){
fiore@0: 		GridBagConstraints c ;
fiore@0: 		
fiore@0: 		c = new GridBagConstraints();
fiore@0: 		c.anchor = GridBagConstraints.WEST;
fiore@0: 		c.gridx = 0;
fiore@0: 		c.gridy = row;
fiore@0: 		c.insets = new java.awt.Insets(PAD,PAD,PAD,pad);
fiore@0: 		
fiore@0: 		return c;
fiore@0: 	}
fiore@0: 	
fiore@3: 	/**
fiore@3: 	 * Equivalent to {@link #label(int)} passing as argument the value previously 
fiore@3: 	 * set by {@link #setLabelPad(int)} or {@link #DEFAULT_LABEL_PAD} otherwise.
fiore@5: 	 * 
fiore@5: 	 * @return a {@code GridBagConstrains} object to pass to the {@code add} method of {@code JComponent}
fiore@3: 	 */
fiore@0: 	public GridBagConstraints label(){
fiore@0: 		return label(labelPad);
fiore@0: 	}
fiore@0: 	
fiore@3: 	/**
fiore@3: 	 * Sets the value used by {@link #label()} as the pad between the label 
fiore@3: 	 * and the left margin of the component containing it 
fiore@3: 	 * @param labelPad the label pad 
fiore@3: 	 */
fiore@0: 	public void setLabelPad(int labelPad){
fiore@0: 		this.labelPad = labelPad;
fiore@0: 	}
fiore@0: 	
fiore@5: 	/**
fiore@5: 	 * Provides the {@code GridBagConstrains} for a component placed on the same row 
fiore@5: 	 * and on the right of a label.
fiore@5: 	 *  
fiore@5: 	 * @return a {@code GridBagConstrains} object to pass to the {@code add} method of {@code JComponent}
fiore@5: 	 */
fiore@0: 	public GridBagConstraints field(){
fiore@0: 		GridBagConstraints c;
fiore@0: 		
fiore@0: 		c = new GridBagConstraints();
fiore@0: 		c.anchor = GridBagConstraints.CENTER;
fiore@0: 		c.gridx = 1;
fiore@0: 		c.gridy = row++;
fiore@0: 		c.insets = new java.awt.Insets(PAD,PAD,PAD,PAD);
fiore@0: 		c.fill = GridBagConstraints.HORIZONTAL;
fiore@0: 		
fiore@0: 		return c;
fiore@0: 	}
fiore@0: 	
fiore@5: 	/**
fiore@5: 	 * Provides the {@code GridBagConstrains} for a component placed alone on a row.
fiore@5: 	 *  
fiore@5: 	 * @return a {@code GridBagConstrains} object to pass to the {@code add} method of {@code JComponent}
fiore@5: 	 */
fiore@0: 	public GridBagConstraints all(){
fiore@0: 		GridBagConstraints c;
fiore@0: 		
fiore@0: 		c = new GridBagConstraints();
fiore@0: 		c.gridy = row++;
fiore@0: 		c.anchor = GridBagConstraints.CENTER;
fiore@0: 		c.gridwidth = GridBagConstraints.REMAINDER;
fiore@0: 		c.fill = GridBagConstraints.HORIZONTAL;
fiore@0: 		c.insets = new java.awt.Insets(PAD,PAD,PAD,PAD);
fiore@0: 		return c;
fiore@0: 	}
fiore@0: 	
fiore@0: 	private int labelPad;
fiore@0: 	private int row;
fiore@0: 	public static final int DEFAULT_LABEL_PAD = 50;
fiore@0: 	public static final int PAD = 2;
fiore@0: }