org.geotools.swing
Class ProgressWindow

Object
  extended by ProgressWindow
All Implemented Interfaces:
ProgressListener

public class ProgressWindow
extends 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
Author:
Martin Desruisseaux
Module:
modules/unsupported/swing (gt-swing.jar)

Constructor Summary
ProgressWindow(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(Throwable exception)
          Display an exception stack trace.
 String getDescription()
          Deprecated.  
 float getProgress()
           
 InternationalString getTask()
           
 String getTitle()
          Returns the window title.
 boolean isCanceled()
          
 void progress(float percent)
          
 void setCanceled(boolean stop)
          
 void setDescription(String description)
          Deprecated.  
 void setTask(InternationalString task)
           
 void setTitle(String title)
          Set the window title.
 void started()
          Notifies that the operation begins.
 void warningOccurred(String source, String margin, String warning)
          Display a warning message under the progress bar.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProgressWindow

public ProgressWindow(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 null if none.
Method Detail

getTitle

public String getTitle()
Returns the window title. The default title is "Progress" localized in current locale.

Returns:
the window title

setTitle

public void setTitle(String title)
Set the window title. A null value reset the default title.

Parameters:
title - the window title

getDescription

public String getDescription()
Deprecated. 

Specified by:
getDescription in interface ProgressListener

setDescription

public void setDescription(String description)
Deprecated. 

Specified by:
setDescription in interface ProgressListener

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)

Specified by:
progress in interface ProgressListener

getProgress

public float getProgress()
Specified by:
getProgress 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()

Specified by:
isCanceled in interface ProgressListener

setCanceled

public void setCanceled(boolean stop)

Specified by:
setCanceled in interface ProgressListener
Parameters:
stop - true to stop; false otherwise

warningOccurred

public void warningOccurred(String source,
                            String margin,
                            String warning)
Display a warning message under the progress bar. The text area for warning messages appears only the first time this method is invoked.

Specified by:
warningOccurred in interface ProgressListener
Parameters:
source - DOCUMENT ME
margin - DOCUMENT ME
warning - DOCUMENT ME

exceptionOccurred

public void exceptionOccurred(Throwable exception)
Display an exception stack trace.

Specified by:
exceptionOccurred in interface ProgressListener
Parameters:
exception - the exception to display

setTask

public void setTask(InternationalString task)
Specified by:
setTask in interface ProgressListener

getTask

public InternationalString getTask()
Specified by:
getTask in interface ProgressListener


Copyright © 1996-2010 Geotools. All Rights Reserved.