jebl.util
Class BasicProgressListener

java.lang.Object
  extended by jebl.util.ProgressListener
      extended by jebl.util.BasicProgressListener
All Implemented Interfaces:
Cancelable

public class BasicProgressListener
extends ProgressListener

A basic ProgressListener implementation that allows the caller to set the canceled status. Typically this class is used when you don't care about providing immediate feedback to the user, but still need to be able to cancel an operation.

Version:
$Id$
Author:
Matt Kearse

Nested Class Summary
 
Nested classes/interfaces inherited from class jebl.util.ProgressListener
ProgressListener.Wrapper
 
Field Summary
 
Fields inherited from class jebl.util.ProgressListener
EMPTY
 
Constructor Summary
BasicProgressListener()
           
 
Method Summary
 void cancel()
          Sets this progress listener as cancel, so that isCanceled() will return true.
 double getFractionCompleted()
           
 java.lang.String getMessage()
           
 boolean isCanceled()
          This method must be implemented by all subclasses.
 boolean isIndeterminate()
           
 
Methods inherited from class jebl.util.ProgressListener
addFeedbackAction, addFeedbackAction, removeFeedbackAction, setImage, setIndeterminateProgress, setMessage, setProgress, setProgress, setProgress, setTitle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicProgressListener

public BasicProgressListener()
Method Detail

isCanceled

public boolean isCanceled()
Description copied from class: ProgressListener
This method must be implemented by all subclasses. It is called from ProgressListener.setProgress(double), ProgressListener.setIndeterminateProgress() and ProgressListener.setMessage(java.lang.String) to determine the return value of these methods.

Specified by:
isCanceled in interface Cancelable
Specified by:
isCanceled in class ProgressListener
Returns:
true if the user has requested that this operation be canceled.

cancel

public void cancel()
Sets this progress listener as cancel, so that isCanceled() will return true.


getMessage

public java.lang.String getMessage()
Returns:
the most recent message set on this progress listener.

getFractionCompleted

public double getFractionCompleted()
Returns:
the current fraction complete.

isIndeterminate

public boolean isIndeterminate()
Returns:
true if ProgressListener.setIndeterminateProgress() has been called, and ProgressListener.setProgress(double) has not been called since


http://code.google.com/p/jebl2/