org.netbeans.modules.progress.spi

Class ProgressEvent

java.lang.Object

org.netbeans.modules.progress.spi.ProgressEvent

public final class ProgressEvent
extends Object

Since:

org.netbeans.api.progress/1 1.18

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_FINISH
static int	TYPE_PROGRESS
static int	TYPE_REQUEST_STOP
static int	TYPE_SILENT
static int	TYPE_START
static int	TYPE_SWITCH

Constructor Summary

Constructors

Constructor and Description
ProgressEvent(InternalHandle src, int type, boolean isWatched) Creates a new instance of ProgressEvent
ProgressEvent(InternalHandle src, int type, boolean isWatched, String msg) Creates a new instance of ProgressEvent
ProgressEvent(InternalHandle src, String msg, int units, double percentage, long estimate, boolean isWatched)
ProgressEvent(InternalHandle src, String msg, int units, double percentage, long estimate, boolean isWatched, String displayName)

Method Summary

Modifier and Type	Method and Description
void	copyMessageFromEarlier(ProgressEvent last) used in controller, preserve dynamic message from earlier events if this one doesn't have it's own.
String	getDisplayName()
long	getEstimatedCompletion()
String	getMessage()
double	getPercentageDone()
InternalHandle	getSource()
int	getType()
int	getWorkunitsDone()
boolean	isSwitched()
boolean	isWatched()
void	markAsSwitched()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_START

public static final int TYPE_START

See Also:

Constant Field Values

TYPE_FINISH

public static final int TYPE_FINISH

See Also:

Constant Field Values

TYPE_REQUEST_STOP

public static final int TYPE_REQUEST_STOP

See Also:

Constant Field Values

TYPE_PROGRESS

public static final int TYPE_PROGRESS

See Also:

Constant Field Values

TYPE_SWITCH

public static final int TYPE_SWITCH

See Also:

Constant Field Values

TYPE_SILENT

public static final int TYPE_SILENT

See Also:

Constant Field Values

Constructor Detail

ProgressEvent

public ProgressEvent(InternalHandle src,
                     int type,
                     boolean isWatched)

Creates a new instance of ProgressEvent

Parameters:

type - one of TYPE_START, TYPE_REQUEST_STOP, TYPE_FINISH, TYPE_SWITCHED

ProgressEvent

public ProgressEvent(InternalHandle src,
                     int type,
                     boolean isWatched,
                     String msg)

Creates a new instance of ProgressEvent

Parameters:

type - one of TYPE_SILENT

ProgressEvent

public ProgressEvent(InternalHandle src,
                     String msg,
                     int units,
                     double percentage,
                     long estimate,
                     boolean isWatched)

Parameters:

percentage - completed work percentage

estimate - estimate of completion in seconds

ProgressEvent

public ProgressEvent(InternalHandle src,
                     String msg,
                     int units,
                     double percentage,
                     long estimate,
                     boolean isWatched,
                     String displayName)

Method Detail

getSource

public InternalHandle getSource()

getEstimatedCompletion

public long getEstimatedCompletion()

getPercentageDone

public double getPercentageDone()

getWorkunitsDone

public int getWorkunitsDone()

getMessage

public String getMessage()

getType

public int getType()

isWatched

public boolean isWatched()

copyMessageFromEarlier

public void copyMessageFromEarlier(ProgressEvent last)

used in controller, preserve dynamic message from earlier events if this one doesn't have it's own.

markAsSwitched

public void markAsSwitched()

isSwitched

public boolean isSwitched()

getDisplayName

public String getDisplayName()

toString

public String toString()

Overrides:

toString in class Object