public final class ProgressHandleFactory extends Object
ProgressHandle
.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.
|
static ProgressHandle |
createHandle(String displayName,
Action linkOutput)
Create a progress ui handle for a long lasting task.
|
static ProgressHandle |
createHandle(String displayName,
Cancellable allowToCancel)
|
static ProgressHandle |
createHandle(String displayName,
Cancellable allowToCancel,
Action linkOutput)
Create a progress ui handle for a long lasting task.
|
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)
Create a handle for a long lasting task that is not triggered by explicit user action.
|
static ProgressHandle |
createSystemHandle(String displayName,
Cancellable allowToCancel)
Create a cancelable handle for a task that is not triggered by explicit user action.
|
static ProgressHandle |
createSystemHandle(String displayName,
Cancellable allowToCancel,
Action linkOutput)
Create a progress ui handle for a task that is not triggered by explicit user action.
|
public static ProgressHandle createHandle(String displayName)
ProgressHandle.createHandle(java.lang.String)
displayName
- to be shown in the progress UIProgressHandle
, initialized but not started.public static ProgressHandle createHandle(String displayName, Cancellable allowToCancel)
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 UIProgressHandle
, initialized but not started.public static ProgressHandle createHandle(String displayName, Action linkOutput)
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 UIProgressHandle
, initialized but not started.public static ProgressHandle createHandle(String displayName, Cancellable allowToCancel, Action linkOutput)
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 UIProgressHandle
, initialized but not started.public static JComponent createProgressComponent(ProgressHandle handle)
public static JLabel createMainLabelComponent(ProgressHandle handle)
ProgressHandle.setDisplayName()
methodpublic static JLabel createDetailLabelComponent(ProgressHandle handle)
ProgressHandle.progress(String)
method.public static ProgressHandle createSystemHandle(String displayName)
displayName
- to be shown in the progress UIProgressHandle
, initialized but not started.public static ProgressHandle createSystemHandle(String displayName, Cancellable allowToCancel)
displayName
- to be shown in the progress UIallowToCancel
- either null, if the task cannot be cancelled or
an instance of Cancellable
that will be called when user
triggers cancel of the task.ProgressHandle
, initialized but not started.public static ProgressHandle createSystemHandle(String displayName, Cancellable allowToCancel, Action linkOutput)
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 UIProgressHandle
, initialized but not started.Built on December 10 2023. | Copyright © 2017-2023 Apache Software Foundation. All Rights Reserved.