plugins/org.eclipse.eef.ide.ui/src/org/eclipse/eef/ide/ui/api/widgets/AbstractEEFLifecycleManager.java

/*******************************************************************************
 * Copyright (c) 2016 Obeo.
 * 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:
 *    Obeo - initial API and implementation
 *******************************************************************************/
package org.eclipse.eef.ide.ui.api.widgets;

import org.eclipse.eef.common.ui.api.IEEFFormContainer;
import org.eclipse.eef.core.api.controllers.IEEFController;
import org.eclipse.eef.core.api.controllers.IInvalidValidationRuleResult;
import org.eclipse.eef.core.api.controllers.IValidationRuleResult;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.ui.forms.IMessageManager;

/**
 * Common superclass of all the lifecycle managers.
 *
 * @author sbegaudeau
 */
public abstract class AbstractEEFLifecycleManager implements IEEFLifecycleManager {

	/**
	 * The form container.
	 */
	protected IEEFFormContainer container;

	/**
	 * {@inheritDoc}
	 *
	 * @see org.eclipse.eef.ide.ui.api.widgets.IEEFLifecycleManager#createControl(org.eclipse.swt.widgets.Composite,
	 *      org.eclipse.eef.common.ui.api.IEEFFormContainer)
	 */
	@Override
	public void createControl(Composite parent, IEEFFormContainer formContainer) {
		this.container = formContainer;
	}

	/**
	 * {@inheritDoc}
	 *
	 * @see org.eclipse.eef.ide.ui.api.widgets.IEEFLifecycleManager#aboutToBeShown()
	 */
	@Override
	public void aboutToBeShown() {
		this.getController().onValidation((validationRuleResults) -> {
			IMessageManager messageManager = container.getForm().getMessageManager();

			for (IValidationRuleResult validationRuleResult : validationRuleResults) {
				if (validationRuleResult instanceof IInvalidValidationRuleResult) {
					IInvalidValidationRuleResult result = (IInvalidValidationRuleResult) validationRuleResult;
					if (getValidationControl() != null) {
						messageManager.addMessage(result.getValidationRule(), result.getMessage(), result.getData(), result.getSeverity(),
								getValidationControl());
					} else {
						messageManager.addMessage(result.getValidationRule(), result.getMessage(), result.getData(), result.getSeverity());
					}
				} else {
					if (getValidationControl() != null) {
						messageManager.removeMessage(validationRuleResult.getValidationRule(), getValidationControl());
					} else {
						messageManager.removeMessage(validationRuleResult.getValidationRule());
					}
				}
			}
		});
	}

	/**
	 * Returns the controller.
	 *
	 * @return The controller
	 */
	protected abstract IEEFController getController();

	/**
	 * Returns the control on which the validation marker will appear.
	 *
	 * @return The control used to display the validation marker
	 */
	protected abstract Control getValidationControl();

	/**
	 * {@inheritDoc}
	 *
	 * @see org.eclipse.eef.ide.ui.api.widgets.IEEFLifecycleManager#refresh()
	 */
	@Override
	public void refresh() {
		this.getController().refresh();
	}

	/**
	 * {@inheritDoc}
	 *
	 * @see org.eclipse.eef.ide.ui.api.widgets.IEEFLifecycleManager#aboutToBeHidden()
	 */
	@Override
	public void aboutToBeHidden() {
		this.getController().removeValidationConsumer();
	}
}