EDIT

/**

 * 

 */

package eu.etaxonomy.taxeditor.ui.forms;

import java.util.ConcurrentModificationException;

import java.util.HashSet;

import java.util.List;

import java.util.Set;

import org.eclipse.core.runtime.Assert;

import org.eclipse.jface.util.IPropertyChangeListener;

import org.eclipse.jface.util.PropertyChangeEvent;

import org.eclipse.jface.viewers.ISelectionChangedListener;

import org.eclipse.jface.viewers.ISelectionProvider;

import org.eclipse.jface.viewers.IStructuredSelection;

import org.eclipse.jface.viewers.SelectionChangedEvent;

import org.eclipse.jface.viewers.StructuredSelection;

import org.eclipse.swt.SWT;

import org.eclipse.swt.events.SelectionEvent;

import org.eclipse.swt.events.SelectionListener;

import org.eclipse.swt.graphics.Color;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Control;

import org.eclipse.swt.widgets.Display;

import org.eclipse.swt.widgets.TypedListener;

import org.eclipse.swt.widgets.Widget;

import org.eclipse.ui.forms.widgets.Section;

import org.eclipse.ui.forms.widgets.TableWrapLayout;

import org.eclipse.ui.forms.widgets.ToggleHyperlink;

import eu.etaxonomy.cdm.api.conversation.ConversationHolder;

import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;

import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;

import eu.etaxonomy.taxeditor.store.StoreUtil;

import eu.etaxonomy.taxeditor.ui.selection.AbstractSelectionElement;

import eu.etaxonomy.taxeditor.ui.term.AbstractEnumComboElement;

import eu.etaxonomy.taxeditor.ui.term.AbstractTermComboElement;

/**

 * <p>Abstract AbstractFormSection class.</p>

 *

 * @author n.hoffmann

 * @created Feb 22, 2010

 * @version 1.0

 * @param <T>

 */

public abstract class AbstractFormSection<ENTITY> extends Section implements ISelectionChangedListener, IEntityElement<ENTITY>, IConversationEnabled{

	private ISelectionProvider selectionProvider;

	private ENTITY entity; 

	private Set<ICdmFormElement> elements = new HashSet<ICdmFormElement>();

	protected CdmFormFactory formFactory;

	private List<IPropertyChangeListener> propertyChangeListeners;

	private ICdmFormElement parentElement;

	private ConversationHolder conversation;

	private boolean handlingPropertyChange;

	/**

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

	 *

	 * @param conversation TODO

	 * @param style a int.

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

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

	 * @param <ENTITY> a ENTITY object.

	 */

	protected AbstractFormSection(CdmFormFactory formFactory, ConversationHolder conversation, ICdmFormElement parentElement, int style) {

		super(parentElement.getLayoutComposite(), style);

		this.parentElement = parentElement;

		this.formFactory = formFactory;

		this.conversation = conversation;

		this.setLayoutData(CdmFormFactory.FILL());

		Composite client = formFactory.createComposite(this, SWT.WRAP);

		client.setBackgroundMode(SWT.INHERIT_DEFAULT);

		TableWrapLayout layout = CdmFormFactory.LAYOUT();

		layout.bottomMargin = 10;

		layout.rightMargin = 5;

		client.setLayout(layout);

		this.setClient(client);

	}

	/**

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

	 *

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

	 * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.

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

	 * @param selectionProvider a {@link org.eclipse.jface.viewers.ISelectionProvider} object.

	 * @param style a int.

	 */

	protected AbstractFormSection(CdmFormFactory formFactory, ConversationHolder conversation, ICdmFormElement parentElement, ISelectionProvider selectionProvider, int style){

		this(formFactory, conversation, parentElement, style);

		this.selectionProvider = selectionProvider;

	}

	/**

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

	 *

	 * @return a {@link java.util.Set} object.

	 */

	public List<IPropertyChangeListener> getPropertyChangeListeners() {

		return propertyChangeListeners;

	}

	/** {@inheritDoc} */

