org.netbeans.api.wizard.displayer
Class NavProgress

java.lang.Object
  extended by org.netbeans.api.wizard.displayer.NavProgress
All Implemented Interfaces:
ResultProgressHandle

public class NavProgress
extends java.lang.Object
implements ResultProgressHandle

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

addProgressComponents

public void addProgressComponents(InstructionsPanel panel)
Description copied from interface: ResultProgressHandle
Add the component to show for the progress display to the instructions panel.

Specified by:
addProgressComponents in interface ResultProgressHandle

setProgress

public void setProgress(java.lang.String description,
                        int currentStep,
                        int totalSteps)
Description copied from interface: ResultProgressHandle
Set the current position and total number of steps, and description of what the computation is doing. Note it is inadvisable to be holding any locks when calling this method, as it may immediately update the GUI using EventQueue.invokeAndWait().

Specified by:
setProgress in interface ResultProgressHandle
Parameters:
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.

setProgress

public void setProgress(int currentStep,
                        int totalSteps)
Description copied from interface: ResultProgressHandle
Set the current position and total number of steps. Note it is inadvisable to be holding any locks when calling this method, as it may immediately update the GUI using EventQueue.invokeAndWait().

Specified by:
setProgress in interface ResultProgressHandle
Parameters:
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.

setBusy

public void setBusy(java.lang.String description)
Description copied from interface: ResultProgressHandle
Set the status as "busy" - a rotating icon will be displayed instead of a percent complete progress bar. Note it is inadvisable to be holding any locks when calling this method, as it may immediately update the GUI using EventQueue.invokeAndWait().

Specified by:
setBusy in interface ResultProgressHandle
Parameters:
description - Text to describe what is being done, which can be displayed in the UI.

setUseBusy

protected void setUseBusy(boolean useBusy)

finished

public void finished(java.lang.Object o)
Description copied from interface: ResultProgressHandle
Call this method when the computation is complete, and pass in the final result of the computation. The method doing the computation (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.

Specified by:
finished in interface ResultProgressHandle
Parameters:
o - the Object which was computed, if any.

failed

public void failed(java.lang.String message,
                   boolean canGoBack)
Description copied from interface: ResultProgressHandle
Call this method if computation fails. The message may be some text describing what went wrong, or null if no description.

Specified by:
failed in interface ResultProgressHandle
Parameters:
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.

isRunning

public boolean isRunning()
Description copied from interface: ResultProgressHandle
Returns true if the computation is still running, i.e., if neither finished or failed have been called.

Specified by:
isRunning in interface ResultProgressHandle
Returns:
true if there is no result yet.