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

import org.eclipse.core.runtime.CoreException;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.jface.text.BadLocationException;

import org.eclipse.jface.text.source.ISourceViewer;

import org.eclipse.jface.text.source.IVerticalRuler;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.ui.IEditorInput;

import org.eclipse.ui.editors.text.TextEditor;

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.operations.IPostOperationEnabled;

/**

 * A list-based editor, where each line in the editor's document is associated with a domain object.

 * <p>

 * Extending classes must set:

 * <ul>

 * <li>an <code>IEntityCreator</code> to create a new domain object when the user creates a new line;

 * <li>an <code>IEntityPersistenceService</code> for interacting with the persistence layer; and

 * <li>an <code>ILineDisplayStrategy</code> for various visual manifestations of the domain object.

 * </ul>

 *

 * @author p.ciardelli

 * @created 25.06.2009

 * @version 1.0

 */

public class AnnotatedLineEditor extends TextEditor implements IConversationEnabled, IPostOperationEnabled {

	private ConversationHolder conversation;

	private IEntityPersistenceService persistenceService;

	protected ILineDisplayStrategy lineDisplayStrategy;

	private IEntityCreatorService entityCreatorService;

	private IEntityCreator<?> entityCreator;

	/**

	 * <p>Constructor for AnnotatedLineEditor.</p>

	 *

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

	 */

	public AnnotatedLineEditor(ConversationHolder conversation) {

		this.conversation = conversation;

	}

	/* (non-Javadoc)

	 * @see org.eclipse.ui.editors.text.TextEditor#doSetInput(org.eclipse.ui.IEditorInput)

	 */

	/** {@inheritDoc} */

	@Override

	protected void doSetInput(IEditorInput input) throws CoreException {

		AnnotatedLineDocumentProvider provider = createAnnotatedLineDocumentProvider();

		if (entityCreatorService != null) {

			provider.setEntityCreator(entityCreatorService.getEntityCreator(input), input);

		} else {

			provider.setEntityCreator(entityCreator, input);

		}

		provider.setLineDisplayStrategy(lineDisplayStrategy, input);

		setDocumentProvider(provider);

		super.doSetInput(input);	

	}

	/**

	 * <p>createAnnotatedLineDocumentProvider</p>

	 *

	 * @return a {@link eu.etaxonomy.taxeditor.annotatedlineeditor.AnnotatedLineDocumentProvider} object.

	 */

	protected AnnotatedLineDocumentProvider createAnnotatedLineDocumentProvider() {

		return new AnnotatedLineDocumentProvider(getEditorInput());

	}

	/**

	 * <p>Setter for the field <code>entityCreatorService</code>.</p>

	 *

	 * @param entityCreatorService a {@link eu.etaxonomy.taxeditor.annotatedlineeditor.IEntityCreatorService} object.

	 */

	protected void setEntityCreatorService(IEntityCreatorService entityCreatorService) {

		this.entityCreatorService = entityCreatorService;

	}

	/**

	 * <p>Setter for the field <code>entityCreator</code>.</p>

	 *

	 * @param entityCreator a {@link eu.etaxonomy.taxeditor.annotatedlineeditor.IEntityCreator} object.

	 */

	protected void setEntityCreator(IEntityCreator entityCreator) {

		this.entityCreator = entityCreator;

	}

	/**

	 * <p>Setter for the field <code>persistenceService</code>.</p>

	 *

	 * @param persistenceService a {@link eu.etaxonomy.taxeditor.annotatedlineeditor.IEntityPersistenceService} object.

	 */

	protected void setPersistenceService(

			IEntityPersistenceService persistenceService) {

		this.persistenceService = persistenceService;	

	}

	/**

	 * <p>Getter for the field <code>persistenceService</code>.</p>

	 *

	 * @return a {@link eu.etaxonomy.taxeditor.annotatedlineeditor.IEntityPersistenceService} object.

	 */

	protected IEntityPersistenceService getPersistenceService() {

		return persistenceService;	

	}

	/**

	 * <p>Setter for the field <code>lineDisplayStrategy</code>.</p>

	 *

	 * @param lineDisplayStrategy a {@link eu.etaxonomy.taxeditor.annotatedlineeditor.ILineDisplayStrategy} object.

	 */

	protected void setLineDisplayStrategy(

			ILineDisplayStrategy lineDisplayStrategy) {

		this.lineDisplayStrategy = lineDisplayStrategy;		

	}

	/** {@inheritDoc} */

	@Override

	protected ISourceViewer createSourceViewer(Composite parent,

			IVerticalRuler ruler, int styles) {

		fAnnotationAccess= getAnnotationAccess();

		fOverviewRuler= createOverviewRuler(getSharedColors());	

		LineSelectionViewer viewer = new LineSelectionViewer(parent, ruler, getOverviewRuler(),  

						isOverviewRulerVisible(), styles);

//						isOverviewRulerVisible(), styles | SWT.WRAP);

		getSourceViewerDecorationSupport(viewer);

		return viewer;

	}

