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.preference.menu;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Iterator;

import java.util.List;

import org.eclipse.core.runtime.IStatus;

import org.eclipse.jface.preference.PreferencePage;

import org.eclipse.jface.viewers.CheckStateChangedEvent;

import org.eclipse.jface.viewers.CheckboxTableViewer;

import org.eclipse.jface.viewers.ICheckStateListener;

import org.eclipse.jface.viewers.IStructuredSelection;

import org.eclipse.jface.viewers.StructuredSelection;

import org.eclipse.jface.wizard.WizardDialog;

import org.eclipse.swt.SWT;

import org.eclipse.swt.events.SelectionAdapter;

import org.eclipse.swt.events.SelectionEvent;

import org.eclipse.swt.layout.GridData;

import org.eclipse.swt.layout.GridLayout;

import org.eclipse.swt.widgets.Button;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Control;

import org.eclipse.ui.IWorkbench;

import org.eclipse.ui.IWorkbenchPreferencePage;

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

import eu.etaxonomy.taxeditor.preference.PreferencesUtil;

import eu.etaxonomy.taxeditor.preference.wizard.VocabularyTermWizard;

import eu.etaxonomy.taxeditor.store.CdmStore;

import eu.etaxonomy.taxeditor.store.StoreUtil;

import eu.etaxonomy.taxeditor.store.TermStore;

/**

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

 *

 * @author n.hoffmann

 * @created 12.06.2009

 * @version 1.0

 */

