bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/progress/AnimationManager.java

/*******************************************************************************
 * Copyright (c) 2003 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.internal.progress;
import java.util.HashSet;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.Job;

import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.widgets.Control;

import org.eclipse.ui.progress.WorkbenchJob;
/**
 * The AnimationManager is the class that keeps track of the animation items to
 * update.
 */
public class AnimationManager {
	private static AnimationManager singleton;

	boolean animated = false;
	private IJobProgressManagerListener listener;
	IAnimationProcessor animationProcessor;
	
	WorkbenchJob animationStartJob;
	WorkbenchJob animationDoneJob;

	public static AnimationManager getInstance() {
		if (singleton == null)
			singleton = new AnimationManager();
		return singleton;
	}

	/**
	 * Get the background color to be used.
	 * 
	 * @param control
	 *            The source of the display.
	 * @return Color
	 */
	static Color getItemBackgroundColor(Control control) {
		return control.getDisplay().getSystemColor(SWT.COLOR_INFO_BACKGROUND);
	}

	AnimationManager() {

		animationProcessor = new ProgressAnimationProcessor(this);

		listener = getProgressListener();
		ProgressManager.getInstance().addListener(listener);
		
		animationStartJob = new WorkbenchJob(ProgressMessages
				.getString("AnimationManager.AnimationStart")) {//$NON-NLS-1$
			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.ui.progress.UIJob#runInUIThread(org.eclipse.core.runtime.IProgressMonitor)
			 */
			public IStatus runInUIThread(IProgressMonitor monitor) {
				if(monitor.isCanceled())
					return Status.CANCEL_STATUS;
				animationProcessor.animationStarted();
				return Status.OK_STATUS;
			}
		};
		animationStartJob.setSystem(true);
		
		animationDoneJob = new WorkbenchJob(ProgressMessages.getString("AnimationManager.DoneJobName")) { //$NON-NLS-1$
			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.ui.progress.UIJob#runInUIThread(org.eclipse.core.runtime.IProgressMonitor)
			 */
			public IStatus runInUIThread(IProgressMonitor monitor) {
				if(monitor.isCanceled())
					return Status.CANCEL_STATUS;
				animationProcessor.animationFinished();
				return Status.OK_STATUS;
			}
		};
		animationDoneJob.setSystem(true);

	}
	/**
	 * Add an items to the list
	 * 
	 * @param item
	 */
	void addItem(final AnimationItem item) {
		animationProcessor.addItem(item);
	}

	/**
	 * Return whether or not the current state is animated.
	 * 
	 * @return boolean
	 */
	boolean isAnimated() {
		return animated;
	}
	/**
	 * Set whether or not the receiver is animated.
	 * 
	 * @param boolean
	 */
	void setAnimated(final boolean bool) {
		animated = bool;
		if (bool) {
			animationStarted();
		}
		else{
			animationFinished();
		}
	}
	/**
	 * Dispose the images in the receiver.
	 */
	void dispose() {
		setAnimated(false);
		ProgressManager.getInstance().removeListener(listener);
	}



	private IJobProgressManagerListener getProgressListener() {
		return new IJobProgressManagerListener() {
			HashSet jobs = new HashSet();
			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.ui.internal.progress.IJobProgressManagerListener#addJob(org.eclipse.ui.internal.progress.JobInfo)
			 */
			public void addJob(JobInfo info) {
				incrementJobCount(info);
			}
			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.ui.internal.progress.IJobProgressManagerListener#refreshJobInfo(org.eclipse.ui.internal.progress.JobInfo)
			 */
			public void refreshJobInfo(JobInfo info) {
				int state = info.getJob().getState();
				if (state == Job.RUNNING)
					addJob(info);
				else
					removeJob(info);
			}
			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.ui.internal.progress.IJobProgressManagerListener#refreshAll()
			 */
			public void refreshAll() {
				ProgressManager manager = ProgressManager.getInstance();
				jobs.clear();
				setAnimated(false);
				JobInfo[] currentInfos = manager.getJobInfos(showsDebug());
				for (int i = 0; i < currentInfos.length; i++) {
					addJob(currentInfos[i]);
				}
			}
			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.ui.internal.progress.IJobProgressManagerListener#remove(org.eclipse.ui.internal.progress.JobInfo)
			 */
			public void removeJob(JobInfo info) {
				if (jobs.contains(info.getJob())) {
					decrementJobCount(info.getJob());
				}
			}
			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.ui.internal.progress.IJobProgressManagerListener#showsDebug()
			 */
			public boolean showsDebug() {
				return false;
			}
			private void incrementJobCount(JobInfo info) {
				//Don't count the animate job itself
				if (isNotTracked(info))
					return;
				if (jobs.isEmpty())
					setAnimated(true);
				jobs.add(info.getJob());
			}
			private void decrementJobCount(Job job) {
				jobs.remove(job);
				if (jobs.isEmpty())
					setAnimated(false);
			}
			/**
			 * If this is one of our jobs or not running then don't bother.
			 */
			private boolean isNotTracked(JobInfo info) {
				//We always track errors
				Job job = info.getJob();
				return job.getState() != Job.RUNNING || animationProcessor.isProcessorJob(job);
			}
			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.ui.internal.progress.IJobProgressManagerListener#addGroup(org.eclipse.ui.internal.progress.GroupInfo)
			 */
			public void addGroup(GroupInfo info) {
				//Don't care about groups
			}
			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.ui.internal.progress.IJobProgressManagerListener#removeGroup(org.eclipse.ui.internal.progress.GroupInfo)
			 */
			public void removeGroup(GroupInfo group) {
				//Don't care about groups
			}
			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.ui.internal.progress.IJobProgressManagerListener#refreshGroup(org.eclipse.ui.internal.progress.GroupInfo)
			 */
			public void refreshGroup(GroupInfo info) {
				//Don't care about groups
			}
		};
	}


	/**
	 * The animation has started. Get the items to do any s other start
	 * behaviour.
	 */
	private void animationStarted() {
		
		animationDoneJob.cancel();
		animationStartJob.schedule();
	}
	/**
	 * The animation has finished. Get the items to do any finish
	 * behaviour.
	 */
	private void animationFinished() {
		
		animationStartJob.cancel();
		animationDoneJob.schedule();
	}
	/**
	 * Get the preferred width for widgets displaying the animation.
	 * 
	 * @return int. Return 0 if there is no image data.
	 */
	int getPreferredWidth() {
		return animationProcessor.getPreferredWidth();
	}
	

}