Overview

# Introduction

This document lists changes made to the Progress API/SPI.

# Index of APIs

- Progress API

# Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

# All changes by date

- (Nov 25 '05) Allow to change display name of running progress task
- (Oct 19 '05) Adding `createProgressComponent(AggregateProgressHandle)` method to `AggregateProgressFactory`
- (Sep 26 '05) Adding `setInitialDelay(int)` method to `ProgressHandle` and `AggregateProgressHandle`
- (May 4 '05) Initial version released

# Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled `1.20`, your manifest should contain in its main attributes the line:

    OpenIDE-Module-Module-Dependencies: org.netbeans.api.progress > 1.20

- (1.5) Allow to change display name of running progress task
- (1.3) Adding `createProgressComponent(AggregateProgressHandle)` method to `AggregateProgressFactory`
- (1.2) Adding `setInitialDelay(int)` method to `ProgressHandle` and `AggregateProgressHandle`
- (1.0) Initial version released

# Changes by affected class

## `org.netbeans.api.progress.aggregate.AggregateProgressFactory`

- (Oct 19 '05) Adding `createProgressComponent(AggregateProgressHandle)` method to `AggregateProgressFactory`

## `org.netbeans.api.progress.aggregate.AggregateProgressHandle`

- (Nov 25 '05) Allow to change display name of running progress task
- (Oct 19 '05) Adding `createProgressComponent(AggregateProgressHandle)` method to `AggregateProgressFactory`
- (Sep 26 '05) Adding `setInitialDelay(int)` method to `ProgressHandle` and `AggregateProgressHandle`

## `org.netbeans.api.progress.ProgressHandle`

- (Nov 25 '05) Allow to change display name of running progress task
- (Sep 26 '05) Adding `setInitialDelay(int)` method to `ProgressHandle` and `AggregateProgressHandle`

# Details of all changes by API and date

## Progress API

### Allow to change display name of running progress task

Nov 25 '05; API spec. version: 1.5; affected top-level classes: `ProgressHandle` `AggregateProgressHandle`; made by: mkleint; issues: #68923

Added new method `setDisplayName(String)` to `ProgressHandle` and `AggregateProgressHandle`, allows to change the main identifying name of the progress task.

### Adding `createProgressComponent(AggregateProgressHandle)` method to `AggregateProgressFactory`

Oct 19 '05; API spec. version: 1.3; affected top-level classes: `AggregateProgressFactory` `AggregateProgressHandle`; made by: mkleint; issues: #66554

For aggregated progress handles the equivalent of ProgressHandleFactory.createProgressComponent() was missing. Added in this version.

### Adding `setInitialDelay(int)` method to `ProgressHandle` and `AggregateProgressHandle`

Sep 26 '05; API spec. version: 1.2; affected top-level classes: `ProgressHandle` `AggregateProgressHandle`; made by: mkleint; issues: #60966

The newly added methods allow to customize the amount of time that shall pass between the start of handle's progress and it's appearance in the status bar. If the progress task finishes fast enough it won't appear in the UI at all. The default value is around 0.5s.

For handles that are used in dialogs and elsewhere, this property has no effect and the handle's component is shown immediately.

### Initial version released

May 4 '05; API spec. version: 1.0; made by: mkleint
first initial release of the progress api.

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