AbstractDataView.java

/*
 * Copyright (c) 2012 Data Harmonisation Panel
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Contributors:
 *     HUMBOLDT EU Integrated Project #030962
 *     Data Harmonisation Panel <http://www.dhpanel.eu>
 */
package eu.esdihumboldt.hale.ui.views.data;

import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.IContributionItem;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.action.Separator;
import org.eclipse.jface.layout.GridLayoutFactory;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.FillLayout;
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.part.WorkbenchPart;

import de.fhg.igd.eclipse.ui.util.extension.exclusive.ExclusiveExtensionContribution;
import de.fhg.igd.eclipse.util.extension.exclusive.ExclusiveExtension;
import de.fhg.igd.eclipse.util.extension.exclusive.ExclusiveExtension.ExclusiveExtensionListener;
import eu.esdihumboldt.hale.common.instance.model.Instance;
import eu.esdihumboldt.hale.common.schema.SchemaSpaceID;
import eu.esdihumboldt.hale.common.schema.model.TypeDefinition;
import eu.esdihumboldt.hale.ui.util.selection.SelectionProviderFacade;
import eu.esdihumboldt.hale.ui.views.data.internal.DataViewPlugin;
import eu.esdihumboldt.hale.ui.views.data.internal.extension.InstanceViewController;
import eu.esdihumboldt.hale.ui.views.data.internal.extension.InstanceViewFactory;
import eu.esdihumboldt.hale.ui.views.data.internal.filter.InstanceSelectionListener;
import eu.esdihumboldt.hale.ui.views.data.internal.filter.InstanceSelector;
import eu.esdihumboldt.hale.ui.views.data.internal.filter.WindowSelectionSelector;
import eu.esdihumboldt.hale.ui.views.properties.PropertiesViewPart;

/**
 * Table view that shows information about certain features
 * 
 * @author Thorsten Reitz
 * @author Simon Templer
 * @partner 01 / Fraunhofer Institute for Computer Graphics Research
 */