	public void setPropertyChangeListeners(

			List<IPropertyChangeListener> propertyChangeListeners) {

		this.propertyChangeListeners = propertyChangeListeners;

	}

	/**

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

	 *

	 * @param entity a ENTITY object.

	 */

	public void setEntity(ENTITY entity){

		this.entity = entity;

	}

	/*

	 * (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.forms.IEntityElement#getEntity()

	 */

	/**

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

	 *

	 * @return a ENTITY object.

	 */

	public ENTITY getEntity() {

		return entity;

	}

	/**

	 * <p>getToggle</p>

	 *

	 * @return a {@link org.eclipse.ui.forms.widgets.ToggleHyperlink} object.

	 */

	public ToggleHyperlink getToggle(){

		return this.toggle;

	}

	/**

	 * <p>getSection</p>

	 *

	 * @return a {@link eu.etaxonomy.taxeditor.ui.forms.AbstractFormSection} object.

	 */

	public AbstractFormSection<ENTITY> getSection(){

		return this;

	}	

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.forms.IPropertyChangeEmitter#firePropertyChangeEvent()

	 */

	/** {@inheritDoc} */

	public void firePropertyChangeEvent(CdmPropertyChangeEvent event) {

		Assert.isNotNull(propertyChangeListeners, "No property change listeners.");

		try{

			for(Object listener : propertyChangeListeners){

				((IPropertyChangeListener) listener).propertyChange(event);

			}

		}catch(ConcurrentModificationException e){

			StoreUtil.warn(getClass(), "ConcurrentModificationException while handling PropertyChangeEvents." +

					" It seems like this is not critical");

		}

	}

	/* (non-Javadoc)

	 * @see org.eclipse.swt.widgets.Composite#setFocus()

	 */

	/** {@inheritDoc} */

	@Override

	public boolean setFocus() {

		return getClient().setFocus();

	}

	/* (non-Javadoc)

	 * @see org.eclipse.jface.util.IPropertyChangeListener#propertyChange(org.eclipse.jface.util.PropertyChangeEvent)

	 */

	/** {@inheritDoc} */

	public void propertyChange(PropertyChangeEvent event) {

		firePropertyChangeEvent(new CdmPropertyChangeEvent(this, event));

	}

	/* (non-Javadoc)

	 * @see org.eclipse.swt.widgets.Control#setBackground(org.eclipse.swt.graphics.Color)

	 */

	/** {@inheritDoc} */

	@Override

	public void setBackground(Color color) {

		for(ICdmFormElement element : getElements()){

			element.setBackground(color);

		}

		getLayoutComposite().setBackground(color);

		super.setBackground(color);

	}

	/**

	 * <p>widgetSelected</p>

	 *

	 * @param e a {@link org.eclipse.swt.events.SelectionEvent} object.

	 */

	public void widgetSelected(SelectionEvent e) {

		Widget widget = e.widget;

		if(widget instanceof Control){

			Control control = (Control) widget;

			if(checkControlAncestryForWidget(control)){

				if(getEntity() != null){

					IStructuredSelection selection = new StructuredSelection(getEntity());

					if(selectionProvider != null){

						selectionProvider.setSelection(selection);

					}

				}

			}

		}	

	}

	private boolean checkControlAncestryForWidget(Control control){

		if(control.equals(this)){

			return true;

		}else{

			Control parent = control.getParent();

			if(parent == null){

				return false;

			}else{

				return checkControlAncestryForWidget(parent);

			}

		}

	}

	/** {@inheritDoc} */

	public void setSelected(boolean selected) {

		if(selected){

			setBackground(Display.getCurrent().getSystemColor(SWT.COLOR_LIST_SELECTION));

		}else{

			setBackground(Display.getCurrent().getSystemColor(SWT.COLOR_WHITE));

		}

	}

	/** {@inheritDoc} */

	public void selectionChanged(SelectionChangedEvent event) {

		if(event.getSelection() == CdmFormFactory.EMPTY_SELECTION){

			return;

		}

		IStructuredSelection selection = (IStructuredSelection) event.getSelection();

		setSelected(false);

		Object selectedObject =  selection.getFirstElement();

		if(selectedObject != null && selectedObject.equals(getEntity())){

			setSelected(true);

		}

	}

	/**

	 * <p>addSelectionListener</p>

	 *

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

	 */

	public void addSelectionListener(SelectionListener listener) {

		addListener(SWT.Selection, new TypedListener(listener));

	}

	/**

	 * <p>removeSelectionListener</p>

	 *

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

	 */

	public void removeSelectionListener(SelectionListener listener) {

		removeListener(SWT.Selection, listener);

	}

	/** {@inheritDoc} */

	public Color getColor(boolean selected) {

		return selected ? SELECTED : NOT_SELECTED;

	}

	/** {@inheritDoc} */

	public void addElement(ICdmFormElement element){

		elements.add(element);

	}

	/**

	 * <p>removeElement</p>

	 *

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

	 */

	protected void removeElement(ICdmFormElement element){

		elements.remove(element);

	}

	/**

	 * <p>removeElements</p>

	 */

	public void removeElements() {

		for(ICdmFormElement childElement : getElements()){

			// recursion

			childElement.removeElements();

			// unregister selection arbitrator

			if(childElement instanceof ISelectableElement){

				ISelectableElement selectableElement = (ISelectableElement) childElement;

				if (selectableElement != null && selectableElement.getSelectionArbitrator() != null) {

					formFactory.destroySelectionArbitrator(selectableElement.getSelectionArbitrator());

				}

			}

			// unregister propertyChangeListener

			formFactory.removePropertyChangeListener(childElement);

			// dispose of the controls

			for(Control control : childElement.getControls()){

				// we added the layoutComposite of the parental element as the layout composite to this formElement

				// but we do not want to destroy it.

				if(control.equals(childElement.getLayoutComposite())){

					continue;

				}else{

					control.dispose();

					control = null;

				}

			}

		}

		elements.clear();

	}

	/**

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

	 *

	 * @return a {@link eu.etaxonomy.taxeditor.ui.forms.ICdmFormElement} object.

	 */

	public ICdmFormElement getParentElement() {

		return parentElement;

	}

	/**

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

	 *

	 * @return a {@link java.util.Set} object.

	 */

	public Set<ICdmFormElement> getElements() {

		return elements;

	}

	/**

	 * <p>getControls</p>

	 *

	 * @return a {@link java.util.Set} object.

	 */

	public Set<Control> getControls() {

		Set<Control> controls = new HashSet<Control>();

		for (Control control : getChildren()){

			controls.add(control);

		}

		return controls; 

	}

	/** {@inheritDoc} */

	@Override

	public void dispose() {

		removeElements();

		super.dispose();

	}

	/**

	 * <p>getLayoutComposite</p>

	 *

	 * @return a {@link org.eclipse.swt.widgets.Composite} object.

	 */

	public Composite getLayoutComposite() {

		return (Composite) getClient();

	}

	/** {@inheritDoc} */

	public boolean containsFormElement(ICdmFormElement formElement){

		if(formElement == this){

			return true;

		}else{

			for(ICdmFormElement element : getElements()){				

				boolean contains = element.containsFormElement(formElement);

				if(contains == true){

					return true;

				}

			}

			return false;

		}

	}

	/**

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

	 *

	 * @return a {@link eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory} object.

	 */

	public CdmFormFactory getFormFactory() {

		return formFactory;

	}

	/*

	 * (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.forms.ICdmFormElement#refresh()

	 */

	/**

	 * <p>refresh</p>

	 */

	public void refresh() {

		// empty default implementation

	}

	/**

	 * <p>getConversationHolder</p>

	 *

	 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.

	 */

	public ConversationHolder getConversationHolder() {

		return conversation;

	}

	/** {@inheritDoc} */

	public void update(CdmDataChangeMap changeEvents) {}

}