Application: gvSIG desktop » gvSIG Document Layout

package org.gvsig.app.project.documents.layout.fframes.gui.numberFormat;

import java.awt.event.FocusEvent;

import java.awt.event.FocusListener;

import java.util.ArrayList;

import javax.swing.JComboBox;

import org.gvsig.i18n.Messages;

/**

 * This is is a customized JComboBox used to select a single character.

 * It has the following properties:

 * <ul>

 * <li>it is editable</li>

 * <li>only allows a single char (if more chars are introduced, the string

 * is trimmed to the first character</li>

 * <li>optionally, it can show a special item (NoneItem) that represents that no

 * character wants to be selected.</li></ul>

 * 

 * @author Cesar Martinez Izquierdo

 *

 */

public class CharComboBox extends JComboBox {

	private static final long serialVersionUID = 2194202669931887456L;

	/**

	 * This item represents that no item is selected

	 */

	private String noneItem = Messages.getText("None");

	public CharComboBox(String[] items, boolean showNoneItem) {

		super();

		this.setEditable(true);

		for (int i=0; i<items.length; i++) {

			String item = items[i];

			if (item!=null && item.length()>0) {

				this.addItem(new String(item.substring(0, 1)));

			}

		}

		if (showNoneItem) {

			this.addItem(noneItem);

		}

		this.addFocusListener(new FocusListener() {

			public void focusGained(FocusEvent e) {	

			}

			public void focusLost(FocusEvent e) {

				String item = getSelectedItem();

				if (item!=null) {

					setSelectedItem(item);

				}

			}

		});

	}

	public CharComboBox() {

		this(new String[]{" "}, true);

	}

	/**

	 * Returns the selected char, or null if the NoneItem is

	 * selected.

	 * @see javax.swing.JComboBox#getSelectedItem()

	 */

	public String getSelectedItem() {

		String item = (String) super.getSelectedItem();

		if (item!=null && item!=noneItem) {

			if (item.length()>0) {

				return item.substring(0, 1);

			}

			else {

				return " ";

			}

		}

		else {

			return null;

		}

	}

	// Ensure all the added items are Strings

	public void addItem(Object obj) {

		super.addItem(String.valueOf(obj));

	}

	/**

	 * Sets the text to show as the NoneItem. The text has to be

	 * provided in its localized form (if translations are in use).

	 * 

	 * @param text The localized text to show as the NoneItem

	 */

	public void setNoneItemText(String text) {

		noneItem = text;

	}

}

package org.gvsig.app.project.documents.layout.fframes.gui.numberFormat;

import java.awt.BorderLayout;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.text.DecimalFormat;

import java.text.DecimalFormatSymbols;

import javax.swing.JComboBox;

import javax.swing.JFrame;

import javax.swing.JLabel;

import org.gvsig.gui.beans.swing.GridBagLayoutPanel;

import org.gvsig.gui.beans.swing.JIncrementalNumberField;

import org.gvsig.gui.beans.swing.ValidatingTextField;

import org.gvsig.gui.beans.swing.ValidatingTextField.Cleaner;

import org.gvsig.gui.beans.swing.ValidatingTextField.Validator;

import org.gvsig.i18n.Messages;

/**

 * A panel to select the format for a decimal number. The following options are

 * offered:

 * <ul>

 * <li>The decimal separator character</li>

 * <li>The thousands separator character</li>

 * <li>The number of decimal digits. Note that this component forces the

 * maximum and minimum number of decimal digits (as defined in {@link DecimalFormat})

 * to be always equal.</li>

 * </ul>

 * 

 * @author Cesar Martinez Izquierdo

 */

public class DecimalFormatPanel extends GridBagLayoutPanel {

	private static final long serialVersionUID = 1L;

	public static final String INTEGER_BASE_PATTERN = "0";

	public static final String INTEGER_GROUPED_BASE_PATTERN = "#,###,###,###,###,###,##0";

