public final class ProgressFrame extends ProgressListener
ProgressListener which displays progress using a progress bar and
a cancel button in a Frame.ProgressListener.WrapperEMPTY| Constructor and Description |
|---|
ProgressFrame(String title,
String message)
Creates a progress frame manager to display the progress of a potentially
time-consuming operation.
|
ProgressFrame(String title,
String message,
long delay,
boolean startDelayImmediately)
Deprecated.
use
ProgressFrame(String, String) instead |
ProgressFrame(String title,
String message,
long delay,
boolean startDelayImmediately,
Window parentWindowToDisable)
Deprecated.
use
ProgressFrame(String, String, java.awt.Window) instead |
ProgressFrame(String title,
String message,
Window parentWindowToDisable)
Creates a progress frame manager to display the progress of a potentially
time-consuming operation.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
_setImage(Image image) |
protected void |
_setIndeterminateProgress() |
protected void |
_setMessage(String message) |
protected void |
_setProgress(double fractionCompleted) |
void |
addFeedbackAction(String label,
SimpleListener listener) |
void |
addFeedbackAction(String label,
String description,
SimpleListener listener) |
void |
addProgressListener(ProgressListener progressListener)
Adds a listener to be notified about all progress messages (i.e all methods in ProgressListener) that this ProgressFrame receives.
|
void |
cancel()
Cancels this progress frame.
|
Frame |
getFrame()
Deprecated.
use
getWindow() |
Window |
getWindow()
Get the window which is used to display progress.
|
boolean |
isCanceled() |
void |
removeFeedbackAction(String label) |
void |
removeProgressListener(ProgressListener progressListener)
Removes a listener added using
addProgressListener(jebl.util.ProgressListener) |
void |
setAutoMinimize(int delayInMilliseconds)
Deprecated.
this isn't nice for the users. Don't use it.
|
void |
setCancelable(boolean isCancelable)
Set whether this progress frame should be cancelable by the user.
|
void |
setCancelButtonLabel(String label)
Set the label for the "Cancel" button.
|
void |
setComplete()
Sets the progress to 100%, causing the frame to close if it is visible.
|
void |
setIcons(Icons icons)
Set the icons for the frame/task bar (displayed in the left corner of the title bar).
|
void |
setTitle(String title) |
createSplitProgress, createSplitProgress, forCancelable, getSplitProgress, setImage, setIndeterminateProgress, setMessage, setProgress, setProgress, setProgresspublic ProgressFrame(String title, String message)
ProgressListener.setProgress(double) isn't called before this delay has elapsed the progress frame will show with indeterminate progress
typical usage:
ProgressFrame progress = new ProgressFrame("Title", "doing stuff");
while(! cancelled) {
//do some stuff
if (progress.setProgress(fractionComplete)) {
cancelled = true;
}
}
progress.setComplete ();
title - Title of the progress framemessage - Initial message to display above the progress bar (replaced by any message set during progress of
the operation)public ProgressFrame(String title, String message, Window parentWindowToDisable)
ProgressListener.setProgress(double) isn't called before this delay has elapsed the progress frame will show with indeterminate progress
typical usage:
ProgressFrame progress = new ProgressFrame("Title", "doing stuff");
while(! cancelled) {
//do some stuff
if (progress.setProgress(fractionComplete)) {
cancelled = true;
}
}
progress.setComplete ();
title - Title of the progress framemessage - Initial message to display above the progress bar (replaced by any message set during progress of
the operation)parentWindowToDisable - A window which is disabled immediately and remains disabled until the progress frame
is complete.@Deprecated public ProgressFrame(String title, String message, long delay, boolean startDelayImmediately)
ProgressFrame(String, String) insteaddelay milliseconds.
typical usage:
ProgressFrame progress = new ProgressFrame("pros", "doing stuff", 1000);
while(! cancelled) {
//do some stuff
if (progress.setProgress(fractionComplete)) {
cancelled = true;
}
}
progress.setComplete ();
title - Title of the progress framemessage - Initial message to display above the progress bar (replaced by any message set during progress of
the operation)delay - Delay in milliseconds before displaying the ProgressFrame.startDelayImmediately - if true, then the delay count starts immediately. If false, then the delay timer is
started when the first setProgress or setMessage call is made.@Deprecated public ProgressFrame(String title, String message, long delay, boolean startDelayImmediately, Window parentWindowToDisable)
ProgressFrame(String, String, java.awt.Window) insteaddelay milliseconds.
typical usage:
ProgressFrame progress = new ProgressFrame("pros", "doing stuff", 1000);
while(! cancelled) {
//do some stuff
if (progress.setProgress(fractionComplete)) {
cancelled = true;
}
}
progress.setComplete ();
title - Title of the progress framemessage - Initial message to display above the progress bar (replaced by any message set during progress of
the operation)delay - Delay in milliseconds before displaying the ProgressFrame.startDelayImmediately - if true, then the delay count starts immediately. If false, then the delay timer is
started when the first setProgress or setMessage call is made.parentWindowToDisable - A window which is disabled immediately and remains disabled until the progress frame
is complete.public void setTitle(String title)
setTitle in class ProgressListenerpublic void setIcons(Icons icons)
icons - Icons to displaypublic Frame getFrame()
getWindow()public Window getWindow()
public void cancel()
protected void _setProgress(double fractionCompleted)
_setProgress in class ProgressListenerfractionCompleted - a number between 0 and 1 inclusive
representing the fraction of the operation completed.protected void _setIndeterminateProgress()
_setIndeterminateProgress in class ProgressListenerprotected void _setMessage(String message)
_setMessage in class ProgressListenerpublic boolean isCanceled()
isCanceled in interface CancelableisCanceled in class ProgressListenerpublic void setComplete()
public void addProgressListener(ProgressListener progressListener)
progressListener - the progress listener to notifypublic void removeProgressListener(ProgressListener progressListener)
addProgressListener(jebl.util.ProgressListener)progressListener - the progress listener to notifyprotected void _setImage(Image image)
_setImage in class ProgressListenerpublic void addFeedbackAction(String label, SimpleListener listener)
addFeedbackAction in class ProgressListenerpublic void addFeedbackAction(String label, String description, SimpleListener listener)
addFeedbackAction in class ProgressListenerpublic void removeFeedbackAction(String label)
removeFeedbackAction in class ProgressListener@Deprecated public void setAutoMinimize(int delayInMilliseconds)
delayInMilliseconds - delay before minimizedpublic void setCancelButtonLabel(String label)
label - label for the cancel buttonpublic void setCancelable(boolean isCancelable)
isCancelable - whether this progress frame should be cancelable by the user