EDIT

// $Id$

/**

* Copyright (C) 2013 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.section;

import java.util.Collection;

import org.eclipse.jface.util.PropertyChangeEvent;

import org.eclipse.swt.SWT;

import org.eclipse.swt.widgets.Composite;

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

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.model.AbstractUtility;

import eu.etaxonomy.taxeditor.ui.element.AbstractCdmFormElementComposite;

import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;

import eu.etaxonomy.taxeditor.ui.element.CdmPropertyChangeEvent;

import eu.etaxonomy.taxeditor.ui.element.ICdmFormElement;

import eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement;

/**

 * @author pplitzner

 * @date 25.07.2013

 *

 */

public abstract class AbstractCdmDetailElementComposite<T> extends AbstractCdmFormElementComposite implements ICdmDetailElement<T>{

    private T entity;

    private boolean irrelevant;

    /**

     * <p>

     * Constructor for AbstractCdmDetailElement.

     * </p>

     *

     * @param formFactory

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

     *            object.

     * @param formElement

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

     *            object.

     * @param <T>

     *            a T object.

     */

    public AbstractCdmDetailElementComposite(Composite parent, FormToolkit formFactory, ICdmFormElement parentFormElement, int style) {

        super(parent, formFactory, parentFormElement, style);

        // register as property change listener

        if(formFactory instanceof CdmFormFactory){

            ((CdmFormFactory) formFactory).addPropertyChangeListener(this);

        }

    }

    /**

     * Sets the entity and updates controls

     *

     * @param entity

     *            a T object.

     */

    @Override

    public void setEntity(T entity) {

        this.entity = entity;

        updateContent();

    }

    /*

     * (non-Javadoc)

     *

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

     */

    /**

     * <p>

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

     * </p>

     *

     * @return a T object.

     */

    @Override

    public T getEntity() {

        return entity;

    }

    /**

     * Updates all widgets to display the latest data

     */

    protected void updateContent() {

        removeElements();

        createControls(this, entity, SWT.WRAP);

        getLayoutComposite().layout();

    }

    /*

     * (non-Javadoc)

     *

     * @see

     * eu.etaxonomy.taxeditor.forms.ISelectableComposite#setSelected(boolean)

     */

    /** {@inheritDoc} */

    @Override

    public void setSelected(boolean selected) {

        Composite section = getLayoutComposite().getParent();

        section.setBackground(selected ? SELECTED : getPersistentBackground());

    }

    /**

     * Sets all field to the given enablement state except the objects in

     * collection except

     *

     * @see eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement#setEnabled(boolean)

     * @param enabled

     *            a boolean.

     * @param except

     *            a {@link java.util.Collection} object.

     */

    public void setEnabled(boolean enabled, Collection<Object> except) {

        for (ICdmFormElement element : getElements()) {

            if (element instanceof IEnableableFormElement) {

                IEnableableFormElement enableableElement = (IEnableableFormElement) element;

                if (except != null && except.contains(enableableElement)) {

                    // enableableElement.setEnabled(enabled);

                } else {

                    enableableElement.setEnabled(enabled);

                }

            }

        }

    }

    /**

     * <p>

     * Setter for the field <code>irrelevant</code>.

     * </p>

     *

     * @param irrelevant

     *            a boolean.

     * @param except

     *            a {@link java.util.Collection} object.

     */

    public void setIrrelevant(boolean irrelevant, Collection<Object> except) {

        // logger.warn("Setting " + this.getClass().getSimpleName() +

        // " to irrelevant state: " + irrelevant);

        for (ICdmFormElement element : getElements()) {

            if (element instanceof IEnableableFormElement) {

                IEnableableFormElement relevantElement = (IEnableableFormElement) element;

                if (except != null && except.contains(relevantElement)) {

                    // do nothing

                    // logger.warn("not setting elements irrelevance: " +

                    // relevantElement.getClass().getSimpleName() + " in :" +

                    // this.getClass().getSimpleName());

                } else {

                    relevantElement.setIrrelevant(irrelevant);

                }

            }

        }

    }

    /** {@inheritDoc} */

    @Override

    public void setEnabled(boolean enabled) {

        setEnabled(enabled, null);

    }

    /** {@inheritDoc} */

    @Override

    public void setIrrelevant(boolean irrelevant) {

        this.irrelevant = irrelevant;

        setIrrelevant(irrelevant, null);

    }

    /**

     * Create all content elements

     *

     * @param formElement

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

     *            object.

     * @param entity

     *            a T object.

     * @param style

     *            a int.

     */

    protected abstract void createControls(ICdmFormElement formElement, T entity, int style);

    /** {@inheritDoc} */

    @Override

    public void propertyChange(PropertyChangeEvent event) {

        if (event == null) {

            return;

        }

        handleTitleCacheRelevantChange(event);

        Object eventSource = event.getSource();

        if (eventSource instanceof ICdmFormElement) {

            ICdmFormElement eventElement = (ICdmFormElement) eventSource;

            ICdmFormElement eventElementContainer = eventElement

                    .getParentElement();

            if (eventElementContainer == this) {

                if (event instanceof CdmPropertyChangeEvent) {

                    if (((CdmPropertyChangeEvent) event).hasException()) {

                        handleException((CdmPropertyChangeEvent) event);

                        return;

                    }

                }

                // call specific handler implementation

                handleEvent(eventSource);

                // refire the event

                firePropertyChangeEvent(this, event);

                // update possible parents

                updateParentSection();

            }

        }

    }

    protected void handleTitleCacheRelevantChange(PropertyChangeEvent event) {

        //FIXME uncomment

//        boolean isRelevant = getEntity() instanceof TaxonNameBase

//                || getEntity() instanceof TaxonBase;

//        isRelevant &= this instanceof AbstractIdentifiableEntityDetailElement;

//

//        if (isRelevant) {

//            ((AbstractIdentifiableEntityDetailElement) this)

//                    .updateToggleableCacheField();

//            updateParentSection();

//        }

    }

    private void updateParentSection() {

        if (getParentElement() instanceof AbstractCdmDetailSection) {

            ((AbstractCdmDetailSection) getParentElement()).updateTitle();

        }

    }

    /**

     * Gets called when the source of the event is a child widget of this

     * widget.

     *

     * @param eventSource

     *            a {@link java.lang.Object} object.

     */

    public abstract void handleEvent(Object eventSource);

    /**

     * <p>

     * handleException

     * </p>

     *

     * @param event

     *            a

     *            {@link eu.etaxonomy.taxeditor.ui.element.CdmPropertyChangeEvent}

     *            object.

     */

    public void handleException(CdmPropertyChangeEvent event) {

        // override this in subclasses if you want to deal with the error

        AbstractUtility.error(event.getSource().getClass(), event.getException());

    }

    /**

     * <p>

     * isIrrelevant

     * </p>

     *

     * @return a boolean.

     */

    public boolean isIrrelevant() {

        return irrelevant;

    }

    /**

     * <p>

     * getConversationHolder

     * </p>

     *

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

     *         object.

     */

    @Override

    public ConversationHolder getConversationHolder() {

        if (getParentElement() instanceof IConversationEnabled) {

            return ((IConversationEnabled) getParentElement())

                    .getConversationHolder();

        }

        throw new IllegalArgumentException(

                "Parent element should be IConversationEnabled");

    }

    /** {@inheritDoc} */

    @Override

    public void update(CdmDataChangeMap changeEvents) {

    }

}