com.inductiveautomation.ignition.client.util.gui

Class ProgressDialog.ProgressTask

java.lang.Object

com.inductiveautomation.ignition.client.util.gui.ProgressDialog.ProgressTask

All Implemented Interfaces:

ProgressListener

Direct Known Subclasses:

IgnitionDesigner.UpdateTask

Enclosing class:

ProgressDialog

public abstract static class ProgressDialog.ProgressTask
extends java.lang.Object
implements ProgressListener

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canceled
protected ProgressDialog	dialog

Constructor Summary

Constructors

Constructor and Description
ProgressTask()

Method Summary

Modifier and Type	Method and Description
protected boolean	allowsCancel()
boolean	isCanceled()
protected abstract java.lang.Object	run()
void	setIndeterminate(boolean bool) Allows the object performing the action to indicate that it won't be able to report back progress information.
void	setNote(java.lang.String note) Sets some sort of note or information about the current position.
void	setProgress(int val) Used to update the current progress value, should be between 0 and the value sent to setProgressMax.
void	setProgressDialog(ProgressDialog dialog)
void	setProgressMax(int max) Used to indicate the upper bound of value that will be passed to setProgress.

Methods inherited from class java.lang.Object

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

Field Detail

dialog

protected ProgressDialog dialog

canceled

protected boolean canceled

Constructor Detail

ProgressTask

public ProgressTask()

Method Detail

setProgressDialog

public void setProgressDialog(ProgressDialog dialog)

setProgressMax

public void setProgressMax(int max)

Description copied from interface: ProgressListener

Used to indicate the upper bound of value that will be passed to setProgress.

Specified by:

setProgressMax in interface ProgressListener

setProgress

public void setProgress(int val)

Description copied from interface: ProgressListener

Used to update the current progress value, should be between 0 and the value sent to setProgressMax.

Specified by:

setProgress in interface ProgressListener

setNote

public void setNote(java.lang.String note)

Description copied from interface: ProgressListener

Sets some sort of note or information about the current position.

Specified by:

setNote in interface ProgressListener

setIndeterminate

public void setIndeterminate(boolean bool)

Description copied from interface: ProgressListener

Allows the object performing the action to indicate that it won't be able to report back progress information.

Specified by:

setIndeterminate in interface ProgressListener

run

protected abstract java.lang.Object run()
                                 throws java.lang.Exception

Throws:

java.lang.Exception

allowsCancel

protected boolean allowsCancel()

isCanceled

public boolean isCanceled()