TypeDefinitionDialog.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.common.definition.selector;

import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.dialogs.FilteredTree;
import org.eclipse.ui.dialogs.PatternFilter;

import eu.esdihumboldt.hale.common.schema.model.TypeDefinition;
import eu.esdihumboldt.hale.common.schema.model.TypeIndex;
import eu.esdihumboldt.hale.ui.common.definition.viewer.DefinitionComparator;
import eu.esdihumboldt.hale.ui.common.definition.viewer.DefinitionLabelProvider;
import eu.esdihumboldt.hale.ui.common.definition.viewer.TypesContentProvider;
import eu.esdihumboldt.hale.ui.util.selector.AbstractViewerSelectionDialog;

/**
 * Selection dialog for {@link TypeDefinition}s.
 * 
 * @author Simon Templer
 */
public class TypeDefinitionDialog extends AbstractViewerSelectionDialog<TypeDefinition, TreeViewer> {

	/**
	 * The types, either a {@link TypeIndex} or an {@link Iterable} of
	 * {@link TypeDefinition}s.
	 */
	private final Object types;

	/**
	 * Create a type definition selection dialog.
	 * 
	 * @param parentShell the parent shell
	 * @param title the dialog title
	 * @param initialSelection the initial selection
	 * @param types the type index
	 */
	public TypeDefinitionDialog(Shell parentShell, String title, TypeDefinition initialSelection,
			TypeIndex types) {
		super(parentShell, title, initialSelection);

		this.types = types;
	}

	/**
	 * Create a type definition selection dialog.
	 * 
	 * @param parentShell the parent shell
	 * @param title the dialog title
	 * @param initialSelection the initial selection
	 * @param types the type index
	 */
	public TypeDefinitionDialog(Shell parentShell, String title, TypeDefinition initialSelection,
			Iterable<TypeDefinition> types) {
		super(parentShell, title, initialSelection);

		this.types = types;
	}

	@Override
	protected TreeViewer createViewer(Composite parent) {
		// create viewer
		PatternFilter patternFilter = new PatternFilter();
		patternFilter.setIncludeLeadingWildcard(true);
		FilteredTree tree = new FilteredTree(parent, SWT.SINGLE | SWT.H_SCROLL | SWT.V_SCROLL
				| SWT.BORDER, patternFilter, true);
		tree.getViewer().setComparator(new DefinitionComparator());
		return tree.getViewer();
	}

	@Override
	protected void setupViewer(TreeViewer viewer, TypeDefinition initialSelection) {
		viewer.setLabelProvider(new DefinitionLabelProvider(viewer));
		viewer.setContentProvider(new TypesContentProvider(viewer));

		viewer.setInput(types);

		if (initialSelection != null) {
			viewer.setSelection(new StructuredSelection(initialSelection));
		}
	}

	@Override
	protected TypeDefinition getObjectFromSelection(ISelection selection) {
		if (!selection.isEmpty() && selection instanceof IStructuredSelection) {
			Object element = ((IStructuredSelection) selection).getFirstElement();
			if (element instanceof TypeDefinition) {
				return (TypeDefinition) element;
			}
		}

		return null;
	}

}