bundles/common/org.eclipse.apogy.common.emf.ui/src/org/eclipse/apogy/common/emf/ui/wizards/ChooseChildEReferenceWizardPage.java

/*******************************************************************************
 * Copyright (c) 2018 Agence spatiale canadienne / Canadian Space Agency 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Pierre Allard, 
 *     Regent L'Archeveque,
 *     Olivier L. Larouche - initial API and implementation
 * SPDX-License-Identifier: EPL-1.0
 *     
 *******************************************************************************/
package org.eclipse.apogy.common.emf.ui.wizards;

import org.eclipse.apogy.common.emf.ui.composites.EObjectListComposite;
import org.eclipse.apogy.common.emf.ui.composites.SubClassesListComposite;
import org.eclipse.emf.common.notify.Adapter;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.common.notify.impl.AdapterImpl;
import org.eclipse.emf.common.util.BasicEList;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EReference;
import org.eclipse.jface.dialogs.IDialogPage;
import org.eclipse.jface.viewers.StyledCellLabelProvider;
import org.eclipse.jface.viewers.TreeSelection;
import org.eclipse.jface.viewers.ViewerCell;
import org.eclipse.jface.wizard.WizardPage;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;

public class ChooseChildEReferenceWizardPage extends WizardPage {

	private final static String WIZARD_PAGE_ID = "org.eclipse.apogy.common.emf.ui.wizards.ChooseChildEReferenceWizardPage";

	private EObjectListComposite eReferencesListComposite;
	private SubClassesListComposite subClassesListComposite;
	private Adapter adapter;
	private EList<EReference> childEReferences;

	/**
	 * Constructor for the WizardPage.
	 * 
	 * @param pageName
	 */
	public ChooseChildEReferenceWizardPage() {
		super(WIZARD_PAGE_ID);
		setTitle("New Child");
		setDescription("Select the new child's reference and type.");
	}

	public ChooseChildEReferenceWizardPage(EList<EReference> childEReferences) {
		this();
		if (this.childEReferences != null) {
			for (int i = 0; i < childEReferences.size(); i++) {
				this.childEReferences.get(i).eAdapters().remove(getAdapter());
			}
		}

		this.childEReferences = childEReferences;

		for (int i = 0; i < childEReferences.size(); i++) {
			this.childEReferences.get(i).eAdapters().add(getAdapter());
		}
	}

	private Adapter getAdapter() {
		if (this.adapter == null) {
			this.adapter = new AdapterImpl() {
				@Override
				public void notifyChanged(Notification msg) {
					validate();
				}
			};
		}
		return this.adapter;
	}

	/**
	 * @see IDialogPage#createControl(Composite)
	 */
	@Override
	public void createControl(Composite parent) {
		Composite container = new Composite(parent, SWT.None);
		container.setLayout(new GridLayout(2, false));

		Label referenceLabel = new Label(container, SWT.None);
		referenceLabel.setText("Reference");
		Label typeLabel = new Label(container, SWT.None);
		typeLabel.setText("Type");

		this.eReferencesListComposite = new EObjectListComposite(container, SWT.None) {
			@Override
			protected void newSelection(TreeSelection selection) {
				// Sets the eClassList of the EObjectListComposite of EClasses
				if (ChooseChildEReferenceWizardPage.this.subClassesListComposite != null) {
					ChooseChildEReferenceWizardPage.this
							.setEClassListCompositeList((EReference) this.getSelectedEObject());
				}
				ChooseChildEReferenceWizardPage.this.validate();
			}

			@Override
			protected StyledCellLabelProvider getLabelProvider() {
				return new EReferenceLabelProvider();
			}
		};

		EList<EObject> eObjectsEReferenceList = new BasicEList<EObject>();
		eObjectsEReferenceList.addAll(this.childEReferences);
		this.eReferencesListComposite.setEObjectsList(eObjectsEReferenceList);
		this.eReferencesListComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1));

		this.subClassesListComposite = new SubClassesListComposite(container, SWT.None) {
			@Override
			protected void newSelection(TreeSelection selection) {
				ChooseChildEReferenceWizardPage.this.validate();
			}

			@Override
			protected StyledCellLabelProvider getLabelProvider() {
				return new EClassLabelProvider();
			}
		};

		if (this.eReferencesListComposite.getSelectedEObject() != null) {
			setEClassListCompositeList((EReference) this.eReferencesListComposite.getSelectedEObject());
		}
		this.subClassesListComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1));
		this.eReferencesListComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1));

		setControl(container);
		validate();
	}

	/**
	 * Gets the selected {@link EReference} in the {@link EObjectListComposite} of
	 * EReferences
	 * 
	 * @return EReference The {@link EReference} selected by the user
	 */
	public EReference getSelectedEReference() {
		return (EReference) this.eReferencesListComposite.getSelectedEObject();
	}

	/**
	 * Returns the selected {@link EClass} in the {@link EObjectListComposite} of
	 * EClasses
	 * 
	 * @return EReference The {@link EClass} selected by the user
	 */
	public EClass getSelectedEClass() {
		return this.subClassesListComposite.getSelectedSubClass();
	}

	/**
	 * Gets all the possible sub classes of an {@link EReference} and sets this list
	 * in the list of {@link EObject} in the {@link EObjectListComposite} of
	 * EClasses
	 * 
	 * @param eReference
	 */
	private void setEClassListCompositeList(EReference eReference) {
		this.subClassesListComposite
				.setSuperClass(((EReference) this.eReferencesListComposite.getSelectedEObject()).getEReferenceType());
	}

	/**
	 * Label provider of the EReferencesListComposite
	 */
	private class EReferenceLabelProvider extends StyledCellLabelProvider {
		@Override
		public void update(ViewerCell cell) {
			if (cell.getElement() instanceof EReference) {
				cell.setText(((EReference) cell.getElement()).getName());
			}
		}

		@Override
		public String getToolTipText(Object element) {
			if (element instanceof EClass) {
				return ((EClass) element).getInstanceClassName();
			}
			return super.getToolTipText(element);
		}

		@Override
		public Point getToolTipShift(Object object) {
			return new Point(5, 5);
		}

		@Override
		public int getToolTipDisplayDelayTime(Object object) {
			return 500;
		}

		@Override
		public int getToolTipTimeDisplayed(Object object) {
			return 5000;
		}
	}

	/**
	 * Label provider of the EClassesListComposite
	 */
	private class EClassLabelProvider extends StyledCellLabelProvider {
		@Override
		public void update(ViewerCell cell) {
			if (cell.getElement() instanceof EClass) {
				cell.setText(((EClass) cell.getElement()).getName());
			}
		}

		@Override
		public String getToolTipText(Object element) {
			if (element instanceof EClass) {
				return ((EClass) element).getInstanceClassName();
			}
			return super.getToolTipText(element);
		}

		@Override
		public Point getToolTipShift(Object object) {
			return new Point(5, 5);
		}

		@Override
		public int getToolTipDisplayDelayTime(Object object) {
			return 500;
		}

		@Override
		public int getToolTipTimeDisplayed(Object object) {
			return 5000;
		}
	}

	@Override
	public void dispose() {
		super.dispose();
		if (this.childEReferences != null) {
			for (int i = 0; i < this.childEReferences.size(); i++) {
				this.childEReferences.get(i).eAdapters().remove(getAdapter());
			}
		}
	}

	/**
	 * This method is invoked to validate the content.
	 */
	protected void validate() {
		String errorEReference = "";
		String errorEClass = "";

		if (this.eReferencesListComposite.getSelectedEObject() == null) {
			errorEReference = "<Reference> ";
		}
		if (this.subClassesListComposite == null || this.subClassesListComposite.getSelectedSubClass() == null) {
			errorEClass = "<Type> ";
		}

		if (errorEReference != "" || errorEClass != "") {
			setErrorMessage(errorEReference + errorEClass + "must be selected");
			setPageComplete(false);
		} else {
			setErrorMessage(null);
			setPageComplete(true);
		}
	}
}