org.netbeans.api.progress

Class ProgressHandleFactory

java.lang.Object

org.netbeans.api.progress.ProgressHandleFactory

public final class ProgressHandleFactory
extends Object

Factory to create various ProgressHandle instances that allow long lasting tasks to show their progress using various progress UIs. This class adds the ability to provide a custom Swing UI (JPanel) and manipulate with Swing components to the ProgressHandle.

Method Summary

Modifier and Type	Method and Description
static JLabel	createDetailLabelComponent(ProgressHandle handle) Get the detail messages component for use in custom dialogs, the task won't show in the progress bar anymore.
static ProgressHandle	createHandle(String displayName) Deprecated. Use ProgressHandle.createHandle(java.lang.String)
static ProgressHandle	createHandle(String displayName, Action linkOutput) Deprecated. Please use ProgressHandle.createHandle(java.lang.String, org.openide.util.Cancellable, javax.swing.Action)
static ProgressHandle	createHandle(String displayName, Cancellable allowToCancel) Deprecated. Use ProgressHandle.createHandle(java.lang.String, org.openide.util.Cancellable).
static ProgressHandle	createHandle(String displayName, Cancellable allowToCancel, Action linkOutput) Deprecated. Please use ProgressHandle.createHandle(java.lang.String, org.openide.util.Cancellable, javax.swing.Action)
static JLabel	createMainLabelComponent(ProgressHandle handle) Get the task title component for use in custom dialogs, the task won't show in the progress bar anymore.
static JComponent	createProgressComponent(ProgressHandle handle) Get the progress bar component for use in custom dialogs, the task won't show in the progress bar anymore.
static ProgressHandle	createSystemHandle(String displayName) Deprecated. Use ProgressHandle.createSystemHandle(java.lang.String, org.openide.util.Cancellable).
static ProgressHandle	createSystemHandle(String displayName, Cancellable allowToCancel) Deprecated. Use ProgressHandle.createSystemHandle(java.lang.String, org.openide.util.Cancellable).
static ProgressHandle	createSystemHandle(String displayName, Cancellable allowToCancel, Action linkOutput) Deprecated. Please use ProgressHandle.createSystemHandle(java.lang.String, org.openide.util.Cancellable, javax.swing.Action)
static ProgressHandle	createSystemUIHandle(String displayName, Cancellable allowToCancel, Action linkOutput) Create a progress UI handle for a task that is not triggered by explicit user action.
static ProgressHandle	createUIHandle(String displayName, Cancellable allowToCancel, Action linkOutput) Create a progress UI handle for a long lasting task.

Methods inherited from class java.lang.Object

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

Method Detail

createHandle

@Deprecated
public static ProgressHandle createHandle(String displayName)

Deprecated. Use ProgressHandle.createHandle(java.lang.String)

Create a progress ui handle for a long lasting task.

Parameters:

displayName - to be shown in the progress UI

Returns:

an instance of ProgressHandle, initialized but not started.

createHandle

@Deprecated
public static ProgressHandle createHandle(String displayName,
                                                      Cancellable allowToCancel)

Deprecated. Use ProgressHandle.createHandle(java.lang.String, org.openide.util.Cancellable).

Create a progress ui handle for a long lasting task.

Parameters:

allowToCancel - either null, if the task cannot be cancelled or an instance of Cancellable that will be called when user triggers cancel of the task.

displayName - to be shown in the progress UI

Returns:

an instance of ProgressHandle, initialized but not started.

createHandle

@Deprecated
public static ProgressHandle createHandle(String displayName,
                                                      Action linkOutput)

Deprecated. Please use ProgressHandle.createHandle(java.lang.String, org.openide.util.Cancellable, javax.swing.Action)

Create a progress ui handle for a long lasting task. Since 1.59, this method was migrated to basic Progress API.

Parameters:

linkOutput - an Action instance that links the running task in the progress bar to an output of the task. The action is assumed to open the apropriate component with the task's output.

displayName - to be shown in the progress UI

Returns:

an instance of ProgressHandle, initialized but not started.

createHandle

@Deprecated
public static ProgressHandle createHandle(String displayName,
                                                      Cancellable allowToCancel,
                                                      Action linkOutput)

Deprecated. Please use ProgressHandle.createHandle(java.lang.String, org.openide.util.Cancellable, javax.swing.Action)

Create a progress UI handle for a long lasting task. Since 1.59, this method was migrated to basic Progress API. This implementation delegates to ProgressHandle.createHandle(java.lang.String, org.openide.util.Cancellable, javax.swing.Action) to enable smooth transition of older Progress API clients.

Parameters:

allowToCancel - either null, if the task cannot be cancelled or an instance of Cancellable that will be called when user triggers cancel of the task.

