ProgressHandleFactory (Progress API

java.lang.Object
- org.netbeans.api.progress.ProgressHandleFactory

```
public final class ProgressHandleFactory
extends java.lang.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

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createHandle
```
public static org.netbeans.api.progress.ProgressHandle createHandle(java.lang.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
```
public static org.netbeans.api.progress.ProgressHandle createHandle(java.lang.String displayName,
                                                                    org.openide.util.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
```
public static org.netbeans.api.progress.ProgressHandle createHandle(java.lang.String displayName,
                                                                    javax.swing.Action linkOutput)
```
    Create a progress ui handle for a long lasting task.
    
    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
```
public static org.netbeans.api.progress.ProgressHandle createHandle(java.lang.String displayName,
                                                                    org.openide.util.Cancellable allowToCancel,
                                                                    javax.swing.Action linkOutput)
```
    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.
    
    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.
  - createProgressComponent
```
public static javax.swing.JComponent createProgressComponent(org.netbeans.api.progress.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 javax.swing.JLabel createMainLabelComponent(org.netbeans.api.progress.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 javax.swing.JLabel createDetailLabelComponent(org.netbeans.api.progress.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
```
public static org.netbeans.api.progress.ProgressHandle createSystemHandle(java.lang.String displayName)
```
    Create a handle for a long lasting task that is not triggered by explicit user action. Such tasks have lower priority in the UI.
    
    Parameters:
    
    displayName - to be shown in the progress UI
    
    Returns:
    
    an instance of ProgressHandle, initialized but not started.
  - createSystemHandle
```
public static org.netbeans.api.progress.ProgressHandle createSystemHandle(java.lang.String displayName,
                                                                          org.openide.util.Cancellable allowToCancel)
```
    Create a cancelable handle for a task that is not triggered by explicit user action. Such tasks have lower priority in the UI.
    
    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
```
public static org.netbeans.api.progress.ProgressHandle createSystemHandle(java.lang.String displayName,
                                                                          org.openide.util.Cancellable allowToCancel,
                                                                          javax.swing.Action linkOutput)
```
    Create a progress ui handle for a task that is not triggered by explicit user action.
    
    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.

Class ProgressHandleFactory

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createHandle

createHandle

createHandle

createHandle

createProgressComponent

createMainLabelComponent

createDetailLabelComponent

createSystemHandle

createSystemHandle

createSystemHandle