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

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import java.util.Iterator;

import org.eclipse.jface.dialogs.MessageDialog;

import org.eclipse.jface.dialogs.MessageDialogWithToggle;

import org.eclipse.jface.preference.IPreferenceStore;

import org.eclipse.jface.text.IDocument;

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

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

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

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

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

import org.eclipse.jface.util.IPropertyChangeListener;

import org.eclipse.jface.window.Window;

import org.eclipse.swt.SWT;

import org.eclipse.swt.custom.StyledText;

import org.eclipse.swt.events.MouseAdapter;

import org.eclipse.swt.events.MouseEvent;

import org.eclipse.swt.layout.GridData;

import org.eclipse.swt.layout.GridLayout;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Control;

import org.eclipse.ui.IEditorInput;

import org.eclipse.ui.IEditorSite;

import org.eclipse.ui.PartInitException;

import org.eclipse.ui.texteditor.IDocumentProvider;

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

import eu.etaxonomy.taxeditor.annotatedlineeditor.AnnotatedLineDocumentProvider;

import eu.etaxonomy.taxeditor.annotatedlineeditor.AnnotatedLineEditor;

import eu.etaxonomy.taxeditor.annotatedlineeditor.LineAnnotation;

import eu.etaxonomy.taxeditor.annotatedlineeditor.LineAnnotationModel;

import eu.etaxonomy.taxeditor.bulkeditor.input.AbstractBulkEditorInput;

import eu.etaxonomy.taxeditor.model.IDirtyMarkableSelectionProvider;

import eu.etaxonomy.taxeditor.model.IPartContentHasDetails;

import eu.etaxonomy.taxeditor.preference.PreferencesUtil;

import eu.etaxonomy.taxeditor.store.CdmStore;

import eu.etaxonomy.taxeditor.store.TermStore;

/**

 * <p>BulkEditor class.</p>

 *

 * @author p.ciardelli

 * @created 07.07.2009

 * @version 1.0

 */

public class BulkEditor extends AnnotatedLineEditor implements PropertyChangeListener, IPartContentHasDetails, IDirtyMarkableSelectionProvider{

	/** Constant <code>ID="bulkeditor.editor"</code> */

	public static final String ID = "bulkeditor.editor";

	private boolean isInitialFocus = true;

	private BulkEditorSearchComposite searchBar = null;

	private IPropertyChangeListener markerPreferenceListener;

	/**

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

	 */

	public BulkEditor() {

		super(CdmStore.createConversation());

	}

	/* (non-Javadoc)

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

	 */

	/** {@inheritDoc} */

	@Override

	protected void initializeEditor() {

		super.initializeEditor();

		/**

		 * see AbstractTextEditor javadoc for explanation of context menu ids

		 */

		setEditorContextMenuId("#BulkEditorContext");

		setEntityCreatorService(new BulkEditorEntityCreatorService());

		setLineDisplayStrategy(new BulkEditorLineDisplay(this));

		setSourceViewerConfiguration(new BulkEditorViewerConfiguration(lineDisplayStrategy));

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.bulkeditor.ListEditor#createSourceViewer(org.eclipse.swt.widgets.Composite, org.eclipse.jface.text.source.IVerticalRuler, int)

	 */

	/** {@inheritDoc} */

	protected ISourceViewer createSourceViewer(Composite parent,

			IVerticalRuler ruler, int styles) {

		ISourceViewer viewer = super.createSourceViewer(parent, ruler, styles);

		if (((AbstractBulkEditorInput) getEditorInput()).isMergingEnabled()) {

			addToggleMergeCandidateListener(ruler.getControl());

		}

		return viewer;

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.bulkeditor.AnnotatedLineEditor#init(org.eclipse.ui.IEditorSite, org.eclipse.ui.IEditorInput)

	 */

	/** {@inheritDoc} */

	@Override

	public void init(IEditorSite site, IEditorInput input)

			throws PartInitException {

		if (!(input instanceof AbstractBulkEditorInput)) {

			throw new PartInitException("Invalid Input: Must be BulkEditorInput");

		}

		super.init(site, input);

		((AbstractBulkEditorInput) input).addPropertyChangeListener(this);

	}

	/* (non-Javadoc)

	 * @see org.eclipse.ui.texteditor.AbstractDecoratedTextEditor#createPartControl(org.eclipse.swt.widgets.Composite)

	 */

	/** {@inheritDoc} */

	@Override

	public void createPartControl(Composite parent) {

		parent.setLayout(new GridLayout());

		Composite layoutComposite = new Composite(parent, SWT.TOP);

		layoutComposite.setLayout(new GridLayout());

		searchBar = new BulkEditorSearchComposite(this, layoutComposite, SWT.NONE);

		layoutComposite.setBackground(parent.getDisplay().getSystemColor(SWT.COLOR_WIDGET_BACKGROUND));

		if (isEditableMarkerTypes()) {

			// TODO this will be obsolete

//			createMarkerEditing(layoutComposite);

		}

		searchBar.setEnabled(! getEditorInput().isSingleEntityMode());

		super.createPartControl(parent);

		// Set viewer composite to fill grid. Unfortunately it is private and we have to do a little hack here.

		for (Control control : parent.getChildren()) {

			if (control instanceof Composite && 

						!(control.equals(layoutComposite))) {

				control.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));

			}

		}

	}

