oracle.ide.controller

Class AsynchronousController.TaskInfo

java.lang.Object

oracle.ide.controller.AsynchronousController.TaskInfo

All Implemented Interfaces:

org.openide.util.Cancellable

Enclosing class:

AsynchronousController

public static final class AsynchronousController.TaskInfo
extends java.lang.Object
implements org.openide.util.Cancellable

Utility class for showing progress, canceling, waiting on task running out of EDT.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Cancels the task.
org.netbeans.api.progress.ProgressHandle	createHandle(java.lang.String displayName, boolean cancelable, boolean modal) Created a ProgressHandle for informing user about how execution is progressing.
org.netbeans.api.progress.ProgressHandle	createHandle(java.lang.String displayName, boolean cancelable, int waitCursorAfter, int dialogAfter) Created a ProgressHandle for informing user about how execution is progressing.
org.netbeans.api.progress.ProgressHandle	getHandle() Must have been created otherwise returns null.
boolean	isCancelled() Test if the task has been canceled
WaitCursor	showWaitCursor() Shows a wait cursor (hourglass or other form) bould to the main window of the IDE.
void	waitFinished() Waits (blocks) till the execution of the task is finished i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isCancelled

public final boolean isCancelled()

Test if the task has been canceled

Returns:

true if cancel() has been called.

cancel

public final boolean cancel()

Cancels the task. After call to this method the isCancelled() will return true. If the task has been set to use Thread.interrupt() this method will be called on the thread handling the action.

It is up to the implementor of the handling method to test often the isCancelled() or Thread.isInterrupted() handling InterruptedException and associated exceptions correctly and cancel the execution in such cases.

Specified by:

cancel in interface org.openide.util.Cancellable

Returns:

true;

waitFinished

public final void waitFinished()

Waits (blocks) till the execution of the task is finished i.e. till it is really finished or till the task react to cancel() and exists.

showWaitCursor

public final WaitCursor showWaitCursor()

Shows a wait cursor (hourglass or other form) bould to the main window of the IDE. Call this method if you want to block the user's interaction and still show progress in the status bar.

createHandle

public final org.netbeans.api.progress.ProgressHandle createHandle(java.lang.String displayName,
                                                    boolean cancelable,
                                                    boolean modal)

Created a ProgressHandle for informing user about how execution is progressing.

Parameters:

displayName - Name/label of the handle.

cancelable - Should user be given a chance to cancel the operation.

modal - If true show a dialog (modal) of false show progress in status bar and does not block interaction with the IDE.

Returns:

the ProgressHandle

createHandle

public final org.netbeans.api.progress.ProgressHandle createHandle(java.lang.String displayName,
                                                    boolean cancelable,
                                                    int waitCursorAfter,
                                                    int dialogAfter)

Created a ProgressHandle for informing user about how execution is progressing.

Parameters:

displayName - Name/label of the handle.

cancelable - Should user be given a chance to cancel the operation.

waitCursorAfter - cursor is changed to wait type when task is not finished in given number of milliseconds, use -1 for default 1000ms interval.

dialogAfter - progress dialog is going to show up when task is not finished in additional given number of milliseconds, use -1 value for additional 2000ms interval.

Returns:

the ProgressHandle

getHandle

public final org.netbeans.api.progress.ProgressHandle getHandle()

Must have been created otherwise returns null. Will not create handle if it has not already been created

Returns: