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.section.name;

import java.util.Arrays;

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

import eu.etaxonomy.cdm.model.name.NomenclaturalCode;

import eu.etaxonomy.cdm.model.name.NonViralName;

import eu.etaxonomy.taxeditor.preference.IPreferenceKeys;

import eu.etaxonomy.taxeditor.preference.PreferencesUtil;

import eu.etaxonomy.taxeditor.ui.combo.EnumComboElement;

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

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

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

import eu.etaxonomy.taxeditor.ui.section.AbstractCdmDetailSection;

import eu.etaxonomy.taxeditor.ui.section.AbstractIdentifiableEntityDetailElement;

/**

 * @author n.hoffmann

 * @created May 20, 2010

 * @version 1.0

 */

public class NonViralNameDetailElement extends

	AbstractIdentifiableEntityDetailElement<NonViralName> {

	private NameDetailSection section_name;

	private AuthorshipDetailSection section_author;

	private EnumComboElement<NomenclaturalCode> combo_nomenclaturalCode;

	private HybridDetailSection section_hybrid;

	public NonViralNameDetailElement(CdmFormFactory formFactory,

			ICdmFormElement formElement) {

		super(formFactory, formElement);

	}

	/** {@inheritDoc} */

	@Override

    protected void createControls(ICdmFormElement formElement, final NonViralName entity, int style) {

	    //name can be null in rare cases. Temporary solution for #4221. May be obsolete when

	    //#4393 (Make changing name of a taxon possible in details view) is implemented.

	    if(entity==null){

	        formFactory.createEmptyElement(formElement, "No name associated with this taxon.");

	    }

	    else {

	        toggleable_cache = formFactory.createToggleableTextField(formElement, "Cache", entity.getTitleCache(), entity.isProtectedTitleCache() || entity.isProtectedFullTitleCache(), style);

	        combo_nomenclaturalCode = formFactory.createEnumComboElement(NomenclaturalCode.class, formElement, style);

	        combo_nomenclaturalCode.setSelection(entity.getNomenclaturalCode());

	        //TODO RL

	        if(PreferencesUtil.getPreferenceStore().getBoolean(IPreferenceKeys.IS_RL)){

	            toggleable_cache.setVisible(false);

	            combo_nomenclaturalCode.setVisible(false);

	        }

	        section_name = formFactory.createNameDetailSection(getConversationHolder(), formElement, null, ExpandableComposite.TWISTIE | ExpandableComposite.EXPANDED);

	        section_name.setLayoutData(LayoutConstants.FILL_HORIZONTALLY(2, 1));

	        addControl(section_name);

	        addElement(section_name);

	        section_author = formFactory.createAuthorshipDetailSection(getConversationHolder(), formElement, null, ExpandableComposite.TWISTIE | ExpandableComposite.EXPANDED);

	        section_author.setLayoutData(LayoutConstants.FILL_HORIZONTALLY(2, 1));

	        addControl(section_author);

	        addElement(section_author);

	        //TODO RL

	        if(!PreferencesUtil.getPreferenceStore().getBoolean(IPreferenceKeys.IS_RL)){

	            section_hybrid = formFactory.createHybridDetailSection(getConversationHolder(), formElement, null, ExpandableComposite.TWISTIE);

	            section_hybrid.setLayoutData(LayoutConstants.FILL_HORIZONTALLY(2, 1));

	            addControl(section_hybrid);

	            addElement(section_hybrid);

	        }

	    }

    }

	/** {@inheritDoc} */

	@Override

	protected void updateContent() {

		super.updateContent();

		// disable nomenclatural code, because changing of nom.code is not

		// implemented on library side

		if(combo_nomenclaturalCode!=null){

		    combo_nomenclaturalCode.setEnabled(false);

		}

		if(toggleable_cache!=null){

		    setIrrelevant(toggleable_cache.getState(),

		            Arrays.asList(new Object[] { toggleable_cache }));

		}

	}

	/** {@inheritDoc} */

	@Override

	public void setEntity(NonViralName entity) {

		super.setEntity(entity);

		if (section_name!=null) {

            section_name.setEntity(entity);

        }

		if (section_author!=null) {

            section_author.setEntity(entity);

        }

		if (section_hybrid!=null) {

            section_hybrid.setEntity(entity);

        }

	}

	/** {@inheritDoc} */

	@Override

	public void removeElements() {

		super.removeElements();

		if (section_name != null) {

			section_name.removeElements();

			removeControl(section_name);

			section_name.dispose();

			section_name = null;

		}

		if (section_author != null) {

			section_author.removeElements();

			removeControl(section_author);

			section_author.dispose();

			section_author = null;

		}

	}

	/** {@inheritDoc} */

	@Override

	public void handleEvent(Object eventSource) {

		if (eventSource == toggleable_cache) {

			handleToggleableCacheField();

			// we never want the fullTitleCache to be protected since we only

			// use it for

			// initiating the free text name editor

			getEntity().setProtectedFullTitleCache(false);

		} else if (eventSource == section_name || eventSource == section_author) {

			if (getParentElement() instanceof AbstractCdmDetailSection) {

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

            }

			if (!toggleable_cache.getState()) {

				toggleable_cache.setText(getEntity().getTitleCache());

			}

		}

		if (eventSource == section_name) {

			section_name.setEntity(getEntity());

			getLayoutComposite().layout();

		}

	}

}