|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.util.EventObject
com.bbn.openmap.event.ProgressEvent
public class ProgressEvent
An event that provides information on progress on a certain task.
| Field Summary | |
|---|---|
protected float |
currentValue
|
static int |
DONE
Progress event type, notification of process completion. |
protected float |
finishedValue
|
static int |
START
Progress event type, start process. |
protected java.lang.String |
taskDescription
|
protected int |
type
|
static int |
UPDATE
Progress event type, update of current process. |
| Fields inherited from class java.util.EventObject |
|---|
source |
| Constructor Summary | |
|---|---|
ProgressEvent(java.lang.Object source,
int type,
java.lang.String taskDescription,
float finishValue,
float currentValue)
Construct a ProgressEvent. |
|
| Method Summary | |
|---|---|
float |
getCurrentValue()
Get the current value representing progress. |
float |
getFinishedValue()
Get the value that current will have to get to to be finished. |
int |
getPercentComplete()
Provide a percentage of progress completed, or -1 if no finished value has been provided. |
java.lang.String |
getTaskDescription()
Get a string describing what the task is. |
int |
getType()
|
| Methods inherited from class java.util.EventObject |
|---|
getSource, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final int START
public static final int UPDATE
public static final int DONE
protected float finishedValue
protected float currentValue
protected java.lang.String taskDescription
protected int type
| Constructor Detail |
|---|
public ProgressEvent(java.lang.Object source,
int type,
java.lang.String taskDescription,
float finishValue,
float currentValue)
source - ObjectfinishValue - the ending valuecurrentValue - the current value| Method Detail |
|---|
public float getFinishedValue()
public float getCurrentValue()
public java.lang.String getTaskDescription()
public int getPercentComplete()
public int getType()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||