Package org.eclipse.zest.layouts.progress

Class ProgressEvent

java.lang.Object

org.eclipse.zest.layouts.progress.ProgressEvent

@Deprecated(since="2.0",
            forRemoval=true)
public class ProgressEvent
extends Object

Deprecated, for removal: This API element is subject to removal in a future version.

No longer used in Zest 2.x. This class will be removed in a future release.

When an algorithm wants to notify everyone it has completely part of its task, it throws a ProgressEvent. The progress is a number (currentProgress) representing the current steps completed out of the total number of steps (totalProgress)

@noextend

This class is not intended to be subclassed by clients.

@noreference

This class is not intended to be referenced by clients.

@noinstantiate

This class is not intended to be instantiated by clients.

Constructor Summary

Constructors

Constructor	Description
ProgressEvent(int stepsCompleted, int totalNumberOfSteps)	Deprecated.

Method Summary

Modifier and Type	Method	Description
int	getStepsCompleted()	Deprecated.
int	getTotalNumberOfSteps()	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

ProgressEvent

@Deprecated
public ProgressEvent(int stepsCompleted,
 int totalNumberOfSteps)

Deprecated.

Creates a progress event.

Parameters:

stepsCompleted - The current progress out of the total

totalNumberOfSteps - The number used to indicate when the algorithm will finish

Method Details

getStepsCompleted

@Deprecated
public int getStepsCompleted()

Deprecated.

Returns the number of steps already completed.

getTotalNumberOfSteps

@Deprecated
public int getTotalNumberOfSteps()

Deprecated.

Returns the total number of steps to complete.