org.jdesktop.swing.event
Class ProgressEvent

java.lang.Object
  java.util.EventObject
      org.jdesktop.swing.event.MessageEvent
          org.jdesktop.swing.event.ProgressEvent

All Implemented Interfaces:

Serializable

public class ProgressEvent

extends MessageEvent

A MessageEvent that represents the cycle of a long running operation. Use the constructors to indicate the stage of the operation.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

ProgressEvent(Object source)
Constructs an indeterminate progress event.

ProgressEvent(Object source, int progress)
Constructs a progress event used to indicate an increment of progress.

ProgressEvent(Object source, int min, int max)
Constructs a ProgressEvent which indicates the beginning of a long operation.

Method Summary

int	getMaximum()
int	getMinimum()
int	getProgress()
boolean	isIndeterminate()

Methods inherited from class org.jdesktop.swing.event.MessageEvent

getLevel, getMessage, getThrowable, getValue, getWhen, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressEvent

public ProgressEvent(Object source)

Constructs an indeterminate progress event.

ProgressEvent

public ProgressEvent(Object source,
                     int progress)

Constructs a progress event used to indicate an increment of progress.

Parameters:

source - the object which orignated the event

progress - the value between min and max which indicates the progression of the operation.

ProgressEvent

public ProgressEvent(Object source,
                     int min,
                     int max)

Constructs a ProgressEvent which indicates the beginning of a long operation. For a determinite progress operation, the minimum value should be less than the maximum value. For indterminate operations, set minimum equal to maximum.

Parameters:

source - the object which orignated the event

min - the minimum value of the progress operation

max - the maximum value of the progress operation

Method Detail

getMaximum

public int getMaximum()

getMinimum

public int getMinimum()

isIndeterminate

public boolean isIndeterminate()

getProgress

public int getProgress()