bundles/org.eclipse.jface.databinding/src/org/eclipse/jface/databinding/dialog/TitleAreaDialogSupport.java - e4/org.eclipse.e4.databinding - Git at Google

 /*******************************************************************************
  * Copyright (c) 2008, 2010 Matthew Hall and others.
  * 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:
  *     IBM Corporation - initial API and implementation
  *        (through WizardPageSupport.java)
  *     Matthew Hall - initial API and implementation (bug 239900)
  *     Ben Vitale <bvitale3002@yahoo.com> - bug 263100
  *     Kai Schlamp - bug 275058
  *     Matthew Hall - bugs 275058, 278550
  *     Ovidio Mallo - bug 248877
  ******************************************************************************/

 package org.eclipse.jface.databinding.dialog;

 import java.util.Iterator;

 import org.eclipse.core.databinding.DataBindingContext;
 import org.eclipse.core.databinding.ValidationStatusProvider;
 import org.eclipse.core.databinding.observable.ChangeEvent;
 import org.eclipse.core.databinding.observable.IChangeListener;
 import org.eclipse.core.databinding.observable.IObservable;
 import org.eclipse.core.databinding.observable.ObservableTracker;
 import org.eclipse.core.databinding.observable.list.IListChangeListener;
 import org.eclipse.core.databinding.observable.list.IObservableList;
 import org.eclipse.core.databinding.observable.list.ListChangeEvent;
 import org.eclipse.core.databinding.observable.list.ListDiff;
 import org.eclipse.core.databinding.observable.list.ListDiffEntry;
 import org.eclipse.core.databinding.observable.value.IObservableValue;
 import org.eclipse.core.databinding.observable.value.IValueChangeListener;
 import org.eclipse.core.databinding.observable.value.ValueChangeEvent;
 import org.eclipse.core.databinding.util.Policy;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.MultiStatus;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.jface.dialogs.IMessageProvider;
 import org.eclipse.jface.dialogs.TitleAreaDialog;
 import org.eclipse.swt.events.DisposeEvent;
 import org.eclipse.swt.events.DisposeListener;

 /**
  * Connects the validation result from the given data binding context to the
  * given TitleAreaDialog, updating the dialog's error message accordingly.
  *
  * @noextend This class is not intended to be subclassed by clients.
  *
  * @since 1.3
  */
 public class TitleAreaDialogSupport {
 	/**
 	 * Connect the validation result from the given data binding context to the
 	 * given TitleAreaDialog. The page's error message will not be set at time
 	 * of creation, ensuring that the dialog does not show an error right away.
 	 * Upon any validation result change, the dialog's error message will be
 	 * updated according to the current validation result.
 	 *
 	 * @param dialog
 	 * @param dbc
 	 * @return an instance of TitleAreaDialogSupport
 	 */
 	public static TitleAreaDialogSupport create(TitleAreaDialog dialog,
 			DataBindingContext dbc) {
 		return new TitleAreaDialogSupport(dialog, dbc);
 	}

 	private TitleAreaDialog dialog;
 	private DataBindingContext dbc;
 	private IValidationMessageProvider messageProvider = new ValidationMessageProvider();
 	private IObservableValue aggregateStatusProvider;
 	private boolean uiChanged = false;
 	private IChangeListener uiChangeListener = new IChangeListener() {
 		public void handleChange(ChangeEvent event) {
 			handleUIChanged();
 		}
 	};
 	private IListChangeListener validationStatusProvidersListener = new IListChangeListener() {
 		public void handleListChange(ListChangeEvent event) {
 			ListDiff diff = event.diff;
 			ListDiffEntry[] differences = diff.getDifferences();
 			for (int i = 0; i < differences.length; i++) {
 				ListDiffEntry listDiffEntry = differences[i];
 				ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) listDiffEntry
 						.getElement();
 				IObservableList targets = validationStatusProvider.getTargets();
 				if (listDiffEntry.isAddition()) {
 					targets
 							.addListChangeListener(validationStatusProviderTargetsListener);
 					for (Iterator it = targets.iterator(); it.hasNext();) {
 						((IObservable) it.next())
 								.addChangeListener(uiChangeListener);
 					}
 				} else {
 					targets
 							.removeListChangeListener(validationStatusProviderTargetsListener);
 					for (Iterator it = targets.iterator(); it.hasNext();) {
 						((IObservable) it.next())
 								.removeChangeListener(uiChangeListener);
 					}
 				}
 			}
 		}
 	};
 	private IListChangeListener validationStatusProviderTargetsListener = new IListChangeListener() {
 		public void handleListChange(ListChangeEvent event) {
 			ListDiff diff = event.diff;
 			ListDiffEntry[] differences = diff.getDifferences();
 			for (int i = 0; i < differences.length; i++) {
 				ListDiffEntry listDiffEntry = differences[i];
 				IObservable target = (IObservable) listDiffEntry.getElement();
 				if (listDiffEntry.isAddition()) {
 					target.addChangeListener(uiChangeListener);
 				} else {
 					target.removeChangeListener(uiChangeListener);
 				}
 			}
 		}
 	};
 	private ValidationStatusProvider currentStatusProvider;
 	private IStatus currentStatus;

 	private TitleAreaDialogSupport(TitleAreaDialog dialogPage,
 			DataBindingContext dbc) {
 		this.dialog = dialogPage;
 		this.dbc = dbc;
 		init();
 	}

 	/**
 	 * Sets the {@link IValidationMessageProvider} to use for providing the
 	 * message text and message type to display on the title area dialog.
 	 *
 	 * @param messageProvider
 	 *            The {@link IValidationMessageProvider} to use for providing
 	 *            the message text and message type to display on the title area
 	 *            dialog.
 	 *
 	 * @since 1.4
 	 */
 	public void setValidationMessageProvider(
 			IValidationMessageProvider messageProvider) {
 		this.messageProvider = messageProvider;
 		handleStatusChanged();
 	}

 	private void init() {
 		ObservableTracker.setIgnore(true);
 		try {
 			aggregateStatusProvider = new MaxSeverityValidationStatusProvider(
 					dbc);
 		} finally {
 			ObservableTracker.setIgnore(false);
 		}

 		aggregateStatusProvider
 				.addValueChangeListener(new IValueChangeListener() {
 					public void handleValueChange(ValueChangeEvent event) {
 						statusProviderChanged();
 					}
 				});
 		dialog.getShell().addDisposeListener(new DisposeListener() {
 			public void widgetDisposed(DisposeEvent e) {
 				dispose();
 			}
 		});
 		statusProviderChanged();
 		dbc.getValidationStatusProviders().addListChangeListener(
 				validationStatusProvidersListener);
 		for (Iterator it = dbc.getValidationStatusProviders().iterator(); it
 				.hasNext();) {
 			ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) it
 					.next();
 			IObservableList targets = validationStatusProvider.getTargets();
 			targets
 					.addListChangeListener(validationStatusProviderTargetsListener);
 			for (Iterator iter = targets.iterator(); iter.hasNext();) {
 				((IObservable) iter.next()).addChangeListener(uiChangeListener);
 			}
 		}
 	}

 	private void statusProviderChanged() {
 		currentStatusProvider = (ValidationStatusProvider) aggregateStatusProvider
 				.getValue();
 		if (currentStatusProvider != null) {
 			currentStatus = (IStatus) currentStatusProvider
 					.getValidationStatus().getValue();
 		} else {
 			currentStatus = null;
 		}
 		handleStatusChanged();
 	}

 	private void handleUIChanged() {
 		uiChanged = true;
 		if (currentStatus != null) {
 			handleStatusChanged();
 		}
 		dbc.getValidationStatusProviders().removeListChangeListener(
 				validationStatusProvidersListener);
 		for (Iterator it = dbc.getValidationStatusProviders().iterator(); it
 				.hasNext();) {
 			ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) it
 					.next();
 			IObservableList targets = validationStatusProvider.getTargets();
 			targets
 					.removeListChangeListener(validationStatusProviderTargetsListener);
 			for (Iterator iter = targets.iterator(); iter.hasNext();) {
 				((IObservable) iter.next())
 						.removeChangeListener(uiChangeListener);
 			}
 		}
 	}

 	private void handleStatusChanged() {
 		if (dialog.getShell() == null || dialog.getShell().isDisposed())
 			return;
 		String message = messageProvider.getMessage(currentStatusProvider);
 		int type = messageProvider.getMessageType(currentStatusProvider);
 		if (type == IMessageProvider.ERROR) {
 			dialog.setMessage(null);
 			dialog.setErrorMessage(uiChanged ? message : null);
 			if (currentStatus != null && currentStatusHasException()) {
 				handleStatusException();
 			}
 		} else {
 			dialog.setErrorMessage(null);
 			dialog.setMessage(message, type);
 		}
 	}

 	private boolean currentStatusHasException() {
 		boolean hasException = false;
 		if (currentStatus.getException() != null) {
 			hasException = true;
 		}
 		if (currentStatus instanceof MultiStatus) {
 			MultiStatus multiStatus = (MultiStatus) currentStatus;

 			for (int i = 0; i < multiStatus.getChildren().length; i++) {
 				IStatus status = multiStatus.getChildren()[i];
 				if (status.getException() != null) {
 					hasException = true;
 					break;
 				}
 			}
 		}
 		return hasException;
 	}

 	/**
 	 * This is called when a Override to provide custom exception handling and
 	 * reporting.
 	 */
 	private void handleStatusException() {
 		if (currentStatus.getException() != null) {
 			logThrowable(currentStatus.getException());
 		} else if (currentStatus instanceof MultiStatus) {
 			MultiStatus multiStatus = (MultiStatus) currentStatus;
 			for (int i = 0; i < multiStatus.getChildren().length; i++) {
 				IStatus status = multiStatus.getChildren()[i];
 				if (status.getException() != null) {
 					logThrowable(status.getException());
 				}
 			}
 		}
 	}

 	private void logThrowable(Throwable throwable) {
 		Policy
 				.getLog()
 				.log(
 						new Status(
 								IStatus.ERROR,
 								Policy.JFACE_DATABINDING,
 								IStatus.OK,
 								"Unhandled exception: " + throwable.getMessage(), throwable)); //$NON-NLS-1$
 	}

 	/**
 	 * Disposes of this title area dialog support object, removing any listeners
 	 * it may have attached.
 	 */
 	public void dispose() {
 		if (aggregateStatusProvider != null)
 			aggregateStatusProvider.dispose();
 		if (dbc != null && !uiChanged) {
 			for (Iterator it = dbc.getValidationStatusProviders().iterator(); it
 					.hasNext();) {
 				ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) it
 						.next();
 				IObservableList targets = validationStatusProvider.getTargets();
 				targets
 						.removeListChangeListener(validationStatusProviderTargetsListener);
 				for (Iterator iter = targets.iterator(); iter.hasNext();) {
 					((IObservable) iter.next())
 							.removeChangeListener(uiChangeListener);
 				}
 			}
 			dbc.getValidationStatusProviders().removeListChangeListener(
 					validationStatusProvidersListener);
 		}
 		aggregateStatusProvider = null;
 		dbc = null;
 		uiChangeListener = null;
 		validationStatusProvidersListener = null;
 		validationStatusProviderTargetsListener = null;
 		dialog = null;
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2008, 2010 Matthew Hall and others.
	* 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:
	* IBM Corporation - initial API and implementation
	* (through WizardPageSupport.java)
	* Matthew Hall - initial API and implementation (bug 239900)
	* Ben Vitale <bvitale3002@yahoo.com> - bug 263100
	* Kai Schlamp - bug 275058
	* Matthew Hall - bugs 275058, 278550
	* Ovidio Mallo - bug 248877
	******************************************************************************/

	package org.eclipse.jface.databinding.dialog;

	import java.util.Iterator;

	import org.eclipse.core.databinding.DataBindingContext;
	import org.eclipse.core.databinding.ValidationStatusProvider;
	import org.eclipse.core.databinding.observable.ChangeEvent;
	import org.eclipse.core.databinding.observable.IChangeListener;
	import org.eclipse.core.databinding.observable.IObservable;
	import org.eclipse.core.databinding.observable.ObservableTracker;
	import org.eclipse.core.databinding.observable.list.IListChangeListener;
	import org.eclipse.core.databinding.observable.list.IObservableList;
	import org.eclipse.core.databinding.observable.list.ListChangeEvent;
	import org.eclipse.core.databinding.observable.list.ListDiff;
	import org.eclipse.core.databinding.observable.list.ListDiffEntry;
	import org.eclipse.core.databinding.observable.value.IObservableValue;
	import org.eclipse.core.databinding.observable.value.IValueChangeListener;
	import org.eclipse.core.databinding.observable.value.ValueChangeEvent;
	import org.eclipse.core.databinding.util.Policy;
	import org.eclipse.core.runtime.IStatus;
	import org.eclipse.core.runtime.MultiStatus;
	import org.eclipse.core.runtime.Status;
	import org.eclipse.jface.dialogs.IMessageProvider;
	import org.eclipse.jface.dialogs.TitleAreaDialog;
	import org.eclipse.swt.events.DisposeEvent;
	import org.eclipse.swt.events.DisposeListener;

	/**
	* Connects the validation result from the given data binding context to the
	* given TitleAreaDialog, updating the dialog's error message accordingly.
	*
	* @noextend This class is not intended to be subclassed by clients.
	*
	* @since 1.3
	*/
	public class TitleAreaDialogSupport {
	/**
	* Connect the validation result from the given data binding context to the
	* given TitleAreaDialog. The page's error message will not be set at time
	* of creation, ensuring that the dialog does not show an error right away.
	* Upon any validation result change, the dialog's error message will be
	* updated according to the current validation result.
	*
	* @param dialog
	* @param dbc
	* @return an instance of TitleAreaDialogSupport
	*/
	public static TitleAreaDialogSupport create(TitleAreaDialog dialog,
	DataBindingContext dbc) {
	return new TitleAreaDialogSupport(dialog, dbc);
	}

	private TitleAreaDialog dialog;
	private DataBindingContext dbc;
	private IValidationMessageProvider messageProvider = new ValidationMessageProvider();
	private IObservableValue aggregateStatusProvider;
	private boolean uiChanged = false;
	private IChangeListener uiChangeListener = new IChangeListener() {
	public void handleChange(ChangeEvent event) {
	handleUIChanged();
	}
	};
	private IListChangeListener validationStatusProvidersListener = new IListChangeListener() {
	public void handleListChange(ListChangeEvent event) {
	ListDiff diff = event.diff;
	ListDiffEntry[] differences = diff.getDifferences();
	for (int i = 0; i < differences.length; i++) {
	ListDiffEntry listDiffEntry = differences[i];
	ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) listDiffEntry
	.getElement();
	IObservableList targets = validationStatusProvider.getTargets();
	if (listDiffEntry.isAddition()) {
	targets
	.addListChangeListener(validationStatusProviderTargetsListener);
	for (Iterator it = targets.iterator(); it.hasNext();) {
	((IObservable) it.next())
	.addChangeListener(uiChangeListener);
	}
	} else {
	targets
	.removeListChangeListener(validationStatusProviderTargetsListener);
	for (Iterator it = targets.iterator(); it.hasNext();) {
	((IObservable) it.next())
	.removeChangeListener(uiChangeListener);
	}
	}
	}
	}
	};
	private IListChangeListener validationStatusProviderTargetsListener = new IListChangeListener() {
	public void handleListChange(ListChangeEvent event) {
	ListDiff diff = event.diff;
	ListDiffEntry[] differences = diff.getDifferences();
	for (int i = 0; i < differences.length; i++) {
	ListDiffEntry listDiffEntry = differences[i];
	IObservable target = (IObservable) listDiffEntry.getElement();
	if (listDiffEntry.isAddition()) {
	target.addChangeListener(uiChangeListener);
	} else {
	target.removeChangeListener(uiChangeListener);
	}
	}
	}
	};
	private ValidationStatusProvider currentStatusProvider;
	private IStatus currentStatus;

	private TitleAreaDialogSupport(TitleAreaDialog dialogPage,
	DataBindingContext dbc) {
	this.dialog = dialogPage;
	this.dbc = dbc;
	init();
	}

	/**
	* Sets the {@link IValidationMessageProvider} to use for providing the
	* message text and message type to display on the title area dialog.
	*
	* @param messageProvider
	* The {@link IValidationMessageProvider} to use for providing
	* the message text and message type to display on the title area
	* dialog.
	*
	* @since 1.4
	*/
	public void setValidationMessageProvider(
	IValidationMessageProvider messageProvider) {
	this.messageProvider = messageProvider;
	handleStatusChanged();
	}

	private void init() {
	ObservableTracker.setIgnore(true);
	try {
	aggregateStatusProvider = new MaxSeverityValidationStatusProvider(
	dbc);
	} finally {
	ObservableTracker.setIgnore(false);
	}

	aggregateStatusProvider
	.addValueChangeListener(new IValueChangeListener() {
	public void handleValueChange(ValueChangeEvent event) {
	statusProviderChanged();
	}
	});
	dialog.getShell().addDisposeListener(new DisposeListener() {
	public void widgetDisposed(DisposeEvent e) {
	dispose();
	}
	});
	statusProviderChanged();
	dbc.getValidationStatusProviders().addListChangeListener(
	validationStatusProvidersListener);
	for (Iterator it = dbc.getValidationStatusProviders().iterator(); it
	.hasNext();) {
	ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) it
	.next();
	IObservableList targets = validationStatusProvider.getTargets();
	targets
	.addListChangeListener(validationStatusProviderTargetsListener);
	for (Iterator iter = targets.iterator(); iter.hasNext();) {
	((IObservable) iter.next()).addChangeListener(uiChangeListener);
	}
	}
	}

	private void statusProviderChanged() {
	currentStatusProvider = (ValidationStatusProvider) aggregateStatusProvider
	.getValue();
	if (currentStatusProvider != null) {
	currentStatus = (IStatus) currentStatusProvider
	.getValidationStatus().getValue();
	} else {
	currentStatus = null;
	}
	handleStatusChanged();
	}

	private void handleUIChanged() {
	uiChanged = true;
	if (currentStatus != null) {
	handleStatusChanged();
	}
	dbc.getValidationStatusProviders().removeListChangeListener(
	validationStatusProvidersListener);
	for (Iterator it = dbc.getValidationStatusProviders().iterator(); it
	.hasNext();) {
	ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) it
	.next();
	IObservableList targets = validationStatusProvider.getTargets();
	targets
	.removeListChangeListener(validationStatusProviderTargetsListener);
	for (Iterator iter = targets.iterator(); iter.hasNext();) {
	((IObservable) iter.next())
	.removeChangeListener(uiChangeListener);
	}
	}
	}

	private void handleStatusChanged() {
	if (dialog.getShell() == null \|\| dialog.getShell().isDisposed())
	return;
	String message = messageProvider.getMessage(currentStatusProvider);
	int type = messageProvider.getMessageType(currentStatusProvider);
	if (type == IMessageProvider.ERROR) {
	dialog.setMessage(null);
	dialog.setErrorMessage(uiChanged ? message : null);
	if (currentStatus != null && currentStatusHasException()) {
	handleStatusException();
	}
	} else {
	dialog.setErrorMessage(null);
	dialog.setMessage(message, type);
	}
	}

	private boolean currentStatusHasException() {
	boolean hasException = false;
	if (currentStatus.getException() != null) {
	hasException = true;
	}
	if (currentStatus instanceof MultiStatus) {
	MultiStatus multiStatus = (MultiStatus) currentStatus;

	for (int i = 0; i < multiStatus.getChildren().length; i++) {
	IStatus status = multiStatus.getChildren()[i];
	if (status.getException() != null) {
	hasException = true;
	break;
	}
	}
	}
	return hasException;
	}

	/**
	* This is called when a Override to provide custom exception handling and
	* reporting.
	*/
	private void handleStatusException() {
	if (currentStatus.getException() != null) {
	logThrowable(currentStatus.getException());
	} else if (currentStatus instanceof MultiStatus) {
	MultiStatus multiStatus = (MultiStatus) currentStatus;
	for (int i = 0; i < multiStatus.getChildren().length; i++) {
	IStatus status = multiStatus.getChildren()[i];
	if (status.getException() != null) {
	logThrowable(status.getException());
	}
	}
	}
	}

	private void logThrowable(Throwable throwable) {
	Policy
	.getLog()
	.log(
	new Status(
	IStatus.ERROR,
	Policy.JFACE_DATABINDING,
	IStatus.OK,
	"Unhandled exception: " + throwable.getMessage(), throwable)); //$NON-NLS-1$
	}

	/**
	* Disposes of this title area dialog support object, removing any listeners
	* it may have attached.
	*/
	public void dispose() {
	if (aggregateStatusProvider != null)
	aggregateStatusProvider.dispose();
	if (dbc != null && !uiChanged) {
	for (Iterator it = dbc.getValidationStatusProviders().iterator(); it
	.hasNext();) {
	ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) it
	.next();
	IObservableList targets = validationStatusProvider.getTargets();
	targets
	.removeListChangeListener(validationStatusProviderTargetsListener);
	for (Iterator iter = targets.iterator(); iter.hasNext();) {
	((IObservable) iter.next())
	.removeChangeListener(uiChangeListener);
	}
	}
	dbc.getValidationStatusProviders().removeListChangeListener(
	validationStatusProvidersListener);
	}
	aggregateStatusProvider = null;
	dbc = null;
	uiChangeListener = null;
	validationStatusProvidersListener = null;
	validationStatusProviderTargetsListener = null;
	dialog = null;
	}
	}