EDIT

/**

* 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.editor;

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import java.util.ArrayList;

import java.util.List;

import org.apache.log4j.Logger;

import org.eclipse.core.commands.operations.IUndoContext;

import org.eclipse.core.commands.operations.UndoContext;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.ui.IEditorInput;

import org.eclipse.ui.IEditorSite;

import org.eclipse.ui.PartInitException;

import org.eclipse.ui.part.MultiPageEditorPart;

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.model.name.TaxonNameBase;

import eu.etaxonomy.cdm.model.taxon.Taxon;

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

import eu.etaxonomy.taxeditor.editor.description.TaxonDescriptionEditor;

import eu.etaxonomy.taxeditor.editor.images.TaxonImageEditor;

import eu.etaxonomy.taxeditor.editor.name.TaxonNameEditor;

import eu.etaxonomy.taxeditor.store.model.DataChangeBridge;

import eu.etaxonomy.taxeditor.store.model.IDataChangeBehavior;

import eu.etaxonomy.taxeditor.store.operations.IPostOperationEnabled;

/**

 * 

 * Generates the tabbed editor with <code>TaxonNameEditor</code> on top and tabs for

 *  "Descriptions", "Concepts", "Geography", etc.

 * 

 * @author p.ciardelli

 * @author n.hoffmann

 * @created 15.05.2008

 * @version 1.0

 */

public class MultiPageTaxonEditor extends MultiPageEditorPart implements IConversationEnabled, IPostOperationEnabled {

	private static final Logger logger = Logger.getLogger(MultiPageTaxonEditor.class);

	public static final String ID = "eu.etaxonomy.taxeditor.editor.multipagetaxonview";

	private Taxon taxon;

	private boolean dirty;

	private ConversationHolder conversation;

	private IDataChangeBehavior dataChangeBehavior;

	private IUndoContext undoContext;

	public MultiPageTaxonEditor() {

		super();		

		undoContext = new UndoContext();

	}

	@Override

	public void dispose() {

		super.dispose();

//		EditorUtil.checkHidePropertySheet();

	}

	@Override

	protected void createPages() {

		TaxonEditorInput input = (TaxonEditorInput) getEditorInput();

		conversation = input.getConversationHolder();

		conversation.registerForDataStoreChanges(this);

		try {

			addPage(Page.NAME.getIndex(), new TaxonNameEditor(this), getEditorInput());

			setPageText(Page.NAME.getIndex(), Page.NAME.getTitle());

			// TODO lazy create

			addPage(Page.DESCRIPTIVE.getIndex(), new TaxonDescriptionEditor(this), getEditorInput());

			setPageText(Page.DESCRIPTIVE.getIndex(), Page.DESCRIPTIVE.getTitle());

			// TODO lazy create

			addPage(Page.IMAGE.getIndex(), new TaxonImageEditor(this), getEditorInput());

			setPageText(Page.IMAGE.getIndex(), Page.IMAGE.getTitle());

//			EditorUtil.showPropertySheet();

		} catch (PartInitException e) {

			logger.error("Could not create MultiPageTaxonEditor.", e);

		}

	}

	@Override

	public void doSave(IProgressMonitor monitor) {

		if( ! conversation.isBound()){

			conversation.bind();

		}

		// commit the conversation and start a new transaction immediately

		conversation.commit(true);

		this.setDirty(false);

	}

	private void setDirty(boolean dirty) {

		this.dirty = dirty;

		firePropertyChange(PROP_DIRTY);

	}

	/* (non-Javadoc)

	 * @see org.eclipse.ui.part.MultiPageEditorPart#isDirty()

	 */

	public boolean isDirty() {

		return dirty;

	}

    /**

     * Checks whether nested editors are calling <code>firePropertyChange(PROP_DIRTY)</code>

     * to signal an edit has taken place before passing property change along to 

     * <code>super.handlePropertyChange(int propertyId)</code>.

     */

	/* (non-Javadoc)

	 * @see org.eclipse.ui.part.MultiPageEditorPart#handlePropertyChange(int)

	 */

	protected void handlePropertyChange(int propertyId) {

		if (propertyId == PROP_DIRTY) {

			setDirty(true);

		}

		super.handlePropertyChange(propertyId);

	}

	@Override

	public void doSaveAs() {}

	@Override

	public boolean isSaveAsAllowed() {

		return false;

	}

	@Override

