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;

import org.eclipse.jface.action.ToolBarManager;

import org.eclipse.jface.viewers.ISelectionProvider;

import org.eclipse.swt.SWT;

import org.eclipse.swt.graphics.Color;

import org.eclipse.swt.widgets.Control;

import org.eclipse.ui.forms.events.ExpansionEvent;

import org.eclipse.ui.forms.events.IExpansionListener;

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

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

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

import eu.etaxonomy.cdm.model.common.IdentifiableEntity;

import eu.etaxonomy.taxeditor.ui.forms.AbstractFormSection;

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

import eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory.DetailType;

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

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

import eu.etaxonomy.taxeditor.ui.forms.ISelectableElement;

/**

 * <p>

 * Abstract AbstractCdmDetailSection class.

 * </p>

 * 

 * @author n.hoffmann

 * @created Feb 26, 2010

 * @version 1.0

 */

public abstract class AbstractCdmDetailSection<ENTITY> extends

		AbstractFormSection<ENTITY> implements IEnableableFormElement,

		IExpansionListener {

	protected AbstractCdmDetailElement<ENTITY> detailElement;

	/**

	 * <p>

	 * Constructor for AbstractCdmDetailSection.

	 * </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.

	 * @param <ENTITY>

	 *            a ENTITY object.

	 */

	public AbstractCdmDetailSection(CdmFormFactory formFactory,

			ConversationHolder conversation, ICdmFormElement parentElement,

			ISelectionProvider selectionProvider, int style) {

		super(formFactory, parentElement, selectionProvider,

				Section.CLIENT_INDENT | style);

		setText(getHeading());

		addExpansionListener(this);

		createControls(this, SWT.NULL);

	}

	/**

	 * <p>

	 * createControls

	 * </p>

	 * 

	 * @param formElement

	 *            a

	 *            {@link eu.etaxonomy.taxeditor.ui.section.AbstractCdmDetailSection}

	 *            object.

	 * @param style

	 *            a int.

	 */

	protected void createControls(AbstractCdmDetailSection<ENTITY> formElement,

			int style) {

		TableWrapLayout layout = (TableWrapLayout) getLayoutComposite()

				.getLayout();

		layout.topMargin = 10;

		layout.numColumns = 2;

		getLayoutComposite().setLayout(layout);

		detailElement = formFactory.createCdmDetailElement(getDetailType(),

				formElement, style);

	}

	/**

	 * <p>

	 * getDetailType

	 * </p>

	 * 

	 * @return a

	 *         {@link eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory.DetailType}

	 *         object.

	 */

	protected abstract DetailType getDetailType();

	/**

	 * <p>

	 * getHeading

	 * </p>

	 * 

	 * @return the heading for this section

	 */

	public abstract String getHeading();

	/** {@inheritDoc} */

	@Override

	public void dispose() {

		if (detailElement instanceof ISelectableElement) {

			ISelectableElement selectableElement = (ISelectableElement) detailElement;

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

				formFactory.destroySelectionArbitrator(selectableElement

						.getSelectionArbitrator());

			}

		}

		super.dispose();

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see

	 * eu.etaxonomy.taxeditor.forms.section.AbstractEditorFormSection#setBackground

	 * (org.eclipse.swt.graphics.Color)

	 */

	/** {@inheritDoc} */

	@Override

	public void setBackground(Color color) {

		if (detailElement != null) {

			// detailComposite.setBackground(color);

		}

		super.setBackground(color);

	}

	/**

	 * <p>

	 * setEntity

	 * </p>

	 * 

	 * @param entity

	 *            a ENTITY object.

	 */

	@Override

	public void setEntity(ENTITY entity) {

		if (detailElement != null) {

			detailElement.setEntity(entity);

		}

		super.setEntity(entity);

		setSectionTitle();

		layout();

	}

	/**

	 * <p>

	 * setSectionTitle

	 * </p>

	 */

	protected void setSectionTitle() {

		String title = "";

		if (getEntity() != null && (getEntity() instanceof IdentifiableEntity)) {

			title = ": " + ((IdentifiableEntity) getEntity()).getTitleCache();

		}

		this.setText(String.format("%s%s", getHeading(), title));

		setTextClient(createToolbar());

	}

	/**

	 * @return

	 */

	protected Control createToolbar() {

		ToolBarManager toolBarManager = new ToolBarManager(SWT.FLAT);

		return toolBarManager.createControl(this);

	}

	/**

	 * <p>

	 * updateTitle

	 * </p>

	 */

	public void updateTitle() {

		if (!isDisposed()) {

			setSectionTitle();

			layout();

		}

	}

	/** {@inheritDoc} */

	public void setIrrelevant(boolean irrelevant) {

		if (detailElement != null) {

			detailElement.setIrrelevant(irrelevant);

		}

	}

	/** {@inheritDoc} */

	public void expansionStateChanging(ExpansionEvent e) {

		// logger.warn("Expansion State Changing");

	}

	/** {@inheritDoc} */

	public void expansionStateChanged(ExpansionEvent e) {

		// logger.warn("Expansion State Changed");

	}

}