bundles/org.eclipse.equinox.p2.ui/src/org/eclipse/equinox/internal/provisional/p2/ui/ProvUI.java - equinox/rt.equinox.p2 - Git at Google

 /*******************************************************************************
  * Copyright (c) 2007, 2008 IBM Corporation 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
  *******************************************************************************/

 package org.eclipse.equinox.internal.provisional.p2.ui;

 import java.lang.reflect.InvocationTargetException;
 import org.eclipse.core.commands.ExecutionException;
 import org.eclipse.core.commands.operations.*;
 import org.eclipse.core.runtime.*;
 import org.eclipse.equinox.internal.p2.ui.ProvUIActivator;
 import org.eclipse.equinox.internal.p2.ui.ProvUIMessages;
 import org.eclipse.equinox.internal.provisional.p2.ui.viewers.IUColumnConfig;
 import org.eclipse.equinox.internal.provisional.p2.ui.viewers.StructuredViewerProvisioningListener;
 import org.eclipse.jface.dialogs.MessageDialog;
 import org.eclipse.jface.dialogs.ProgressMonitorDialog;
 import org.eclipse.jface.operation.IRunnableWithProgress;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Shell;
 import org.eclipse.ui.*;
 import org.eclipse.ui.statushandlers.StatusManager;

 /**
  * Generic provisioning UI utility and policy methods.
  *
  * @since 3.4
  */
 public class ProvUI {

 	// Public constants for common command and tooltip names
 	public static final String INSTALL_COMMAND_LABEL = ProvUIMessages.InstallIUCommandLabel;
 	public static final String INSTALL_COMMAND_TOOLTIP = ProvUIMessages.InstallIUCommandTooltip;
 	public static final String UNINSTALL_COMMAND_LABEL = ProvUIMessages.UninstallIUCommandLabel;
 	public static final String UNINSTALL_COMMAND_TOOLTIP = ProvUIMessages.UninstallIUCommandTooltip;
 	public static final String UPDATE_COMMAND_LABEL = ProvUIMessages.UpdateIUCommandLabel;
 	public static final String UPDATE_COMMAND_TOOLTIP = ProvUIMessages.UpdateIUCommandTooltip;
 	public static final String REVERT_COMMAND_LABEL = ProvUIMessages.RevertIUCommandLabel;
 	public static final String REVERT_COMMAND_TOOLTIP = ProvUIMessages.RevertIUCommandTooltip;

 	static ObjectUndoContext provisioningUndoContext;
 	private static final int DEFAULT_COLUMN_WIDTH = 200;
 	private static IUColumnConfig[] iuColumnConfig = new IUColumnConfig[] {new IUColumnConfig(ProvUIMessages.ProvUI_NameColumnTitle, IUColumnConfig.COLUMN_NAME, DEFAULT_COLUMN_WIDTH), new IUColumnConfig(ProvUIMessages.ProvUI_VersionColumnTitle, IUColumnConfig.COLUMN_VERSION, DEFAULT_COLUMN_WIDTH)};

 	public static Shell getShell(IAdaptable uiInfo) {
 		Shell shell;
 		if (uiInfo != null) {
 			shell = (Shell) uiInfo.getAdapter(Shell.class);
 			if (shell != null) {
 				return shell;
 			}
 		}
 		// Get the default shell
 		IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
 		if (window != null) {
 			return window.getShell();
 		}
 		Display display = Display.getCurrent();
 		if (display == null) {
 			display = Display.getDefault();
 		}
 		return display.getActiveShell();
 	}

 	public static IStatus handleException(Throwable t, String message, int style) {
 		if (message == null && t != null) {
 			message = t.getMessage();
 		}
 		IStatus status = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, 0, message, t);
 		StatusManager.getManager().handle(status, style);
 		return status;
 	}

 	public static void reportStatus(IStatus status, int style) {
 		// workaround for
 		// https://bugs.eclipse.org/bugs/show_bug.cgi?id=211933
 		if ((style & StatusManager.BLOCK) == StatusManager.BLOCK) {
 			if (status.getSeverity() == IStatus.INFO) {
 				MessageDialog.openInformation(null, ProvUIMessages.ProvUI_InformationTitle, status.getMessage());
 				// unset the block bit
 				style = style & ~StatusManager.BLOCK;
 			} else if (status.getSeverity() == IStatus.WARNING) {
 				MessageDialog.openWarning(null, ProvUIMessages.ProvUI_WarningTitle, status.getMessage());
 				// unset the block bit
 				style = style & ~StatusManager.BLOCK;
 			}
 		}
 		if (style != 0)
 			StatusManager.getManager().handle(status, style);
 	}

 	public static IUColumnConfig[] getIUColumnConfig() {
 		return iuColumnConfig;
 	}

 	public static void setIUColumnConfig(IUColumnConfig[] columnConfig) {
 		iuColumnConfig = columnConfig;
 	}

 	public static IUndoContext getProvisioningUndoContext() {
 		if (provisioningUndoContext == null) {
 			provisioningUndoContext = new ObjectUndoContext(new Object(), "Provisioning Undo Context"); //$NON-NLS-1$
 			IOperationHistory opHistory = PlatformUI.getWorkbench().getOperationSupport().getOperationHistory();
 			opHistory.addOperationApprover(getOperationApprover());
 		}
 		return provisioningUndoContext;
 	}

 	public static Object getAdapter(Object object, Class adapterType) {
 		if (object == null)
 			return null;
 		if (adapterType.isInstance(object))
 			return object;
 		if (object instanceof IAdaptable)
 			return ((IAdaptable) object).getAdapter(adapterType);
 		return null;
 	}

 	/**
 	 * Returns an appropriate shell that is appropriate to use as the parent
 	 * for a modal dialog. This returns the existing modal dialog, if any, to
 	 * avoid multiple modal dialogs being open. Returns <code>null</code>
 	 * if there is no appropriate default parent.
 	 *
 	 * This method is copied from ProgressManagerUtil#getDefaultParent()
 	 */
 	public static Shell getDefaultParentShell() {
 		//first look for a modal shell
 		IWorkbench workbench = PlatformUI.getWorkbench();
 		Shell[] shells = workbench.getDisplay().getShells();
 		int modal = SWT.APPLICATION_MODAL | SWT.SYSTEM_MODAL | SWT.PRIMARY_MODAL;
 		for (int i = 0; i < shells.length; i++) {
 			// Do not worry about shells that will not block the user.
 			if (shells[i].isVisible()) {
 				int style = shells[i].getStyle();
 				if ((style & modal) != 0) {
 					return shells[i];
 				}
 			}
 		}
 		//try the active workbench window
 		IWorkbenchWindow window = workbench.getActiveWorkbenchWindow();
 		if (window != null)
 			return window.getShell();
 		IWorkbenchWindow[] windows = PlatformUI.getWorkbench().getWorkbenchWindows();
 		if (windows.length > 0)
 			return windows[0].getShell();
 		//there is no modal shell and no active window, so just return a null parent shell
 		return null;
 	}

 	static IOperationApprover getOperationApprover() {
 		return new IOperationApprover() {
 			public IStatus proceedUndoing(final IUndoableOperation operation, IOperationHistory history, IAdaptable info) {
 				final IStatus[] status = new IStatus[1];
 				status[0] = Status.OK_STATUS;
 				if (operation.hasContext(provisioningUndoContext) && operation instanceof IAdvancedUndoableOperation) {
 					final IRunnableWithProgress runnable = new IRunnableWithProgress() {
 						public void run(IProgressMonitor monitor) {
 							try {
 								status[0] = ((IAdvancedUndoableOperation) operation).computeUndoableStatus(monitor);
 								if (!status[0].isOK()) {
 									ProvUI.reportStatus(status[0], StatusManager.SHOW | StatusManager.LOG);
 								}
 							} catch (ExecutionException e) {
 								status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
 								ProvUI.handleException(e.getCause(), null, StatusManager.SHOW | StatusManager.LOG);
 							}
 						}
 					};
 					PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable() {
 						public void run() {
 							try {
 								new ProgressMonitorDialog(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell()).run(true, true, runnable);
 							} catch (InterruptedException e) {
 								// don't report thread interruption
 							} catch (InvocationTargetException e) {
 								status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
 								ProvUI.handleException(e.getCause(), null, StatusManager.SHOW | StatusManager.LOG);
 							}
 						}
 					});

 				}
 				return status[0];
 			}

 			public IStatus proceedRedoing(final IUndoableOperation operation, IOperationHistory history, IAdaptable info) {
 				final IStatus[] status = new IStatus[1];
 				status[0] = Status.OK_STATUS;
 				if (operation.hasContext(provisioningUndoContext) && operation instanceof IAdvancedUndoableOperation) {
 					final IRunnableWithProgress runnable = new IRunnableWithProgress() {
 						public void run(IProgressMonitor monitor) {
 							try {
 								status[0] = ((IAdvancedUndoableOperation) operation).computeRedoableStatus(monitor);
 								if (!status[0].isOK()) {
 									ProvUI.reportStatus(status[0], StatusManager.SHOW);
 								}
 							} catch (ExecutionException e) {
 								status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
 								ProvUI.handleException(e.getCause(), null, StatusManager.SHOW | StatusManager.LOG);
 							}
 						}
 					};
 					PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable() {
 						public void run() {
 							try {
 								new ProgressMonitorDialog(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell()).run(true, true, runnable);
 							} catch (InterruptedException e) {
 								// don't report thread interruption
 							} catch (InvocationTargetException e) {
 								status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
 								ProvUI.handleException(e.getCause(), null, StatusManager.SHOW | StatusManager.LOG);
 							}
 						}
 					});

 				}
 				return status[0];
 			}

 		};

 	}

 	/**
 	 * Make an <code>IAdaptable</code> that adapts to the specified shell,
 	 * suitable for passing for passing to any
 	 * {@link org.eclipse.core.commands.operations.IUndoableOperation} or
 	 * {@link org.eclipse.core.commands.operations.IOperationHistory} method
 	 * that requires an {@link org.eclipse.core.runtime.IAdaptable}
 	 * <code>uiInfo</code> parameter.
 	 *
 	 * @param shell
 	 *            the shell that should be returned by the IAdaptable when asked
 	 *            to adapt a shell. If this parameter is <code>null</code>,
 	 *            the returned shell will also be <code>null</code>.
 	 *
 	 * @return an IAdaptable that will return the specified shell.
 	 */
 	static IAdaptable getUIInfoAdapter(final Shell shell) {
 		return new IAdaptable() {
 			public Object getAdapter(Class clazz) {
 				if (clazz == Shell.class) {
 					return shell;
 				}
 				return null;
 			}
 		};
 	}

 	public static void addProvisioningListener(StructuredViewerProvisioningListener listener) {
 		ProvUIActivator.getDefault().addProvisioningListener(listener);
 	}

 	public static void removeProvisioningListener(StructuredViewerProvisioningListener listener) {
 		ProvUIActivator.getDefault().removeProvisioningListener(listener);
 	}

 	public static void startBatchOperation() {
 		ProvUIActivator.getDefault().signalBatchOperationStart();
 	}

 	public static void endBatchOperation() {
 		ProvUIActivator.getDefault().signalBatchOperationComplete();
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2007, 2008 IBM Corporation 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
	*******************************************************************************/

	package org.eclipse.equinox.internal.provisional.p2.ui;

	import java.lang.reflect.InvocationTargetException;
	import org.eclipse.core.commands.ExecutionException;
	import org.eclipse.core.commands.operations.*;
	import org.eclipse.core.runtime.*;
	import org.eclipse.equinox.internal.p2.ui.ProvUIActivator;
	import org.eclipse.equinox.internal.p2.ui.ProvUIMessages;
	import org.eclipse.equinox.internal.provisional.p2.ui.viewers.IUColumnConfig;
	import org.eclipse.equinox.internal.provisional.p2.ui.viewers.StructuredViewerProvisioningListener;
	import org.eclipse.jface.dialogs.MessageDialog;
	import org.eclipse.jface.dialogs.ProgressMonitorDialog;
	import org.eclipse.jface.operation.IRunnableWithProgress;
	import org.eclipse.swt.SWT;
	import org.eclipse.swt.widgets.Display;
	import org.eclipse.swt.widgets.Shell;
	import org.eclipse.ui.*;
	import org.eclipse.ui.statushandlers.StatusManager;

	/**
	* Generic provisioning UI utility and policy methods.
	*
	* @since 3.4
	*/
	public class ProvUI {

	// Public constants for common command and tooltip names
	public static final String INSTALL_COMMAND_LABEL = ProvUIMessages.InstallIUCommandLabel;
	public static final String INSTALL_COMMAND_TOOLTIP = ProvUIMessages.InstallIUCommandTooltip;
	public static final String UNINSTALL_COMMAND_LABEL = ProvUIMessages.UninstallIUCommandLabel;
	public static final String UNINSTALL_COMMAND_TOOLTIP = ProvUIMessages.UninstallIUCommandTooltip;
	public static final String UPDATE_COMMAND_LABEL = ProvUIMessages.UpdateIUCommandLabel;
	public static final String UPDATE_COMMAND_TOOLTIP = ProvUIMessages.UpdateIUCommandTooltip;
	public static final String REVERT_COMMAND_LABEL = ProvUIMessages.RevertIUCommandLabel;
	public static final String REVERT_COMMAND_TOOLTIP = ProvUIMessages.RevertIUCommandTooltip;

	static ObjectUndoContext provisioningUndoContext;
	private static final int DEFAULT_COLUMN_WIDTH = 200;
	private static IUColumnConfig[] iuColumnConfig = new IUColumnConfig[] {new IUColumnConfig(ProvUIMessages.ProvUI_NameColumnTitle, IUColumnConfig.COLUMN_NAME, DEFAULT_COLUMN_WIDTH), new IUColumnConfig(ProvUIMessages.ProvUI_VersionColumnTitle, IUColumnConfig.COLUMN_VERSION, DEFAULT_COLUMN_WIDTH)};

	public static Shell getShell(IAdaptable uiInfo) {
	Shell shell;
	if (uiInfo != null) {
	shell = (Shell) uiInfo.getAdapter(Shell.class);
	if (shell != null) {
	return shell;
	}
	}
	// Get the default shell
	IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
	if (window != null) {
	return window.getShell();
	}
	Display display = Display.getCurrent();
	if (display == null) {
	display = Display.getDefault();
	}
	return display.getActiveShell();
	}

	public static IStatus handleException(Throwable t, String message, int style) {
	if (message == null && t != null) {
	message = t.getMessage();
	}
	IStatus status = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, 0, message, t);
	StatusManager.getManager().handle(status, style);
	return status;
	}

	public static void reportStatus(IStatus status, int style) {
	// workaround for
	// https://bugs.eclipse.org/bugs/show_bug.cgi?id=211933
	if ((style & StatusManager.BLOCK) == StatusManager.BLOCK) {
	if (status.getSeverity() == IStatus.INFO) {
	MessageDialog.openInformation(null, ProvUIMessages.ProvUI_InformationTitle, status.getMessage());
	// unset the block bit
	style = style & ~StatusManager.BLOCK;
	} else if (status.getSeverity() == IStatus.WARNING) {
	MessageDialog.openWarning(null, ProvUIMessages.ProvUI_WarningTitle, status.getMessage());
	// unset the block bit
	style = style & ~StatusManager.BLOCK;
	}
	}
	if (style != 0)
	StatusManager.getManager().handle(status, style);
	}

	public static IUColumnConfig[] getIUColumnConfig() {
	return iuColumnConfig;
	}

	public static void setIUColumnConfig(IUColumnConfig[] columnConfig) {
	iuColumnConfig = columnConfig;
	}

	public static IUndoContext getProvisioningUndoContext() {
	if (provisioningUndoContext == null) {
	provisioningUndoContext = new ObjectUndoContext(new Object(), "Provisioning Undo Context"); //$NON-NLS-1$
	IOperationHistory opHistory = PlatformUI.getWorkbench().getOperationSupport().getOperationHistory();
	opHistory.addOperationApprover(getOperationApprover());
	}
	return provisioningUndoContext;
	}

	public static Object getAdapter(Object object, Class adapterType) {
	if (object == null)
	return null;
	if (adapterType.isInstance(object))
	return object;
	if (object instanceof IAdaptable)
	return ((IAdaptable) object).getAdapter(adapterType);
	return null;
	}

	/**
	* Returns an appropriate shell that is appropriate to use as the parent
	* for a modal dialog. This returns the existing modal dialog, if any, to
	* avoid multiple modal dialogs being open. Returns <code>null</code>
	* if there is no appropriate default parent.
	*
	* This method is copied from ProgressManagerUtil#getDefaultParent()
	*/
	public static Shell getDefaultParentShell() {
	//first look for a modal shell
	IWorkbench workbench = PlatformUI.getWorkbench();
	Shell[] shells = workbench.getDisplay().getShells();
	int modal = SWT.APPLICATION_MODAL \| SWT.SYSTEM_MODAL \| SWT.PRIMARY_MODAL;
	for (int i = 0; i < shells.length; i++) {
	// Do not worry about shells that will not block the user.
	if (shells[i].isVisible()) {
	int style = shells[i].getStyle();
	if ((style & modal) != 0) {
	return shells[i];
	}
	}
	}
	//try the active workbench window
	IWorkbenchWindow window = workbench.getActiveWorkbenchWindow();
	if (window != null)
	return window.getShell();
	IWorkbenchWindow[] windows = PlatformUI.getWorkbench().getWorkbenchWindows();
	if (windows.length > 0)
	return windows[0].getShell();
	//there is no modal shell and no active window, so just return a null parent shell
	return null;
	}

	static IOperationApprover getOperationApprover() {
	return new IOperationApprover() {
	public IStatus proceedUndoing(final IUndoableOperation operation, IOperationHistory history, IAdaptable info) {
	final IStatus[] status = new IStatus[1];
	status[0] = Status.OK_STATUS;
	if (operation.hasContext(provisioningUndoContext) && operation instanceof IAdvancedUndoableOperation) {
	final IRunnableWithProgress runnable = new IRunnableWithProgress() {
	public void run(IProgressMonitor monitor) {
	try {
	status[0] = ((IAdvancedUndoableOperation) operation).computeUndoableStatus(monitor);
	if (!status[0].isOK()) {
	ProvUI.reportStatus(status[0], StatusManager.SHOW \| StatusManager.LOG);
	}
	} catch (ExecutionException e) {
	status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
	ProvUI.handleException(e.getCause(), null, StatusManager.SHOW \| StatusManager.LOG);
	}
	}
	};
	PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable() {
	public void run() {
	try {
	new ProgressMonitorDialog(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell()).run(true, true, runnable);
	} catch (InterruptedException e) {
	// don't report thread interruption
	} catch (InvocationTargetException e) {
	status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
	ProvUI.handleException(e.getCause(), null, StatusManager.SHOW \| StatusManager.LOG);
	}
	}
	});

	}
	return status[0];
	}

	public IStatus proceedRedoing(final IUndoableOperation operation, IOperationHistory history, IAdaptable info) {
	final IStatus[] status = new IStatus[1];
	status[0] = Status.OK_STATUS;
	if (operation.hasContext(provisioningUndoContext) && operation instanceof IAdvancedUndoableOperation) {
	final IRunnableWithProgress runnable = new IRunnableWithProgress() {
	public void run(IProgressMonitor monitor) {
	try {
	status[0] = ((IAdvancedUndoableOperation) operation).computeRedoableStatus(monitor);
	if (!status[0].isOK()) {
	ProvUI.reportStatus(status[0], StatusManager.SHOW);
	}
	} catch (ExecutionException e) {
	status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
	ProvUI.handleException(e.getCause(), null, StatusManager.SHOW \| StatusManager.LOG);
	}
	}
	};
	PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable() {
	public void run() {
	try {
	new ProgressMonitorDialog(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell()).run(true, true, runnable);
	} catch (InterruptedException e) {
	// don't report thread interruption
	} catch (InvocationTargetException e) {
	status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
	ProvUI.handleException(e.getCause(), null, StatusManager.SHOW \| StatusManager.LOG);
	}
	}
	});

	}
	return status[0];
	}

	};

	}

	/**
	* Make an <code>IAdaptable</code> that adapts to the specified shell,
	* suitable for passing for passing to any
	* {@link org.eclipse.core.commands.operations.IUndoableOperation} or
	* {@link org.eclipse.core.commands.operations.IOperationHistory} method
	* that requires an {@link org.eclipse.core.runtime.IAdaptable}
	* <code>uiInfo</code> parameter.
	*
	* @param shell
	* the shell that should be returned by the IAdaptable when asked
	* to adapt a shell. If this parameter is <code>null</code>,
	* the returned shell will also be <code>null</code>.
	*
	* @return an IAdaptable that will return the specified shell.
	*/
	static IAdaptable getUIInfoAdapter(final Shell shell) {
	return new IAdaptable() {
	public Object getAdapter(Class clazz) {
	if (clazz == Shell.class) {
	return shell;
	}
	return null;
	}
	};
	}

	public static void addProvisioningListener(StructuredViewerProvisioningListener listener) {
	ProvUIActivator.getDefault().addProvisioningListener(listener);
	}

	public static void removeProvisioningListener(StructuredViewerProvisioningListener listener) {
	ProvUIActivator.getDefault().removeProvisioningListener(listener);
	}

	public static void startBatchOperation() {
	ProvUIActivator.getDefault().signalBatchOperationStart();
	}

	public static void endBatchOperation() {
	ProvUIActivator.getDefault().signalBatchOperationComplete();
	}
	}