// $Header: /home/cvs/jakarta-jmeter/src/core/org/apache/jmeter/testbeans/gui/FieldStringEditor.java,v 1.4 2004/02/10 21:24:01 jsalvata Exp $
/*
 * Copyright 2003-2004 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.jmeter.testbeans.gui;

import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.beans.PropertyEditorSupport;

import javax.swing.JTextField;

import org.apache.jorphan.logging.LoggingManager;
import org.apache.log.Logger;

/**
 * This class implements a property editor for non-null String properties
 * that supports custom editing (i.e.: provides a GUI component) based
 * on a text field.
 * 

 * The provided GUI is a simple text field.
 * 
 * @author Jordi Salvat i Alabart
 * @version $Revision: 1.4 $ updated on $Date: 2004/02/10 21:24:01 $
 */
class FieldStringEditor extends PropertyEditorSupport
	implements ActionListener, FocusListener
{
	protected static Logger log= LoggingManager.getLoggerForClass();

	/**
	 * This will hold the text editing component, either a plain JTextField
	 * (in cases where the combo box would not have other options
	 * than 'Edit'), or the text editing component in the combo box.  
	 */
	private JTextField textField;

    /**
     * Value on which we started the editing. Used to avoid firing
     * PropertyChanged events when there's not been such change.
     */
    private String initialValue= "";

    protected FieldStringEditor()
    {
    	super();

		textField= new JTextField();
		textField.addActionListener(this);
		textField.addFocusListener(this);
    }

	public String getAsText()
	{
		return textField.getText();
	}
	
	public void setAsText(String value)
	{
        initialValue= value;
		textField.setText(value);
	}
	
	public Object getValue()
	{
		return getAsText();
	}
	
	public void setValue(Object value)
	{
		if (value instanceof String) setAsText((String)value);
		else throw new IllegalArgumentException();
	}
	
    /* (non-Javadoc)
     * @see java.beans.PropertyEditor#getCustomEditor()
     */
    public Component getCustomEditor()
    {
		return textField;
    }

    /* (non-Javadoc)
     * Avoid needlessly firing PropertyChanged events.
     */
    public void firePropertyChange()
    {
        String newValue= getAsText();

        if (initialValue.equals(newValue)) return;
        initialValue= newValue;

        super.firePropertyChange();
    }

	/* (non-Javadoc)
	 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
	 */
	public void actionPerformed(ActionEvent e)
    {
        firePropertyChange();
    }
    
	/* (non-Javadoc)
	 * @see java.awt.event.FocusListener#focusGained(java.awt.event.FocusEvent)
	 */
	public void focusGained(FocusEvent e)
	{
	}

	/* (non-Javadoc)
	 * @see java.awt.event.FocusListener#focusLost(java.awt.event.FocusEvent)
	 */
	public void focusLost(FocusEvent e)
	{
		firePropertyChange();
	}
	
	public static class Test extends junit.framework.TestCase
	{
		public Test(String name)
		{
			super(name);
		}

		private void testSetGet(ComboStringEditor e, Object value) throws Exception
		{
			e.setValue(value);
			assertEquals(value, e.getValue());
		}
		private void testSetGetAsText(ComboStringEditor e, String text) throws Exception
		{
			e.setAsText(text);
			assertEquals(text, e.getAsText());
		}
		public void testSetGet() throws Exception
		{
			ComboStringEditor e= new ComboStringEditor();
				
			testSetGet(e, "any string");
			testSetGet(e, "");
			testSetGet(e, "${var}");
		}
		public void testSetGetAsText() throws Exception
		{
			ComboStringEditor e= new ComboStringEditor();
				
			testSetGetAsText(e, "any string");
			testSetGetAsText(e, "");
			testSetGetAsText(e, "${var}");
		}
	}
}