	/**

	 * @param parent 

	 * 

	 */

	private void createMarkerEditing(Composite parent) {

		final BulkEditorMarkerPreferenceComposite markerPreferenceBar = 

				new BulkEditorMarkerPreferenceComposite((AbstractBulkEditorInput) getEditorInput(), parent, SWT.NONE);

		markerPreferenceListener = new IPropertyChangeListener() {

			public void propertyChange(

					org.eclipse.jface.util.PropertyChangeEvent event) {

				if (event.getProperty().contains(PreferencesUtil.EDIT_MARKER_TYPE_PREFIX)) {

					refreshLineDisplay();

				}

			}

		};

		PreferencesUtil.getPreferenceStore().addPropertyChangeListener(markerPreferenceListener);

	}

	/* (non-Javadoc)

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

	 */

	/** {@inheritDoc} */

	@Override

	public void dispose() {

		if (markerPreferenceListener != null ) {

			PreferencesUtil.getPreferenceStore().removePropertyChangeListener(markerPreferenceListener);

		}

		super.dispose();

	}

	/**

	 * Can this input type edit any markers?

	 * 

	 * @return

	 */

	private boolean isEditableMarkerTypes() { 

		for (MarkerType markerType : TermStore.getNonTechnicalMarkerTypes()) {

			if (((AbstractBulkEditorInput) getEditorInput()).isMarkerTypeEditingEnabled(markerType)) {

				return true;

			}

		}

		return false;

	}

	/**

	 * Refreshes text in all lines.

	 */

	protected void refreshLineDisplay() {

		IDocumentProvider provider = getDocumentProvider();

		IEditorInput input = getEditorInput();

		IAnnotationModel model = provider.getAnnotationModel(input);

		Iterator iter = getDocumentProvider().getAnnotationModel(getEditorInput()).getAnnotationIterator();

		while (iter.hasNext()) {

			Object next = iter.next();

			if (next instanceof LineAnnotation) {

				LineAnnotation annotation = (LineAnnotation) next;

				((AnnotatedLineDocumentProvider) getDocumentProvider()).

						updateLineFromAnnotation(annotation);

			}

		}

	}

	/* (non-Javadoc)

	 * @see org.eclipse.ui.texteditor.AbstractDecoratedTextEditor#isEditable()

	 */

	/** {@inheritDoc} */

	@Override