public abstract class AbstractDataView extends PropertiesViewPart
		implements InstanceSelectionListener {

	/**
	 * Action for toggling if an instance selection is provided by the view.
	 */
	public class ToggleProvideSelectionAction extends Action {

		/**
		 * Default constructor
		 */
		public ToggleProvideSelectionAction() {
			super("", AS_CHECK_BOX);

			updateText();
			setImageDescriptor(DataViewPlugin.getImageDescriptor("icons/map.gif"));
			setChecked(isProvideInstanceSelection());

			addPropertyChangeListener(new IPropertyChangeListener() {

				@Override
				public void propertyChange(PropertyChangeEvent event) {
					if (event.getProperty().equals(CHECKED)) {
						setProvideInstanceSelection((Boolean) event.getNewValue());
						updateText();
					}
				}
			});
		}

		/**
		 * Update the action text
		 */
		private void updateText() {
			setToolTipText((isProvideInstanceSelection())
					? ("Disable providing an application instance selection (e.g. for the map)")
					: ("Enable providing an instance selection for the application, e.g. for display in the map"));
		}

	}

	/**
	 * The instance viewer
	 */
	private InstanceViewer viewer;

	private Composite selectorComposite;

	private InstanceSelector instanceSelector;

	private Control selectorControl;

	private Composite viewerComposite;

	private final InstanceViewController controller;

	private TypeDefinition lastType;

	private Iterable<Instance> lastSelection;

	private final SelectionProviderFacade selectionFacade = new SelectionProviderFacade();

	private boolean provideInstanceSelection = false;

	private final InstanceSelector defaultInstanceSelector;

	private final SchemaSpaceID schemaSpace;

	/**
	 * Creates a table view
	 * 
	 * @param instanceSelector the feature selector
	 * @param schemaSpace the represented schema space
	 * @param controllerPreferenceKey the preference key for storing the
	 *            instance view controller configuration
	 */
	public AbstractDataView(InstanceSelector instanceSelector, SchemaSpaceID schemaSpace,
			String controllerPreferenceKey) {
		super();

		this.defaultInstanceSelector = instanceSelector;
		this.schemaSpace = schemaSpace;
		this.controller = new InstanceViewController(
				DataViewPlugin.getDefault().getPreferenceStore(), controllerPreferenceKey);
	}

	/**
	 * Get the default instance selector.
	 * 
	 * @return the default instance selector
	 */
	public InstanceSelector getDefaultInstanceSelector() {
		return defaultInstanceSelector;
	}

	/**
	 * @see eu.esdihumboldt.hale.ui.views.properties.PropertiesViewPart#createViewControl(org.eclipse.swt.widgets.Composite)
	 */
	@Override
	public void createViewControl(Composite parent) {
		Composite page = new Composite(parent, SWT.NONE);
		GridData data = new GridData(SWT.FILL, SWT.FILL, true, true);
		data.heightHint = 300;
		page.setLayoutData(data);
		page.setLayout(GridLayoutFactory.fillDefaults().numColumns(1).create());

		// bar composite
		Composite bar = new Composite(page, SWT.NONE);
		bar.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, false));

		GridLayout gridLayout;
		// if (showBackgroundProcess())
		gridLayout = new GridLayout(3, false);
		// else
		// gridLayout = new GridLayout(2, false);
		gridLayout.marginWidth = 3;
		gridLayout.marginHeight = 2;
		gridLayout.verticalSpacing = 0;
		gridLayout.horizontalSpacing = 0;
		bar.setLayout(gridLayout);

		// custom control composite
		Composite custom = new Composite(bar, SWT.NONE);
		custom.setLayoutData(new GridData(SWT.CENTER, SWT.CENTER, false, false));
		provideCustomControls(custom);

		// selector composite
		selectorComposite = new Composite(bar, SWT.NONE);
		selectorComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, false));
		gridLayout = new GridLayout(1, false);
		gridLayout.marginWidth = 0;
		gridLayout.marginHeight = 0;
		gridLayout.verticalSpacing = 0;
		gridLayout.horizontalSpacing = 0;
		selectorComposite.setLayout(gridLayout);

		// Background process progressbar
		Composite backgroundProcessComposite = new Composite(bar, SWT.NONE);
		backgroundProcessComposite
				.setLayoutData(new GridData(SWT.CENTER, SWT.CENTER, false, false));
		provideBackgroundProcessControl(backgroundProcessComposite);

		// tree composite
		viewerComposite = new Composite(page, SWT.NONE);
		viewerComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));

		// tree column layout
		FillLayout fillLayout = new FillLayout();
		fillLayout.marginHeight = 0;
		fillLayout.marginWidth = 0;
		viewerComposite.setLayout(fillLayout);

		fillActionBars();

		// selector
		setInstanceSelector(defaultInstanceSelector);

		// tree viewer
		updateViewer(controller.getCurrent());

		controller
				.addListener(new ExclusiveExtensionListener<InstanceViewer, InstanceViewFactory>() {

					@Override
					public void currentObjectChanged(InstanceViewer current,
							InstanceViewFactory definition) {
						updateViewer(current);
					}
				});

		getSite().setSelectionProvider(selectionFacade);
	}

	/**
	 * Fill the action bars
	 */
	private void fillActionBars() {
		IContributionItem viewSelector = new ExclusiveExtensionContribution<InstanceViewer, InstanceViewFactory>() {

			@Override
			protected ExclusiveExtension<InstanceViewer, InstanceViewFactory> initExtension() {
				return controller;
			}
		};

		IToolBarManager toolbar = getViewSite().getActionBars().getToolBarManager();
		toolbar.add(viewSelector);
		toolbar.add(new Separator());
		toolbar.add(new ToggleProvideSelectionAction());

		IMenuManager menu = getViewSite().getActionBars().getMenuManager();
		menu.add(viewSelector);
	}

	/**
	 * Update on viewer change.
	 * 
	 * @param viewer the new viewer
	 */
	private void updateViewer(InstanceViewer viewer) {
		if (this.viewer != null) {
			// dispose old viewer
			this.viewer.getControl().dispose();
		}

		// create new viewer controls
		viewer.createControls(viewerComposite, schemaSpace);

		viewer.setInput(lastType, lastSelection);

		viewerComposite.layout(true, true);

		this.viewer = viewer;

		// setup selection provider
		updateSelectionProvider();
//		new ViewerMenu(getSite(), viewer.getViewer());
	}

	/**
	 * Update the selection provider when either the instance viewer or instance
	 * selector have changed.
	 */
	protected void updateSelectionProvider() {
		if (viewer == null || !provideInstanceSelection
				|| getInstanceSelector() instanceof WindowSelectionSelector) {
			selectionFacade.setSelectionProvider(null);
		}
		else {
			selectionFacade.setSelectionProvider(viewer.getInstanceSelectionProvider());// .getViewer());
		}
	}

	/**
	 * Add custom controls. Override this method to add custom controls
	 * 
	 * @param parent the parent composite
	 */
	protected void provideCustomControls(Composite parent) {
		GridData gd = new GridData(SWT.CENTER, SWT.CENTER, false, false);
		// empty composite trick: exclude
		gd.exclude = true;
		parent.setLayoutData(gd);
	}

	/**
	 * @see WorkbenchPart#setFocus()
	 */
	@Override
	public void setFocus() {
		viewer.getViewer().getControl().setFocus();
	}

	/**
	 * @return the instance selector
	 */
	public InstanceSelector getInstanceSelector() {
		return instanceSelector;
	}

	/**
	 * Set the current instance selector.
	 * 
	 * @param instanceSelector the instance selector to set
	 */
	public void setInstanceSelector(InstanceSelector instanceSelector) {
		if (this.instanceSelector == instanceSelector)
			return;

		selectionFacade.setSelectionProvider(null); // disable selection

		// remove listener
		if (this.instanceSelector != null)
			this.instanceSelector.removeSelectionListener(this);

		this.instanceSelector = instanceSelector;

		// remove old control
		if (selectorControl != null) {
			selectorControl.dispose();
		}

		// add listener
		instanceSelector.addSelectionListener(this);

		// if want to disable Controls on implemented Class prior to create
		// Selctor Control
		enableControls(false);
		// create new control
		selectorControl = instanceSelector.createControl(selectorComposite);
		selectorControl.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, false));
		// enable control if disable it before
		enableControls(true);

		updateSelectionProvider();

		// re-layout
		selectorComposite.getParent().getParent().layout(true, true);
	}

	/**
	 * @see eu.esdihumboldt.hale.ui.views.data.internal.filter.InstanceSelectionListener#preSelectionChange()
	 */
	@Override
	public void preSelectionChange() {
		// disable controls
		enableControls(false);
	}

	@Override
	public void selectionChanged(TypeDefinition type, Iterable<Instance> selection) {
		if (viewer != null) {
			viewer.setInput(type, selection);
		}
		lastType = type;
		lastSelection = selection;
		onSelectionChange(selection);
	}

	/**
	 * @see eu.esdihumboldt.hale.ui.views.data.internal.filter.InstanceSelectionListener#postSelectionChange()
	 */
	@Override
	public void postSelectionChange() {
		// enable controls again
		enableControls(true);
	}

	/**
	 * Called when the selection has changed
	 * 
	 * @param selection the current selection
	 */
	protected void onSelectionChange(Iterable<Instance> selection) {
		// do nothing
	}

	/**
	 * @see WorkbenchPart#dispose()
	 */
	@Override
	public void dispose() {
		if (selectorControl != null) {
			selectorControl.dispose();
		}
	}

	/**
	 * @return the provideInstanceSelection
	 */
	private boolean isProvideInstanceSelection() {
		return provideInstanceSelection;
	}

	/**
	 * @param provideInstanceSelection the provideInstanceSelection to set
	 */
	private void setProvideInstanceSelection(boolean provideInstanceSelection) {
		this.provideInstanceSelection = provideInstanceSelection;

		updateSelectionProvider();
	}

	/**
	 * Override this to enable/disable controls while creating Selector controls
	 * in {@link #setInstanceSelector(InstanceSelector)}
	 * 
	 * @param enable false, to disable controls and true, to enable controls
	 */
	protected void enableControls(boolean enable) {
		// do nothing
	}

//	/**
//	 * Override this to show background process progress bar in bar control.
//	 * 
//	 * @return boolean if true, then progress bar will be added to view. if
//	 *         false, then progress bar will not be added to view.
//	 */
//	protected boolean showBackgroundProcess() {
//		return false;
//	}

	/**
	 * Override this method to provide background process controls.
	 * 
	 * @param parent the parent composite
	 */
	protected void provideBackgroundProcessControl(Composite parent) {
		GridData gd = new GridData(SWT.CENTER, SWT.CENTER, false, false);
		// empty composite trick: exclude
		gd.exclude = true;
		parent.setLayoutData(gd);
	}

}