Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui.progress
Interface IWorkbenchSiteProgressService

All Superinterfaces:
IProgressService, IRunnableContext

public interface IWorkbenchSiteProgressService
extends IProgressService

IWorkbenchPartProgressService is an IProgressService that adds API for jobs that change the state in a IWorkbenchPartSite while they are being run.

This service can be acquired from your service locator:

        IWorkbenchSiteProgressService service = (IWorkbenchSiteProgressService) getSite().getService(IWorkbenchSiteProgressService.class);
 
  • This service is not available globally, only at the part site level.

WorkbenchParts may access an instance of IWorkbenchSiteProgressService by calling getSite.getAdapter(IWorkbenchSiteProgressService.class);, although getService(IWorkbenchSiteProgressService.class) is preferred.

Since:
3.0
See Also:
IAdaptable.getAdapter(Class), IServiceLocator.getService(Class)
Restriction:
This interface is not intended to be implemented by clients.

Field Summary
static  String BUSY_PROPERTY
          Deprecated. this property is no longer in use in the Eclipse SDK
 
Method Summary
 void decrementBusy ()
          Decrements the busy counter for this workbench site.
 void incrementBusy ()
          Increments the busy counter for this workbench site.
 void schedule ( Job job)
          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.
 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.
 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.
 void showBusyForFamily ( Object family)
          Show busy state if any job of the specified family is running.
 void warnOfContentChange ()
          Warn that the content of the receiver has changed.
 
Methods inherited from interface org.eclipse.ui.progress. IProgressService
busyCursorWhile, getIconFor, getLongOperationTime, registerIconForFamily, run, runInUI, showInDialog
 

Field Detail

BUSY_PROPERTY

static final 
String BUSY_PROPERTY
Deprecated. this property is no longer in use in the Eclipse SDK
The property that is sent with busy notifications.

See Also:
Constant Field Values
Method Detail

schedule

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 WorkbenchPart.setBusy(). If useHalfBusyCursor is true then the cursor will change to the half busy cursor for the duration of the job.

Parameters:
job - The job to schedule
delay - The delay in scheduling.
useHalfBusyCursor - A boolean to indicate if the half busy cursor should be used while this job is running.
See Also:
Job.schedule(long)

schedule

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 WorkbenchPart.setBusy.

Parameters:
job - The job to schedule
delay - The delay in scheduling.
See Also:
Job.schedule(long)

schedule

void schedule(
Job job)
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 WorkbenchPart.setBusy.

Parameters:
job - The job to schedule
See Also:
Job.schedule()

showBusyForFamily

void showBusyForFamily(
Object family)
Show busy state if any job of the specified family is running.

Parameters:
family - Object
See Also:
Job.belongsTo(Object)

warnOfContentChange

void warnOfContentChange()
Warn that the content of the receiver has changed. The method of this is determined by how the presentation shows this.

See Also:
IPresentablePart.PROP_HIGHLIGHT_IF_BACK

incrementBusy

void incrementBusy()
Increments the busy counter for this workbench site. This API should only be used for background work that does not use jobs. As long as there have been more calls to incrementBusy() than to decrementBusy(), the part will show a busy affordance. Each call to incrementBusy must be followed by a call to decrementBusy once the caller no longer needs the part to show the busy affordance.

Note that the job-related methods on this class are another way to let the part show a busy affordance. A part will only appear non-busy if no jobs have been scheduled through this service, and the internal busy counter is not positive.

Since:
3.3

decrementBusy

void decrementBusy()
Decrements the busy counter for this workbench site. This API should only be used for background work that does not use jobs. It is an error to call this method without first making a matching call to incrementBusy().

Since:
3.3

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire