|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IRunnableWithProgress
interface should be implemented by any
class whose instances are intended to be executed as a long-running operation.
Long-running operations are typically presented at the UI via a modal dialog
showing a progress indicator and a Cancel button.
The class must define a run
method that takes a progress monitor.
The run
method is usually not invoked directly, but rather by
passing the IRunnableWithProgress
to the run
method of
an IRunnableContext
, which provides the UI for the progress monitor
and Cancel button.
IRunnableContext
Method Summary | |
void |
run(IProgressMonitor monitor)
Runs this operation. |
Method Detail |
public void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException
IRunnableContext
's run
method,
which supplies the progress monitor.
A request to cancel the operation should be honored and acknowledged
by throwing InterruptedException
.
monitor
- the progress monitor to use to display progress and receive
requests for cancelation
InvocationTargetException
- if the run method must propagate a checked exception,
it should wrap it inside an InvocationTargetException
; runtime exceptions are automatically
wrapped in an InvocationTargetException
by the calling context
InterruptedException
- if the operation detects a request to cancel,
using IProgressMonitor.isCanceled()
, it should exit by throwing
InterruptedException
IRunnableContext.run(boolean, boolean, org.eclipse.jface.operation.IRunnableWithProgress)
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |