EDIT

// $Id$

/**

* Copyright (C) 2007 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.taxeditor.ui.element;

import java.util.HashSet;

import java.util.Set;

import org.eclipse.swt.SWT;

import org.eclipse.swt.events.KeyAdapter;

import org.eclipse.swt.events.KeyEvent;

import org.eclipse.swt.events.ModifyEvent;

import org.eclipse.swt.events.ModifyListener;

import org.eclipse.swt.events.SelectionEvent;

import org.eclipse.swt.events.SelectionListener;

import org.eclipse.swt.graphics.Color;

import org.eclipse.swt.widgets.Button;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Label;

import org.eclipse.swt.widgets.Text;

import eu.etaxonomy.taxeditor.model.ImageResources;

import eu.etaxonomy.taxeditor.preference.Resources;

import eu.etaxonomy.taxeditor.store.StoreUtil;

/**

 * When the button is pressed, this textfield may be edited.

 *

 * @author n.hoffmann

 * @created Nov 18, 2009

 * @version 1.0

 */

public class ToggleableTextElement extends AbstractCdmFormElement implements SelectionListener, ModifyListener, IEnableableFormElement, ISelectable {

	private final Text text_cache;

	private final Button button_toggle;

	private boolean state;

	private final Set<SelectionListener> selectionListener = new HashSet<SelectionListener>();

	private final Label label;

	private final Composite container;

	/**

	 * <p>Constructor for ToggleableTextElement.</p>

	 *

	 * @param style a int.

	 * @param formFactory a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.

	 * @param parentElement a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.

	 * @param labelString a {@link java.lang.String} object.

	 * @param initialText a {@link java.lang.String} object.

	 * @param initialState a boolean.

	 */

	protected ToggleableTextElement(CdmFormFactory formFactory, ICdmFormElement parentElement,

			String labelString, String initialText, boolean initialState, int style) {

		super(formFactory, parentElement);

		label = formFactory.createLabel(getLayoutComposite(), labelString, style);

		addControl(label);

		container = formFactory.createComposite(getLayoutComposite(), SWT.WRAP);

		container.setLayout(LayoutConstants.LAYOUT(2, false));

		container.setLayoutData(LayoutConstants.FILL_HORIZONTALLY());

		addControl(container);

		text_cache = formFactory.createText(container, initialText, SWT.WRAP | SWT.MULTI);

		addControl(text_cache);

		text_cache.addModifyListener(this);

		text_cache.setLayoutData(LayoutConstants.FILL());

		// Don't accept carriage returns as input

		text_cache.addKeyListener( new KeyAdapter(){

			@Override

			public void keyPressed(KeyEvent e) {

			if(e.character == SWT.CR) {

                e.doit = false;

            }

			}

		});

		button_toggle = formFactory.createButton(container, "Edit", SWT.TOGGLE);

		button_toggle.setText("");

		button_toggle.setImage(ImageResources.getImage(ImageResources.LOCK_ICON));

		addControl(button_toggle);

		button_toggle.addSelectionListener(this);

		setState(initialState);

	}

	/**

	 * <p>setText</p>

	 *

	 * @param text a {@link java.lang.String} object.

	 */

	public void setText(String text){

		if(text != null){

			// store current caret position

			int caretPosition = text_cache.getCaretPosition();

			text_cache.removeModifyListener(this);

			text_cache.setText(text);

			text_cache.addModifyListener(this);

			// restore caret position

			text_cache.setSelection(caretPosition);

		}

	}

	/**

	 * <p>getText</p>

	 *

	 * @return a {@link java.lang.String} object.

	 */

	public String getText(){

		return text_cache.getText();

	}

	/**

	 * <p>Setter for the field <code>state</code>.</p>

	 *

	 * @param state a boolean.

	 */

	public void setState(boolean state) {

	    if(state){

	        button_toggle.setImage(ImageResources.getImage(ImageResources.LOCK_OPEN_ICON));

	    }

	    else{

	        button_toggle.setImage(ImageResources.getImage(ImageResources.LOCK_ICON));

	    }

		this.state = state;

		setEnabled(state);

	}

	/** {@inheritDoc} */

	@Override

    public void setEnabled(boolean enabled) {

		text_cache.setEnabled(enabled);

		String symbolicName = enabled ? Resources.COLOR_FONT_DEFAULT : Resources.COLOR_TEXT_DISABLED;

		text_cache.setForeground(StoreUtil.getColor(symbolicName));

		button_toggle.setSelection(enabled);

	}

	/**

	 * <p>Getter for the field <code>state</code>.</p>

	 *

	 * @return a boolean.

	 */

	public boolean getState(){

		return state;

	}

	/* (non-Javadoc)

	 * @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent)

	 */

	/** {@inheritDoc} */

	@Override

    public void widgetSelected(SelectionEvent e) {

		setState(button_toggle.getSelection());

		for(SelectionListener listener : selectionListener){

			listener.widgetSelected(e);

		}

		firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e));

	}

	/**

	 * <p>addSelectionListener</p>

	 *

	 * @param listener a {@link org.eclipse.swt.events.SelectionListener} object.

	 */

	public void addSelectionListener(SelectionListener listener){

		selectionListener.add(listener);

	}

	/**

	 * <p>removeSelectionListener</p>

	 *

	 * @param listener a {@link org.eclipse.swt.events.SelectionListener} object.

	 */

	public void removeSelectionListener(SelectionListener listener){

		selectionListener.remove(listener);

	}

	/** {@inheritDoc} */

	@Override

    public void widgetDefaultSelected(SelectionEvent e) {}

	/** {@inheritDoc} */

	@Override

    public void modifyText(ModifyEvent e) {

		firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e));

	}

	/** {@inheritDoc} */

	@Override

    public void setIrrelevant(boolean irrelevant) {

		String colorId = irrelevant ? Resources.COLOR_COMPOSITE_IRRELEVANT : Resources.COLOR_COMPOSITE_BACKGROUND;

		Color color = getColor(colorId);

		text_cache.setBackground(color);

	}

	/** {@inheritDoc} */

	@Override

	public void setBackground(Color color) {

		label.setBackground(color);

		container.setBackground(color);

	}

	@Override

	public void setSelected(boolean selected) {

		setBackground(selected ? SELECTED : getPersistentBackground());

	}

}