org.netbeans.api.progress.aggregate

Class BasicAggregateProgressFactory

java.lang.Object

org.netbeans.api.progress.aggregate.BasicAggregateProgressFactory

public class BasicAggregateProgressFactory
extends Object

Factory for creation of aggregate progress indication handles and individual contributor instances. For a more simple version of progress indication, see ProgressHandle

Constructor Summary

Constructors

Constructor and Description
BasicAggregateProgressFactory()

Method Summary

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)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAggregateProgressFactory

public BasicAggregateProgressFactory()

Method Detail

createHandle

public static AggregateProgressHandle createHandle(String displayName,
                                                   ProgressContributor[] contributors,
                                                   Cancellable allowToCancel)

Create an aggregating progress ui handle for a long lasting task.

Parameters:

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.

displayName - to be shown in the progress UI

Returns:

an instance of ProgressHandle, initialized but not started.

createProgressContributor

public static ProgressContributor createProgressContributor(String trackingId)

createSystemHandle

public static AggregateProgressHandle createSystemHandle(String displayName,
                                                         ProgressContributor[] contributors,
                                                         Cancellable allowToCancel,
                                                         Action linkOutput)

Create an aggregating progress ui handle for a long lasting task.

Parameters:

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 UI

Returns:

an instance of ProgressHandle, initialized but not started.

Since:

1.59

createHandle

public static AggregateProgressHandle createHandle(String displayName,
                                                   ProgressContributor[] contributors,
                                                   Cancellable allowToCancel,
                                                   Action linkOutput)

Create an aggregating progress ui handle for a long lasting task.

Parameters:

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 UI

Returns:

an instance of ProgressHandle, initialized but not started.

Since:

1.59

doCreateHandle

protected static AggregateProgressHandle doCreateHandle(String displayName,
                                                        ProgressContributor[] contributors,
                                                        Cancellable allowToCancel,
                                                        boolean systemHandle,
                                                        ProgressHandle h)

getProgressHandle

protected static ProgressHandle getProgressHandle(AggregateProgressHandle ah)