	/**

	 * Create an annotated line with an "empty" entity, i.e. using the editor

	 * input's default entity type and a zero-length title cache.

	 *

	 * @return a {@link eu.etaxonomy.taxeditor.annotatedlineeditor.LineAnnotation} object.

	 */

	public LineAnnotation createAnnotatedLineNewObject() {

		// Create new object

		Object entity = ((AnnotatedLineDocumentProvider) getDocumentProvider()).

							getEntityCreator(getEditorInput()).createEntity(null);

		LineAnnotation annotation = createAnnotatedLine(entity);

		if (annotation != null) {

			annotation.markAsNew(true);

		}

		return annotation;

	}

	/**

	 * Create an annotated line, first creating an entity of type "key" - this key

	 * must be recognized by the editor's entity creator.

	 *

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

	 * @param titleCache a {@link java.lang.String} object.

	 * @return a {@link eu.etaxonomy.taxeditor.annotatedlineeditor.LineAnnotation} object.

	 */

	public LineAnnotation createAnnotatedLineNewObject(Object key, String titleCache) {

		// Create new object

		Object entity = ((AnnotatedLineDocumentProvider) getDocumentProvider()).

							getEntityCreator(getEditorInput()).createEntity(key, titleCache);

		LineAnnotation annotation = createAnnotatedLine(entity);

		if (annotation != null) {

			annotation.markAsNew(true);

		}

		return annotation;

	}

	/**

	 * Creates an annotated line at the end of the document. The annotation contains the entity.

	 *

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

	 * @return a {@link eu.etaxonomy.taxeditor.annotatedlineeditor.LineAnnotation} object.

	 */

	public LineAnnotation createAnnotatedLine(Object entity) {

		IEditorInput input = getEditorInput();

		AnnotatedLineDocumentProvider provider = (AnnotatedLineDocumentProvider) getDocumentProvider();

		LineAnnotation annotation = null;

		try {

			annotation = provider.createAnnotatedLine(input, entity);

			// Jump to new line

			int start= provider.getAnnotationModel(input).getPosition(annotation).getOffset();

			selectAndReveal(start, 0);

		} catch (BadLocationException e) {

			// TODO Auto-generated catch block

			e.printStackTrace();

		}		

		return annotation;

	}

	/**

	 * <p>removeAnnotatedLine</p>

	 *

	 * @param lineno a int.

	 */

	public void removeAnnotatedLine(int lineno) {

		((AnnotatedLineDocumentProvider) getDocumentProvider()).removeAnnotatedLine(lineno);

	}

	/**

	 * <p>removeAnnotatedLine</p>

	 *

	 * @param annotation a {@link eu.etaxonomy.taxeditor.annotatedlineeditor.LineAnnotation} object.

	 */

	public void removeAnnotatedLine(LineAnnotation annotation) {

		((AnnotatedLineDocumentProvider) getDocumentProvider()).removeAnnotatedLine(annotation);

	}

	/* (non-Javadoc)

	 * @see org.eclipse.ui.texteditor.AbstractTextEditor#doSave(org.eclipse.core.runtime.IProgressMonitor)

	 */

	/** {@inheritDoc} */

	@Override

	public void doSave(IProgressMonitor progressMonitor) {

		if (getConversationHolder() != null) {

			if( ! getConversationHolder().isBound()){

				getConversationHolder().bind();

			}

			super.doSave(progressMonitor);

			getConversationHolder().commit(true);

		} else {

			super.doSave(progressMonitor);	

		}

		firePropertyChange(PROP_DIRTY);

	}

	/* (non-Javadoc)

	 * @see org.eclipse.ui.texteditor.AbstractTextEditor#setFocus()

	 */

	/** {@inheritDoc} */

	@Override

	public void setFocus() {

		super.setFocus();

		if (getConversationHolder() != null) {

			getConversationHolder().bind();

		}

		// TODO pass focus to underlying widgets

	}

	/* (non-Javadoc)

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

	 */

	/**

	 * <p>getConversationHolder</p>

	 *

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

	 */

	public ConversationHolder getConversationHolder() {

		return conversation;

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver#update(eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap)

	 */

	/** {@inheritDoc} */

	public void update(CdmDataChangeMap changeEvents) {}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.operations.IPostOperationEnabled#postOperation(eu.etaxonomy.cdm.model.common.CdmBase)

	 */

	/** {@inheritDoc} */

	public boolean postOperation(CdmBase objectAffectedByOperation) {

		return false;

	}

	/* (non-Javadoc)

	 * @see org.eclipse.ui.editors.text.TextEditor#dispose()

	 */

	/** {@inheritDoc} */

	@Override

	public void dispose() {

		super.dispose();

		conversation.close();

	}

	/**

	 * <p>onComplete</p>

	 *

	 * @return a boolean.

	 */

	public boolean onComplete() {

		// TODO Auto-generated method stub

		return false;

	}

}