org.netbeans.modules.progress.spi

Interface RunOffEDTProvider.Progress

All Superinterfaces:

RunOffEDTProvider

All Known Subinterfaces:

RunOffEDTProvider.Progress2

Enclosing interface:

RunOffEDTProvider

public static interface RunOffEDTProvider.Progress
extends RunOffEDTProvider

Interface all RunOffEDTProviders should implement, which allows for blocking the main window and showing a progress bar in a dialog while executing a runnable. If not present, ProjectUtils will delegate to runOffEventDispatchThread(), but this provides an inferior user experience and sometimes useless cancel button.

Since:

1.19

Nested Class Summary

Nested classes/interfaces inherited from interface org.netbeans.modules.progress.spi.RunOffEDTProvider

RunOffEDTProvider.Progress, RunOffEDTProvider.Progress2

Method Summary

Modifier and Type	Method and Description
<T> T	showProgressDialogAndRun(ProgressRunnable<T> toRun, String displayName, boolean includeDetailLabel) Show a modal progress dialog that blocks the main window while running a background process.
void	showProgressDialogAndRun(Runnable operation, ProgressHandle handle, boolean includeDetailLabel) Show a modal progress dialog that blocks the main window while running a background process.
<T> Future<T>	showProgressDialogAndRunLater(ProgressRunnable<T> toRun, ProgressHandle handle, boolean includeDetailLabel) Show a modal progress dialog that blocks the main window while running a background process.

Methods inherited from interface org.netbeans.modules.progress.spi.RunOffEDTProvider

runOffEventDispatchThread

Method Detail

showProgressDialogAndRun

void showProgressDialogAndRun(Runnable operation,
                              ProgressHandle handle,
                              boolean includeDetailLabel)

Show a modal progress dialog that blocks the main window while running a background process. This call should block until the work is completed.

The resulting progress UI should show a cancel button if the passed runnable implements org.openide.util.Cancellable.

Parameters:

operation - A runnable that needs to be run with the UI blocked

handle - A progress handle that will be updated to reflect the progress of the operation

includeDetailLabel - If true, a label should be provided in the progress dialog to show detailed progress messages

showProgressDialogAndRun

<T> T showProgressDialogAndRun(ProgressRunnable<T> toRun,
                               String displayName,
                               boolean includeDetailLabel)

Show a modal progress dialog that blocks the main window while running a background process. This call should block until the work is completed.

The resulting progress UI should show a cancel button if the passed runnable implements org.openide.util.Cancellable.

Type Parameters:

T - The type of the return value

Parameters:

toRun - A ProgressCallable which will be passed a progress handle on a background thread, can do its work and (optionally) return a value

displayName - The display name of the work being done

includeDetailLabel - Show the detail levels. Set to true if the caller will use ProgressHandle.progress (String, int) to provide detailed progress messages

Returns:

The result of the call to ProgressRunnable.call()

showProgressDialogAndRunLater

<T> Future<T> showProgressDialogAndRunLater(ProgressRunnable<T> toRun,
                                            ProgressHandle handle,
                                            boolean includeDetailLabel)

Show a modal progress dialog that blocks the main window while running a background process. This call should block until the work is started, and then return a Future which can be monitored for completion or cancelled.

The resulting progress UI should show a cancel button if the passed runnable implements org.openide.util.Cancellable.

Parameters:

toRun - The operation to run

handle - A progress handle

includeDetailLabel - Whether or not to include a detail label

Returns:

A future which can be cancelled