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.view;

import org.eclipse.jface.viewers.ISelection;

import org.eclipse.jface.viewers.IStructuredSelection;

import org.eclipse.jface.viewers.StructuredSelection;

import org.eclipse.jface.viewers.Viewer;

import org.eclipse.swt.SWT;

import org.eclipse.swt.custom.SashForm;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Label;

import org.eclipse.ui.ISelectionListener;

import org.eclipse.ui.ISelectionService;

import org.eclipse.ui.IWorkbenchPart;

import org.eclipse.ui.part.PageBook;

import org.eclipse.ui.part.ViewPart;

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

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

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

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

import eu.etaxonomy.taxeditor.model.AbstractUtility;

import eu.etaxonomy.taxeditor.model.IDirtyMarkable;

import eu.etaxonomy.taxeditor.operation.IPostOperationEnabled;

/**

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

 *

 * @author n.hoffmann

 * @created Jun 15, 2010

 * @version 1.0

 */

public abstract class AbstractCdmViewPart extends ViewPart implements ISelectionListener, IPostOperationEnabled, IConversationEnabled, IDirtyMarkable{

	protected ISelectionService selectionService;

	public static IStructuredSelection EMPTY_SELECTION = new StructuredSelection();

	protected IWorkbenchPart part;

    private PageBook pageBook;

	private Label emptySelectionLabel;

	private Composite viewerComposite;

	/** {@inheritDoc} */

	@Override

	public void createPartControl(Composite parent) {

		selectionService = getSite().getWorkbenchWindow().getSelectionService();

		selectionService.addSelectionListener(this);

		pageBook = new PageBook(parent, SWT.NULL);

		//create viewerComposite

		viewerComposite = new SashForm(pageBook, SWT.HORIZONTAL);

		createViewer(viewerComposite);

		// Page 2: Nothing selected

        emptySelectionLabel = new Label(pageBook, SWT.TOP + SWT.LEFT + SWT.WRAP);

        setInitialSelection();

	}

	/**

	 *

	 */

	private void setInitialSelection() {

		selectionChanged(AbstractUtility.getActivePart(), getInitialSelection());

	}

	/**

	 * <p>getInitialSelection</p>

	 *

	 * @return a {@link org.eclipse.jface.viewers.ISelection} object.

	 */

	protected ISelection getInitialSelection() {

		return selectionService.getSelection();

	}

	/**

	 * <p>showEmptyPage</p>

	 */

	public void showEmptyPage(){

		pageBook.showPage(emptySelectionLabel);

	}

    /**

     * <p>showViewer</p>

     *

     * @param part a {@link org.eclipse.ui.IWorkbenchPart} object.

     * @param selection a {@link org.eclipse.jface.viewers.ISelection} object.

     */

    public void showViewer(IWorkbenchPart part, IStructuredSelection selection){

    	this.part = part;

		Object element = selection.getFirstElement();

		getViewer().setInput(element);

		showViewer();

    }

    /**

     * <p>getViewer</p>

     *

     * @return a {@link org.eclipse.jface.viewers.Viewer} object.

     */

    public abstract Viewer getViewer();

	/**

	 * <p>showViewer</p>

	 */

	public void showViewer(){

		pageBook.showPage(viewerComposite);

    }

	public void setEnabled(boolean enabled){

		pageBook.setEnabled(enabled);

	}

	/** {@inheritDoc} */

	@Override

	public void setFocus() {

		if(getConversationHolder() != null){

			getConversationHolder().bind();

		}

		getViewer().getControl().setFocus();

	}

	/**

	 * <p>createViewer</p>

	 *

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

	 */

	public abstract void createViewer(Composite parent);

	/** {@inheritDoc} */

	@Override

    public boolean postOperation(CdmBase objectAffectedByOperation) {

		changed(objectAffectedByOperation);

		return true;

	}

	/** {@inheritDoc} */

	@Override

    public abstract void changed(Object object);

	/**

	 * <p>getConversationHolder</p>

	 *

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

	 */

	@Override

    public ConversationHolder getConversationHolder() {

		if(part != null && part instanceof IConversationEnabled) {

            return ((IConversationEnabled) part).getConversationHolder();

        }

		return null;

	}

	/** {@inheritDoc} */

	@Override

    public void update(CdmDataChangeMap changeEvents) {

	}

	/** {@inheritDoc} */

	@Override

	public void dispose() {

		selectionService.removeSelectionListener(this);

		super.dispose();

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.model.IDirtyMarkableSelectionProvider#forceDirty()

	 */

	@Override

	public void forceDirty() {

	    changed(null);

	}

}