public abstract class AbstractMenuPreferences<T extends DefinedTermBase> extends PreferencePage implements

		IWorkbenchPreferencePage{

	private Button toggleButton;

	protected HashMap<DefinedTermBase<T>, Button> menuButtons;

	protected Button newButton;

	protected Button editButton;

	protected Button removeButton;

	protected List<T> terms;

	protected CheckboxTableViewer tableViewer;

	private boolean state = true;

	private boolean vocabularyIsEditable;

	/**

	 * Constructs a new menu preference page.

	 *

	 * @param initialVocabulary

	 * 			the initial vocabulary containing all possible entries for the menu

	 * @param title

	 * 			the title of the page

	 * @param description

	 * 			describing text for the preference page

	 * @param editable

	 * 			whether this vocabulary should be editable. Will render "New", "Edit", "Delete" buttons

	 * 			Handler for these buttons have to be overriding addEditButtonListeners()

	 * @param <T> a T object.

	 */

	public AbstractMenuPreferences(List<T> initialVocabulary, String title, String description, boolean editable) {

		super(title);

		terms = initialVocabulary;

		vocabularyIsEditable = editable;

		setDescription(description);

	}

	/**

	 * {@inheritDoc}

	 *

	 * Create contents of the preference page

	 */

	@Override

	public Control createContents(Composite parent) {

		Composite container = new Composite(parent, SWT.NULL);

		final GridLayout gridLayout = new GridLayout();

		gridLayout.numColumns = 2;

		container.setLayout(gridLayout);

		tableViewer = CheckboxTableViewer.newCheckList(container, SWT.NULL);

		GridData tableLayoutData = new GridData(SWT.FILL, SWT.FILL, true, false);

		tableLayoutData.heightHint = 300;

		tableViewer.getTable().setLayoutData(tableLayoutData);

		tableViewer.setContentProvider(new DefinedTermBaseContentProvider());

		tableViewer.setLabelProvider(new DefinedTermBaseLabelProvider());

		refresh(terms);

		tableViewer.addCheckStateListener(new ICheckStateListener() {

			@Override

			public void checkStateChanged(CheckStateChangedEvent arg0) {

				checkNoneChecked();

			}

		});

		Composite buttonContainer = new Composite(container, SWT.NULL);

		GridData buttonContainerLayoutData = new GridData();

		buttonContainerLayoutData.verticalAlignment = SWT.TOP;

		buttonContainer.setLayoutData(buttonContainerLayoutData);

		buttonContainer.setLayout(new GridLayout());

		if(vocabularyIsEditable) createEditButtons(buttonContainer);

		toggleButton = new Button(buttonContainer, SWT.PUSH);

		toggleButton.setText("Toggle");

		toggleButton.addSelectionListener(new SelectionAdapter(){

			/* (non-Javadoc)

			 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)

			 */

			@Override

			public void widgetSelected(SelectionEvent e) {

				state = state ? false : true;

				tableViewer.setAllChecked(state);

				checkNoneChecked();

			}

		});

		createAdditionalContent(container);

		return container;

	}

	/**

	 * <p>refresh</p>

	 *

	 * @param definedTerms a {@link java.util.List} object.

	 */

	protected void refresh(List<T> definedTerms) {

		tableViewer.setInput(definedTerms);

		List<T> preferedTerms = PreferencesUtil.getPreferredTerms(definedTerms);

		tableViewer.setCheckedElements(preferedTerms.toArray());

	}

	/**

	 * <p>createAdditionalContent</p>

	 *

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

	 */

	protected void createAdditionalContent(Composite container) {

		// implement where needed		

	}

	/* (non-Javadoc)

	 * @see eu.etaxonomy.taxeditor.preference.AbstractMenuPreferences#createButtons(org.eclipse.swt.widgets.Composite)

	 */

	/**

	 * <p>createEditButtons</p>

	 *

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

	 */

	protected void createEditButtons(Composite buttonContainer) {

		newButton = new Button(buttonContainer, SWT.PUSH);

		newButton.setText("New");

		newButton.setLayoutData(new GridData(SWT.FILL));

		editButton = new Button(buttonContainer, SWT.PUSH);

		editButton.setText("Edit");

		editButton.setLayoutData(new GridData(SWT.FILL));

		removeButton = new Button(buttonContainer, SWT.PUSH);

		removeButton.setText("Remove");

		removeButton.setLayoutData(new GridData(SWT.FILL));

		addNewButtonListeners();

		addEditButtonListeners();

		addDeleteButtonListeners();

	}

	/**

	 * Implement this method in MenuPreference Pages where the vocabulary should be editable, editable flag

	 * is set.

	 */

	protected void addNewButtonListeners() {

		newButton.addSelectionListener(new SelectionAdapter(){

			/* (non-Javadoc)

			 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)

			 */

			@Override

			public void widgetSelected(SelectionEvent e) {

				VocabularyTermWizard<T> wizard = new VocabularyTermWizard<T>(getTermClass()); 

				WizardDialog dialog = new WizardDialog(StoreUtil.getShell(), wizard);

			    if(dialog.open() == IStatus.OK){

			    	tableViewer.setInput(TermStore.getFeatures());

			    }

			}

		});

	}

	/**

	 * Implement this method in MenuPreference Pages where the vocabulary should be editable, editable flag

	 * is set.

	 */

	protected void addEditButtonListeners() {

		editButton.addSelectionListener(new SelectionAdapter(){

			/* (non-Javadoc)

			 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)

			 */

			@Override

			public void widgetSelected(SelectionEvent e) {

				T selection = (T) ((StructuredSelection) tableViewer.getSelection()).getFirstElement();

				VocabularyTermWizard<T> wizard = new VocabularyTermWizard<T>(getTermClass(), selection); 

				WizardDialog dialog = new WizardDialog(StoreUtil.getShell(), wizard);

			    dialog.open();

			    tableViewer.setInput(TermStore.getFeatures());

			    tableViewer.reveal(selection);

			}

		});

	}

	/**

	 * Implement this method in MenuPreference Pages where the vocabulary should be editable, editable flag

	 * is set.

	 */

	protected void addDeleteButtonListeners() {

		removeButton.addSelectionListener(new SelectionAdapter(){

			/* (non-Javadoc)

			 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)

			 */

			@Override

			public void widgetSelected(SelectionEvent e) {

				boolean confirmation = StoreUtil.confirmDialog("Confirm deletion", "Do you really want to delete the selected terms?");

				if(confirmation){

					IStructuredSelection selection = (IStructuredSelection) tableViewer.getSelection();

					Iterator<T> selectionIterator = selection.iterator();

					while(selectionIterator.hasNext()){

						CdmStore.getTermService().delete(selectionIterator.next());

					}

				}

			}

		});

	}

	/** {@inheritDoc} */

	public void init(IWorkbench workbench) {

		setPreferenceStore(PreferencesUtil.getPreferenceStore());

	}

	/*

	 * (non-Javadoc)

	 * @see org.eclipse.jface.preference.PreferencePage#performDefaults()

	 */

	/**

	 * <p>performDefaults</p>

	 */

	protected void performDefaults() {

		tableViewer.setAllChecked(true);

	}

	/**

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

	 *

	 * @return the tableViewer

	 */

	public CheckboxTableViewer getTableViewer() {

		return tableViewer;

	}

	/* (non-Javadoc)

	 * @see org.eclipse.jface.preference.PreferencePage#performOk()

	 */

	/** {@inheritDoc} */

	@Override

	public boolean performOk() {

		if(checkNoneChecked()){

			return false;

		}

		List<T> preferredTerms = new ArrayList<T>();

		for (Object element : getTableViewer().getCheckedElements()){

			preferredTerms.add((T) element);

		}

		PreferencesUtil.setPreferredTerms(preferredTerms, this.terms);

		PreferencesUtil.firePreferencesChanged(this.getClass());

		return true;

	}

	private boolean checkNoneChecked(){

		if(tableViewer.getCheckedElements().length == 0){

			setMessage("Please check at least one item", WARNING);

			return true;

		}else{

			setMessage(null);

			return false;

		}

	}

	/**

	 * <p>getTermClass</p>

	 *

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

	 */

	protected abstract Class<T> getTermClass();

}