001/* ========================================================================
002 * JCommon : a free general purpose class library for the Java(tm) platform
003 * ========================================================================
004 *
005 * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
006 * 
007 * Project Info:  http://www.jfree.org/jcommon/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it 
010 * under the terms of the GNU Lesser General Public License as published by 
011 * the Free Software Foundation; either version 2.1 of the License, or 
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but 
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
022 * USA.  
023 *
024 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
025 * in the United States and other countries.]
026 * 
027 * --------------------
028 * InsetsTextField.java
029 * --------------------
030 * (C) Copyright 2000-2004, by Andrzej Porebski.
031 *
032 * Original Author:  Andrzej Porebski;
033 * Contributor(s):   Arnaud Lelievre;
034 *
035 * $Id: InsetsTextField.java,v 1.2 2005/10/18 13:18:34 mungady Exp $
036 *
037 * Changes (from 7-Nov-2001)
038 * -------------------------
039 * 07-Nov-2001 : Added to com.jrefinery.ui package (DG);
040 * 08-Sep-2003 : Added internationalization via use of properties resourceBundle (RFE 690236) (AL);
041 *
042 */
043
044package org.jfree.ui;
045
046import java.awt.Insets;
047import java.util.ResourceBundle;
048
049import javax.swing.JTextField;
050
051/**
052 * A JTextField for displaying insets.
053 *
054 * @author Andrzej Porebski
055 */
056public class InsetsTextField extends JTextField {
057
058    /** The resourceBundle for the localization. */
059    protected static ResourceBundle localizationResources = 
060        ResourceBundle.getBundle("org.jfree.ui.LocalizationBundle");
061
062    /**
063     * Default constructor. Initializes this text field with formatted string describing
064     * provided insets.
065     *
066     * @param insets  the insets.
067     */
068    public InsetsTextField(final Insets insets) {
069        super();
070        setInsets(insets);
071        setEnabled(false);
072    }
073
074    /**
075     * Returns a formatted string describing provided insets.
076     *
077     * @param insets  the insets.
078     *
079     * @return the string.
080     */
081    public String formatInsetsString(Insets insets) {
082        insets = (insets == null) ? new Insets(0, 0, 0, 0) : insets;
083        return
084            localizationResources.getString("T") + insets.top + ", "
085             + localizationResources.getString("L") + insets.left + ", "
086             + localizationResources.getString("B") + insets.bottom + ", "
087             + localizationResources.getString("R") + insets.right;
088    }
089
090    /**
091     * Sets the text of this text field to the formatted string
092     * describing provided insets. If insets is null, empty insets
093     * (0,0,0,0) are used.
094     *
095     * @param insets  the insets.
096     */
097    public void setInsets(final Insets insets) {
098        setText(formatInsetsString(insets));
099    }
100
101}