ProgressPage.java

/*******************************************************************************
 *  Copyright (c) 2014 Mentor Graphics 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:
 *     Mentor Graphics - initial API and implementation
 *******************************************************************************/
package com.codesourcery.internal.installer.ui.pages;

import java.text.MessageFormat;

import org.eclipse.jface.wizard.ProgressMonitorPart;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Layout;
import org.eclipse.swt.widgets.Listener;

import com.codesourcery.installer.IInstallDescription;
import com.codesourcery.installer.IInstallMode;
import com.codesourcery.installer.Installer;
import com.codesourcery.installer.ui.FormattedLabel;
import com.codesourcery.installer.ui.InstallWizardPage;
import com.codesourcery.internal.installer.InstallMessages;
import com.codesourcery.internal.installer.Log;
import com.codesourcery.internal.installer.ui.InstallWizard;
import com.codesourcery.internal.installer.ui.BusyAnimationControl;

/**
 * Page to show installation progress.
 * This page does not support console.
 */
public class ProgressPage extends InstallWizardPage {
	/** Install progress monitor part */
	private ProgressMonitorPart progressMonitorPart;
	/** Animate control */
	private BusyAnimationControl animateCtrl;
	/** Progress label */
	private FormattedLabel progressLabel;
	/** Main area */
	private Composite area;

	/**
	 * Constructor
	 * 
	 * @param pageName Page name
	 */
	public ProgressPage(String pageName) {
		super(pageName, "");
	}
	
	@Override
	public void initPageLabel() {
		String label;
		
		// Installing
		if (getInstallMode().isInstall()) {
			IInstallDescription desc = Installer.getDefault().getInstallManager().getInstallDescription();
			
			if (getInstallMode().isMirror()) {
				label = desc.getText(IInstallDescription.TEXT_PROGRESS_PAGE_NAME_MIRRORING, InstallMessages.MirroringPageTitle);
			}
			else {
				label = desc.getText(IInstallDescription.TEXT_PROGRESS_PAGE_NAME_INSTALLING, InstallMessages.InstallingPageTitle);
			}
		}
		// Uninstalling
		else {
			label = InstallMessages.Uninstalling;
		}
		
		setPageLabel(label);
	}

	/**
	 * Returns the progress monitor part.
	 * 
	 * @return Progress monitor part
	 */
	public ProgressMonitorPart getProgressMonitorPart() {
		return progressMonitorPart;
	}
	
	/**
	 * Returns the main page area.
	 * 
	 * @return Area
	 */
	private Composite getArea() {
		return area;
	}
	
	@Override
	public Control createContents(Composite parent) {
		area = new Composite(parent, SWT.NONE);
		
		area.setLayout(new GridLayout(2, false));
		area.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1));
		
		// Progress label
		progressLabel = new FormattedLabel(area, SWT.WRAP);
		progressLabel.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 2, 1));
		
		// Spacing
		Label spacer = new Label(area, SWT.NONE);
		spacer.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 2, 1));

		// Installing animation
		animateCtrl = new BusyAnimationControl(area, SWT.NONE);
		animateCtrl.setLayoutData(new GridData(SWT.CENTER, SWT.CENTER, false, false, 1, 1));
		
		// Progress monitor part
		progressMonitorPart = new InstallProgressMonitorPart(area, new GridLayout());
		GridData data = new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1);
		progressMonitorPart.setLayoutData(data);
		progressMonitorPart.setVisible(true);

		return area;
	}
	
	@Override
	public void setVisible(boolean visible) {
		try {
			// Progress message
			IInstallMode mode = Installer.getDefault().getInstallManager().getInstallMode();		
			String message;
			if (mode.isInstall()) {
				IInstallDescription desc = (IInstallDescription)Installer.getDefault().getInstallManager().getInstallDescription();
				
				String productName = Installer.getDefault().getInstallManager().getInstallDescription().getProductName();
				// Upgrading
				if (mode.isUpgrade()) {
					message = MessageFormat.format(InstallMessages.UpgradingMessage0, new Object[] { productName });
				}
				// Updating
				else if (mode.isUpdate()) {
					message = MessageFormat.format(InstallMessages.UpdatingMessage0, new Object[] { productName });
				}
				// Installing
				else {
					if (mode.isMirror()) {
						message = desc.getText(IInstallDescription.TEXT_PROGRESS_PAGE_MESSAGE_MIRRORING, 
								MessageFormat.format(InstallMessages.MirroringMessage0, new Object[] { productName }));
					}
					else {
						message = desc.getText(IInstallDescription.TEXT_PROGRESS_PAGE_MESSAGE_INSTALLING, 
								MessageFormat.format(InstallMessages.InstallingMessage0, new Object[] { productName }));
					}
				}
			}
			else {
				message = InstallMessages.UninstallingMessage;
			}
			
			progressLabel.setText(message);
			getArea().layout(true);
		}
		catch (Exception e) {
			Installer.log(e);
		}

		super.setVisible(visible);
	}

	/**
	 * Called to confirm installation cancel.
	 * 
	 * @return <code>true</code> to cancel.
	 */
	protected boolean canCancel() {
		InstallWizard wizard = (InstallWizard)getWizard();
		return wizard.showCancelConfirmation();
	}
	
	/**
	 * An installation progress monitor part that confirms
	 * Cancellation.
	 */
	private class InstallProgressMonitorPart extends ProgressMonitorPart
	{
		/**
		 * Constructor
		 * 
		 * @param parent Parent
		 * @param layout Layout
		 */
		public InstallProgressMonitorPart(Composite parent, Layout layout) {
			super(parent, layout, false);
			
			// Replace the cancel handler with one that can
			// prompt for confirmation.
		    fCancelListener = new Listener() {
		        public void handleEvent(Event e) {
		        	if (canCancel()) {
			            setCanceled(true);
			            if (fCancelComponent != null) {
							fCancelComponent.setEnabled(false);
						}
		        	}
		        }
		    };
		}
		
		@Override
		public void beginTask(String name, int totalWork) {
			super.beginTask(name, totalWork);

			// Start animation
			animateCtrl.animate(true);
			Log.getDefault().log(name);
		}

		@Override
		public void setTaskName(String name) {
			super.setTaskName(name);
			
			Log.getDefault().log(name);
		}

		@Override
		public void subTask(String name) {
			super.subTask(name);
			
			Log.getDefault().log(name);
		}

		@Override
		public void done() {
			// Stop animation
			animateCtrl.animate(false);
			super.done();
		}
	}

	@Override
	public boolean isSupported() {
		return true;
	}
}