org.hortonmachine.gui.utils.monitor

Class HMProgressMonitorDialog

java.lang.Object

org.hortonmachine.gui.utils.monitor.HMProgressMonitorDialog

All Implemented Interfaces:

PropertyChangeListener, EventListener

public abstract class HMProgressMonitorDialog
extends Object
implements PropertyChangeListener

A progress dialog for long background jobs.

Author:

Andrea Antonello (www.hydrologis.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected StringBuilder	finalErrorSb
protected StringBuilder	finalInfoSb
protected ProgressMonitor	progressMonitor
protected org.hortonmachine.gui.utils.monitor.HMProgressMonitorDialog.BackgroundTask	task

Constructor Summary

Constructors

Constructor and Description
HMProgressMonitorDialog(Component parent, String title, int workLoad) Create the monitor dialog.

Method Summary

Modifier and Type	Method and Description
protected boolean	isCancelled()
static void	main(String[] args)
abstract void	postDoneInUi() Execute something after the progress has finished in the UI thread.
abstract void	processInBackground() Method inside which the job has to be done in background.
void	propertyChange(PropertyChangeEvent evt) Invoked when task's progress property changes.
void	run() Start the job with monitor dialog.
void	setProgress(int progress)
void	setProgressText(String text)

Methods inherited from class java.lang.Object

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

Field Detail

progressMonitor

protected ProgressMonitor progressMonitor

task

protected org.hortonmachine.gui.utils.monitor.HMProgressMonitorDialog.BackgroundTask task

finalInfoSb

protected StringBuilder finalInfoSb

finalErrorSb

protected StringBuilder finalErrorSb

Constructor Detail

HMProgressMonitorDialog

public HMProgressMonitorDialog(Component parent,
                               String title,
                               int workLoad)

Create the monitor dialog.

Parameters:

parent - the parent component.

title - the title of the monitor dialog.

workLoad - the maximum work to do.

Method Detail

run

public void run()

Start the job with monitor dialog.

processInBackground

public abstract void processInBackground()
                                  throws Exception

Method inside which the job has to be done in background.

• update progress bar with progressMonitor.setProgress(0);
• update progress text with setProgressText("My message");

Throws:

Exception

postDoneInUi

public abstract void postDoneInUi()

Execute something after the progress has finished in the UI thread.

isCancelled

protected boolean isCancelled()

setProgressText

public void setProgressText(String text)

setProgress

public void setProgress(int progress)

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Invoked when task's progress property changes.

Specified by:

propertyChange in interface PropertyChangeListener

main

public static void main(String[] args)