org.netbeans.spi.wizard
Interface WizardPage.WizardResultProducer

Enclosing class:
WizardPage

public static interface WizardPage.WizardResultProducer

Interface that is passed to WizardPage.createWizard(). For wizards created from a set of WizardPages or WizardPage subclasses, this is the object that whose code will be run to create or do whatever the wizard does when the user clicks the Finish button.


Field Summary
Modifier and Type Field and Description
static WizardPage.WizardResultProducer NO_OP
          A no-op WizardResultProducer that returns null.
 
Method Summary
Modifier and Type Method and Description
 boolean cancel(java.util.Map settings)
          Called when the user presses the cancel button.
 java.lang.Object finish(java.util.Map wizardData)
          Conclude a wizard, doing whatever the wizard does with the data gathered into the map on the various panels.
 

Field Detail

NO_OP

static final WizardPage.WizardResultProducer NO_OP
A no-op WizardResultProducer that returns null.

Method Detail

finish

java.lang.Object finish(java.util.Map wizardData)
                        throws WizardException
Conclude a wizard, doing whatever the wizard does with the data gathered into the map on the various panels.

If an instance of Summary is returned from this method, the UI shall display it on a final page and disable all navigation buttons except the Close/Cancel button.

If an instance of DeferredWizardResult is returned from this method, the UI shall display some sort of progress bar while the result is computed in the background. If that DeferredWizardResult produces a Summary object, that summary shall be displayed as described above.

Parameters:
wizardData - the map with key-value pairs which has been populated by the UI as the user progressed through the wizard
Returns:
an object composed based on what the user entered in the wizard - somethingmeaningful to whatever code invoked the wizard, or null. Note special handling if an instance of DeferredWizardResult or Summary is returned from this method.
Throws:
WizardException

cancel

boolean cancel(java.util.Map settings)
Called when the user presses the cancel button. Almost all implementations will want to return true.