	public static final String DECIMAL_BASE_PATTERN = "#0.";

	public static final String DECIMAL_GROUPED_BASE_PATTERN = "#,###,###,###,###,###,##0.";

	private DecimalFormat format;

	private CharComboBox cbDecimalSep = null;

	private CharComboBox cbThousandsSep = null;

	private JIncrementalNumberField tfDecimalDigits = null;

	private JLabel lbResult = null;

	private double testNumber = 123456789.00;

	private static final DecimalFormatSymbols defaultLocaleSymbols = DecimalFormatSymbols.getInstance();

	/**

	 * Creates and initializes the panel using the default format

	 *  for the current locale

	 */

	public DecimalFormatPanel() {

		this(new DecimalFormat());

	}

	/**

	 * Creates and initializes the panel using the provided

	 * DecimalFormat 

	 */

	public DecimalFormatPanel(DecimalFormat format) {

		super();

		initComponents();

		setFormat(format);

	}

	/**

	 * Creates and initializes the panel using the provided parameters

	 * 

	 * @param decimalSeparator The character used to separate the decimal part

	 * @param thousandsSeparator The character used to group thousands

	 * @param decimalDigits The number of decimal digits to show

	 * @param basePattern A base pattern used to create the DecimalFormat.

	 * Usually, one of {@link #INTEGER_BASE_PATTERN},

	 * {@link #INTEGER_GROUPED_BASE_PATTERN}, {@link #DECIMAL_BASE_PATTERN}

	 * or {@link #DECIMAL_GROUPED_BASE_PATTERN}.

	 * Any decimal digits in the pattern will be ignored (as they will be

	 * included depending on the <code>decimalDigits</code> parameter). The

	 * behavior of the component is undefined if a wrong pattern is provided

	 * 

	 * @see DecimalFormat

	 */

	public DecimalFormatPanel(char decimalSeparator, char thousandsSeparator, int decimalDigits, String basePattern) {

		super();

		initComponents();

		DecimalFormatSymbols sym = new DecimalFormatSymbols();

		sym.setDecimalSeparator(decimalSeparator);

		sym.setGroupingSeparator(thousandsSeparator);

		String pattern = getPattern(basePattern, decimalDigits);

		DecimalFormat f = new DecimalFormat(pattern, sym);

		setFormat(f);

	}

	protected void initComponents() {

		this.addComponent(Messages.getText("Decimal_separator"), getCbDecimalSep());

		this.addComponent(Messages.getText("Thousands_separator"), getCbThousandsSep());

		this.addComponent(Messages.getText("Decimal_digits"), getTfDecimalDigits());

		this.addComponent(Messages.getText("Result"), getLbTestResult());

	}

	private String getPattern(String basePattern, int decimalDigits) {

		int pos = basePattern.indexOf('.');

		if (pos>=0) {

			basePattern = basePattern.substring(0, pos+1);

		}

		if (decimalDigits>0) {

			return basePattern + String.format(("%1$0"+decimalDigits+"d"),0);

		}

		else {

			return basePattern;

		}

	}

	private CharComboBox getCbDecimalSep() {

		if (cbDecimalSep==null) {

			cbDecimalSep = new CharComboBox(new String[]{".", ","}, false);

			cbDecimalSep.addActionListener(new ActionListener() {

				public void actionPerformed(ActionEvent e) {

					if (e.getSource() instanceof CharComboBox) {

						DecimalFormatPanel.this.updateFormat(e.getSource());

					}

				}

			});

		}

		return cbDecimalSep;

	}

	private CharComboBox getCbThousandsSep() {

		if (cbThousandsSep==null) {

			cbThousandsSep = new CharComboBox(new String[]{",", ".", " "}, true);

			cbThousandsSep.addActionListener(new ActionListener() {

				public void actionPerformed(ActionEvent e) {

					if (e.getSource() instanceof CharComboBox) {

						DecimalFormatPanel.this.updateFormat(e.getSource());

					}

				}

			});

		}

		return cbThousandsSep;

	}

	protected void updateFormat(Object source) {

		// get selected values

		String thousandsSeparator = getCbThousandsSep().getSelectedItem();

		String decimalSeparator = getCbDecimalSep().getSelectedItem();

		int decimalDigits = getTfDecimalDigits().getInteger();

		boolean b_decimalSep, b_thousandsSep;

		DecimalFormatSymbols sym = format.getDecimalFormatSymbols();

		if (decimalSeparator!=null && decimalSeparator.length()>0) {

			sym.setDecimalSeparator(decimalSeparator.charAt(0));

			b_decimalSep = true;

		}

		else {

			b_decimalSep = false;

		}

		if (thousandsSeparator!=null && thousandsSeparator.length()>0) {

			sym.setGroupingSeparator(thousandsSeparator.charAt(0));

			b_thousandsSep = true;

		}

		else {

			b_thousandsSep = false;

		}

		// choose the right pattern

		String pattern = null;

		if (b_decimalSep && decimalDigits>0) {

			if (b_thousandsSep) {

				pattern = getPattern(DECIMAL_GROUPED_BASE_PATTERN, decimalDigits);

			}

			else {

				pattern = getPattern(DECIMAL_BASE_PATTERN, decimalDigits);

			}

		}

		else {

			if (b_thousandsSep) {

				pattern = INTEGER_GROUPED_BASE_PATTERN;

			}

			else {

				pattern = INTEGER_BASE_PATTERN;

			}

		}

		// update the format

		this.format = new DecimalFormat(pattern, sym);

		getLbTestResult().setText(this.format.format(testNumber));

		// set coherent options in UI

		if (source==getCbDecimalSep()) {

			if (!b_decimalSep) {

				// if no decimal separator is shown at all, we can't

				// have any decimal digit

				getTfDecimalDigits().setInteger(0);

			}	

		}

		else {

			if (decimalDigits>0 && !b_decimalSep) {

				selectItem(getCbDecimalSep(), String.valueOf(defaultLocaleSymbols.getDecimalSeparator()));

			}

		}

	}             

	private JIncrementalNumberField getTfDecimalDigits() {

		if (tfDecimalDigits==null) {

			Cleaner cleaner = ValidatingTextField.NUMBER_CLEANER;

			Validator validator = ValidatingTextField.INTEGER_VALIDATOR;

			tfDecimalDigits = new JIncrementalNumberField("Decimal digits", 2, validator, cleaner, 0.0d, 100.0d, 1.0);

			tfDecimalDigits.addActionListener(new ActionListener() {

				public void actionPerformed(ActionEvent e) {

					DecimalFormatPanel.this.updateFormat(e.getSource());

				}

			});

		}

		return tfDecimalDigits;

	}

	private JLabel getLbTestResult() {

		if (lbResult==null) {

			String text;

			lbResult = new JLabel();

		}

		return lbResult;

	}

	public DecimalFormat getFormat() {

		return format;

	}

	public void setFormat(DecimalFormat format) {

		this.format = format;

		getTfDecimalDigits().setInteger(format.getMinimumFractionDigits());

		String decSep = String.valueOf(format.getDecimalFormatSymbols().getDecimalSeparator());

		selectItem(getCbDecimalSep(), decSep);

		String thousandsSep = String.valueOf(format.getDecimalFormatSymbols().getGroupingSeparator());

		selectItem(getCbThousandsSep(), thousandsSep);

	}

	/**

	 * Adds the provided item to the combo if it is not already present,

	 * then selects it.

	 * 

	 * @param cb

	 * @param item

	 * @return

	 */

	private void selectItem(JComboBox cb, String item) {

		for (int i=0; i<cb.getItemCount(); i++) {

			if (cb.getItemAt(i).equals(item)) {

				cb.setSelectedItem(item);

				return;

			}

		}

		cb.addItem(item);

		cb.setSelectedItem(item);

	}

}