com.nqadmin.swingset.formatting.SSCurrencyFormatterFactory Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (C) 2003-2021, Prasanth R. Pasala, Brian E. Pangburn, & The Pangburn Group
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * 3. Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * Contributors:
 *   Prasanth R. Pasala
 *   Brian E. Pangburn
 *   Diego Gil
 *   Man "Bee" Vo
 *   Ernie R. Rael
 ******************************************************************************/
package com.nqadmin.swingset.formatting;

import java.text.NumberFormat;
import java.util.Locale;

import javax.swing.text.NumberFormatter;

// SSCurrencyFormatterFactory.java
//
// SwingSet - Open Toolkit For Making Swing Controls Database-Aware

/**
 * SSCurrencyFormatterFactory extends DefaultFormatterFactory for US Currency fields.
 */
public class SSCurrencyFormatterFactory extends javax.swing.text.DefaultFormatterFactory {

    /**
	 * unique serial id
	 */
	private static final long serialVersionUID = -3893270430611620113L;

	/**
     *  SSCurrencyFormatterFactory constructor, without arguments.
     *  Creates a SSCurrencyFormatter with default Locale
     */
    public SSCurrencyFormatterFactory() {
    	this(null,null,null,null);
    }

    /**
     * Creates SSCurrencyFormatterFactory object with the specified precision and decimals
     * @param _precision - number of digits needed in the integer portion of the number
     * @param _decimals - number of digits needed in the fraction portion of the number
     */
    public SSCurrencyFormatterFactory(final Integer _precision, final Integer _decimals) {
    	this(_precision,_decimals,null,null);
    }

    /**
     * Creates SSCurrencyFormatterFactory object with the specified precision, decimals, editor locale and display locale
     * @param _precision - number of digits needed in the integer portion of the number
     * @param _decimals - number of digits needed in the fraction portion of the number
     * @param _editorLocale  - locale to be used by the editor
     * @param _displayLocale - locale to be used while displaying number
     */
    public SSCurrencyFormatterFactory(final Integer _precision, final Integer _decimals, final Locale _editorLocale, final Locale _displayLocale) {
    	super();
    	
    	NumberFormat editorFormat;
    	if (_editorLocale==null) {
    		// May want to use US for default: NumberFormat.getCurrencyInstance(Locale.US);
    		editorFormat = NumberFormat.getInstance();
    	} else {
    		editorFormat = NumberFormat.getInstance(_editorLocale);
    	}
    	
    	NumberFormat displayFormat;
    	if (_displayLocale==null) {
    		// May want to use US for default: NumberFormat.getCurrencyInstance(Locale.US);
    		displayFormat = NumberFormat.getCurrencyInstance();
    	} else {
    		displayFormat = NumberFormat.getCurrencyInstance(_displayLocale);
    	}
    	
    	if (_precision!=null) {
    		editorFormat.setMaximumIntegerDigits(_precision);
    		editorFormat.setMinimumIntegerDigits(1);
    		
    		displayFormat.setMaximumIntegerDigits(_precision);
    		displayFormat.setMinimumIntegerDigits(1);
    	}
    	
    	if (_decimals!=null) {
    		editorFormat.setMaximumFractionDigits(_decimals);
    		editorFormat.setMinimumFractionDigits(_decimals);
    		
    		displayFormat.setMaximumFractionDigits(_decimals);
    		displayFormat.setMinimumFractionDigits(_decimals);
    	}
    	
    	// TODO Consider using displayFormat for setDefaultFormatter()
    	setDefaultFormatter(new NumberFormatter(NumberFormat.getCurrencyInstance()));
        setNullFormatter(null);
    	
    	setEditFormatter(new NumberFormatter(editorFormat));
    	setDisplayFormatter(new NumberFormatter(displayFormat));

    }

}