Package org.teamapps.ux.task

Class Progress

java.lang.Object

org.teamapps.ux.task.Progress

All Implemented Interfaces:

ObservableProgress, ProgressMonitor

public class Progress
extends java.lang.Object
implements ProgressMonitor, ObservableProgress

Field Summary

Fields

Modifier and Type	Field	Description
Event<ProgressChangeEventData>	onChanged

Constructor Summary

Constructors

Constructor	Description
Progress()

Method Summary

Modifier and Type	Method	Description
double	getProgress()
ProgressStatus	getStatus()
java.lang.String	getStatusMessage()
boolean	isCancelable()
boolean	isCancellationRequested()
void	markCanceled()
void	markCanceled(java.lang.String statusMessage)
void	markCompleted()
void	markCompleted(java.lang.String statusMessage)
void	markFailed()
void	markFailed(java.lang.String message)
Event<ProgressChangeEventData>	onChanged()
void	requestCancellation()
void	setCancelable(boolean cancelable)
void	setProgress(double progress)
void	setProgress(double progress, java.lang.String statusMessage)
void	setStatusMessage(java.lang.String statusMessage)
void	start()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.task.ObservableProgress

isProgressUnknown

Methods inherited from interface org.teamapps.ux.task.ProgressMonitor

setProgressIndeterminate, setProgressIndeterminate

Field Detail

onChanged

public final Event<ProgressChangeEventData> onChanged

Constructor Detail

Progress

public Progress()

Method Detail

onChanged

public Event<ProgressChangeEventData> onChanged()

Specified by:

onChanged in interface ObservableProgress

getStatusMessage

public java.lang.String getStatusMessage()

Specified by:

getStatusMessage in interface ObservableProgress

getProgress

public double getProgress()

Specified by:

getProgress in interface ObservableProgress

isCancelable

public boolean isCancelable()

Specified by:

isCancelable in interface ObservableProgress

Specified by:

isCancelable in interface ProgressMonitor

requestCancellation

public void requestCancellation()

Specified by:

requestCancellation in interface ObservableProgress

isCancellationRequested

public boolean isCancellationRequested()

Specified by:

isCancellationRequested in interface ObservableProgress

Specified by:

isCancellationRequested in interface ProgressMonitor

getStatus

public ProgressStatus getStatus()

Specified by:

getStatus in interface ObservableProgress

start

public void start()

Specified by:

start in interface ProgressMonitor

setProgress

public void setProgress(double progress)

Specified by:

setProgress in interface ProgressMonitor

setProgress

public void setProgress(double progress,
                        java.lang.String statusMessage)

Specified by:

setProgress in interface ProgressMonitor

setStatusMessage

public void setStatusMessage(java.lang.String statusMessage)

Specified by:

setStatusMessage in interface ProgressMonitor

markCanceled

public void markCanceled()

Specified by:

markCanceled in interface ProgressMonitor

markCanceled

public void markCanceled(java.lang.String statusMessage)

Specified by:

markCanceled in interface ProgressMonitor

markCompleted

public void markCompleted()

Specified by:

markCompleted in interface ProgressMonitor

markCompleted

public void markCompleted(java.lang.String statusMessage)

Specified by:

markCompleted in interface ProgressMonitor

markFailed

public void markFailed()

Specified by:

markFailed in interface ProgressMonitor

markFailed

public void markFailed(java.lang.String message)

Specified by:

markFailed in interface ProgressMonitor

setCancelable

public void setCancelable(boolean cancelable)

Specified by:

setCancelable in interface ProgressMonitor