|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IWorkbenchSiteProgressService
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.
IAdaptable.getAdapter(Class)
Field Summary | |
---|---|
static java.lang.String |
BUSY_PROPERTY
The property that is sent with busy notifications. |
Method Summary | |
---|---|
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(java.lang.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 |
---|
static final java.lang.String BUSY_PROPERTY
Method Detail |
---|
void schedule(Job job, long delay, boolean useHalfBusyCursor)
WorkbenchPart.setBusy()
.
If useHalfBusyCursor is true then the cursor will change to
the half busy cursor for the duration of the job.
job
- The job to scheduledelay
- The delay in scheduling.useHalfBusyCursor
- A boolean to indicate if the half busy
cursor should be used while this job is running.Job.schedule(long)
void schedule(Job job, long delay)
WorkbenchPart.setBusy
.
job
- The job to scheduledelay
- The delay in scheduling.Job.schedule(long)
void schedule(Job job)
WorkbenchPart.setBusy
.
job
- The job to scheduleJob.schedule()
void showBusyForFamily(java.lang.Object family)
family
- ObjectJob.belongsTo(Object)
void warnOfContentChange()
IPresentablePart.PROP_HIGHLIGHT_IF_BACK
|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.