org.geotools.gui.swing
Class ProgressWindow

java.lang.Object
  org.geotools.gui.swing.ProgressWindow

All Implemented Interfaces:

ProgressListener

public class ProgressWindow

extends java.lang.Object

implements ProgressListener

Reports progress of a lengthly operation in a window. This implementation can also format warnings. Its method can be invoked from any thread (it doesn't need to be the Swing thread), which make it easier to use it from some background thread. Such background thread should have a low priority in order to avoid delaying Swing repaint events.

Since:

2.0

Version:

$Id: ProgressWindow.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

Constructor Summary

ProgressWindow(java.awt.Component parent)
Creates a window for reporting progress.

Method Summary

void	complete() Notifies that the operation has finished.
void	dispose() Releases any resource holds by this window.
void	exceptionOccurred(java.lang.Throwable exception) Display an exception stack trace.
java.lang.String	getDescription() Returns the description for the lengthly operation to be reported, or if none.
java.lang.String	getTitle() Returns the window title.
boolean	isCanceled() Is this job canceled?
void	progress(float percent) Notifies this listener of progress in the lengthly operation. Progress are reported as a value between 0 and 100 inclusive. Values out of bounds will be clamped.
void	setCanceled(boolean stop) Indicate that progress should is canceled.
void	setDescription(java.lang.String description) Set the description for the lenghtly operation to be reported. This method is usually invoked before any progress begins. However, it is legal to invoke this method at any time during the operation, in which case the description display is updated without any change to the percentage accomplished.
void	setTitle(java.lang.String name) Set the window title.
void	started() Notifies that the operation begins.
void	warningOccurred(java.lang.String source, java.lang.String margin, java.lang.String warning) Display a warning message under the progress bar.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressWindow

public ProgressWindow(java.awt.Component parent)

Creates a window for reporting progress. The window will not appears immediately. It will appears only when the started() method will be invoked.

Parameters:

parent - The parent component, or if none.

Method Detail

getTitle

public java.lang.String getTitle()

Returns the window title. The default title is "Progress" localized in current locale.

setTitle

public void setTitle(java.lang.String name)

Set the window title. A value reset the default title.

getDescription

public java.lang.String getDescription()

Returns the description for the lengthly operation to be reported, or if none.

Specified by:

getDescription in interface ProgressListener

setDescription

public void setDescription(java.lang.String description)

Set the description for the lenghtly operation to be reported. This method is usually invoked before any progress begins. However, it is legal to invoke this method at any time during the operation, in which case the description display is updated without any change to the percentage accomplished.

Specified by:

setDescription in interface ProgressListener

Parameters:

description - The new description, or if none.

started

public void started()

Notifies that the operation begins. This method display the windows if it was not already visible.

Specified by:

started in interface ProgressListener

progress

public void progress(float percent)

Notifies this listener of progress in the lengthly operation. Progress are reported as a value between 0 and 100 inclusive. Values out of bounds will be clamped.

Specified by:

progress in interface ProgressListener

complete

public void complete()

Notifies that the operation has finished. The window will disaspears, except if it contains warning or exception stack traces.

Specified by:

complete in interface ProgressListener

dispose

public void dispose()

Releases any resource holds by this window. Invoking this method destroy the window.

Specified by:

dispose in interface ProgressListener

isCanceled

public boolean isCanceled()

Is this job canceled?

Specified by:

isCanceled in interface ProgressListener

setCanceled

public void setCanceled(boolean stop)

Indicate that progress should is canceled.

Specified by:

setCanceled in interface ProgressListener

warningOccurred

public void warningOccurred(java.lang.String source,
                            java.lang.String margin,
                            java.lang.String warning)

Display a warning message under the progress bar. The text area for warning messages will appears only the first time this method is invoked.

Specified by:

warningOccurred in interface ProgressListener

Parameters:

source - The source of the warning, or if none. This is typically the filename in process of being parsed.

margin - Text to write on the left side of the warning message, or if none. This is typically the line number where the error occured in the file.

warning - The warning message.

exceptionOccurred

public void exceptionOccurred(java.lang.Throwable exception)

Display an exception stack trace.

Specified by:

exceptionOccurred in interface ProgressListener