Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| org.netbeans.api.progress/1 1.5.22
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

## Package org.netbeans.api.progress

This API allows to visualize tracking for progress of long lasting tasks.

See:
Description

Class Summary
ProgressHandle | Instances provided by the ProgressHandleFactory allow the users of the API to notify the progress bar UI about changes in the state of the running task.
ProgressHandleFactory | Factory to create various ProgressHandle instances that allow long lasting tasks to show their progress using various progress UIs.

## Package org.netbeans.api.progress Description

This API allows to visualize tracking for progress of long lasting tasks.

The usual usecase goes like this:

    ProgressHandle handle = ProgressHandleFactory.createHandle("My custom task");
    ...
    // we have 100 workunits
    // at this point the task appears in status bar.
    handle.start(100);
    ...
    handle.progress(10);
    ...
    handle.progress(50);
    ...
    // at this point the task is finished and removed from status bar
    handle.finish();

There are several options on how detailed visualization you want.

- task with unknown duration or with hard to show progress steps.
- task with known scaled steps
- task with known steps and also with a time estimate for completion

All these usecases are supported by methods of `ProgressHandle` class. Additionally it's possible to include textual information about current progress.
If the task allows to be cancelled by the user, then you have to implement `Cancellable` interface and pass it to the `ProgressHandleFactory` when creating the handle.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| org.netbeans.api.progress/1 1.5.22
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

Built on December 7 2006. | Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.