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.3 2007/11/02 17:50:36 taqua 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    
044    package org.jfree.ui;
045    
046    import java.awt.Insets;
047    import java.util.ResourceBundle;
048    import javax.swing.JTextField;
049    
050    /**
051     * A JTextField for displaying insets.
052     *
053     * @author Andrzej Porebski
054     */
055    public class InsetsTextField extends JTextField {
056    
057        /** The resourceBundle for the localization. */
058        protected static ResourceBundle localizationResources = 
059            ResourceBundle.getBundle("org.jfree.ui.LocalizationBundle");
060    
061        /**
062         * Default constructor. Initializes this text field with formatted string describing
063         * provided insets.
064         *
065         * @param insets  the insets.
066         */
067        public InsetsTextField(final Insets insets) {
068            super();
069            setInsets(insets);
070            setEnabled(false);
071        }
072    
073        /**
074         * Returns a formatted string describing provided insets.
075         *
076         * @param insets  the insets.
077         *
078         * @return the string.
079         */
080        public String formatInsetsString(Insets insets) {
081            insets = (insets == null) ? new Insets(0, 0, 0, 0) : insets;
082            return
083                localizationResources.getString("T") + insets.top + ", "
084                 + localizationResources.getString("L") + insets.left + ", "
085                 + localizationResources.getString("B") + insets.bottom + ", "
086                 + localizationResources.getString("R") + insets.right;
087        }
088    
089        /**
090         * Sets the text of this text field to the formatted string
091         * describing provided insets. If insets is null, empty insets
092         * (0,0,0,0) are used.
093         *
094         * @param insets  the insets.
095         */
096        public void setInsets(final Insets insets) {
097            setText(formatInsetsString(insets));
098        }
099    
100    }