	public boolean isEditable() {

		return false;

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.annotatedlineeditor.AnnotatedLineEditor#setFocus()

	 */

	/** {@inheritDoc} */

	@Override

	public void setFocus() {

//		super.setFocus();

		// TODO Since setFocus() is called by RCP, can a global variable (searchBar) be avoided?

		setFocusOnToolBar();

		// TODO find a better place to put this - this dialog should be shown after initial contents of 

		//	Editor are displayed

		if (isInitialFocus) {

			displayWarningDialog();

			isInitialFocus = false;

		}

	}

	/**

	 * Sets focus on the toolbar.

	 */

	private void setFocusOnToolBar() {

		if (searchBar != null) {

			searchBar.setFocus();

		}

	}

	/**

	 * 

	 */

	private void displayWarningDialog() {

		IPreferenceStore prefs = PreferencesUtil.getPreferenceStore();

		if (!prefs.getBoolean(PreferencesUtil.HIDE_BULKEDITOR_INFO)) {

			String msg = "The Bulk Editor allows you to edit objects used to reference other objects, such as names, references, and authors.\n\n" +

							"Any changes you make to an object in the Bulk Editor will be displayed wherever the object is used.\n\n" +

							"For instance, a reference may be displayed with both a name and a descriptive element. If the reference name is changed here, the display of both the name and the descriptive element will be affected.";

			MessageDialogWithToggle dialog = MessageDialogWithToggle.openOkCancelConfirm

												(getSite().getShell(), "Bulk Editor", msg, "Do not show this message again", 

														false, null, PreferencesUtil.HIDE_BULKEDITOR_INFO);

			if (dialog.getReturnCode() == Window.OK) { 

				prefs.setValue(PreferencesUtil.HIDE_BULKEDITOR_INFO, dialog.getToggleState());

			}

		}

	}

	/**

	 * @param control

	 */

	private void addToggleMergeCandidateListener(Control control) {

		control.addMouseListener(new MouseAdapter() {

			@Override

			public void mouseDoubleClick(MouseEvent e) {

				StyledText textWidget = getSourceViewer().getTextWidget();

				int line = textWidget.getLineIndex(e.y);

				toggleMergeCandidateAnnotation(line);

			}

		});

	}

	/**

	 * <p>toggleMergeCandidateAnnotation</p>

	 *

	 * @param line a int.

	 */

	public void toggleMergeCandidateAnnotation(int line) {

		IDocument document = getSourceViewer().getDocument();

		LineAnnotationModel model = 

				(LineAnnotationModel) getSourceViewer().getAnnotationModel();

		Annotation annotation = model.getAnnotationAtLine(line, document);

		if (annotation != null) {

			if (annotation.getType().equals(IBulkEditorConstants.TYPE_MERGE_CANDIDATE)) {

				model.changeAnnotationType(

						annotation, LineAnnotation.TYPE_GENERIC);

			} else {

				model.changeAnnotationType(

						annotation, IBulkEditorConstants.TYPE_MERGE_CANDIDATE);

			}

		}

	}

	/** {@inheritDoc} */

	public void changed(Object object) {

//		this.dirty = dirty;

		AnnotatedLineDocumentProvider p = (AnnotatedLineDocumentProvider) getDocumentProvider();

		p.changed(object);

//		firePropertyChange(PROP_DIRTY);

	}

	/* (non-Javadoc)

	 * @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)

	 */

	/** {@inheritDoc} */

	public void propertyChange(PropertyChangeEvent evt) {

		if (evt.getPropertyName().equals(AbstractBulkEditorInput.QUERY_CHANGED)) {

			// TODO check if dirty, prompt save

			if (isDirty()) {

				boolean proceed = MessageDialog.openQuestion(getEditorSite().getShell(), 

						"Save changes", "You have made changes that must be saved before this query can be executed. Would you like to proceed?");

				if (proceed) {

					doSave(null);

				} else {

					return;

				}

			}

			if(getDocumentProvider().getAnnotationModel(getEditorInput()) != null){

				((AnnotationModel) getDocumentProvider().getAnnotationModel(getEditorInput())).removeAllAnnotations();

			}

			setInput(getEditorInput());

		}

	}

	/* (non-Javadoc)

	 * @see org.eclipse.ui.views.properties.tabbed.ITabbedPropertySheetPageContributor#getContributorId()

	 */

	/**

	 * <p>getContributorId</p>

	 *

	 * @return a {@link java.lang.String} object.

	 */

	public String getContributorId() {

		return BulkEditor.ID;

	}

	/** {@inheritDoc} */

	@Override

	public AbstractBulkEditorInput getEditorInput() {

		// TODO Auto-generated method stub

		return (AbstractBulkEditorInput) super.getEditorInput();

	}

}