Package jebl.util
Class ProgressListener.Wrapper
java.lang.Object
jebl.util.ProgressListener
jebl.util.ProgressListener.Wrapper
- All Implemented Interfaces:
Cancelable
- Enclosing class:
- ProgressListener
A decorator progress listener which delegates all method calls to an internal progress listener.
-
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddFeedbackAction(String label, String description, SimpleListener listener) Adds an action that can choose to provide feedback.voidaddFeedbackAction(String label, SimpleListener listener) Equivalent toaddFeedbackAction(label,"",listener)booleanThis method must be implemented by all subclasses.voidremoveFeedbackAction(String label) Removes a feedback action previously added usingProgressListener.addFeedbackAction(String, jebl.util.SimpleListener).voidSets a title associated with whatever is being done.Methods inherited from class jebl.util.ProgressListener
setImage, setIndeterminateProgress, setMessage, setProgress, setProgress, setProgress
-
Constructor Details
-
Wrapper
- Parameters:
internalProgressListener- progress listener that all method calls are forwarded to.
-
-
Method Details
-
isCanceled
public boolean isCanceled()Description copied from class:ProgressListenerThis method must be implemented by all subclasses. It is called fromProgressListener.setProgress(double),ProgressListener.setIndeterminateProgress()andProgressListener.setMessage(java.lang.String)to determine the return value of these methods.- Specified by:
isCanceledin interfaceCancelable- Specified by:
isCanceledin classProgressListener- Returns:
- true if the user has requested that this operation be canceled.
-
addFeedbackAction
Description copied from class:ProgressListenerEquivalent toaddFeedbackAction(label,"",listener)- Overrides:
addFeedbackActionin classProgressListener
-
addFeedbackAction
Description copied from class:ProgressListenerAdds an action that can choose to provide feedback. For example, an operation may choose to provide a "Skip to next step" button alongside the cancel button. There is no requirement that a ProgressListener actually present this to the user - it may choose to ignore this method, in which caselistenerwill never be fired.- Overrides:
addFeedbackActionin classProgressListener- Parameters:
label- a label describing this feedback action. For example, "Skip to next step"listener- a listener to be notified when the user chooses to invoke this action
-
removeFeedbackAction
Description copied from class:ProgressListenerRemoves a feedback action previously added usingProgressListener.addFeedbackAction(String, jebl.util.SimpleListener).- Overrides:
removeFeedbackActionin classProgressListener- Parameters:
label- The label used as a parameter toProgressListener.addFeedbackAction(String, jebl.util.SimpleListener)
-
setTitle
Description copied from class:ProgressListenerSets a title associated with whatever is being done. This will not necessarily even be presented to the user, but typically will be presented as the title of a progress window.- Overrides:
setTitlein classProgressListener- Parameters:
title- the title of a progress window (if any). Must not be null.
-