|
| |
|
| org.eclipse.ui.progress.IWorkbenchSiteProgressService
All known Subclasses: org.eclipse.ui.internal.progress.WorkbenchSiteProgressService,
| IWorkbenchSiteProgressService | | public interface IWorkbenchSiteProgressService extends IProgressService(Code) | | 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
getSite.getAdapter(IWorkbenchSiteProgressService.class);
This interface is not intended to be implemented by client
plug-ins.
See Also: IWorkbenchPartSite.getAdapter(Class)
since:
3.0 |
| Field Summary | |
| final public static String | BUSY_PROPERTY
The property that is sent with busy notifications. |
| Method Summary | |
| public void | decrementBusy()
Decrements the busy counter for this workbench site. | | public void | incrementBusy()
Increments the busy counter for this workbench site. | | 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. | | 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. | | public 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. | | public void | showBusyForFamily(Object family)
Show busy state if any job of the specified family is running. | | public void | warnOfContentChange()
Warn that the content of the receiver has
changed. |
| BUSY_PROPERTY | | final public static String BUSY_PROPERTY(Code) | | The property that is sent with busy notifications.
|
| decrementBusy | | public void decrementBusy()(Code) | | 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
IWorkbenchSiteProgressService.incrementBusy() .
since:
3.3 |
| incrementBusy | | public void incrementBusy()(Code) | | 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 |
| schedule | | public void schedule(Job job, long delay, boolean useHalfBusyCursor)(Code) | | 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
Parameters:
delay - The delay in scheduling.
Parameters:
useHalfBusyCursor - A boolean to indicate if the half busycursor should be used while this job is running.
See Also: Job.schedule(long) |
| schedule | | public void schedule(Job job, long delay)(Code) | | 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
Parameters:
delay - The delay in scheduling.
See Also: Job.schedule(long) |
| schedule | | public void schedule(Job job)(Code) | | 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 | | public void showBusyForFamily(Object family)(Code) | | Show busy state if any job of the specified family is running.
Parameters:
family - Object
See Also: Job.belongsTo(Object) |
| warnOfContentChange | | public void warnOfContentChange()(Code) | | 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 |
|
|
|