public class BasicAggregateProgressFactory extends Object
ProgressHandle
Constructor and Description |
---|
BasicAggregateProgressFactory() |
Modifier and Type | Method and Description |
---|---|
static AggregateProgressHandle |
createHandle(String displayName,
ProgressContributor[] contributors,
Cancellable allowToCancel)
Create an aggregating progress ui handle for a long lasting task.
|
static AggregateProgressHandle |
createHandle(String displayName,
ProgressContributor[] contributors,
Cancellable allowToCancel,
Action linkOutput)
Create an aggregating progress ui handle for a long lasting task.
|
static ProgressContributor |
createProgressContributor(String trackingId) |
static AggregateProgressHandle |
createSystemHandle(String displayName,
ProgressContributor[] contributors,
Cancellable allowToCancel,
Action linkOutput)
Create an aggregating progress ui handle for a long lasting task.
|
protected static AggregateProgressHandle |
doCreateHandle(String displayName,
ProgressContributor[] contributors,
Cancellable allowToCancel,
boolean systemHandle,
ProgressHandle h) |
protected static ProgressHandle |
getProgressHandle(AggregateProgressHandle ah) |
public static AggregateProgressHandle createHandle(String displayName, ProgressContributor[] contributors, Cancellable allowToCancel)
contributors
- the initial set of progress indication contributors that are aggregated in the 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.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 ProgressContributor createProgressContributor(String trackingId)
public static AggregateProgressHandle createSystemHandle(String displayName, ProgressContributor[] contributors, Cancellable allowToCancel, Action linkOutput)
contributors
- the initial set of progress indication contributors that are aggregated in the 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.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 AggregateProgressHandle createHandle(String displayName, ProgressContributor[] contributors, Cancellable allowToCancel, Action linkOutput)
contributors
- the initial set of progress indication contributors that are aggregated in the 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.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.protected static AggregateProgressHandle doCreateHandle(String displayName, ProgressContributor[] contributors, Cancellable allowToCancel, boolean systemHandle, ProgressHandle h)
protected static ProgressHandle getProgressHandle(AggregateProgressHandle ah)