bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/progress/ProgressAnimationItem.java - platform/eclipse.platform.ui - Git at Google

 /*******************************************************************************
  * Copyright (c) 2004 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 org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.jobs.Job;
 import org.eclipse.jface.action.IAction;
 import org.eclipse.jface.dialogs.ErrorDialog;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.events.DisposeEvent;
 import org.eclipse.swt.events.DisposeListener;
 import org.eclipse.swt.events.MouseAdapter;
 import org.eclipse.swt.events.MouseEvent;
 import org.eclipse.swt.events.MouseListener;
 import org.eclipse.swt.events.SelectionAdapter;
 import org.eclipse.swt.events.SelectionEvent;
 import org.eclipse.swt.graphics.Image;
 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.Display;
 import org.eclipse.swt.widgets.Label;
 import org.eclipse.swt.widgets.ProgressBar;
 import org.eclipse.swt.widgets.ToolBar;
 import org.eclipse.swt.widgets.ToolItem;
 import org.eclipse.ui.internal.util.ImageSupport;
 import org.eclipse.ui.progress.IProgressConstants;

 /**
  * Create an instance of the receiver in the window.
  *
  * @param workbenchWindow
  *            The window this is being created in.
  */
 public class ProgressAnimationItem extends AnimationItem implements FinishedJobs.KeptJobsListener {

 	ProgressBar bar;
 	MouseListener mouseListener;
 	Composite top;
 	ToolBar toolbar;
 	ToolItem toolButton;
 	ProgressRegion progressRegion;
     Image noneImage, okImage, errorImage;
     boolean animationRunning;
     JobInfo lastJobInfo;

 	/**
 	 * Create an instance of the receiver in the supplied region.
 	 *
 	 * @param region. The ProgressRegion that contains the receiver.
 	 */
 	ProgressAnimationItem(ProgressRegion region) {
 		super(region.workbenchWindow);

 	    FinishedJobs.getInstance().addListener(this);

 		progressRegion= region;
 		mouseListener = new MouseAdapter() {
 			public void mouseDoubleClick(MouseEvent e) {
 				doAction();
 			}
 		};
 	}

 	void doAction() {

 		JobTreeElement[] jobTreeElements= FinishedJobs.getInstance().getJobInfos();
 		// search from end (youngest)
 		for (int i= jobTreeElements.length-1; i >= 0; i--) {
 			if (jobTreeElements[i] instanceof JobInfo) {
 				JobInfo ji= (JobInfo) jobTreeElements[i];
 				Job job= ji.getJob();
 				if (job != null) {

 				    IStatus status= job.getResult();
 				    if (status != null && status.getSeverity() == IStatus.ERROR) {
 						String title= ProgressMessages.getString("NewProgressView.errorDialogTitle"); //$NON-NLS-1$
 						String msg= ProgressMessages.getString("NewProgressView.errorDialogMessage"); //$NON-NLS-1$
 						ErrorDialog.openError(toolbar.getShell(), title, msg, status);
 						JobTreeElement topElement= (JobTreeElement) ji.getParent();
 						if (topElement == null)
 							topElement= ji;
 						FinishedJobs.getInstance().remove(topElement);
 				        return;
 				    }

 					IAction action= null;
 					Object property= job.getProperty(IProgressConstants.ACTION_PROPERTY);
 					if (property instanceof IAction) {
 						action= (IAction) property;
 					} else {	// backward compatibility
 						property= job.getProperty(NewProgressViewer.GOTO_PROPERTY);
 						if (property instanceof IAction)
 							action= (IAction) property;
 					}
 					if (action != null && action.isEnabled()) {
 						action.run();
 						JobTreeElement topElement= (JobTreeElement) ji.getParent();
 						if (topElement == null)
 							topElement= ji;
 						FinishedJobs.getInstance().remove(topElement);
 						return;
 					}
 				}
 			}
 		}

 		progressRegion.processDoubleClick();
 		refresh();
 	}

 	private IAction getAction(Job job) {
 		Object property= job.getProperty(IProgressConstants.ACTION_PROPERTY);
 		if (property instanceof IAction)
 			return (IAction) property;
 		// backward compatibility
 		property= job.getProperty(NewProgressViewer.GOTO_PROPERTY);
 		if (property instanceof IAction)
 			return (IAction) property;
 		return null;
 	}

 	private void refresh() {

 		if (toolbar == null && toolbar.isDisposed())
 			return;

 		lastJobInfo= null;

 		JobTreeElement[] jobTreeElements= FinishedJobs.getInstance().getJobInfos();
 		// search from end (youngest)
 		for (int i= jobTreeElements.length-1; i >= 0; i--) {
 			if (jobTreeElements[i] instanceof JobInfo) {
 				JobInfo ji= (JobInfo) jobTreeElements[i];
 				lastJobInfo= ji;
 				Job job= ji.getJob();
 				if (job != null) {
 				    IStatus status= job.getResult();
 				    if (status != null && status.getSeverity() == IStatus.ERROR) {
 				    		// green arrow with error overlay
 				    		initButton(errorImage, ProgressMessages.format("ProgressAnimationItem.error", new Object[] { job.getName() } )); //$NON-NLS-1$
 				        return;
 				    }
 					IAction action= getAction(job);
 					if (action != null && action.isEnabled()) {
 						// green arrow with exclamation mark
 						String tt= action.getToolTipText();
 						if (tt == null || tt.trim().length() == 0)
 							tt= ProgressMessages.format("ProgressAnimationItem.ok", new Object[] { job.getName() } );
 						initButton(okImage, tt); //$NON-NLS-1$
 						return;
 					}
 					// just the green arrow
 					initButton(noneImage, ProgressMessages.getString("ProgressAnimationItem.tasks")); //$NON-NLS-1$
 					return;
 				}
 			}
 		}

 		if (animationRunning) {
 			initButton(noneImage, ProgressMessages.getString("ProgressAnimationItem.tasks")); //$NON-NLS-1$
     			return;
 		}

 		// if nothing found hide tool item
    		toolbar.setVisible(false);
 	}

 	private void initButton(Image im, String tt) {
 		toolButton.setImage(im);
 		toolButton.setToolTipText(tt);
 		toolbar.setVisible(true);
 		toolbar.redraw();
 	}

 	/*
 	 * (non-Javadoc)
 	 *
 	 * @see org.eclipse.ui.internal.progress.AnimationItem#createAnimationItem(org.eclipse.swt.widgets.Composite)
 	 */
 	protected Control createAnimationItem(Composite parent) {

 	    if (okImage == null) {
 	        Display display= parent.getDisplay();
 	        noneImage= ImageSupport.getImageDescriptor("icons/full/progress/progress_none.gif").createImage(display); //$NON-NLS-1$
 	        okImage= ImageSupport.getImageDescriptor("icons/full/progress/progress_ok.gif").createImage(display); //$NON-NLS-1$
 	        errorImage= ImageSupport.getImageDescriptor("icons/full/progress/progress_error.gif").createImage(display); //$NON-NLS-1$
 	    }

 		top = new Composite(parent, SWT.NULL);
 		top.addDisposeListener(new DisposeListener() {
 		    public void widgetDisposed(DisposeEvent e) {
         	    FinishedJobs.getInstance().removeListener(ProgressAnimationItem.this);
             noneImage.dispose();
     	   		okImage.dispose();
      	    errorImage.dispose();
            }
 		});

 		boolean isCarbon = "carbon".equals(SWT.getPlatform()); //$NON-NLS-1$

 		GridLayout gl= new GridLayout();
 		gl.numColumns= isCarbon ? 3 : 2;
 		gl.marginHeight= 0;
 		gl.marginWidth= 0;
 		gl.horizontalSpacing= 2;
 		top.setLayout(gl);

 		bar = new ProgressBar(top, SWT.HORIZONTAL | SWT.INDETERMINATE);
 		bar.setVisible(false);
 		bar.addMouseListener(mouseListener);
 		GridData gd= new GridData(GridData.VERTICAL_ALIGN_CENTER | GridData.FILL_HORIZONTAL);
 		gd.heightHint= 12;
 		bar.setLayoutData(gd);

 		toolbar= new ToolBar(top, SWT.FLAT);
 		toolbar.setVisible(false);
 		toolButton= new ToolItem(toolbar, SWT.NONE);
 		toolButton.addSelectionListener(new SelectionAdapter() {
             public void widgetSelected(SelectionEvent e) {
             		doAction();
             }
         });

 		if (isCarbon) // prevent that Mac growbox overlaps with toolbar item
 		    new Label(top, SWT.NONE).setLayoutData(new GridData(4, 4));

 		refresh();

 		return top;
 	}

 	/*
 	 * (non-Javadoc)
 	 *
 	 * @see org.eclipse.ui.internal.progress.AnimationItem#getControl()
 	 */
 	public Control getControl() {
 		return top;
 	}

 	/*
 	 * (non-Javadoc)
 	 *
 	 * @see org.eclipse.ui.internal.progress.AnimationItem#animationDone()
 	 */
 	void animationDone() {
 		super.animationDone();
 		animationRunning= false;
 		if (bar.isDisposed())
 			return;
 		bar.setVisible(false);
 		refresh();
 	}

 	/*
 	 * (non-Javadoc)
 	 *
 	 * @see org.eclipse.ui.internal.progress.AnimationItem#animationStart()
 	 */
 	void animationStart() {
 		super.animationStart();
 		animationRunning= true;
 		if (bar.isDisposed())
 			return;
 		bar.setVisible(true);
 		refresh();
 	}

     public void removed(JobTreeElement info) {
 	    final Display display= Display.getDefault();
 	    display.asyncExec(new Runnable() {
 	        public void run() {
 	        	refresh();
 	        }
 	    });
     }

     public void finished(final JobTreeElement jte) {
 	    final Display display= Display.getDefault();
 	    display.asyncExec(new Runnable() {
 	        public void run() {
 	        	refresh();
 	        }
 	    });
     }
 }
	/*******************************************************************************
	* Copyright (c) 2004 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 org.eclipse.core.runtime.IStatus;
	import org.eclipse.core.runtime.jobs.Job;
	import org.eclipse.jface.action.IAction;
	import org.eclipse.jface.dialogs.ErrorDialog;
	import org.eclipse.swt.SWT;
	import org.eclipse.swt.events.DisposeEvent;
	import org.eclipse.swt.events.DisposeListener;
	import org.eclipse.swt.events.MouseAdapter;
	import org.eclipse.swt.events.MouseEvent;
	import org.eclipse.swt.events.MouseListener;
	import org.eclipse.swt.events.SelectionAdapter;
	import org.eclipse.swt.events.SelectionEvent;
	import org.eclipse.swt.graphics.Image;
	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.Display;
	import org.eclipse.swt.widgets.Label;
	import org.eclipse.swt.widgets.ProgressBar;
	import org.eclipse.swt.widgets.ToolBar;
	import org.eclipse.swt.widgets.ToolItem;
	import org.eclipse.ui.internal.util.ImageSupport;
	import org.eclipse.ui.progress.IProgressConstants;

	/**
	* Create an instance of the receiver in the window.
	*
	* @param workbenchWindow
	* The window this is being created in.
	*/
	public class ProgressAnimationItem extends AnimationItem implements FinishedJobs.KeptJobsListener {

	ProgressBar bar;
	MouseListener mouseListener;
	Composite top;
	ToolBar toolbar;
	ToolItem toolButton;
	ProgressRegion progressRegion;
	Image noneImage, okImage, errorImage;
	boolean animationRunning;
	JobInfo lastJobInfo;

	/**
	* Create an instance of the receiver in the supplied region.
	*
	* @param region. The ProgressRegion that contains the receiver.
	*/
	ProgressAnimationItem(ProgressRegion region) {
	super(region.workbenchWindow);

	FinishedJobs.getInstance().addListener(this);

	progressRegion= region;
	mouseListener = new MouseAdapter() {
	public void mouseDoubleClick(MouseEvent e) {
	doAction();
	}
	};
	}

	void doAction() {

	JobTreeElement[] jobTreeElements= FinishedJobs.getInstance().getJobInfos();
	// search from end (youngest)
	for (int i= jobTreeElements.length-1; i >= 0; i--) {
	if (jobTreeElements[i] instanceof JobInfo) {
	JobInfo ji= (JobInfo) jobTreeElements[i];
	Job job= ji.getJob();
	if (job != null) {

	IStatus status= job.getResult();
	if (status != null && status.getSeverity() == IStatus.ERROR) {
	String title= ProgressMessages.getString("NewProgressView.errorDialogTitle"); //$NON-NLS-1$
	String msg= ProgressMessages.getString("NewProgressView.errorDialogMessage"); //$NON-NLS-1$
	ErrorDialog.openError(toolbar.getShell(), title, msg, status);
	JobTreeElement topElement= (JobTreeElement) ji.getParent();
	if (topElement == null)
	topElement= ji;
	FinishedJobs.getInstance().remove(topElement);
	return;
	}

	IAction action= null;
	Object property= job.getProperty(IProgressConstants.ACTION_PROPERTY);
	if (property instanceof IAction) {
	action= (IAction) property;
	} else { // backward compatibility
	property= job.getProperty(NewProgressViewer.GOTO_PROPERTY);
	if (property instanceof IAction)
	action= (IAction) property;
	}
	if (action != null && action.isEnabled()) {
	action.run();
	JobTreeElement topElement= (JobTreeElement) ji.getParent();
	if (topElement == null)
	topElement= ji;
	FinishedJobs.getInstance().remove(topElement);
	return;
	}
	}
	}
	}

	progressRegion.processDoubleClick();
	refresh();
	}

	private IAction getAction(Job job) {
	Object property= job.getProperty(IProgressConstants.ACTION_PROPERTY);
	if (property instanceof IAction)
	return (IAction) property;
	// backward compatibility
	property= job.getProperty(NewProgressViewer.GOTO_PROPERTY);
	if (property instanceof IAction)
	return (IAction) property;
	return null;
	}

	private void refresh() {

	if (toolbar == null && toolbar.isDisposed())
	return;

	lastJobInfo= null;

	JobTreeElement[] jobTreeElements= FinishedJobs.getInstance().getJobInfos();
	// search from end (youngest)
	for (int i= jobTreeElements.length-1; i >= 0; i--) {
	if (jobTreeElements[i] instanceof JobInfo) {
	JobInfo ji= (JobInfo) jobTreeElements[i];
	lastJobInfo= ji;
	Job job= ji.getJob();
	if (job != null) {
	IStatus status= job.getResult();
	if (status != null && status.getSeverity() == IStatus.ERROR) {
	// green arrow with error overlay
	initButton(errorImage, ProgressMessages.format("ProgressAnimationItem.error", new Object[] { job.getName() } )); //$NON-NLS-1$
	return;
	}
	IAction action= getAction(job);
	if (action != null && action.isEnabled()) {
	// green arrow with exclamation mark
	String tt= action.getToolTipText();
	if (tt == null \|\| tt.trim().length() == 0)
	tt= ProgressMessages.format("ProgressAnimationItem.ok", new Object[] { job.getName() } );
	initButton(okImage, tt); //$NON-NLS-1$
	return;
	}
	// just the green arrow
	initButton(noneImage, ProgressMessages.getString("ProgressAnimationItem.tasks")); //$NON-NLS-1$
	return;
	}
	}
	}

	if (animationRunning) {
	initButton(noneImage, ProgressMessages.getString("ProgressAnimationItem.tasks")); //$NON-NLS-1$
	return;
	}

	// if nothing found hide tool item
	toolbar.setVisible(false);
	}

	private void initButton(Image im, String tt) {
	toolButton.setImage(im);
	toolButton.setToolTipText(tt);
	toolbar.setVisible(true);
	toolbar.redraw();
	}

	/*
	* (non-Javadoc)
	*
	* @see org.eclipse.ui.internal.progress.AnimationItem#createAnimationItem(org.eclipse.swt.widgets.Composite)
	*/
	protected Control createAnimationItem(Composite parent) {

	if (okImage == null) {
	Display display= parent.getDisplay();
	noneImage= ImageSupport.getImageDescriptor("icons/full/progress/progress_none.gif").createImage(display); //$NON-NLS-1$
	okImage= ImageSupport.getImageDescriptor("icons/full/progress/progress_ok.gif").createImage(display); //$NON-NLS-1$
	errorImage= ImageSupport.getImageDescriptor("icons/full/progress/progress_error.gif").createImage(display); //$NON-NLS-1$
	}

	top = new Composite(parent, SWT.NULL);
	top.addDisposeListener(new DisposeListener() {
	public void widgetDisposed(DisposeEvent e) {
	FinishedJobs.getInstance().removeListener(ProgressAnimationItem.this);
	noneImage.dispose();
	okImage.dispose();
	errorImage.dispose();
	}
	});

	boolean isCarbon = "carbon".equals(SWT.getPlatform()); //$NON-NLS-1$

	GridLayout gl= new GridLayout();
	gl.numColumns= isCarbon ? 3 : 2;
	gl.marginHeight= 0;
	gl.marginWidth= 0;
	gl.horizontalSpacing= 2;
	top.setLayout(gl);

	bar = new ProgressBar(top, SWT.HORIZONTAL \| SWT.INDETERMINATE);
	bar.setVisible(false);
	bar.addMouseListener(mouseListener);
	GridData gd= new GridData(GridData.VERTICAL_ALIGN_CENTER \| GridData.FILL_HORIZONTAL);
	gd.heightHint= 12;
	bar.setLayoutData(gd);

	toolbar= new ToolBar(top, SWT.FLAT);
	toolbar.setVisible(false);
	toolButton= new ToolItem(toolbar, SWT.NONE);
	toolButton.addSelectionListener(new SelectionAdapter() {
	public void widgetSelected(SelectionEvent e) {
	doAction();
	}
	});

	if (isCarbon) // prevent that Mac growbox overlaps with toolbar item
	new Label(top, SWT.NONE).setLayoutData(new GridData(4, 4));

	refresh();

	return top;
	}

	/*
	* (non-Javadoc)
	*
	* @see org.eclipse.ui.internal.progress.AnimationItem#getControl()
	*/
	public Control getControl() {
	return top;
	}

	/*
	* (non-Javadoc)
	*
	* @see org.eclipse.ui.internal.progress.AnimationItem#animationDone()
	*/
	void animationDone() {
	super.animationDone();
	animationRunning= false;
	if (bar.isDisposed())
	return;
	bar.setVisible(false);
	refresh();
	}

	/*
	* (non-Javadoc)
	*
	* @see org.eclipse.ui.internal.progress.AnimationItem#animationStart()
	*/
	void animationStart() {
	super.animationStart();
	animationRunning= true;
	if (bar.isDisposed())
	return;
	bar.setVisible(true);
	refresh();
	}

	public void removed(JobTreeElement info) {
	final Display display= Display.getDefault();
	display.asyncExec(new Runnable() {
	public void run() {
	refresh();
	}
	});
	}

	public void finished(final JobTreeElement jte) {
	final Display display= Display.getDefault();
	display.asyncExec(new Runnable() {
	public void run() {
	refresh();
	}
	});
	}
	}