|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.netbeans.api.wizard.displayer.NavProgress
public class NavProgress
Show progress bar for deferred results, with a label showing percent done and progress bar.
This class is NOT AN API CLASS. There is no
commitment that it will remain backward compatible or even exist in the
future. The API of this library is in the packages org.netbeans.api.wizard
and org.netbeans.spi.wizard
.
Method Summary | |
---|---|
void |
addProgressComponents(InstructionsPanel panel)
Add the component to show for the progress display to the instructions panel. |
void |
failed(java.lang.String message,
boolean canGoBack)
Call this method if computation fails. |
void |
finished(java.lang.Object o)
Call this method when the computation is complete, and pass in the final result of the computation. |
boolean |
isRunning()
Returns true if the computation is still running, i.e., if neither finished or failed have been called. |
void |
setBusy(java.lang.String description)
Set the status as "busy" - a rotating icon will be displayed instead of a percent complete progress bar. |
void |
setProgress(int currentStep,
int totalSteps)
Set the current position and total number of steps. |
void |
setProgress(java.lang.String description,
int currentStep,
int totalSteps)
Set the current position and total number of steps, and description of what the computation is doing. |
protected void |
setUseBusy(boolean useBusy)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void addProgressComponents(InstructionsPanel panel)
ResultProgressHandle
addProgressComponents
in interface ResultProgressHandle
public void setProgress(java.lang.String description, int currentStep, int totalSteps)
ResultProgressHandle
EventQueue.invokeAndWait()
.
setProgress
in interface ResultProgressHandle
description
- Text to describe what is being done, which can
be displayed in the UI.currentStep
- the current step in the progress of computing the
result.totalSteps
- the total number of steps. Must be greater than
or equal to currentStep.public void setProgress(int currentStep, int totalSteps)
ResultProgressHandle
EventQueue.invokeAndWait()
.
setProgress
in interface ResultProgressHandle
currentStep
- the current step in the progress of computing the
result.totalSteps
- the total number of steps. Must be greater than
or equal to currentStep.public void setBusy(java.lang.String description)
ResultProgressHandle
EventQueue.invokeAndWait()
.
setBusy
in interface ResultProgressHandle
description
- Text to describe what is being done, which can
be displayed in the UI.protected void setUseBusy(boolean useBusy)
public void finished(java.lang.Object o)
ResultProgressHandle
DeferredWizardResult.start()
or something it
called) should exit immediately after calling this method. If the
failed()
method is called after this method has been
called, a runtime exception may be thrown.
finished
in interface ResultProgressHandle
o
- the Object which was computed, if any.public void failed(java.lang.String message, boolean canGoBack)
ResultProgressHandle
failed
in interface ResultProgressHandle
message
- The text to display to the user. The method
doing the computation (DeferredWizardResult.start()
or something it
called). If the finished()
method is called after this
method has been called, a runtime exception may be thrown.
should exit immediately after calling this method.
It is A description of what went wrong, or null.canGoBack
- whether or not the Prev button should be
enabled.public boolean isRunning()
ResultProgressHandle
isRunning
in interface ResultProgressHandle
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |