ProgressMeter (Mango Plugin API)

```
public interface ProgressMeter
```
A meter that can be used to provide feedback to users about the progress of a process. The progress meter will appear in the application toolbox.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getCurrent()` Returns the current value.
`int`	`getMax()` Returns the maximum value.
`int`	`getMin()` Returns the minimum value.
`void`	`setDescription(String des)` Sets the text of the progress meter.
`void`	`setIndeterminateMode(boolean bool)` Sets the indeterminate state (progress meter with no current value).
`void`	`setValue(int val)` Sets the current value of the meter.
`void`	`start(int min, int current, int max)` Starts the progress meter.
`void`	`start(int min, int current, int max, boolean forceStart)` Starts the progress meter.

- Method Detail
  - getCurrent
```
int getCurrent()
```
    Returns the current value.
    
    Returns:
    the current value
  - getMax
```
int getMax()
```
    Returns the maximum value.
    
    Returns:
    the maximum value
  - getMin
```
int getMin()
```
    Returns the minimum value.
    
    Returns:
    the minimum value
  - setDescription
```
void setDescription(String des)
```
    Sets the text of the progress meter.
    
    Parameters:
    des - the text
  - setIndeterminateMode
```
void setIndeterminateMode(boolean bool)
```
    Sets the indeterminate state (progress meter with no current value).
    
    Parameters:
    bool - if true, the meter will be set to indeterminate state, false otherwise
  - setValue
```
void setValue(int val)
```
    Sets the current value of the meter. The meter will automatically end when the value is greater than or equal to getMax(). It is recommended that meter.setValue(meter.getMax()) is placed in a "finally" block to ensure the meter will always be quit.
    
    Parameters:
    val - the current value of the meter
  - start
```
void start(int min,
         int current,
         int max)
```
    Starts the progress meter. The meter will not appear until setValue() has been called at least once after approximately 100ms have elapsed. It may not appear at all if the duration is to be very short-lived.
    
    Parameters:
    min - the minimum value of the meter
    current - the current value of the meter
    max - the maximum value of the meter
  - start
```
void start(int min,
         int current,
         int max,
         boolean forceStart)
```
    Starts the progress meter. The meter will not appear until setValue() has been called at least once after approximately 100ms have elapsed. It may not appear at all if the duration is to be very short-lived.
    
    Parameters:
    min - the minimum value of the meter
    current - the current value of the meter
    max - the maximum value of the meter
    forceStart - starts immediately

Interface ProgressMeter

Method Summary

Method Detail

getCurrent

getMax

getMin

setDescription

setIndeterminateMode

setValue

start

start