	public void init(IEditorSite site, IEditorInput input) throws PartInitException {

		if (!(input instanceof IEditorInput))

			throw new PartInitException(

					"Invalid Input: Must be IEditorInput");

		// Get taxon from editor input

		if (input.getAdapter(Taxon.class) != null) {

			taxon = (Taxon) input.getAdapter(Taxon.class);

		} else {

			taxon = null;

		}

		try {

			// Listen for name changes, 

			//  change tab for this taxon editor accordingly

			taxon.addPropertyChangeListener("name",

					new PropertyChangeListener() {

						public void propertyChange(PropertyChangeEvent e) {

							setPartName();

						}

					});

		} catch (NullPointerException e) {

			logger.warn("Caught an NPE while initing an editor. This is most " +

					"likely due to the unsuccesful attempt to restore the former " +

					"state of the application. We ignore this because the workbench " +

					"will simply be reset.");

		}

		setPartName();

		super.init(site, input);

	}

    /**

     * Calls <code>MultiPageEditorPart.setPartName(String partName)</code>

     *  with text appropriate to the state of the taxon: any taxon that has 

     *  been saved will by necessity have a name to display; a new taxon 

     *  should display "New taxon" in the editor tab.

     */

    protected void setPartName() {

    	String partName = null;

    	TaxonNameBase name = taxon.getName();

    	if (name != null) {

    		partName = name.getTitleCache();

    	}

    	if (partName == null || partName.equals("")) {

    		partName = ("New taxon");

    	}

        setPartName(partName);

    }

    /**

     * Editor pages call this in their postOperation to notify the MultiPageTaxonEditor 

     * of unsaved changes

     */

    public void setDirty() {

    	setDirty(true);

    }

    public Taxon getTaxon(){

    	return this.taxon;

    }

    /*

     * (non-Javadoc)

     * @see eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder()

     */

	public ConversationHolder getConversationHolder() {

		return conversation;

	}

	public void setConversationHolder(ConversationHolder conversation){

		this.conversation = conversation;

	}

	public IUndoContext getUndoContext() {

		return undoContext;

	}

	public void setUndoContext(IUndoContext undoContext) {

		this.undoContext = undoContext;

	}

	@Override

	public void setFocus(){

		// bind the conversation

		getConversationHolder().bind();

		// pass focus to the active editor page

		getActiveEditorPage().setFocus();

	}

	public AbstractTaxonEditor getActiveEditorPage(){

		return (AbstractTaxonEditor) getEditor(getActivePage());

	}

	/*

	 * (non-Javadoc)

	 * @see eu.etaxonomy.cdm.persistence.hibernate.ICdmPostCrudObserver#update(eu.etaxonomy.cdm.persistence.hibernate.CdmCrudEvent)

	 */

	public void update(CdmDataChangeMap events) {

		if(dataChangeBehavior == null){

			dataChangeBehavior = new MultiPageTaxonEditorDataChangeBehaviour(this);

		}

		DataChangeBridge.handleDataChange(events, dataChangeBehavior);

	}

	/*

	 * (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.store.operations.IPostOperationEnabled#postOperation()

	 */

	public boolean postOperation(CdmBase objectAffectedByOperation) {

		setDirty(true);

		for(AbstractTaxonEditor editor : this.getPages()){

			editor.postOperation(objectAffectedByOperation);

		}

		logger.warn("postOperation called on MultiPageTaxonEditor. Can you make it more specific?");

		return false;

	}

	/**

	 * Returns an <code>AbstractTaxonEditor</code> implementation by type

	 * 

	 * @param page the page type

	 * @return

	 */

	public AbstractTaxonEditor getPage(Page page){

		for(AbstractTaxonEditor editor : this.getPages()){

		 	if(editor.getClass().equals(page.getClazz())){

		 		return editor;

		 	}

		}

		return null;

	}

	/**

	 * Return a list of <code>AbstractTaxonEditor</code>s registered with this 

	 * <code>MultiPageTaxonEditor</code>.  

	 * 

	 * @return

	 */

	public List<AbstractTaxonEditor> getPages(){

		ArrayList<AbstractTaxonEditor> editors = new ArrayList<AbstractTaxonEditor>();

		for(int i = 0; i < this.getPageCount(); i++){

		 	editors.add((AbstractTaxonEditor) this.getEditor(i));

		}

		return editors;

	}

}