bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/IWorkbenchSiteProgressService.java

/**********************************************************************
 * Copyright (c) 2003,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 - Initial API and implementation
 **********************************************************************/
package org.eclipse.ui.progress;

import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.ui.IWorkbenchPartSite;
import org.eclipse.ui.presentations.IPresentablePart;

/**
 * IWorkbenchPartProgressService is an IProgressService that adds API for 
 * jobs that change the state in a IWorkbenchPartSite while they are being 
 * run.
 * 
 * WorkbenchParts may access an instance of IWorkbenchSiteProgressService
 * by calling
 * <code>getSite.getAdapter(IWorkbenchSiteProgressService.class);</code>
 * 
 * This interface is not intended to be implemented by client
 * plug-ins.
 * @see IWorkbenchPartSite#getAdapter(Class)
 * @since 3.0
 */
public interface IWorkbenchSiteProgressService extends IProgressService {
	
	/**
	 * The property that is sent with busy notifications.
	 */
	public static final String BUSY_PROPERTY = "SITE_BUSY"; //$NON-NLS-1$
	
	/**
	 * Jobs scheduled with this method will cause the part's presentation 
	 * to be changed to indicate that the part is busy and in a transient 
	 * state until the job completes. Parts can also add customized busy 
	 * indication by overriding <code>WorkbenchPart.setBusy()</code>.
	 * If useHalfBusyCursor is true then the cursor will change to
	 * the half busy cursor for the duration of the job.
	 * @param job. The job to schedule
	 * @param delay. The delay in scheduling.
	 * @param useHalfBusyCursor. A boolean to indicate if the half busy
	 * 		cursor should be used while this job is running.
	 * @see Job#schedule(long)
	 */
	public void schedule(Job job, long delay, boolean useHalfBusyCursor);
	
	/**
	 * Jobs scheduled with this method will cause the part's presentation 
	 * to be changed to indicate that the part is busy and in a transient 
	 * state until the job completes. Parts can also add customized busy 
	 * indication by overriding <code>WorkbenchPart.setBusy</code>.
	 * @param job. The job to schedule
	 * @param delay. The delay in scheduling.
	 * @see Job#schedule(long)
	 */
	public void schedule(Job job, long delay);
	
	/**
	 * Jobs scheduled with this method will cause the part's presentation 
	 * to be changed to indicate that the part is busy and in a transient 
	 * state until the job completes. Parts can also add customized busy 
	 * indication by overriding <code>WorkbenchPart.setBusy</code>.
	 * @param job. The job to schedule
	 * @see Job#schedule()
	 */
	public void schedule(Job job);
	
	/**
	 * Show busy state if any job of the specified family is running.
	 * @param family Object
	 * @see Job#belongsTo(Object)
	 */
	public void showBusyForFamily(Object family);
	
	/**
	 * Warn that the content of the receiver has 
	 * changed. The method of this is determined by
	 * how the presentation shows this. 
	 * @see IPresentablePart#PROP_HIGHLIGHT_IF_BACK
	 */
	public void warnOfContentChange();
	
}