/*
 * TextFieldHandler.java
 * Copyright 2011 Connor Petty <cpmeister@users.sourceforge.net>
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 * 
 * Created on Oct 1, 2011, 4:48:35 PM
 */
package pcgen.gui2.tabs.models;

import javax.swing.JTextField;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;

import pcgen.facade.util.ReferenceFacade;
import pcgen.facade.util.event.ReferenceEvent;
import pcgen.facade.util.event.ReferenceListener;

/**
 *
 * @author Connor Petty <cpmeister@users.sourceforge.net>
 */
public abstract class TextFieldHandler implements DocumentListener, ReferenceListener<String>
{

	private JTextField textField;
	private ReferenceFacade<String> ref;

	public TextFieldHandler(JTextField textField, ReferenceFacade<String> ref)
	{
		this.textField = textField;
		this.ref = ref;
	}

	public JTextField getTextField()
	{
		return textField;
	}

	/**
	 * Attach the handler to the screen field. e.g. When the character is
	 * made active.
	 */
	public void install()
	{
		textField.setText(ref.get());
		textField.getDocument().addDocumentListener(this);
		ref.addReferenceListener(this);
	}

	/**
	 * Detach the handler from the on screen field. e.g. when the
	 * character is no longer being displayed.
	 */
	public void uninstall()
	{
		textField.getDocument().removeDocumentListener(this);
		ref.removeReferenceListener(this);
	}

	@Override
	public void referenceChanged(ReferenceEvent<String> e)
	{
		if (!textField.getText().equals(e.getNewReference()))
		{
			//This is done to prevent an event feedback loop since
			//setText modifies the document we are listening to.
			textField.getDocument().removeDocumentListener(this);
			textField.setText(e.getNewReference());
			textField.getDocument().addDocumentListener(this);
		}
	}

	protected abstract void textChanged(String text);

	@Override
	public void insertUpdate(DocumentEvent e)
	{
		textChanged(textField.getText());
	}

	@Override
	public void removeUpdate(DocumentEvent e)
	{
		textChanged(textField.getText());
	}

	@Override
	public void changedUpdate(DocumentEvent e)
	{
		textChanged(textField.getText());
	}

}