linkOutput - an Action instance that links the running task in the progress bar to an output of the task. The action is assumed to open the appropriate component with the task's output.

displayName - to be shown in the progress UI

Returns:

an instance of ProgressHandle, initialized but not started.

createUIHandle

public static ProgressHandle createUIHandle(String displayName,
                                            Cancellable allowToCancel,
                                            Action linkOutput)

Create a progress UI handle for a long lasting task. This call creates a Swing-based implementation. Use only when the Handle is directly used in Swing UIs. These handles will never work in other presenters.

Parameters:

allowToCancel - either null, if the task cannot be cancelled or an instance of Cancellable that will be called when user triggers cancel of the task.

linkOutput - an Action instance that links the running task in the progress bar to an output of the task. The action is assumed to open the appropriate component with the task's output.

displayName - to be shown in the progress UI

Returns:

an instance of ProgressHandle, initialized but not started.

Since:

1.59

createProgressComponent

public static JComponent createProgressComponent(ProgressHandle handle)

Get the progress bar component for use in custom dialogs, the task won't show in the progress bar anymore.

Returns:

the component to use in custom UI.

createMainLabelComponent

public static JLabel createMainLabelComponent(ProgressHandle handle)

Get the task title component for use in custom dialogs, the task won't show in the progress bar anymore. The text of the label is changed by calls to ProgressHandle.setDisplayName() method

Returns:

the component to use in custom UI.

Since:

org.netbeans.api.progress 1.8

createDetailLabelComponent

public static JLabel createDetailLabelComponent(ProgressHandle handle)

Get the detail messages component for use in custom dialogs, the task won't show in the progress bar anymore. The text of the label is changed by calls to ProgressHandle.progress(String) method.

Returns:

the component to use in custom UI.

Since:

org.netbeans.api.progress 1.8

createSystemHandle

@Deprecated
public static ProgressHandle createSystemHandle(String displayName)

Deprecated. Use ProgressHandle.createSystemHandle(java.lang.String, org.openide.util.Cancellable).

Create a handle for a long lasting task that is not triggered by explicit user action. Such tasks have lower priority in the UI. Since 1.59, the functionality moves to basic Progress API; this method is retained for smooth transition of older API clients.

Parameters:

displayName - to be shown in the progress UI

Returns:

an instance of ProgressHandle, initialized but not started.

createSystemHandle

@Deprecated
public static ProgressHandle createSystemHandle(String displayName,
                                                            Cancellable allowToCancel)

Deprecated. Use ProgressHandle.createSystemHandle(java.lang.String, org.openide.util.Cancellable).

Create a cancelable handle for a task that is not triggered by explicit user action. Such tasks have lower priority in the UI. Since 1.59, the functionality moves to basic Progress API; this method is retained for smooth transition of older API clients.

Parameters:

displayName - to be shown in the progress UI

allowToCancel - either null, if the task cannot be cancelled or an instance of Cancellable that will be called when user triggers cancel of the task.

Returns:

an instance of ProgressHandle, initialized but not started.

createSystemHandle

@Deprecated
public static ProgressHandle createSystemHandle(String displayName,
                                                            Cancellable allowToCancel,
                                                            Action linkOutput)

Deprecated. Please use ProgressHandle.createSystemHandle(java.lang.String, org.openide.util.Cancellable, javax.swing.Action)

Create a progress UI handle for a task that is not triggered by explicit user action. Starting from 1.59, this method is fully superseded by ProgressHandle.createSystemHandle(java.lang.String, org.openide.util.Cancellable, javax.swing.Action). Since 1.59, the functionality moves to basic Progress API; this method is retained for smooth transition of older API clients.

Parameters:

allowToCancel - either null, if the task cannot be cancelled or an instance of Cancellable that will be called when user triggers cancel of the task.

linkOutput - an Action instance that links the running task in the progress bar to an output of the task. The action is assumed to open the apropriate component with the task's output.

displayName - to be shown in the progress UI

Returns:

an instance of ProgressHandle, initialized but not started.

createSystemUIHandle

public static ProgressHandle createSystemUIHandle(String displayName,
                                                  Cancellable allowToCancel,
                                                  Action linkOutput)

Create a progress UI handle for a task that is not triggered by explicit user action. This call creates a Swing-based implementation. Use only when the Handle is directly used in Swing UIs. These handles will never work in other presenters.

Parameters:

allowToCancel - either null, if the task cannot be cancelled or an instance of Cancellable that will be called when user triggers cancel of the task.

linkOutput - an Action instance that links the running task in the progress bar to an output of the task. The action is assumed to open the apropriate component with the task's output.

displayName - to be shown in the progress UI

Returns:

an instance of ProgressHandle, initialized but not started.

Since:

1.59