com.xmlmind.guiutil

Class PossiblyLengthyTask

java.lang.Object

com.xmlmind.guiutil.PossiblyLengthyTask

public class PossiblyLengthyTask
extends Object

Utility allowing to execute a possibly lengthy task. If the execution of the task, an object which implements Runnable, takes more than a configurable amount of time, then a feedback dialog box is displayed allowing the user to cancel the task.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PossiblyLengthyTask.MonitoredRunnable A Runnable which can be monitored.

Field Summary

Fields

Modifier and Type	Field and Description
int	graceMillis After this amount of milliseconds, a feedback dialog box is displayed allowing the user to cancel the task.
Component	parentComponent The parent of the feedback dialog box.
Runnable	task The possibly lengthy task.
String	title The title of the feedback dialog box.

Constructor Summary

Constructors

Constructor and Description
PossiblyLengthyTask(Component parentComponent, String title, Runnable task, int graceMillis) Constructs a possibly lengthy task.

Method Summary

Modifier and Type	Method and Description
protected ThreadMonitorDialog	createThreadMonitorDialog(Component parentComponent, String title, String subTitle, int rows, int columns, boolean hasProgressBar)
String	execute() Execute the task.
int	getAnimateMillis() Returns the duration specified using setAnimateMillis(int).
void	setAnimateMillis(int ms) Wait specified duration, expressed in milliseconds, between the different execution steps of a PossiblyLengthyTask.MonitoredRunnable.

Methods inherited from class java.lang.Object

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

Field Detail

parentComponent

public final Component parentComponent

The parent of the feedback dialog box.

title

public final String title

The title of the feedback dialog box.

task

public final Runnable task

The possibly lengthy task. May implement PossiblyLengthyTask.MonitoredRunnable.

graceMillis

public final int graceMillis

After this amount of milliseconds, a feedback dialog box is displayed allowing the user to cancel the task.

Constructor Detail

PossiblyLengthyTask

public PossiblyLengthyTask(Component parentComponent,
                           String title,
                           Runnable task,
                           int graceMillis)

Constructs a possibly lengthy task.

Parameters:

parentComponent - parent of the feedback dialog box

title - title of the feedback dialog box

task - the possibly lengthy task. May implement PossiblyLengthyTask.MonitoredRunnable.

graceMillis - after this amount of milliseconds, a feedback dialog box is displayed allowing the user to cancel the task

Method Detail

setAnimateMillis

public void setAnimateMillis(int ms)

Wait specified duration, expressed in milliseconds, between the different execution steps of a PossiblyLengthyTask.MonitoredRunnable.

This method is mainly useful during tests where otherwise the task would be too quick to execute.

See Also:

getAnimateMillis()

getAnimateMillis

public int getAnimateMillis()

Returns the duration specified using setAnimateMillis(int).

execute

public String execute()

Execute the task.

Returns:

null if the task completed successfully; error message otherwise

createThreadMonitorDialog

protected ThreadMonitorDialog createThreadMonitorDialog(Component parentComponent,
                                                        String title,
                                                        String subTitle,
                                                        int rows,
                                                        int columns,
                                                        boolean hasProgressBar)